feat(utils): initialize benchmarks

.github/workflows/ci.yml

@@ -28,18 +28,18 @@ on:
 name: Tests
 
 jobs:
-  test:
+
+  multiplier:
     strategy:
       matrix:
         platform: [ubuntu-latest, macos-latest]
-        crate: [multiplier, semaphore, rln, utils]
     runs-on: ${{ matrix.platform }}
     timeout-minutes: 60
   
-    name: test - ${{ matrix.crate }} - ${{ matrix.platform }}
+    name: multiplier - ${{ matrix.platform }}
     steps:
       - name: Checkout sources
-        uses: actions/checkout@v3
+        uses: actions/checkout@v2
       - name: Install stable toolchain
         uses: actions-rs/toolchain@v1
         with:
@@ -52,8 +52,33 @@ jobs:
       - name: cargo-make test
         run: |
             cargo make test --release
-        working-directory: ${{ matrix.crate }}
+        working-directory: multiplier
   
+  semaphore:
+    strategy:
+      matrix:
+        platform: [ubuntu-latest, macos-latest]
+    runs-on: ${{ matrix.platform }}
+    timeout-minutes: 60
+  
+    name: semaphore - ${{ matrix.platform }}
+    steps:
+      - name: Checkout sources
+        uses: actions/checkout@v2
+      - name: Install stable toolchain
+        uses: actions-rs/toolchain@v1
+        with:
+          profile: minimal
+          toolchain: stable
+          override: true
+      - uses: Swatinem/rust-cache@v2
+      - name: Install Dependencies
+        run: make installdeps
+      - name: cargo-make test
+        run: |
+            cargo make test --release
+        working-directory: semaphore
+
   rln-wasm:
     strategy:
       matrix:
@@ -61,9 +86,9 @@ jobs:
     runs-on: ${{ matrix.platform }}
     timeout-minutes: 60
   
-    name: test - rln-wasm - ${{ matrix.platform }}
+    name: rln-wasm - ${{ matrix.platform }}
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v2
       - name: Install stable toolchain
         uses: actions-rs/toolchain@v1
         with:
@@ -80,19 +105,68 @@ jobs:
       - run: cargo make test --release
         working-directory: rln-wasm
 
+  rln:
+    strategy:
+      matrix:
+        platform: [ubuntu-latest, macos-latest]
+    runs-on: ${{ matrix.platform }}
+    timeout-minutes: 60
+  
+    name: rln - ${{ matrix.platform }}
+    steps:
+      - name: Checkout sources
+        uses: actions/checkout@v2
+      - name: Install stable toolchain
+        uses: actions-rs/toolchain@v1
+        with:
+          profile: minimal
+          toolchain: stable
+          override: true
+      - uses: Swatinem/rust-cache@v2
+      - name: Install Dependencies
+        run: make installdeps
+      - name: cargo-make test
+        run: |
+            cargo make test --release
+        working-directory: rln
+
+  utils:
+    strategy:
+      matrix:
+        platform: [ubuntu-latest, macos-latest]
+    runs-on: ${{ matrix.platform }}
+    timeout-minutes: 60
+  
+    name: utils - ${{ matrix.platform }}
+    steps:
+      - name: Checkout sources
+        uses: actions/checkout@v2
+      - name: Install stable toolchain
+        uses: actions-rs/toolchain@v1
+        with:
+          profile: minimal
+          toolchain: stable
+          override: true
+      - uses: Swatinem/rust-cache@v2
+      - name: Install Dependencies
+        run: make installdeps
+      - name: cargo-make test
+        run: |
+            cargo make test --release
+        working-directory: utils
+
   lint:
     strategy:
       matrix:
         # we run lint tests only on ubuntu
         platform: [ubuntu-latest]
-        crate: [multiplier, semaphore, rln, utils]
     runs-on: ${{ matrix.platform }}
     timeout-minutes: 60
 
-    name: lint - ${{ matrix.crate }} - ${{ matrix.platform }}  
+    name: lint - ${{ matrix.platform }}  
     steps:
       - name: Checkout sources
-        uses: actions/checkout@v3
+        uses: actions/checkout@v2
       - name: Install stable toolchain
         uses: actions-rs/toolchain@v1
         with:
@@ -105,33 +179,27 @@ jobs:
         run: make installdeps
       - name: cargo fmt
         if: success() || failure()
-        run: cargo fmt -- --check
-        working-directory: ${{ matrix.crate }}
-      - name: cargo clippy
+        run: cargo fmt --all -- --check
+      - name: multiplier - cargo clippy
         if: success() || failure()
         run: |
             cargo clippy --release -- -D warnings
-        working-directory: ${{ matrix.crate }}
+        working-directory: multiplier
+      - name: semaphore - cargo clippy
+        if: success() || failure()
+        run: |
+            cargo clippy --release -- -D warnings
+        working-directory: semaphore
+      - name: rln - cargo clippy
+        if: success() || failure()
+        run: |
+            cargo clippy --release -- -D warnings
+        working-directory: rln
+      - name: utils - cargo clippy
+        if: success() || failure()
+        run: |
+            cargo clippy --release -- -D warnings
+        working-directory: utils
         # We skip clippy on rln-wasm, since wasm target is managed by cargo make
         # Currently not treating warnings as error, too noisy
-        # -- -D warnings
-  benchmark:
-    # run only in pull requests
-    if: github.event_name == 'pull_request'
-    strategy:
-      matrix:
-        # we run benchmark tests only on ubuntu
-        platform: [ubuntu-latest]
-        crate: [rln, utils]
-    runs-on: ${{ matrix.platform }}
-    timeout-minutes: 60
-
-    name: benchmark - ${{ matrix.platform }} - ${{ matrix.crate }}
-    steps:
-      - name: Checkout sources
-        uses: actions/checkout@v3
-      - uses: Swatinem/rust-cache@v2
-      - uses: boa-dev/criterion-compare-action@v3
-        with:
-          branchName: ${{ github.base_ref }}
-          cwd: ${{ matrix.crate }}
+        # -- -D warnings

.github/workflows/nightly-release.yml

@@ -16,7 +16,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout sources
-        uses: actions/checkout@v3
+        uses: actions/checkout@v2
       - name: Install stable toolchain
         uses: actions-rs/toolchain@v1
         with:
@@ -51,7 +51,7 @@ jobs:
           - aarch64-apple-darwin
     steps:
       - name: Checkout sources
-        uses: actions/checkout@v3
+        uses: actions/checkout@v2
       - name: Install stable toolchain
         uses: actions-rs/toolchain@v1
         with:
@@ -81,7 +81,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout sources
-        uses: actions/checkout@v3
+        uses: actions/checkout@v2
       - name: Install stable toolchain
         uses: actions-rs/toolchain@v1
         with:
@@ -115,7 +115,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout code
-        uses: actions/checkout@v3
+        uses: actions/checkout@v2
         with:
           ref: master
       - name: Download artifacts

.github/workflows/sync-labels.yml

@@ -9,7 +9,7 @@ jobs:
   build:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v2
       - uses: micnncim/action-label-syncer@v1
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

Cargo.lock

@@ -2678,7 +2678,6 @@ dependencies = [
  "ark-std 0.4.0",
  "cfg-if",
  "color-eyre 0.6.2",
- "criterion 0.4.0",
  "include_dir",
  "num-bigint",
  "num-traits",

rln-cli/src/commands.rs

@@ -33,33 +33,4 @@ pub(crate) enum Commands {
         #[arg(short, long)]
         file: PathBuf,
     },
-    SetNextLeaf {
-        #[arg(short, long)]
-        file: PathBuf,
-    },
-    DeleteLeaf {
-        index: usize,
-    },
-    GetRoot,
-    GetProof {
-        index: usize,
-    },
-    Prove {
-        #[arg(short, long)]
-        input: PathBuf,
-    },
-    Verify {
-        #[arg(short, long)]
-        file: PathBuf,
-    },
-    GenerateProof {
-        #[arg(short, long)]
-        input: PathBuf,
-    },
-    VerifyWithRoots {
-        #[arg(short, long)]
-        input: PathBuf,
-        #[arg(short, long)]
-        roots: PathBuf,
-    },
 }

rln-cli/src/main.rs

@@ -54,7 +54,7 @@ fn main() -> Result<()> {
         Some(Commands::SetTree { tree_height }) => {
             state
                 .rln
-                .ok_or(Report::msg("no RLN instance initialized"))?
+                .ok_or(Report::msg("no RLN initialized"))?
                 .set_tree(*tree_height)?;
             Ok(())
         }
@@ -62,7 +62,7 @@ fn main() -> Result<()> {
             let input_data = File::open(&file)?;
             state
                 .rln
-                .ok_or(Report::msg("no RLN instance initialized"))?
+                .ok_or(Report::msg("no RLN initialized"))?
                 .set_leaf(*index, input_data)?;
             Ok(())
         }
@@ -70,7 +70,7 @@ fn main() -> Result<()> {
             let input_data = File::open(&file)?;
             state
                 .rln
-                .ok_or(Report::msg("no RLN instance initialized"))?
+                .ok_or(Report::msg("no RLN initialized"))?
                 .set_leaves_from(*index, input_data)?;
             Ok(())
         }
@@ -78,76 +78,10 @@ fn main() -> Result<()> {
             let input_data = File::open(&file)?;
             state
                 .rln
-                .ok_or(Report::msg("no RLN instance initialized"))?
+                .ok_or(Report::msg("no RLN initialized"))?
                 .init_tree_with_leaves(input_data)?;
             Ok(())
         }
-        Some(Commands::SetNextLeaf { file }) => {
-            let input_data = File::open(&file)?;
-            state
-                .rln
-                .ok_or(Report::msg("no RLN instance initialized"))?
-                .set_next_leaf(input_data)?;
-            Ok(())
-        }
-        Some(Commands::DeleteLeaf { index }) => {
-            state
-                .rln
-                .ok_or(Report::msg("no RLN instance initialized"))?
-                .delete_leaf(*index)?;
-            Ok(())
-        }
-        Some(Commands::GetRoot) => {
-            let writer = std::io::stdout();
-            state
-                .rln
-                .ok_or(Report::msg("no RLN instance initialized"))?
-                .get_root(writer)?;
-            Ok(())
-        }
-        Some(Commands::GetProof { index }) => {
-            let writer = std::io::stdout();
-            state
-                .rln
-                .ok_or(Report::msg("no RLN instance initialized"))?
-                .get_proof(*index, writer)?;
-            Ok(())
-        }
-        Some(Commands::Prove { input }) => {
-            let input_data = File::open(&input)?;
-            let writer = std::io::stdout();
-            state
-                .rln
-                .ok_or(Report::msg("no RLN instance initialized"))?
-                .prove(input_data, writer)?;
-            Ok(())
-        }
-        Some(Commands::Verify { file }) => {
-            let input_data = File::open(&file)?;
-            state
-                .rln
-                .ok_or(Report::msg("no RLN instance initialized"))?
-                .verify(input_data)?;
-            Ok(())
-        }
-        Some(Commands::GenerateProof { input }) => {
-            let input_data = File::open(&input)?;
-            let writer = std::io::stdout();
-            state
-                .rln
-                .ok_or(Report::msg("no RLN instance initialized"))?
-                .generate_rln_proof(input_data, writer)?;
-            Ok(())
-        }
-        Some(Commands::VerifyWithRoots { input, roots }) => {
-            let input_data = File::open(&input)?;
-            let roots_data = File::open(&roots)?;
-            state
-                .rln
-                .ok_or(Report::msg("no RLN instance initialized"))?
-                .verify_with_roots(input_data, roots_data)?;
-            Ok(())
-        }
         None => Ok(()),
     }
 }

rln/Cargo.toml

@@ -6,7 +6,6 @@ license = "MIT OR Apache-2.0"
 
 [lib]
 crate-type = ["rlib", "staticlib"]
-bench = false
 
 # This flag disable cargo doctests, i.e. testing example code-snippets in documentation
 doctest = false
@@ -48,7 +47,6 @@ include_dir = "=0.7.3"
 
 [dev-dependencies]
 sled = "=0.34.7"
-criterion = { version = "0.4", features = ["html_reports"] }
 
 [features]
 default = ["parallel", "wasmer/sys-default", "pmtree-ft"]
@@ -58,7 +56,3 @@ fullmerkletree = ["default"]
 
 # Note: pmtree feature is still experimental
 pmtree-ft = ["utils/pmtree-ft"]
-
-[[bench]]
-name = "pmtree_benchmark"
-harness = false

rln/Makefile.toml

@@ -5,7 +5,3 @@ args = ["build", "--release"]
 [tasks.test]
 command = "cargo"
 args = ["test", "--release"]
-
-[tasks.bench]
-command = "cargo"
-args = ["bench"]

rln/benches/pmtree_benchmark.rs

@@ -1,44 +0,0 @@
-use criterion::{criterion_group, criterion_main, Criterion};
-use utils::ZerokitMerkleTree;
-
-use rln::{circuit::Fr, pm_tree_adapter::PmTree};
-
-pub fn pmtree_benchmark(c: &mut Criterion) {
-    let mut tree = PmTree::default(2).unwrap();
-
-    let leaves: Vec<Fr> = (0..4).map(|s| Fr::from(s)).collect();
-
-    c.bench_function("Pmtree::set", |b| {
-        b.iter(|| {
-            tree.set(0, leaves[0]).unwrap();
-        })
-    });
-
-    c.bench_function("Pmtree:delete", |b| {
-        b.iter(|| {
-            tree.delete(0).unwrap();
-        })
-    });
-
-    c.bench_function("Pmtree::override_range", |b| {
-        b.iter(|| {
-            tree.override_range(0, leaves.clone(), [0, 1, 2, 3])
-                .unwrap();
-        })
-    });
-
-    c.bench_function("Pmtree::compute_root", |b| {
-        b.iter(|| {
-            tree.compute_root().unwrap();
-        })
-    });
-
-    c.bench_function("Pmtree::get", |b| {
-        b.iter(|| {
-            tree.get(0).unwrap();
-        })
-    });
-}
-
-criterion_group!(benches, pmtree_benchmark);
-criterion_main!(benches);

