yevm-core 0.1.0

Async, WASM-native Ethereum VM engine: opcode dispatch, gas accounting, precompiles, state traits, structured trace events.
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
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
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
use yevm_base::math::lift;
use yevm_base::{Acc, Int};
use yevm_misc::keccak256;

use crate::{
    Call,
    evm::{self, CallMode, Context, Evm, EvmResult, EvmYield, Fetch, HaltReason},
    misc::{create_address, create2_address, is_precompile},
    state::State,
};

/// Allocate gas for a child frame per EIP-150 (63/64 rule).
fn sub_call_gas(evm: &Evm) -> u64 {
    let remaining = evm.gas_remaining().max(0) as u64;
    remaining - remaining / 64
}

pub fn create<S: State>(evm: &mut Evm, ctx: &Context, _: &Call, state: &mut S) -> EvmResult<()> {
    if ctx.is_static {
        return Err(EvmYield::Halt(HaltReason::NonStatic));
    }
    evm.gas_charge(32_000)?;
    let [value, offset, size] = evm.peek()?;
    evm::mem_check_int(offset, size)?;
    let (offset, size) = (offset.as_usize(), size.as_usize());
    let initcode_cost = 2 * ((size as i64 + 31) / 32);
    evm.gas_charge(initcode_cost)?;

    let Some(nonce) = state.nonce(&ctx.this).map(|x| x.as_u64()) else {
        return Err(EvmYield::Fetch(Fetch::Nonce(ctx.this)));
    };
    let address = create_address(&ctx.this, nonce);

    let data = evm.mem_get(offset, size)?;
    let data: Vec<u8> = data.to_vec();
    let gas = sub_call_gas(evm);
    evm.gas_charge(gas as i64)?;

    let call = Call {
        by: ctx.this,
        to: None,
        gas,
        eth: value,
        data: data.into(),
    };

    Err(EvmYield::Call(call, CallMode::Create(address)))
}

pub fn call<S: State>(evm: &mut Evm, ctx: &Context, _: &Call, state: &mut S) -> EvmResult<()> {
    let [
        gas_arg,
        address,
        value,
        args_offset,
        args_size,
        ret_offset,
        ret_size,
    ] = evm.peek()?;
    evm::mem_check_int(args_offset, args_size)?;
    evm::mem_check_int(ret_offset, ret_size)?;
    let (args_offset, args_size) = (args_offset.as_usize(), args_size.as_usize());
    let (ret_offset, ret_size) = (ret_offset.as_usize(), ret_size.as_usize());
    let address: Acc = address.to();

    if state.acc(&ctx.this).is_none() {
        return Err(EvmYield::Fetch(Fetch::Account(ctx.this)));
    }
    if state.acc(&address).is_none() {
        return Err(EvmYield::Fetch(Fetch::Account(address)));
    }
    if let Some(delegate) = state.auth(&address)
        && state.acc(&address).is_none()
    {
        return Err(EvmYield::Fetch(Fetch::Account(delegate)));
    }

    // EIP-2929: warm/cold address access (use pending warm to survive Fetch+reset)
    let access_cost: i64 = if state.is_cold_acc(&address) {
        2600
    } else {
        100
    };
    evm.warm_acc(&address);
    evm.gas_charge(access_cost)?;

    if let Some(delegate) = state.auth(&address) {
        let access_cost: i64 = if state.is_cold_acc(&delegate) {
            2600
        } else {
            100
        };
        evm.warm_acc(&delegate);
        evm.gas_charge(access_cost)?;
    };

    // Value transfer cost
    let has_value = !value.is_zero();
    if ctx.is_static && has_value {
        return Err(EvmYield::Halt(HaltReason::NonStatic));
    }
    if has_value {
        evm.gas_charge(9000)?;
    }

    // New account cost (sending value to dead account per EIP-161).
    // Applies to ALL addresses including precompiles — if the precompile address
    // is empty in the state, the 25000 cost is charged just like any other address.
    if has_value {
        if state.acc(&address).is_none() {
            return Err(EvmYield::Fetch(Fetch::Account(address)));
        }
        let is_empty = state
            .acc(&address)
            .map(|a| a.value.is_zero() && a.nonce.is_zero() && a.code.0.0.is_empty())
            .unwrap_or(true);
        if is_empty {
            evm.gas_charge(25000)?;
        }
    }

    // Memory expansion for both args and return regions (AFTER all Fetch points so it survives reset)
    evm.mem_expand_max(&[(args_offset, args_size), (ret_offset, ret_size)])?;

    // 63/64 rule: cap the gas arg at available_gas * 63/64
    let available = evm.gas_remaining().max(0) as u64;
    let max_child = available - available / 64;
    let mut gas = gas_arg.as_u64().min(max_child);
    evm.gas_charge(gas as i64)?;

    // Gas stipend: add 2300 to child when sending value
    if has_value {
        gas += 2300;
    }

    let data = evm.mem_get(args_offset, args_size)?;

    let call = Call {
        by: ctx.this,
        to: Some(address),
        gas,
        eth: value,
        data: data.to_vec().into(),
    };

    Err(EvmYield::Call(call, CallMode::Call(ret_offset, ret_size)))
}

