Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

chore: add recursive example #4969

Draft
wants to merge 26 commits into
base: master
Choose a base branch
from
Draft

chore: add recursive example #4969

wants to merge 26 commits into from

Conversation

jzaki
Copy link
Contributor

@jzaki jzaki commented May 3, 2024

Description

Adds new examples directory with recursive example from dev-rel repo.

Problem

Examples in dev-rel are not kept strictly up to date with each noir language update, so when referred to in the docs would be out of date. This code will likely need updating before automating any test as part of noir repo's CI.

Resolves #4410

Summary

There were some quirks/workarounds at the time of writing, and fixes in Noir will likely resolve those quirks (if not already).

Additional Context

A future restructure would have a new docs directory created, with the current docs moving to subfolder in that, alongside examples. So structure could be something like docs/docs and docs/examples.
PS. I presume the prettier was on default cargo fmt settings.

Documentation

Check one:

  • No documentation needed.
  • Documentation included in this PR.
  • [For Experimental Features] Documentation to be submitted in a separate PR.

PR Checklist

  • I have tested the changes locally.
  • I have formatted the changes with Prettier and/or cargo fmt on default settings.

jzaki added 17 commits April 5, 2024 11:53
@jzaki
Add 'how-to/recursive-proofs/' from commit '6ede541281290dcff86ca37d4…
5763e3d 
…8bdfa1cd17ef69e'

git-subtree-dir: how-to/recursive-proofs
git-subtree-mainline: ae3bcde966dd2f1f52835ea83086c31f3046d812
git-subtree-split: 6ede541281290dcff86ca37d48bdfa1cd17ef69e
@jzaki
Ignore circuit exports
7c2c4cb
@jzaki
add usage instructions
5300045
@jzaki
User intermediate proof in circuit
20da2c1
@jzaki
Test altered proof
61e732b
@jzaki
verify outer proof
29a714f
@jzaki
Verify two inner proofs (exception)
5e036fc
@jzaki
minor updates to recursive howto script (exception)
dfbdbea
@jzaki
Single recursive function (WIP)
39d20c0
@jzaki
Revert "Single recursive function (WIP)"
f02851a 
This reverts commit 8120d965b61323a56b16b8531cc342fb48d49cee.
@jzaki
Modify for single nested recursion
112f83d
@jzaki
Add verification before failing recursive generation
fad7e64
@jzaki
fix public input length with hidden size
2ce50c5
@jzaki
WIP outer proof
d33f7ff
@jzaki
Fix execution errors with outer recursive proof
9c3d5af
@jzaki
Document recursive verification example
13a9ecf
@jzaki
Add 'examples/' from commit '13a9ecf375be0b85bdd6cbfc0e93a530b839f5d5'
ba904f4 
git-subtree-dir: examples
git-subtree-mainline: f7fa696
git-subtree-split: 13a9ecf
TomAFrench
TomAFrench reviewed May 3, 2024
View reviewed changes
Copy link
Member

@TomAFrench TomAFrench left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for this. We just need to hook it up into JS workspace + tested in CI

examples/recursive-proofs/package.json Outdated
Comment on lines 16 to 19
"@noir-lang/backend_barretenberg": "^0.26.0",
"@noir-lang/noir_codegen": "^0.26.0",
"@noir-lang/noir_js": "^0.26.0",
"@noir-lang/noir_wasm": "^0.26.0",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you add this package to the workspace and pull these packages from there?

examples/recursive-proofs/tsconfig.json Outdated
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We have a workspace tsconfig which this package can inherit from.

examples/recursive-proofs/package.json Outdated
@@ -0,0 +1,23 @@
{
"license": "UNLICENSED",
"scripts": {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you add a script which generates everything necessary and then runs main.ts? We'll then want to add this to CI.

examples/recursive-proofs/package.json Outdated Show resolved Hide resolved
examples/recursive-proofs/package.json Outdated Show resolved Hide resolved
examples/recursive-proofs/package.json Outdated
Comment on lines 8 to 11
"export:leaf": "nargo export --program-dir=./circuits/sum",
"export:recurseLeaf": "nargo export --program-dir=./circuits/recurseLeaf",
"export:recurseNode": "nargo export --program-dir=./circuits/recurseNode",
"export:all": "yarn clean:codegen && yarn export:leaf && yarn export:recurseLeaf && yarn export:recurseNode",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks like we don't use noir_codegen here?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Evolved from another example, and did remove use of codegen artifacts.

@TomAFrench TomAFrench self-assigned this May 3, 2024
@TomAFrench
Copy link
Member

Assigning myself just for tracking me supporting these efforts in the Noir board.

@TomAFrench
Copy link
Member

Also it would be good to experiment with inlining some of the text to be shown in the docs in amongst the code and using snippets to populate the doc. This would make it easier for us to keep text + code in sync.

jzaki and others added 2 commits May 3, 2024 14:50
@jzaki @TomAFrench
Update examples/recursive-proofs/package.json
23e43eb 
Co-authored-by: Tom French <15848336+TomAFrench@users.noreply.github.com>
@jzaki @TomAFrench
Update examples/recursive-proofs/package.json
96b8a22 
Co-authored-by: Tom French <15848336+TomAFrench@users.noreply.github.com>
@jzaki jzaki changed the title Jz/add recursive example chore: add recursive example May 3, 2024
@jzaki jzaki marked this pull request as draft May 8, 2024 10:35
@jzaki jzaki self-assigned this May 13, 2024
@TomAFrench TomAFrench mentioned this pull request May 14, 2024
Merged
@socket-security Socket Security
Copy link

New and removed dependencies detected. Learn more about Socket for GitHub ↗︎

Package New capabilities Transitives Size Publisher
npm/@cspell/cspell-json-reporter@8.8.1 None 0 12.3 kB jason-dent
npm/recursive-proofs-30599d@0.0.0-use.local None 0 0 B

🚮 Removed packages: npm/bech32@1.1.4, npm/chai-as-promised@7.1.2

View full report↗︎

TomAFrench added a commit to AztecProtocol/aztec-packages that referenced this pull request May 29, 2024
@TomAFrench
chore: add example for recursion on the CLI (#6389)
e704ff6 
This PR adds an example script which does recursive verification using
`nargo` and the `bb` binary as based on @jzaki's javascript example
noir-lang/noir#4969.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@TomAFrench TomAFrench TomAFrench left review comments

At least 1 approving review is required to merge this pull request.

Assignees

@jzaki jzaki

@TomAFrench TomAFrench

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Bring nested recursion example into noir-lang/noir
2 participants
@jzaki @TomAFrench