rln/src/pm_tree_adapter.rs

@@ -61,22 +61,10 @@ impl FromStr for PmtreeConfig {
         let temporary = config["temporary"].as_bool();
         let path = config["path"].as_str();
         let path = path.map(PathBuf::from);
-        let cache_capacity = config["cache_capacity"].as_u64();
-        let flush_every_ms = config["flush_every_ms"].as_u64();
-        let mode = match config["mode"].as_str() {
-            Some("HighThroughput") => Mode::HighThroughput,
-            Some("LowSpace") => Mode::LowSpace,
-            _ => Mode::HighThroughput,
-        };
-        let use_compression = config["use_compression"].as_bool();
 
         let config = pm_tree::Config::new()
             .temporary(temporary.unwrap_or(get_tmp()))
-            .path(path.unwrap_or(get_tmp_path()))
-            .cache_capacity(cache_capacity.unwrap_or(1024 * 1024 * 1024))
-            .flush_every_ms(flush_every_ms)
-            .mode(mode)
-            .use_compression(use_compression.unwrap_or(false));
+            .path(path.unwrap_or(get_tmp_path()));
         Ok(PmtreeConfig(config))
     }
 }
@@ -84,15 +72,7 @@ impl FromStr for PmtreeConfig {
 impl Default for PmtreeConfig {
     fn default() -> Self {
         let tmp_path = get_tmp_path();
-        PmtreeConfig(
-            pm_tree::Config::new()
-                .temporary(true)
-                .path(tmp_path)
-                .cache_capacity(150_000)
-                .mode(Mode::HighThroughput)
-                .use_compression(false)
-                .flush_every_ms(Some(12_000)),
-        )
+        PmtreeConfig(pm_tree::Config::new().temporary(true).path(tmp_path))
     }
 }
 impl Debug for PmtreeConfig {

rln/src/public.rs

@@ -554,8 +554,7 @@ impl RLN<'_> {
         // [ proof<128> | root<32> | epoch<32> | share_x<32> | share_y<32> | nullifier<32> | rln_identifier<32> ]
         let mut input_byte: Vec<u8> = Vec::new();
         input_data.read_to_end(&mut input_byte)?;
-        let proof =
-            ArkProof::deserialize_compressed_unchecked(&mut Cursor::new(&input_byte[..128]))?;
+        let proof = ArkProof::deserialize_compressed(&mut Cursor::new(&input_byte[..128]))?;
 
         let (proof_values, _) = deserialize_proof_values(&input_byte[128..]);
 
@@ -685,9 +684,8 @@ impl RLN<'_> {
         let mut serialized: Vec<u8> = Vec::new();
         input_data.read_to_end(&mut serialized)?;
         let mut all_read = 0;
-        let proof = ArkProof::deserialize_compressed_unchecked(&mut Cursor::new(
-            &serialized[..128].to_vec(),
-        ))?;
+        let proof =
+            ArkProof::deserialize_compressed(&mut Cursor::new(&serialized[..128].to_vec()))?;
         all_read += 128;
         let (proof_values, read) = deserialize_proof_values(&serialized[all_read..]);
         all_read += read;
@@ -764,9 +762,8 @@ impl RLN<'_> {
         let mut serialized: Vec<u8> = Vec::new();
         input_data.read_to_end(&mut serialized)?;
         let mut all_read = 0;
-        let proof = ArkProof::deserialize_compressed_unchecked(&mut Cursor::new(
-            &serialized[..128].to_vec(),
-        ))?;
+        let proof =
+            ArkProof::deserialize_compressed(&mut Cursor::new(&serialized[..128].to_vec()))?;
         all_read += 128;
         let (proof_values, read) = deserialize_proof_values(&serialized[all_read..]);
         all_read += read;
@@ -1433,8 +1430,7 @@ mod test {
         let serialized_proof = output_buffer.into_inner();
 
         // Before checking public verify API, we check that the (deserialized) proof generated by prove is actually valid
-        let proof = ArkProof::deserialize_compressed_unchecked(&mut Cursor::new(&serialized_proof))
-            .unwrap();
+        let proof = ArkProof::deserialize_compressed(&mut Cursor::new(&serialized_proof)).unwrap();
         let verified = verify_proof(&rln.verification_key, &proof, &proof_values);
         assert!(verified.unwrap());
 

utils/Cargo.toml

@@ -3,8 +3,6 @@ name = "utils"
 version = "0.1.0"
 edition = "2021"
 license = "MIT OR Apache-2.0"
-
-[lib]
 bench = false
 
 [dependencies]

utils/Makefile.toml

@@ -5,7 +5,3 @@ args = ["build", "--release"]
 [tasks.test]
 command = "cargo"
 args = ["test", "--release"]
-
-[tasks.bench]
-command = "cargo"
-args = ["bench"]