@agoric/swing-store 0.9.2-u13.0 → 0.9.2-u16.0

package/CHANGELOG.md

@@ -3,50 +3,29 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
-### [0.9.2-u13.0](https://github.com/Agoric/agoric-sdk/compare/@agoric/swing-store@0.9.2-u12.0...@agoric/swing-store@0.9.2-u13.0) (2023-12-07)
+### [0.9.2-u16.0](https://github.com/Agoric/agoric-sdk/compare/@agoric/swing-store@0.9.1...@agoric/swing-store@0.9.2-u16.0) (2024-07-02)
 
 
 ### Features
 
-* add exporter.getHostKV() API ([16435d2](https://github.com/Agoric/agoric-sdk/commit/16435d20e9ede86916a54c7bae54ecfc59e4c950)), closes [#8523](https://github.com/Agoric/agoric-sdk/issues/8523)
-
-
-
-### [0.9.2-u12.0](https://github.com/Agoric/agoric-sdk/compare/@agoric/swing-store@0.9.2-u11wf.0...@agoric/swing-store@0.9.2-u12.0) (2023-11-10)
-
-
-### Features
-
-* **swing-store:** faster import of swing-store ([35aef87](https://github.com/Agoric/agoric-sdk/commit/35aef87ec0f10b7f0cdce462ac0509296e8bd752))
-* **swing-store:** prevent SwingSet usage of imported swing-store ([03f642d](https://github.com/Agoric/agoric-sdk/commit/03f642d39f90ef9465a439723c3a69beef73bd61))
-
-
-### Bug Fixes
-
-* **swing-store:** ensure crank savepoint is wrapped in transaction ([8d738c6](https://github.com/Agoric/agoric-sdk/commit/8d738c65ed37b9159e94fbcf291ed7fe8478ee5a))
-
-
-
-### [0.9.2-u11wf.0](https://github.com/Agoric/agoric-sdk/compare/@agoric/swing-store@0.9.2-u11.0...@agoric/swing-store@0.9.2-u11wf.0) (2023-09-23)
-
-**Note:** Version bump only for package @agoric/swing-store
-
-
-
-
-
-### [0.9.2-u11.0](https://github.com/Agoric/agoric-sdk/compare/@agoric/swing-store@0.9.1...@agoric/swing-store@0.9.2-u11.0) (2023-08-24)
-
-
-### Features
-
-* **swingstore:** add repairMetadata() ([5b2d19d](https://github.com/Agoric/agoric-sdk/commit/5b2d19d1153a23c118afb14ca4ed80e175640f62)), closes [#8025](https://github.com/Agoric/agoric-sdk/issues/8025) [#8025](https://github.com/Agoric/agoric-sdk/issues/8025)
+* add exporter.getHostKV() API ([eb564f9](https://github.com/Agoric/agoric-sdk/commit/eb564f9635397c0706e1f8255b3e125681e2d031)), closes [#8523](https://github.com/Agoric/agoric-sdk/issues/8523)
+* **swing-store:** faster import of swing-store ([0170568](https://github.com/Agoric/agoric-sdk/commit/0170568d66748af76f0bd24a4acdaa34b9c79cca))
+* **swing-store:** prevent SwingSet usage of imported swing-store ([6a833eb](https://github.com/Agoric/agoric-sdk/commit/6a833ebda2b2ff0e72040ca8186f93ae91567add))
+* **swingstore:** add repairMetadata() ([33b5c1c](https://github.com/Agoric/agoric-sdk/commit/33b5c1c1fefd5278a24cd5f06630b238439e2891)), closes [#8025](https://github.com/Agoric/agoric-sdk/issues/8025) [#8025](https://github.com/Agoric/agoric-sdk/issues/8025)
+* tool for auditing dangling kindID references ([eeadc46](https://github.com/Agoric/agoric-sdk/commit/eeadc462d8fb09449e4ea6f0118ae8654e0c8e9b)), closes [#7655](https://github.com/Agoric/agoric-sdk/issues/7655)
 
 
 ### Bug Fixes
 
-* **swing-store:** add 'replay' artifactMode, make export more strict ([d46c8e2](https://github.com/Agoric/agoric-sdk/commit/d46c8e2d270999ccba552e0072cb5e0926922f28)), closes [#8105](https://github.com/Agoric/agoric-sdk/issues/8105)
-* rewrite importSwingStore to preserve metadata properly ([03e323a](https://github.com/Agoric/agoric-sdk/commit/03e323a55ffeb98dcc84a57050a5d3fc881899b8)), closes [#8025](https://github.com/Agoric/agoric-sdk/issues/8025)
+* misc runtime robustness found by typecheck ([a033f26](https://github.com/Agoric/agoric-sdk/commit/a033f2638f9f11e19d94d7931e4e0614773b1f60))
+* performance.now() binding ([4a3b59b](https://github.com/Agoric/agoric-sdk/commit/4a3b59b486c0cb916e531d5de390fbf90e4421ad))
+* rewrite importSwingStore to preserve metadata properly ([38c9efc](https://github.com/Agoric/agoric-sdk/commit/38c9efce10957e0eb245e25ae5f9f45792eb58ad)), closes [#8025](https://github.com/Agoric/agoric-sdk/issues/8025)
+* **swing-store:** add 'replay' artifactMode, make export more strict ([9939ea6](https://github.com/Agoric/agoric-sdk/commit/9939ea699bb1fd0b711f950679b432eef9054fda)), closes [#8105](https://github.com/Agoric/agoric-sdk/issues/8105)
+* **swing-store:** ensure crank savepoint is wrapped in transaction ([9d2dd3f](https://github.com/Agoric/agoric-sdk/commit/9d2dd3f9966940961a4c21351d256fa3615715d7))
+* **swing-store:** explicitly harden prototypes ([86c128a](https://github.com/Agoric/agoric-sdk/commit/86c128a29b5ed61764a67644c3734b0c05df2993))
+* **swing-store:** no completeness check when creating exporter ([d4df073](https://github.com/Agoric/agoric-sdk/commit/d4df073ffcc48b0f0e62bac107ee8edf21150ad9))
+* **types:** template syntax ([279b903](https://github.com/Agoric/agoric-sdk/commit/279b903a559710511d69f1614badddeab801b90d))
+* update for `[@jessie](https://github.com/jessie).js/safe-await-separator` ([94c6b3c](https://github.com/Agoric/agoric-sdk/commit/94c6b3c83a5326594f1e2886ae01d6a703a7a68f))
 
 
 

package/docs/data-export.md

@@ -39,30 +39,41 @@ The exporter is created by calling `makeSwingStoreExporter(dirpath)`, passing it
 After calling `hostStorage.commit()`, the host application can extract the first-stage export data, and then the second-stage export artifacts:
 
 ```js
-   import { buffer } from 'node:stream/consumers';
-
-   const dirPath = '.../swing-store';
-   const swingStore = openSwingStore(dirPath);
-   ...
-   await controller.run();
-   hostStorage.commit();
-   // spawn a child process
-
-  // child process does:
-  const exporter = makeSwingStoreExporter(dirPath);
-  // exporter now has a txn, parent process is free to proceed forward
-  const exportData = new Map();
-  for (const [key, value] of exporter.getExportData()) {
-    exportData.set(key, value);
+const dirPath = '.../swing-store';
+const swingStore = openSwingStore(dirPath);
+...
+await controller.run();
+hostStorage.commit();
+// spawn a child process and wait for it to open a transaction
+const started = makePromiseKit();
+const child = fork(path, args);
+child.on('error', started.reject);
+child.on('exit', started.reject);
+child.on('message', msg => {
+  if (msg?.type === 'started') {
+    started.resolve();
   }
-  const exportArtifacts = new Map();
-  for (const name of exporter.getArtifactNames()) {
-    const reader = exporter.getArtifact(name);
-    // reader is an async iterable of Uint8Array, e.g. a stream
-    const data = await buffer(reader);
-    exportArtifacts.set(name, data);
-  }
-  // export is 'exportData' and 'exportArtifacts'
+});
+await started.promise;
+...
+
+// child process does:
+import { buffer } from 'node:stream/consumers';
+const exporter = makeSwingStoreExporter(dirPath);
+// exporter now has a txn, so parent process is free to proceed forward
+process.send({ type: 'started' });
+const exportData = new Map();
+for (const [key, value] of exporter.getExportData()) {
+  exportData.set(key, value);
+}
+const exportArtifacts = new Map();
+for (const name of exporter.getArtifactNames()) {
+  const reader = exporter.getArtifact(name);
+  // reader is an async iterable of Uint8Array, e.g. a stream
+  const data = await buffer(reader);
+  exportArtifacts.set(name, data);
+}
+// export is the combination of 'exportData' and 'exportArtifacts'
 ```
 
 ![image 3](./images/data-export-3.jpg)
@@ -92,35 +103,51 @@ Then, on the few occasions when the application needs to build a full state-sync
 ![image 4](./images/data-export-4.jpg)
 
 ```js
-   const dirPath = '.../swing-store';
-   const iavl = ...;
-   function exportCallback(key, value) {
-     const iavlKey = `ssed.${key}`; // 'ssed' is short for SwingStoreExportData
-     if (value) {
-       iavl.set(iavlKey, value);
-     } else {
-       iavl.delete(iavlKey); // value===undefined means delete
-     }
-   }
-   const swingStore = openSwingStore(dirPath, { exportCallback });
-   ...
-   await controller.run();
-   hostStorage.commit();
-
-   // now, if the validator is configured to publish state-sync snapshots,
-   // and if this block height is one of the publishing points,
-   // do the following:
-
-  // spawn a child process
-
-  // child process does:
-  const exporter = makeSwingStoreExporter(dirPath);
-  // note: no exporter.getExportData(), the first-stage data is already in IAVL
-  const artifacts = new Map();
-  for (const name of exporter.getArtifactNames()) {
-    artifacts.set(name, exporter.getArtifact(name));
+const dirPath = '.../swing-store';
+const iavl = ...;
+function exportCallback(key, value) {
+  const iavlKey = `ssed.${key}`; // 'ssed' is short for SwingStoreExportData
+  if (value === undefined) {
+    iavl.delete(iavlKey);
+  } else {
+    iavl.set(iavlKey, value);
+  }
+}
+const swingStore = openSwingStore(dirPath, { exportCallback });
+...
+await controller.run();
+hostStorage.commit();
+
+// now, if the validator is configured to publish state-sync snapshots,
+// and if this block height is one of the publishing points,
+// do the following:
+
+// spawn a child process and wait for it to open a transaction
+const started = makePromiseKit();
+const child = fork(path, args);
+child.on('error', started.reject);
+child.on('exit', started.reject);
+child.on('message', msg => {
+  if (msg?.type === 'started') {
+    started.resolve();
   }
-  // instruct cosmos-sdk to include 'artifacts' in the state-sync snapshot
+});
+try {
+  await started.promise;
+} catch (err) {
+  ...
+}
+...
+
+// child process does:
+const exporter = makeSwingStoreExporter(dirPath);
+process.send({ type: 'started' });
+// note: no exporter.getExportData(), the first-stage data is already in IAVL
+const artifacts = new Map();
+for (const name of exporter.getArtifactNames()) {
+  artifacts.set(name, exporter.getArtifact(name));
+}
+// instruct cosmos-sdk to include 'artifacts' in the state-sync snapshot
 ```
 
 ## Import
@@ -202,7 +229,7 @@ SwingStore contains components to accommodate all the various kinds of state tha
 * `kvStore`, a general-purpose string/string key-value table
 * `transcriptStore`: append-only vat deliveries, broken into "spans", delimited by heap snapshot events
 * `snapshotStore`: binary blobs containing JS engine heap state, to limit transcript replay depth
-* `bundleStore`: code bundles that can be imported with `@endo/import-bundle`
+* `bundleStore`: code bundles that can be imported with [@endo/import-bundle](https://www.npmjs.com/package/@endo/import-bundle)
 
 Currently, the SwingStore treats transcript spans, heap snapshots, and bundles as export artifacts, with hashes recorded in the export data for validation (and to remember exactly which artifacts are necessary). The `kvStore` is copied one-to-one into the export data (i.e. we keep a full shadow copy in IAVL), because that is the fastest way to ensure the `kvStore` data is fully available and validated.
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@agoric/swing-store",
-  "version": "0.9.2-u13.0",
+  "version": "0.9.2-u16.0",
   "description": "Persistent storage for SwingSet",
   "type": "module",
   "main": "./src/index.js",
@@ -17,23 +17,23 @@
     "test:xs": "exit 0",
     "lint-fix": "yarn lint:eslint --fix",
     "lint": "run-s --continue-on-error lint:*",
-    "lint:types": "tsc -p jsconfig.json",
+    "lint:types": "tsc",
     "lint:eslint": "eslint ."
   },
   "dependencies": {
-    "@agoric/assert": "^0.6.1-u11wf.0",
-    "@agoric/internal": "^0.4.0-u13.0",
-    "@endo/base64": "0.2.31",
-    "@endo/bundle-source": "2.5.2-upstream-rollup",
-    "@endo/check-bundle": "0.2.18",
-    "@endo/nat": "4.1.27",
-    "better-sqlite3": "^8.2.0"
+    "@agoric/assert": "^0.6.1-u16.0",
+    "@agoric/internal": "^0.4.0-u16.0",
+    "@endo/base64": "^1.0.5",
+    "@endo/bundle-source": "^3.2.3",
+    "@endo/check-bundle": "^1.0.7",
+    "@endo/nat": "^5.0.7",
+    "better-sqlite3": "^9.1.1"
   },
   "devDependencies": {
-    "@endo/init": "0.5.56",
-    "@types/better-sqlite3": "^7.5.0",
-    "ava": "^5.2.0",
-    "c8": "^7.13.0",
+    "@endo/init": "^1.1.2",
+    "@types/better-sqlite3": "^7.6.9",
+    "ava": "^5.3.0",
+    "c8": "^9.1.0",
     "tmp": "^0.2.1"
   },
   "publishConfig": {
@@ -41,9 +41,15 @@
   },
   "ava": {
     "files": [
-      "test/**/test-*.js"
+      "test/**/*.test.*"
+    ],
+    "require": [
+      "@endo/init/debug.js"
     ],
     "timeout": "2m"
   },
-  "gitHead": "5a6cdeb0c18ae9700d706445acf402f8d1e873c3"
+  "typeCoverage": {
+    "atLeast": 76.31
+  },
+  "gitHead": "bbdf652c3f413381cb352a8a360db1063974fafd"
 }

package/src/bundleStore.js

@@ -15,7 +15,7 @@ import { createSHA256 } from './hasher.js';
  * @typedef { EndoZipBase64Bundle | GetExportBundle | NestedEvaluateBundle } Bundle
  */
 /**
- * @typedef { import('./exporter').SwingStoreExporter } SwingStoreExporter
+ * @typedef { import('./exporter.js').SwingStoreExporter } SwingStoreExporter
  * @typedef { import('./internal.js').ArtifactMode } ArtifactMode
  *
  * @typedef {{
@@ -267,6 +267,7 @@ export function makeBundleStore(db, ensureTxn, noteExport = () => {}) {
     const rawBundle = row.bundle || Fail`bundle ${q(bundleID)} pruned`;
     yield* Readable.from(Buffer.from(rawBundle));
   }
+  harden(exportBundle);
 
   const sqlGetBundleIDs = db.prepare(`
     SELECT bundleID
@@ -286,12 +287,14 @@ export function makeBundleStore(db, ensureTxn, noteExport = () => {}) {
       yield [bundleArtifactName(bundleID), bundleID];
     }
   }
+  harden(getExportRecords);
 
   async function* getArtifactNames() {
     for (const bundleID of sqlGetBundleIDs.iterate()) {
       yield bundleArtifactName(bundleID);
     }
   }
+  harden(getArtifactNames);
 
   function computeSha512(bytes) {
     const hash = createHash('sha512');
@@ -328,7 +331,6 @@ export function makeBundleStore(db, ensureTxn, noteExport = () => {}) {
         endoZipBase64: encodeBase64(data),
       });
       // Assert that the bundle contents match the ID and hash
-      // eslint-disable-next-line @jessie.js/no-nested-await
       await checkBundle(bundle, computeSha512, bundleID);
       populateBundle(bundleID, serializeBundle(bundleID, bundle));
     } else {
@@ -365,6 +367,7 @@ export function makeBundleStore(db, ensureTxn, noteExport = () => {}) {
   function* getBundleIDs() {
     yield* sqlListBundleIDs.iterate();
   }
+  harden(getBundleIDs);
 
   return harden({
     importBundleRecord,

package/src/exporter.js

@@ -13,11 +13,11 @@ import { validateArtifactMode } from './internal.js';
 
 /**
  * @template T
- *  @typedef  { Iterable<T> | AsyncIterable<T> } AnyIterable<T>
+ * @typedef  { Iterable<T> | AsyncIterable<T> } AnyIterable
  */
 /**
  * @template T
- *  @typedef  { IterableIterator<T> | AsyncIterableIterator<T> } AnyIterableIterator<T>
+ * @typedef  { IterableIterator<T> | AsyncIterableIterator<T> } AnyIterableIterator
  */
 
 /**
@@ -111,12 +111,6 @@ export function makeSwingStoreExporter(dirPath, options = {}) {
   const bundleStore = makeBundleStore(db, ensureTxn);
   const transcriptStore = makeTranscriptStore(db, ensureTxn, () => {});
 
-  if (artifactMode !== 'debug') {
-    // throw early if this DB will not be able to create all the desired artifacts
-    const internal = { snapStore, bundleStore, transcriptStore };
-    assertComplete(internal, artifactMode);
-  }
-
   const sqlKVGet = db.prepare(`
     SELECT value
     FROM kvStore
@@ -141,9 +135,11 @@ export function makeSwingStoreExporter(dirPath, options = {}) {
   function getHostKV(key) {
     typeof key === 'string' || Fail`key must be a string`;
     getKeyType(key) === 'host' || Fail`getHostKV requires host keys`;
+    // @ts-expect-error unknown
     return sqlKVGet.get(key);
   }
 
+  /** @type {any} */
   const sqlGetAllKVData = db.prepare(`
     SELECT key, value
     FROM kvStore
@@ -164,16 +160,27 @@ export function makeSwingStoreExporter(dirPath, options = {}) {
     yield* transcriptStore.getExportRecords(true);
     yield* bundleStore.getExportRecords();
   }
+  harden(getExportData);
 
-  /**
-   * @returns {AsyncIterableIterator<string>}
-   * @yields {string}
-   */
-  async function* getArtifactNames() {
+  /** @yields {string} */
+  async function* artifactNames() {
     yield* snapStore.getArtifactNames(artifactMode);
     yield* transcriptStore.getArtifactNames(artifactMode);
     yield* bundleStore.getArtifactNames();
   }
+  harden(artifactNames);
+
+  /**
+   * @returns {AsyncIterableIterator<string>}
+   */
+  function getArtifactNames() {
+    if (artifactMode !== 'debug') {
+      // throw if this DB will not be able to yield all the desired artifacts
+      const internal = { snapStore, bundleStore, transcriptStore };
+      assertComplete(internal, artifactMode);
+    }
+    return artifactNames();
+  }
 
   /**
    * @param {string} name

package/src/importer.js

@@ -17,10 +17,10 @@ import { assertComplete } from './assertComplete.js';
  * returned swingStore is not suitable for execution, and thus only contains
  * the host facet for committing the populated swingStore.
  *
- * @param {import('./exporter').SwingStoreExporter} exporter
+ * @param {import('./exporter.js').SwingStoreExporter} exporter
  * @param {string | null} [dirPath]
  * @param {ImportSwingStoreOptions} [options]
- * @returns {Promise<Pick<import('./swingStore').SwingStore, 'hostStorage' | 'debug'>>}
+ * @returns {Promise<Pick<import('./swingStore.js').SwingStore, 'hostStorage' | 'debug'>>}
  */
 export async function importSwingStore(exporter, dirPath = null, options = {}) {
   if (dirPath && typeof dirPath !== 'string') {

package/src/internal.js

@@ -1,9 +1,9 @@
 import { Fail, q } from '@agoric/assert';
 
 /**
- * @typedef { import('./snapStore').SnapStoreInternal } SnapStoreInternal
- * @typedef { import('./transcriptStore').TranscriptStoreInternal } TranscriptStoreInternal
- * @typedef { import('./bundleStore').BundleStoreInternal } BundleStoreInternal
+ * @typedef { import('./snapStore.js').SnapStoreInternal } SnapStoreInternal
+ * @typedef { import('./transcriptStore.js').TranscriptStoreInternal } TranscriptStoreInternal
+ * @typedef { import('./bundleStore.js').BundleStoreInternal } BundleStoreInternal
  *
  * @typedef {{
  *    transcriptStore: TranscriptStoreInternal,

package/src/repairMetadata.js

@@ -25,7 +25,7 @@ import { assertComplete } from './assertComplete.js';
  * `hostStorage.commit()` when they are ready.
  *
  * @param {import('./internal.js').SwingStoreInternal} internal
- * @param {import('./exporter').SwingStoreExporter} exporter
+ * @param {import('./exporter.js').SwingStoreExporter} exporter
  * @returns {Promise<void>}
  */
 export async function doRepairMetadata(internal, exporter) {

package/src/snapStore.js

@@ -4,7 +4,10 @@ import { finished as finishedCallback, PassThrough, Readable } from 'stream';
 import { promisify } from 'util';
 import { createGzip, createGunzip } from 'zlib';
 import { Fail, q } from '@agoric/assert';
-import { aggregateTryFinally, PromiseAllOrErrors } from '@agoric/internal';
+import {
+  aggregateTryFinally,
+  PromiseAllOrErrors,
+} from '@agoric/internal/src/node/utils.js';
 import { buffer } from './util.js';
 
 /**
@@ -25,12 +28,11 @@ import { buffer } from './util.js';
  */
 
 /**
- * @template T
- *  @typedef { import('./exporter').AnyIterableIterator<T> } AnyIterableIterator<T>
+ * @import {AnyIterableIterator} from './exporter.js'
  */
 
 /**
- * @typedef { import('./exporter').SwingStoreExporter } SwingStoreExporter
+ * @typedef { import('./exporter.js').SwingStoreExporter } SwingStoreExporter
  * @typedef { import('./internal.js').ArtifactMode } ArtifactMode
  *
  * @typedef {{
@@ -306,6 +308,7 @@ export function makeSnapStore(
       const snapshotReader = gzReader.pipe(unzipper);
       yield* snapshotReader;
     }
+    harden(exporter);
     return exporter();
   }
 
@@ -333,17 +336,18 @@ export function makeSnapStore(
     snapReader.pipe(hashStream);
     snapReader.pipe(output);
 
+    await null;
     try {
       yield* output;
     } finally {
       gzReader.destroy();
-      // eslint-disable-next-line @jessie.js/no-nested-await
       await finished(gzReader);
       const hash = hashStream.digest('hex');
       hash === snapshotID ||
         Fail`actual hash ${q(hash)} !== expected ${q(snapshotID)}`;
     }
   }
+  harden(loadSnapshot);
 
   const sqlDeleteVatSnapshots = db.prepare(`
     DELETE FROM snapshots
@@ -481,6 +485,7 @@ export function makeSnapStore(
       }
     }
   }
+  harden(getExportRecords);
 
   async function* getArtifactNames(artifactMode) {
     for (const rec of sqlGetAvailableSnapshots.iterate(1)) {
@@ -492,6 +497,7 @@ export function makeSnapStore(
       }
     }
   }
+  harden(getArtifactNames);
 
   const sqlAddSnapshotRecord = db.prepare(`
     INSERT INTO snapshots (vatID, snapPos, hash, inUse)
@@ -640,6 +646,7 @@ export function makeSnapStore(
   function* listAllSnapshots() {
     yield* sqlListAllSnapshots.iterate();
   }
+  harden(listAllSnapshots);
 
   const sqlDumpCurrentSnapshots = db.prepare(`
     SELECT vatID, snapPos, hash, compressedSnapshot, inUse

package/src/snapStoreIO.js

@@ -3,6 +3,6 @@ import { makeMeasureSeconds } from '@agoric/internal';
 
 export function makeSnapStoreIO() {
   return {
-    measureSeconds: makeMeasureSeconds(performance.now),
+    measureSeconds: makeMeasureSeconds(performance.now.bind(performance)),
   };
 }

package/src/swingStore.js

@@ -1,7 +1,7 @@
 // @ts-check
 /* global Buffer */
-import fs from 'fs';
-import path from 'path';
+import * as fs from 'fs';
+import * as path from 'path';
 
 import sqlite3 from 'better-sqlite3';
 
@@ -17,18 +17,18 @@ import { makeSnapStoreIO } from './snapStoreIO.js';
 import { doRepairMetadata } from './repairMetadata.js';
 
 /**
- * @typedef { import('./kvStore').KVStore } KVStore
+ * @typedef { import('./kvStore.js').KVStore } KVStore
  *
- * @typedef { import('./snapStore').SnapStore } SnapStore
- * @typedef { import('./snapStore').SnapshotResult } SnapshotResult
+ * @typedef { import('./snapStore.js').SnapStore } SnapStore
+ * @typedef { import('./snapStore.js').SnapshotResult } SnapshotResult
  *
- * @typedef { import('./transcriptStore').TranscriptStore } TranscriptStore
- * @typedef { import('./transcriptStore').TranscriptStoreDebug } TranscriptStoreDebug
+ * @typedef { import('./transcriptStore.js').TranscriptStore } TranscriptStore
+ * @typedef { import('./transcriptStore.js').TranscriptStoreDebug } TranscriptStoreDebug
  *
- * @typedef { import('./bundleStore').BundleStore } BundleStore
- * @typedef { import('./bundleStore').BundleStoreDebug } BundleStoreDebug
+ * @typedef { import('./bundleStore.js').BundleStore } BundleStore
+ * @typedef { import('./bundleStore.js').BundleStoreDebug } BundleStoreDebug
  *
- * @typedef { import('./exporter').KVPair } KVPair
+ * @typedef { import('./exporter.js').KVPair } KVPair
  *
  * @typedef {{
  *   kvStore: KVStore, // a key-value API object to load and store data on behalf of the kernel
@@ -49,7 +49,7 @@ import { doRepairMetadata } from './repairMetadata.js';
  *   close: () => Promise<void>,   // shutdown the store, abandoning any uncommitted changes
  *   diskUsage?: () => number, // optional stats method
  *   setExportCallback: (cb: (updates: KVPair[]) => void) => void, // Set a callback invoked by swingStore when new serializable data is available for export
- *   repairMetadata: (exporter: import('./exporter').SwingStoreExporter) => Promise<void>,
+ *   repairMetadata: (exporter: import('./exporter.js').SwingStoreExporter) => Promise<void>,
  * }} SwingStoreHostStorage
  */
 
@@ -543,6 +543,10 @@ export function makeSwingStore(dirPath, forceReset, options = {}) {
     });
   }
 
+  function getDatabase() {
+    return db;
+  }
+
   const transcriptStorePublic = {
     initTranscript: transcriptStore.initTranscript,
     rolloverSpan: transcriptStore.rolloverSpan,
@@ -592,6 +596,7 @@ export function makeSwingStore(dirPath, forceReset, options = {}) {
   const debug = {
     serialize,
     dump,
+    getDatabase,
   };
 
   return harden({

package/src/transcriptStore.js

@@ -43,6 +43,7 @@ import { createSHA256 } from './hasher.js';
 function* empty() {
   // Yield nothing
 }
+harden(empty);
 
 /**
  * @param {number} position
@@ -158,6 +159,7 @@ export function makeTranscriptStore(
       }
     }
   }
+  harden(readFullVatTranscript);
 
   function spanArtifactName(rec) {
     return `transcript.${rec.vatID}.${rec.startPos}.${rec.endPos}`;
@@ -393,6 +395,7 @@ export function makeTranscriptStore(
       }
     }
   }
+  harden(getExportRecords);
 
   const sqlCountSpanItems = db.prepare(`
     SELECT COUNT(*) FROM transcriptItems
@@ -447,6 +450,7 @@ export function makeTranscriptStore(
       }
     }
   }
+  harden(getArtifactNames);
 
   const sqlGetSpanEndPos = db.prepare(`
     SELECT endPos
@@ -501,6 +505,7 @@ export function makeTranscriptStore(
           expectedCount,
         )})`;
     }
+    harden(reader);
 
     if (startPos === endPos) {
       return empty();
@@ -541,6 +546,7 @@ export function makeTranscriptStore(
       yield Buffer.from(`${entry}\n`);
     }
   }
+  harden(exportSpan);
 
   const sqlAddItem = db.prepare(`
     INSERT INTO transcriptItems (vatID, item, position, incarnation)

package/src/util.js

@@ -6,7 +6,7 @@ import { Buffer } from 'buffer';
  * 'stream/consumers' package, which unfortunately only exists in newer versions
  * of Node.
  *
- * @param {import('./exporter').AnyIterable<Uint8Array>} inStream
+ * @param {import('./exporter.js').AnyIterable<Uint8Array>} inStream
  */
 export const buffer = async inStream => {
   const chunks = [];

package/test/{test-bundles.js → bundles.test.js}

@@ -1,5 +1,4 @@
 // @ts-check
-import '@endo/init/debug.js';
 import test from 'ava';
 import tmp from 'tmp';
 import { Buffer } from 'buffer';
@@ -162,7 +161,7 @@ test('unknown format', t => {
   const { kernelStorage } = initSwingStore();
   const { bundleStore } = kernelStorage;
   const unknownID = 'b1999-whoa-futuristic';
-  /** @typedef {import('../src/bundleStore.js').Bundle} Bundle */
+  /** @import {Bundle} from '../src/bundleStore.js' */
   t.throws(() => bundleStore.addBundle(unknownID, /** @type {Bundle} */ ({})), {
     message: /unsupported BundleID/,
   });

package/test/{test-deletion.js → deletion.test.js}

@@ -1,12 +1,12 @@
 // @ts-check
 import test from 'ava';
-import '@endo/init/debug.js';
 import { Buffer } from 'node:buffer';
 import { initSwingStore } from '../src/swingStore.js';
 
 async function* getSnapshotStream() {
   yield Buffer.from('abc');
 }
+harden(getSnapshotStream);
 
 test('delete snapshots with export callback', async t => {
   const exportLog = [];

package/test/{test-export.js → export.test.js}

@@ -1,5 +1,3 @@
-import '@endo/init/debug.js';
-
 import test from 'ava';
 
 import { buffer } from '../src/util.js';
@@ -83,7 +81,7 @@ const exportTest = test.macro(async (t, mode) => {
   // historical transcript spans, and no historical snapshots
 
   assert.typeof(mode, 'string');
-  /** @typedef {import('../src/internal.js').ArtifactMode} ArtifactMode */
+  /** @import {ArtifactMode} from '../src/internal.js' */
   let artifactMode = /** @type {ArtifactMode} */ (mode);
   if (mode === 'debug-on-pruned') {
     artifactMode = 'debug';

package/test/{test-exportImport.js → exportImport.test.js}

@@ -1,11 +1,8 @@
 // @ts-check
 
-import '@endo/init/debug.js';
 import { Buffer } from 'node:buffer';
 
-// eslint-disable-next-line import/no-extraneous-dependencies
 import test from 'ava';
-// eslint-disable-next-line import/no-extraneous-dependencies
 import tmp from 'tmp';
 import bundleSource from '@endo/bundle-source';
 
@@ -55,7 +52,7 @@ async function embundle(filename) {
   const bundleFile = new URL(filename, import.meta.url).pathname;
   const bundle = await bundleSource(bundleFile);
   const bundleID = `b1-${bundle.endoZipBase64Sha512}`;
-  return [bundleID, bundle];
+  return /** @type {const} */ ([bundleID, bundle]);
 }
 
 function actLikeAVatRunningACrank(vat, ks, crank, doFail) {
@@ -86,6 +83,7 @@ async function fakeAVatSnapshot(vat, ks) {
   async function* getSnapshotStream() {
     yield Buffer.from(`snapshot of vat ${vat.vatID} as of ${vat.endPos}`);
   }
+  harden(getSnapshotStream);
   await ks.snapStore.saveSnapshot(vat.vatID, vat.endPos, getSnapshotStream());
   ks.transcriptStore.addItem(vat.vatID, 'save-snapshot');
   vat.endPos += 1;
@@ -122,7 +120,6 @@ test('crank abort leaves no debris in export log', async t => {
         crankNum % 3 === 0,
       );
     }
-    // eslint-disable-next-line no-await-in-loop
     await ssOut.hostStorage.commit();
   }
 
@@ -218,22 +215,21 @@ async function testExportImport(
       actLikeAVatRunningACrank(vat, kernelStorage, crankNum);
     }
     if (block < 3) {
-      // eslint-disable-next-line no-await-in-loop
       await fakeAVatSnapshot(vats[block % 2], kernelStorage);
     }
-    // eslint-disable-next-line no-await-in-loop
     await ssOut.hostStorage.commit();
   }
 
+  // the exporter may be broken (the swingstore may be incomplete), but that is
+  // signaled during `getArtifactNames()`, not during construction (which must
+  // finish quickly, without scanning the whole DB)
+  const exporter = makeSwingStoreExporter(dbDir, { artifactMode: exportMode });
+
   const incomplete = 'incomplete archival transcript: 3 vs 12';
-  function doExport() {
-    return makeSwingStoreExporter(dbDir, { artifactMode: exportMode });
-  }
   if (failureMode === 'export') {
-    await t.throws(doExport, { message: incomplete });
+    await t.throws(() => exporter.getArtifactNames(), { message: incomplete });
     return;
   }
-  const exporter = doExport();
 
   const exportData = [];
   for await (const elem of exporter.getExportData()) {

package/test/exports.js

@@ -0,0 +1,102 @@
+import { Buffer } from 'buffer';
+import { makeB0ID } from './util.js';
+
+export const snapshotData = 'snapshot data';
+// this snapHash was computed manually
+export const snapHash =
+  'e7dee7266896538616b630a5da40a90e007726a383e005a9c9c5dd0c2daf9329';
+
+/** @type {import('../src/bundleStore.js').Bundle} */
+export const bundle0 = { moduleFormat: 'nestedEvaluate', source: '1+1' };
+export const bundle0ID = makeB0ID(bundle0);
+
+export function buildData() {
+  // build an export manually
+  const exportData = new Map();
+  const artifacts = new Map();
+
+  // shadow kvStore
+  exportData.set('kv.key1', 'value1');
+
+  // now add artifacts and metadata in pairs
+
+  artifacts.set(`bundle.${bundle0ID}`, JSON.stringify(bundle0));
+  exportData.set(`bundle.${bundle0ID}`, bundle0ID);
+
+  const sbase = { vatID: 'v1', hash: snapHash, inUse: 0 };
+  const tbase = { vatID: 'v1', startPos: 0, isCurrent: 0, incarnation: 1 };
+  const addTS = (key, obj) =>
+    exportData.set(key, JSON.stringify({ ...tbase, ...obj }));
+  const t0hash =
+    '5bee0f44eca02f23eab03703e84ed2647d5d117fed99e1c30a3b424b7f082ab9';
+  const t2hash =
+    '57152efdd7fdf75c03371d2b4f1088d5bf3eae7fe643babce527ff81df38998c';
+  const t5hash =
+    '1947001e78e01bd1e773feb22b4ffc530447373b9de9274d5d5fbda3f23dbf2b';
+  const t8hash =
+    'e6b42c6a3fb94285a93162f25a9fc0145fd4c5bb144917dc572c50ae2d02ee69';
+
+  addTS(`transcript.v1.0`, { incarnation: 0, endPos: 2, hash: t0hash });
+  artifacts.set(`transcript.v1.0.2`, 'start-worker\nshutdown-worker\n');
+
+  addTS(`transcript.v1.2`, { startPos: 2, endPos: 5, hash: t2hash });
+  artifacts.set(
+    `transcript.v1.2.5`,
+    'start-worker\ndelivery1\nsave-snapshot\n',
+  );
+  exportData.set(`snapshot.v1.4`, JSON.stringify({ ...sbase, snapPos: 4 }));
+  artifacts.set(`snapshot.v1.4`, snapshotData);
+
+  addTS(`transcript.v1.5`, { startPos: 5, endPos: 8, hash: t5hash });
+  artifacts.set(
+    'transcript.v1.5.8',
+    'load-snapshot\ndelivery2\nsave-snapshot\n',
+  );
+  exportData.set(
+    `snapshot.v1.7`,
+    JSON.stringify({ ...sbase, snapPos: 7, inUse: 1 }),
+  );
+  artifacts.set(`snapshot.v1.7`, snapshotData);
+
+  artifacts.set('transcript.v1.8.10', 'load-snapshot\ndelivery3\n');
+  exportData.set(`snapshot.v1.current`, 'snapshot.v1.7');
+  addTS(`transcript.v1.current`, {
+    startPos: 8,
+    endPos: 10,
+    isCurrent: 1,
+    hash: t8hash,
+  });
+
+  return { exportData, artifacts, t0hash, t2hash, t5hash, t8hash };
+}
+
+/**
+ * @param { Map<string, string | null> } exportData
+ * @param { Map<string, string> } artifacts
+ */
+export function makeExporter(exportData, artifacts) {
+  return {
+    getHostKV(_key) {
+      return undefined;
+    },
+    async *getExportData() {
+      for (const [key, value] of exportData.entries()) {
+        /** @type { import('../src/exporter.js').KVPair } */
+        const pair = [key, value];
+        yield pair;
+      }
+    },
+    async *getArtifactNames() {
+      for (const name of artifacts.keys()) {
+        yield name;
+      }
+    },
+    async *getArtifact(name) {
+      const data = artifacts.get(name);
+      assert(data, `missing artifact ${name}`);
+      yield Buffer.from(data);
+    },
+    // eslint-disable-next-line no-empty-function
+    async close() {},
+  };
+}

package/test/{test-hasher.js → hasher.test.js}

@@ -1,7 +1,5 @@
-import '@endo/init/debug.js';
 import test from 'ava';
 
-// eslint-disable-next-line import/order
 import { createSHA256 } from '../src/hasher.js';
 
 test('createSHA256', t => {

package/test/{test-import.js → import.test.js}

@@ -1,7 +1,5 @@
 // @ts-check
 
-import '@endo/init/debug.js';
-
 import path from 'path';
 import { createGunzip } from 'zlib';
 import { Readable } from 'stream';
@@ -14,7 +12,15 @@ import { decodeBase64 } from '@endo/base64';
 import { buffer } from '../src/util.js';
 import { importSwingStore, makeSwingStoreExporter } from '../src/index.js';
 
-import { tmpDir, makeB0ID } from './util.js';
+import { tmpDir } from './util.js';
+import {
+  buildData,
+  bundle0,
+  bundle0ID,
+  makeExporter,
+  snapHash,
+  snapshotData,
+} from './exports.js';
 
 const rank = {
   operational: 1,
@@ -23,15 +29,6 @@ const rank = {
   debug: 4,
 };
 
-const snapshotData = 'snapshot data';
-// this snapHash was computed manually
-const snapHash =
-  'e7dee7266896538616b630a5da40a90e007726a383e005a9c9c5dd0c2daf9329';
-
-/** @type {import('../src/bundleStore.js').Bundle} */
-const bundle0 = { moduleFormat: 'nestedEvaluate', source: '1+1' };
-const bundle0ID = makeB0ID(bundle0);
-
 function convert(orig) {
   const bundles = Object.fromEntries(
     Object.entries(orig.bundles).map(([bundleID, encBundle]) => {
@@ -44,41 +41,6 @@ function convert(orig) {
   return { ...orig, bundles };
 }
 
-/**
- * @typedef { import('../src/exporter').KVPair } KVPair
- */
-
-/**
- * @param { Map<string, string | null> } exportData
- * @param { Map<string, string> } artifacts
- */
-export function makeExporter(exportData, artifacts) {
-  return {
-    getHostKV(_key) {
-      return undefined;
-    },
-    async *getExportData() {
-      for (const [key, value] of exportData.entries()) {
-        /** @type { KVPair } */
-        const pair = [key, value];
-        yield pair;
-      }
-    },
-    async *getArtifactNames() {
-      for (const name of artifacts.keys()) {
-        yield name;
-      }
-    },
-    async *getArtifact(name) {
-      const data = artifacts.get(name);
-      assert(data, `missing artifact ${name}`);
-      yield Buffer.from(data);
-    },
-    // eslint-disable-next-line no-empty-function
-    async close() {},
-  };
-}
-
 test('import empty', async t => {
   const [dbDir, cleanup] = await tmpDir('testdb');
   t.teardown(cleanup);
@@ -95,68 +57,8 @@ test('import empty', async t => {
   });
 });
 
-export function buildData() {
-  // build an export manually
-  const exportData = new Map();
-  const artifacts = new Map();
-
-  // shadow kvStore
-  exportData.set('kv.key1', 'value1');
-
-  // now add artifacts and metadata in pairs
-
-  artifacts.set(`bundle.${bundle0ID}`, JSON.stringify(bundle0));
-  exportData.set(`bundle.${bundle0ID}`, bundle0ID);
-
-  const sbase = { vatID: 'v1', hash: snapHash, inUse: 0 };
-  const tbase = { vatID: 'v1', startPos: 0, isCurrent: 0, incarnation: 1 };
-  const addTS = (key, obj) =>
-    exportData.set(key, JSON.stringify({ ...tbase, ...obj }));
-  const t0hash =
-    '5bee0f44eca02f23eab03703e84ed2647d5d117fed99e1c30a3b424b7f082ab9';
-  const t2hash =
-    '57152efdd7fdf75c03371d2b4f1088d5bf3eae7fe643babce527ff81df38998c';
-  const t5hash =
-    '1947001e78e01bd1e773feb22b4ffc530447373b9de9274d5d5fbda3f23dbf2b';
-  const t8hash =
-    'e6b42c6a3fb94285a93162f25a9fc0145fd4c5bb144917dc572c50ae2d02ee69';
-
-  addTS(`transcript.v1.0`, { incarnation: 0, endPos: 2, hash: t0hash });
-  artifacts.set(`transcript.v1.0.2`, 'start-worker\nshutdown-worker\n');
-
-  addTS(`transcript.v1.2`, { startPos: 2, endPos: 5, hash: t2hash });
-  artifacts.set(
-    `transcript.v1.2.5`,
-    'start-worker\ndelivery1\nsave-snapshot\n',
-  );
-  exportData.set(`snapshot.v1.4`, JSON.stringify({ ...sbase, snapPos: 4 }));
-  artifacts.set(`snapshot.v1.4`, snapshotData);
-
-  addTS(`transcript.v1.5`, { startPos: 5, endPos: 8, hash: t5hash });
-  artifacts.set(
-    'transcript.v1.5.8',
-    'load-snapshot\ndelivery2\nsave-snapshot\n',
-  );
-  exportData.set(
-    `snapshot.v1.7`,
-    JSON.stringify({ ...sbase, snapPos: 7, inUse: 1 }),
-  );
-  artifacts.set(`snapshot.v1.7`, snapshotData);
-
-  artifacts.set('transcript.v1.8.10', 'load-snapshot\ndelivery3\n');
-  exportData.set(`snapshot.v1.current`, 'snapshot.v1.7');
-  addTS(`transcript.v1.current`, {
-    startPos: 8,
-    endPos: 10,
-    isCurrent: 1,
-    hash: t8hash,
-  });
-
-  return { exportData, artifacts, t0hash, t2hash, t5hash, t8hash };
-}
-
 const importTest = test.macro(async (t, mode) => {
-  /** @typedef {import('../src/internal.js').ArtifactMode} ArtifactMode */
+  /** @import {ArtifactMode} from '../src/internal.js' */
   const artifactMode = /** @type {ArtifactMode} */ (mode);
 
   const [dbDir, cleanup] = await tmpDir('testdb');
@@ -254,6 +156,7 @@ const importTest = test.macro(async (t, mode) => {
     ...db.prepare('SELECT * FROM transcriptSpans ORDER BY startPos').iterate(),
   ];
   t.deepEqual(
+    // @ts-expect-error unknown
     spanRows.map(sr => sr.startPos),
     [0, 2, 5, 8],
   );

package/test/{test-repair-metadata.js → repair-metadata.test.js}

@@ -1,14 +1,12 @@
 // @ts-check
 
-import '@endo/init/debug.js';
-
 import path from 'path';
 import test from 'ava';
 import sqlite3 from 'better-sqlite3';
 
 import { importSwingStore, openSwingStore } from '../src/index.js';
 
-import { makeExporter, buildData } from './test-import.js';
+import { makeExporter, buildData } from './exports.js';
 import { tmpDir } from './util.js';
 
 test('repair metadata', async t => {

package/test/{test-snapstore.js → snapstore.test.js}

@@ -1,13 +1,10 @@
 // @ts-check
 
-import '@endo/init/debug.js';
 import { Buffer } from 'node:buffer';
 import zlib from 'zlib';
 import sqlite3 from 'better-sqlite3';
 
-// eslint-disable-next-line import/no-extraneous-dependencies
 import test from 'ava';
-// eslint-disable-next-line import/no-extraneous-dependencies
 import { makeMeasureSeconds } from '@agoric/internal';
 import { makeSnapStore } from '../src/snapStore.js';
 
@@ -29,6 +26,7 @@ function ensureTxn() {}
 async function* getSnapshotStream(payload) {
   yield Buffer.from(payload);
 }
+harden(getSnapshotStream);
 
 test('compress to cache file; closes snapshot stream', async t => {
   const db = sqlite3(':memory:');
@@ -83,6 +81,7 @@ test('compress to cache file; closes snapshot stream', async t => {
   sqlGetSnapshot.pluck(true);
   const snapshotGZ = sqlGetSnapshot.get(hash);
   t.truthy(snapshotGZ);
+  // @ts-expect-error unknown
   const contents = zlib.gunzipSync(snapshotGZ);
   t.is(contents.toString(), 'abc', 'gunzip(contents) matches original');
   const logInfo = { vatID: 'fakeVatID', ...exportInfo };
@@ -103,7 +102,6 @@ test('snapStore prepare / commit delete is robust', async t => {
 
   const hashes = [];
   for (let i = 0; i < 5; i += 1) {
-    // eslint-disable-next-line no-await-in-loop
     const { hash } = await store.saveSnapshot(
       'fakeVatID2',
       i,
@@ -133,7 +131,6 @@ test('snapStore prepare / commit delete is robust', async t => {
   t.is(sqlCountSnapshots.get(), 0);
 
   for (let i = 0; i < 5; i += 1) {
-    // eslint-disable-next-line no-await-in-loop
     const { hash } = await store.saveSnapshot(
       'fakeVatID4',
       i,

package/test/{test-state.js → state.test.js}

@@ -1,7 +1,5 @@
 // @ts-check
 
-import '@endo/init/debug.js';
-
 import tmp from 'tmp';
 import test from 'ava';
 
@@ -32,7 +30,7 @@ async function embundle(filename) {
   const bundleFile = new URL(filename, import.meta.url).pathname;
   const bundle = await bundleSource(bundleFile);
   const bundleID = `b1-${bundle.endoZipBase64Sha512}`;
-  return [bundleID, bundle];
+  return /** @type {const} */ ([bundleID, bundle]);
 }
 
 function* iterate(kvStore, start, end) {
@@ -49,6 +47,7 @@ function* iterate(kvStore, start, end) {
     prev = next;
   }
 }
+harden(iterate);
 
 function makeExportLog() {
   const exportLog = [];

package/test/util.js

@@ -20,6 +20,7 @@ export const tmpDir = prefix =>
 export async function* getSnapshotStream(contents) {
   yield Buffer.from(contents);
 }
+harden(getSnapshotStream);
 
 export function makeB0ID(bundle) {
   return `b0-${createSHA256(JSON.stringify(bundle)).finish()}`;

package/{jsconfig.json → tsconfig.json}

@@ -1,6 +1,7 @@
 // This file can contain .js-specific Typescript compiler config.
 {
   "extends": "../../tsconfig.json",
+  "compilerOptions": {},
   "include": [
     "src/**/*.js",
     "test/**/*.js",