feat(contract): linting and typedefs

contract/package.json

@@ -13,21 +13,24 @@
     "start": "yarn docker:make clean start-contract print-key",
     "build": "exit 0",
     "test": "ava --verbose",
-    "lint": "eslint '**/*.{js,jsx}'",
-    "lint-fix": "eslint --fix '**/*.{js,jsx}'",
-    "lint-fix-jessie": "eslint -c '.eslintrc-jessie.js' --fix '**/*.{js,jsx}'",
-    "lint-jessie": "eslint -c '.eslintrc-jessie.js' '**/*.{js,jsx}'"
+    "lint": "eslint '**/*.{js,ts}'",
+    "lint-fix": "eslint --fix '**/*.{js,ts}'",
+    "lint-fix-jessie": "eslint -c '.eslintrc-jessie.js' --fix '**/*.js'",
+    "lint-jessie": "eslint -c '.eslintrc-jessie.js' '**/*.js'",
+    "typecheck": "tsc"
   },
   "devDependencies": {
-    "agoric": "^0.21.2-u12.0",
     "@agoric/deploy-script-support": "^0.10.4-u12.0",
+    "@agoric/eslint-config": "dev",
     "@endo/bundle-source": "^2.8.0",
     "@endo/eslint-plugin": "^0.5.2",
     "@endo/init": "^0.5.60",
+    "@endo/promise-kit": "^1.0.1",
     "@endo/ses-ava": "^0.2.44",
     "@jessie.js/eslint-plugin": "^0.4.0",
     "@typescript-eslint/eslint-plugin": "^6.7.0",
     "@typescript-eslint/parser": "^6.7.0",
+    "agoric": "^0.21.2-u12.0",
     "ava": "^5.3.0",
     "eslint": "^8.47.0",
     "eslint-config-airbnb-base": "^15.0.0",
@@ -49,8 +52,8 @@
     "@babel/highlight": "7.22.5"
   },
   "dependencies": {
-    "@agoric/zoe": "^0.26.3-u12.0",
     "@agoric/ertp": "^0.16.3-u12.0",
+    "@agoric/zoe": "^0.26.3-u12.0",
     "@endo/far": "^0.2.22",
     "@endo/marshal": "^0.8.9",
     "@endo/patterns": "^0.2.5"
@@ -73,13 +76,47 @@
   },
   "homepage": "https://github.com/agoric-labs/dapp-join-game#readme",
   "eslintConfig": {
+    "env": {
+      "node": true
+    },
+    "parser": "@typescript-eslint/parser",
+    "parserOptions": {
+      "project": "./tsconfig.json",
+      "sourceType": "module",
+      "ecmaVersion": 2020
+    },
     "extends": [
+      "plugin:@typescript-eslint/recommended",
       "@agoric"
-    ]
+    ],
+    "plugins": [
+      "@typescript-eslint",
+      "prettier"
+    ],
+    "rules": {
+      "@typescript-eslint/prefer-ts-expect-error": "warn",
+      "@typescript-eslint/no-floating-promises": "warn",
+      "no-void": [
+        "error",
+        {
+          "allowAsStatement": true
+        }
+      ],
+      "prettier/prettier": "warn",
+      "@typescript-eslint/no-unused-vars": [
+        "error",
+        {
+          "vars": "all",
+          "args": "all",
+          "argsIgnorePattern": "^_",
+          "varsIgnorePattern": "^_"
+        }
+      ]
+    }
   },
   "prettier": {
     "trailingComma": "all",
     "arrowParens": "avoid",
     "singleQuote": true
   }
-}
+}

contract/scripts/build-game1-start.js

@@ -16,11 +16,9 @@ export const game1ProposalBuilder = async ({ publishRef, install }) => {
       getManifestForGame1.name,
       {
         game1Ref: publishRef(
-          install(
-            '../src/gameAssetContract.js',
-            '../bundles/bundle-game1.js',
-            { persist: true },
-          ),
+          install('../src/gameAssetContract.js', '../bundles/bundle-game1.js', {
+            persist: true,
+          }),
         ),
       },
     ],

contract/src/gameAssetContract.js

@@ -23,8 +23,9 @@ const bagValueSize = amt => {
   return total;
 };
 
