@agoric/inter-protocol 0.16.2-dev-5dc325b.0 → 0.16.2-getting-started-dev-d127d1d.0

package/src/price/roundsManager.js

@@ -10,14 +10,13 @@ import {
 import { E } from '@endo/eventual-send';
 import { Far } from '@endo/marshal';
 import { isNat, Nat } from '@endo/nat';
-import { UnguardedHelperI } from '@agoric/internal/src/typeGuards.js';
+import { UnguardedHelperI } from '../typeGuards.js';
 
 const { add, subtract, multiply, floorDivide, ceilDivide, isGTE } = natSafeMath;
 
 /** @typedef {import('./priceOracleKit.js').OracleStatus} OracleStatus */
 /**
  * @typedef {import('@agoric/time/src/types').Timestamp} Timestamp
- *
  * @typedef {import('@agoric/time/src/types').TimerService} TimerService
  */
 
@@ -29,30 +28,34 @@ export const ROUND_MAX = BigInt(2 ** 32 - 1);
 
 const trace = makeTracer('RoundsM', false);
 
-/** @param {bigint} roundId */
+/**
+ * @param {bigint} roundId
+ */
 const validRoundId = roundId => {
   return roundId <= ROUND_MAX;
 };
 
 /**
- * @typedef {{ roundId: number | undefined; unitPrice: NatValue }} PriceRound
+ * @typedef {{ roundId: number | undefined, unitPrice: NatValue }} PriceRound
  *
- * @typedef {Pick<RoundData, 'roundId' | 'startedAt'> & { startedBy: string }} LatestRound
+ * @typedef {Pick<RoundData, 'roundId' | 'startedAt'> &  { startedBy: string }} LatestRound
  */
 
-/** @typedef {Round & { roundId: bigint }} RoundData */
+/**
+ * @typedef {Round & {roundId: bigint}} RoundData
+ */
 
 /**
  * @typedef {object} Round
  * @property {bigint} answer the answer for the given round
- * @property {Timestamp} startedAt the timestamp when the round was started.
- *   This is 0 if the round hasn't been started yet.
- * @property {Timestamp} updatedAt the timestamp when the round last was updated
- *   (i.e. answer was last computed)
- * @property {bigint} answeredInRound the round ID of the round in which the
- *   answer was computed. answeredInRound may be smaller than roundId when the
- *   round timed out. answeredInRound is equal to roundId when the round didn't
- *   time out and was completed regularly.
+ * @property {Timestamp} startedAt the timestamp when the round was started. This is 0
+ * if the round hasn't been started yet.
+ * @property {Timestamp} updatedAt the timestamp when the round last was updated (i.e.
+ * answer was last computed)
+ * @property {bigint} answeredInRound the round ID of the round in which the answer
+ * was computed. answeredInRound may be smaller than roundId when the round
+ * timed out. answeredInRound is equal to roundId when the round didn't time out
+ * and was completed regularly.
  */
 
 /**
@@ -63,31 +66,29 @@ const validRoundId = roundId => {
  * @property {number} roundTimeout
  */
 
-/** @typedef {IssuerKit<'set'>} QuoteKit */
+/**
+ * @typedef {IssuerKit<'set'>} QuoteKit
+ */
 
 /**
- * @typedef {Readonly<
- *   import('./fluxAggregatorKit.js').ChainlinkConfig & {
- *     quoteKit: QuoteKit;
- *     answerPublisher: Publisher<void>;
- *     brandIn: Brand<'nat'>;
- *     brandOut: Brand<'nat'>;
- *     latestRoundPublisher: import('@agoric/zoe/src/contractSupport/recorder.js').Recorder<LatestRound>;
- *     timerPresence: TimerService;
- *   }
- * >} HeldParams
+ * @typedef {Readonly<import('./fluxAggregatorKit.js').ChainlinkConfig & {
+ * quoteKit: QuoteKit,
+ * answerPublisher: Publisher<void>,
+ * brandIn: Brand<'nat'>,
+ * brandOut: Brand<'nat'>,
+ * latestRoundPublisher: import('@agoric/zoe/src/contractSupport/recorder.js').Recorder<LatestRound>,
+ * timerPresence: TimerService,
+ * }>} HeldParams
  *
- * @typedef {Readonly<
- *   HeldParams & {
- *     details: MapStore<bigint, RoundDetails>;
- *     rounds: MapStore<bigint, Round>;
- *     unitIn: bigint;
- *   }
- * >} ImmutableState
+ * @typedef {Readonly<HeldParams & {
+ * details: MapStore<bigint, RoundDetails>,
+ * rounds: MapStore<bigint, Round>,
+ * unitIn: bigint,
+ * }>} ImmutableState
  *
  * @typedef {{
- *   lastValueOutForUnitIn: bigint?;
- *   reportingRoundId: bigint;
+ * lastValueOutForUnitIn: bigint?,
+ * reportingRoundId: bigint,
  * }} MutableState
  */
 /** @typedef {ImmutableState & MutableState} State */
@@ -115,11 +116,7 @@ export const prepareRoundsManagerKit = baggage =>
         handlePush: M.call(M.record(), M.record()).returns(M.promise()),
       }),
     },
