@agoric/deploy-script-support 0.10.4-dev-d1a4a53.0 → 0.10.4-dev-872bb3b.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@agoric/deploy-script-support",
-  "version": "0.10.4-dev-d1a4a53.0+d1a4a53",
+  "version": "0.10.4-dev-872bb3b.0+872bb3b",
   "description": "Helpers and other support for writing deploy scripts",
   "type": "module",
   "main": "src/helpers.js",
@@ -13,7 +13,7 @@
     "test:xs": "exit 0",
     "lint-fix": "yarn lint:eslint --fix",
     "lint:eslint": "eslint .",
-    "lint:types": "tsc -p jsconfig.json",
+    "lint:types": "tsc",
     "lint": "run-s --continue-on-error lint:*"
   },
   "repository": {
@@ -34,14 +34,14 @@
   },
   "homepage": "https://github.com/Agoric/agoric-sdk#readme",
   "dependencies": {
-    "@agoric/assert": "0.6.1-dev-d1a4a53.0+d1a4a53",
-    "@agoric/ertp": "0.16.3-dev-d1a4a53.0+d1a4a53",
-    "@agoric/import-manager": "0.3.12-dev-d1a4a53.0+d1a4a53",
-    "@agoric/internal": "0.3.3-dev-d1a4a53.0+d1a4a53",
-    "@agoric/notifier": "0.6.3-dev-d1a4a53.0+d1a4a53",
-    "@agoric/store": "0.9.3-dev-d1a4a53.0+d1a4a53",
-    "@agoric/time": "0.3.3-dev-d1a4a53.0+d1a4a53",
-    "@agoric/zoe": "0.26.3-dev-d1a4a53.0+d1a4a53",
+    "@agoric/assert": "0.6.1-dev-872bb3b.0+872bb3b",
+    "@agoric/ertp": "0.16.3-dev-872bb3b.0+872bb3b",
+    "@agoric/import-manager": "0.3.12-dev-872bb3b.0+872bb3b",
+    "@agoric/internal": "0.3.3-dev-872bb3b.0+872bb3b",
+    "@agoric/notifier": "0.6.3-dev-872bb3b.0+872bb3b",
+    "@agoric/store": "0.9.3-dev-872bb3b.0+872bb3b",
+    "@agoric/time": "0.3.3-dev-872bb3b.0+872bb3b",
+    "@agoric/zoe": "0.26.3-dev-872bb3b.0+872bb3b",
     "@endo/base64": "^0.2.32",
     "@endo/bundle-source": "^2.5.2",
     "@endo/far": "^0.2.19",
@@ -51,7 +51,7 @@
     "@endo/zip": "^0.2.32"
   },
   "devDependencies": {
-    "@agoric/vats": "0.15.2-dev-d1a4a53.0+d1a4a53",
+    "@agoric/vats": "0.15.2-dev-872bb3b.0+872bb3b",
     "@endo/init": "^0.5.57",
     "ava": "^5.3.0",
     "import-meta-resolve": "^2.2.1"
@@ -69,5 +69,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "d1a4a539cd1f60bf7bc04c037688ec46e0ce6a40"
+  "gitHead": "872bb3be25122001190a35d0155d942315c81238"
 }

package/src/externalTypes.js

@@ -30,7 +30,7 @@ export {};
  * @param {string} srcSpec
  * @param {string} bundlePath
  * @param {any} [opts]
