@aztec/kv-store 0.77.0-testnet-ignition.29 → 0.77.0

package/dest/lmdb-v2/factory.d.ts

@@ -1,9 +1,12 @@
+import { EthAddress } from '@aztec/foundation/eth-address';
 import { type Logger } from '@aztec/foundation/log';
 import type { DataStoreConfig } from '../config.js';
 import { AztecLMDBStoreV2 } from './store.js';
-export declare function createStore(name: string, config: DataStoreConfig, log?: Logger): Promise<AztecLMDBStoreV2>;
+export declare function createStore(name: string, schemaVersion: number, config: DataStoreConfig, log?: Logger): Promise<AztecLMDBStoreV2>;
 export declare function openTmpStore(name: string, ephemeral?: boolean, dbMapSizeKb?: number, // 10GB
 maxReaders?: number, log?: Logger): Promise<AztecLMDBStoreV2>;
 export declare function openStoreAt(dataDir: string, dbMapSizeKb?: number, // 10GB
 maxReaders?: number, log?: Logger): Promise<AztecLMDBStoreV2>;
+export declare function openVersionedStoreAt(dataDir: string, schemaVersion: number, rollupAddress: EthAddress, dbMapSizeKb?: number, // 10GB
+maxReaders?: number, log?: Logger): Promise<AztecLMDBStoreV2>;
 //# sourceMappingURL=factory.d.ts.map

