Skip to content

chore: make rahul happy with migration notes #13255

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
LHerskind merged 2 commits into from
Apr 3, 2025
Merged

chore: make rahul happy with migration notes #13255

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ebdee45
chore: make rahul happy with migration notes
LHerskind Apr 3, 2025
b6f46a3
chore: number go up
LHerskind Apr 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 14 additions & 2 deletions docs/docs/migration_notes.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ keywords: [sandbox, aztec, notes, migration, updating, upgrading]

Aztec is in full-speed development. Literally every version breaks compatibility with the previous ones. This page attempts to target errors and difficulties you might encounter when upgrading, and how to resolve them.

## TBD
## 0.83.0

### [aztec.js] AztecNode.getPrivateEvents API change

Expand All @@ -17,6 +17,19 @@ The `getPrivateEvents` method signature has changed to require an address of a c
+ const events = await wallet.getPrivateEvents<Transfer>(token.address, TokenContract.events.Transfer, 1, 1, [recipient.getAddress()]);
```

### [portal contracts] Versions and Non-following message boxes

The version number is no longer hard-coded to be `1` across all deployments (it not depends on where it is deployed to and with what genesis and logic).
This means that if your portal were hard-coding `1` it will now fail when inserting into the `inbox` or consuming from the `outbox` because of a version mismatch.
Instead you can get the real version (which don't change for a deployment) by reading the `VERSION` on inbox and outbox, or using `getVersion()` on the rollup.

New Deployments of the protocol do not preserve former state/across each other.
This means that after a new deployment, any "portal" following the registry would try to send messages into this empty rollup to non-existant contracts.
To solve, the portal should be linked to a specific deployment, e.g., a specific inbox.
This can be done by storing the inbox/outbox/version at the time of deployment or initialize and not update them.

Both of these issues were in the token portal and the uniswap portal, so if you used them as a template it is very likely that you will also have it.

## 0.82.0

### [aztec.js] AztecNode.findLeavesIndexes returns indexes with block metadata
Expand Down Expand Up @@ -123,7 +136,6 @@ const witness = await wallet.createAuthWit({ caller, action });

PXE is no longer be able to execute contract functions concurrently (e.g. by collecting calls to `simulateTx` and then using `await Promise.all`). They will instead be put in a job queue and executed sequentially in order of arrival.


## 0.79.0

### [aztec.js] Changes to `BatchCall` and `BaseContractInteraction`
Expand Down