zk_evm 0.153.12

ZKsync out-of-circuit EraEVM 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

use crate::zkevm_opcode_defs::decoding::{EncodingModeProduction, VmEncodingMode};
use zk_evm_abstractions::{aux::MemoryLocation, vm::Memory};

use crate::{
    opcodes::DecodedOpcode,
    vm_state::{ErrorFlags, PrimitiveValue, VmLocalState},
};

use super::*;

#[derive(Clone, Copy, Debug, PartialEq)]
pub struct VmLocalStateData<'a, const N: usize = 8, E: VmEncodingMode<N> = EncodingModeProduction> {
    pub vm_local_state: &'a VmLocalState<N, E>,
}

#[derive(Clone, Copy, Debug)]
pub struct AfterDecodingData<const N: usize = 8, E: VmEncodingMode<N> = EncodingModeProduction> {
    pub raw_opcode_unmasked: E::IntegerRepresentation, // what one gets from memory
    pub opcode_masked: DecodedOpcode<N, E>,            // what one gets after exception handling
    pub error_flags_accumulated: ErrorFlags,
    pub resolved_condition: bool,
    pub did_skip_cycle: bool,
}

#[derive(Clone, Copy, Debug)]
pub struct BeforeExecutionData<const N: usize = 8, E: VmEncodingMode<N> = EncodingModeProduction> {
    pub opcode: DecodedOpcode<N, E>,
    pub src0_value: PrimitiveValue,
    pub src1_value: PrimitiveValue,
    pub src0_mem_location: Option<MemoryLocation>,
    pub new_pc: E::PcOrImm,
}

#[derive(Clone, Copy, Debug)]
pub struct AfterExecutionData<const N: usize = 8, E: VmEncodingMode<N> = EncodingModeProduction> {
    pub opcode: DecodedOpcode<N, E>,
    pub dst0_mem_location: Option<MemoryLocation>,
}

pub trait Tracer<const N: usize = 8, E: VmEncodingMode<N> = EncodingModeProduction>:
    std::fmt::Debug
{
    const CALL_BEFORE_DECODING: bool = false;
    const CALL_AFTER_DECODING: bool = false;
    const CALL_BEFORE_EXECUTION: bool = false;
    const CALL_AFTER_EXECUTION: bool = false;

    type SupportedMemory: Memory;
    fn before_decoding(
        &mut self,
        state: VmLocalStateData<'_, N, E>,
        memory: &Self::SupportedMemory,
    );
    fn after_decoding(
        &mut self,
        state: VmLocalStateData<'_, N, E>,
        data: AfterDecodingData<N, E>,
        memory: &Self::SupportedMemory,
    );
    fn before_execution(
        &mut self,
        state: VmLocalStateData<'_, N, E>,
        data: BeforeExecutionData<N, E>,
        memory: &Self::SupportedMemory,
    );
    fn after_execution(
        &mut self,
        state: VmLocalStateData<'_, N, E>,
        data: AfterExecutionData<N, E>,
        memory: &Self::SupportedMemory,
    );
}