@agoric/inter-protocol 0.13.2-dev-606cbd2.0 → 0.13.2-dev-8d17cce.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@agoric/inter-protocol",
-  "version": "0.13.2-dev-606cbd2.0+606cbd2",
+  "version": "0.13.2-dev-8d17cce.0+8d17cce",
   "description": "Core cryptoeconomy contracts",
   "type": "module",
   "main": "src/index.js",
@@ -29,29 +29,29 @@
   },
   "homepage": "https://github.com/Agoric/agoric-sdk#readme",
   "dependencies": {
-    "@agoric/assert": "0.5.2-dev-606cbd2.0+606cbd2",
-    "@agoric/ertp": "0.15.4-dev-606cbd2.0+606cbd2",
-    "@agoric/governance": "0.9.2-dev-606cbd2.0+606cbd2",
-    "@agoric/internal": "0.2.2-dev-606cbd2.0+606cbd2",
-    "@agoric/notifier": "0.5.2-dev-606cbd2.0+606cbd2",
-    "@agoric/store": "0.8.4-dev-606cbd2.0+606cbd2",
-    "@agoric/time": "0.2.2-dev-606cbd2.0+606cbd2",
-    "@agoric/vat-data": "0.4.4-dev-606cbd2.0+606cbd2",
-    "@agoric/vats": "0.13.1-dev-606cbd2.0+606cbd2",
-    "@agoric/zoe": "0.25.4-dev-606cbd2.0+606cbd2",
+    "@agoric/assert": "0.5.2-dev-8d17cce.0+8d17cce",
+    "@agoric/ertp": "0.15.4-dev-8d17cce.0+8d17cce",
+    "@agoric/governance": "0.9.2-dev-8d17cce.0+8d17cce",
+    "@agoric/internal": "0.2.2-dev-8d17cce.0+8d17cce",
+    "@agoric/notifier": "0.5.2-dev-8d17cce.0+8d17cce",
+    "@agoric/store": "0.8.4-dev-8d17cce.0+8d17cce",
+    "@agoric/time": "0.2.2-dev-8d17cce.0+8d17cce",
+    "@agoric/vat-data": "0.4.4-dev-8d17cce.0+8d17cce",
+    "@agoric/vats": "0.13.1-dev-8d17cce.0+8d17cce",
+    "@agoric/zoe": "0.25.4-dev-8d17cce.0+8d17cce",
     "@endo/captp": "^3.1.1",
     "@endo/eventual-send": "^0.17.2",
     "@endo/far": "^0.2.18",
     "@endo/marshal": "^0.8.5",
     "@endo/nat": "^4.1.27",
-    "agoric": "0.18.3-dev-606cbd2.0+606cbd2",
+    "agoric": "0.18.3-dev-8d17cce.0+8d17cce",
     "jessie.js": "^0.3.2"
   },
   "devDependencies": {
-    "@agoric/deploy-script-support": "0.9.5-dev-606cbd2.0+606cbd2",
-    "@agoric/smart-wallet": "0.4.3-dev-606cbd2.0+606cbd2",
-    "@agoric/swingset-liveslots": "0.9.1-dev-606cbd2.0+606cbd2",
-    "@agoric/swingset-vat": "0.30.3-dev-606cbd2.0+606cbd2",
+    "@agoric/deploy-script-support": "0.9.5-dev-8d17cce.0+8d17cce",
+    "@agoric/smart-wallet": "0.4.3-dev-8d17cce.0+8d17cce",
+    "@agoric/swingset-liveslots": "0.9.1-dev-8d17cce.0+8d17cce",
+    "@agoric/swingset-vat": "0.30.3-dev-8d17cce.0+8d17cce",
     "@endo/bundle-source": "^2.5.1",
     "@endo/init": "^0.5.56",
     "@endo/promise-kit": "^0.2.56",
@@ -77,5 +77,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "606cbd2c4b76ca1b5ce1b2488cbeab9bdd5a31ec"
+  "gitHead": "8d17ccef5b83f5feff95318e234067d1866edd8d"
 }

package/scripts/add-collateral-core.js

