zkevm_circuits 0.153.9

use cs_derive::*;

use super::*;
use crate::ethereum_types::U256;
use boojum::cs::traits::cs::ConstraintSystem;
use boojum::cs::traits::cs::DstBuffer;
use boojum::cs::Variable;
use boojum::gadgets::boolean::Boolean;
use boojum::gadgets::num::Num;
use boojum::gadgets::traits::allocatable::CSPlaceholder;
use boojum::gadgets::traits::allocatable::{CSAllocatable, CSAllocatableExt};
use boojum::gadgets::traits::castable::WitnessCastable;
use boojum::gadgets::traits::encodable::CircuitVarLengthEncodable;
use boojum::gadgets::traits::encodable::WitnessVarLengthEncodable;
use boojum::gadgets::traits::encodable::{CircuitEncodable, CircuitEncodableExt};
use boojum::gadgets::traits::selectable::Selectable;
use boojum::gadgets::traits::witnessable::WitnessHookable;
use boojum::gadgets::u32::UInt32;
use boojum::{field::SmallField, gadgets::u256::UInt256};

#[derive(
    Derivative,
    CSAllocatable,
    CSSelectable,
    WitnessHookable,
    CSVarLengthEncodable,
    WitVarLengthEncodable,
)]
#[derivative(Clone, Copy, Debug)]
pub struct DecommitQuery<F: SmallField> {
    pub code_hash: UInt256<F>,
    pub page: UInt32<F>,
    pub is_first: Boolean<F>,
    pub timestamp: UInt32<F>,
}

pub const DECOMMIT_QUERY_PACKED_WIDTH: usize = 8;

impl<F: SmallField> CircuitEncodable<F, DECOMMIT_QUERY_PACKED_WIDTH> for DecommitQuery<F> {
    fn encode<CS: ConstraintSystem<F>>(
        &self,
        cs: &mut CS,
    ) -> [Variable; DECOMMIT_QUERY_PACKED_WIDTH] {
        debug_assert!(F::CAPACITY_BITS >= 56);

        // we assume that page bytes are known, so it'll be nop anyway
        let page_bytes = self.page.decompose_into_bytes(cs);

        let timestamp_bytes = self.timestamp.decompose_into_bytes(cs);

        let v0 = Num::linear_combination(
            cs,
            &[
                (self.code_hash.inner[0].get_variable(), F::ONE),
                (
                    page_bytes[0].get_variable(),
                    F::from_u64_unchecked(1u64 << 32),
                ),
                (
                    page_bytes[1].get_variable(),
                    F::from_u64_unchecked(1u64 << 40),
                ),
                (
                    page_bytes[2].get_variable(),
                    F::from_u64_unchecked(1u64 << 48),
                ),
            ],
        )
        .get_variable();

        let v1 = Num::linear_combination(
            cs,
            &[
                (self.code_hash.inner[1].get_variable(), F::ONE),
                (
                    page_bytes[3].get_variable(),
                    F::from_u64_unchecked(1u64 << 32),
                ),
                (
                    timestamp_bytes[0].get_variable(),
                    F::from_u64_unchecked(1u64 << 40),
                ),
                (
                    timestamp_bytes[1].get_variable(),
                    F::from_u64_unchecked(1u64 << 48),
                ),
            ],
        )
        .get_variable();

        let v2 = Num::linear_combination(
            cs,
            &[
                (self.code_hash.inner[2].get_variable(), F::ONE),
                (
                    timestamp_bytes[2].get_variable(),
                    F::from_u64_unchecked(1u64 << 32),
                ),
                (
                    timestamp_bytes[3].get_variable(),
                    F::from_u64_unchecked(1u64 << 40),
                ),
                (
                    self.is_first.get_variable(),
                    F::from_u64_unchecked(1u64 << 48),
                ),
            ],
        )
        .get_variable();

        let v3 = self.code_hash.inner[3].get_variable();
        let v4 = self.code_hash.inner[4].get_variable();
        let v5 = self.code_hash.inner[5].get_variable();
        let v6 = self.code_hash.inner[6].get_variable();
        let v7 = self.code_hash.inner[7].get_variable();

        [v0, v1, v2, v3, v4, v5, v6, v7]
    }
}

impl<F: SmallField> CSAllocatableExt<F> for DecommitQuery<F> {
    const INTERNAL_STRUCT_LEN: usize = 11;

    fn witness_from_set_of_values(values: [F; Self::INTERNAL_STRUCT_LEN]) -> Self::Witness {
        let code_hash: U256 = WitnessCastable::cast_from_source([
            values[0], values[1], values[2], values[3], values[4], values[5], values[6], values[7],
        ]);

        let page: u32 = WitnessCastable::cast_from_source(values[8]);
        let is_first: bool = WitnessCastable::cast_from_source(values[9]);
        let timestamp: u32 = WitnessCastable::cast_from_source(values[10]);

        Self::Witness {
            code_hash,
            page,
            is_first,
            timestamp,
        }
    }

    fn flatten_as_variables(&self) -> [Variable; Self::INTERNAL_STRUCT_LEN]
    where
        [(); Self::INTERNAL_STRUCT_LEN]:,
    {
        [
            self.code_hash.inner[0].get_variable(),
            self.code_hash.inner[1].get_variable(),
            self.code_hash.inner[2].get_variable(),
            self.code_hash.inner[3].get_variable(),
            self.code_hash.inner[4].get_variable(),
            self.code_hash.inner[5].get_variable(),
            self.code_hash.inner[6].get_variable(),
            self.code_hash.inner[7].get_variable(),
            self.page.get_variable(),
            self.is_first.get_variable(),
            self.timestamp.get_variable(),
        ]
    }
    fn set_internal_variables_values(witness: Self::Witness, dst: &mut DstBuffer<'_, '_, F>) {
        // NOTE: must be same sequence as in `flatten_as_variables`
        UInt256::set_internal_variables_values(witness.code_hash, dst);
        UInt32::set_internal_variables_values(witness.page, dst);
        Boolean::set_internal_variables_values(witness.is_first, dst);
        UInt32::set_internal_variables_values(witness.timestamp, dst);
    }
}

impl<F: SmallField> CircuitEncodableExt<F, DECOMMIT_QUERY_PACKED_WIDTH> for DecommitQuery<F> {}

impl<F: SmallField> CSPlaceholder<F> for DecommitQuery<F> {
    fn placeholder<CS: ConstraintSystem<F>>(cs: &mut CS) -> Self {
        let zero_u32 = UInt32::zero(cs);
        let boolean_false = Boolean::allocated_constant(cs, false);
        Self {
            code_hash: UInt256::<F>::zero(cs),
            page: zero_u32,
            is_first: boolean_false,
            timestamp: zero_u32,
        }
    }
}

use boojum::gadgets::queue::full_state_queue::{
    FullStateCircuitQueue, FullStateCircuitQueueWitness,
};

pub type DecommitQueryQueue<F, const AW: usize, const SW: usize, const CW: usize, R> =
    FullStateCircuitQueue<F, DecommitQuery<F>, AW, SW, CW, DECOMMIT_QUERY_PACKED_WIDTH, R>;

pub type DecommitQueue<F, R> = DecommitQueryQueue<F, 8, 12, 4, R>;

pub type DecommitQueueWitness<F, const SW: usize> =
    FullStateCircuitQueueWitness<F, DecommitQuery<F>, SW, DECOMMIT_QUERY_PACKED_WIDTH>;