Struct EvmArgs

pub struct EvmArgs {

    pub fork_url: Option<String>,
    pub fork_block_number: Option<u64>,
    pub fork_retries: Option<u32>,
    pub fork_retry_backoff: Option<u64>,
    pub no_storage_caching: bool,
    pub initial_balance: Option<U256>,
    pub sender: Option<Address>,
    pub ffi: bool,
    pub always_use_create_2_factory: bool,
    pub compute_units_per_second: Option<u64>,
    pub no_rpc_rate_limit: bool,
    pub env: EnvArgs,
    pub isolate: bool,
    pub alphanet: bool,
}

EvmArgs and EnvArgs take the highest precedence in the Config/Figment hierarchy.

All vars are opt-in, their default values are expected to be set by the [foundry_config::Config], and are always present ([foundry_config::Config::default])

Both have corresponding types in the evm_adapters crate which have mandatory fields. The expected workflow is

1. load the [foundry_config::Config]
2. merge with EvmArgs into a figment::Figment
3. extract evm_adapters::Opts from the merged Figment

Example

use foundry_config::Config;
use forge::executor::opts::EvmOpts;
use foundry_common::evm::EvmArgs;
let figment = Config::figment_with_root(".").merge(args);
let opts = figment.extract::<EvmOpts>().unwrap();

Fields

fork_url: Option<String>

Fetch state over a remote endpoint instead of starting from an empty state.

If you want to fetch state from a specific block number, see –fork-block-number.

fork_block_number: Option<u64>

Fetch state from a specific block number over a remote endpoint.

See –fork-url.

fork_retries: Option<u32>

Number of retries.

See –fork-url.

fork_retry_backoff: Option<u64>

Initial retry backoff on encountering errors.

See –fork-url.

no_storage_caching: bool

Explicitly disables the use of RPC caching.

All storage slots are read entirely from the endpoint.

This flag overrides the project’s configuration file.

See –fork-url.

initial_balance: Option<U256>

The initial balance of deployed test contracts.

sender: Option<Address>

The address which will be executing tests/scripts.

ffi: bool

Enable the FFI cheatcode.

always_use_create_2_factory: bool

Use the create 2 factory in all cases including tests and non-broadcasting scripts.

compute_units_per_second: Option<u64>

Sets the number of assumed available compute units per second for this provider

default value: 330

See also –fork-url and https://docs.alchemy.com/reference/compute-units#what-are-cups-compute-units-per-second

no_rpc_rate_limit: bool

Disables rate limiting for this node’s provider.

See also –fork-url and https://docs.alchemy.com/reference/compute-units#what-are-cups-compute-units-per-second

env: EnvArgs

All ethereum environment related arguments

isolate: bool

Whether to enable isolation of calls. In isolation mode all top-level calls are executed as a separate transaction in a separate EVM context, enabling more precise gas accounting and transaction state changes.

alphanet: bool

Whether to enable Alphanet features.

Implementations

impl EvmArgs

pub fn ensure_fork_url(&self) -> Result<&String>

Ensures that fork url exists and returns its reference.

Trait Implementations

impl Args for EvmArgs

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 EvmArgs

fn clone(&self) -> EvmArgs

Returns a copy of the value.

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

Performs copy-assignment from source.

impl CommandFactory for EvmArgs

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 EvmArgs

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

Formats the value using the given formatter.

impl Default for EvmArgs

fn default() -> EvmArgs

Returns the “default value” for a type.

impl FromArgMatches for EvmArgs

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 EvmArgs

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.

impl Provider for EvmArgs

fn metadata(&self) -> Metadata

Returns the [Metadata] for this provider, identifying itself and its configuration sources.

fn data(&self) -> Result<Map<Profile, Dict>, Error>

Returns the configuration data.

fn profile(&self) -> Option<Profile>

Optionally returns a profile to set on the Figment this provider is merged into. The profile is only set if self is merged.

impl Serialize for EvmArgs

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

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: 392 bytes