Struct InspectorStack

pub struct InspectorStack {
    pub cheatcodes: Option<Cheatcodes>,
    pub inner: InspectorStackInner,
}

An inspector that calls multiple inspectors in sequence.

If a call to an inspector returns a value other than [InstructionResult::Continue] (or equivalent) the remaining inspectors are not called.

Stack is divided into Cheatcodes and InspectorStackInner. This is done to allow assembling InspectorStackRefMut inside Cheatcodes to allow usage of it as [revm::Inspector]. This gives us ability to create and execute separate EVM frames from inside cheatcodes while still having access to entire stack of inspectors and correctly handling traces, logs, debugging info collection, etc.

Fields

cheatcodes: Option<Cheatcodes>

inner: InspectorStackInner

Implementations

impl InspectorStack

pub fn new() -> Self

Creates a new inspector stack.

Note that the stack is empty by default, and you must add inspectors to it. This is done by calling the set_* methods on the stack directly, or by building the stack with InspectorStack.

pub fn log_status(&self)

Logs the status of the inspectors.

pub fn set_env(&mut self, env: &Env)

Set variables from an environment for the relevant inspectors.

pub fn set_block(&mut self, block: &BlockEnv)

Sets the block for the relevant inspectors.

pub fn set_gas_price(&mut self, gas_price: U256)

Sets the gas price for the relevant inspectors.

pub fn set_cheatcodes(&mut self, cheatcodes: Cheatcodes)

Set the cheatcodes inspector.

pub fn set_fuzzer(&mut self, fuzzer: Fuzzer)

Set the fuzzer inspector.

pub fn set_chisel(&mut self, final_pc: usize)

Set the Chisel inspector.

pub fn collect_coverage(&mut self, yes: bool)

Set whether to enable the coverage collector.

pub fn enable_isolation(&mut self, yes: bool)

Set whether to enable call isolation.

pub fn odyssey(&mut self, yes: bool)

Set whether to enable call isolation.

pub fn set_create2_deployer(&mut self, deployer: Address)

Set the CREATE2 deployer address.

pub fn collect_logs(&mut self, yes: bool)

Set whether to enable the log collector.

pub fn print(&mut self, yes: bool)

Set whether to enable the trace printer.

pub fn tracing(&mut self, mode: TraceMode)

Set whether to enable the tracer.

pub fn collect(self) -> InspectorData

Collects all the data gathered during inspection into a single struct.

fn as_mut(&mut self) -> InspectorStackRefMut<'_>

Trait Implementations

impl Clone for InspectorStack

fn clone(&self) -> InspectorStack

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for InspectorStack

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

Formats the value using the given formatter.

impl Default for InspectorStack

fn default() -> InspectorStack

Returns the “default value” for a type.

impl Deref for InspectorStack

type Target = InspectorStackInner

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl DerefMut for InspectorStack

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl Inspector<&mut dyn DatabaseExt<Error = DatabaseError>> for InspectorStack

fn step( &mut self, interpreter: &mut Interpreter, ecx: &mut EvmContext<&mut dyn DatabaseExt>, )

Called on each step of the interpreter.

fn step_end( &mut self, interpreter: &mut Interpreter, ecx: &mut EvmContext<&mut dyn DatabaseExt>, )

Called after step when the instruction has been executed.

fn call( &mut self, context: &mut EvmContext<&mut dyn DatabaseExt>, inputs: &mut CallInputs, ) -> Option<CallOutcome>

Called whenever a call to a contract is about to start.

fn call_end( &mut self, context: &mut EvmContext<&mut dyn DatabaseExt>, inputs: &CallInputs, outcome: CallOutcome, ) -> CallOutcome

Called when a call to a contract has concluded.

fn create( &mut self, context: &mut EvmContext<&mut dyn DatabaseExt>, create: &mut CreateInputs, ) -> Option<CreateOutcome>

Called when a contract is about to be created.

fn create_end( &mut self, context: &mut EvmContext<&mut dyn DatabaseExt>, call: &CreateInputs, outcome: CreateOutcome, ) -> CreateOutcome

Called when a contract has been created.

fn eofcreate( &mut self, context: &mut EvmContext<&mut dyn DatabaseExt>, create: &mut EOFCreateInputs, ) -> Option<CreateOutcome>

Called when EOF creating is called.

fn eofcreate_end( &mut self, context: &mut EvmContext<&mut dyn DatabaseExt>, call: &EOFCreateInputs, outcome: CreateOutcome, ) -> CreateOutcome

Called when eof creating has ended.

fn initialize_interp( &mut self, interpreter: &mut Interpreter, ecx: &mut EvmContext<&mut dyn DatabaseExt>, )

Called before the interpreter is initialized.

fn log( &mut self, interpreter: &mut Interpreter, ecx: &mut EvmContext<&mut dyn DatabaseExt>, log: &Log, )

Called when a log is emitted.

fn selfdestruct(&mut self, contract: Address, target: Address, value: U256)

Called when a contract has been self-destructed with funds transferred to target.

impl InspectorExt for InspectorStack

fn should_use_create2_factory( &mut self, ecx: &mut EvmContext<&mut dyn DatabaseExt>, inputs: &mut CreateInputs, ) -> bool

Determines whether the DEFAULT_CREATE2_DEPLOYER should be used for a CREATE2 frame.

fn is_odyssey(&self) -> bool

Returns true if the current network is Odyssey.

fn create2_deployer(&self) -> Address

Returns the CREATE2 deployer address.

fn console_log(&mut self, _input: String)

Simulates console.log invocation.

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