@agoric/zoe 0.26.3-upgrade-14-dev-c8f9e7b.0 → 0.26.3-upgrade-16-dev-8879538.0

package/tools/priceAuthorityRegistry.js

@@ -1,209 +0,0 @@
-import { BrandShape } from '@agoric/ertp';
-import {
-  M,
-  prepareExo,
-  makeScalarBigMapStore,
-  provideDurableMapStore,
-} from '@agoric/vat-data';
-import { provideLazy } from '@agoric/store';
-import { E } from '@endo/eventual-send';
-import { Far } from '@endo/marshal';
-import { PriceAuthorityI } from '../src/contractSupport/priceAuthority.js';
-
-const { Fail } = assert;
-
-/**
- * @typedef {object} Deleter
- * @property {() => void} delete
- */
-
-/**
- * @typedef {object} PriceAuthorityRegistryAdmin
- * @property {(pa: ERef<PriceAuthority>,
- *             brandIn: Brand,
- *             brandOut: Brand,
- *             force?: boolean) => Promise<Deleter>} registerPriceAuthority
- * Add a unique price authority for a given pair
- */
-
-/**
- * @typedef {object} PriceAuthorityRegistry A price authority that is a facade
- * for other backing price authorities registered for a given asset and price
- * brand
- * @property {PriceAuthority} priceAuthority
- * @property {PriceAuthorityRegistryAdmin} adminFacet
- */
-
-/**
- * Make a singleton registry for priceAuthorities
- *
- * @param {import('@agoric/vat-data').Baggage} baggage
- * @returns {PriceAuthorityRegistry}
- */
-export const providePriceAuthorityRegistry = baggage => {
-  /**
-   * @typedef {object} PriceAuthorityRecord A record indicating a registered
-   * price authority.  We put a box around the priceAuthority to ensure the
-   * deleter doesn't delete the wrong thing.
-   * @property {ERef<PriceAuthority>} priceAuthority the sub-authority for a
-   * given input and output brand pair
-   */
-
-  /** @type {MapStore<Brand, MapStore<Brand, PriceAuthorityRecord>>} */
-  const assetToPriceStore = provideDurableMapStore(baggage, 'brandIn');
-
-  /**
-   * Get the registered price authority for a given input and output pair.
-   *
-   * @param {Brand} brandIn
-   * @param {Brand} brandOut
-   * @returns {ERef<PriceAuthority>}
-   */
-  const paFor = (brandIn, brandOut) => {
-    const priceStore = assetToPriceStore.get(brandIn);
-    return priceStore.get(brandOut).priceAuthority;
-  };
-
-  /**
-   * Create a quoteWhen* method for the given condition.
-   *
-   * @param {'LT' | 'LTE' | 'GTE' | 'GT'} relation
-   */
-  const makeQuoteWhen =
-    relation =>
-    /**
-     * Return a quote when relation is true of the arguments.
-     *
-     * @param {Amount<'nat'>} amountIn monitor the amountOut corresponding to this amountIn
-     * @param {Amount<'nat'>} amountOutLimit the value to compare with the monitored amountOut
-     * @returns {Promise<PriceQuote>} resolve with a quote when `amountOut
-     * relation amountOutLimit` is true
-     */
-    async (amountIn, amountOutLimit) => {
-      const pa = paFor(amountIn.brand, amountOutLimit.brand);
-      return E(pa)[`quoteWhen${relation}`](amountIn, amountOutLimit);
-    };
-
-  /**
-   * Create a mutableQuoteWhen* method for the given condition.
-   *
-   * @param {'LT' | 'LTE' | 'GTE' | 'GT'} relation
-   */
-  const makeMutableQuoteWhen =
-    relation =>
-    /**
-     * Return a mutable quote when relation is true of the arguments.
-     *
-     * @param {Amount} amountIn monitor the amountOut corresponding to this amountIn
-     * @param {Amount} amountOutLimit the value to compare with the monitored amountOut
-     * @returns {Promise<MutableQuote>} resolve with a quote when `amountOut
-     * relation amountOutLimit` is true
-     */
-    async (amountIn, amountOutLimit) => {
-      const pa = paFor(amountIn.brand, amountOutLimit.brand);
-      return E(pa)[`mutableQuoteWhen${relation}`](amountIn, amountOutLimit);
-    };
-
-  /**
-   * This PriceAuthority is just a wrapper for multiple registered
-   * PriceAuthorities.
-   *
-   * @type {PriceAuthority}
-   */
-  const priceAuthority = prepareExo(
-    baggage,
-    'composite price authority',
-    PriceAuthorityI,
-    {
-      getQuoteIssuer(brandIn, brandOut) {
-        return E(paFor(brandIn, brandOut)).getQuoteIssuer(brandIn, brandOut);
-      },
-      getTimerService(brandIn, brandOut) {
-        return E(paFor(brandIn, brandOut)).getTimerService(brandIn, brandOut);
-      },
-      quoteGiven(amountIn, brandOut) {
-        return E(paFor(amountIn.brand, brandOut)).quoteGiven(
-          amountIn,
-          brandOut,
-        );
-      },
-      quoteWanted(brandIn, amountOut) {
-        return E(paFor(brandIn, amountOut.brand)).quoteWanted(
-          brandIn,
-          amountOut,
-        );
-      },
-      makeQuoteNotifier(amountIn, brandOut) {
-        return E(paFor(amountIn.brand, brandOut)).makeQuoteNotifier(
-          amountIn,
-          brandOut,
-        );
-      },
-      quoteAtTime(deadline, amountIn, brandOut) {
-        return E(paFor(amountIn.brand, brandOut)).quoteAtTime(
-          deadline,
-          amountIn,
-          brandOut,
-        );
-      },
-      quoteWhenLT: makeQuoteWhen('LT'),
-      quoteWhenLTE: makeQuoteWhen('LTE'),
-      quoteWhenGTE: makeQuoteWhen('GTE'),
-      quoteWhenGT: makeQuoteWhen('GT'),
-      mutableQuoteWhenLT: makeMutableQuoteWhen('LT'),
-      mutableQuoteWhenLTE: makeMutableQuoteWhen('LTE'),
-      mutableQuoteWhenGTE: makeMutableQuoteWhen('GTE'),
-      mutableQuoteWhenGT: makeMutableQuoteWhen('GT'),
-    },
-  );
-
-  /** @type {PriceAuthorityRegistryAdmin} */
-  const adminFacet = prepareExo(
-    baggage,
-    'price authority admin facet',
-    M.interface('priceAuthorityRegistryAdmin', {
-      registerPriceAuthority: M.callWhen(
-        M.await(M.remotable('priceAuthority')),
-        BrandShape,
-        BrandShape,
-      )
-        .optional(M.boolean())
-        .returns(M.remotable('deleter')),
-    }),
-    {
-      registerPriceAuthority(pa, brandIn, brandOut, force = false) {
-        /** @type {MapStore<Brand, PriceAuthorityRecord>} */
-        const priceStore = provideLazy(assetToPriceStore, brandIn, () =>
-          makeScalarBigMapStore('brandOut', { durable: true }),
-        );
-
-        // Put a box around the authority so that we can be ensured the deleter
-        // won't delete the wrong thing.
-        const record = {
-          priceAuthority: pa,
-        };
-
-        // Set up the record.
-        if (force && priceStore.has(brandOut)) {
-          priceStore.set(brandOut, harden(record));
-        } else {
-          priceStore.init(brandOut, harden(record));
-        }
-
-        return Far('deleter', {
-          // @ts-expect-error XXX callWhen
-          delete() {
-            (priceStore.has(brandOut) && priceStore.get(brandOut) === record) ||
-              Fail`Price authority already dropped`;
-            priceStore.delete(brandOut);
-          },
-        });
-      },
-    },
-  );
-
-  return harden({
-    priceAuthority,
-    adminFacet,
-  });
-};

package/tools/types-ambient.d.ts

@@ -1,142 +0,0 @@
-type PriceQuote = {
-    /**
-     * Amount whose value is a PriceQuoteValue
-     */
-    quoteAmount: Amount<'set'>;
-    /**
-     * The `quoteAmount` wrapped as a payment
-     */
-    quotePayment: ERef<Payment<'set'>>;
-};
-/**
- * A single-valued set of PriceDescriptions.  This is the `value` in
- * PriceQuote.quoteAmount (`{ brand, value: PriceQuoteValue }`).
- */
-type PriceQuoteValue = [PriceDescription];
-/**
- * A description of a single quote
- */
-type PriceDescription = {
-    /**
-     * The amount supplied to a trade
-     */
-    amountIn: Amount<'nat'>;
-    /**
-     * The quoted result of trading `amountIn`
-     */
-    amountOut: Amount<'nat'>;
-    /**
-     * The service that gave the `timestamp`
-     */
-    timer: import('@agoric/time/src/types').TimerService;
-    /**
-     * A timestamp according to `timer` for the quote
-     */
-    timestamp: import('@agoric/time/src/types').TimestampRecord;
-    /**
-     * Additional conditions for the quote
-     */
-    conditions?: any;
-};
-type PriceQuoteCreate = (priceQuery: PriceQuery) => ERef<PriceQuote> | undefined;
-type PriceQuoteTrigger = (createQuote: PriceQuoteCreate) => any;
-type PriceAuthorityAdmin = {
-    fireTriggers: (createQuote: PriceQuoteCreate) => Promise<void>;
-};
-type PriceAuthorityKit = {
-    priceAuthority: PriceAuthority;
-    adminFacet: PriceAuthorityAdmin;
-};
-type MutableQuote = {
-    cancel: (reason?: any) => void;
-    updateLevel: (amountIn: Amount<'nat'>, amountOut: Amount<'nat'>) => void;
-    getPromise: () => ERef<PriceQuote>;
-};
-/**
- * An object that mints PriceQuotes and handles
- * triggers and notifiers for changes in the price
- */
-type PriceAuthority = {
-    /**
-     * Get the ERTP issuer of PriceQuotes for a given brandIn/brandOut pair
-     */
-    getQuoteIssuer: (brandIn: Brand, brandOut: Brand) => ERef<Issuer<'set'>>;
-    /**
-     * Get the timer used in PriceQuotes for a given brandIn/brandOut pair
-     */
-    getTimerService: (brandIn: Brand, brandOut: Brand) => ERef<import('@agoric/time/src/types').TimerService>;
-    /**
-     * Be notified of the latest PriceQuotes for a given
-     * `amountIn`.  The rate at which these are issued may be very different between
-     * `priceAuthorities`.
-     */
-    makeQuoteNotifier: (amountIn: Amount<'nat'>, brandOut: Brand<'nat'>) => ERef<Notifier<PriceQuote>>;
-    /**
-     * Resolves after `deadline` passes on the
-     * priceAuthority's timerService with the price quote of `amountIn` at that time
-     */
-    quoteAtTime: (deadline: import('@agoric/time/src/types').Timestamp, amountIn: Amount<'nat'>, brandOut: Brand<'nat'>) => Promise<PriceQuote>;
-    /**
-     * Get a quote corresponding to the specified amountIn
-     */
-    quoteGiven: (amountIn: Amount<'nat'>, brandOut: Brand<'nat'>) => Promise<PriceQuote>;
-    /**
-     * Get a quote corresponding to the specified amountOut
-     */
-    quoteWanted: (brandIn: Brand<'nat'>, amountOut: Amount<'nat'>) => Promise<PriceQuote>;
-    /**
-     * Resolve when a price quote of `amountIn` exceeds `amountOutLimit`
-     */
-    quoteWhenGT: (amountIn: Amount<'nat'>, amountOutLimit: Amount<'nat'>) => Promise<PriceQuote>;
-    /**
-     * Resolve when a price quote of `amountIn` reaches or exceeds `amountOutLimit`
-     */
-    quoteWhenGTE: (amountIn: Amount<'nat'>, amountOutLimit: Amount<'nat'>) => Promise<PriceQuote>;
-    /**
-     * Resolve when a price quote of `amountIn` reaches or drops below
-     * `amountOutLimit`
-     */
-    quoteWhenLTE: (amountIn: Amount, amountOutLimit: Amount) => Promise<PriceQuote>;
-    /**
-     * Resolve when the price quote of `amountIn` drops below `amountOutLimit`
-     */
-    quoteWhenLT: (amountIn: Amount, amountOutLimit: Amount) => Promise<PriceQuote>;
-    /**
-     * Resolve when a price quote of `amountIn` exceeds `amountOutLimit`
-     */
-    mutableQuoteWhenGT: (amountIn: Amount, amountOutLimit: Amount) => ERef<MutableQuote>;
-    /**
-     * Resolve when a price quote of `amountIn` reaches or exceeds
-     * `amountOutLimit`
-     */
-    mutableQuoteWhenGTE: (amountIn: Amount, amountOutLimit: Amount) => ERef<MutableQuote>;
-    /**
-     * Resolve when a price quote of `amountIn` reaches or drops below
-     * `amountOutLimit`
-     */
-    mutableQuoteWhenLTE: (amountIn: Amount, amountOutLimit: Amount) => ERef<MutableQuote>;
-    /**
-     * Resolve when the price quote of `amountIn` drops below `amountOutLimit`
-     */
-    mutableQuoteWhenLT: (amountIn: Amount, amountOutLimit: Amount) => ERef<MutableQuote>;
-};
-type PriceCalculator = (amount: Amount<'nat'>) => Amount<'nat'>;
-type PriceQuery = (calcAmountIn: PriceCalculator, calcAmountOut: PriceCalculator) => {
-    amountIn: Amount<'nat'>;
-    amountOut: Amount<'nat'>;
-    timestamp?: import('@agoric/time/src/types').TimestampRecord;
-} | undefined;
-/**
- * A description of a single quote
- */
-type PriceLevel = {
-    /**
-     * The amount supplied to a trade
-     */
-    amountIn: Amount<'nat'>;
-    /**
-     * The quoted result of trading `amountIn`
-     */
-    amountOut: Amount<'nat'>;
-};
-//# sourceMappingURL=types-ambient.d.ts.map

