@aztec/world-state 0.0.1-commit.3100065 → 0.0.1-commit.321f6a9

package/src/native/native_world_state.ts

@@ -3,7 +3,6 @@ import { BlockNumber } from '@aztec/foundation/branded-types';
 import { fromEntries, padArrayEnd } from '@aztec/foundation/collection';
 import { Fr } from '@aztec/foundation/curves/bn254';
 import { EthAddress } from '@aztec/foundation/eth-address';
-import { tryRmDir } from '@aztec/foundation/fs';
 import { type Logger, type LoggerBindings, createLogger } from '@aztec/foundation/log';
 import type { L2Block } from '@aztec/stdlib/block';
 import { DatabaseVersionManager } from '@aztec/stdlib/database-version/manager';
@@ -19,16 +18,16 @@ import { EMPTY_GENESIS_DATA, type GenesisData, WorldStateRevision } from '@aztec
 import { getTelemetryClient } from '@aztec/telemetry-client';
 
 import assert from 'assert/strict';
-import { mkdtemp, rm } from 'fs/promises';
+import { mkdir, mkdtemp, rm } from 'fs/promises';
 import { tmpdir } from 'os';
 import { join } from 'path';
 
 import { WorldStateInstrumentation } from '../instrumentation/instrumentation.js';
 import type { WorldStateTreeMapSizes } from '../synchronizer/factory.js';
 import type { MerkleTreeAdminDatabase as MerkleTreeDatabase } from '../world-state-db/merkle_tree_db.js';
