pub struct Pair { /* private fields */ }
Expand description
A key pair.
Implementations§
source§impl Pair
impl Pair
sourcepub fn from_legacy_string(s: &str, password_override: Option<&str>) -> Pair
pub fn from_legacy_string(s: &str, password_override: Option<&str>) -> Pair
Exactly as from_string
except that if no matches are found then, the the first 32
characters are taken (padded with spaces as necessary) and used as the MiniSecretKey.
sourcepub fn sign_prehashed(&self, message: &[u8; 32]) -> Signature
pub fn sign_prehashed(&self, message: &[u8; 32]) -> Signature
Sign a pre-hashed message
Trait Implementations§
source§impl Pair for Pair
impl Pair for Pair
source§fn from_seed_slice(seed_slice: &[u8]) -> Result<Pair, SecretStringError>
fn from_seed_slice(seed_slice: &[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
source§fn derive<Iter: Iterator<Item = DeriveJunction>>(
&self,
path: Iter,
_seed: Option<[u8; 32]>,
) -> Result<(Pair, Option<[u8; 32]>), DeriveError>
fn derive<Iter: Iterator<Item = DeriveJunction>>( &self, path: Iter, _seed: Option<[u8; 32]>, ) -> Result<(Pair, Option<[u8; 32]>), DeriveError>
Derive a child key from a series of given junctions.
source§fn verify<M: AsRef<[u8]>>(sig: &Signature, message: M, public: &Public) -> bool
fn verify<M: AsRef<[u8]>>(sig: &Signature, message: M, public: &Public) -> bool
Verify a signature on a message. Returns true if the signature is good.
§type Public = CryptoBytes<PUBLIC_KEY_SERIALIZED_SIZE, (PublicTag, EcdsaTag)>
type Public = CryptoBytes<PUBLIC_KEY_SERIALIZED_SIZE, (PublicTag, EcdsaTag)>
The type which is used to encode a public key.
§type Seed = [u8; 32]
type Seed = [u8; 32]
The type used to (minimally) encode the data required to securely create
a new key pair.
§type Signature = CryptoBytes<SIGNATURE_SERIALIZED_SIZE, (SignatureTag, EcdsaTag)>
type Signature = CryptoBytes<SIGNATURE_SERIALIZED_SIZE, (SignatureTag, EcdsaTag)>
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.
source§fn generate_with_phrase(password: Option<&str>) -> (Self, String, Self::Seed)
fn generate_with_phrase(password: Option<&str>) -> (Self, String, Self::Seed)
Generate new secure (random) key pair and provide the recovery phrase. Read more
source§fn from_phrase(
phrase: &str,
password: Option<&str>,
) -> Result<(Self, Self::Seed), SecretStringError>
fn from_phrase( phrase: &str, password: Option<&str>, ) -> Result<(Self, Self::Seed), SecretStringError>
Returns the KeyPair from the English BIP39 seed
phrase
, or an error if it’s invalid.source§fn from_seed(seed: &Self::Seed) -> Self
fn from_seed(seed: &Self::Seed) -> Self
Generate new key pair from the provided
seed
. Read moresource§fn 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 moresource§fn 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 Freeze for Pair
impl RefUnwindSafe for Pair
impl Send for Pair
impl Sync for Pair
impl Unpin for Pair
impl UnwindSafe for Pair
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
Converts
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
Converts
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§impl<T, Outer> IsWrappedBy<Outer> for T
impl<T, Outer> IsWrappedBy<Outer> for T
source§impl<S, T> UncheckedInto<T> for Swhere
T: UncheckedFrom<S>,
impl<S, T> UncheckedInto<T> for Swhere
T: UncheckedFrom<S>,
source§fn unchecked_into(self) -> T
fn unchecked_into(self) -> T
The counterpart to
unchecked_from
.