pub struct Pair(_);
Expand description
An Schnorrkel/Ristretto x25519 (“sr25519”) key pair.
Implementations
Trait Implementations
sourceimpl CryptoType for Pair
impl CryptoType for Pair
sourceimpl From<MiniSecretKey> for Pair
impl From<MiniSecretKey> for Pair
sourcefn from(sec: MiniSecretKey) -> Pair
fn from(sec: MiniSecretKey) -> Pair
Converts to this type from the input type.
sourceimpl Pair for Pair
impl Pair for Pair
sourcefn from_seed(seed: &[u8; 32]) -> Pair
fn from_seed(seed: &[u8; 32]) -> Pair
Make a new key pair from raw secret seed material.
This is generated using schnorrkel’s Mini-Secret-Keys.
A MiniSecretKey is literally what Ed25519 calls a SecretKey, which is just 32 random bytes.
sourcefn from_seed_slice(seed: &[u8]) -> Result<Pair, SecretStringError>
fn from_seed_slice(seed: &[u8]) -> Result<Pair, SecretStringError>
Make a new key pair from secret seed material. The slice must be 32 bytes long or it
will return None
.
You should never need to use this; generate(), generate_with_phrase(), from_phrase()
type Seed = [u8; 32]
type Seed = [u8; 32]
The type used to (minimally) encode the data required to securely create
a new key pair. Read more
type Signature = Signature
type Signature = Signature
The type used to represent a signature. Can be created from a key pair and a message
and verified with the message and a public key. Read more
type DeriveError = Infallible
type DeriveError = Infallible
Error returned from the
derive
function.sourcefn generate_with_phrase(password: Option<&str>) -> (Pair, String, [u8; 32])
fn generate_with_phrase(password: Option<&str>) -> (Pair, String, [u8; 32])
Generate new secure (random) key pair and provide the recovery phrase. Read more
sourcefn from_phrase(
phrase: &str,
password: Option<&str>
) -> Result<(Pair, [u8; 32]), SecretStringError>
fn from_phrase(
phrase: &str,
password: Option<&str>
) -> Result<(Pair, [u8; 32]), SecretStringError>
Returns the KeyPair from the English BIP39 seed
phrase
, or None
if it’s invalid.sourcefn derive<Iter: Iterator<Item = DeriveJunction>>(
&self,
path: Iter,
seed: Option<[u8; 32]>
) -> Result<(Pair, Option<[u8; 32]>), Self::DeriveError>
fn derive<Iter: Iterator<Item = DeriveJunction>>(
&self,
path: Iter,
seed: Option<[u8; 32]>
) -> Result<(Pair, Option<[u8; 32]>), Self::DeriveError>
Derive a child key from a series of given junctions.
sourcefn verify<M: AsRef<[u8]>>(
sig: &Self::Signature,
message: M,
pubkey: &Self::Public
) -> bool
fn verify<M: AsRef<[u8]>>(
sig: &Self::Signature,
message: M,
pubkey: &Self::Public
) -> bool
Verify a signature on a message. Returns true if the signature is good.
sourcefn verify_weak<P: AsRef<[u8]>, M: AsRef<[u8]>>(
sig: &[u8],
message: M,
pubkey: P
) -> bool
fn verify_weak<P: AsRef<[u8]>, M: AsRef<[u8]>>(
sig: &[u8],
message: M,
pubkey: P
) -> bool
Verify a signature on a message. Returns true if the signature is good.
sourcefn to_raw_vec(&self) -> Vec<u8> ⓘ
fn to_raw_vec(&self) -> Vec<u8> ⓘ
Return a vec filled with raw data.
sourcefn from_string_with_seed(
s: &str,
password_override: Option<&str>
) -> Result<(Self, Option<Self::Seed>), SecretStringError>
fn from_string_with_seed(
s: &str,
password_override: Option<&str>
) -> Result<(Self, Option<Self::Seed>), SecretStringError>
Interprets the string
s
in order to generate a key Pair. Returns both the pair and an
optional seed, in the case that the pair can be expressed as a direct derivation from a seed
(some cases, such as Sr25519 derivations with path components, cannot). Read moresourcefn from_string(
s: &str,
password_override: Option<&str>
) -> Result<Self, SecretStringError>
fn from_string(
s: &str,
password_override: Option<&str>
) -> Result<Self, SecretStringError>
Interprets the string
s
in order to generate a key pair. Read moreAuto Trait Implementations
impl RefUnwindSafe for Pair
impl Send for Pair
impl Sync for Pair
impl Unpin for Pair
impl UnwindSafe for Pair
Blanket Implementations
sourceimpl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>
fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>
Convert
Box<dyn Trait>
(where Trait: Downcast
) to Box<dyn Any>
. Box<dyn Any>
can
then be further downcast
into Box<ConcreteType>
where ConcreteType
implements Trait
. Read morefn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
Convert
Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
. Read morefn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
Convert
&Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s. Read morefn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
Convert
&mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s. Read moresourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T, Outer> IsWrappedBy<Outer> for Twhere
Outer: AsRef<T> + AsMut<T> + From<T>,
T: From<Outer>,
impl<T, Outer> IsWrappedBy<Outer> for Twhere
Outer: AsRef<T> + AsMut<T> + From<T>,
T: From<Outer>,
sourceimpl<S, T> UncheckedInto<T> for Swhere
T: UncheckedFrom<S>,
impl<S, T> UncheckedInto<T> for Swhere
T: UncheckedFrom<S>,
sourcefn unchecked_into(self) -> T
fn unchecked_into(self) -> T
The counterpart to
unchecked_from
.