+/** @typedef {StandardTerms & { joinPrice: Amount<'nat'> }} GamePlacesTerms */
 /**
- * @param {ZCF<{joinPrice: Amount}>} zcf
+ * @param {ZCF<GamePlacesTerms>} zcf
  */
 export const start = async zcf => {
   const { joinPrice } = zcf.getTerms();

contract/src/start-game1-proposal.js

@@ -1,7 +1,8 @@
 // @ts-check
-import { E } from '@endo/far';
+import { E } from '@endo/eventual-send';
 import { makeMarshal } from '@endo/marshal';
 import { AmountMath } from '@agoric/ertp/src/amountMath.js';
+import '@agoric/zoe/exported.js';
 
 console.warn('start-game1-proposal.js module evaluating');
 
@@ -26,6 +27,11 @@ const makeBoardAuxNode = async (chainStorage, boardId) => {
   return E(boardAux).makeChildNode(boardId);
 };
 
+/**
+ * @param {ERef<StorageNode>} chainStorage
+ * @param {ERef<import('@agoric/vats/src/types').Board>} board
+ * @param {ERef<Brand>} brand
+ */
 const publishBrandInfo = async (chainStorage, board, brand) => {
   const [id, displayInfo] = await Promise.all([
     E(board).getId(brand),
@@ -38,28 +44,25 @@ const publishBrandInfo = async (chainStorage, board, brand) => {
 
 /**
  * Core eval script to start contract
- *
- * @param {BootstrapPowers} permittedPowers
+ * XXX FIXME File '~/agoric-sdk/packages/vats/src/core/types.js' is not a module
+ * @param {import('@agoric/vats/src/core/types').BootstrapPowers} permittedPowers
  */
 export const startGameContract = async permittedPowers => {
   console.error('startGameContract()...');
   const {
     consume: { board, chainStorage, startUpgradable, zoe },
     brand: {
       consume: { IST: istBrandP },
-      // @ts-expect-error dynamic extension to promise space
       produce: { Place: producePlaceBrand },
     },
     issuer: {
       consume: { IST: istIssuerP },
-      // @ts-expect-error dynamic extension to promise space
       produce: { Place: producePlaceIssuer },
     },
     installation: {
       consume: { game1: game1InstallationP },
     },
     instance: {
-      // @ts-expect-error dynamic extension to promise space
       produce: { game1: produceInstance },
     },
   } = permittedPowers;
@@ -117,6 +120,9 @@ const gameManifest = {
 };
 harden(gameManifest);
 
+/**
+ * @param {{restoreRef: (ref: unknown) => Promise<unknown> }} r
+ * @param {{ game1Ref: unknown }} g */
 export const getManifestForGame1 = ({ restoreRef }, { game1Ref }) => {
   return harden({
     manifest: gameManifest,

contract/test/mintStable.js

@@ -4,7 +4,7 @@
  */
 
 // @ts-check
-import { E } from '@endo/far';
+import { E } from '@endo/eventual-send';
 import { createRequire } from 'module';
 
 const myRequire = createRequire(import.meta.url);
@@ -27,7 +27,7 @@ const centralSupplyPath = myRequire.resolve(
  * just for this purpose. Each time we want to mint a fee/stable token payment,
  * we make an instance of of the `centralSupply` contract.
  *
- * @param {Object} powers
+ * @param {object} powers
  * @param {ERef<FeeMintAccess>} powers.feeMintAccess for minting IST
  * @param {ERef<ZoeService>} powers.zoe for starting the `centralSupply` contract
  * @param {BundleCache} powers.bundleCache for bundling the `centralSupply` contract

contract/test/test-bundle-source.js

@@ -8,7 +8,8 @@ import { test } from './prepare-test-env-ava.js';
 
 import { createRequire } from 'module';
 import bundleSource from '@endo/bundle-source';
-import { E, passStyleOf } from '@endo/far';
+import { E } from '@endo/eventual-send';
+import { passStyleOf } from '@endo/far';
 import { makeZoeKitForTest } from '@agoric/zoe/tools/setup-zoe.js';
 
 const myRequire = createRequire(import.meta.url);

contract/test/test-contract.js

@@ -7,7 +7,8 @@
 import { test as anyTest } from './prepare-test-env-ava.js';
 
 import { createRequire } from 'module';
-import { E, Far } from '@endo/far';
+import { E } from '@endo/eventual-send';
+import { Far } from '@endo/far';
 import { makePromiseKit } from '@endo/promise-kit';
 import { makeCopyBag } from '@endo/patterns';
 import { makeNodeBundleCache } from '@endo/bundle-source/cache.js';
@@ -78,8 +79,9 @@ test('Start the contract', async t => {
  *
  * @param {import('ava').ExecutionContext} t
  * @param {ZoeService} zoe
- * @param {ERef<import('@agoric/zoe/src/zoeService/utils').Instance<GameContractFn>} instance
- * @param {Purse} purse
+ * @param {import('@agoric/zoe/src/zoeService/utils').Instance<GameContractFn>} instance
+ * @param {Purse<"nat">} purse
+ * @param {string[]} choices
  */
 const alice = async (
   t,
@@ -89,7 +91,7 @@ const alice = async (
   choices = ['Park Place', 'Boardwalk'],
 ) => {
   const publicFacet = E(zoe).getPublicFacet(instance);
-  // @ts-expect-error Promise<Instance> seems to work
+  /** @type {import('../src/gameAssetContract.js').GamePlacesTerms} */
   const terms = await E(zoe).getTerms(instance);
   const { issuers, brands, joinPrice } = terms;
 
@@ -187,6 +189,14 @@ test('use the code that will go on chain to start the contract', async t => {
     });
 
     const { zoe } = t.context;
+    /**
+     * @param {{
+     *  installation: ERef<Installation<GameContractFn>>;
+     *  issuerKeywordRecord: IssuerKeywordRecord;
+     *  label: string;
+     *  terms: import('../src/gameAssetContract.js').GamePlacesTerms;
+     * }} opts
+     */
     const startUpgradable = async ({
       installation,
       issuerKeywordRecord,

contract/tsconfig.json

@@ -0,0 +1,17 @@
+{
+  "compilerOptions": {
+    "noEmit": true,
+    "target": "esnext",
+    "module": "esnext",
+    "moduleResolution": "node",
+    "skipLibCheck": true,
+    // Don't check by default because that includes node_modules in JS
+    "checkJs": false,
+    // Features implied with jsconfig.json that have to be explicit in tsconfig.json
+    "allowJs": true,
+    "allowSyntheticDefaultImports": true,
+    "maxNodeModuleJsDepth": 2,
+    "strict": true
+  },
+  "include": ["**/*.js", "**/*.ts"]
+}

yarn.lock

@@ -167,6 +167,11 @@
     "@endo/nat" "4.1.27"
     "@endo/promise-kit" "0.2.56"
 
+"@agoric/eslint-config@dev":
+  version "0.4.1-dev-a0d8229.0"
+  resolved "https://registry.yarnpkg.com/@agoric/eslint-config/-/eslint-config-0.4.1-dev-a0d8229.0.tgz#cbe1cbd0f39bf65bfbc0d2fdf93fa8f0ae4dbbdf"
+  integrity sha512-cs1Gr4WFm2vY5ixBTP0YYYE1503x5wSDYPZuvjyVvCTs+6eRGj7cKOd+1qkZ+uRSFlOoKFYMaQHmqvAuzXMtAg==
+
 "@agoric/eventual-send@^0.14.1":
   version "0.14.1"
   resolved "https://registry.yarnpkg.com/@agoric/eventual-send/-/eventual-send-0.14.1.tgz#b414888bed67cf003a61bd22da30a70f79b8f9dc"
@@ -1401,6 +1406,11 @@
   resolved "https://registry.yarnpkg.com/@endo/env-options/-/env-options-0.1.4.tgz#e516bc3864f00b154944e444fb8996a9a0c23a45"
   integrity sha512-Ol8ct0aW8VK1ZaqntnUJfrYT59P6Xn36XPbHzkqQhsYkpudKDn5ILYEwGmSO/Ff+XJjv/pReNI0lhOyyrDa9mg==
 
+"@endo/env-options@^1.0.1":
+  version "1.0.1"
+  resolved "https://registry.yarnpkg.com/@endo/env-options/-/env-options-1.0.1.tgz#a6ad1951f3303426cd15956aa7b95ea06cb34ad0"
+  integrity sha512-5hieu6ow9Kgf2wKKchE1xQEN7VlKVLL3O0eEjxN9d52XodHMbEFu0gGoFA6NeQJq9SHNrbgJhZDfMkPaHvoFxg==
+
 "@endo/eslint-plugin@^0.5.2":
   version "0.5.2"
   resolved "https://registry.yarnpkg.com/@endo/eslint-plugin/-/eslint-plugin-0.5.2.tgz#835d22e9ff17d9935f7f565e50a21ef07aa92ca2"
@@ -1603,6 +1613,13 @@
   dependencies:
     ses "^0.18.8"
 
+"@endo/promise-kit@^1.0.1":
+  version "1.0.1"
+  resolved "https://registry.yarnpkg.com/@endo/promise-kit/-/promise-kit-1.0.1.tgz#056c8cd59e52260fc4cea2a83422450333a04e26"
+  integrity sha512-JLhfkuQaERVvf+G+kXpDjyzyik3kxkX1FHbiDQfK2ge9Ltz7vRk/OD+yZma0UE2Rn91F2B/mvelxz1MxlYibwA==
+  dependencies:
+    ses "^1.0.1"
+
 "@endo/[email protected]":
   version "0.2.40"
   resolved "https://registry.yarnpkg.com/@endo/ses-ava/-/ses-ava-0.2.40.tgz#8a6c1f668131ecbe4d06339cac2a8346253089b8"
@@ -6168,6 +6185,13 @@ ses@^0.18.4, ses@^0.18.5, ses@^0.18.8:
   dependencies:
     "@endo/env-options" "^0.1.4"
 
+ses@^1.0.1:
+  version "1.0.1"
+  resolved "https://registry.yarnpkg.com/ses/-/ses-1.0.1.tgz#ede4c688b150ffa4d368679d8c1f8ee57d9e4836"
+  integrity sha512-iuqGQ1dsktipGgmC/FLL2agq88WcarXxbFDKMEPVyRUxhAhReKpBIO63uDK4IvYYofFJ6FpfhNn/mVTNZpPOCg==
+  dependencies:
+    "@endo/env-options" "^1.0.1"
+
 set-function-length@^1.1.1:
   version "1.1.1"
   resolved "https://registry.yarnpkg.com/set-function-length/-/set-function-length-1.1.1.tgz#4bc39fafb0307224a33e106a7d35ca1218d659ed"