@agoric/inter-protocol 0.16.2-upgrade-14-dev-c8f9e7b.0 → 0.16.2-upgrade-16-fi-dev-8879538.0

package/src/vaultFactory/liquidation.d.ts

@@ -0,0 +1,163 @@
+export function setWakeupsForNextAuction(auctioneerPublicFacet: ERef<import("../auction/auctioneer.js").AuctioneerPublicFacet>, timer: globalThis.ERef<TimerService>, priceLockWaker: TimerWaker, liquidationWaker: TimerWaker, reschedulerWaker: TimerWaker): Promise<void>;
+export function liquidationResults(debt: Amount<"nat">, minted: Amount<"nat">): {
+    overage: Amount<"nat">;
+    shortfall: Amount<"nat">;
+};
+export function watchForGovernanceChange(auctioneerPublicFacet: ERef<import("../auction/auctioneer.js").AuctioneerPublicFacet>, timer: globalThis.ERef<TimerService>, reschedulerWaker: TimerWaker): void;
+export function getLiquidatableVaults(zcf: ZCF, collateralizationDetails: {
+    quote: PriceQuote;
+    interest: Ratio;
+    margin: Ratio;
+}, prioritizedVaults: ReturnType<typeof import("./prioritizedVaults.js").makePrioritizedVaults>, liquidatingVaults: globalThis.SetStore<import("@endo/exo").Guarded<{
+    getVaultSeat(): ZCFSeat;
+    initVaultKit(seat: ZCFSeat, storageNode: StorageNode): Promise<{
+        publicSubscribers: {
+            vault: {
+                description: string;
+                subscriber: globalThis.Subscriber<VaultNotification>;
+                storagePath: Promise<string>;
+            };
+        };
+        invitationMakers: import("@endo/exo").Guarded<{
+            AdjustBalances(): Promise<Invitation<string, undefined>>;
+            CloseVault(): Promise<Invitation<string, undefined>>;
+            TransferVault(): Promise<Invitation<any, undefined>>;
+        }>;
+        vault: import("@endo/exo").Guarded<{
+            getPublicTopics(): {
+                vault: {
+                    description: string;
+                    subscriber: globalThis.Subscriber<VaultNotification>;
+                    storagePath: Promise<string>;
+                };
+            };
+            makeAdjustBalancesInvitation(): Promise<Invitation<string, undefined>>;
+            makeCloseInvitation(): Promise<Invitation<string, undefined>>;
+            makeTransferInvitation(): Promise<Invitation<any, undefined>>;
+            getCollateralAmount(): import("@agoric/ertp/src/types.js").NatAmount;
+            getCurrentDebt(): import("@agoric/ertp/src/types.js").NatAmount;
+            getNormalizedDebt(): import("./storeUtils.js").NormalizedDebt;
+        }>;
+        vaultUpdater: import("@agoric/zoe/src/contractSupport/recorder.js").Recorder<VaultNotification>;
+    }>;
+    liquidating(): void;
+    liquidated(): void;
+    abortLiquidation(): string;
+    makeAdjustBalancesInvitation(): Promise<Invitation<string, undefined>>;
+    makeCloseInvitation(): Promise<Invitation<string, undefined>>;
+    makeTransferInvitation(): Promise<Invitation<{
+        publicSubscribers: {
+            vault: {
+                description: string;
+                subscriber: globalThis.Subscriber<VaultNotification>;
+                storagePath: Promise<string>;
+            };
+        };
+        invitationMakers: import("@endo/exo").Guarded<{
+            AdjustBalances(): Promise<Invitation<string, undefined>>;
+            CloseVault(): Promise<Invitation<string, undefined>>;
+            TransferVault(): Promise<Invitation<any, undefined>>;
+        }>;
+        vault: import("@endo/exo").Guarded<{
+            getPublicTopics(): {
+                vault: {
+                    description: string;
+                    subscriber: globalThis.Subscriber<VaultNotification>;
+                    storagePath: Promise<string>;
+                };
+            };
+            makeAdjustBalancesInvitation(): Promise<Invitation<string, undefined>>;
+            makeCloseInvitation(): Promise<Invitation<string, undefined>>;
+            makeTransferInvitation(): Promise<Invitation<any, undefined>>;
+            getCollateralAmount(): import("@agoric/ertp/src/types.js").NatAmount;
+            getCurrentDebt(): import("@agoric/ertp/src/types.js").NatAmount;
+            getNormalizedDebt(): import("./storeUtils.js").NormalizedDebt;
+        }>;
+        vaultUpdater: import("@agoric/zoe/src/contractSupport/recorder.js").Recorder<VaultNotification>;
+    }, undefined>>;
+    getCollateralAmount(): import("@agoric/ertp/src/types.js").NatAmount;
+    getCurrentDebt(): import("@agoric/ertp/src/types.js").NatAmount;
+    getNormalizedDebt(): import("./storeUtils.js").NormalizedDebt;
+}>>, debtBrand: Brand<"nat">, collateralBrand: Brand<"nat">): {
+    vaultData: globalThis.MapStore<import("@endo/exo").Guarded<{
+        getVaultSeat(): ZCFSeat;
+        initVaultKit(seat: ZCFSeat, storageNode: StorageNode): Promise<{
+            publicSubscribers: {
+                vault: {
+                    description: string;
+                    subscriber: globalThis.Subscriber<VaultNotification>;
+                    storagePath: Promise<string>;
+                };
+            };
+            invitationMakers: import("@endo/exo").Guarded<{
+                AdjustBalances(): Promise<Invitation<string, undefined>>;
+                CloseVault(): Promise<Invitation<string, undefined>>;
+                TransferVault(): Promise<Invitation<any, undefined>>;
+            }>;
+            vault: import("@endo/exo").Guarded<{
+                getPublicTopics(): {
+                    vault: {
+                        description: string;
+                        subscriber: globalThis.Subscriber<VaultNotification>;
+                        storagePath: Promise<string>;
+                    };
+                };
+                makeAdjustBalancesInvitation(): Promise<Invitation<string, undefined>>;
+                makeCloseInvitation(): Promise<Invitation<string, undefined>>;
+                makeTransferInvitation(): Promise<Invitation<any, undefined>>;
+                getCollateralAmount(): import("@agoric/ertp/src/types.js").NatAmount;
+                getCurrentDebt(): import("@agoric/ertp/src/types.js").NatAmount;
+                getNormalizedDebt(): import("./storeUtils.js").NormalizedDebt;
+            }>;
+            vaultUpdater: import("@agoric/zoe/src/contractSupport/recorder.js").Recorder<VaultNotification>;
+        }>;
+        liquidating(): void;
+        liquidated(): void;
+        abortLiquidation(): string;
+        makeAdjustBalancesInvitation(): Promise<Invitation<string, undefined>>;
+        makeCloseInvitation(): Promise<Invitation<string, undefined>>;
+        makeTransferInvitation(): Promise<Invitation<{
+            publicSubscribers: {
+                vault: {
+                    description: string;
+                    subscriber: globalThis.Subscriber<VaultNotification>;
+                    storagePath: Promise<string>;
+                };
+            };
+            invitationMakers: import("@endo/exo").Guarded<{
+                AdjustBalances(): Promise<Invitation<string, undefined>>;
+                CloseVault(): Promise<Invitation<string, undefined>>;
+                TransferVault(): Promise<Invitation<any, undefined>>;
+            }>;
+            vault: import("@endo/exo").Guarded<{
+                getPublicTopics(): {
+                    vault: {
+                        description: string;
+                        subscriber: globalThis.Subscriber<VaultNotification>;
+                        storagePath: Promise<string>;
+                    };
+                };
+                makeAdjustBalancesInvitation(): Promise<Invitation<string, undefined>>;
+                makeCloseInvitation(): Promise<Invitation<string, undefined>>;
+                makeTransferInvitation(): Promise<Invitation<any, undefined>>;
+                getCollateralAmount(): import("@agoric/ertp/src/types.js").NatAmount;
+                getCurrentDebt(): import("@agoric/ertp/src/types.js").NatAmount;
+                getNormalizedDebt(): import("./storeUtils.js").NormalizedDebt;
+            }>;
+            vaultUpdater: import("@agoric/zoe/src/contractSupport/recorder.js").Recorder<VaultNotification>;
+        }, undefined>>;
+        getCollateralAmount(): import("@agoric/ertp/src/types.js").NatAmount;
+        getCurrentDebt(): import("@agoric/ertp/src/types.js").NatAmount;
+        getNormalizedDebt(): import("./storeUtils.js").NormalizedDebt;
+    }>, {
+        collateralAmount: Amount<"nat">;
+        debtAmount: Amount<"nat">;
+    }>;
+    totalDebt: Amount<"nat">;
+    totalCollateral: Amount<"nat">;
+    liqSeat: ZCFSeat;
+};
+import type { TimerService } from '@agoric/time';
+import type { TimerWaker } from '@agoric/time';
+import type { PriceQuote } from '@agoric/zoe/tools/types.js';
+//# sourceMappingURL=liquidation.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"liquidation.d.ts","sourceRoot":"","sources":["liquidation.js"],"names":[],"mappings":"AAqJO,gEAPI,IAAI,CAAC,OAAO,0BAA0B,EAAE,qBAAqB,CAAC,iIAK5D,OAAO,CAAC,IAAI,CAAC,CAqCzB;AAQM,yCAJI,MAAM,CAAC,KAAK,CAAC,UACb,MAAM,CAAC,KAAK,CAAC,GACX;IAAE,OAAO,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC;IAAC,SAAS,EAAE,MAAM,CAAC,KAAK,CAAC,CAAA;CAAE,CAYhE;AAWM,gEALI,IAAI,CAAC,OAAO,0BAA0B,EAAE,qBAAqB,CAAC,uEAG5D,IAAI,CA0BhB;AAwBM,2CArBI,GAAG;;cAGH,KAAK;YACL,KAAK;sBACL,UAAU,CACpB,cAAkB,wBAAwB,EAAE,qBAAqB,CAC9D;;uBA+DgoU,OAAO,eAA0B,WAAW;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;gBA7DrqU,KAAK,CAAC,KAAK,CAAC,mBACZ,KAAK,CAAC,KAAK,CAAC;;;2BA4D6mU,OAAO,eAA0B,WAAW;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;0BAxDrpU,MAAM,CAAC,KAAK,CAAC;oBAAc,MAAM,CAAC,KAAK,CAAC;;eAEnD,MAAM,CAAC,KAAK,CAAC;qBACP,MAAM,CAAC,KAAK,CAAC;aACrB,OAAO;EAkDpB;kCArS+B,cAAc;gCAChB,cAAc;gCAGkD,4BAA4B"}