pub fn callcode<S: State>(evm: &mut Evm, ctx: &Context, _: &Call, state: &mut S) -> EvmResult<()> {
    let [
        gas_arg,
        address,
        value,
        args_offset,
        args_size,
        ret_offset,
        ret_size,
    ] = evm.peek()?;
    evm::mem_check_int(args_offset, args_size)?;
    evm::mem_check_int(ret_offset, ret_size)?;
    let (args_offset, args_size) = (args_offset.as_usize(), args_size.as_usize());
    let (ret_offset, ret_size) = (ret_offset.as_usize(), ret_size.as_usize());
    let address: Acc = address.to();

    let is_precompile = is_precompile(&address);
    // Address 0 has no account but can be called (empty code returns success)
    let needs_account = address != Acc::ZERO && !is_precompile;
    if needs_account && state.acc(&address).is_none() {
        return Err(EvmYield::Fetch(Fetch::Account(address)));
    };
    if let Some(delegate) = state.auth(&address)
        && state.acc(&address).is_none()
    {
        return Err(EvmYield::Fetch(Fetch::Account(delegate)));
    }

    let access_cost: i64 = if state.is_cold_acc(&address) {
        2600
    } else {
        100
    };
    evm.warm_acc(&address);
    evm.gas_charge(access_cost)?;

    if let Some(delegate) = state.auth(&address) {
        let access_cost: i64 = if state.is_cold_acc(&delegate) {
            2600
        } else {
            100
        };
        evm.warm_acc(&delegate);
        evm.gas_charge(access_cost)?;
    };

    evm.mem_expand_max(&[(args_offset, args_size), (ret_offset, ret_size)])?;

    let has_value = !value.is_zero();
    if has_value {
        evm.gas_charge(9000)?;
    }

    let available = evm.gas_remaining().max(0) as u64;
    let max_child = available - available / 64;
    let mut gas = gas_arg.as_u64().min(max_child);
    evm.gas_charge(gas as i64)?;

    if has_value {
        gas += 2300;
    }

    let data = evm.mem_get(args_offset, args_size)?;

    let call = Call {
        by: ctx.this,
        to: Some(address),
        gas,
        eth: value,
        data: data.to_vec().into(),
    };

    Err(EvmYield::Call(
        call,
        CallMode::CallCode(ret_offset, ret_size),
    ))
}

pub fn r#return(evm: &mut Evm, _: &Context, _: &Call, _: &mut dyn State) -> EvmResult<()> {
    let [offset, size] = evm.peek()?;
    evm::mem_check_int(offset, size)?;
    let (offset, size) = (offset.as_usize(), size.as_usize());
    let mem = evm.mem_get(offset, size)?;
    Err(EvmYield::Return(mem.to_vec()))
}

