Struct sp1_recursion_compiler::ir::Builder

pub struct Builder<C: Config> {
    pub operations: TracedVec<DslIr<C>>,
    pub program_type: RecursionProgramType,
    /* private fields */
}

A builder for the DSL.

Can compile to both assembly and a set of constraints.

Fields

operations: TracedVec<DslIr<C>>

program_type: RecursionProgramType

Implementations

impl<F: PrimeField32 + TwoAdicField, EF: ExtensionField<F> + TwoAdicField> Builder<AsmConfig<F, EF>>

pub fn compile_asm(self) -> AssemblyCode<F, EF>

Compile to assembly code.

pub fn compile_program(self) -> RecursionProgram<F>

Compile to a program that can be executed in the recursive zkVM.

impl<C: Config> Builder<C>

pub fn num2bits_v(&mut self, num: Var<C::N>) -> Array<C, Var<C::N>>

Converts a variable to LE bits.

pub fn range_check_v(&mut self, num: Var<C::N>, num_bits: usize)

Range checks a variable to a certain number of bits.

pub fn num2bits_v_circuit( &mut self, num: Var<C::N>, bits: usize, ) -> Vec<Var<C::N>>

Converts a variable to bits inside a circuit.

pub fn range_check_f(&mut self, num: Felt<C::F>, num_bits: usize)

Range checks a felt to a certain number of bits.

pub fn num2bits_f(&mut self, num: Felt<C::F>) -> Array<C, Var<C::N>>

Converts a felt to bits.

pub fn num2bits_f_circuit(&mut self, num: Felt<C::F>) -> Vec<Var<C::N>>

Converts a felt to bits inside a circuit.

pub fn bits2num_v(&mut self, bits: &Array<C, Var<C::N>>) -> Var<C::N>

Convert bits to a variable.

pub fn bits2num_v_circuit(&mut self, bits: &[Var<C::N>]) -> Var<C::N>

Convert bits to a variable inside a circuit.

pub fn bits2num_f(&mut self, bits: &Array<C, Var<C::N>>) -> Felt<C::F>

Convert bits to a felt.

pub fn reverse_bits_len( &mut self, index_bits: &Array<C, Var<C::N>>, bit_len: impl Into<Usize<C::N>>, ) -> Array<C, Var<C::N>>

Reverse a list of bits.

SAFETY: calling this function with bit_len greater NUM_BITS will result in undefined behavior.

Reference: p3_util::reverse_bits_len

pub fn reverse_bits_len_circuit( &mut self, index_bits: Vec<Var<C::N>>, bit_len: usize, ) -> Vec<Var<C::N>>

Reverse a list of bits inside a circuit.

SAFETY: calling this function with bit_len greater NUM_BITS will result in undefined behavior.

Reference: p3_util::reverse_bits_len

impl<C: Config> Builder<C>

pub fn new(program_type: RecursionProgramType) -> Self

pub fn new_sub_builder( var_count: u32, felt_count: u32, ext_count: u32, nb_public_values: Option<Var<C::N>>, p2_hash_num: Var<C::N>, debug: bool, program_type: RecursionProgramType, ) -> Self

Creates a new builder with a given number of counts for each type.

pub fn push(&mut self, op: DslIr<C>)

Pushes an operation to the builder.

pub fn trace_push(&mut self, op: DslIr<C>)

Pushes an operation to the builder and records a trace if SP1_DEBUG.

pub fn uninit<V: Variable<C>>(&mut self) -> V

Creates an uninitialized variable.

pub fn eval<V: Variable<C>, E: Into<V::Expression>>(&mut self, expr: E) -> V

Evaluates an expression and returns a variable.

pub fn constant<V: FromConstant<C>>(&mut self, value: V::Constant) -> V

Evaluates a constant expression and returns a variable.

pub fn assign<V: Variable<C>, E: Into<V::Expression>>( &mut self, dst: V, expr: E, )

Assigns an expression to a variable.

pub fn assert_eq<V: Variable<C>>( &mut self, lhs: impl Into<V::Expression>, rhs: impl Into<V::Expression>, )

Asserts that two expressions are equal.

pub fn assert_ne<V: Variable<C>>( &mut self, lhs: impl Into<V::Expression>, rhs: impl Into<V::Expression>, )

Asserts that two expressions are not equal.

