verbs-rs 0.4.1

Ethereum Agent based simulation library
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

//! Transaction related data types

use alloy_primitives::{Address, U256};
use alloy_sol_types::SolCall;
use revm::primitives::{Log, Output};

/// EVM transaction argument data
#[derive(Clone)]
pub struct Transaction {
    /// 4 byte function selector
    pub function_selector: [u8; 4],
    /// Address of the contract caller
    pub callee: Address,
    /// Address of the contract to call
    pub transact_to: Address,
    /// ABI encoded arguments bytes
    pub args: Vec<u8>,
    /// Gas priority `None` will be treated as 0 for sorting
    pub gas_priority_fee: Option<U256>,
    /// Transaction nonce, used for transaction ordering
    pub nonce: Option<u64>,
    /// Value attached to the transaction
    pub value: U256,
    /// Flag, if `true` the simulation will halt (panic)
    /// if this transaction is reverted.
    pub checked: bool,
}

impl Transaction {
    pub fn new<T: SolCall>(
        callee: Address,
        contract: Address,
        args: T,
        gas_priority_fee: Option<U256>,
        nonce: Option<u64>,
        value: U256,
        checked: bool,
    ) -> Self {
        Transaction {
            function_selector: T::SELECTOR,
            callee,
            transact_to: contract,
            args: args.abi_encode(),
            gas_priority_fee,
            nonce,
            value,
            checked,
        }
    }

    pub fn basic<T: SolCall>(callee: Address, contract: Address, args: T, checked: bool) -> Self {
        Transaction {
            function_selector: T::SELECTOR,
            callee,
            transact_to: contract,
            args: args.abi_encode(),
            gas_priority_fee: None,
            nonce: None,
            value: U256::ZERO,
            checked,
        }
    }
}

/// Result of a transaction included any generated events
pub struct TransactionResult {
    /// Flag whether transaction was successful
    pub success: bool,
    /// Output data
    pub output: Output,
    /// Vec of events returned by the transaction
    pub events: Option<Event>,
}

/// Wraps event logs with additional event information
///
/// Events are created for each transaction processed
/// during the simulation, included failed (reverted)
/// transactions. This allow a history of simulation
/// events to be recreated after a simulation
///
pub struct Event {
    /// If the event was successful (i.e. `false`
    /// indicates a transaction was reverted)
    pub success: bool,
    /// 4 byte function selector of the called function
    pub function_selector: [u8; 4],
    /// Event data generated by the transaction
    pub logs: Vec<Log>,
    /// Simulation step the event was created
    pub step: usize,
    /// Sequence the event was created inside a block
    pub sequence: usize,
}