Struct AggregationCircuit

pub struct AggregationCircuit {
    pub builder: BaseCircuitBuilder<Fr>,
    /* private fields */
}

Fields

builder: BaseCircuitBuilder<Fr>

Circuit builder consisting of virtual region managers

Implementations

impl AggregationCircuit

pub fn previous_instances(&self) -> &Vec<Vec<AssignedValue<Fr>>>

The (flattened) public instances from previous snarks that were aggregated, now collected as PRIVATE assigned values.

• If previous snark was from aggregation circuit, the previous instances will still contain the old KZG accumulator.

The user can optionally append these private witnesses to inner.assigned_instances to expose them.

pub fn preprocessed(&self) -> &Vec<PreprocessedAndDomainAsWitness>

This returns the assigned preprocessed_digest (vkey), optional transcript_initial_state, domain.n (optional), and omega (optional) values as a vector of assigned values, one for each aggregated snark. These can then be exposed as public instances.

impl AggregationCircuit

pub fn new<AS>( stage: CircuitBuilderStage, config_params: AggregationConfigParams, params: &ParamsKZG<Bn256>, snarks: impl IntoIterator<Item = Snark>, universality: VerifierUniversality, ) -> Self

where AS: for<'a> Halo2KzgAccumulationScheme<'a>,

Given snarks, this creates BaseCircuitBuilder and populates the circuit builder with the virtual cells and constraints necessary to verify all the snarks.

By default, the returned circuit has public instances equal to the limbs of the pair of elliptic curve points, referred to as the accumulator, that need to be verified in a final pairing check.

Universality

• If universality is not None, then the verifying keys of each snark in snarks is loaded as a witness in the circuit.
• Moreover, if universality is Full, then the number of rows n of each snark in snarks is also loaded as a witness. In this case the generator omega of the order n multiplicative subgroup of F is also loaded as a witness.
• By default, these witnesses are private and returned in `self.preprocessed_digests
• The user can optionally modify the circuit after calling this function to add more instances to assigned_instances to expose.

Warning

Will fail silently if snarks were created using a different multi-open scheme than AS where AS can be either crate::SHPLONK or crate::GWC (for original PLONK multi-open scheme)

pub fn expose_previous_instances(&mut self, has_prev_accumulator: bool)

Re-expose the previous public instances of aggregated snarks again. If hash_prev_accumulator is true, then we assume all aggregated snarks were themselves aggregation snarks, and we exclude the old accumulators from the public input.

pub fn lookup_bits(&self) -> usize

The log_2 size of the lookup table

pub fn set_params(&mut self, params: AggregationConfigParams)

Set config params

pub fn use_params(self, params: AggregationConfigParams) -> Self

Returns new with config params

pub fn break_points(&self) -> MultiPhaseThreadBreakPoints

The break points of the circuit.

pub fn set_break_points(&mut self, break_points: MultiPhaseThreadBreakPoints)

Sets the break points of the circuit.

pub fn use_break_points(self, break_points: MultiPhaseThreadBreakPoints) -> Self

Returns new with break points

pub fn calculate_params( &mut self, minimum_rows: Option<usize>, ) -> AggregationConfigParams

Auto-configure the circuit and change the circuit’s internal configuration parameters.

Trait Implementations

impl Circuit<Fr> for AggregationCircuit

type Config = BaseConfig<Fr>

This is a configuration object that stores things like columns.

type FloorPlanner = SimpleFloorPlanner

The floor planner used for this circuit. This is an associated type of the Circuit trait because its behaviour is circuit-critical.

type Params = AggregationConfigParams

Optional circuit configuration parameters. Requires the circuit-params feature.

fn params(&self) -> Self::Params

Returns a reference to the parameters that should be used to configure the circuit. Requires the circuit-params feature.

fn without_witnesses(&self) -> Self

Returns a copy of this circuit with no witness values (i.e. all witnesses set to None). For most circuits, this will be equal to Self::default().

fn configure_with_params( meta: &mut ConstraintSystem<Fr>, params: Self::Params, ) -> Self::Config

The circuit is given an opportunity to describe the exact gate arrangement, column arrangement, etc. Takes a runtime parameter. The default implementation calls configure ignoring the _params argument in order to easily support circuits that don’t use configuration parameters.

fn configure(_: &mut ConstraintSystem<Fr>) -> Self::Config

The circuit is given an opportunity to describe the exact gate arrangement, column arrangement, etc.

fn synthesize( &self, config: Self::Config, layouter: impl Layouter<Fr>, ) -> Result<(), Error>

Given the provided cs, synthesize the circuit. The concrete type of the caller will be different depending on the context, and they may or may not expect to have a witness present.

impl CircuitExt<Fr> for AggregationCircuit

fn num_instance(&self) -> Vec<usize>

Return the number of instances of the circuit. This may depend on extra circuit parameters but NOT on private witnesses.

fn instances(&self) -> Vec<Vec<Fr>>

fn accumulator_indices() -> Option<Vec<(usize, usize)>>

fn selectors(config: &Self::Config) -> Vec<Selector>

Output the simple selector columns (before selector compression) of the circuit

impl Clone for AggregationCircuit

fn clone(&self) -> AggregationCircuit

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AggregationCircuit

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

Formats the value using the given formatter.