feat: save PSM adminFacet in bootstrap (#6101)

* feat: save PSM adminFacet in bootstrap Additionally, the contractGovernor will now make the adminFacet available. * chore: export AdminFacet type from Zoe * chore: correct permissions in startPSM.js Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
Agoric · Sep 1, 2022 · 14b20e6 · 14b20e6
1 parent 64241cd
commit 14b20e6
Show file tree

Hide file tree

Showing 5 changed files with 21 additions and 10 deletions.
diff --git a/packages/governance/src/contractGovernor.js b/packages/governance/src/contractGovernor.js
@@ -163,6 +163,7 @@ const start = async (zcf, privateArgs) => {
     creatorFacet: governedCF,
     instance: governedInstance,
     publicFacet: governedPF,
+    adminFacet,
   } = await E(zoe).startInstance(
     governedContractInstallation,
     governedIssuerKeywordRecord,
@@ -281,6 +282,7 @@ const start = async (zcf, privateArgs) => {
     voteOnApiInvocation,
     voteOnOfferFilter: voteOnFilter,
     getCreatorFacet: () => limitedCreatorFacet,
+    getAdminFacet: () => adminFacet,
     getInstance: () => governedInstance,
     getPublicFacet: () => governedPF,
   });

diff --git a/packages/inter-protocol/src/proposals/econ-behaviors.js b/packages/inter-protocol/src/proposals/econ-behaviors.js
@@ -60,6 +60,7 @@ const sanitizePathSegment = name => {
  *   bankMints: Mint[],
  *   psmCreatorFacet: unknown,
  *   psmGovernorCreatorFacet: GovernedContractFacetAccess<{},{}>,
+ *   psmAdminFacet: AdminFacet,
  *   reservePublicFacet: import('../reserve/assetReserve.js').AssetReservePublicFacet,
  *   reserveCreatorFacet: import('../reserve/assetReserve.js').AssetReserveLimitedCreatorFacet,
  *   reserveGovernorCreatorFacet: GovernedAssetReserveFacetAccess,

diff --git a/packages/inter-protocol/src/proposals/startPSM.js b/packages/inter-protocol/src/proposals/startPSM.js
@@ -34,7 +34,7 @@ export const startPSM = async (
       chainStorage,
       chainTimerService,
     },
-    produce: { psmCreatorFacet, psmGovernorCreatorFacet },
+    produce: { psmCreatorFacet, psmGovernorCreatorFacet, psmAdminFacet },
     installation: {
       consume: { contractGovernor, psm: psmInstall },
     },
@@ -138,14 +138,11 @@ export const startPSM = async (
     }),
   );
 
-  const governedInstance = await E(governorFacets.creatorFacet).getInstance();
-  const creatorFacet = E(governorFacets.creatorFacet).getCreatorFacet();
-
-  psmInstanceR.resolve(governedInstance);
+  psmInstanceR.resolve(await E(governorFacets.creatorFacet).getInstance());
   psmGovernorR.resolve(governorFacets.instance);
-  psmCreatorFacet.resolve(creatorFacet);
+  psmCreatorFacet.resolve(E(governorFacets.creatorFacet).getCreatorFacet());
+  psmAdminFacet.resolve(E(governorFacets.creatorFacet).getAdminFacet());
   psmGovernorCreatorFacet.resolve(governorFacets.creatorFacet);
-  psmInstanceR.resolve(governedInstance);
 };
 harden(startPSM);
 
@@ -262,7 +259,11 @@ export const PSM_MANIFEST = harden({
       economicCommitteeCreatorFacet: 'economicCommittee',
       chainTimerService: 'timer',
     },
-    produce: { psmCreatorFacet: 'psm', psmGovernorCreatorFacet: 'psmGovernor' },
+    produce: {
+      psmCreatorFacet: 'psm',
+      psmAdminFacet: 'psm',
+      psmGovernorCreatorFacet: 'psmGovernor',
+    },
     installation: {
       consume: { contractGovernor: 'zoe', psm: 'zoe' },
     },

diff --git a/packages/zoe/src/contractFacet/types.js b/packages/zoe/src/contractFacet/types.js
@@ -243,3 +243,7 @@
  * @template S
  * @typedef {import('../zoeService/utils').ContractOf<S>} ContractOf
  */
+
+/**
+ * @typedef {import('../zoeService/utils').AdminFacet} AdminFacet
+ */
diff --git a/packages/zoe/src/zoeService/utils.d.ts b/packages/zoe/src/zoeService/utils.d.ts
@@ -13,8 +13,11 @@ type ContractFacet<T extends {} = {}> = {
   readonly [P in keyof T]: T[P] extends Callable ? T[P] : never;
 };
 
-type AdminFacet = {
-  getVatShutdownPromise: () => Promise<any>; // Completion, which is currently any
+export type AdminFacet = {
+  // Completion, which is currently any
+  getVatShutdownPromise: () => Promise<any>;
+  upgradeContract: (contractBundleId: string, newPrivateArgs: any) => void;
+  restartContract: (newPrivateArgs: any) => void;
 };
 
 /**