revm-trace 4.2.0

High-performance multi-threaded EVM transaction simulator and analyzer with comprehensive tracing capabilities
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128

//! Core transaction inspector implementation
//!
//! This module provides the main TxInspector type and its core functionality.
//! The inspector is responsible for tracking and collecting detailed information
//! about transaction execution in the EVM.
//!
//! # Architecture
//!
//! The implementation is split across several modules:
//! - `types`: Output and internal data structures
//! - `trace`: Call tracing and error tracking
//! - `inspector`: REVM Inspector trait implementation
//!
//! # Features
//!
//! - Complete transaction tracing
//! - Asset transfer tracking (ETH and ERC20)
//! - Call hierarchy reconstruction
//! - Error propagation tracking
//! - Event log collection

use crate::types::*;
use serde::Serialize;
mod inspector;
mod trace;
mod traits;
use alloy::primitives::{Address, Log, U256};
use std::collections::HashMap;

/// Core transaction tracing inspector
///
/// Provides comprehensive transaction execution tracking by implementing
/// the REVM Inspector trait. Collects detailed information about:
///
/// - Asset transfers (ETH and ERC20 tokens)
/// - Contract calls and creations
/// - Call hierarchy and execution paths
/// - Event logs and error states
///
/// # State Management
///
/// The inspector maintains several internal collections to track execution:
/// - Transfers: Chronological list of all value movements
/// - Call traces: Complete tree of contract interactions
/// - Logs: All emitted events
/// - Call stack: Current execution path
/// - Address stack: Caller context for delegate calls
///
/// # Thread Safety
///
/// This inspector is designed to be Send + Sync safe for multi-threaded usage.
/// All internal state uses thread-safe types or types that can be safely
/// moved between threads.
#[derive(Default, Clone)]
pub struct TxInspector {
    /// Chronological record of all asset transfers during execution
    transfers: Vec<TokenTransfer>,
    /// Hierarchical tree of all contract calls and creations
    call_traces: Vec<CallTrace>,
    /// Sequential list of all emitted event logs
    logs: Vec<Log>,
    /// Stack tracking current position in call hierarchy
    call_stack: Vec<usize>,
    /// Stack maintaining caller context for delegate calls
    address_stack: Vec<Address>,
    /// Stack of pending contract creation transfers
    ///
    /// Tracks (transfer_index, transfer) pairs for each level of contract creation
    /// to properly handle nested contract creations. Operates in parallel with
    /// call_stack to maintain proper creation context.
    pending_create_transfers: Vec<(usize, TokenTransfer)>,
    /// Cache for storage slot values to avoid redundant database queries
    slot_cache: HashMap<(Address, U256), U256>,
}

// The explicit implementation of Send and Sync ensures thread safety.
unsafe impl Send for TxInspector {}
unsafe impl Sync for TxInspector {}

/// Complete transaction execution trace output
///
/// Aggregates all collected information during transaction execution:
/// - Asset movements (both ETH and tokens)
/// - Complete call hierarchy
/// - Event logs
/// - Error location if execution failed
#[derive(Debug, Clone, Serialize)]
pub struct TxTraceOutput {
    /// All asset transfers (ETH and tokens) during execution
    pub asset_transfers: Vec<TokenTransfer>,
    /// Complete hierarchical call tree
    pub call_trace: Option<CallTrace>,
    /// All emitted event logs
    pub logs: Vec<Log>,
    /// Location of the first error in the call tree
    pub error_trace_address: Option<Vec<usize>>,
}

impl TxInspector {
    /// Creates a new inspector instance with empty state
    pub fn new() -> Self {
        Default::default()
    }

    /// Returns all recorded asset transfers in chronological order
    ///
    /// Includes both ETH transfers and ERC20 token transfers
    pub fn get_transfers(&self) -> &Vec<TokenTransfer> {
        &self.transfers
    }

    /// Returns the complete call trace tree
    ///
    /// The trace contains all contract interactions including:
    /// - Regular calls
    /// - Delegate calls
    /// - Contract creations
    pub fn get_traces(&self) -> &[CallTrace] {
        &self.call_traces
    }

    /// Returns all event logs emitted during execution
    ///
    /// Includes both regular events and ERC20 Transfer events
    pub fn get_logs(&self) -> &Vec<Log> {
        &self.logs
    }
}