zkevm_circuits 0.153.9

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
115
116
117
118
119
120
121
122
123
124

use crate::base_structures::{
    memory_query::{MemoryQuery, MEMORY_QUERY_PACKED_WIDTH},
    vm_state::*,
};
use crate::boojum::gadgets::traits::auxiliary::PrettyComparison;
use crate::DEFAULT_NUM_PERMUTATION_ARGUMENT_REPETITIONS;
use boojum::cs::{traits::cs::ConstraintSystem, Variable};
use boojum::field::SmallField;
use boojum::gadgets::{
    boolean::Boolean,
    num::Num,
    queue::full_state_queue::*,
    queue::*,
    traits::{
        allocatable::*, encodable::CircuitVarLengthEncodable, encodable::WitnessVarLengthEncodable,
        selectable::Selectable, witnessable::WitnessHookable,
    },
    u256::UInt256,
    u32::UInt32,
};
use boojum::serde_utils::BigArraySerde;
use cs_derive::*;
use derivative::*;

#[derive(
    Derivative,
    CSAllocatable,
    CSSelectable,
    CSVarLengthEncodable,
    WitnessHookable,
    WitVarLengthEncodable,
)]
#[derivative(Clone, Debug)]
pub struct RamPermutationInputData<F: SmallField> {
    pub unsorted_queue_initial_state: QueueState<F, FULL_SPONGE_QUEUE_STATE_WIDTH>,
    pub sorted_queue_initial_state: QueueState<F, FULL_SPONGE_QUEUE_STATE_WIDTH>,
    pub non_deterministic_bootloader_memory_snapshot_length: UInt32<F>,
}

impl<F: SmallField> CSPlaceholder<F> for RamPermutationInputData<F> {
    fn placeholder<CS: ConstraintSystem<F>>(cs: &mut CS) -> Self {
        let zero_u32 = UInt32::zero(cs);
        let empty_state = QueueState::placeholder(cs);

        Self {
            unsorted_queue_initial_state: empty_state,
            sorted_queue_initial_state: empty_state,
            non_deterministic_bootloader_memory_snapshot_length: zero_u32,
        }
    }
}

pub const RAM_SORTING_KEY_LENGTH: usize = 3;
pub const RAM_FULL_KEY_LENGTH: usize = 2;

#[derive(
    Derivative,
    CSAllocatable,
    CSSelectable,
    CSVarLengthEncodable,
    WitnessHookable,
    WitVarLengthEncodable,
)]
#[derivative(Clone, Copy, Debug)]
#[DerivePrettyComparison("true")]
pub struct RamPermutationFSMInputOutput<F: SmallField> {
    pub lhs_accumulator: [Num<F>; DEFAULT_NUM_PERMUTATION_ARGUMENT_REPETITIONS],
    pub rhs_accumulator: [Num<F>; DEFAULT_NUM_PERMUTATION_ARGUMENT_REPETITIONS],
    pub current_unsorted_queue_state: QueueState<F, FULL_SPONGE_QUEUE_STATE_WIDTH>,
    pub current_sorted_queue_state: QueueState<F, FULL_SPONGE_QUEUE_STATE_WIDTH>,
    pub previous_sorting_key: [UInt32<F>; RAM_SORTING_KEY_LENGTH],
    pub previous_full_key: [UInt32<F>; RAM_FULL_KEY_LENGTH],
    pub previous_value: UInt256<F>,
    pub previous_is_ptr: Boolean<F>,
    pub num_nondeterministic_writes: UInt32<F>,
}

impl<F: SmallField> CSPlaceholder<F> for RamPermutationFSMInputOutput<F> {
    fn placeholder<CS: ConstraintSystem<F>>(cs: &mut CS) -> Self {
        let zero_num = Num::zero(cs);
        let zero_u32 = UInt32::zero(cs);
        let zero_u256 = UInt256::zero(cs);
        let boolean_false = Boolean::allocated_constant(cs, false);
        let empty_state = QueueState::placeholder(cs);

        Self {
            lhs_accumulator: [zero_num; DEFAULT_NUM_PERMUTATION_ARGUMENT_REPETITIONS],
            rhs_accumulator: [zero_num; DEFAULT_NUM_PERMUTATION_ARGUMENT_REPETITIONS],
            current_unsorted_queue_state: empty_state,
            current_sorted_queue_state: empty_state,
            previous_sorting_key: [zero_u32; RAM_SORTING_KEY_LENGTH],
            previous_full_key: [zero_u32; RAM_FULL_KEY_LENGTH],
            previous_value: zero_u256,
            previous_is_ptr: boolean_false,
            num_nondeterministic_writes: zero_u32,
        }
    }
}

pub type RamPermutationCycleInputOutput<F> = crate::fsm_input_output::ClosedFormInput<
    F,
    RamPermutationFSMInputOutput<F>,
    RamPermutationInputData<F>,
    (),
>;
pub type RamPermutationCycleInputOutputWitness<F> = crate::fsm_input_output::ClosedFormInputWitness<
    F,
    RamPermutationFSMInputOutput<F>,
    RamPermutationInputData<F>,
    (),
>;

#[derive(Derivative, serde::Serialize, serde::Deserialize)]
#[derivative(Clone, Debug, Default)]
#[serde(bound = "")]
pub struct RamPermutationCircuitInstanceWitness<F: SmallField> {
    pub closed_form_input: RamPermutationCycleInputOutputWitness<F>,

    pub unsorted_queue_witness: Vec<<MemoryQuery<F> as CSAllocatable<F>>::Witness>,
    pub sorted_queue_witness: Vec<<MemoryQuery<F> as CSAllocatable<F>>::Witness>,
}

pub type MemoryQueriesQueue<F, R> =
    FullStateCircuitQueue<F, MemoryQuery<F>, 8, 12, 4, MEMORY_QUERY_PACKED_WIDTH, R>;