Struct TracingInspector

pub struct TracingInspector {
    config: TracingInspectorConfig,
    traces: CallTraceArena,
    trace_stack: Vec<usize>,
    step_stack: Vec<StackStep>,
    last_call_return_data: Option<Bytes>,
    spec_id: Option<SpecId>,
}

An inspector that collects call traces.

This [Inspector] can be hooked into revm’s EVM which then calls the inspector functions, such as [Inspector::call] or [Inspector::call_end].

The TracingInspector keeps track of everything by:

1. start tracking steps/calls on [Inspector::step] and [Inspector::call]
2. complete steps/calls on [Inspector::step_end] and [Inspector::call_end]

Fields

config: TracingInspectorConfig

traces: CallTraceArena

trace_stack: Vec<usize>

step_stack: Vec<StackStep>

last_call_return_data: Option<Bytes>

spec_id: Option<SpecId>

Implementations

impl TracingInspector

pub fn new(config: TracingInspectorConfig) -> TracingInspector

Returns a new instance for the given config

pub fn fuse(&mut self)

Resets the inspector to its initial state of Self::new. This makes the inspector ready to be used again.

Note that this method has no effect on the allocated capacity of the vector.

pub fn fused(self) -> TracingInspector

Resets the inspector to it’s initial state of Self::new.

pub const fn config(&self) -> &TracingInspectorConfig

Returns the config of the inspector.

pub fn config_mut(&mut self) -> &mut TracingInspectorConfig

Returns a mutable reference to the config of the inspector.

pub fn update_config( &mut self, f: impl FnOnce(TracingInspectorConfig) -> TracingInspectorConfig, )

Updates the config of the inspector.

pub const fn traces(&self) -> &CallTraceArena

Gets a reference to the recorded call traces.

pub fn traces_mut(&mut self) -> &mut CallTraceArena

Gets a mutable reference to the recorded call traces.

pub fn into_traces(self) -> CallTraceArena

Consumes the inspector and returns the recorded call traces.

pub fn set_transaction_gas_used(&mut self, gas_used: u64)

Manually set the gas used of the root trace.

This is useful if the root trace’s gasUsed should mirror the actual gas used by the transaction.

This allows setting it manually by consuming the execution result’s gas for example.

pub fn set_transaction_gas_limit(&mut self, gas_limit: u64)

Manually set the gas limit of the debug root trace.

This is useful if the debug root trace’s gasUsed should mirror the actual gas used by the transaction.

This allows setting it manually by consuming the execution result’s gas for example.

pub fn with_transaction_gas_used(self, gas_used: u64) -> TracingInspector

Convenience function for [ParityTraceBuilder::set_transaction_gas_used] that consumes the type.

pub fn with_transaction_gas_limit(self, gas_limit: u64) -> TracingInspector

Work with TracingInspector::set_transaction_gas_limit function

pub fn into_parity_builder(self) -> ParityTraceBuilder

Consumes the Inspector and returns a [ParityTraceBuilder].

pub fn into_geth_builder(self) -> GethTraceBuilder<'static>

Consumes the Inspector and returns a [GethTraceBuilder].

pub fn geth_builder(&self) -> GethTraceBuilder<'_>

Returns the [GethTraceBuilder] for the recorded traces without consuming the type.

This can be useful for multiple transaction tracing (block) where this inspector can be reused for each transaction but caller must ensure that the traces are cleared before starting a new transaction: Self::fuse

Trait Implementations

impl Clone for TracingInspector

fn clone(&self) -> TracingInspector

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TracingInspector

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

Formats the value using the given formatter.

impl Default for TracingInspector

fn default() -> TracingInspector

Returns the “default value” for a type.

impl<DB> Inspector<DB> for TracingInspector

where DB: Database,

fn step(&mut self, interp: &mut Interpreter, context: &mut EvmContext<DB>)

Called on each step of the interpreter.

fn step_end(&mut self, interp: &mut Interpreter, context: &mut EvmContext<DB>)

Called after step when the instruction has been executed.

fn log( &mut self, _interp: &mut Interpreter, _context: &mut EvmContext<DB>, log: &Log, )

Called when a log is emitted.

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

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

fn call_end( &mut self, context: &mut EvmContext<DB>, _inputs: &CallInputs, outcome: CallOutcome, ) -> CallOutcome

Called when a call to a contract has concluded.

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

Called when a contract is about to be created.

fn create_end( &mut self, context: &mut EvmContext<DB>, _inputs: &CreateInputs, outcome: CreateOutcome, ) -> CreateOutcome

Called when a contract has been created.

fn eofcreate( &mut self, context: &mut EvmContext<DB>, inputs: &mut EOFCreateInputs, ) -> Option<CreateOutcome>

Called when EOF creating is called.

fn eofcreate_end( &mut self, context: &mut EvmContext<DB>, _inputs: &EOFCreateInputs, outcome: CreateOutcome, ) -> CreateOutcome

Called when eof creating has ended.

fn selfdestruct( &mut self, contract: Address, target: Address, value: Uint<256, 4>, )

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

fn initialize_interp( &mut self, interp: &mut Interpreter, context: &mut EvmContext<DB>, )

Called before the interpreter is initialized.

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