chore: minor cleanups in governParam: types, comments, harden

Agoric · Aug 26, 2021 · 6b006d4 · 6b006d4
1 parent 342de7c
commit 6b006d4
Show file tree

Hide file tree

Showing 3 changed files with 19 additions and 10 deletions.
diff --git a/packages/governance/src/contractGovernor.js b/packages/governance/src/contractGovernor.js
@@ -48,18 +48,18 @@ const validateBallotFromCounter = async (zoe, registrar, ballotCounter) => {
  *
  * The governedContract is responsible for supplying getParamMgrAccessor() in
  * its creatorFacet. getParamMgrAccessor() takes a ParamSpecification, which
- *  identifies the parameter to be voted on. A minimal ParamSpecification
- *  specifies the key which identifies a particular paramManager (even if
- *  there's only one) and the parameterName. The interpretation of
- *  ParamSpecification is up to the contract.
+ * identifies the parameter to be voted on. A minimal ParamSpecification
+ * specifies the key which identifies a particular paramManager (even if there's
+ * only one) and the parameterName. The interpretation of ParamSpecification is
+ * up to the contract.
  *
  * The call to startGovernedInstance() returns a facet with voteOnParamChange(),
  * which is used to create ballot questions that will automatically update
  * contract parameters if passed. This facet will usually be closely held.
  *
- * The govened contract's terms include the instance of this (governing)
- *  contract (as electionManager) so clients will be able to look up the state
- *  of the governed parameters.
+ * The governed contract's terms include the instance of this (governing)
+ * contract (as electionManager) so clients will be able to look up the state
+ * of the governed parameters.
  *
  * @type {ContractStartFn}
  */
@@ -74,7 +74,7 @@ const start = async zcf => {
   /** @type {PromiseRecord<Instance>} */
   const governedInstancePK = makePromiseKit();
 
-  // a predicate that identifies ballots created by this governor
+  // Promise for a predicate that identifies ballots created by this governor
   /** @type {PromiseRecord<CreatedBallot>} */
   const createdBallotPK = makePromiseKit();
 
@@ -92,10 +92,10 @@ const start = async zcf => {
       E.get(E(zoe).getInvitationDetails(poserInvitation)).instance,
     );
 
-    const augmentedTerms = {
+    const augmentedTerms = harden({
       ...customTerms,
       electionManager: zcf.getInstance(),
-    };
+    });
 
     const { creatorFacet, instance, publicFacet } = await E(zoe).startInstance(
       governedContractInstallation,

diff --git a/packages/governance/src/governParam.js b/packages/governance/src/governParam.js
@@ -45,8 +45,11 @@ const validateParamChangeBallot = details => {
   );
 };
 
+/** @type {AssertBallotConcernsQuestion} */
 const assertBallotConcernsQuestion = (paramName, ballotDetails) => {
   assert(
+    // @ts-ignore typescript isn't sure the question is a paramChangeQuestion
+    // if it isn't, the assertion will fail.
     ballotDetails.question.paramSpec.parameterName === paramName,
     X`expected ${paramName} to be included`,
   );

diff --git a/packages/governance/src/types.js b/packages/governance/src/types.js
@@ -431,6 +431,12 @@
  *   contract
  */
 
+/**
+ * @callback AssertBallotConcernsQuestion
+ * @param {string} paramName
+ * @param {BallotDetails} ballotDetails
+ */
+
 /**
  * @callback StartGovernedContract
  * @param {RegistrarCreator} registrarCreatorFacet