Struct CfgEnv

#[non_exhaustive]
pub struct CfgEnv {
    pub chain_id: u64,
    pub kzg_settings: EnvKzgSettings,
    pub perf_analyse_created_bytecodes: AnalysisKind,
    pub limit_contract_code_size: Option<usize>,
    pub memory_limit: u64,
    pub disable_balance_check: bool,
    pub disable_block_gas_limit: bool,
    pub disable_eip3607: bool,
    pub disable_gas_refund: bool,
    pub disable_base_fee: bool,
    pub disable_beneficiary_reward: bool,
}

EVM configuration.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

chain_id: u64

Chain ID of the EVM, it will be compared to the transaction’s Chain ID. Chain ID is introduced EIP-155

kzg_settings: EnvKzgSettings

Available on crate features c-kzg or kzg-rs only.

KZG Settings for point evaluation precompile. By default, this is loaded from the ethereum mainnet trusted setup.

perf_analyse_created_bytecodes: AnalysisKind

Bytecode that is created with CREATE/CREATE2 is by default analysed and jumptable is created. This is very beneficial for testing and speeds up execution of that bytecode if called multiple times.

Default: Analyse

limit_contract_code_size: Option<usize>

If some it will effects EIP-170: Contract code size limit. Useful to increase this because of tests. By default it is 0x6000 (~25kb).

memory_limit: u64

Available on crate feature memory_limit only.

A hard memory limit in bytes beyond which crate::result::OutOfGasError::Memory cannot be resized.

In cases where the gas limit may be extraordinarily high, it is recommended to set this to a sane value to prevent memory allocation panics. Defaults to 2^32 - 1 bytes per EIP-1985.

disable_balance_check: bool

Available on crate feature optional_balance_check only.

Skip balance checks if true. Adds transaction cost to balance to ensure execution doesn’t fail.

disable_block_gas_limit: bool

Available on crate feature optional_block_gas_limit only.

There are use cases where it’s allowed to provide a gas limit that’s higher than a block’s gas limit. To that end, you can disable the block gas limit validation. By default, it is set to false.

disable_eip3607: bool

Available on crate feature optional_eip3607 only.

EIP-3607 rejects transactions from senders with deployed code. In development, it can be desirable to simulate calls from contracts, which this setting allows. By default, it is set to false.

disable_gas_refund: bool

Available on crate feature optional_gas_refund only.

Disables all gas refunds. This is useful when using chains that have gas refunds disabled e.g. Avalanche. Reasoning behind removing gas refunds can be found in EIP-3298. By default, it is set to false.

disable_base_fee: bool

Available on crate feature optional_no_base_fee only.

Disables base fee checks for EIP-1559 transactions. This is useful for testing method calls with zero gas price. By default, it is set to false.

disable_beneficiary_reward: bool

Available on crate feature optional_beneficiary_reward only.

Disables the payout of the reward to the beneficiary. By default, it is set to false.

Implementations

impl CfgEnv

pub fn max_code_size(&self) -> usize

Returns max code size from Self::limit_contract_code_size if set or default MAX_CODE_SIZE value.

pub fn with_chain_id(self, chain_id: u64) -> CfgEnv

pub fn is_eip3607_disabled(&self) -> bool

Available on crate feature optional_eip3607 only.

pub fn is_balance_check_disabled(&self) -> bool

Available on crate feature optional_balance_check only.

pub fn is_gas_refund_disabled(&self) -> bool

Available on crate feature optional_gas_refund only.

pub fn is_base_fee_check_disabled(&self) -> bool

Available on crate feature optional_no_base_fee only.

pub fn is_block_gas_limit_disabled(&self) -> bool

Available on crate feature optional_block_gas_limit only.

pub fn is_beneficiary_reward_disabled(&self) -> bool

Available on crate feature optional_beneficiary_reward only.

Trait Implementations

impl Clone for CfgEnv

fn clone(&self) -> CfgEnv

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CfgEnv

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

Formats the value using the given formatter.

impl Default for CfgEnv

fn default() -> CfgEnv

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for CfgEnv

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for CfgEnv

fn eq(&self, other: &CfgEnv) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for CfgEnv

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.

impl Eq for CfgEnv

impl StructuralPartialEq for CfgEnv

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