@agoric/swingset-liveslots 0.10.3-dev-51399d1.0 → 0.10.3-dev-1b5e57f.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@agoric/swingset-liveslots",
-  "version": "0.10.3-dev-51399d1.0+51399d1",
+  "version": "0.10.3-dev-1b5e57f.0+1b5e57f",
   "description": "SwingSet ocap support layer",
   "type": "module",
   "main": "src/index.js",
@@ -17,9 +17,9 @@
     "lint:eslint": "eslint ."
   },
   "dependencies": {
-    "@agoric/assert": "0.6.1-dev-51399d1.0+51399d1",
-    "@agoric/internal": "0.3.3-dev-51399d1.0+51399d1",
-    "@agoric/store": "0.9.3-dev-51399d1.0+51399d1",
+    "@agoric/assert": "0.6.1-dev-1b5e57f.0+1b5e57f",
+    "@agoric/internal": "0.3.3-dev-1b5e57f.0+1b5e57f",
+    "@agoric/store": "0.9.3-dev-1b5e57f.0+1b5e57f",
     "@endo/eventual-send": "^0.17.5",
     "@endo/exo": "^0.2.5",
     "@endo/far": "^0.2.21",
@@ -31,7 +31,7 @@
     "@endo/promise-kit": "^0.2.59"
   },
   "devDependencies": {
-    "@agoric/kmarshal": "0.1.1-dev-51399d1.0+51399d1",
+    "@agoric/kmarshal": "0.1.1-dev-1b5e57f.0+1b5e57f",
     "ava": "^5.3.0"
   },
   "files": [
@@ -67,5 +67,5 @@
   "typeCoverage": {
     "atLeast": 71.48
   },
-  "gitHead": "51399d19e8b32f794e2e0b6af990cc439d60dfaa"
+  "gitHead": "1b5e57f17a043a43171621bbe3ef68131954f714"
 }

package/src/types.js

@@ -1,3 +1,6 @@
+// Ensure this is a module.
+export {};
+
 /**
  * @callback makeLiveSlots
  */
@@ -79,5 +82,8 @@
  *
  */
 
-// Ensure this is a module.
-export {};
+/**
+ * @template V fulfilled value
+ * @template {any[]} [A=unknown[]] arguments
+ * @typedef { {onFulfilled?: (value: V, ...args: A) => void, onRejected?: (reason: unknown, ...args: A) => void} } PromiseWatcher
+ */

package/src/watchedPromises.js

@@ -1,3 +1,4 @@
+// @ts-check
 // no-lonely-if is a stupid rule that really should be disabled globally
 /* eslint-disable no-lonely-if */
 
@@ -6,6 +7,12 @@ import { initEmpty, M } from '@agoric/store';
 import { E } from '@endo/eventual-send';
 import { parseVatSlot } from './parseVatSlots.js';
 
+/**
+ * @template V
+ * @template {any[]} [A=unknown[]]
+ * @typedef {[watcher: import('./types.js').PromiseWatcher<V, A>, ...args: A]} PromiseWatcherTuple
+ */
+
 /**
  * @param {object} options
  * @param {*} options.syscall
@@ -28,17 +35,28 @@ export function makeWatchedPromiseManager({
   const { makeScalarBigMapStore } = collectionManager;
   const { defineDurableKind } = vom;
 
-  // virtual Store (not durable) mapping vpid to Promise objects, to
-  // maintain the slotToVal registration until resolution. Without
-  // this, slotToVal would forget local Promises that aren't exported.
+  /**
+   * virtual Store (not durable) mapping vpid to Promise objects, to
+   * maintain the slotToVal registration until resolution. Without
+   * this, slotToVal would forget local Promises that aren't exported.
+   *
+   * @type {MapStore<string, Promise<unknown>>}
+   */
   let promiseRegistrations;
 
