@aztec/world-state 0.0.1-commit.b655e406 → 0.0.1-commit.b9865e97

package/dest/native/native_world_state.js

@@ -1,53 +1,72 @@
+var _computedKey;
 import { MAX_NOTE_HASHES_PER_TX, MAX_NULLIFIERS_PER_TX, NUMBER_OF_L1_L2_MESSAGES_PER_ROLLUP } from '@aztec/constants';
+import { BlockNumber } from '@aztec/foundation/branded-types';
 import { fromEntries, padArrayEnd } from '@aztec/foundation/collection';
-import { EthAddress } from '@aztec/foundation/eth-address';
-import { Fr } from '@aztec/foundation/fields';
-import { tryRmDir } from '@aztec/foundation/fs';
+import { Fr } from '@aztec/foundation/curves/bn254';
 import { createLogger } from '@aztec/foundation/log';
-import { DatabaseVersionManager } from '@aztec/stdlib/database-version';
+import { DatabaseVersionManager } from '@aztec/stdlib/database-version/manager';
 import { MerkleTreeId, NullifierLeaf, PublicDataTreeLeaf } from '@aztec/stdlib/trees';
-import { BlockHeader, PartialStateReference, StateReference } from '@aztec/stdlib/tx';
-import { WorldStateRevision } from '@aztec/stdlib/world-state';
+import { BlockHeader, GlobalVariables, PartialStateReference, StateReference } from '@aztec/stdlib/tx';
+import { EMPTY_GENESIS_DATA, WorldStateRevision } from '@aztec/stdlib/world-state';
 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 { IpcWorldState } from './ipc_world_state_instance.js';
 import { MerkleTreesFacade, MerkleTreesForkFacade, serializeLeaf } from './merkle_trees_facade.js';
-import { WorldStateMessageType, blockStateReference, sanitizeFullStatus, sanitizeSummary, treeStateReferenceToSnapshot } from './message.js';
-import { NativeWorldState } from './native_world_state_instance.js';
+import { blockStateReference, sanitizeFullStatus, sanitizeSummary, treeStateReferenceToSnapshot } from './message.js';
 // The current version of the world state database schema
 // Increment this when making incompatible changes to the database schema
 export const WORLD_STATE_DB_VERSION = 2; // The initial version
 export const WORLD_STATE_DIR = 'world_state';
