@aztec/world-state 0.62.0 → 0.63.0

package/src/native/world_state_version.ts

@@ -0,0 +1,41 @@
+import { EthAddress } from '@aztec/circuits.js';
+
+import { readFile, writeFile } from 'fs/promises';
+
+export class WorldStateVersion {
+  constructor(readonly version: number, readonly rollupAddress: EthAddress) {}
+
+  static async readVersion(filename: string) {
+    const versionData = await readFile(filename, 'utf-8').catch(() => undefined);
+    if (versionData === undefined) {
+      return undefined;
+    }
+    const versionJSON = JSON.parse(versionData);
+    if (versionJSON.version === undefined || versionJSON.rollupAddress === undefined) {
+      return undefined;
+    }
+    return WorldStateVersion.fromJSON(versionJSON);
+  }
+
+  public async writeVersionFile(filename: string) {
+    const data = JSON.stringify(this.toJSON());
+    await writeFile(filename, data, 'utf-8');
+  }
+
+  toJSON() {
+    return {
+      version: this.version,
+      rollupAddress: this.rollupAddress.toChecksumString(),
+    };
+  }
+
+  static fromJSON(obj: any): WorldStateVersion {
+    const version = obj.version;
+    const rollupAddress = EthAddress.fromString(obj.rollupAddress);
+    return new WorldStateVersion(version, rollupAddress);
+  }
+
+  static empty() {
+    return new WorldStateVersion(0, EthAddress.ZERO);
+  }
+}

package/src/synchronizer/config.ts