package/src/vaultFactory/liquidation.js

@@ -13,16 +13,18 @@ import { makeCancelTokenMaker } from '../auction/util.js';
 
 const trace = makeTracer('LIQ');
 
-/** @typedef {import('@agoric/time/src/types').TimerService} TimerService */
-/** @typedef {import('@agoric/time/src/types').TimerWaker} TimerWaker */
-/** @typedef {import('@agoric/time/src/types').CancelToken} CancelToken */
-/** @typedef {import('@agoric/time/src/types').RelativeTimeRecord} RelativeTimeRecord */
+/** @import {TimerService} from '@agoric/time' */
+/** @import {TimerWaker} from '@agoric/time' */
+/** @import {CancelToken} from '@agoric/time' */
+/** @import {RelativeTimeRecord} from '@agoric/time' */
+/** @import {PriceAuthority, PriceDescription, PriceQuote, PriceQuoteValue, PriceQuery,} from '@agoric/zoe/tools/types.js'; */
 
 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 +49,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
@@ -63,7 +66,7 @@ const cancelWakeups = timer => {
  * @param {TimerWaker} opts.liquidationWaker
  * @param {TimerWaker} opts.reschedulerWaker
  * @param {import('../auction/scheduler.js').Schedule} opts.nextAuctionSchedule
- * @param {import('@agoric/time/src/types').TimestampRecord} opts.now
+ * @param {import('@agoric/time').TimestampRecord} opts.now
  * @param {ParamStateRecord} opts.params
  * @returns {void}
  */
@@ -132,7 +135,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 +188,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 +243,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,13 +270,18 @@ 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();
   let totalDebt = AmountMath.makeEmpty(debtBrand);
   let totalCollateral = AmountMath.makeEmpty(collateralBrand);
-  /** @type {import('@agoric/zoe/src/contractSupport/atomicTransfer.js').TransferPart[]} */
+  /** @type {TransferPart[]} */
   const transfers = [];
 
   for (const vault of vaultsToLiquidate.values()) {

package/src/vaultFactory/math.d.ts

@@ -0,0 +1,11 @@
+export function calculateMinimumCollateralization(liquidationMargin: Ratio, liquidationPadding: Ratio): Ratio;
+export function minimumPrice(quoteA: PriceQuote, quoteB?: PriceQuote | undefined): Ratio;
+export function maxDebtForVault(quoteAmount: PriceQuote, liquidationMargin: Ratio, liquidationPadding: Ratio): Amount<"nat">;
+export function calculateDebtCosts(currentDebt: Amount<"nat">, give: Amount<"nat">, want: Amount<"nat">, debtFee: Ratio): {
+    newDebt: import("@agoric/ertp/src/types.js").NatAmount;
+    toMint: import("@agoric/ertp/src/types.js").NatAmount;
+    fee: import("@agoric/ertp/src/types.js").NatAmount;
+    surplus: import("@agoric/ertp/src/types.js").NatAmount;
+};
+import type { PriceQuote } from '@agoric/zoe/tools/types.js';
+//# sourceMappingURL=math.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"math.d.ts","sourceRoot":"","sources":["math.js"],"names":[],"mappings":"AA4BO,qEAJI,KAAK,sBACL,KAAK,GACH,KAAK,CAKmC;AAS9C,mFAFM,KAAK,CAajB;AAYM,4EAJI,KAAK,sBACL,KAAK,GACH,MAAM,CAAC,KAAK,CAAC,CAczB;AAaM,gDALI,MAAM,CAAC,KAAK,CAAC,QACb,MAAM,CAAC,KAAK,CAAC,QACb,MAAM,CAAC,KAAK,CAAC,WACb,KAAK;;;;;EASf;gCA7E6F,4BAA4B"}

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';
@@ -16,9 +16,11 @@ import {
 import { priceFrom } from '../auction/util.js';
 import { addSubtract } from '../contractSupport.js';
 
+/** @import {PriceAuthority, PriceDescription, PriceQuote, PriceQuoteValue, PriceQuery,} from '@agoric/zoe/tools/types.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 +76,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'