Merge pull request #8596 from Agoric/ta/typecheck-scripts

typecheck vats package

package.json

@@ -14,8 +14,8 @@
     "@jessie.js/eslint-plugin": "^0.4.0",
     "@types/express": "^4.17.17",
     "@types/node": "^16.13.0",
-    "@typescript-eslint/eslint-plugin": "^6.7.0",
-    "@typescript-eslint/parser": "^6.7.0",
+    "@typescript-eslint/eslint-plugin": "^6.13.2",
+    "@typescript-eslint/parser": "^6.13.2",
     "ava": "^5.3.0",
     "c8": "^7.13.0",
     "conventional-changelog-conventionalcommits": "^4.6.0",

packages/eslint-config/package.json

@@ -27,8 +27,8 @@
   "peerDependencies": {
     "@endo/eslint-plugin": "^0.5.1",
     "@jessie.js/eslint-plugin": "^0.4.0",
-    "@typescript-eslint/eslint-plugin": "^6.7.0",
-    "@typescript-eslint/parser": "^6.7.0",
+    "@typescript-eslint/eslint-plugin": "^6.13.2",
+    "@typescript-eslint/parser": "^6.13.2",
     "eslint": "^8.47.0",
     "eslint-config-airbnb-base": "^15.0.0",
     "eslint-plugin-github": "^4.10.0",

packages/governance/src/contractHelper.js

@@ -152,7 +152,8 @@ const facetHelpers = (zcf, paramManager) => {
    *
    * @see {makeDurableGovernorFacet}
    *
-   * @param {{ [methodName: string]: (context?: unknown, ...rest: unknown[]) => unknown}} limitedCreatorFacet
+   * @template {{ [methodName: string]: (context?: unknown, ...rest: unknown[]) => unknown}} LCF
+   * @param {LCF} limitedCreatorFacet
    */
   const makeVirtualGovernorFacet = limitedCreatorFacet => {
     /** @type {import('@agoric/swingset-liveslots').FunctionsPlusContext<unknown, GovernedCreatorFacet<limitedCreatorFacet>>} */

packages/inter-protocol/src/proposals/startPSM.js

@@ -276,7 +276,6 @@ export const startPSM = async (
       governorFacets.creatorFacet,
       instanceKey,
     ),
-    // @ts-expect-error TODO type for provisionPoolStartResult
     E(E.get(provisionPoolStartResult).creatorFacet).initPSM(
       anchorBrand,
       newpsmKit.psm,

packages/inter-protocol/test/psm/setupPsm.js

@@ -99,6 +99,7 @@ export const setupPsm = async (
   issuer.produce.IST.resolve(istIssuer);
 
   space.produce.provisionPoolStartResult.resolve({
+    // @ts-expect-error mock
     creatorFacet: Far('dummy', {
       initPSM: () => {
         t.log('dummy provisionPool.initPSM');

packages/swingset-liveslots/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
+ */

packages/swingset-liveslots/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

packages/swingset-liveslots/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),

packages/vat-data/src/index.test-d.ts

@@ -13,6 +13,7 @@ import {
   makeKindHandle,
   defineDurableKind,
   partialAssign,
+  watchPromise,
 } from '.';
 
 // for use in assignments below
@@ -168,3 +169,22 @@ const vom: VirtualObjectManager = anyVal;
 vom.missingMethod;
 // @ts-expect-error Expected 0-4 arguments but got 5
 vom.defineDurableKind(anyVal, anyVal, anyVal, anyVal, 'extra');
+
+const p: Promise<bigint> = anyVal;
+watchPromise(
+  p,
+  {
+    onFulfilled(value, extra1, extra2) {
+      expectType<bigint>(value);
+      expectType<string>(extra1);
+      // @ts-expect-error str
+      expectType<number>(extra2);
+    },
+    onRejected(reason, extra1) {
+      expectType<unknown>(reason);
+      expectType<string>(extra1);
+    },
+  },
+  'extraString',
+  'alsoString',
+);

packages/vats/index.js

@@ -1,4 +1,3 @@
-// @ts-check
 // Ambient types
 import '@agoric/zoe/exported.js';
 import './src/core/types-ambient.js';

packages/vats/package.json

@@ -76,6 +76,6 @@
     "workerThreads": false
   },
   "typeCoverage": {
-    "atLeast": 90.86
+    "atLeast": 90.88
   }
 }

packages/vats/src/bridge.js

@@ -1,5 +1,3 @@
-// @ts-check
-
 import { M } from '@agoric/store';
 import '@agoric/store/exported.js';
 import { E } from '@endo/far';

packages/vats/src/centralSupply.js

@@ -1,5 +1,3 @@
-// @ts-check
-
 import { AmountMath } from '@agoric/ertp';
 import { E, Far } from '@endo/far';
 

packages/vats/src/core/basic-behaviors.js

@@ -1,5 +1,3 @@
-// @ts-check
-
 import { AssetKind } from '@agoric/ertp';
 import { CONTRACT_ELECTORATE, ParamTypes } from '@agoric/governance';
 import { Stable, Stake } from '@agoric/internal/src/tokens.js';

packages/vats/src/core/boot-chain.js

@@ -1,4 +1,3 @@
-// @ts-check
 import { makeDurableZone } from '@agoric/zone/durable.js';
 import { makeBootstrap } from './lib-boot.js';
 

packages/vats/src/core/boot-sim.js

@@ -1,4 +1,3 @@
-// @ts-check
 import { makeBootstrap } from './lib-boot.js';
 
 import * as basicBehaviorsPlus from './basic-behaviors.js';

packages/vats/src/core/boot-solo.js

@@ -1,4 +1,3 @@
-// @ts-check
 import { makeBootstrap } from './lib-boot.js';
 
 import * as basicBehaviorsPlus from './basic-behaviors.js';

packages/vats/src/core/chain-behaviors.js

@@ -1,5 +1,4 @@
 /* global globalThis */
-// @ts-check
 import { allValues, BridgeId as BRIDGE_ID } from '@agoric/internal';
 import * as STORAGE_PATH from '@agoric/internal/src/chain-storage-paths.js';
 import { makePrioritySendersManager } from '@agoric/internal/src/priority-senders.js';

packages/vats/src/core/client-behaviors.js

@@ -1,4 +1,3 @@
-// @ts-check
 import { E, Far } from '@endo/far';
 import { makePluginManager } from '@agoric/swingset-vat/src/vats/plugin-manager.js';
 import { observeNotifier } from '@agoric/notifier';

packages/vats/src/core/lib-boot.js

@@ -1,4 +1,3 @@
-// @ts-check
 import { E, Far } from '@endo/far';
 import { makeHeapZone } from '@agoric/zone';
 import {

packages/vats/src/core/promise-space.js

@@ -1,4 +1,3 @@
-// @ts-check
 import { E } from '@endo/far';
 import { assertKey } from '@agoric/store';
 import { canBeDurable } from '@agoric/vat-data';

packages/vats/src/core/startWalletFactory.js

@@ -1,4 +1,3 @@
-// @ts-check
 import { makeMap } from 'jessie.js';
 import { E, Far } from '@endo/far';
 import { deeplyFulfilled } from '@endo/marshal';

packages/vats/src/core/types-ambient.d.ts

@@ -373,7 +373,9 @@ type ChainBootstrapSpaceT = {
   testFirstAnchorKit: import('../vat-bank.js').AssetIssuerKit<'nat'>;
   walletBridgeManager: import('../types.js').ScopedBridgeManager | undefined;
   walletFactoryStartResult: import('./startWalletFactory.js').WalletFactoryStartResult;
-  provisionPoolStartResult: unknown;
+  provisionPoolStartResult: GovernanceFacetKit<
+    typeof import('@agoric/inter-protocol/src/provisionPool.js').start
+  >;
   vatStore: import('./utils.js').VatStore;
   zoe: ZoeService;
 };

packages/vats/src/core/utils.js

@@ -1,4 +1,3 @@
-// @ts-check
 import { Stable, Stake } from '@agoric/internal/src/tokens.js';
 import { WalletName } from '@agoric/internal';
 import { E, Far } from '@endo/far';

packages/vats/src/crc.js

@@ -6,7 +6,6 @@
  * Forked from npm [email protected] for module system compatibility, then trimmed
  * down to a version that assumes TypedArrays are universal.
  */
-// @ts-check
 /* eslint-disable no-bitwise */
 
 /** @typedef {string | number | Uint8Array | ArrayBuffer} Data */

packages/vats/src/ibc.js

@@ -1,5 +1,3 @@
-// @ts-check
-
 import { makeScalarMapStore, makeLegacyMap } from '@agoric/store';
 import { makePromiseKit } from '@endo/promise-kit';
 import { assert, details as X, Fail } from '@agoric/assert';

packages/vats/src/lib-board.js

@@ -1,4 +1,3 @@
-// @ts-check
 /**
  * @file lib-board: share objects by way of plain-data ids
  * @see prepareBoardKit()

packages/vats/src/mintHolder.js

@@ -1,4 +1,3 @@
-// @ts-check
 // @jessie-check
 
 import { prepareIssuerKit } from '@agoric/ertp';

packages/vats/src/nameHub.js

@@ -1,5 +1,3 @@
-// @ts-check
-
 import { assert, NonNullish } from '@agoric/assert';
 import { E } from '@endo/far';
 import { makePromiseKit } from '@endo/promise-kit';

packages/vats/src/proposals/network-proposal.js

@@ -1,4 +1,3 @@
-// @ts-check
 import { E, Far } from '@endo/far';
 import { BridgeId as BRIDGE_ID } from '@agoric/internal';
 import {

packages/vats/src/proposals/null-upgrade-zoe-proposal.js

@@ -4,7 +4,10 @@ import { E } from '@endo/far';
  * @param {BootstrapPowers & {
  *   consume: {
  *     vatAdminSvc: VatAdminSvc;
- *     vatStore: MapStore<string, CreateVatResults>;
+ *     vatStore: MapStore<
+ *       string,
+ *       import('@agoric/swingset-vat').CreateVatResults
+ *     >;
  *   };
  * }} powers
  * @param {object} options
@@ -16,6 +19,7 @@ export const nullUpgradeZoe = async (
 ) => {
   const { zoeRef } = options.options;
 
+  assert(zoeRef.bundleID);
   const zoeBundleCap = await E(vatAdminSvc).getBundleCap(zoeRef.bundleID);
   console.log(`ZOE BUNDLE ID: `, zoeRef.bundleID);
 

packages/vats/src/proposals/restart-vats-proposal.js

@@ -1,5 +1,3 @@
-// @ts-check
-
 import { Fail } from '@agoric/assert';
 import { deeplyFulfilledObject, makeTracer } from '@agoric/internal';
 import { M, mustMatch } from '@agoric/store';

packages/vats/src/proposals/zcf-proposal.js

@@ -4,7 +4,10 @@ import { E } from '@endo/far';
  * @param {BootstrapPowers & {
  *   consume: {
  *     vatAdminSvc: VatAdminSvc;
- *     vatStore: MapStore<string, CreateVatResults>;
+ *     vatStore: MapStore<
+ *       string,
+ *       import('@agoric/swingset-vat').CreateVatResults
+ *     >;
  *   };
  * }} powers
  * @param {object} options
@@ -16,6 +19,7 @@ export const upgradeZcf = async (
 ) => {
   const { zoeRef, zcfRef } = options.options;
 
+  assert(zoeRef.bundleID);
   const zoeBundleCap = await E(vatAdminSvc).getBundleCap(zoeRef.bundleID);
   console.log(`ZOE BUNDLE ID: `, zoeRef.bundleID);
 

packages/vats/src/repl.js

@@ -1,4 +1,3 @@
-// @ts-check
 import { isPromise } from '@endo/promise-kit';
 import { E, Far } from '@endo/far';
 import * as farExports from '@endo/far';