Release 0.5

.github/workflows/ci.yml

@@ -16,7 +16,7 @@ jobs:
         uses: actions-rs/toolchain@v1
         with:
           profile: minimal
-          toolchain: 1.75.0
+          toolchain: stable
           override: true
 
       # Install for Anvil
@@ -34,11 +34,6 @@ jobs:
             export PATH=$HOME/bin:$PATH
             cargo test
 
-      - name: cargo test circom 2 feature flag
-        run: |
-            export PATH=$HOME/bin:$PATH
-            cargo test --features circom-2
-
   lint:
     runs-on: ubuntu-latest
     steps:
@@ -48,10 +43,25 @@ jobs:
         uses: actions-rs/toolchain@v1
         with:
           profile: minimal
-          toolchain: 1.75.0
+          toolchain: stable
           override: true
           components: rustfmt, clippy
       - name: cargo fmt
         run: cargo fmt --all -- --check
       - name: cargo clippy
         run: cargo clippy -- -D warnings
+
+  wasm32-wasip1-check:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout sources
+        uses: actions/checkout@v2
+      - name: Install stable toolchain
+        uses: actions-rs/toolchain@v1
+        with:
+          profile: minimal
+          toolchain: stable
+          override: true
+          target: wasm32-wasip1
+      - name: Check wasm32-wasip compilation
+        run: cargo check --target wasm32-wasip1 --no-default-features --features="wasm"

.gitignore

@@ -1,2 +1,3 @@
 /target
 Cargo.lock
+*.ptau

Cargo.toml

@@ -1,32 +1,35 @@
 [package]
 name = "ark-circom"
-version = "0.1.0"
+version = "0.5.0"
 edition = "2021"
 description = "Arkworks bindings to Circom's R1CS, for Groth16 Proof and Witness generation in Rust"
+homepage = "https://arkworks.rs"
+repository = "https://github.com/arkworks-rs/circom-compat"
 license = "MIT OR Apache-2.0"
+resolver = "2"
 
 [lib]
 crate-type = ["cdylib", "rlib"]
 
 [dependencies]
 # WASM operations
-wasmer = "4.4.0"
-wasmer-wasix = { version = "0.28.0" }
+wasmer = { version = "4.4.0", default-features = false }
+wasmer-wasix = { version = "0.28.0", default-features = false }
 fnv = { version = "1.0.7", default-features = false }
 num = { version = "0.4.3" }
 num-traits = { version = "0.2.16", default-features = false }
 num-bigint = { version = "0.4.3", default-features = false, features = ["rand"] }
 
 # ZKP Generation
