Struct MnemonicBuilder

pub struct MnemonicBuilder<W: Wordlist = English> { /* private fields */ }

Available on crate feature mnemonic only.

Represents a structure that can resolve into a PrivateKeySigner.

Implementations

impl<W: Wordlist> MnemonicBuilder<W>

pub fn phrase<P: Into<String>>(self, phrase: P) -> Self

Sets the phrase in the mnemonic builder. The phrase can either be a string or a path to the file that contains the phrase. Once a phrase is provided, the key will be generated deterministically by calling the build method.

Examples

use alloy_signer_local::{MnemonicBuilder, coins_bip39::English};

let signer = MnemonicBuilder::<English>::default()
    .phrase("abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon about")
    .build()?;

pub const fn word_count(self, count: usize) -> Self

Sets the word count of a mnemonic phrase to be generated at random. If the phrase field is set, then word_count will be ignored.

Examples

use alloy_signer_local::{coins_bip39::English, MnemonicBuilder};

let signer = MnemonicBuilder::<English>::default().word_count(24).build()?;

pub fn index(self, index: u32) -> Result<Self, LocalSignerError>

Sets the derivation path of the child key to be derived. The derivation path is calculated using the default derivation path prefix used in Ethereum, i.e. “m/44’/60’/0’/0/{index}”.

pub fn derivation_path<T: AsRef<str>>( self, path: T, ) -> Result<Self, LocalSignerError>

Sets the derivation path of the child key to be derived.

pub fn password<T: Into<String>>(self, password: T) -> Self

Sets the password used to construct the seed from the mnemonic phrase.

pub fn write_to<P: Into<PathBuf>>(self, path: P) -> Self

Sets the path to which the randomly generated phrase will be written to. This field is ignored when building a wallet from the provided mnemonic phrase.

pub fn build(&self) -> Result<PrivateKeySigner, LocalSignerError>

Builds a PrivateKeySigner using the parameters set in mnemonic builder. This method expects the phrase field to be set.

pub fn build_random(&self) -> Result<PrivateKeySigner, LocalSignerError>

Builds a PrivateKeySigner using the parameters set in the mnemonic builder and constructing the phrase using the thread RNG.

pub fn build_random_with<R: Rng>( &self, rng: &mut R, ) -> Result<PrivateKeySigner, LocalSignerError>

Builds a PrivateKeySigner using the parameters set in the mnemonic builder and constructing the phrase using the provided random number generator.

Trait Implementations

impl<W: Clone + Wordlist> Clone for MnemonicBuilder<W>

fn clone(&self) -> MnemonicBuilder<W>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<W: Debug + Wordlist> Debug for MnemonicBuilder<W>

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

Formats the value using the given formatter.

impl<W: Wordlist> Default for MnemonicBuilder<W>

fn default() -> Self

Returns the “default value” for a type.

impl<W: PartialEq + Wordlist> PartialEq for MnemonicBuilder<W>

fn eq(&self, other: &MnemonicBuilder<W>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<W: Eq + Wordlist> Eq for MnemonicBuilder<W>

impl<W: Wordlist> StructuralPartialEq for MnemonicBuilder<W>