Struct sp_core::paired_crypto::Pair

pub struct Pair<LeftPair: PairT, RightPair: PairT, const PUBLIC_KEY_LEN: usize, const SIGNATURE_LEN: usize, SubTag> { /* private fields */ }

A key pair.

Trait Implementations

impl<LeftPair: PairT + Clone, RightPair: PairT + Clone, const PUBLIC_KEY_LEN: usize, const SIGNATURE_LEN: usize, SubTag> Clone for Pair<LeftPair, RightPair, PUBLIC_KEY_LEN, SIGNATURE_LEN, SubTag>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<LeftPair: PairT, RightPair: PairT, const LEFT_PLUS_RIGHT_PUBLIC_LEN: usize, const SIGNATURE_LEN: usize, SubTag: PairedCryptoSubTagBound> From<Pair<LeftPair, RightPair, LEFT_PLUS_RIGHT_PUBLIC_LEN, SIGNATURE_LEN, SubTag>> for Public<LEFT_PLUS_RIGHT_PUBLIC_LEN, SubTag>

where Pair<LeftPair, RightPair, LEFT_PLUS_RIGHT_PUBLIC_LEN, SIGNATURE_LEN, SubTag>: PairT<Public = Public<LEFT_PLUS_RIGHT_PUBLIC_LEN, SubTag>>,

fn from( x: Pair<LeftPair, RightPair, LEFT_PLUS_RIGHT_PUBLIC_LEN, SIGNATURE_LEN, SubTag>, ) -> Self

Converts to this type from the input type.

impl<LeftPair: PairT, RightPair: PairT, const PUBLIC_KEY_LEN: usize, const SIGNATURE_LEN: usize, SubTag: PairedCryptoSubTagBound> Pair for Pair<LeftPair, RightPair, PUBLIC_KEY_LEN, SIGNATURE_LEN, SubTag>

where Pair<LeftPair, RightPair, PUBLIC_KEY_LEN, SIGNATURE_LEN, SubTag>: CryptoType, Public<PUBLIC_KEY_LEN, SubTag>: PublicT, Signature<SIGNATURE_LEN, SubTag>: SignatureT, LeftPair::Seed: From<[u8; 32]> + Into<[u8; 32]>, RightPair::Seed: From<[u8; 32]> + Into<[u8; 32]>,

fn derive<Iter: Iterator<Item = DeriveJunction>>( &self, path: Iter, seed: Option<Self::Seed>, ) -> Result<(Self, Option<Self::Seed>), DeriveError>

Derive a child key from a series of given junctions.

Note: if the LeftPair and RightPair crypto schemes differ in seed derivation, derive will drop the seed in the return.

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

Get the seed/secret key for each key and then concatenate them.

type Seed = [u8; 32]

The type used to (minimally) encode the data required to securely create a new key pair.

type Public = CryptoBytes<PUBLIC_KEY_LEN, (PublicTag, (PairedCryptoTag, SubTag))>

The type which is used to encode a public key.

type Signature = CryptoBytes<SIGNATURE_LEN, (SignatureTag, (PairedCryptoTag, SubTag))>

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.

fn from_seed_slice(seed_slice: &[u8]) -> Result<Self, SecretStringError>

Make a new key pair from secret seed material. The slice must be the correct size or an error will be returned.

fn public(&self) -> Self::Public

Get the public key.

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

Sign a message.

fn verify<Msg: AsRef<[u8]>>( sig: &Self::Signature, message: Msg, public: &Self::Public, ) -> bool

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

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

Generate new secure (random) key pair.

fn generate_with_phrase(password: Option<&str>) -> (Self, String, Self::Seed)

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

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.

fn from_seed(seed: &Self::Seed) -> Self

Generate new key pair from the provided seed.

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.