@agoric/inter-protocol 0.16.2-dev-857e650.0 → 0.16.2-dev-fb922d3.0

package/src/price/fluxAggregatorContract.js

@@ -18,6 +18,7 @@ import { prepareFluxAggregatorKit } from './fluxAggregatorKit.js';
 const trace = makeTracer('FluxAgg', false);
 /**
  * @typedef {import('@agoric/vat-data').Baggage} Baggage
+ *
  * @typedef {import('@agoric/time/src/types').TimerService} TimerService
  */
 
@@ -39,23 +40,25 @@ export const privateArgsShape = M.splitRecord(
 );
 
 /**
- * PriceAuthority for their median. Unlike the simpler `priceAggregator.js`, this approximates
- * the *Node Operator Aggregation* logic of [Chainlink price
+ * PriceAuthority for their median. Unlike the simpler `priceAggregator.js`,
+ * this approximates the _Node Operator Aggregation_ logic of [Chainlink price
  * feeds](https://blog.chain.link/levels-of-data-aggregation-in-chainlink-price-feeds/).
  *
- * @param {ZCF<import('./fluxAggregatorKit.js').ChainlinkConfig & {
- * timer: TimerService,
- * brandIn: Brand<'nat'>,
- * brandOut: Brand<'nat'>,
- * description: string,
- * unitAmountIn?: Amount<'nat'>,
- * }>} zcf
+ * @param {ZCF<
+ *   import('./fluxAggregatorKit.js').ChainlinkConfig & {
+ *     timer: TimerService;
+ *     brandIn: Brand<'nat'>;
+ *     brandOut: Brand<'nat'>;
+ *     description: string;
+ *     unitAmountIn?: Amount<'nat'>;
+ *   }
+ * >} zcf
  * @param {{
- * highPrioritySendersManager?: import('@agoric/internal/src/priority-senders.js').PrioritySendersManager,
- * initialPoserInvitation: Invitation,
- * marshaller: ERef<Marshaller>,
- * namesByAddressAdmin: ERef<import('@agoric/vats').NameAdmin>,
- * storageNode: StorageNode,
+ *   highPrioritySendersManager?: import('@agoric/internal/src/priority-senders.js').PrioritySendersManager;
+ *   initialPoserInvitation: Invitation;
+ *   marshaller: ERef<Marshaller>;
+ *   namesByAddressAdmin: ERef<import('@agoric/vats').NameAdmin>;
+ *   storageNode: StorageNode;
  * }} privateArgs
  * @param {Baggage} baggage
  */