-ark-crypto-primitives = { version = "0.4.0" }
-ark-ec = { version = "0.4.2", default-features = false, features = ["parallel"] }
-ark-ff = { version = "0.4.2", 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", default-features = false, features = ["parallel"] }
-ark-poly = { version = "0.4.2", default-features = false, features = ["parallel"] }
-ark-relations = { version = "0.4.0", default-features = false }
-ark-serialize = { version = "0.4.2", default-features = false }
+ark-crypto-primitives = { version = "0.5.0" }
+ark-ff = { version = "0.5.0", default-features = false, features = ["parallel", "asm"] }
+ark-ec = { version = "0.5.0", default-features = false, features = ["parallel"] }
+ark-std = { version = "0.5.0", default-features = false, features = ["parallel"] }
+ark-bn254 = { version = "0.5.0" }
+ark-groth16 = { version = "0.5.0", default-features = false, features = ["parallel"] }
+ark-poly = { version = "0.5.0", default-features = false, features = ["parallel"] }
+ark-relations = { version = "0.5.0", default-features = false }
+ark-serialize = { version = "0.5.0", default-features = false }
 
 
 # decoding of data
@@ -54,8 +57,7 @@ name = "groth16"
 harness = false
 
 [features]
-default = ["wasmer/default", "circom-2", "ethereum"]
-wasm = ["wasmer/js-default"]
+default = ["wasmer/default", "ethereum", "wasmer-wasix/default"]
+wasm = ["wasmer/js-default", "wasmer-wasix/js"]
 bench-complex-all = []
-circom-2 = []
 ethereum = ["ethers-core"]

README.md

@@ -13,7 +13,7 @@ Clone the repository and run `cd ark-circom/ && cargo doc --open`
 ```toml
 [dependencies]
 
-ark-circom = { git = "https://github.com/gakonst/ark-circom.git" }
+ark-circom = "0.5.0"
 ```
 
 ## Example
@@ -66,6 +66,13 @@ Tests require the following installed:
 - [x] Proof generations and verification using Arkworks
 - [ ] CLI for common operations
 
+## Notes
+
+The prover key generated by circom differs from the one generated by arkworks' groth16 library. While the format is the same, it represents different values.
+Circom 'prepares' the powers of tau by converting them to Lagrange base, i.e. from `s^i.G` -> `L_i(s).G`. This affects the witness generation process, and the caller needs to ensure the correct `R1CSToQAP` implementer is used:
+- use [`CircomReduction`](https://github.com/arkworks-rs/circom-compat/blob/b892c62597687c23341cda1e8e89d58bb6428f36/src/circom/qap.rs#L12) for working with circom-generated files,
+- use [`LibsnarkReduction`](https://github.com/arkworks-rs/groth16/blob/5272c935bda290a24cd18d0a3f994b0af70d5f27/src/r1cs_to_qap.rs#L101) for setup produced using the arkworks backend.
+
 ## Acknowledgements
 
 This library would not have been possibly without the great work done in:

rust-toolchain.toml

@@ -1,3 +1,2 @@
 [toolchain]
-channel = "stable"
-version = "1.75.0"
+channel = "stable"

src/circom/circuit.rs

@@ -92,7 +92,7 @@ mod tests {
     #[tokio::test]
     async fn satisfied() {
         let cfg = CircomConfig::<Fr>::new(
-            "./test-vectors/mycircuit.wasm",
+            "./test-vectors/mycircuit_js/mycircuit.wasm",
             "./test-vectors/mycircuit.r1cs",
         )
         .unwrap();

src/witness/circom.rs

@@ -7,164 +7,57 @@ pub struct Wasm {
     pub memory: Memory,
 }
 
-pub trait CircomBase {
-    fn init(&self, store: &mut Store, sanity_check: bool) -> Result<()>;
-    fn func(&self, name: &str) -> &Function;
-    fn get_n_vars(&self, store: &mut Store) -> Result<u32>;
-    fn get_u32(&self, store: &mut Store, name: &str) -> Result<u32>;
-    // Only exists natively in Circom2, hardcoded for Circom
-    fn get_version(&self, store: &mut Store) -> Result<u32>;
-}
-
-pub trait Circom1 {
-    fn get_ptr_witness(&self, store: &mut Store, w: u32) -> Result<u32>;
-    fn get_fr_len(&self, store: &mut Store) -> Result<u32>;
-    fn get_signal_offset32(
-        &self,
-        store: &mut Store,
-        p_sig_offset: u32,
-        component: u32,
-        hash_msb: u32,
-        hash_lsb: u32,
-    ) -> Result<()>;
-    fn set_signal(
-        &self,
-        store: &mut Store,
-        c_idx: u32,
-        component: u32,
-        signal: u32,
-        p_val: u32,
-    ) -> Result<()>;
-    fn get_ptr_raw_prime(&self, store: &mut Store) -> Result<u32>;
-}
-
-pub trait Circom2 {
-    fn get_field_num_len32(&self, store: &mut Store) -> Result<u32>;
-    fn get_raw_prime(&self, store: &mut Store) -> Result<()>;
-    fn read_shared_rw_memory(&self, store: &mut Store, i: u32) -> Result<u32>;
-    fn write_shared_rw_memory(&self, store: &mut Store, i: u32, v: u32) -> Result<()>;
-    fn set_input_signal(&self, store: &mut Store, hmsb: u32, hlsb: u32, pos: u32) -> Result<()>;
-    fn get_witness(&self, store: &mut Store, i: u32) -> Result<()>;
-    fn get_witness_size(&self, store: &mut Store) -> Result<u32>;
-}
-
-impl Circom1 for Wasm {
-    fn get_fr_len(&self, store: &mut Store) -> Result<u32> {
-        self.get_u32(store, "getFrLen")
-    }
-
-    fn get_ptr_raw_prime(&self, store: &mut Store) -> Result<u32> {
-        self.get_u32(store, "getPRawPrime")
-    }
-
-    fn get_ptr_witness(&self, store: &mut Store, w: u32) -> Result<u32> {
-        let func = self.func("getPWitness");
-
-        let res = func.call(store, &[w.into()])?;
-
-        Ok(res[0].unwrap_i32() as u32)
-    }
-
-    fn get_signal_offset32(
-        &self,
-        store: &mut Store,
-        p_sig_offset: u32,
-        component: u32,
-        hash_msb: u32,
-        hash_lsb: u32,
-    ) -> Result<()> {
-        let func = self.func("getSignalOffset32");
-        func.call(
-            store,
-            &[
-                p_sig_offset.into(),
-                component.into(),
-                hash_msb.into(),
-                hash_lsb.into(),
-            ],
-        )?;
-
-        Ok(())
-    }
-
-    fn set_signal(
-        &self,
-        store: &mut Store,
-        c_idx: u32,
-        component: u32,
-        signal: u32,
-        p_val: u32,
-    ) -> Result<()> {
-        let func = self.func("setSignal");
-        func.call(
-            store,
-            &[c_idx.into(), component.into(), signal.into(), p_val.into()],
-        )?;
-
-        Ok(())
-    }
-}
-
-#[cfg(feature = "circom-2")]
-impl Circom2 for Wasm {
-    fn get_field_num_len32(&self, store: &mut Store) -> Result<u32> {
+impl Wasm {
+    pub(crate) fn get_field_num_len32(&self, store: &mut Store) -> Result<u32> {
         self.get_u32(store, "getFieldNumLen32")
     }
 
-    fn get_raw_prime(&self, store: &mut Store) -> Result<()> {
+    pub(crate) fn get_raw_prime(&self, store: &mut Store) -> Result<()> {
         let func = self.func("getRawPrime");
         func.call(store, &[])?;
         Ok(())
     }
 
-    fn read_shared_rw_memory(&self, store: &mut Store, i: u32) -> Result<u32> {
+    pub(crate) fn read_shared_rw_memory(&self, store: &mut Store, i: u32) -> Result<u32> {
         let func = self.func("readSharedRWMemory");
         let result = func.call(store, &[i.into()])?;
         Ok(result[0].unwrap_i32() as u32)
     }
 
-    fn write_shared_rw_memory(&self, store: &mut Store, i: u32, v: u32) -> Result<()> {
+    pub(crate) fn write_shared_rw_memory(&self, store: &mut Store, i: u32, v: u32) -> Result<()> {
         let func = self.func("writeSharedRWMemory");
         func.call(store, &[i.into(), v.into()])?;
         Ok(())
     }
 
-    fn set_input_signal(&self, store: &mut Store, hmsb: u32, hlsb: u32, pos: u32) -> Result<()> {
+    pub(crate) fn set_input_signal(
+        &self,
+        store: &mut Store,
+        hmsb: u32,
+        hlsb: u32,
+        pos: u32,
+    ) -> Result<()> {
         let func = self.func("setInputSignal");
         func.call(store, &[hmsb.into(), hlsb.into(), pos.into()])?;
         Ok(())
     }
 
-    fn get_witness(&self, store: &mut Store, i: u32) -> Result<()> {
+    pub(crate) fn get_witness(&self, store: &mut Store, i: u32) -> Result<()> {
         let func = self.func("getWitness");
         func.call(store, &[i.into()])?;
         Ok(())
     }
 
-    fn get_witness_size(&self, store: &mut Store) -> Result<u32> {
+    pub(crate) fn get_witness_size(&self, store: &mut Store) -> Result<u32> {
         self.get_u32(store, "getWitnessSize")
     }
-}
 
-impl CircomBase for Wasm {
-    fn init(&self, store: &mut Store, sanity_check: bool) -> Result<()> {
+    pub(crate) fn init(&self, store: &mut Store, sanity_check: bool) -> Result<()> {
         let func = self.func("init");
         func.call(store, &[Value::I32(sanity_check as i32)])?;
         Ok(())
     }
 
-    fn get_n_vars(&self, store: &mut Store) -> Result<u32> {
-        self.get_u32(store, "getNVars")
-    }
-
-    // Default to version 1 if it isn't explicitly defined
-    fn get_version(&self, store: &mut Store) -> Result<u32> {
-        match self.exports.get_function("getVersion") {
-            Ok(func) => Ok(func.call(store, &[])?[0].unwrap_i32() as u32),
-            Err(_) => Ok(1),
-        }
-    }
-
     fn get_u32(&self, store: &mut Store, name: &str) -> Result<u32> {
         let func = &self.func(name);
         let result = func.call(store, &[])?;

src/witness/mod.rs

@@ -5,14 +5,8 @@ mod memory;
 pub(super) use memory::SafeMemory;
 
 mod circom;
-pub(super) use circom::CircomBase;
 pub use circom::Wasm;
 
-#[cfg(feature = "circom-2")]
-pub(super) use circom::Circom2;
-
-pub(super) use circom::Circom1;
-
 use fnv::FnvHasher;
 use std::hash::Hasher;