Move the experimental frontends into a separate crate, so that when n…

…ot using them they don't take several minutes to compile (and indirect dependencies).

This saves several minutes (and MBs of data) on compilation time both
when running tests in this repo, but also when using the sonobe lib as a
dependency in external repos.

.github/scripts/wasm-target-test-build.sh

@@ -15,7 +15,8 @@ cp "${GIT_ROOT}/rust-toolchain" .
 rustup target add wasm32-unknown-unknown wasm32-wasi 
 
 # add dependencies
-cargo add --path "${GIT_ROOT}/folding-schemes" --features wasm, parallel
+cargo add --path "${GIT_ROOT}/frontends" --features wasm, parallel
+cargo add --path "${GIT_ROOT}/folding-schemes" --features parallel
 cargo add getrandom --features js --target wasm32-unknown-unknown
 
 # test build for wasm32-* targets
@@ -26,4 +27,4 @@ cargo build --release --target wasm32-wasi
 
 # delete test project
 cd ../
-rm -rf foobar
+rm -rf foobar

.github/workflows/ci.yml

@@ -61,9 +61,9 @@ jobs:
           curl -sSfL https://github.com/ethereum/solidity/releases/download/v0.8.4/solc-static-linux -o /usr/local/bin/solc
           chmod +x /usr/local/bin/solc
       - name: Execute compile.sh to generate .r1cs and .wasm from .circom
-        run: ./folding-schemes/src/frontend/circom/test_folder/compile.sh
+        run: ./frontends/src/circom/test_folder/compile.sh
       - name: Execute compile.sh to generate .json from noir
-        run: ./folding-schemes/src/frontend/noir/test_folder/compile.sh
+        run: ./frontends/src/noir/test_folder/compile.sh
       - name: Run tests
         uses: actions-rs/cargo@v1
         with:
@@ -95,11 +95,16 @@ jobs:
           default: true
       - name: Add target
         run: rustup target add ${{ matrix.target }}
-      - name: Wasm-compat build
+      - name: Wasm-compat frontends build
         uses: actions-rs/cargo@v1
         with:
           command: build
-          args: -p folding-schemes --no-default-features --target ${{ matrix.target }} --features "wasm, parallel"
+          args: -p frontends --no-default-features --target ${{ matrix.target }} --features "wasm, parallel"
+      - name: Wasm-compat folding-schemes build
+        uses: actions-rs/cargo@v1
+        with:
+          command: build
+          args: -p folding-schemes --no-default-features --target ${{ matrix.target }} --features "default,light-test"
       - name: Run wasm-compat script
         run: |
           chmod +x .github/scripts/wasm-target-test-build.sh
@@ -127,9 +132,9 @@ jobs:
           curl -sSfL https://github.com/ethereum/solidity/releases/download/v0.8.4/solc-static-linux -o /usr/local/bin/solc
           chmod +x /usr/local/bin/solc
       - name: Execute compile.sh to generate .r1cs and .wasm from .circom
-        run: ./folding-schemes/src/frontend/circom/test_folder/compile.sh
+        run: ./frontends/src/circom/test_folder/compile.sh
       - name: Execute compile.sh to generate .json from noir
-        run: ./folding-schemes/src/frontend/noir/test_folder/compile.sh
+        run: ./frontends/src/noir/test_folder/compile.sh
       - name: Run examples tests
         run: cargo test --examples
       - name: Run examples
@@ -160,9 +165,9 @@ jobs:
         include:
           - feature_set: basic
             features: --features default,light-test
-            # We only want to test `folding-schemes` package with `wasm` feature.
+            # We only want to test `frontends` package with `wasm` feature.
           - feature_set: wasm
-            features: -p folding-schemes --features wasm,parallel --target wasm32-unknown-unknown
+            features: -p frontends --features wasm,parallel --target wasm32-unknown-unknown
     steps:
       - uses: actions/checkout@v2
       - uses: actions-rs/toolchain@v1

