Merge pull request #1 from noir-lang/jtriley/updates

jtriley2p · web-flow · commit 7be571e7915d · 2025-01-16T07:15:09.000-08:00
chore: Updates to tests, fuzzes, scripts, &amp; metadata
diff --git a/.github/workflows/benchmark.yml b/.github/workflows/benchmark.yml
@@ -3,7 +3,7 @@ name: Benchmarks
 on:
   push:
    branches:
-    - master
+    - main
   pull_request:
 
 jobs:
@@ -17,12 +17,12 @@ jobs:
       - name: Install Nargo
         uses: noir-lang/noirup@v0.1.3
         with:
-          toolchain: 0.34.0
+          toolchain: 0.36.0
 
       - name: Install bb
         run: |
           npm install -g bbup
-          bbup -nv 0.34.0
+          bbup -nv 0.36.0
 
       - name: Build Noir benchmark programs
         run: nargo export
@@ -34,7 +34,7 @@ jobs:
 
       - name: Compare gates reports
         id: gates_diff
-        uses: noir-lang/noir-gates-diff@1931aaaa848a1a009363d6115293f7b7fc72bb87
+        uses: noir-lang/noir-gates-diff@7e4ddaa91c69380f15ccba514eac17bc7432a8cc
         with:
           report: gates_report.json
           summaryQuantile: 0.9 # only display the 10% most significant circuit size diffs in the summary (defaults to 20%)
diff --git a/.github/workflows/nightly-canary.yml b/.github/workflows/nightly-canary.yml
@@ -13,7 +13,7 @@ permissions:
 
 jobs:
   test:
-    name: Test on Nargo ${{matrix.toolchain}}
+    name: Test on Nargo Nightly
     runs-on: ubuntu-latest
     steps:
       - name: Checkout sources
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -3,7 +3,7 @@ name: Release
 on:
   push:
     branches:
-      - master
+      - main
 
 jobs:
   release-please:
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -47,6 +47,21 @@ jobs:
         with:
           toolchain: ${{ matrix.toolchain }}
 
+      - name: Run Noir tests
+        run: nargo test
+
+  rust-equivalence-tests:
+    name: Test for equivalence against Rust impl
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout sources
+        uses: actions/checkout@v4
+
+      - name: Install Nargo
+        uses: noir-lang/noirup@v0.1.3
+        with:
+          toolchain: ${{ env.MINIMUM_NOIR_VERSION }}
+
       - name: Install Cargo
         uses: dtolnay/rust-toolchain@1.74.1
         with:
@@ -58,11 +73,8 @@ jobs:
           key: x86_64-unknown-linux-gnu
           cache-on-failure: true
 
-      - name: Run Noir tests
-        run: nargo test
-
-      - name: Run Cargo tests
-        run: cargo test
+      - name: Export and Test Noir Functions
+        run: ./scripts/fuzz-test.sh
 
   format:
     runs-on: ubuntu-latest
@@ -87,6 +99,7 @@ jobs:
     if: ${{ always() }}
     needs: 
       - test
+      - rust-equivalence-tests
       - format
 
     steps:
diff --git a/.gitignore b/.gitignore
@@ -1 +1,3 @@
-/target
+target
+export
+gates_report.json
diff --git a/Nargo.toml b/Nargo.toml
@@ -1,7 +1,7 @@
 [package]
 name = "keccak256"
 type = "lib"
-authors = ["jtriley-eth"]
+authors = ["noir-lang"]
 compiler_version = ">=0.36.0"
 
 [dependencies]
diff --git a/README.md b/README.md
@@ -2,4 +2,27 @@
 
 This package contains the Keccak256 hashing interface, formerly in the Noir standard library.
 
-> WIP
+## Noir Version Compatibility
+
+This library is tested to work as of Noir v0.36.0.
+
+## Benchmarks
+
+Benchmarks are ignored by `git` and checked on pull-request. As such, benchmarks may be generated
+with the following command.
+
+```bash
+# execute the following
+./scripts/build-gates-report.sh
+```
+
+The benchmark will be generated at `./gates_report.json`.
+
+## Installation
+
+In `Nargo.toml`, add the version of this library desired to install the dependency:
+
+```toml
+[dependencies]
+keccak256 = { tag = "v0.1.0", git = "https://github.com/noir-lang/keccak256" }
+```
diff --git a/export/test_keccak256_0.json b/export/test_keccak256_0.json
diff --git a/export/test_keccak256_1.json b/export/test_keccak256_1.json
diff --git a/export/test_keccak256_100.json b/export/test_keccak256_100.json
diff --git a/scripts/fuzz-test.sh b/scripts/fuzz-test.sh
@@ -0,0 +1,19 @@
+#!/usr/bin/env bash
+set -e
+
+# dependencies:
+#
+# - `nargo`
+# - `cargo`
+
+# export noir functions purely in brillig
+nargo export --force-brillig
+
+# run rust prop tests against brillig functions
+cargo test
+
+# export noir functions as-is
+nargo export
+
+# run rust prop tests against noir functions
+cargo test
diff --git a/src/keccak256.nr b/src/keccak256.nr
@@ -1,3 +1,5 @@
+mod tests;
+
 use std::runtime::is_unconstrained;
 use std::hash::keccak::keccakf1600;
 
@@ -7,7 +9,7 @@ global LIMBS_PER_BLOCK: u32 = BLOCK_SIZE_IN_BYTES / WORD_SIZE;
 global NUM_KECCAK_LANES: u32 = 25;
 
 #[no_predicates]
-pub(crate) fn keccak256<let N: u32>(input: [u8; N], message_size: u32) -> [u8; 32] {
+pub fn keccak256<let N: u32>(input: [u8; N], message_size: u32) -> [u8; 32] {
     assert(N >= message_size);
 
     // Copy input to block bytes. For that we'll need at least input bytes (N)
diff --git a/src/keccak256/tests.nr b/src/keccak256/tests.nr
@@ -1,9 +1,4 @@
-use crate::keccak256::keccak256;
-
-#[export]
-fn test_keccak256_0() -> [u8; 32] {
-    keccak256([], 0)
-}
+use super::keccak256;
 
 #[export]
 fn test_keccak256_1(input: [u8; 1], len: u32) -> [u8; 32] {
diff --git a/src/lib.nr b/src/lib.nr
@@ -1,4 +1,3 @@
 mod keccak256;
-mod tests;
 
 pub use keccak256::keccak256;
diff --git a/tests/differential.rs b/tests/differential.rs
@@ -5,20 +5,6 @@ use noir_runner::{NoirRunner, ToNoir};
 use proptest::{prelude::prop, test_runner::TestRunner};
 use sha3::{Digest, Keccak256};
 
-#[test]
-fn test_vibe_check() {
-    let runner = NoirRunner::try_new(PathBuf::new()).unwrap();
-
-    let result = runner
-        .run("test_keccak256_0", BTreeMap::new())
-        .unwrap()
-        .unwrap();
-
-    let expected: [u8; 32] = Keccak256::digest([]).try_into().unwrap();
-
-    assert_eq!(result, expected.to_noir());
-}
-
 #[test]
 fn test_prop_keccak256_1() {
     let runner = NoirRunner::try_new(PathBuf::new()).unwrap();

-Original file line number
+Diff line change
@@ @@ -1 +1,3 @@ @@
 -/target
 +target
 +export
 +gates_report.json