zkevm_opcode_defs 0.153.11

ZKsync EraVM opcode definitions
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

use crate::DecodedOpcode;
use ethereum_types::U256;

pub mod encoding_mode_production;
pub mod encoding_mode_testing;

pub use self::encoding_mode_production::EncodingModeProduction;
pub use self::encoding_mode_testing::EncodingModeTesting;

#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)]
pub struct VariantMonotonicNumber(pub usize);

impl VariantMonotonicNumber {
    #[inline]
    pub const fn from_usize(value: usize) -> Self {
        Self(value)
    }

    #[inline]
    pub const fn into_usize(self) -> usize {
        self.0 as usize
    }
}

pub trait AllowedIntegerRepresentation<const N: usize>:
    Clone + Copy + Send + Sync + PartialEq + Eq + Default + std::fmt::Debug + std::fmt::LowerHex
{
    fn encode_as_bytes(self) -> [u8; N];
}

impl AllowedIntegerRepresentation<16> for u128 {
    fn encode_as_bytes(self) -> [u8; 16] {
        self.to_be_bytes()
    }
}

impl AllowedIntegerRepresentation<8> for u64 {
    fn encode_as_bytes(self) -> [u8; 8] {
        self.to_be_bytes()
    }
}

pub trait AllowedPcOrImm:
    Clone + Copy + Send + Sync + PartialEq + Eq + Default + std::fmt::Debug + std::fmt::LowerHex
{
    fn from_u64_clipped(value: u64) -> Self;
    fn as_u64(self) -> u64;
    fn wrapping_add(self, other: Self) -> Self;
    fn wrapping_sub(self, other: Self) -> Self;
    fn max() -> Self;
}

impl AllowedPcOrImm for u16 {
    #[inline]
    fn from_u64_clipped(value: u64) -> Self {
        value as Self
    }
    #[inline]
    fn as_u64(self) -> u64 {
        self as u64
    }
    #[inline]
    fn wrapping_add(self, other: Self) -> Self {
        self.wrapping_add(other)
    }
    #[inline]
    fn wrapping_sub(self, other: Self) -> Self {
        self.wrapping_sub(other)
    }
    #[inline]
    fn max() -> Self {
        u16::MAX
    }
}
impl AllowedPcOrImm for u32 {
    #[inline]
    fn from_u64_clipped(value: u64) -> Self {
        value as Self
    }
    #[inline]
    fn as_u64(self) -> u64 {
        self as u64
    }
    #[inline]
    fn wrapping_add(self, other: Self) -> Self {
        self.wrapping_add(other)
    }
    #[inline]
    fn wrapping_sub(self, other: Self) -> Self {
        self.wrapping_sub(other)
    }
    #[inline]
    fn max() -> Self {
        u32::MAX
    }
}

// Some abstraction over encoding mode
// to be able to parse integer representation, as well as memory words
pub trait VmEncodingMode<const N: usize>:
    Clone + Copy + Send + Sync + PartialEq + Eq + std::fmt::Debug
{
    type PcOrImm: AllowedPcOrImm;
    type IntegerRepresentation: AllowedIntegerRepresentation<N>;

    fn nop_encoding() -> Self::IntegerRepresentation;
    fn exception_revert_encoding() -> Self::IntegerRepresentation;

    fn parse_preliminary_variant_and_absolute_number(
        integer_representaiton: Self::IntegerRepresentation,
    ) -> (DecodedOpcode<N, Self>, VariantMonotonicNumber);

    fn encode_as_integer(opcode: &DecodedOpcode<N, Self>) -> Self::IntegerRepresentation;

    fn encode_as_bytes(opcode: &DecodedOpcode<N, Self>) -> [u8; N];

    fn split_pc(pc: Self::PcOrImm) -> (Self::PcOrImm, Self::PcOrImm);

    fn integer_representaiton_from_u256(
        value: U256,
        index: Self::PcOrImm,
    ) -> Self::IntegerRepresentation;

    // there may be some unused bits, but we want canonicality
    fn is_canonical_encoding(value: Self::IntegerRepresentation) -> bool;
}