Struct halo2_proofs::dev::MockProver
source · pub struct MockProver<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 group::ff::PrimeField;
use halo2_proofs::{
circuit::{Layouter, SimpleFloorPlanner, Value},
dev::{FailureLocation, MockProver, VerifyFailure},
pasta::Fp,
plonk::{Advice, Any, Circuit, Column, ConstraintSystem, Error, Selector},
poly::Rotation,
};
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;
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![
(((Any::Advice, 0).into(), 0).into(), "0x2".to_string()),
(((Any::Advice, 1).into(), 0).into(), "0x4".to_string()),
(((Any::Advice, 2).into(), 0).into(), "0x8".to_string()),
],
}])
);
// If we provide a too-small K, we get an error.
assert!(matches!(
MockProver::<Fp>::run(2, &circuit, vec![]).unwrap_err(),
Error::NotEnoughRowsAvailable {
current_k,
} if current_k == 2,
));
Implementations§
source§impl<F: Field + Ord> MockProver<F>
impl<F: Field + Ord> MockProver<F>
sourcepub fn run<ConcreteCircuit: Circuit<F>>(
k: u32,
circuit: &ConcreteCircuit,
instance: Vec<Vec<F>>
) -> Result<Self, Error>
pub fn run<ConcreteCircuit: Circuit<F>>( k: u32, circuit: &ConcreteCircuit, instance: Vec<Vec<F>> ) -> Result<Self, Error>
Runs a synthetic keygen-and-prove operation on the given circuit, collecting data about the constraints and their assignments.
sourcepub fn verify(&self) -> Result<(), Vec<VerifyFailure>>
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.
sourcepub fn assert_satisfied(&self)
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(()));
Trait Implementations§
source§impl<F: Field> Assignment<F> for MockProver<F>
impl<F: Field> Assignment<F> for MockProver<F>
source§fn enter_region<NR, N>(&mut self, name: N)where
NR: Into<String>,
N: FnOnce() -> NR,
fn enter_region<NR, N>(&mut self, name: N)where NR: Into<String>, N: FnOnce() -> NR,
source§fn exit_region(&mut self)
fn exit_region(&mut self)
source§fn enable_selector<A, AR>(
&mut self,
_: A,
selector: &Selector,
row: usize
) -> Result<(), Error>where
A: FnOnce() -> AR,
AR: Into<String>,
fn enable_selector<A, AR>( &mut self, _: A, selector: &Selector, row: usize ) -> Result<(), Error>where A: FnOnce() -> AR, AR: Into<String>,
source§fn query_instance(
&self,
column: Column<Instance>,
row: usize
) -> Result<Value<F>, Error>
fn query_instance( &self, column: Column<Instance>, row: usize ) -> Result<Value<F>, Error>
source§fn assign_advice<V, VR, A, AR>(
&mut self,
_: 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>,
fn assign_advice<V, VR, A, AR>( &mut self, _: 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>,
source§fn assign_fixed<V, VR, A, AR>(
&mut self,
_: 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>,
fn assign_fixed<V, VR, A, AR>( &mut self, _: 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>,
source§fn copy(
&mut self,
left_column: Column<Any>,
left_row: usize,
right_column: Column<Any>,
right_row: usize
) -> Result<(), Error>
fn copy( &mut self, left_column: Column<Any>, left_row: usize, right_column: Column<Any>, right_row: usize ) -> Result<(), Error>
source§fn fill_from_row(
&mut self,
col: Column<Fixed>,
from_row: usize,
to: Value<Assigned<F>>
) -> Result<(), Error>
fn fill_from_row( &mut self, col: Column<Fixed>, from_row: usize, to: Value<Assigned<F>> ) -> Result<(), Error>
column
starting from the given row
with value to
.Auto Trait Implementations§
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§
§impl<T> Conv for T
impl<T> Conv for T
§impl<T> FmtForward for T
impl<T> FmtForward for T
§fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
fn fmt_binary(self) -> FmtBinary<Self>where Self: Binary,
self
to use its Binary
implementation when Debug
-formatted.§fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
fn fmt_display(self) -> FmtDisplay<Self>where Self: Display,
self
to use its Display
implementation when
Debug
-formatted.§fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
fn fmt_lower_exp(self) -> FmtLowerExp<Self>where Self: LowerExp,
self
to use its LowerExp
implementation when
Debug
-formatted.§fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
fn fmt_lower_hex(self) -> FmtLowerHex<Self>where Self: LowerHex,
self
to use its LowerHex
implementation when
Debug
-formatted.§fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
fn fmt_octal(self) -> FmtOctal<Self>where Self: Octal,
self
to use its Octal
implementation when Debug
-formatted.§fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
fn fmt_pointer(self) -> FmtPointer<Self>where Self: Pointer,
self
to use its Pointer
implementation when
Debug
-formatted.§fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
fn fmt_upper_exp(self) -> FmtUpperExp<Self>where Self: UpperExp,
self
to use its UpperExp
implementation when
Debug
-formatted.§fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
fn fmt_upper_hex(self) -> FmtUpperHex<Self>where Self: UpperHex,
self
to use its UpperHex
implementation when
Debug
-formatted.§fn fmt_list(self) -> FmtList<Self>where
&'a Self: for<'a> IntoIterator,
fn fmt_list(self) -> FmtList<Self>where &'a Self: for<'a> IntoIterator,
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
§impl<T> Pipe for Twhere
T: ?Sized,
impl<T> Pipe for Twhere T: ?Sized,
§fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere Self: Sized,
§fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere R: 'a,
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) -> Rwhere
R: 'a,
fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere R: 'a,
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) -> Rwhere
Self: Borrow<B>,
B: 'a + ?Sized,
R: 'a,
fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> Rwhere Self: Borrow<B>, B: 'a + ?Sized, R: 'a,
§fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R
) -> Rwhere
Self: BorrowMut<B>,
B: 'a + ?Sized,
R: 'a,
fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R ) -> Rwhere Self: BorrowMut<B>, B: 'a + ?Sized, R: 'a,
§fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> Rwhere
Self: AsRef<U>,
U: 'a + ?Sized,
R: 'a,
fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> Rwhere Self: AsRef<U>, U: 'a + ?Sized, R: 'a,
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) -> Rwhere
Self: AsMut<U>,
U: 'a + ?Sized,
R: 'a,
fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> Rwhere Self: AsMut<U>, U: 'a + ?Sized, R: 'a,
self
, then passes self.as_mut()
into the pipe
function.§impl<T> Pointable for T
impl<T> Pointable for T
§impl<T> Tap for T
impl<T> Tap for T
§fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Selfwhere
Self: Borrow<B>,
B: ?Sized,
fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Selfwhere Self: Borrow<B>, B: ?Sized,
Borrow<B>
of a value. Read more§fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Selfwhere
Self: BorrowMut<B>,
B: ?Sized,
fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Selfwhere Self: BorrowMut<B>, B: ?Sized,
BorrowMut<B>
of a value. Read more§fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Selfwhere
Self: AsRef<R>,
R: ?Sized,
fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Selfwhere Self: AsRef<R>, R: ?Sized,
AsRef<R>
view of a value. Read more§fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Selfwhere
Self: AsMut<R>,
R: ?Sized,
fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Selfwhere Self: AsMut<R>, R: ?Sized,
AsMut<R>
view of a value. Read more§fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Selfwhere
Self: Deref<Target = T>,
T: ?Sized,
fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Selfwhere Self: Deref<Target = T>, T: ?Sized,
Deref::Target
of a value. Read more§fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Selfwhere
Self: DerefMut<Target = T> + Deref,
T: ?Sized,
fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Selfwhere Self: DerefMut<Target = T> + Deref, T: ?Sized,
Deref::Target
of a value. Read more§fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
.tap()
only in debug builds, and is erased in release builds.§fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
.tap_mut()
only in debug builds, and is erased in release
builds.§fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Selfwhere
Self: Borrow<B>,
B: ?Sized,
fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Selfwhere Self: Borrow<B>, B: ?Sized,
.tap_borrow()
only in debug builds, and is erased in release
builds.§fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Selfwhere
Self: BorrowMut<B>,
B: ?Sized,
fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Selfwhere Self: BorrowMut<B>, B: ?Sized,
.tap_borrow_mut()
only in debug builds, and is erased in release
builds.§fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Selfwhere
Self: AsRef<R>,
R: ?Sized,
fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Selfwhere Self: AsRef<R>, R: ?Sized,
.tap_ref()
only in debug builds, and is erased in release
builds.§fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Selfwhere
Self: AsMut<R>,
R: ?Sized,
fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Selfwhere Self: AsMut<R>, R: ?Sized,
.tap_ref_mut()
only in debug builds, and is erased in release
builds.