package/tools/types-ambient.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"types-ambient.d.ts","sourceRoot":"","sources":["types-ambient.js"],"names":[],"mappings":";;;;iBAIc,OAAO,KAAK,CAAC;;;;kBAEb,KAAK,QAAQ,KAAK,CAAC,CAAC;;;;;;uBAKrB,CAAC,gBAAgB,CAAC;;;;;;;;cAQjB,OAAO,KAAK,CAAC;;;;eAEb,OAAO,KAAK,CAAC;;;;WAEb,OAAO,wBAAwB,EAAE,YAAY;;;;eAE7C,OAAO,wBAAwB,EAAE,eAAe;;;;iBAEhD,GAAG;;qCAMN,UAAU,KACR,KAAK,UAAU,CAAC,GAAG,SAAS;uCAK9B,gBAAgB;;gCAKC,gBAAgB,KAAK,QAAQ,IAAI,CAAC;;;oBAKhD,cAAc;gBACd,mBAAmB;;;sBAKT,GAAG,KAAK,IAAI;4BACX,OAAO,KAAK,CAAC,aAAa,OAAO,KAAK,CAAC,KAAK,IAAI;gBAC3D,MAAM,KAAK,UAAU,CAAC;;;;;;;;;;8BAQZ,KAAK,YAAY,KAAK,KAAK,KAAK,OAAO,KAAK,CAAC,CAAC;;;;+BAG9C,KAAK,YACJ,KAAK,KACtB,KAAK,OAAO,wBAAwB,EAAE,YAAY,CAAC;;;;;;kCAGlC,OAAO,KAAK,CAAC,YACb,MAAM,KAAK,CAAC,KAClB,KAAK,SAAS,UAAU,CAAC,CAAC;;;;;4BAKpB,OAAO,wBAAwB,EAAE,SAAS,YAC1C,OAAO,KAAK,CAAC,YACb,MAAM,KAAK,CAAC,KAC7B,QAAQ,UAAU,CAAC;;;;2BAIF,OAAO,KAAK,CAAC,YACb,MAAM,KAAK,CAAC,KAC7B,QAAQ,UAAU,CAAC;;;;2BAGH,MAAM,KAAK,CAAC,aACV,OAAO,KAAK,CAAC,KAAK,QAAQ,UAAU,CAAC;;;;4BAGtC,OAAO,KAAK,CAAC,kBACP,OAAO,KAAK,CAAC,KACpC,QAAQ,UAAU,CAAC;;;;6BAGF,OAAO,KAAK,CAAC,kBACP,OAAO,KAAK,CAAC,KACpC,QAAQ,UAAU,CAAC;;;;;6BAGF,MAAM,kBACA,MAAM,KAC7B,QAAQ,UAAU,CAAC;;;;4BAIF,MAAM,kBACA,MAAM,KAC7B,QAAQ,UAAU,CAAC;;;;mCAGF,MAAM,kBACA,MAAM,KAC7B,KAAK,YAAY,CAAC;;;;;oCAGD,MAAM,kBACA,MAAM,KAC7B,KAAK,YAAY,CAAC;;;;;oCAID,MAAM,kBACA,MAAM,KAC7B,KAAK,YAAY,CAAC;;;;mCAID,MAAM,kBACA,MAAM,KAC7B,KAAK,YAAY,CAAC;;gCAKJ,OAAO,KAAK,CAAC,KAAK,OAAO,KAAK,CAAC;iCAK1C,eAAe,iBACf,eAAe,KACb;IAAE,QAAQ,EAAE,OAAO,KAAK,CAAC,CAAC;IAAC,SAAS,EAAE,OAAO,KAAK,CAAC,CAAC;IAAC,SAAS,CAAC,EAAE,OAAO,wBAAwB,EAAE,eAAe,CAAA;CAAE,GAAG,SAAS;;;;;;;;cAO9H,OAAO,KAAK,CAAC;;;;eAEb,OAAO,KAAK,CAAC"}

