Struct EvmBuilder

pub struct EvmBuilder<'a, BuilderStage, EXT, DB: Database> { /* private fields */ }

Evm Builder allows building or modifying EVM. Note that some of the methods that changes underlying structures will reset the registered handler to default mainnet.

Implementations

impl<'a, EXT, DB: Database> EvmBuilder<'a, SetGenericStage, EXT, DB>

pub fn with_empty_db(self) -> EvmBuilder<'a, SetGenericStage, EXT, EmptyDB>

Sets the EmptyDB as the Database that will be used by Evm.

pub fn with_db<ODB: Database>( self, db: ODB, ) -> EvmBuilder<'a, SetGenericStage, EXT, ODB>

Sets the Database that will be used by Evm.

pub fn with_ref_db<ODB: DatabaseRef>( self, db: ODB, ) -> EvmBuilder<'a, SetGenericStage, EXT, WrapDatabaseRef<ODB>>

Sets the DatabaseRef that will be used by Evm.

pub fn with_external_context<OEXT>( self, external: OEXT, ) -> EvmBuilder<'a, SetGenericStage, OEXT, DB>

Sets the external context that will be used by Evm.

pub fn with_env_with_handler_cfg( self, env_with_handler_cfg: EnvWithHandlerCfg, ) -> EvmBuilder<'a, HandlerStage, EXT, DB>

Sets Builder with EnvWithHandlerCfg.

pub fn with_context_with_handler_cfg<OEXT, ODB: Database>( self, context_with_handler_cfg: ContextWithHandlerCfg<OEXT, ODB>, ) -> EvmBuilder<'a, HandlerStage, OEXT, ODB>

Sets Builder with ContextWithHandlerCfg.

pub fn with_cfg_env_with_handler_cfg( self, cfg_env_and_spec_id: CfgEnvWithHandlerCfg, ) -> EvmBuilder<'a, HandlerStage, EXT, DB>

Sets Builder with CfgEnvWithHandlerCfg.

pub fn with_handler_cfg( self, handler_cfg: HandlerCfg, ) -> EvmBuilder<'a, HandlerStage, EXT, DB>

Sets Builder with HandlerCfg

pub fn optimism(self) -> EvmBuilder<'a, HandlerStage, EXT, DB>

Sets the Optimism handler with latest spec.

If optimism-default-handler feature is enabled this is not needed.

pub fn mainnet(self) -> EvmBuilder<'a, HandlerStage, EXT, DB>

Sets the mainnet handler with latest spec.

Enabled only with optimism-default-handler feature.

impl<'a, EXT, DB: Database> EvmBuilder<'a, HandlerStage, EXT, DB>

pub fn new(evm: Evm<'a, EXT, DB>) -> Self

Creates new builder from Evm, Evm is consumed and all field are moved to Builder. It will preserve set handler and context.

Builder is in HandlerStage and both database and external are set.

pub fn reset_handler_with_empty_db( self, ) -> EvmBuilder<'a, HandlerStage, EXT, EmptyDB>

Sets the EmptyDB and resets the Handler to default mainnet.

pub fn reset_handler_with_mainnet(self) -> EvmBuilder<'a, HandlerStage, EXT, DB>

Resets the Handler and sets base mainnet handler.

Enabled only with optimism-default-handler feature.

pub fn reset_handler_with_db<ODB: Database>( self, db: ODB, ) -> EvmBuilder<'a, SetGenericStage, EXT, ODB>

Sets the Database that will be used by Evm and resets the Handler to default mainnet.

pub fn reset_handler_with_ref_db<ODB: DatabaseRef>( self, db: ODB, ) -> EvmBuilder<'a, SetGenericStage, EXT, WrapDatabaseRef<ODB>>

Resets Handler and sets the DatabaseRef that will be used by Evm and resets the Handler to default mainnet.

pub fn reset_handler_with_external_context<OEXT>( self, external: OEXT, ) -> EvmBuilder<'a, SetGenericStage, OEXT, DB>

Resets Handler and sets new ExternalContext type. and resets the Handler to default mainnet.

impl<'a, BuilderStage, EXT, DB: Database> EvmBuilder<'a, BuilderStage, EXT, DB>

pub fn with_handler( self, handler: Handler<'a, Context<EXT, DB>, EXT, DB>, ) -> EvmBuilder<'a, BuilderStage, EXT, DB>

This modifies the EvmBuilder to make it easy to construct an Evm with a specific handler.

Example

use revm::{EvmBuilder, Handler, primitives::{SpecId, HandlerCfg}};
use revm_interpreter::primitives::CancunSpec;
let builder = EvmBuilder::default();

// get the desired handler
let mainnet = Handler::mainnet::<CancunSpec>();
let builder = builder.with_handler(mainnet);

// build the EVM
let evm = builder.build();

pub fn build(self) -> Evm<'a, EXT, DB>

Builds the Evm.

pub fn append_handler_register( self, handle_register: HandleRegister<EXT, DB>, ) -> EvmBuilder<'a, HandlerStage, EXT, DB>

Register Handler that modifies the behavior of EVM. Check Handler for more information.

When called, EvmBuilder will transition from SetGenericStage to HandlerStage.

pub fn append_handler_register_box( self, handle_register: HandleRegisterBox<'a, EXT, DB>, ) -> EvmBuilder<'a, HandlerStage, EXT, DB>

Register Handler that modifies the behavior of EVM. Check Handler for more information.

When called, EvmBuilder will transition from SetGenericStage to HandlerStage.

pub fn with_spec_id(self, spec_id: SpecId) -> Self

Sets specification Id , that will mark the version of EVM. It represent the hard fork of ethereum.

Note

When changed it will reapply all handle registers, this can be expensive operation depending on registers.

pub fn modify_db(self, f: impl FnOnce(&mut DB)) -> Self

Allows modification of Evm Database.

pub fn modify_external_context(self, f: impl FnOnce(&mut EXT)) -> Self

Allows modification of external context.

pub fn modify_env(self, f: impl FnOnce(&mut Box<Env>)) -> Self

Allows modification of Evm Environment.

pub fn with_env(self, env: Box<Env>) -> Self

Sets Evm Environment.

pub fn modify_tx_env(self, f: impl FnOnce(&mut TxEnv)) -> Self

Allows modification of Evm’s Transaction Environment.

pub fn with_tx_env(self, tx_env: TxEnv) -> Self

Sets Evm’s Transaction Environment.

pub fn modify_block_env(self, f: impl FnOnce(&mut BlockEnv)) -> Self

Allows modification of Evm’s Block Environment.

pub fn with_block_env(self, block_env: BlockEnv) -> Self

Sets Evm’s Block Environment.

pub fn modify_cfg_env(self, f: impl FnOnce(&mut CfgEnv)) -> Self

Allows modification of Evm’s Config Environment.

pub fn with_clear_env(self) -> Self

Clears Environment of EVM.

pub fn with_clear_tx_env(self) -> Self

Clears Transaction environment of EVM.

pub fn with_clear_block_env(self) -> Self

Clears Block environment of EVM.

pub fn reset_handler(self) -> Self

Resets Handler to default mainnet.

Trait Implementations

impl<'a> Default for EvmBuilder<'a, SetGenericStage, (), EmptyDB>

fn default() -> Self

Returns the “default value” for a type.