Update ark-circom for arkworks 0.4.0 (arkworks-rs#43)

Cargo.toml

@@ -12,14 +12,15 @@ num-traits = { version = "0.2.0", default-features = false }
 num-bigint = { version = "0.4", default-features = false, features = ["rand"] }
 
 # ZKP Generation
-ark-ec = { version = "0.3.0", default-features = false, features = ["parallel"] }
-ark-ff = { version = "0.3.0", default-features = false, features = ["parallel", "asm"] }
-ark-std = { version = "0.3.0", default-features = false, features = ["parallel"] }
-ark-bn254 = { version = "0.3.0" }
-ark-groth16 = { git = "https://github.com/arkworks-rs/groth16", rev = "765817f", features = ["parallel"] }
-ark-poly = { version = "^0.3.0", default-features = false, features = ["parallel"] }
-ark-relations = { version = "0.3.0", default-features = false }
-ark-serialize = { version = "0.3.0", default-features = false }
+ark-crypto-primitives = { version = "0.4.0" }
+ark-ec = { version = "0.4.1", default-features = false, features = ["parallel"] }
+ark-ff = { version = "0.4.1", default-features = false, features = ["parallel", "asm"] }
+ark-std = { version = "0.4.0", default-features = false, features = ["parallel"] }
+ark-bn254 = { version = "0.4.0" }
+ark-groth16 = { version = "0.4.0", features = ["parallel"] }
+ark-poly = { version = "0.4.1", default-features = false, features = ["parallel"] }
+ark-relations = { version = "0.4.0", default-features = false }
+ark-serialize = { version = "0.4.1", default-features = false }
 
 # decoding of data
 hex = "0.4.3"
@@ -49,4 +50,4 @@ harness = false
 bench-complex-all = []
 circom-2 = []
 ethereum = ["ethers-core"]
-default = ["ethereum"]
+default = ["circom-2", "ethereum"]

README.md

@@ -35,19 +35,19 @@ let circom = builder.setup();
 
 // Run a trusted setup
 let mut rng = thread_rng();
-let params = generate_random_parameters::<Bn254, _, _>(circom, &mut rng)?;
+let params = generate_random_parameters_with_reduction(circom, &mut rng)?;
 
 // Get the populated instance of the circuit with the witness
 let circom = builder.build()?;
 
 let inputs = circom.get_public_inputs().unwrap();
 
 // Generate the proof
-let proof = prove(circom, &params, &mut rng)?;
+let proof = prove(&params, circom, &mut rng)?;
 
 // Check that the proof is valid
-let pvk = prepare_verifying_key(&params.vk);
-let verified = verify_proof(&pvk, &proof, &inputs)?;
+let pvk = process_vk(&params.vk)?;
+let verified = verify_with_processed_vk(&pvk, &inputs, &proof)?;
 assert!(verified);
 ```
 

benches/groth16.rs

@@ -1,10 +1,11 @@
+use ark_crypto_primitives::snark::SNARK;
 use criterion::{black_box, criterion_group, criterion_main, Criterion};
 
 use ark_circom::{read_zkey, CircomReduction, WitnessCalculator};
 use ark_std::rand::thread_rng;
 
 use ark_bn254::Bn254;
-use ark_groth16::{create_proof_with_reduction_and_matrices, prepare_verifying_key, verify_proof};
+use ark_groth16::Groth16;
 
 use std::{collections::HashMap, fs::File};
 
@@ -15,7 +16,7 @@ fn bench_groth(c: &mut Criterion, num_validators: u32, num_constraints: u32) {
         "./test-vectors/complex-circuit/complex-circuit-{}-{}.zkey",
         i, j
     );
-    let mut file = File::open(&path).unwrap();
+    let mut file = File::open(path).unwrap();
     let (params, matrices) = read_zkey(&mut file).unwrap();
     let num_inputs = matrices.num_instance_variables;
     let num_constraints = matrices.num_constraints;
@@ -28,7 +29,7 @@ fn bench_groth(c: &mut Criterion, num_validators: u32, num_constraints: u32) {
         inputs
     };
 
-    let mut wtns = WitnessCalculator::new(&format!(
+    let mut wtns = WitnessCalculator::new(format!(
         "./test-vectors/complex-circuit/complex-circuit-{}-{}.wasm",
         i, j
     ))
@@ -44,7 +45,7 @@ fn bench_groth(c: &mut Criterion, num_validators: u32, num_constraints: u32) {
     let r = ark_bn254::Fr::rand(rng);
     let s = ark_bn254::Fr::rand(rng);
 
-    let proof = create_proof_with_reduction_and_matrices::<_, CircomReduction>(
+    let proof = Groth16::<Bn254, CircomReduction>::create_proof_with_reduction_and_matrices(
         &params,
         r,
         s,
@@ -55,16 +56,16 @@ fn bench_groth(c: &mut Criterion, num_validators: u32, num_constraints: u32) {
     )
     .unwrap();
 
-    let pvk = prepare_verifying_key(&params.vk);
+    let pvk = Groth16::<Bn254>::process_vk(&params.vk).unwrap();
     let inputs = &full_assignment[1..num_inputs];
-    let verified = verify_proof(&pvk, &proof, inputs).unwrap();
+    let verified = Groth16::<Bn254>::verify_with_processed_vk(&pvk, inputs, &proof).unwrap();
 
     assert!(verified);
 
     c.bench_function(&format!("groth proof {} {}", i, j), |b| {
         b.iter(|| {
             black_box(
-                create_proof_with_reduction_and_matrices::<_, CircomReduction>(
+                Groth16::<Bn254, CircomReduction>::create_proof_with_reduction_and_matrices(
                     &params,
                     r,
                     s,

src/circom/builder.rs

@@ -1,4 +1,4 @@
-use ark_ec::PairingEngine;
+use ark_ec::pairing::Pairing;
 use std::{fs::File, path::Path};
 
 use super::{CircomCircuit, R1CS};
@@ -10,20 +10,20 @@ use crate::{circom::R1CSFile, witness::WitnessCalculator};
 use color_eyre::Result;
 
 #[derive(Clone, Debug)]
-pub struct CircomBuilder<E: PairingEngine> {
+pub struct CircomBuilder<E: Pairing> {
     pub cfg: CircomConfig<E>,
     pub inputs: HashMap<String, Vec<BigInt>>,
 }
 
 // Add utils for creating this from files / directly from bytes
 #[derive(Clone, Debug)]
-pub struct CircomConfig<E: PairingEngine> {
+pub struct CircomConfig<E: Pairing> {
     pub r1cs: R1CS<E>,
     pub wtns: WitnessCalculator,
     pub sanity_check: bool,
 }
 
-impl<E: PairingEngine> CircomConfig<E> {
+impl<E: Pairing> CircomConfig<E> {
     pub fn new(wtns: impl AsRef<Path>, r1cs: impl AsRef<Path>) -> Result<Self> {
         let wtns = WitnessCalculator::new(wtns).unwrap();
         let reader = File::open(r1cs)?;
@@ -36,7 +36,7 @@ impl<E: PairingEngine> CircomConfig<E> {
     }
 }
 
-impl<E: PairingEngine> CircomBuilder<E> {
+impl<E: Pairing> CircomBuilder<E> {
     /// Instantiates a new builder using the provided WitnessGenerator and R1CS files
     /// for your circuit
     pub fn new(cfg: CircomConfig<E>) -> Self {
@@ -81,7 +81,7 @@ impl<E: PairingEngine> CircomBuilder<E> {
         // sanity check
         debug_assert!({
             use ark_relations::r1cs::{ConstraintSynthesizer, ConstraintSystem};
-            let cs = ConstraintSystem::<E::Fr>::new_ref();
+            let cs = ConstraintSystem::<E::ScalarField>::new_ref();
             circom.clone().generate_constraints(cs.clone()).unwrap();
             let is_satisfied = cs.is_satisfied().unwrap();
             if !is_satisfied {

src/circom/circuit.rs

@@ -1,4 +1,4 @@
-use ark_ec::PairingEngine;
+use ark_ec::pairing::Pairing;
 use ark_relations::r1cs::{
     ConstraintSynthesizer, ConstraintSystemRef, LinearCombination, SynthesisError, Variable,
 };
@@ -8,13 +8,13 @@ use super::R1CS;
 use color_eyre::Result;
 
 #[derive(Clone, Debug)]
-pub struct CircomCircuit<E: PairingEngine> {
+pub struct CircomCircuit<E: Pairing> {
     pub r1cs: R1CS<E>,
-    pub witness: Option<Vec<E::Fr>>,
+    pub witness: Option<Vec<E::ScalarField>>,
 }
 
-impl<E: PairingEngine> CircomCircuit<E> {
-    pub fn get_public_inputs(&self) -> Option<Vec<E::Fr>> {
+impl<E: Pairing> CircomCircuit<E> {
+    pub fn get_public_inputs(&self) -> Option<Vec<E::ScalarField>> {
         match &self.witness {
             None => None,
             Some(w) => match &self.r1cs.wire_mapping {
@@ -25,16 +25,19 @@ impl<E: PairingEngine> CircomCircuit<E> {
     }
 }
 
-impl<E: PairingEngine> ConstraintSynthesizer<E::Fr> for CircomCircuit<E> {
-    fn generate_constraints(self, cs: ConstraintSystemRef<E::Fr>) -> Result<(), SynthesisError> {
+impl<E: Pairing> ConstraintSynthesizer<E::ScalarField> for CircomCircuit<E> {
+    fn generate_constraints(
+        self,
+        cs: ConstraintSystemRef<E::ScalarField>,
+    ) -> Result<(), SynthesisError> {
         let witness = &self.witness;
         let wire_mapping = &self.r1cs.wire_mapping;
 
         // Start from 1 because Arkworks implicitly allocates One for the first input
         for i in 1..self.r1cs.num_inputs {
             cs.new_input_variable(|| {
                 Ok(match witness {
-                    None => E::Fr::from(1u32),
+                    None => E::ScalarField::from(1u32),
                     Some(w) => match wire_mapping {
                         Some(m) => w[m[i]],
                         None => w[i],
@@ -46,7 +49,7 @@ impl<E: PairingEngine> ConstraintSynthesizer<E::Fr> for CircomCircuit<E> {
         for i in 0..self.r1cs.num_aux {
             cs.new_witness_variable(|| {
                 Ok(match witness {
-                    None => E::Fr::from(1u32),
+                    None => E::ScalarField::from(1u32),
                     Some(w) => match wire_mapping {
                         Some(m) => w[m[i + self.r1cs.num_inputs]],
                         None => w[i + self.r1cs.num_inputs],
@@ -62,10 +65,12 @@ impl<E: PairingEngine> ConstraintSynthesizer<E::Fr> for CircomCircuit<E> {
                 Variable::Witness(index - self.r1cs.num_inputs)
             }
         };
-        let make_lc = |lc_data: &[(usize, E::Fr)]| {
+        let make_lc = |lc_data: &[(usize, E::ScalarField)]| {
             lc_data.iter().fold(
-                LinearCombination::<E::Fr>::zero(),
-                |lc: LinearCombination<E::Fr>, (index, coeff)| lc + (*coeff, make_index(*index)),
+                LinearCombination::<E::ScalarField>::zero(),
+                |lc: LinearCombination<E::ScalarField>, (index, coeff)| {
+                    lc + (*coeff, make_index(*index))
+                },
             )
         };
 

src/circom/mod.rs

@@ -1,4 +1,4 @@
-use ark_ec::PairingEngine;
+use ark_ec::pairing::Pairing;
 
 pub mod r1cs_reader;
 pub use r1cs_reader::{R1CSFile, R1CS};
@@ -13,4 +13,4 @@ mod qap;
 pub use qap::CircomReduction;
 
 pub type Constraints<E> = (ConstraintVec<E>, ConstraintVec<E>, ConstraintVec<E>);
-pub type ConstraintVec<E> = Vec<(usize, <E as PairingEngine>::Fr)>;
+pub type ConstraintVec<E> = Vec<(usize, <E as Pairing>::ScalarField)>;

src/circom/qap.rs

@@ -1,5 +1,5 @@
 use ark_ff::PrimeField;
-use ark_groth16::r1cs_to_qap::{evaluate_constraint, LibsnarkReduction, R1CStoQAP};
+use ark_groth16::r1cs_to_qap::{evaluate_constraint, LibsnarkReduction, R1CSToQAP};
 use ark_poly::EvaluationDomain;
 use ark_relations::r1cs::{ConstraintMatrices, ConstraintSystemRef, SynthesisError};
 use ark_std::{cfg_into_iter, cfg_iter, cfg_iter_mut, vec};
@@ -11,7 +11,7 @@ use ark_std::{cfg_into_iter, cfg_iter, cfg_iter_mut, vec};
 /// in that domain. This serves as HZ when computing the C proof element.
 pub struct CircomReduction;
 
-impl R1CStoQAP for CircomReduction {
+impl R1CSToQAP for CircomReduction {
     #[allow(clippy::type_complexity)]
     fn instance_map_with_evaluation<F: PrimeField, D: EvaluationDomain<F>>(
         cs: ConstraintSystemRef<F>,