chore(types): DeployScriptFunction

packages/agoric-cli/test/upgrade-contract/propose-buggy-contract.js

@@ -15,6 +15,7 @@ export const defaultProposalBuilder = async ({ publishRef, install }) =>
     ],
   });
 
+/** @type {import('@agoric/deploy-script-support/src/externalTypes.js').DeployScriptFunction} */
 export default async (homeP, endowments) => {
   const helperEndowments = {
     ...endowments,

packages/agoric-cli/test/upgrade-contract/propose-upgrade-contract.js

@@ -14,6 +14,7 @@ export const defaultProposalBuilder = async ({ publishRef, install }) =>
     ],
   });
 
+/** @type {import('@agoric/deploy-script-support/src/externalTypes.js').DeployScriptFunction} */
 export default async (homeP, endowments) => {
   const helperEndowments = {
     ...endowments,

packages/deploy-script-support/src/externalTypes.js

@@ -39,3 +39,41 @@ export {};
  * @param {...any} args
  * @returns {Promise<ProposalResult>}
  */
+
+/**
+ * @typedef {{
+ *  bundleSource: typeof import('@endo/bundle-source').default,
+ *  now: () => number,
+ *  lookup: (...path: string[]) => unknown,
+ *  publishBundle: PublishBundleRef,
+ *  pathResolve: (...path: string[]) => string,
+ *  cacheDir: string,
+ * }} DeployScriptEndownments
+ */
+
+/**
+ * @typedef {{
+ * agoricNames: ERef<NameHub>,
+ * bank: ERef<import("@agoric/vats/src/vat-bank.js").Bank>,
+ * board: ERef<import("@agoric/vats").Board>,
+ * faucet: unknown,
+ * myAddressNameAdmin: ERef<import("@agoric/vats").NameAdmin>,
+ * namesByAddress: ERef<NameHub>,
+ * scratch: ERef<import('@agoric/internal/src/scratch.js').ScratchPad>,
+ * zoe: ERef<ZoeService>,
+ * }} CanonicalHome
+ */
+
+// TODO wallet as import('@agoric/wallet-backend/src/types').WalletAdmin once it's a module
+/**
+ * @typedef {CanonicalHome & {
+ * wallet?: any,
+ * }} AgSoloHome
+ */
+
+/**
+ * @callback DeployScriptFunction
+ * @param {Promise<CanonicalHome>} homeP
+ * @param {DeployScriptEndownments} endowments
+ * @returns {Promise<void>}
+ */

packages/deploy-script-support/src/helpers.js

@@ -50,6 +50,10 @@ const makeLazyObject = sourceObject => {
   return /** @type {T} */ (lazyObject);
 };
 
+/**
+ * @param {Promise<import('./externalTypes.js').AgSoloHome>} homePromise
+ * @param {import('./externalTypes.js').DeployScriptEndownments} endowments
+ */
 export const makeHelpers = async (homePromise, endowments) => {
   // Endowments provided via `agoric run` or `agoric deploy`.
   const {

packages/inter-protocol/scripts/add-collateral-core.js

@@ -98,6 +98,7 @@ export const psmProposalBuilder = async (
   });
 };
 
+/** @type {import('@agoric/deploy-script-support/src/externalTypes.js').DeployScriptFunction} */
 export default async (homeP, endowments) => {
   const { writeCoreProposal } = await makeHelpers(homeP, endowments);
 

packages/inter-protocol/scripts/deploy-contracts.js

@@ -30,6 +30,7 @@ const provideWhen = async (store, key, make) => {
   return value;
 };
 
+/** @type {import('@agoric/deploy-script-support/src/externalTypes.js').DeployScriptFunction} */
 export default async (homeP, endowments) => {
   const home = await homeP;
   const { zoe, scratch, board } = home;

packages/inter-protocol/scripts/init-core.js

@@ -180,6 +180,7 @@ export const defaultProposalBuilder = async (
   });
 };
 
+/** @type {import('@agoric/deploy-script-support/src/externalTypes.js').DeployScriptFunction} */
 export default async (homeP, endowments) => {
   const { writeCoreProposal } = await makeHelpers(homeP, endowments);
 

packages/inter-protocol/scripts/invite-committee-core.js

@@ -36,6 +36,7 @@ export const defaultProposalBuilder = async (
   });
 };
 
+/** @type {import('@agoric/deploy-script-support/src/externalTypes.js').DeployScriptFunction} */
 export default async (homeP, endowments) => {
   const { writeCoreProposal } = await makeHelpers(homeP, endowments);
   await writeCoreProposal('gov-invite-committee', defaultProposalBuilder);

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

@@ -91,7 +91,7 @@ const provideWhen = async (store, key, make) => {
 };
 
 /**
- * @param {{ scratch: ERef<import('@agoric/internal/src/scratch.js').ScratchPad> }} homeP
+ * @param {Promise<{ scratch: ERef<import('@agoric/internal/src/scratch.js').ScratchPad> }>} homeP
  * @param {object} opts
  * @param {(specifier: string) => Promise<{default: Bundle}>} opts.loadBundle
  * @param {string} [opts.installCacheKey]

packages/pegasus/scripts/init-core.js

@@ -14,6 +14,7 @@ export const defaultProposalBuilder = async ({ publishRef, install }) =>
     ],
   });
 
+/** @type {import('@agoric/deploy-script-support/src/externalTypes.js').DeployScriptFunction} */
 export default async (homeP, endowments) => {
   const { writeCoreProposal } = await makeHelpers(homeP, endowments);
   await writeCoreProposal('gov-pegasus', defaultProposalBuilder);

packages/vats/scripts/init-core.js

@@ -25,6 +25,7 @@ export const defaultProposalBuilder = async ({ publishRef, install }) =>
     ],
   });
 
+/** @type {import('@agoric/deploy-script-support/src/externalTypes.js').DeployScriptFunction} */
 export default async (homeP, endowments) => {
   const { writeCoreProposal } = await makeHelpers(homeP, endowments);
   await writeCoreProposal('gov-vats', defaultProposalBuilder);

packages/vats/scripts/init-network.js

@@ -13,6 +13,7 @@ export const defaultProposalBuilder = async ({ publishRef, install }) =>
     ],
   });
 
+/** @type {import('@agoric/deploy-script-support/src/externalTypes.js').DeployScriptFunction} */
 export default async (homeP, endowments) => {
   const { writeCoreProposal } = await makeHelpers(homeP, endowments);
   await writeCoreProposal('gov-network', defaultProposalBuilder);

packages/vats/scripts/restart-vats.js

@@ -17,6 +17,7 @@ export const defaultProposalBuilder = async () => {
   });
 };
 
+/** @type {import('@agoric/deploy-script-support/src/externalTypes.js').DeployScriptFunction} */
 export default async (homeP, endowments) => {
   const { writeCoreProposal } = await makeHelpers(homeP, endowments);
   await writeCoreProposal('restart-vats', defaultProposalBuilder);