Trait ConfigureEvmEnv

pub trait ConfigureEvmEnv:
    Send
    + Sync
    + Unpin
    + Clone
    + 'static {
    type Header: BlockHeader;
    type Transaction;
    type Error: Error + Send + Sync;

    // Required methods
    fn fill_tx_env(
        &self,
        tx_env: &mut TxEnv,
        transaction: &Self::Transaction,
        sender: Address,
    );
    fn fill_tx_env_system_contract_call(
        &self,
        env: &mut Env,
        caller: Address,
        contract: Address,
        data: Bytes,
    );
    fn fill_cfg_env(
        &self,
        cfg_env: &mut CfgEnvWithHandlerCfg,
        header: &Self::Header,
    );
    fn next_cfg_and_block_env(
        &self,
        parent: &Self::Header,
        attributes: NextBlockEnvAttributes,
    ) -> Result<EvmEnv, Self::Error>;

    // Provided methods
    fn tx_env(&self, transaction: &Self::Transaction, signer: Address) -> TxEnv { ... }
    fn cfg_env(&self, header: &Self::Header) -> CfgEnvWithHandlerCfg { ... }
    fn fill_block_env(
        &self,
        block_env: &mut BlockEnv,
        header: &Self::Header,
        after_merge: bool,
    ) { ... }
    fn cfg_and_block_env(&self, header: &Self::Header) -> EvmEnv { ... }
    fn fill_cfg_and_block_env(
        &self,
        cfg: &mut CfgEnvWithHandlerCfg,
        block_env: &mut BlockEnv,
        header: &Self::Header,
    ) { ... }
}

Traits and helper types used to abstract over EVM methods and types. This represents the set of methods used to configure the EVM’s environment before block execution.

Default trait method implementation is done w.r.t. L1.

Required Associated Types

type Header: BlockHeader

The header type used by the EVM.

type Transaction

The transaction type.

type Error: Error + Send + Sync

The error type that is returned by Self::next_cfg_and_block_env.

Required Methods

fn fill_tx_env( &self, tx_env: &mut TxEnv, transaction: &Self::Transaction, sender: Address, )

Fill transaction environment from a transaction and the given sender address.

fn fill_tx_env_system_contract_call( &self, env: &mut Env, caller: Address, contract: Address, data: Bytes, )

Fill transaction environment with a system contract call.

fn fill_cfg_env( &self, cfg_env: &mut CfgEnvWithHandlerCfg, header: &Self::Header, )

Fill [CfgEnvWithHandlerCfg] fields according to the chain spec and given header.

This must set the corresponding spec id in the handler cfg, based on timestamp or total difficulty

fn next_cfg_and_block_env( &self, parent: &Self::Header, attributes: NextBlockEnvAttributes, ) -> Result<EvmEnv, Self::Error>

Returns the configured [EvmEnv] for parent + 1 block.

This is intended for usage in block building after the merge and requires additional attributes that can’t be derived from the parent block: attributes that are determined by the CL, such as the timestamp, suggested fee recipient, and randomness value.

Provided Methods

fn tx_env(&self, transaction: &Self::Transaction, signer: Address) -> TxEnv

Returns a [TxEnv] from a transaction and [Address].

fn cfg_env(&self, header: &Self::Header) -> CfgEnvWithHandlerCfg

Returns a [CfgEnvWithHandlerCfg] for the given header.

fn fill_block_env( &self, block_env: &mut BlockEnv, header: &Self::Header, after_merge: bool, )

Fill [BlockEnv] field according to the chain spec and given header

fn cfg_and_block_env(&self, header: &Self::Header) -> EvmEnv

Creates a new [EvmEnv] for the given header.

fn fill_cfg_and_block_env( &self, cfg: &mut CfgEnvWithHandlerCfg, block_env: &mut BlockEnv, header: &Self::Header, )

Convenience function to call both fill_cfg_env and ConfigureEvmEnv::fill_block_env.

Note: Implementers should ensure that all fields are required fields are filled.

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementations on Foreign Types

impl<'a, T> ConfigureEvmEnv for &'a T

where T: 'a + ConfigureEvmEnv + ?Sized, &'a T: Send + Sync + Unpin + Clone + 'static,

type Header = <T as ConfigureEvmEnv>::Header

type Transaction = <T as ConfigureEvmEnv>::Transaction

type Error = <T as ConfigureEvmEnv>::Error

fn tx_env( &self, transaction: &<&'a T as ConfigureEvmEnv>::Transaction, signer: Address, ) -> TxEnv

fn fill_tx_env( &self, tx_env: &mut TxEnv, transaction: &<&'a T as ConfigureEvmEnv>::Transaction, sender: Address, )

fn fill_tx_env_system_contract_call( &self, env: &mut Env, caller: Address, contract: Address, data: Bytes, )

fn cfg_env( &self, header: &<&'a T as ConfigureEvmEnv>::Header, ) -> CfgEnvWithHandlerCfg

fn fill_cfg_env( &self, cfg_env: &mut CfgEnvWithHandlerCfg, header: &<&'a T as ConfigureEvmEnv>::Header, )

fn fill_block_env( &self, block_env: &mut BlockEnv, header: &<&'a T as ConfigureEvmEnv>::Header, after_merge: bool, )

fn cfg_and_block_env( &self, header: &<&'a T as ConfigureEvmEnv>::Header, ) -> EvmEnv

fn fill_cfg_and_block_env( &self, cfg: &mut CfgEnvWithHandlerCfg, block_env: &mut BlockEnv, header: &<&'a T as ConfigureEvmEnv>::Header, )

fn next_cfg_and_block_env( &self, parent: &<&'a T as ConfigureEvmEnv>::Header, attributes: NextBlockEnvAttributes, ) -> Result<EvmEnv, <&'a T as ConfigureEvmEnv>::Error>

impl<T> ConfigureEvmEnv for Arc<T>

where T: ConfigureEvmEnv + ?Sized, Arc<T>: Send + Sync + Unpin + Clone + 'static,

type Header = <T as ConfigureEvmEnv>::Header

type Transaction = <T as ConfigureEvmEnv>::Transaction

type Error = <T as ConfigureEvmEnv>::Error

fn tx_env( &self, transaction: &<Arc<T> as ConfigureEvmEnv>::Transaction, signer: Address, ) -> TxEnv

fn fill_tx_env( &self, tx_env: &mut TxEnv, transaction: &<Arc<T> as ConfigureEvmEnv>::Transaction, sender: Address, )

fn fill_tx_env_system_contract_call( &self, env: &mut Env, caller: Address, contract: Address, data: Bytes, )

fn cfg_env( &self, header: &<Arc<T> as ConfigureEvmEnv>::Header, ) -> CfgEnvWithHandlerCfg

fn fill_cfg_env( &self, cfg_env: &mut CfgEnvWithHandlerCfg, header: &<Arc<T> as ConfigureEvmEnv>::Header, )

fn fill_block_env( &self, block_env: &mut BlockEnv, header: &<Arc<T> as ConfigureEvmEnv>::Header, after_merge: bool, )

fn cfg_and_block_env( &self, header: &<Arc<T> as ConfigureEvmEnv>::Header, ) -> EvmEnv

fn fill_cfg_and_block_env( &self, cfg: &mut CfgEnvWithHandlerCfg, block_env: &mut BlockEnv, header: &<Arc<T> as ConfigureEvmEnv>::Header, )

fn next_cfg_and_block_env( &self, parent: &<Arc<T> as ConfigureEvmEnv>::Header, attributes: NextBlockEnvAttributes, ) -> Result<EvmEnv, <Arc<T> as ConfigureEvmEnv>::Error>

Implementors