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

//! This module generates traces by connecting to an external tracer

use eth_types::{
    geth_types::{Account, BlockConstants, Transaction, Withdrawal},
    Address, Error, GethExecTrace, Word,
};
use serde::Serialize;
use std::collections::BTreeMap;

/// Configuration structure for `geth_utils::trace`
#[derive(Debug, Default, Clone, Serialize)]
pub struct TraceConfig {
    /// chain id
    pub chain_id: Word,
    /// history hashes contains most recent 256 block hashes in history, where
    /// the latest one is at history_hashes[history_hashes.len() - 1].
    pub history_hashes: Vec<Word>,
    /// block constants
    pub block_constants: BlockConstants,
    /// accounts
    pub accounts: BTreeMap<Address, Account>,
    /// transaction
    pub transactions: Vec<Transaction>,
    /// withdrawal
    pub withdrawals: Vec<Withdrawal>,
    /// logger
    pub logger_config: LoggerConfig,
}

/// Configuration structure for `logger.Config`
#[derive(Debug, Clone, Serialize)]
#[serde(rename_all = "PascalCase")]
pub struct LoggerConfig {
    /// enable memory capture
    pub enable_memory: bool,
    /// disable stack capture
    pub disable_stack: bool,
    /// disable storage capture
    pub disable_storage: bool,
    /// enable return data capture
    pub enable_return_data: bool,
}

impl Default for LoggerConfig {
    fn default() -> Self {
        Self {
            enable_memory: false,
            disable_stack: false,
            disable_storage: false,
            enable_return_data: true,
        }
    }
}

impl LoggerConfig {
    pub fn enable_memory() -> Self {
        Self {
            enable_memory: true,
            ..Self::default()
        }
    }
}

/// Creates a trace for the specified config
pub fn trace(config: &TraceConfig) -> Result<Vec<GethExecTrace>, Error> {
    // Get the trace
    let trace_string = geth_utils::trace(&serde_json::to_string(&config).unwrap()).map_err(
        |error| match error {
            geth_utils::Error::TracingError(error) => Error::TracingError(error),
        },
    )?;

    let trace: Vec<GethExecTrace> =
        serde_json::from_str(&trace_string).map_err(Error::SerdeError)?;
    // Don't throw only for specific invalid transactions we support.
    for trace in trace.iter() {
        let error = &trace.return_value;
        let allowed_cases = error.contains("nonce too low")
            || error.contains("nonce too high")
            || error.contains("intrinsic gas too low")
            || error.contains("insufficient funds for gas * price + value")
            || error.contains("insufficient funds for transfer");
        if trace.invalid && !allowed_cases {
            return Err(Error::TracingError(error.clone()));
        }
    }
    Ok(trace)
}