feat(docs): autogenerate node JSON-RPC API reference#22543
Merged
Conversation
…source Adds a generation script that parses the AztecNode and AztecNodeAdmin interfaces to produce the API reference doc, ensuring it stays in sync with the actual RPC surface. Fixes missing endpoints (getCheckpointedBlockNumber, getCheckpointsDataForEpoch, etc.) and removes stale methods.
…de API reference generation
AztecBot
added a commit
that referenced
this pull request
Apr 15, 2026
…node API reference - Added node JSON-RPC API reference generator from PR #22543 (scripts/node_api_reference_generation/) - Generated node API reference for v4.2.0 (64 methods: 56 node + 8 admin) - Cut network versioned docs snapshot for v4.2.0 - Updated network_version_config.json: mainnet → v4.2.0, testnet stays v4.1.3 - network_versions.json: ["v4.2.0", "v4.1.3"]
…eference # Conflicts: # .claude/skills/release-network-docs/SKILL.md # docs/docs-operate/operators/reference/node-api-reference.md # docs/network_versioned_docs/version-v4.1.3/operators/reference/node-api-reference.md
…arity and accuracy
ciaranightingale
approved these changes
May 5, 2026
ciaranightingale
left a comment
ciaranightingale
left a comment
Contributor
There was a problem hiding this comment.
again, don't really have context to know and properly review but lgtm as far as I can tell (plus claude)
koenmtb1
approved these changes
May 7, 2026
Collaborator
|
❌ Failed to cherry-pick to |
critesjosh
added a commit
that referenced
this pull request
May 8, 2026
…updates The original cherry-pick of 6fd76de carried only the first commit of PR #22543's five-commit feature branch, leaving the script using the pre-22543 build-required check and missing the SKILL.md/CLAUDE.md/README.md documentation that landed alongside. Bring this backport in line with PR #22543's final merged state: - Replace the .sh `stdlib/dest/` build check with source-file + node_modules checks (no yarn-project build needed). - Apply the .ts generator improvements: optional handling order, array parenthesization, BlockHash in BlockParameterSchema, JSDoc index fix, name-aware example params, remarks rendering, fallback warnings. - Add Step 5a (Regenerate Node API Reference) to release-network-docs SKILL.md plus the matching Key Points entry. - Document `yarn generate:node-api-reference` in docs/CLAUDE.md and add the Node JSON-RPC API Reference section to docs/README.md. - Regenerate docs-operate/.../node-api-reference.md against this branch's yarn-project interfaces (64 methods, 55 node + 9 admin). METHOD_GROUPS adjustments for this branch's API surface: re-add getSlashPayloads to the admin group (still present in aztec-node-admin.ts here) and drop getPredictedMinFees from the fees group (not yet present here). The version-v2.1.11-ignition snapshot is left untouched — its content reflects that release's API and would be corrupted by regenerating against HEAD.
critesjosh
added a commit
that referenced
this pull request
May 8, 2026
…22543) (#23046) Backport of #22543 to `backport-to-v4-next-staging`. Cherry-pick of the squash-merge commit (`6fd76de513`) applied cleanly via `git cherry-pick` (the automatic backport workflow's `gh pr diff | git apply --reject` had failed; switching to a real cherry-pick resolved it without manual conflict edits). ## Files - `docs/docs-operate/operators/reference/node-api-reference.md` — regenerated reference - `docs/network_versioned_docs/version-v2.1.11-ignition/operators/reference/node-api-reference.md` — regenerated versioned snapshot - `docs/scripts/node_api_reference_generation/generate_node_api_reference.{sh,ts}` — new generation script - `docs/package.json` — wires up the generator ## Verification - `git cherry-pick 6fd76de` succeeded with auto-merge; working tree clean afterwards. - Reference paths (`docs/docs-operate/...`, `docs/network_versioned_docs/version-v2.1.11-ignition/...`) exist on the staging branch, so the generated files land in valid locations. Original PR description: see #22543. ClaudeBox log: https://claudebox.work/s/6b4f81c28ae8a770?run=1
AztecBot
added a commit
that referenced
this pull request
May 9, 2026
BEGIN_COMMIT_OVERRIDE fix(aztec-up): Aztec installer does not shadow user installed binaries on PATH (#22902) fix: include sqlite binary in its npm package (#23039) chore: backport #23041 (add sendMessagesAs to wallet api schemas) to v4-next (#23081) chore: backport DeployMethod refactor (#22985) to v4-next (#23029) refactor(pxe): deduplicate tx hash lookups in MessageContextService (#23075) refactor(pxe): batch tagged private log queries across all secrets (#23048) refactor(pxe): batch log RPC calls in LogService.fetchLogsByTag (#23088) feat(aztec-nr): Initial handshake registry contract with non interactive handshake function (#22854) fix: add Tag.random() helper required by backported #23088 tests (#23094) chore: backport: fix(aztec-up): installer does not shadow user binaries on PATH (#22902) (#23060) chore: backport handshake registry contract (#22854) to v4-next (#23063) feat: deploy method refactor 2 (#23033) refactor(pxe): skip redundant getBlock RPC when querying at anchor block (#23100) port(v4-next): feat(docs): autogenerate node JSON-RPC API reference (#22543) (#23046) chore: backport feat: deploy method refactor 2 (#23033) to v4-next (#23103) port(v4-next): feat(ci): Snapshots for aztec-nr contract compilation failures and nargo expand (#23061) (#23104) feat(txe): allow authorizing cross-contract utility calls in nr tests (#23064) END_COMMIT_OVERRIDE
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
4 participants
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.
Summary
docs/scripts/node_api_reference_generation/) that parses theAztecNodeandAztecNodeAdminTypeScript interfaces and Zod schemas to produce the node API reference docnode-api-reference.mdwith an autogenerated versionWhat this fixes
The manual doc had drifted significantly from the actual API:
node_getCheckpointedBlockNumber,node_getCheckpointsDataForEpoch,node_getCheckpointNumber, and others that external integrators needHow it works
The generator uses the TypeScript Compiler API to parse source files (no runtime imports needed):
@param,@returns,@deprecated) from interface declarationsRun with:
yarn generate:node-api-referenceMethod count comparison (v4.1.3)
Test plan
yarn buildpasses in docs directory🤖 Generated with Claude Code