pub fn assert_var_eq<LhsExpr: Into<SymbolicVar<C::N>>, RhsExpr: Into<SymbolicVar<C::N>>>( &mut self, lhs: LhsExpr, rhs: RhsExpr, )

Assert that two vars are equal.

pub fn assert_var_ne<LhsExpr: Into<SymbolicVar<C::N>>, RhsExpr: Into<SymbolicVar<C::N>>>( &mut self, lhs: LhsExpr, rhs: RhsExpr, )

Assert that two vars are not equal.

pub fn assert_felt_eq<LhsExpr: Into<SymbolicFelt<C::F>>, RhsExpr: Into<SymbolicFelt<C::F>>>( &mut self, lhs: LhsExpr, rhs: RhsExpr, )

Assert that two felts are equal.

pub fn assert_felt_ne<LhsExpr: Into<SymbolicFelt<C::F>>, RhsExpr: Into<SymbolicFelt<C::F>>>( &mut self, lhs: LhsExpr, rhs: RhsExpr, )

Assert that two felts are not equal.

pub fn assert_usize_eq<LhsExpr: Into<SymbolicUsize<C::N>>, RhsExpr: Into<SymbolicUsize<C::N>>>( &mut self, lhs: LhsExpr, rhs: RhsExpr, )

Assert that two usizes are equal.

pub fn assert_usize_ne( &mut self, lhs: impl Into<SymbolicUsize<C::N>>, rhs: impl Into<SymbolicUsize<C::N>>, )

Assert that two usizes are not equal.

pub fn assert_ext_eq<LhsExpr: Into<SymbolicExt<C::F, C::EF>>, RhsExpr: Into<SymbolicExt<C::F, C::EF>>>( &mut self, lhs: LhsExpr, rhs: RhsExpr, )

Assert that two exts are equal.

pub fn assert_ext_ne<LhsExpr: Into<SymbolicExt<C::F, C::EF>>, RhsExpr: Into<SymbolicExt<C::F, C::EF>>>( &mut self, lhs: LhsExpr, rhs: RhsExpr, )

Assert that two exts are not equal.

pub fn lt(&mut self, lhs: Var<C::N>, rhs: Var<C::N>) -> Var<C::N>

pub fn if_eq<LhsExpr: Into<SymbolicVar<C::N>>, RhsExpr: Into<SymbolicVar<C::N>>>( &mut self, lhs: LhsExpr, rhs: RhsExpr, ) -> IfBuilder<'_, C>

Evaluate a block of operations if two expressions are equal.

pub fn if_ne<LhsExpr: Into<SymbolicVar<C::N>>, RhsExpr: Into<SymbolicVar<C::N>>>( &mut self, lhs: LhsExpr, rhs: RhsExpr, ) -> IfBuilder<'_, C>

Evaluate a block of operations if two expressions are not equal.

pub fn range( &mut self, start: impl Into<Usize<C::N>>, end: impl Into<Usize<C::N>>, ) -> RangeBuilder<'_, C>

Evaluate a block of operations over a range from start to end.

pub fn break_loop(&mut self)

Break out of a loop.

pub fn print_debug(&mut self, val: usize)

pub fn print_v(&mut self, dst: Var<C::N>)

Print a variable.

pub fn print_f(&mut self, dst: Felt<C::F>)

Print a felt.

pub fn print_e(&mut self, dst: Ext<C::F, C::EF>)

Print an ext.

pub fn hint_len(&mut self) -> Var<C::N>

Hint the length of the next vector of variables.

pub fn hint_var(&mut self) -> Var<C::N>

Hint a single variable.

pub fn hint_felt(&mut self) -> Felt<C::F>

Hint a single felt.

pub fn hint_ext(&mut self) -> Ext<C::F, C::EF>

Hint a single ext.

pub fn hint_vars(&mut self) -> Array<C, Var<C::N>>

Hint a vector of variables.

pub fn hint_felts(&mut self) -> Array<C, Felt<C::F>>

Hint a vector of felts.

pub fn hint_exts(&mut self) -> Array<C, Ext<C::F, C::EF>>

Hint a vector of exts.

pub fn witness_var(&mut self) -> Var<C::N>

pub fn witness_felt(&mut self) -> Felt<C::F>

pub fn witness_ext(&mut self) -> Ext<C::F, C::EF>

pub fn error(&mut self)

Throws an error.

