Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

circom interface with tests #7

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ thiserror = "1.0"
halo2curves = { version = "0.4.0", features = ["derive_serde"] }
group = "0.13.0"
once_cell = "1.18.0"
circom-scotia = "0.1.2"

[target.'cfg(any(target_arch = "x86_64", target_arch = "aarch64"))'.dependencies]
pasta-msm = { version = "0.1.4" }
Expand Down
10 changes: 10 additions & 0 deletions examples/cube/cube.circom
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
pragma circom 2.0.6;

template cube() {
signal input x;
signal input y;
signal x_sq <== x * x;
y === x_sq * x;
}

component main { public [x, y] } = cube();
Binary file added examples/cube/cube.r1cs
Binary file not shown.
Binary file added examples/cube/cube.wasm
Binary file not shown.
135 changes: 135 additions & 0 deletions src/circom/mod.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,135 @@
use std::path::PathBuf;

use crate::{
errors::SpartanError,
traits::{self, snark::RelaxedR1CSSNARKTrait, Group},
ProverKey, VerifierKey, SNARK,
};

use bellpepper_core::{Circuit, ConstraintSystem, SynthesisError};
use ff::PrimeField;

use circom_scotia::{r1cs::R1CS, reader::load_r1cs, witness::WitnessCalculator};

#[derive(Clone, Debug)]
pub struct SpartanCircuit<F: PrimeField> {
r1cs: R1CS<F>,
witness: Option<Vec<F>>, // this is actually z = [1 || x || w]
}

#[allow(dead_code)]
impl<F: PrimeField> SpartanCircuit<F> {
pub fn new(r1cs_path: PathBuf) -> Self {
SpartanCircuit {
r1cs: load_r1cs(r1cs_path),
witness: None,
}
}

pub fn compute_witness(&mut self, input: Vec<(String, Vec<F>)>, wtns_path: PathBuf) {
let mut witness_calculator = WitnessCalculator::new(wtns_path).unwrap();
let witness = witness_calculator
.calculate_witness(input.clone(), true)
.expect("msg");

self.witness = Some(witness);
}
}

impl<F: PrimeField> Circuit<F> for SpartanCircuit<F> {
fn synthesize<CS: ConstraintSystem<F>>(self, cs: &mut CS) -> Result<(), SynthesisError> {
let _ = circom_scotia::synthesize(cs, self.r1cs.clone(), self.witness).unwrap();

Ok(())
}
}

#[allow(dead_code)]
pub fn setup<G: Group, S: RelaxedR1CSSNARKTrait<G>>(
circuit: SpartanCircuit<<G as Group>::Scalar>,
) -> (ProverKey<G, S>, VerifierKey<G, S>) {
SNARK::<G, S, SpartanCircuit<<G as Group>::Scalar>>::setup(circuit).unwrap()
}

#[allow(dead_code)]
pub fn generate_proof<G: Group, S: RelaxedR1CSSNARKTrait<G>>(
pk: ProverKey<G, S>,
circuit: &mut SpartanCircuit<<G as Group>::Scalar>,
input: Vec<(String, Vec<<G as Group>::Scalar>)>,
wtns_path: PathBuf,
) -> Result<SNARK<G, S, SpartanCircuit<<G as traits::Group>::Scalar>>, SpartanError> {
circuit.compute_witness(input, wtns_path);
SNARK::prove(&pk, circuit.clone())
}

#[allow(dead_code)]
pub fn create_snark<G: Group, S: RelaxedR1CSSNARKTrait<G>>(
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This method seems not that useful. In other words, we can just have two methods, one for setup and another for prove. The setup takes the r1cs file path and the prove takes the witness file path (in addition to pk).

r1cs_path: PathBuf,
wtns_path: PathBuf,
input: Vec<(String, Vec<<G as Group>::Scalar>)>,
) -> (
ProverKey<G, S>,
VerifierKey<G, S>,
Result<SNARK<G, S, SpartanCircuit<<G as traits::Group>::Scalar>>, SpartanError>,
) {
let mut circuit = SpartanCircuit::new(r1cs_path);
let (pk, vk) =
SNARK::<G, S, SpartanCircuit<<G as Group>::Scalar>>::setup(circuit.clone()).unwrap();
circuit.compute_witness(input, wtns_path);
let proof = SNARK::prove(&pk, circuit.clone());
(pk, vk, proof)
}

#[cfg(test)]
mod test {
use super::{create_snark, generate_proof, setup, SpartanCircuit};
use crate::{provider::bn256_grumpkin::bn256, traits::Group};
use std::env::current_dir;

#[test]
fn test_spartan_snark() {
type G = bn256::Point;
type EE = crate::provider::ipa_pc::EvaluationEngine<G>;
type S = crate::spartan::snark::RelaxedR1CSSNARK<G, EE>;

let root = current_dir().unwrap().join("examples/cube");
let r1cs_path = root.join("cube.r1cs");
let wtns_path = root.join("cube.wasm");

let arg_x = ("x".into(), vec![<G as Group>::Scalar::from(2)]);
let arg_y = ("y".into(), vec![<G as Group>::Scalar::from(8)]);
let input = vec![arg_x, arg_y];

let (_, vk, res) = create_snark::<G, S>(r1cs_path, wtns_path, input);
assert!(res.is_ok());

let snark = res.unwrap();
assert!(snark.verify(&vk).is_ok());
}

#[test]
fn test_spartan_snark_fail() {
type G = bn256::Point;
type EE = crate::provider::ipa_pc::EvaluationEngine<G>;
type S = crate::spartan::snark::RelaxedR1CSSNARK<G, EE>;

let root = current_dir().unwrap().join("examples/cube");
let r1cs_path = root.join("cube.r1cs");
let wtns_path = root.join("cube.wasm");
let mut circuit = SpartanCircuit::new(r1cs_path);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There's a simplification here. We can just pass r1cs_path to setup (which returns (pk,vk)) and the setup can internally create a SpartanCircuit object (this will hide the struct from the caller and reduces code that someone needs to write). Isn't it?


let (pk, vk) = setup(circuit.clone());

// setting y to 9 shouldn't satisfy
let arg_x = ("x".into(), vec![<G as Group>::Scalar::from(2)]);
let arg_y = ("y".into(), vec![<G as Group>::Scalar::from(9)]);
let input = vec![arg_x, arg_y];

let res = generate_proof::<G, S>(pk, &mut circuit, input, wtns_path);
assert!(res.is_ok());

let snark = res.unwrap();
// check that it fails
assert!(snark.verify(&vk).is_err());
}
}
1 change: 1 addition & 0 deletions src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@

// private modules
mod bellpepper;
mod circom;
mod constants;
mod digest;
mod r1cs;
Expand Down