@aztec/world-state 0.72.1 → 0.74.0

package/src/world-state-db/merkle_tree_operations_facade.ts

@@ -1,199 +0,0 @@
-import { type BatchInsertionResult, type MerkleTreeId, type SiblingPath } from '@aztec/circuit-types';
-import {
-  type IndexedTreeId,
-  type MerkleTreeLeafType,
-  type MerkleTreeWriteOperations,
-  type SequentialInsertionResult,
-  type TreeInfo,
-} from '@aztec/circuit-types/interfaces';
-import { type BlockHeader, type StateReference } from '@aztec/circuits.js';
-import { type IndexedTreeLeafPreimage } from '@aztec/foundation/trees';
-
-import { type MerkleTrees } from './merkle_trees.js';
-
-/**
- * Wraps a MerkleTreeDbOperations to call all functions with a preset includeUncommitted flag.
- */
-export class MerkleTreeReadOperationsFacade implements MerkleTreeWriteOperations {
-  constructor(protected trees: MerkleTrees, protected includeUncommitted: boolean) {}
-
-  /**
-   * Returns the tree info for the specified tree id.
-   * @param treeId - Id of the tree to get information from.
-   * @param includeUncommitted - Indicates whether to include uncommitted data.
-   * @returns The tree info for the specified tree.
-   */
-  getTreeInfo(treeId: MerkleTreeId): Promise<TreeInfo> {
-    return this.trees.getTreeInfo(treeId, this.includeUncommitted);
-  }
-
-  /**
-   * Get the current state reference.
-   * @returns The current state reference.
-   */
-  getStateReference(): Promise<StateReference> {
-    return this.trees.getStateReference(this.includeUncommitted);
-  }
-
-  /**
-   * Returns the initial header for the chain before the first block.
-   * @returns The initial header.
-   */
-  getInitialHeader(): BlockHeader {
-    return this.trees.getInitialHeader();
-  }
-
-  /**
-   * Appends a set of leaf values to the tree.
-   * @param treeId - Id of the tree to append leaves to.
-   * @param leaves - The set of leaves to be appended.
-   * @returns The tree info of the specified tree.
-   */
-  appendLeaves<ID extends MerkleTreeId>(treeId: ID, leaves: MerkleTreeLeafType<ID>[]): Promise<void> {
-    return this.trees.appendLeaves(treeId, leaves);
-  }
-
-  /**
-   * Returns the sibling path for a requested leaf index.
-   * @param treeId - Id of the tree to get the sibling path from.
-   * @param index - The index of the leaf for which a sibling path is required.
-   * @returns A promise with the sibling path of the specified leaf index.
-   */
-  async getSiblingPath<N extends number>(treeId: MerkleTreeId, index: bigint): Promise<SiblingPath<N>> {
-    const path = await this.trees.getSiblingPath(treeId, index, this.includeUncommitted);
-    return path as unknown as SiblingPath<N>;
-  }
-
-  /**
-   * Finds the index of the largest leaf whose value is less than or equal to the provided value.
-   * @param treeId - The ID of the tree to search.
-   * @param value - The 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`.
-   */
-  getPreviousValueIndex<ID extends IndexedTreeId>(
-    treeId: ID,
-    value: bigint,
-  ): Promise<
-    | {
-        /**
-         * The index of the found leaf.
-         */
-        index: bigint;
-        /**
-         * A flag indicating if the corresponding leaf's value is equal to `newValue`.
-         */
-        alreadyPresent: boolean;
-      }
-    | undefined
-  > {
-    return this.trees.getPreviousValueIndex(treeId, value, this.includeUncommitted);
-  }
-
-  /**
-   * Gets the leaf data at a given index and tree.
-   * @param treeId - The ID of the tree get the leaf from.
-   * @param index - The index of the leaf to get.
-   * @returns Leaf preimage.
-   */
-  async getLeafPreimage<ID extends IndexedTreeId>(
-    treeId: ID,
-    index: bigint,
-  ): Promise<IndexedTreeLeafPreimage | undefined> {
-    const preimage = await this.trees.getLeafPreimage(treeId, index, this.includeUncommitted);
-    return preimage as IndexedTreeLeafPreimage | undefined;
-  }
-
-  /**
-   * Returns the index of a leaf given its value, or undefined if no leaf with that value is found.
-   * @param treeId - The ID of the tree.
-   * @param value - The leaf value to look for.
-   * @returns The index of the first leaf found with a given value (undefined if not found).
-   */
-  findLeafIndices<ID extends MerkleTreeId>(
-    treeId: ID,
-    values: MerkleTreeLeafType<ID>[],
-  ): Promise<(bigint | undefined)[]> {
-    return Promise.all(values.map(leaf => this.trees.findLeafIndex(treeId, leaf, this.includeUncommitted)));
-  }
-
-  /**
-   * Returns the first index containing a leaf value after `startIndex`.
-   * @param treeId - The tree for which the index should be returned.
-   * @param value - The value to search for in the tree.
-   * @param startIndex - The index to start searching from (used when skipping nullified messages)
-   */
-  findLeafIndicesAfter<ID extends MerkleTreeId>(
-    treeId: ID,
-    values: MerkleTreeLeafType<ID>[],
-    startIndex: bigint,
-  ): Promise<(bigint | undefined)[]> {
-    return Promise.all(
-      values.map(leaf => this.trees.findLeafIndexAfter(treeId, leaf, startIndex, this.includeUncommitted)),
-    );
-  }
-
-  /**
-   * Gets the value at the given index.
-   * @param treeId - The ID of the tree to get the leaf value from.
-   * @param index - The index of the leaf.
-   * @param includeUncommitted - Indicates whether to include uncommitted changes.
-   * @returns Leaf value at the given index (undefined if not found).
-   */
-  getLeafValue<ID extends MerkleTreeId>(
-    treeId: ID,
-    index: bigint,
-  ): Promise<MerkleTreeLeafType<typeof treeId> | undefined> {
-    return this.trees.getLeafValue(treeId, index, this.includeUncommitted) as Promise<
-      MerkleTreeLeafType<typeof treeId> | undefined
-    >;
-  }
-
-  /**
-   * Inserts the new block hash into the archive.
-   * This includes all of the current roots of all of the data trees and the current blocks global vars.
-   * @param header - The header to insert into the archive.
-   */
-  public updateArchive(header: BlockHeader): Promise<void> {
-    return this.trees.updateArchive(header);
-  }
-
-  /**
-   * Batch insert multiple leaves into the tree.
-   * @param treeId - The ID of the tree.
-   * @param leaves - Leaves to insert into the tree.
-   * @param subtreeHeight - Height of the subtree.
-   * @returns The data for the leaves to be updated when inserting the new ones.
-   */
-  public batchInsert<TreeHeight extends number, SubtreeSiblingPathHeight extends number>(
-    treeId: IndexedTreeId,
-    leaves: Buffer[],
-    subtreeHeight: number,
-  ): Promise<BatchInsertionResult<TreeHeight, SubtreeSiblingPathHeight>> {
-    return this.trees.batchInsert(treeId, leaves, subtreeHeight);
-  }
-
-  /**
-   * Sequentially inserts multiple leaves into the tree.
-   * @param treeId - The ID of the tree.
-   * @param leaves - Leaves to insert into the tree.
-   * @returns Witnesses for the operations performed.
-   */
-  public sequentialInsert<TreeHeight extends number>(
-    _treeId: IndexedTreeId,
-    _leaves: Buffer[],
-  ): Promise<SequentialInsertionResult<TreeHeight>> {
-    throw new Error('Method not implemented in legacy merkle tree');
-  }
-
-  getBlockNumbersForLeafIndices<ID extends MerkleTreeId>(
-    _treeId: ID,
-    _leafIndices: bigint[],
-  ): Promise<(bigint | undefined)[]> {
-    throw new Error('Method not implemented in legacy merkle tree');
-  }
-
-  close(): Promise<void> {
-    return Promise.resolve();
-  }
-}

