@aztec/merkle-tree 0.0.0-test.0

package/README.md

@@ -0,0 +1,41 @@
+# Merkle Tree
+
+## Overview
+
+The Merkle Trees package contains typescript implementations of the various Merkle Trees required by the system.
+
+- Append only 'Standard' merkle trees. New values are inserted into the next available leaf index. Values are never updated.
+- Indexed trees are also append only in nature but retain the ability to update leaves. The reason for this is that the Indexed Tree leaves not only store the value but the index of the next highest leaf. New insertions can require prior leaves to be updated.
+- Sparse trees that can be updated at any index. The 'size' of the tree is defined by the number of non-empty leaves, not by the highest populated leaf index as is the case with a Standard Tree.
+
+## Implementations
+
+All implementations require the following arguments:
+
+- An instance of level db for storing information at a tree node level as well as some tree level metadata.
+- An instance of a Hasher object. Used for hashing the nodes of the Merkle Tree.
+- A name, for namespacing the tree's nodes within the db.
+- The depth of the tree, this is exclusive of the root.
+
+Implementations have commit/rollback semantics with modifications stored only in memory until being committed. Rolling back returns the tree discards the cached modifications and returns the tree to it's previous committed state.
+
+## Tree Operations
+
+The primary operations available on the various implementations are:
+
+- Create a new, empty tree
+- Restore a tree from the provided DB
+- Append new leaves (Standard and Indexed trees only)
+- Update a leaf (Sparse tree and Indexed trees only)
+- Retrieve the number of leaves. This is the number of non empty leaves for a Sparse tree and the highest populated index for Standard and Indexed trees.
+- Commit modifications
+- Rollback modifications
+- Retrieve a Sibling Path for a given index. For performing Merkle proofs it is necessary to derive the set of nodes from a leaf index to the root of the tree, known as the 'hash path'. Given a leaf, it is therefore required to have the 'sibling' node at each tree level in order for the hash path to be computed.
+
+Note: Tree operations are not 'thread' safe. Operations should be queued or otherwise executed serially to ensure consistency of the data structures and any data retrieved from them.
+
+## Building/Testing
+
+To build the package, execute `yarn build` in the root.
+
+To run the tests, execute `yarn test`.

package/dest/hasher_with_stats.d.ts

@@ -0,0 +1,22 @@
+/// <reference types="node" resolution-mode="require"/>
+import type { Hasher } from '@aztec/foundation/trees';
+/**
+ * A helper class to track stats for a Hasher
+ */
+export declare class HasherWithStats implements Hasher {
+    hashCount: number;
+    hashInputsCount: number;
+    hashHistogram: import("perf_hooks").RecordableHistogram;
+    hashInputsHistogram: import("perf_hooks").RecordableHistogram;
+    hash: Hasher['hash'];
+    hashInputs: Hasher['hashInputs'];
+    constructor(hasher: Hasher);
+    stats(): {
+        hashCount: number;
+        hashDuration: number;
+        hashInputsCount: number;
+        hashInputsDuration: number;
+    };
+    reset(): void;
+}
+//# sourceMappingURL=hasher_with_stats.d.ts.map

package/dest/hasher_with_stats.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"hasher_with_stats.d.ts","sourceRoot":"","sources":["../src/hasher_with_stats.ts"],"names":[],"mappings":";AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,yBAAyB,CAAC;AAItD;;GAEG;AACH,qBAAa,eAAgB,YAAW,MAAM;IAC5C,SAAS,SAAK;IACd,eAAe,SAAK;IACpB,aAAa,2CAAqB;IAClC,mBAAmB,2CAAqB;IAExC,IAAI,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC;IACrB,UAAU,EAAE,MAAM,CAAC,YAAY,CAAC,CAAC;gBAErB,MAAM,EAAE,MAAM;IAiB1B,KAAK;;;;;;IAUL,KAAK;CAON"}

package/dest/hasher_with_stats.js