.gitignore

@@ -2,14 +2,14 @@
 Cargo.lock
 
 # Circom generated files
-folding-schemes/src/frontend/circom/test_folder/*_js/
+frontends/src/circom/test_folder/*_js/
 *.r1cs
 *.sym
 
 # Noir generated files
-folding-schemes/src/frontend/noir/test_folder/*/target/*
+frontends/src/noir/test_folder/*/target/*
 
-# generated contracts at test time
+# generated contracts data
 solidity-verifiers/generated
 examples/*.sol
 examples/*.calldata

Cargo.toml

@@ -2,7 +2,8 @@
 members = [
     "folding-schemes",
     "solidity-verifiers",
-    "cli"
+    "cli",
+    "frontends"
 ]
 resolver = "2"
 

README.md

@@ -27,14 +27,6 @@ Work in progress:
 
 - [ProtoGalaxy: Efficient ProtoStar-style folding of multiple instances](https://eprint.iacr.org/2023/1106.pdf), Liam Eagen, Ariel Gabizon. 2023
 
-## Available frontends
-
-Available frontends to define the folded circuit:
-
-- [arkworks](https://github.com/arkworks-rs), arkworks contributors
-- [Circom](https://github.com/iden3/circom), iden3, 0Kims Association
-- [Noname](https://github.com/zksecurity/noname), zkSecurity
-
 ## Usage
 
 ### Build & test

examples/circom_full_flow.rs

@@ -23,10 +23,11 @@ use folding_schemes::{
         decider_eth::{prepare_calldata, Decider as DeciderEth},
         Nova, PreprocessorParam,
     },
-    frontend::{circom::CircomFCircuit, FCircuit},
+    frontend::FCircuit,
     transcript::poseidon::poseidon_canonical_config,
     Decider, FoldingScheme,
 };
+use frontends::circom::CircomFCircuit;
 use solidity_verifiers::{
     evm::{compile_solidity, Evm},
     utils::get_function_selector_for_nova_cyclefold_verifier,
@@ -54,11 +55,9 @@ fn main() {
     ];
 
     // initialize the Circom circuit
-    let r1cs_path = PathBuf::from(
-        "./folding-schemes/src/frontend/circom/test_folder/with_external_inputs.r1cs",
-    );
+    let r1cs_path = PathBuf::from("./frontends/src/circom/test_folder/with_external_inputs.r1cs");
     let wasm_path = PathBuf::from(
-        "./folding-schemes/src/frontend/circom/test_folder/with_external_inputs_js/with_external_inputs.wasm",
+        "./frontends/src/circom/test_folder/with_external_inputs_js/with_external_inputs.wasm",
     );
 
     let f_circuit_params = (r1cs_path.into(), wasm_path.into(), 1, 2);

examples/noir_full_flow.rs

@@ -20,13 +20,11 @@ use folding_schemes::{
         decider_eth::{prepare_calldata, Decider as DeciderEth},
         Nova, PreprocessorParam,
     },
-    frontend::{
-        noir::{load_noir_circuit, NoirFCircuit},
-        FCircuit,
-    },
+    frontend::FCircuit,
     transcript::poseidon::poseidon_canonical_config,
     Decider, FoldingScheme,
 };
+use frontends::noir::{load_noir_circuit, NoirFCircuit};
 use std::{env, time::Instant};
 
 use solidity_verifiers::{
@@ -44,7 +42,7 @@ fn main() {
     let cur_path = env::current_dir().unwrap();
 
     let circuit_path = format!(
-        "{}/folding-schemes/src/frontend/noir/test_folder/test_mimc/target/test_mimc.json",
+        "{}/frontends/src/noir/test_folder/test_mimc/target/test_mimc.json",
         cur_path.to_str().unwrap()
     );
 

examples/noname_full_flow.rs

@@ -21,10 +21,11 @@ use folding_schemes::{
         decider_eth::{prepare_calldata, Decider as DeciderEth},
         Nova, PreprocessorParam,
     },
-    frontend::{noname::NonameFCircuit, FCircuit},
+    frontend::FCircuit,
     transcript::poseidon::poseidon_canonical_config,
     Decider, FoldingScheme,
 };
+use frontends::noname::NonameFCircuit;
 use std::time::Instant;
 
 use solidity_verifiers::{

folding-schemes/Cargo.toml

@@ -9,28 +9,20 @@ ark-ff = { version = "^0.4.0", default-features = false, features = ["parallel",
 ark-poly = { version = "^0.4.0", default-features = false, features = ["parallel"] }
 ark-std = { version = "^0.4.0", default-features = false, features = ["parallel"] }
 ark-crypto-primitives = { version = "^0.4.0", default-features = false, features = ["r1cs", "sponge", "crh", "parallel"] }
-ark-grumpkin = { version = "0.4.0", default-features = false }
 ark-poly-commit = { version = "^0.4.0", default-features = false, features = ["parallel"] }
 ark-relations = { version = "^0.4.0", default-features = false }
-# this is patched at the workspace level
+# ark-r1cs-std is patched at the workspace level
 ark-r1cs-std = { version = "0.4.0", default-features = false, features = ["parallel"] }
 ark-snark = { version = "^0.4.0", default-features = false }
 ark-serialize = { version = "^0.4.0", default-features = false }
-ark-circom = { git = "https://github.com/arnaucube/circom-compat", default-features = false }
 ark-groth16 = { version = "^0.4.0", default-features = false, features = ["parallel"]}
 ark-bn254 = { version = "^0.4.0", default-features = false }
+ark-grumpkin = { version = "0.4.0", default-features = false }
 thiserror = "1.0"
 rayon = "1"
 num-bigint = "0.4"
 num-integer = "0.1"
-color-eyre = "=0.6.2"
 sha3 = "0.10"
-ark-noname = { git = "https://github.com/dmpierre/ark-noname", branch = "feat/sonobe-integration" }
-noname = { git = "https://github.com/dmpierre/noname" }
-serde_json = "1.0.85"                                                                # to (de)serialize JSON
-serde = "1.0.203"
-acvm = { git = "https://github.com/noir-lang/noir", rev="2b4853e", default-features = false }
-noir_arkworks_backend = { package="arkworks_backend", git = "https://github.com/dmpierre/arkworks_backend", branch = "feat/sonobe-integration" }
 log = "0.4"
 
 # tmp import for espresso's sumcheck
@@ -46,6 +38,7 @@ ark-grumpkin = {version="0.4.0", features=["r1cs"]}
 ark-mnt4-298 = {version="0.4.0", features=["r1cs"]}
 ark-mnt6-298 = {version="0.4.0", features=["r1cs"]}
 rand = "0.8.5"
+num-bigint = {version = "0.4", features = ["rand"]}
 tracing = { version = "0.1", default-features = false, features = [ "attributes" ] }
 tracing-subscriber = { version = "0.2" }
 
@@ -55,9 +48,8 @@ tracing-subscriber = { version = "0.2" }
 getrandom = { version = "0.2", features = ["js"] }
 
 [features]
-default = ["ark-circom/default", "parallel"]
+default = ["parallel"]
 parallel = []
-wasm = ["ark-circom/wasm"]
 light-test = []
 
 

folding-schemes/src/frontend/mod.rs

@@ -4,9 +4,6 @@ use ark_r1cs_std::fields::fp::FpVar;
 use ark_relations::r1cs::{ConstraintSystemRef, SynthesisError};
 use ark_std::fmt::Debug;
 
-pub mod circom;
-pub mod noir;
-pub mod noname;
 pub mod utils;
 
 /// FCircuit defines the trait of the circuit of the F function, which is the one being folded (ie.

folding-schemes/src/frontend/utils.rs

@@ -152,14 +152,12 @@ impl<F: PrimeField> FCircuit<F> for CustomFCircuit<F> {
 /// than the one done in the `AugmentedFCircuit`, but without adding all the extra constraints
 /// of the AugmentedF circuit logic, in order to run lighter tests when we're not interested in
 /// the the AugmentedF logic but in the wrapping of the circuits.
-#[cfg(test)]
 pub struct WrapperCircuit<F: PrimeField, FC: FCircuit<F>> {
     pub FC: FC, // F circuit
     pub z_i: Option<Vec<F>>,
     pub z_i1: Option<Vec<F>>,
 }
 
-#[cfg(test)]
 impl<F, FC> ark_relations::r1cs::ConstraintSynthesizer<F> for WrapperCircuit<F, FC>
 where
     F: PrimeField,

frontends/Cargo.toml

@@ -0,0 +1,41 @@
+[package]
+name = "frontends"
+version = "0.1.0"
+edition = "2021"
+
+# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+
+[dependencies]
+ark-ec = { version = "^0.4.0", default-features = false, features = ["parallel"] }
+ark-ff = { version = "^0.4.0", default-features = false, features = ["parallel", "asm"] }
+ark-poly = { version = "^0.4.0", default-features = false, features = ["parallel"] }
+ark-std = { version = "^0.4.0", default-features = false, features = ["parallel"] }
+ark-relations = { version = "^0.4.0", default-features = false }
+# this is patched at the workspace level
+ark-r1cs-std = { version = "0.4.0", default-features = false, features = ["parallel"] }
+ark-serialize = { version = "^0.4.0", default-features = false }
+ark-circom = { git = "https://github.com/arnaucube/circom-compat", default-features = false }
+num-bigint = "0.4"
+color-eyre = "=0.6.2"
+ark-noname = { git = "https://github.com/dmpierre/ark-noname", branch = "feat/sonobe-integration" }
+noname = { git = "https://github.com/dmpierre/noname" }
+serde_json = "1.0.85"                                                                # to (de)serialize JSON
+acvm = { git = "https://github.com/noir-lang/noir", rev="2b4853e", default-features = false }
+noir_arkworks_backend = { package="arkworks_backend", git = "https://github.com/dmpierre/arkworks_backend", branch = "feat/sonobe-integration" }
+folding-schemes = { path = "../folding-schemes/"}
+
+# tmp import for espresso's sumcheck
+espresso_subroutines = {git="https://github.com/EspressoSystems/hyperplonk", package="subroutines"}
+
+[dev-dependencies]
+ark-bn254 = {version="0.4.0", features=["r1cs"]}
+
+# This allows the crate to be built when targeting WASM.
+# See more at: https://docs.rs/getrandom/#webassembly-support 
+[target.'cfg(all(target_arch = "wasm32", target_os = "unknown"))'.dependencies]
+getrandom = { version = "0.2", features = ["js"] }
+
+[features]
+default = ["ark-circom/default", "parallel"]
+parallel = []
+wasm = ["ark-circom/wasm"]

frontends/README.md

@@ -0,0 +1,14 @@
+# frontends
+
+Experimental frontends for Sonobe.
+The recommended frontend is to directly use [arkworks](https://github.com/arkworks-rs) to define the FCircuit, just following the [`FCircuit` trait](https://github.com/privacy-scaling-explorations/sonobe/blob/main/folding-schemes/src/frontend/mod.rs).
+
+## Experimental frontends
+> Warning: the following frontends are experimental and some computational and time overhead is expected when using them compared to directly using the [arkworks frontend](https://github.com/privacy-scaling-explorations/sonobe/blob/main/folding-schemes/src/frontend/mod.rs).
+
+- [Circom](https://github.com/iden3/circom), iden3, 0Kims Association (supported v2.1.9)
+- [Noir](https://github.com/noir-lang/noir), Aztec
+- [Noname](https://github.com/zksecurity/noname), zkSecurity
+
+
+More details about frontends: https://privacy-scaling-explorations.github.io/sonobe-docs/usage/frontend.html