package/src/world-state-db/merkle_tree_snapshot_operations_facade.ts

@@ -1,151 +0,0 @@
-import { MerkleTreeId, type SiblingPath } from '@aztec/circuit-types';
-import {
-  type IndexedTreeId,
-  type MerkleTreeLeafType,
-  type MerkleTreeReadOperations,
-  type TreeInfo,
-} from '@aztec/circuit-types/interfaces';
-import {
-  AppendOnlyTreeSnapshot,
-  type BlockHeader,
-  Fr,
-  PartialStateReference,
-  StateReference,
-} from '@aztec/circuits.js';
-import { type IndexedTreeLeafPreimage } from '@aztec/foundation/trees';
-import { type IndexedTreeSnapshot } from '@aztec/merkle-tree';
-
-import { type TreeSnapshots } from './merkle_tree_db.js';
-import { type MerkleTrees } from './merkle_trees.js';
-
-/**
- * Merkle tree operations on readonly tree snapshots.
- */
-export class MerkleTreeSnapshotOperationsFacade implements MerkleTreeReadOperations {
-  #treesDb: MerkleTrees;
-  #blockNumber: number;
-  #treeSnapshots: TreeSnapshots = {} as any;
-
-  constructor(trees: MerkleTrees, blockNumber: number) {
-    this.#treesDb = trees;
-    this.#blockNumber = blockNumber;
-  }
-
-  async #getTreeSnapshot(treeId: MerkleTreeId): Promise<TreeSnapshots[typeof treeId]> {
-    if (this.#treeSnapshots[treeId]) {
-      return this.#treeSnapshots[treeId];
-    }
-
-    this.#treeSnapshots = await this.#treesDb.getTreeSnapshots(this.#blockNumber);
-    return this.#treeSnapshots[treeId]!;
-  }
-
-  async findLeafIndices<ID extends MerkleTreeId>(
-    treeId: ID,
-    values: MerkleTreeLeafType<ID>[],
-  ): Promise<(bigint | undefined)[]> {
-    const tree = await this.#getTreeSnapshot(treeId);
-    // TODO #5448 fix "as any"
-    return values.map(leaf => tree.findLeafIndex(leaf as any));
-  }
-
-  async findLeafIndicesAfter<ID extends MerkleTreeId>(
-    treeId: MerkleTreeId,
-    values: MerkleTreeLeafType<ID>[],
-    startIndex: bigint,
-  ): Promise<(bigint | undefined)[]> {
-    const tree = await this.#getTreeSnapshot(treeId);
-    // TODO #5448 fix "as any"
-    return values.map(leaf => tree.findLeafIndexAfter(leaf as any, startIndex));
-  }
-
-  async getLeafPreimage<ID extends IndexedTreeId>(
-    treeId: ID,
-    index: bigint,
-  ): Promise<IndexedTreeLeafPreimage | undefined> {
-    const snapshot = (await this.#getTreeSnapshot(treeId)) as IndexedTreeSnapshot;
-    return snapshot.getLatestLeafPreimageCopy(BigInt(index));
-  }
-
-  async getLeafValue<ID extends MerkleTreeId>(
-    treeId: ID,
-    index: bigint,
-  ): Promise<MerkleTreeLeafType<typeof treeId> | undefined> {
-    const snapshot = await this.#getTreeSnapshot(treeId);
-    return snapshot.getLeafValue(BigInt(index)) as MerkleTreeLeafType<typeof treeId> | undefined;
-  }
-
-  async getPreviousValueIndex(
-    treeId: IndexedTreeId,
-    value: bigint,
-  ): Promise<
-    | {
-        /**
-         * The index of the found leaf.
-         */
-        index: bigint;
-        /**
-         * A flag indicating if the corresponding leaf's value is equal to `newValue`.
-         */
-        alreadyPresent: boolean;
-      }
-    | undefined
-  > {
-    const snapshot = (await this.#getTreeSnapshot(treeId)) as IndexedTreeSnapshot;
-    return snapshot.findIndexOfPreviousKey(value);
-  }
-
-  async getSiblingPath<N extends number>(treeId: MerkleTreeId, index: bigint): Promise<SiblingPath<N>> {
-    const snapshot = await this.#getTreeSnapshot(treeId);
-    return snapshot.getSiblingPath(index);
-  }
-
-  async getTreeInfo(treeId: MerkleTreeId): Promise<TreeInfo> {
-    const snapshot = await this.#getTreeSnapshot(treeId);
-    return {
-      depth: snapshot.getDepth(),
-      root: snapshot.getRoot(),
-      size: snapshot.getNumLeaves(),
-      treeId,
-    };
-  }
-
-  getBlockNumbersForLeafIndices<ID extends MerkleTreeId>(_a: ID, _b: bigint[]): Promise<(bigint | undefined)[]> {
-    throw new Error('Not implemented');
-  }
-
-  async getStateReference(): Promise<StateReference> {
-    const snapshots = await Promise.all([
-      this.#getTreeSnapshot(MerkleTreeId.NULLIFIER_TREE),
-      this.#getTreeSnapshot(MerkleTreeId.NOTE_HASH_TREE),
-      this.#getTreeSnapshot(MerkleTreeId.PUBLIC_DATA_TREE),
-      this.#getTreeSnapshot(MerkleTreeId.L1_TO_L2_MESSAGE_TREE),
-      this.#getTreeSnapshot(MerkleTreeId.ARCHIVE),
-    ]);
-
-    return new StateReference(
-      new AppendOnlyTreeSnapshot(
-        Fr.fromBuffer(snapshots[MerkleTreeId.L1_TO_L2_MESSAGE_TREE].getRoot()),
-        Number(snapshots[MerkleTreeId.L1_TO_L2_MESSAGE_TREE].getNumLeaves()),
-      ),
-      new PartialStateReference(
-        new AppendOnlyTreeSnapshot(
-          Fr.fromBuffer(snapshots[MerkleTreeId.NOTE_HASH_TREE].getRoot()),
-          Number(snapshots[MerkleTreeId.NOTE_HASH_TREE].getNumLeaves()),
-        ),
-        new AppendOnlyTreeSnapshot(
-          Fr.fromBuffer(snapshots[MerkleTreeId.NULLIFIER_TREE].getRoot()),
-          Number(snapshots[MerkleTreeId.NULLIFIER_TREE].getNumLeaves()),
-        ),
-        new AppendOnlyTreeSnapshot(
-          Fr.fromBuffer(snapshots[MerkleTreeId.PUBLIC_DATA_TREE].getRoot()),
-          Number(snapshots[MerkleTreeId.PUBLIC_DATA_TREE].getNumLeaves()),
-        ),
-      ),
-    );
-  }
-
-  getInitialHeader(): BlockHeader {
-    throw new Error('Getting initial header not supported on snapshot.');
-  }
-}