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

package/src/vaultFactory/types.js

@@ -2,21 +2,30 @@
 
 /**
  * @typedef {import('./vault').VaultNotification} VaultNotification
+ *
  * @typedef {import('./vault').Vault} Vault
+ *
  * @typedef {import('./vaultKit').VaultKit} VaultKit
+ *
  * @typedef {import('./vaultManager').VaultManager} VaultManager
+ *
  * @typedef {import('./vaultManager').CollateralManager} CollateralManager
+ *
  * @typedef {import('../reserve/assetReserve.js').AssetReserveLimitedCreatorFacet} AssetReserveCreatorFacet
+ *
  * @typedef {import('../reserve/assetReserve.js').AssetReservePublicFacet} AssetReservePublicFacet
+ *
  * @typedef {import('../auction/auctioneer.js').AuctioneerPublicFacet} AuctioneerPublicFacet
+ *
  * @typedef {import('./vaultFactory.js').VaultFactoryContract['publicFacet']} VaultFactoryPublicFacet
  *
  * @typedef {import('@agoric/time/src/types').Timestamp} Timestamp
+ *
  * @typedef {import('@agoric/time/src/types').RelativeTime} RelativeTime
  */
 
 /**
- * @typedef  {object} AutoswapLocal
+ * @typedef {object} AutoswapLocal
  * @property {(amount: Amount, brand: Brand) => Amount} getInputPrice
  * @property {() => Invitation} makeSwapInvitation
  */
@@ -24,13 +33,16 @@
 /**
  * @typedef {object} VaultManagerParamValues
  * @property {Ratio} liquidationMargin - margin below which collateral will be
- * liquidated to satisfy the debt.
- * @property {Ratio} liquidationPenalty - penalty charged upon liquidation as proportion of debt
- * @property {Ratio} stabilityFee - annual interest rate charged on debt positions
- * @property {Ratio} mintFee - The fee (in BasisPoints) charged when creating
- * or increasing a debt position.
+ *   liquidated to satisfy the debt.
+ * @property {Ratio} liquidationPenalty - penalty charged upon liquidation as
+ *   proportion of debt
+ * @property {Ratio} stabilityFee - annual interest rate charged on debt
+ *   positions
+ * @property {Ratio} mintFee - The fee (in BasisPoints) charged when creating or
+ *   increasing a debt position.
  * @property {Amount<'nat'>} debtLimit
- * @property {Ratio} [liquidationPadding] - vault must maintain this in order to remove collateral or add debt
+ * @property {Ratio} [liquidationPadding] - vault must maintain this in order to
+ *   remove collateral or add debt
  */
 
 /**
@@ -42,7 +54,7 @@
  */
 
 /**
- * @typedef  {object} VaultFactoryCreatorFacet
+ * @typedef {object} VaultFactoryCreatorFacet
  * @property {AddVaultType} addVaultType
  * @property {() => Allocation} getRewardAllocation
  * @property {() => Promise<Invitation<string, never>>} makeCollectFeesInvitation
@@ -51,10 +63,10 @@
  */
 
 /**
- * @callback MintAndTransfer
- * 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.
+ * @callback MintAndTransfer 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.
  * @param {ZCFSeat} mintReceiver
  * @param {Amount<'nat'>} toMint
  * @param {Amount<'nat'>} fee
@@ -63,11 +75,8 @@
  */
 
 /**
- * @callback BurnDebt
- *
- * Burn debt tokens off a seat and update
- * the `totalDebt` if the reallocate succeeds.
- *
+ * @callback BurnDebt Burn debt tokens off a seat and update the `totalDebt` if
+ *   the reallocate succeeds.
  * @param {Amount} toBurn
  * @param {ZCFSeat} fromSeat
  * @returns {void}
@@ -78,16 +87,15 @@
  * @property {() => Ratio} getLiquidationMargin
  * @property {() => Ratio} getMintFee
  * @property {() => Promise<PriceQuote>} getCollateralQuote
- * @property {() => Ratio} getStabilityFee - The annual interest rate on a debt position
+ * @property {() => Ratio} getStabilityFee - The annual interest rate on a debt
+ *   position
  * @property {() => RelativeTime} getChargingPeriod - The period (in seconds) at
  *   which interest is charged to the debt position.
  * @property {() => RelativeTime} getRecordingPeriod - The period (in seconds)
  *   at which interest is recorded to the debt position.
  */
 
-/**
- * @typedef {string} VaultId
- */
+/** @typedef {string} VaultId */
 
 /**
  * @typedef {object} InterestTiming
@@ -104,7 +112,9 @@
 
 /**
  * @typedef {object} Liquidator
- * @property {() => Promise<Invitation<void, { debt: Amount<'nat'>; penaltyRate: Ratio; }>>} makeLiquidateInvitation
+ * @property {() => Promise<
+ *   Invitation<void, { debt: Amount<'nat'>; penaltyRate: Ratio }>
+ * >} makeLiquidateInvitation
  */
 
 /**
@@ -124,11 +134,11 @@
 /**
  * @typedef {object} CalculatorKit
  * @property {Calculate} calculate calculate new debt for charging periods up to
- * the present.
+ *   the present.
  * @property {Calculate} calculateReportingPeriod calculate new debt for
- * reporting periods up to the present. If some charging periods have elapsed
- * that don't constitute whole reporting periods, the time is not updated past
- * them and interest is not accumulated for them.
+ *   reporting periods up to the present. If some charging periods have elapsed
+ *   that don't constitute whole reporting periods, the time is not updated past
+ *   them and interest is not accumulated for them.
  */
 