@@ -0,0 +1,40 @@
+import { createHistogram, performance } from 'perf_hooks';
+/**
+ * A helper class to track stats for a Hasher
+ */ export class HasherWithStats {
+    hashCount = 0;
+    hashInputsCount = 0;
+    hashHistogram = createHistogram();
+    hashInputsHistogram = createHistogram();
+    hash;
+    hashInputs;
+    constructor(hasher){
+        this.hash = performance.timerify((lhs, rhs)=>{
+            this.hashCount++;
+            return hasher.hash(lhs, rhs);
+        }, {
+            histogram: this.hashHistogram
+        });
+        this.hashInputs = performance.timerify((inputs)=>{
+            this.hashInputsCount++;
+            return hasher.hashInputs(inputs);
+        }, {
+            histogram: this.hashInputsHistogram
+        });
+    }
+    stats() {
+        return {
+            hashCount: this.hashCount,
+            // timerify records in ns, convert to ms
+            hashDuration: this.hashHistogram.mean / 1e6,
+            hashInputsCount: this.hashInputsCount,
+            hashInputsDuration: this.hashInputsHistogram.mean / 1e6
+        };
+    }
+    reset() {
+        this.hashCount = 0;
+        this.hashHistogram.reset();
+        this.hashInputsCount = 0;
+        this.hashInputsHistogram.reset();
+    }
+}

package/dest/index.d.ts

@@ -0,0 +1,20 @@
+export * from './interfaces/append_only_tree.js';
+export * from './interfaces/indexed_tree.js';
+export * from './interfaces/merkle_tree.js';
+export * from './interfaces/update_only_tree.js';
+export * from './pedersen.js';
+export * from './poseidon.js';
+export * from './sha_256.js';
+export * from './sparse_tree/sparse_tree.js';
+export { StandardIndexedTree } from './standard_indexed_tree/standard_indexed_tree.js';
+export { StandardIndexedTreeWithAppend } from './standard_indexed_tree/test/standard_indexed_tree_with_append.js';
+export * from './standard_tree/standard_tree.js';
+export * from './unbalanced_tree.js';
+export { INITIAL_LEAF, getTreeMeta } from './tree_base.js';
+export { newTree } from './new_tree.js';
+export { loadTree } from './load_tree.js';
+export * from './snapshots/snapshot_builder.js';
+export * from './snapshots/full_snapshot.js';
+export * from './snapshots/append_only_snapshot.js';
+export * from './snapshots/indexed_tree_snapshot.js';
+//# sourceMappingURL=index.d.ts.map

package/dest/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,kCAAkC,CAAC;AACjD,cAAc,8BAA8B,CAAC;AAC7C,cAAc,6BAA6B,CAAC;AAC5C,cAAc,kCAAkC,CAAC;AACjD,cAAc,eAAe,CAAC;AAC9B,cAAc,eAAe,CAAC;AAC9B,cAAc,cAAc,CAAC;AAC7B,cAAc,8BAA8B,CAAC;AAC7C,OAAO,EAAE,mBAAmB,EAAE,MAAM,kDAAkD,CAAC;AACvF,OAAO,EAAE,6BAA6B,EAAE,MAAM,mEAAmE,CAAC;AAClH,cAAc,kCAAkC,CAAC;AACjD,cAAc,sBAAsB,CAAC;AACrC,OAAO,EAAE,YAAY,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC3D,OAAO,EAAE,OAAO,EAAE,MAAM,eAAe,CAAC;AACxC,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAC1C,cAAc,iCAAiC,CAAC;AAChD,cAAc,8BAA8B,CAAC;AAC7C,cAAc,qCAAqC,CAAC;AACpD,cAAc,sCAAsC,CAAC"}

package/dest/index.js

@@ -0,0 +1,19 @@
+export * from './interfaces/append_only_tree.js';
+export * from './interfaces/indexed_tree.js';
+export * from './interfaces/merkle_tree.js';
+export * from './interfaces/update_only_tree.js';
+export * from './pedersen.js';
+export * from './poseidon.js';
+export * from './sha_256.js';
+export * from './sparse_tree/sparse_tree.js';
+export { StandardIndexedTree } from './standard_indexed_tree/standard_indexed_tree.js';
+export { StandardIndexedTreeWithAppend } from './standard_indexed_tree/test/standard_indexed_tree_with_append.js';
+export * from './standard_tree/standard_tree.js';
+export * from './unbalanced_tree.js';
+export { INITIAL_LEAF, getTreeMeta } from './tree_base.js';
+export { newTree } from './new_tree.js';
+export { loadTree } from './load_tree.js';
+export * from './snapshots/snapshot_builder.js';
+export * from './snapshots/full_snapshot.js';
+export * from './snapshots/append_only_snapshot.js';
+export * from './snapshots/indexed_tree_snapshot.js';

package/dest/interfaces/append_only_tree.d.ts