@@ -151,20 +154,22 @@ export const prepare = async (zcf, privateArgs, baggage) => {
 
   const governedApis = {
     /**
-     * Add the specified oracles. May partially fail, such that some oracles are added and others aren't.
+     * Add the specified oracles. May partially fail, such that some oracles are
+     * added and others aren't.
      *
      * @param {string[]} addrs
-     * @returns {Promise<Array<PromiseSettledResult<string>>>}
+     * @returns {Promise<PromiseSettledResult<string>[]>}
      */
     addOracles: addrs => {
       return Promise.allSettled(addrs.map(addOracle));
     },
     /**
-     * Remove the specified oracles. May partially fail, such that some oracles are removed and others aren't.
-     * If the oracle was never part of the set that's a PromiseRejectedResult
+     * Remove the specified oracles. May partially fail, such that some oracles
+     * are removed and others aren't. If the oracle was never part of the set
+     * that's a PromiseRejectedResult
      *
      * @param {string[]} addrs
-     * @returns {Promise<Array<PromiseSettledResult<string>>>}
+     * @returns {Promise<PromiseSettledResult<string>[]>}
      */
     removeOracles: addrs => {
       return Promise.allSettled(addrs.map(removeOracle));

package/src/price/fluxAggregatorKit.d.ts

@@ -10,9 +10,9 @@ export function prepareFluxAggregatorKit(baggage: MapStore<string, unknown>, zcf
          * An "oracle invitation" is an invitation to be able to submit data to
          * include in the priceAggregator's results.
          *
-         * The offer result from this invitation is a OracleAdmin, which can be used
-         * directly to manage the price submissions as well as to terminate the
-         * relationship.
+         * The offer result from this invitation is a OracleAdmin, which can be
+         * used directly to manage the price submissions as well as to terminate
+         * the relationship.
          *
          * @param {string} oracleId unique per contract instance
          */
@@ -39,8 +39,9 @@ export function prepareFluxAggregatorKit(baggage: MapStore<string, unknown>, zcf
             };
         }>>;
         /**
-         * 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 {string} oracleId
          * @param {bigint} queriedRoundId
@@ -61,9 +62,9 @@ export function prepareFluxAggregatorKit(baggage: MapStore<string, unknown>, zcf
          * An "oracle invitation" is an invitation to be able to submit data to
          * include in the priceAggregator's results.
          *
-         * The offer result from this invitation is a OracleAdmin, which can be used
-         * directly to manage the price submissions as well as to terminate the
-         * relationship.
+         * The offer result from this invitation is a OracleAdmin, which can be
+         * used directly to manage the price submissions as well as to terminate
+         * the relationship.
          *
          * @param {string} oracleId unique per contract instance
          */
@@ -90,8 +91,9 @@ export function prepareFluxAggregatorKit(baggage: MapStore<string, unknown>, zcf
             };
         }>>;
         /**
-         * 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 {string} oracleId
          * @param {bigint} queriedRoundId
@@ -110,7 +112,8 @@ export function prepareFluxAggregatorKit(baggage: MapStore<string, unknown>, zcf
 export type Baggage = import('@agoric/vat-data').Baggage;
 export type Timestamp = import('@agoric/time/src/types').Timestamp;
 /**
- * // TODO: use RelativeTime, not RelativeTimeValue
+ * //
+ * TODO: use RelativeTime, not RelativeTimeValue
  */
 export type RelativeTime = import('@agoric/time/src/types').RelativeTime;
 export type RelativeTimeValue = import('@agoric/time/src/types').RelativeTimeValue;
@@ -127,22 +130,24 @@ export type ChainlinkConfig = {
     maxSubmissionCount: number;
     minSubmissionCount: number;
     /**
-     * the number of rounds an Oracle has to wait before they can initiate a round
+     * the number of rounds an Oracle has to wait
+     * before they can initiate a round
      */
     restartDelay: bigint;
     /**
-     * an immutable check for a lower bound of what
-     * submission values are accepted from an oracle
+     * an immutable check for a lower bound of
+     * what submission values are accepted from an oracle
      */
     minSubmissionValue: number;
     /**
-     * an immutable check for an upper bound of what
-     * submission values are accepted from an oracle
+     * an immutable check for an upper bound
+     * of what submission values are accepted from an oracle
      */
     maxSubmissionValue: number;
     /**
-     * the number of seconds after the previous round that
-     * allowed to lapse before allowing an oracle to skip an unfinished round
+     * the number of seconds after the previous round
+     * that allowed to lapse before allowing an oracle to skip an unfinished
+     * round
      */
     timeout: number;
 };

package/src/price/fluxAggregatorKit.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"fluxAggregatorKit.d.ts","sourceRoot":"","sources":["fluxAggregatorKit.js"],"names":[],"mappings":"AAsBA,yDAA0D;AA2DnD;WAXG,YAAY;aACV,MAAM,KAAK,CAAC;cACX,MAAM,KAAK,CAAC;;mBAGd,YAAY,YACZ,OAAO,oBAAoB,EAAE,QAAQ,eACrC,WAAW,yBACX,MAAM,WAAW,GAAG,CAAC,gBACrB,OAAO,6CAA6C,EAAE,YAAY;;QA8IrE;;;;;;;;;WASG;uCADQ,MAAM;QAsCjB,+BAA+B;+BAAnB,MAAM;;QAalB,+BAA+B;6BAAnB,MAAM;;;;;;;;;;;;;;;;;QAoBlB;;;;;;;WAOG;mCAHQ,MAAM,kBACN,MAAM,GACJ,QAAQ,UAAU,CAAC;;;;;;;;;;;QArFhC;;;;;;;;;WASG;uCADQ,MAAM;QAsCjB,+BAA+B;+BAAnB,MAAM;;QAalB,+BAA+B;6BAAnB,MAAM;;;;;;;;;;;;;;;;;QAoBlB;;;;;;;WAOG;mCAHQ,MAAM,kBACN,MAAM,GACJ,QAAQ,UAAU,CAAC;;;;;;;;;IAqDvC;sBA9UY,OAAO,kBAAkB,EAAE,OAAO;wBAClC,OAAO,wBAAwB,EAAE,SAAS;;;;2BAC1C,OAAO,wBAAwB,EAAE,YAAY;gCAE7C,OAAO,wBAAwB,EAAE,iBAAiB;2BAClD,OAAO,wBAAwB,EAAE,YAAY;;8BAQ5C,OAAO;oBACP,MAAM;sBACN,MAAM;eACN,SAAS;kBACT,MAAM;iBACN,MAAM;;;wBAMN,MAAM;wBACN,MAAM;;;;kBACN,MAAM;;;;;wBACN,MAAM;;;;;wBAEN,MAAM;;;;;aAEN,MAAM;;gCAiTN,WAAW,QAAQ,WAAW,+BAA+B,CAAC,CAAC,CAAC"}
+{"version":3,"file":"fluxAggregatorKit.d.ts","sourceRoot":"","sources":["fluxAggregatorKit.js"],"names":[],"mappings":"AAsBA,yDAA0D;AAoEnD;WAZO,YAAY;aACV,MAAM,KAAK,CAAC;cACX,MAAM,KAAK,CAAC;;mBAIlB,YAAY,YACZ,OAAO,oBAAoB,EAAE,QAAQ,eACrC,WAAW,yBACX,MAAM,WAAW,GAAG,CAAC,gBACrB,OAAO,6CAA6C,EAAE,YAAY;;QAmJrE;;;;;;;;;WASG;uCADQ,MAAM;QAsCjB,+BAA+B;+BAAnB,MAAM;;QAalB,+BAA+B;6BAAnB,MAAM;;;;;;;;;;;;;;;;;QAoBlB;;;;;;;;WAQG;mCAHQ,MAAM,kBACN,MAAM,GACJ,QAAQ,UAAU,CAAC;;;;;;;;;;;QAtFhC;;;;;;;;;WASG;uCADQ,MAAM;QAsCjB,+BAA+B;+BAAnB,MAAM;;QAalB,+BAA+B;6BAAnB,MAAM;;;;;;;;;;;;;;;;;QAoBlB;;;;;;;;WAQG;mCAHQ,MAAM,kBACN,MAAM,GACJ,QAAQ,UAAU,CAAC;;;;;;;;;IAqDvC;sBA7VY,OAAO,kBAAkB,EAAE,OAAO;wBAElC,OAAO,wBAAwB,EAAE,SAAS;;;;;2BAE1C,OAAO,wBAAwB,EAAE,YAAY;gCAG7C,OAAO,wBAAwB,EAAE,iBAAiB;2BAElD,OAAO,wBAAwB,EAAE,YAAY;;8BAQ5C,OAAO;oBACP,MAAM;sBACN,MAAM;eACN,SAAS;kBACT,MAAM;iBACN,MAAM;;;wBAMN,MAAM;wBACN,MAAM;;;;;kBACN,MAAM;;;;;wBAEN,MAAM;;;;;wBAEN,MAAM;;;;;;aAEN,MAAM;;gCA2TN,WAAW,QAAQ,WAAW,+BAA+B,CAAC,CAAC,CAAC"}

package/src/price/fluxAggregatorKit.js

@@ -1,7 +1,7 @@
 /**
- * @file
- * Adaptation of Chainlink algorithm to the Agoric platform.
- * Modeled on https://github.com/smartcontractkit/chainlink/blob/master/contracts/src/v0.6/FluxAggregator.sol (version?)
+ * @file Adaptation of Chainlink algorithm to the Agoric platform. Modeled on
+ *   https://github.com/smartcontractkit/chainlink/blob/master/contracts/src/v0.6/FluxAggregator.sol
+ *   (version?)
  */
 import { AmountMath } from '@agoric/ertp';
 import { assertAllDefined, makeTracer } from '@agoric/internal';
@@ -24,10 +24,14 @@ export const INVITATION_MAKERS_DESC = 'oracle invitation';
 
 /**
  * @typedef {import('@agoric/vat-data').Baggage} Baggage
+ *
  * @typedef {import('@agoric/time/src/types').Timestamp} Timestamp
- * @typedef {import('@agoric/time/src/types').RelativeTime} RelativeTime
- * // TODO: use RelativeTime, not RelativeTimeValue
+ *
+ * @typedef {import('@agoric/time/src/types').RelativeTime} RelativeTime //
+ *   TODO: use RelativeTime, not RelativeTimeValue
+ *
  * @typedef {import('@agoric/time/src/types').RelativeTimeValue} RelativeTimeValue
+ *
  * @typedef {import('@agoric/time/src/types').TimerService} TimerService
  */
 
@@ -49,30 +53,35 @@ const priceDescriptionFromQuote = quote => quote.quoteAmount.value[0];
  * @typedef {object} ChainlinkConfig
  * @property {number} maxSubmissionCount
  * @property {number} minSubmissionCount
- * @property {bigint} restartDelay the number of rounds an Oracle has to wait before they can initiate a round
- * @property {number} minSubmissionValue an immutable check for a lower bound of what
- * submission values are accepted from an oracle
- * @property {number} maxSubmissionValue an immutable check for an upper bound of what
- * submission values are accepted from an oracle
- * @property {number} timeout the number of seconds after the previous round that
- * allowed to lapse before allowing an oracle to skip an unfinished round
+ * @property {bigint} restartDelay the number of rounds an Oracle has to wait
+ *   before they can initiate a round
+ * @property {number} minSubmissionValue an immutable check for a lower bound of
+ *   what submission values are accepted from an oracle
+ * @property {number} maxSubmissionValue an immutable check for an upper bound
+ *   of what submission values are accepted from an oracle
+ * @property {number} timeout the number of seconds after the previous round
+ *   that allowed to lapse before allowing an oracle to skip an unfinished
+ *   round
  */
 
 /**
- * Returns a maker for a single durable FluxAggregatorKit, closed over the prepare() arguments.
+ * Returns a maker for a single durable FluxAggregatorKit, closed over the
+ * prepare() arguments.
  *
  * The kit aggregates price inputs to produce a PriceAuthority. Unlike the
- * simpler `priceAggregator.js`, this approximates the *Node Operator
- * Aggregation* logic of [Chainlink price
+ * simpler `priceAggregator.js`, this approximates the _Node Operator
+ * Aggregation_ logic of [Chainlink price
  * feeds](https://blog.chain.link/levels-of-data-aggregation-in-chainlink-price-feeds/).
  *
  * @param {Baggage} baggage
- * @param {ZCF<ChainlinkConfig & {
- * timer: TimerService,
- * brandIn: Brand<'nat'>,
- * brandOut: Brand<'nat'>,
- * unitAmountIn?: Amount<'nat'>,
- * }>} zcf
+ * @param {ZCF<
+ *   ChainlinkConfig & {
+ *     timer: TimerService;
+ *     brandIn: Brand<'nat'>;
+ *     brandOut: Brand<'nat'>;
+ *     unitAmountIn?: Amount<'nat'>;
+ *   }
+ * >} zcf
  * @param {TimerService} timerPresence
  * @param {import('./roundsManager.js').QuoteKit} quoteKit
  * @param {StorageNode} storageNode
@@ -128,7 +137,10 @@ export const prepareFluxAggregatorKit = async (
   // end of maker definitions /////////////////////////////////
 
   const { answerKit, latestRoundKit, priceKit } = await provideAll(baggage, {
-    /** This is just a signal that there's a new answer, which is read from `lastValueOutForUnitIn` */
+    /**
+     * This is just a signal that there's a new answer, which is read from
+     * `lastValueOutForUnitIn`
+     */
     answerKit: () => makeDurablePublishKit(),
     /** For publishing priceAuthority values to off-chain storage */
     priceKit: () =>
@@ -142,9 +154,11 @@ export const prepareFluxAggregatorKit = async (
       E.when(E(storageNode).makeChildNode('latestRound'), node =>
         makeRecorderKit(
           node,
-          /** @type {import('@agoric/zoe/src/contractSupport/recorder.js').TypedMatcher<import('./roundsManager.js').LatestRound>} */ (
-            M.any()
-          ),
+          /**
+           * @type {import('@agoric/zoe/src/contractSupport/recorder.js').TypedMatcher<
+           *     import('./roundsManager.js').LatestRound
+           *   >}
+           */ (M.any()),
         ),
       ),
   });