-    /**
-     * @type {(
-     *   opts: HeldParams & { unitAmountIn: Amount<'nat'> },
-     * ) => State}
-     */
+    /** @type {(opts: HeldParams & { unitAmountIn: Amount<'nat'> }) => State} */
     ({
       // ChainlinkConfig
       maxSubmissionCount,
@@ -173,7 +170,9 @@ export const prepareRoundsManagerKit = baggage =>
     },
     {
       helper: {
-        /** @param {bigint} roundId */
+        /**
+         * @param {bigint} roundId
+         */
         acceptingSubmissions(roundId) {
           const { details } = this.state;
           return (
@@ -191,7 +190,9 @@ export const prepareRoundsManagerKit = baggage =>
           return roundId > add(lastStarted, restartDelay) || lastStarted === 0n;
         },
 
-        /** @param {bigint} roundId */
+        /**
+         * @param {bigint} roundId
+         */
         deleteRoundDetails(roundId) {
           const { details } = this.state;
           const roundDetails = details.get(roundId);
@@ -200,7 +201,9 @@ export const prepareRoundsManagerKit = baggage =>
           details.delete(roundId);
         },
 
-        /** @param {bigint} roundId */
+        /**
+         * @param {bigint} roundId
+         */
         isNextRound(roundId) {
           const { reportingRoundId } = this.state;
           return roundId === add(reportingRoundId, 1);
@@ -418,7 +421,7 @@ export const prepareRoundsManagerKit = baggage =>
          * @param {OracleStatus} status
          * @param {bigint} roundId
          * @param {Timestamp} blockTimestamp
-         * @returns {string | null} error message, if there is one
+         * @returns {string?} error message, if there is one
          */
         validateOracleRound(status, roundId, blockTimestamp) {
           const { reportingRoundId } = this.state;
@@ -446,7 +449,10 @@ export const prepareRoundsManagerKit = baggage =>
         },
       },
       contract: {
-        /** @param {PriceQuoteValue} quote */
+        /**
+         *
+         * @param {PriceQuoteValue} quote
+         */
         async authenticateQuote(quote) {
           const { quoteKit } = this.state;
           const quoteAmount = AmountMath.make(quoteKit.brand, harden(quote));
@@ -464,7 +470,9 @@ export const prepareRoundsManagerKit = baggage =>
           const { brandIn, brandOut, timerPresence } = state;
           const { contract } = this.facets;
 
-          /** @param {PriceQuery} priceQuery */
+          /**
+           * @param {PriceQuery} priceQuery
+           */
           return Far('createQuote', priceQuery => {
             const { lastValueOutForUnitIn, unitIn } = state;
 
@@ -478,7 +486,9 @@ export const prepareRoundsManagerKit = baggage =>
               return undefined;
             }
 
-            /** @param {Amount<'nat'>} amountIn the given amountIn */
+            /**
+             * @param {Amount<'nat'>} amountIn the given amountIn
+             */
             const calcAmountOut = amountIn => {
               const valueIn = AmountMath.getValue(brandIn, amountIn);
               return AmountMath.make(
@@ -487,7 +497,9 @@ export const prepareRoundsManagerKit = baggage =>
               );
             };
 
-            /** @param {Amount<'nat'>} amountOut the wanted amountOut */
+            /**
+             * @param {Amount<'nat'>} amountOut the wanted amountOut
+             */
             const calcAmountIn = amountOut => {
               const valueOut = AmountMath.getValue(brandOut, amountOut);
               return AmountMath.make(
@@ -552,8 +564,9 @@ export const prepareRoundsManagerKit = baggage =>
         },
 
         /**
-         * consumers are encouraged to check that they're receiving fresh data
-         * by inspecting the updatedAt and answeredInRound return values.
+         * consumers are encouraged to check
+         * that they're receiving fresh data by inspecting the updatedAt and
+         * answeredInRound return values.
          *
          * @param {bigint | number} roundIdRaw
          * @returns {Promise<RoundData>}
@@ -590,9 +603,8 @@ export const prepareRoundsManagerKit = baggage =>
         },
 
         /**
-         * a method to provide all current info oracleStatuses need. Intended
-         * only only to be callable by oracleStatuses. Not for use by contracts
-         * to read state.
+         * a method to provide all current info oracleStatuses need. Intended only
+         * only to be callable by oracleStatuses. Not for use by contracts to read state.
          *
          * @param {OracleStatus} status
          * @param {Timestamp} blockTimestamp

package/src/proposals/addAssetToVault.js

@@ -1,44 +1,28 @@
 // @jessie-check
-// @ts-check
 
-import { ToFarFunction } from '@endo/captp';
-import { Far } from '@endo/marshal';
 import { AmountMath, AssetKind } from '@agoric/ertp';
-import { deeplyFulfilledObject } from '@agoric/internal';
 import { makeRatio } from '@agoric/zoe/src/contractSupport/index.js';
-import { parseRatio } from '@agoric/zoe/src/contractSupport/ratio.js';
+import { deeplyFulfilledObject } from '@agoric/internal';
+import { Stable } from '@agoric/vats/src/tokens.js';
 import { E } from '@endo/far';
-import { Stable } from '@agoric/internal/src/tokens.js';
-import { TimeMath } from '@agoric/time/src/timeMath.js';
-import { makePromiseKit } from '@endo/promise-kit';
-
-import {
-  oracleBrandFeedName,
-  reserveThenGetNames,
-  scaledPriceFeedName,
-} from './utils.js';
+import { parseRatio } from '@agoric/zoe/src/contractSupport/ratio.js';
+import { reserveThenGetNames } from './utils.js';
 
 export * from './startPSM.js';
 
-const { quote: q } = assert;
-
 /**
  * @typedef {object} InterchainAssetOptions
  * @property {string} [issuerBoardId]
  * @property {string} [denom]
  * @property {number} [decimalPlaces]
- * @property {string} keyword - used in regstering with reserve, vaultFactory
- * @property {string} [issuerName] - used in agoricNames for compatibility:
- *   defaults to `keyword` if not provided
- * @property {string} [proposedName] - defaults to `issuerName` if not provided
- * @property {string} [oracleBrand] - defaults to `issuerName` if not provided
+ * @property {string} [proposedName]
+ * @property {string} keyword
+ * @property {string} oracleBrand
  * @property {number} [initialPrice]
  */
 
-/** @typedef {import('./econ-behaviors.js').EconomyBootstrapPowers} EconomyBootstrapPowers */
-
 /**
- * @param {BootstrapPowers} powers
+ * @param {EconomyBootstrapPowers} powers
  * @param {object} config
  * @param {object} config.options
  * @param {InterchainAssetOptions} config.options.interchainAssetOptions
@@ -47,22 +31,18 @@ export const publishInterchainAssetFromBoardId = async (
   { consume: { board, agoricNamesAdmin } },
   { options: { interchainAssetOptions } },
 ) => {
-  const {
-    issuerBoardId,
-    keyword,
-    issuerName = keyword,
-  } = interchainAssetOptions;
+  const { issuerBoardId, keyword } = interchainAssetOptions;
   // Incompatible with denom.
   assert.equal(interchainAssetOptions.denom, undefined);
   assert.typeof(issuerBoardId, 'string');
-  assert.typeof(issuerName, 'string');
+  assert.typeof(keyword, 'string');
 
   const issuer = await E(board).getValue(issuerBoardId);
   const brand = await E(issuer).getBrand();
 
   return Promise.all([
-    E(E(agoricNamesAdmin).lookupAdmin('issuer')).update(issuerName, issuer),
-    E(E(agoricNamesAdmin).lookupAdmin('brand')).update(issuerName, brand),
+    E(E(agoricNamesAdmin).lookupAdmin('issuer')).update(keyword, issuer),
+    E(E(agoricNamesAdmin).lookupAdmin('brand')).update(keyword, brand),
   ]);
 };
 
@@ -81,23 +61,18 @@ export const publishInterchainAssetFromBank = async (
   },
   { options: { interchainAssetOptions } },
 ) => {
-  const {
-    denom,
-    decimalPlaces,
-    keyword,
-    issuerName = keyword,
-    proposedName = keyword,
-  } = interchainAssetOptions;
+  const { denom, decimalPlaces, proposedName, keyword } =
+    interchainAssetOptions;
 
   // Incompatible with issuerBoardId.
   assert.equal(interchainAssetOptions.issuerBoardId, undefined);
   assert.typeof(denom, 'string');
+  assert.typeof(keyword, 'string');
   assert.typeof(decimalPlaces, 'number');
-  assert.typeof(issuerName, 'string');
   assert.typeof(proposedName, 'string');
 
   const terms = {
-    keyword: issuerName, // "keyword" is a misnomer in mintHolder terms
+    keyword,
     assetKind: AssetKind.NAT,
     displayInfo: {
       decimalPlaces,
@@ -107,7 +82,7 @@ export const publishInterchainAssetFromBank = async (
 
   const { creatorFacet: mint, publicFacet: issuer } = await E(startUpgradable)({
     installation: mintHolder,
-    label: issuerName,
+    label: keyword,
     privateArgs: undefined,
     terms,
   });
@@ -118,9 +93,9 @@ export const publishInterchainAssetFromBank = async (
   await E(E.get(reserveKit).creatorFacet).addIssuer(issuer, keyword);
 
   await Promise.all([
-    E(E(agoricNamesAdmin).lookupAdmin('issuer')).update(issuerName, issuer),
-    E(E(agoricNamesAdmin).lookupAdmin('brand')).update(issuerName, brand),
-    E(bankManager).addAsset(denom, issuerName, proposedName, kit),
+    E(E(agoricNamesAdmin).lookupAdmin('issuer')).update(keyword, issuer),
+    E(E(agoricNamesAdmin).lookupAdmin('brand')).update(keyword, brand),
+    E(bankManager).addAsset(denom, keyword, proposedName, kit),
   ]);
 };
 
@@ -138,17 +113,15 @@ export const registerScaledPriceAuthority = async (
       priceAuthorityAdmin,
       priceAuthority,
     },
-    instance: { produce: produceInstance },
   },
   { options: { interchainAssetOptions } },
 ) => {
   const {
     keyword,
-    issuerName = keyword,
-    oracleBrand = issuerName,
+    oracleBrand,
     initialPrice: initialPriceRaw,
   } = interchainAssetOptions;
-  assert.typeof(issuerName, 'string');
+  assert.typeof(keyword, 'string');
   assert.typeof(oracleBrand, 'string');
 
   const [
@@ -159,7 +132,7 @@ export const registerScaledPriceAuthority = async (
   ] = await Promise.all([
     priceAuthority,
     reserveThenGetNames(E(agoricNamesAdmin).lookupAdmin('brand'), [
-      issuerName,
+      keyword,
       'IST',
     ]),
     reserveThenGetNames(E(agoricNamesAdmin).lookupAdmin('oracleBrand'), [
@@ -215,11 +188,9 @@ export const registerScaledPriceAuthority = async (
     }),
   );
 
-  const label = scaledPriceFeedName(issuerName);
-
   const spaKit = await E(startUpgradable)({
     installation: scaledPriceAuthority,
-    label,
+    label: `scaledPriceAuthority-${keyword}`,
     terms,
   });
 
@@ -230,81 +201,9 @@ export const registerScaledPriceAuthority = async (
     stableBrand,
     true, // force
   );
-
-  // publish into agoricNames so that others can await its presence.
-  // This must stay after registerPriceAuthority above so it's evidence of registration.
-  // eslint-disable-next-line no-restricted-syntax -- computed property
-  produceInstance[label].resolve(spaKit.instance);
 };
 
-// wait a short while after end to allow things to settle
-const BUFFER = 5n * 60n;
-// let's insist on 20 minutes leeway for running the scripts
-const COMPLETION = 20n * 60n;
-
-/**
- * This function works around an issue identified in #8307 and #8296, and fixed
- * in #8301. The fix is needed until #8301 makes it into production.
- *
- * If there is a liveSchedule, 1) run now if start is far enough away,
- * otherwise, 2) run after endTime. If neither liveSchedule nor nextSchedule is
- * defined, 3) run now. If there is only a nextSchedule, 4) run now if startTime
- * is far enough away, else 5) run after endTime
- *
- * @param {import('../auction/scheduler.js').FullSchedule} schedules
- * @param {ERef<import('@agoric/time/src/types').TimerService>} timer
- * @param {() => void} thunk
- */
-const whenQuiescent = async (schedules, timer, thunk) => {
-  const { nextAuctionSchedule, liveAuctionSchedule } = schedules;
-  const now = await E(timer).getCurrentTimestamp();
-
-  const waker = Far('addAssetWaker', { wake: () => thunk() });
-
-  if (liveAuctionSchedule) {
-    const safeStart = TimeMath.subtractAbsRel(
-      liveAuctionSchedule.startTime,
-      COMPLETION,
-    );
-
-    if (TimeMath.compareAbs(safeStart, now) < 0) {
-      // case 2
-      console.warn(
-        `Add Asset after live schedule's endtime: ${q(
-          liveAuctionSchedule.endTime,
-        )}`,
-      );
-
-      return E(timer).setWakeup(
-        TimeMath.addAbsRel(liveAuctionSchedule.endTime, BUFFER),
-        waker,
-      );
-    }
-  }
-
-  if (!liveAuctionSchedule && nextAuctionSchedule) {
-    const safeStart = TimeMath.subtractAbsRel(
-      nextAuctionSchedule.startTime,
-      COMPLETION,
-    );
-    if (TimeMath.compareAbs(safeStart, now) < 0) {
-      // case 5
-      console.warn(
-        `Add Asset after next schedule's endtime: ${q(
-          nextAuctionSchedule.endTime,
-        )}`,
-      );
-      return E(timer).setWakeup(
-        TimeMath.addAbsRel(nextAuctionSchedule.endTime, BUFFER),
-        waker,
-      );
-    }
-  }
-
-  // cases 1, 3, and 4 fall through to here.
-  console.warn(`Add Asset immediately`, thunk);
-  return thunk();
-};
+/** @typedef {import('./econ-behaviors.js').EconomyBootstrapPowers} EconomyBootstrapPowers */
 
 /**
  * @param {EconomyBootstrapPowers} powers
@@ -316,16 +215,10 @@ const whenQuiescent = async (schedules, timer, thunk) => {
  */
 export const addAssetToVault = async (
   {
-    consume: {
-      vaultFactoryKit,
-      agoricNamesAdmin,
-      auctioneerKit,
-      chainTimerService,
-    },
+    consume: { vaultFactoryKit, agoricNamesAdmin, auctioneerKit },
     brand: {
       consume: { [Stable.symbol]: stableP },
     },
-    instance: { consume: consumeInstance },
   },
   {
     options: {
@@ -338,43 +231,17 @@ export const addAssetToVault = async (
     },
   },
 ) => {
-  const {
-    keyword,
-    issuerName = keyword,
-    oracleBrand = issuerName,
-  } = interchainAssetOptions;
+  const { keyword, oracleBrand } = interchainAssetOptions;
   assert.typeof(keyword, 'string');
-  assert.typeof(issuerName, 'string');
   assert.typeof(oracleBrand, 'string');
   const [interchainIssuer] = await reserveThenGetNames(
     E(agoricNamesAdmin).lookupAdmin('issuer'),
-    [issuerName],
+    [keyword],
   );
 
-  // don't add the collateral offering to vaultFactory until its price feed is available
-  // eslint-disable-next-line no-restricted-syntax -- allow this computed property
-  await consumeInstance[oracleBrandFeedName(oracleBrand, 'USD')];
-  // await also the negotiable brand
-  // eslint-disable-next-line no-restricted-syntax -- allow this computed property
-  await consumeInstance[scaledPriceFeedName(issuerName)];
-
-  const auctioneerCreator = E.get(auctioneerKit).creatorFacet;
-  const schedules = await E(auctioneerCreator).getSchedule();
-
-  const finishPromiseKit = makePromiseKit();
-  const addBrandThenResolve = ToFarFunction('addBrandThenResolve', async () => {
-    await E(auctioneerCreator).addBrand(interchainIssuer, keyword);
-    finishPromiseKit.resolve(undefined);
-  });
-
-  // schedules actions on a timer (or does it immediately).
-  // finishPromiseKit signals completion.
-  void whenQuiescent(schedules, chainTimerService, addBrandThenResolve);
-  await finishPromiseKit.promise;
-
   const stable = await stableP;
   const vaultFactoryCreator = E.get(vaultFactoryKit).creatorFacet;
-  await E(vaultFactoryCreator).addVaultType(interchainIssuer, keyword, {
+  await E(vaultFactoryCreator).addVaultType(interchainIssuer, oracleBrand, {
     debtLimit: AmountMath.make(stable, BigInt(debtLimitValue)),
     interestRate: makeRatio(interestRateValue, stable),
     // The rest of these we use safe defaults.
@@ -386,6 +253,8 @@ export const addAssetToVault = async (
     mintFee: makeRatio(50n, stable, 10_000n),
     liquidationPenalty: makeRatio(1n, stable),
   });
+  const auctioneerCreator = E.get(auctioneerKit).creatorFacet;
+  await E(auctioneerCreator).addBrand(interchainIssuer, keyword);
 };
 
 export const getManifestForAddAssetToVault = (
@@ -417,7 +286,9 @@ export const getManifestForAddAssetToVault = (
           consume: {
             bankManager: true,
             agoricNamesAdmin: true,
+            bankMints: true,
             reserveKit: true,
+            vBankKits: true,
             startUpgradable: true,
           },
           produce: { bankMints: true, vBankKits: true },
@@ -432,9 +303,10 @@ export const getManifestForAddAssetToVault = (
           startUpgradable: true,
           priceAuthorityAdmin: true,
           priceAuthority: true,
+          scaledPriceAuthorityKits: true,
         },
-        instance: {
-          produce: true,
+        produce: {
+          scaledPriceAuthorityKits: true,
         },
         installation: {
           consume: { scaledPriceAuthority: true },
@@ -445,16 +317,10 @@ export const getManifestForAddAssetToVault = (
           auctioneerKit: 'auctioneer',
           vaultFactoryKit: 'vaultFactory',
           agoricNamesAdmin: true,
-          chainTimerService: true,
         },
         brand: {
           consume: { [Stable.symbol]: true },
         },
-        instance: {
-          // allow any instance because the AGORIC_INSTANCE_NAME of
-          // priceFeedOptions cannot be known statically.
-          consume: true,
-        },
       },
     },
     installations: {