Struct NodeArgs

pub struct NodeArgs {

    pub port: u16,
    pub accounts: u64,
    pub balance: u64,
    pub timestamp: Option<u64>,
    pub mnemonic: Option<String>,
    pub mnemonic_random: Option<usize>,
    pub mnemonic_seed: Option<u64>,
    pub derivation_path: Option<String>,
    pub hardfork: Option<String>,
    pub block_time: Option<Duration>,
    pub slots_in_an_epoch: u64,
    pub config_out: Option<String>,
    pub no_mining: bool,
    pub mixed_mining: bool,
    pub host: Vec<IpAddr>,
    pub order: TransactionOrder,
    pub init: Option<Genesis>,
    pub state: Option<StateFile>,
    pub state_interval: Option<u64>,
    pub dump_state: Option<PathBuf>,
    pub preserve_historical_states: bool,
    pub load_state: Option<SerializableState>,
    pub ipc: Option<Option<String>>,
    pub prune_history: Option<Option<usize>>,
    pub max_persisted_states: Option<usize>,
    pub transaction_block_keeper: Option<usize>,
    pub evm_opts: AnvilEvmArgs,
    pub server_config: ServerConfig,
    pub cache_path: Option<PathBuf>,
}

Available on crate feature cmd only.

Fields

port: u16

Port number to listen on.

accounts: u64

Number of dev accounts to generate and configure.

balance: u64

The balance of every dev account in Ether.

timestamp: Option<u64>

The timestamp of the genesis block.

mnemonic: Option<String>

BIP39 mnemonic phrase used for generating accounts. Cannot be used if mnemonic_random or mnemonic_seed are used.

mnemonic_random: Option<usize>

Automatically generates a BIP39 mnemonic phrase, and derives accounts from it. Cannot be used with other mnemonic options. You can specify the number of words you want in the mnemonic. [default: 12]

mnemonic_seed: Option<u64>

Generates a BIP39 mnemonic phrase from a given seed Cannot be used with other mnemonic options.

CAREFUL: This is NOT SAFE and should only be used for testing. Never use the private keys generated in production.

derivation_path: Option<String>

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

[default: m/44’/60’/0’/0/]

hardfork: Option<String>

The EVM hardfork to use.

Choose the hardfork by name, e.g. shanghai, paris, london, etc… [default: latest]

block_time: Option<Duration>

Block time in seconds for interval mining.

slots_in_an_epoch: u64

Slots in an epoch

config_out: Option<String>

Writes output of anvil as json to user-specified file.

no_mining: bool

Disable auto and interval mining, and mine on demand instead.

mixed_mining: bool

host: Vec<IpAddr>

The hosts the server will listen on.

order: TransactionOrder

How transactions are sorted in the mempool.

init: Option<Genesis>

Initialize the genesis block with the given genesis.json file.

state: Option<StateFile>

This is an alias for both –load-state and –dump-state.

It initializes the chain with the state and block environment stored at the file, if it exists, and dumps the chain’s state on exit.

state_interval: Option<u64>

Interval in seconds at which the state and block environment is to be dumped to disk.

See –state and –dump-state

dump_state: Option<PathBuf>

Dump the state and block environment of chain on exit to the given file.

If the value is a directory, the state will be written to <VALUE>/state.json.

preserve_historical_states: bool

Preserve historical state snapshots when dumping the state.

This will save the in-memory states of the chain at particular block hashes.

These historical states will be loaded into the memory when --load-state / --state, and aids in RPC calls beyond the block at which state was dumped.

load_state: Option<SerializableState>

Initialize the chain from a previously saved state snapshot.

ipc: Option<Option<String>>

prune_history: Option<Option<usize>>

Don’t keep full chain history. If a number argument is specified, at most this number of states is kept in memory.

If enabled, no state will be persisted on disk, so max_persisted_states will be 0.

max_persisted_states: Option<usize>

Max number of states to persist on disk.

Note that prune_history will overwrite max_persisted_states to 0.

transaction_block_keeper: Option<usize>

Number of blocks with transactions to keep in memory.

evm_opts: AnvilEvmArgs

server_config: ServerConfig

cache_path: Option<PathBuf>

Path to the cache directory where states are stored.

Implementations

impl NodeArgs

pub fn into_node_config(self) -> Result<NodeConfig>

fn account_generator(&self) -> AccountGenerator

fn dump_state_path(&self) -> Option<PathBuf>

Returns the location where to dump the state to.

pub async fn run(self) -> Result<()>

Starts the node

See also crate::spawn()

Trait Implementations

impl Args for NodeArgs

fn group_id() -> Option<Id>

Report the [ArgGroup::id][crate::ArgGroup::id] for this set of arguments

fn augment_args<'b>(__clap_app: Command) -> Command

Append to [Command] so it can instantiate Self via [FromArgMatches::from_arg_matches_mut]

fn augment_args_for_update<'b>(__clap_app: Command) -> Command

Append to [Command] so it can instantiate self via [FromArgMatches::update_from_arg_matches_mut]

impl Clone for NodeArgs

fn clone(&self) -> NodeArgs

Returns a copy of the value.

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

Performs copy-assignment from source.

impl CommandFactory for NodeArgs

fn command<'b>() -> Command

Build a [Command] that can instantiate Self.

fn command_for_update<'b>() -> Command

Build a [Command] that can update self.

impl Debug for NodeArgs

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

Formats the value using the given formatter.

impl FromArgMatches for NodeArgs

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>

Instantiate Self from [ArgMatches], parsing the arguments as needed.

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches, ) -> Result<Self, Error>

Instantiate Self from [ArgMatches], parsing the arguments as needed.

fn update_from_arg_matches( &mut self, __clap_arg_matches: &ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

fn update_from_arg_matches_mut( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

impl Parser for NodeArgs

fn parse() -> Self

Parse from std::env::args_os(), [exit][Error::exit] on error.

fn try_parse() -> Result<Self, Error>

Parse from std::env::args_os(), return Err on error.

fn parse_from<I, T>(itr: I) -> Self

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, [exit][Error::exit] on error.

fn try_parse_from<I, T>(itr: I) -> Result<Self, Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, return Err on error.

fn update_from<I, T>(&mut self, itr: I)

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, [exit][Error::exit] on error.

fn try_update_from<I, T>(&mut self, itr: I) -> Result<(), Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, return Err on error.

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 2288 bytes