@aztec/world-state 0.0.0-test.0 → 0.0.1-commit.001888fc

package/src/test/utils.ts

@@ -4,107 +4,100 @@ import {
   NULLIFIER_SUBTREE_HEIGHT,
   NUMBER_OF_L1_L2_MESSAGES_PER_ROLLUP,
 } from '@aztec/constants';
+import { asyncMap } from '@aztec/foundation/async-map';
+import { BlockNumber, type CheckpointNumber, IndexWithinCheckpoint } from '@aztec/foundation/branded-types';
 import { padArrayEnd } from '@aztec/foundation/collection';
-import { Fr } from '@aztec/foundation/fields';
+import { Fr } from '@aztec/foundation/curves/bn254';
 import { L2Block } from '@aztec/stdlib/block';
-import type { MerkleTreeReadOperations, MerkleTreeWriteOperations } from '@aztec/stdlib/interfaces/server';
+import type {
+  IndexedTreeId,
+  MerkleTreeReadOperations,
+  MerkleTreeWriteOperations,
+} from '@aztec/stdlib/interfaces/server';
+import { mockCheckpointAndMessages, mockL1ToL2Messages } from '@aztec/stdlib/testing';
 import { AppendOnlyTreeSnapshot, MerkleTreeId } from '@aztec/stdlib/trees';
+import { BlockHeader } from '@aztec/stdlib/tx';
 
 import type { NativeWorldStateService } from '../native/native_world_state.js';
 
