Struct ethers_signers::MnemonicBuilder

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

Represents a structure that can resolve into a Wallet<SigningKey>.

Implementations

impl<W: Wordlist> MnemonicBuilder<W>

pub fn phrase<P: Into<PathOrString>>(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.

Example

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

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

pub 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.

Example

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

let mut rng = rand::thread_rng();
let wallet = MnemonicBuilder::<English>::default()
    .word_count(24)
    .build_random(&mut rng)?;

pub fn index<U: Into<u32>>(self, index: U) -> Result<Self, WalletError>

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(self, path: &str) -> Result<Self, WalletError>

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

pub fn password(self, password: &str) -> 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<Wallet<SigningKey>, WalletError>

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

pub fn build_random<R: Rng>(
    &self,
    rng: &mut R
) -> Result<Wallet<SigningKey>, WalletError>

Builds a LocalWallet 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<MnemonicBuilder<W>> for MnemonicBuilder<W>

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

This method tests for self and other values to be equal, and is used by ==.

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

This method 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> StructuralEq for MnemonicBuilder<W>

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