@@ -10,6 +10,12 @@ export interface WorldStateConfig {
 
   /** Size of the batch for each get-blocks request from the synchronizer to the archiver. */
   worldStateBlockRequestBatchSize?: number;
+
+  /** The maximum size of the combined world state db in KB, optional, will inherit from the general dataStoreMapSizeKB if not specified*/
+  worldStateDbMapSizeKb?: number;
+
+  /** Optional directory for the world state DB, if unspecified will default to the general data directory */
+  worldStateDataDirectory?: string;
 }
 
 export const worldStateConfigMappings: ConfigMappingsType<WorldStateConfig> = {
@@ -29,6 +35,15 @@ export const worldStateConfigMappings: ConfigMappingsType<WorldStateConfig> = {
     parseEnv: (val: string | undefined) => (val ? +val : undefined),
     description: 'Size of the batch for each get-blocks request from the synchronizer to the archiver.',
   },
+  worldStateDbMapSizeKb: {
+    env: 'WS_DB_MAP_SIZE_KB',
+    parseEnv: (val: string | undefined) => (val ? +val : undefined),
+    description: 'The maximum possible size of the world state DB',
+  },
+  worldStateDataDirectory: {
+    env: 'WS_DATA_DIRECTORY',
+    description: 'Optional directory for the world state database',
+  },
 };
 
 /**

package/src/synchronizer/factory.ts

@@ -1,6 +1,7 @@
 import { type L1ToL2MessageSource, type L2BlockSource } from '@aztec/circuit-types';
 import { createDebugLogger } from '@aztec/foundation/log';
-import { type DataStoreConfig, createStore } from '@aztec/kv-store/utils';
+import { type DataStoreConfig } from '@aztec/kv-store/config';
+import { createStore } from '@aztec/kv-store/utils';
 import { type TelemetryClient } from '@aztec/telemetry-client';
 import { NoopTelemetryClient } from '@aztec/telemetry-client/noop';
 
@@ -18,14 +19,25 @@ export async function createWorldStateSynchronizer(
   return new ServerWorldStateSynchronizer(merkleTrees, l2BlockSource, config);
 }
 
-export async function createWorldState(config: DataStoreConfig, client: TelemetryClient = new NoopTelemetryClient()) {
+export async function createWorldState(
+  config: WorldStateConfig & DataStoreConfig,
+  client: TelemetryClient = new NoopTelemetryClient(),
+) {
+  const newConfig = {
+    dataDirectory: config.worldStateDataDirectory ?? config.dataDirectory,
+    dataStoreMapSizeKB: config.worldStateDbMapSizeKb ?? config.dataStoreMapSizeKB,
+  } as DataStoreConfig;
   const merkleTrees = ['true', '1'].includes(process.env.USE_LEGACY_WORLD_STATE ?? '')
     ? await MerkleTrees.new(
-        await createStore('world-state', config, createDebugLogger('aztec:world-state:lmdb')),
+        await createStore('world-state', newConfig, createDebugLogger('aztec:world-state:lmdb')),
         client,
       )
-    : config.dataDirectory
-    ? await NativeWorldStateService.new(config.l1Contracts.rollupAddress, config.dataDirectory)
+    : newConfig.dataDirectory
+    ? await NativeWorldStateService.new(
+        config.l1Contracts.rollupAddress,
+        newConfig.dataDirectory,
+        newConfig.dataStoreMapSizeKB,
+      )
     : await NativeWorldStateService.tmp(
         config.l1Contracts.rollupAddress,
         !['true', '1'].includes(process.env.DEBUG_WORLD_STATE!),

package/src/synchronizer/server_world_state_synchronizer.ts

@@ -24,7 +24,7 @@ import { promiseWithResolvers } from '@aztec/foundation/promise';
 import { elapsed } from '@aztec/foundation/timer';
 import { SHA256Trunc } from '@aztec/merkle-tree';
 
-import { type WorldStateStatus } from '../native/message.js';
+import { type WorldStateStatusSummary } from '../native/message.js';
 import { type MerkleTreeAdminDatabase } from '../world-state-db/merkle_tree_db.js';
 import { type WorldStateConfig } from './config.js';
 
@@ -163,7 +163,7 @@ export class ServerWorldStateSynchronizer
 
   /** Returns the latest L2 block number for each tip of the chain (latest, proven, finalized). */
   public async getL2Tips(): Promise<L2Tips> {
-    const status = await this.merkleTreeDb.getStatus();
+    const status = await this.merkleTreeDb.getStatusSummary();
     const unfinalisedBlockHash = await this.getL2BlockHash(Number(status.unfinalisedBlockNumber));
     const latestBlockId: L2BlockId = { number: Number(status.unfinalisedBlockNumber), hash: unfinalisedBlockHash! };
 
@@ -225,7 +225,7 @@ export class ServerWorldStateSynchronizer
    * @param l1ToL2Messages - The L1 to L2 messages for the block.
    * @returns Whether the block handled was produced by this same node.
    */
-  private async handleL2Block(l2Block: L2Block, l1ToL2Messages: Fr[]): Promise<WorldStateStatus> {
+  private async handleL2Block(l2Block: L2Block, l1ToL2Messages: Fr[]): Promise<WorldStateStatusSummary> {
     // First we check that the L1 to L2 messages hash to the block inHash.
     // Note that we cannot optimize this check by checking the root of the subtree after inserting the messages
     // to the real L1_TO_L2_MESSAGE_TREE (like we do in merkleTreeDb.handleL2BlockAndMessages(...)) because that
@@ -240,7 +240,7 @@ export class ServerWorldStateSynchronizer
       this.syncPromise.resolve();
     }
 
-    return result;
+    return result.summary;
   }
 
   private async handleChainFinalized(blockNumber: number) {

package/src/test/utils.ts

@@ -3,7 +3,6 @@ import {
   MerkleTreeId,
   type MerkleTreeReadOperations,
   type MerkleTreeWriteOperations,
-  PublicDataWrite,
   TxEffect,
 } from '@aztec/circuit-types';
 import {
@@ -15,7 +14,7 @@ import {
   NULLIFIER_SUBTREE_HEIGHT,
   NUMBER_OF_L1_L2_MESSAGES_PER_ROLLUP,
   PUBLIC_DATA_SUBTREE_HEIGHT,
-  PublicDataTreeLeaf,
+  PublicDataWrite,
 } from '@aztec/circuits.js';
 import { padArrayEnd } from '@aztec/foundation/collection';
 
@@ -54,7 +53,7 @@ export async function mockBlock(blockNum: number, size: number, fork: MerkleTree
 
       await fork.batchInsert(
         MerkleTreeId.PUBLIC_DATA_TREE,
-        publicDataWrites.map(write => new PublicDataTreeLeaf(write.leafIndex, write.newValue).toBuffer()),
+        publicDataWrites.map(write => write.toBuffer()),
         PUBLIC_DATA_SUBTREE_HEIGHT,
       );
 

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

@@ -3,7 +3,7 @@ import { type MerkleTreeReadOperations, type MerkleTreeWriteOperations } from '@
 import { type Fr, MAX_NULLIFIERS_PER_TX, MAX_TOTAL_PUBLIC_DATA_UPDATE_REQUESTS_PER_TX } from '@aztec/circuits.js';
 import { type IndexedTreeSnapshot, type TreeSnapshot } from '@aztec/merkle-tree';
 
-import { type WorldStateStatus } from '../native/message.js';
+import { type WorldStateStatusFull, type WorldStateStatusSummary } from '../native/message.js';
 
 /**
  *
@@ -38,7 +38,7 @@ export interface MerkleTreeAdminDatabase {
    * @param block - The L2 block to handle.
    * @param l1ToL2Messages - The L1 to L2 messages for the block.
    */
-  handleL2BlockAndMessages(block: L2Block, l1ToL2Messages: Fr[]): Promise<WorldStateStatus>;
+  handleL2BlockAndMessages(block: L2Block, l1ToL2Messages: Fr[]): Promise<WorldStateStatusFull>;
 
   /**
    * Gets a handle that allows reading the latest committed state
@@ -62,27 +62,27 @@ export interface MerkleTreeAdminDatabase {
    * @param toBlockNumber The block number of the new oldest historical block
    * @returns The new WorldStateStatus
    */
-  removeHistoricalBlocks(toBlockNumber: bigint): Promise<WorldStateStatus>;
+  removeHistoricalBlocks(toBlockNumber: bigint): 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<WorldStateStatus>;
+  unwindBlocks(toBlockNumber: bigint): 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
    * @returns The new WorldStateStatus
    */
-  setFinalised(toBlockNumber: bigint): Promise<WorldStateStatus>;
+  setFinalised(toBlockNumber: bigint): Promise<WorldStateStatusSummary>;
 
   /**
-   * Gets the current status of the database.
+   * Gets the current status summary of the database.
    * @returns The current WorldStateStatus.
    */
-  getStatus(): Promise<WorldStateStatus>;
+  getStatusSummary(): Promise<WorldStateStatusSummary>;
 
   /** Stops the database */
   close(): Promise<void>;

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

@@ -1,4 +1,4 @@
-import { type L2Block, MerkleTreeId, PublicDataWrite, type SiblingPath, TxEffect } from '@aztec/circuit-types';
+import { type L2Block, MerkleTreeId, type SiblingPath, TxEffect } from '@aztec/circuit-types';
 import {
   type BatchInsertionResult,
   type IndexedTreeId,
@@ -27,6 +27,7 @@ import {
   PartialStateReference,
   PublicDataTreeLeaf,
   PublicDataTreeLeafPreimage,
+  PublicDataWrite,
   StateReference,
 } from '@aztec/circuits.js';
 import { padArrayEnd } from '@aztec/foundation/collection';
@@ -50,7 +51,11 @@ import { type TelemetryClient } from '@aztec/telemetry-client';
 import { NoopTelemetryClient } from '@aztec/telemetry-client/noop';
 import { type Hasher } from '@aztec/types/interfaces';
 
-import { type WorldStateStatus } from '../native/message.js';
+import {
+  type WorldStateStatusFull,
+  type WorldStateStatusSummary,
+  buildEmptyWorldStateStatusFull,
+} from '../native/message.js';
 import {
   INITIAL_NULLIFIER_TREE_SIZE,
   INITIAL_PUBLIC_DATA_TREE_SIZE,
@@ -197,19 +202,19 @@ export class MerkleTrees implements MerkleTreeAdminDatabase {
     }
   }
 
-  public removeHistoricalBlocks(_toBlockNumber: bigint): Promise<WorldStateStatus> {
+  public removeHistoricalBlocks(_toBlockNumber: bigint): Promise<WorldStateStatusFull> {
     throw new Error('Method not implemented.');
   }
 
-  public unwindBlocks(_toBlockNumber: bigint): Promise<WorldStateStatus> {
+  public unwindBlocks(_toBlockNumber: bigint): Promise<WorldStateStatusFull> {
     throw new Error('Method not implemented.');
   }
 
-  public setFinalised(_toBlockNumber: bigint): Promise<WorldStateStatus> {
+  public setFinalised(_toBlockNumber: bigint): Promise<WorldStateStatusSummary> {
     throw new Error('Method not implemented.');
   }
 
-  public getStatus(): Promise<WorldStateStatus> {
+  public getStatusSummary(): Promise<WorldStateStatusSummary> {
     throw new Error('Method not implemented.');
   }
 
@@ -466,7 +471,7 @@ export class MerkleTrees implements MerkleTreeAdminDatabase {
    * @param l1ToL2Messages - The L1 to L2 messages for the block.
    * @returns Whether the block handled was produced by this same node.
    */
-  public async handleL2BlockAndMessages(block: L2Block, l1ToL2Messages: Fr[]): Promise<WorldStateStatus> {
+  public async handleL2BlockAndMessages(block: L2Block, l1ToL2Messages: Fr[]): Promise<WorldStateStatusFull> {
     return await this.synchronize(() => this.#handleL2BlockAndMessages(block, l1ToL2Messages));
   }
 
@@ -616,7 +621,7 @@ export class MerkleTrees implements MerkleTreeAdminDatabase {
    * @param l2Block - The L2 block to handle.
    * @param l1ToL2Messages - The L1 to L2 messages for the block.
    */
-  async #handleL2BlockAndMessages(l2Block: L2Block, l1ToL2Messages: Fr[]): Promise<WorldStateStatus> {
+  async #handleL2BlockAndMessages(l2Block: L2Block, l1ToL2Messages: Fr[]): Promise<WorldStateStatusFull> {
     const timer = new Timer();
 
     const treeRootWithIdPairs = [
@@ -678,7 +683,7 @@ export class MerkleTrees implements MerkleTreeAdminDatabase {
           );
 
           await publicDataTree.batchInsert(
-            publicDataWrites.map(write => new PublicDataTreeLeaf(write.leafIndex, write.newValue).toBuffer()),
+            publicDataWrites.map(write => write.toBuffer()),
             PUBLIC_DATA_SUBTREE_HEIGHT,
           );
         }
@@ -709,7 +714,7 @@ export class MerkleTrees implements MerkleTreeAdminDatabase {
 
     this.metrics.recordDbSize(this.store.estimateSize().bytes);
     this.metrics.recordSyncDuration('commit', timer);
-    return { unfinalisedBlockNumber: 0n, finalisedBlockNumber: 0n, oldestHistoricalBlock: 0n } as WorldStateStatus;
+    return buildEmptyWorldStateStatusFull();
   }
 
   #isDbPopulated(): boolean {