@agoric/inter-protocol 0.16.2-dev-ecf2d8e.0 → 0.16.2-other-dev-70beeb7.0

package/src/vaultFactory/vaultHolder.js

@@ -1,15 +1,17 @@
-/** @file Use-object for the owner of a vault */
+/**
+ * @file Use-object for the owner of a vault
+ */
 import { AmountShape } from '@agoric/ertp';
 import { M, prepareExoClassKit } from '@agoric/vat-data';
 import { TopicsRecordShape } from '@agoric/zoe/src/contractSupport/index.js';
-import { UnguardedHelperI } from '@agoric/internal/src/typeGuards.js';
+import { UnguardedHelperI } from '../typeGuards.js';
 
 const { Fail } = assert;
 
 /**
  * @typedef {{
- *   topicKit: import('@agoric/zoe/src/contractSupport/recorder.js').RecorderKit<VaultNotification>;
- *   vault: Vault | null;
+ * topicKit: import('@agoric/zoe/src/contractSupport/recorder.js').RecorderKit<VaultNotification>,
+ * vault: Vault | null,
  * }} State
  */
 
@@ -23,7 +25,7 @@ const HolderI = M.interface('holder', {
   makeTransferInvitation: M.call().returns(M.promise()),
 });
 
-/** @type {{ [name: string]: [description: string, valueShape: Pattern] }} */
+/** @type {{ [name: string]: [ description: string, valueShape: Pattern ] }} */
 const PUBLIC_TOPICS = {
   vault: ['Vault holder status', M.any()],
 };
