revm_handler/
execution.rs

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
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
use super::{frame_data::FrameResult, EthFrame, EthPrecompileProvider};
use bytecode::EOF_MAGIC_BYTES;
use context_interface::{
    result::InvalidTransaction, BlockGetter, Cfg, CfgGetter, ErrorGetter, JournalStateGetter,
    JournalStateGetterDBError, Transaction, TransactionGetter,
};
use handler_interface::{util::FrameOrFrameResult, ExecutionHandler, Frame as FrameTrait};
use interpreter::{
    interpreter::{EthInstructionProvider, EthInterpreter},
    CallInputs, CallScheme, CallValue, CreateInputs, CreateScheme, EOFCreateInputs, EOFCreateKind,
    FrameInput, Gas,
};
use primitives::TxKind;
use specification::hardfork::SpecId;
use std::boxed::Box;

#[derive(Default)]
pub struct EthExecution<
    CTX,
    ERROR,
    FRAME = EthFrame<
        CTX,
        ERROR,
        EthInterpreter<()>,
        EthPrecompileProvider<CTX, ERROR>,
        EthInstructionProvider<EthInterpreter<()>, CTX>,
    >,
> {
    _phantom: core::marker::PhantomData<(CTX, FRAME, ERROR)>,
}

impl<CTX, ERROR, FRAME> ExecutionHandler for EthExecution<CTX, ERROR, FRAME>
where
    CTX: EthExecutionContext<ERROR>,
    ERROR: EthExecutionError<CTX>,
    FRAME:
        FrameTrait<Context = CTX, Error = ERROR, FrameInit = FrameInput, FrameResult = FrameResult>,
{
    type Context = CTX;
    type Error = ERROR;
    type Frame = FRAME;
    type ExecResult = FrameResult;

    fn init_first_frame(
        &mut self,
        context: &mut Self::Context,
        gas_limit: u64,
    ) -> Result<FrameOrFrameResult<Self::Frame>, Self::Error> {
        // Make new frame action.
        let spec = context.cfg().spec().into();
        let tx = context.tx();
        let input = tx.common_fields().input().clone();

        let init_frame: FrameInput = match tx.kind() {
            TxKind::Call(target_address) => FrameInput::Call(Box::new(CallInputs {
                input,
                gas_limit,
                target_address,
                bytecode_address: target_address,
                caller: tx.common_fields().caller(),
                value: CallValue::Transfer(tx.common_fields().value()),
                scheme: CallScheme::Call,
                is_static: false,
                is_eof: false,
                return_memory_offset: 0..0,
            })),
            TxKind::Create => {
                // if first byte of data is magic 0xEF00, then it is EOFCreate.
                if spec.is_enabled_in(SpecId::OSAKA) && input.starts_with(&EOF_MAGIC_BYTES) {
                    FrameInput::EOFCreate(Box::new(EOFCreateInputs::new(
                        tx.common_fields().caller(),
                        tx.common_fields().value(),
                        gas_limit,
                        EOFCreateKind::Tx { initdata: input },
                    )))
                } else {
                    FrameInput::Create(Box::new(CreateInputs {
                        caller: tx.common_fields().caller(),
                        scheme: CreateScheme::Create,
                        value: tx.common_fields().value(),
                        init_code: input,
                        gas_limit,
                    }))
                }
            }
        };
        FRAME::init_first(context, init_frame)
    }

    fn last_frame_result(
        &self,
        context: &mut Self::Context,
        mut frame_result: <Self::Frame as FrameTrait>::FrameResult,
    ) -> Result<Self::ExecResult, Self::Error> {
        let instruction_result = frame_result.interpreter_result().result;
        let gas = frame_result.gas_mut();
        let remaining = gas.remaining();
        let refunded = gas.refunded();

        // Spend the gas limit. Gas is reimbursed when the tx returns successfully.
        *gas = Gas::new_spent(context.tx().common_fields().gas_limit());

        if instruction_result.is_ok_or_revert() {
            gas.erase_cost(remaining);
        }

        if instruction_result.is_ok() {
            gas.record_refund(refunded);
        }

        Ok(frame_result)
    }
}

impl<CTX, ERROR, FRAME> EthExecution<CTX, ERROR, FRAME> {
    pub fn new() -> Self {
        Self {
            _phantom: core::marker::PhantomData,
        }
    }

    pub fn new_boxed() -> Box<Self> {
        Box::new(Self::new())
    }
}

pub trait EthExecutionContext<ERROR>:
    TransactionGetter + ErrorGetter<Error = ERROR> + BlockGetter + JournalStateGetter + CfgGetter
{
}

impl<
        ERROR,
        T: TransactionGetter
            + ErrorGetter<Error = ERROR>
            + BlockGetter
            + JournalStateGetter
            + CfgGetter,
    > EthExecutionContext<ERROR> for T
{
}

pub trait EthExecutionError<CTX: JournalStateGetter>:
    From<InvalidTransaction> + From<JournalStateGetterDBError<CTX>>
{
}

impl<
        CTX: JournalStateGetter,
        T: From<InvalidTransaction> + From<JournalStateGetterDBError<CTX>>,
    > EthExecutionError<CTX> for T
{
}

// #[cfg(test)]
// mod tests {
//     use super::*;
//     use crate::handler::mainnet::refund;
//     use interpreter::InstructionResult;
//     use primitives::Bytes;
//     use specification::hardfork::CancunSpec;
//     use context_interface::{default::EnvWiring, DefaultEthereumWiring};

//     /// Creates frame result.
//     fn call_last_frame_return(instruction_result: InstructionResult, gas: Gas) -> Gas {
//         let mut env = Envcontext_interface::<DefaultEthereumWiring>::default();
//         env.tx.gas_limit = 100;

//         let mut context = Context::builder();
//         context.evm.inner.env = Box::new(env);
//         let mut first_frame = FrameResult::Call(CallOutcome::new(
//             InterpreterResult {
//                 result: instruction_result,
//                 output: Bytes::new(),
//                 gas,
//             },
//             0..0,
//         ));
//         last_frame_return::<DefaultEthereumWiring, CancunSpec>(&mut context, &mut first_frame).unwrap();
//         refund::<DefaultEthereumWiring, CancunSpec>(&mut context, first_frame.gas_mut(), 0);
//         *first_frame.gas()
//     }

//     #[test]
//     fn test_consume_gas() {
//         let gas = call_last_frame_return(InstructionResult::Stop, Gas::new(90));
//         assert_eq!(gas.remaining(), 90);
//         assert_eq!(gas.spent(), 10);
//         assert_eq!(gas.refunded(), 0);
//     }

//     #[test]
//     fn test_consume_gas_with_refund() {
//         let mut return_gas = Gas::new(90);
//         return_gas.record_refund(30);

//         let gas = call_last_frame_return(InstructionResult::Stop, return_gas);
//         assert_eq!(gas.remaining(), 90);
//         assert_eq!(gas.spent(), 10);
//         assert_eq!(gas.refunded(), 2);

//         let gas = call_last_frame_return(InstructionResult::Revert, return_gas);
//         assert_eq!(gas.remaining(), 90);
//         assert_eq!(gas.spent(), 10);
//         assert_eq!(gas.refunded(), 0);
//     }

//     #[test]
//     fn test_revert_gas() {
//         let gas = call_last_frame_return(InstructionResult::Revert, Gas::new(90));
//         assert_eq!(gas.remaining(), 90);
//         assert_eq!(gas.spent(), 10);
//         assert_eq!(gas.refunded(), 0);
//     }
// }