Merge pull request #55 from noir-lang/jc/update-recursion

Update recursion example and add recursion CI

Author: critesjosh

.github/workflows/recursion.yml

@@ -0,0 +1,44 @@
+name: Run recursion Tests on PR
+on:
+  pull_request:
+    paths:
+      - "recursion/**"
+
+jobs:
+  test:
+    defaults:
+      run:
+        working-directory: recursion
+
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Install Nargo
+        uses: noir-lang/noirup@v0.1.2
+        with:
+          toolchain: stable
+
+      - name: Install bb
+        run: |
+          curl -L https://raw.githubusercontent.com/AztecProtocol/aztec-packages/refs/heads/master/barretenberg/bbup/install | bash
+          echo "PATH=$PATH:/home/runner/.bb" >> $GITHUB_ENV
+
+      - name: Run bbup
+        run: |
+          bbup
+
+      - name: Build circuits
+        run: |
+          ./build.sh
+        working-directory: recursion/circuits
+
+      - name: Install JS dependencies
+        working-directory: recursion/js
+        run: |
+          yarn install
+
+      - name: Generate proof in JS
+        run: |
+          yarn generate-proof
+        working-directory: recursion/js

recursion/.gitignore

@@ -1,13 +1,9 @@
-proofs
-.vscode
-crs
-.DS_Store
-artifacts
-.cache
-.target
-typechain-types
 cache
-target
-.next
-node_modules
-next-env.d.types
+out
+proofs
+broadcast
+.env
+plonk_vk.sol
+circuits/**/target/*
+js/node_modules
+.DS_Store

recursion/.prettierignore

@@ -1,25 +1,28 @@
-# Recursive proofs with Noir
+# Noir Recursion Example
 
-Recursive proofs mean you prove that another proof is correct. A bit of a proofinception but bear
-with me:
+E2E example of generating a recursive proof using Noir and bb.js.
 
-- You prove that `x != y`
-- You pick that proof and send it to another circuit (the "outer" proof)
-- You generate the outer proof and verify it
+- Circuits in `circuits/` directory
+- JS code in `js/generate-proof.ts`
 
-Why is this useful? In this example, it doesn't do much. But you could verify two proofs within a
-proof, which can be incredibly useful.
+### Version used
 
-You could also avoid verifying stuff on-chain for turn-based games, for example. Check out the
-[Noir Docs](https://noir-lang.org/docs/explainers/explainer-recursion) for a high-level explanation.
+```
+Noir 1.0.0-beta.6
+bb 0.84.0
+```
 
-## Getting Started
+### Steps
 
-1. Install dependencies by running `yarn`
-2. For on-chain verification, open another terminal, and run
-   `cd packages/hardhat && npx hardhat node`
-3. Run `yarn dev`
+1. Compile the circuits
 
-## Testing
+```bash
+(cd circuits && ./build.sh)
+```
 
-To run the [test file](./packages/hardhat/test/index.test.ts), try `yarn test`
+2. Generate inner and recursive proof, and verify the recursive proof
+
+```bash
+(cd js && yarn install)
+(cd js && yarn generate-proof)
+```

recursion/.prettierrc

@@ -0,0 +1,13 @@
+set -e
+
+cd inner
+nargo compile
+bb write_vk --oracle_hash keccak -b ./target/inner.json -o ./target
+cd ..
+
+cd recursive
+nargo compile
+bb write_vk --oracle_hash keccak -b ./target/recursive.json -o ./target
+cd ..
+
+echo "Done"

recursion/.yarn/install-state.gz

@@ -0,0 +1,7 @@
+[package]
+name="inner"
+type="bin"
+authors = ["saleel"]
+compiler_version = ">=1.0.0"
+
+[dependencies]