From 15b45128a1ec0e2a3f40a3e3ffbdd8972d21e337 Mon Sep 17 00:00:00 2001 From: Rahul Kothari Date: Tue, 24 Sep 2024 10:22:04 +0000 Subject: [PATCH] fix migration notes --- docs/docs/migration_notes.md | 37 ++++++++++++++++++------------------ 1 file changed, 19 insertions(+), 18 deletions(-) diff --git a/docs/docs/migration_notes.md b/docs/docs/migration_notes.md index be2603f0c132..3a691c9b33c5 100644 --- a/docs/docs/migration_notes.md +++ b/docs/docs/migration_notes.md @@ -6,25 +6,8 @@ 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.56.0 -### Key rotation removed - -The ability to rotate incoming, outgoing, nullifying and tagging keys has been removed - this feature was easy to misuse and not worth the complexity and gate count cost. As part of this, the Key Registry contract has also been deleted. The API for fetching public keys has been adjusted accordingly: - -```diff -- let keys = get_current_public_keys(&mut context, account); -+ let keys = get_public_keys(account); -``` - -### [Aztec.nr] Rework `NoteGetterOptions::select` - -The `select` function in both `NoteGetterOptions` and `NoteViewerOptions` no longer takes an `Option` of a comparator, but instead requires an explicit comparator to be passed. Additionally, the order of the parameters has been changed so that they are `(lhs, operator, rhs)`. These two changes should make invocations of the function easier to read: - -```diff -- options.select(ValueNote::properties().value, amount, Option::none()) -+ options.select(ValueNote::properties().value, Comparator.EQ, amount) -``` ### [Aztec.nr] Changes to contract definition @@ -107,6 +90,24 @@ The `Contract::storage()` static method has been renamed to `Contract::storage_l + let user_balances_slot = derive_storage_slot_in_map(Token::storage_layout().balances.slot, user); ``` +### Key rotation removed + +The ability to rotate incoming, outgoing, nullifying and tagging keys has been removed - this feature was easy to misuse and not worth the complexity and gate count cost. As part of this, the Key Registry contract has also been deleted. The API for fetching public keys has been adjusted accordingly: + +```diff +- let keys = get_current_public_keys(&mut context, account); ++ let keys = get_public_keys(account); +``` + +### [Aztec.nr] Rework `NoteGetterOptions::select` + +The `select` function in both `NoteGetterOptions` and `NoteViewerOptions` no longer takes an `Option` of a comparator, but instead requires an explicit comparator to be passed. Additionally, the order of the parameters has been changed so that they are `(lhs, operator, rhs)`. These two changes should make invocations of the function easier to read: + +```diff +- options.select(ValueNote::properties().value, amount, Option::none()) ++ options.select(ValueNote::properties().value, Comparator.EQ, amount) +``` + ## 0.53.0 ### [Aztec.nr] Remove `OwnedNote` and create `UintNote`