-/** @typedef {{key: 'governedParams' | {collateralBrand: Brand}}} VaultFactoryParamPath */
+/** @typedef {{ key: 'governedParams' | { collateralBrand: Brand } }} VaultFactoryParamPath */

package/src/vaultFactory/vault.d.ts

@@ -10,7 +10,8 @@ export namespace Phase {
  *
  * @typedef {object} VaultNotification
  * @property {Amount<'nat'>} locked Amount of Collateral locked
- * @property {{debt: Amount<'nat'>, stabilityFee: Ratio}} debtSnapshot 'debt' at the point the compounded stabilityFee was 'stabilityFee'
+ * @property {{ debt: Amount<'nat'>; stabilityFee: Ratio }} debtSnapshot 'debt'
+ *   at the point the compounded stabilityFee was 'stabilityFee'
  * @property {HolderPhase} vaultState
  */
 /**
@@ -23,25 +24,34 @@ export namespace Phase {
  * @property {MintAndTransfer} mintAndTransfer
  * @property {(amount: Amount, seat: ZCFSeat) => void} burn
  * @property {() => Ratio} getCompoundedStabilityFee
- * @property {(oldDebt: import('./storeUtils.js').NormalizedDebt, oldCollateral: Amount<'nat'>, vaultId: VaultId, vaultPhase: VaultPhase, vault: Vault) => void} handleBalanceChange
+ * @property {(
+ *   oldDebt: import('./storeUtils.js').NormalizedDebt,
+ *   oldCollateral: Amount<'nat'>,
+ *   vaultId: VaultId,
+ *   vaultPhase: VaultPhase,
+ *   vault: Vault,
+ * ) => void} handleBalanceChange
  * @property {() => import('./vaultManager.js').GovernedParamGetters} getGovernedParams
  */
 /**
  * @typedef {Readonly<{
- * idInManager: VaultId,
- * manager: VaultManager,
- * storageNode: StorageNode,
- * vaultSeat: ZCFSeat,
+ *   idInManager: VaultId;
+ *   manager: VaultManager;
+ *   storageNode: StorageNode;
+ *   vaultSeat: ZCFSeat;
  * }>} ImmutableState
  */
 /**
- * Snapshot is of the debt and compounded interest when the principal was last changed.
+ * Snapshot is of the debt and compounded interest when the principal was last
+ * changed.
  *
  * @typedef {{
- *   stabilityFeeSnapshot: Ratio,
- *   phase: VaultPhase,
- *   debtSnapshot: Amount<'nat'>,
- *   outerUpdater: import('@agoric/zoe/src/contractSupport/recorder.js').Recorder<VaultNotification> | null,
+ *   stabilityFeeSnapshot: Ratio;
+ *   phase: VaultPhase;
+ *   debtSnapshot: Amount<'nat'>;
+ *   outerUpdater:
+ *     | import('@agoric/zoe/src/contractSupport/recorder.js').Recorder<VaultNotification>
+ *     | null;
  * }} MutableState
  */
 export const VaultI: import("@endo/patterns").InterfaceGuard<{
@@ -64,7 +74,10 @@ export function prepareVault(baggage: MapStore<string, unknown>, makeRecorderKit
         emptyCollateral(): Amount<"nat">;
         emptyDebt(): Amount<"nat">;
         /**
-         * @typedef {{ give: { Collateral: Amount<'nat'>, Minted: Amount<'nat'> }, want: { Collateral: Amount<'nat'>, Minted: Amount<'nat'> } }} FullProposal
+         * @typedef {{
+         *   give: { Collateral: Amount<'nat'>; Minted: Amount<'nat'> };
+         *   want: { Collateral: Amount<'nat'>; Minted: Amount<'nat'> };
+         * }} FullProposal
          */
         /**
          * @param {ProposalRecord} partial
@@ -80,9 +93,7 @@ export function prepareVault(baggage: MapStore<string, unknown>, makeRecorderKit
                 Minted: Amount<'nat'>;
             };
         };
-        /**
-         * @param {VaultPhase} newPhase
-         */
+        /** @param {VaultPhase} newPhase */
         assignPhase(newPhase: VaultPhase): void;
         assertActive(): void;
         assertCloseable(): void;
@@ -94,31 +105,26 @@ export function prepareVault(baggage: MapStore<string, unknown>, makeRecorderKit
          */
         updateDebtSnapshot(newDebt: Amount<'nat'>): void;
         /**
-         * Update the debt balance and propagate upwards to
-         * maintain aggregate debt and liquidation order.
+         * Update the debt balance and propagate upwards to maintain aggregate
+         * debt and liquidation order.
          *
-         * @param {NormalizedDebt} oldDebtNormalized - prior principal and all accrued interest, normalized to the launch of the vaultManager
+         * @param {NormalizedDebt} oldDebtNormalized - prior principal and all
+         *   accrued interest, normalized to the launch of the vaultManager
          * @param {Amount<'nat'>} oldCollateral - actual collateral
-         * @param {Amount<'nat'>} newDebtActual - actual principal and all accrued interest
+         * @param {Amount<'nat'>} newDebtActual - actual principal and all
+         *   accrued interest
          */
         updateDebtAccounting(oldDebtNormalized: NormalizedDebt, oldCollateral: Amount<'nat'>, newDebtActual: Amount<'nat'>): void;
-        /**
-         *
-         * @param {ZCFSeat} seat
-         */
+        /** @param {ZCFSeat} seat */
         getCollateralAllocated(seat: ZCFSeat): Amount<any>;
         getMintedAllocated(seat: any): any;
         assertVaultHoldsNoMinted(): void;
         /**
-         *
          * @param {Amount<'nat'>} collateralAmount
          * @param {Amount<'nat'>} proposedDebt
          */
         assertSufficientCollateral(collateralAmount: Amount<'nat'>, proposedDebt: Amount<'nat'>): void;
-        /**
-         *
-         * @param {HolderPhase} newPhase
-         */
+        /** @param {HolderPhase} newPhase */
         getStateSnapshot(newPhase: HolderPhase): {
             debtSnapshot: {
                 debt: Amount<"nat">;
@@ -127,20 +133,16 @@ export function prepareVault(baggage: MapStore<string, unknown>, makeRecorderKit
             locked: Amount<"nat">;
             vaultState: HolderPhase;
         };
-        /**
-         * call this whenever anything changes!
-         */
+        /** call this whenever anything changes! */
         updateUiState(): void;
-        /**
-         * @param {ZCFSeat} seat
-         */
+        /** @param {ZCFSeat} seat */
         closeHook(seat: ZCFSeat): Promise<string>;
         /**
-         * 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'>} giveAmount
@@ -160,7 +162,6 @@ export function prepareVault(baggage: MapStore<string, unknown>, makeRecorderKit
          */
         adjustBalancesHook(clientSeat: ZCFSeat): string;
         /**
-         *
          * @param {ZCFSeat} clientSeat
          * @param {FullProposal} fp
          * @param {ReturnType<typeof calculateDebtCosts>} costs
@@ -183,7 +184,6 @@ export function prepareVault(baggage: MapStore<string, unknown>, makeRecorderKit
             collateralPre: Amount<'nat'>;
         }): string;
         /**
-         *
          * @param {ZCFSeat} seat
          * @returns {VaultKit}
          */
@@ -221,35 +221,15 @@ export function prepareVault(baggage: MapStore<string, unknown>, makeRecorderKit
                 makeTransferInvitation(): Promise<Invitation<R, A>>;
                 getCollateralAmount(): Amount<"nat">;
                 getCurrentDebt(): Amount<"nat">;
-                /**
-                 * @typedef {Readonly<{
-                 * idInManager: VaultId,
-                 * manager: VaultManager,
-                 * storageNode: StorageNode,
-                 * vaultSeat: ZCFSeat,
-                 * }>} ImmutableState
-                 */
-                /**
-                 * Snapshot is of the debt and compounded interest when the principal was last changed.
-                 *
-                 * @typedef {{
-                 *   stabilityFeeSnapshot: Ratio,
-                 *   phase: VaultPhase,
-                 *   debtSnapshot: Amount<'nat'>,
-                 *   outerUpdater: import('@agoric/zoe/src/contractSupport/recorder.js').Recorder<VaultNotification> | null,
-                 * }} MutableState
-                 */
                 getNormalizedDebt(): import("./storeUtils.js").NormalizedDebt;
             };
             vaultUpdater: import("@agoric/zoe/src/contractSupport/recorder.js").Recorder<VaultNotification>;
         }>;
-        /**
-         * Called by manager at start of liquidation.
-         */
+        /** Called by manager at start of liquidation. */
         liquidating(): void;
         /**
-         * Called by manager at end of liquidation, at which point all debts have been
-         * covered.
+         * Called by manager at end of liquidation, at which point all debts
+         * have been covered.
          */
         liquidated(): void;
         /**
@@ -261,38 +241,34 @@ export function prepareVault(baggage: MapStore<string, unknown>, makeRecorderKit
         abortLiquidation(): string;
         makeAdjustBalancesInvitation(): Promise<Invitation<R, A>>;
         makeCloseInvitation(): Promise<Invitation<R, A>>;
-        /**
-         * @returns {Promise<Invitation>}
-         */
+        /** @returns {Promise<Invitation>} */
         makeTransferInvitation(): Promise<Invitation>;
-        /**
-         *
-         * @returns {Amount<'nat'>}
-         */
+        /** @returns {Amount<'nat'>} */
         getCollateralAmount(): Amount<'nat'>;
         /**
          * The actual current debt, including accrued interest.
          *
-         * This looks like a simple getter but it does a lot of the heavy lifting for
-         * interest accrual. Rather than updating all records when interest accrues,
-         * the vault manager updates just its rolling compounded interest. Here we
-         * calculate what the current debt is given what's recorded in this vault and
-         * what interest has compounded since this vault record was written.
-         *
-         * @see getNormalizedDebt
+         * This looks like a simple getter but it does a lot of the heavy
+         * lifting for interest accrual. Rather than updating all records when
+         * interest accrues, the vault manager updates just its rolling
+         * compounded interest. Here we calculate what the current debt is given
+         * what's recorded in this vault and what interest has compounded since
+         * this vault record was written.
          *
          * @returns {Amount<'nat'>}
+         * @see getNormalizedDebt
          */
         getCurrentDebt(): Amount<'nat'>;
         /**
-         * The normalization puts all debts on a common time-independent scale since
-         * the launch of this vault manager. This allows the manager to order vaults
-         * by their debt-to-collateral ratios without having to mutate the debts as
-         * the interest accrues.
+         * The normalization puts all debts on a common time-independent scale
+         * since the launch of this vault manager. This allows the manager to
+         * order vaults by their debt-to-collateral ratios without having to
+         * mutate the debts as the interest accrues.
          *
+         * @returns {import('./storeUtils.js').NormalizedDebt} as if the vault
+         *   was open at the launch of this manager, before any interest
+         *   accrued
          * @see getActualDebAmount
-         *
-         * @returns {import('./storeUtils.js').NormalizedDebt} as if the vault was open at the launch of this manager, before any interest accrued
          */
         getNormalizedDebt(): import('./storeUtils.js').NormalizedDebt;
     };
@@ -303,7 +279,10 @@ export function prepareVault(baggage: MapStore<string, unknown>, makeRecorderKit
         emptyCollateral(): Amount<"nat">;
         emptyDebt(): Amount<"nat">;
         /**
-         * @typedef {{ give: { Collateral: Amount<'nat'>, Minted: Amount<'nat'> }, want: { Collateral: Amount<'nat'>, Minted: Amount<'nat'> } }} FullProposal
+         * @typedef {{
+         *   give: { Collateral: Amount<'nat'>; Minted: Amount<'nat'> };
+         *   want: { Collateral: Amount<'nat'>; Minted: Amount<'nat'> };
+         * }} FullProposal
          */
         /**
          * @param {ProposalRecord} partial
@@ -319,9 +298,7 @@ export function prepareVault(baggage: MapStore<string, unknown>, makeRecorderKit
                 Minted: Amount<'nat'>;
             };
         };
-        /**
-         * @param {VaultPhase} newPhase
-         */
+        /** @param {VaultPhase} newPhase */
         assignPhase(newPhase: VaultPhase): void;
         assertActive(): void;
         assertCloseable(): void;
@@ -333,31 +310,26 @@ export function prepareVault(baggage: MapStore<string, unknown>, makeRecorderKit
          */
         updateDebtSnapshot(newDebt: Amount<'nat'>): void;
         /**
-         * Update the debt balance and propagate upwards to
-         * maintain aggregate debt and liquidation order.
+         * Update the debt balance and propagate upwards to maintain aggregate
+         * debt and liquidation order.
          *
-         * @param {NormalizedDebt} oldDebtNormalized - prior principal and all accrued interest, normalized to the launch of the vaultManager
+         * @param {NormalizedDebt} oldDebtNormalized - prior principal and all
+         *   accrued interest, normalized to the launch of the vaultManager
          * @param {Amount<'nat'>} oldCollateral - actual collateral
-         * @param {Amount<'nat'>} newDebtActual - actual principal and all accrued interest
+         * @param {Amount<'nat'>} newDebtActual - actual principal and all
+         *   accrued interest
          */
         updateDebtAccounting(oldDebtNormalized: NormalizedDebt, oldCollateral: Amount<'nat'>, newDebtActual: Amount<'nat'>): void;
-        /**
-         *
-         * @param {ZCFSeat} seat
-         */
+        /** @param {ZCFSeat} seat */
         getCollateralAllocated(seat: ZCFSeat): Amount<any>;
         getMintedAllocated(seat: any): any;
         assertVaultHoldsNoMinted(): void;
         /**
-         *
          * @param {Amount<'nat'>} collateralAmount
          * @param {Amount<'nat'>} proposedDebt
          */
         assertSufficientCollateral(collateralAmount: Amount<'nat'>, proposedDebt: Amount<'nat'>): void;
-        /**
-         *
-         * @param {HolderPhase} newPhase
-         */
+        /** @param {HolderPhase} newPhase */
         getStateSnapshot(newPhase: HolderPhase): {
             debtSnapshot: {
                 debt: Amount<"nat">;
@@ -366,20 +338,16 @@ export function prepareVault(baggage: MapStore<string, unknown>, makeRecorderKit
             locked: Amount<"nat">;
             vaultState: HolderPhase;
         };
-        /**
-         * call this whenever anything changes!
-         */
+        /** call this whenever anything changes! */
         updateUiState(): void;
-        /**
-         * @param {ZCFSeat} seat
-         */
+        /** @param {ZCFSeat} seat */
         closeHook(seat: ZCFSeat): Promise<string>;
         /**
-         * 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'>} giveAmount
@@ -399,7 +367,6 @@ export function prepareVault(baggage: MapStore<string, unknown>, makeRecorderKit
          */
         adjustBalancesHook(clientSeat: ZCFSeat): string;
         /**
-         *
          * @param {ZCFSeat} clientSeat
          * @param {FullProposal} fp
          * @param {ReturnType<typeof calculateDebtCosts>} costs
@@ -422,7 +389,6 @@ export function prepareVault(baggage: MapStore<string, unknown>, makeRecorderKit
             collateralPre: Amount<'nat'>;
         }): string;
         /**
-         *
          * @param {ZCFSeat} seat
          * @returns {VaultKit}
          */
@@ -460,35 +426,15 @@ export function prepareVault(baggage: MapStore<string, unknown>, makeRecorderKit
                 makeTransferInvitation(): Promise<Invitation<R, A>>;
                 getCollateralAmount(): Amount<"nat">;
                 getCurrentDebt(): Amount<"nat">;
-                /**
-                 * @typedef {Readonly<{
-                 * idInManager: VaultId,
-                 * manager: VaultManager,
-                 * storageNode: StorageNode,
-                 * vaultSeat: ZCFSeat,
-                 * }>} ImmutableState
-                 */
-                /**
-                 * Snapshot is of the debt and compounded interest when the principal was last changed.
-                 *
-                 * @typedef {{
-                 *   stabilityFeeSnapshot: Ratio,
-                 *   phase: VaultPhase,
-                 *   debtSnapshot: Amount<'nat'>,
-                 *   outerUpdater: import('@agoric/zoe/src/contractSupport/recorder.js').Recorder<VaultNotification> | null,
-                 * }} MutableState
-                 */
                 getNormalizedDebt(): import("./storeUtils.js").NormalizedDebt;
             };
             vaultUpdater: import("@agoric/zoe/src/contractSupport/recorder.js").Recorder<VaultNotification>;
         }>;
-        /**
-         * Called by manager at start of liquidation.
-         */
+        /** Called by manager at start of liquidation. */
         liquidating(): void;
         /**
-         * Called by manager at end of liquidation, at which point all debts have been
-         * covered.
+         * Called by manager at end of liquidation, at which point all debts
+         * have been covered.
          */
         liquidated(): void;
         /**
@@ -500,38 +446,34 @@ export function prepareVault(baggage: MapStore<string, unknown>, makeRecorderKit
         abortLiquidation(): string;
         makeAdjustBalancesInvitation(): Promise<Invitation<R, A>>;
         makeCloseInvitation(): Promise<Invitation<R, A>>;
-        /**
-         * @returns {Promise<Invitation>}
-         */
+        /** @returns {Promise<Invitation>} */
         makeTransferInvitation(): Promise<Invitation>;
-        /**
-         *
-         * @returns {Amount<'nat'>}
-         */
+        /** @returns {Amount<'nat'>} */
         getCollateralAmount(): Amount<'nat'>;
         /**
          * The actual current debt, including accrued interest.
          *
-         * This looks like a simple getter but it does a lot of the heavy lifting for
-         * interest accrual. Rather than updating all records when interest accrues,
-         * the vault manager updates just its rolling compounded interest. Here we
-         * calculate what the current debt is given what's recorded in this vault and
-         * what interest has compounded since this vault record was written.
-         *
-         * @see getNormalizedDebt
+         * This looks like a simple getter but it does a lot of the heavy
+         * lifting for interest accrual. Rather than updating all records when
+         * interest accrues, the vault manager updates just its rolling
+         * compounded interest. Here we calculate what the current debt is given
+         * what's recorded in this vault and what interest has compounded since
+         * this vault record was written.
          *
          * @returns {Amount<'nat'>}
+         * @see getNormalizedDebt
          */
         getCurrentDebt(): Amount<'nat'>;
         /**
-         * The normalization puts all debts on a common time-independent scale since
-         * the launch of this vault manager. This allows the manager to order vaults
-         * by their debt-to-collateral ratios without having to mutate the debts as
-         * the interest accrues.
+         * The normalization puts all debts on a common time-independent scale
+         * since the launch of this vault manager. This allows the manager to
+         * order vaults by their debt-to-collateral ratios without having to
+         * mutate the debts as the interest accrues.
          *
+         * @returns {import('./storeUtils.js').NormalizedDebt} as if the vault
+         *   was open at the launch of this manager, before any interest
+         *   accrued
          * @see getActualDebAmount
-         *
-         * @returns {import('./storeUtils.js').NormalizedDebt} as if the vault was open at the launch of this manager, before any interest accrued
          */
         getNormalizedDebt(): import('./storeUtils.js').NormalizedDebt;
     };
@@ -557,7 +499,8 @@ export type VaultNotification = {
      */
     locked: Amount<'nat'>;
     /**
-     * 'debt' at the point the compounded stabilityFee was 'stabilityFee'
+     * 'debt'
+     * at the point the compounded stabilityFee was 'stabilityFee'
      */
     debtSnapshot: {
         debt: Amount<'nat'>;
@@ -584,7 +527,8 @@ export type ImmutableState = Readonly<{
     vaultSeat: ZCFSeat;
 }>;
 /**
- * Snapshot is of the debt and compounded interest when the principal was last changed.
+ * Snapshot is of the debt and compounded interest when the principal was last
+ * changed.
  */
 export type MutableState = {
     stabilityFeeSnapshot: Ratio;

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

@@ -1 +1 @@
-{"version":3,"file":"vault.d.ts","sourceRoot":"","sources":["vault.js"],"names":[],"mappings":";;;;;;;AAqEA;;;;;;;GAOG;AAGH;;;;;;;;;;;;GAYG;AAEH;;;;;;;GAOG;AAEH;;;;;;;;;GASG;AAEH;;;;;;;;;;;;GAYG;AAkBI,kFAHI,OAAO,6CAA6C,EAAE,eAAe,OACrE,GAAG;;;;;;QAuDN;;WAEG;QACH;;;WAGG;8BAFQ,cAAc;kBAHJ;gBAAE,UAAU,EAAE,OAAO,KAAK,CAAC,CAAC;gBAAC,MAAM,EAAE,OAAO,KAAK,CAAC,CAAA;aAAE;kBAAQ;gBAAE,UAAU,EAAE,OAAO,KAAK,CAAC,CAAC;gBAAC,MAAM,EAAE,OAAO,KAAK,CAAC,CAAA;aAAE;;QAyBrI;;WAEG;8BADQ,UAAU;;;QAyBrB;;;;;WAKG;oCADQ,OAAO,KAAK,CAAC;QAWxB;;;;;;;WAOG;gDAHQ,cAAc,iBACd,OAAO,KAAK,CAAC,iBACb,OAAO,KAAK,CAAC;QAgBxB;;;WAGG;qCADQ,OAAO;;;QAsBlB;;;;WAIG;qDAFQ,OAAO,KAAK,CAAC,gBACb,OAAO,KAAK,CAAC;QAWxB;;;WAGG;mCADQ,WAAW;;;;;;;;QAiBtB;;WAEG;;QA4BH;;WAEG;wBADQ,OAAO;QAsElB;;;;;;;;;;WAUG;6BAHQ,OAAO,KAAK,CAAC,cACb,OAAO,KAAK,CAAC,cACb,OAAO,KAAK,CAAC;;;;;;QAaxB;;;;;WAKG;uCAFQ,OAAO,GACL,MAAM;QAwDnB;;;;;;;;;WASG;4CAPQ,OAAO;kBA1UG;gBAAE,UAAU,EAAE,OAAO,KAAK,CAAC,CAAC;gBAAC,MAAM,EAAE,OAAO,KAAK,CAAC,CAAA;aAAE;kBAAQ;gBAAE,UAAU,EAAE,OAAO,KAAK,CAAC,CAAC;gBAAC,MAAM,EAAE,OAAO,KAAK,CAAC,CAAA;aAAE;8CA4U1H,WAAW,yBAAyB,CAAC;YAEV,iBAAiB,EAA5C,cAAc;YACY,aAAa,EAAvC,OAAO,KAAK,CAAC;YACX,MAAM;QAsCnB;;;;WAIG;yCAFQ,OAAO,GACL,QAAQ;;;;QAsBrB;;;WAGG;2BAFQ,OAAO,eACP,WAAW;;;;;;;;;;;;;;;;;;;;;;;;;;gBAzf9B;;;;;;;mBAOG;gBAEH;;;;;;;;;mBASG;;;;;QAkjBK;;WAEG;;QASH;;;WAGG;;QAcH;;;;;WAKG;;;;QAwEH;;WAEG;kCADU,QAAQ,UAAU,CAAC;QAiChC;;;WAGG;+BADU,OAAO,KAAK,CAAC;QAY1B;;;;;;;;;;;;WAYG;0BADU,OAAO,KAAK,CAAC;QAW1B;;;;;;;;;WASG;6BADU,OAAO,iBAAiB,EAAE,cAAc;;;;;;;;QAppBrD;;WAEG;QACH;;;WAGG;8BAFQ,cAAc;kBAHJ;gBAAE,UAAU,EAAE,OAAO,KAAK,CAAC,CAAC;gBAAC,MAAM,EAAE,OAAO,KAAK,CAAC,CAAA;aAAE;kBAAQ;gBAAE,UAAU,EAAE,OAAO,KAAK,CAAC,CAAC;gBAAC,MAAM,EAAE,OAAO,KAAK,CAAC,CAAA;aAAE;;QAyBrI;;WAEG;8BADQ,UAAU;;;QAyBrB;;;;;WAKG;oCADQ,OAAO,KAAK,CAAC;QAWxB;;;;;;;WAOG;gDAHQ,cAAc,iBACd,OAAO,KAAK,CAAC,iBACb,OAAO,KAAK,CAAC;QAgBxB;;;WAGG;qCADQ,OAAO;;;QAsBlB;;;;WAIG;qDAFQ,OAAO,KAAK,CAAC,gBACb,OAAO,KAAK,CAAC;QAWxB;;;WAGG;mCADQ,WAAW;;;;;;;;QAiBtB;;WAEG;;QA4BH;;WAEG;wBADQ,OAAO;QAsElB;;;;;;;;;;WAUG;6BAHQ,OAAO,KAAK,CAAC,cACb,OAAO,KAAK,CAAC,cACb,OAAO,KAAK,CAAC;;;;;;QAaxB;;;;;WAKG;uCAFQ,OAAO,GACL,MAAM;QAwDnB;;;;;;;;;WASG;4CAPQ,OAAO;kBA1UG;gBAAE,UAAU,EAAE,OAAO,KAAK,CAAC,CAAC;gBAAC,MAAM,EAAE,OAAO,KAAK,CAAC,CAAA;aAAE;kBAAQ;gBAAE,UAAU,EAAE,OAAO,KAAK,CAAC,CAAC;gBAAC,MAAM,EAAE,OAAO,KAAK,CAAC,CAAA;aAAE;8CA4U1H,WAAW,yBAAyB,CAAC;YAEV,iBAAiB,EAA5C,cAAc;YACY,aAAa,EAAvC,OAAO,KAAK,CAAC;YACX,MAAM;QAsCnB;;;;WAIG;yCAFQ,OAAO,GACL,QAAQ;;;;QAsBrB;;;WAGG;2BAFQ,OAAO,eACP,WAAW;;;;;;;;;;;;;;;;;;;;;;;;;;gBAzf9B;;;;;;;mBAOG;gBAEH;;;;;;;;;mBASG;;;;;QAkjBK;;WAEG;;QASH;;;WAGG;;QAcH;;;;;WAKG;;;;QAwEH;;WAEG;kCADU,QAAQ,UAAU,CAAC;QAiChC;;;WAGG;+BADU,OAAO,KAAK,CAAC;QAY1B;;;;;;;;;;;;WAYG;0BADU,OAAO,KAAK,CAAC;QAW1B;;;;;;;;;WASG;6BADU,OAAO,iBAAiB,EAAE,cAAc;;GAiB5D;6BAp1Ba,OAAO,iBAAiB,EAAE,cAAc;yBAsCzC;;;;;;EAAM,MAAM,KAAK,YAAY,EAAE,UAAU,CAAC,CAAC;0BAW3C;;;;;;EAAM,MAAM,YAAY,CAAC;;;;;YAGxB,OAAO,KAAK,CAAC;;;;kBACb;QAAC,IAAI,EAAE,OAAO,KAAK,CAAC,CAAC;QAAC,YAAY,EAAE,KAAK,CAAA;KAAC;gBAC1C,WAAW;;;wBAMX,MAAM,WAAW,OAAO,gBAAgB,EAAE,UAAU,CAAC;mCAClC,MAAM,KAAK,OAAO,KAAK,CAAC;wBAC3C,MAAM,KAAK;6BACJ,MAAM,KAAK,MAAM;kBACxB,MAAM,MAAM,KAAK,CAAC;qBAClB,eAAe;mBACN,MAAM,QAAQ,OAAO,KAAK,IAAI;+BACvC,MAAM,KAAK;mCACD,OAAO,iBAAiB,EAAE,cAAc,iBAAiB,OAAO,KAAK,CAAC,WAAW,OAAO,cAAc,UAAU,SAAS,KAAK,KAAK,IAAI;uBACjJ,MAAM,OAAO,mBAAmB,EAAE,oBAAoB;;6BAIvD,SAAS;IACrB,WAAa,EAAE,OAAO,CAAC;IACvB,OAAS,EAAE,YAAY,CAAC;IACxB,WAAa,EAAE,WAAW,CAAC;IAC3B,SAAW,EAAE,OAAO,CAAC;CAClB,CAAC;;;;2BAMQ;IACZ,oBAAwB,EAAE,KAAK,CAAC;IAChC,KAAS,EAAE,UAAU,CAAC;IACtB,YAAgB,EAAE,OAAO,KAAK,CAAC,CAAC;IAChC,YAAgB,EAAE,OAAO,6CAA6C,EAAE,QAAQ,CAAC,iBAAiB,CAAC,GAAG,IAAI,CAAC;CACxG;oBA6vBU,WAAW,WAAW,mBAAmB,CAAC,CAAC,CAAC,MAAM,CAAC;mCA51B9B,WAAW"}
+{"version":3,"file":"vault.d.ts","sourceRoot":"","sources":["vault.js"],"names":[],"mappings":";;;;;;;AA0EA;;;;;;;;GAQG;AAGH;;;;;;;;;;;;;;;;;;GAkBG;AAEH;;;;;;;GAOG;AAEH;;;;;;;;;;;;GAYG;AAEH;;;;;;;;;;;;GAYG;AAkBI,kFAHI,OAAO,6CAA6C,EAAE,eAAe,OACrE,GAAG;;;;;;QAuDN;;;;;WAKG;QACH;;;WAGG;8BAFQ,cAAc;kBALd;gBAAE,UAAU,EAAE,OAAO,KAAK,CAAC,CAAC;gBAAC,MAAM,EAAE,OAAO,KAAK,CAAC,CAAA;aAAE;kBACpD;gBAAE,UAAU,EAAE,OAAO,KAAK,CAAC,CAAC;gBAAC,MAAM,EAAE,OAAO,KAAK,CAAC,CAAA;aAAE;;QA0B/D,mCAAmC;8BAAvB,UAAU;;;QAwBtB;;;;;WAKG;oCADQ,OAAO,KAAK,CAAC;QAWxB;;;;;;;;;WASG;gDALQ,cAAc,iBAEd,OAAO,KAAK,CAAC,iBACb,OAAO,KAAK,CAAC;QAiBxB,4BAA4B;qCAAhB,OAAO;;;QAqBnB;;;WAGG;qDAFQ,OAAO,KAAK,CAAC,gBACb,OAAO,KAAK,CAAC;QAWxB,oCAAoC;mCAAxB,WAAW;;;;;;;;QAgBvB,2CAA2C;;QA4B3C,4BAA4B;wBAAhB,OAAO;QAqEnB;;;;;;;;;;WAUG;6BAHQ,OAAO,KAAK,CAAC,cACb,OAAO,KAAK,CAAC,cACb,OAAO,KAAK,CAAC;;;;;;QAaxB;;;;;WAKG;uCAFQ,OAAO,GACL,MAAM;QAwDnB;;;;;;;;WAQG;4CAPQ,OAAO;kBAhUP;gBAAE,UAAU,EAAE,OAAO,KAAK,CAAC,CAAC;gBAAC,MAAM,EAAE,OAAO,KAAK,CAAC,CAAA;aAAE;kBACpD;gBAAE,UAAU,EAAE,OAAO,KAAK,CAAC,CAAC;gBAAC,MAAM,EAAE,OAAO,KAAK,CAAC,CAAA;aAAE;8CAiUpD,WAAW,yBAAyB,CAAC;YAEV,iBAAiB,EAA5C,cAAc;YACY,aAAa,EAAvC,OAAO,KAAK,CAAC;YACX,MAAM;QAsCnB;;;WAGG;yCAFQ,OAAO,GACL,QAAQ;;;;QAsBrB;;;WAGG;2BAFQ,OAAO,eACP,WAAW;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;QA2EtB,iDAAiD;;QASjD;;;WAGG;;QAcH;;;;;WAKG;;;;QAwEH,qCAAqC;kCAAvB,QAAQ,UAAU,CAAC;QAgCjC,+BAA+B;+BAAjB,OAAO,KAAK,CAAC;QAW3B;;;;;;;;;;;;WAYG;0BAFU,OAAO,KAAK,CAAC;QAY1B;;;;;;;;;;WAUG;6BAJU,OAAO,iBAAiB,EAAE,cAAc;;;;;;;;QAjoBrD;;;;;WAKG;QACH;;;WAGG;8BAFQ,cAAc;kBALd;gBAAE,UAAU,EAAE,OAAO,KAAK,CAAC,CAAC;gBAAC,MAAM,EAAE,OAAO,KAAK,CAAC,CAAA;aAAE;kBACpD;gBAAE,UAAU,EAAE,OAAO,KAAK,CAAC,CAAC;gBAAC,MAAM,EAAE,OAAO,KAAK,CAAC,CAAA;aAAE;;QA0B/D,mCAAmC;8BAAvB,UAAU;;;QAwBtB;;;;;WAKG;oCADQ,OAAO,KAAK,CAAC;QAWxB;;;;;;;;;WASG;gDALQ,cAAc,iBAEd,OAAO,KAAK,CAAC,iBACb,OAAO,KAAK,CAAC;QAiBxB,4BAA4B;qCAAhB,OAAO;;;QAqBnB;;;WAGG;qDAFQ,OAAO,KAAK,CAAC,gBACb,OAAO,KAAK,CAAC;QAWxB,oCAAoC;mCAAxB,WAAW;;;;;;;;QAgBvB,2CAA2C;;QA4B3C,4BAA4B;wBAAhB,OAAO;QAqEnB;;;;;;;;;;WAUG;6BAHQ,OAAO,KAAK,CAAC,cACb,OAAO,KAAK,CAAC,cACb,OAAO,KAAK,CAAC;;;;;;QAaxB;;;;;WAKG;uCAFQ,OAAO,GACL,MAAM;QAwDnB;;;;;;;;WAQG;4CAPQ,OAAO;kBAhUP;gBAAE,UAAU,EAAE,OAAO,KAAK,CAAC,CAAC;gBAAC,MAAM,EAAE,OAAO,KAAK,CAAC,CAAA;aAAE;kBACpD;gBAAE,UAAU,EAAE,OAAO,KAAK,CAAC,CAAC;gBAAC,MAAM,EAAE,OAAO,KAAK,CAAC,CAAA;aAAE;8CAiUpD,WAAW,yBAAyB,CAAC;YAEV,iBAAiB,EAA5C,cAAc;YACY,aAAa,EAAvC,OAAO,KAAK,CAAC;YACX,MAAM;QAsCnB;;;WAGG;yCAFQ,OAAO,GACL,QAAQ;;;;QAsBrB;;;WAGG;2BAFQ,OAAO,eACP,WAAW;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;QA2EtB,iDAAiD;;QASjD;;;WAGG;;QAcH;;;;;WAKG;;;;QAwEH,qCAAqC;kCAAvB,QAAQ,UAAU,CAAC;QAgCjC,+BAA+B;+BAAjB,OAAO,KAAK,CAAC;QAW3B;;;;;;;;;;;;WAYG;0BAFU,OAAO,KAAK,CAAC;QAY1B;;;;;;;;;;WAUG;6BAJU,OAAO,iBAAiB,EAAE,cAAc;;GAoB5D;6BAn1Ba,OAAO,iBAAiB,EAAE,cAAc;yBA2CzC;;;;;;EAAM,MAAM,KAAK,YAAY,EAAE,UAAU,CAAC,CAAC;0BAW3C;;;;;;EAAM,MAAM,YAAY,CAAC;;;;;YAGxB,OAAO,KAAK,CAAC;;;;;kBACb;QAAE,IAAI,EAAE,OAAO,KAAK,CAAC,CAAC;QAAC,YAAY,EAAE,KAAK,CAAA;KAAE;gBAE5C,WAAW;;;wBAMX,MAAM,WAAW,OAAO,gBAAgB,EAAE,UAAU,CAAC;mCAClC,MAAM,KAAK,OAAO,KAAK,CAAC;wBAC3C,MAAM,KAAK;6BACJ,MAAM,KAAK,MAAM;kBACxB,MAAM,MAAM,KAAK,CAAC;qBAClB,eAAe;mBACN,MAAM,QAAQ,OAAO,KAAK,IAAI;+BACvC,MAAM,KAAK;mCAEX,OAAO,iBAAiB,EAAE,cAAc,iBAClC,OAAO,KAAK,CAAC,WACnB,OAAO,cACJ,UAAU,SACf,KAAK,KACT,IAAI;uBACE,MAAM,OAAO,mBAAmB,EAAE,oBAAoB;;6BAIvD,SAAS;IACrB,WAAe,EAAE,OAAO,CAAC;IACzB,OAAW,EAAE,YAAY,CAAC;IAC1B,WAAe,EAAE,WAAW,CAAC;IAC7B,SAAa,EAAE,OAAO,CAAC;CACpB,CAAC;;;;;2BAOQ;IACZ,oBAAwB,EAAE,KAAK,CAAC;IAChC,KAAS,EAAE,UAAU,CAAC;IACtB,YAAgB,EAAE,OAAO,KAAK,CAAC,CAAC;IAChC,YAAgB,EACR,OAAO,6CAA6C,EAAE,QAAQ,CAAC,iBAAiB,CAAC,GACjF,IAAI,CAAC;CACV;oBA6uBU,WAAW,WAAW,mBAAmB,CAAC,CAAC,CAAC,MAAM,CAAC;mCA31B9B,WAAW"}