@@ -0,0 +1,16 @@
+/// <reference types="node" resolution-mode="require"/>
+/// <reference types="node" resolution-mode="require"/>
+import type { Bufferable } from '@aztec/foundation/serialize';
+import type { TreeSnapshot, TreeSnapshotBuilder } from '../snapshots/snapshot_builder.js';
+import type { MerkleTree } from './merkle_tree.js';
+/**
+ * A Merkle tree that supports only appending leaves and not updating existing leaves.
+ */
+export interface AppendOnlyTree<T extends Bufferable = Buffer> extends MerkleTree<T>, TreeSnapshotBuilder<TreeSnapshot<T>> {
+    /**
+     * Appends a set of leaf values to the tree.
+     * @param leaves - The set of leaves to be appended.
+     */
+    appendLeaves(leaves: T[]): Promise<void>;
+}
+//# sourceMappingURL=append_only_tree.d.ts.map

package/dest/interfaces/append_only_tree.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"append_only_tree.d.ts","sourceRoot":"","sources":["../../src/interfaces/append_only_tree.ts"],"names":[],"mappings":";;AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,6BAA6B,CAAC;AAE9D,OAAO,KAAK,EAAE,YAAY,EAAE,mBAAmB,EAAE,MAAM,kCAAkC,CAAC;AAC1F,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAEnD;;GAEG;AACH,MAAM,WAAW,cAAc,CAAC,CAAC,SAAS,UAAU,GAAG,MAAM,CAC3D,SAAQ,UAAU,CAAC,CAAC,CAAC,EACnB,mBAAmB,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;IACtC;;;OAGG;IACH,YAAY,CAAC,MAAM,EAAE,CAAC,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CAC1C"}

package/dest/interfaces/append_only_tree.js

@@ -0,0 +1,3 @@
+/**
+ * A Merkle tree that supports only appending leaves and not updating existing leaves.
+ */ export { };

package/dest/interfaces/indexed_tree.d.ts

@@ -0,0 +1,69 @@
+/// <reference types="node" resolution-mode="require"/>
+/// <reference types="node" resolution-mode="require"/>
+import type { IndexedTreeLeaf, IndexedTreeLeafPreimage } from '@aztec/foundation/trees';
+import type { BatchInsertionResult } from '@aztec/stdlib/trees';
+import type { IndexedTreeSnapshot, TreeSnapshot, TreeSnapshotBuilder } from '../snapshots/snapshot_builder.js';
+import type { AppendOnlyTree } from './append_only_tree.js';
+import type { MerkleTree } from './merkle_tree.js';
+/**
+ * Factory for creating leaf preimages.
+ */
+export interface PreimageFactory {
+    /**
+     * Creates a new preimage from a leaf.
+     * @param leaf - Leaf to create a preimage from.
+     * @param nextKey - Next key of the leaf.
+     * @param nextIndex - Next index of the leaf.
+     */
+    fromLeaf(leaf: IndexedTreeLeaf, nextKey: bigint, nextIndex: bigint): IndexedTreeLeafPreimage;
+    /**
+     * Creates a new preimage from a buffer.
+     * @param buffer - Buffer to create a preimage from.
+     */
+    fromBuffer(buffer: Buffer): IndexedTreeLeafPreimage;
+    /**
+     * Creates an empty preimage.
+     */
+    empty(): IndexedTreeLeafPreimage;
+    /**
+     * Creates a copy of a preimage.
+     * @param preimage - Preimage to be cloned.
+     */
+    clone(preimage: IndexedTreeLeafPreimage): IndexedTreeLeafPreimage;
+}
+/**
+ * Indexed merkle tree.
+ */
+export interface IndexedTree extends MerkleTree<Buffer>, TreeSnapshotBuilder<IndexedTreeSnapshot>, Omit<AppendOnlyTree<Buffer>, keyof TreeSnapshotBuilder<TreeSnapshot<Buffer>>> {
+    /**
+     * Finds the index of the largest leaf whose value is less than or equal to the provided value.
+     * @param newValue - The new value to be inserted into the tree.
+     * @param includeUncommitted - If true, the uncommitted changes are included in the search.
+     * @returns The found leaf index and a flag indicating if the corresponding leaf's value is equal to `newValue`.
+     */
+    findIndexOfPreviousKey(newValue: bigint, includeUncommitted: boolean): {
+        /**
+         * The index of the found leaf.
+         */
+        index: bigint;
+        /**
+         * A flag indicating if the corresponding leaf's value is equal to `newValue`.
+         */
+        alreadyPresent: boolean;
+    } | undefined;
+    /**
+     * Gets the latest LeafPreimage copy.
+     * @param index - Index of the leaf of which to obtain the LeafPreimage copy.
+     * @param includeUncommitted - If true, the uncommitted changes are included in the search.
+     * @returns A copy of the leaf preimage at the given index or undefined if the leaf was not found.
+     */
+    getLatestLeafPreimageCopy(index: bigint, includeUncommitted: boolean): IndexedTreeLeafPreimage | undefined;
+    /**
+     * Batch insert multiple leaves into the tree.
+     * @param leaves - Leaves to insert into the tree.
+     * @param subtreeHeight - Height of the subtree.
+     * @param includeUncommitted - If true, the uncommitted changes are included in the search.
+     */
+    batchInsert<TreeHeight extends number, SubtreeHeight extends number, SubtreeSiblingPathHeight extends number>(leaves: Buffer[], subtreeHeight: SubtreeHeight, includeUncommitted: boolean): Promise<BatchInsertionResult<TreeHeight, SubtreeSiblingPathHeight>>;
+}
+//# sourceMappingURL=indexed_tree.d.ts.map

