fixup puppet

Agoric · Feb 10, 2023 · 1762a38 · 1762a38
1 parent 6aa0059
commit 1762a38
Show file tree

Hide file tree

Showing 5 changed files with 38 additions and 18 deletions.
diff --git a/packages/governance/src/contractGovernance/typedParamManager.js b/packages/governance/src/contractGovernance/typedParamManager.js
@@ -51,6 +51,10 @@ const isAsync = {
  * @typedef {[type: T, value: ParamValueForType<T>]} ST param spec tuple
  */
 
+/**
+ * @typedef {{ type: 'invitation', value: Amount<'set'> }} InvitationParam
+ */
+
 // XXX better to use the manifest constant ParamTypes
 // but importing that here turns this file into a module,
 // breaking the ambient typing

diff --git a/packages/governance/src/contractGovernor.js b/packages/governance/src/contractGovernor.js
@@ -121,7 +121,11 @@ const validateQuestionFromCounter = async (zoe, electorate, voteCounter) => {
  */
 
 /**
- * @template {() => {creatorFacet: GovernorFacet<any>, publicFacet: GovernedPublicFacetMethods} } SF Start function of governed contract
+ * @typedef {() => {creatorFacet: GovernorFacet<any>, publicFacet: GovernedPublicFacetMethods}} GovernableStartFn
+ */
+
+/**
+ * @template {GovernableStartFn} SF Start function of governed contract
  * @param {ZCF<{
  *   timer: import('@agoric/time/src/types').TimerService,
  *   governedContractInstallation: Installation<SF>,

diff --git a/packages/governance/test/unitTests/test-puppetContractGovernor.js b/packages/governance/test/unitTests/test-puppetContractGovernor.js
@@ -58,7 +58,7 @@ test('multiple params bad change', async t => {
   const timer = buildManualTimer(t.log);
   const { governorFacets } = await setUpGovernedContract(
     zoe,
-    governedBundleP,
+    E(zoe).install(governedBundleP),
     timer,
     governedTerms,
   );
@@ -85,7 +85,7 @@ test('change a param', async t => {
   const timer = buildManualTimer(t.log);
   const { governorFacets, getFakeInvitation } = await setUpGovernedContract(
     zoe,
-    governedBundleP,
+    E(zoe).install(governedBundleP),
     timer,
     governedTerms,
   );
@@ -142,7 +142,7 @@ test('set offer Filter directly', async t => {
   const timer = buildManualTimer(t.log);
   const { governorFacets } = await setUpGovernedContract(
     zoe,
-    governedBundleP,
+    E(zoe).install(governedBundleP),
     timer,
     governedTerms,
   );
@@ -159,13 +159,14 @@ test('call API directly', async t => {
   const timer = buildManualTimer(t.log);
   const { governorFacets } = await setUpGovernedContract(
     zoe,
-    governedBundleP,
+    E(zoe).install(governedBundleP),
     timer,
     governedTerms,
   );
 
   await E(governorFacets.creatorFacet).invokeAPI('governanceApi', []);
   t.deepEqual(
+    // @ts-expect-error FIXME type the puppet extensions
     await E(E(governorFacets.creatorFacet).getPublicFacet()).getApiCalled(),
     1,
   );

diff --git a/packages/governance/tools/puppetContractGovernor.js b/packages/governance/tools/puppetContractGovernor.js
@@ -12,13 +12,13 @@ import { CONTRACT_ELECTORATE } from '../src/contractGovernance/governParam.js';
 // It adds the ability for tests to update parameters directly.
 
 /**
- * @template {() => {creatorFacet: GovernorFacet<any>, publicFacet: unknown} } SF Start function of governed contract
+ * @template {import('../src/contractGovernor.js').GovernableStartFn} SF Start function of governed contract
  * @param {ZCF<{
  *   timer: import('@agoric/time/src/types').TimerService,
  *   governedContractInstallation: Installation<SF>,
  *   governed: {
  *     issuerKeywordRecord: IssuerKeywordRecord,
- *     terms: {governedParams: {[CONTRACT_ELECTORATE]: Amount<'set'>}},
+ *     terms: {governedParams: {[CONTRACT_ELECTORATE]: import('../src/contractGovernance/typedParamManager.js').InvitationParam }},
  *   }
  * }>} zcf
  * @param {{
@@ -94,6 +94,6 @@ export const start = async (zcf, privateArgs) => {
 };
 harden(start);
 /**
- * @template {() => {creatorFacet: GovernorFacet<any>, publicFacet: unknown} } SF Start function of governed contract
+ * @template {import('../src/contractGovernor.js').GovernableStartFn} SF Start function of governed contract
  * @typedef {Awaited<ReturnType<typeof start<SF>>>} PuppetContractGovernorKit<SF>
  */
diff --git a/packages/governance/tools/puppetGovernance.js b/packages/governance/tools/puppetGovernance.js
@@ -19,30 +19,39 @@ const autoRefundBundleP = makeBundle(
   '@agoric/zoe/src/contracts/automaticRefund.js',
 );
 
+/**  */
+
 /**
- *
+ * @template {import('../src/contractGovernor.js').GovernableStartFn} T governed contract startfn
  * @param {ERef<ZoeService>} zoe
- * @param {ERef<Installation>} governedBundleP
+ * @param {ERef<Installation<T>>} governedP
  * @param {import('@agoric/swingset-vat/src/vats/timer/vat-timer.js').TimerService} timer
  * @param {{ governedParams?: Record<string, unknown>, governedApis?: string[] }} governedTerms
+ * @param {{}} governedPrivateArgs
  */
 export const setUpGovernedContract = async (
   zoe,
-  governedBundleP,
+  governedP,
   timer,
   governedTerms = {},
+  governedPrivateArgs = {},
 ) => {
-  const [contractGovernorBundle, autoRefundBundle, governedBundle] =
-    await Promise.all([
-      contractGovernorBundleP,
-      autoRefundBundleP,
-      governedBundleP,
-    ]);
+  const [contractGovernorBundle, autoRefundBundle] = await Promise.all([
+    contractGovernorBundleP,
+    autoRefundBundleP,
+  ]);
 
+  /**
+   * @type {[
+   * Installation<import('./puppetContractGovernor').start>,
+   * Installation<any>,
+   * Installation<T>,
+   * ]}
+   */
   const [governor, autoRefund, governed] = await Promise.all([
     E(zoe).install(contractGovernorBundle),
     E(zoe).install(autoRefundBundle),
-    E(zoe).install(governedBundle),
+    governedP,
   ]);
   const installs = { governor, autoRefund, governed };
 
@@ -63,6 +72,7 @@ export const setUpGovernedContract = async (
     await getFakeInvitation();
 
   const governedTermsWithElectorate = {
+    ...governedTerms,
     governedParams: {
       ...governedTerms.governedParams,
       [CONTRACT_ELECTORATE]: {
@@ -87,6 +97,7 @@ export const setUpGovernedContract = async (
     governorTerms,
     {
       governed: {
+        ...governedPrivateArgs,
         initialPoserInvitation: fakeInvitationPayment,
       },
     },