@aztec/merkle-tree 0.0.0-test.1 → 0.0.1-commit.03f7ef2

package/src/snapshots/snapshot_builder_test_suite.ts

@@ -1,4 +1,5 @@
-import { randomBigInt } from '@aztec/foundation/crypto';
+import { BlockNumber } from '@aztec/foundation/branded-types';
+import { randomBigInt } from '@aztec/foundation/crypto/random';
 import type { Bufferable } from '@aztec/foundation/serialize';
 
 import { jest } from '@jest/globals';
@@ -29,14 +30,14 @@ export function describeSnapshotBuilderTestSuite<
       it('takes snapshots', async () => {
         await modifyTree(tree);
         await tree.commit();
-        await expect(snapshotBuilder.snapshot(1)).resolves.toBeDefined();
+        await expect(snapshotBuilder.snapshot(BlockNumber(1))).resolves.toBeDefined();
       });
 
       it('is idempotent', async () => {
         await modifyTree(tree);
         await tree.commit();
 
-        const block = 1;
+        const block = BlockNumber(1);
         const snapshot = await snapshotBuilder.snapshot(block);
         const newSnapshot = await snapshotBuilder.snapshot(block);
 
@@ -46,7 +47,7 @@ export function describeSnapshotBuilderTestSuite<
       it('returns the same path if tree has not diverged', async () => {
         await modifyTree(tree);
         await tree.commit();
-        const snapshot = await snapshotBuilder.snapshot(1);
+        const snapshot = await snapshotBuilder.snapshot(BlockNumber(1));
 
         const historicPaths = await Promise.all(leaves.map(leaf => snapshot.getSiblingPath(leaf)));
         const expectedPaths = await Promise.all(leaves.map(leaf => tree.getSiblingPath(leaf, false)));
@@ -59,7 +60,7 @@ export function describeSnapshotBuilderTestSuite<
       it('returns historic paths if tree has diverged and no new snapshots have been taken', async () => {
         await modifyTree(tree);
         await tree.commit();
-        const snapshot = await snapshotBuilder.snapshot(1);
+        const snapshot = await snapshotBuilder.snapshot(BlockNumber(1));
 
         const expectedPaths = await Promise.all(leaves.map(leaf => tree.getSiblingPath(leaf, false)));
 
@@ -79,12 +80,12 @@ export function describeSnapshotBuilderTestSuite<
 
         const expectedPaths = await Promise.all(leaves.map(leaf => tree.getSiblingPath(leaf, false)));
 
-        const snapshot = await snapshotBuilder.snapshot(1);
+        const snapshot = await snapshotBuilder.snapshot(BlockNumber(1));
 
         await modifyTree(tree);
         await tree.commit();
 
-        await snapshotBuilder.snapshot(2);
+        await snapshotBuilder.snapshot(BlockNumber(2));
 
         // check that snapshot 2 has not influenced snapshot(1) at all
         const historicPaths = await Promise.all(leaves.map(leaf => snapshot.getSiblingPath(leaf)));
@@ -100,12 +101,12 @@ export function describeSnapshotBuilderTestSuite<
 
         const expectedPaths = await Promise.all(leaves.map(leaf => tree.getSiblingPath(leaf, false)));
 
-        const snapshot = await snapshotBuilder.snapshot(1);
+        const snapshot = await snapshotBuilder.snapshot(BlockNumber(1));
 
         await modifyTree(tree);
         await tree.commit();
 
-        await snapshotBuilder.snapshot(2);
+        await snapshotBuilder.snapshot(BlockNumber(2));
 
         await modifyTree(tree);
         await tree.commit();
@@ -125,15 +126,15 @@ export function describeSnapshotBuilderTestSuite<
         await modifyTree(tree);
         await tree.commit();
         const expectedPaths = await Promise.all(leaves.map(leaf => tree.getSiblingPath(leaf, false)));
-        await snapshotBuilder.snapshot(1);
+        await snapshotBuilder.snapshot(BlockNumber(1));
 
         for (let i = 2; i < 5; i++) {
           await modifyTree(tree);
           await tree.commit();
-          await snapshotBuilder.snapshot(i);
+          await snapshotBuilder.snapshot(BlockNumber(i));
         }
 
-        const firstSnapshot = await snapshotBuilder.getSnapshot(1);
+        const firstSnapshot = await snapshotBuilder.getSnapshot(BlockNumber(1));
         const historicPaths = await Promise.all(leaves.map(leaf => firstSnapshot.getSiblingPath(leaf)));
 
         for (const [index, path] of historicPaths.entries()) {
@@ -144,9 +145,9 @@ export function describeSnapshotBuilderTestSuite<
       it('throws if an unknown snapshot is requested', async () => {
         await modifyTree(tree);
         await tree.commit();
-        await snapshotBuilder.snapshot(1);
+        await snapshotBuilder.snapshot(BlockNumber(1));
 
-        await expect(snapshotBuilder.getSnapshot(2)).rejects.toThrow();
+        await expect(snapshotBuilder.getSnapshot(BlockNumber(2))).rejects.toThrow();
       });
     });
 
@@ -154,7 +155,7 @@ export function describeSnapshotBuilderTestSuite<
       it('returns the historical root of the tree when the snapshot was taken', async () => {
         await modifyTree(tree);
         await tree.commit();
-        const snapshot = await snapshotBuilder.snapshot(1);
+        const snapshot = await snapshotBuilder.snapshot(BlockNumber(1));
         const historicalRoot = tree.getRoot(false);
 
         await modifyTree(tree);
@@ -169,7 +170,7 @@ export function describeSnapshotBuilderTestSuite<
       it('returns the same depth as the tree', async () => {
         await modifyTree(tree);
         await tree.commit();
-        const snapshot = await snapshotBuilder.snapshot(1);
+        const snapshot = await snapshotBuilder.snapshot(BlockNumber(1));
         expect(snapshot.getDepth()).toEqual(tree.getDepth());
       });
     });
@@ -178,7 +179,7 @@ export function describeSnapshotBuilderTestSuite<
       it('returns the historical leaves count when the snapshot was taken', async () => {
         await modifyTree(tree);
         await tree.commit();
-        const snapshot = await snapshotBuilder.snapshot(1);
+        const snapshot = await snapshotBuilder.snapshot(BlockNumber(1));
         const historicalNumLeaves = tree.getNumLeaves(false);
 
         await modifyTree(tree);
@@ -192,7 +193,7 @@ export function describeSnapshotBuilderTestSuite<
       it('returns the historical leaf value when the snapshot was taken', async () => {
         await modifyTree(tree);
         await tree.commit();
-        const snapshot = await snapshotBuilder.snapshot(1);
+        const snapshot = await snapshotBuilder.snapshot(BlockNumber(1));
         const historicalLeafValue = tree.getLeafValue(0n, false);
         expect(snapshot.getLeafValue(0n)).toEqual(historicalLeafValue);
 
@@ -207,7 +208,7 @@ export function describeSnapshotBuilderTestSuite<
       it('returns the historical leaf index when the snapshot was taken', async () => {
         await modifyTree(tree);
         await tree.commit();
-        const snapshot = await snapshotBuilder.snapshot(1);
+        const snapshot = await snapshotBuilder.snapshot(BlockNumber(1));
 
         const initialLastLeafIndex = tree.getNumLeaves(false) - 1n;
         let lastLeaf = tree.getLeafValue(initialLastLeafIndex, false);

package/src/sparse_tree/sparse_tree.ts

@@ -1,3 +1,4 @@
+import type { BlockNumber } from '@aztec/foundation/branded-types';
 import { type Bufferable, serializeToBuffer } from '@aztec/foundation/serialize';
 
 import type { UpdateOnlyTree } from '../interfaces/update_only_tree.js';
@@ -38,11 +39,11 @@ export class SparseTree<T extends Bufferable> extends TreeBase<T> implements Upd
     return Promise.resolve();
   }
 
-  public snapshot(block: number): Promise<TreeSnapshot<T>> {
+  public snapshot(block: BlockNumber): Promise<TreeSnapshot<T>> {
     return this.#snapshotBuilder.snapshot(block);
   }
 
-  public getSnapshot(block: number): Promise<TreeSnapshot<T>> {
+  public getSnapshot(block: BlockNumber): Promise<TreeSnapshot<T>> {
     return this.#snapshotBuilder.getSnapshot(block);
   }
 

package/src/standard_indexed_tree/standard_indexed_tree.ts

@@ -1,4 +1,5 @@
 import { toBufferBE } from '@aztec/foundation/bigint-buffer';
+import type { BlockNumber } from '@aztec/foundation/branded-types';
 import type { FromBuffer } from '@aztec/foundation/serialize';
 import { Timer } from '@aztec/foundation/timer';
 import { SiblingPath } from '@aztec/foundation/trees';
@@ -60,7 +61,7 @@ export const noopDeserializer: FromBuffer<Buffer> = {
  * Standard implementation of an indexed tree.
  */
 export class StandardIndexedTree extends TreeBase<Buffer> implements IndexedTree {
-  #snapshotBuilder = new IndexedTreeSnapshotBuilder(this.store, this, this.leafPreimageFactory);
+  #snapshotBuilder: IndexedTreeSnapshotBuilder;
 
   protected cachedLeafPreimages: { [key: string]: IndexedTreeLeafPreimage } = {};
   protected leaves: AztecMap<ReturnType<typeof buildDbKeyForPreimage>, Buffer>;
@@ -79,6 +80,7 @@ export class StandardIndexedTree extends TreeBase<Buffer> implements IndexedTree
     super(store, hasher, name, depth, size, noopDeserializer, root);
     this.leaves = store.openMap(`tree_${name}_leaves`);
     this.leafIndex = store.openMap(`tree_${name}_leaf_index`);
+    this.#snapshotBuilder = new IndexedTreeSnapshotBuilder(this.store, this, this.leafPreimageFactory);
   }
 
   /**
@@ -87,7 +89,7 @@ export class StandardIndexedTree extends TreeBase<Buffer> implements IndexedTree
    * @returns Empty promise.
    * @remarks Use batchInsert method instead.
    */
-  override appendLeaves(_leaves: Buffer[]): Promise<void> {
+  override appendLeaves(_leaves: Buffer[]): void {
     throw new Error('Not implemented');
   }
 
@@ -217,7 +219,7 @@ export class StandardIndexedTree extends TreeBase<Buffer> implements IndexedTree
   public getLatestLeafPreimageCopy(index: bigint, includeUncommitted: boolean): IndexedTreeLeafPreimage | undefined {
     const preimage = !includeUncommitted
       ? this.getDbPreimage(index)
-      : this.getCachedPreimage(index) ?? this.getDbPreimage(index);
+      : (this.getCachedPreimage(index) ?? this.getDbPreimage(index));
     return preimage && this.leafPreimageFactory.clone(preimage);
   }
 
@@ -318,7 +320,6 @@ export class StandardIndexedTree extends TreeBase<Buffer> implements IndexedTree
     }
   }
 
-  /* eslint-disable jsdoc/require-description-complete-sentence */
   /* The following doc block messes up with complete-sentence, so we just disable it */
 
   /**
@@ -595,11 +596,11 @@ export class StandardIndexedTree extends TreeBase<Buffer> implements IndexedTree
     return fullSiblingPath.getSubtreeSiblingPath(subtreeHeight);
   }
 
-  snapshot(blockNumber: number): Promise<IndexedTreeSnapshot> {
+  snapshot(blockNumber: BlockNumber): Promise<IndexedTreeSnapshot> {
     return this.#snapshotBuilder.snapshot(blockNumber);
   }
 
-  getSnapshot(blockNumber: number): Promise<IndexedTreeSnapshot> {
+  getSnapshot(blockNumber: BlockNumber): Promise<IndexedTreeSnapshot> {
     return this.#snapshotBuilder.getSnapshot(blockNumber);
   }
 

package/src/standard_indexed_tree/test/standard_indexed_tree_with_append.ts

@@ -12,12 +12,10 @@ export class StandardIndexedTreeWithAppend extends StandardIndexedTree {
    * @returns Empty promise.
    * @remarks This method is inefficient and is here mostly for testing. Use batchInsert instead.
    */
-  public override appendLeaves(leaves: Buffer[]): Promise<void> {
+  public override appendLeaves(leaves: Buffer[]) {
     for (const leaf of leaves) {
       this.appendLeaf(leaf);
     }
-
-    return Promise.resolve();
   }
 
   private appendEmptyLeaf() {

package/src/standard_tree/standard_tree.ts

@@ -1,3 +1,4 @@
+import type { BlockNumber } from '@aztec/foundation/branded-types';
 import { type Bufferable, serializeToBuffer } from '@aztec/foundation/serialize';
 import { Timer } from '@aztec/foundation/timer';
 import type { TreeInsertionStats } from '@aztec/stdlib/stats';
@@ -18,7 +19,7 @@ export class StandardTree<T extends Bufferable = Buffer> extends TreeBase<T> imp
    * @param leaves - The leaves to append.
    * @returns Empty promise.
    */
-  public override appendLeaves(leaves: T[]): Promise<void> {
+  public override appendLeaves(leaves: T[]): void {
     this.hasher.reset();
     const timer = new Timer();
     super.appendLeaves(leaves);
@@ -31,15 +32,13 @@ export class StandardTree<T extends Bufferable = Buffer> extends TreeBase<T> imp
       treeType: 'append-only',
       ...this.hasher.stats(),
     } satisfies TreeInsertionStats);
-
-    return Promise.resolve();
   }
 
-  public snapshot(blockNumber: number): Promise<TreeSnapshot<T>> {
+  public snapshot(blockNumber: BlockNumber): Promise<TreeSnapshot<T>> {
     return this.#snapshotBuilder.snapshot(blockNumber);
   }
 
-  public getSnapshot(blockNumber: number): Promise<TreeSnapshot<T>> {
+  public getSnapshot(blockNumber: BlockNumber): Promise<TreeSnapshot<T>> {
     return this.#snapshotBuilder.getSnapshot(blockNumber);
   }
 

package/src/tree_base.ts

@@ -92,7 +92,7 @@ export abstract class TreeBase<T extends Bufferable> implements MerkleTree<T> {
    * @returns The root of the tree.
    */
   public getRoot(includeUncommitted: boolean): Buffer {
-    return !includeUncommitted ? this.root : this.cache[indexToKeyHash(this.name, 0, 0n)] ?? this.root;
+    return !includeUncommitted ? this.root : (this.cache[indexToKeyHash(this.name, 0, 0n)] ?? this.root);
   }
 
   /**
@@ -101,7 +101,7 @@ export abstract class TreeBase<T extends Bufferable> implements MerkleTree<T> {
    * @returns The number of leaves in the tree.
    */
   public getNumLeaves(includeUncommitted: boolean) {
-    return !includeUncommitted ? this.size : this.cachedSize ?? this.size;
+    return !includeUncommitted ? this.size : (this.cachedSize ?? this.size);
   }
 
   /**

package/dest/sha_256.d.ts

@@ -1,22 +0,0 @@
-/// <reference types="node" resolution-mode="require"/>
-/// <reference types="node" resolution-mode="require"/>
-import type { Hasher } from '@aztec/foundation/trees';
-/**
- * A helper class encapsulating SHA256 hash functionality.
- * @deprecated Don't call SHA256 directly in production code. Instead, create suitably-named functions for specific
- * purposes.
- */
-export declare class SHA256 implements Hasher {
-    hash(lhs: Uint8Array, rhs: Uint8Array): Buffer;
-    hashInputs(inputs: Buffer[]): Buffer;
-}
-/**
- * A helper class encapsulating truncated SHA256 hash functionality.
- * @deprecated Don't call SHA256 directly in production code. Instead, create suitably-named functions for specific
- * purposes.
- */
-export declare class SHA256Trunc implements Hasher {
-    hash(lhs: Uint8Array, rhs: Uint8Array): Buffer;
-    hashInputs(inputs: Buffer[]): Buffer;
-}
-//# sourceMappingURL=sha_256.d.ts.map

package/dest/sha_256.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"sha_256.d.ts","sourceRoot":"","sources":["../src/sha_256.ts"],"names":[],"mappings":";;AAEA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,yBAAyB,CAAC;AAEtD;;;;GAIG;AACH,qBAAa,MAAO,YAAW,MAAM;IAK5B,IAAI,CAAC,GAAG,EAAE,UAAU,EAAE,GAAG,EAAE,UAAU,GAAG,MAAM;IAQ9C,UAAU,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM;CAG5C;AAED;;;;GAIG;AACH,qBAAa,WAAY,YAAW,MAAM;IAKjC,IAAI,CAAC,GAAG,EAAE,UAAU,EAAE,GAAG,EAAE,UAAU,GAAG,MAAM;IAQ9C,UAAU,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM;CAG5C"}

package/dest/sha_256.js

@@ -1,44 +0,0 @@
-import { sha256 } from '@aztec/foundation/crypto';
-import { truncateAndPad } from '@aztec/foundation/serialize';
-/**
- * A helper class encapsulating SHA256 hash functionality.
- * @deprecated Don't call SHA256 directly in production code. Instead, create suitably-named functions for specific
- * purposes.
- */ export class SHA256 {
-    /*
-   * @deprecated Don't call SHA256 directly in production code. Instead, create suitably-named functions for specific
-   * purposes.
-   */ hash(lhs, rhs) {
-        return sha256(Buffer.concat([
-            Buffer.from(lhs),
-            Buffer.from(rhs)
-        ]));
-    }
-    /*
-   * @deprecated Don't call SHA256 directly in production code. Instead, create suitably-named functions for specific
-   * purposes.
-   */ hashInputs(inputs) {
-        return sha256(Buffer.concat(inputs));
-    }
-}
-/**
- * A helper class encapsulating truncated SHA256 hash functionality.
- * @deprecated Don't call SHA256 directly in production code. Instead, create suitably-named functions for specific
- * purposes.
- */ export class SHA256Trunc {
-    /*
-   * @deprecated Don't call SHA256 directly in production code. Instead, create suitably-named functions for specific
-   * purposes.
-   */ hash(lhs, rhs) {
-        return truncateAndPad(sha256(Buffer.concat([
-            Buffer.from(lhs),
-            Buffer.from(rhs)
-        ])));
-    }
-    /*
-   * @deprecated Don't call SHA256 directly in production code. Instead, create suitably-named functions for specific
-   * purposes.
-   */ hashInputs(inputs) {
-        return truncateAndPad(sha256(Buffer.concat(inputs)));
-    }
-}

package/src/sha_256.ts

@@ -1,49 +0,0 @@
-import { sha256 } from '@aztec/foundation/crypto';
-import { truncateAndPad } from '@aztec/foundation/serialize';
-import type { Hasher } from '@aztec/foundation/trees';
-
-/**
- * A helper class encapsulating SHA256 hash functionality.
- * @deprecated Don't call SHA256 directly in production code. Instead, create suitably-named functions for specific
- * purposes.
- */
-export class SHA256 implements Hasher {
-  /*
-   * @deprecated Don't call SHA256 directly in production code. Instead, create suitably-named functions for specific
-   * purposes.
-   */
-  public hash(lhs: Uint8Array, rhs: Uint8Array): Buffer {
-    return sha256(Buffer.concat([Buffer.from(lhs), Buffer.from(rhs)]));
-  }
-
-  /*
-   * @deprecated Don't call SHA256 directly in production code. Instead, create suitably-named functions for specific
-   * purposes.
-   */
-  public hashInputs(inputs: Buffer[]): Buffer {
-    return sha256(Buffer.concat(inputs));
-  }
-}
-
-/**
- * A helper class encapsulating truncated SHA256 hash functionality.
- * @deprecated Don't call SHA256 directly in production code. Instead, create suitably-named functions for specific
- * purposes.
- */
-export class SHA256Trunc implements Hasher {
-  /*
-   * @deprecated Don't call SHA256 directly in production code. Instead, create suitably-named functions for specific
-   * purposes.
-   */
-  public hash(lhs: Uint8Array, rhs: Uint8Array): Buffer {
-    return truncateAndPad(sha256(Buffer.concat([Buffer.from(lhs), Buffer.from(rhs)])));
-  }
-
-  /*
-   * @deprecated Don't call SHA256 directly in production code. Instead, create suitably-named functions for specific
-   * purposes.
-   */
-  public hashInputs(inputs: Buffer[]): Buffer {
-    return truncateAndPad(sha256(Buffer.concat(inputs)));
-  }
-}