- * @returns {ManifestBundleRef}
+ * @returns {Promise<ManifestBundleRef>}
  */
 
 /**

package/src/extract-proposal.js

@@ -40,6 +40,19 @@ const findModule = (initDir, srcSpec) =>
     ? pathResolve(initDir, srcSpec)
     : req.resolve(srcSpec);
 
+/**
+ * @param {{ bundleID?: string, bundleName?: string }} handle - mutated then hardened
+ * @param {string} sourceSpec - the specifier of a module to load
+ * @param {number} sequence - the sequence number of the proposal
+ * @param {string} piece - the piece of the proposal
+ * @returns {Promise<[string, any]>}
+ */
+const namedHandleToBundleSpec = async (handle, sourceSpec, sequence, piece) => {
+  handle.bundleName = `coreProposal${sequence}_${piece}`;
+  harden(handle);
+  return harden([handle.bundleName, { sourceSpec }]);
+};
+
 /**
  * Format core proposals to be run at bootstrap:
  * SwingSet `bundles` configuration
@@ -54,26 +67,28 @@ const findModule = (initDir, srcSpec) =>
  * @param {ConfigProposal[]} coreProposals - governance
  * proposals to run at chain bootstrap for scenarios such as sim-chain.
  * @param {FilePath} [dirname]
- * @param {typeof makeEnactCoreProposalsFromBundleRef} [makeEnactCoreProposals]
- * @param {(i: number) => number} [getSequenceForProposal]
+ * @param {object} [opts]
+ * @param {typeof makeEnactCoreProposalsFromBundleRef} [opts.makeEnactCoreProposals]
+ * @param {(i: number) => number} [opts.getSequenceForProposal]
+ * @param {typeof namedHandleToBundleSpec} [opts.handleToBundleSpec]
  */
 export const extractCoreProposalBundles = async (
   coreProposals,
   dirname = '.',
-  makeEnactCoreProposals = makeEnactCoreProposalsFromBundleRef,
-  getSequenceForProposal,
+  opts,
 ) => {
-  if (!getSequenceForProposal) {
-    // Deterministic proposal numbers.
-    getSequenceForProposal = i => i;
-  }
+  const {
+    makeEnactCoreProposals = makeEnactCoreProposalsFromBundleRef,
+    getSequenceForProposal = i => i,
+    handleToBundleSpec = namedHandleToBundleSpec,
+  } = opts || {};
 
   dirname = pathResolve(dirname);
   dirname = await fs.promises
     .stat(dirname)
     .then(stbuf => (stbuf.isDirectory() ? dirname : path.dirname(dirname)));
 
-  /** @type {Map<{ bundleName?: string }, { source: string, bundle?: string }>} */
+  /** @type {Map<{ bundleID?: string, bundleName?: string }, { source: string, bundle?: string }>} */
   const bundleHandleToAbsolutePaths = new Map();
 
   const bundleToSource = new Map();
@@ -151,29 +166,30 @@ export const extractCoreProposalBundles = async (
       );
 
       // Add the proposal bundle handles in sorted order.
-      const bundleSpecEntries = [...thisProposalBundleHandles.keys()]
-        .map(handle => [handle, bundleHandleToAbsolutePaths.get(handle)])
-        .sort(([_hnda, { source: a }], [_hndb, { source: b }]) => {
-          if (a < b) {
-            return -1;
-          }
-          if (a > b) {
-            return 1;
-          }
-          return 0;
-        })
-        .map(([handle, absolutePaths], j) => {
-          // Transform the bundle handle identity into a bundleName reference.
-          handle.bundleName = `coreProposal${thisProposalSequence}_${j}`;
-          harden(handle);
-
-          /** @type {[string, { sourceSpec: string }]} */
-          const specEntry = [
-            handle.bundleName,
-            { sourceSpec: absolutePaths.source },
-          ];
-          return specEntry;
-        });
+      const bundleSpecEntries = await Promise.all(
+        [...thisProposalBundleHandles.keys()]
+          .map(handle => [handle, bundleHandleToAbsolutePaths.get(handle)])
+          .sort(([_hnda, { source: a }], [_hndb, { source: b }]) => {
+            if (a < b) {
+              return -1;
+            }
+            if (a > b) {
+              return 1;
+            }
+            return 0;
+          })
+          .map(async ([handle, absolutePaths], j) => {
+            // Transform the bundle handle identity into a bundleName reference.
+            const specEntry = await handleToBundleSpec(
+              handle,
+              absolutePaths.source,
+              thisProposalSequence,
+              String(j),
+            );
+            harden(handle);
+            return specEntry;
+          }),
+      );
 
       // Now that we've assigned all the bundleNames and hardened the
       // handles, we can extract the behavior bundle.
@@ -192,21 +208,21 @@ export const extractCoreProposalBundles = async (
         exportedGetManifest
       ](harden({ restoreRef: () => null }), ...manifestArgs);
 
-      const behaviorBundleHandle = harden({
-        bundleName: `coreProposal${thisProposalSequence}_behaviors`,
-      });
-      const behaviorAbsolutePaths = harden({
-        source: behaviorSource,
-      });
-      bundleHandleToAbsolutePaths.set(
+      const behaviorBundleHandle = {};
+      const specEntry = await handleToBundleSpec(
         behaviorBundleHandle,
-        behaviorAbsolutePaths,
+        behaviorSource,
+        thisProposalSequence,
+        'behaviors',
       );
+      bundleSpecEntries.unshift(specEntry);
 
-      bundleSpecEntries.unshift([
-        behaviorBundleHandle.bundleName,
-        { sourceSpec: behaviorAbsolutePaths.source },
-      ]);
+      bundleHandleToAbsolutePaths.set(
+        behaviorBundleHandle,
+        harden({
+          source: behaviorSource,
+        }),
+      );
 
       return harden({
         ref: behaviorBundleHandle,

package/src/getBundlerMaker.js

@@ -13,6 +13,8 @@
 import { E } from '@endo/far';
 import url from 'url';
 
+/** @typedef {ReturnType<import('./endo-pieces-contract.js')['start']>['publicFacet']} BundleMaker */
+
 export const makeGetBundlerMaker =
   (homeP, { lookup, bundleSource }) =>
   async ({
@@ -20,6 +22,7 @@ export const makeGetBundlerMaker =
     log = console.log,
   } = {}) => {
     const { board: optionalBoard, zoe, scratch } = await homeP;
+    /** @type {() => Promise<BundleMaker>} */
     const lookupOrCreate = async () => {
       // Locate the bundler maker if any already exists at the given path.
       let bundlerMaker = await lookup(JSON.parse(BUNDLER_MAKER_LOOKUP));

package/src/writeCoreProposal.js

@@ -7,6 +7,25 @@ import { createBundles } from '@agoric/internal/src/node/createBundles.js';
 import { defangAndTrim, mergePermits, stringify } from './code-gen.js';
 import { makeCoreProposalBehavior, permits } from './coreProposalBehavior.js';
 
+/**
+ * @callback WriteCoreProposal
+ * @param {string} filePrefix
+ * @param {import('./externalTypes.js').ProposalBuilder} proposalBuilder
+ * @returns {Promise<void>}
+ */
+
+/**
+ *
+ * @param {*} homeP
+ * @param {*} endowments
+ * @param {{
+ *   getBundlerMaker: () => Promise<import('./getBundlerMaker.js').BundleMaker>,
+ *   getBundleSpec: (...args: *) => Promise<import('./externalTypes.js').ManifestBundleRef>,
+ *   log?: typeof console.log,
+ *   writeFile?: typeof fs.promises.writeFile
+ * }} io
+ * @returns {WriteCoreProposal}
+ */
 export const makeWriteCoreProposal = (
   homeP,
   endowments,
@@ -50,8 +69,18 @@ export const makeWriteCoreProposal = (
     };
   };
 
-  let mutex = Promise.resolve();
+  let mutex =
+    /** @type {Promise<import('./externalTypes.js').ManifestBundleRef | undefined>} */ (
+      Promise.resolve()
+    );
+  /** @type {WriteCoreProposal} */
   const writeCoreProposal = async (filePrefix, proposalBuilder) => {
+    /**
+     *
+     * @param {string} entrypoint
+     * @param {string} [bundlePath]
+     * @returns {Promise<NodeModule>}
+     */
     const getBundle = async (entrypoint, bundlePath) => {
       if (!bundlePath) {
         return bundleSource(pathResolve(entrypoint));
@@ -62,7 +91,14 @@ export const makeWriteCoreProposal = (
       return ns.default;
     };
 
-    // Install an entrypoint.
+    /**
+     * Install an entrypoint.
+     *
+     * @param {string} entrypoint
+     * @param {string} [bundlePath]
+     * @param [opts]
+     * @returns {Promise<import('./externalTypes.js').ManifestBundleRef>}
+     */
     const install = async (entrypoint, bundlePath, opts) => {
       const bundle = getBundle(entrypoint, bundlePath);
 
@@ -71,6 +107,7 @@ export const makeWriteCoreProposal = (
         // console.log('installing', { filePrefix, entrypoint, bundlePath });
         return getBundleSpec(bundle, getBundler, opts);
       });
+      // @ts-expect-error xxx mutex type narrowing
       return mutex;
     };