Struct EvmOpts

pub struct EvmOpts {

    pub env: Env,
    pub fork_url: Option<String>,
    pub fork_block_number: Option<u64>,
    pub fork_retries: Option<u32>,
    pub fork_retry_backoff: Option<u64>,
    pub fork_headers: Option<Vec<String>>,
    pub compute_units_per_second: Option<u64>,
    pub no_rpc_rate_limit: bool,
    pub no_storage_caching: bool,
    pub initial_balance: Uint<256, 4>,
    pub sender: Address,
    pub ffi: bool,
    pub always_use_create_2_factory: bool,
    pub verbosity: u8,
    pub memory_limit: u64,
    pub isolate: bool,
    pub disable_block_gas_limit: bool,
    pub odyssey: bool,
    pub create2_deployer: Address,
}

Fields

env: Env

The EVM environment configuration.

fork_url: Option<String>

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

fork_block_number: Option<u64>

Pins the block number for the state fork.

fork_retries: Option<u32>

The number of retries.

fork_retry_backoff: Option<u64>

Initial retry backoff.

fork_headers: Option<Vec<String>>

Headers to use with fork_url

compute_units_per_second: Option<u64>

The available compute units per second.

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

no_rpc_rate_limit: bool

Disables RPC rate limiting entirely.

no_storage_caching: bool

Disables storage caching entirely.

initial_balance: Uint<256, 4>

The initial balance of each deployed test contract.

sender: Address

The address which will be executing all tests.

ffi: bool

Enables the FFI cheatcode.

always_use_create_2_factory: bool

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

verbosity: u8

Verbosity mode of EVM output as number of occurrences.

memory_limit: u64

The memory limit per EVM execution in bytes. If this limit is exceeded, a MemoryLimitOOG result is thrown.

isolate: bool

Whether to enable isolation of calls.

disable_block_gas_limit: bool

Whether to disable block gas limit checks.

odyssey: bool

whether to enable Odyssey features.

create2_deployer: Address

The CREATE2 deployer’s address.

Implementations

impl EvmOpts

pub async fn evm_env(&self) -> Result<Env, Report>

Configures a new revm::Env

If a fork_url is set, it gets configured with settings fetched from the endpoint (chain id, )

pub async fn fork_evm_env( &self, fork_url: &str, ) -> Result<(Env, WithOtherFields<Block<WithOtherFields<Transaction<AnyTxEnvelope>>, Header<AnyHeader>>>), Report>

Returns the revm::Env that is configured with settings retrieved from the endpoint. And the block that was used to configure the environment.

pub fn local_evm_env(&self) -> Env

Returns the revm::Env configured with only local settings

pub fn get_fork(&self, config: &Config, env: Env) -> Option<CreateFork>

Helper function that returns the CreateFork to use, if any.

storage caching for the CreateFork will be enabled if

• fork_url is present
• fork_block_number is present
• StorageCachingConfig allows the fork_url + chain ID pair
• storage is allowed (no_storage_caching = false)

If all these criteria are met, then storage caching is enabled and storage info will be written to <Config::foundry_cache_dir()>/<str(chainid)>/<block>/storage.json.

for mainnet and --fork-block-number 14435000 on mac the corresponding storage cache will be at ~/.foundry/cache/mainnet/14435000/storage.json.

pub fn gas_limit(&self) -> u64

Returns the gas limit to use

pub async fn get_chain_id(&self) -> u64

Returns the configured chain id, which will be

• the value of chain_id if set
• mainnet if fork_url contains “mainnet”
• the chain if fork_url is set and the endpoints returned its chain id successfully
• mainnet otherwise

pub fn get_compute_units_per_second(&self) -> u64

Returns the available compute units per second, which will be

• u64::MAX, if no_rpc_rate_limit if set (as rate limiting is disabled)
• the assigned compute units, if compute_units_per_second is set
• ALCHEMY_FREE_TIER_CUPS (330) otherwise

pub async fn get_remote_chain_id(&self) -> Option<Chain>

Returns the chain ID from the RPC, if any.

Trait Implementations

impl Clone for EvmOpts

fn clone(&self) -> EvmOpts

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for EvmOpts

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

Formats the value using the given formatter.

impl Default for EvmOpts

fn default() -> EvmOpts

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for EvmOpts

fn deserialize<__D>( __deserializer: __D, ) -> Result<EvmOpts, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for EvmOpts

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::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: 368 bytes