@@ -223,9 +237,9 @@ export const prepareFluxAggregatorKit = async (
          * An "oracle invitation" is an invitation to be able to submit data to
          * include in the priceAggregator's results.
          *
-         * The offer result from this invitation is a OracleAdmin, which can be used
-         * directly to manage the price submissions as well as to terminate the
-         * relationship.
+         * The offer result from this invitation is a OracleAdmin, which can be
+         * used directly to manage the price submissions as well as to terminate
+         * the relationship.
          *
          * @param {string} oracleId unique per contract instance
          */
@@ -235,8 +249,8 @@ export const prepareFluxAggregatorKit = async (
           /**
            * If custom arguments are supplied to the `zoe.offer` call, they can
            * indicate an OraclePriceSubmission notifier and a corresponding
-           * `shiftValueOut` that should be adapted as part of the priceAuthority's
-           * reported data.
+           * `shiftValueOut` that should be adapted as part of the
+           * priceAuthority's reported data.
            *
            * @param {ZCFSeat} seat
            */
@@ -299,8 +313,9 @@ export const prepareFluxAggregatorKit = async (
         },
 
         /**
-         * 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 {string} oracleId
          * @param {bigint} queriedRoundId

package/src/price/priceOracleKit.d.ts

@@ -10,10 +10,7 @@ export function prepareOracleAdminKit(baggage: any): (args_0: HeldParams) => {
          * @param {PriceDatum} datum
          */
         pushPrice({ roundId: roundIdRaw, unitPrice: valueRaw, }: PriceDatum): Promise<void>;
-        /**
-         *
-         * @returns {OracleStatus}
-         */
+        /** @returns {OracleStatus} */
         getStatus(): OracleStatus;
     };
 } & import("@endo/eventual-send").RemotableBrand<{}, {
@@ -27,10 +24,7 @@ export function prepareOracleAdminKit(baggage: any): (args_0: HeldParams) => {
          * @param {PriceDatum} datum
          */
         pushPrice({ roundId: roundIdRaw, unitPrice: valueRaw, }: PriceDatum): Promise<void>;
-        /**
-         *
-         * @returns {OracleStatus}
-         */
+        /** @returns {OracleStatus} */
         getStatus(): OracleStatus;
     };
 }>;