package/dest/interfaces/indexed_tree.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"indexed_tree.d.ts","sourceRoot":"","sources":["../../src/interfaces/indexed_tree.ts"],"names":[],"mappings":";;AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,uBAAuB,EAAE,MAAM,yBAAyB,CAAC;AACxF,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,qBAAqB,CAAC;AAEhE,OAAO,KAAK,EAAE,mBAAmB,EAAE,YAAY,EAAE,mBAAmB,EAAE,MAAM,kCAAkC,CAAC;AAC/G,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AAC5D,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAEnD;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;;;;OAKG;IACH,QAAQ,CAAC,IAAI,EAAE,eAAe,EAAE,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,uBAAuB,CAAC;IAC7F;;;OAGG;IACH,UAAU,CAAC,MAAM,EAAE,MAAM,GAAG,uBAAuB,CAAC;IACpD;;OAEG;IACH,KAAK,IAAI,uBAAuB,CAAC;IACjC;;;OAGG;IACH,KAAK,CAAC,QAAQ,EAAE,uBAAuB,GAAG,uBAAuB,CAAC;CACnE;AAED;;GAEG;AACH,MAAM,WAAW,WACf,SAAQ,UAAU,CAAC,MAAM,CAAC,EACxB,mBAAmB,CAAC,mBAAmB,CAAC,EACxC,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,EAAE,MAAM,mBAAmB,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC;IAC/E;;;;;OAKG;IACH,sBAAsB,CACpB,QAAQ,EAAE,MAAM,EAChB,kBAAkB,EAAE,OAAO,GAEzB;QACE;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QACd;;WAEG;QACH,cAAc,EAAE,OAAO,CAAC;KACzB,GACD,SAAS,CAAC;IAEd;;;;;OAKG;IACH,yBAAyB,CAAC,KAAK,EAAE,MAAM,EAAE,kBAAkB,EAAE,OAAO,GAAG,uBAAuB,GAAG,SAAS,CAAC;IAE3G;;;;;OAKG;IACH,WAAW,CAAC,UAAU,SAAS,MAAM,EAAE,aAAa,SAAS,MAAM,EAAE,wBAAwB,SAAS,MAAM,EAC1G,MAAM,EAAE,MAAM,EAAE,EAChB,aAAa,EAAE,aAAa,EAC5B,kBAAkB,EAAE,OAAO,GAC1B,OAAO,CAAC,oBAAoB,CAAC,UAAU,EAAE,wBAAwB,CAAC,CAAC,CAAC;CACxE"}

package/dest/interfaces/indexed_tree.js

@@ -0,0 +1,3 @@
+/**
+ * Indexed merkle tree.
+ */ export { };

package/dest/interfaces/merkle_tree.d.ts

