Skip to content

docs: backfill v4.2.0 migration notes (backport #22612)#22616

Open
AztecBot wants to merge 2 commits into
backport-to-v4-next-stagingfrom
claudebox/backport-22612-v4-next
Open

docs: backfill v4.2.0 migration notes (backport #22612)#22616
AztecBot wants to merge 2 commits into
backport-to-v4-next-stagingfrom
claudebox/backport-22612-v4-next

Conversation

@AztecBot

Copy link
Copy Markdown
Collaborator

Summary

Backport of #22612 to v4-next.

The upstream PR moves four v4.2.0 breaking-change migration notes from ## Unreleased (v5) into a ## 4.2.0 section of the live docs and adds them to developer_versioned_docs/version-v4.2.0/. Neither target exists on v4-next yet — v4.2.0 has not been cut, and the v4.2.0 versioned snapshot does not exist. The established convention on v4-next (see 42ecd02a34) is to accumulate new breaking-change notes under ## TBD until the release is cut.

Three of the four notes (GasSettings.default→fallback, simulateTx scopes, capsule scope enforcement) are already present in ## TBD on v4-next. Only the EphemeralArray note was missing; it has been added to the end of ## TBD in the live developer migration notes.

No changes to any developer_versioned_docs/version-* snapshot — published versioned docs are locked per docs/CLAUDE.md.

Full analysis: https://gist.github.com/AztecBot/1ccd427c97cfa82285cee44fb2935937

Commit structure

  1. Cherry-pick of the merge commit with conflict markers preserved (for reviewer visibility).
  2. Conflict resolution: keep HEAD for both conflicted files; add only the missing [Aztec.nr] Ephemeral arrays replace capsule arrays in PXE oracle interfaces entry to ## TBD in docs-developers/docs/resources/migration_notes.md.

Test plan

  • Docs build passes (yarn build under docs/)
  • Spellcheck passes (yarn spellcheck under docs/)
  • New entry renders correctly under ## TBD in the live developer migration notes

ClaudeBox log: https://claudebox.work/s/8123d27b3c4276e4?run=1

critesjosh and others added 2 commits April 16, 2026 18:57
## Summary

Move four breaking-change migration notes from the unreleased area into
the `## 4.2.0` section of the live developer docs, and add them to the
v4.2.0 versioned snapshot:

- `GasSettings.default()` renamed to `GasSettings.fallback()` (plus
removal of `DEFAULT_GAS_LIMIT` / `DEFAULT_TEARDOWN_GAS_LIMIT`)
- `simulateTx` / `executeUtility` / `profileTx` / `proveTx` no longer
accept `scopes: 'ALL_SCOPES'`
- PXE now scope-enforces capsule operations
- `EphemeralArray` replaces `CapsuleArray` in PXE oracle interfaces

These notes were written after the v4.2.0 cut but document breaking
changes that shipped in 4.2.0, so they belong in the 4.2.0 section of
both the live and versioned docs.

## Test plan

- [ ] Migration notes render correctly on the docs site
- [ ] v4.2.0 versioned docs show the backfilled entries under `## 4.2.0`
- [ ] Live developer docs no longer list these entries as unreleased

# Conflicts:
#	docs/developer_versioned_docs/version-v4.1.0-rc.2/docs/resources/migration_notes.md
#	docs/docs-developers/docs/resources/migration_notes.md
Keep HEAD content for both migration notes files:
- version-v4.1.0-rc.2 snapshot is a locked published doc, do not modify
- v4.2.0 versioned snapshot does not exist on v4-next yet

Add only the missing EphemeralArray migration note to the ## TBD section
of the live developer migration notes. The other three notes the PR moves
(GasSettings.default, simulateTx scopes, capsule scope enforcement) are
already present in ## TBD on v4-next (see commit 42ecd02).
@AztecBot AztecBot added ci-draft Run CI on draft PRs. claudebox Owned by claudebox. it can push to this PR. labels Apr 16, 2026
@critesjosh critesjosh marked this pull request as ready for review April 16, 2026 19:04
@critesjosh critesjosh enabled auto-merge April 16, 2026 19:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ci-draft Run CI on draft PRs. claudebox Owned by claudebox. it can push to this PR.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants