Struct halo2_proofs::dev::MockProver

source ·
pub struct MockProver<F>
where F: Field,
{ /* private fields */ }
Expand description

A test prover for debugging circuits.

The normal proving process, when applied to a buggy circuit implementation, might return proofs that do not validate when they should, but it can’t indicate anything other than “something is invalid”. MockProver can be used to figure out why these are invalid: it stores all the private inputs along with the circuit internals, and then checks every constraint manually.

§Examples

use halo2_frontend::{
    circuit::{Layouter, SimpleFloorPlanner, Value},
    dev::{FailureLocation, MockProver, VerifyFailure},
    plonk::{circuit::Column, Circuit, ConstraintSystem, Error, Advice, Selector},
};
use halo2_middleware::circuit::{Any, ColumnMid};
use halo2_middleware::poly::Rotation;
use halo2_middleware::ff::PrimeField;
use halo2curves::pasta::Fp;
const K: u32 = 5;

#[derive(Copy, Clone)]
struct MyConfig {
    a: Column<Advice>,
    b: Column<Advice>,
    c: Column<Advice>,
    s: Selector,
}

#[derive(Clone, Default)]
struct MyCircuit {
    a: Value<u64>,
    b: Value<u64>,
}

impl<F: PrimeField> Circuit<F> for MyCircuit {
    type Config = MyConfig;
    type FloorPlanner = SimpleFloorPlanner;
    #[cfg(feature = "circuit-params")]
    type Params = ();

    fn without_witnesses(&self) -> Self {
        Self::default()
    }

    fn configure(meta: &mut ConstraintSystem<F>) -> MyConfig {
        let a = meta.advice_column();
        let b = meta.advice_column();
        let c = meta.advice_column();
        let s = meta.selector();

        meta.create_gate("R1CS constraint", |meta| {
            let a = meta.query_advice(a, Rotation::cur());
            let b = meta.query_advice(b, Rotation::cur());
            let c = meta.query_advice(c, Rotation::cur());
            let s = meta.query_selector(s);

            // BUG: Should be a * b - c
            Some(("buggy R1CS", s * (a * b + c)))
        });

        MyConfig { a, b, c, s }
    }

    fn synthesize(&self, config: MyConfig, mut layouter: impl Layouter<F>) -> Result<(), Error> {
        layouter.assign_region(|| "Example region", |mut region| {
            config.s.enable(&mut region, 0)?;
            region.assign_advice(|| "a", config.a, 0, || {
                self.a.map(F::from)
            })?;
            region.assign_advice(|| "b", config.b, 0, || {
                self.b.map(F::from)
            })?;
            region.assign_advice(|| "c", config.c, 0, || {
                (self.a * self.b).map(F::from)
            })?;
            Ok(())
        })
    }
}

// Assemble the private inputs to the circuit.
let circuit = MyCircuit {
    a: Value::known(2),
    b: Value::known(4),
};

// This circuit has no public inputs.
let instance = vec![];

let prover = MockProver::<Fp>::run(K, &circuit, instance).unwrap();
assert_eq!(
    prover.verify(),
    Err(vec![VerifyFailure::ConstraintNotSatisfied {
        constraint: ((0, "R1CS constraint").into(), 0, "buggy R1CS").into(),
        location: FailureLocation::InRegion {
            region: (0, "Example region").into(),
            offset: 0,
        },
        cell_values: vec![
            ((ColumnMid::new(Any::Advice, 0), 0).into(), "0x2".to_string()),
            ((ColumnMid::new(Any::Advice, 1), 0).into(), "0x4".to_string()),
            ((ColumnMid::new(Any::Advice, 2), 0).into(), "0x8".to_string()),
        ],
    }])
);

// If we provide a too-small K, we get a panic.
use std::panic;
let result = panic::catch_unwind(|| {
    MockProver::<Fp>::run(2, &circuit, vec![]).unwrap_err()
});
assert_eq!(
    result.unwrap_err().downcast_ref::<String>().unwrap(),
    "n=4, minimum_rows=8, k=2"
);

Implementations§

source§

impl<F> MockProver<F>
where F: Field,

source

pub fn advice_mut(&mut self, column_index: usize) -> &mut [CellValue<F>]

Return the content of an advice column as mutable

source

pub fn instance_mut(&mut self, column_index: usize) -> &mut [InstanceValue<F>]

Return the content of an instance column as mutable

source§

impl<F> MockProver<F>
where F: FromUniformBytes<64> + Ord,

source

pub fn run<ConcreteCircuit>( k: u32, circuit: &ConcreteCircuit, instance: Vec<Vec<F>> ) -> Result<MockProver<F>, Error>
where ConcreteCircuit: Circuit<F>,

Runs a synthetic keygen-and-prove operation on the given circuit, collecting data about the constraints and their assignments.

source

pub fn advice_values(&self, column: Column<Advice>) -> &[CellValue<F>]

Return the content of an advice column as assigned by the circuit.

source

pub fn fixed_values(&self, column: Column<Fixed>) -> &[CellValue<F>]

Return the content of a fixed column as assigned by the circuit.

source

pub fn verify(&self) -> Result<(), Vec<VerifyFailure>>

Returns Ok(()) if this MockProver is satisfied, or a list of errors indicating the reasons that the circuit is not satisfied. Constraints and lookup are checked at usable_rows, parallelly.

source

pub fn verify_at_rows<I>( &self, gate_row_ids: I, lookup_input_row_ids: I ) -> Result<(), Vec<VerifyFailure>>
where I: Clone + Iterator<Item = usize>,

Returns Ok(()) if this MockProver is satisfied, or a list of errors indicating the reasons that the circuit is not satisfied. Constraints are only checked at gate_row_ids, and lookup inputs are only checked at lookup_input_row_ids, parallelly.

source

pub fn assert_satisfied(&self)

Panics if the circuit being checked by this MockProver is not satisfied.

Any verification failures will be pretty-printed to stderr before the function panics.

Apart from the stderr output, this method is equivalent to:

assert_eq!(prover.verify(), Ok(()));
source

pub fn assert_satisfied_at_rows<I>( &self, gate_row_ids: I, lookup_input_row_ids: I )
where I: Clone + Iterator<Item = usize>,

Panics if the circuit being checked by this MockProver is not satisfied.

Any verification failures will be pretty-printed to stderr before the function panics.

Constraints are only checked at gate_row_ids, and lookup inputs are only checked at lookup_input_row_ids, parallelly.

Apart from the stderr output, this method is equivalent to:

assert_eq!(prover.verify_at_rows(), Ok(()));
source

pub fn cs(&self) -> &ConstraintSystem<F>

Returns the constraint system

source

pub fn usable_rows(&self) -> &Range<usize>

Returns the usable rows

source

pub fn advice(&self) -> &Vec<Vec<CellValue<F>>>

Returns the list of Advice Columns used within a MockProver instance and the associated values contained on each Cell.

source

pub fn fixed(&self) -> &Vec<Vec<CellValue<F>>>

Returns the list of Fixed Columns used within a MockProver instance and the associated values contained on each Cell.

source

pub fn selectors(&self) -> &Vec<Vec<bool>>

Returns the list of Selector Columns used within a MockProver instance and the associated values contained on each Cell.

source

pub fn instance(&self) -> &Vec<Vec<InstanceValue<F>>>

Returns the list of Instance Columns used within a MockProver instance and the associated values contained on each Cell.

Trait Implementations§

source§

impl<F> Assignment<F> for MockProver<F>
where F: Field,

source§

fn enter_region<NR, N>(&mut self, name: N)
where NR: Into<String>, N: FnOnce() -> NR,

Creates a new region and enters into it. Read more
source§

fn exit_region(&mut self)

Exits the current region. Read more
source§

fn annotate_column<A, AR>(&mut self, annotation: A, column: Column<Any>)
where A: FnOnce() -> AR, AR: Into<String>,

Allows the developer to include an annotation for an specific column within a Region. Read more
source§

fn enable_selector<A, AR>( &mut self, desc: A, selector: &Selector, row: usize ) -> Result<(), Error>
where A: FnOnce() -> AR, AR: Into<String>,

Enables a selector at the given row.
source§

fn query_instance( &self, column: Column<Instance>, row: usize ) -> Result<Value<F>, Error>

Queries the cell of an instance column at a particular absolute row. Read more
source§

fn assign_advice<V, VR, A, AR>( &mut self, desc: A, column: Column<Advice>, row: usize, to: V ) -> Result<(), Error>
where V: FnOnce() -> Value<VR>, VR: Into<Assigned<F>>, A: FnOnce() -> AR, AR: Into<String>,

Assign an advice column value (witness)
source§

fn assign_fixed<V, VR, A, AR>( &mut self, desc: A, column: Column<Fixed>, row: usize, to: V ) -> Result<(), Error>
where V: FnOnce() -> Value<VR>, VR: Into<Assigned<F>>, A: FnOnce() -> AR, AR: Into<String>,

Assign a fixed value
source§

fn copy( &mut self, left_column: Column<Any>, left_row: usize, right_column: Column<Any>, right_row: usize ) -> Result<(), Error>

Assign two cells to have the same value
source§

fn fill_from_row( &mut self, col: Column<Fixed>, from_row: usize, to: Value<Assigned<F>> ) -> Result<(), Error>

Fills a fixed column starting from the given row with value to.
source§

fn get_challenge(&self, challenge: Challenge) -> Value<F>

Queries the value of the given challenge. Read more
source§

fn push_namespace<NR, N>(&mut self, _: N)
where NR: Into<String>, N: FnOnce() -> NR,

Creates a new (sub)namespace and enters into it. Read more
source§

fn pop_namespace(&mut self, _: Option<String>)

Exits out of the existing namespace. Read more
source§

impl<F> Debug for MockProver<F>
where F: Debug + Field,

source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<F> Freeze for MockProver<F>

§

impl<F> RefUnwindSafe for MockProver<F>
where F: RefUnwindSafe,

§

impl<F> Send for MockProver<F>

§

impl<F> Sync for MockProver<F>

§

impl<F> Unpin for MockProver<F>
where F: Unpin,

§

impl<F> UnwindSafe for MockProver<F>
where F: UnwindSafe,

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<T> Conv for T

§

fn conv<T>(self) -> T
where Self: Into<T>,

Converts self into T using Into<T>. Read more
§

impl<T> FmtForward for T

§

fn fmt_binary(self) -> FmtBinary<Self>
where Self: Binary,

Causes self to use its Binary implementation when Debug-formatted.
§

fn fmt_display(self) -> FmtDisplay<Self>
where Self: Display,

Causes self to use its Display implementation when Debug-formatted.
§

fn fmt_lower_exp(self) -> FmtLowerExp<Self>
where Self: LowerExp,

Causes self to use its LowerExp implementation when Debug-formatted.
§

fn fmt_lower_hex(self) -> FmtLowerHex<Self>
where Self: LowerHex,

Causes self to use its LowerHex implementation when Debug-formatted.
§

fn fmt_octal(self) -> FmtOctal<Self>
where Self: Octal,

Causes self to use its Octal implementation when Debug-formatted.
§

fn fmt_pointer(self) -> FmtPointer<Self>
where Self: Pointer,

Causes self to use its Pointer implementation when Debug-formatted.
§

fn fmt_upper_exp(self) -> FmtUpperExp<Self>
where Self: UpperExp,

Causes self to use its UpperExp implementation when Debug-formatted.
§

fn fmt_upper_hex(self) -> FmtUpperHex<Self>
where Self: UpperHex,

Causes self to use its UpperHex implementation when Debug-formatted.
§

fn fmt_list(self) -> FmtList<Self>
where &'a Self: for<'a> IntoIterator,

Formats each item in a sequence. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> IntoEither for T

source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> Pipe for T
where T: ?Sized,

§

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R
where Self: Sized,

Pipes by value. This is generally the method you want to use. Read more
§

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R
where R: 'a,

Borrows self and passes that borrow into the pipe function. Read more
§

fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R
where R: 'a,

Mutably borrows self and passes that borrow into the pipe function. Read more
§

fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
where Self: Borrow<B>, B: 'a + ?Sized, R: 'a,

Borrows self, then passes self.borrow() into the pipe function. Read more
§

fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R ) -> R
where Self: BorrowMut<B>, B: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.borrow_mut() into the pipe function. Read more
§

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
where Self: AsRef<U>, U: 'a + ?Sized, R: 'a,

Borrows self, then passes self.as_ref() into the pipe function.
§

fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
where Self: AsMut<U>, U: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.as_mut() into the pipe function.
§

fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
where Self: Deref<Target = T>, T: 'a + ?Sized, R: 'a,

Borrows self, then passes self.deref() into the pipe function.
§

fn pipe_deref_mut<'a, T, R>( &'a mut self, func: impl FnOnce(&'a mut T) -> R ) -> R
where Self: DerefMut<Target = T> + Deref, T: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.deref_mut() into the pipe function.
§

impl<T> Pointable for T

§

const ALIGN: usize = _

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
source§

impl<T> Same for T

§

type Output = T

Should always be Self
§

impl<T> Tap for T

§

fn tap(self, func: impl FnOnce(&Self)) -> Self

Immutable access to a value. Read more
§

fn tap_mut(self, func: impl FnOnce(&mut Self)) -> Self

Mutable access to a value. Read more
§

fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Immutable access to the Borrow<B> of a value. Read more
§

fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Mutable access to the BorrowMut<B> of a value. Read more
§

fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Immutable access to the AsRef<R> view of a value. Read more
§

fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Mutable access to the AsMut<R> view of a value. Read more
§

fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Immutable access to the Deref::Target of a value. Read more
§

fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Mutable access to the Deref::Target of a value. Read more
§

fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self

Calls .tap() only in debug builds, and is erased in release builds.
§

fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self

Calls .tap_mut() only in debug builds, and is erased in release builds.
§

fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Calls .tap_borrow() only in debug builds, and is erased in release builds.
§

fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Calls .tap_borrow_mut() only in debug builds, and is erased in release builds.
§

fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Calls .tap_ref() only in debug builds, and is erased in release builds.
§

fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Calls .tap_ref_mut() only in debug builds, and is erased in release builds.
§

fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Calls .tap_deref() only in debug builds, and is erased in release builds.
§

fn tap_deref_mut_dbg<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Calls .tap_deref_mut() only in debug builds, and is erased in release builds.
§

impl<T> TryConv for T

§

fn try_conv<T>(self) -> Result<T, Self::Error>
where Self: TryInto<T>,

Attempts to convert self into T using TryInto<T>. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more
source§

impl<T> SyncDeps for T
where T: Send + Sync,