@agoric/inter-protocol 0.13.3 → 0.13.4-dev-800c2bb.0

package/src/auction/scheduler.js

@@ -0,0 +1,370 @@
+import { E } from '@endo/eventual-send';
+import { TimeMath } from '@agoric/time';
+import { Far } from '@endo/marshal';
+import { makeTracer } from '@agoric/internal';
+import { observeIteration, subscribeEach } from '@agoric/notifier';
+
+import { AuctionState, makeCancelTokenMaker } from './util.js';
+import {
+  computeRoundTiming,
+  nextDescendingStepTime,
+  timeVsSchedule,
+} from './scheduleMath.js';
+
+const { details: X, Fail, quote: q } = assert;
+
+const trace = makeTracer('SCHED', true);
+
+// If the startAuction wakeup is no more than 5 minutes late, go ahead with it.
+const MAX_LATE_TICK = 300n;
+
+/**
+ * @file The scheduler is presumed to be quiescent between auction rounds. Each
+ * Auction round consists of a sequence of steps with decreasing prices. There
+ * should always be a next schedule, but between rounds, liveSchedule is null.
+ *
+ * The lock period that the liquidators use might start before the previous
+ * round has finished, so we need to schedule the next round each time an
+ * auction starts. This means if the scheduling parameters change, it'll be a
+ * full cycle before we switch. Otherwise, the vaults wouldn't know when to
+ * start their lock period. If the lock period for the next auction hasn't
+ * started when each aucion ends, we recalculate it, in case the parameters have
+ * changed.
+ *
+ * If the clock skips forward (because of a chain halt, for instance), the
+ * scheduler will try to cleanly and quickly finish any round already in
+ * progress. It would take additional work on the manual timer to test this
+ * thoroughly.
+ */
+
+const makeCancelToken = makeCancelTokenMaker('scheduler');
+
+/**
+ * @typedef {object} AuctionDriver
+ * @property {() => void} reducePriceAndTrade
+ * @property {() => void} finalize
+ * @property {() => void} startRound
+ * @property {() => void} capturePrices
+ */
+
+/**
+ * @typedef {object} ScheduleNotification
+ *
+ * @property {Timestamp | null} activeStartTime start time of current
+ *    auction if auction is active
+ * @property {Timestamp | null} nextStartTime start time of next auction
+ * @property {Timestamp | null} nextDescendingStepTime when the next descending step
+ *    will take place
+ */
+
+const safelyComputeRoundTiming = (params, baseTime) => {
+  try {
+    return computeRoundTiming(params, baseTime);
+  } catch (e) {
+    console.error('🚨 No Next Auction', e);
+    return null;
+  }
+};
+
+const nominalStartTime = nextSchedule =>
+  TimeMath.subtractAbsRel(nextSchedule.startTime, nextSchedule.startDelay);
+
+/**
+ * @param {AuctionDriver} auctionDriver
+ * @param {import('@agoric/time/src/types').TimerService} timer
+ * @param {Awaited<import('./params.js').AuctionParamManager>} params
+ * @param {import('@agoric/time/src/types').TimerBrand} timerBrand
+ * @param {import('@agoric/zoe/src/contractSupport/recorder.js').Recorder<ScheduleNotification>} scheduleRecorder
+ * @param {StoredSubscription<GovernanceSubscriptionState>} paramUpdateSubscription
+ */
+export const makeScheduler = async (
+  auctionDriver,
+  timer,
+  params,
+  timerBrand,
+  scheduleRecorder,
+  paramUpdateSubscription,
+) => {
+  /**
+   * live version is defined when an auction is active.
+   *
+   * @type {Schedule | null}
+   */
+  let liveSchedule = null;
+
+  /** @returns {Promise<{ now: Timestamp, nextSchedule: Schedule | null }>} */
+  const initializeNextSchedule = async () => {
+    return E.when(
+      // XXX manualTimer returns a bigint, not a timeRecord.
+      E(timer).getCurrentTimestamp(),
+      now => {
+        const nextSchedule = safelyComputeRoundTiming(
+          params,
+          TimeMath.coerceTimestampRecord(now, timerBrand),
+        );
+        return { now, nextSchedule };
+      },
+    );
+  };
+  let { now, nextSchedule } = await initializeNextSchedule();
+  const setTimeMonotonically = time => {
+    TimeMath.compareAbs(time, now) >= 0 || Fail`Time only moves forward`;
+    now = time;
+  };
+
+  const stepCancelToken = makeCancelToken();
+
+  /** @type {typeof AuctionState[keyof typeof AuctionState]} */
+  let auctionState = AuctionState.WAITING;
+
+  /**
+   * Publish the schedule. To be called after clockTick() (which processes a
+   * descending step) or when the next round is scheduled.
+   */
+  const publishSchedule = () => {
+    const sched = harden({
+      activeStartTime: liveSchedule?.startTime || null,
+      nextStartTime: nextSchedule?.startTime || null,
+      nextDescendingStepTime: nextDescendingStepTime(
+        liveSchedule,
+        nextSchedule,
+        now,
+      ),
+    });
+    return scheduleRecorder.write(sched);
+  };
+
+  /**
+   * @param {Schedule | null} schedule
+   * @returns {void}
+   */
+  const clockTick = schedule => {
+    trace('clockTick', schedule?.startTime, now);
+    if (!schedule) {
+      return;
+    }
+
+    /** @type {() => void} */
+    const finishAuctionRound = () => {
+      auctionState = AuctionState.WAITING;
+      auctionDriver.finalize();
+
+      if (nextSchedule) {
+        // only recalculate the next schedule at this point if the lock time has
+        // not been reached.
+        const nextLock = nextSchedule.lockTime;
+        if (nextLock && TimeMath.compareAbs(now, nextLock) < 0) {
+          const afterNow = TimeMath.addAbsRel(
+            now,
+            TimeMath.coerceRelativeTimeRecord(1n, timerBrand),
+          );
+          nextSchedule = safelyComputeRoundTiming(params, afterNow);
+        }
+      } else {
+        console.error(
+          '🛠️ finishAuctionRound without scheduling the next; repair with new auctioneer params',
+        );
+      }
+
+      liveSchedule = null;
+
+      // Async because a remote call. In rare event of failure, wakeup is robust.
+      void E(timer).cancel(stepCancelToken);
+    };
+
+    const advanceRound = () => {
+      if (auctionState === AuctionState.ACTIVE) {
+        auctionDriver.reducePriceAndTrade();
+      } else {
+        auctionState = AuctionState.ACTIVE;
+        try {
+          auctionDriver.startRound();
+          // This has been observed to fail because prices hadn't been locked.
+          // This may be an issue about timing during chain start-up.
+        } catch (err) {
+          console.error(
+            'Unable to start auction cleanly. skipping this auction round.',
+            err,
+          );
+        }
+      }
+    };
+
+    switch (timeVsSchedule(now, schedule)) {
+      case 'before':
+        break;
+      case 'during':
+        advanceRound();
+        break;
+      case 'endExactly':
+        // do both the "during" and "after" behaviors
+        advanceRound();
+        finishAuctionRound();
+        break;
+      case 'after':
+        finishAuctionRound();
+        break;
+      default:
+        Fail`invalid case`;
+    }
+
+    void publishSchedule();
+  };
+
+  // set wakeups for the steps of this round
+  const scheduleDescendingSteps = () => {
+    if (!liveSchedule) {
+      console.error('🚨 scheduleDescendingSteps called with no liveSchedule');
+      return;
+    }
+
+    const { startTime } = liveSchedule;
+    trace('START ', startTime);
+
+    const delayFromNow =
+      TimeMath.compareAbs(startTime, now) > 0
+        ? TimeMath.subtractAbsAbs(startTime, now)
+        : TimeMath.subtractAbsAbs(startTime, startTime);
+
+    trace('scheduleDescendingSteps repeating', now, delayFromNow, startTime);
+
+    void E(timer).repeatAfter(
+      delayFromNow,
+      liveSchedule.clockStep,
+      Far('PriceStepWaker', {
+        wake(time) {
+          setTimeMonotonically(time);
+          trace('wake step', now);
+          void clockTick(liveSchedule);
+        },
+      }),
+      stepCancelToken,
+    );
+  };
+
+  // schedule a wakeup for the next round
+  const scheduleNextRound = start => {
+    trace(`nextRound`, start);
+    void E(timer).setWakeup(
+      start,
+      Far('SchedulerWaker', {
+        wake(time) {
+          setTimeMonotonically(time);
+          auctionDriver.capturePrices();
+          // eslint-disable-next-line no-use-before-define
+          return startAuction();
+        },
+      }),
+    );
+    void publishSchedule();
+  };
+
+  const relativeTime = t => TimeMath.coerceRelativeTimeRecord(t, timerBrand);
+
+  const startAuction = async () => {
+    !liveSchedule || Fail`can't start an auction round while one is active`;
+
+    if (!nextSchedule) {
+      console.error(
+        assert.error(X`tried to start auction when none is scheduled`),
+      );
+      return;
+    }
+
+    // The clock tick may have arrived too late to trigger the next scheduled
+    // round, for example because of a chain halt.  When this happens the oracle
+    // quote may out of date and so must be ignored. Recover by returning
+    // deposits and scheduling the next round. If it's only a little late,
+    // continue with auction, just starting late.
+    const nominalStart = nominalStartTime(nextSchedule);
+    if (TimeMath.compareAbs(now, nominalStart) > 0) {
+      const late = TimeMath.subtractAbsAbs(now, nominalStart);
+      const maxLate = relativeTime(MAX_LATE_TICK);
+
+      if (TimeMath.compareRel(late, maxLate) > 0) {
+        console.warn(
+          `Auction time jumped to ${q(now)} before next scheduled start ${q(
+            nextSchedule.startTime,
+          )}. Skipping that round.`,
+        );
+        nextSchedule = safelyComputeRoundTiming(params, now);
+      } else {
+        console.warn(`Auction started late by ${q(late)}. Starting ${q(now)}`);
+      }
+    }
+
+    if (!nextSchedule) {
+      // nothing new to schedule
+      return;
+    }
+    // activate the nextSchedule as the live one
+    // (read here and in function calls below)
+    liveSchedule = nextSchedule;
+    scheduleDescendingSteps();
+    nextSchedule = safelyComputeRoundTiming(
+      params,
+      TimeMath.addAbsRel(liveSchedule.endTime, relativeTime(1n)),
+    );
+
+    if (nextSchedule) {
+      scheduleNextRound(nominalStartTime(nextSchedule));
+    } else {
+      console.warn(
+        'no nextSchedule so cannot schedule next round or price capture',
+      );
+    }
+  };
+
+  // initial setting:  firstStart is startDelay before next's startTime
+  const startSchedulingFromScratch = () => {
+    trace('startSchedulingFromScratch');
+    if (nextSchedule) {
+      scheduleNextRound(nominalStartTime(nextSchedule));
+    }
+  };
+  startSchedulingFromScratch();
+
+  // when auction parameters change, schedule a next auction if one isn't
+  // already scheduled.
+  // NB: what is already scheduled (live or next) is unaffected by param changes
+  void observeIteration(
+    subscribeEach(paramUpdateSubscription),
+    harden({
+      // NB: may be fired with the initial params as well
+      async updateState(_newState) {
+        trace('received param update', _newState);
+        if (!nextSchedule) {
+          trace('repairing nextSchedule and restarting');
+          ({ nextSchedule } = await initializeNextSchedule());
+          startSchedulingFromScratch();
+        }
+      },
+    }),
+  );
+
+  return Far('scheduler', {
+    getSchedule: () =>
+      harden({
+        liveAuctionSchedule: liveSchedule,
+        nextAuctionSchedule: nextSchedule,
+      }),
+    getAuctionState: () => auctionState,
+  });
+};
+
+/**
+ * @typedef {object} Schedule
+ * @property {import('@agoric/time/src/types').TimestampRecord} startTime
+ * @property {import('@agoric/time/src/types').TimestampRecord} endTime
+ * @property {NatValue} steps
+ * @property {NatValue} endRate
+ * @property {RelativeTime} startDelay
+ * @property {RelativeTime} clockStep
+ * @property {Timestamp} [lockTime]
+ */
+
+/**
+ * @typedef {object} FullSchedule
+ * @property {Schedule | null} nextAuctionSchedule
+ * @property {Schedule | null} liveAuctionSchedule
+ */