+_computedKey = Symbol.asyncDispose;
 export class NativeWorldStateService {
     instance;
     worldStateInstrumentation;
     log;
+    genesis;
     cleanup;
+    recreateInstance;
     initialHeader;
     // This is read heavily and only changes when data is persisted, so we cache it
     cachedStatusSummary;
-    constructor(instance, worldStateInstrumentation, log = createLogger('world-state:database'), cleanup = ()=>Promise.resolve()){
+    constructor(instance, worldStateInstrumentation, log, genesis = EMPTY_GENESIS_DATA, cleanup = ()=>Promise.resolve(), /** Factory to recreate a fresh IpcWorldState after clear(). */ recreateInstance){
         this.instance = instance;
         this.worldStateInstrumentation = worldStateInstrumentation;
         this.log = log;
+        this.genesis = genesis;
         this.cleanup = cleanup;
+        this.recreateInstance = recreateInstance;
     }
-    static async new(rollupAddress, dataDir, wsTreeMapSizes, prefilledPublicData = [], instrumentation = new WorldStateInstrumentation(getTelemetryClient()), log = createLogger('world-state:database'), cleanup = ()=>Promise.resolve()) {
+    static async new(rollupAddress, dataDir, wsTreeMapSizes, genesis = EMPTY_GENESIS_DATA, instrumentation = new WorldStateInstrumentation(getTelemetryClient()), bindings, cleanup = ()=>Promise.resolve()) {
+        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);
-        // Create a version manager to handle versioning
         const versionManager = new DatabaseVersionManager({
             schemaVersion: WORLD_STATE_DB_VERSION,
             rollupAddress,
             dataDirectory: worldStateDirectory,
-            onOpen: (dir)=>{
-                return Promise.resolve(new NativeWorldState(dir, wsTreeMapSizes, prefilledPublicData, instrumentation));
-            }
+            onOpen: (dir)=>IpcWorldState.spawn(dir, wsTreeMapSizes, genesis, instrumentation, bindings)
         });
         const [instance] = await versionManager.open();
-        const worldState = new this(instance, instrumentation, log, 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) {
@@ -56,10 +75,14 @@ export class NativeWorldStateService {
         }
         return worldState;
     }
-    static async tmp(rollupAddress = EthAddress.ZERO, cleanupTmpDir = true, prefilledPublicData = [], instrumentation = new WorldStateInstrumentation(getTelemetryClient())) {
-        const log = createLogger('world-state:database');
+    static async tmp(cleanupTmpDir = true, genesis = EMPTY_GENESIS_DATA, instrumentation = new WorldStateInstrumentation(getTelemetryClient()), bindings) {
+        const log = createLogger('world-state:database', bindings);
         const dataDir = await mkdtemp(join(tmpdir(), 'aztec-world-state-'));
-        const dbMapSizeKb = 10 * 1024 * 1024;
+        // 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 = {
             archiveTreeMapSizeKb: dbMapSizeKb,
             nullifierTreeMapSizeKb: dbMapSizeKb,
@@ -68,7 +91,7 @@ export class NativeWorldStateService {
             publicDataTreeMapSizeKb: dbMapSizeKb
         };
         log.debug(`Created temporary world state database at: ${dataDir} with tree map size: ${dbMapSizeKb}`);
-        // pass a cleanup callback because process.on('beforeExit', cleanup) does not work under Jest
+        const instance = await IpcWorldState.spawn(dataDir, worldStateTreeMapSizes, genesis, instrumentation, bindings);
         const cleanup = async ()=>{
             if (cleanupTmpDir) {
                 await rm(dataDir, {
@@ -81,7 +104,35 @@ export class NativeWorldStateService {
                 log.debug(`Leaving temporary world state database: ${dataDir}`);
             }
         };
-        return this.new(rollupAddress, dataDir, worldStateTreeMapSizes, prefilledPublicData, instrumentation, log, cleanup);
+        const recreateInstance = async ()=>{
+            await rm(dataDir, {
+                recursive: true,
+                force: true,
+                maxRetries: 3
+            });
+            await mkdir(dataDir, {
+                recursive: true
+            });
+            return IpcWorldState.spawn(dataDir, worldStateTreeMapSizes, genesis, instrumentation, bindings);
+        };
+        const worldState = new this(instance, instrumentation, log, genesis, cleanup, recreateInstance);
+        try {
+            await worldState.init();
+        } catch (e) {
+            log.error(`Error initializing tmp world state: ${e}`);
+            throw e;
+        }
+        return worldState;
+    }
+    static ephemeral(genesis = EMPTY_GENESIS_DATA, instrumentation = new WorldStateInstrumentation(getTelemetryClient()), bindings) {
+        return this.tmp(/*cleanupTmpDir=*/ true, genesis, instrumentation, bindings);
+    }
+    static async fromIpc(wsdbBackend, instrumentation = new WorldStateInstrumentation(getTelemetryClient()), bindings, genesis = EMPTY_GENESIS_DATA, cleanup = ()=>Promise.resolve(), recreateInstance) {
+        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;
     }
     async init() {
         const status = await this.getStatusSummary();
@@ -104,10 +155,21 @@ export class NativeWorldStateService {
         assert.strictEqual(initialHeaderIndex, 0n, 'Invalid initial archive state');
     }
     async clear() {
+        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. */ getIpcPath() {
+        if (this.instance instanceof IpcWorldState) {
+            return this.instance.getIpcPath();
+        }
+        throw new Error('getIpcPath() is only available with IPC world state');
     }
     getCommitted() {
         return new MerkleTreesFacade(this.instance, this.initialHeader, WorldStateRevision.empty());
@@ -115,23 +177,25 @@ export class NativeWorldStateService {
     getSnapshot(blockNumber) {
         return new MerkleTreesFacade(this.instance, this.initialHeader, new WorldStateRevision(/*forkId=*/ 0, /* blockNumber=*/ blockNumber, /* includeUncommitted=*/ false));
     }
-    async fork(blockNumber) {
-        const resp = await this.instance.call(WorldStateMessageType.CREATE_FORK, {
+    async fork(blockNumber, opts = {}) {
+        const forkId = await this.instance.createFork({
             latest: blockNumber === undefined,
-            blockNumber: blockNumber ?? 0,
-            canonical: true
+            blockNumber: blockNumber ?? BlockNumber.ZERO
         });
-        return new MerkleTreesForkFacade(this.instance, this.initialHeader, new WorldStateRevision(/*forkId=*/ resp.forkId, /* blockNumber=*/ 0, /* includeUncommitted=*/ true));
+        return new MerkleTreesForkFacade(this.instance, this.initialHeader, new WorldStateRevision(/*forkId=*/ forkId, /* blockNumber=*/ WorldStateRevision.LATEST, /* includeUncommitted=*/ true), opts);
     }
     getInitialHeader() {
         return this.initialHeader;
     }
-    async handleL2BlockAndMessages(l2Block, l1ToL2Messages, // TODO(#17027)
-    // Temporary hack to only insert l1 to l2 messages for the first block in a checkpoint.
-    isFirstBlock = true) {
-        // We have to pad both the values within tx effects because that's how the trees are built by circuits.
-        const paddedNoteHashes = l2Block.body.txEffects.flatMap((txEffect)=>padArrayEnd(txEffect.noteHashes, Fr.ZERO, MAX_NOTE_HASHES_PER_TX));
+    async handleL2BlockAndMessages(l2Block, l1ToL2Messages) {
+        const isFirstBlock = l2Block.indexWithinCheckpoint === 0;
+        if (!isFirstBlock && l1ToL2Messages.length > 0) {
+            throw new Error(`L1 to L2 messages must be empty for non-first blocks, but got ${l1ToL2Messages.length} messages for block ${l2Block.number}.`);
+        }
+        // We have to pad the given l1 to l2 messages, and the note hashes and nullifiers within tx effects, because that's
+        // how the trees are built by circuits.
         const paddedL1ToL2Messages = isFirstBlock ? padArrayEnd(l1ToL2Messages, Fr.ZERO, NUMBER_OF_L1_L2_MESSAGES_PER_ROLLUP) : [];
+        const paddedNoteHashes = l2Block.body.txEffects.flatMap((txEffect)=>padArrayEnd(txEffect.noteHashes, Fr.ZERO, MAX_NOTE_HASHES_PER_TX));
         const paddedNullifiers = l2Block.body.txEffects.flatMap((txEffect)=>padArrayEnd(txEffect.nullifiers, Fr.ZERO, MAX_NULLIFIERS_PER_TX)).map((nullifier)=>new NullifierLeaf(nullifier));
         const publicDataWrites = l2Block.body.txEffects.flatMap((txEffect)=>{
             return txEffect.publicDataWrites.map((write)=>{
@@ -142,29 +206,39 @@ export class NativeWorldStateService {
             });
         });
         try {
-            return await this.instance.call(WorldStateMessageType.SYNC_BLOCK, {
+            const status = await this.instance.syncBlock({
                 blockNumber: l2Block.number,
-                blockHeaderHash: await l2Block.getBlockHeader().hash(),
+                blockHeaderHash: (await l2Block.hash()).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));
+                blockStateRef: blockStateReference(l2Block.header.state)
+            });
+            return this.sanitizeAndCacheSummaryFromFull(status);
         } catch (err) {
+            this.deleteCachedSummary();
             this.worldStateInstrumentation.incCriticalErrors('synch_pending_block');
             throw err;
         }
     }
     async close() {
-        await this.instance.close();
-        await this.cleanup();
+        try {
+            await this.instance.close();
+        } finally{
+            await this.cleanup();
+        }
+    }
+    async [_computedKey]() {
+        await this.close();
     }
     async buildInitialHeader() {
         const state = await this.getInitialStateReference();
         return BlockHeader.empty({
-            state
+            state,
+            globalVariables: GlobalVariables.empty({
+                timestamp: this.genesis.genesisTimestamp
+            })
         });
     }
     sanitizeAndCacheSummaryFromFull(response) {
@@ -181,7 +255,7 @@ export class NativeWorldStateService {
         };
         return sanitized;
     }
-    deleteCachedSummary(_) {
+    deleteCachedSummary() {
         this.cachedStatusSummary = undefined;
     }
     /**
@@ -190,11 +264,9 @@ export class NativeWorldStateService {
    * @returns The new WorldStateStatus
    */ async setFinalized(toBlockNumber) {
         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;
         }
@@ -206,11 +278,9 @@ export class NativeWorldStateService {
    * @returns The new WorldStateStatus
    */ async removeHistoricalBlocks(toBlockNumber) {
         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;
         }
@@ -221,11 +291,9 @@ export class NativeWorldStateService {
    * @returns The new WorldStateStatus
    */ async unwindBlocks(toBlockNumber) {
         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;
         }
@@ -236,25 +304,17 @@ export class NativeWorldStateService {
                 ...this.cachedStatusSummary
             };
         }
-        return await this.instance.call(WorldStateMessageType.GET_STATUS, {
-            canonical: true
-        }, this.sanitizeAndCacheSummary.bind(this));
+        return this.sanitizeAndCacheSummary(await this.instance.getStatus());
     }
     updateLeaf(_treeId, _leaf, _index) {
         return Promise.reject(new Error('Method not implemented'));
     }
     async getInitialStateReference() {
-        const resp = await this.instance.call(WorldStateMessageType.GET_INITIAL_STATE_REFERENCE, {
-            canonical: true
-        });
-        return new StateReference(treeStateReferenceToSnapshot(resp.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])));
+        const state = await this.instance.getInitialStateReference();
+        return new StateReference(treeStateReferenceToSnapshot(state[MerkleTreeId.L1_TO_L2_MESSAGE_TREE]), new PartialStateReference(treeStateReferenceToSnapshot(state[MerkleTreeId.NOTE_HASH_TREE]), treeStateReferenceToSnapshot(state[MerkleTreeId.NULLIFIER_TREE]), treeStateReferenceToSnapshot(state[MerkleTreeId.PUBLIC_DATA_TREE])));
     }
     async backupTo(dstPath, compact = true) {
-        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')

package/dest/native/native_world_state_instance.d.ts

@@ -1,40 +1,66 @@
-import { type Logger } from '@aztec/foundation/log';
-import type { PublicDataTreeLeaf } from '@aztec/stdlib/trees';
-import type { WorldStateInstrumentation } from '../instrumentation/instrumentation.js';
-import type { WorldStateTreeMapSizes } from '../synchronizer/factory.js';
-import { WorldStateMessageType, type WorldStateRequest, type WorldStateRequestCategories, type WorldStateResponse } from './message.js';
-export interface NativeWorldStateInstance {
-    call<T extends WorldStateMessageType>(messageType: T, body: WorldStateRequest[T] & WorldStateRequestCategories): Promise<WorldStateResponse[T]>;
-}
+import type { BlockNumber } from '@aztec/foundation/branded-types';
+import type { Fr } from '@aztec/foundation/curves/bn254';
+import type { IndexedTreeId, TreeInfo } from '@aztec/stdlib/interfaces/server';
+import type { MerkleTreeId } from '@aztec/stdlib/trees';
+import type { WorldStateRevision } from '@aztec/stdlib/world-state';
+import type { BlockStateReference, SerializedBatchInsertionResult, SerializedIndexedLeaf, SerializedLeafValue, SerializedSequentialInsertionResult, SerializedSiblingPathAndIndex, TreeStateReference, WorldStateStatusFull, WorldStateStatusSummary } from './message.js';
 /**
- * Strongly-typed interface to access the WorldState class in the native world_state_napi module.
+ * Backend-agnostic handle to a running aztec-wsdb world state, accessed by the TS layer.
+ *
+ * The legacy in-process NAPI implementation has been removed; the C++ AVM (NAPI) now connects to
+ * the same aztec-wsdb process using the IPC path returned by {@link getIpcPath}.
  */
-export declare class NativeWorldState implements NativeWorldStateInstance {
-    private readonly dataDir;
-    private readonly wsTreeMapSizes;
-    private readonly prefilledPublicData;
-    private readonly instrumentation;
-    private readonly log;
-    private open;
-    private queues;
-    private instance;
-    /** Creates a new native WorldState instance */
-    constructor(dataDir: string, wsTreeMapSizes: WorldStateTreeMapSizes, prefilledPublicData: PublicDataTreeLeaf[] | undefined, instrumentation: WorldStateInstrumentation, log?: Logger);
-    getDataDir(): string;
-    clone(): NativeWorldState;
+export interface NativeWorldStateInstance {
+    getTreeInfo(treeId: MerkleTreeId, revision: WorldStateRevision): Promise<TreeInfo>;
+    getStateReference(revision: WorldStateRevision): Promise<Record<number, TreeStateReference>>;
+    getInitialStateReference(): Promise<Record<number, TreeStateReference>>;
+    getLeafValue(treeId: MerkleTreeId, revision: WorldStateRevision, leafIndex: bigint): Promise<SerializedLeafValue | undefined>;
+    getLeafPreimage(treeId: IndexedTreeId, revision: WorldStateRevision, leafIndex: bigint): Promise<SerializedIndexedLeaf | undefined>;
+    getSiblingPath(treeId: MerkleTreeId, revision: WorldStateRevision, leafIndex: bigint): Promise<Buffer[]>;
+    getBlockNumbersForLeafIndices(treeId: MerkleTreeId, revision: WorldStateRevision, leafIndices: bigint[]): Promise<(bigint | undefined)[]>;
+    findLeafIndices(treeId: MerkleTreeId, revision: WorldStateRevision, leaves: SerializedLeafValue[], startIndex: bigint): Promise<(bigint | undefined)[]>;
+    findLowLeaf(treeId: IndexedTreeId, revision: WorldStateRevision, key: Fr): Promise<{
+        index: bigint;
+        alreadyPresent: boolean;
+    }>;
+    findSiblingPaths(treeId: MerkleTreeId, revision: WorldStateRevision, leaves: SerializedLeafValue[]): Promise<(SerializedSiblingPathAndIndex | undefined)[]>;
+    updateArchive(forkId: number, blockStateRef: BlockStateReference, blockHeaderHash: Buffer): Promise<void>;
+    appendLeaves(treeId: MerkleTreeId, forkId: number, leaves: SerializedLeafValue[]): Promise<void>;
+    batchInsert(treeId: IndexedTreeId, forkId: number, leaves: SerializedLeafValue[], subtreeDepth: number): Promise<SerializedBatchInsertionResult>;
+    sequentialInsert(treeId: IndexedTreeId, forkId: number, leaves: SerializedLeafValue[]): Promise<SerializedSequentialInsertionResult>;
+    syncBlock(input: {
+        blockNumber: BlockNumber;
+        blockStateRef: BlockStateReference;
+        blockHeaderHash: Buffer;
+        paddedNoteHashes: readonly SerializedLeafValue[];
+        paddedL1ToL2Messages: readonly SerializedLeafValue[];
+        paddedNullifiers: readonly SerializedLeafValue[];
+        publicDataWrites: readonly SerializedLeafValue[];
+    }): Promise<WorldStateStatusFull>;
+    createFork(input: {
+        latest: boolean;
+        blockNumber: BlockNumber;
+    }): Promise<number>;
+    deleteFork(forkId: number): Promise<void>;
+    finalizeBlocks(toBlockNumber: BlockNumber): Promise<WorldStateStatusSummary>;
+    unwindBlocks(toBlockNumber: BlockNumber): Promise<WorldStateStatusFull>;
+    removeHistoricalBlocks(toBlockNumber: BlockNumber): Promise<WorldStateStatusFull>;
+    getStatus(): Promise<WorldStateStatusSummary>;
+    createCheckpoint(forkId: number): Promise<number>;
+    commitCheckpoint(forkId: number): Promise<void>;
+    revertCheckpoint(forkId: number): Promise<void>;
+    commitAllCheckpoints(forkId: number, depth: number): Promise<void>;
+    revertAllCheckpoints(forkId: number, depth: number): Promise<void>;
+    copyStores(dstPath: string, compact: boolean): Promise<void>;
     /**
-     * Sends a message to the native instance and returns the response.
-     * @param messageType - The type of message to send
-     * @param body - The message body
-     * @param responseHandler - A callback accepting the response, executed on the job queue
-     * @param errorHandler - A callback called on request error, executed on the job queue
-     * @returns The response to the message
+     * IPC path the underlying aztec-wsdb process listens on. The C++ AVM uses this to attach to the
+     * same world state instance the TS layer is using.
      */
-    call<T extends WorldStateMessageType>(messageType: T, body: WorldStateRequest[T] & WorldStateRequestCategories, responseHandler?: (response: WorldStateResponse[T]) => WorldStateResponse[T], errorHandler?: (_: string) => void): Promise<WorldStateResponse[T]>;
+    getIpcPath(): string;
     /**
-     * Stops the native instance.
+     * Shut down the world state instance. Cancels any in-flight queues, closes the IPC channel, and
+     * terminates the underlying aztec-wsdb process. Idempotent.
      */
     close(): Promise<void>;
-    private _sendMessage;
 }
-//# sourceMappingURL=native_world_state_instance.d.ts.map
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoibmF0aXZlX3dvcmxkX3N0YXRlX2luc3RhbmNlLmQudHMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvbmF0aXZlL25hdGl2ZV93b3JsZF9zdGF0ZV9pbnN0YW5jZS50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSxPQUFPLEtBQUssRUFBRSxXQUFXLEVBQUUsTUFBTSxpQ0FBaUMsQ0FBQztBQUNuRSxPQUFPLEtBQUssRUFBRSxFQUFFLEVBQUUsTUFBTSxnQ0FBZ0MsQ0FBQztBQUN6RCxPQUFPLEtBQUssRUFBRSxhQUFhLEVBQUUsUUFBUSxFQUFFLE1BQU0saUNBQWlDLENBQUM7QUFDL0UsT0FBTyxLQUFLLEVBQUUsWUFBWSxFQUFFLE1BQU0scUJBQXFCLENBQUM7QUFDeEQsT0FBTyxLQUFLLEVBQUUsa0JBQWtCLEVBQUUsTUFBTSwyQkFBMkIsQ0FBQztBQUVwRSxPQUFPLEtBQUssRUFDVixtQkFBbUIsRUFDbkIsOEJBQThCLEVBQzlCLHFCQUFxQixFQUNyQixtQkFBbUIsRUFDbkIsbUNBQW1DLEVBQ25DLDZCQUE2QixFQUM3QixrQkFBa0IsRUFDbEIsb0JBQW9CLEVBQ3BCLHVCQUF1QixFQUN4QixNQUFNLGNBQWMsQ0FBQztBQUV0Qjs7Ozs7R0FLRztBQUNILE1BQU0sV0FBVyx3QkFBd0I7SUFDdkMsV0FBVyxDQUFDLE1BQU0sRUFBRSxZQUFZLEVBQUUsUUFBUSxFQUFFLGtCQUFrQixHQUFHLE9BQU8sQ0FBQyxRQUFRLENBQUMsQ0FBQztJQUNuRixpQkFBaUIsQ0FBQyxRQUFRLEVBQUUsa0JBQWtCLEdBQUcsT0FBTyxDQUFDLE1BQU0sQ0FBQyxNQUFNLEVBQUUsa0JBQWtCLENBQUMsQ0FBQyxDQUFDO0lBQzdGLHdCQUF3QixJQUFJLE9BQU8sQ0FBQyxNQUFNLENBQUMsTUFBTSxFQUFFLGtCQUFrQixDQUFDLENBQUMsQ0FBQztJQUN4RSxZQUFZLENBQ1YsTUFBTSxFQUFFLFlBQVksRUFDcEIsUUFBUSxFQUFFLGtCQUFrQixFQUM1QixTQUFTLEVBQUUsTUFBTSxHQUNoQixPQUFPLENBQUMsbUJBQW1CLEdBQUcsU0FBUyxDQUFDLENBQUM7SUFDNUMsZUFBZSxDQUNiLE1BQU0sRUFBRSxhQUFhLEVBQ3JCLFFBQVEsRUFBRSxrQkFBa0IsRUFDNUIsU0FBUyxFQUFFLE1BQU0sR0FDaEIsT0FBTyxDQUFDLHFCQUFxQixHQUFHLFNBQVMsQ0FBQyxDQUFDO0lBQzlDLGNBQWMsQ0FBQyxNQUFNLEVBQUUsWUFBWSxFQUFFLFFBQVEsRUFBRSxrQkFBa0IsRUFBRSxTQUFTLEVBQUUsTUFBTSxHQUFHLE9BQU8sQ0FBQyxNQUFNLEVBQUUsQ0FBQyxDQUFDO0lBQ3pHLDZCQUE2QixDQUMzQixNQUFNLEVBQUUsWUFBWSxFQUNwQixRQUFRLEVBQUUsa0JBQWtCLEVBQzVCLFdBQVcsRUFBRSxNQUFNLEVBQUUsR0FDcEIsT0FBTyxDQUFDLENBQUMsTUFBTSxHQUFHLFNBQVMsQ0FBQyxFQUFFLENBQUMsQ0FBQztJQUNuQyxlQUFlLENBQ2IsTUFBTSxFQUFFLFlBQVksRUFDcEIsUUFBUSxFQUFFLGtCQUFrQixFQUM1QixNQUFNLEVBQUUsbUJBQW1CLEVBQUUsRUFDN0IsVUFBVSxFQUFFLE1BQU0sR0FDakIsT0FBTyxDQUFDLENBQUMsTUFBTSxHQUFHLFNBQVMsQ0FBQyxFQUFFLENBQUMsQ0FBQztJQUNuQyxXQUFXLENBQ1QsTUFBTSxFQUFFLGFBQWEsRUFDckIsUUFBUSxFQUFFLGtCQUFrQixFQUM1QixHQUFHLEVBQUUsRUFBRSxHQUNOLE9BQU8sQ0FBQztRQUFFLEtBQUssRUFBRSxNQUFNLENBQUM7UUFBQyxjQUFjLEVBQUUsT0FBTyxDQUFBO0tBQUUsQ0FBQyxDQUFDO0lBQ3ZELGdCQUFnQixDQUNkLE1BQU0sRUFBRSxZQUFZLEVBQ3BCLFFBQVEsRUFBRSxrQkFBa0IsRUFDNUIsTUFBTSxFQUFFLG1CQUFtQixFQUFFLEdBQzVCLE9BQU8sQ0FBQyxDQUFDLDZCQUE2QixHQUFHLFNBQVMsQ0FBQyxFQUFFLENBQUMsQ0FBQztJQUMxRCxhQUFhLENBQUMsTUFBTSxFQUFFLE1BQU0sRUFBRSxhQUFhLEVBQUUsbUJBQW1CLEVBQUUsZUFBZSxFQUFFLE1BQU0sR0FBRyxPQUFPLENBQUMsSUFBSSxDQUFDLENBQUM7SUFDMUcsWUFBWSxDQUFDLE1BQU0sRUFBRSxZQUFZLEVBQUUsTUFBTSxFQUFFLE1BQU0sRUFBRSxNQUFNLEVBQUUsbUJBQW1CLEVBQUUsR0FBRyxPQUFPLENBQUMsSUFBSSxDQUFDLENBQUM7SUFDakcsV0FBVyxDQUNULE1BQU0sRUFBRSxhQUFhLEVBQ3JCLE1BQU0sRUFBRSxNQUFNLEVBQ2QsTUFBTSxFQUFFLG1CQUFtQixFQUFFLEVBQzdCLFlBQVksRUFBRSxNQUFNLEdBQ25CLE9BQU8sQ0FBQyw4QkFBOEIsQ0FBQyxDQUFDO0lBQzNDLGdCQUFnQixDQUNkLE1BQU0sRUFBRSxhQUFhLEVBQ3JCLE1BQU0sRUFBRSxNQUFNLEVBQ2QsTUFBTSxFQUFFLG1CQUFtQixFQUFFLEdBQzVCLE9BQU8sQ0FBQyxtQ0FBbUMsQ0FBQyxDQUFDO0lBQ2hELFNBQVMsQ0FBQyxLQUFLLEVBQUU7UUFDZixXQUFXLEVBQUUsV0FBVyxDQUFDO1FBQ3pCLGFBQWEsRUFBRSxtQkFBbUIsQ0FBQztRQUNuQyxlQUFlLEVBQUUsTUFBTSxDQUFDO1FBQ3hCLGdCQUFnQixFQUFFLFNBQVMsbUJBQW1CLEVBQUUsQ0FBQztRQUNqRCxvQkFBb0IsRUFBRSxTQUFTLG1CQUFtQixFQUFFLENBQUM7UUFDckQsZ0JBQWdCLEVBQUUsU0FBUyxtQkFBbUIsRUFBRSxDQUFDO1FBQ2pELGdCQUFnQixFQUFFLFNBQVMsbUJBQW1CLEVBQUUsQ0FBQztLQUNsRCxHQUFHLE9BQU8sQ0FBQyxvQkFBb0IsQ0FBQyxDQUFDO0lBQ2xDLFVBQVUsQ0FBQyxLQUFLLEVBQUU7UUFBRSxNQUFNLEVBQUUsT0FBTyxDQUFDO1FBQUMsV0FBVyxFQUFFLFdBQVcsQ0FBQTtLQUFFLEdBQUcsT0FBTyxDQUFDLE1BQU0sQ0FBQyxDQUFDO0lBQ2xGLFVBQVUsQ0FBQyxNQUFNLEVBQUUsTUFBTSxHQUFHLE9BQU8sQ0FBQyxJQUFJLENBQUMsQ0FBQztJQUMxQyxjQUFjLENBQUMsYUFBYSxFQUFFLFdBQVcsR0FBRyxPQUFPLENBQUMsdUJBQXVCLENBQUMsQ0FBQztJQUM3RSxZQUFZLENBQUMsYUFBYSxFQUFFLFdBQVcsR0FBRyxPQUFPLENBQUMsb0JBQW9CLENBQUMsQ0FBQztJQUN4RSxzQkFBc0IsQ0FBQyxhQUFhLEVBQUUsV0FBVyxHQUFHLE9BQU8sQ0FBQyxvQkFBb0IsQ0FBQyxDQUFDO0lBQ2xGLFNBQVMsSUFBSSxPQUFPLENBQUMsdUJBQXVCLENBQUMsQ0FBQztJQUM5QyxnQkFBZ0IsQ0FBQyxNQUFNLEVBQUUsTUFBTSxHQUFHLE9BQU8sQ0FBQyxNQUFNLENBQUMsQ0FBQztJQUNsRCxnQkFBZ0IsQ0FBQyxNQUFNLEVBQUUsTUFBTSxHQUFHLE9BQU8sQ0FBQyxJQUFJLENBQUMsQ0FBQztJQUNoRCxnQkFBZ0IsQ0FBQyxNQUFNLEVBQUUsTUFBTSxHQUFHLE9BQU8sQ0FBQyxJQUFJLENBQUMsQ0FBQztJQUNoRCxvQkFBb0IsQ0FBQyxNQUFNLEVBQUUsTUFBTSxFQUFFLEtBQUssRUFBRSxNQUFNLEdBQUcsT0FBTyxDQUFDLElBQUksQ0FBQyxDQUFDO0lBQ25FLG9CQUFvQixDQUFDLE1BQU0sRUFBRSxNQUFNLEVBQUUsS0FBSyxFQUFFLE1BQU0sR0FBRyxPQUFPLENBQUMsSUFBSSxDQUFDLENBQUM7SUFDbkUsVUFBVSxDQUFDLE9BQU8sRUFBRSxNQUFNLEVBQUUsT0FBTyxFQUFFLE9BQU8sR0FBRyxPQUFPLENBQUMsSUFBSSxDQUFDLENBQUM7SUFFN0Q7OztPQUdHO0lBQ0gsVUFBVSxJQUFJLE1BQU0sQ0FBQztJQUVyQjs7O09BR0c7SUFDSCxLQUFLLElBQUksT0FBTyxDQUFDLElBQUksQ0FBQyxDQUFDO0NBQ3hCIn0=

package/dest/native/native_world_state_instance.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"native_world_state_instance.d.ts","sourceRoot":"","sources":["../../src/native/native_world_state_instance.ts"],"names":[],"mappings":"AAUA,OAAO,EAAE,KAAK,MAAM,EAAgB,MAAM,uBAAuB,CAAC;AAGlE,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,qBAAqB,CAAC;AAK9D,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,uCAAuC,CAAC;AACvF,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,4BAA4B,CAAC;AACzE,OAAO,EACL,qBAAqB,EACrB,KAAK,iBAAiB,EACtB,KAAK,2BAA2B,EAChC,KAAK,kBAAkB,EAIxB,MAAM,cAAc,CAAC;AAKtB,MAAM,WAAW,wBAAwB;IACvC,IAAI,CAAC,CAAC,SAAS,qBAAqB,EAClC,WAAW,EAAE,CAAC,EACd,IAAI,EAAE,iBAAiB,CAAC,CAAC,CAAC,GAAG,2BAA2B,GACvD,OAAO,CAAC,kBAAkB,CAAC,CAAC,CAAC,CAAC,CAAC;CACnC;AAED;;GAEG;AACH,qBAAa,gBAAiB,YAAW,wBAAwB;IAU7D,OAAO,CAAC,QAAQ,CAAC,OAAO;IACxB,OAAO,CAAC,QAAQ,CAAC,cAAc;IAC/B,OAAO,CAAC,QAAQ,CAAC,mBAAmB;IACpC,OAAO,CAAC,QAAQ,CAAC,eAAe;IAChC,OAAO,CAAC,QAAQ,CAAC,GAAG;IAbtB,OAAO,CAAC,IAAI,CAAQ;IAGpB,OAAO,CAAC,MAAM,CAAyC;IAEvD,OAAO,CAAC,QAAQ,CAA+E;IAE/F,+CAA+C;gBAE5B,OAAO,EAAE,MAAM,EACf,cAAc,EAAE,sBAAsB,EACtC,mBAAmB,EAAE,kBAAkB,EAAE,YAAK,EAC9C,eAAe,EAAE,yBAAyB,EAC1C,GAAG,GAAE,MAA6C;IAsC9D,UAAU;IAIV,KAAK;IAUZ;;;;;;;OAOG;IACU,IAAI,CAAC,CAAC,SAAS,qBAAqB,EAC/C,WAAW,EAAE,CAAC,EACd,IAAI,EAAE,iBAAiB,CAAC,CAAC,CAAC,GAAG,2BAA2B,EAExD,eAAe,IAAI,UAAU,kBAAkB,CAAC,CAAC,CAAC,KAAG,kBAAkB,CAAC,CAAC,CAAa,EACtF,YAAY,IAAI,GAAG,MAAM,SAAO,GAC/B,OAAO,CAAC,kBAAkB,CAAC,CAAC,CAAC,CAAC;IAuDjC;;OAEG;IACU,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;YAiBrB,YAAY;CA8D3B"}
+{"version":3,"file":"native_world_state_instance.d.ts","sourceRoot":"","sources":["../../src/native/native_world_state_instance.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,iCAAiC,CAAC;AACnE,OAAO,KAAK,EAAE,EAAE,EAAE,MAAM,gCAAgC,CAAC;AACzD,OAAO,KAAK,EAAE,aAAa,EAAE,QAAQ,EAAE,MAAM,iCAAiC,CAAC;AAC/E,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AACxD,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,2BAA2B,CAAC;AAEpE,OAAO,KAAK,EACV,mBAAmB,EACnB,8BAA8B,EAC9B,qBAAqB,EACrB,mBAAmB,EACnB,mCAAmC,EACnC,6BAA6B,EAC7B,kBAAkB,EAClB,oBAAoB,EACpB,uBAAuB,EACxB,MAAM,cAAc,CAAC;AAEtB;;;;;GAKG;AACH,MAAM,WAAW,wBAAwB;IACvC,WAAW,CAAC,MAAM,EAAE,YAAY,EAAE,QAAQ,EAAE,kBAAkB,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC;IACnF,iBAAiB,CAAC,QAAQ,EAAE,kBAAkB,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,kBAAkB,CAAC,CAAC,CAAC;IAC7F,wBAAwB,IAAI,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,kBAAkB,CAAC,CAAC,CAAC;IACxE,YAAY,CACV,MAAM,EAAE,YAAY,EACpB,QAAQ,EAAE,kBAAkB,EAC5B,SAAS,EAAE,MAAM,GAChB,OAAO,CAAC,mBAAmB,GAAG,SAAS,CAAC,CAAC;IAC5C,eAAe,CACb,MAAM,EAAE,aAAa,EACrB,QAAQ,EAAE,kBAAkB,EAC5B,SAAS,EAAE,MAAM,GAChB,OAAO,CAAC,qBAAqB,GAAG,SAAS,CAAC,CAAC;IAC9C,cAAc,CAAC,MAAM,EAAE,YAAY,EAAE,QAAQ,EAAE,kBAAkB,EAAE,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC;IACzG,6BAA6B,CAC3B,MAAM,EAAE,YAAY,EACpB,QAAQ,EAAE,kBAAkB,EAC5B,WAAW,EAAE,MAAM,EAAE,GACpB,OAAO,CAAC,CAAC,MAAM,GAAG,SAAS,CAAC,EAAE,CAAC,CAAC;IACnC,eAAe,CACb,MAAM,EAAE,YAAY,EACpB,QAAQ,EAAE,kBAAkB,EAC5B,MAAM,EAAE,mBAAmB,EAAE,EAC7B,UAAU,EAAE,MAAM,GACjB,OAAO,CAAC,CAAC,MAAM,GAAG,SAAS,CAAC,EAAE,CAAC,CAAC;IACnC,WAAW,CACT,MAAM,EAAE,aAAa,EACrB,QAAQ,EAAE,kBAAkB,EAC5B,GAAG,EAAE,EAAE,GACN,OAAO,CAAC;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,cAAc,EAAE,OAAO,CAAA;KAAE,CAAC,CAAC;IACvD,gBAAgB,CACd,MAAM,EAAE,YAAY,EACpB,QAAQ,EAAE,kBAAkB,EAC5B,MAAM,EAAE,mBAAmB,EAAE,GAC5B,OAAO,CAAC,CAAC,6BAA6B,GAAG,SAAS,CAAC,EAAE,CAAC,CAAC;IAC1D,aAAa,CAAC,MAAM,EAAE,MAAM,EAAE,aAAa,EAAE,mBAAmB,EAAE,eAAe,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC1G,YAAY,CAAC,MAAM,EAAE,YAAY,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,mBAAmB,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACjG,WAAW,CACT,MAAM,EAAE,aAAa,EACrB,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,mBAAmB,EAAE,EAC7B,YAAY,EAAE,MAAM,GACnB,OAAO,CAAC,8BAA8B,CAAC,CAAC;IAC3C,gBAAgB,CACd,MAAM,EAAE,aAAa,EACrB,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,mBAAmB,EAAE,GAC5B,OAAO,CAAC,mCAAmC,CAAC,CAAC;IAChD,SAAS,CAAC,KAAK,EAAE;QACf,WAAW,EAAE,WAAW,CAAC;QACzB,aAAa,EAAE,mBAAmB,CAAC;QACnC,eAAe,EAAE,MAAM,CAAC;QACxB,gBAAgB,EAAE,SAAS,mBAAmB,EAAE,CAAC;QACjD,oBAAoB,EAAE,SAAS,mBAAmB,EAAE,CAAC;QACrD,gBAAgB,EAAE,SAAS,mBAAmB,EAAE,CAAC;QACjD,gBAAgB,EAAE,SAAS,mBAAmB,EAAE,CAAC;KAClD,GAAG,OAAO,CAAC,oBAAoB,CAAC,CAAC;IAClC,UAAU,CAAC,KAAK,EAAE;QAAE,MAAM,EAAE,OAAO,CAAC;QAAC,WAAW,EAAE,WAAW,CAAA;KAAE,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAClF,UAAU,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC1C,cAAc,CAAC,aAAa,EAAE,WAAW,GAAG,OAAO,CAAC,uBAAuB,CAAC,CAAC;IAC7E,YAAY,CAAC,aAAa,EAAE,WAAW,GAAG,OAAO,CAAC,oBAAoB,CAAC,CAAC;IACxE,sBAAsB,CAAC,aAAa,EAAE,WAAW,GAAG,OAAO,CAAC,oBAAoB,CAAC,CAAC;IAClF,SAAS,IAAI,OAAO,CAAC,uBAAuB,CAAC,CAAC;IAC9C,gBAAgB,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAClD,gBAAgB,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAChD,gBAAgB,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAChD,oBAAoB,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACnE,oBAAoB,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACnE,UAAU,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE7D;;;OAGG;IACH,UAAU,IAAI,MAAM,CAAC;IAErB;;;OAGG;IACH,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;CACxB"}