@@ -0,0 +1,64 @@
+/// <reference types="node" resolution-mode="require"/>
+/// <reference types="node" resolution-mode="require"/>
+import type { Bufferable } from '@aztec/foundation/serialize';
+import type { SiblingPath } from '@aztec/foundation/trees';
+/**
+ * Defines the interface for a source of sibling paths.
+ */
+export interface SiblingPathSource {
+    /**
+     * Returns the sibling path for a requested leaf index.
+     * @param index - The index of the leaf for which a sibling path is required.
+     * @param includeUncommitted - Set to true to include uncommitted updates in the sibling path.
+     */
+    getSiblingPath<N extends number>(index: bigint, includeUncommitted: boolean): Promise<SiblingPath<N>>;
+}
+/**
+ * Defines the interface for a Merkle tree.
+ */
+export interface MerkleTree<T extends Bufferable = Buffer> extends SiblingPathSource {
+    /**
+     * Returns the current root of the tree.
+     * @param includeUncommitted - Set to true to include uncommitted updates in the calculated root.
+     */
+    getRoot(includeUncommitted: boolean): Buffer;
+    /**
+     * Returns the number of leaves in the tree.
+     * @param includeUncommitted - Set to true to include uncommitted updates in the returned value.
+     */
+    getNumLeaves(includeUncommitted: boolean): bigint;
+    /**
+     * Commit pending updates to the tree.
+     */
+    commit(): Promise<void>;
+    /**
+     * Returns the depth of the tree.
+     */
+    getDepth(): number;
+    /**
+     * Rollback pending update to the tree.
+     */
+    rollback(): Promise<void>;
+    /**
+     * Returns the value of a leaf at the specified index.
+     * @param index - The index of the leaf value to be returned.
+     * @param includeUncommitted - Set to true to include uncommitted updates in the data set.
+     */
+    getLeafValue(index: bigint, includeUncommitted: boolean): T | undefined;
+    /**
+     * Returns the index of a leaf given its value, or undefined if no leaf with that value is found.
+     * @param leaf - The leaf value to look for.
+     * @param includeUncommitted - Indicates whether to include uncommitted data.
+     * @returns The index of the first leaf found with a given value (undefined if not found).
+     */
+    findLeafIndex(leaf: T, includeUncommitted: boolean): bigint | undefined;
+    /**
+     * Returns the first index containing a leaf value after `startIndex`.
+     * @param leaf - The leaf value to look for.
+     * @param startIndex - The index to start searching from (used when skipping nullified messages)
+     * @param includeUncommitted - Indicates whether to include uncommitted data.
+     * @returns The index of the first leaf found with a given value (undefined if not found).
+     */
+    findLeafIndexAfter(leaf: T, startIndex: bigint, includeUncommitted: boolean): bigint | undefined;
+}
+//# sourceMappingURL=merkle_tree.d.ts.map

package/dest/interfaces/merkle_tree.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"merkle_tree.d.ts","sourceRoot":"","sources":["../../src/interfaces/merkle_tree.ts"],"names":[],"mappings":";;AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,6BAA6B,CAAC;AAC9D,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC;AAE3D;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;;;OAIG;IACH,cAAc,CAAC,CAAC,SAAS,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,kBAAkB,EAAE,OAAO,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC;CACvG;AAED;;GAEG;AACH,MAAM,WAAW,UAAU,CAAC,CAAC,SAAS,UAAU,GAAG,MAAM,CAAE,SAAQ,iBAAiB;IAClF;;;OAGG;IACH,OAAO,CAAC,kBAAkB,EAAE,OAAO,GAAG,MAAM,CAAC;IAE7C;;;OAGG;IACH,YAAY,CAAC,kBAAkB,EAAE,OAAO,GAAG,MAAM,CAAC;IAElD;;OAEG;IACH,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAExB;;OAEG;IACH,QAAQ,IAAI,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAE1B;;;;OAIG;IACH,YAAY,CAAC,KAAK,EAAE,MAAM,EAAE,kBAAkB,EAAE,OAAO,GAAG,CAAC,GAAG,SAAS,CAAC;IAExE;;;;;OAKG;IACH,aAAa,CAAC,IAAI,EAAE,CAAC,EAAE,kBAAkB,EAAE,OAAO,GAAG,MAAM,GAAG,SAAS,CAAC;IAExE;;;;;;OAMG;IACH,kBAAkB,CAAC,IAAI,EAAE,CAAC,EAAE,UAAU,EAAE,MAAM,EAAE,kBAAkB,EAAE,OAAO,GAAG,MAAM,GAAG,SAAS,CAAC;CAClG"}

package/dest/interfaces/merkle_tree.js

@@ -0,0 +1,3 @@
+/**
+ * Defines the interface for a Merkle tree.
+ */ export { };

package/dest/interfaces/update_only_tree.d.ts

@@ -0,0 +1,17 @@
+/// <reference types="node" resolution-mode="require"/>
+/// <reference types="node" resolution-mode="require"/>
+import type { Bufferable } from '@aztec/foundation/serialize';
+import type { TreeSnapshot, TreeSnapshotBuilder } from '../snapshots/snapshot_builder.js';
+import type { MerkleTree } from './merkle_tree.js';
+/**
+ * A Merkle tree that supports updates at arbitrary indices but not appending.
+ */
+export interface UpdateOnlyTree<T extends Bufferable = Buffer> extends MerkleTree<T>, TreeSnapshotBuilder<TreeSnapshot<T>> {
+    /**
+     * Updates a leaf at a given index in the tree.
+     * @param leaf - The leaf value to be updated.
+     * @param index - The leaf to be updated.
+     */
+    updateLeaf(leaf: T, index: bigint): Promise<void>;
+}
+//# sourceMappingURL=update_only_tree.d.ts.map

