Struct hedera::Mnemonic

pub struct Mnemonic(/* private fields */);

BIP-39 24-word mnemonic phrase compatible with the Android and iOS mobile wallets.

Implementations

impl Mnemonic

pub fn is_legacy(&self) -> bool

Returns true if self is a legacy mnemonic.

pub fn from_words(words: Vec<String>) -> Result<Self>

Constructs a Mnemonic from a 24-word list.

Errors

• if the mnemonic has an invalid length.
• if the mnemonic uses invalid words.
• if the mnemonic has an invalid checksum.

pub fn generate_12() -> Self

Generate a new 12 word Mnemonic from the BIP-39 standard English word list.

pub fn generate_24() -> Self

Generate a new 24 word Mnemonic from the BIP-39 standard English word list.

pub fn to_legacy_private_key(&self) -> Result<PrivateKey>

Recover a PrivateKey from this Mnemonic.

Errors

Under certain circumstances, this function will return a Error::MnemonicEntropy.

• MnemonicEntropyError::ChecksumMismatch if the computed checksum doesn’t match the actual checksum.
• MnemonicEntropyError::BadLength if this is a v2 legacy mnemonic and doesn’t have 24 words.

pub fn to_private_key(&self, passphrase: &str) -> Result<PrivateKey>

Recover a PrivateKey from this Mnemonic.

Errors

Under certain circumstances, this function will return a Error::MnemonicEntropy.

• MnemonicEntropyError::LegacyWithPassphrase if this is a legacy private key, and the passphrase isn’t empty.
• MnemonicEntropyError::ChecksumMismatch if this is a legacy private key, and the Mnemonic’s checksum doesn’t match up with the computed one.

Trait Implementations

impl Debug for Mnemonic

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Display for Mnemonic

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl FromStr for Mnemonic

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.