+import { IpcWorldState } from './ipc_world_state_instance.js';
 import { MerkleTreesFacade, MerkleTreesForkFacade, serializeLeaf } from './merkle_trees_facade.js';
 import {
-  WorldStateMessageType,
   type WorldStateStatusFull,
   type WorldStateStatusSummary,
   blockStateReference,
@@ -36,7 +35,7 @@ import {
   sanitizeSummary,
   treeStateReferenceToSnapshot,
 } from './message.js';
-import { NativeWorldState } from './native_world_state_instance.js';
+import type { NativeWorldStateInstance } from './native_world_state_instance.js';
 
 // The current version of the world state database schema
 // Increment this when making incompatible changes to the database schema
@@ -44,47 +43,21 @@ export const WORLD_STATE_DB_VERSION = 2; // The initial version
 
 export const WORLD_STATE_DIR = 'world_state';
 
-const DEFAULT_TMP_TREE_MAP_SIZE_KB = 10 * 1024 * 1024;
-
-/**
- * Sets up a fresh `mkdtemp` directory + default `WorldStateTreeMapSizes` shared by both
- * the `.tmp` (fsync-on) and `.ephemeral` (fsync-off) factories. Returns the raw tmpdir,
- * the tree map sizes, and the package logger.
- */
-async function createTmpWorldStateDir(
-  bindings?: LoggerBindings,
-): Promise<{ dataDir: string; wsTreeMapSizes: WorldStateTreeMapSizes; log: Logger }> {
-  const log = createLogger('world-state:database', bindings);
-  const dataDir = await mkdtemp(join(tmpdir(), 'aztec-world-state-'));
-  const wsTreeMapSizes: WorldStateTreeMapSizes = {
-    archiveTreeMapSizeKb: DEFAULT_TMP_TREE_MAP_SIZE_KB,
-    nullifierTreeMapSizeKb: DEFAULT_TMP_TREE_MAP_SIZE_KB,
-    noteHashTreeMapSizeKb: DEFAULT_TMP_TREE_MAP_SIZE_KB,
-    messageTreeMapSizeKb: DEFAULT_TMP_TREE_MAP_SIZE_KB,
-    publicDataTreeMapSizeKb: DEFAULT_TMP_TREE_MAP_SIZE_KB,
-  };
-  log.debug(`Created temporary world state database at: ${dataDir} (map size ${DEFAULT_TMP_TREE_MAP_SIZE_KB} KB)`);
-  return { dataDir, wsTreeMapSizes, log };
-}
-
 export class NativeWorldStateService implements MerkleTreeDatabase {
   protected initialHeader: BlockHeader | undefined;
   // This is read heavily and only changes when data is persisted, so we cache it
   private cachedStatusSummary: WorldStateStatusSummary | undefined;
 
   protected constructor(
-    protected instance: NativeWorldState,
+    protected instance: NativeWorldStateInstance,
     protected readonly worldStateInstrumentation: WorldStateInstrumentation,
     protected readonly log: Logger,
     private readonly genesis: GenesisData = EMPTY_GENESIS_DATA,
     private readonly cleanup = () => Promise.resolve(),
+    /** Factory to recreate a fresh IpcWorldState after clear(). */
+    private readonly recreateInstance?: () => Promise<NativeWorldStateInstance>,
   ) {}
 
-  /**
-   * Opens a persistent world state at `dataDir`. Goes through `DatabaseVersionManager` so the
-   * caller's rollup address is bound to the on-disk schema and incompatible versions surface
-   * loudly. The LMDB envs commit with full fsync.
-   */
   static async new(
     rollupAddress: EthAddress,
     dataDir: string,
@@ -94,28 +67,31 @@ export class NativeWorldStateService implements MerkleTreeDatabase {
     bindings?: LoggerBindings,
     cleanup = () => Promise.resolve(),
   ): Promise<NativeWorldStateService> {
+    for (const [key, value] of Object.entries(wsTreeMapSizes)) {
+      if (value <= 0) {
+        throw new Error(`Map size must be a positive number, got ${value} for ${key}`);
+      }
+    }
+
     const log = createLogger('world-state:database', bindings);
     const worldStateDirectory = join(dataDir, WORLD_STATE_DIR);
+
     const versionManager = new DatabaseVersionManager({
       schemaVersion: WORLD_STATE_DB_VERSION,
       rollupAddress,
       dataDirectory: worldStateDirectory,
-      onOpen: (dir: string) =>
-        Promise.resolve(
-          new NativeWorldState(
-            dir,
-            wsTreeMapSizes,
-            genesis,
-            instrumentation,
-            bindings,
-            undefined,
-            /*ephemeral=*/ false,
-          ),
-        ),
+      onOpen: dir => IpcWorldState.spawn(dir, wsTreeMapSizes, genesis, instrumentation, bindings),
     });
 
     const [instance] = await versionManager.open();
-    const worldState = new this(instance, instrumentation, log, genesis, cleanup);
+
+    const recreateInstance = async () => {
+      await rm(worldStateDirectory, { recursive: true, force: true, maxRetries: 3 });
+      await mkdir(worldStateDirectory, { recursive: true });
+      return IpcWorldState.spawn(worldStateDirectory, wsTreeMapSizes, genesis, instrumentation, bindings);
+    };
+
+    const worldState = new this(instance, instrumentation, log, genesis, cleanup, recreateInstance);
     try {
       await worldState.init();
     } catch (e) {
@@ -126,23 +102,38 @@ export class NativeWorldStateService implements MerkleTreeDatabase {
     return worldState;
   }
 
-  /**
-   * Opens a world state in a fresh tmpdir with full fsync semantics. Use when you need the
-   * on-disk file to remain crash-recoverable (e.g. for snapshot/backup tests) but don't
-   * want a persistent dataDir. Pass `cleanupTmpDir=false` to keep the directory after
-   * close for inspection.
-   *
-   * If you don't care about crash-recoverability — i.e. you just want a fast scratch
-   * database for tests — use {@link ephemeral} instead.
-   */
   static async tmp(
-    rollupAddress = EthAddress.ZERO,
     cleanupTmpDir = true,
     genesis: GenesisData = EMPTY_GENESIS_DATA,
     instrumentation = new WorldStateInstrumentation(getTelemetryClient()),
     bindings?: LoggerBindings,
+    threads?: number,
   ): Promise<NativeWorldStateService> {
-    const { dataDir, wsTreeMapSizes, log } = await createTmpWorldStateDir(bindings);
+    const log = createLogger('world-state:database', bindings);
+    const dataDir = await mkdtemp(join(tmpdir(), 'aztec-world-state-'));
+    // Temporary (test/dev) world states are small and short-lived. Keep the LMDB
+    // map sizes in the MB range: with the IPC backend each tmp() spawns a separate
+    // aztec-wsdb that maps these per tree, and oversized maps add real cold-start
+    // I/O under parallel CI load. 256 MB/tree is ample for tests.
+    const dbMapSizeKb = 256 * 1024;
+    const worldStateTreeMapSizes: WorldStateTreeMapSizes = {
+      archiveTreeMapSizeKb: dbMapSizeKb,
+      nullifierTreeMapSizeKb: dbMapSizeKb,
+      noteHashTreeMapSizeKb: dbMapSizeKb,
+      messageTreeMapSizeKb: dbMapSizeKb,
+      publicDataTreeMapSizeKb: dbMapSizeKb,
+    };
+    log.debug(`Created temporary world state database at: ${dataDir} with tree map size: ${dbMapSizeKb}`);
+
+    const instance = await IpcWorldState.spawn(
+      dataDir,
+      worldStateTreeMapSizes,
+      genesis,
+      instrumentation,
+      bindings,
+      threads,
+    );
+
     const cleanup = async () => {
       if (cleanupTmpDir) {
         await rm(dataDir, { recursive: true, force: true, maxRetries: 3 });
@@ -151,47 +142,50 @@ export class NativeWorldStateService implements MerkleTreeDatabase {
         log.debug(`Leaving temporary world state database: ${dataDir}`);
       }
     };
-    return this.new(rollupAddress, dataDir, wsTreeMapSizes, genesis, instrumentation, bindings, cleanup);
-  }
 
-  /**
-   * Opens a fully-ephemeral world state. The directory is created in `os.tmpdir()`, the LMDB
-   * envs open with `MDB_NOSYNC | MDB_NOMETASYNC` so commits never block on fsync, and the
-   * directory is removed on dispose. A crash mid-write leaves the env unrecoverable.
-   *
-   * For unit tests and other isolated runs. Use {@link tmp} when you need fsync semantics in a
-   * tmp dir, and {@link new} for a persistent store. Skips {@link DatabaseVersionManager} —
-   * there is no on-disk schema to bind to and no rollup address is taken.
-   */
-  static async ephemeral(
-    genesis: GenesisData = EMPTY_GENESIS_DATA,
-    instrumentation = new WorldStateInstrumentation(getTelemetryClient()),
-    bindings?: LoggerBindings,
-  ): Promise<NativeWorldStateService> {
-    const { dataDir, wsTreeMapSizes, log } = await createTmpWorldStateDir(bindings);
-    const cleanup = async () => {
+    const recreateInstance = async () => {
       await rm(dataDir, { recursive: true, force: true, maxRetries: 3 });
-      log.debug(`Deleted ephemeral world state database: ${dataDir}`);
+      await mkdir(dataDir, { recursive: true });
+      return IpcWorldState.spawn(dataDir, worldStateTreeMapSizes, genesis, instrumentation, bindings, threads);
     };
-    const instance = new NativeWorldState(
-      join(dataDir, WORLD_STATE_DIR),
-      wsTreeMapSizes,
-      genesis,
-      instrumentation,
-      bindings,
-      undefined,
-      /*ephemeral=*/ true,
-    );
-    const worldState = new this(instance, instrumentation, log, genesis, cleanup);
+
+    const worldState = new this(instance, instrumentation, log, genesis, cleanup, recreateInstance);
     try {
       await worldState.init();
     } catch (e) {
-      log.error(`Error initializing ephemeral world state: ${e}`);
+      log.error(`Error initializing tmp world state: ${e}`);
       throw e;
     }
     return worldState;
   }
 
+  static ephemeral(
+    genesis: GenesisData = EMPTY_GENESIS_DATA,
+    instrumentation = new WorldStateInstrumentation(getTelemetryClient()),
+    bindings?: LoggerBindings,
+  ): Promise<NativeWorldStateService> {
+    // The TXE spins up one tiny, short-lived world state per test, many concurrently. Cap the wsdb thread
+    // usage to the minimum: a single tree-op thread instead of one per core (the C++ IPC dispatcher pool
+    // still floors at 2). This avoids ~32 threads per wsdb multiplied across dozens of concurrent test
+    // world states — the trees are cache-sized (see tmp's map-size note), so extra threads buy nothing.
+    return this.tmp(/*cleanupTmpDir=*/ true, genesis, instrumentation, bindings, /*threads=*/ 1);
+  }
+
+  static async fromIpc(
+    wsdbBackend: ConstructorParameters<typeof IpcWorldState>[0],
+    instrumentation = new WorldStateInstrumentation(getTelemetryClient()),
+    bindings?: LoggerBindings,
+    genesis: GenesisData = EMPTY_GENESIS_DATA,
+    cleanup = () => Promise.resolve(),
+    recreateInstance?: () => Promise<NativeWorldStateInstance>,
+  ): Promise<NativeWorldStateService> {
+    const log = createLogger('world-state:database', bindings);
+    const instance = new IpcWorldState(wsdbBackend, instrumentation, bindings);
+    const worldState = new this(instance, instrumentation, log, genesis, cleanup, recreateInstance);
+    await worldState.init();
+    return worldState;
+  }
+
   protected async init() {
     const status = await this.getStatusSummary();
     if (!status.treesAreSynched) {
@@ -213,11 +207,24 @@ export class NativeWorldStateService implements MerkleTreeDatabase {
     assert.strictEqual(initialHeaderIndex, 0n, 'Invalid initial archive state');
   }
 
-  public async clear() {
+  public async clear(): Promise<void> {
+    if (!this.recreateInstance) {
+      throw new Error('clear() is not available for externally-managed IPC backends');
+    }
+    this.log.warn('Clearing world state: shutting down WSDB, deleting data, and recreating');
     await this.instance.close();
     this.cachedStatusSummary = undefined;
-    await tryRmDir(this.instance.getDataDir(), this.log);
-    this.instance = this.instance.clone();
+    this.instance = await this.recreateInstance();
+    await this.init();
+    this.log.info('World state cleared and reinitialized from genesis');
+  }
+
+  /** Returns the IPC path of the underlying IPC backend, if available. */
+  public getIpcPath(): string {
+    if (this.instance instanceof IpcWorldState) {
+      return this.instance.getIpcPath();
+    }
+    throw new Error('getIpcPath() is only available with IPC world state');
   }
 
   public getCommitted(): MerkleTreeReadOperations {
@@ -236,16 +243,15 @@ export class NativeWorldStateService implements MerkleTreeDatabase {
     blockNumber?: BlockNumber,
     opts: { closeDelayMs?: number } = {},
   ): Promise<MerkleTreeWriteOperations> {
-    const resp = await this.instance.call(WorldStateMessageType.CREATE_FORK, {
+    const forkId = await this.instance.createFork({
       latest: blockNumber === undefined,
       blockNumber: blockNumber ?? BlockNumber.ZERO,
-      canonical: true,
     });
     return new MerkleTreesForkFacade(
       this.instance,
       this.initialHeader!,
       new WorldStateRevision(
-        /*forkId=*/ resp.forkId,
+        /*forkId=*/ forkId,
         /* blockNumber=*/ WorldStateRevision.LATEST,
         /* includeUncommitted=*/ true,
       ),
@@ -289,33 +295,36 @@ export class NativeWorldStateService implements MerkleTreeDatabase {
     });
 
     try {
-      return await this.instance.call(
-        WorldStateMessageType.SYNC_BLOCK,
-        {
-          blockNumber: l2Block.number,
-          blockHeaderHash: (await l2Block.hash()).toBuffer(),
-          // Forwarded so the native sync verifies the archive root against canonical and rejects a divergent tree.
-          expectedArchiveRoot: l2Block.archive.root.toBuffer(),
-          expectedPreviousArchiveRoot: l2Block.header.lastArchive.root.toBuffer(),
-          paddedL1ToL2Messages: paddedL1ToL2Messages.map(serializeLeaf),
-          paddedNoteHashes: paddedNoteHashes.map(serializeLeaf),
-          paddedNullifiers: paddedNullifiers.map(serializeLeaf),
-          publicDataWrites: publicDataWrites.map(serializeLeaf),
-          blockStateRef: blockStateReference(l2Block.header.state),
-          canonical: true,
-        },
-        this.sanitizeAndCacheSummaryFromFull.bind(this),
-        this.deleteCachedSummary.bind(this),
-      );
+      const status = await this.instance.syncBlock({
+        blockNumber: l2Block.number,
+        blockHeaderHash: (await l2Block.hash()).toBuffer(),
+        // Forwarded so the native sync verifies the archive root against canonical and rejects a divergent tree.
+        expectedArchiveRoot: l2Block.archive.root.toBuffer(),
+        expectedPreviousArchiveRoot: l2Block.header.lastArchive.root.toBuffer(),
+        paddedL1ToL2Messages: paddedL1ToL2Messages.map(serializeLeaf),
+        paddedNoteHashes: paddedNoteHashes.map(serializeLeaf),
+        paddedNullifiers: paddedNullifiers.map(serializeLeaf),
+        publicDataWrites: publicDataWrites.map(serializeLeaf),
+        blockStateRef: blockStateReference(l2Block.header.state),
+      });
+      return this.sanitizeAndCacheSummaryFromFull(status);
     } catch (err) {
+      this.deleteCachedSummary();
       this.worldStateInstrumentation.incCriticalErrors('synch_pending_block');
       throw err;
     }
   }
 
   public async close(): Promise<void> {
-    await this.instance.close();
-    await this.cleanup();
+    try {
+      await this.instance.close();
+    } finally {
+      await this.cleanup();
+    }
+  }
+
+  async [Symbol.asyncDispose](): Promise<void> {
+    await this.close();
   }
 
   private async buildInitialHeader(): Promise<BlockHeader> {
@@ -338,7 +347,7 @@ export class NativeWorldStateService implements MerkleTreeDatabase {
     return sanitized;
   }
 
-  private deleteCachedSummary(_: string) {
+  private deleteCachedSummary() {
     this.cachedStatusSummary = undefined;
   }
 
@@ -349,16 +358,9 @@ export class NativeWorldStateService implements MerkleTreeDatabase {
    */
   public async setFinalized(toBlockNumber: BlockNumber) {
     try {
-      await this.instance.call(
-        WorldStateMessageType.FINALIZE_BLOCKS,
-        {
-          toBlockNumber,
-          canonical: true,
-        },
-        this.sanitizeAndCacheSummary.bind(this),
-        this.deleteCachedSummary.bind(this),
-      );
+      this.sanitizeAndCacheSummary(await this.instance.finalizeBlocks(toBlockNumber));
     } catch (err) {
+      this.deleteCachedSummary();
       this.worldStateInstrumentation.incCriticalErrors('finalize_block');
       throw err;
     }
@@ -372,16 +374,9 @@ export class NativeWorldStateService implements MerkleTreeDatabase {
    */
   public async removeHistoricalBlocks(toBlockNumber: BlockNumber) {
     try {
-      return await this.instance.call(
-        WorldStateMessageType.REMOVE_HISTORICAL_BLOCKS,
-        {
-          toBlockNumber,
-          canonical: true,
-        },
-        this.sanitizeAndCacheSummaryFromFull.bind(this),
-        this.deleteCachedSummary.bind(this),
-      );
+      return this.sanitizeAndCacheSummaryFromFull(await this.instance.removeHistoricalBlocks(toBlockNumber));
     } catch (err) {
+      this.deleteCachedSummary();
       this.worldStateInstrumentation.incCriticalErrors('prune_historical_block');
       throw err;
     }
@@ -394,16 +389,9 @@ export class NativeWorldStateService implements MerkleTreeDatabase {
    */
   public async unwindBlocks(toBlockNumber: BlockNumber) {
     try {
-      return await this.instance.call(
-        WorldStateMessageType.UNWIND_BLOCKS,
-        {
-          toBlockNumber,
-          canonical: true,
-        },
-        this.sanitizeAndCacheSummaryFromFull.bind(this),
-        this.deleteCachedSummary.bind(this),
-      );
+      return this.sanitizeAndCacheSummaryFromFull(await this.instance.unwindBlocks(toBlockNumber));
     } catch (err) {
+      this.deleteCachedSummary();
       this.worldStateInstrumentation.incCriticalErrors('prune_pending_block');
       throw err;
     }
@@ -413,11 +401,7 @@ export class NativeWorldStateService implements MerkleTreeDatabase {
     if (this.cachedStatusSummary !== undefined) {
       return { ...this.cachedStatusSummary };
     }
-    return await this.instance.call(
-      WorldStateMessageType.GET_STATUS,
-      { canonical: true },
-      this.sanitizeAndCacheSummary.bind(this),
-    );
+    return this.sanitizeAndCacheSummary(await this.instance.getStatus());
   }
 
   updateLeaf<ID extends IndexedTreeId>(
@@ -429,14 +413,14 @@ export class NativeWorldStateService implements MerkleTreeDatabase {
   }
 
   private async getInitialStateReference(): Promise<StateReference> {
-    const resp = await this.instance.call(WorldStateMessageType.GET_INITIAL_STATE_REFERENCE, { canonical: true });
+    const state = await this.instance.getInitialStateReference();
 
     return new StateReference(
-      treeStateReferenceToSnapshot(resp.state[MerkleTreeId.L1_TO_L2_MESSAGE_TREE]),
+      treeStateReferenceToSnapshot(state[MerkleTreeId.L1_TO_L2_MESSAGE_TREE]),
       new PartialStateReference(
-        treeStateReferenceToSnapshot(resp.state[MerkleTreeId.NOTE_HASH_TREE]),
-        treeStateReferenceToSnapshot(resp.state[MerkleTreeId.NULLIFIER_TREE]),
-        treeStateReferenceToSnapshot(resp.state[MerkleTreeId.PUBLIC_DATA_TREE]),
+        treeStateReferenceToSnapshot(state[MerkleTreeId.NOTE_HASH_TREE]),
+        treeStateReferenceToSnapshot(state[MerkleTreeId.NULLIFIER_TREE]),
+        treeStateReferenceToSnapshot(state[MerkleTreeId.PUBLIC_DATA_TREE]),
       ),
     );
   }
@@ -445,11 +429,7 @@ export class NativeWorldStateService implements MerkleTreeDatabase {
     dstPath: string,
     compact: boolean = true,
   ): Promise<Record<Exclude<SnapshotDataKeys, 'archiver'>, string>> {
-    await this.instance.call(WorldStateMessageType.COPY_STORES, {
-      dstPath,
-      compact,
-      canonical: true,
-    });
+    await this.instance.copyStores(dstPath, compact);
     return fromEntries(NATIVE_WORLD_STATE_DBS.map(([name, dir]) => [name, join(dstPath, dir, 'data.mdb')] as const));
   }
 }