@agoric/inter-protocol 0.16.2-other-dev-8f8782b.0 → 0.16.2-other-dev-fbe72e7.0.fbe72e7

package/src/auction/auctioneer.d.ts

@@ -0,0 +1,70 @@
+export function distributeProportionalSharesWithLimits(unsoldCollateral: Amount<"nat">, proceeds: Amount<"nat">, deposits: {
+    seat: ZCFSeat;
+    amount: Amount<"nat">;
+    goal: Amount<"nat">;
+}[], collateralSeat: ZCFSeat, bidHoldingSeat: ZCFSeat, collateralKeyword: string, reserveSeat: ZCFSeat, brand: Brand): globalThis.TransferPart[];
+export function start(zcf: ZCF<GovernanceTerms<typeof auctioneerParamTypes> & {
+    timerService: import("@agoric/time").TimerService;
+    reservePublicFacet: AssetReservePublicFacet;
+    priceAuthority: PriceAuthority;
+}>, privateArgs: {
+    initialPoserInvitation: Invitation;
+    storageNode: StorageNode;
+    marshaller: Marshaller;
+}, baggage: Baggage): Promise<{
+    publicFacet: globalThis.GovernedPublicFacet<{
+        getElectorate: () => import("@agoric/ertp").SetAmount<import("@endo/patterns").Key>;
+        getStartFrequency: () => RelativeTime;
+        getClockStep: () => RelativeTime;
+        getStartingRate: () => bigint;
+        getLowestRate: () => bigint;
+        getDiscountStep: () => bigint;
+        getAuctionStartDelay: () => RelativeTime;
+        getPriceLockPeriod: () => RelativeTime;
+        /** @param {Brand<'nat'>} collateralBrand */
+        makeBidInvitation(collateralBrand: Brand<"nat">): Promise<globalThis.Invitation<string, import("./auctionBook.js").OfferSpec>>;
+        getSchedules(): {
+            liveAuctionSchedule: import("./scheduler.js").Schedule | null;
+            nextAuctionSchedule: import("./scheduler.js").Schedule | null;
+        };
+        getScheduleUpdates(): globalThis.Subscriber<import("./scheduler.js").ScheduleNotification>;
+        getBookDataUpdates(brand: any): globalThis.Subscriber<import("./auctionBook.js").BookDataNotification>;
+        getPublicTopics(brand: any): {
+            bookData: import("@agoric/zoe/src/contractSupport/topics.js").PublicTopic<import("./auctionBook.js").BookDataNotification>;
+        } | {
+            schedule: import("@agoric/zoe/src/contractSupport/topics.js").PublicTopic<import("./scheduler.js").ScheduleNotification>;
+        };
+        makeDepositInvitation: () => Promise<globalThis.Invitation<string, {
+            goal: Amount<"nat">;
+        }>>;
+    }>;
+    creatorFacet: globalThis.GovernedCreatorFacet<{
+        /**
+         * @param {Issuer<'nat'>} issuer
+         * @param {Keyword} kwd
+         */
+        addBrand(issuer: Issuer<"nat">, kwd: Keyword): Promise<void>;
+        /** @returns {Promise<import('./scheduler.js').FullSchedule>} */
+        getSchedule(): Promise<import("./scheduler.js").FullSchedule>;
+    } & RemotableObject<`Alleged: ${string}`> & import("@endo/eventual-send").RemotableBrand<{}, {
+        /**
+         * @param {Issuer<'nat'>} issuer
+         * @param {Keyword} kwd
+         */
+        addBrand(issuer: Issuer<"nat">, kwd: Keyword): Promise<void>;
+        /** @returns {Promise<import('./scheduler.js').FullSchedule>} */
+        getSchedule(): Promise<import("./scheduler.js").FullSchedule>;
+    }>>;
+}>;
+/** @typedef {ContractOf<typeof start>} AuctioneerContract */
+/** @typedef {AuctioneerContract['publicFacet']} AuctioneerPublicFacet */
+/** @typedef {AuctioneerContract['creatorFacet']} AuctioneerCreatorFacet */
+export const AuctionPFShape: import("@endo/patterns").Matcher;
+export type AuctioneerContract = ContractOf<typeof start>;
+export type AuctioneerPublicFacet = AuctioneerContract["publicFacet"];
+export type AuctioneerCreatorFacet = AuctioneerContract["creatorFacet"];
+import { auctioneerParamTypes } from './params.js';
+import type { PriceAuthority } from '@agoric/zoe/tools/types.js';
+import type { Baggage } from '@agoric/vat-data';
+import type { ContractOf } from '@agoric/zoe/src/zoeService/utils.js';
+//# sourceMappingURL=auctioneer.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"auctioneer.d.ts","sourceRoot":"","sources":["auctioneer.js"],"names":[],"mappings":"AAoLO,yEAXI,MAAM,CAAC,KAAK,CAAC,YACb,MAAM,CAAC,KAAK,CAAC,YACb;IAAE,IAAI,EAAE,OAAO,CAAC;IAAC,MAAM,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC;IAAC,IAAI,EAAE,MAAM,CAAC,KAAK,CAAC,CAAA;CAAE,EAAE,kBAC/D,OAAO,kBACP,OAAO,qBAEP,MAAM,eAEN,OAAO,SACP,KAAK,6BAgNf;AAiBM,2BAdI,GAAG,CACT,eAAe,CAAC,OAAO,oBAAoB,CAAC,GAAG;IAC7C,YAAY,EAAE,OAAO,cAAc,EAAE,YAAY,CAAC;IAClD,kBAAkB,EAAE,uBAAuB,CAAC;IAC5C,cAAc,EAAE,cAAc,CAAC;CAChC,CACF,eACO;IACN,sBAAsB,EAAE,UAAU,CAAC;IACnC,WAAW,EAAE,WAAW,CAAC;IACzB,UAAU,EAAE,UAAU,CAAC;CACxB,WACO,OAAO;;;;;;;;;;QAqOZ,4CAA4C;2CAAhC,KAAK,CAAC,KAAK,CAAC;;;;;;;;;;;;;kBApCT,MAAM,CAAC,KAAK,CAAC;;;;QAkG5B;;;WAGG;yBAFQ,MAAM,CAAC,KAAK,CAAC,OACb,OAAO;QAwBlB,gEAAgE;uBAAlD,OAAO,CAAC,OAAO,gBAAgB,EAAE,YAAY,CAAC;;QA1B5D;;;WAGG;yBAFQ,MAAM,CAAC,KAAK,CAAC,OACb,OAAO;QAwBlB,gEAAgE;uBAAlD,OAAO,CAAC,OAAO,gBAAgB,EAAE,YAAY,CAAC;;GAQjE;AAED,6DAA6D;AAC7D,yEAAyE;AACzE,2EAA2E;AAE3E,8DAAkE;iCAJpD,WAAW,OAAO,KAAK,CAAC;oCACxB,kBAAkB,CAAC,aAAa,CAAC;qCACjC,kBAAkB,CAAC,cAAc,CAAC;qCA1rBX,aAAa;oCAS2C,4BAA4B;6BAF/F,kBAAkB;gCACf,qCAAqC"}

