Skip to main content

LevmOpcodeTracer

Struct LevmOpcodeTracer 

Source
pub struct LevmOpcodeTracer {
    pub active: bool,
    pub cfg: OpcodeTracerConfig,
    pub logs: Vec<OpcodeStep>,
    pub output: Bytes,
    pub error: Option<String>,
    pub gas_used: u64,
    pub last_opcode_gas_cost: Option<u64>,
    pub last_step_index: Option<usize>,
    pub cumulative_storage: BTreeMap<H256, H256>,
}
Expand description

Per-opcode (EIP-3155) tracer, emitted under the de-facto cross-client structLogger wrapper shape.

Use LevmOpcodeTracer::disabled() when tracing is not wanted; the dispatch-loop guard is a single if self.opcode_tracer.active branch with no other overhead on the fast path.

Fields§

§active: bool

Whether this tracer is active.

§cfg: OpcodeTracerConfig

Configuration.

§logs: Vec<OpcodeStep>

Collected per-step entries.

§output: Bytes

Final output bytes (from RETURN / REVERT).

§error: Option<String>

Top-level error string, if the transaction reverted.

§gas_used: u64

Gas used by the transaction.

§last_opcode_gas_cost: Option<u64>

Explicit gas cost written by CALL/CALLCODE/DELEGATECALL/STATICCALL/CREATE/CREATE2 handlers before invoking the child frame, and by jump() when JUMP/JUMPI is fused with JUMPDEST under active tracing. The dispatch loop prefers this value over the (incorrect) gas-diff that would include forwarded gas.

§last_step_index: Option<usize>

Index in logs of the entry that the next finalize_step should patch. Some(i) is set by pre_step_capture after a push; None after the limit cap is reached (so finalize_step is a no-op). Synthesized steps (e.g. fused JUMPDEST) push directly without touching this index, preserving the parent opcode’s pending finalize target.

§cumulative_storage: BTreeMap<H256, H256>

Cumulative map of every storage slot touched by an SLOAD/SSTORE so far in this transaction, with the most recent value observed. Each SLOAD/SSTORE-bearing step embeds a snapshot of this map under its storage field, matching geth’s structLogger behavior of accumulating touched slots across the trace rather than emitting only the slot just accessed. Empty until the first SLOAD/SSTORE; not reset between call frames (consistent with how slot keys are indexed — by slot only, not by (address, slot) — so cross-frame frame isolation is a separate concern).

Implementations§

Source§

impl LevmOpcodeTracer

Source

pub fn disabled() -> Self

Returns an inactive tracer. No allocations; zero overhead on the hot path.

Source

pub fn new(cfg: OpcodeTracerConfig) -> Self

Returns an active tracer with the given config.

Source

pub fn pre_step_capture( &mut self, pc: u64, opcode: u8, gas: u64, depth: u32, refund: u64, stack_view: &[U256], memory_view: &[u8], mem_size: u64, return_data: &Bytes, storage_kv: Option<(H256, H256)>, )

Captures pre-step state, building and buffering an OpcodeStep entry.

Called BEFORE the opcode executes. pc must be the address of the current opcode (before advance_pc()).

stack_view must already be bottom-first (caller reverses LEVM’s top-first layout) and empty when cfg.disable_stack is true.

memory_view is the live byte slice for the current frame (caller provides this only when cfg.enable_memory is true; otherwise pass &[]).

storage_kv is pre-fetched by the caller via read_storage_for_trace; it is None for all opcodes except SLOAD/SSTORE (or when storage capture is disabled).

Source

pub fn finalize_step( &mut self, gas_cost: u64, refund_after: u64, error: Option<&str>, )

Patches the entry recorded by the most recent pre_step_capture with the actual gas cost, the post-execution refund counter, and any step-level error string. Called immediately after the opcode handler returns.

refund_after matches geth’s structLogger timing: the refund counter shown on an opcode’s step is the value after the opcode’s gas+refund accounting has been applied. For opcodes that don’t mutate the refund counter (every opcode except SSTORE and pre-London SELFDESTRUCT) this is a no-op since the captured pre-op refund already equals the post-op one.

No-op when the most recent pre_step_capture did not push (limit reached). Synthesized entries (e.g. fused JUMPDEST) push directly into logs without updating last_step_index, so this still patches the correct parent entry.

Source

pub fn synthesize_step(&mut self, step: OpcodeStep)

Pushes a fully-formed synthetic step (used for fused JUMPDEST under JUMP/JUMPI).

Does not update last_step_index, so the pending finalize_step for the parent opcode continues to patch the parent’s entry. The limit cap is honored — synthetic pushes are dropped once cfg.limit is reached.

Source

pub fn take_result(&mut self) -> OpcodeTraceResult

Assembles the final OpcodeTraceResult after the transaction finishes.

Trait Implementations§

Source§

impl Debug for LevmOpcodeTracer

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> ArchivePointee for T

Source§

type ArchivedMetadata = ()

The archived version of the pointer metadata for this type.
Source§

fn pointer_metadata( _: &<T as ArchivePointee>::ArchivedMetadata, ) -> <T as Pointee>::Metadata

Converts some archived metadata to the pointer metadata for itself.
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T, U> ExactFrom<T> for U
where U: TryFrom<T>,

Source§

fn exact_from(value: T) -> U

Source§

impl<T, U> ExactInto<U> for T
where U: ExactFrom<T>,

Source§

fn exact_into(self) -> U

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> LayoutRaw for T

Source§

fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>

Returns the layout of the type.
Source§

impl<T, N1, N2> Niching<NichedOption<T, N1>> for N2
where T: SharedNiching<N1, N2>, N1: Niching<T>, N2: Niching<T>,

Source§

unsafe fn is_niched(niched: *const NichedOption<T, N1>) -> bool

Returns whether the given value has been niched. Read more
Source§

fn resolve_niched(out: Place<NichedOption<T, N1>>)

Writes data to out indicating that a T is niched.
Source§

impl<T, U> OverflowingInto<U> for T
where U: OverflowingFrom<T>,

Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Pointee for T

Source§

type Metadata = ()

The metadata type for pointers and references to this type.
Source§

impl<T, U> RoundingInto<U> for T
where U: RoundingFrom<T>,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> SaturatingInto<U> for T
where U: SaturatingFrom<T>,

Source§

impl<T> ToDebugString for T
where T: Debug,

Source§

fn to_debug_string(&self) -> String

Returns the String produced by Ts Debug implementation.

§Examples
use malachite_base::strings::ToDebugString;

assert_eq!([1, 2, 3].to_debug_string(), "[1, 2, 3]");
assert_eq!(
    [vec![2, 3], vec![], vec![4]].to_debug_string(),
    "[[2, 3], [], [4]]"
);
assert_eq!(Some(5).to_debug_string(), "Some(5)");
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T, U> WrappingInto<U> for T
where U: WrappingFrom<T>,

Source§

fn wrapping_into(self) -> U