Struct Mnemonic 

pub struct Mnemonic { /* private fields */ }

Available on crate feature mnemonic only.

A BIP-39 mnemonic phrase for key derivation.

Example

use aptos_sdk::account::Mnemonic;

// Generate a new mnemonic
let mnemonic = Mnemonic::generate(24).unwrap();
println!("Mnemonic: {}", mnemonic.phrase());

// Parse an existing mnemonic
let mnemonic = Mnemonic::from_phrase("abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon about").unwrap();

Implementations

impl Mnemonic

pub fn generate(word_count: usize) -> AptosResult<Self>

Generates a new random mnemonic phrase.

Arguments

• word_count - Number of words (12, 15, 18, 21, or 24)

Errors

Returns an error if the word count is not one of 12, 15, 18, 21, or 24, or if entropy generation fails.

pub fn from_phrase(phrase: &str) -> AptosResult<Self>

Creates a mnemonic from an existing phrase.

Errors

Returns an error if the phrase is not a valid BIP-39 mnemonic.

pub fn phrase(&self) -> &str

Returns the mnemonic phrase.

pub fn to_seed(&self) -> AptosResult<[u8; 64]>

Derives the seed from this mnemonic.

Uses an empty passphrase by default.

Errors

Returns an error if the mnemonic cannot be re-parsed (should not happen since the phrase was validated during construction).

pub fn to_seed_with_passphrase(&self, passphrase: &str) -> AptosResult<[u8; 64]>

Derives the seed from this mnemonic with a passphrase.

Errors

Returns an error if the mnemonic phrase cannot be re-parsed. This should never happen because the phrase is validated during construction, but returning an error is safer than panicking.

pub fn derive_ed25519_key(&self, index: u32) -> AptosResult<Ed25519PrivateKey>

Available on crate feature ed25519 only.

Derives an Ed25519 private key using the Aptos derivation path.

Path: m/44'/637'/0'/0'/index'

Errors

Returns an error if key derivation fails or the derived key is invalid.

Trait Implementations

impl Clone for Mnemonic

fn clone(&self) -> Mnemonic

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Mnemonic

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

Formats the value using the given formatter.