package/src/auction/sortedOffers.js

@@ -0,0 +1,136 @@
+// @jessie-check
+
+import {
+  makeRatio,
+  ratioToNumber,
+} from '@agoric/zoe/src/contractSupport/index.js';
+import { M, mustMatch } from '@agoric/store';
+import { RatioShape } from '@agoric/ertp';
+
+import { decodeData, encodeData } from '../vaultFactory/storeUtils.js';
+
+const { Fail } = assert;
+
+/**
+ * @file we use a floating point representation of the price or rate as the
+ * first part of the key in the store. The second part is the sequence number of
+ * the bid, but it doesn't matter for sorting. When we retrieve multiple bids,
+ * it's only by bid value, so we don't care how the sequence numbers sort.
+ *
+ * We take advantage of the fact that encodeData takes a passable and turns it
+ * into a sort key. Arrays of passable data sort like composite keys.
+ */
+
+/**
+ * Return a sort key that will compare based only on price. Price is the prefix
+ * of the complete sort key, which is sufficient to find offers below a cutoff.
+ *
+ * @param {Ratio} offerPrice
+ */
+export const toPartialOfferKey = offerPrice => {
+  assert(offerPrice);
+  const mostSignificantPart = ratioToNumber(offerPrice);
+  return encodeData(harden([mostSignificantPart, 0n]));
+};
+
+/**
+ * Return a sort key that distinguishes by Price and sequence number
+ *
+ * @param {Ratio} offerPrice IST/collateral
+ * @param {bigint} sequenceNumber
+ * @returns {string} lexically sortable string in which highest price is first,
+ *    ties will be broken by sequenceNumber of offer
+ */
+export const toPriceOfferKey = (offerPrice, sequenceNumber) => {
+  mustMatch(offerPrice, RatioShape);
+  offerPrice.numerator.brand !== offerPrice.denominator.brand ||
+    Fail`offer prices must have different numerator and denominator`;
+  mustMatch(sequenceNumber, M.nat());
+
+  const mostSignificantPart = ratioToNumber(offerPrice);
+  return encodeData(harden([mostSignificantPart, sequenceNumber]));
+};
+
+/**
+ * @param {number} floatPrice
+ * @param {Brand<'nat'>} numBrand
+ * @param {Brand<'nat'>} denomBrand
+ * @param {number} useDecimals
+ * @returns {Ratio}
+ */
+const priceRatioFromFloat = (floatPrice, numBrand, denomBrand, useDecimals) => {
+  const denominatorValue = 10 ** useDecimals;
+  return makeRatio(
+    BigInt(Math.round(floatPrice * denominatorValue)),
+    numBrand,
+    BigInt(denominatorValue),
+    denomBrand,
+  );
+};
+
+const bidScalingRatioFromKey = (bidScaleFloat, numBrand, useDecimals) => {
+  const denominatorValue = 10 ** useDecimals;
+  return makeRatio(
+    BigInt(Math.round(bidScaleFloat * denominatorValue)),
+    numBrand,
+    BigInt(denominatorValue),
+  );
+};
+
+/**
+ * fromPriceOfferKey is only used for diagnostics.
+ *
+ * @param {string} key
+ * @param {Brand<'nat'>} numBrand
+ * @param {Brand<'nat'>} denomBrand
+ * @param {number} useDecimals
+ * @returns {[normalizedPrice: Ratio, sequenceNumber: bigint]}
+ */
+export const fromPriceOfferKey = (key, numBrand, denomBrand, useDecimals) => {
+  const [pricePart, sequenceNumberPart] = decodeData(key);
+  return [
+    priceRatioFromFloat(pricePart, numBrand, denomBrand, useDecimals),
+    sequenceNumberPart,
+  ];
+};
+
+/** @type {(rate: Ratio) => string} */
+export const toBidScalingComparator = rate => {
+  assert(rate);
+  const mostSignificantPart = ratioToNumber(rate);
+  return encodeData(harden([mostSignificantPart, 0n]));
+};
+
+/**
+ * Sorts offers expressed as percentage of the current oracle price.
+ *
+ * @param {Ratio} rate discount/markup rate expressed as a ratio IST/IST
+ * @param {bigint} sequenceNumber
+ * @returns {string} lexically sortable string in which highest price is first,
+ *    ties will be broken by sequenceNumber of offer
+ */
+export const toScaledRateOfferKey = (rate, sequenceNumber) => {
+  mustMatch(rate, RatioShape);
+  rate.numerator.brand === rate.denominator.brand ||
+    Fail`bid scaling rate must have the same numerator and denominator`;
+  mustMatch(sequenceNumber, M.nat());
+
+  const mostSignificantPart = ratioToNumber(rate);
+  return encodeData(harden([mostSignificantPart, sequenceNumber]));
+};
+
+/**
+ * fromScaledRateOfferKey is only used for diagnostics.
+ *
+ * @param {string} key
+ * @param {Brand} brand
+ * @param {number} useDecimals
+ * @returns {[normalizedPrice: Ratio, sequenceNumber: bigint]}
+ */
+export const fromScaledRateOfferKey = (key, brand, useDecimals) => {
+  const [bidScalingPart, sequenceNumberPart] = decodeData(key);
+  return [
+    bidScalingRatioFromKey(bidScalingPart, brand, useDecimals),
+    sequenceNumberPart,
+  ];
+};

