@agoric/inter-protocol 0.16.2-dev-857e650.0 → 0.16.2-dev-fb922d3.0

package/src/vaultFactory/liquidation.js

@@ -22,7 +22,8 @@ const makeCancelToken = makeCancelTokenMaker('liq');
 
 /**
  * This will normally be set. If the schedule goes sideways, we'll unschedule
- * all events and unset it. When auction params are changed, we'll restart the schedule
+ * all events and unset it. When auction params are changed, we'll restart the
+ * schedule
  *
  * @type {object | undefined}
  */
@@ -47,15 +48,16 @@ const cancelWakeups = timer => {
 };
 
 /**
- * Schedule wakeups for the *next* auction round.
+ * Schedule wakeups for the _next_ auction round.
  *
- * In practice, there are these cases to handle (with N as "live" and N+1 is "next"):
+ * In practice, there are these cases to handle (with N as "live" and N+1 is
+ * "next"):
  *
- * | when (now within the range)      | what                                    |
- * | -------------------------------- | --------------------------------------- |
- * | [start N, nominalStart N+1]      | good: schedule normally the three wakers|
- * | (nominalStart N+1, endTime N+1]  | recover: skip round N+1 and schedule N+2|
- * | (endTime N+1, ∞)                 | give up: wait for repair by governance  |
+ * | when (now within the range)     | what                                     |
+ * | ------------------------------- | ---------------------------------------- |
+ * | [start N, nominalStart N+1]     | good: schedule normally the three wakers |
+ * | (nominalStart N+1, endTime N+1] | recover: skip round N+1 and schedule N+2 |
+ * | (endTime N+1, ∞)                | give up: wait for repair by governance   |
  *
  * @param {object} opts
  * @param {ERef<TimerService>} opts.timer
@@ -132,7 +134,7 @@ const setWakeups = ({
 };
 
 /**
- * Schedule wakeups for the *next* auction round.
+ * Schedule wakeups for the _next_ auction round.
  *
  * Called by vaultDirector's resetWakeupsForNextAuction at start() and every
  * time there's a "reschedule" wakeup.
@@ -185,7 +187,7 @@ harden(setWakeupsForNextAuction);
 /**
  * @param {Amount<'nat'>} debt
  * @param {Amount<'nat'>} minted
- * @returns {{ overage: Amount<'nat'>, shortfall: Amount<'nat'>}}
+ * @returns {{ overage: Amount<'nat'>; shortfall: Amount<'nat'> }}
  */
 export const liquidationResults = (debt, minted) => {
   if (AmountMath.isEmpty(minted)) {
@@ -240,15 +242,21 @@ export const watchForGovernanceChange = (
  * @param {PriceQuote} collateralizationDetails.quote
  * @param {Ratio} collateralizationDetails.interest
  * @param {Ratio} collateralizationDetails.margin
- * @param {ReturnType<typeof import('./prioritizedVaults.js').makePrioritizedVaults>} prioritizedVaults
+ * @param {ReturnType<
+ *   typeof import('./prioritizedVaults.js').makePrioritizedVaults
+ * >} prioritizedVaults
  * @param {SetStore<Vault>} liquidatingVaults
  * @param {Brand<'nat'>} debtBrand
  * @param {Brand<'nat'>} collateralBrand
  * @returns {{
- *    vaultData: MapStore<Vault, { collateralAmount: Amount<'nat'>, debtAmount:  Amount<'nat'>}>,
- *    totalDebt: Amount<'nat'>,
- *    totalCollateral: Amount<'nat'>,
- *    liqSeat: ZCFSeat}}
+ *   vaultData: MapStore<
+ *     Vault,
+ *     { collateralAmount: Amount<'nat'>; debtAmount: Amount<'nat'> }
+ *   >;
+ *   totalDebt: Amount<'nat'>;
+ *   totalCollateral: Amount<'nat'>;
+ *   liqSeat: ZCFSeat;
+ * }}
  */
 export const getLiquidatableVaults = (
   zcf,
@@ -261,7 +269,12 @@ export const getLiquidatableVaults = (
   const vaultsToLiquidate = prioritizedVaults.removeVaultsBelow(
     collateralizationDetails,
   );
-  /** @type {MapStore<Vault, { collateralAmount: Amount<'nat'>, debtAmount:  Amount<'nat'>}>} */
+  /**
+   * @type {MapStore<
+   *   Vault,
+   *   { collateralAmount: Amount<'nat'>; debtAmount: Amount<'nat'> }
+   * >}
+   */
   const vaultData = makeScalarMapStore();
 
   const { zcfSeat: liqSeat } = zcf.makeEmptySeatKit();

package/src/vaultFactory/math.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"math.d.ts","sourceRoot":"","sources":["math.js"],"names":[],"mappings":"AA0BO,qEAJI,KAAK,sBACL,KAAK,GACH,KAAK,CAKmC;AAS9C,qCAJI,UAAU,oCAER,KAAK,CAajB;AAYM,6CALI,UAAU,qBACV,KAAK,sBACL,KAAK,GACH,OAAO,KAAK,CAAC,CAczB;AAcM,gDALI,OAAO,KAAK,CAAC,QACb,OAAO,KAAK,CAAC,QACb,OAAO,KAAK,CAAC,WACb,KAAK;;;;;EASf"}
+{"version":3,"file":"math.d.ts","sourceRoot":"","sources":["math.js"],"names":[],"mappings":"AA0BO,qEAJI,KAAK,sBACL,KAAK,GACH,KAAK,CAKmC;AAS9C,qCAJI,UAAU,oCAER,KAAK,CAajB;AAYM,6CALI,UAAU,qBACV,KAAK,sBACL,KAAK,GACH,OAAO,KAAK,CAAC,CAczB;AAaM,gDALI,OAAO,KAAK,CAAC,QACb,OAAO,KAAK,CAAC,QACb,OAAO,KAAK,CAAC,WACb,KAAK;;;;;EASf"}

package/src/vaultFactory/math.js

@@ -1,8 +1,8 @@
 // @jessie-check
 
 /**
- * @file calculations specific to the Vault Factory contract
- * See also ../interest-math.js
+ * @file calculations specific to the Vault Factory contract See also
+ *   ../interest-math.js
  */
 
 import { AmountMath } from '@agoric/ertp';
@@ -17,8 +17,8 @@ import { priceFrom } from '../auction/util.js';
 import { addSubtract } from '../contractSupport.js';
 
 /**
- * Calculate the minimum collateralization given the liquidation margin and the "padding"
- * from that liquidation threshold.
+ * Calculate the minimum collateralization given the liquidation margin and the
+ * "padding" from that liquidation threshold.
  *
  * @param {Ratio} liquidationMargin
  * @param {Ratio} liquidationPadding
@@ -74,11 +74,10 @@ export const maxDebtForVault = (
 };
 
 /**
- * Calculate the fee, the amount to mint and the resulting debt.
- * The give and the want together reflect a delta, where typically
- * one is zero because they come from the gave/want of an offer
- * proposal. If the `want` is zero, the `fee` will also be zero,
- * so the simple math works.
+ * Calculate the fee, the amount to mint and the resulting debt. The give and
+ * the want together reflect a delta, where typically one is zero because they
+ * come from the gave/want of an offer proposal. If the `want` is zero, the
+ * `fee` will also be zero, so the simple math works.
  *
  * @param {Amount<'nat'>} currentDebt
  * @param {Amount<'nat'>} give excess of currentDebt is returned in 'surplus'

package/src/vaultFactory/orderedVaultStore.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"orderedVaultStore.d.ts","sourceRoot":"","sources":["orderedVaultStore.js"],"names":[],"mappings":"AAkBO,6CAFI,SAAS,MAAM,EAAE,KAAK,CAAC;wBAKrB,MAAM,SACN,KAAK;uBAYL,MAAM,KACJ,KAAK;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAiCnB;oBAxDa,OAAO,SAAS,EAAE,KAAK;2BACvB,OAAO,cAAc,EAAE,YAAY"}
+{"version":3,"file":"orderedVaultStore.d.ts","sourceRoot":"","sources":["orderedVaultStore.js"],"names":[],"mappings":"AAiBO,6CADK,SAAS,MAAM,EAAE,KAAK,CAAC;wBAGtB,MAAM,SACN,KAAK;uBAWL,MAAM,KACJ,KAAK;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAiCnB;oBApDa,OAAO,SAAS,EAAE,KAAK;2BACvB,OAAO,cAAc,EAAE,YAAY"}

package/src/vaultFactory/orderedVaultStore.js

@@ -3,22 +3,20 @@ import { fromVaultKey, toVaultKey } from './storeUtils.js';
 /**
  * Used by prioritizedVaults to wrap the Collections API for this use case.
  *
- * Designed to be replaceable by naked Collections API when composite keys are available.
+ * Designed to be replaceable by naked Collections API when composite keys are
+ * available.
  *
- * In this module debts are encoded as the inverse quotient (collateral over debt) so that
- * greater collateralization sorts after lower. (Higher debt-to-collateral come
- * first.)
+ * In this module debts are encoded as the inverse quotient (collateral over
+ * debt) so that greater collateralization sorts after lower. (Higher
+ * debt-to-collateral come first.)
  */
 
 /** @typedef {import('./vault').Vault} Vault */
 /** @typedef {import('./storeUtils').CompositeKey} CompositeKey */
 
-/**
- * @param {MapStore<string, Vault>} store
- */
+/** @param {MapStore<string, Vault>} store */
 export const makeOrderedVaultStore = store => {
   /**
-   *
    * @param {string} vaultId
    * @param {Vault} vault
    */
@@ -31,7 +29,6 @@ export const makeOrderedVaultStore = store => {
   };
 
   /**
-   *
    * @param {string} key
    * @returns {Vault}
    */

package/src/vaultFactory/params.d.ts

@@ -98,7 +98,6 @@ export function makeGovernedTerms({ auctioneerPublicFacet, bootstrapPaymentValue
 };
 export function provideVaultParamManagers(baggage: MapStore<string, unknown>, marshaller: ERef<Marshaller>): {
     /**
-     *
      * @param {Brand} brand
      * @param {StorageNode} storageNode
      * @param {VaultManagerParamValues} initialParamValues
@@ -111,9 +110,7 @@ export function provideVaultParamManagers(baggage: MapStore<string, unknown>, ma
         LiquidationPenalty: "ratio";
         MintFee: "ratio";
     }>;
-    /**
-     * @param {Brand} brand
-     */
+    /** @param {Brand} brand */
     get(brand: Brand): import("@agoric/governance/src/contractGovernance/typedParamManager").TypedParamManager<{
         DebtLimit: "amount";
         StabilityFee: "ratio";

package/src/vaultFactory/params.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"params.d.ts","sourceRoot":"","sources":["params.js"],"names":[],"mappings":"AAgBA,mDAAoD;AACpD,qDAAsD;AAEtD,yCAA0C;AAC1C,yDAA0D;AAC1D,2DAA4D;AAC5D,2DAA4D;AAC5D,+CAAgD;AAChD,qCAAsC;AACtC,oDAAqD;AACrD,6DAA8D;AAC9D,+CAAgD;;;;;;;AA4DzC,oDAHI,OAAO,kBAAkB,EAAE,kBAAkB,CAAC,2BAA2B,CAAC,oGAC1E,uBAAuB;;;;;;;GAoB9B;AACJ,4EAA4E;AAE5E,iEAYE;AAgBK,qOAbI;IACV,qBAAyB,EAAE,KAAK,qBAAqB,CAAC,CAAC;IACvD,0BAA8B,EAAE,OAAO,KAAK,CAAC,CAAC;IAC9C,cAAkB,EAAE,OAAO,KAAK,CAAC,CAAC;IAClC,qBAAyB,EAAE,MAAM,CAAC;IAClC,cAAkB,EAAE,KAAK,cAAc,CAAC,CAAC;IACzC,KAAS,EAAE,KAAK,OAAO,wBAAwB,EAAE,YAAY,CAAC,CAAC;IAC/D,kBAAsB,EAAE,uBAAuB,CAAC;IAChD,cAAkB,EAAE,cAAc,CAAC;IACnC,yBAA6B,EAAE,OAAO,KAAK,CAAC,CAAC;IAC7C,YAAgB,CAAC,EAAE,MAAM,CAAC;CACvB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EA4BH;AAWM,0FAFI,KAAK,UAAU,CAAC;IA0BvB;;;;;OAKG;2BAHQ,KAAK,eACL,WAAW,sBACX,uBAAuB;;;;;;;;IAOlC;;OAEG;eADQ,KAAK;;;;;;;;EAMnB;kCA1Ia,OAAO,6DAA6D,EAAE,uBAAuB,CAAC,WAAW,8BAA8B,CAAC,CAAC;gCA6BzI,WAAW,4BAA4B,CAAC;AArEtD;;;;;;GAMG;AACH,qEANW,OAAO,KAAK,CAAC,kBACb,OAAO,KAAK,CAAC,6BACb,OAAO,KAAK,CAAC,gBACb,MAAM,kBACN,cAAc;;;;;;;;;;;;;;;;;;;;;;;;;EAgCxB"}
+{"version":3,"file":"params.d.ts","sourceRoot":"","sources":["params.js"],"names":[],"mappings":"AAgBA,mDAAoD;AACpD,qDAAsD;AAEtD,yCAA0C;AAC1C,yDAA0D;AAC1D,2DAA4D;AAC5D,2DAA4D;AAC5D,+CAAgD;AAChD,qCAAsC;AACtC,oDAAqD;AACrD,6DAA8D;AAC9D,+CAAgD;;;;;;;AAgEzC,oDAHI,OAAO,kBAAkB,EAAE,kBAAkB,CAAC,2BAA2B,CAAC,oGAC1E,uBAAuB;;;;;;;GAoB9B;AACJ,4EAA4E;AAE5E,iEAYE;AAgBK,qOAbI;IACV,qBAAyB,EAAE,KAAK,qBAAqB,CAAC,CAAC;IACvD,0BAA8B,EAAE,OAAO,KAAK,CAAC,CAAC;IAC9C,cAAkB,EAAE,OAAO,KAAK,CAAC,CAAC;IAClC,qBAAyB,EAAE,MAAM,CAAC;IAClC,cAAkB,EAAE,KAAK,cAAc,CAAC,CAAC;IACzC,KAAS,EAAE,KAAK,OAAO,wBAAwB,EAAE,YAAY,CAAC,CAAC;IAC/D,kBAAsB,EAAE,uBAAuB,CAAC;IAChD,cAAkB,EAAE,cAAc,CAAC;IACnC,yBAA6B,EAAE,OAAO,KAAK,CAAC,CAAC;IAC7C,YAAgB,CAAC,EAAE,MAAM,CAAC;CACvB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EA4BH;AAWM,0FAFI,KAAK,UAAU,CAAC;IA+BvB;;;;OAIG;2BAHQ,KAAK,eACL,WAAW,sBACX,uBAAuB;;;;;;;;IAOlC,2BAA2B;eAAf,KAAK;;;;;;;;EAKpB;kCA/IY,OAAO,6DAA6D,EAAE,uBAAuB,CACzG,WAAiB,8BAA8B,CAAC,CAC3C;gCA8BQ,WAAW,4BAA4B,CAAC;AAzEtD;;;;;;GAMG;AACH,qEANW,OAAO,KAAK,CAAC,kBACb,OAAO,KAAK,CAAC,6BACb,OAAO,KAAK,CAAC,gBACb,MAAM,kBACN,cAAc;;;;;;;;;;;;;;;;;;;;;;;;;EAgCxB"}

package/src/vaultFactory/params.js

@@ -75,7 +75,11 @@ const makeVaultDirectorParams = (
 };
 harden(makeVaultDirectorParams);
 
-/** @typedef {import('@agoric/governance/src/contractGovernance/typedParamManager').ParamTypesMapFromRecord<ReturnType<typeof makeVaultDirectorParams>>} VaultDirectorParams */
+/**
+ * @typedef {import('@agoric/governance/src/contractGovernance/typedParamManager').ParamTypesMapFromRecord<
+ *     ReturnType<typeof makeVaultDirectorParams>
+ *   >} VaultDirectorParams
+ */
 
 /** @type {(liquidationMargin: Ratio) => Ratio} */
 const zeroRatio = liquidationMargin =>
@@ -122,16 +126,16 @@ export const vaultParamPattern = M.splitRecord(
 
 /**
  * @param {{
- *   auctioneerPublicFacet: ERef<AuctioneerPublicFacet>,
- *   electorateInvitationAmount: Amount<'set'>,
- *   minInitialDebt: Amount<'nat'>,
- *   bootstrapPaymentValue: bigint,
- *   priceAuthority: ERef<PriceAuthority>,
- *   timer: ERef<import('@agoric/time/src/types').TimerService>,
- *   reservePublicFacet: AssetReservePublicFacet,
- *   interestTiming: InterestTiming,
- *   shortfallInvitationAmount: Amount<'set'>,
- *   referencedUi?: string,
+ *   auctioneerPublicFacet: ERef<AuctioneerPublicFacet>;
+ *   electorateInvitationAmount: Amount<'set'>;
+ *   minInitialDebt: Amount<'nat'>;
+ *   bootstrapPaymentValue: bigint;
+ *   priceAuthority: ERef<PriceAuthority>;
+ *   timer: ERef<import('@agoric/time/src/types').TimerService>;
+ *   reservePublicFacet: AssetReservePublicFacet;
+ *   interestTiming: InterestTiming;
+ *   shortfallInvitationAmount: Amount<'set'>;
+ *   referencedUi?: string;
  * }} opts
  */
 export const makeGovernedTerms = ({
@@ -163,8 +167,8 @@ export const makeGovernedTerms = ({
 };
 harden(makeGovernedTerms);
 /**
- * Stop-gap which restores initial param values
- * UNTIL https://github.com/Agoric/agoric-sdk/issues/5200
+ * Stop-gap which restores initial param values UNTIL
+ * https://github.com/Agoric/agoric-sdk/issues/5200
  *
  * NB: changes from initial values will be lost upon restart
  *
@@ -176,7 +180,12 @@ export const provideVaultParamManagers = (baggage, marshaller) => {
   const managers = makeScalarMapStore();
 
   // the managers aren't durable but their arguments are
-  /** @type {MapStore<Brand, {storageNode: StorageNode, initialParamValues: VaultManagerParamValues}>} */
+  /**
+   * @type {MapStore<
+   *   Brand,
+   *   { storageNode: StorageNode; initialParamValues: VaultManagerParamValues }
+   * >}
+   */
   const managerArgs = provideDurableMapStore(
     baggage,
     'vault param manager parts',
@@ -196,7 +205,6 @@ export const provideVaultParamManagers = (baggage, marshaller) => {
 
   return {
     /**
-     *
      * @param {Brand} brand
      * @param {StorageNode} storageNode
      * @param {VaultManagerParamValues} initialParamValues
@@ -206,9 +214,7 @@ export const provideVaultParamManagers = (baggage, marshaller) => {
       managerArgs.init(brand, args);
       return makeManager(brand, args);
     },
-    /**
-     * @param {Brand} brand
-     */
+    /** @param {Brand} brand */
     get(brand) {
       return managers.get(brand);
     },

package/src/vaultFactory/prioritizedVaults.js

@@ -47,8 +47,8 @@ export const currentDebtToCollateral = vault =>
  * Vaults, ordered by their debt ratio so that all the vaults below a threshold
  * can be quickly found and liquidated.
  *
- * @param {MapStore<string, Vault>} store
- * vault has a higher debt ratio than the previous highest
+ * @param {MapStore<string, Vault>} store vault has a higher debt ratio than the
+ *   previous highest
  */
 export const makePrioritizedVaults = store => {
   const vaults = makeOrderedVaultStore(store);

package/src/vaultFactory/proceeds.d.ts

@@ -3,7 +3,7 @@ export function calculateDistributionPlan({ proceeds, totalDebt, totalCollateral
     totalDebt: Amount<'nat'>;
     totalCollateral: Amount<'nat'>;
     oraclePriceAtStart: PriceDescription;
-    vaultsBalances: Array<VaultBalances>;
+    vaultsBalances: VaultBalances[];
     penaltyRate: Ratio;
 }): DistributionPlan;
 /**
@@ -23,8 +23,8 @@ export type DistributionPlan = {
     mintedProceeds: Amount<'nat'>;
     phantomDebt: Amount<'nat'>;
     totalPenalty: Amount<'nat'>;
-    transfersToVault: Array<[number, AmountKeywordRecord]>;
-    vaultsToReinstate: Array<number>;
+    transfersToVault: [number, AmountKeywordRecord][];
+    vaultsToReinstate: number[];
 };
 export type VaultBalances = {
     collateral: Amount<'nat'>;

package/src/vaultFactory/proceeds.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"proceeds.d.ts","sourceRoot":"","sources":["proceeds.js"],"names":[],"mappings":"AAoDO;IARgC,QAAQ,EAApC,mBAAmB;IACG,SAAS,EAA/B,OAAO,KAAK,CAAC;IACS,eAAe,EAArC,OAAO,KAAK,CAAC;IACY,kBAAkB,EAA3C,gBAAgB;IACa,cAAc,EAA3C,MAAM,aAAa,CAAC;IACN,WAAW,EAAzB,KAAK;IACH,gBAAgB,CA8N5B;;;;;;+BApQY;IACZ,OAAW,EAAE,OAAO,KAAK,CAAC,CAAC;IAC3B,kBAAsB,EAAE,OAAO,KAAK,CAAC,CAAC;IACtC,oBAAwB,EAAE,OAAO,KAAK,CAAC,CAAC;IACxC,oBAAwB,EAAE,OAAO,KAAK,CAAC,CAAC;IACxC,cAAkB,EAAE,OAAO,KAAK,CAAC,CAAC;IAClC,eAAmB,EAAE,OAAO,KAAK,CAAC,CAAC;IACnC,UAAc,EAAE,OAAO,KAAK,CAAC,CAAC;IAC9B,gBAAoB,EAAE,OAAO,KAAK,CAAC,CAAC;IACpC,cAAkB,EAAE,OAAO,KAAK,CAAC,CAAC;IAClC,WAAe,EAAE,OAAO,KAAK,CAAC,CAAC;IAC/B,YAAgB,EAAE,OAAO,KAAK,CAAC,CAAC;IAChC,gBAAoB,EAAE,MAAM,CAAC,MAAM,EAAE,mBAAmB,CAAC,CAAC,CAAC;IAC3D,iBAAqB,EAAE,MAAM,MAAM,CAAC,CAAA;CACjC;4BAOU;IAAE,UAAU,EAAE,OAAO,KAAK,CAAC,CAAC;IAAC,WAAW,EAAG,OAAO,KAAK,CAAC,CAAC;IAAC,WAAW,EAAE,OAAO,KAAK,CAAC,CAAA;CAAE"}
+{"version":3,"file":"proceeds.d.ts","sourceRoot":"","sources":["proceeds.js"],"names":[],"mappings":"AA0DO;IATgC,QAAQ,EAApC,mBAAmB;IACG,SAAS,EAA/B,OAAO,KAAK,CAAC;IACS,eAAe,EAArC,OAAO,KAAK,CAAC;IACY,kBAAkB,EAA3C,gBAAgB;IACQ,cAAc,EAAtC,aAAa,EAAE;IAED,WAAW,EAAzB,KAAK;IACH,gBAAgB,CA8N5B;;;;;;+BA1QY;IACZ,OAAW,EAAE,OAAO,KAAK,CAAC,CAAC;IAC3B,kBAAsB,EAAE,OAAO,KAAK,CAAC,CAAC;IACtC,oBAAwB,EAAE,OAAO,KAAK,CAAC,CAAC;IACxC,oBAAwB,EAAE,OAAO,KAAK,CAAC,CAAC;IACxC,cAAkB,EAAE,OAAO,KAAK,CAAC,CAAC;IAClC,eAAmB,EAAE,OAAO,KAAK,CAAC,CAAC;IACnC,UAAc,EAAE,OAAO,KAAK,CAAC,CAAC;IAC9B,gBAAoB,EAAE,OAAO,KAAK,CAAC,CAAC;IACpC,cAAkB,EAAE,OAAO,KAAK,CAAC,CAAC;IAClC,WAAe,EAAE,OAAO,KAAK,CAAC,CAAC;IAC/B,YAAgB,EAAE,OAAO,KAAK,CAAC,CAAC;IAChC,gBAAoB,EAAE,CAAC,MAAM,EAAE,mBAAmB,CAAC,EAAE,CAAC;IACtD,iBAAqB,EAAE,MAAM,EAAE,CAAC;CAC7B;4BAOS;IACZ,UAAc,EAAE,OAAO,KAAK,CAAC,CAAC;IAC9B,WAAe,EAAE,OAAO,KAAK,CAAC,CAAC;IAC/B,WAAe,EAAE,OAAO,KAAK,CAAC,CAAC;CAC5B"}

package/src/vaultFactory/proceeds.js

@@ -11,27 +11,32 @@ import { liquidationResults } from './liquidation.js';
 
 /**
  * @typedef {{
- *   overage: Amount<'nat'>,
- *   shortfallToReserve: Amount<'nat'>,
- *   collateralForReserve: Amount<'nat'>,
- *   actualCollateralSold: Amount<'nat'>,
- *   collateralSold: Amount<'nat'>,
- *   collatRemaining: Amount<'nat'>,
- *   debtToBurn: Amount<'nat'>,
- *   mintedForReserve: Amount<'nat'>,
- *   mintedProceeds: Amount<'nat'>,
- *   phantomDebt: Amount<'nat'>,
- *   totalPenalty: Amount<'nat'>,
- *   transfersToVault: Array<[number, AmountKeywordRecord]>,
- *   vaultsToReinstate: Array<number>
+ *   overage: Amount<'nat'>;
+ *   shortfallToReserve: Amount<'nat'>;
+ *   collateralForReserve: Amount<'nat'>;
+ *   actualCollateralSold: Amount<'nat'>;
+ *   collateralSold: Amount<'nat'>;
+ *   collatRemaining: Amount<'nat'>;
+ *   debtToBurn: Amount<'nat'>;
+ *   mintedForReserve: Amount<'nat'>;
+ *   mintedProceeds: Amount<'nat'>;
+ *   phantomDebt: Amount<'nat'>;
+ *   totalPenalty: Amount<'nat'>;
+ *   transfersToVault: [number, AmountKeywordRecord][];
+ *   vaultsToReinstate: number[];
  * }} DistributionPlan
+ *   The plan to execute for distributing proceeds of a liquidation.
  *
- * The plan to execute for distributing proceeds of a liquidation.
- *
- * Vaults are referenced by index in the list sent to the calculator.
+ *   Vaults are referenced by index in the list sent to the calculator.
  */
 
-/** @typedef {{ collateral: Amount<'nat'>, presaleDebt:  Amount<'nat'>, currentDebt: Amount<'nat'> }} VaultBalances */
+/**
+ * @typedef {{
+ *   collateral: Amount<'nat'>;
+ *   presaleDebt: Amount<'nat'>;
+ *   currentDebt: Amount<'nat'>;
+ * }} VaultBalances
+ */
 
 /**
  * Liquidation.md describes how to process liquidation proceeds.
@@ -46,7 +51,8 @@ import { liquidationResults } from './liquidation.js';
  * @param {Amount<'nat'>} inputs.totalDebt
  * @param {Amount<'nat'>} inputs.totalCollateral
  * @param {PriceDescription} inputs.oraclePriceAtStart
- * @param {Array<VaultBalances>} inputs.vaultsBalances ordered best to worst collateralized
+ * @param {VaultBalances[]} inputs.vaultsBalances ordered best to worst
+ *   collateralized
  * @param {Ratio} inputs.penaltyRate
  * @returns {DistributionPlan}
  */

package/src/vaultFactory/storeUtils.d.ts

@@ -1,9 +1,5 @@
-/**
- * @typedef {import('@endo/marshal').PureData} PureData
- */
-/**
- * @typedef {[normalizedCollateralization: number, vaultId: VaultId]} CompositeKey
- */
+/** @typedef {import('@endo/marshal').PureData} PureData */
+/** @typedef {[normalizedCollateralization: number, vaultId: VaultId]} CompositeKey */
 /**
  * @param {PureData} key
  * @returns {string}

package/src/vaultFactory/storeUtils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"storeUtils.d.ts","sourceRoot":"","sources":["storeUtils.js"],"names":[],"mappings":"AAqBA;;GAEG;AAEH;;GAEG;AAOH;;;GAGG;AACH,mDAA+C;AAO/C;;;GAGG;AACH,kDAA+C;AAkDxC,2CANI,cAAc,cACd,OAAO,KAAK,CAAC,WACb,OAAO,GACL,MAAM,CAelB;AAOM,kCAHI,MAAM,GACJ,CAAC,2BAA2B,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,CAAC,CAKnE;AAgBM,2CALI,UAAU,0BACV,KAAK,UACL,KAAK,GACH,MAAM,CAiBlB;AAcM,8CANI,UAAU,0BACV,KAAK,UACL,KAAK,GACH,MAAM,CAUlB;uBAvJY,OAAO,eAAe,EAAE,QAAQ;2BAIhC,CAAC,2BAA2B,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,CAAC;6BA6CtD,OAAO,KAAK,CAAC,GAAG;IAAC,UAAU,EAAE,IAAI,CAAA;CAAC;yBAClC,OAAO,KAAK,CAAC,GAAG;IAAC,UAAU,EAAE,KAAK,CAAA;CAAC"}
+{"version":3,"file":"storeUtils.d.ts","sourceRoot":"","sources":["storeUtils.js"],"names":[],"mappings":"AAqBA,2DAA2D;AAE3D,sFAAsF;AAOtF;;;GAGG;AACH,mDAA+C;AAO/C;;;GAGG;AACH,kDAA+C;AAkDxC,2CANI,cAAc,cACd,OAAO,KAAK,CAAC,WACb,OAAO,GACL,MAAM,CAelB;AAOM,kCAHI,MAAM,GACJ,CAAC,2BAA2B,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,CAAC,CAKnE;AAgBM,2CALI,UAAU,0BACV,KAAK,UACL,KAAK,GACH,MAAM,CAiBlB;AAcM,8CANI,UAAU,0BACV,KAAK,UACL,KAAK,GACH,MAAM,CAUlB;uBApJa,OAAO,eAAe,EAAE,QAAQ;2BAEhC,CAAC,2BAA2B,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,CAAC;6BA4CvD,OAAO,KAAK,CAAC,GAAG;IAAE,UAAU,EAAE,IAAI,CAAA;CAAE;yBACpC,OAAO,KAAK,CAAC,GAAG;IAAE,UAAU,EAAE,KAAK,CAAA;CAAE"}

package/src/vaultFactory/storeUtils.js

@@ -19,13 +19,9 @@ const { multiply } = natSafeMath;
 
 const trace = makeTracer('Store', true);
 
-/**
- * @typedef {import('@endo/marshal').PureData} PureData
- */
+/** @typedef {import('@endo/marshal').PureData} PureData */
 
-/**
- * @typedef {[normalizedCollateralization: number, vaultId: VaultId]} CompositeKey
- */
+/** @typedef {[normalizedCollateralization: number, vaultId: VaultId]} CompositeKey */
 
 // `makeEncodePassable` has three named options:
 // `encodeRemotable`, `encodeError`, and `encodePromise`.
@@ -69,12 +65,12 @@ const decodeNumber = encoded => {
 };
 
 // Type annotations to support static testing of amount values
-/** @typedef {Amount<'nat'> & {normalized: true}} NormalizedDebt */
-/** @typedef {Amount<'nat'> & {normalized: false}} ActualDebt */
+/** @typedef {Amount<'nat'> & { normalized: true }} NormalizedDebt */
+/** @typedef {Amount<'nat'> & { normalized: false }} ActualDebt */
 
 /**
- * Overcollateralized are greater than one.
- * The more undercollaterized the smaller in [0-1].
+ * Overcollateralized are greater than one. The more undercollaterized the
+ * smaller in [0-1].
  *
  * @param {NormalizedDebt} normalizedDebt normalized (not actual) total debt
  * @param {Amount<'nat'>} collateral
@@ -95,7 +91,7 @@ const collateralizationRatio = (normalizedDebt, collateral) => {
  * @param {Amount<'nat'>} collateral
  * @param {VaultId} vaultId
  * @returns {string} lexically sortable string in which highest
- * debt-to-collateral is earliest
+ *   debt-to-collateral is earliest
  */
 export const toVaultKey = (normalizedDebt, collateral, vaultId) => {
   assert(normalizedDebt);
@@ -162,7 +158,7 @@ harden(normalizedCollRatio);
  * @param {Ratio} compoundedStabilityFee
  * @param {Ratio} margin
  * @returns {string} lexically sortable string in which highest
- * debt-to-collateral is earliest
+ *   debt-to-collateral is earliest
  */
 export const normalizedCollRatioKey = (
   quote,

package/src/vaultFactory/types.d.ts

@@ -20,21 +20,24 @@ type VaultManagerParamValues = {
      */
     liquidationMargin: Ratio;
     /**
-     * - penalty charged upon liquidation as proportion of debt
+     * - penalty charged upon liquidation as
+     * proportion of debt
      */
     liquidationPenalty: Ratio;
     /**
-     * - annual interest rate charged on debt positions
+     * - annual interest rate charged on debt
+     * positions
      */
     stabilityFee: Ratio;
     /**
-     * - The fee (in BasisPoints) charged when creating
-     * or increasing a debt position.
+     * - The fee (in BasisPoints) charged when creating or
+     * increasing a debt position.
      */
     mintFee: Ratio;
     debtLimit: Amount<'nat'>;
     /**
-     * - vault must maintain this in order to remove collateral or add debt
+     * - vault must maintain this in order to
+     * remove collateral or add debt
      */
     liquidationPadding?: Ratio | undefined;
 };
@@ -47,14 +50,15 @@ type VaultFactoryCreatorFacet = {
     makePriceLockWaker: () => import('@agoric/time/src/types').TimerWaker;
 };
 /**
- * Mint new debt `toMint` and transfer the `fee` portion to the vaultFactory's reward
- * pool. Then reallocate over all the seat arguments and the rewardPoolSeat. Update
- * the `totalDebt` if the reallocate succeeds.
+ * Mint new debt `toMint` and transfer the `fee`
+ *   portion to the vaultFactory's reward pool. Then reallocate over all the
+ *   seat arguments and the rewardPoolSeat. Update the `totalDebt` if the
+ *   reallocate succeeds.
  */
 type MintAndTransfer = (mintReceiver: ZCFSeat, toMint: Amount<'nat'>, fee: Amount<'nat'>, transfers: import('@agoric/zoe/src/contractSupport/atomicTransfer.js').TransferPart[]) => void;
 /**
- * Burn debt tokens off a seat and update
- * the `totalDebt` if the reallocate succeeds.
+ * Burn debt tokens off a seat and update the `totalDebt` if
+ *   the reallocate succeeds.
  */
 type BurnDebt = (toBurn: Amount, fromSeat: ZCFSeat) => void;
 type GetVaultParams = {
@@ -62,7 +66,8 @@ type GetVaultParams = {
     getMintFee: () => Ratio;
     getCollateralQuote: () => Promise<PriceQuote>;
     /**
-     * - The annual interest rate on a debt position
+     * - The annual interest rate on a debt
+     * position
      */
     getStabilityFee: () => Ratio;
     /**

package/src/vaultFactory/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["types.js"],"names":[],"mappings":"yBAGa,OAAO,SAAS,EAAE,iBAAiB;aACnC,OAAO,SAAS,EAAE,KAAK;gBACvB,OAAO,YAAY,EAAE,QAAQ;oBAC7B,OAAO,gBAAgB,EAAE,YAAY;yBACrC,OAAO,gBAAgB,EAAE,iBAAiB;gCAC1C,OAAO,4BAA4B,EAAE,+BAA+B;+BACpE,OAAO,4BAA4B,EAAE,uBAAuB;6BAC5D,OAAO,0BAA0B,EAAE,qBAAqB;+BACxD,OAAO,mBAAmB,EAAE,oBAAoB,CAAC,aAAa,CAAC;iBAE/D,OAAO,wBAAwB,EAAE,SAAS;oBAC1C,OAAO,wBAAwB,EAAE,YAAY;;4BAKnC,MAAM,SAAS,KAAK,KAAK,MAAM;wBACxC,MAAM,UAAU;;;;;;;uBAKhB,KAAK;;;;wBAEL,KAAK;;;;kBACL,KAAK;;;;;aACL,KAAK;eAEL,OAAO,KAAK,CAAC;;;;;;uCAMhB,MAAM,qBACN,OAAO,UACP,uBAAuB,KACrB,QAAQ,YAAY,CAAC;;kBAKpB,YAAY;yBACZ,MAAM,UAAU;+BAChB,MAAM,QAAQ,WAAW,MAAM,EAAE,KAAK,CAAC,CAAC;0BACxC,MAAM,OAAO,wBAAwB,EAAE,UAAU;wBACjD,MAAM,OAAO,wBAAwB,EAAE,UAAU;;;;;;;sCAQpD,OAAO,UACP,OAAO,KAAK,CAAC,OACb,OAAO,KAAK,CAAC,aACb,OAAO,mDAAmD,EAAE,YAAY,EAAE,KACxE,IAAI;;;;;yBASN,MAAM,YACN,OAAO,KACL,IAAI;;0BAKH,MAAM,KAAK;gBACX,MAAM,KAAK;wBACX,MAAM,QAAQ,UAAU,CAAC;;;;qBACzB,MAAM,KAAK;;;;;uBACX,MAAM,YAAY;;;;;wBAElB,MAAM,YAAY;;eAKnB,MAAM;;;;;oBAKL,YAAY;;;;qBACZ,YAAY;;;oBAKZ,MAAM,oBAAoB;+BACb,MAAM,OAAO,MAAM,KAAK,QAAQ;2BACtC,MAAM,KAAK,QAAQ,UAAU,CAAC;;;6BAKrC,MAAM,QAAQ,WAAW,IAAI,EAAE;QAAE,IAAI,EAAE,OAAO,KAAK,CAAC,CAAC;QAAC,WAAW,EAAE,KAAK,CAAC;KAAE,CAAC,CAAC;;;8BAK7E,SAAS;;;;cACT,QAAQ;;;;aACR,QAAQ;;8BAKX,UAAU,eACV,SAAS,KACP,UAAU;;;;;;eAKT,SAAS;;;;;;;8BAET,SAAS;;6BAMT;IAAC,GAAG,EAAE,gBAAgB,GAAG;QAAC,eAAe,EAAE,KAAK,CAAA;KAAC,CAAA;CAAC"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["types.js"],"names":[],"mappings":"yBAGa,OAAO,SAAS,EAAE,iBAAiB;aAEnC,OAAO,SAAS,EAAE,KAAK;gBAEvB,OAAO,YAAY,EAAE,QAAQ;oBAE7B,OAAO,gBAAgB,EAAE,YAAY;yBAErC,OAAO,gBAAgB,EAAE,iBAAiB;gCAE1C,OAAO,4BAA4B,EAAE,+BAA+B;+BAEpE,OAAO,4BAA4B,EAAE,uBAAuB;6BAE5D,OAAO,0BAA0B,EAAE,qBAAqB;+BAExD,OAAO,mBAAmB,EAAE,oBAAoB,CAAC,aAAa,CAAC;iBAE/D,OAAO,wBAAwB,EAAE,SAAS;oBAE1C,OAAO,wBAAwB,EAAE,YAAY;;4BAKnC,MAAM,SAAS,KAAK,KAAK,MAAM;wBACxC,MAAM,UAAU;;;;;;;uBAKhB,KAAK;;;;;wBAEL,KAAK;;;;;kBAEL,KAAK;;;;;aAEL,KAAK;eAEL,OAAO,KAAK,CAAC;;;;;;;uCAOhB,MAAM,qBACN,OAAO,UACP,uBAAuB,KACrB,QAAQ,YAAY,CAAC;;kBAKpB,YAAY;yBACZ,MAAM,UAAU;+BAChB,MAAM,QAAQ,WAAW,MAAM,EAAE,KAAK,CAAC,CAAC;0BACxC,MAAM,OAAO,wBAAwB,EAAE,UAAU;wBACjD,MAAM,OAAO,wBAAwB,EAAE,UAAU;;;;;;;;sCAQpD,OAAO,UACP,OAAO,KAAK,CAAC,OACb,OAAO,KAAK,CAAC,aACb,OAAO,mDAAmD,EAAE,YAAY,EAAE,KACxE,IAAI;;;;;yBAMN,MAAM,YACN,OAAO,KACL,IAAI;;0BAKH,MAAM,KAAK;gBACX,MAAM,KAAK;wBACX,MAAM,QAAQ,UAAU,CAAC;;;;;qBACzB,MAAM,KAAK;;;;;uBAEX,MAAM,YAAY;;;;;wBAElB,MAAM,YAAY;;eAIlB,MAAM;;;;;oBAIN,YAAY;;;;qBACZ,YAAY;;;oBAKZ,MAAM,oBAAoB;+BACb,MAAM,OAAO,MAAM,KAAK,QAAQ;2BACtC,MAAM,KAAK,QAAQ,UAAU,CAAC;;;6BAKrC,MAAM,QACnB,WAAe,IAAI,EAAE;QAAE,IAAI,EAAE,OAAO,KAAK,CAAC,CAAC;QAAC,WAAW,EAAE,KAAK,CAAA;KAAE,CAAC,CAC9D;;;8BAKU,SAAS;;;;cACT,QAAQ;;;;aACR,QAAQ;;8BAKX,UAAU,eACV,SAAS,KACP,UAAU;;;;;;eAKT,SAAS;;;;;;;8BAET,SAAS;;6BAMT;IAAE,GAAG,EAAE,gBAAgB,GAAG;QAAE,eAAe,EAAE,KAAK,CAAA;KAAE,CAAA;CAAE"}