package/dest/lmdb-v2/factory.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"factory.d.ts","sourceRoot":"","sources":["../../src/lmdb-v2/factory.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,KAAK,MAAM,EAAgB,MAAM,uBAAuB,CAAC;AAMlE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,cAAc,CAAC;AACpD,OAAO,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAC;AAK9C,wBAAsB,WAAW,CAC/B,IAAI,EAAE,MAAM,EACZ,MAAM,EAAE,eAAe,EACvB,GAAG,GAAE,MAAiD,GACrD,OAAO,CAAC,gBAAgB,CAAC,CAsC3B;AAED,wBAAsB,YAAY,CAChC,IAAI,EAAE,MAAM,EACZ,SAAS,GAAE,OAAc,EACzB,WAAW,SAAqB,EAAE,OAAO;AACzC,UAAU,SAAc,EACxB,GAAG,GAAE,MAAiD,GACrD,OAAO,CAAC,gBAAgB,CAAC,CAmB3B;AAED,wBAAgB,WAAW,CACzB,OAAO,EAAE,MAAM,EACf,WAAW,SAAqB,EAAE,OAAO;AACzC,UAAU,SAAc,EACxB,GAAG,GAAE,MAAyC,GAC7C,OAAO,CAAC,gBAAgB,CAAC,CAG3B"}
+{"version":3,"file":"factory.d.ts","sourceRoot":"","sources":["../../src/lmdb-v2/factory.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,+BAA+B,CAAC;AAC3D,OAAO,EAAE,KAAK,MAAM,EAAgB,MAAM,uBAAuB,CAAC;AAOlE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,cAAc,CAAC;AACpD,OAAO,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAC;AAI9C,wBAAsB,WAAW,CAC/B,IAAI,EAAE,MAAM,EACZ,aAAa,EAAE,MAAM,EACrB,MAAM,EAAE,eAAe,EACvB,GAAG,GAAE,MAAiD,GACrD,OAAO,CAAC,gBAAgB,CAAC,CAyB3B;AAED,wBAAsB,YAAY,CAChC,IAAI,EAAE,MAAM,EACZ,SAAS,GAAE,OAAc,EACzB,WAAW,SAAqB,EAAE,OAAO;AACzC,UAAU,SAAc,EACxB,GAAG,GAAE,MAAiD,GACrD,OAAO,CAAC,gBAAgB,CAAC,CAqB3B;AAED,wBAAsB,WAAW,CAC/B,OAAO,EAAE,MAAM,EACf,WAAW,SAAqB,EAAE,OAAO;AACzC,UAAU,SAAc,EACxB,GAAG,GAAE,MAAyC,GAC7C,OAAO,CAAC,gBAAgB,CAAC,CAG3B;AAED,wBAAsB,oBAAoB,CACxC,OAAO,EAAE,MAAM,EACf,aAAa,EAAE,MAAM,EACrB,aAAa,EAAE,UAAU,EACzB,WAAW,SAAqB,EAAE,OAAO;AACzC,UAAU,SAAc,EACxB,GAAG,GAAE,MAAyC,GAC7C,OAAO,CAAC,gBAAgB,CAAC,CAM3B"}

package/dest/lmdb-v2/factory.js

@@ -1,42 +1,25 @@
 import { EthAddress } from '@aztec/foundation/eth-address';
 import { createLogger } from '@aztec/foundation/log';
-import { mkdir, mkdtemp, readFile, rm, writeFile } from 'fs/promises';
+import { DatabaseVersionManager } from '@aztec/stdlib/database-version';
+import { mkdir, mkdtemp, rm } from 'fs/promises';
 import { tmpdir } from 'os';
 import { join } from 'path';
 import { AztecLMDBStoreV2 } from './store.js';
-const ROLLUP_ADDRESS_FILE = 'rollup_address';
 const MAX_READERS = 16;
-export async function createStore(name, config, log = createLogger('kv-store:lmdb-v2:' + name)) {
+export async function createStore(name, schemaVersion, config, log = createLogger('kv-store:lmdb-v2:' + name)) {
     const { dataDirectory, l1Contracts } = config;
     let store;
     if (typeof dataDirectory !== 'undefined') {
+        // Get rollup address from contracts config, or use zero address
         const subDir = join(dataDirectory, name);
         await mkdir(subDir, {
             recursive: true
         });
-        if (l1Contracts) {
-            const { rollupAddress } = l1Contracts;
-            const localRollupAddress = await readFile(join(subDir, ROLLUP_ADDRESS_FILE), 'utf-8').then(EthAddress.fromString).catch(()=>EthAddress.ZERO);
-            if (!localRollupAddress.equals(rollupAddress)) {
-                if (!localRollupAddress.isZero()) {
-                    log.warn(`Rollup address mismatch. Clearing entire database...`, {
-                        expected: rollupAddress,
-                        found: localRollupAddress
-                    });
-                    await rm(subDir, {
-                        recursive: true,
-                        force: true,
-                        maxRetries: 3
-                    });
-                    await mkdir(subDir, {
-                        recursive: true
-                    });
-                }
-                await writeFile(join(subDir, ROLLUP_ADDRESS_FILE), rollupAddress.toString());
-            }
-        }
+        const rollupAddress = l1Contracts ? l1Contracts.rollupAddress : EthAddress.ZERO;
+        // Create a version manager
+        const versionManager = new DatabaseVersionManager(schemaVersion, rollupAddress, subDir, (dbDirectory)=>AztecLMDBStoreV2.new(dbDirectory, config.dataStoreMapSizeKB, MAX_READERS, ()=>Promise.resolve(), log));
         log.info(`Creating ${name} data store at directory ${subDir} with map size ${config.dataStoreMapSizeKB} KB (LMDB v2)`);
-        store = await AztecLMDBStoreV2.new(subDir, config.dataStoreMapSizeKB, MAX_READERS, ()=>Promise.resolve(), log);
+        [store] = await versionManager.open();
     } else {
         store = await openTmpStore(name, true, config.dataStoreMapSizeKB, MAX_READERS, log);
     }
@@ -62,9 +45,16 @@ export async function openTmpStore(name, ephemeral = true, dbMapSizeKb = 10 * 1_
             log.debug(`Leaving temporary data store: ${dataDir}`);
         }
     };
+    // For temporary stores, we don't need to worry about versioning
+    // as they are ephemeral and get cleaned up after use
     return AztecLMDBStoreV2.new(dataDir, dbMapSizeKb, maxReaders, cleanup, log);
 }
-export function openStoreAt(dataDir, dbMapSizeKb = 10 * 1_024 * 1_024, maxReaders = MAX_READERS, log = createLogger('kv-store:lmdb-v2')) {
+export async function openStoreAt(dataDir, dbMapSizeKb = 10 * 1_024 * 1_024, maxReaders = MAX_READERS, log = createLogger('kv-store:lmdb-v2')) {
     log.debug(`Opening data store at: ${dataDir} with size: ${dbMapSizeKb} KB (LMDB v2)`);
-    return AztecLMDBStoreV2.new(dataDir, dbMapSizeKb, maxReaders, undefined, log);
+    return await AztecLMDBStoreV2.new(dataDir, dbMapSizeKb, maxReaders, undefined, log);
+}
+export async function openVersionedStoreAt(dataDir, schemaVersion, rollupAddress, dbMapSizeKb = 10 * 1_024 * 1_024, maxReaders = MAX_READERS, log = createLogger('kv-store:lmdb-v2')) {
+    log.debug(`Opening data store at: ${dataDir} with size: ${dbMapSizeKb} KB (LMDB v2)`);
+    const [store] = await new DatabaseVersionManager(schemaVersion, rollupAddress, dataDir, (dataDir)=>AztecLMDBStoreV2.new(dataDir, dbMapSizeKb, maxReaders, undefined, log)).open();
+    return store;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aztec/kv-store",
-  "version": "0.77.0-testnet-ignition.29",
+  "version": "0.77.0",
   "type": "module",
   "exports": {
     ".": "./dest/interfaces/index.js",
@@ -25,10 +25,10 @@
     "./package.local.json"
   ],
   "dependencies": {
-    "@aztec/ethereum": "0.77.0-testnet-ignition.29",
-    "@aztec/foundation": "0.77.0-testnet-ignition.29",
-    "@aztec/native": "0.77.0-testnet-ignition.29",
-    "@aztec/stdlib": "0.77.0-testnet-ignition.29",
+    "@aztec/ethereum": "0.77.0",
+    "@aztec/foundation": "0.77.0",
+    "@aztec/native": "0.77.0",
+    "@aztec/stdlib": "0.77.0",
     "idb": "^8.0.0",
     "lmdb": "^3.2.0",
     "msgpackr": "^1.11.2",

package/src/lmdb-v2/factory.ts

@@ -1,18 +1,19 @@
 import { EthAddress } from '@aztec/foundation/eth-address';
 import { type Logger, createLogger } from '@aztec/foundation/log';
+import { DatabaseVersionManager } from '@aztec/stdlib/database-version';
 
-import { mkdir, mkdtemp, readFile, rm, writeFile } from 'fs/promises';
+import { mkdir, mkdtemp, rm } from 'fs/promises';
 import { tmpdir } from 'os';
 import { join } from 'path';
 
 import type { DataStoreConfig } from '../config.js';
 import { AztecLMDBStoreV2 } from './store.js';
 
-const ROLLUP_ADDRESS_FILE = 'rollup_address';
 const MAX_READERS = 16;
 
 export async function createStore(
   name: string,
+  schemaVersion: number,
   config: DataStoreConfig,
   log: Logger = createLogger('kv-store:lmdb-v2:' + name),
 ): Promise<AztecLMDBStoreV2> {
@@ -20,34 +21,21 @@ export async function createStore(
 
   let store: AztecLMDBStoreV2;
   if (typeof dataDirectory !== 'undefined') {
+    // Get rollup address from contracts config, or use zero address
     const subDir = join(dataDirectory, name);
     await mkdir(subDir, { recursive: true });
 
-    if (l1Contracts) {
-      const { rollupAddress } = l1Contracts;
-      const localRollupAddress = await readFile(join(subDir, ROLLUP_ADDRESS_FILE), 'utf-8')
-        .then(EthAddress.fromString)
-        .catch(() => EthAddress.ZERO);
+    const rollupAddress = l1Contracts ? l1Contracts.rollupAddress : EthAddress.ZERO;
 
-      if (!localRollupAddress.equals(rollupAddress)) {
-        if (!localRollupAddress.isZero()) {
-          log.warn(`Rollup address mismatch. Clearing entire database...`, {
-            expected: rollupAddress,
-            found: localRollupAddress,
-          });
-
-          await rm(subDir, { recursive: true, force: true, maxRetries: 3 });
-          await mkdir(subDir, { recursive: true });
-        }
-
-        await writeFile(join(subDir, ROLLUP_ADDRESS_FILE), rollupAddress.toString());
-      }
-    }
+    // Create a version manager
+    const versionManager = new DatabaseVersionManager(schemaVersion, rollupAddress, subDir, dbDirectory =>
+      AztecLMDBStoreV2.new(dbDirectory, config.dataStoreMapSizeKB, MAX_READERS, () => Promise.resolve(), log),
+    );
 
     log.info(
       `Creating ${name} data store at directory ${subDir} with map size ${config.dataStoreMapSizeKB} KB (LMDB v2)`,
     );
-    store = await AztecLMDBStoreV2.new(subDir, config.dataStoreMapSizeKB, MAX_READERS, () => Promise.resolve(), log);
+    [store] = await versionManager.open();
   } else {
     store = await openTmpStore(name, true, config.dataStoreMapSizeKB, MAX_READERS, log);
   }
@@ -79,15 +67,32 @@ export async function openTmpStore(
     }
   };
 
+  // For temporary stores, we don't need to worry about versioning
+  // as they are ephemeral and get cleaned up after use
   return AztecLMDBStoreV2.new(dataDir, dbMapSizeKb, maxReaders, cleanup, log);
 }
 
-export function openStoreAt(
+export async function openStoreAt(
+  dataDir: string,
+  dbMapSizeKb = 10 * 1_024 * 1_024, // 10GB
+  maxReaders = MAX_READERS,
+  log: Logger = createLogger('kv-store:lmdb-v2'),
+): Promise<AztecLMDBStoreV2> {
+  log.debug(`Opening data store at: ${dataDir} with size: ${dbMapSizeKb} KB (LMDB v2)`);
+  return await AztecLMDBStoreV2.new(dataDir, dbMapSizeKb, maxReaders, undefined, log);
+}
+
+export async function openVersionedStoreAt(
   dataDir: string,
+  schemaVersion: number,
+  rollupAddress: EthAddress,
   dbMapSizeKb = 10 * 1_024 * 1_024, // 10GB
   maxReaders = MAX_READERS,
   log: Logger = createLogger('kv-store:lmdb-v2'),
 ): Promise<AztecLMDBStoreV2> {
   log.debug(`Opening data store at: ${dataDir} with size: ${dbMapSizeKb} KB (LMDB v2)`);
-  return AztecLMDBStoreV2.new(dataDir, dbMapSizeKb, maxReaders, undefined, log);
+  const [store] = await new DatabaseVersionManager(schemaVersion, rollupAddress, dataDir, dataDir =>
+    AztecLMDBStoreV2.new(dataDir, dbMapSizeKb, maxReaders, undefined, log),
+  ).open();
+  return store;
 }