zkevm_circuits 0.153.12

ZKsync Era circuits for EraVM
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

use super::*;
use boojum::field::SmallField;
use boojum::gadgets::u256::UInt256;

use boojum::gadgets::boolean::Boolean;
use boojum::gadgets::u16::UInt16;
use boojum::gadgets::u32::UInt32;

use boojum::cs::traits::cs::ConstraintSystem;
use boojum::cs::traits::cs::DstBuffer;
use boojum::cs::Variable;
use boojum::gadgets::traits::allocatable::{CSAllocatable, CSAllocatableExt};
use boojum::gadgets::traits::encodable::CircuitVarLengthEncodable;
use boojum::gadgets::traits::encodable::WitnessVarLengthEncodable;
use boojum::gadgets::traits::selectable::Selectable;
use boojum::gadgets::traits::witnessable::WitnessHookable;

use cs_derive::*;

#[derive(
    Derivative,
    CSSelectable,
    CSAllocatable,
    CSVarLengthEncodable,
    WitnessHookable,
    WitVarLengthEncodable,
)]
#[derivative(Clone, Copy, Debug, Hash)]
pub struct VMRegister<F: SmallField> {
    pub is_pointer: Boolean<F>,
    pub value: UInt256<F>,
}

impl<F: SmallField> VMRegister<F> {
    pub fn zero<CS: ConstraintSystem<F>>(cs: &mut CS) -> Self {
        let boolean_false = Boolean::allocated_constant(cs, false);
        let zero_u256 = UInt256::zero(cs);

        Self {
            is_pointer: boolean_false,
            value: zero_u256,
        }
    }

    pub fn from_imm<CS: ConstraintSystem<F>>(cs: &mut CS, imm: UInt16<F>) -> Self {
        let boolean_false = Boolean::allocated_constant(cs, false);
        let zero_u32 = UInt32::zero(cs);

        Self {
            is_pointer: boolean_false,
            value: UInt256 {
                inner: [
                    unsafe { UInt32::from_variable_unchecked(imm.get_variable()) },
                    zero_u32,
                    zero_u32,
                    zero_u32,
                    zero_u32,
                    zero_u32,
                    zero_u32,
                    zero_u32,
                ],
            },
        }
    }

    pub fn conditionally_erase<CS: ConstraintSystem<F>>(
        &mut self,
        cs: &mut CS,
        condition: Boolean<F>,
    ) {
        self.is_pointer = self.is_pointer.mask_negated(cs, condition);
        self.value = self.value.mask_negated(cs, condition);
    }

    pub fn conditionally_erase_fat_pointer_data<CS: ConstraintSystem<F>>(
        &mut self,
        cs: &mut CS,
        condition: Boolean<F>,
    ) {
        self.is_pointer = self.is_pointer.mask_negated(cs, condition);
        // we need to erase bits 32-64 and 64-96
        self.value.inner[1] = self.value.inner[1].mask_negated(cs, condition);
        self.value.inner[2] = self.value.inner[2].mask_negated(cs, condition);
    }
}

impl<F: SmallField> CSAllocatableExt<F> for VMRegister<F> {
    const INTERNAL_STRUCT_LEN: usize = 9;

    fn flatten_as_variables(&self) -> [Variable; Self::INTERNAL_STRUCT_LEN] {
        // NOTE: CSAllocatable is done by the macro, so it allocates in the order of declaration,
        // and we should do the same here!

        [
            self.is_pointer.get_variable(),
            self.value.inner[0].get_variable(),
            self.value.inner[1].get_variable(),
            self.value.inner[2].get_variable(),
            self.value.inner[3].get_variable(),
            self.value.inner[4].get_variable(),
            self.value.inner[5].get_variable(),
            self.value.inner[6].get_variable(),
            self.value.inner[7].get_variable(),
        ]
    }

    fn set_internal_variables_values(_witness: Self::Witness, _dst: &mut DstBuffer<'_, '_, F>) {
        todo!()
    }

    fn witness_from_set_of_values(_values: [F; Self::INTERNAL_STRUCT_LEN]) -> Self::Witness {
        todo!()
    }
}