Struct ethers::signers::MnemonicBuilder[][src]

pub struct MnemonicBuilder<W> where
    W: Wordlist
{ /* fields omitted */ }
Expand description

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

Implementations

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()?;

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)?;

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}”.

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

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

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.

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

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

Trait Implementations

Returns a copy of the value. Read more

Performs copy-assignment from source. Read more

Formats the value using the given formatter. Read more

Returns the “default value” for a type. Read more

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

This method tests for !=.

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

Performs the conversion.

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

Performs the conversion.

Should always be Self

The resulting type after obtaining ownership.

Creates owned data from borrowed data, usually by cloning. Read more

🔬 This is a nightly-only experimental API. (toowned_clone_into)

Uses borrowed data to replace owned data, usually by cloning. Read more

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more