Struct sp_core::sr25519::Pair

pub struct Pair(_);

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

Implementations

impl Pair

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.

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

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

impl AsRef<Keypair> for Pair

fn as_ref(&self) -> &Keypair

Performs the conversion.

impl Clone for Pair

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl CryptoType for Pair

type Pair = Pair

The pair key type of this crypto.

impl From<Keypair> for Pair

fn from(p: Keypair) -> Pair

Performs the conversion.

impl From<MiniSecretKey> for Pair

fn from(sec: MiniSecretKey) -> Pair

Performs the conversion.

impl From<Pair> for Keypair

fn from(p: Pair) -> Keypair

Performs the conversion.

impl From<SecretKey> for Pair

fn from(sec: SecretKey) -> Pair

Performs the conversion.

impl Pair for 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.

fn public(&self) -> Public

Get the public key.

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.

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.

type DeriveError = Infallible

Error returned from the derive function.

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

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

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.

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.

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

Sign a message.

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.

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.

fn to_raw_vec(&self) -> Vec<u8>

Return a vec filled with raw data.

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

Generate new secure (random) key pair.

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

fn from_string(
    s: &str,
    password_override: Option<&str>
) -> Result<Self, SecretStringError>

Interprets the string s in order to generate a key pair.