@@ -5,6 +5,7 @@ import { getManifestForAddAssetToVault } from '../src/proposals/addAssetToVault.
 import { getManifestForPsm } from '../src/proposals/startPSM.js';
 import { makeInstallCache } from '../src/proposals/utils.js';
 
+/** @type {import('@agoric/deploy-script-support/src/externalTypes.js').ProposalBuilder} */
 export const defaultProposalBuilder = async (
   { publishRef, install: install0, wrapInstall },
   {
@@ -59,6 +60,7 @@ export const defaultProposalBuilder = async (
   });
 };
 
+/** @type {import('@agoric/deploy-script-support/src/externalTypes.js').ProposalBuilder} */
 export const psmProposalBuilder = async (
   { publishRef, install: install0, wrapInstall },
   { anchorOptions = /** @type {object} */ ({}) } = {},

package/scripts/init-core.js

@@ -121,6 +121,7 @@ export const mainProposalBuilder = async ({
 };
 
 // Build proposal for sim-chain etc.
+/** @type {import('@agoric/deploy-script-support/src/externalTypes.js').ProposalBuilder} */
 export const defaultProposalBuilder = async (
   { publishRef, install },
   options = {},

package/scripts/invite-committee-core.js

@@ -4,6 +4,7 @@ import { makeHelpers } from '@agoric/deploy-script-support';
 import { getManifestForInviteCommittee } from '../src/proposals/committee-proposal.js';
 
 // Build proposal for sim-chain etc.
+/** @type {import('@agoric/deploy-script-support/src/externalTypes.js').ProposalBuilder} */
 export const defaultProposalBuilder = async (
   { publishRef, install },
   options = {},

package/scripts/price-feed-core.js

@@ -11,6 +11,7 @@ const DEFAULT_CONTRACT_TERMS = {
   maxSubmissionValue: 2n ** 256n,
 };
 
+/** @type {import('@agoric/deploy-script-support/src/externalTypes.js').ProposalBuilder} */
 export const defaultProposalBuilder = async (
   { publishRef, install },
   options = {},

package/src/auction/auctionBook.js

@@ -358,7 +358,7 @@ export const prepareAuctionBook = (baggage, zcf, makeRecorderKit) => {
         ) {
           const { priceBook, curAuctionPrice } = this.state;
           const { helper } = this.facets;
-          trace('acceptPrice');
+          trace(this.state.collateralBrand, 'acceptPrice');
 
           const settleIfPriceExists = () => {
             if (curAuctionPrice !== null) {
@@ -383,7 +383,7 @@ export const prepareAuctionBook = (baggage, zcf, makeRecorderKit) => {
             priceBook.add(seat, price, stillWant, exitAfterBuy);
           }
 
-          helper.publishBookData();
+          void helper.publishBookData();
         },
 
         /**
@@ -404,7 +404,7 @@ export const prepareAuctionBook = (baggage, zcf, makeRecorderKit) => {
           maxBuy,
           { trySettle, exitAfterBuy = false },
         ) {
-          trace('accept scaledBid offer');
+          trace(this.state.collateralBrand, 'accept scaledBid offer');
           const { curAuctionPrice, lockedPriceForRound, scaledBidBook } =
             this.state;
           const { helper } = this.facets;
@@ -437,7 +437,7 @@ export const prepareAuctionBook = (baggage, zcf, makeRecorderKit) => {
             scaledBidBook.add(seat, bidScaling, stillWant, exitAfterBuy);
           }
 
-          helper.publishBookData();
+          void helper.publishBookData();
         },
         publishBookData() {
           const { state } = this;
@@ -457,7 +457,7 @@ export const prepareAuctionBook = (baggage, zcf, makeRecorderKit) => {
             collateralAvailable,
             currentPriceLevel: state.curAuctionPrice,
           });
-          state.bookDataKit.recorder.write(bookData);
+          return state.bookDataKit.recorder.write(bookData);
         },
       },
       self: {
@@ -534,13 +534,13 @@ export const prepareAuctionBook = (baggage, zcf, makeRecorderKit) => {
           state.startCollateral = state.startCollateral
             ? AmountMath.add(state.startCollateral, assetAmount)
             : assetAmount;
-          facets.helper.publishBookData();
+          void facets.helper.publishBookData();
         },
         /** @type {(reduction: Ratio) => void} */
         settleAtNewRate(reduction) {
           const { state, facets } = this;
 
-          trace('settleAtNewRate', reduction);
+          trace(this.state.collateralBrand, 'settleAtNewRate', reduction);
           const { lockedPriceForRound, priceBook, scaledBidBook } = state;
           lockedPriceForRound !== null ||
             Fail`price must be locked before auction starts`;
@@ -601,7 +601,7 @@ export const prepareAuctionBook = (baggage, zcf, makeRecorderKit) => {
             }
           }
 
-          facets.helper.publishBookData();
+          void facets.helper.publishBookData();
         },
         getCurrentPrice() {
           return this.state.curAuctionPrice;
@@ -615,7 +615,7 @@ export const prepareAuctionBook = (baggage, zcf, makeRecorderKit) => {
 
           trace(`locking `, state.updatingOracleQuote);
           state.lockedPriceForRound = state.updatingOracleQuote;
-          facets.helper.publishBookData();
+          void facets.helper.publishBookData();
         },
 
         setStartingRate(rate) {
@@ -689,7 +689,7 @@ export const prepareAuctionBook = (baggage, zcf, makeRecorderKit) => {
           state.curAuctionPrice = null;
           state.remainingProceedsGoal = null;
           state.startProceedsGoal = null;
-          facets.helper.publishBookData();
+          void facets.helper.publishBookData();
         },
         getDataUpdates() {
           return this.state.bookDataKit.subscriber;
@@ -738,7 +738,7 @@ export const prepareAuctionBook = (baggage, zcf, makeRecorderKit) => {
             });
           },
         );
-        facets.helper.publishBookData();
+        void facets.helper.publishBookData();
       },
       stateShape: AuctionBookStateShape,
     },

package/src/auction/auctioneer.js

@@ -573,16 +573,7 @@ export const start = async (zcf, privateArgs, baggage) => {
     },
   });
 
-  const scheduler = await E.when(scheduleKit.recorderP, scheduleRecorder =>
-    makeScheduler(
-      driver,
-      timer,
-      // @ts-expect-error types are correct. How to convince TS?
-      params,
-      timerBrand,
-      scheduleRecorder,
-    ),
-  );
+  // eslint-disable-next-line no-use-before-define
   const isActive = () => scheduler.getAuctionState() === AuctionState.ACTIVE;
 
   /**
@@ -649,7 +640,8 @@ export const start = async (zcf, privateArgs, baggage) => {
         );
       },
       getSchedules() {
-        return E(scheduler).getSchedule();
+        // eslint-disable-next-line no-use-before-define
+        return scheduler.getSchedule();
       },
       getScheduleUpdates() {
         return scheduleKit.subscriber;
@@ -671,6 +663,18 @@ export const start = async (zcf, privateArgs, baggage) => {
     }),
   );
 
+  const scheduler = await E.when(scheduleKit.recorderP, scheduleRecorder =>
+    makeScheduler(
+      driver,
+      timer,
+      // @ts-expect-error types are correct. How to convince TS?
+      params,
+      timerBrand,
+      scheduleRecorder,
+      publicFacet.getSubscription(),
+    ),
+  );
+
   const creatorFacet = makeFarGovernorFacet(
     Far('Auctioneer creatorFacet', {
       /**

package/src/auction/params.js

@@ -63,7 +63,7 @@ export const auctioneerParamTypes = harden({
 /**
  * @typedef {object} AuctionParams
  * @property {Amount<'set'>} ElectorateInvitationAmount
- * @property {RelativeTime} StartFreq
+ * @property {RelativeTime} StartFrequency
  * @property {RelativeTime} ClockStep
  * @property {bigint} StartingRate
  * @property {bigint} LowestRate
@@ -78,7 +78,7 @@ export const auctioneerParamTypes = harden({
  */
 export const makeAuctioneerParams = ({
   ElectorateInvitationAmount,
-  StartFreq,
+  StartFrequency,
   ClockStep,
   LowestRate,
   StartingRate,
@@ -94,7 +94,7 @@ export const makeAuctioneerParams = ({
     },
     [START_FREQUENCY]: {
       type: ParamTypes.RELATIVE_TIME,
-      value: TimeMath.coerceRelativeTimeRecord(StartFreq, TimerBrand),
+      value: TimeMath.coerceRelativeTimeRecord(StartFrequency, TimerBrand),
     },
     [CLOCK_STEP]: {
       type: ParamTypes.RELATIVE_TIME,
@@ -171,4 +171,4 @@ export const makeGovernedTerms = (
 };
 harden(makeGovernedTerms);
 
-/** @typedef {ReturnType<typeof makeAuctioneerParamManager>} AuctionParamManaager */
+/** @typedef {ReturnType<typeof makeAuctioneerParamManager>} AuctionParamManager */

package/src/auction/scheduleMath.js

@@ -2,64 +2,86 @@
 
 import { TimeMath } from '@agoric/time';
 import { natSafeMath } from '@agoric/zoe/src/contractSupport/index.js';
-import { makeTracer } from '@agoric/internal';
+import { assertAllDefined, makeTracer } from '@agoric/internal';
 
 const { subtract, multiply, floorDivide } = natSafeMath;
 const { Fail } = assert;
 
 const trace = makeTracer('SMath', false);
 
+const subtract1 = relTime =>
+  TimeMath.subtractRelRel(
+    relTime,
+    TimeMath.coerceRelativeTimeRecord(1n, relTime.timerBrand),
+  );
+
+/**
+ * The length of the auction has to be inferred from the governed params.
+ *
+ * 1. The auction starts by offering collateral at a `StartingRate` (e.g., 105%)
+ *    of the market price at auction start, and continues until it reaches
+ *    (or would exceed on its next step) LowestRate (e.g., 65%)
+ * 2. The offer price changes every `ClockStep` seconds
+ * 3. The offer price changes by `DiscountStep` amount (e.g., 5%) each step So
+ *    it must run however many `ClockSteps` are required to get from
+ *    `StartingRate` to `LowestRate` changing by `DiscountStep` each time.
+ *
+ * Therefore, the duration is `(StartingRate - LowestRate) / DiscountStep * ClockStep`.
+ *
+ * Note that this is what's *scheduled*. More than one auction can be running
+ * simultaneously, and some conditions can cause some of the auctions to stop
+ * selling early (e.g. reaching their target debt to raise or selling all of
+ * their collateral).
+ *
+ * @param {Awaited<import('./params.js').AuctionParamManager>} params
+ * @param {Timestamp} baseTime
+ * @returns {import('./scheduler.js').Schedule}
+ */
 export const computeRoundTiming = (params, baseTime) => {
-  // currently a TimeValue; hopefully a TimeRecord soon
-  /** @type {RelativeTime} */
   const freq = params.getStartFrequency();
-  /** @type {RelativeTime} */
   const clockStep = params.getClockStep();
-  /** @type {NatValue} */
   const startingRate = params.getStartingRate();
-  /** @type {NatValue} */
   const discountStep = params.getDiscountStep();
-  /** @type {RelativeTime} */
   const lockPeriod = params.getPriceLockPeriod();
-  /** @type {NatValue} */
   const lowestRate = params.getLowestRate();
-
-  /** @type {RelativeTime} */
   const startDelay = params.getAuctionStartDelay();
+
   TimeMath.compareRel(freq, startDelay) > 0 ||
     Fail`startFrequency must exceed startDelay, ${freq}, ${startDelay}`;
   TimeMath.compareRel(freq, lockPeriod) > 0 ||
     Fail`startFrequency must exceed lock period, ${freq}, ${lockPeriod}`;
+  TimeMath.compareRel(freq, clockStep) >= 0 ||
+    Fail`clockStep ${TimeMath.relValue(
+      clockStep,
+    )} must be shorter than startFrequency ${TimeMath.relValue(
+      freq,
+    )} to allow at least one step down`;
 
   startingRate > lowestRate ||
     Fail`startingRate ${startingRate} must be more than lowest: ${lowestRate}`;
+
   const rateChange = subtract(startingRate, lowestRate);
   const requestedSteps = floorDivide(rateChange, discountStep);
   requestedSteps > 0n ||
     Fail`discountStep ${discountStep} too large for requested rates`;
-  TimeMath.compareRel(freq, clockStep) >= 0 ||
-    Fail`clockStep ${TimeMath.relValue(
-      clockStep,
-    )} must be shorter than startFrequency ${TimeMath.relValue(
-      freq,
-    )} to allow at least one step down`;
 
-  const requestedDuration = TimeMath.multiplyRelNat(clockStep, requestedSteps);
-  const targetDuration =
-    TimeMath.compareRel(requestedDuration, freq) < 0
-      ? requestedDuration
-      : TimeMath.subtractRelRel(freq, 1n);
-  const steps = TimeMath.divideRelRel(targetDuration, clockStep);
-  const duration = TimeMath.multiplyRelNat(clockStep, steps);
+  // How many steps fit in a full auction? We want the biggest integer for which
+  // steps * discountStep <= startingRate - lowestRate, and
+  // steps * clockStep < freq
+  const maxRateSteps = floorDivide(startingRate - lowestRate, discountStep);
+  const maxTimeSteps = TimeMath.divideRelRel(subtract1(freq), clockStep);
+  const steps = maxRateSteps < maxTimeSteps ? maxRateSteps : maxTimeSteps;
 
+  const duration = TimeMath.multiplyRelNat(clockStep, steps);
   steps > 0n ||
     Fail`clockStep ${clockStep} too long for auction duration ${duration}`;
   const endRate = subtract(startingRate, multiply(steps, discountStep));
 
+  // Use a duration that exactly matches the last step completing (no remainder)
   const actualDuration = TimeMath.multiplyRelNat(clockStep, steps);
-  // computed start is baseTime + freq - (now mod freq). if there are hourly
-  // starts, we add an hour to the time, and subtract now mod freq.
-  // Then we add the delay
+  // computed start is `startDelay + baseTime + freq - (baseTime mod freq)`.
+  // That is, if there are hourly starts, we add an hour to the time, and
+  // subtract baseTime mod freq. Then we add the delay.
   /** @type {import('@agoric/time/src/types').TimestampRecord} */
   const startTime = TimeMath.addAbsRel(
     TimeMath.addAbsRel(
@@ -91,15 +113,14 @@ harden(computeRoundTiming);
  * auction has started, then it'll be nextSchedule.startTime. Otherwise, it's
  * the start of the step following the current step.
  *
- * @param {import('./scheduler.js').Schedule | undefined} liveSchedule
- * @param {import('./scheduler.js').Schedule} nextSchedule
+ * @param {import('./scheduler.js').Schedule | null} liveSchedule
+ * @param {import('./scheduler.js').Schedule | null} nextSchedule
  * @param {Timestamp} now
+ * @returns {Timestamp | null}
  */
 export const nextDescendingStepTime = (liveSchedule, nextSchedule, now) => {
-  nextSchedule || Fail`nextSchedule must always be defined`;
-
   if (!liveSchedule) {
-    return nextSchedule.startTime;
+    return nextSchedule?.startTime || null;
   }
 
   const { startTime, endTime, clockStep } = liveSchedule;
@@ -114,9 +135,33 @@ export const nextDescendingStepTime = (liveSchedule, nextSchedule, now) => {
   const expectedNext = TimeMath.addAbsRel(lastStepStart, clockStep);
 
   if (TimeMath.compareAbs(expectedNext, endTime) > 0) {
-    return nextSchedule.startTime;
+    return nextSchedule?.startTime || null;
   }
 
   return expectedNext;
 };
 harden(nextDescendingStepTime);
+
+/**
+ *
+ * @param {Timestamp} time
+ * @param {import('./scheduler.js').Schedule} schedule
+ * @returns {'before' | 'during' | 'endExactly' | 'after'}
+ */
+export const timeVsSchedule = (time, schedule) => {
+  const { startTime, endTime } = schedule;
+  assertAllDefined({ startTime, endTime });
+
+  if (TimeMath.compareAbs(time, schedule.startTime) < 0) {
+    return 'before';
+  }
+  if (TimeMath.compareAbs(time, schedule.endTime) < 0) {
+    return 'during';
+  }
+  if (TimeMath.compareAbs(time, schedule.endTime) === 0) {
+    return 'endExactly';
+  }
+
+  return 'after';
+};
+harden(timeVsSchedule);