-export async function mockBlock(blockNum: number, size: number, fork: MerkleTreeWriteOperations) {
-  const l2Block = await L2Block.random(blockNum, size);
-  const l1ToL2Messages = Array(16).fill(0).map(Fr.random);
-
-  // Sync the append only trees
-  {
-    const noteHashesPadded = l2Block.body.txEffects.flatMap(txEffect =>
-      padArrayEnd(txEffect.noteHashes, Fr.ZERO, MAX_NOTE_HASHES_PER_TX),
-    );
-    await fork.appendLeaves(MerkleTreeId.NOTE_HASH_TREE, noteHashesPadded);
-
-    const l1ToL2MessagesPadded = padArrayEnd(l1ToL2Messages, Fr.ZERO, NUMBER_OF_L1_L2_MESSAGES_PER_ROLLUP);
-    await fork.appendLeaves(MerkleTreeId.L1_TO_L2_MESSAGE_TREE, l1ToL2MessagesPadded);
-  }
-
-  // Sync the indexed trees
-  {
-    // We insert the public data tree leaves with one batch per tx to avoid updating the same key twice
-    for (const txEffect of l2Block.body.txEffects) {
-      await fork.batchInsert(
-        MerkleTreeId.PUBLIC_DATA_TREE,
-        txEffect.publicDataWrites.map(write => write.toBuffer()),
-        0,
-      );
-
-      const nullifiersPadded = padArrayEnd(txEffect.nullifiers, Fr.ZERO, MAX_NULLIFIERS_PER_TX);
-
-      await fork.batchInsert(
-        MerkleTreeId.NULLIFIER_TREE,
-        nullifiersPadded.map(nullifier => nullifier.toBuffer()),
-        NULLIFIER_SUBTREE_HEIGHT,
-      );
+export async function updateBlockState(block: L2Block, l1ToL2Messages: Fr[], fork: MerkleTreeWriteOperations) {
+  const insertData = async (
+    treeId: IndexedTreeId,
+    data: Buffer[][],
+    subTreeHeight: number,
+    fork: MerkleTreeWriteOperations,
+  ) => {
+    for (const dataBatch of data) {
+      await fork.batchInsert(treeId, dataBatch, subTreeHeight);
     }
-  }
+  };
+
+  const publicDataInsert = insertData(
+    MerkleTreeId.PUBLIC_DATA_TREE,
+    block.body.txEffects.map(txEffect => txEffect.publicDataWrites.map(write => write.toBuffer())),
+    0,
+    fork,
+  );
+  const nullifierInsert = insertData(
+    MerkleTreeId.NULLIFIER_TREE,
+    block.body.txEffects.map(txEffect =>
+      padArrayEnd(txEffect.nullifiers, Fr.ZERO, MAX_NULLIFIERS_PER_TX).map(nullifier => nullifier.toBuffer()),
+    ),
+    NULLIFIER_SUBTREE_HEIGHT,
+    fork,
+  );
+  const noteHashesPadded = block.body.txEffects.flatMap(txEffect =>
+    padArrayEnd(txEffect.noteHashes, Fr.ZERO, MAX_NOTE_HASHES_PER_TX),
+  );
+
+  const l1ToL2MessagesPadded =
+    block.indexWithinCheckpoint === 0
+      ? padArrayEnd<Fr, number>(l1ToL2Messages, Fr.ZERO, NUMBER_OF_L1_L2_MESSAGES_PER_ROLLUP)
+      : l1ToL2Messages;
+
+  const noteHashInsert = fork.appendLeaves(MerkleTreeId.NOTE_HASH_TREE, noteHashesPadded);
+  const messageInsert = fork.appendLeaves(MerkleTreeId.L1_TO_L2_MESSAGE_TREE, l1ToL2MessagesPadded);
+  await Promise.all([publicDataInsert, nullifierInsert, noteHashInsert, messageInsert]);
 
   const state = await fork.getStateReference();
-  l2Block.header.state = state;
-  await fork.updateArchive(l2Block.header);
+  block.header = BlockHeader.from({ ...block.header, state });
+  await fork.updateArchive(block.header);
 
   const archiveState = await fork.getTreeInfo(MerkleTreeId.ARCHIVE);
 
-  l2Block.archive = new AppendOnlyTreeSnapshot(Fr.fromBuffer(archiveState.root), Number(archiveState.size));
+  block.archive = new AppendOnlyTreeSnapshot(Fr.fromBuffer(archiveState.root), Number(archiveState.size));
+}
+
+export async function mockBlock(
+  blockNum: BlockNumber,
+  size: number,
+  fork: MerkleTreeWriteOperations,
+  maxEffects: number | undefined = 1000, // Defaults to the maximum tx effects.
+  numL1ToL2Messages: number = NUMBER_OF_L1_L2_MESSAGES_PER_ROLLUP,
+  isFirstBlockInCheckpoint: boolean = true,
+) {
+  const block = await L2Block.random(blockNum, {
+    indexWithinCheckpoint: isFirstBlockInCheckpoint ? IndexWithinCheckpoint(0) : IndexWithinCheckpoint(1),
+    txsPerBlock: size,
+    txOptions: { maxEffects },
+  });
+  const l1ToL2Messages = mockL1ToL2Messages(numL1ToL2Messages);
+
+  await updateBlockState(block, l1ToL2Messages, fork);
 
   return {
-    block: l2Block,
+    block,
     messages: l1ToL2Messages,
   };
 }
 
-export async function mockEmptyBlock(blockNum: number, fork: MerkleTreeWriteOperations) {
+export async function mockEmptyBlock(blockNum: BlockNumber, fork: MerkleTreeWriteOperations) {
   const l2Block = L2Block.empty();
   const l1ToL2Messages = Array(16).fill(0).map(Fr.zero);
 
-  l2Block.header.globalVariables.blockNumber = new Fr(blockNum);
+  l2Block.header.globalVariables.blockNumber = blockNum;
 
-  // Sync the append only trees
-  {
-    const noteHashesPadded = l2Block.body.txEffects.flatMap(txEffect =>
-      padArrayEnd(txEffect.noteHashes, Fr.ZERO, MAX_NOTE_HASHES_PER_TX),
-    );
-    await fork.appendLeaves(MerkleTreeId.NOTE_HASH_TREE, noteHashesPadded);
-
-    const l1ToL2MessagesPadded = padArrayEnd(l1ToL2Messages, Fr.ZERO, NUMBER_OF_L1_L2_MESSAGES_PER_ROLLUP);
-    await fork.appendLeaves(MerkleTreeId.L1_TO_L2_MESSAGE_TREE, l1ToL2MessagesPadded);
-  }
-
-  // Sync the indexed trees
-  {
-    // We insert the public data tree leaves with one batch per tx to avoid updating the same key twice
-    for (const txEffect of l2Block.body.txEffects) {
-      await fork.batchInsert(
-        MerkleTreeId.PUBLIC_DATA_TREE,
-        txEffect.publicDataWrites.map(write => write.toBuffer()),
-        0,
-      );
-
-      const nullifiersPadded = padArrayEnd(txEffect.nullifiers, Fr.ZERO, MAX_NULLIFIERS_PER_TX);
-
-      await fork.batchInsert(
-        MerkleTreeId.NULLIFIER_TREE,
-        nullifiersPadded.map(nullifier => nullifier.toBuffer()),
-        NULLIFIER_SUBTREE_HEIGHT,
-      );
-    }
-  }
-
-  const state = await fork.getStateReference();
-  l2Block.header.state = state;
-  await fork.updateArchive(l2Block.header);
-
-  const archiveState = await fork.getTreeInfo(MerkleTreeId.ARCHIVE);
-
-  l2Block.archive = new AppendOnlyTreeSnapshot(Fr.fromBuffer(archiveState.root), Number(archiveState.size));
+  await updateBlockState(l2Block, l1ToL2Messages, fork);
 
   return {
     block: l2Block,
@@ -112,13 +105,18 @@ export async function mockEmptyBlock(blockNum: number, fork: MerkleTreeWriteOper
   };
 }
 
-export async function mockBlocks(from: number, count: number, numTxs: number, worldState: NativeWorldStateService) {
-  const tempFork = await worldState.fork(from - 1);
+export async function mockBlocks(
+  from: BlockNumber,
+  count: number,
+  numTxs: number,
+  worldState: NativeWorldStateService,
+) {
+  const tempFork = await worldState.fork(BlockNumber(from - 1));
 
   const blocks = [];
   const messagesArray = [];
   for (let blockNumber = from; blockNumber < from + count; blockNumber++) {
-    const { block, messages } = await mockBlock(blockNumber, numTxs, tempFork);
+    const { block, messages } = await mockBlock(BlockNumber(blockNumber), numTxs, tempFork);
     blocks.push(block);
     messagesArray.push(messages);
   }
@@ -128,6 +126,18 @@ export async function mockBlocks(from: number, count: number, numTxs: number, wo
   return { blocks, messages: messagesArray };
 }
 
+export async function mockCheckpoint(
+  checkpointNumber: CheckpointNumber,
+  fork: MerkleTreeWriteOperations,
+  options: Partial<Parameters<typeof mockCheckpointAndMessages>[1]> = {},
+) {
+  const { checkpoint, messages } = await mockCheckpointAndMessages(checkpointNumber, options);
+  await asyncMap(checkpoint.blocks, async (block, i) => {
+    await updateBlockState(block, i === 0 ? messages : [], fork);
+  });
+  return { checkpoint, messages };
+}
+
 export async function assertSameState(forkA: MerkleTreeReadOperations, forkB: MerkleTreeReadOperations) {
   const nativeStateRef = await forkA.getStateReference();
   const nativeArchive = await forkA.getTreeInfo(MerkleTreeId.ARCHIVE);

package/src/testing.ts

@@ -1,5 +1,5 @@
-import { GENESIS_ARCHIVE_ROOT, GENESIS_BLOCK_HASH } from '@aztec/constants';
-import { Fr } from '@aztec/foundation/fields';
+import { GENESIS_ARCHIVE_ROOT } from '@aztec/constants';
+import { Fr } from '@aztec/foundation/curves/bn254';
 import { computeFeePayerBalanceLeafSlot } from '@aztec/protocol-contracts/fee-juice';
 import type { AztecAddress } from '@aztec/stdlib/aztec-address';
 import { MerkleTreeId, PublicDataTreeLeaf } from '@aztec/stdlib/trees';
@@ -10,7 +10,6 @@ async function generateGenesisValues(prefilledPublicData: PublicDataTreeLeaf[])
   if (!prefilledPublicData.length) {
     return {
       genesisArchiveRoot: new Fr(GENESIS_ARCHIVE_ROOT),
-      genesisBlockHash: new Fr(GENESIS_BLOCK_HASH),
     };
   }
 
@@ -20,14 +19,11 @@ async function generateGenesisValues(prefilledPublicData: PublicDataTreeLeaf[])
     true /* cleanupTmpDir */,
     prefilledPublicData,
   );
-  const initialHeader = ws.getInitialHeader();
-  const genesisBlockHash = await initialHeader.hash();
   const genesisArchiveRoot = new Fr((await ws.getCommitted().getTreeInfo(MerkleTreeId.ARCHIVE)).root);
   await ws.close();
 
   return {
     genesisArchiveRoot,
-    genesisBlockHash,
   };
 }
 
@@ -50,11 +46,11 @@ export async function getGenesisValues(
 
   prefilledPublicData.sort((a, b) => (b.slot.lt(a.slot) ? 1 : -1));
 
-  const { genesisBlockHash, genesisArchiveRoot } = await generateGenesisValues(prefilledPublicData);
+  const { genesisArchiveRoot } = await generateGenesisValues(prefilledPublicData);
 
   return {
     genesisArchiveRoot,
-    genesisBlockHash,
     prefilledPublicData,
+    fundingNeeded: BigInt(initialAccounts.length) * initialAccountFeeJuice.toBigInt(),
   };
 }

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

@@ -1,9 +1,12 @@
 import { MAX_NULLIFIERS_PER_TX, MAX_TOTAL_PUBLIC_DATA_UPDATE_REQUESTS_PER_TX } from '@aztec/constants';
-import type { Fr } from '@aztec/foundation/fields';
-import type { IndexedTreeSnapshot, TreeSnapshot } from '@aztec/merkle-tree';
+import type { BlockNumber } from '@aztec/foundation/branded-types';
+import type { Fr } from '@aztec/foundation/curves/bn254';
 import type { L2Block } from '@aztec/stdlib/block';
-import type { ForkMerkleTreeOperations, MerkleTreeReadOperations } from '@aztec/stdlib/interfaces/server';
-import type { MerkleTreeId } from '@aztec/stdlib/trees';
+import type {
+  ForkMerkleTreeOperations,
+  MerkleTreeReadOperations,
+  ReadonlyWorldStateAccess,
+} from '@aztec/stdlib/interfaces/server';
 
 import type { WorldStateStatusFull, WorldStateStatusSummary } from '../native/message.js';
 
@@ -26,15 +29,7 @@ export const INITIAL_NULLIFIER_TREE_SIZE = 2 * MAX_NULLIFIERS_PER_TX;
 
 export const INITIAL_PUBLIC_DATA_TREE_SIZE = 2 * MAX_TOTAL_PUBLIC_DATA_UPDATE_REQUESTS_PER_TX;
 
-export type TreeSnapshots = {
-  [MerkleTreeId.NULLIFIER_TREE]: IndexedTreeSnapshot;
-  [MerkleTreeId.NOTE_HASH_TREE]: TreeSnapshot<Fr>;
-  [MerkleTreeId.PUBLIC_DATA_TREE]: IndexedTreeSnapshot;
-  [MerkleTreeId.L1_TO_L2_MESSAGE_TREE]: TreeSnapshot<Fr>;
-  [MerkleTreeId.ARCHIVE]: TreeSnapshot<Fr>;
-};
-
-export interface MerkleTreeAdminDatabase extends ForkMerkleTreeOperations {
+export interface MerkleTreeAdminDatabase extends ForkMerkleTreeOperations, ReadonlyWorldStateAccess {
   /**
    * Handles a single L2 block (i.e. Inserts the new note hashes into the merkle tree).
    * @param block - The L2 block to handle.
@@ -52,21 +47,21 @@ export interface MerkleTreeAdminDatabase extends ForkMerkleTreeOperations {
    * @param toBlockNumber The block number of the new oldest historical block
    * @returns The new WorldStateStatus
    */
-  removeHistoricalBlocks(toBlockNumber: bigint): Promise<WorldStateStatusFull>;
+  removeHistoricalBlocks(toBlockNumber: BlockNumber): Promise<WorldStateStatusFull>;
 
   /**
    * Removes all pending blocks down to but not including the given block number
    * @param toBlockNumber The block number of the new tip of the pending chain,
    * @returns The new WorldStateStatus
    */
-  unwindBlocks(toBlockNumber: bigint): Promise<WorldStateStatusFull>;
+  unwindBlocks(toBlockNumber: BlockNumber): Promise<WorldStateStatusFull>;
 
   /**
-   * Advances the finalised block number to be the number provided
-   * @param toBlockNumber The block number that is now the tip of the finalised chain
+   * Advances the finalized block number to be the number provided
+   * @param toBlockNumber The block number that is now the tip of the finalized chain
    * @returns The new WorldStateStatus
    */
-  setFinalised(toBlockNumber: bigint): Promise<WorldStateStatusSummary>;
+  setFinalized(toBlockNumber: BlockNumber): Promise<WorldStateStatusSummary>;
 
   /**
    * Gets the current status summary of the database.
@@ -76,4 +71,7 @@ export interface MerkleTreeAdminDatabase extends ForkMerkleTreeOperations {
 
   /** Stops the database */
   close(): Promise<void>;
+
+  /** Deletes the db. */
+  clear(): Promise<void>;
 }