pub fn delegatecall<S: State>(
    evm: &mut Evm,
    _ctx: &Context,
    call: &Call,
    state: &mut S,
) -> EvmResult<()> {
    let [
        gas_arg,
        address,
        args_offset,
        args_size,
        ret_offset,
        ret_size,
    ] = evm.peek()?;
    evm::mem_check_int(args_offset, args_size)?;
    evm::mem_check_int(ret_offset, ret_size)?;
    let (args_offset, args_size) = (args_offset.as_usize(), args_size.as_usize());
    let (ret_offset, ret_size) = (ret_offset.as_usize(), ret_size.as_usize());
    let address: Acc = address.to();

    let is_precompile = is_precompile(&address);
    // Address 0 has no account but can be called (empty code returns success)
    let needs_account = address != Acc::ZERO && !is_precompile;
    if needs_account && state.acc(&address).is_none() {
        return Err(EvmYield::Fetch(Fetch::Account(address)));
    };
    if let Some(delegate) = state.auth(&address)
        && state.acc(&address).is_none()
    {
        return Err(EvmYield::Fetch(Fetch::Account(delegate)));
    }

    let access_cost: i64 = if state.is_cold_acc(&address) {
        2600
    } else {
        100
    };
    evm.warm_acc(&address);
    evm.gas_charge(access_cost)?;

    if let Some(delegate) = state.auth(&address) {
        let access_cost: i64 = if state.is_cold_acc(&delegate) {
            2600
        } else {
            100
        };
        evm.warm_acc(&delegate);
        evm.gas_charge(access_cost)?;
    };

    evm.mem_expand_max(&[(args_offset, args_size), (ret_offset, ret_size)])?;

    let available = evm.gas_remaining().max(0) as u64;
    let max_child = available - available / 64;
    let gas = gas_arg.as_u64().min(max_child);
    evm.gas_charge(gas as i64)?;

    let data = evm.mem_get(args_offset, args_size)?;

    // DELEGATECALL preserves msg.sender and msg.value from the parent frame
    let inner_call = Call {
        by: call.by,
        to: Some(address),
        gas,
        eth: call.eth,
        data: data.to_vec().into(),
    };

    Err(EvmYield::Call(
        inner_call,
        CallMode::Delegate(ret_offset, ret_size),
    ))
}

pub fn create2(evm: &mut Evm, ctx: &Context, _: &Call, _: &mut dyn State) -> EvmResult<()> {
    if ctx.is_static {
        return Err(EvmYield::Halt(HaltReason::NonStatic));
    }
    evm.gas_charge(32_000)?;
    let [value, offset, size, salt] = evm.peek()?;
    evm::mem_check_int(offset, size)?;
    let (offset, size) = (offset.as_usize(), size.as_usize());
    // EIP-3860 initcode word cost (2) + CREATE2 hash word cost (6) = 8 per word
    let word_cost = 8 * ((size as i64 + 31) / 32);
    evm.gas_charge(word_cost)?;

    let data = evm.mem_get(offset, size)?;
    let data: Vec<u8> = data.to_vec();
    let init_code_hash = Int::from(keccak256(&data).as_ref());
    let address = create2_address(&ctx.this, &salt, &init_code_hash);

    let gas = sub_call_gas(evm);
    evm.gas_charge(gas as i64)?;

    let call = Call {
        by: ctx.this,
        to: None,
        gas,
        eth: value,
        data: data.into(),
    };

    Err(EvmYield::Call(call, CallMode::Create2(address)))
}

