Struct hkd32::mnemonic::Phrase

pub struct Phrase { /* fields omitted */ }

BIP39 mnemonic phrases: sequences of words representing cryptographic keys.

Methods

impl Phrase

pub fn random(language: Language) -> Self

Create a random BIP39 mnemonic phrase.

pub fn from_entropy(entropy: [u8; 32], language: Language) -> Self

Create a new BIP39 mnemonic phrase from the given entropy

pub fn new<S>(phrase: S, language: Language) -> Result<Self, Error> where
    S: AsRef<str>, 

Create a new BIP39 mnemonic phrase from the given string.

The phrase supplied will be checked for word length and validated according to the checksum specified in BIP0039.

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

Get source entropy for this phrase.

pub fn phrase(&self) -> &str

Get the mnemonic phrase as a string reference.

pub fn language(&self) -> Language

Language this phrase's wordlist is for

pub fn derive_subkey(self, path: impl AsRef<Path>) -> KeyMaterial

Convert this mnemonic phrase's entropy directly into key material. If you are looking for the shortest path between a mnemonic phrase and a key derivation hierarchy, this is it.

Note: that this does not follow the normal BIP39 derivation, which first applies PBKDF2 along with a secondary password. Use to_seed if you are interested in BIP39 compatibility. Derive a BIP32 subkey from this seed

pub fn to_seed(&self, password: &str) -> Seed

Convert this mnemonic phrase into the BIP39 seed value.

This is only available when the bip39 Cargo feature is enabled.

Trait Implementations

impl From<Phrase> for KeyMaterial

fn from(phrase: Phrase) -> KeyMaterial

Convert to KeyMaterial using an empty password

impl Drop for Phrase

fn drop(&mut self)

Executes the destructor for this type.

impl Clone for Phrase

fn clone(&self) -> Phrase

Returns a copy of the value.

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

Performs copy-assignment from source.