trevm 0.34.1

A typestate API wrapper for the revm EVM implementation
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
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157

//! Helpers for system actions including [EIP-4788], [EIP-6110], [EIP-7002] and
//! [EIP-7251].
//!
//! System actions are special state changes or smart contract calls made
//! before or after transaction exection. These actions are introduced via
//! hardfork. System actions are sometimes modeled as transactions with special
//! properties (as in [EIP-4788], [EIP-7002] and [EIP-7251]) or as special state
//! changes outside of the transaction lifecycle (as in [EIP-6110]).
//!
//! System transactions are modeled by the [`SystemTx`] struct, which implements
//! the [`Tx`] trait. The system transactions are sent from a special system
//! caller address: [`DEFAULT_SYSTEM_CALLER`]. Note that the system caller is
//! specified independently in each EIP, which allows introduction off
//! different system callers in future EIPs
//!
//! [`Tx`]: crate::Tx
//!
//! [EIP-4788]: https://eips.ethereum.org/EIPS/eip-4788
//! [EIP-6110]: https://eips.ethereum.org/EIPS/eip-6110
//! [EIP-7002]: https://eips.ethereum.org/EIPS/eip-7002
//! [EIP-7251]: https://eips.ethereum.org/EIPS/eip-7251

mod fill;
pub use fill::{SystemTx, DEFAULT_SYSTEM_CALLER};

/// Helpers for Prague historical block hash [EIP-2935] system actions.
///
/// [EIP-2935]: https://eips.ethereum.org/EIPS/eip-2935
pub mod eip2935;

/// Helpers for Cancun beacon root [EIP-4788] system actions.
///
/// [EIP-4788]: https://eips.ethereum.org/EIPS/eip-4788
pub mod eip4788;

/// Helpers for Cancun withdrawal [EIP-4895] system actions.
///
/// [EIP-4895]: https://eips.ethereum.org/EIPS/eip-4895
pub mod eip4895;

/// Helpers for Shanghai withdrawal [EIP-6110] system actions.
///
/// [EIP-6110]: https://eips.ethereum.org/EIPS/eip-6110
pub mod eip6110;

/// Helpers for Prague withdrawal request [EIP-7002] system actions.
///
/// [EIP-7002]: https://eips.ethereum.org/EIPS/eip-7002
pub mod eip7002;

/// Helpers for Prague consolidation request [EIP-7251] system actions.
///
/// [EIP-7251]: https://eips.ethereum.org/EIPS/eip-7251
pub mod eip7251;

/// The maximum blob gas limit for a block in Cancun.
pub const MAX_BLOB_GAS_PER_BLOCK_CANCUN: u64 = 786_432;

/// The maximum blob gas limit for a block in Prague.
pub const MAX_BLOB_GAS_PER_BLOCK_PRAGUE: u64 = 1_179_648;

/// The maximum blob gas limit for a block in Osaka, pre BPO-1.
pub const MAX_BLOB_GAS_PER_BLOCK_OSAKA: u64 = 1_749_648;

use crate::{
    helpers::{Ctx, Evm},
    EvmExtUnchecked, Tx,
};
use alloy::primitives::{Address, Bytes};
use revm::{
    bytecode::Bytecode,
    context::{
        result::{EVMError, ExecutionResult, ResultAndState},
        Block, ContextTr, Transaction,
    },
    primitives::KECCAK_EMPTY,
    Database, DatabaseCommit, InspectEvm, Inspector,
};

fn checked_insert_code<Db, Insp>(
    evm: &mut Evm<Db, Insp>,
    address: Address,
    code: &Bytes,
) -> Result<(), EVMError<Db::Error>>
where
    Db: Database + DatabaseCommit,
{
    if evm.account(address).map_err(EVMError::Database)?.info.code_hash == KECCAK_EMPTY {
        evm.set_bytecode(address, Bytecode::new_raw(code.clone())).map_err(EVMError::Database)?;
    }
    Ok(())
}

/// Clean up the system call, restoring the block env.
fn cleanup_syscall<Db, Insp>(
    evm: &mut Evm<Db, Insp>,
    result: &mut ResultAndState,
    syscall: &SystemTx,
    old_gas_limit: u64,
    old_base_fee: u64,
    previous_nonce_check: bool,
) where
    Db: Database + DatabaseCommit,
{
    let coinbase = evm.block().beneficiary();

    // Restore the block environment
    evm.modify_block(|block| {
        block.gas_limit = old_gas_limit;
        block.basefee = old_base_fee;
    });

    // Restore the nonce check
    evm.ctx.modify_cfg(|cfg| cfg.disable_nonce_check = previous_nonce_check);

    // Remove the system caller and fees from the state
    let state = &mut result.state;
    state.remove(&syscall.caller);
    state.remove(&coinbase);
}

/// Apply a system transaction as specified in [EIP-4788], [EIP-7002], or
/// [EIP-7251]. This function will execute the system transaction and apply
/// the result if non-error, cleaning up any extraneous state changes, and
/// restoring the block environment.
///
/// [EIP-4788]: https://eips.ethereum.org/EIPS/eip-4788
/// [EIP-7002]: https://eips.ethereum.org/EIPS/eip-7002
/// [EIP-7251]: https://eips.ethereum.org/EIPS/eip-7251
pub(crate) fn execute_system_tx<Db, Insp>(
    evm: &mut Evm<Db, Insp>,
    syscall: &SystemTx,
) -> Result<ExecutionResult, EVMError<Db::Error>>
where
    Db: Database + DatabaseCommit,
    Insp: Inspector<Ctx<Db>>,
{
    syscall.fill_tx(evm);

    let limit = evm.tx().gas_limit();

    let block = &mut evm.ctx.block;

    let old_gas_limit = core::mem::replace(&mut block.gas_limit, limit);
    let old_base_fee = core::mem::take(&mut block.basefee);
    let previous_nonce_check = std::mem::replace(&mut evm.ctx.cfg.disable_nonce_check, true);

    let mut result = evm.inspect_tx(evm.tx().clone())?;

    // Cleanup the syscall.
    cleanup_syscall(evm, &mut result, syscall, old_gas_limit, old_base_fee, previous_nonce_check);

    evm.ctx.db_mut().commit(result.state);

    // apply result, remove receipt from block outputs.
    Ok(result.result)
}