docs: fix sub-README inaccuracies and stale comments - #14
Merged
Conversation
This comment has been minimized.
This comment has been minimized.
- Token: fix 'ARC-20' -> AIP-20 naming slip, link the ARC-403 forum draft, replace the dead aztec-arc403-extensions link (404) with the forum thread, and document the five #[only_self] internal ABI functions previously absent from the README - Escrow: document all six derived master keys (mssk_m and fbsk_m were missing from the pipeline diagram) and the six individual derive_master_* functions; fix the 'all four' comment in key_derivation.nr - Vault: replace 'will be addressed in a future update' with the honest status (no fix scheduled) for the to-address privacy leak; fix a test comment referencing a nonexistent constructor_with_asset function - Dripper: state that it is intentionally outside automated test scope - NFT benchmark: drop commented-out dead code whose note did not match the disabled call Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
IlyasRidhuan
force-pushed
the
stack/sub-readme-accuracy
branch
from
August 12, 2026 16:40
43c7ec9 to
29137c4
Compare
IlyasRidhuan
approved these changes
Aug 12, 2026
Benchmark Comparison
Contract: escrow
Contract: logic
Contract: multitoken
Contract: nft
Contract: token
Contract: vault
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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
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.
What
Sub-README and comment accuracy fixes — every "comment that references something that isn't there" found in the audit:
aztec-arc403-extensionslink (404 since the Wonderland wind-down) with the ARC-403 forum thread. Documents the five#[only_self]internal ABI functions that were absent from the README.mssk_m,fbsk_mwere undocumented). Pipeline diagram,derive_keysdoc, and the six individualderive_master_*functions are now documented; fixes the stale "all four" comment inkey_derivation.nr.to-address privacy leak) → honest status: no fix scheduled, with a pointer for signalling demand. Fixes a test comment referencing a nonexistentconstructor_with_assetfunction.Validation
Docs/comments only; the one
.nrchange is a doc-comment. Workspace compiles.🤖 Generated with Claude Code