chore(types): InstallEntrypoint

Jorge-Lopes · Mar 4, 2024 · 6604527 · 6604527
1 parent 54ecb35
commit 6604527
Show file tree

Hide file tree

Showing 10 changed files with 17 additions and 9 deletions.
diff --git a/packages/deploy-script-support/src/endo-pieces-contract.js b/packages/deploy-script-support/src/endo-pieces-contract.js
@@ -18,6 +18,9 @@ export const start = () => {
     });
   };
 
+  /**
+   * @param {{ zoe: ERef<ZoeService> }} opts
+   */
   const makeBundler = ({ zoe }) => {
     /** @type { Map<string, [string, Uint8Array]>} */
     const nameToContent = new Map();

diff --git a/packages/deploy-script-support/src/externalTypes.js b/packages/deploy-script-support/src/externalTypes.js
@@ -16,7 +16,7 @@ export {};
  */
 
 /**
- * @typedef {{ bundleName: string } | { bundleID: string} } ManifestBundleRef
+ * @typedef {{fileName?: string} & ({ bundleName: string } | { bundleID: string}) } ManifestBundleRef
  */
 
 /**
@@ -26,19 +26,19 @@ export {};
  */
 
 /**
- * @callback InstallBundle
+ * @callback InstallEntrypoint
  * @param {string} srcSpec
- * @param {string} bundlePath
- * @param {any} [opts]
+ * @param {string} [bundlePath]
+ * @param {unknown} [opts]
  * @returns {Promise<ManifestBundleRef>}
  */
 
 /**
  * @callback ProposalBuilder
  * @param {{
  *   publishRef: PublishBundleRef,
- *   install: InstallBundle,
- *   wrapInstall?: <T>(f: T) => T }
+ *   install: InstallEntrypoint,
+ *   wrapInstall?: <T extends InstallEntrypoint>(f: T) => T }
  * } powers
  * @param {...any} args
  * @returns {Promise<ProposalResult>}

diff --git a/packages/deploy-script-support/src/getBundlerMaker.js b/packages/deploy-script-support/src/getBundlerMaker.js
@@ -14,6 +14,7 @@ import { E } from '@endo/far';
 import url from 'url';
 
 /** @typedef {ReturnType<import('./endo-pieces-contract.js')['start']>['publicFacet']} BundleMaker */
+/** @typedef {ReturnType<BundleMaker['makeBundler']>} Bundler */
 
 export const makeGetBundlerMaker =
   (homeP, { lookup, bundleSource }) =>

diff --git a/packages/deploy-script-support/src/writeCoreProposal.js b/packages/deploy-script-support/src/writeCoreProposal.js
@@ -39,6 +39,7 @@ export const makeWriteCoreProposal = (
   const { bundleSource, pathResolve } = endowments;
 
   let bundlerCache;
+  /** @returns {import('./getBundlerMaker.js').Bundler} */
   const getBundler = () => {
     if (!bundlerCache) {
       bundlerCache = E(getBundlerMaker()).makeBundler({
@@ -120,6 +121,7 @@ export const makeWriteCoreProposal = (
 
     // Await a reference then publish to the board.
     const cmds = [];
+    /** @param {Promise<import('./externalTypes.js').ManifestBundleRef>} refP */
     const publishRef = async refP => {
       const { fileName, ...ref } = await refP;
       if (fileName) {

diff --git a/packages/deploy-script-support/test/unitTests/test-installInPieces.js b/packages/deploy-script-support/test/unitTests/test-installInPieces.js
@@ -27,6 +27,7 @@ test('installInPieces', async t => {
     },
   };
 
+  // @ts-expect-error fake Zoe
   const bundler = E(publicFacet).makeBundler({ zoe });
 
   const installation = await installInPieces(endoPieces, bundler, {

diff --git a/packages/inter-protocol/scripts/add-collateral-core.js b/packages/inter-protocol/scripts/add-collateral-core.js
@@ -107,6 +107,7 @@ export default async (homeP, endowments) => {
 
   await writeCoreProposal('gov-add-collateral', defaultProposalBuilder);
   await writeCoreProposal('gov-start-psm', opts =>
+    // @ts-expect-error XXX makeInstallCache types
     psmProposalBuilder({ ...opts, wrapInstall: tool.wrapInstall }),
   );
 };
diff --git a/packages/inter-protocol/scripts/init-core.js b/packages/inter-protocol/scripts/init-core.js
@@ -188,9 +188,11 @@ export default async (homeP, endowments) => {
   });
   await Promise.all([
     writeCoreProposal('gov-econ-committee', opts =>
+      // @ts-expect-error XXX makeInstallCache types
       committeeProposalBuilder({ ...opts, wrapInstall: tool.wrapInstall }),
     ),
     writeCoreProposal('gov-amm-vaults-etc', opts =>
+      // @ts-expect-error XXX makeInstallCache types
       mainProposalBuilder({ ...opts, wrapInstall: tool.wrapInstall }),
     ),
   ]);

diff --git a/packages/vats/scripts/build-game1-start.js b/packages/vats/scripts/build-game1-start.js
@@ -27,7 +27,6 @@ export const game1ProposalBuilder = async ({ publishRef, install }) => {
   });
 };
 
-/** @type {DeployScriptFunction} */
 export default async (homeP, endowments) => {
   const { writeCoreProposal } = await makeHelpers(homeP, endowments);
   await writeCoreProposal('start-game1', game1ProposalBuilder);

diff --git a/packages/vats/scripts/build-walletFactory-upgrade.js b/packages/vats/scripts/build-walletFactory-upgrade.js
@@ -28,7 +28,6 @@ export const defaultProposalBuilder = async ({ publishRef, install }) => {
   });
 };
 
-/** @type {DeployScriptFunction} */
 export default async (homeP, endowments) => {
   const { writeCoreProposal } = await makeHelpers(homeP, endowments);
   await writeCoreProposal('upgrade-walletFactory', defaultProposalBuilder);

diff --git a/packages/vats/scripts/set-core-proposal-env.js b/packages/vats/scripts/set-core-proposal-env.js
@@ -10,7 +10,7 @@ if (!spec) {
 }
 
 const vatConfigFile = require.resolve(spec);
-const configJson = fs.readFileSync(vatConfigFile);
+const configJson = fs.readFileSync(vatConfigFile, 'utf-8');
 const config = JSON.parse(configJson);
 
 const envs = new Map();