zec
/
halo2
mirror of https://github.com/zcash/halo2.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
halo2/tests/plonk_api.rs

799 lines
26 KiB
Rust
Raw Normal View History

Disable clippy::{many_single_char_names,op_ref} lint in integration test.
2021-02-26 09:33:59 -08:00
#![allow(clippy::many_single_char_names)]
#![allow(clippy::op_ref)]
Move PLONK integration tests into the tests subdirectory.
2021-02-25 12:29:25 -08:00
use group::Curve;
use halo2::arithmetic::FieldExt;
use halo2::dev::MockProver;
use halo2::pasta::{EqAffine, Fp};
use halo2::plonk::{
create_proof, keygen_pk, keygen_vk, verify_proof, Advice, Assignment, Circuit, Column,
ConstraintSystem, Error, Fixed, Permutation, VerifyingKey,
};
use halo2::poly::{
commitment::{Blind, Params},
Rotation,
};
Replace ChallengeSpace with EncodedChallenge API Co-authored-by: Sean Bowe <ewillbefull@gmail.com>
2021-04-30 18:28:50 -07:00
use halo2::transcript::{Blake2bRead, Blake2bWrite, Challenge255};
Move PLONK integration tests into the tests subdirectory.
2021-02-25 12:29:25 -08:00
use std::marker::PhantomData;
#[test]
fn plonk_api() {
const K: u32 = 5;
/// This represents an advice column at a certain row in the ConstraintSystem
#[derive(Copy, Clone, Debug)]
pub struct Variable(Column<Advice>, usize);
// Initialize the polynomial commitment parameters
let params: Params<EqAffine> = Params::new(K);
#[derive(Clone)]
struct PLONKConfig {
a: Column<Advice>,
b: Column<Advice>,
c: Column<Advice>,
d: Column<Advice>,
e: Column<Advice>,
sa: Column<Fixed>,
sb: Column<Fixed>,
sc: Column<Fixed>,
sm: Column<Fixed>,
sp: Column<Fixed>,
sl: Column<Fixed>,
sl2: Column<Fixed>,
perm: Permutation,
perm2: Permutation,
}
trait StandardCS<FF: FieldExt> {
fn raw_multiply<F>(&mut self, f: F) -> Result<(Variable, Variable, Variable), Error>
where
F: FnOnce() -> Result<(FF, FF, FF), Error>;
fn raw_add<F>(&mut self, f: F) -> Result<(Variable, Variable, Variable), Error>
where
F: FnOnce() -> Result<(FF, FF, FF), Error>;
fn copy(&mut self, a: Variable, b: Variable) -> Result<(), Error>;
fn public_input<F>(&mut self, f: F) -> Result<Variable, Error>
where
F: FnOnce() -> Result<FF, Error>;
fn lookup_table(&mut self, values: &[Vec<FF>]) -> Result<(), Error>;
}
#[derive(Clone)]
struct MyCircuit<F: FieldExt> {
a: Option<F>,
lookup_tables: Vec<Vec<F>>,
}
struct StandardPLONK<'a, F: FieldExt, CS: Assignment<F> + 'a> {
cs: &'a mut CS,
config: PLONKConfig,
current_gate: usize,
_marker: PhantomData<F>,
}
impl<'a, FF: FieldExt, CS: Assignment<FF>> StandardPLONK<'a, FF, CS> {
fn new(cs: &'a mut CS, config: PLONKConfig) -> Self {
StandardPLONK {
cs,
config,
current_gate: 0,
_marker: PhantomData,
}
}
}
impl<'a, FF: FieldExt, CS: Assignment<FF>> StandardCS<FF> for StandardPLONK<'a, FF, CS> {
fn raw_multiply<F>(&mut self, f: F) -> Result<(Variable, Variable, Variable), Error>
where
F: FnOnce() -> Result<(FF, FF, FF), Error>,
{
let index = self.current_gate;
self.current_gate += 1;
let mut value = None;
self.cs.assign_advice(
|| "lhs",
self.config.a,
index,
|| {
value = Some(f()?);
Ok(value.ok_or(Error::SynthesisError)?.0)
},
)?;
self.cs.assign_advice(
|| "lhs^4",
self.config.d,
index,
|| Ok(value.ok_or(Error::SynthesisError)?.0.square().square()),
)?;
self.cs.assign_advice(
|| "rhs",
self.config.b,
index,
|| Ok(value.ok_or(Error::SynthesisError)?.1),
)?;
self.cs.assign_advice(
|| "rhs^4",
self.config.e,
index,
|| Ok(value.ok_or(Error::SynthesisError)?.1.square().square()),
)?;
self.cs.assign_advice(
|| "out",
self.config.c,
index,
|| Ok(value.ok_or(Error::SynthesisError)?.2),
)?;
self.cs
.assign_fixed(|| "a", self.config.sa, index, || Ok(FF::zero()))?;
self.cs
.assign_fixed(|| "b", self.config.sb, index, || Ok(FF::zero()))?;
self.cs
.assign_fixed(|| "c", self.config.sc, index, || Ok(FF::one()))?;
self.cs
.assign_fixed(|| "a * b", self.config.sm, index, || Ok(FF::one()))?;
Ok((
Variable(self.config.a, index),
Variable(self.config.b, index),
Variable(self.config.c, index),
))
}
fn raw_add<F>(&mut self, f: F) -> Result<(Variable, Variable, Variable), Error>
where
F: FnOnce() -> Result<(FF, FF, FF), Error>,
{
let index = self.current_gate;
self.current_gate += 1;
let mut value = None;
self.cs.assign_advice(
|| "lhs",
self.config.a,
index,
|| {
value = Some(f()?);
Ok(value.ok_or(Error::SynthesisError)?.0)
},
)?;
self.cs.assign_advice(
|| "lhs^4",
self.config.d,
index,
|| Ok(value.ok_or(Error::SynthesisError)?.0.square().square()),
)?;
self.cs.assign_advice(
|| "rhs",
self.config.b,
index,
|| Ok(value.ok_or(Error::SynthesisError)?.1),
)?;
self.cs.assign_advice(
|| "rhs^4",
self.config.e,
index,
|| Ok(value.ok_or(Error::SynthesisError)?.1.square().square()),
)?;
self.cs.assign_advice(
|| "out",
self.config.c,
index,
|| Ok(value.ok_or(Error::SynthesisError)?.2),
)?;
self.cs
.assign_fixed(|| "a", self.config.sa, index, || Ok(FF::one()))?;
self.cs
.assign_fixed(|| "b", self.config.sb, index, || Ok(FF::one()))?;
self.cs
.assign_fixed(|| "c", self.config.sc, index, || Ok(FF::one()))?;
self.cs
.assign_fixed(|| "a * b", self.config.sm, index, || Ok(FF::zero()))?;
Ok((
Variable(self.config.a, index),
Variable(self.config.b, index),
Variable(self.config.c, index),
))
}
fn copy(&mut self, left: Variable, right: Variable) -> Result<(), Error> {
self.cs.copy(
&self.config.perm,
left.0.into(),
left.1,
right.0.into(),
right.1,
)?;
self.cs.copy(
&self.config.perm2,
left.0.into(),
left.1,
right.0.into(),
right.1,
)
}
fn public_input<F>(&mut self, f: F) -> Result<Variable, Error>
where
F: FnOnce() -> Result<FF, Error>,
{
let index = self.current_gate;
self.current_gate += 1;
self.cs
.assign_advice(|| "value", self.config.a, index, || f())?;
self.cs
.assign_fixed(|| "public", self.config.sp, index, || Ok(FF::one()))?;
Ok(Variable(self.config.a, index))
}
fn lookup_table(&mut self, values: &[Vec<FF>]) -> Result<(), Error> {
for (&value_0, &value_1) in values[0].iter().zip(values[1].iter()) {
let index = self.current_gate;
self.current_gate += 1;
self.cs
.assign_fixed(|| "table col 1", self.config.sl, index, || Ok(value_0))?;
self.cs
.assign_fixed(|| "table col 2", self.config.sl2, index, || Ok(value_1))?;
}
Ok(())
}
}
impl<F: FieldExt> Circuit<F> for MyCircuit<F> {
type Config = PLONKConfig;
fn configure(meta: &mut ConstraintSystem<F>) -> PLONKConfig {
let e = meta.advice_column();
let a = meta.advice_column();
let b = meta.advice_column();
let sf = meta.fixed_column();
let c = meta.advice_column();
let d = meta.advice_column();
let p = meta.instance_column();
let perm = meta.permutation(&[a.into(), b.into(), c.into()]);
let perm2 = meta.permutation(&[a.into(), b.into(), c.into()]);
let sm = meta.fixed_column();
let sa = meta.fixed_column();
let sb = meta.fixed_column();
let sc = meta.fixed_column();
let sp = meta.fixed_column();
let sl = meta.fixed_column();
let sl2 = meta.fixed_column();
/*
* A B ... sl sl2
* [
* instance 0 ... 0 0
* a a ... 0 0
* a a^2 ... 0 0
* a a ... 0 0
* a a^2 ... 0 0
* ... ... ... ... ...
* ... ... ... instance 0
* ... ... ... a a
* ... ... ... a a^2
* ... ... ... 0 0
* ]
*/
`ConstraintSystem::lookup`: Move lookup queries into a closure This matches `ConstraintSystem::create_gate`. At the same time, we bind the input and table expressions together as a "table map" by requiring the closure to return a vector of tuples. This ensures they are always the same length.
2021-05-26 16:37:32 -07:00
meta.lookup(|meta| {
let a_ = meta.query_any(a.into(), Rotation::cur());
let sl_ = meta.query_any(sl.into(), Rotation::cur());
vec![(a_, sl_)]
});
meta.lookup(|meta| {
let a_ = meta.query_any(a.into(), Rotation::cur());
let b_ = meta.query_any(b.into(), Rotation::cur());
let sl_ = meta.query_any(sl.into(), Rotation::cur());
let sl2_ = meta.query_any(sl2.into(), Rotation::cur());
vec![(a_ * b_, sl_ * sl2_)]
});
Move PLONK integration tests into the tests subdirectory.
2021-02-25 12:29:25 -08:00
meta.create_gate("Combined add-mult", |meta| {
let d = meta.query_advice(d, Rotation::next());
let a = meta.query_advice(a, Rotation::cur());
let sf = meta.query_fixed(sf, Rotation::cur());
let e = meta.query_advice(e, Rotation::prev());
let b = meta.query_advice(b, Rotation::cur());
let c = meta.query_advice(c, Rotation::cur());
let sa = meta.query_fixed(sa, Rotation::cur());
let sb = meta.query_fixed(sb, Rotation::cur());
let sc = meta.query_fixed(sc, Rotation::cur());
let sm = meta.query_fixed(sm, Rotation::cur());
Allow multiple polynomial constraints per gate This enables a gate such as ECC complete addition to define its constraints in terms of a common set of queried columns.
2021-05-27 06:44:02 -07:00
vec![
a.clone() * sa
+ b.clone() * sb
+ a * b * sm
+ (c * sc * (-F::one()))
+ sf * (d * e),
]
Move PLONK integration tests into the tests subdirectory.
2021-02-25 12:29:25 -08:00
});
meta.create_gate("Public input", |meta| {
let a = meta.query_advice(a, Rotation::cur());
let p = meta.query_instance(p, Rotation::cur());
let sp = meta.query_fixed(sp, Rotation::cur());
Allow multiple polynomial constraints per gate This enables a gate such as ECC complete addition to define its constraints in terms of a common set of queried columns.
2021-05-27 06:44:02 -07:00
vec![sp * (a + p * (-F::one()))]
Move PLONK integration tests into the tests subdirectory.
2021-02-25 12:29:25 -08:00
});
PLONKConfig {
a,
b,
c,
d,
e,
sa,
sb,
sc,
sm,
sp,
sl,
sl2,
perm,
perm2,
}
}
fn synthesize(
&self,
cs: &mut impl Assignment<F>,
config: PLONKConfig,
) -> Result<(), Error> {
let mut cs = StandardPLONK::new(cs, config);
let _ = cs.public_input(|| Ok(F::one() + F::one()))?;
for _ in 0..10 {
let mut a_squared = None;
let (a0, _, c0) = cs.raw_multiply(|| {
a_squared = self.a.map(|a| a.square());
Ok((
self.a.ok_or(Error::SynthesisError)?,
self.a.ok_or(Error::SynthesisError)?,
a_squared.ok_or(Error::SynthesisError)?,
))
})?;
let (a1, b1, _) = cs.raw_add(|| {
let fin = a_squared.and_then(|a2| self.a.map(|a| a + a2));
Ok((
self.a.ok_or(Error::SynthesisError)?,
a_squared.ok_or(Error::SynthesisError)?,
fin.ok_or(Error::SynthesisError)?,
))
})?;
cs.copy(a0, a1)?;
cs.copy(b1, c0)?;
}
cs.lookup_table(&self.lookup_tables)?;
Ok(())
}
}
let a = Fp::from_u64(2834758237) * Fp::ZETA;
let a_squared = a * &a;
let instance = Fp::one() + Fp::one();
let lookup_table = vec![instance, a, a, Fp::zero()];
let lookup_table_2 = vec![Fp::zero(), a, a_squared, Fp::zero()];
let empty_circuit: MyCircuit<Fp> = MyCircuit {
a: None,
lookup_tables: vec![lookup_table.clone(), lookup_table_2.clone()],
};
let circuit: MyCircuit<Fp> = MyCircuit {
a: Some(a),
lookup_tables: vec![lookup_table, lookup_table_2],
};
// Initialize the proving key
let vk = keygen_vk(&params, &empty_circuit).expect("keygen_vk should not fail");
let pk = keygen_pk(&params, vk, &empty_circuit).expect("keygen_pk should not fail");
let mut pubinputs = pk.get_vk().get_domain().empty_lagrange();
pubinputs[0] = instance;
let pubinput = params
.commit_lagrange(&pubinputs, Blind::default())
.to_affine();
// Check this circuit is satisfied.
let prover = match MockProver::run(K, &circuit, vec![pubinputs.to_vec()]) {
Ok(prover) => prover,
Err(e) => panic!("{:?}", e),
};
assert_eq!(prover.verify(), Ok(()));
for _ in 0..10 {
Input as associated type on EncodedChallenge Use Input as an associated type instead of a type parameter, to reduce infection Co-authored-by: Sean Bowe <ewillbefull@gmail.com>
2021-05-07 07:21:54 -07:00
let mut transcript = Blake2bWrite::<_, _, Challenge255<_>>::init(vec![]);
Move PLONK integration tests into the tests subdirectory.
2021-02-25 12:29:25 -08:00
// Create a proof
create_proof(
&params,
&pk,
&[circuit.clone(), circuit.clone()],
&[&[pubinputs.clone()], &[pubinputs.clone()]],
&mut transcript,
)
.expect("proof generation should not fail");
let proof: Vec<u8> = transcript.finalize();
let pubinput_slice = &[pubinput];
let pubinput_slice_copy = &[pubinput];
let msm = params.empty_msm();
Input as associated type on EncodedChallenge Use Input as an associated type instead of a type parameter, to reduce infection Co-authored-by: Sean Bowe <ewillbefull@gmail.com>
2021-05-07 07:21:54 -07:00
let mut transcript = Blake2bRead::<_, _, Challenge255<_>>::init(&proof[..]);
Move PLONK integration tests into the tests subdirectory.
2021-02-25 12:29:25 -08:00
let guard = verify_proof(
&params,
pk.get_vk(),
msm,
&[pubinput_slice, pubinput_slice_copy],
&mut transcript,
)
.unwrap();
{
let msm = guard.clone().use_challenges();
assert!(msm.eval());
}
{
let g = guard.compute_g();
let (msm, _) = guard.clone().use_g(g);
assert!(msm.eval());
}
let msm = guard.clone().use_challenges();
assert!(msm.clone().eval());
Input as associated type on EncodedChallenge Use Input as an associated type instead of a type parameter, to reduce infection Co-authored-by: Sean Bowe <ewillbefull@gmail.com>
2021-05-07 07:21:54 -07:00
let mut transcript = Blake2bRead::<_, _, Challenge255<_>>::init(&proof[..]);
Move PLONK integration tests into the tests subdirectory.
2021-02-25 12:29:25 -08:00
let mut vk_buffer = vec![];
pk.get_vk().write(&mut vk_buffer).unwrap();
let vk = VerifyingKey::<EqAffine>::read::<_, MyCircuit<Fp>>(&mut &vk_buffer[..], &params)
.unwrap();
let guard = verify_proof(
&params,
&vk,
msm,
&[pubinput_slice, pubinput_slice_copy],
&mut transcript,
)
.unwrap();
{
let msm = guard.clone().use_challenges();
assert!(msm.eval());
}
{
let g = guard.compute_g();
let (msm, _) = guard.clone().use_g(g);
assert!(msm.eval());
}
}
// Check that the verification key has not changed unexpectedly
{
assert_eq!(
format!("{:#?}", pk.get_vk().pinned()),
r#####"PinnedVerificationKey {
base_modulus: "0x40000000000000000000000000000000224698fc0994a8dd8c46eb2100000001",
scalar_modulus: "0x40000000000000000000000000000000224698fc094cf91b992d30ed00000001",
domain: PinnedEvaluationDomain {
k: 5,
extended_k: 7,
omega: 0x0cc3380dc616f2e1daf29ad1560833ed3baea3393eceb7bc8fa36376929b78cc,
},
cs: PinnedConstraintSystem {
num_fixed_columns: 8,
num_advice_columns: 5,
num_instance_columns: 1,
gates: [
Sum(
Sum(
Sum(
Sum(
Product(
Advice(
0,
),
Fixed(
3,
),
),
Product(
Advice(
1,
),
Fixed(
4,
),
),
),
Product(
Product(
Advice(
0,
),
Advice(
1,
),
),
Fixed(
6,
),
),
),
Scaled(
Product(
Advice(
2,
),
Fixed(
5,
),
),
0x40000000000000000000000000000000224698fc094cf91b992d30ed00000000,
),
),
Product(
Fixed(
2,
),
Product(
Advice(
3,
),
Advice(
4,
),
),
),
),
Product(
Fixed(
7,
),
Sum(
Advice(
0,
),
Scaled(
Instance(
0,
),
0x40000000000000000000000000000000224698fc094cf91b992d30ed00000000,
),
),
),
],
advice_queries: [
(
Column {
index: 1,
column_type: Advice,
},
Rotation(
0,
),
),
(
Column {
index: 2,
column_type: Advice,
},
Rotation(
0,
),
),
(
Column {
index: 3,
column_type: Advice,
},
Rotation(
0,
),
),
(
Column {
index: 4,
column_type: Advice,
},
Rotation(
1,
),
),
(
Column {
index: 0,
column_type: Advice,
},
Rotation(
-1,
),
),
],
instance_queries: [
(
Column {
index: 0,
column_type: Instance,
},
Rotation(
0,
),
),
],
fixed_queries: [
(
Column {
index: 6,
column_type: Fixed,
},
Rotation(
0,
),
),
(
Column {
index: 7,
column_type: Fixed,
},
Rotation(
0,
),
),
(
Column {
index: 0,
column_type: Fixed,
},
Rotation(
0,
),
),
(
Column {
index: 2,
column_type: Fixed,
},
Rotation(
0,
),
),
(
Column {
index: 3,
column_type: Fixed,
},
Rotation(
0,
),
),
(
Column {
index: 4,
column_type: Fixed,
},
Rotation(
0,
),
),
(
Column {
index: 1,
column_type: Fixed,
},
Rotation(
0,
),
),
(
Column {
index: 5,
column_type: Fixed,
},
Rotation(
0,
),
),
],
permutations: [
Argument {
columns: [
Column {
index: 1,
column_type: Advice,
},
Column {
index: 2,
column_type: Advice,
},
Column {
index: 3,
column_type: Advice,
},
],
},
Argument {
columns: [
Column {
index: 1,
column_type: Advice,
},
Column {
index: 2,
column_type: Advice,
},
Column {
index: 3,
column_type: Advice,
},
],
},
],
lookups: [
Argument {
input_expressions: [
Advice(
0,
),
],
table_expressions: [
Fixed(
0,
),
],
},
Argument {
input_expressions: [
Product(
Advice(
0,
),
Advice(
1,
),
),
],
table_expressions: [
Product(
Fixed(
0,
),
Fixed(
1,
),
),
],
},
],
},
fixed_commitments: [
Update commitments in PinnedVerificationKey The pinned commitments have changed, presumably after the hash_to_field fix in zcash/pasta_curves a1194672c55ee03a1631b6e1af9d86a3bd87ab70.
2021-04-23 02:32:09 -07:00
(0x2bbc94ef7b22aebef24f9a4b0cc1831882548b605171366017d45c3e6fd92075, 0x082b801a6e176239943bfb759fb02138f47a5c8cc4aa7fa0af559fde4e3abd97),
(0x2bf5082b105b2156ed0e9c5b8e42bf2a240b058f74a464d080e9585274dd1e84, 0x222ad83cee7777e7a160585e212140e5e770dd8d1df788d869b5ee483a5864fb),
(0x374a656456a0aae7429b23336f825752b575dd5a44290ff614946ee59d6a20c0, 0x054491e187e6e3460e7601fb54ae10836d34d420026f96316f0c5c62f86db9b8),
(0x374a656456a0aae7429b23336f825752b575dd5a44290ff614946ee59d6a20c0, 0x054491e187e6e3460e7601fb54ae10836d34d420026f96316f0c5c62f86db9b8),
(0x02e62cd68370b13711139a08cbcdd889e800a272b9ea10acc90880fff9d89199, 0x1a96c468cb0ce77065d3a58f1e55fea9b72d15e44c01bba1e110bd0cbc6e9bc6),
(0x224ef42758215157d3ee48fb8d769da5bddd35e5929a90a4a89736f5c4b5ae9b, 0x11bc3a1e08eb320cde764f1492ecef956d71e996e2165f7a9a30ad2febb511c1),
(0x0009ccc670d8d139c168165a3bdffc9b06620c8440df66c2b35757572763a04f, 0x3e12747aa6df89dd554200e592026cc43dd529fb32de6fc6f252128d1e596a8a),
(0x12ed9a5b874da7ed995fcff158687dad0d642a4f1af67a6524078bb6fb8754b0, 0x097ac5730034c8fa454dac57d700af4b92d82691ef76c0bf9e6e6fa719a936c2),
Move PLONK integration tests into the tests subdirectory.
2021-02-25 12:29:25 -08:00
],
permutations: [
VerifyingKey {
commitments: [
Update commitments in PinnedVerificationKey The pinned commitments have changed, presumably after the hash_to_field fix in zcash/pasta_curves a1194672c55ee03a1631b6e1af9d86a3bd87ab70.
2021-04-23 02:32:09 -07:00
(0x1347b4b385837977a96b87f199c6a9a81520015539d1e8fa79429bb4ca229a00, 0x2168e404cabef513654d6ff516cde73f0ba87e3dc84e4b940ed675b5f66f3884),
(0x0e6d69cd2455ec43be640f6397ed65c9e51b1d8c0fd2216339314ff37ade122a, 0x222ed6dc8cfc9ea26dcc10b9d4add791ada60f2b5a63ee1e4635f88aa0c96654),
(0x13c447846f48c41a5e0675ccf88ebc0cdef2c96c51446d037acb866d24255785, 0x1f0b5414fc5e8219dbfab996eed6129d831488b2386a8b1a63663938903bd63a),
Move PLONK integration tests into the tests subdirectory.
2021-02-25 12:29:25 -08:00
],
},
VerifyingKey {
commitments: [
Update commitments in PinnedVerificationKey The pinned commitments have changed, presumably after the hash_to_field fix in zcash/pasta_curves a1194672c55ee03a1631b6e1af9d86a3bd87ab70.
2021-04-23 02:32:09 -07:00
(0x1347b4b385837977a96b87f199c6a9a81520015539d1e8fa79429bb4ca229a00, 0x2168e404cabef513654d6ff516cde73f0ba87e3dc84e4b940ed675b5f66f3884),
(0x0e6d69cd2455ec43be640f6397ed65c9e51b1d8c0fd2216339314ff37ade122a, 0x222ed6dc8cfc9ea26dcc10b9d4add791ada60f2b5a63ee1e4635f88aa0c96654),
(0x13c447846f48c41a5e0675ccf88ebc0cdef2c96c51446d037acb866d24255785, 0x1f0b5414fc5e8219dbfab996eed6129d831488b2386a8b1a63663938903bd63a),
Move PLONK integration tests into the tests subdirectory.
2021-02-25 12:29:25 -08:00
],
},
],
}"#####
);
}
}