@agoric/zoe 0.26.3-dev-0001c49.0 → 0.26.3-dev-a0953fe.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@agoric/zoe",
-  "version": "0.26.3-dev-0001c49.0+0001c49",
+  "version": "0.26.3-dev-a0953fe.0+a0953fe",
   "description": "Zoe: the Smart Contract Framework for Offer Enforcement",
   "type": "module",
   "main": "./src/zoeService/zoe.js",
@@ -43,15 +43,15 @@
   },
   "homepage": "https://github.com/Agoric/agoric-sdk#readme",
   "dependencies": {
-    "@agoric/assert": "0.6.1-dev-0001c49.0+0001c49",
-    "@agoric/ertp": "0.16.3-dev-0001c49.0+0001c49",
-    "@agoric/internal": "0.3.3-dev-0001c49.0+0001c49",
-    "@agoric/notifier": "0.6.3-dev-0001c49.0+0001c49",
-    "@agoric/store": "0.9.3-dev-0001c49.0+0001c49",
-    "@agoric/swingset-liveslots": "0.10.3-dev-0001c49.0+0001c49",
-    "@agoric/swingset-vat": "0.32.3-dev-0001c49.0+0001c49",
-    "@agoric/time": "0.3.3-dev-0001c49.0+0001c49",
-    "@agoric/vat-data": "0.5.3-dev-0001c49.0+0001c49",
+    "@agoric/assert": "0.6.1-dev-a0953fe.0+a0953fe",
+    "@agoric/ertp": "0.16.3-dev-a0953fe.0+a0953fe",
+    "@agoric/internal": "0.3.3-dev-a0953fe.0+a0953fe",
+    "@agoric/notifier": "0.6.3-dev-a0953fe.0+a0953fe",
+    "@agoric/store": "0.9.3-dev-a0953fe.0+a0953fe",
+    "@agoric/swingset-liveslots": "0.10.3-dev-a0953fe.0+a0953fe",
+    "@agoric/swingset-vat": "0.32.3-dev-a0953fe.0+a0953fe",
+    "@agoric/time": "0.3.3-dev-a0953fe.0+a0953fe",
+    "@agoric/vat-data": "0.5.3-dev-a0953fe.0+a0953fe",
     "@endo/bundle-source": "^2.7.0",
     "@endo/captp": "^3.1.4",
     "@endo/eventual-send": "^0.17.5",
@@ -64,7 +64,7 @@
     "yargs-parser": "^21.1.1"
   },
   "devDependencies": {
-    "@agoric/kmarshal": "0.1.1-dev-0001c49.0+0001c49",
+    "@agoric/kmarshal": "0.1.1-dev-a0953fe.0+a0953fe",
     "@endo/init": "^0.5.59",
     "ava": "^5.3.0",
     "c8": "^7.13.0",
@@ -137,5 +137,5 @@
   "typeCoverage": {
     "atLeast": 81.5
   },
-  "gitHead": "0001c4901ee1e256c46e7c1647a674330f63dc0c"
+  "gitHead": "a0953fe7d6d64fb37d426f69c087aa2d0a7ca4fe"
 }

package/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>;

package/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: {};

package/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',
+});