Skip to content

chore(docs): cut v4.3.0 docs version (mainnet)#23375

Merged
critesjosh merged 22 commits into
nextfrom
release-docs/v4.3.0-rc.1-pr
May 20, 2026
Merged

chore(docs): cut v4.3.0 docs version (mainnet)#23375
critesjosh merged 22 commits into
nextfrom
release-docs/v4.3.0-rc.1-pr

Conversation

@critesjosh
Copy link
Copy Markdown
Contributor

Summary

Cuts the v4.3.0-rc.1 versioned docs snapshot for mainnet (pre-release prep — the live mainnet RPC at https://aztec-mainnet.drpc.org currently reports v4.2.1; this is the docs cut for the upcoming v4.3.0-rc.1 release).

What changed

Versioned snapshots cut at the v4.3.0-rc.1 tag:

  • docs/developer_versioned_docs/version-v4.3.0-rc.1/ — full developer docs snapshot
  • docs/network_versioned_docs/version-v4.3.0-rc.1/ — full network/operator docs snapshot
  • Both developer_version_config.json and network_version_config.json map mainnet (and testnet for developer) to v4.3.0-rc.1
  • Old version-v4.2.0/ directories removed under both instances

Generated artifacts (against v4.3.0-rc.1 tag source):

  • docs/static/aztec-nr-api/mainnet/ (2,500 HTML files) — regenerated with aztec-nargo 1.0.0-beta.21 at the tag's noir submodule commit
  • docs/static/typescript-api/mainnet/ (9 markdown files for accounts, aztec.js, constants, entrypoints, foundation, pxe, stdlib, wallet-sdk, wallets + llm summary)
  • docs/docs-developers/docs/cli/aztec_cli_reference.md, aztec_wallet_cli_reference.md, aztec_up_cli_reference.md — regenerated from installed aztec CLI v4.3.0-rc.1
  • docs/docs-operate/operators/reference/node-api-reference.md — regenerated from yarn-project/stdlib/src/interfaces/

Networks page (unversioned root):

  • Replaced tag's outdated Ignition-era docs/docs/networks.md with next's Alpha-era content
  • Bumped the version cell for both mainnet and testnet columns to 4.3.0-rc.1
  • Mainnet L1 contract addresses verified against the live RPC response (Rollup 0xae2001f7e21d5ecabf6234e9fdd1e76f50f74962, etc.)

Wallet SDK docs (backport):

  • Added PR #22806's wallet-sdk integration guides into the v4.3.0-rc.1 snapshot at developer_versioned_docs/version-v4.3.0-rc.1/docs/aztec-js/wallet-sdk/ (4 files: index.md, dapp_integration.md, wallet_integration.md, _category_.json)
  • Source-code links pinned to the v4.3.0-rc.1 tag (verified all referenced paths exist at the tag)

Migration notes:

  • The ## 4.3.0-rc.1 section at the tag already covered all breaking changes from the GitHub release body (17 subsections including counter-template scaffolding, history module nullifier oracle return-type change, DeployMethod refactor, etc.). No content changes were needed beyond the snapshot

Other snapshot fixups:

  • developer_versioned_docs/version-v4.3.0-rc.1/docs/foundational-topics/accounts/keys.mdaddress_derivation.png.svg (png never existed at the tag)
  • developer_versioned_docs/version-v4.3.0-rc.1/docs/aztec-nr/framework-description/contract_structure.mdaztec-nr-api/mainnet/noir_aztec/macros/aztec/fn.aztecmacros/fn.aztec

Skill updates (.claude/skills/release-docs/SKILL.md):

  • Document that release work runs on the tag, not next, with backport step
  • Note that docs/docs/ root pages (e.g. networks.md) are unversioned and behave as "post-release-live" rather than snapshot-of-tag
  • Document the yarn build ordering caveat (must run after the version cut, not before)
  • Note the rc-in-version-string case: pass RELEASE_TYPE=mainnet explicitly so API doc generation scripts don't fall back to testnet

Test plan

  • MAINNET_TAG=v4.3.0-rc.1 TESTNET_TAG=v4.3.0-rc.1 RELEASE_TYPE=mainnet COMMIT_TAG=v4.3.0-rc.1 yarn build succeeds with 0 broken API-ref links and 0 version mismatches
  • Codex review: configs, networks.md mainnet addresses, snapshot content vs tag source, ported wallet-sdk file integrity all PASS
  • yarn start — visually inspect the version dropdown and the new wallet-sdk pages
  • Confirm the mainnet version label/path in the deployed Netlify preview

Notes

  • Pre-release: the live mainnet RPC still reports v4.2.1 — once v4.3.0-rc.1 is deployed, no further docs work is needed beyond merging this
  • The TypeScript-API tuple-rendering quirk noted by codex (generateClaimSecret() => Promise<[]> vs Promise<[Fr, Fr]>) is a TypeDoc limitation, not specific to this release

- Reconcile developer/network version configs to v4.3.0-rc.1 (mainnet + testnet)
- Delete orphan version-v4.2.0 directories
- Bring docs/networks.md inline with next's Alpha-era content, bump versions to 4.3.0-rc.1
- Restore broken image and api-ref links in versioned snapshot
  (address_derivation.png -> .svg; macros/aztec/fn.aztec -> macros/fn.aztec)
- Add wallet-sdk integration guides from PR #22806 under
  developer_versioned_docs/version-v4.3.0-rc.1/docs/aztec-js/wallet-sdk/,
  with version refs updated to v4.3.0-rc.1
Runtime artifact from forge that was untracked in the working tree at the
tag and got swept in by git add -A. Not relevant to the release-docs work.
v4.2.md operator changelog wasn't on the tag (added on next after the cut)
but is still a useful reference for operators upgrading. Copy it from
next's source and add it to the snapshot's changelog sidebar.
- Rename version-v4.3.0-rc.1 → version-v4.3.0 (developer + network snapshots,
  sidebar files, version config + array files).
- Substitute v4.3.0-rc.1 → v4.3.0 across all snapshot content (851 files):
  versioned docs, autogenerated API refs, wallet-sdk source-link pins,
  networks.md version cells.
- Migration notes: move three entries out of the v4.3.0 section into
  4.2.0-aztecnr-rc.2 (codex review found they document changes that already
  shipped at v4.2.1, not new in v4.3): GasSettings.default→fallback, removal
  of scopes: 'ALL_SCOPES', PXE capsule scope enforcement.
@critesjosh critesjosh changed the title chore(docs): cut v4.3.0-rc.1 docs version (mainnet) chore(docs): cut v4.3.0 docs version (mainnet) May 18, 2026
@critesjosh critesjosh marked this pull request as ready for review May 18, 2026 16:33
Covers operator-facing changes in v4.3.0:
- Bundled binaries renamed under aztec- prefix on PATH (#22902, #22709)
- --pxe flag removed from aztec start (#22867)
- aztec-up pins manifest Node version (#23201)
- aztec-up pins FOUNDRY_DIR (#22886)

Added to both source docs-operate/ and the v4.3.0 versioned snapshot,
and linked from the operator changelog sidebar in both places.
Codex review caught two issues:
- The earlier sidebar edits (both sidebars-operate.js and the snapshot sidebar
  JSON) had failed silently, so the v4.3 entry was missing from both sidebars.
  Add 'operators/reference/changelog/v4.3' at the top of both.
- Node-version-pin wording was too strong; aztec-up only installs the manifest
  Node version when no satisfying version is already on the host.
…only

Per upstream release-notes author's review: the three other items I had
included (--pxe flag removal, aztec-up Node version pin, FOUNDRY_DIR pin)
were intentionally left out of the v4.3.0-rc.1 release notes as too minor.
Keep only the binary rename under aztec- prefix, which was the one item the
release notes underdocumented.
…--help

The operator cli-reference.md is hand-maintained (the auto-generation
scripts under scripts/cli_reference_generation/ only target the three
developer-facing CLI refs). The doc had silently drifted from the actual
'aztec start --help' output between v4.2.x and v4.3.0:

- Bare --pxe flag removed (#22867) -- file still documented it
- New --local-network.testAccounts flag added -- file didn't document it
- ~460 lines of help-text drift across other flags/descriptions

Regenerated source + v4.3.0 snapshot from the v4.3.0-rc.1 CLI's actual
--help output. A follow-up PR should wire this regeneration into
scripts/cli_reference_generation/ so the operator CLI ref stays in sync
the same way the developer CLI refs do.
Copy link
Copy Markdown
Contributor

@ciaranightingale ciaranightingale left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

claude says:

Critical issues

Dropped ## 4.2.0 and ## 4.1.3 headings in version-v4.3.0/docs/resources/migration_notes.md. The v4.2.0 snapshot on origin/next has ## 4.2.0, ##
4.2.0-aztecnr-rc.2, ## 4.1.3, ## 4.1.0-rc.2 … The new v4.3.0 snapshot has ## 4.3.0, ## 4.2.0-aztecnr-rc.2, ## 4.1.0-rc.2 … — the ## 4.2.0 and ##
4.1.3 headers are gone. The content didn't get deleted; it got absorbed into the next-older surviving heading:

  • v4.2.0's GasSettings.fallback() entry is now sitting under ## 4.2.0-aztecnr-rc.2 at version-v4.3.0/.../migration_notes.md (it appears immediately
    after the ## 4.2.0-aztecnr-rc.2 heading at line 351).
  • v4.1.3's TxReceipt epochNumber entry is at line 721 of the v4.3.0 snapshot, still inside the ## 4.2.0-aztecnr-rc.2 block (the next heading isn't
    until 758).

This violates the docs/CLAUDE.md rule "never modify already-published migration entries" — readers on v4.3.0 will see v4.1.3 changes mislabelled as
v4.2.0-aztecnr-rc.2. Restore the two missing headings inside the v4.3.0 snapshot before merging.

…ion notes

External reviewer flagged that v4.3.0/migration_notes.md was missing two
section headings (## 4.2.0 and ## 4.1.3) that exist in the v4.2.0 snapshot
on origin/next, causing 8 entries to appear mislabeled under the older
## 4.2.0-aztecnr-rc.2 heading. The headings never made it into the
v4.3.0-rc.1 tag (added on next afterward), so they were also absent from
this PR's snapshot.

Restored both headings and redistributed entries to match the v4.2.0
snapshot's authoritative grouping:

- ## 4.2.0 (4 entries): GasSettings.default→fallback, ALL_SCOPES removed,
  PXE capsule scope-enforced, EmbeddedWalletOptions unified pxe field.
- ## 4.2.0-aztecnr-rc.2 (15 entries): unchanged otherwise.
- ## 4.1.3 (4 entries): TxReceipt.epochNumber, computeL2ToL1MembershipWitness
  signature, getPublicEvents object, get_random_bytes removed.
…0 section

Codex review flagged that the v4.2.0 snapshot on origin/next has a fifth
entry under ## 4.2.0 ('[Aztec.nr] Ephemeral arrays replace capsule arrays
in PXE oracle interfaces') that wasn't in our v4.3.0 snapshot. Confirmed
the change is present in v4.3.0-rc.1 source:

- noir-projects/aztec-nr/aztec/src/ephemeral/mod.nr exists at the tag
- enqueue_note_for_validation in v4.3.0-rc.1 source has no trailing 'scope'
  parameter (matches the migration note's + line)
- validate_and_store_enqueued_notes_and_events takes only 'scope', no
  'contract_address' (matches the migration note's + line)
- attempt_note_discovery has no 'recipient' parameter (matches the - line)

So this is a real v4.2.0 breaking change that v4.3.0 readers upgrading from
older versions need to know about. Backporting the migration note from the
v4.2.0 snapshot into v4.3.0's ## 4.2.0 section.
Eight GitHub source-code URLs in the cut v4.3.0 versioned docs pointed at
`master`/`next` instead of the release tag. Pin those in the cut snapshot
and switch the corresponding source files in docs-developers/ to the
#include_aztec_version macro so future cuts pick up the tag automatically.
…or items

Backfills v4.3.0 docs with items from the official release notes that
weren't carried into the migration notes, framework docs, tutorials, or
operator changelog:

- migration_notes: add '[CLI] aztec init now scaffolds a Counter example
  template' under v4.3.0 (#22751). aztec new continues to scaffold blank.
- contract_structure: rewrite Directory structure for the 2-crate
  workspace; drop the stale --name reference removed in v4.3.0.
- token_contract tutorial: fix 'aztec init created...' wording to
  'aztec new' (the command shown is aztec new bob_token); update live
  copy from single-crate to 2-crate layout.
- recursive_verification tutorial: replace removed 'aztec new --name X Y'
  with 'aztec new ValueNotEqual'; fix the workspace layout, package name
  (ValueNotEqual_contract), ccc script, and artifact paths.
- v4.3 operator changelog: add 'Other notable changes' for the three
  non-breaking release-notes items (sequencer last-block signing #22117,
  stdlib package.json stamping #23393, macOS aztec-up install fixes
  #23310 / #23335).
…gin marketplace snippet

- getting_started_on_testnet (v4.3.0 snapshot): the install command and
  warning line were frozen at 4.1.0-rc.2 from the prior snapshot. Testnet
  is now running v4.3.0; update both. The live source uses
  #include_testnet_version, which already resolves to v4.3.0 via
  developer_version_config.json.
- ai_tooling (v4.3.0 snapshot): remove the '/plugin marketplace add
  critesjosh/aztec-claude-plugin' + '/plugin install aztec@aztec-plugins'
  block. Reword the lead-in so the remaining 'claude mcp add' commands
  stand on their own.
aztec new <NAME> scaffolds <NAME>_test/src/lib.nr with `use <NAME>_contract::Main`,
matched to the scaffold's placeholder `pub contract Main`. Both the
recursive_verification and token_contract tutorials immediately tell the
user to replace main.nr with a renamed contract (ValueNotEqual / BobToken),
which leaves the test crate referencing a contract that no longer exists.

`aztec compile` still emits the contract artifact (the contract crate
compiles independently) so the tutorials worked end-to-end, but the
compile output included a noisy `Aborting due to 6 previous errors`
block right before `Compilation complete!` that the tutorials didn't
explain.

Add a short admonition right after the main.nr replacement step in each
tutorial telling the user to stub the test crate's lib.nr. Linked to the
Testing Contracts guide for users who want to write real tests. Applied
to both the v4.3.0 versioned snapshot and the docs-developers mirror.
The "final pair of log lines" sample said Alice ends at 100 public / 130
private and Bob's Clinic at 20 public / 50 private. Running the tutorial
flow as written gives Alice 10/130 and Bob 10/50, which matches the
step-by-step narration immediately above ("Giggle mints Alice 100 BOB
in public → Alice transfers 10 BOB to Bob in public → Alice makes the
remaining 90 BOB private → ... Of the remaining 40 BOB, she makes 10
public again").

Verified against a live `aztec start --local-network` with
@aztec/aztec.js@4.3.0 — produced Alice 10/130, Bob 10/50.

Applied to both the v4.3.0 versioned snapshot and the docs-developers
mirror.
@critesjosh critesjosh added this pull request to the merge queue May 20, 2026
@critesjosh critesjosh removed this pull request from the merge queue due to a manual request May 20, 2026
…shot

These changes landed on next between Feb and May but never reached the v4
release branch, so the snapshot cut from the v4.3.0 tag missed them.

- debugging.md: switch the two `dep::aztec::oracle::debug_log::*` import
  samples to `aztec::oracle::logging::*` to match the rename described
  in the same snapshot's migration notes (and the actual v4.3.0
  contract source).
- operator changelog index.md: add v4.3.0 and v4.2.0 cards so the
  landing page matches the sidebar and the v4.3.md / v4.2.md files
  that already exist in the snapshot.
- v4.2.md: replace `Migration difficulty: TODO` with `Low`.
- how_to_pay_fees.md: clarify that the Sponsored FPC is available on
  testnet (not just devnet and local). Verified against networks.md
  which lists the SponsoredFPC contract on testnet.
- how_to_create_account.md: update two anchor links to match the
  renamed `### Sponsored FPC` section heading.
- migration_notes.md: update the parallel `fpc-sponsored` wording so
  it stays consistent with how_to_pay_fees.md.

Mainnet build passes: 0 broken redirect targets, 0 broken API-ref
links, 0 spellcheck issues.
@critesjosh critesjosh enabled auto-merge May 20, 2026 15:22
@critesjosh critesjosh added this pull request to the merge queue May 20, 2026
Merged via the queue into next with commit 3f7cbc0 May 20, 2026
21 of 22 checks passed
@critesjosh critesjosh deleted the release-docs/v4.3.0-rc.1-pr branch May 20, 2026 16:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants