Struct sp_core::bandersnatch::Pair

pub struct Pair { /* private fields */ }

Bandersnatch secret key.

Implementations

impl Pair

pub fn make_bytes<const N: usize>( &self, context: &'static [u8], input: &VrfInput, ) -> [u8; N]

Generate an arbitrary number of bytes from the given context and VRF input.

impl Pair

pub fn ring_vrf_sign( &self, data: &VrfSignData, prover: &RingProver, ) -> RingVrfSignature

Produce a ring-vrf signature.

The ring signature is verifiable if the public key corresponding to the signing Pair is part of the ring from which the RingProver has been constructed. If not, the produced signature is just useless.

impl Pair

pub fn seed(&self) -> [u8; 32]

Get the key seed.

Trait Implementations

impl Clone for Pair

fn clone(&self) -> Pair

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

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 an error.

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 (hard) junctions.

Soft junctions are not supported.

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

Sign a message.

In practice this produce a Schnorr signature of a transcript composed by the constant label SIGNING_CTX and data without any additional data.

See vrf::VrfSignData for additional details.

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

Return a vector filled with the seed (32 bytes).

type Seed = [u8; 32]

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

type Public = CryptoBytes<PUBLIC_SERIALIZED_SIZE, (PublicTag, BandersnatchTag)>

The type which is used to encode a public key.

type Signature = CryptoBytes<SIGNATURE_SERIALIZED_SIZE, (SignatureTag, BandersnatchTag)>

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 public(&self) -> Public

Get the public key.

fn verify<M: AsRef<[u8]>>( signature: &Signature, data: M, public: &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.

impl VrfCrypto for Pair

type VrfInput = VrfInput

VRF input.

type VrfPreOutput = VrfPreOutput

VRF pre-output.

type VrfSignData = VrfSignData

VRF signing data.

type VrfSignature = VrfSignature

VRF signature.

impl VrfSecret for Pair

fn vrf_sign(&self, data: &Self::VrfSignData) -> Self::VrfSignature

Sign VRF-specific data.

fn vrf_pre_output(&self, input: &Self::VrfInput) -> Self::VrfPreOutput

Get VRF-specific pre-output.