package/src/price/priceOracleKit.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"priceOracleKit.d.ts","sourceRoot":"","sources":["priceOracleKit.js"],"names":[],"mappings":"AAMA,yDAA0D;AA2DnD;;;;;QAcC;;;;WAIG;iEADQ,UAAU;QA0BrB;;;WAGG;qBADU,YAAY;;;;;;;QA/BzB;;;;WAIG;iEADQ,UAAU;QA0BrB;;;WAGG;qBADU,YAAY;;GAc9B;;cAlHY,MAAM;;6BACoB,YAAY,UAAU,OAAO,oBAAoB,EAAE,UAAU,KAAK,QAAQ,YAAY,CAAC;;;yBAKnH;IAAE,OAAO,EAAE,MAAM,GAAG,SAAS,CAAC;IAAC,SAAS,EAAE,QAAQ,CAAA;CAAE;;;uBAMnD,MAAM;sBACN,MAAM;sBACN,MAAM;cACN,MAAM;;6BAGP,SAAS,UAAU,GAAG,EAC/B,CAAC;2BAEQ,YAAY,GAAG,EACxB;oBAEU,cAAc,GAAG,YAAY;wBA4F7B,WAAW,WAAW,4BAA4B,CAAC,CAAC"}
+{"version":3,"file":"priceOracleKit.d.ts","sourceRoot":"","sources":["priceOracleKit.js"],"names":[],"mappings":"AAMA,yDAA0D;AA4DnD;;;;;QAcC;;;;WAIG;iEADQ,UAAU;QA0BrB,8BAA8B;qBAAhB,YAAY;;;;;;;QA7B1B;;;;WAIG;iEADQ,UAAU;QA0BrB,8BAA8B;qBAAhB,YAAY;;GAa/B;;cAhHY,MAAM;;6BAGJ,YAAY,UACZ,OAAO,oBAAoB,EAAE,UAAU,KAC5C,QAAQ,YAAY,CAAC;;;yBAKnB;IAAE,OAAO,EAAE,MAAM,GAAG,SAAS,CAAC;IAAC,SAAS,EAAE,QAAQ,CAAA;CAAE;;;uBAKpD,MAAM;sBACN,MAAM;sBACN,MAAM;cACN,MAAM;;6BAGP,SAAS,UAAU,GAAG,EAAE,CAAC;2BAEzB,YAAY,GAAG,EAAE;oBAEhB,cAAc,GAAG,YAAY;wBAyF7B,WAAW,WAAW,4BAA4B,CAAC,CAAC"}

