From f5005af3e423d7e35775712002dbae6a5b845f34 Mon Sep 17 00:00:00 2001 From: benesjan Date: Mon, 26 Feb 2024 11:12:56 +0000 Subject: [PATCH] migration notes --- docs/docs/misc/migration_notes.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/docs/docs/misc/migration_notes.md b/docs/docs/misc/migration_notes.md index fe4c9a3d31f2..8b959a6981c2 100644 --- a/docs/docs/misc/migration_notes.md +++ b/docs/docs/misc/migration_notes.md @@ -14,6 +14,20 @@ Historically developers have been required to include a `compute_note_hash_and_n It is possible to provide a user-defined implementation, in which case auto-generation will be skipped (though there are no known use cases for this). +### Updated naming of state variable wrappers +We have decided to change the naming of our state variable wrappers because the naming was not clear. +The changes are as follows: +2. `Singleton` -> `PrivateMutable` +1. `ImmutableSingleton` -> `PrivateImmutable` +3. `StablePublicState` -> `SharedImmutable` +4. `SlowUpdates` -> `SharedMutable` +4. `PublicState` -> `PublicMutable` + +This is the meaning of "private", "public" and "shared": +Private: read (R) and write (W) from private, not accessible from public +Public: not accessible from private, R/W from public +Shared: R from private, R/W from public + ## 0.24.0 ### Introduce Note Type IDs