docs: release v5.2.0 developer and node docs - #25266
Merged
Merged
Conversation
alejoamiras
marked this pull request as ready for review
August 19, 2026 11:28
alejoamiras
self-requested a review
August 19, 2026 11:29
alejoamiras
approved these changes
Aug 19, 2026
## Summary Publishes `v5.2.0` as the shared release for both **Alpha (Mainnet)** and **Testnet** across developer and network/operator documentation, and removes the deprecated `v5.1.0` snapshots. - both `mainnet` and `testnet` selectors resolve to the same `v5.2.0` snapshot - developer and network/operator snapshots cut from the `v5.2.0` tag (`49a592109ec`), so `#include_code` snippets and version macros freeze against what shipped - Aztec.nr, TypeScript, Aztec.js, `aztec` / `aztec-wallet` / `aztec-up` CLI, operator `aztec start` CLI and Node JSON-RPC references all regenerated at the tag - identical generated API artifacts under the stable `mainnet` and `testnet` paths - `networks.md` re-derived from the node RPCs and on-chain reads A backport of this release into `v5-next` is [#25265](#25265). ## Merged `next` (2026-08-19) `next` moved 64 commits while this was open. Merged and resolved; `yarn build` re-run green on the merged tree. Two conflicts, both around the Aztec.js reference: - `docs/scripts/aztecjs_reference_generation/transform_to_markdown.py` — **took `next`'s version wholesale.** [#25248](#25248) landed a proper `HeadingSlugger` (github-slugger semantics including the `-1`/`-2` uniqueness suffixes) and code-block handling for multi-line types, which supersedes the two narrower fixes this PR originally carried. - `docs/docs-developers/docs/aztec-js/aztec_js_reference.md` — **took `next`'s version.** [#25249](#25249) added `update_docs.sh --check` to `docs/bootstrap.sh`, so the committed source page must match what the generator produces from the working tree. Regenerating on the merged tree reproduces `next`'s page byte-for-byte (modulo the self-stamped timestamp) and `--check` passes. The **v5.2.0 snapshot's** copy of that page was regenerated with `next`'s generator against the `v5.2.0` tag's `aztec.js` source, so the released snapshot gets the improved anchors and code-block formatting while still documenting v5.2.0's API. Also reconciled from `next` into the snapshot: [#25220](#25220 clarification that `teardownGasLimits` is carved out of `gasLimits` rather than added to it. Verified true at the tag (`yarn-project/stdlib/src/gas/gas_settings.ts`: "teardown gas is reserved from gasLimits during private execution ... the effective gas available for app logic is `gasLimits - teardownGasLimits - privateOverhead`"). The other post-tag doc changes on `next` are fast-inbox / AZIP-22 work (`inbox.md`, the `MessageSent` signature and message-availability wording in `token_bridge.md` and `uniswap_swap.md`, and dropping `AZTEC_INBOX_LAG`), which is not in v5.2.0 — deliberately **not** backported, so the snapshot keeps the wording that is correct for the release. ## Release details Verified from the node RPCs at cut time: | | Alpha (Mainnet) | Testnet | | --- | --- | --- | | `nodeVersion` from RPC | `5.1.0` | `5.2.0-nightly.20260815` | | `rollupVersion` | `4248422647` | `1821665230` | | L1 chain id | `1` | `11155111` | Per the instruction that the network versions are unchanged, the **Version** row in `networks.md` stays `5.1.0` for both columns; only the documentation version advances to `v5.2.0`. Every figure in `networks.md` was re-derived rather than carried forward: - all L1 addresses in both columns match `aztec_getNodeInfo` - Slasher, Honk verifier, Reward Booster, Tally Slashing Proposer and Slash Payload Cloneable re-read on chain from the Rollup / Slasher / Proposer for both networks, all unchanged - rollup version read from `getVersion()` on both rollups; chain ids from `cast chain-id` - governance parameters re-read on chain for **both** columns: proposer quorum 600/1000 and 60/100; voting delay, duration and execution delay decoded from `getConfiguration()` (mainnet 3 d / 7 d / 2 d, testnet 12 h / 24 h / 12 h); slashing quorum 65/128 over 4 epochs (128 slots) ### The canonical SponsoredFPC address changes under v5.2.0 tooling, and the new one is not deployed `aztec get-canonical-sponsored-fpc-address` built from the `v5.2.0` tag returns: ``` 0x2ece607a8dba690c9aa4ee1d53a55286fa815543a27f9364bbaf65eb68e7315b (class id 0x1cf37d561fb76ae2b95d3c395c3204c1dab4a6309b045a3fc17a58483c5ad2e9) ``` Testnet has nothing at that address (`aztec_getContract` returns `null`). What is deployed and funded is the v5.1.0-built FPC, `0x130925fb...923296` (class id `0x184e81e5...8673a5`), which is what this PR keeps. The SponsoredFPC Noir source is byte-identical between `v5.1.0` and `v5.2.0` — the address moved purely because the Noir compiler went `beta.22` to `beta.25`, which changes the compiled bytecode, the contract class id, and therefore the derived address. The same thing happened at the v5.1.0 cut, where a new FPC was deployed and funded. The consequence is worth stating plainly: `wallet.registerContract` does not validate that the supplied artifact matches the instance's class (explicit comment in `yarn-project/wallet-sdk/src/base-wallet/base_wallet.ts`), so `aztec-wallet register-contract ... SponsoredFPC` appears to succeed on v5.2.0 tooling and then fails at simulation, because the PXE only holds the `0x1cf37d...` artifact. **Either a v5.2.0-built SponsoredFPC is deployed and funded on testnet at `0x2ece...` and this PR is repointed at it, or sponsored fees on testnet stay pinned to v5.1.0 tooling.** ## Documentation content changes ### Aztec.nr: the v5.2.0 breaking change was live in three doc snippets Note structs declared inside a `contract` block must now be `pub` (Noir `beta.25`, [#24907](#24907)). `state_variables.md` (`AddressNote`, `UintNote`), `functions/attributes.md` (`CustomNote`) and the `#[custom_note]` example in the `notes.nr` doc comment (published through `nargo doc`) all showed non-`pub` declarations that do not compile on v5.2.0. Every `.nr` **source** file the docs pull in via `#include_code` was already `pub`, so the defect was confined to prose snippets. ### Migration notes - The `pub` note-visibility entry was filed under `## 5.1.0`, but the Noir `beta.25` bump that causes it is not in the `v5.1.0` tag. Moved to a new `## 5.2.0` section. - Four v5.2.0 behaviour changes had no migration note at all, each verified against `v5.1.0..v5.2.0`: the zero-peer proposing gate (`SEQ_MIN_PEERS_TO_PROPOSE`), JSON-RPC internal errors moving from `-32600` to `-32603`, `GET /status` gaining a per-component JSON body (and the widened `StatusCheckFn`), and the removal of `deserializeArrayFromVector` from `@aztec/foundation/serialize`. - The `## TBD` entries on this branch are left untouched: they describe changes on this line that have not shipped in a release yet. ### Operator / node docs All eight new v5.2.0 env vars were missing from the CLI reference; regenerating it at the tag picks them up, along with `--proverNode.proofSubmissionTargetAddress`, which existed in v5.1.0 code but was never documented. Hand edits on top: | File | Change | | --- | --- | | `reference/changelog/v5.2.md` | new page; the operator changelog stopped at v4.3.x. Plus index and sidebar entries | | `concepts/monitoring.md` | claimed the node emits no "about to be slashed" metric; it now does, so that section carries the real logs and metrics | | `monitoring/metrics-reference.md` | new own-validator slashing metrics section (with alert rule) and JSON-RPC server metrics section | | `concepts/sequencer-troubleshooting.md` | the four peerless-node gates, plus the `/status` health check and `P2P_HEALTH_MIN_PEERS` | | `reference/reading-logs.md` | five new entries: fatal p2p start failure, zero-peer warning, skipped proposal, mempool drop reasons, slash-target warning | | `sequencer-management/governance-participation.md` | the node now stops signalling an executed payload; `GOVERNANCE_PROPOSER_FORCE_PAYLOAD_VOTE` escape hatch | | `concepts/l1-rpc.md` | server-side filter methods are no longer required; watchers poll bounded `eth_getLogs` | | `provider/start-node.mdx`, `solo-sequencer/start-node.mdx` | sample `nodeVersion` `5.0.0` to `5.2.0` | Reviewed on the deploy preview by @yev. ### Developer docs - `tutorials/js_tutorials/aave_bridge.md` pinned `@aztec/l1-artifacts` to a literal version; it now uses the version macro like every other pin on that page, so it stops going stale each release. - `aztec-js/how_to_send_transaction.md` documents the new first-receipt-poll delay and `initialDelay` ([#25089](#25089)). - `@aztec/viem@2.38.2` is deliberately left alone in the three tutorials that pin it: it tracks upstream `viem`, not the release line. **Known gap, not fixed here:** the declarative deployment framework at `@aztec/aztec/deploy` ([#24685](#24685)), headlined as "New in this release", has **zero** documentation. It wants a new `aztec-js` page; that was scoped but not written, rather than shipping a half-verified page for a new API. ## Non-docs changes Three one-line source edits, all comment-only, no behaviour change: - `archiver/src/config.ts` and `stdlib/src/interfaces/archiver.ts` — `on-chain` to `onchain`, so the regenerated operator CLI reference passes the repo's own spellcheck (`on-chain` is a repo-wide `flagWord`) - `noir-projects/labs/aztec-nr/aztec/src/macros/notes.nr` — the `pub` fix in the `#[custom_note]` doc comment The equivalent `aztec.js` JSDoc fixes this PR originally carried are gone: `next` made the same corrections upstream, so the merge left nothing to change. ## Validation `MAINNET_TAG=5.2.0 TESTNET_TAG=5.2.0 RELEASE_TYPE=mainnet COMMIT_TAG=v5.2.0 yarn build`, re-run on the merged tree: - CSpell: 682 files, **0 issues** - Redirect targets: 185 checked, all valid - API reference links: 112 checked, **0 broken, 0 version mismatches** - Docusaurus production build: **successful** - `./scripts/aztecjs_reference_generation/update_docs.sh --check`: **✓ Reference matches aztec.js** - no unresolved `#release_version` / `#release_network` / `#include_code` macros in either snapshot - version configs and version lists carry one shared `v5.2.0` snapshot for both Alpha and Testnet - generated `mainnet` and `testnet` Aztec.nr and TypeScript API directories are byte-identical - empty `## TBD` heading stripped from the cut snapshot's migration notes Remaining broken-anchor warnings are the pre-existing ones only (the `validator-keys|valkeys` CLI alias and the operator compose-page anchors); `onBrokenAnchors` is `warn`, so the build passes. **Not run:** the functional validation pass (walking the guides and tutorials against a live local network). This container has no Docker daemon, so the dockerized `aztec` CLI could not be installed; everything above was produced from a source build of the tag with shims for `aztec` / `aztec-wallet` / `aztec-up`. The guides and tutorials in this snapshot are link- and spell-validated but not executed. --- *Created by [claudebox](https://claudebox.work/v2/sessions/c8d26e6f93543878/jobs/12) · group: `slackbot` · requested by Alejo Amiras · [Slack thread](https://aztecfoundation.slack.com/archives/C0B24G1GFGB/p1787064177273599?thread_ts=1787064177.273599&cid=C0B24G1GFGB)*
AztecBot
force-pushed
the
cb/release-docs-v5.2.0-next
branch
from
August 19, 2026 12:25
6f996bc to
f9a3cba
Compare
AztecBot
enabled auto-merge
August 19, 2026 12:25
AztecBot
added a commit
that referenced
this pull request
Aug 19, 2026
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.
Summary
Publishes
v5.2.0as the shared release for both Alpha (Mainnet) and Testnet across developer and network/operator documentation, and removes the deprecatedv5.1.0snapshots.mainnetandtestnetselectors resolve to the samev5.2.0snapshotv5.2.0tag (49a592109ec), so#include_codesnippets and version macros freeze against what shippedaztec/aztec-wallet/aztec-upCLI, operatoraztec startCLI and Node JSON-RPC references all regenerated at the tagmainnetandtestnetpathsnetworks.mdre-derived from the node RPCs and on-chain readsA backport of this release into
v5-nextis #25265.Merged
next(2026-08-19)nextmoved 64 commits while this was open. Merged and resolved;yarn buildre-run green on the merged tree. Two conflicts, both around the Aztec.js reference:docs/scripts/aztecjs_reference_generation/transform_to_markdown.py— tooknext's version wholesale. #25248 landed a properHeadingSlugger(github-slugger semantics including the-1/-2uniqueness suffixes) and code-block handling for multi-line types, which supersedes the two narrower fixes this PR originally carried.docs/docs-developers/docs/aztec-js/aztec_js_reference.md— tooknext's version. #25249 addedupdate_docs.sh --checktodocs/bootstrap.sh, so the committed source page must match what the generator produces from the working tree. Regenerating on the merged tree reproducesnext's page byte-for-byte (modulo the self-stamped timestamp) and--checkpasses.The v5.2.0 snapshot's copy of that page was regenerated with
next's generator against thev5.2.0tag'saztec.jssource, so the released snapshot gets the improved anchors and code-block formatting while still documenting v5.2.0's API.Also reconciled from
nextinto the snapshot: #25220's clarification thatteardownGasLimitsis carved out ofgasLimitsrather than added to it. Verified true at the tag (yarn-project/stdlib/src/gas/gas_settings.ts: "teardown gas is reserved from gasLimits during private execution ... the effective gas available for app logic isgasLimits - teardownGasLimits - privateOverhead"). The other post-tag doc changes onnextare fast-inbox / AZIP-22 work (inbox.md, theMessageSentsignature and message-availability wording intoken_bridge.mdanduniswap_swap.md, and droppingAZTEC_INBOX_LAG), which is not in v5.2.0 — deliberately not backported, so the snapshot keeps the wording that is correct for the release.Release details
Verified from the node RPCs at cut time:
nodeVersionfrom RPC5.1.05.2.0-nightly.20260815rollupVersion42484226471821665230111155111Per the instruction that the network versions are unchanged, the Version row in
networks.mdstays5.1.0for both columns; only the documentation version advances tov5.2.0.Every figure in
networks.mdwas re-derived rather than carried forward:aztec_getNodeInfogetVersion()on both rollups; chain ids fromcast chain-idgetConfiguration()(mainnet 3 d / 7 d / 2 d, testnet 12 h / 24 h / 12 h); slashing quorum 65/128 over 4 epochs (128 slots)The canonical SponsoredFPC address changes under v5.2.0 tooling, and the new one is not deployed
aztec get-canonical-sponsored-fpc-addressbuilt from thev5.2.0tag returns:Testnet has nothing at that address (
aztec_getContractreturnsnull). What is deployed and funded is the v5.1.0-built FPC,0x130925fb...923296(class id0x184e81e5...8673a5), which is what this PR keeps.The SponsoredFPC Noir source is byte-identical between
v5.1.0andv5.2.0— the address moved purely because the Noir compiler wentbeta.22tobeta.25, which changes the compiled bytecode, the contract class id, and therefore the derived address. The same thing happened at the v5.1.0 cut, where a new FPC was deployed and funded.The consequence is worth stating plainly:
wallet.registerContractdoes not validate that the supplied artifact matches the instance's class (explicit comment inyarn-project/wallet-sdk/src/base-wallet/base_wallet.ts), soaztec-wallet register-contract ... SponsoredFPCappears to succeed on v5.2.0 tooling and then fails at simulation, because the PXE only holds the0x1cf37d...artifact. Either a v5.2.0-built SponsoredFPC is deployed and funded on testnet at0x2ece...and this PR is repointed at it, or sponsored fees on testnet stay pinned to v5.1.0 tooling.Documentation content changes
Aztec.nr: the v5.2.0 breaking change was live in three doc snippets
Note structs declared inside a
contractblock must now bepub(Noirbeta.25, #24907).state_variables.md(AddressNote,UintNote),functions/attributes.md(CustomNote) and the#[custom_note]example in thenotes.nrdoc comment (published throughnargo doc) all showed non-pubdeclarations that do not compile on v5.2.0. Every.nrsource file the docs pull in via#include_codewas alreadypub, so the defect was confined to prose snippets.Migration notes
pubnote-visibility entry was filed under## 5.1.0, but the Noirbeta.25bump that causes it is not in thev5.1.0tag. Moved to a new## 5.2.0section.v5.1.0..v5.2.0: the zero-peer proposing gate (SEQ_MIN_PEERS_TO_PROPOSE), JSON-RPC internal errors moving from-32600to-32603,GET /statusgaining a per-component JSON body (and the widenedStatusCheckFn), and the removal ofdeserializeArrayFromVectorfrom@aztec/foundation/serialize.## TBDentries on this branch are left untouched: they describe changes on this line that have not shipped in a release yet.Operator / node docs
All eight new v5.2.0 env vars were missing from the CLI reference; regenerating it at the tag picks them up, along with
--proverNode.proofSubmissionTargetAddress, which existed in v5.1.0 code but was never documented. Hand edits on top:reference/changelog/v5.2.mdconcepts/monitoring.mdmonitoring/metrics-reference.mdconcepts/sequencer-troubleshooting.md/statushealth check andP2P_HEALTH_MIN_PEERSreference/reading-logs.mdsequencer-management/governance-participation.mdGOVERNANCE_PROPOSER_FORCE_PAYLOAD_VOTEescape hatchconcepts/l1-rpc.mdeth_getLogsprovider/start-node.mdx,solo-sequencer/start-node.mdxnodeVersion5.0.0to5.2.0Reviewed on the deploy preview by @yev.
Developer docs
tutorials/js_tutorials/aave_bridge.mdpinned@aztec/l1-artifactsto a literal version; it now uses the version macro like every other pin on that page, so it stops going stale each release.aztec-js/how_to_send_transaction.mddocuments the new first-receipt-poll delay andinitialDelay(#25089).@aztec/viem@2.38.2is deliberately left alone in the three tutorials that pin it: it tracks upstreamviem, not the release line.Known gap, not fixed here: the declarative deployment framework at
@aztec/aztec/deploy(#24685), headlined as "New in this release", has zero documentation. It wants a newaztec-jspage; that was scoped but not written, rather than shipping a half-verified page for a new API.Non-docs changes
Three one-line source edits, all comment-only, no behaviour change:
archiver/src/config.tsandstdlib/src/interfaces/archiver.ts—on-chaintoonchain, so the regenerated operator CLI reference passes the repo's own spellcheck (on-chainis a repo-wideflagWord)noir-projects/labs/aztec-nr/aztec/src/macros/notes.nr— thepubfix in the#[custom_note]doc commentThe equivalent
aztec.jsJSDoc fixes this PR originally carried are gone:nextmade the same corrections upstream, so the merge left nothing to change.Validation
MAINNET_TAG=5.2.0 TESTNET_TAG=5.2.0 RELEASE_TYPE=mainnet COMMIT_TAG=v5.2.0 yarn build, re-run on the merged tree:./scripts/aztecjs_reference_generation/update_docs.sh --check: ✓ Reference matches aztec.js#release_version/#release_network/#include_codemacros in either snapshotv5.2.0snapshot for both Alpha and TestnetmainnetandtestnetAztec.nr and TypeScript API directories are byte-identical## TBDheading stripped from the cut snapshot's migration notesRemaining broken-anchor warnings are the pre-existing ones only (the
validator-keys|valkeysCLI alias and the operator compose-page anchors);onBrokenAnchorsiswarn, so the build passes.Not run: the functional validation pass (walking the guides and tutorials against a live local network). This container has no Docker daemon, so the dockerized
aztecCLI could not be installed; everything above was produced from a source build of the tag with shims foraztec/aztec-wallet/aztec-up. The guides and tutorials in this snapshot are link- and spell-validated but not executed.Created by claudebox · group:
slackbot· requested by Alejo Amiras · Slack thread