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.

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

chore(docs): updating docs to match new recursion interfacee #4187

Merged
merged 3 commits into from
Jan 30, 2024

Conversation

signorecello
Copy link
Contributor

Description

This PR documents the new recursion interface.

Problem*

Resolves #4139
Resolves AztecProtocol/dev-rel#148

Summary*

  • Removes the usage of aggregation object while retaining the mention that recursive proofs are actually aggregation of proofs
  • Removes the mention to add the size of public inputs to the proof, as they are now separate
  • Removes some leftover explainer in the verify_proof reference

Additional Context

noir-examples is actually not working with this new interface, as I'm blocked by a weird issue where proofs give me my dear friend unreachable

Will debug that next week with @TomAFrench but I think we're good to push the docs for now.

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Jan 27, 2024
Copy link
Contributor

github-actions bot commented Jan 27, 2024

@TomAFrench
Copy link
Member

Can you update the PR title to represent what this PR is doing in the docs?

@signorecello signorecello changed the title chore(docs): moving this forward even though noir-examples isn't working chore(docs): updating docs to match new recursion interfacee Jan 29, 2024
@signorecello
Copy link
Contributor Author

Sure, sorry took it from the commit message (which wasn't descriptive either I reckon)

@Savio-Sou
Copy link
Collaborator

Thank you for drafting the PR!

Can we also add the changes into versioned_docs/version-v0.23.0? (#3955 was a part of v0.23.0.)

@signorecello
Copy link
Contributor Author

Gonna YOLO this without re-review for versioned_docs, trust me bro

@signorecello signorecello added this pull request to the merge queue Jan 30, 2024
Merged via the queue into master with commit f4de6ee Jan 30, 2024
33 checks passed
@signorecello signorecello deleted the zpedro/recursion_interface branch January 30, 2024 15:28
TomAFrench added a commit that referenced this pull request Jan 31, 2024
* master:
  fix(lsp): replace panics with errors (#4209)
  feat: Improve Error Handling for Cargo in Bootstrap Script (#4211)
  fix: prevent declarations of blackbox functions outside of the stdlib (#4177)
  feat: disable unused variable checks on low-level and oracle functions (#4179)
  chore: Rename acir_docs.md to README.md (#4208)
  feat: remove replacement of boolean range opcodes with `AssertZero` opcodes (#4107)
  chore(docs): updating docs to match new recursion interfacee (#4187)
  feat!: Sync commits from `aztec-packages` (#4144)
github-merge-queue bot pushed a commit that referenced this pull request Feb 1, 2024
# Description

## Problem\*

Followup to #4187 for resolving
#4139

## Summary\*

We no longer need to distinguish between `generateIntermediateProof` and
`generateFinalProof`. This will go into effect once
AztecProtocol/aztec-packages#4221 is merged and
released.

## Additional Context

## Documentation\*

Check one:
- [ ] No documentation needed.
- [ ] Documentation included in this PR.
- [ ] **[Exceptional Case]** Documentation to be submitted in a separate
PR.

# PR Checklist\*

- [ ] I have tested the changes locally.
- [ ] I have formatted the changes with [Prettier](https://prettier.io/)
and/or `cargo fmt` on default settings.

---------

Co-authored-by: José Pedro Sousa <outgoing@zpedro.dev>
Co-authored-by: Cat McGee <helloworld@mcgee.cat>
TomAFrench added a commit that referenced this pull request Feb 2, 2024
* master: (22 commits)
  feat: remove predicate from `sort` intrinsic function (#4228)
  chore: add test for missing lambda closure environment (#2120) (#4212)
  chore(docs): Updates following `is_recursive` flag removal (#4199)
  fix: from field with constant values (#4226)
  feat: Option expect method (#4219)
  feat: Evaluation of dynamic assert messages (#4101)
  chore(docs): XOR typo in docs (#4223)
  fix: apply range constraints to return values from unconstrained functions (#4217)
  fix(lsp): replace panics with errors (#4209)
  feat: Improve Error Handling for Cargo in Bootstrap Script (#4211)
  fix: prevent declarations of blackbox functions outside of the stdlib (#4177)
  feat: disable unused variable checks on low-level and oracle functions (#4179)
  chore: Rename acir_docs.md to README.md (#4208)
  feat: remove replacement of boolean range opcodes with `AssertZero` opcodes (#4107)
  chore(docs): updating docs to match new recursion interfacee (#4187)
  feat!: Sync commits from `aztec-packages` (#4144)
  feat: multiply first to allow more ACIR gen optimizations (#4201)
  feat: Move bounded_vec into the noir stdlib (#4197)
  chore: simplify marking black box function outputs as solvable (#4194)
  chore(doc): Add docs for `assert_max_bit_size` (#4196)
  ...
@Savio-Sou
Copy link
Collaborator

There #[recursive] attribute doesn't seem to be mentioned on the updated page.

@signorecello @vezenovm was that intentional?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Fix verify_proof in Noir Docs Document updated verify_proof
6 participants