Struct sp_application_crypto::sr25519::Pair

source · [−]

pub struct Pair(_);

Expand description

An Schnorrkel/Ristretto x25519 (“sr25519”) key pair.

Implementations

source

impl Pair

source

pub fn from_entropy(entropy: &[u8 ], password: Option<&str>) -> (Pair, [u8 ; 32])

Make a new key pair from binary data derived from a valid seed phrase.

This uses a key derivation function to convert the entropy into a seed, then returns the pair generated from it.

source

pub fn verify_deprecated<M>(
 sig: &Signature,
 message: M,
 pubkey: &Public
) -> bool where
 M: AsRef<[u8 ]>,

Verify a signature on a message. Returns true if the signature is good. Supports old 0.1.1 deprecated signatures and should be used only for backward compatibility.

Trait Implementations

source

impl Clone for Pair

source

pub fn clone(&self) -> Pair

Returns a copy of the value. Read more

1.0.0 · source

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more

source

impl From<MiniSecretKey> for Pair

source

pub fn from(sec: MiniSecretKey) -> Pair

Performs the conversion.

source

impl Pair for Pair

source

pub 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.

source

pub fn public(&self) -> Public

Get the public key.

source

pub 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 Public = Public

The type which is used to encode a public key.

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

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

Error returned from the derive function.

source

pub fn generate_with_phrase(password: Option<&str>) -> (Pair, String, [u8 ; 32])

Generate new secure (random) key pair and provide the recovery phrase. Read more

source

pub 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.

source

pub fn derive<Iter>(
 &self,
 path: Iter,
 seed: Option<[u8 ; 32]>
) -> Result<(Pair, Option<[u8 ; 32]>), <Pair as Pair>::DeriveError> where
 Iter: Iterator<Item = DeriveJunction>,

Derive a child key from a series of given junctions.

source

pub fn sign(&self, message: &[u8 ]) -> Signature

Sign a message.

source

pub fn verify<M>(
 sig: &<Pair as Pair>::Signature,
 message: M,
 pubkey: &<Pair as Pair>::Public
) -> bool where
 M: AsRef<[u8 ]>,

Verify a signature on a message. Returns true if the signature is good.

source

pub fn verify_weak<P, M>(sig: &[u8 ], message: M, pubkey: P) -> bool where
P: AsRef<[u8 ]>,
M: AsRef<[u8 ]>,

Verify a signature on a message. Returns true if the signature is good.

source

pub fn to_raw_vec(&self) -> Vec<u8, Global>ⓘNotable traits for Vec<u8, A>`impl<A> Write for Vec<u8, A> where A: Allocator,`

Return a vec filled with raw data.

source

fn generate() -> (Self, Self::Seed )

Generate new secure (random) key pair. Read more

source

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 more

source