package/dest/interfaces/update_only_tree.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"update_only_tree.d.ts","sourceRoot":"","sources":["../../src/interfaces/update_only_tree.ts"],"names":[],"mappings":";;AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,6BAA6B,CAAC;AAE9D,OAAO,KAAK,EAAE,YAAY,EAAE,mBAAmB,EAAE,MAAM,kCAAkC,CAAC;AAC1F,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAEnD;;GAEG;AACH,MAAM,WAAW,cAAc,CAAC,CAAC,SAAS,UAAU,GAAG,MAAM,CAC3D,SAAQ,UAAU,CAAC,CAAC,CAAC,EACnB,mBAAmB,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;IACtC;;;;OAIG;IACH,UAAU,CAAC,IAAI,EAAE,CAAC,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CACnD"}

package/dest/interfaces/update_only_tree.js

@@ -0,0 +1,3 @@
+/**
+ * A Merkle tree that supports updates at arbitrary indices but not appending.
+ */ export { };

package/dest/load_tree.d.ts

@@ -0,0 +1,16 @@
+/// <reference types="node" resolution-mode="require"/>
+/// <reference types="node" resolution-mode="require"/>
+import type { Bufferable, FromBuffer } from '@aztec/foundation/serialize';
+import type { Hasher } from '@aztec/foundation/trees';
+import type { AztecKVStore } from '@aztec/kv-store';
+import { type TreeBase } from './tree_base.js';
+/**
+ * Creates a new tree and sets its root, depth and size based on the meta data which are associated with the name.
+ * @param c - The class of the tree to be instantiated.
+ * @param db - A database used to store the Merkle tree data.
+ * @param hasher - A hasher used to compute hash paths.
+ * @param name - Name of the tree.
+ * @returns The newly created tree.
+ */
+export declare function loadTree<T extends TreeBase<Bufferable>, D extends FromBuffer<Bufferable>>(c: new (store: AztecKVStore, hasher: Hasher, name: string, depth: number, size: bigint, deserializer: D, root: Buffer) => T, store: AztecKVStore, hasher: Hasher, name: string, deserializer: D): Promise<T>;
+//# sourceMappingURL=load_tree.d.ts.map

package/dest/load_tree.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"load_tree.d.ts","sourceRoot":"","sources":["../src/load_tree.ts"],"names":[],"mappings":";;AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,6BAA6B,CAAC;AAC1E,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,yBAAyB,CAAC;AACtD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAEpD,OAAO,EAAE,KAAK,QAAQ,EAAe,MAAM,gBAAgB,CAAC;AAE5D;;;;;;;GAOG;AACH,wBAAgB,QAAQ,CAAC,CAAC,SAAS,QAAQ,CAAC,UAAU,CAAC,EAAE,CAAC,SAAS,UAAU,CAAC,UAAU,CAAC,EACvF,CAAC,EAAE,KACD,KAAK,EAAE,YAAY,EACnB,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,MAAM,EACZ,KAAK,EAAE,MAAM,EACb,IAAI,EAAE,MAAM,EACZ,YAAY,EAAE,CAAC,EACf,IAAI,EAAE,MAAM,KACT,CAAC,EACN,KAAK,EAAE,YAAY,EACnB,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,MAAM,EACZ,YAAY,EAAE,CAAC,GACd,OAAO,CAAC,CAAC,CAAC,CAIZ"}

package/dest/load_tree.js

@@ -0,0 +1,13 @@
+import { getTreeMeta } from './tree_base.js';
+/**
+ * Creates a new tree and sets its root, depth and size based on the meta data which are associated with the name.
+ * @param c - The class of the tree to be instantiated.
+ * @param db - A database used to store the Merkle tree data.
+ * @param hasher - A hasher used to compute hash paths.
+ * @param name - Name of the tree.
+ * @returns The newly created tree.
+ */ export function loadTree(c, store, hasher, name, deserializer) {
+    const { root, depth, size } = getTreeMeta(store, name);
+    const tree = new c(store, hasher, name, depth, size, deserializer, root);
+    return Promise.resolve(tree);
+}

package/dest/new_tree.d.ts

