chore: address some linting errors revealed in merge.

Agoric · Dec 14, 2023 · 62428ac · 62428ac
1 parent 918c73b
commit 62428ac
Show file tree

Hide file tree

Showing 9 changed files with 20 additions and 16 deletions.
diff --git a/packages/governance/src/contractHelper.js b/packages/governance/src/contractHelper.js
@@ -31,8 +31,8 @@ const publicMixinAPI = harden({
 });
 
 /**
- * @param {ZCF<GovernanceTerms<{}> & {}>} zcf
- * @param {import('./contractGovernance/typedParamManager').TypedParamManager<unknown>} paramManager
+ @template {import('./contractGovernance/typedParamManager.js').ParamTypesMap} T Governed parameters of contract * @param {ZCF<GovernanceTerms<{}> & {}>} zcf
+ * @param {import('./contractGovernance/typedParamManager').TypedParamManager<T>} paramManager
  */
 export const validateElectorate = (zcf, paramManager) => {
   const { governedParams } = zcf.getTerms();
@@ -53,8 +53,7 @@ harden(validateElectorate);
 /**
  * Utility function for `makeParamGovernance`.
  *
- * @template T
- * @param {ZCF<GovernanceTerms<{}> & {}>} zcf
+ * @template {import('./contractGovernance/typedParamManager.js').ParamTypesMap} T Governed parameters of contract * @param {ZCF<GovernanceTerms<{}> & {}>} zcf
  * @param {import('./contractGovernance/typedParamManager').TypedParamManager<T>} paramManager
  */
 const facetHelpers = (zcf, paramManager) => {

diff --git a/packages/governance/src/electorateTools.js b/packages/governance/src/electorateTools.js
@@ -17,7 +17,7 @@ import { deeplyFulfilled, Far } from '@endo/marshal';
  * @param {MapStore<Handle<'Question'>, QuestionRecord>} questionStore
  * @param {Publisher<unknown>} questionPublisher
  * @param {Publisher<OutcomeRecord>} outcomePublisher
- * @returns {AddQuestionReturn}
+ * @returns {Promise<AddQuestionReturn>}
  */
 
 /**

diff --git a/packages/governance/src/types-ambient.js b/packages/governance/src/types-ambient.js
@@ -615,7 +615,7 @@
  * @param {Installation} voteCounterInstallation
  * @param {import('@agoric/time/src/types').Timestamp} deadline
  * @param {ParamChangesSpec<P>} paramSpec
- * @returns {ContractGovernanceVoteResult}
+ * @returns {Promise<ContractGovernanceVoteResult>}
  */
 
 /**
@@ -632,7 +632,7 @@
  * @param {Installation} voteCounterInstallation
  * @param {import('@agoric/time/src/types').Timestamp} deadline
  * @param {string[]} strings
- * @returns {ContractGovernanceVoteResult}
+ * @returns {Promise<ContractGovernanceVoteResult>}
  */
 
 /**

diff --git a/packages/smart-wallet/src/offerWatcher.js b/packages/smart-wallet/src/offerWatcher.js
@@ -21,9 +21,15 @@ import { UNPUBLISHED_RESULT } from './offers.js';
  * }} OfferStatus
  */
 
+/**
+ * @template V fulfilled value
+ * @template {any[]} [A=unknown[]] arguments
+ * @typedef { {onFulfilled?: (value: V, ...args: A) => void, onRejected?: (reason: unknown, ...args: A) => void} } PromiseWatcher
+ */
+
 /**
  * @template {any} T
- * @typedef {import('@agoric/swingset-liveslots').PromiseWatcher<T, [UserSeat]>} OfferPromiseWatcher<T, [UserSeat]
+ * @typedef {PromiseWatcher<T, [UserSeat]>} OfferPromiseWatcher<T, [UserSeat]
  */
 
 /**

diff --git a/packages/smart-wallet/src/smartWallet.js b/packages/smart-wallet/src/smartWallet.js
@@ -598,6 +598,7 @@ export const prepareSmartWallet = (baggage, shared) => {
 
             const invitation = invitationFromSpec(offerSpec.invitationSpec);
             const invitationAmount =
+              // eslint-disable-next-line no-await-in-loop, @jessie.js/no-nested-await
               await E(invitationIssuer).getAmountOf(invitation);
             const watcher = makeOfferWatcher(
               facets.helper,

diff --git a/...wallet/test/swingsetTests/upgradeWalletFactory/bootstrap-walletFactory-service-upgrade.js b/...wallet/test/swingsetTests/upgradeWalletFactory/bootstrap-walletFactory-service-upgrade.js
@@ -67,12 +67,10 @@ export const buildRootObject = async () => {
       v1BundleId || Fail`bundleId must not be empty`;
       installation = await E(zoe).installBundleID(v1BundleId);
 
-      const autoRefundBundleId = await E(vatAdmin).getBundleIDByName(
-        'automaticRefund',
-      );
-      const autoRefundInstallation = await E(zoe).installBundleID(
-        autoRefundBundleId,
-      );
+      const autoRefundBundleId =
+        await E(vatAdmin).getBundleIDByName('automaticRefund');
+      const autoRefundInstallation =
+        await E(zoe).installBundleID(autoRefundBundleId);
       const { instance } = await E(zoe).startInstance(autoRefundInstallation, {
         Moola: moolaKit.issuer,
       });

diff --git a/packages/smart-wallet/test/test-addAsset.js b/packages/smart-wallet/test/test-addAsset.js
@@ -391,6 +391,7 @@ test.serial('trading in non-vbank asset: game real-estate NFTs', async t => {
   await finishBootstrap(somePowers, bundles);
   t.log(
     'install game contract bundle with hash:',
+    // @ts-expect-error It's present on a subset of the types of bundles.game
     bundles.game.endoZipBase64Sha512.slice(0, 24),
     '...',
   );

diff --git a/packages/vats/src/core/basic-behaviors.js b/packages/vats/src/core/basic-behaviors.js
@@ -485,7 +485,6 @@ export const makeAddressNameHubs = async ({
   const { nameHub: namesByAddress, nameAdmin: namesByAddressAdmin } =
     makeNameHubKit();
   produce.namesByAddress.resolve(namesByAddress);
-  // @ts-expect-error deprecated type structure
   produce.namesByAddressAdmin.resolve(namesByAddressAdmin);
 
   const perAddress = address => {

diff --git a/packages/vats/src/core/types.js b/packages/vats/src/core/types.js
@@ -76,11 +76,11 @@
  */
 
 /**
+ * @template T
  * @typedef {object} Producer<T>
  * @property {(v: ERef<T>) => void} resolve
  * @property {(r: unknown) => void} reject
  * @property {(reason?: unknown) => void} reset
- * @template T
  */
 /**
  * @typedef {{ bundleName?: string, bundleID?: string }} VatSourceRef