Struct CallTraceDecoder

pub struct CallTraceDecoder {
    pub contracts: HashMap<Address, String>,
    pub labels: HashMap<Address, String>,
    pub receive_contracts: Vec<Address>,
    pub fallback_contracts: HashMap<Address, Vec<String>>,
    pub functions: HashMap<Selector, Vec<Function>>,
    pub events: BTreeMap<(B256, usize), Vec<Event>>,
    pub revert_decoder: RevertDecoder,
    pub signature_identifier: Option<SingleSignaturesIdentifier>,
    pub verbosity: u8,
    pub debug_identifier: Option<DebugTraceIdentifier>,
}

The call trace decoder.

The decoder collects address labels and ABIs from any number of TraceIdentifiers, which it then uses to decode the call trace.

Note that a call trace decoder is required for each new set of traces, since addresses in different sets might overlap.

Fields

contracts: HashMap<Address, String>

Addresses identified to be a specific contract.

The values are in the form "<artifact>:<contract>".

labels: HashMap<Address, String>

Address labels.

receive_contracts: Vec<Address>

Contract addresses that have a receive function.

fallback_contracts: HashMap<Address, Vec<String>>

Contract addresses that have fallback functions, mapped to function sigs.

functions: HashMap<Selector, Vec<Function>>

All known functions.

events: BTreeMap<(B256, usize), Vec<Event>>

All known events.

revert_decoder: RevertDecoder

Revert decoder. Contains all known custom errors.

signature_identifier: Option<SingleSignaturesIdentifier>

A signature identifier for events and functions.

verbosity: u8

Verbosity level

debug_identifier: Option<DebugTraceIdentifier>

Optional identifier of individual trace steps.

Implementations

impl CallTraceDecoder

pub fn new() -> &'static Self

Creates a new call trace decoder.

The call trace decoder always knows how to decode calls to the cheatcode address, as well as DSTest-style logs.

fn init() -> Self

pub fn clear_addresses(&mut self)

Clears all known addresses.

pub fn identify( &mut self, trace: &CallTraceArena, identifier: &mut impl TraceIdentifier, )

Identify unknown addresses in the specified call trace using the specified identifier.

Unknown contracts are contracts that either lack a label or an ABI.

pub fn push_event(&mut self, event: Event)

Adds a single event to the decoder.

pub fn push_function(&mut self, function: Function)

Adds a single function to the decoder.

pub fn push_error(&mut self, error: Error)

Adds a single error to the decoder.

pub fn trace_addresses<'a>( &'a self, arena: &'a CallTraceArena, ) -> impl Iterator<Item = (&'a Address, Option<&'a [u8]>, Option<&'a [u8]>)> + Clone + 'a

Returns an iterator over the trace addresses.

fn collect_identities(&mut self, identities: Vec<AddressIdentity<'_>>)

fn collect_abi(&mut self, abi: &JsonAbi, address: Option<&Address>)

pub async fn populate_traces(&self, traces: &mut Vec<CallTraceNode>)

Populates the traces with decoded data by mutating the CallTrace in place. See CallTraceDecoder::decode_function and CallTraceDecoder::decode_event for more details.

pub async fn decode_function(&self, trace: &CallTrace) -> DecodedCallTrace

Decodes a call trace.

fn decode_function_input( &self, trace: &CallTrace, func: &Function, ) -> DecodedCallData

Decodes a function’s input into the given trace.

fn decode_cheatcode_inputs( &self, func: &Function, data: &[u8], ) -> Option<Vec<String>>

Custom decoding for cheatcode inputs.

fn decode_function_output( &self, trace: &CallTrace, funcs: &[Function], ) -> Option<String>

Decodes a function’s output into the given trace.

fn decode_cheatcode_outputs(&self, func: &Function) -> Option<String>

Custom decoding for cheatcode outputs.

fn default_return_data(&self, trace: &CallTrace) -> Option<String>

The default decoded return data for a trace.

pub async fn decode_event(&self, log: &LogData) -> DecodedCallLog

Decodes an event.

pub async fn prefetch_signatures(&self, nodes: &[CallTraceNode])

Prefetches function and event signatures into the identifier cache

fn format_value(&self, value: &DynSolValue) -> String

Pretty-prints a value.

Trait Implementations

impl Clone for CallTraceDecoder

fn clone(&self) -> CallTraceDecoder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CallTraceDecoder

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

Formats the value using the given formatter.

impl Default for CallTraceDecoder

fn default() -> CallTraceDecoder

Returns the “default value” for a type.

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