@aztec/world-state 0.77.0-testnet-ignition.30 → 0.77.0

package/dest/native/native_world_state.d.ts

@@ -10,7 +10,6 @@ import { WorldStateInstrumentation } from '../instrumentation/instrumentation.js
 import type { MerkleTreeAdminDatabase as MerkleTreeDatabase } from '../world-state-db/merkle_tree_db.js';
 import { type WorldStateStatusFull, type WorldStateStatusSummary } from './message.js';
 import { NativeWorldState } from './native_world_state_instance.js';
-export declare const WORLD_STATE_VERSION_FILE = "version";
 export declare const WORLD_STATE_DB_VERSION = 1;
 export declare class NativeWorldStateService implements MerkleTreeDatabase {
     protected readonly instance: NativeWorldState;

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

@@ -1 +1 @@
-{"version":3,"file":"native_world_state.d.ts","sourceRoot":"","sources":["../../src/native/native_world_state.ts"],"names":[],"mappings":";;AAEA,OAAO,EAAE,UAAU,EAAE,MAAM,+BAA+B,CAAC;AAC3D,OAAO,EAAE,EAAE,EAAE,MAAM,0BAA0B,CAAC;AAE9C,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AACnD,OAAO,KAAK,EACV,aAAa,EACb,wBAAwB,EACxB,yBAAyB,EAC1B,MAAM,iCAAiC,CAAC;AACzC,OAAO,EAA+B,KAAK,qBAAqB,EAAE,kBAAkB,EAAE,MAAM,qBAAqB,CAAC;AAClH,OAAO,EAAE,WAAW,EAAyC,MAAM,kBAAkB,CAAC;AAQtF,OAAO,EAAE,yBAAyB,EAAE,MAAM,uCAAuC,CAAC;AAClF,OAAO,KAAK,EAAE,uBAAuB,IAAI,kBAAkB,EAAE,MAAM,qCAAqC,CAAC;AAEzG,OAAO,EAEL,KAAK,oBAAoB,EACzB,KAAK,uBAAuB,EAM7B,MAAM,cAAc,CAAC;AACtB,OAAO,EAAE,gBAAgB,EAAE,MAAM,kCAAkC,CAAC;AAGpE,eAAO,MAAM,wBAAwB,YAAY,CAAC;AAOlD,eAAO,MAAM,sBAAsB,IAAI,CAAC;AAExC,qBAAa,uBAAwB,YAAW,kBAAkB;IAM9D,SAAS,CAAC,QAAQ,CAAC,QAAQ,EAAE,gBAAgB;IAC7C,SAAS,CAAC,QAAQ,CAAC,yBAAyB,EAAE,yBAAyB;IACvE,SAAS,CAAC,QAAQ,CAAC,GAAG;IACtB,OAAO,CAAC,QAAQ,CAAC,OAAO;IAR1B,SAAS,CAAC,aAAa,EAAE,WAAW,GAAG,SAAS,CAAC;IAEjD,OAAO,CAAC,mBAAmB,CAAsC;IAEjE,SAAS,aACY,QAAQ,EAAE,gBAAgB,EAC1B,yBAAyB,EAAE,yBAAyB,EACpD,GAAG,yCAAuC,EAC5C,OAAO,sBAA0B;WAGvC,GAAG,CACd,aAAa,EAAE,UAAU,EACzB,OAAO,EAAE,MAAM,EACf,WAAW,EAAE,MAAM,EACnB,mBAAmB,GAAE,kBAAkB,EAAO,EAC9C,eAAe,4BAAsD,EACrE,GAAG,yCAAuC,EAC1C,OAAO,sBAA0B,GAChC,OAAO,CAAC,uBAAuB,CAAC;WAiCtB,GAAG,CACd,aAAa,aAAkB,EAC/B,aAAa,UAAO,EACpB,mBAAmB,GAAE,kBAAkB,EAAO,EAC9C,eAAe,4BAAsD,GACpE,OAAO,CAAC,uBAAuB,CAAC;cAmBnB,IAAI;IAqBb,YAAY,IAAI,wBAAwB;IAIxC,WAAW,CAAC,WAAW,EAAE,MAAM,GAAG,wBAAwB;IAIpD,IAAI,CAAC,WAAW,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,yBAAyB,CAAC;IASpE,gBAAgB,IAAI,WAAW;IAIzB,wBAAwB,CAAC,OAAO,EAAE,OAAO,EAAE,cAAc,EAAE,EAAE,EAAE,GAAG,OAAO,CAAC,oBAAoB,CAAC;IA0C/F,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;YAKrB,kBAAkB;IAKhC,OAAO,CAAC,+BAA+B;IAMvC,OAAO,CAAC,uBAAuB;IAM/B,OAAO,CAAC,mBAAmB;IAI3B;;;;OAIG;IACU,YAAY,CAAC,aAAa,EAAE,MAAM;IAkB/C;;;;OAIG;IACU,sBAAsB,CAAC,aAAa,EAAE,MAAM;IAiBzD;;;;OAIG;IACU,YAAY,CAAC,aAAa,EAAE,MAAM;IAiBlC,gBAAgB;IAW7B,UAAU,CAAC,EAAE,SAAS,aAAa,EACjC,OAAO,EAAE,EAAE,EACX,KAAK,EAAE,qBAAqB,GAAG,MAAM,EACrC,MAAM,EAAE,MAAM,GACb,OAAO,CAAC,IAAI,CAAC;YAIF,wBAAwB;CAYvC"}
+{"version":3,"file":"native_world_state.d.ts","sourceRoot":"","sources":["../../src/native/native_world_state.ts"],"names":[],"mappings":";;AAEA,OAAO,EAAE,UAAU,EAAE,MAAM,+BAA+B,CAAC;AAC3D,OAAO,EAAE,EAAE,EAAE,MAAM,0BAA0B,CAAC;AAE9C,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AAEnD,OAAO,KAAK,EACV,aAAa,EACb,wBAAwB,EACxB,yBAAyB,EAC1B,MAAM,iCAAiC,CAAC;AACzC,OAAO,EAA+B,KAAK,qBAAqB,EAAE,kBAAkB,EAAE,MAAM,qBAAqB,CAAC;AAClH,OAAO,EAAE,WAAW,EAAyC,MAAM,kBAAkB,CAAC;AAQtF,OAAO,EAAE,yBAAyB,EAAE,MAAM,uCAAuC,CAAC;AAClF,OAAO,KAAK,EAAE,uBAAuB,IAAI,kBAAkB,EAAE,MAAM,qCAAqC,CAAC;AAEzG,OAAO,EAEL,KAAK,oBAAoB,EACzB,KAAK,uBAAuB,EAM7B,MAAM,cAAc,CAAC;AACtB,OAAO,EAAE,gBAAgB,EAAE,MAAM,kCAAkC,CAAC;AAIpE,eAAO,MAAM,sBAAsB,IAAI,CAAC;AAExC,qBAAa,uBAAwB,YAAW,kBAAkB;IAM9D,SAAS,CAAC,QAAQ,CAAC,QAAQ,EAAE,gBAAgB;IAC7C,SAAS,CAAC,QAAQ,CAAC,yBAAyB,EAAE,yBAAyB;IACvE,SAAS,CAAC,QAAQ,CAAC,GAAG;IACtB,OAAO,CAAC,QAAQ,CAAC,OAAO;IAR1B,SAAS,CAAC,aAAa,EAAE,WAAW,GAAG,SAAS,CAAC;IAEjD,OAAO,CAAC,mBAAmB,CAAsC;IAEjE,SAAS,aACY,QAAQ,EAAE,gBAAgB,EAC1B,yBAAyB,EAAE,yBAAyB,EACpD,GAAG,yCAAuC,EAC5C,OAAO,sBAA0B;WAGvC,GAAG,CACd,aAAa,EAAE,UAAU,EACzB,OAAO,EAAE,MAAM,EACf,WAAW,EAAE,MAAM,EACnB,mBAAmB,GAAE,kBAAkB,EAAO,EAC9C,eAAe,4BAAsD,EACrE,GAAG,yCAAuC,EAC1C,OAAO,sBAA0B,GAChC,OAAO,CAAC,uBAAuB,CAAC;WAwBtB,GAAG,CACd,aAAa,aAAkB,EAC/B,aAAa,UAAO,EACpB,mBAAmB,GAAE,kBAAkB,EAAO,EAC9C,eAAe,4BAAsD,GACpE,OAAO,CAAC,uBAAuB,CAAC;cAmBnB,IAAI;IAqBb,YAAY,IAAI,wBAAwB;IAIxC,WAAW,CAAC,WAAW,EAAE,MAAM,GAAG,wBAAwB;IAIpD,IAAI,CAAC,WAAW,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,yBAAyB,CAAC;IASpE,gBAAgB,IAAI,WAAW;IAIzB,wBAAwB,CAAC,OAAO,EAAE,OAAO,EAAE,cAAc,EAAE,EAAE,EAAE,GAAG,OAAO,CAAC,oBAAoB,CAAC;IA0C/F,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;YAKrB,kBAAkB;IAKhC,OAAO,CAAC,+BAA+B;IAMvC,OAAO,CAAC,uBAAuB;IAM/B,OAAO,CAAC,mBAAmB;IAI3B;;;;OAIG;IACU,YAAY,CAAC,aAAa,EAAE,MAAM;IAkB/C;;;;OAIG;IACU,sBAAsB,CAAC,aAAa,EAAE,MAAM;IAiBzD;;;;OAIG;IACU,YAAY,CAAC,aAAa,EAAE,MAAM;IAiBlC,gBAAgB;IAW7B,UAAU,CAAC,EAAE,SAAS,aAAa,EACjC,OAAO,EAAE,EAAE,EACX,KAAK,EAAE,qBAAqB,GAAG,MAAM,EACrC,MAAM,EAAE,MAAM,GACb,OAAO,CAAC,IAAI,CAAC;YAIF,wBAAwB;CAYvC"}

package/dest/native/native_world_state.js

@@ -3,24 +3,20 @@ import { padArrayEnd } from '@aztec/foundation/collection';
 import { EthAddress } from '@aztec/foundation/eth-address';
 import { Fr } from '@aztec/foundation/fields';
 import { createLogger } from '@aztec/foundation/log';
+import { DatabaseVersionManager } from '@aztec/stdlib/database-version';
 import { MerkleTreeId, NullifierLeaf, PublicDataTreeLeaf } from '@aztec/stdlib/trees';
 import { BlockHeader, PartialStateReference, StateReference } from '@aztec/stdlib/tx';
 import { getTelemetryClient } from '@aztec/telemetry-client';
 import assert from 'assert/strict';
-import { mkdir, mkdtemp, rm } from 'fs/promises';
+import { mkdtemp, rm } from 'fs/promises';
 import { tmpdir } from 'os';
 import { join } from 'path';
 import { WorldStateInstrumentation } from '../instrumentation/instrumentation.js';
 import { MerkleTreesFacade, MerkleTreesForkFacade, serializeLeaf } from './merkle_trees_facade.js';
 import { WorldStateMessageType, blockStateReference, sanitiseFullStatus, sanitiseSummary, treeStateReferenceToSnapshot, worldStateRevision } from './message.js';
 import { NativeWorldState } from './native_world_state_instance.js';
-import { WorldStateVersion } from './world_state_version.js';
-export const WORLD_STATE_VERSION_FILE = 'version';
-// A crude way of maintaining DB versioning
-// We don't currently have any method of performing data migrations
-// should the world state db structure change
-// For now we will track versions using this hardcoded value and delete
-// the state if a change is detected
+// 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 = 1; // The initial version
 export class NativeWorldStateService {
     instance;
@@ -38,36 +34,11 @@ export class NativeWorldStateService {
     }
     static async new(rollupAddress, dataDir, dbMapSizeKb, prefilledPublicData = [], instrumentation = new WorldStateInstrumentation(getTelemetryClient()), log = createLogger('world-state:database'), cleanup = ()=>Promise.resolve()) {
         const worldStateDirectory = join(dataDir, 'world_state');
-        const versionFile = join(worldStateDirectory, WORLD_STATE_VERSION_FILE);
-        const storedWorldStateVersion = await WorldStateVersion.readVersion(versionFile);
-        if (!storedWorldStateVersion) {
-            log.warn('No world state version found, deleting world state directory');
-            await rm(worldStateDirectory, {
-                recursive: true,
-                force: true,
-                maxRetries: 3
-            });
-        } else if (!rollupAddress.equals(storedWorldStateVersion.rollupAddress)) {
-            log.warn('Rollup address changed, deleting world state directory');
-            await rm(worldStateDirectory, {
-                recursive: true,
-                force: true,
-                maxRetries: 3
-            });
-        } else if (storedWorldStateVersion.version != WORLD_STATE_DB_VERSION) {
-            log.warn('World state version change detected, deleting world state directory');
-            await rm(worldStateDirectory, {
-                recursive: true,
-                force: true,
-                maxRetries: 3
-            });
-        }
-        const newWorldStateVersion = new WorldStateVersion(WORLD_STATE_DB_VERSION, rollupAddress);
-        await mkdir(worldStateDirectory, {
-            recursive: true
+        // Create a version manager to handle versioning
+        const versionManager = new DatabaseVersionManager(WORLD_STATE_DB_VERSION, rollupAddress, worldStateDirectory, (dir)=>{
+            return Promise.resolve(new NativeWorldState(dir, dbMapSizeKb, prefilledPublicData, instrumentation));
         });
-        await newWorldStateVersion.writeVersionFile(versionFile);
-        const instance = new NativeWorldState(worldStateDirectory, dbMapSizeKb, prefilledPublicData, instrumentation);
+        const [instance] = await versionManager.open();
         const worldState = new this(instance, instrumentation, log, cleanup);
         try {
             await worldState.init();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aztec/world-state",
-  "version": "0.77.0-testnet-ignition.30",
+  "version": "0.77.0",
   "type": "module",
   "exports": {
     ".": "./dest/index.js",
@@ -62,19 +62,19 @@
     ]
   },
   "dependencies": {
-    "@aztec/constants": "0.77.0-testnet-ignition.30",
-    "@aztec/foundation": "0.77.0-testnet-ignition.30",
-    "@aztec/kv-store": "0.77.0-testnet-ignition.30",
-    "@aztec/merkle-tree": "0.77.0-testnet-ignition.30",
-    "@aztec/native": "0.77.0-testnet-ignition.30",
-    "@aztec/protocol-contracts": "0.77.0-testnet-ignition.30",
-    "@aztec/stdlib": "0.77.0-testnet-ignition.30",
-    "@aztec/telemetry-client": "0.77.0-testnet-ignition.30",
+    "@aztec/constants": "0.77.0",
+    "@aztec/foundation": "0.77.0",
+    "@aztec/kv-store": "0.77.0",
+    "@aztec/merkle-tree": "0.77.0",
+    "@aztec/native": "0.77.0",
+    "@aztec/protocol-contracts": "0.77.0",
+    "@aztec/stdlib": "0.77.0",
+    "@aztec/telemetry-client": "0.77.0",
     "tslib": "^2.4.0",
     "zod": "^3.23.8"
   },
   "devDependencies": {
-    "@aztec/archiver": "0.77.0-testnet-ignition.30",
+    "@aztec/archiver": "0.77.0",
     "@jest/globals": "^29.5.0",
     "@types/jest": "^29.5.0",
     "@types/levelup": "^5.1.2",

package/src/native/native_world_state.ts

@@ -4,6 +4,7 @@ import { EthAddress } from '@aztec/foundation/eth-address';
 import { Fr } from '@aztec/foundation/fields';
 import { createLogger } from '@aztec/foundation/log';
 import type { L2Block } from '@aztec/stdlib/block';
+import { DatabaseVersionManager } from '@aztec/stdlib/database-version';
 import type {
   IndexedTreeId,
   MerkleTreeReadOperations,
@@ -14,7 +15,7 @@ import { BlockHeader, PartialStateReference, StateReference } from '@aztec/stdli
 import { getTelemetryClient } from '@aztec/telemetry-client';
 
 import assert from 'assert/strict';
-import { mkdir, mkdtemp, rm } from 'fs/promises';
+import { mkdtemp, rm } from 'fs/promises';
 import { tmpdir } from 'os';
 import { join } from 'path';
 
@@ -32,15 +33,9 @@ import {
   worldStateRevision,
 } from './message.js';
 import { NativeWorldState } from './native_world_state_instance.js';
-import { WorldStateVersion } from './world_state_version.js';
 
-export const WORLD_STATE_VERSION_FILE = 'version';
-
-// A crude way of maintaining DB versioning
-// We don't currently have any method of performing data migrations
-// should the world state db structure change
-// For now we will track versions using this hardcoded value and delete
-// the state if a change is detected
+// 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 = 1; // The initial version
 
 export class NativeWorldStateService implements MerkleTreeDatabase {
@@ -65,26 +60,17 @@ export class NativeWorldStateService implements MerkleTreeDatabase {
     cleanup = () => Promise.resolve(),
   ): Promise<NativeWorldStateService> {
     const worldStateDirectory = join(dataDir, 'world_state');
-    const versionFile = join(worldStateDirectory, WORLD_STATE_VERSION_FILE);
-    const storedWorldStateVersion = await WorldStateVersion.readVersion(versionFile);
-
-    if (!storedWorldStateVersion) {
-      log.warn('No world state version found, deleting world state directory');
-      await rm(worldStateDirectory, { recursive: true, force: true, maxRetries: 3 });
-    } else if (!rollupAddress.equals(storedWorldStateVersion.rollupAddress)) {
-      log.warn('Rollup address changed, deleting world state directory');
-      await rm(worldStateDirectory, { recursive: true, force: true, maxRetries: 3 });
-    } else if (storedWorldStateVersion.version != WORLD_STATE_DB_VERSION) {
-      log.warn('World state version change detected, deleting world state directory');
-      await rm(worldStateDirectory, { recursive: true, force: true, maxRetries: 3 });
-    }
-
-    const newWorldStateVersion = new WorldStateVersion(WORLD_STATE_DB_VERSION, rollupAddress);
-
-    await mkdir(worldStateDirectory, { recursive: true });
-    await newWorldStateVersion.writeVersionFile(versionFile);
+    // Create a version manager to handle versioning
+    const versionManager = new DatabaseVersionManager(
+      WORLD_STATE_DB_VERSION,
+      rollupAddress,
+      worldStateDirectory,
+      (dir: string) => {
+        return Promise.resolve(new NativeWorldState(dir, dbMapSizeKb, prefilledPublicData, instrumentation));
+      },
+    );
 
-    const instance = new NativeWorldState(worldStateDirectory, dbMapSizeKb, prefilledPublicData, instrumentation);
+    const [instance] = await versionManager.open();
     const worldState = new this(instance, instrumentation, log, cleanup);
     try {
       await worldState.init();

package/dest/native/world_state_version.d.ts

@@ -1,24 +0,0 @@
-import { EthAddress } from '@aztec/foundation/eth-address';
-import { z } from 'zod';
-export declare class WorldStateVersion {
-    readonly version: number;
-    readonly rollupAddress: EthAddress;
-    constructor(version: number, rollupAddress: EthAddress);
-    static readVersion(filename: string): Promise<WorldStateVersion | undefined>;
-    writeVersionFile(filename: string): Promise<void>;
-    static get schema(): z.ZodEffects<z.ZodObject<{
-        version: z.ZodNumber;
-        rollupAddress: z.ZodType<EthAddress, any, string>;
-    }, "strip", z.ZodTypeAny, {
-        version: number;
-        rollupAddress: EthAddress;
-    }, {
-        version: number;
-        rollupAddress: string;
-    }>, WorldStateVersion, {
-        version: number;
-        rollupAddress: string;
-    }>;
-    static empty(): WorldStateVersion;
-}
-//# sourceMappingURL=world_state_version.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"world_state_version.d.ts","sourceRoot":"","sources":["../../src/native/world_state_version.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,+BAA+B,CAAC;AAK3D,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,qBAAa,iBAAiB;aACA,OAAO,EAAE,MAAM;aAAkB,aAAa,EAAE,UAAU;gBAA1D,OAAO,EAAE,MAAM,EAAkB,aAAa,EAAE,UAAU;WAEzE,WAAW,CAAC,QAAQ,EAAE,MAAM;IAK5B,gBAAgB,CAAC,QAAQ,EAAE,MAAM;IAK9C,MAAM,KAAK,MAAM;;;;;;;;;;;;OAOhB;IAED,MAAM,CAAC,KAAK;CAGb"}

package/dest/native/world_state_version.js

@@ -1,30 +0,0 @@
-import { EthAddress } from '@aztec/foundation/eth-address';
-import { jsonParseWithSchema, jsonStringify } from '@aztec/foundation/json-rpc';
-import { schemas } from '@aztec/foundation/schemas';
-import { readFile, writeFile } from 'fs/promises';
-import { z } from 'zod';
-export class WorldStateVersion {
-    version;
-    rollupAddress;
-    constructor(version, rollupAddress){
-        this.version = version;
-        this.rollupAddress = rollupAddress;
-    }
-    static async readVersion(filename) {
-        const versionData = await readFile(filename, 'utf-8').catch(()=>undefined);
-        return versionData === undefined ? undefined : await jsonParseWithSchema(versionData, WorldStateVersion.schema);
-    }
-    async writeVersionFile(filename) {
-        const data = jsonStringify(this);
-        await writeFile(filename, data, 'utf-8');
-    }
-    static get schema() {
-        return z.object({
-            version: z.number(),
-            rollupAddress: schemas.EthAddress
-        }).transform(({ version, rollupAddress })=>new WorldStateVersion(version, rollupAddress));
-    }
-    static empty() {
-        return new WorldStateVersion(0, EthAddress.ZERO);
-    }
-}

package/src/native/world_state_version.ts

@@ -1,33 +0,0 @@
-import { EthAddress } from '@aztec/foundation/eth-address';
-import { jsonParseWithSchema, jsonStringify } from '@aztec/foundation/json-rpc';
-import { schemas } from '@aztec/foundation/schemas';
-
-import { readFile, writeFile } from 'fs/promises';
-import { z } from 'zod';
-
-export class WorldStateVersion {
-  constructor(public readonly version: number, public readonly rollupAddress: EthAddress) {}
-
-  static async readVersion(filename: string) {
-    const versionData = await readFile(filename, 'utf-8').catch(() => undefined);
-    return versionData === undefined ? undefined : await jsonParseWithSchema(versionData, WorldStateVersion.schema);
-  }
-
-  public async writeVersionFile(filename: string) {
-    const data = jsonStringify(this);
-    await writeFile(filename, data, 'utf-8');
-  }
-
-  static get schema() {
-    return z
-      .object({
-        version: z.number(),
-        rollupAddress: schemas.EthAddress,
-      })
-      .transform(({ version, rollupAddress }) => new WorldStateVersion(version, rollupAddress));
-  }
-
-  static empty() {
-    return new WorldStateVersion(0, EthAddress.ZERO);
-  }
-}