package/src/price/priceOracleKit.js

@@ -8,14 +8,17 @@ export const INVITATION_MAKERS_DESC = 'oracle invitation';
 
 /**
  * @typedef {{
- *   oracleId: string,
- *   roundPowers: { handlePush: (status: OracleStatus, result: import('./roundsManager.js').PriceRound) => Promise<OracleStatus> }
+ *   oracleId: string;
+ *   roundPowers: {
+ *     handlePush: (
+ *       status: OracleStatus,
+ *       result: import('./roundsManager.js').PriceRound,
+ *     ) => Promise<OracleStatus>;
+ *   };
  * }} HeldParams
  */
 
-/**
- * @typedef {{ roundId: number | undefined, unitPrice: NatValue }} PriceDatum
- */
+/** @typedef {{ roundId: number | undefined; unitPrice: NatValue }} PriceDatum */
 
 /**
  * @typedef {object} OracleStatus
@@ -26,11 +29,9 @@ export const INVITATION_MAKERS_DESC = 'oracle invitation';
  * @property {string} oracleId
  */
 /**
- * @typedef {Readonly<HeldParams & {
- * }>} ImmutableState
+ * @typedef {Readonly<HeldParams & {}>} ImmutableState
  *
- * @typedef {OracleStatus & {
- * }} MutableState
+ * @typedef {OracleStatus & {}} MutableState
  */
 /** @typedef {ImmutableState & MutableState} State */
 
@@ -106,10 +107,7 @@ export const prepareOracleAdminKit = baggage =>
           state.lastStartedRound = result.lastStartedRound;
           state.latestSubmission = result.latestSubmission;
         },
