Skip to content

docs: fix aztec-nr v4.2.0 documentation issues from audit#22166

Open
critesjosh wants to merge 2 commits intonextfrom
docs/aztec-nr-v4.2.0-doc-audit-fixes
Open

docs: fix aztec-nr v4.2.0 documentation issues from audit#22166
critesjosh wants to merge 2 commits intonextfrom
docs/aztec-nr-v4.2.0-doc-audit-fixes

Conversation

@critesjosh
Copy link
Copy Markdown
Contributor

Summary

  • Fix 52 issues across all aztec-nr doc pages identified during a manual review against nargo 1.0.0-beta.18 and local Aztec network v4.2.0-aztecnr-rc.2
  • Fixes applied to both docs-developers/ (source) and developer_versioned_docs/version-v4.2.0-aztecnr-rc.2/ (versioned copy)
  • Key categories: deprecated import paths, missing API parameters (capsule scope), non-existent methods (simulate_utility, msg_sender().unwrap()), incorrect struct names, out-of-bounds array access in code examples, wrong dependency URLs, stale content removal

Critical fixes (would cause compilation failures if copied from docs)

  • Add missing scope parameter to all capsule API examples
  • Fix CapsuleArray::at() call signature (2 args → 3)
  • Fix out-of-bounds array access in sort_efficient example
  • Update debug_log import path (dep::aztec::oracle::debug_logaztec::oracle::logging)
  • Replace simulate_utility() with execute_utility()
  • Fix NoteMessagePendingDeliveryNoteMessage
  • Correct partial note commitment structure (storage_slot in completion phase, not partial phase)

Other fixes

  • Update all dep:: import prefixes to current unprefixed style
  • Fix dependency URLs from aztec-packages repo to aztec-nr repo
  • Correct ONCHAIN_CONSTRAINED link that pointed to ONCHAIN_UNCONSTRAINED
  • Remove stale TODO comments, placeholder image, delegate_call references
  • Update pedersen → poseidon2, return_values: BoundedVecreturn_hash: Field
  • Fix variable name mismatch (TWO_POW_32TWO_POW_16)
  • Add missing unconstrained keyword to utility function examples
  • Add missing #[derive] attributes on NFTNote in AIP-721

Test plan

  • Verify docs build succeeds (yarn build in docs/)
  • Spot-check code examples against source at v4.2.0-aztecnr-rc.2 tag
  • Review rendered pages for formatting issues

Codespace added 2 commits March 30, 2026 16:45
Fix 52 issues across all aztec-nr doc pages identified during a manual
review against nargo 1.0.0-beta.18 and local Aztec network v4.2.0-aztecnr-rc.2.

Key fixes:
- Update deprecated import paths (dep::aztec:: -> aztec::, protocol_types -> protocol)
- Add missing scope parameter to capsule API examples
- Correct partial note commitment structure (storage_slot moves to completion phase)
- Replace non-existent methods (simulate_utility -> execute_utility, msg_sender().unwrap() -> msg_sender())
- Fix NoteMessagePendingDelivery -> NoteMessage struct name
- Fix out-of-bounds array access in sort_efficient example
- Correct dependency URLs from aztec-packages to aztec-nr repo
- Fix ONCHAIN_CONSTRAINED link target that incorrectly pointed to ONCHAIN_UNCONSTRAINED
- Remove stale TODO comments, placeholder images, and delegate_call references
- Update pedersen -> poseidon2, return_values BoundedVec -> return_hash Field
@critesjosh critesjosh requested a review from a team March 30, 2026 20:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant