docs: improve docs for nullifier read requests, mark pub fn as unsafe #19479
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
nventuro
changed the title
benesjan
approved these changes
Jan 12, 2026
noir-projects/noir-contracts/contracts/protocol/contract_instance_registry/src/main.nr
Outdated
Show resolved
Hide resolved
noir-projects/noir-contracts/contracts/protocol/contract_instance_registry/src/main.nr
Outdated
Show resolved
Hide resolved
noir-projects/noir-contracts/contracts/protocol/contract_instance_registry/src/main.nr
Outdated
Show resolved
Hide resolved
This marks the public read nullifier function as unsafe, and explains what is unsafe about it. It clearly points out our own unsafe usage, which we need to address. I took the opportunity to improve the docs of this and related functions. Co-authored-by: Jan Beneš <janbenes1234@gmail.com> Co-authored-by: Nicolás Venturo <nicolas.venturo@gmail.com>
AztecBot
force-pushed
the
nv/nullifier-read-docs
branch
from
529c67d to
f70d22a
Compare
Collaborator
Flakey Tests🤖 says: This CI run detected 2 tests that failed, but were tolerated due to a .test_patterns.yml entry. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This marks the public read nullifier function as unsafe, and explains what is unsafe about it. It clearly points out our own unsafe usage, which we need to address.
I took the opportunity to improve the docs of this and related functions.