-        /**
-         *
-         * @returns {OracleStatus}
-         */
+        /** @returns {OracleStatus} */
         getStatus() {
           const { state } = this;
           return {

package/src/price/roundsManager.d.ts

@@ -11,22 +11,16 @@ export function prepareRoundsManagerKit(baggage: any): (args_0: Readonly<import(
     unitAmountIn: Amount<'nat'>;
 }) => {
     helper: {
-        /**
-         * @param {bigint} roundId
-         */
+        /** @param {bigint} roundId */
         acceptingSubmissions(roundId: bigint): boolean;
         /**
          * @param {OracleStatus} status
          * @param {bigint} roundId
          */
         delayed(status: OracleStatus, roundId: bigint): boolean;
-        /**
-         * @param {bigint} roundId
-         */
+        /** @param {bigint} roundId */
         deleteRoundDetails(roundId: bigint): void;
-        /**
-         * @param {bigint} roundId
-         */
+        /** @param {bigint} roundId */
         isNextRound(roundId: bigint): boolean;
         /**
          * @param {bigint} roundId
@@ -77,15 +71,12 @@ export function prepareRoundsManagerKit(baggage: any): (args_0: Readonly<import(
          * @param {OracleStatus} status
          * @param {bigint} roundId
          * @param {Timestamp} blockTimestamp
-         * @returns {string?} error message, if there is one
+         * @returns {string | null} error message, if there is one
          */
         validateOracleRound(status: OracleStatus, roundId: bigint, blockTimestamp: Timestamp): string | null;
     };
     contract: {
-        /**
-         *
-         * @param {PriceQuoteValue} quote
-         */
+        /** @param {PriceQuoteValue} quote */
         authenticateQuote(quote: PriceQuoteValue): Promise<{
             quoteAmount: Amount<"set">;
             quotePayment: Payment<"set">;
@@ -112,9 +103,8 @@ export function prepareRoundsManagerKit(baggage: any): (args_0: Readonly<import(
          */
         eligibleForSpecificRound(status: OracleStatus, queriedRoundId: bigint, blockTimestamp: Timestamp): boolean;
         /**
-         * 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>}
@@ -123,8 +113,9 @@ export function prepareRoundsManagerKit(baggage: any): (args_0: Readonly<import(
         /** @type {(roundId: bigint) => Readonly<RoundDetails & Round>} */
         getRoundStatus(roundId: bigint): Readonly<RoundDetails & Round>;
         /**
-         * 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
@@ -148,22 +139,16 @@ export function prepareRoundsManagerKit(baggage: any): (args_0: Readonly<import(
     };
 } & import("@endo/eventual-send").RemotableBrand<{}, {
     helper: {
-        /**
-         * @param {bigint} roundId
-         */
+        /** @param {bigint} roundId */
         acceptingSubmissions(roundId: bigint): boolean;
         /**
          * @param {OracleStatus} status
          * @param {bigint} roundId
          */
         delayed(status: OracleStatus, roundId: bigint): boolean;
-        /**
-         * @param {bigint} roundId
-         */
+        /** @param {bigint} roundId */
         deleteRoundDetails(roundId: bigint): void;
-        /**
-         * @param {bigint} roundId
-         */
+        /** @param {bigint} roundId */
         isNextRound(roundId: bigint): boolean;
         /**
          * @param {bigint} roundId
@@ -214,15 +199,12 @@ export function prepareRoundsManagerKit(baggage: any): (args_0: Readonly<import(
          * @param {OracleStatus} status
          * @param {bigint} roundId
          * @param {Timestamp} blockTimestamp
-         * @returns {string?} error message, if there is one
+         * @returns {string | null} error message, if there is one
          */
         validateOracleRound(status: OracleStatus, roundId: bigint, blockTimestamp: Timestamp): string | null;
     };
     contract: {
-        /**
-         *
-         * @param {PriceQuoteValue} quote
-         */
+        /** @param {PriceQuoteValue} quote */
         authenticateQuote(quote: PriceQuoteValue): Promise<{
             quoteAmount: Amount<"set">;
             quotePayment: Payment<"set">;
@@ -249,9 +231,8 @@ export function prepareRoundsManagerKit(baggage: any): (args_0: Readonly<import(
          */
         eligibleForSpecificRound(status: OracleStatus, queriedRoundId: bigint, blockTimestamp: Timestamp): boolean;
         /**
-         * 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>}
@@ -260,8 +241,9 @@ export function prepareRoundsManagerKit(baggage: any): (args_0: Readonly<import(
         /** @type {(roundId: bigint) => Readonly<RoundDetails & Round>} */
         getRoundStatus(roundId: bigint): Readonly<RoundDetails & Round>;
         /**
-         * 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
@@ -303,20 +285,20 @@ export type Round = {
      */
     answer: bigint;
     /**
-     * the timestamp when the round was started. This is 0
-     * if the round hasn't been started yet.
+     * the timestamp when the round was started.
+     * This is 0 if the round hasn't been started yet.
      */
     startedAt: Timestamp;
     /**
-     * the timestamp when the round last was updated (i.e.
-     * answer was last computed)
+     * the timestamp when the round last was updated
+     * (i.e. answer was last computed)
      */
     updatedAt: Timestamp;
     /**
-     * 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.
+     * 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.
      */
     answeredInRound: bigint;
 };

package/src/price/roundsManager.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"roundsManager.d.ts","sourceRoot":"","sources":["roundsManager.js"],"names":[],"mappings":"AAyBA,qBAAqB;AACrB,wBADW,MAAM,CAC4B;AAqEtC;cArBM,QAAQ;qBACD,UAAU,IAAI,CAAC;aACvB,MAAM,KAAK,CAAC;cACX,MAAM,KAAK,CAAC;0BACA,OAAO,6CAA6C,EAAE,QAAQ,CAAC,WAAW,CAAC;mBAClF,YAAY;;kBAuCqB,OAAO,KAAK,CAAC;;;QAsDxD;;WAEG;sCADQ,MAAM;QASjB;;;WAGG;wBAFQ,YAAY,WACZ,MAAM;QAQjB;;WAEG;oCADQ,MAAM;QAUjB;;WAEG;6BADQ,MAAM;QAOjB;;;;WAIG;oCAHQ,MAAM,kBACN,SAAS,YACT,MAAM;QA4CjB;;;WAGG;8CAFQ,MAAM,QACN,MAAM;QAOjB;;;;;WAKG;iCAJQ,MAAM,UACN,YAAY,kBACZ,SAAS,GACP,YAAY,GAAG,SAAS;QAiBrC;;;;;WAKG;qCAJQ,MAAM,WACN,MAAM,UACN,YAAY,GACV,YAAY;QAwBzB;;;WAGG;8BAFQ,MAAM,kBACN,SAAS;QAWpB;;;WAGG;0BAFQ,MAAM,kBACN,SAAS;QAyBpB;;;WAGG;mCAFQ,MAAM,kBACN,SAAS;QAgCpB;;;WAGG;yCAFQ,MAAM,kBACN,SAAS;QA2BpB;;;;;WAKG;oCAJQ,YAAY,WACZ,MAAM,kBACN,SAAS,GACP,MAAM;;;QA4BnB;;;WAGG;;;;;QAQH;;;;WAIG;;YAFwB,gBAAgB;YACb,SAAS;;;;;;;;QA8EvC;;;;WAIG;yCAHQ,YAAY,kBACZ,MAAM,kBACN,SAAS;QAmBpB;;;;;;;WAOG;iCAFQ,MAAM,GAAG,MAAM,GACb,QAAQ,SAAS,CAAC;QAwB/B,kEAAkE;gCAA7C,MAAM,GAAK,SAAS,YAAY,GAAG,KAAK,CAAC;QAS9D;;;;;;WAMG;6CAFQ,YAAY,kBACZ,SAAS;;;;;;;;;QAyDpB;;;;;WAKG;2BAFQ,YAAY,gDACZ,UAAU;;;;QAlfrB;;WAEG;sCADQ,MAAM;QASjB;;;WAGG;wBAFQ,YAAY,WACZ,MAAM;QAQjB;;WAEG;oCADQ,MAAM;QAUjB;;WAEG;6BADQ,MAAM;QAOjB;;;;WAIG;oCAHQ,MAAM,kBACN,SAAS,YACT,MAAM;QA4CjB;;;WAGG;8CAFQ,MAAM,QACN,MAAM;QAOjB;;;;;WAKG;iCAJQ,MAAM,UACN,YAAY,kBACZ,SAAS,GACP,YAAY,GAAG,SAAS;QAiBrC;;;;;WAKG;qCAJQ,MAAM,WACN,MAAM,UACN,YAAY,GACV,YAAY;QAwBzB;;;WAGG;8BAFQ,MAAM,kBACN,SAAS;QAWpB;;;WAGG;0BAFQ,MAAM,kBACN,SAAS;QAyBpB;;;WAGG;mCAFQ,MAAM,kBACN,SAAS;QAgCpB;;;WAGG;yCAFQ,MAAM,kBACN,SAAS;QA2BpB;;;;;WAKG;oCAJQ,YAAY,WACZ,MAAM,kBACN,SAAS,GACP,MAAM;;;QA4BnB;;;WAGG;;;;;QAQH;;;;WAIG;;YAFwB,gBAAgB;YACb,SAAS;;;;;;;;QA8EvC;;;;WAIG;yCAHQ,YAAY,kBACZ,MAAM,kBACN,SAAS;QAmBpB;;;;;;;WAOG;iCAFQ,MAAM,GAAG,MAAM,GACb,QAAQ,SAAS,CAAC;QAwB/B,kEAAkE;gCAA7C,MAAM,GAAK,SAAS,YAAY,GAAG,KAAK,CAAC;QAS9D;;;;;;WAMG;6CAFQ,YAAY,kBACZ,SAAS;;;;;;;;;QAyDpB;;;;;WAKG;2BAFQ,YAAY,gDACZ,UAAU;;GA+D1B;2BA7sBW,OAAO,qBAAqB,EAAE,YAAY;wBAE3C,OAAO,wBAAwB,EAAE,SAAS;2BAC1C,OAAO,wBAAwB,EAAE,YAAY;yBAmB7C;IAAE,OAAO,EAAE,MAAM,GAAG,SAAS,CAAC;IAAC,SAAS,EAAE,QAAQ,CAAA;CAAE;0BAEpD,KAAK,SAAS,EAAE,SAAS,GAAG,WAAW,CAAC,GAAI;IAAE,SAAS,EAAE,MAAM,CAAA;CAAE;wBAIjE,KAAK,GAAG;IAAC,OAAO,EAAE,MAAM,CAAA;CAAC;;;;;YAKxB,MAAM;;;;;eACN,SAAS;;;;;eAET,SAAS;;;;;;;qBAET,MAAM;;;iBAQN,MAAM,EAAE;oBACR,MAAM;oBACN,MAAM;kBACN,MAAM;;uBAIP,UAAU,KAAK,CAAC;yBAIhB,SAAS,OAAO,wBAAwB,EAAE,eAAe,GAAG;IACxE,QAAU,EAAE,QAAQ,CAAC;IACrB,eAAiB,EAAE,UAAU,IAAI,CAAC,CAAC;IACnC,OAAS,EAAE,MAAM,KAAK,CAAC,CAAC;IACxB,QAAU,EAAE,MAAM,KAAK,CAAC,CAAC;IACzB,oBAAsB,EAAE,OAAO,6CAA6C,EAAE,QAAQ,CAAC,WAAW,CAAC,CAAC;IACpG,aAAe,EAAE,YAAY,CAAC;CAC3B,CAAC;6BAEQ,SAAS,UAAU,GAAG;IAClC,OAAS,EAAE,SAAS,MAAM,EAAE,YAAY,CAAC,CAAC;IAC1C,MAAQ,EAAE,SAAS,MAAM,EAAE,KAAK,CAAC,CAAC;IAClC,MAAQ,EAAE,MAAM,CAAC;CACd,CAAC;2BAEQ;IACZ,qBAAuB,EAAE,MAAM,QAAE;IACjC,gBAAkB,EAAE,MAAM,CAAC;CACxB;oBAEU,cAAc,GAAG,YAAY"}
+{"version":3,"file":"roundsManager.d.ts","sourceRoot":"","sources":["roundsManager.js"],"names":[],"mappings":"AA0BA,qBAAqB;AACrB,wBADW,MAAM,CAC4B;AAmEtC;cAxBU,QAAQ;qBACD,UAAU,IAAI,CAAC;aACvB,MAAM,KAAK,CAAC;cACX,MAAM,KAAK,CAAC;0BACA,OAAO,6CAA6C,EAAE,QAAQ,CAAC,WAAW,CAAC;mBAClF,YAAY;;kBA4CU,OAAO,KAAK,CAAC;;;QAwDjD,8BAA8B;sCAAlB,MAAM;QAQlB;;;WAGG;wBAFQ,YAAY,WACZ,MAAM;QAQjB,8BAA8B;oCAAlB,MAAM;QASlB,8BAA8B;6BAAlB,MAAM;QAMlB;;;;WAIG;oCAHQ,MAAM,kBACN,SAAS,YACT,MAAM;QA4CjB;;;WAGG;8CAFQ,MAAM,QACN,MAAM;QAOjB;;;;;WAKG;iCAJQ,MAAM,UACN,YAAY,kBACZ,SAAS,GACP,YAAY,GAAG,SAAS;QAiBrC;;;;;WAKG;qCAJQ,MAAM,WACN,MAAM,UACN,YAAY,GACV,YAAY;QAwBzB;;;WAGG;8BAFQ,MAAM,kBACN,SAAS;QAWpB;;;WAGG;0BAFQ,MAAM,kBACN,SAAS;QAyBpB;;;WAGG;mCAFQ,MAAM,kBACN,SAAS;QAgCpB;;;WAGG;yCAFQ,MAAM,kBACN,SAAS;QA2BpB;;;;;WAKG;oCAJQ,YAAY,WACZ,MAAM,kBACN,SAAS,GACP,MAAM,GAAG,IAAI;;;QA4B1B,qCAAqC;;;;;QAQrC;;;;WAIG;;YAFwB,gBAAgB;YACb,SAAS;;;;;;;;QAwEvC;;;;WAIG;yCAHQ,YAAY,kBACZ,MAAM,kBACN,SAAS;QAmBpB;;;;;;WAMG;iCAFQ,MAAM,GAAG,MAAM,GACb,QAAQ,SAAS,CAAC;QAwB/B,kEAAkE;gCAA7C,MAAM,GAAK,SAAS,YAAY,GAAG,KAAK,CAAC;QAS9D;;;;;;;WAOG;6CAFQ,YAAY,kBACZ,SAAS;;;;;;;;;QAyDpB;;;;;WAKG;2BAFQ,YAAY,gDACZ,UAAU;;;;QAnerB,8BAA8B;sCAAlB,MAAM;QAQlB;;;WAGG;wBAFQ,YAAY,WACZ,MAAM;QAQjB,8BAA8B;oCAAlB,MAAM;QASlB,8BAA8B;6BAAlB,MAAM;QAMlB;;;;WAIG;oCAHQ,MAAM,kBACN,SAAS,YACT,MAAM;QA4CjB;;;WAGG;8CAFQ,MAAM,QACN,MAAM;QAOjB;;;;;WAKG;iCAJQ,MAAM,UACN,YAAY,kBACZ,SAAS,GACP,YAAY,GAAG,SAAS;QAiBrC;;;;;WAKG;qCAJQ,MAAM,WACN,MAAM,UACN,YAAY,GACV,YAAY;QAwBzB;;;WAGG;8BAFQ,MAAM,kBACN,SAAS;QAWpB;;;WAGG;0BAFQ,MAAM,kBACN,SAAS;QAyBpB;;;WAGG;mCAFQ,MAAM,kBACN,SAAS;QAgCpB;;;WAGG;yCAFQ,MAAM,kBACN,SAAS;QA2BpB;;;;;WAKG;oCAJQ,YAAY,WACZ,MAAM,kBACN,SAAS,GACP,MAAM,GAAG,IAAI;;;QA4B1B,qCAAqC;;;;;QAQrC;;;;WAIG;;YAFwB,gBAAgB;YACb,SAAS;;;;;;;;QAwEvC;;;;WAIG;yCAHQ,YAAY,kBACZ,MAAM,kBACN,SAAS;QAmBpB;;;;;;WAMG;iCAFQ,MAAM,GAAG,MAAM,GACb,QAAQ,SAAS,CAAC;QAwB/B,kEAAkE;gCAA7C,MAAM,GAAK,SAAS,YAAY,GAAG,KAAK,CAAC;QAS9D;;;;;;;WAOG;6CAFQ,YAAY,kBACZ,SAAS;;;;;;;;;QAyDpB;;;;;WAKG;2BAFQ,YAAY,gDACZ,UAAU;;GA+D1B;2BAjsBW,OAAO,qBAAqB,EAAE,YAAY;wBAE3C,OAAO,wBAAwB,EAAE,SAAS;2BAE1C,OAAO,wBAAwB,EAAE,YAAY;yBAiB7C;IAAE,OAAO,EAAE,MAAM,GAAG,SAAS,CAAC;IAAC,SAAS,EAAE,QAAQ,CAAA;CAAE;0BAEpD,KAAK,SAAS,EAAE,SAAS,GAAG,WAAW,CAAC,GAAG;IAAE,SAAS,EAAE,MAAM,CAAA;CAAE;wBAG/D,KAAK,GAAG;IAAE,OAAO,EAAE,MAAM,CAAA;CAAE;;;;;YAI3B,MAAM;;;;;eACN,SAAS;;;;;eAET,SAAS;;;;;;;qBAET,MAAM;;;iBAQN,MAAM,EAAE;oBACR,MAAM;oBACN,MAAM;kBACN,MAAM;;uBAGN,UAAU,KAAK,CAAC;yBAGjB,SACZ,OAAW,wBAAwB,EAAE,eAAe,GAAG;IACvD,QAAc,EAAE,QAAQ,CAAC;IACzB,eAAqB,EAAE,UAAU,IAAI,CAAC,CAAC;IACvC,OAAa,EAAE,MAAM,KAAK,CAAC,CAAC;IAC5B,QAAc,EAAE,MAAM,KAAK,CAAC,CAAC;IAC7B,oBAA0B,EAAE,OAAO,6CAA6C,EAAE,QAAQ,CAAC,WAAW,CAAC,CAAC;IACxG,aAAmB,EAAE,YAAY,CAAC;CAC7B,CACF;6BAES,SACZ,UAAc,GAAG;IACjB,OAAa,EAAE,SAAS,MAAM,EAAE,YAAY,CAAC,CAAC;IAC9C,MAAY,EAAE,SAAS,MAAM,EAAE,KAAK,CAAC,CAAC;IACtC,MAAY,EAAE,MAAM,CAAC;CAChB,CACF;2BAES;IACZ,qBAAyB,EAAE,MAAM,QAAE;IACnC,gBAAoB,EAAE,MAAM,CAAC;CAC1B;oBAEU,cAAc,GAAG,YAAY"}