pub fn materialize(&mut self, num: Usize<C::N>) -> Var<C::N>

Materializes a usize into a variable.

pub fn register_public_value(&mut self, val: Felt<C::F>)

Register a felt as public value. This is append to the proof’s public values buffer.

pub fn commit_public_value(&mut self, val: Felt<C::F>)

Register and commits a felt as public value. This value will be constrained when verified.

pub fn commit_public_values(&mut self, vals: &Array<C, Felt<C::F>>)

Commits an array of felts in public values.

pub fn commit_vkey_hash_circuit(&mut self, var: Var<C::N>)

pub fn commit_commited_values_digest_circuit(&mut self, var: Var<C::N>)

pub fn cycle_tracker(&mut self, name: &str)

pub fn halt(&mut self)

impl<C: Config> Builder<C>

pub fn array<V: MemVariable<C>>( &mut self, len: impl Into<Usize<C::N>>, ) -> Array<C, V>

Initialize an array of fixed length len. The entries will be uninitialized.

pub fn vec<V: MemVariable<C>>(&mut self, v: Vec<V>) -> Array<C, V>

Creates an array from a vector.

pub fn dyn_array<V: MemVariable<C>>( &mut self, len: impl Into<Usize<C::N>>, ) -> Array<C, V>

Creates a dynamic array for a length.

pub fn get<V: MemVariable<C>, I: Into<Usize<C::N>>>( &mut self, slice: &Array<C, V>, index: I, ) -> V

pub fn get_ptr<V: MemVariable<C>, I: Into<Usize<C::N>>>( &mut self, slice: &Array<C, V>, index: I, ) -> Ptr<C::N>

pub fn set<V: MemVariable<C>, I: Into<Usize<C::N>>, Expr: Into<V::Expression>>( &mut self, slice: &mut Array<C, V>, index: I, value: Expr, )

pub fn set_value<V: MemVariable<C>, I: Into<Usize<C::N>>>( &mut self, slice: &mut Array<C, V>, index: I, value: V, )

impl<C: Config> Builder<C>

pub fn poseidon2_permute( &mut self, array: &Array<C, Felt<C::F>>, ) -> Array<C, Felt<C::F>>

Applies the Poseidon2 permutation to the given array.

Reference: p3_poseidon2::Poseidon2

pub fn poseidon2_permute_mut(&mut self, array: &Array<C, Felt<C::F>>)

Applies the Poseidon2 permutation to the given array.

Reference: p3_poseidon2::Poseidon2

pub fn poseidon2_absorb( &mut self, p2_hash_num: Var<C::N>, input: &Array<C, Felt<C::F>>, )

Applies the Poseidon2 absorb function to the given array.

Reference: p3_symmetric::PaddingFreeSponge

pub fn poseidon2_finalize_mut( &mut self, p2_hash_num: Var<C::N>, output: &Array<C, Felt<C::F>>, )

Applies the Poseidon2 finalize to the given hash number.

Reference: p3_symmetric::PaddingFreeSponge

pub fn poseidon2_compress( &mut self, left: &Array<C, Felt<C::F>>, right: &Array<C, Felt<C::F>>, ) -> Array<C, Felt<C::F>>

Applies the Poseidon2 compression function to the given array.

Reference: p3_symmetric::TruncatedPermutation

pub fn poseidon2_compress_x( &mut self, result: &mut Array<C, Felt<C::F>>, left: &Array<C, Felt<C::F>>, right: &Array<C, Felt<C::F>>, )

Applies the Poseidon2 compression to the given array.

Reference: p3_symmetric::TruncatedPermutation

pub fn poseidon2_hash( &mut self, array: &Array<C, Felt<C::F>>, ) -> Array<C, Felt<C::F>>

Applies the Poseidon2 permutation to the given array.

Reference: p3_symmetric::PaddingFreeSponge

pub fn poseidon2_hash_x( &mut self, array: &Array<C, Array<C, Felt<C::F>>>, ) -> Array<C, Felt<C::F>>

pub fn poseidon2_hash_ext( &mut self, array: &Array<C, Array<C, Ext<C::F, C::EF>>>, ) -> Array<C, Felt<C::F>>

impl<C: Config> Builder<C>

pub fn load<V: MemVariable<C>>( &mut self, var: V, ptr: Ptr<C::N>, index: MemIndex<C::N>, )