package/tools/types-ambient.js

@@ -1,160 +0,0 @@
-// @jessie-check
-
-/**
- * @typedef {object} PriceQuote
- * @property {Amount<'set'>} quoteAmount
- * Amount whose value is a PriceQuoteValue
- * @property {ERef<Payment<'set'>>} quotePayment
- * The `quoteAmount` wrapped as a payment
- */
-
-/**
- * @typedef {[PriceDescription]} PriceQuoteValue
- * A single-valued set of PriceDescriptions.  This is the `value` in
- * PriceQuote.quoteAmount (`{ brand, value: PriceQuoteValue }`).
- */
-
-/**
- * @typedef {object} PriceDescription
- * A description of a single quote
- * @property {Amount<'nat'>} amountIn
- * The amount supplied to a trade
- * @property {Amount<'nat'>} amountOut
- * The quoted result of trading `amountIn`
- * @property {import('@agoric/time/src/types').TimerService} timer
- * The service that gave the `timestamp`
- * @property {import('@agoric/time/src/types').TimestampRecord} timestamp
- * A timestamp according to `timer` for the quote
- * @property {any} [conditions]
- * Additional conditions for the quote
- */
-
-/**
- * @callback PriceQuoteCreate
- * @param {PriceQuery} priceQuery
- * @returns {ERef<PriceQuote> | undefined}
- */
-
-/**
- * @callback PriceQuoteTrigger
- * @param {PriceQuoteCreate} createQuote
- */
-
-/**
- * @typedef {object} PriceAuthorityAdmin
- * @property {(createQuote: PriceQuoteCreate) => Promise<void>} fireTriggers
- */
-
-/**
- * @typedef {object} PriceAuthorityKit
- * @property {PriceAuthority} priceAuthority
- * @property {PriceAuthorityAdmin} adminFacet
- */
-
-/**
- * @typedef {object} MutableQuote
- * @property {(reason?: any) => void} cancel
- * @property {(amountIn: Amount<'nat'>, amountOut: Amount<'nat'>) => void} updateLevel
- * @property {() => ERef<PriceQuote>} getPromise
- */
-
-/**
- * @typedef {object} PriceAuthority
- * An object that mints PriceQuotes and handles
- * triggers and notifiers for changes in the price
- *
- * @property {(brandIn: Brand, brandOut: Brand) => ERef<Issuer<'set'>>} getQuoteIssuer
- * Get the ERTP issuer of PriceQuotes for a given brandIn/brandOut pair
- *
- * @property {(brandIn: Brand,
- *             brandOut: Brand
- * ) => ERef<import('@agoric/time/src/types').TimerService>} getTimerService
- * Get the timer used in PriceQuotes for a given brandIn/brandOut pair
- *
- * @property {(amountIn: Amount<'nat'>,
- *             brandOut: Brand<'nat'>
- *            ) => ERef<Notifier<PriceQuote>>} makeQuoteNotifier
- * Be notified of the latest PriceQuotes for a given
- * `amountIn`.  The rate at which these are issued may be very different between
- * `priceAuthorities`.
- *
- * @property {(deadline: import('@agoric/time/src/types').Timestamp,
- *             amountIn: Amount<'nat'>,
- *             brandOut: Brand<'nat'>
- * ) => Promise<PriceQuote>} quoteAtTime
- * Resolves after `deadline` passes on the
- * priceAuthority's timerService with the price quote of `amountIn` at that time
- *
- * @property {(amountIn: Amount<'nat'>,
- *             brandOut: Brand<'nat'>
- * ) => Promise<PriceQuote>} quoteGiven
- * Get a quote corresponding to the specified amountIn
- *
- * @property {(brandIn: Brand<'nat'>,
- *             amountOut: Amount<'nat'>) => Promise<PriceQuote>} quoteWanted
- * Get a quote corresponding to the specified amountOut
- *
- * @property {(amountIn: Amount<'nat'>,
- *             amountOutLimit: Amount<'nat'>
- * ) => Promise<PriceQuote>} quoteWhenGT
- * Resolve when a price quote of `amountIn` exceeds `amountOutLimit`
- *
- * @property {(amountIn: Amount<'nat'>,
- *             amountOutLimit: Amount<'nat'>
- * ) => Promise<PriceQuote>} quoteWhenGTE
- * Resolve when a price quote of `amountIn` reaches or exceeds `amountOutLimit`
- *
- * @property {(amountIn: Amount,
- *             amountOutLimit: Amount
- * ) => Promise<PriceQuote>} quoteWhenLTE
- * Resolve when a price quote of `amountIn` reaches or drops below
- * `amountOutLimit`
- *
- * @property {(amountIn: Amount,
- *             amountOutLimit: Amount
- * ) => Promise<PriceQuote>} quoteWhenLT
- * Resolve when the price quote of `amountIn` drops below `amountOutLimit`
- *
- * @property {(amountIn: Amount,
- *             amountOutLimit: Amount
- * ) => ERef<MutableQuote>} mutableQuoteWhenGT
- * Resolve when a price quote of `amountIn` exceeds `amountOutLimit`
- *
- * @property {(amountIn: Amount,
- *             amountOutLimit: Amount
- * ) => ERef<MutableQuote>} mutableQuoteWhenGTE
- * Resolve when a price quote of `amountIn` reaches or exceeds
- * `amountOutLimit`
- *
- * @property {(amountIn: Amount,
- *             amountOutLimit: Amount
- * ) => ERef<MutableQuote>} mutableQuoteWhenLTE
- * Resolve when a price quote of `amountIn` reaches or drops below
- * `amountOutLimit`
- *
- * @property {(amountIn: Amount,
- *             amountOutLimit: Amount
- * ) => ERef<MutableQuote>} mutableQuoteWhenLT
- * Resolve when the price quote of `amountIn` drops below `amountOutLimit`
- */
-
-/**
- * @typedef {(amount: Amount<'nat'>) => Amount<'nat'>} PriceCalculator
- */
-
-/**
- * @callback PriceQuery
- * @param {PriceCalculator} calcAmountIn
- * @param {PriceCalculator} calcAmountOut
- * @returns {{ amountIn: Amount<'nat'>, amountOut: Amount<'nat'>, timestamp?: import('@agoric/time/src/types').TimestampRecord } | undefined}
- */
-
-/**
- * @typedef {object} PriceLevel
- * A description of a single quote
- *
- * @property {Amount<'nat'>} amountIn
- * The amount supplied to a trade
- * @property {Amount<'nat'>} amountOut
- * The quoted result of trading `amountIn`
- */