pub fn staticcall<S: State>(
    evm: &mut Evm,
    ctx: &Context,
    _: &Call,
    state: &mut S,
) -> EvmResult<()> {
    let [
        gas_arg,
        address,
        args_offset,
        args_size,
        ret_offset,
        ret_size,
    ] = evm.peek()?;
    evm::mem_check_int(args_offset, args_size)?;
    evm::mem_check_int(ret_offset, ret_size)?;
    let (args_offset, args_size) = (args_offset.as_usize(), args_size.as_usize());
    let (ret_offset, ret_size) = (ret_offset.as_usize(), ret_size.as_usize());
    let address: Acc = address.to();
    let is_precompile = is_precompile(&address);

    let needs_account = address != Acc::ZERO && !is_precompile;
    if needs_account && state.acc(&address).is_none() {
        return Err(EvmYield::Fetch(Fetch::Account(address)));
    };
    if let Some(delegate) = state.auth(&address)
        && state.acc(&address).is_none()
    {
        return Err(EvmYield::Fetch(Fetch::Account(delegate)));
    }

    // EIP-2929: warm/cold address access (applies to precompiles too)
    let access_cost: i64 = if state.is_cold_acc(&address) {
        2600
    } else {
        100
    };
    evm.warm_acc(&address);
    evm.gas_charge(access_cost)?;

    if let Some(delegate) = state.auth(&address) {
        let access_cost: i64 = if state.is_cold_acc(&delegate) {
            2600
        } else {
            100
        };
        evm.warm_acc(&delegate);
        evm.gas_charge(access_cost)?;
    };

    // Fetch before mem_expand_max so expansion/charge survive reset
    if !is_precompile && state.acc(&address).is_none() {
        return Err(EvmYield::Fetch(Fetch::Account(address)));
    };

    evm.mem_expand_max(&[(args_offset, args_size), (ret_offset, ret_size)])?;

    let available = evm.gas_remaining().max(0) as u64;
    let max_child = available - available / 64;
    let gas = gas_arg.as_u64().min(max_child);
    evm.gas_charge(gas as i64)?;

    let data = evm.mem_get(args_offset, args_size)?;

    let call = Call {
        by: ctx.this,
        to: Some(address),
        gas,
        eth: Int::ZERO,
        data: data.to_vec().into(),
    };

    Err(EvmYield::Call(call, CallMode::Static(ret_offset, ret_size)))
}

pub fn revert(evm: &mut Evm, _: &Context, _: &Call, _: &mut dyn State) -> EvmResult<()> {
    let [offset, size] = evm.peek()?;
    evm::mem_check_int(offset, size)?;
    let (offset, size) = (offset.as_usize(), size.as_usize());
    let mem = evm.mem_get(offset, size)?;
    Err(EvmYield::Revert(mem.to_vec()))
}

pub fn selfdestruct<S: State>(
    evm: &mut Evm,
    ctx: &Context,
    _: &Call,
    state: &mut S,
) -> EvmResult<()> {
    // EIP-214: SELFDESTRUCT in static context is an exceptional halt
    if ctx.is_static {
        return Err(EvmYield::Halt(HaltReason::NonStatic));
    }

    let [beneficiary] = evm.peek()?;
    let beneficiary: Acc = beneficiary.to();

    // Fetch beneficiary before gas accounting so is_empty check is accurate.
    if state.acc(&beneficiary).is_none() {
        return Err(EvmYield::Fetch(crate::evm::Fetch::Account(beneficiary)));
    }

    evm.gas_charge(5_000)?;

    // EIP-2929: cold address surcharge for beneficiary (no warm cost — covered by 5000 base)
    if state.is_cold_acc(&beneficiary) {
        evm.gas_charge(2600)?;
    }
    evm.warm_acc(&beneficiary);

    let balance = state.balance(&ctx.this).unwrap_or(Int::ZERO);
    if !balance.is_zero() && beneficiary != ctx.this {
        // EIP-161: creating empty account costs 25000 when transferring value
        let is_empty = state
            .acc(&beneficiary)
            .map(|a| a.value.is_zero() && a.nonce.is_zero() && a.code.0.0.is_empty())
            .unwrap_or(true);
        if is_empty {
            evm.gas_charge(25000)?;
        }
        let add = lift(|[a, b]| a + b);
        let to_bal = state.balance(&beneficiary).unwrap_or(Int::ZERO);
        state.set_value(&beneficiary, add([to_bal, balance]));
        state.set_value(&ctx.this, Int::ZERO);
    }

    // EIP-6780 (Cancun): only destroy if contract was created in same transaction
    if state.created().contains(&ctx.this) {
        state.destroy(&ctx.this);
    }
    Err(EvmYield::Return(vec![]))
}