@agoric/swingset-vat 0.32.3-upgrade-18-dev-6ddbef0.0 → 0.32.3-upgrade-19-dev-c605745.0

package/src/kernel/vat-warehouse.js

@@ -97,6 +97,7 @@ export function makeSyscallSimulator(
   deliveryNum,
   transcriptEntry,
 ) {
+  const context = `anachrophobia in ${vatID} delivery d${deliveryNum}`;
   const syscallsExpected = [...transcriptEntry.sc]; // copy
   const syscallsMade = [];
   // syscallStatus's length will be max(syscallsExpected,
@@ -107,31 +108,36 @@ export function makeSyscallSimulator(
   let replayError; // sticky
 
   const explain = () => {
-    console.log(`anachrophobia strikes ${vatID} on delivery ${deliveryNum}`);
+    console.log(
+      `anachrophobia strikes ${vatID} delivery d${deliveryNum} syscalls`,
+    );
     for (const [idx, status] of syscallStatus.entries()) {
       const expected = syscallsExpected[idx];
       const got = syscallsMade[idx];
       switch (status) {
         case 'ok': {
-          console.log(`sc[${idx}]: ok: ${djson.stringify(got)}`);
+          console.log(`sc${idx}: ok: ${djson.stringify(got)}`);
           break;
         }
         case 'wrong': {
-          console.log(`sc[${idx}]: wrong`);
-          console.log(`  expected: ${djson.stringify(expected.s)}`);
-          console.log(`  got     : ${djson.stringify(got)}`);
+          console.log(
+            `
+sc${idx}: WRONG
+  expected: ${djson.stringify(expected.s)}
+  got     : ${djson.stringify(got)}`.trimStart(),
+          );
           break;
         }
         case 'extra': {
-          console.log(`sc[${idx}]: extra: ${djson.stringify(got)}`);
+          console.log(`sc${idx}: EXTRA: ${djson.stringify(got)}`);
           break;
         }
         case 'missing': {
-          console.log(`sc[${idx}]: missing: ${djson.stringify(expected.s)}`);
+          console.log(`sc${idx}: MISSING: ${djson.stringify(expected.s)}`);
           break;
         }
         default:
-          Fail`bad ${status}`;
+          Fail`sc${idx}: bad status ${status}`;
       }
     }
   };
@@ -140,16 +146,16 @@ export function makeSyscallSimulator(
     // slog entries have no kernel-translated kso/ksr
     const finish = kernelSlog.syscall(vatID, undefined, vso);
     const expected = syscallsExpected[syscallsMade.length];
-    syscallsMade.push(vso);
+    const idx = syscallsMade.push(vso) - 1;
     if (!expected) {
       syscallStatus.push('extra');
-      const error = Error(`anachrophobia in ${vatID}: extra syscall`);
+      const error = Error(`${context}: extra syscall at index sc${idx}`);
       replayError ||= error;
       throw error;
     }
     if (!syscallsAreIdentical(expected.s, vso)) {
       syscallStatus.push('wrong');
-      const error = Error(`anachrophobia in ${vatID}: wrong syscall`);
+      const error = Error(`${context}: wrong syscall at index sc${idx}`);
       replayError ||= error;
       throw error;
     }
@@ -159,12 +165,14 @@ export function makeSyscallSimulator(
   };
 
   const finishSimulation = () => {
-    if (syscallsMade.length < syscallsExpected.length) {
-      const missing = syscallsExpected.length - syscallsMade.length;
+    const missing = syscallsExpected.length - syscallsMade.length;
+    if (missing > 0) {
       for (let i = 0; i < missing; i += 1) {
         syscallStatus.push('missing');
       }
-      const error = Error(`anachrophobia in ${vatID}: missing syscalls`);
+      const error = Error(
+        `${context}: missing ${missing} syscall(s) at index sc${syscallsMade.length}`,
+      );
       replayError ||= error;
     }
 
@@ -389,7 +397,6 @@ export function makeVatWarehouse({
     //   entriesReplayed, // retval of replayTranscript() above
     // );
     ephemeral.vats.set(vatID, result);
-    // eslint-disable-next-line no-use-before-define
     await applyAvailabilityPolicy(vatID);
     return result;
   }
@@ -596,7 +603,6 @@ export function makeVatWarehouse({
     //
     /** @type { KernelDeliveryObject } */
     const kd = harden(['bringOutYourDead']);
-    // eslint-disable-next-line no-use-before-define
     const vd = kernelDeliveryToVatDelivery(vatID, kd);
     const vs = kernelSlog.provideVatSlogger(vatID).vatSlog;
     await deliverToVat(vatID, kd, vd, vs);

package/src/supervisors/subprocess-node/supervisor-subprocess-node.js

@@ -36,6 +36,7 @@ workerLog(`supervisor started`);
 
 function makeNetstringReader({ fd, encoding }) {
   const input = Buffer.alloc(32 * 1024);
+  /** @type {Buffer<ArrayBufferLike>} */
   let buffered = Buffer.alloc(0);
   let decoded = [];
 

package/src/supervisors/supervisor-helper.js

@@ -32,16 +32,15 @@ function makeSupervisorDispatch(dispatch) {
   async function dispatchToVat(delivery) {
     // the (low-level) vat is responsible for giving up agency, but we still
     // protect against exceptions
-    return Promise.resolve(delivery)
-      .then(dispatch)
-      .then(
-        res => harden(['ok', res, null]),
-        err => {
-          // TODO react more thoughtfully, maybe terminate the vat
-          console.warn(`error during vat dispatch() of ${delivery}`, err);
-          return harden(['error', `${err}`, null]);
-        },
-      );
+    await null;
+    try {
+      const res = await dispatch(delivery);
+      return harden(['ok', res, null]);
+    } catch (err) {
+      // TODO react more thoughtfully, maybe terminate the vat
+      console.warn(`error during vat dispatch() of ${delivery}`, err);
+      return harden(['error', `${err}`, null]);
+    }
   }
 
   return harden(dispatchToVat);

package/src/typeGuards.js

@@ -10,37 +10,40 @@ export const ManagerType = M.or(
 
 const Bundle = M.splitRecord({ moduleType: M.string() });
 
-const SwingsetConfigOptions = harden({
+const VatConfigOptions = harden({
   creationOptions: M.splitRecord({}, { critical: M.boolean() }),
   parameters: M.recordOf(M.string(), M.any()),
 });
 
-const SwingSetConfigProperties = M.or(
-  M.splitRecord({ sourceSpec: M.string() }, SwingsetConfigOptions),
-  M.splitRecord({ bundleSpec: M.string() }, SwingsetConfigOptions),
-  M.splitRecord({ bundle: Bundle }, SwingsetConfigOptions),
-);
-const SwingSetConfigDescriptor = M.recordOf(
-  M.string(),
-  SwingSetConfigProperties,
-);
+const makeSwingSetConfigProperties = (required = {}, optional = {}, rest) =>
+  M.or(
+    M.splitRecord({ sourceSpec: M.string(), ...required }, optional, rest),
+    M.splitRecord({ bundleSpec: M.string(), ...required }, optional, rest),
+    M.splitRecord({ bundle: Bundle, ...required }, optional, rest),
+  );
+const makeSwingSetConfigDescriptor = (required, optional, rest) =>
+  M.recordOf(
+    M.string(),
+    makeSwingSetConfigProperties(required, optional, rest),
+  );
 
 /**
  * NOTE: this pattern suffices for PSM bootstrap,
  * but does not cover the whole SwingSet config syntax.
  *
  * {@link ./docs/configuration.md}
- * TODO: move this to swingset?
  *
  * @see SwingSetConfig
  * in ./types-external.js
  */
-export const SwingSetConfig = M.and(
-  M.splitRecord({}, { defaultManagerType: ManagerType }),
-  M.splitRecord({}, { includeDevDependencies: M.boolean() }),
-  M.splitRecord({}, { defaultReapInterval: M.number() }), // not in type decl
-  M.splitRecord({}, { snapshotInterval: M.number() }),
-  M.splitRecord({}, { vats: SwingSetConfigDescriptor }),
-  M.splitRecord({}, { bootstrap: M.string() }),
-  M.splitRecord({}, { bundles: SwingSetConfigDescriptor }),
+export const SwingSetConfig = M.splitRecord(
+  { vats: makeSwingSetConfigDescriptor(undefined, VatConfigOptions) },
+  {
+    defaultManagerType: ManagerType,
+    includeDevDependencies: M.boolean(),
+    defaultReapInterval: M.number(),
+    snapshotInterval: M.number(),
+    bootstrap: M.string(),
+    bundles: makeSwingSetConfigDescriptor(undefined, undefined, {}),
+  },
 );

package/src/types-external.js

@@ -1,10 +1,10 @@
-/** @import { ERef } from '@endo/far'; */
-
 export {};
 
 /**
  * @import {Guarded} from '@endo/exo';
+ * @import {ERef} from '@endo/far';
  * @import {Passable, RemotableObject} from '@endo/pass-style';
+ * @import {LimitedConsole} from '@agoric/internal/src/js-utils.js';
  */
 
 /* This file defines types that part of the external API of swingset. That
@@ -129,14 +129,6 @@ export {};
  * @typedef { (dr: VatDeliveryResult) => void } SlogFinishDelivery
  * @typedef { (ksr: KernelSyscallResult, vsr: VatSyscallResult) => void } SlogFinishSyscall
  * @typedef { { write: ({}) => void,
- *              vatConsole: (vatID: string, origConsole: {}) => {},
- *              delivery: (vatID: string,
- *                         newCrankNum: BigInt, newDeliveryNum: BigInt,
- *                         kd: KernelDeliveryObject, vd: VatDeliveryObject,
- *                         replay?: boolean) => SlogFinishDelivery,
- *              syscall: (vatID: string,
- *                        ksc: KernelSyscallObject | undefined,
- *                        vsc: VatSyscallObject) => SlogFinishSyscall,
  *              provideVatSlogger: (vatID: string,
  *                                  dynamic?: boolean,
  *                                  description?: string,
@@ -144,6 +136,20 @@ export {};
  *                                  vatSourceBundle?: unknown,
  *                                  managerType?: string,
  *                                  vatParameters?: unknown) => { vatSlog: VatSlog },
+ *              vatConsole: (vatID: string, origConsole: LimitedConsole) => LimitedConsole,
+ *              startup: (vatID: string) => () => void,
+ *              delivery: (vatID: string,
+ *                         newCrankNum: BigInt, newDeliveryNum: BigInt,
+ *                         kd: KernelDeliveryObject, vd: VatDeliveryObject,
+ *                         replay?: boolean) => SlogFinishDelivery,
+ *              syscall: (vatID: string,
+ *                        ksc: KernelSyscallObject | undefined,
+ *                        vsc: VatSyscallObject) => SlogFinishSyscall,
+ *              changeCList: (vatID: string,
+ *                            crankNum: BigInt,
+ *                            mode: 'import' | 'export' | 'drop',
+ *                            kernelSlot: string,
+ *                            vatSlot: string) => void,
  *              terminateVat: (vatID: string, shouldReject: boolean, info: SwingSetCapData) => void,
  *             } } KernelSlog
  * @typedef {{
@@ -154,27 +160,25 @@ export {};
  */
 
 /**
+ * @typedef {{ bundle: Bundle }} BundleRef a bundle object
+ * @typedef {{ bundleName: string }} BundleName a name identifying a property in the `bundles` of a SwingSetOptions object
+ * @typedef {{ bundleSpec: string }} BundleSpec a path to a bundle file
+ * @typedef {{ sourceSpec: string }} SourceSpec a package specifier such as "@agoric/swingset-vat/tools/vat-puppet.js"
+ *
  * @typedef {{
- *   sourceSpec: string // path to pre-bundled root
- * }} SourceSpec
- * @typedef {{
- *   bundleSpec: string // path to bundled code
- * }} BundleSpec
- * @typedef {{
- *   bundle: Bundle
- * }} BundleRef
- * @typedef {{
- *   bundleName: string
- * }} BundleName
- * @typedef {(SourceSpec | BundleSpec | BundleRef | BundleName ) & {
  *   bundleID?: BundleID,
- *   creationOptions?: Record<string, any>,
+ *   creationOptions?: StaticVatOptions,
  *   parameters?: Record<string, any>,
- * }} SwingSetConfigProperties
+ * }} VatConfigOptions
+ */
+/**
+ * @template [Fields=object]
+ * @typedef {(SourceSpec | BundleSpec | BundleName | BundleRef) & Fields} SwingSetConfigProperties
  */
 
 /**
- * @typedef {Record<string, SwingSetConfigProperties>} SwingSetConfigDescriptor
+ * @template [Fields=object]
+ * @typedef {Record<string, SwingSetConfigProperties<Fields>>} SwingSetConfigDescriptor
  * Where the property name is the name of the vat.  Note that
  * the `bootstrap` property names the vat that should be used as the bootstrap vat.  Although a swingset
  * configuration can designate any vat as its bootstrap vat, `loadBasedir` will always look for a file named
@@ -188,7 +192,7 @@ export {};
  * `devDependencies` of the surrounding `package.json` should be accessible to
  * bundles.
  * @property {string} [bundleCachePath] if present, SwingSet will use a bundle cache at this path
- * @property {SwingSetConfigDescriptor} vats
+ * @property {SwingSetConfigDescriptor<VatConfigOptions>} vats
  * @property {SwingSetConfigDescriptor} [bundles]
  * @property {BundleFormat} [bundleFormat] the bundle source / import bundle
  * format.
@@ -206,7 +210,7 @@ export {};
  */
 
 /**
- * @typedef {{ bundleName: string} | { bundle: Bundle } | { bundleID: BundleID } } SourceOfBundle
+ * @typedef {BundleName | BundleRef | {bundleID: BundleID}} SourceOfBundle
  */
 /**
  * @typedef { import('@agoric/swing-store').KVStore } KVStore
@@ -295,12 +299,8 @@ export {};
  * Vat Creation and Management
  *
  * @typedef { string } BundleID
- * @typedef {any} BundleCap
+ * @typedef { any } BundleCap
  * @typedef { { moduleFormat: 'endoZipBase64', endoZipBase64: string, endoZipBase64Sha512: string } } EndoZipBase64Bundle
- *
- * @typedef { unknown } Meter
- *
- * E(vatAdminService).createVat(bundle, options: DynamicVatOptions)
  */
 
 /**
@@ -326,8 +326,6 @@ export {};
  * types are then defined as amendments to this base type.
  *
  * @typedef { object } BaseVatOptions
- * @property { string } name
- * @property { * } [vatParameters]
  * @property { boolean } [enableSetup]
  *           If true, permits the vat to construct itself using the
  *           `setup()` API, which bypasses the imposition of LiveSlots but
@@ -346,6 +344,10 @@ export {};
  *            outbound syscalls so that the vat's internal state can be
  *            reconstructed via replay.  If false, no such record is kept.
  *            Defaults to true.
+ * @property { ManagerType } [managerType]
+ * @property { boolean } [neverReap]
+ *            If true, disables automatic bringOutYourDead deliveries to a vat.
+ *            Defaults to false.
  * @property { number | 'never' } [reapInterval]
  *            Trigger a bringOutYourDead after the vat has received
  *            this many deliveries. If the value is 'never',
@@ -360,7 +362,7 @@ export {};
  */
 
 /**
- * @typedef { { meter?: Meter } } OptMeter
+ * @typedef { { meter?: unknown } } OptMeter
  *        If a meter is provided, the new dynamic vat is limited to a fixed
  *        amount of computation and allocation that can occur during any
  *        given crank. Peak stack frames are limited as well. In addition,
@@ -370,14 +372,13 @@ export {};
  *        terminated. If undefined, the vat is unmetered. Static vats
  *        cannot be metered.
  *
- * @typedef { { managerType?: ManagerType } } OptManagerType
- * @typedef { BaseVatOptions & OptMeter & OptManagerType } DynamicVatOptions
+ * @typedef { BaseVatOptions & { name: string, vatParameters?: object } & OptMeter } DynamicVatOptions
  *
  * config.vats[name].creationOptions: StaticVatOptions
  *
  * @typedef { { enableDisavow?: boolean } } OptEnableDisavow
  * @typedef { { nodeOptions?: string[] } } OptNodeOptions
- * @typedef { BaseVatOptions & OptManagerType & OptEnableDisavow & OptNodeOptions } StaticVatOptions
+ * @typedef { BaseVatOptions & OptEnableDisavow & OptNodeOptions } StaticVatOptions
  *
  * @typedef { { vatParameters?: object, upgradeMessage?: string } } VatUpgradeOptions
  * @typedef { { incarnationNumber: number } } VatUpgradeResults

package/src/types-internal.js

@@ -29,7 +29,6 @@ export {};
  * @typedef { string } MeterID
  * @typedef { { meterID?: MeterID } } OptMeterID
  * @typedef { import('./types-external.js').BaseVatOptions } BaseVatOptions
- * @typedef { import('./types-external.js').OptManagerType } OptManagerType
  * @typedef { import('@agoric/swingset-liveslots').VatDeliveryObject } VatDeliveryObject
  * @typedef { import('@agoric/swingset-liveslots').VatDeliveryResult } VatDeliveryResult
  * @typedef { import('@agoric/swingset-liveslots').VatSyscallObject } VatSyscallObject
@@ -38,7 +37,7 @@ export {};
  *
  * // used by vatKeeper.setSourceAndOptions(source, RecordedVatOptions)
  *
- * @typedef { BaseVatOptions & OptMeterID & OptManagerType } InternalDynamicVatOptions
+ * @typedef { BaseVatOptions & OptMeterID } InternalDynamicVatOptions
  *
  * RecordedVatOptions is fully-specified, no optional fields
  *
@@ -112,7 +111,7 @@ export {};
  *   enableDisavow: boolean,
  *   useTranscript: boolean,
  *   name: string,
- *   sourcedConsole: Pick<Console, 'debug' | 'log' | 'info' | 'warn' | 'error'>,
+ *   sourcedConsole: import('@agoric/internal/src/js-utils.js').LimitedConsole,
  *   enableSetup: boolean,
  *   setup?: unknown,
  *   retainSyscall?: boolean

package/src/vats/comms/delivery.js

@@ -1,5 +1,3 @@
-/* eslint-disable no-use-before-define */
-
 import { assert, Fail } from '@endo/errors';
 import { kser } from '@agoric/kmarshal';
 import { parseLocalSlot, insistLocalType } from './parseLocalSlots.js';

package/src/vats/comms/state.js

@@ -150,7 +150,6 @@ export function makeState(syscall) {
       store.set('r.nextID', '1');
       store.set('initialized', 'true');
       if (controller) {
-        // eslint-disable-next-line no-use-before-define
         addMetaObject(controller);
         cdebug(`comms controller is ${controller}`);
       }
@@ -393,7 +392,6 @@ export function makeState(syscall) {
             // the object is unreachable
 
             const { owner, isReachable, isRecognizable } =
-              // eslint-disable-next-line no-use-before-define
               getOwnerAndStatus(lref);
             if (isReachable) {
               // but the exporter doesn't realize it yet, so schedule a
@@ -558,7 +556,6 @@ export function makeState(syscall) {
       isReachable = isReachableByKernel(lref);
       isRecognizable = !!mapToKernel(lref);
     } else {
-      // eslint-disable-next-line no-use-before-define
       const remote = getRemote(owner);
       isReachable = remote.isReachable(lref);
       isRecognizable = !!remote.mapToRemote(lref);
@@ -794,7 +791,6 @@ export function makeState(syscall) {
     insistPromiseIsUnresolved,
     markPromiseAsResolved,
 
-    // eslint-disable-next-line no-use-before-define
     getRemote,
     addRemote,
     getRemoteIDForName,

package/src/vats/timer/vat-timer.js

@@ -1,5 +1,3 @@
-/* eslint-disable no-use-before-define */
-
 import { assert } from '@endo/errors';
 import { Far, E, passStyleOf } from '@endo/far';
 import { makePromiseKit } from '@endo/promise-kit';
@@ -16,6 +14,8 @@ import { makeScalarWeakMapStore } from '@agoric/store';
 import { TimeMath } from '@agoric/time';
 
 /**
+ * @import {LegacyWeakMap, WeakMapStore} from '@agoric/store';
+ * @import {MapStore} from '@agoric/swingset-liveslots';
  * @import {Passable, RemotableObject} from '@endo/pass-style';
  * @import {Key} from '@endo/patterns';
  */

package/src/vats/vat-admin/vat-vat-admin.js

@@ -100,7 +100,6 @@ export function buildRootObject(vatPowers, _vatParameters, baggage) {
       // getNotifier: ({ state }) => state.notifier, // XXX RESTORE
       getNotifier: ({ _self }) => Fail`not implemented, see #7234`, // XXX TEMP
     },
-    // eslint-disable-next-line no-use-before-define
     { finish: finishMeter },
   );
 
@@ -120,18 +119,15 @@ export function buildRootObject(vatPowers, _vatParameters, baggage) {
       // getNotifier: ({ state }) => state.notifier, // will never fire // XXX RESTORE
       getNotifier: ({ _self }) => Fail`not implemented, see #7234`, // XXX TEMP
     },
-    // eslint-disable-next-line no-use-before-define
     { finish: finishMeter },
   );
 
   function finishMeter({ state, self }) {
-    // eslint-disable-next-line no-use-before-define
     meterByID.init(
       state.meterID,
       // harden({ meter: self, updater: state.updater }), // XXX RESTORE
       harden({ meter: self }), // XXX TEMP
     );
-    // eslint-disable-next-line no-use-before-define
     meterIDByMeter.set(self, state.meterID);
   }
 

package/tools/baggage-check.js

@@ -1,8 +1,6 @@
 import { makeMarshal } from '@endo/marshal';
 import { Far } from '@endo/far';
 
-/* eslint-disable no-use-before-define */
-
 function fakeSTV(slot, iface = 'Remotable') {
   return Far(iface, {
     getSlot: () => slot,

package/tools/bootstrap-dvo-test.js

@@ -11,7 +11,6 @@ export function buildRootObject() {
   async function runTests(phase) {
     testLog = [];
     doneP = makePromiseKit();
-    // eslint-disable-next-line no-use-before-define
     await E(testVatRoot).runTests(self, phase);
     await doneP.promise;
     return testLog;

package/tools/bootstrap-relay.js

@@ -1,3 +1,12 @@
+/**
+ * @file Source code for a bootstrap vat that runs blockchain behaviors (such as
+ *   bridge vat integration) and exposes reflective methods for use in testing.
+ *
+ * TODO: Build from ./vat-puppet.js makeReflectionMethods
+ * and share code with packages/vats/tools/vat-reflective-chain-bootstrap.js
+ * (which basically extends this for better [mock] blockchain integration).
+ */
+
 import { Fail, q } from '@endo/errors';
 import { objectMap } from '@agoric/internal';
 import { Far, E } from '@endo/far';

package/tools/bundleTool.js

@@ -1,6 +1,10 @@
 import { makeNodeBundleCache as wrappedMaker } from '@endo/bundle-source/cache.js';
 import styles from 'ansi-styles'; // less authority than 'chalk'
 
+/**
+ * @import {EReturn} from '@endo/far';
+ */
+
 /** @type {typeof wrappedMaker} */
 export const makeNodeBundleCache = async (dest, options, loadModule, pid) => {
   const log = (...args) => {
@@ -17,7 +21,7 @@ export const makeNodeBundleCache = async (dest, options, loadModule, pid) => {
   };
   return wrappedMaker(dest, { log, ...options }, loadModule, pid);
 };
-/** @typedef {Awaited<ReturnType<typeof makeNodeBundleCache>>} BundleCache */
+/** @typedef {EReturn<typeof makeNodeBundleCache>} BundleCache */
 
 /** @type {Map<string, Promise<BundleCache>>} */
 const providedCaches = new Map();