package/src/auction/auctioneer.js

@@ -1,16 +1,17 @@
-import '@agoric/governance/exported.js';
-import '@agoric/zoe/exported.js';
-import '@agoric/zoe/src/contracts/exported.js';
+/// <reference types="@agoric/governance/exported" />
+/// <reference types="@agoric/zoe/exported" />
 
+import { Fail, q } from '@endo/errors';
+import { E } from '@endo/eventual-send';
+import { Far } from '@endo/marshal';
 import { AmountMath, AmountShape, BrandShape } from '@agoric/ertp';
 import { handleParamGovernance } from '@agoric/governance';
-import { BASIS_POINTS, makeTracer } from '@agoric/internal';
+import { makeTracer } from '@agoric/internal';
 import { prepareDurablePublishKit } from '@agoric/notifier';
 import { mustMatch } from '@agoric/store';
 import { appendToStoredArray } from '@agoric/store/src/stores/store-utils.js';
 import { M, provideDurableMapStore } from '@agoric/vat-data';
 import {
-  atomicRearrange,
   ceilDivideBy,
   ceilMultiplyBy,
   defineERecorderKit,
@@ -26,8 +27,6 @@ import {
   offerTo,
 } from '@agoric/zoe/src/contractSupport/index.js';
 import { FullProposalShape } from '@agoric/zoe/src/typeGuards.js';
-import { E } from '@endo/eventual-send';
-import { Far } from '@endo/marshal';
 
 import { makeNatAmountShape } from '../contractSupport.js';
 import { makeOfferSpecShape, prepareAuctionBook } from './auctionBook.js';
@@ -35,19 +34,25 @@ import { auctioneerParamTypes } from './params.js';
 import { makeScheduler } from './scheduler.js';
 import { AuctionState } from './util.js';
 
-/** @typedef {import('@agoric/vat-data').Baggage} Baggage */
+/**
+ * @import {TypedPattern} from '@agoric/internal';
+ * @import {MapStore} from '@agoric/store';
+ * @import {Baggage} from '@agoric/vat-data';
+ * @import {ContractOf} from '@agoric/zoe/src/zoeService/utils.js';
+ * @import {PriceAuthority, PriceDescription, PriceQuote, PriceQuoteValue, PriceQuery,} from '@agoric/zoe/tools/types.js';
+ */
+
+const BASIS_POINTS = 10_000n;
 
-const { Fail, quote: q } = assert;
 const { add, multiply } = natSafeMath;
 
 const trace = makeTracer('Auction', true);
 
 /**
- * @file
- * In this file, 'Bid' is the name of the ERTP issuer used to purchase
- * collateral from various issuers. It's too confusing to also use Bid as a verb
- * or a description of amounts offered, so we've tried to find alternatives in
- * all those cases.
+ * @file In this file, 'Bid' is the name of the ERTP issuer used to purchase
+ *   collateral from various issuers. It's too confusing to also use Bid as a
+ *   verb or a description of amounts offered, so we've tried to find
+ *   alternatives in all those cases.
  */
 
 const MINIMUM_BID_GIVE = 1n;
@@ -67,17 +72,19 @@ const makeBPRatio = (rate, bidBrand, collateralBrand = bidBrand) =>
  * The auction sold some amount of collateral, and raised a certain amount of
  * Bid. The excess collateral was returned as `unsoldCollateral`. The Bid amount
  * collected from the auction participants is `proceeds`.
+ *
  * Return a set of transfers for atomicRearrange() that distribute
  * `unsoldCollateral` and `proceeds` proportionally to each seat's deposited
  * amount. Any uneven split should be allocated to the reserve.
  *
  * @param {Amount} unsoldCollateral
  * @param {Amount} proceeds
- * @param {{seat: ZCFSeat, amount: Amount<'nat'>, goal: Amount<'nat'>}[]} deposits
+ * @param {{ seat: ZCFSeat; amount: Amount<'nat'>; goal: Amount<'nat'> }[]} deposits
  * @param {ZCFSeat} collateralSeat
- * @param {ZCFSeat} bidHoldingSeat seat with the Bid allocation to be distributed
+ * @param {ZCFSeat} bidHoldingSeat seat with the Bid allocation to be
+ *   distributed
  * @param {string} collateralKeyword The Reserve will hold multiple collaterals,
- *      so they need distinct keywords
+ *   so they need distinct keywords
  * @param {ZCFSeat} reserveSeat
  * @param {Brand} brand
  */
@@ -97,7 +104,7 @@ const distributeProportionalShares = (
 
   const collShare = makeRatioFromAmounts(unsoldCollateral, totalCollDeposited);
   const currShare = makeRatioFromAmounts(proceeds, totalCollDeposited);
-  /** @type {import('@agoric/zoe/src/contractSupport/atomicTransfer.js').TransferPart[]} */
+  /** @type {TransferPart[]} */
   const transfers = [];
   let proceedsLeft = proceeds;
   let collateralLeft = unsoldCollateral;
@@ -132,6 +139,7 @@ const distributeProportionalShares = (
  * The auction sold some amount of collateral, and raised a certain amount of
  * Bid. The excess collateral was returned as `unsoldCollateral`. The Bid amount
  * collected from the auction participants is `proceeds`.
+ *
  * Return a set of transfers for atomicRearrange() that distribute
  * `unsoldCollateral` and `proceeds` proportionally to each seat's deposited
  * amount. Any uneven split should be allocated to the reserve.
@@ -140,32 +148,33 @@ const distributeProportionalShares = (
  * outside the contract below.
  *
  * Some or all of the depositors may have specified a goal amount.
- *  * A if none did, return collateral and Bid prorated to deposits.
- *  * B if proceeds < proceedsGoal everyone gets prorated amounts of both.
- *  * C if proceeds matches proceedsGoal, everyone gets the Bid they
- *    asked for, plus enough collateral to reach the same proportional payout.
- *    If any depositor's goal amount exceeded their share of the total,
- *    we'll fall back to the first approach.
- *  * D if proceeds > proceedsGoal && all depositors specified a limit,
- *    all depositors get their goal first, then we distribute the
- *    remainder (collateral and Bid) to get the same proportional payout.
- *  * E if proceeds > proceedsGoal && some depositors didn't specify a
- *    limit, depositors who did will get their goal first, then we distribute
- *    the remainder (collateral and Bid) to get the same proportional
- *    payout. If any depositor's goal amount exceeded their share of the
- *    total, we'll fall back as above.
- * Think of it this way: those who specified a limit want as much collateral
- * back as possible, consistent with raising a certain amount of Bid. Those
- * who didn't specify a limit are trying to sell collateral, and would prefer to
- * have as much as possible converted to Bid.
+ *
+ * - A if none did, return collateral and Bid prorated to deposits.
+ * - B if proceeds < proceedsGoal everyone gets prorated amounts of both.
+ * - C if proceeds matches proceedsGoal, everyone gets the Bid they asked for,
+ *   plus enough collateral to reach the same proportional payout. If any
+ *   depositor's goal amount exceeded their share of the total, we'll fall back
+ *   to the first approach.
+ * - D if proceeds > proceedsGoal && all depositors specified a limit, all
+ *   depositors get their goal first, then we distribute the remainder
+ *   (collateral and Bid) to get the same proportional payout.
+ * - E if proceeds > proceedsGoal && some depositors didn't specify a limit,
+ *   depositors who did will get their goal first, then we distribute the
+ *   remainder (collateral and Bid) to get the same proportional payout. If any
+ *   depositor's goal amount exceeded their share of the total, we'll fall back
+ *   as above. Think of it this way: those who specified a limit want as much
+ *   collateral back as possible, consistent with raising a certain amount of
+ *   Bid. Those who didn't specify a limit are trying to sell collateral, and
+ *   would prefer to have as much as possible converted to Bid.
  *
  * @param {Amount<'nat'>} unsoldCollateral
  * @param {Amount<'nat'>} proceeds
- * @param {{seat: ZCFSeat, amount: Amount<'nat'>, goal: Amount<'nat'>}[]} deposits
+ * @param {{ seat: ZCFSeat; amount: Amount<'nat'>; goal: Amount<'nat'> }[]} deposits
  * @param {ZCFSeat} collateralSeat
- * @param {ZCFSeat} bidHoldingSeat seat with the Bid allocation to be distributed
+ * @param {ZCFSeat} bidHoldingSeat seat with the Bid allocation to be
+ *   distributed
  * @param {string} collateralKeyword The Reserve will hold multiple collaterals,
- *      so they need distinct keywords
+ *   so they need distinct keywords
  * @param {ZCFSeat} reserveSeat
  * @param {Brand} brand
  */
@@ -255,7 +264,7 @@ export const distributeProportionalSharesWithLimits = (
   // collateral to reach their share. Then see what's left, and allocate it
   // among the remaining depositors. Escape to distributeProportionalShares if
   // anything doesn't work.
-  /** @type {import('@agoric/zoe/src/contractSupport/atomicTransfer.js').TransferPart[]} */
+  /** @type {TransferPart[]} */
   const transfers = [];
   let proceedsLeft = proceeds;
   let collateralLeft = unsoldCollateral;
@@ -378,15 +387,17 @@ export const distributeProportionalSharesWithLimits = (
 };
 
 /**
- * @param {ZCF<GovernanceTerms<typeof auctioneerParamTypes> & {
- *   timerService: import('@agoric/time/src/types').TimerService,
- *   reservePublicFacet: AssetReservePublicFacet,
- *   priceAuthority: PriceAuthority
- * }>} zcf
+ * @param {ZCF<
+ *   GovernanceTerms<typeof auctioneerParamTypes> & {
+ *     timerService: import('@agoric/time').TimerService;
+ *     reservePublicFacet: AssetReservePublicFacet;
+ *     priceAuthority: PriceAuthority;
+ *   }
+ * >} zcf
  * @param {{
- *   initialPoserInvitation: Invitation,
- *   storageNode: StorageNode,
- *   marshaller: Marshaller
+ *   initialPoserInvitation: Invitation;
+ *   storageNode: StorageNode;
+ *   marshaller: Marshaller;
  * }} privateArgs
  * @param {Baggage} baggage
  */
@@ -399,7 +410,12 @@ export const start = async (zcf, privateArgs, baggage) => {
 
   /** @type {MapStore<Brand, import('./auctionBook.js').AuctionBook>} */
   const books = provideDurableMapStore(baggage, 'auctionBooks');
-  /** @type {MapStore<Brand, Array<{ seat: ZCFSeat, amount: Amount<'nat'>, goal: Amount<'nat'>}>>} */
+  /**
+   * @type {MapStore<
+   *   Brand,
+   *   { seat: ZCFSeat; amount: Amount<'nat'>; goal: Amount<'nat'> }[]
+   * >}
+   */
   const deposits = provideDurableMapStore(baggage, 'deposits');
   /** @type {MapStore<Brand, Keyword>} */
   const brandToKeyword = provideDurableMapStore(baggage, 'brandToKeyword');
@@ -427,9 +443,9 @@ export const start = async (zcf, privateArgs, baggage) => {
   });
   const scheduleKit = makeERecorderKit(
     E(privateArgs.storageNode).makeChildNode('schedule'),
-    /** @type {import('@agoric/zoe/src/contractSupport/recorder.js').TypedMatcher<import('./scheduler.js').ScheduleNotification>} */ (
-      M.any()
-    ),
+    /**
+     * @type {TypedPattern<import('./scheduler.js').ScheduleNotification>}
+     */ (M.any()),
   );
 
   /**
@@ -477,8 +493,7 @@ export const start = async (zcf, privateArgs, baggage) => {
         // send it all to the one
         const liqSeat = depositsForBrand[0].seat;
 
-        atomicRearrange(
-          zcf,
+        zcf.atomicRearrange(
           harden([
             [collateralSeat, liqSeat, collateralSeat.getCurrentAllocation()],
             [bidHoldingSeat, liqSeat, bidHoldingSeat.getCurrentAllocation()],
@@ -501,7 +516,7 @@ export const start = async (zcf, privateArgs, baggage) => {
           reserveSeat,
           brand,
         );
-        atomicRearrange(zcf, harden(transfers));
+        zcf.atomicRearrange(harden(transfers));
 
         for (const { seat } of depositsForBrand) {
           seat.exit();
@@ -573,12 +588,11 @@ export const start = async (zcf, privateArgs, baggage) => {
     },
   });
 
-  // eslint-disable-next-line no-use-before-define
   const isActive = () => scheduler.getAuctionState() === AuctionState.ACTIVE;
 
   /**
    * @param {ZCFSeat} zcfSeat
-   * @param {{ goal: Amount<'nat'>}} offerArgs
+   * @param {{ goal: Amount<'nat'> }} offerArgs
    */
   const depositOfferHandler = (zcfSeat, offerArgs) => {
     const goalMatcher = M.or(undefined, { goal: bidAmountShape });
@@ -640,7 +654,6 @@ export const start = async (zcf, privateArgs, baggage) => {
         );
       },
       getSchedules() {
-        // eslint-disable-next-line no-use-before-define
         return scheduler.getSchedule();
       },
       getScheduleUpdates() {
@@ -678,7 +691,7 @@ export const start = async (zcf, privateArgs, baggage) => {
   const creatorFacet = makeFarGovernorFacet(
     Far('Auctioneer creatorFacet', {
       /**
-       * @param {Issuer} issuer
+       * @param {Issuer<'nat'>} issuer
        * @param {Keyword} kwd
        */
       async addBrand(issuer, kwd) {

package/src/auction/offerBook.d.ts

@@ -0,0 +1,46 @@
+export function prepareScaledBidBook(baggage: Baggage): (bidScalingPattern: Pattern, collateralBrand: globalThis.Brand) => import("@endo/exo").Guarded<{
+    /**
+     * @param {ZCFSeat} seat
+     * @param {Ratio} bidScaling
+     * @param {Amount<'nat'>} wanted
+     * @param {boolean} exitAfterBuy
+     */
+    add(seat: ZCFSeat, bidScaling: Ratio, wanted: Amount<"nat">, exitAfterBuy: boolean): string;
+    /** @param {Ratio} bidScaling */
+    offersAbove(bidScaling: Ratio): [string, BidderRecord][];
+    hasOrders(): boolean;
+    delete(key: any): void;
+    updateReceived(key: any, sold: any): void;
+    exitAllSeats(): void;
+}>;
+export function preparePriceBook(baggage: Baggage): (priceRatioPattern: Pattern, collateralBrand: globalThis.Brand) => import("@endo/exo").Guarded<{
+    /**
+     * @param {ZCFSeat} seat
+     * @param {Ratio} price
+     * @param {Amount<'nat'>} wanted
+     * @param {boolean} exitAfterBuy
+     */
+    add(seat: ZCFSeat, price: Ratio, wanted: Amount<"nat">, exitAfterBuy: boolean): string;
+    offersAbove(price: any): [string, BidderRecord][];
+    hasOrders(): boolean;
+    delete(key: any): void;
+    updateReceived(key: any, sold: any): void;
+    exitAllSeats(): void;
+}>;
+export type BidderRecord = {
+    seat: ZCFSeat;
+    wanted: Amount<"nat">;
+    seqNum: NatValue;
+    received: Amount<"nat">;
+} & {
+    exitAfterBuy: boolean;
+} & ({
+    bidScaling: Pattern;
+    price: undefined;
+} | {
+    bidScaling: undefined;
+    price: Ratio;
+});
+import type { Baggage } from '@agoric/vat-data';
+import type { Pattern } from '@endo/patterns';
+//# sourceMappingURL=offerBook.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"offerBook.d.ts","sourceRoot":"","sources":["offerBook.js"],"names":[],"mappings":"AAsDO,8CAFI,OAAO;IAkBZ;;;;;OAKG;cAJQ,OAAO,cACP,KAAK,UACL,MAAM,CAAC,KAAK,CAAC,gBACb,OAAO;IAsBlB,gCAAgC;4BAApB,KAAK;;;;;GAqCpB;AAcI,0CAFI,OAAO;IAkBZ;;;;;OAKG;cAJQ,OAAO,SACP,KAAK,UACL,MAAM,CAAC,KAAK,CAAC,gBACb,OAAO;;;;;;GA0DrB;2BAnMU;IACR,IAAI,EAAE,OAAO,CAAC;IACd,MAAM,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC;IACtB,MAAM,EAAE,QAAQ,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC;CACzB,GAAG;IAAE,YAAY,EAAE,OAAO,CAAA;CAAE,GAAG,CAC1B;IAAE,UAAU,EAAE,OAAO,CAAC;IAAC,KAAK,EAAE,SAAS,CAAA;CAAE,GACzC;IAAE,UAAU,EAAE,SAAS,CAAC;IAAC,KAAK,EAAE,KAAK,CAAA;CAAE,CAC1C;6BAtBoB,kBAAkB;6BACb,gBAAgB"}

package/src/auction/offerBook.js

@@ -12,7 +12,11 @@ import {
   toScaledRateOfferKey,
 } from './sortedOffers.js';
 
-/** @typedef {import('@agoric/vat-data').Baggage} Baggage */
+/**
+ * @import {MapStore} from '@agoric/store';
+ * @import {Baggage} from '@agoric/vat-data';
+ * @import {Key, Pattern} from '@endo/patterns';
+ */
 
 // multiple offers might be provided at the same time (since the time
 // granularity is limited to blocks), so we increment a sequenceNumber with each
@@ -25,12 +29,14 @@ const nextSequenceNumber = () => {
 
 /**
  * @typedef {{
- * seat: ZCFSeat,
- * wanted: Amount<'nat'>,
- * seqNum: NatValue,
- * received: Amount<'nat'>,
- * } &  {exitAfterBuy: boolean} & ({ bidScaling: Pattern, price: undefined } | { bidScaling: undefined, price: Ratio})
- * } BidderRecord
+ *   seat: ZCFSeat;
+ *   wanted: Amount<'nat'>;
+ *   seqNum: NatValue;
+ *   received: Amount<'nat'>;
+ * } & { exitAfterBuy: boolean } & (
+ *     | { bidScaling: Pattern; price: undefined }
+ *     | { bidScaling: undefined; price: Ratio }
+ *   )} BidderRecord
  */
 
 const ScaledBidBookStateShape = harden({
@@ -41,7 +47,8 @@ const ScaledBidBookStateShape = harden({
 
 /**
  * Prices in this book are expressed as percentage of the full oracle price
- * snapshot taken when the auction started. .4 is 60% off. 1.1 is 10% above par.
+ * snapshot taken when the auction started. .4 is 60% off. 1.1 is 10% above
+ * par.
  *
  * @param {Baggage} baggage
  */
@@ -51,7 +58,6 @@ export const prepareScaledBidBook = baggage =>
     'scaledBidBook',
     undefined,
     /**
-     *
      * @param {Pattern} bidScalingPattern
      * @param {Brand} collateralBrand
      */
@@ -134,8 +140,8 @@ const PriceBookStateShape = harden({
 });
 
 /**
- * Prices in this book are actual prices expressed in terms of bid amount
- * and collateral amount.
+ * Prices in this book are actual prices expressed in terms of bid amount and
+ * collateral amount.
  *
  * @param {Baggage} baggage
  */
@@ -145,7 +151,6 @@ export const preparePriceBook = baggage =>
     'priceBook',
     undefined,
     /**
-     *
      * @param {Pattern} priceRatioPattern
      * @param {Brand} collateralBrand
      */

package/src/auction/params.d.ts

@@ -0,0 +1,145 @@
+/**
+ * @import {AsyncSpecTuple} from '@agoric/governance/src/contractGovernance/typedParamManager.js';
+ * @import {SyncSpecTuple} from '@agoric/governance/src/contractGovernance/typedParamManager.js';
+ * @import {PriceAuthority, PriceDescription, PriceQuote, PriceQuoteValue, PriceQuery,} from '@agoric/zoe/tools/types.js';
+ */
+export const InvitationShape: import("@endo/patterns").Matcher;
+/**
+ * In seconds, how often to start an auction. The auction will start at
+ * AUCTION_START_DELAY seconds after a multiple of START_FREQUENCY, with the
+ * price at STARTING_RATE_BP. Every CLOCK_STEP, the price will be reduced by
+ * DISCOUNT_STEP_BP, as long as the rate is at or above LOWEST_RATE_BP, or until
+ * START_FREQUENCY has elapsed.
+ */
+export const START_FREQUENCY: "StartFrequency";
+/** in seconds, how often to reduce the price */
+export const CLOCK_STEP: "ClockStep";
+/** discount or markup for starting price in basis points. 9999 = 1bp discount */
+export const STARTING_RATE_BP: "StartingRate";
+/** A limit below which the price will not be discounted. */
+export const LOWEST_RATE_BP: "LowestRate";
+/** amount to reduce prices each time step in bp, as % of the start price */
+export const DISCOUNT_STEP_BP: "DiscountStep";
+/**
+ * VaultManagers liquidate vaults at a frequency configured by START_FREQUENCY.
+ * Auctions start this long after the hour to give vaults time to finish.
+ */
+export const AUCTION_START_DELAY: "AuctionStartDelay";
+export const PRICE_LOCK_PERIOD: "PriceLockPeriod";
+export const auctioneerParamPattern: import("@endo/patterns").Matcher;
+export namespace auctioneerParamTypes {
+    let Electorate: "invitation";
+    let StartFrequency: "relativeTime";
+    let ClockStep: "relativeTime";
+    let StartingRate: "nat";
+    let LowestRate: "nat";
+    let DiscountStep: "nat";
+    let AuctionStartDelay: "relativeTime";
+    let PriceLockPeriod: "relativeTime";
+}
+export function makeAuctioneerParams({ ElectorateInvitationAmount, StartFrequency, ClockStep, LowestRate, StartingRate, DiscountStep, AuctionStartDelay, PriceLockPeriod, TimerBrand, }: AuctionParams): {
+    Electorate: {
+        type: "invitation";
+        value: import("@agoric/ertp").SetAmount<import("@endo/patterns").Key>;
+    };
+    StartFrequency: {
+        type: "relativeTime";
+        value: import("@agoric/time").RelativeTimeRecord;
+    };
+    ClockStep: {
+        type: "relativeTime";
+        value: import("@agoric/time").RelativeTimeRecord;
+    };
+    AuctionStartDelay: {
+        type: "relativeTime";
+        value: import("@agoric/time").RelativeTimeRecord;
+    };
+    PriceLockPeriod: {
+        type: "relativeTime";
+        value: import("@agoric/time").RelativeTimeRecord;
+    };
+    StartingRate: {
+        type: "nat";
+        value: bigint;
+    };
+    LowestRate: {
+        type: "nat";
+        value: bigint;
+    };
+    DiscountStep: {
+        type: "nat";
+        value: bigint;
+    };
+};
+export function makeAuctioneerParamManager(publisherKit: import("@agoric/notifier").StoredPublisherKit<GovernanceSubscriptionState>, zcf: ZCF, initial: AuctionParams): import("@agoric/governance/src/contractGovernance/typedParamManager.js").TypedParamManager<{
+    Electorate: "invitation";
+    StartFrequency: "relativeTime";
+    ClockStep: "relativeTime";
+    StartingRate: "nat";
+    LowestRate: "nat";
+    DiscountStep: "nat";
+    AuctionStartDelay: "relativeTime";
+    PriceLockPeriod: "relativeTime";
+}>;
+export function makeGovernedTerms({ storageNode: _storageNode, marshaller: _marshaller }: {
+    storageNode: ERef<StorageNode>;
+    marshaller: ERef<Marshaller>;
+}, timer: ERef<import("@agoric/time").TimerService>, priceAuthority: ERef<PriceAuthority>, reservePublicFacet: ERef<AssetReservePublicFacet>, params: AuctionParams): {
+    priceAuthority: globalThis.ERef<PriceAuthority>;
+    reservePublicFacet: globalThis.ERef<globalThis.GovernedPublicFacet<import("@endo/exo").Guarded<{
+        makeAddCollateralInvitation(): Promise<globalThis.Invitation<string, never>>;
+        getPublicTopics(): {
+            metrics: import("@agoric/zoe/src/contractSupport").PublicTopic<import("../reserve/assetReserveKit").MetricsNotification>;
+        };
+    }>>>;
+    timerService: globalThis.ERef<import("@agoric/time").TimerService>;
+    governedParams: {
+        Electorate: {
+            type: "invitation";
+            value: import("@agoric/ertp").SetAmount<import("@endo/patterns").Key>;
+        };
+        StartFrequency: {
+            type: "relativeTime";
+            value: import("@agoric/time").RelativeTimeRecord;
+        };
+        ClockStep: {
+            type: "relativeTime";
+            value: import("@agoric/time").RelativeTimeRecord;
+        };
+        AuctionStartDelay: {
+            type: "relativeTime";
+            value: import("@agoric/time").RelativeTimeRecord;
+        };
+        PriceLockPeriod: {
+            type: "relativeTime";
+            value: import("@agoric/time").RelativeTimeRecord;
+        };
+        StartingRate: {
+            type: "nat";
+            value: bigint;
+        };
+        LowestRate: {
+            type: "nat";
+            value: bigint;
+        };
+        DiscountStep: {
+            type: "nat";
+            value: bigint;
+        };
+    };
+};
+export type AuctionParams = {
+    ElectorateInvitationAmount: Amount<"set">;
+    StartFrequency: RelativeTime;
+    ClockStep: RelativeTime;
+    StartingRate: bigint;
+    LowestRate: bigint;
+    DiscountStep: bigint;
+    AuctionStartDelay: RelativeTime;
+    PriceLockPeriod: RelativeTime;
+    TimerBrand: import("@agoric/time").TimerBrand;
+};
+export type AuctionParamRecord = ReturnType<typeof makeAuctioneerParams>;
+export type AuctionParamManager = ReturnType<typeof makeAuctioneerParamManager>;
+import type { PriceAuthority } from '@agoric/zoe/tools/types.js';
+//# sourceMappingURL=params.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"params.d.ts","sourceRoot":"","sources":["params.js"],"names":[],"mappings":"AAQA;;;;GAIG;AAGH,+DAAyD;AAEzD;;;;;;GAMG;AACH,8BAA+B,gBAAgB,CAAC;AAChD,gDAAgD;AAChD,yBAA0B,WAAW,CAAC;AACtC,iFAAiF;AACjF,+BAAgC,cAAc,CAAC;AAC/C,4DAA4D;AAC5D,6BAA8B,YAAY,CAAC;AAC3C,4EAA4E;AAC5E,+BAAgC,cAAc,CAAC;AAC/C;;;GAGG;AACH,kCAAmC,mBAAmB,CAAC;AAIvD,gCAAiC,iBAAiB,CAAC;AAEnD,sEASG;;;;;;;;;;;AA2BI,yLADK,aAAa;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAqCxB;AAQM,yDAJI,OAAO,kBAAkB,EAAE,kBAAkB,CAAC,2BAA2B,CAAC,OAC1E,GAAG,WACH,aAAa;;;;;;;;;GA0BvB;AAWM,0FANI;IAAE,WAAW,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;IAAC,UAAU,EAAE,IAAI,CAAC,UAAU,CAAC,CAAA;CAAE,SAChE,IAAI,CAAC,OAAO,cAAc,EAAE,YAAY,CAAC,kBACzC,IAAI,CAAC,cAAc,CAAC,sBACpB,IAAI,CAAC,uBAAuB,CAAC,UAC7B,aAAa;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAgBvB;;gCAzGa,MAAM,CAAC,KAAK,CAAC;oBACb,YAAY;eACZ,YAAY;kBACZ,MAAM;gBACN,MAAM;kBACN,MAAM;uBACN,YAAY;qBACZ,YAAY;gBACZ,OAAO,cAAc,EAAE,UAAU;;iCA0EjC,UAAU,CAAC,OAAO,oBAAoB,CAAC;kCA0BvC,UAAU,CAAC,OAAO,0BAA0B,CAAC;oCApKkC,4BAA4B"}