Struct TracingInspectorConfig

pub struct TracingInspectorConfig {
    pub record_steps: bool,
    pub record_memory_snapshots: bool,
    pub record_stack_snapshots: StackSnapshotType,
    pub record_state_diff: bool,
    pub record_returndata_snapshots: bool,
    pub record_opcodes_filter: Option<OpcodeFilter>,
    pub exclude_precompile_calls: bool,
    pub record_logs: bool,
    pub record_immediate_bytes: bool,
}

Gives guidance to the TracingInspector.

Use TracingInspectorConfig::default_parity or TracingInspectorConfig::default_geth to get the default configs for specific styles of traces.

Fields

record_steps: bool

Whether to record every individual opcode level step.

record_memory_snapshots: bool

Whether to record individual memory snapshots.

record_stack_snapshots: StackSnapshotType

Whether to record individual stack snapshots.

record_state_diff: bool

Whether to record state diffs.

record_returndata_snapshots: bool

Whether to record returndata buffer snapshots.

record_opcodes_filter: Option<OpcodeFilter>

Optional filter for opcodes to record. If provided, only steps with opcode in this set will be recorded.

exclude_precompile_calls: bool

Whether to ignore precompile calls.

record_logs: bool

Whether to record logs

record_immediate_bytes: bool

Whether to record immediate bytes for opcodes.

Implementations

impl TracingInspectorConfig

pub const fn all() -> TracingInspectorConfig

Returns a config with everything enabled.

pub const fn none() -> TracingInspectorConfig

Returns a config with everything disabled.

pub const fn default_parity() -> TracingInspectorConfig

Returns a config for parity style traces.

This config does not record opcode level traces and is suited for trace_transaction

pub const fn default_geth() -> TracingInspectorConfig

Returns a config for geth style traces.

This config does not record opcode level traces and is suited for debug_traceTransaction

This will configure the default output of geth’s default StructLogTracer.

pub fn from_parity_config( trace_types: &HashSet<TraceType, RandomState>, ) -> TracingInspectorConfig

Returns the TracingInspectorConfig depending on the enabled [TraceType]s

Note: the parity statediffs can be populated entirely via the execution result, so we don’t need statediff recording

pub fn from_geth_config( config: &GethDefaultTracingOptions, ) -> TracingInspectorConfig

Returns a config for geth style traces based on the given [GethDefaultTracingOptions].

This will configure the output of geth’s default StructLogTracer according to the given config.

pub fn from_geth_call_config(config: &CallConfig) -> TracingInspectorConfig

Returns a config for geth’s CallTracer.

This returns Self::none and enables TracingInspectorConfig::record_logs if configured in the given [CallConfig]

pub fn from_flat_call_config(config: &FlatCallConfig) -> TracingInspectorConfig

Returns a config for geth’s FlatCallTracer.

This returns Self::default_parity and sets TracingInspectorConfig::exclude_precompile_calls if configured in the given [FlatCallConfig]

pub const fn from_geth_prestate_config( _config: &PreStateConfig, ) -> TracingInspectorConfig

Returns a config for geth’s PrestateTracer.

Note: This currently returns Self::none because the prestate tracer result currently relies on the execution result entirely, see GethTraceBuilder::geth_prestate_traces

pub fn merge( &mut self, other: TracingInspectorConfig, ) -> &mut TracingInspectorConfig

Merge another config into this one.

pub const fn set_exclude_precompile_calls( self, exclude_precompile_calls: bool, ) -> TracingInspectorConfig

Configure whether calls to precompiles should be ignored.

If set to true, calls to precompiles without value transfers will be ignored.

pub const fn disable_steps(self) -> TracingInspectorConfig

Disable recording of individual opcode level steps

pub const fn steps(self) -> TracingInspectorConfig

Enable recording of individual opcode level steps

pub const fn set_steps(self, record_steps: bool) -> TracingInspectorConfig

Configure whether individual opcode level steps should be recorded

pub const fn disable_memory_snapshots(self) -> TracingInspectorConfig

Disable recording of individual memory snapshots

pub const fn memory_snapshots(self) -> TracingInspectorConfig

Enable recording of individual memory snapshots

pub const fn set_memory_snapshots( self, record_memory_snapshots: bool, ) -> TracingInspectorConfig

Configure whether the tracer should record memory snapshots

pub const fn disable_stack_snapshots(self) -> TracingInspectorConfig

Disable recording of individual stack snapshots

pub const fn stack_snapshots(self) -> TracingInspectorConfig

Enable recording of individual stack snapshots

pub const fn set_stack_snapshots( self, record_stack_snapshots: StackSnapshotType, ) -> TracingInspectorConfig

Configure how the tracer should record stack snapshots

pub const fn disable_state_diffs(self) -> TracingInspectorConfig

Disable recording of state diffs

pub const fn set_state_diffs( self, record_state_diff: bool, ) -> TracingInspectorConfig

Configure whether the tracer should record state diffs

pub const fn with_state_diffs(self) -> TracingInspectorConfig

Sets state diff recording to true.

Also enables steps recording since state diff recording requires steps recording.

pub const fn set_steps_and_state_diffs( self, steps_and_diffs: bool, ) -> TracingInspectorConfig

Configure whether the tracer should record steps and state diffs.

This is a convenience method for setting both TracingInspectorConfig::set_steps and TracingInspectorConfig::set_state_diffs since tracking state diffs requires steps tracing.

pub const fn disable_record_logs(self) -> TracingInspectorConfig

Disable recording of individual logs

pub const fn record_logs(self) -> TracingInspectorConfig

Enable recording of individual logs

pub const fn set_record_logs(self, record_logs: bool) -> TracingInspectorConfig

Configure whether the tracer should record logs

pub const fn set_immediate_bytes( self, record_immediate_bytes: bool, ) -> TracingInspectorConfig

Configure whether the tracer should record immediate bytes

pub const fn record_immediate_bytes(self) -> TracingInspectorConfig

Enable recording of immediate bytes

pub fn should_record_opcode(&self, op: OpCode) -> bool

If [OpcodeFilter] is configured, returns whether the given opcode should be recorded. Otherwise, always returns true.

Trait Implementations

impl Clone for TracingInspectorConfig

fn clone(&self) -> TracingInspectorConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TracingInspectorConfig

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

Formats the value using the given formatter.

impl Default for TracingInspectorConfig

fn default() -> TracingInspectorConfig

Returns the “default value” for a type.

impl PartialEq for TracingInspectorConfig

fn eq(&self, other: &TracingInspectorConfig) -> 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 Copy for TracingInspectorConfig

impl Eq for TracingInspectorConfig

impl StructuralPartialEq for TracingInspectorConfig

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