@@ -46,6 +48,7 @@ export const prepareVaultHolder = (baggage, makeRecorderKit) => {
       }),
     },
     /**
+     *
      * @param {Vault} vault
      * @param {StorageNode} storageNode
      * @returns {State}
@@ -58,7 +61,9 @@ export const prepareVaultHolder = (baggage, makeRecorderKit) => {
     },
     {
       helper: {
-        /** @throws if this holder no longer owns the vault */
+        /**
+         * @throws if this holder no longer owns the vault
+         */
         owned() {
           const { vault } = this.state;
           if (!vault) {
@@ -99,8 +104,8 @@ export const prepareVaultHolder = (baggage, makeRecorderKit) => {
           return this.facets.helper.owned().makeCloseInvitation();
         },
         /**
-         * Starting a transfer revokes the vault holder. The associated updater
-         * will get a special notification that the vault is being transferred.
+         * Starting a transfer revokes the vault holder. The associated updater will
+         * get a special notification that the vault is being transferred.
          */
         makeTransferInvitation() {
           const vault = this.facets.helper.owned();

package/src/vaultFactory/vaultKit.js

@@ -8,8 +8,7 @@ import { prepareVaultHolder } from './vaultHolder.js';
 const trace = makeTracer('VK', true);
 
 /**
- * Wrap the VaultHolder duration object in a record suitable for the result of
- * an invitation.
+ * Wrap the VaultHolder duration object in a record suitable for the result of an invitation.
  *
  * @param {import('@agoric/ertp').Baggage} baggage
  * @param {import('@agoric/zoe/src/contractSupport/recorder.js').MakeRecorderKit} makeRecorderKit
@@ -44,4 +43,4 @@ export const prepareVaultKit = (baggage, makeRecorderKit) => {
   return makeVaultKit;
 };
 
-/** @typedef {ReturnType<ReturnType<typeof prepareVaultKit>>} VaultKit */
+/** @typedef {(ReturnType<ReturnType<typeof prepareVaultKit>>)} VaultKit */

package/src/vaultFactory/vaultManager.js

@@ -2,20 +2,18 @@
 /**
  * @file Vault Manager object manages vault-based debts for a collateral type.
  *
- *   The responsibilities include:
+ * The responsibilities include:
+ * - opening a new vault backed by the collateral
+ * - publishing metrics on the vault economy for that collateral
+ * - charging interest on all active vaults
+ * - liquidating active vaults that have exceeded the debt ratio
  *
- *   - opening a new vault backed by the collateral
- *   - publishing metrics on the vault economy for that collateral
- *   - charging interest on all active vaults
- *   - liquidating active vaults that have exceeded the debt ratio
+ * Once a vault is settled (liquidated or closed) it can still be used, traded,
+ * etc. but is no longer the concern of the manager. It can't be liquidated,
+ * have interest charged, or be counted in the metrics.
  *
- *   Once a vault is settled (liquidated or closed) it can still be used, traded,
- *   etc. but is no longer the concern of the manager. It can't be liquidated,
- *   have interest charged, or be counted in the metrics.
- *
- *   Undercollateralized vaults can have their assets sent to the auctioneer to be
- *   liquidated. If the auction is unsuccessful, the liquidation may be
- *   reverted.
+ * Undercollateralized vaults can have their assets sent to the auctioneer to be
+ * liquidated. If the auction is unsuccessful, the liquidation may be reverted.
  */
 import '@agoric/zoe/exported.js';
 
@@ -75,102 +73,93 @@ const trace = makeTracer('VM');
 // Metrics naming scheme: nouns are present values; past-participles are accumulative.
 /**
  * @typedef {object} MetricsNotification
- * @property {Ratio | null} lockedQuote priceQuote that will be used for
- *   liquidation. Non-null from priceLock time until liquidation has taken
- *   place.
- * @property {number} numActiveVaults present count of vaults
- * @property {number} numLiquidatingVaults present count of liquidating vaults
- * @property {Amount<'nat'>} totalCollateral present sum of collateral across
- *   all vaults
- * @property {Amount<'nat'>} totalDebt present sum of debt across all vaults
- * @property {Amount<'nat'>} retainedCollateral collateral held as a result of
- *   not returning excess refunds to owners of vaults liquidated with
- *   shortfalls
- * @property {Amount<'nat'>} liquidatingCollateral present sum of collateral in
- *   vaults sent for liquidation
- * @property {Amount<'nat'>} liquidatingDebt present sum of debt in vaults sent
- *   for liquidation
- * @property {Amount<'nat'>} totalCollateralSold running sum of collateral sold
- *   in liquidation
- * @property {Amount<'nat'>} totalOverageReceived running sum of overages,
- *   central received greater than debt
- * @property {Amount<'nat'>} totalProceedsReceived running sum of minted
- *   received from liquidation
- * @property {Amount<'nat'>} totalShortfallReceived running sum of shortfalls,
- *   minted received less than debt
- * @property {number} numLiquidationsCompleted running count of liquidated
- *   vaults
- * @property {number} numLiquidationsAborted running count of vault liquidations
- *   that were reverted.
+ *
+ * @property {Ratio | null} lockedQuote      priceQuote that will be used for liquidation.
+ *                                   Non-null from priceLock time until liquidation has taken place.
+ * @property {number}         numActiveVaults          present count of vaults
+ * @property {number}         numLiquidatingVaults  present count of liquidating vaults
+ * @property {Amount<'nat'>}  totalCollateral    present sum of collateral across all vaults
+ * @property {Amount<'nat'>}  totalDebt          present sum of debt across all vaults
+ * @property {Amount<'nat'>}  retainedCollateral collateral held as a result of not returning excess refunds
+ *                                                to owners of vaults liquidated with shortfalls
+ * @property {Amount<'nat'>}  liquidatingCollateral  present sum of collateral in vaults sent for liquidation
+ * @property {Amount<'nat'>}  liquidatingDebt        present sum of debt in vaults sent for liquidation
+ *
+ * @property {Amount<'nat'>}  totalCollateralSold       running sum of collateral sold in liquidation
+ * @property {Amount<'nat'>}  totalOverageReceived      running sum of overages, central received greater than debt
+ * @property {Amount<'nat'>}  totalProceedsReceived     running sum of minted received from liquidation
+ * @property {Amount<'nat'>}  totalShortfallReceived    running sum of shortfalls, minted received less than debt
+ * @property {number}         numLiquidationsCompleted  running count of liquidated vaults
+ * @property {number}         numLiquidationsAborted    running count of vault liquidations that were reverted.
  */
 
 /**
  * @typedef {{
- *   compoundedInterest: Ratio;
- *   interestRate: Ratio;
- *   latestInterestUpdate: Timestamp;
+ *  compoundedInterest: Ratio,
+ *  interestRate: Ratio,
+ *  latestInterestUpdate: Timestamp,
  * }} AssetState
  *
  * @typedef {{
- *   getChargingPeriod: () => RelativeTime;
- *   getRecordingPeriod: () => RelativeTime;
- *   getDebtLimit: () => Amount<'nat'>;
- *   getInterestRate: () => Ratio;
- *   getLiquidationPadding: () => Ratio;
- *   getLiquidationMargin: () => Ratio;
- *   getLiquidationPenalty: () => Ratio;
- *   getMintFee: () => Ratio;
- *   getMinInitialDebt: () => Amount<'nat'>;
+ *  getChargingPeriod: () => RelativeTime,
+ *  getRecordingPeriod: () => RelativeTime,
+ *  getDebtLimit: () => Amount<'nat'>,
+ *  getInterestRate: () => Ratio,
+ *  getLiquidationPadding: () => Ratio,
+ *  getLiquidationMargin: () => Ratio,
+ *  getLiquidationPenalty: () => Ratio,
+ *  getMintFee: () => Ratio,
+ *  getMinInitialDebt: () => Amount<'nat'>,
  * }} GovernedParamGetters
  */
 
 /**
  * @typedef {Readonly<{
- *   debtMint: ZCFMint<'nat'>;
- *   collateralBrand: Brand<'nat'>;
- *   collateralUnit: Amount<'nat'>;
- *   descriptionScope: string;
- *   startTimeStamp: Timestamp;
- *   storageNode: StorageNode;
+ *   debtMint: ZCFMint<'nat'>,
+ *   collateralBrand: Brand<'nat'>,
+ *   collateralUnit: Amount<'nat'>,
+ *   descriptionScope: string,
+ *   startTimeStamp: Timestamp,
+ *   storageNode: StorageNode,
  * }>} HeldParams
  */
 
 /**
  * @typedef {{
- *   assetTopicKit: import('@agoric/zoe/src/contractSupport/recorder.js').RecorderKit<AssetState>;
- *   debtBrand: Brand<'nat'>;
- *   liquidatingVaults: SetStore<Vault>;
- *   metricsTopicKit: import('@agoric/zoe/src/contractSupport/recorder.js').RecorderKit<MetricsNotification>;
- *   poolIncrementSeat: ZCFSeat;
- *   retainedCollateralSeat: ZCFSeat;
- *   unsettledVaults: MapStore<string, Vault>;
+ *   assetTopicKit: import('@agoric/zoe/src/contractSupport/recorder.js').RecorderKit<AssetState>,
+ *   debtBrand: Brand<'nat'>,
+ *   liquidatingVaults: SetStore<Vault>,
+ *   metricsTopicKit: import('@agoric/zoe/src/contractSupport/recorder.js').RecorderKit<MetricsNotification>,
+ *   poolIncrementSeat: ZCFSeat,
+ *   retainedCollateralSeat: ZCFSeat,
+ *   unsettledVaults: MapStore<string, Vault>,
  * }} ImmutableState
  */
 
 /**
  * @typedef {{
- *   compoundedInterest: Ratio;
- *   latestInterestUpdate: Timestamp;
- *   numLiquidationsCompleted: number;
- *   numLiquidationsAborted: number;
- *   totalCollateral: Amount<'nat'>;
- *   totalCollateralSold: Amount<'nat'>;
- *   totalDebt: Amount<'nat'>;
- *   liquidatingCollateral: Amount<'nat'>;
- *   liquidatingDebt: Amount<'nat'>;
- *   totalOverageReceived: Amount<'nat'>;
- *   totalProceedsReceived: Amount<'nat'>;
- *   totalShortfallReceived: Amount<'nat'>;
- *   vaultCounter: number;
- *   lockedQuote: PriceQuote | undefined;
+ *   compoundedInterest: Ratio,
+ *   latestInterestUpdate: Timestamp,
+ *   numLiquidationsCompleted: number,
+ *   numLiquidationsAborted: number,
+ *   totalCollateral: Amount<'nat'>,
+ *   totalCollateralSold: Amount<'nat'>,
+ *   totalDebt: Amount<'nat'>,
+ *   liquidatingCollateral: Amount<'nat'>,
+ *   liquidatingDebt: Amount<'nat'>,
+ *   totalOverageReceived: Amount<'nat'>,
+ *   totalProceedsReceived: Amount<'nat'>,
+ *   totalShortfallReceived: Amount<'nat'>,
+ *   vaultCounter: number,
+ *   lockedQuote: PriceQuote | undefined,
  * }} MutableState
  */
 
 /**
  * @type {(brand: Brand) => {
- *   prioritizedVaults: ReturnType<typeof makePrioritizedVaults>;
- *   storedQuotesNotifier: import('@agoric/notifier').StoredNotifier<PriceQuote>;
- *   storedCollateralQuote: PriceQuote;
+ * prioritizedVaults: ReturnType<typeof makePrioritizedVaults>,
+ * storedQuotesNotifier: import('@agoric/notifier').StoredNotifier<PriceQuote>,
+ * storedCollateralQuote: PriceQuote,
  * }}
  */
 // any b/c will be filled after start()
@@ -179,11 +168,11 @@ const collateralEphemera = makeEphemeraProvider(() => /** @type {any} */ ({}));
 /**
  * @param {import('@agoric/ertp').Baggage} baggage
  * @param {{
- *   zcf: import('./vaultFactory.js').VaultFactoryZCF;
- *   marshaller: ERef<Marshaller>;
- *   makeRecorderKit: import('@agoric/zoe/src/contractSupport/recorder.js').MakeRecorderKit;
- *   makeERecorderKit: import('@agoric/zoe/src/contractSupport/recorder.js').MakeERecorderKit;
- *   factoryPowers: import('./vaultDirector.js').FactoryPowersFacet;
+ *   zcf: import('./vaultFactory.js').VaultFactoryZCF,
+ *   marshaller: ERef<Marshaller>,
+ *   makeRecorderKit: import('@agoric/zoe/src/contractSupport/recorder.js').MakeRecorderKit,
+ *   makeERecorderKit: import('@agoric/zoe/src/contractSupport/recorder.js').MakeERecorderKit,
+ *   factoryPowers: import('./vaultDirector.js').FactoryPowersFacet,
  * }} powers
  */
 export const prepareVaultManagerKit = (
@@ -214,9 +203,8 @@ export const prepareVaultManagerKit = (
       poolIncrementSeat: zcf.makeEmptySeatKit().zcfSeat,
 
       /**
-       * Vaults that have been sent for liquidation. When we get proceeds (or
-       * lack thereof) back from the liquidator, we will allocate them among the
-       * vaults.
+       * Vaults that have been sent for liquidation. When we get proceeds (or lack
+       * thereof) back from the liquidator, we will allocate them among the vaults.
        *
        * @type {SetStore<Vault>}
        */
@@ -351,7 +339,9 @@ export const prepareVaultManagerKit = (
 
       // Some of these could go in closures but are kept on a facet anticipating future durability options.
       helper: {
-        /** Start non-durable processes (or restart if needed after vat restart) */
+        /**
+         * Start non-durable processes (or restart if needed after vat restart)
+         */
         start() {
           const { state, facets } = this;
           trace(state.collateralBrand, 'helper.start()', state.vaultCounter);
@@ -410,7 +400,7 @@ export const prepareVaultManagerKit = (
           // throw. See https://github.com/Agoric/agoric-sdk/issues/4317
           void observeNotifier(quoteNotifier, {
             updateState(value) {
-              trace('storing new quote', value.quoteAmount.value);
+              trace('vaultManager got new collateral quote', value);
               ephemera.storedCollateralQuote = value;
             },
             fail(reason) {
@@ -419,7 +409,9 @@ export const prepareVaultManagerKit = (
           });
           trace('helper.start() done');
         },
-        /** @param {Timestamp} updateTime */
+        /**
+         * @param {Timestamp} updateTime
+         */
         async chargeAllVaults(updateTime) {
           const { state, facets } = this;
           const { collateralBrand, debtMint, poolIncrementSeat } = state;
@@ -523,6 +515,7 @@ export const prepareVaultManagerKit = (
           state.liquidatingDebt = AmountMath.add(state.liquidatingDebt, debt);
         },
         /**
+         *
          * @param {Amount<'nat'>} debt
          * @param {Amount<'nat'>} collateral
          * @param {Amount<'nat'>} overage
@@ -605,18 +598,14 @@ export const prepareVaultManagerKit = (
         },
 
         /**
-         * This is designed to tolerate an incomplete plan, in case
-         * calculateDistributionPlan encounters an error during its calculation.
-         * We don't have a way to induce such errors in CI so we've done so
-         * manually in dev and verified this function recovers as expected.
+         * This is designed to tolerate an incomplete plan, in case calculateDistributionPlan encounters
+         * an error during its calculation. We don't have a way to induce such errors in CI so we've
+         * done so manually in dev and verified this function recovers as expected.
          *
          * @param {AmountKeywordRecord} proceeds
          * @param {Amount<'nat'>} totalDebt
          * @param {Pick<PriceQuote, 'quoteAmount'>} oraclePriceAtStart
-         * @param {MapStore<
-         *   Vault,
-         *   { collateralAmount: Amount<'nat'>; debtAmount: Amount<'nat'> }
-         * >} vaultData
+         * @param {MapStore<Vault, { collateralAmount: Amount<'nat'>, debtAmount:  Amount<'nat'>}>} vaultData
          * @param {Amount<'nat'>} totalCollateral
          */
         planProceedsDistribution(
@@ -672,14 +661,13 @@ export const prepareVaultManagerKit = (
         },
 
         /**
-         * This is designed to tolerate an incomplete plan, in case
-         * calculateDistributionPlan encounters an error during its calculation.
-         * We don't have a way to induce such errors in CI so we've done so
-         * manually in dev and verified this function recovers as expected.
+         * This is designed to tolerate an incomplete plan, in case calculateDistributionPlan encounters
+         * an error during its calculation. We don't have a way to induce such errors in CI so we've
+         * done so manually in dev and verified this function recovers as expected.
          *
          * @param {object} obj
          * @param {import('./proceeds.js').DistributionPlan} obj.plan
-         * @param {Vault[]} obj.vaultsInPlan
+         * @param {Array<Vault>} obj.vaultsInPlan
          * @param {ZCFSeat} obj.liqSeat
          * @param {Amount<'nat'>} obj.totalCollateral
          * @param {Amount<'nat'>} obj.totalDebt
@@ -699,7 +687,7 @@ export const prepareVaultManagerKit = (
           if (plan.transfersToVault.length > 0) {
             const transfers = plan.transfersToVault.map(
               ([vaultIndex, amounts]) =>
-                /** @type {TransferPart} */ ([
+                /** @type {import('@agoric/zoe/src/contractSupport/atomicTransfer.js').TransferPart} */ ([
                   liqSeat,
                   vaultsInPlan[vaultIndex].getVaultSeat(),
                   amounts,
@@ -852,7 +840,9 @@ export const prepareVaultManagerKit = (
           const { descriptionScope } = this.state;
           return `${descriptionScope}: ${base}`;
         },
-        /** coefficient on existing debt to calculate new debt */
+        /**
+         * coefficient on existing debt to calculate new debt
+         */
         getCompoundedInterest() {
           return this.state.compoundedInterest;
         },
@@ -862,8 +852,7 @@ export const prepareVaultManagerKit = (
          * @param {NormalizedDebt} oldDebtNormalized
          * @param {Amount<'nat'>} oldCollateral
          * @param {VaultId} vaultId
-         * @param {import('./vault.js').VaultPhase} vaultPhase at the end of
-         *   whatever change updated balances
+         * @param {import('./vault.js').VaultPhase} vaultPhase at the end of whatever change updated balances
          * @param {Vault} vault
          * @returns {void}
          */
@@ -948,7 +937,9 @@ export const prepareVaultManagerKit = (
           return factoryPowers.getGovernedParams(collateralBrand);
         },
 
-        /** @param {ZCFSeat} seat */
+        /**
+         * @param {ZCFSeat} seat
+         */
         async makeVaultKit(seat) {
           const {
             state,
@@ -972,6 +963,7 @@ export const prepareVaultManagerKit = (
 
           try {
             // TODO `await` is allowed until the above ordering is fixed
+            // eslint-disable-next-line @jessie.js/no-nested-await
             const vaultKit = await vault.initVaultKit(seat, vaultStorageNode);
             // initVaultKit calls back to handleBalanceChange() which will add the
             // vault to prioritizedVaults
@@ -1045,16 +1037,18 @@ export const prepareVaultManagerKit = (
           if (!storedCollateralQuote)
             throw Fail`lockOraclePrices called before a collateral quote was available`;
           trace(
-            `lockOraclePrices`,
+            `lockPrice`,
             getAmountIn(storedCollateralQuote),
             getAmountOut(storedCollateralQuote),
           );
 
           state.lockedQuote = storedCollateralQuote;
-          void facets.helper.writeMetrics();
+          facets.helper.writeMetrics();
           return storedCollateralQuote;
         },
-        /** @param {ERef<AuctioneerPublicFacet>} auctionPF */
+        /**
+         * @param {AuctioneerPublicFacet} auctionPF
+         */
         async liquidateVaults(auctionPF) {
           const { state, facets } = this;
           const { self, helper } = facets;
@@ -1067,19 +1061,11 @@ export const prepareVaultManagerKit = (
           } = state;
           trace(collateralBrand, 'considering liquidation');
 
-          if (!lockedQuote) {
-            // By design, the first cycle of auction may call this before a quote is locked
-            // because the schedule is global at the vaultDirector level, and if a manager
-            // starts after the price lock time there's nothing to be done.
-            // NB: this message should not log repeatedly.
-            console.error(
-              'Skipping liquidation because no quote is locked yet (may happen with new manager)',
-            );
-            return;
-          }
-
           const { prioritizedVaults } = collateralEphemera(collateralBrand);
-          prioritizedVaults || Fail`prioritizedVaults missing from ephemera`;
+          assert(factoryPowers && prioritizedVaults && zcf);
+          lockedQuote ||
+            Fail`Must have locked a quote before liquidating vaults.`;
+          assert(lockedQuote); // redundant with previous line
 
           const liqMargin = self.getGovernedParams().getLiquidationMargin();
 
@@ -1101,7 +1087,6 @@ export const prepareVaultManagerKit = (
           state.lockedQuote = undefined;
 
           if (vaultData.getSize() === 0) {
-            void helper.writeMetrics();
             return;
           }
           trace(
@@ -1165,7 +1150,7 @@ export const prepareVaultManagerKit = (
             liquidatingVaults.delete(vault);
           }
 
-          void helper.writeMetrics();
+          await facets.helper.writeMetrics();
         },
       },
     },
@@ -1189,12 +1174,7 @@ export const prepareVaultManagerKit = (
     },
   );
 
-  /**
-   * @param {Omit<
-   *   Parameters<typeof makeVaultManagerKitInternal>[0],
-   *   'metricsStorageNode'
-   * >} externalParams
-   */
+  /** @param {Omit<Parameters<typeof makeVaultManagerKitInternal>[0], 'metricsStorageNode'>} externalParams */
   const makeVaultManagerKit = async externalParams => {
     const metricsStorageNode = await E(
       externalParams.storageNode,
@@ -1207,13 +1187,15 @@ export const prepareVaultManagerKit = (
   return makeVaultManagerKit;
 };
 
-/** @typedef {Awaited<ReturnType<ReturnType<typeof prepareVaultManagerKit>>>} VaultManagerKit */
 /**
- * @typedef {VaultManagerKit['self']} VaultManager Each VaultManager manages a
- *   single collateral type.
+ * @typedef {Awaited<ReturnType<ReturnType<typeof prepareVaultManagerKit>>>} VaultManagerKit
+ */
+/**
+ * @typedef {VaultManagerKit['self']} VaultManager
+ * Each VaultManager manages a single collateral type.
  *
- *   It manages some number of outstanding debt positions, each called a Vault,
- *   for which the collateral is provided in exchange for borrowed Minted.
+ * It manages some number of outstanding debt positions, each called a Vault,
+ * for which the collateral is provided in exchange for borrowed Minted.
  */
 /** @typedef {VaultManagerKit['collateral']} CollateralManager */
 

package/src/auction/auctionBook.d.ts

@@ -1,83 +0,0 @@
-export function makeOfferSpecShape(bidBrand: Brand<'nat'>, collateralBrand: Brand<'nat'>): any;
-export function prepareAuctionBook(baggage: Baggage, zcf: ZCF, makeRecorderKit: import('@agoric/zoe/src/contractSupport/recorder.js').MakeRecorderKit): (bidBrand: Brand<"nat">, collateralBrand: Brand<"nat">, pAuthority: PriceAuthority, node: StorageNode) => {
-    /**
-     * @param {Amount<'nat'>} assetAmount
-     * @param {ZCFSeat} sourceSeat
-     * @param {Amount<'nat'>} [proceedsGoal] an amount that the depositor
-     *   would like to raise. The auction is requested to not sell more
-     *   collateral than required to raise that much. The auctioneer might
-     *   sell more if there is more than one supplier of collateral, and
-     *   they request inconsistent limits.
-     */
-    addAssets(assetAmount: Amount<'nat'>, sourceSeat: ZCFSeat, proceedsGoal?: Amount<"nat"> | undefined): void;
-    /** @type {(reduction: Ratio) => void} */
-    settleAtNewRate(reduction: Ratio): void;
-    getCurrentPrice(): Ratio | null;
-    hasOrders(): boolean;
-    captureOraclePriceForRound(): void;
-    setStartingRate(rate: any): void;
-    /**
-     * @param {OfferSpec} offerSpec
-     * @param {ZCFSeat} seat
-     * @param {boolean} trySettle
-     */
-    addOffer(offerSpec: OfferSpec, seat: ZCFSeat, trySettle: boolean): void;
-    getSeats(): {
-        collateralSeat: ZCFSeat;
-        bidHoldingSeat: ZCFSeat;
-    };
-    exitAllSeats(): void;
-    endAuction(): void;
-    getDataUpdates(): Subscriber<BookDataNotification>;
-    getPublicTopics(): {
-        bookData: import("@agoric/zoe/src/contractSupport/topics.js").PublicTopic<BookDataNotification>;
-    };
-};
-export type OfferSpec = {
-    maxBuy: Amount<'nat'>;
-} & {
-    exitAfterBuy?: boolean;
-} & ({
-    offerPrice: Ratio;
-} | {
-    offerBidScaling: Ratio;
-});
-export type Baggage = import('@agoric/vat-data').Baggage;
-export type BookDataNotification = {
-    /**
-     * identifies the priceAuthority and price
-     */
-    startPrice: Ratio | null;
-    /**
-     * the price at the current auction
-     * tier
-     */
-    currentPriceLevel: Ratio | null;
-    /**
-     * The proceeds the sellers
-     * were targeting to raise
-     */
-    startProceedsGoal: Amount<'nat'> | null;
-    /**
-     * The remainder of the
-     * proceeds the sellers were targeting to raise
-     */
-    remainingProceedsGoal: Amount<'nat'> | null;
-    /**
-     * The proceeds raised so
-     * far in the auction
-     */
-    proceedsRaised: Amount<'nat'> | undefined;
-    /**
-     * How much collateral was available
-     * for sale at the start. (If more is deposited later, it'll be added in.)
-     */
-    startCollateral: Amount<'nat'>;
-    /**
-     * The amount of collateral
-     * remaining
-     */
-    collateralAvailable: Amount<'nat'> | null;
-};
-export type AuctionBook = ReturnType<ReturnType<typeof prepareAuctionBook>>;
-//# sourceMappingURL=auctionBook.d.ts.map

package/src/auction/auctionBook.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"auctionBook.d.ts","sourceRoot":"","sources":["auctionBook.js"],"names":[],"mappings":"AAyEO,6CAHI,MAAM,KAAK,CAAC,mBACZ,MAAM,KAAK,CAAC,OAiBtB;AA0BM,4CAJI,OAAO,OACP,GAAG,mBACH,OAAO,6CAA6C,EAAE,eAAe;IAwWxE;;;;;;;;OAQG;2BAPQ,OAAO,KAAK,CAAC,cACb,OAAO;IA6ElB,yCAAyC;+BAAlB,KAAK,GAAK,IAAI;;;;;IAsGrC;;;;OAIG;wBAHQ,SAAS,QACT,OAAO,aACP,OAAO;;;;;;;;;;;EAsHzB;wBA9sBY;IACZ,MAAU,EAAE,OAAO,KAAK,CAAC,CAAC;CACvB,GAAG;IACN,YAAgB,CAAC,EAAE,OAAO,CAAC;CACxB,GAAG,CACE;IACR,UAAoB,EAAE,KAAK,CAAC;CACnB,GACD;IACR,eAAyB,EAAE,KAAK,CAAC;CACxB,CACJ;sBAuBQ,OAAO,kBAAkB,EAAE,OAAO;;;;;gBAIlC,KAAK,GAAG,IAAI;;;;;uBACZ,KAAK,GAAG,IAAI;;;;;uBAEZ,OAAO,KAAK,CAAC,GAAG,IAAI;;;;;2BAEpB,OAAO,KAAK,CAAC,GAAG,IAAI;;;;;oBAEpB,OAAO,KAAK,CAAC,GAAG,SAAS;;;;;qBAEzB,OAAO,KAAK,CAAC;;;;;yBAEb,OAAO,KAAK,CAAC,GAAG,IAAI;;0BAgqBpB,WAAW,WAAW,yBAAyB,CAAC,CAAC"}