@@ -0,0 +1,16 @@
+import type { Bufferable, FromBuffer } from '@aztec/foundation/serialize';
+import type { Hasher } from '@aztec/foundation/trees';
+import type { AztecKVStore } from '@aztec/kv-store';
+import type { TreeBase } from './tree_base.js';
+/**
+ * Creates a new tree.
+ * @param c - The class of the tree to be instantiated.
+ * @param db - A database used to store the Merkle tree data.
+ * @param hasher - A hasher used to compute hash paths.
+ * @param name - Name of the tree.
+ * @param depth - Depth of the tree.
+ * @param prefilledSize - A number of leaves that are prefilled with values.
+ * @returns The newly created tree.
+ */
+export declare function newTree<T extends TreeBase<Bufferable>, D extends FromBuffer<Bufferable>>(c: new (store: AztecKVStore, hasher: Hasher, name: string, depth: number, size: bigint, deserializer: D) => T, store: AztecKVStore, hasher: Hasher, name: string, deserializer: D, depth: number, prefilledSize?: number): Promise<T>;
+//# sourceMappingURL=new_tree.d.ts.map

package/dest/new_tree.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"new_tree.d.ts","sourceRoot":"","sources":["../src/new_tree.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,6BAA6B,CAAC;AAC1E,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,yBAAyB,CAAC;AACtD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAEpD,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAE/C;;;;;;;;;GASG;AACH,wBAAsB,OAAO,CAAC,CAAC,SAAS,QAAQ,CAAC,UAAU,CAAC,EAAE,CAAC,SAAS,UAAU,CAAC,UAAU,CAAC,EAC5F,CAAC,EAAE,KAAK,KAAK,EAAE,YAAY,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,YAAY,EAAE,CAAC,KAAK,CAAC,EAC7G,KAAK,EAAE,YAAY,EACnB,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,MAAM,EACZ,YAAY,EAAE,CAAC,EACf,KAAK,EAAE,MAAM,EACb,aAAa,SAAI,GAChB,OAAO,CAAC,CAAC,CAAC,CAIZ"}

package/dest/new_tree.js

@@ -0,0 +1,14 @@
+/**
+ * Creates a new tree.
+ * @param c - The class of the tree to be instantiated.
+ * @param db - A database used to store the Merkle tree data.
+ * @param hasher - A hasher used to compute hash paths.
+ * @param name - Name of the tree.
+ * @param depth - Depth of the tree.
+ * @param prefilledSize - A number of leaves that are prefilled with values.
+ * @returns The newly created tree.
+ */ export async function newTree(c, store, hasher, name, deserializer, depth, prefilledSize = 1) {
+    const tree = new c(store, hasher, name, depth, 0n, deserializer);
+    await tree.init(prefilledSize);
+    return tree;
+}

package/dest/pedersen.d.ts

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

package/dest/pedersen.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"pedersen.d.ts","sourceRoot":"","sources":["../src/pedersen.ts"],"names":[],"mappings":";;AAEA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,yBAAyB,CAAC;AAEtD;;;;GAIG;AACH,qBAAa,QAAS,YAAW,MAAM;IAK9B,IAAI,CAAC,GAAG,EAAE,UAAU,EAAE,GAAG,EAAE,UAAU,GAAG,MAAM;IAQ9C,UAAU,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM;CAI5C"}

package/dest/pedersen.js

@@ -0,0 +1,24 @@
+import { pedersenHash } from '@aztec/foundation/crypto/sync';
+import { Fr } from '@aztec/foundation/fields';
+/**
+ * A helper class encapsulating Pedersen hash functionality.
+ * @deprecated Don't call pedersen directly in production code. Instead, create suitably-named functions for specific
+ * purposes.
+ */ export class Pedersen {
+    /*
+   * @deprecated Don't call pedersen directly in production code. Instead, create suitably-named functions for specific
+   * purposes.
+   */ hash(lhs, rhs) {
+        return pedersenHash([
+            Fr.fromBuffer(Buffer.from(lhs)),
+            Fr.fromBuffer(Buffer.from(rhs))
+        ]).toBuffer();
+    }
+    /*
+   * @deprecated Don't call pedersen directly in production code. Instead, create suitably-named functions for specific
+   * purposes.
+   */ hashInputs(inputs) {
+        const inputFields = inputs.map((i)=>Fr.fromBuffer(i));
+        return pedersenHash(inputFields).toBuffer();
+    }
+}

package/dest/poseidon.d.ts

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

package/dest/poseidon.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"poseidon.d.ts","sourceRoot":"","sources":["../src/poseidon.ts"],"names":[],"mappings":";;AAEA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,yBAAyB,CAAC;AAEtD;;;;GAIG;AACH,qBAAa,QAAS,YAAW,MAAM;IAK9B,IAAI,CAAC,GAAG,EAAE,UAAU,EAAE,GAAG,EAAE,UAAU,GAAG,MAAM;IAQ9C,UAAU,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM;CAI5C"}

