Merge pull request #8568 from Agoric/ta/privateArgs-types

typedefs for Zoe privateArgs

packages/inter-protocol/src/proposals/econ-behaviors.js

@@ -462,9 +462,9 @@ export const startRewardDistributor = async ({
     });
 
   /**
-   * @type {Awaited<
-   *   ReturnType<typeof import('../feeDistributor.js').makeFeeDistributor>
-   * > & { adminFacet: AdminFacet; instance: Instance }}
+   * @type {StartedInstanceKit<
+   *   typeof import('@agoric/inter-protocol/src/feeDistributor.js').start
+   * >}
    */
   const instanceKit = await E(zoe).startInstance(
     feeDistributor,
@@ -473,7 +473,6 @@ export const startRewardDistributor = async ({
     undefined,
     'feeDistributor',
   );
-  /** @type {ERef<import('../feeDistributor.js').FeeDestination>} */
   await E(instanceKit.creatorFacet).setDestinations({
     ...(rewardDistributorDepositFacet && {
       RewardDistributor: E(

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

@@ -197,7 +197,7 @@ async function makePsmDriver(t, customTerms) {
   // Each driver needs its own to avoid state pollution between tests
   const mockChainStorage = makeMockChainStorageRoot();
 
-  /** @type {Awaited<ReturnType<import('../../src/psm/psm.js').start>>} */
+  /** @type {StartedInstanceKit<import('../../src/psm/psm.js').start>} */
   const { creatorFacet, publicFacet } = await E(zoe).startInstance(
     psmInstall,
     harden({ AUSD: anchor.issuer }),

packages/inter-protocol/test/swingsetTests/psmUpgrade/bootstrap-psm-upgrade.js

@@ -276,6 +276,8 @@ export const buildRootObject = async () => {
       ).getAdminFacet();
       const upgradeResult = await E(psmAdminFacet).upgradeContract(bundleId, {
         ...staticPrivateArgs,
+        // @ts-expect-error mock
+        feeMintAccess: undefined,
         initialPoserInvitation,
       });
       // incremented from zero

packages/inter-protocol/test/swingsetTests/reserve/bootstrap-assetReserve-upgrade.js

@@ -245,6 +245,8 @@ export const buildRootObject = async () => {
       const arAdminFacet = await E(governorFacets.creatorFacet).getAdminFacet();
       const upgradeResult = await E(arAdminFacet).upgradeContract(bundleId, {
         ...staticPrivateArgs,
+        // @ts-expect-error mock
+        feeMintAccess: undefined,
         initialPoserInvitation,
       });
       assert.equal(upgradeResult.incarnationNumber, 1);

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

@@ -3,7 +3,7 @@ import { E } from '@endo/far';
 /**
  * @param {BootstrapPowers & {
  *   consume: {
- *     vatAdminSvc: VatAdminSve;
+ *     vatAdminSvc: VatAdminSvc;
  *     vatStore: MapStore<string, CreateVatResults>;
  *   };
  * }} powers

packages/zoe/src/contractFacet/types-ambient.d.ts

@@ -244,4 +244,4 @@ type ContractStartFnResult<PF, CF> = {
   creatorInvitation?: Promise<Invitation<R, A>> | undefined;
 };
 type ContractOf<S> = import('../zoeService/utils').ContractOf<S>;
-type AdminFacet = import('../zoeService/utils').AdminFacet;
+type AdminFacet = import('../zoeService/utils').AdminFacet<any>;

packages/zoe/src/zoeService/utils.d.ts

@@ -11,16 +11,6 @@ type ContractFacet<T extends {} = {}> = {
   readonly [P in keyof T]: T[P] extends Callable ? T[P] : never;
 };
 
-export type AdminFacet = {
-  // Completion, which is currently any
-  getVatShutdownPromise: () => Promise<any>;
-  upgradeContract: (
-    contractBundleId: string,
-    newPrivateArgs?: any,
-  ) => Promise<VatUpgradeResults>;
-  restartContract: (newPrivateArgs?: any) => Promise<VatUpgradeResults>;
-};
-
 /**
  * Installation of a contract, typed by its start function.
  */
@@ -46,11 +36,29 @@ type ContractStartFunction = (
   baggage?: Baggage,
 ) => ERef<{ creatorFacet?: {}; publicFacet?: {} }>;
 
+export type AdminFacet<SF extends ContractStartFunction> = {
+  // Completion, which is currently any
+  getVatShutdownPromise: () => Promise<any>;
+  upgradeContract: Parameters<SF>[1] extends undefined
+    ? (contractBundleId: string) => Promise<VatUpgradeResults>
+    : (
+        contractBundleId: string,
+        newPrivateArgs: Parameters<SF>[1],
+      ) => Promise<VatUpgradeResults>;
+  restartContract: Parameters<SF>[1] extends undefined
+    ? () => Promise<VatUpgradeResults>
+    : (newPrivateArgs: Parameters<SF>[1]) => Promise<VatUpgradeResults>;
+};
+
 type StartParams<SF> = SF extends ContractStartFunction
-  ? {
-      terms: ReturnType<Parameters<SF>[0]['getTerms']>;
-      privateArgs: Parameters<SF>[1];
-    }
+  ? Parameters<SF>[1] extends undefined
+    ? {
+        terms: ReturnType<Parameters<SF>[0]['getTerms']>;
+      }
+    : {
+        terms: ReturnType<Parameters<SF>[0]['getTerms']>;
+        privateArgs: Parameters<SF>[1];
+      }
   : never;
 
 type StartResult<S> = S extends (...args: any) => Promise<infer U>
@@ -72,13 +80,13 @@ type StartContractInstance<C> = (
   publicFacet: C['publicFacet'];
   instance: Instance;
   creatorInvitation: C['creatorInvitation'];
-  adminFacet: AdminFacet;
+  adminFacet: AdminFacet<any>;
 }>;
 
 /** The result of `startInstance` */
 export type StartedInstanceKit<SF> = {
   instance: Instance<SF>;
-  adminFacet: AdminFacet;
+  adminFacet: AdminFacet<SF>;
   // theses are empty by default. the return type will override
   creatorFacet: {};
   publicFacet: {};

packages/zoe/src/zoeService/utils.test-d.ts

@@ -0,0 +1,33 @@
+import type { StartedInstanceKit } from './utils';
+
+const someContractStartFn = (
+  zcf: ZCF,
+  privateArgs: { someNumber: number; someString: string },
+) => {};
+
+type PsmInstanceKit = StartedInstanceKit<typeof someContractStartFn>;
+
+const psmInstanceKit: PsmInstanceKit = null as any;
+
+// @ts-expect-error missing privateArgs argument
+void psmInstanceKit.adminFacet.restartContract();
+
+const partial = {
+  someNumber: 1,
+};
+// @ts-expect-error missing member of privateArgs argument
+void psmInstanceKit.adminFacet.restartContract(partial);
+
+// valid privateArgs now with 'marshaller'
+void psmInstanceKit.adminFacet.restartContract({
+  ...partial,
+  someString: 'str',
+});
+
+// @ts-expect-error missing member of privateArgs argument
+void psmInstanceKit.adminFacet.upgradeContract('whatever', partial);
+// valid privateArgs now with 'marshaller'
+void psmInstanceKit.adminFacet.upgradeContract('whatever', {
+  ...partial,
+  someString: 'str',
+});