refactor: Add iter_from() method in CyclicBoundedVec (#686)

* refactor: Add `iter_from()` method in `CyclicBoundedVec` `ConcurrentMerkleTree` uses `CyclicBoundedVec` for storing changelog entries. And it often needs to iterate over changelogs which are full and started overwriting elements from the start. Even though `CyclicBoundedVec` was doing good job in preserving the bounds, before this change, it didn't provide any safe way of iterating over elements with a custom index as a start. That unfortunately resulted in attempts to solve that problem in the code of `ConcurrentMerkleTree`, which eventually resulted in bugs. The bugs were harder to spot, because mixing the logic of Merkle proof patching with leaked internals of `CyclicBoundedVec` made it confusing to read, debug and test. To avoid such issues, introduce the `iter_from()` method which allows iteration from the given index and simplify the `ConcurrentMerkleTree` to just use that iterator. Other changes: * Stop returning `Result` in `push()`. `push()` can never panic, unless we have a bug in the implementation. Our tests should make sure that the structure is bulletproof. * fix: Point `getAccountState.sh` to new test crate location * chore: Regenerate accounts * test: Add more cases for `CyclicBoundedVec` * chore: Update IDL
Lightprotocol · May 9, 2024 · e6dbd11 · e6dbd11
1 parent 175fc0c
commit e6dbd11
Show file tree

Hide file tree

Showing 10 changed files with 474 additions and 153 deletions.
diff --git a/cli/accounts/address_merkle_tree_C83cpRN6oaafjNgMQJvaYgAz592EP5wunKvbokeTKPLn.json b/cli/accounts/address_merkle_tree_C83cpRN6oaafjNgMQJvaYgAz592EP5wunKvbokeTKPLn.json
diff --git a/cli/accounts/merkle_tree_pubkey_5bdFnXU47QjzGpzHfXnxcEi5WXyxzEAZzd1vrE39bf1W.json b/cli/accounts/merkle_tree_pubkey_5bdFnXU47QjzGpzHfXnxcEi5WXyxzEAZzd1vrE39bf1W.json
diff --git a/js/stateless.js/src/idls/account_compression.ts b/js/stateless.js/src/idls/account_compression.ts
@@ -785,7 +785,7 @@ export type AccountCompression = {
                     {
                         name: 'merkleTreeStruct';
                         type: {
-                            array: ['u8', 296];
+                            array: ['u8', 320];
                         };
                     },
                     {
@@ -893,7 +893,7 @@ export type AccountCompression = {
                         name: 'stateMerkleTreeStruct';
                         docs: ['Merkle tree for the transaction state.'];
                         type: {
-                            array: ['u8', 256];
+                            array: ['u8', 272];
                         };
                     },
                     {
@@ -1975,7 +1975,7 @@ export const IDL: AccountCompression = {
                     {
                         name: 'merkleTreeStruct',
                         type: {
-                            array: ['u8', 296],
+                            array: ['u8', 320],
                         },
                     },
                     {
@@ -2083,7 +2083,7 @@ export const IDL: AccountCompression = {
                         name: 'stateMerkleTreeStruct',
                         docs: ['Merkle tree for the transaction state.'],
                         type: {
-                            array: ['u8', 256],
+                            array: ['u8', 272],
                         },
                     },
                     {