Struct halo2_proofs::dev::MockProver
source · [−]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_proofs::{
arithmetic::FieldExt,
circuit::{Layouter, SimpleFloorPlanner},
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: Option<u64>,
b: Option<u64>,
}
impl<F: FieldExt> 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(|v| F::from(v)).ok_or(Error::Synthesis)
})?;
region.assign_advice(|| "b", config.b, 0, || {
self.b.map(|v| F::from(v)).ok_or(Error::Synthesis)
})?;
region.assign_advice(|| "c", config.c, 0, || {
self.a
.and_then(|a| self.b.map(|b| F::from(a * b)))
.ok_or(Error::Synthesis)
})?;
Ok(())
})
}
}
// Assemble the private inputs to the circuit.
let circuit = MyCircuit {
a: Some(2),
b: Some(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
sourceimpl<F: FieldExt> MockProver<F>
impl<F: FieldExt> 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
sourceimpl<F: Field + Group> Assignment<F> for MockProver<F>
impl<F: Field + Group> Assignment<F> for MockProver<F>
sourcefn 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,
Creates a new region and enters into it. Read more
sourcefn exit_region(&mut self)
fn exit_region(&mut self)
Exits the current region. Read more
sourcefn 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>,
Enables a selector at the given row.
sourcefn query_instance(
&self,
column: Column<Instance>,
row: usize
) -> Result<Option<F>, Error>
fn query_instance(
&self,
column: Column<Instance>,
row: usize
) -> Result<Option<F>, Error>
Queries the cell of an instance column at a particular absolute row. Read more
sourcefn assign_advice<V, VR, A, AR>(
&mut self,
_: A,
column: Column<Advice>,
row: usize,
to: V
) -> Result<(), Error> where
V: FnOnce() -> Result<VR, Error>,
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() -> Result<VR, Error>,
VR: Into<Assigned<F>>,
A: FnOnce() -> AR,
AR: Into<String>,
Assign an advice column value (witness)
sourcefn assign_fixed<V, VR, A, AR>(
&mut self,
_: A,
column: Column<Fixed>,
row: usize,
to: V
) -> Result<(), Error> where
V: FnOnce() -> Result<VR, Error>,
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() -> Result<VR, Error>,
VR: Into<Assigned<F>>,
A: FnOnce() -> AR,
AR: Into<String>,
Assign a fixed value
sourcefn 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>
Assign two cells to have the same value
sourcefn fill_from_row(
&mut self,
col: Column<Fixed>,
from_row: usize,
to: Option<Assigned<F>>
) -> Result<(), Error>
fn fill_from_row(
&mut self,
col: Column<Fixed>,
from_row: usize,
to: Option<Assigned<F>>
) -> Result<(), Error>
Fills a fixed column
starting from the given row
with value to
.
sourcefn push_namespace<NR, N>(&mut self, _: N) where
NR: Into<String>,
N: FnOnce() -> NR,
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
sourcefn pop_namespace(&mut self, _: Option<String>)
fn pop_namespace(&mut self, _: Option<String>)
Exits out of the existing namespace. Read more
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
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
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,
Causes 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,
Causes self
to use its Display
implementation when
Debug
-formatted. Read more
fn fmt_lower_exp(self) -> FmtLowerExp<Self> where
Self: LowerExp,
fn fmt_lower_exp(self) -> FmtLowerExp<Self> where
Self: LowerExp,
Causes self
to use its LowerExp
implementation when
Debug
-formatted. Read more
fn fmt_lower_hex(self) -> FmtLowerHex<Self> where
Self: LowerHex,
fn fmt_lower_hex(self) -> FmtLowerHex<Self> where
Self: LowerHex,
Causes self
to use its LowerHex
implementation when
Debug
-formatted. Read more
fn fmt_octal(self) -> FmtOctal<Self> where
Self: Octal,
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,
fn fmt_pointer(self) -> FmtPointer<Self> where
Self: Pointer,
Causes self
to use its Pointer
implementation when
Debug
-formatted. Read more
fn fmt_upper_exp(self) -> FmtUpperExp<Self> where
Self: UpperExp,
fn fmt_upper_exp(self) -> FmtUpperExp<Self> where
Self: UpperExp,
Causes self
to use its UpperExp
implementation when
Debug
-formatted. Read more
fn fmt_upper_hex(self) -> FmtUpperHex<Self> where
Self: UpperHex,
fn fmt_upper_hex(self) -> FmtUpperHex<Self> where
Self: UpperHex,
Causes self
to use its UpperHex
implementation when
Debug
-formatted. Read more
impl<T> Pipe for T where
T: ?Sized,
impl<T> Pipe for T where
T: ?Sized,
fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R
fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R
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,
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,
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,
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,
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,
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,
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. Read more
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,
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.
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)) -> Self where
Self: Borrow<B>,
B: ?Sized,
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,
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,
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,
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,
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,
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
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
fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
Calls .tap_mut()
only in debug builds, and is erased in release
builds. Read more
fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self where
Self: Borrow<B>,
B: ?Sized,
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. Read more
fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self where
Self: BorrowMut<B>,
B: ?Sized,
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. Read more
fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self where
Self: AsRef<R>,
R: ?Sized,
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. Read more
fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self where
Self: AsMut<R>,
R: ?Sized,
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. Read more