-  // watched promises by vpid: each entry is an array of watches on the
-  // corresponding vpid; each of these is in turn an array of a watcher object
-  // and the arguments associated with it by `watchPromise`.
+  /**
+   * watched promises by vpid: each entry is an array of watches on the
+   * corresponding vpid; each of these is in turn an array of a watcher object
+   * and the arguments associated with it by `watchPromise`.
+   * @type {MapStore<string, PromiseWatcherTuple<unknown>[]>}
+   */
   let watchedPromiseTable;
 
-  // defined promise watcher objects indexed by kindHandle
+  /**
+   * defined promise watcher objects indexed by kindHandle
+   *
+   * @type {MapStore<import('./vatDataTypes.js').DurableKindHandle, import('./types.js').PromiseWatcher<unknown>>}
+   */
   let promiseWatcherByKindTable;
 
   function preparePromiseWatcherTables() {
@@ -73,11 +91,17 @@ export function makeWatchedPromiseManager({
   }
 
   /**
-   *
-   * @param {Promise<unknown>} p
+   * @template T
+   * @param {Promise<T>} p
    * @param {string} vpid
+   * @returns {void}
    */
   function pseudoThen(p, vpid) {
+    /**
+     *
+     * @param {T} value
+     * @param {boolean} wasFulfilled
+     */
     function settle(value, wasFulfilled) {
       const watches = watchedPromiseTable.get(vpid);
       watchedPromiseTable.delete(vpid);
@@ -121,20 +145,28 @@ export function makeWatchedPromiseManager({
     }
   }
 
+  /**
+   * @template V
+   * @template {any[]} A]
+   * @param {import('./vatDataTypes.js').DurableKindHandle} kindHandle
+   * @param {(value: V, ...args: A) => void} fulfillHandler
+   * @param {(reason: any, ...args: A) => void} rejectHandler
+   * @returns {import('./types.js').PromiseWatcher<V, A>}
+   */
   function providePromiseWatcher(
     kindHandle,
-    fulfillHandler = x => x,
-    rejectHandler = x => {
-      throw x;
-    },
+    // @ts-expect-error xxx rest params in typedef
+    fulfillHandler = _value => {},
+    // @ts-expect-error xxx rest params in typedef
+    rejectHandler = _reason => {},
   ) {
     assert.typeof(fulfillHandler, 'function');
     assert.typeof(rejectHandler, 'function');
 
     const makeWatcher = defineDurableKind(kindHandle, initEmpty, {
-      // @ts-expect-error  TS is confused by the spread operator
+      /** @type {(context: unknown, res: V, ...args: A) => void} */
       onFulfilled: (_context, res, ...args) => fulfillHandler(res, ...args),
-      // @ts-expect-error
+      /** @type {(context: unknown, rej: unknown, ...args: A) => void} */
       onRejected: (_context, rej, ...args) => rejectHandler(rej, ...args),
     });
 
@@ -148,10 +180,7 @@ export function makeWatchedPromiseManager({
   }
 
   /**
-   *
-   * @param {Promise} p
-   * @param {{onFulfilled?: Function, onRejected?: Function}} watcher
-   * @param  {...any} args
+   * @type {<P extends Promise<any>, A extends any[]>(p: P, watcher: import('./types.js').PromiseWatcher<Awaited<P>, A>, ...args: A) => void}
    */
   function watchPromise(p, watcher, ...args) {
     // The following wrapping defers setting up the promise watcher itself to a

package/tools/setup-vat-data.js

@@ -23,6 +23,7 @@ globalThis.VatData = harden({
   makeKindHandle: tag => fakeVomKit.vom.makeKindHandle(tag),
   canBeDurable: (...args) => fakeVomKit.vom.canBeDurable(...args),
   providePromiseWatcher: (...args) =>
+    // @ts-expect-error spread argument for non-rest parameter
     fakeVomKit.wpm.providePromiseWatcher(...args),
   watchPromise: (p, watcher, ...args) =>
     fakeVomKit.wpm.watchPromise(p, watcher, ...args),