@agoric/inter-protocol 0.16.2-dev-eb7e9eb.0 → 0.16.2-u11.0

package/src/clientSupport.js

@@ -15,31 +15,23 @@ const scaleDecimals = num => BigInt(num * Number(COSMOS_UNIT));
 /**
  * Give/want
  *
- * @param {Pick<
- *   import('@agoric/vats/tools/board-utils.js').AgoricNamesRemotes,
- *   'brand'
- * >} agoricNames
- * @param {| { giveMinted?: number; wantMinted?: number }
- *   | {
- *       collateralBrandKey: string;
- *       giveCollateral?: number;
- *       wantCollateral?: number;
- *     }} opts
+ * @param {Record<string, Brand>} brands
+ * @param {{ giveMinted?: number, wantMinted?: number } | { collateralBrandKey: string, giveCollateral?: number, wantCollateral?: number }} opts
  * @returns {Proposal}
  */
-const makeVaultProposal = ({ brand }, opts) => {
+const makeVaultProposal = (brands, opts) => {
   const proposal = { give: {}, want: {} };
 
   if ('giveCollateral' in opts && opts.giveCollateral) {
     const { collateralBrandKey } = opts;
     proposal.give.Collateral = {
-      brand: brand[collateralBrandKey],
+      brand: brands[collateralBrandKey],
       value: scaleDecimals(opts.giveCollateral),
     };
   }
   if ('giveMinted' in opts && opts.giveMinted) {
     proposal.give.Minted = {
-      brand: brand.IST,
+      brand: brands.IST,
       value: scaleDecimals(opts.giveMinted),
     };
   }
@@ -47,13 +39,13 @@ const makeVaultProposal = ({ brand }, opts) => {
   if ('wantCollateral' in opts && opts.wantCollateral) {
     const { collateralBrandKey } = opts;
     proposal.want.Collateral = {
-      brand: brand[collateralBrandKey],
+      brand: brands[collateralBrandKey],
       value: scaleDecimals(opts.wantCollateral),
     };
   }
   if ('wantMinted' in opts && opts.wantMinted) {
     proposal.want.Minted = {
-      brand: brand.IST,
+      brand: brands.IST,
       value: scaleDecimals(opts.wantMinted),
     };
   }
@@ -62,26 +54,18 @@ const makeVaultProposal = ({ brand }, opts) => {
 };
 
 /**
- * @param {Pick<
- *   import('@agoric/vats/tools/board-utils.js').AgoricNamesRemotes,
- *   'brand'
- * >} agoricNames
- * @param {{
- *   offerId: string;
- *   wantMinted: number;
- *   giveCollateral: number;
- *   collateralBrandKey: string;
- * }} opts
+ * @param {Record<string, Brand>} brands
+ * @param {{ offerId: string, wantMinted: number, giveCollateral: number, collateralBrandKey: string }} opts
  * @returns {import('@agoric/smart-wallet/src/offers.js').OfferSpec}
  */
-const makeOpenOffer = ({ brand }, opts) => {
-  const proposal = makeVaultProposal({ brand }, opts);
+const makeOpenOffer = (brands, opts) => {
+  const proposal = makeVaultProposal(brands, opts);
 
   // NB: not really a Proposal because the brands are not remotes
   // Instead they're copyRecord like  "{"boardId":"board0257","iface":"Alleged: IST brand"}" to pass through the boardId
   // mustMatch(harden(proposal), ProposalShape);
 
-  const collateralBrand = brand[opts.collateralBrandKey];
+  const collateralBrand = brands[opts.collateralBrandKey];
 
   return {
     id: opts.offerId,
@@ -98,26 +82,16 @@ const makeOpenOffer = ({ brand }, opts) => {
 };
 
 /**
- * @param {Pick<
- *   import('@agoric/vats/tools/board-utils.js').AgoricNamesRemotes,
- *   'brand'
- * >} agoricNames
- * @param {{
- *   offerId: string;
- *   collateralBrandKey?: string;
- *   giveCollateral?: number;
- *   wantCollateral?: number;
- *   giveMinted?: number;
- *   wantMinted?: number;
- * }} opts
+ * @param {Record<string, Brand>} brands
+ * @param {{ offerId: string, collateralBrandKey?: string, giveCollateral?: number, wantCollateral?: number, giveMinted?: number, wantMinted?: number }} opts
  * @param {string} previousOffer
  * @returns {import('@agoric/smart-wallet/src/offers.js').OfferSpec}
  */
-const makeAdjustOffer = ({ brand }, opts, previousOffer) => {
+const makeAdjustOffer = (brands, opts, previousOffer) => {
   // NB: not really a Proposal because the brands are not remotes
   // Instead they're copyRecord like  "{"boardId":"board0257","iface":"Alleged: IST brand"}" to pass through the boardId
   // mustMatch(harden(proposal), ProposalShape);
-  const proposal = makeVaultProposal({ brand }, opts);
+  const proposal = makeVaultProposal(brands, opts);
 
   return {
     id: opts.offerId,
@@ -131,20 +105,13 @@ const makeAdjustOffer = ({ brand }, opts, previousOffer) => {
 };
 
 /**
- * @param {Pick<
- *   import('@agoric/vats/tools/board-utils.js').AgoricNamesRemotes,
- *   'brand'
- * >} agoricNames
- * @param {{
- *   offerId: string;
- *   collateralBrandKey?: string;
- *   giveMinted: number;
- * }} opts
+ * @param {Record<string, Brand>} brands
+ * @param {{ offerId: string, collateralBrandKey?: string, giveMinted: number }} opts
  * @param {string} previousOffer
  * @returns {import('@agoric/smart-wallet/src/offers.js').OfferSpec}
  */
-const makeCloseOffer = ({ brand }, opts, previousOffer) => {
-  const proposal = makeVaultProposal({ brand }, opts);
+const makeCloseOffer = (brands, opts, previousOffer) => {
+  const proposal = makeVaultProposal(brands, opts);
 
   return {
     id: opts.offerId,
@@ -159,9 +126,7 @@ const makeCloseOffer = ({ brand }, opts, previousOffer) => {
 
 /**
  * @param {string} vaultId
- * @param {Promise<
- *   import('@agoric/smart-wallet/src/smartWallet').CurrentWalletRecord
- * >} currentP
+ * @param {Promise<import('@agoric/smart-wallet/src/smartWallet').CurrentWalletRecord>} currentP
  * @returns {Promise<string>} offer id in which the vault was made
  */
 export const lookupOfferIdForVault = async (vaultId, currentP) => {
@@ -176,14 +141,11 @@ export const lookupOfferIdForVault = async (vaultId, currentP) => {
 };
 
 /**
- * @param {Record<
- *   string,
- *   import('@agoric/internal/src/marshal.js').BoardRemote
- * >} brands
- * @param {| { wantMinted: number; giveMinted?: undefined }
- *   | { giveMinted: number; wantMinted?: undefined }} opts
- * @param {number} [fee]
+ * @param {Record<string, Brand>} brands
+ * @param {({ wantMinted: number, giveMinted?: undefined } | { giveMinted: number, wantMinted?: undefined })} opts
+ * @param {number} [fee=0]
  * @param {string} [anchor]
+ * @returns {Proposal} XXX not a real proposal, uses BoardRemote
  */
 const makePsmProposal = (brands, opts, fee = 0, anchor = 'AUSD') => {
   const giving = 'giveMinted' in opts ? 'minted' : 'anchor';
@@ -209,24 +171,19 @@ const makePsmProposal = (brands, opts, fee = 0, anchor = 'AUSD') => {
 };
 
 /**
- * @param {Pick<
- *   import('@agoric/vats/tools/board-utils.js').AgoricNamesRemotes,
- *   'brand'
- * >} agoricNames
  * @param {Instance} instance
- * @param {{ offerId: string; feePct?: number; pair: [string, string] } & (
- *   | { wantMinted: number }
- *   | { giveMinted: number }
- * )} opts
+ * @param {Record<string, Brand>} brands
+ * @param {{ offerId: string, feePct?: number, pair: [string, string] } &
+ *         ({ wantMinted: number } | { giveMinted: number })} opts
  * @returns {import('@agoric/smart-wallet/src/offers.js').OfferSpec}
  */
-const makePsmSwapOffer = ({ brand }, instance, opts) => {
+const makePsmSwapOffer = (instance, brands, opts) => {
   const method =
     'wantMinted' in opts
       ? 'makeWantMintedInvitation'
       : 'makeGiveMintedInvitation'; // ref psm.js
   const proposal = makePsmProposal(
-    brand,
+    brands,
     opts,
     opts.feePct ? opts.feePct / 100 : undefined,
     opts.pair[1],
@@ -243,79 +200,33 @@ const makePsmSwapOffer = ({ brand }, instance, opts) => {
       instance,
       publicInvitationMaker: method,
     },
-    // @ts-expect-error BoardRemote not a Brand object
     proposal,
   };
 };
 
 /**
- * @param {Pick<
- *   import('@agoric/vats/tools/board-utils.js').AgoricNamesRemotes,
- *   'brand' | 'vbankAsset'
- * >} agoricNames
- * @param {(msg: string) => Error} makeError error constructor
- * @returns {(a: string) => Amount<'nat'>}
- */
-export const makeParseAmount =
-  (agoricNames, makeError = msg => RangeError(msg)) =>
-  opt => {
-    assert.typeof(opt, 'string', 'parseAmount expected string');
-    const m = opt.match(/^(?<value>[\d_]+(\.[\d_]+)?)(?<brand>[A-Z]\w*?)$/);
-    if (!m || !m.groups) {
-      throw makeError(`invalid amount: ${opt}`);
-    }
-    const anyBrand = agoricNames.brand[m.groups.brand];
-    if (!anyBrand) {
-      throw makeError(`unknown brand: ${m.groups.brand}`);
-    }
-    const assetDesc = Object.values(agoricNames.vbankAsset).find(
-      d => d.brand === anyBrand,
-    );
-    if (!assetDesc) {
-      throw makeError(`unknown brand: ${m.groups.brand}`);
-    }
-    const { displayInfo } = assetDesc;
-    if (!displayInfo.decimalPlaces || displayInfo.assetKind !== 'nat') {
-      throw makeError(`bad brand: ${displayInfo}`);
-    }
-    const value = BigInt(
-      Number(m.groups.value.replace(/_/g, '')) *
-        10 ** displayInfo.decimalPlaces,
-    );
-    /** @type {Brand<'nat'>} */
-    // @ts-expect-error dynamic cast
-    const natBrand = anyBrand;
-    const amt = { value, brand: natBrand };
-    return amt;
-  };
-
-/**
- * @param {Pick<
- *   import('@agoric/vats/tools/board-utils.js').AgoricNamesRemotes,
- *   'brand' | 'vbankAsset'
- * >} agoricNames
+ * @param {Record<string, Brand>} _brands
  * @param {{
- *   offerId: string;
- *   give: string;
- *   maxBuy: string;
- *   wantMinimum?: string;
- * } & (
- *   | {
- *       price: number;
- *     }
- *   | {
- *       discount: number; // -1 to 1. e.g. 0.10 for 10% discount, -0.05 for 5% markup
- *     }
- * )} opts
+ *   offerId: string,
+ *   give: string,
+ *   maxBuy: string,
+ *   wantMinimum?: string,
+ *   parseAmount: (x: string) => Amount<'nat'>,
+ * } & ({
+ *   price: number,
+ * } | {
+ *   discount: number,  // -1 to 1. e.g. 0.10 for 10% discount, -0.05 for 5% markup
+ * })} opts
  * @returns {import('@agoric/smart-wallet/src/offers.js').OfferSpec}
  */
-const makeBidOffer = (agoricNames, opts) => {
+const makeBidOffer = (_brands, opts) => {
+  assert.typeof(opts.parseAmount, 'function');
   assertAllDefined({
     offerId: opts.offerId,
     give: opts.give,
     maxBuy: opts.maxBuy,
   });
-  const parseAmount = makeParseAmount(agoricNames);
+  const { parseAmount } = opts;
   const proposal = {
     give: { Bid: parseAmount(opts.give) },
     ...(opts.wantMinimum
@@ -365,23 +276,19 @@ const makeBidOffer = (agoricNames, opts) => {
 };
 
 /**
- * @param {Pick<
- *   import('@agoric/vats/tools/board-utils.js').AgoricNamesRemotes,
- *   'brand'
- * >} agoricNames
+ * @param {Record<string, Brand>} brands
  * @param {{
- *   offerId: string;
- *   give: number;
- *   collateralBrandKey: string;
+ *   offerId: string,
+ *   give: number,
+ *   collateralBrandKey: string,
  * }} opts
  * @returns {import('@agoric/smart-wallet/src/offers.js').OfferSpec}
  */
-const makeAddCollateralOffer = ({ brand }, opts) => {
+const makeAddCollateralOffer = (brands, opts) => {
   /** @type {AmountKeywordRecord} */
   const give = {
     Collateral: AmountMath.make(
-      // @ts-expect-error BoardRemote not a Brand object
-      brand[opts.collateralBrandKey],
+      brands[opts.collateralBrandKey],
       scaleDecimals(opts.give),
     ),
   };
@@ -400,16 +307,17 @@ const makeAddCollateralOffer = ({ brand }, opts) => {
 };
 
 /**
- * @param {unknown} _agoricNames
+ *
+ * @param {Record<string, Brand>} _brands
  * @param {{
- *   offerId: string;
- *   roundId?: bigint;
- *   unitPrice: bigint;
+ *   offerId: string,
+ *   roundId?: bigint,
+ *   unitPrice: bigint,
  * }} opts
  * @param {string} previousOffer
  * @returns {import('@agoric/smart-wallet/src/offers.js').OfferSpec}
  */
-const makePushPriceOffer = (_agoricNames, opts, previousOffer) => {
+const makePushPriceOffer = (_brands, opts, previousOffer) => {
   return {
     id: opts.offerId,
     invitationSpec: {
@@ -424,12 +332,48 @@ const makePushPriceOffer = (_agoricNames, opts, previousOffer) => {
   };
 };
 
+// TODO DRY with CLI wallet.js
 /**
- * @satisfies {Record<
- *   string,
- *   Record<string, import('@agoric/smart-wallet/src/types.js').OfferMaker>
- * >}
+ * @param {{
+ *   brand: Record<string, Brand>,
+ *   vbankAsset: Record<string, { brand: Brand, displayInfo: DisplayInfo }>,
+ * }} agoricNames
+ * @param {(msg: string) => Error} makeError error constructor
+ * @returns {(a: string) => Amount<'nat'>}
  */
+export const makeParseAmount =
+  (agoricNames, makeError = msg => RangeError(msg)) =>
+  opt => {
+    assert.typeof(opt, 'string', 'parseAmount expected string');
+    const m = opt.match(/^(?<value>[\d_]+(\.[\d_]+)?)(?<brand>[A-Z]\w*?)$/);
+    if (!m || !m.groups) {
+      throw makeError(`invalid amount: ${opt}`);
+    }
+    const anyBrand = agoricNames.brand[m.groups.brand];
+    if (!anyBrand) {
+      throw makeError(`unknown brand: ${m.groups.brand}`);
+    }
+    const assetDesc = Object.values(agoricNames.vbankAsset).find(
+      d => d.brand === anyBrand,
+    );
+    if (!assetDesc) {
+      throw makeError(`unknown brand: ${m.groups.brand}`);
+    }
+    const { displayInfo } = assetDesc;
+    if (!displayInfo.decimalPlaces || displayInfo.assetKind !== 'nat') {
+      throw makeError(`bad brand: ${displayInfo}`);
+    }
+    const value = BigInt(
+      Number(m.groups.value.replace(/_/g, '')) *
+        10 ** displayInfo.decimalPlaces,
+    );
+    /** @type {Brand<'nat'>} */
+    // @ts-expect-error dynamic cast
+    const natBrand = anyBrand;
+    const amt = { value, brand: natBrand };
+    return amt;
+  };
+
 export const Offers = {
   auction: {
     Bid: makeBidOffer,

package/src/contractSupport.js

@@ -13,11 +13,11 @@ export const ratioPattern = harden({
 });
 
 /**
- * Apply a delta to the `base` Amount, where the delta is represented as an
- * amount to gain and an amount to lose. Typically one of those will be empty
- * because gain/loss comes from the give/want for a specific asset on a
- * proposal. We use two Amounts because an Amount cannot represent a negative
- * number (so we use a "loss" that will be subtracted).
+ * Apply a delta to the `base` Amount, where the delta is represented as
+ * an amount to gain and an amount to lose. Typically one of those will
+ * be empty because gain/loss comes from the give/want for a specific asset
+ * on a proposal. We use two Amounts because an Amount cannot represent
+ * a negative number (so we use a "loss" that will be subtracted).
  *
  * @template {AssetKind} K
  * @param {Amount<K>} base

package/src/econCommitteeCharter.js

@@ -13,10 +13,12 @@ import {
 import { E } from '@endo/far';
 
 /**
- * @file This contract makes it possible for those who govern contracts to call
- *   for votes on changes. A more complete implementation would validate
- *   parameters, constrain deadlines and possibly split the ability to call for
- *   votes into separate capabilities for finer grain encapsulation.
+ * @file
+ *
+ * This contract makes it possible for those who govern contracts to call for
+ * votes on changes. A more complete implementation would validate parameters,
+ * constrain deadlines and possibly split the ability to call for votes into
+ * separate capabilities for finer grain encapsulation.
  */
 
 export const INVITATION_MAKERS_DESC = 'charter member invitation';
@@ -26,7 +28,7 @@ export const INVITATION_MAKERS_DESC = 'charter member invitation';
  * @property {bigint} deadline
  * @property {Instance} instance
  * @property {Record<string, unknown>} params
- * @property {{ paramPath: { key: string } }} [path]
+ * @property {{paramPath: { key: string }}} [path]
  */
 const ParamChangesOfferArgsShape = M.splitRecord(
   {
@@ -39,21 +41,19 @@ const ParamChangesOfferArgsShape = M.splitRecord(
   },
 );
 
-/** @type {ContractMeta} */
-export const meta = {
-  customTermsShape: {
-    binaryVoteCounterInstallation: InstallationShape,
-  },
-  upgradability: 'canUpgrade',
-};
-harden(meta);
+/**
+ * A pattern for Zoe to check custom terms before `start()`ing the contract.
+ */
+export const customTermsShape = harden({
+  binaryVoteCounterInstallation: InstallationShape,
+});
 
 /**
- * @param {ZCF<{ binaryVoteCounterInstallation: Installation }>} zcf
+ * @param {ZCF<{binaryVoteCounterInstallation: Installation}>} zcf
  * @param {undefined} privateArgs
  * @param {import('@agoric/vat-data').Baggage} baggage
  */
-export const start = async (zcf, privateArgs, baggage) => {
+export const prepare = async (zcf, privateArgs, baggage) => {
   const { binaryVoteCounterInstallation: counter } = zcf.getTerms();
   /** @type {MapStore<Instance, GovernorCreatorFacet<any>>} */
   const instanceToGovernor = provideDurableMapStore(
@@ -184,4 +184,3 @@ export const start = async (zcf, privateArgs, baggage) => {
 
   return harden({ creatorFacet });
 };
-harden(start);

package/src/feeDistributor.js

@@ -9,24 +9,23 @@ import { KeywordShape } from '@agoric/zoe/src/typeGuards.js';
 
 const KeywordSharesShape = M.recordOf(KeywordShape, M.nat());
 
-/** @type {ContractMeta} */
-export const meta = {
-  customTermsShape: {
-    keywordShares: KeywordSharesShape,
-    timerService: M.eref(M.remotable('TimerService')),
-    collectionInterval: RelativeTimeShape,
-  },
-};
-harden(meta);
+/**
+ * A pattern for Zoe to check custom terms before `start()`ing the contract.
+ */
+export const customTermsShape = harden({
+  keywordShares: KeywordSharesShape,
+  timerService: M.eref(M.remotable('TimerService')),
+  collectionInterval: RelativeTimeShape,
+});
 
 /**
  * @typedef {import('@agoric/time/src/types').RelativeTime} RelativeTime
- *
  * @typedef {import('@agoric/time/src/types').TimerService} TimerService
  */
 
 /**
  * @typedef {object} FeeCollector
+ *
  * @property {() => ERef<Payment<'nat'>>} collectFees
  */
 
@@ -66,12 +65,10 @@ export const makeContractFeeCollector = (zoe, creatorFacet) => {
  * for fees that have been collected to date and send that payment to the
  * depositFacet.
  *
- * @param {() => Promise<unknown>} schedulePayments - distribute to the
- *   destinations
- * @param {ERef<TimerService>} timerService - timer that is used to schedule
- *   collections
+ * @param {() => Promise<unknown>} schedulePayments - distribute to the destinations
+ * @param {ERef<TimerService>} timerService - timer that is used to schedule collections
  * @param {RelativeTime} [collectionInterval] - how often to collect fees in the
- *   `timerService` unit
+ * `timerService` unit
  */
 export const startDistributing = (
   schedulePayments,
@@ -102,9 +99,8 @@ export const startDistributing = (
 };
 
 /**
- * @typedef {{
- *   pushPayment: (payment: Payment, issuer: ERef<Issuer>) => Promise<Amount>;
- * }} FeeDestination
+ * @typedef {{ pushPayment: (payment: Payment, issuer: ERef<Issuer>) => Promise<Amount>}} FeeDestination
+ *
  * @param {Record<Keyword, ERef<FeeDestination>>} [destinations]
  * @param {Record<Keyword, NatValue>} [keywordShares]
  */
@@ -165,16 +161,17 @@ export const sharePayment = async (
     .filter(([_, amt]) => !AmountMath.isEmpty(amt));
 
   /**
-   * If the `sharedPayment[i]` payments that are sent to the fee `destination`
-   * with `pushPayment` never arrive, or never get deposited (or otherwise used
-   * up), then they remain in the recovery set of the `recoveryPurse`. The
-   * purpose of this, and of recovery sets in general, is to be able, in
-   * emergencies, to recover the assets of payments in flight that seem to be
-   * stuck. This is much like cancelling a check that may still be undeposited.
+   * If the `sharedPayment[i]` payments that are sent to the fee
+   * `destination` with `pushPayment` never arrive, or never get deposited
+   * (or otherwise used up), then they remain in the recovery set of the
+   * `recoveryPurse`. The purpose of this, and of recovery sets in general,
+   * is to be able, in emergencies, to recover the assets of payments in flight
+   * that seem to be stuck. This is much like cancelling a check that may still
+   * be undeposited.
    *
    * TODO: However, for this to be possible, the `recoveryPurse` holding that
-   * recovery set must remain accessible to someone that should legitimately be
-   * able to recover those payments. But this `recoveryPurse` is currently
+   * recovery set must remain accessible to someone that should legitimately
+   * be able to recover those payments. But this `recoveryPurse` is currently
    * dropped on the floor instead.
    */
   const recoveryPurse = E(issuer).makeEmptyPurse();
@@ -196,11 +193,7 @@ export const sharePayment = async (
 
 /**
  * @param {ERef<Issuer<'nat'>>} feeIssuer
- * @param {{
- *   keywordShares: Record<Keyword, NatValue>;
- *   timerService: ERef<TimerService>;
- *   collectionInterval: RelativeTime;
- * }} terms
+ * @param {{ keywordShares: Record<Keyword, NatValue>, timerService: ERef<TimerService>, collectionInterval: RelativeTime}} terms
  */
 export const makeFeeDistributor = (feeIssuer, terms) => {
   const { timerService, collectionInterval } = terms;
@@ -268,7 +261,9 @@ export const makeFeeDistributor = (feeIssuer, terms) => {
       return periodicCollector;
     },
 
-    /** @param {import('@endo/far').EOnly<DepositFacet>} depositFacet */
+    /**
+     * @param {import('@endo/far').EOnly<DepositFacet>} depositFacet
+     */
     makeDepositFacetDestination: depositFacet => {
       return Far(`DepositFacetDestination`, {
         pushPayment: async (payment, _issuer) => {
@@ -320,7 +315,9 @@ export const makeFeeDistributor = (feeIssuer, terms) => {
       });
     },
 
-    /** @param {Record<Keyword, ERef<FeeDestination>>} newDestinations */
+    /**
+     * @param {Record<Keyword, ERef<FeeDestination>>} newDestinations
+     */
     setDestinations: async newDestinations => {
       destinations = newDestinations;
       shareConfig = makeShareConfig(destinations, keywordShares);
@@ -347,7 +344,9 @@ export const makeFeeDistributor = (feeIssuer, terms) => {
 /** @typedef {ReturnType<typeof makeFeeDistributor>['creatorFacet']} FeeDistributorCreatorFacet */
 /** @typedef {ReturnType<typeof makeFeeDistributor>['publicFacet']} FeeDistributorPublicFacet */
 
-/** @param {ZCF<Parameters<typeof makeFeeDistributor>[1]>} zcf */
+/**
+ * @param {ZCF<Parameters<typeof makeFeeDistributor>[1]>} zcf
+ */
 export const start = async zcf => {
   const feeIssuer = E(zcf.getZoeService()).getFeeIssuer();
   return makeFeeDistributor(feeIssuer, zcf.getTerms());

package/src/interest.js

@@ -12,7 +12,6 @@ import { TimeMath } from '@agoric/time';
 
 /**
  * @typedef {import('@agoric/time/src/types').Timestamp} Timestamp
- *
  * @typedef {import('@agoric/time/src/types').RelativeTime} RelativeTime
  */
 
@@ -21,7 +20,9 @@ const BASIS_POINTS = 10000;
 // single digit APR is less than a basis point per day.
 const LARGE_DENOMINATOR = BASIS_POINTS * BASIS_POINTS;
 
-/** Number chosen from 6 digits for a basis point, doubled for multiplication. */
+/**
+ * Number chosen from 6 digits for a basis point, doubled for multiplication.
+ */
 const COMPOUNDED_INTEREST_DENOMINATOR = 10n ** 20n;
 
 /**
@@ -146,27 +147,20 @@ const validatedBrand = (mint, debt) => {
  * Charge interest accrued between `latestInterestUpdate` and `accruedUntil`.
  *
  * @param {{
- *   mint: ZCFMint<'nat'>;
- *   mintAndTransferWithFee: MintAndTransfer;
- *   poolIncrementSeat: ZCFSeat;
- *   seatAllocationKeyword: Keyword;
- * }} powers
+ *  mint: ZCFMint<'nat'>,
+ *  mintAndTransferWithFee: MintAndTransfer,
+ *  poolIncrementSeat: ZCFSeat,
+ *  seatAllocationKeyword: Keyword }} powers
  * @param {{
- *   interestRate: Ratio;
- *   chargingPeriod: RelativeTime;
- *   recordingPeriod: RelativeTime;
- * }} params
+ *  interestRate: Ratio,
+ *  chargingPeriod: RelativeTime,
+ *  recordingPeriod: RelativeTime}} params
  * @param {{
- *   latestInterestUpdate: Timestamp;
- *   compoundedInterest: Ratio;
- *   totalDebt: Amount<'nat'>;
- * }} prior
+ *  latestInterestUpdate: Timestamp,
+ *  compoundedInterest: Ratio,
+ *  totalDebt: Amount<'nat'>}} prior
  * @param {Timestamp} accruedUntil
- * @returns {{
- *   compoundedInterest: Ratio;
- *   latestInterestUpdate: Timestamp;
- *   totalDebt: Amount<'nat'>;
- * }}
+ * @returns {{compoundedInterest: Ratio, latestInterestUpdate: Timestamp, totalDebt: Amount<'nat'> }}
  */
 export const chargeInterest = (powers, params, prior, accruedUntil) => {
   const brand = validatedBrand(powers.mint, prior.totalDebt);