Struct o1vm::keccak::environment::KeccakEnv

pub struct KeccakEnv<F> {
    pub constraints_env: ConstraintsEnv<F>,
    pub witness_env: WitnessEnv<F>,
    pub step: Option<Steps>,
    /* private fields */
}

This struct contains all that needs to be kept track of during the execution of the Keccak step interpreter

Fields

constraints_env: ConstraintsEnv<F>

Environment for the constraints (includes lookups). The step of the hash that is being executed can be None if just ended

witness_env: WitnessEnv<F>

Environment for the witness (includes multiplicities)

step: Option<Steps>

Current step

Implementations

impl<F: Field> KeccakEnv<F>

pub fn new(hash_idx: u64, preimage: &[u8]) -> Self

Starts a new Keccak environment for a given hash index and bytestring of preimage data

pub fn write_column(&mut self, column: KeccakColumn, value: u64)

Writes an integer value to a column of the Keccak witness

pub fn write_column_field(&mut self, column: KeccakColumn, value: F)

Writes a field value to a column of the Keccak witness

pub fn null_state(&mut self)

Nullifies the Witness and Constraint environments by resetting it to default values (except for table-related) This way, each row only adds the constraints of that step (do not nullify the step)

pub fn selector(&self) -> Steps

Returns the selector of the current step in standardized form

pub fn step(&mut self)

Entrypoint for the interpreter. It executes one step of the Keccak circuit (one row), and updates the environment accordingly (including the witness and inter-step lookups). When it finishes, it updates the value of the current step, so that the next call to the step() function executes the next step.

pub fn update_step(&mut self)

This function updates the next step of the environment depending on the current step

Trait Implementations

impl<F: Clone> Clone for KeccakEnv<F>

fn clone(&self) -> KeccakEnv<F>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<F: Debug> Debug for KeccakEnv<F>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl DecomposableTracer<KeccakEnv<<<KeccakConfig as FoldingConfig>::Curve as AffineCurve>::ScalarField>> for DecomposedKeccakTrace

fn new( domain_size: usize, env: &mut KeccakEnv<<<KeccakConfig as FoldingConfig>::Curve as AffineCurve>::ScalarField> ) -> Self

Create a new decomposable trace with the given domain size, and environment.

fn pad_witnesses(&mut self)

Pads the rows of the witnesses until reaching the domain size using the first row repeatedly. It does not add selector columns.

impl<F: Field> Default for KeccakEnv<F>

fn default() -> Self

Returns the “default value” for a type.

impl Tracer<N_ZKVM_KECCAK_REL_COLS, KeccakConfig, KeccakEnv<<<KeccakConfig as FoldingConfig>::Curve as AffineCurve>::ScalarField>> for KeccakTrace

type Selector = ()

fn init( domain_size: usize, selector: Steps, _env: &mut KeccakEnv<<<KeccakConfig as FoldingConfig>::Curve as AffineCurve>::ScalarField> ) -> Self

Initialize a new trace with the given domain size, selector, and environment.

fn push_row( &mut self, _selector: Self::Selector, row: &[<<KeccakConfig as FoldingConfig>::Curve as AffineCurve>::ScalarField; 2073] )

Add a witness row to the circuit (only for relation columns)

fn pad_with_row( &mut self, _selector: Self::Selector, row: &[<<KeccakConfig as FoldingConfig>::Curve as AffineCurve>::ScalarField; 2073] ) -> usize

Pad the rows of one opcode with the given row until reaching the domain size if needed. Returns the number of rows that were added. It does not add selector columns.

fn pad_with_zeros(&mut self, _selector: Self::Selector) -> usize

Pads the rows of one opcode with zero rows until reaching the domain size if needed. Returns the number of rows that were added. It does not add selector columns.

fn pad_dummy(&mut self, _selector: Self::Selector) -> usize

Pad the rows of one opcode with the first row until reaching the domain size if needed. It only tries to pad witnesses which are non empty. Returns the number of rows that were added. It does not add selector columns.