Loads a value from memory.

pub fn store<V: MemVariable<C>>( &mut self, ptr: Ptr<C::N>, index: MemIndex<C::N>, value: V, )

Stores a value to memory.

impl<C: Config> Builder<C>

pub fn generator(&mut self) -> Felt<C::F>

The generator for the field.

Reference: p3_baby_bear::BabyBear

pub fn select_v( &mut self, cond: Var<C::N>, a: Var<C::N>, b: Var<C::N>, ) -> Var<C::N>

Select a variable based on a condition.

pub fn select_f( &mut self, cond: Var<C::N>, a: Felt<C::F>, b: Felt<C::F>, ) -> Felt<C::F>

Select a felt based on a condition.

pub fn select_ef( &mut self, cond: Var<C::N>, a: Ext<C::F, C::EF>, b: Ext<C::F, C::EF>, ) -> Ext<C::F, C::EF>

Select an extension based on a condition.

pub fn exp_power_of_2<V: Variable<C>, E: Into<V::Expression>>( &mut self, e: E, power_log: usize, ) -> V

where V::Expression: MulAssign<V::Expression> + Clone,

Exponentiates a variable to a power of two.

pub fn exp_bits<V>(&mut self, x: V, power_bits: &Array<C, Var<C::N>>) -> V

where V::Expression: AbstractField, V: Copy + Mul<Output = V::Expression> + Variable<C>,

Exponentializes a variable to an array of bits in little endian.

pub fn exp_f_bits( &mut self, x: Felt<C::F>, power_bits: Vec<Var<C::N>>, ) -> Felt<C::F>

Exponentiates a felt to a list of bits in little endian.

pub fn exp_e_bits( &mut self, x: Ext<C::F, C::EF>, power_bits: Vec<Var<C::N>>, ) -> Ext<C::F, C::EF>

Exponentiates a extension to a list of bits in little endian.

pub fn exp_reverse_bits_len<V>( &mut self, x: V, power_bits: &Array<C, Var<C::N>>, bit_len: impl Into<Usize<C::N>>, ) -> V

where V::Expression: AbstractField, V: Copy + Mul<Output = V::Expression> + Variable<C>,

Exponetiates a varibale to a list of reversed bits with a given length.

Reference: p3_util::reverse_bits_len

pub fn exp_reverse_bits_len_fast( &mut self, x: Felt<C::F>, power_bits: &Array<C, Var<C::N>>, bit_len: impl Into<Usize<C::N>>, ) -> Felt<C::F>

A version of exp_reverse_bits_len that uses the ExpReverseBitsLen precompile.

pub fn exp_power_of_2_v<V>( &mut self, base: impl Into<V::Expression>, power_log: impl Into<Usize<C::N>>, ) -> V

where V: Variable<C> + Copy + Mul<Output = V::Expression>,

Exponentiates a variable to a list of bits in little endian.

pub fn exp_power_of_2_v_circuit<V>( &mut self, base: impl Into<V::Expression>, power_log: usize, ) -> V

where V: Copy + Mul<Output = V::Expression> + Variable<C>,

Exponentiates a variable to a list of bits in little endian insid a circuit.

pub fn sll<V>( &mut self, base: impl Into<V::Expression>, shift: Usize<C::N>, ) -> V

where V: Variable<C> + Copy + Add<Output = V::Expression>,

Multiplies base by 2^{log_power}.

pub fn ext_from_base_slice(&mut self, arr: &[Felt<C::F>]) -> Ext<C::F, C::EF>

Creates an ext from a slice of felts.

pub fn felts2ext(&mut self, felts: &[Felt<C::F>]) -> Ext<C::F, C::EF>

pub fn ext2felt(&mut self, value: Ext<C::F, C::EF>) -> Array<C, Felt<C::F>>

Converts an ext to a slice of felts.

pub fn ext2felt_circuit(&mut self, value: Ext<C::F, C::EF>) -> [Felt<C::F>; 4]

Converts an ext to a slice of felts inside a circuit.

Trait Implementations

impl<C: Clone + Config> Clone for Builder<C>

where C::N: Clone,

fn clone(&self) -> Builder<C>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<C: Debug + Config> Debug for Builder<C>

where C::N: Debug,

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

Formats the value using the given formatter.

impl<C: Config> Default for Builder<C>

fn default() -> Self

Returns the “default value” for a type.