package/dest/poseidon.js

@@ -0,0 +1,24 @@
+import { poseidon2Hash } from '@aztec/foundation/crypto/sync';
+import { Fr } from '@aztec/foundation/fields';
+/**
+ * A helper class encapsulating poseidon2 hash functionality.
+ * @deprecated Don't call poseidon2 directly in production code. Instead, create suitably-named functions for specific
+ * purposes.
+ */ export class Poseidon {
+    /*
+   * @deprecated Don't call poseidon2 directly in production code. Instead, create suitably-named functions for specific
+   * purposes.
+   */ hash(lhs, rhs) {
+        return poseidon2Hash([
+            Fr.fromBuffer(Buffer.from(lhs)),
+            Fr.fromBuffer(Buffer.from(rhs))
+        ]).toBuffer();
+    }
+    /*
+   * @deprecated Don't call poseidon2 directly in production code. Instead, create suitably-named functions for specific
+   * purposes.
+   */ hashInputs(inputs) {
+        const inputFields = inputs.map((i)=>Fr.fromBuffer(i));
+        return poseidon2Hash(inputFields).toBuffer();
+    }
+}

package/dest/sha_256.d.ts

@@ -0,0 +1,22 @@
+/// <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

@@ -0,0 +1 @@
+{"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

@@ -0,0 +1,44 @@
+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/dest/snapshots/append_only_snapshot.d.ts

@@ -0,0 +1,32 @@
+import { type Bufferable, type FromBuffer } from '@aztec/foundation/serialize';
+import type { Hasher } from '@aztec/foundation/trees';
+import type { AztecKVStore } from '@aztec/kv-store';
+import type { AppendOnlyTree } from '../interfaces/append_only_tree.js';
+import type { TreeBase } from '../tree_base.js';
+import type { TreeSnapshot, TreeSnapshotBuilder } from './snapshot_builder.js';
+/**
+ * A more space-efficient way of storing snapshots of AppendOnlyTrees that trades space need for slower
+ * sibling path reads.
+ *
+ * Complexity:
+ *
+ * N - count of non-zero nodes in tree
+ * M - count of snapshots
+ * H - tree height
+ *
+ * Space complexity: O(N + M) (N nodes - stores the last snapshot for each node and M - ints, for each snapshot stores up to which leaf its written to)
+ * Sibling path access:
+ *  Best case: O(H) database reads + O(1) hashes
+ *  Worst case: O(H) database reads + O(H) hashes
+ */
+export declare class AppendOnlySnapshotBuilder<T extends Bufferable> implements TreeSnapshotBuilder<TreeSnapshot<T>> {
+    #private;
+    private db;
+    private tree;
+    private hasher;
+    private deserializer;
+    constructor(db: AztecKVStore, tree: TreeBase<T> & AppendOnlyTree<T>, hasher: Hasher, deserializer: FromBuffer<T>);
+    getSnapshot(block: number): Promise<TreeSnapshot<T>>;
+    snapshot(block: number): Promise<TreeSnapshot<T>>;
+}
+//# sourceMappingURL=append_only_snapshot.d.ts.map

package/dest/snapshots/append_only_snapshot.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"append_only_snapshot.d.ts","sourceRoot":"","sources":["../../src/snapshots/append_only_snapshot.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,UAAU,EAAE,KAAK,UAAU,EAAqB,MAAM,6BAA6B,CAAC;AAElG,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,yBAAyB,CAAC;AACtD,OAAO,KAAK,EAAE,YAAY,EAAY,MAAM,iBAAiB,CAAC;AAE9D,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,mCAAmC,CAAC;AACxE,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,KAAK,EAAE,YAAY,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAkB/E;;;;;;;;;;;;;;GAcG;AACH,qBAAa,yBAAyB,CAAC,CAAC,SAAS,UAAU,CAAE,YAAW,mBAAmB,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;;IAMxG,OAAO,CAAC,EAAE;IACV,OAAO,CAAC,IAAI;IACZ,OAAO,CAAC,MAAM;IACd,OAAO,CAAC,YAAY;gBAHZ,EAAE,EAAE,YAAY,EAChB,IAAI,EAAE,QAAQ,CAAC,CAAC,CAAC,GAAG,cAAc,CAAC,CAAC,CAAC,EACrC,MAAM,EAAE,MAAM,EACd,YAAY,EAAE,UAAU,CAAC,CAAC,CAAC;IAQrC,WAAW,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;IAqBpD,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;CA4ElD"}