package/src/auction/util.js

@@ -0,0 +1,55 @@
+// @jessie-check
+
+import {
+  makeRatioFromAmounts,
+  multiplyRatios,
+  ratioGTE,
+} from '@agoric/zoe/src/contractSupport/index.js';
+import { Far } from '@endo/marshal';
+
+/**
+ * Constants for Auction State.
+ *
+ * @type {{ ACTIVE: 'active', WAITING: 'waiting' }}
+ */
+export const AuctionState = {
+  ACTIVE: 'active',
+  WAITING: 'waiting',
+};
+
+/**
+ * @param {{ brand: Brand, value: Pattern }} numeratorAmountShape
+ * @param {{ brand: Brand, value: Pattern }} denominatorAmountShape
+ */
+export const makeBrandedRatioPattern = (
+  numeratorAmountShape,
+  denominatorAmountShape,
+) => {
+  return harden({
+    numerator: numeratorAmountShape,
+    denominator: denominatorAmountShape,
+  });
+};
+
+/**
+ * @param {Ratio} bidScaling
+ * @param {Ratio} currentPrice
+ * @param {Ratio} oraclePrice
+ * @returns {boolean} TRUE iff the discount(/markup) applied to the price is
+ *          higher than the quote.
+ */
+export const isScaledBidPriceHigher = (bidScaling, currentPrice, oraclePrice) =>
+  ratioGTE(multiplyRatios(oraclePrice, bidScaling), currentPrice);
+
+/** @type {(quote: PriceQuote) => Ratio} */
+export const priceFrom = quote =>
+  makeRatioFromAmounts(
+    quote.quoteAmount.value[0].amountOut,
+    quote.quoteAmount.value[0].amountIn,
+  );
+
+export const makeCancelTokenMaker = name => {
+  let tokenCount = 1;
+
+  return () => Far(`cancelToken-${name}-${(tokenCount += 1)}`, {});
+};