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

package/src/contractSupport/priceAuthority.js

@@ -1,8 +1,6 @@
-/// <reference path="../../../time/src/types.d.ts" />
-
+/* eslint @typescript-eslint/no-floating-promises: "warn" */
 import { E } from '@endo/eventual-send';
 import { Far } from '@endo/marshal';
-import { assert, q, Fail } from '@agoric/assert';
 import { makePromiseKit } from '@endo/promise-kit';
 import { AmountMath, AmountShape, BrandShape } from '@agoric/ertp';
 import { makeNotifier } from '@agoric/notifier';
@@ -10,6 +8,12 @@ import { makeTracer } from '@agoric/internal';
 import { TimestampShape } from '@agoric/time';
 import { M } from '@agoric/store';
 
+/**
+ * @import {PriceAuthority, PriceDescription, PriceQuote, PriceQuoteValue, PriceQuery, PriceQuoteCreate, PriceAuthorityKit, PriceQuoteTrigger, MutableQuote,} from '@agoric/zoe/tools/types.js';
+ */
+
+const { quote: q, Fail } = assert;
+
 const trace = makeTracer('PA', false);
 
 /**
@@ -61,15 +65,15 @@ export const PriceAuthorityI = M.interface('PriceAuthority', {
 
 /**
  * @param {object} opts
- * @param {Issuer<'set'>} opts.quoteIssuer
+ * @param {Issuer<'set', PriceDescription>} opts.quoteIssuer
  * @param {ERef<Notifier<unknown>>} opts.notifier
- * @param {ERef<import('@agoric/time/src/types').TimerService>} opts.timer
+ * @param {ERef<import('@agoric/time').TimerService>} opts.timer
  * @param {PriceQuoteCreate} opts.createQuote
  * @param {Brand<'nat'>} opts.actualBrandIn
  * @param {Brand<'nat'>} opts.actualBrandOut
  * @returns {PriceAuthorityKit}
  */
-export function makeOnewayPriceAuthorityKit(opts) {
+export const makeOnewayPriceAuthorityKit = opts => {
   const {
     timer,
     createQuote,
@@ -81,7 +85,7 @@ export function makeOnewayPriceAuthorityKit(opts) {
 
   let haveFirstQuote = false;
 
-  E(notifier)
+  void E(notifier)
     .getUpdateSince()
     .then(_ => (haveFirstQuote = true));
 
@@ -109,7 +113,8 @@ export function makeOnewayPriceAuthorityKit(opts) {
    *
    * @param {CompareAmount} compareAmountsFn
    */
-  const makeQuoteWhenOut = compareAmountsFn =>
+  const makeQuoteWhenOut =
+    compareAmountsFn =>
     /**
      * Return a quote when triggerWhen is true of the arguments.
      *
@@ -117,7 +122,7 @@ export function makeOnewayPriceAuthorityKit(opts) {
      * @param {Amount} amountOutLimit the value to compare with the output
      * of calcAmountTrigger
      */
-    async function quoteWhenOutTrigger(amountIn, amountOutLimit) {
+    async (amountIn, amountOutLimit) => {
       amountIn = AmountMath.coerce(actualBrandIn, amountIn);
       amountOutLimit = AmountMath.coerce(actualBrandOut, amountOutLimit);
 
@@ -170,12 +175,13 @@ export function makeOnewayPriceAuthorityKit(opts) {
    *
    * @param {CompareAmount} compareAmountsFn
    */
-  const makeMutableQuote = compareAmountsFn =>
+  const makeMutableQuote =
+    compareAmountsFn =>
     /**
      * @param {Amount<'nat'>} amountIn
      * @param {Amount<'nat'>} amountOutLimit
      */
-    async function mutableQuoteWhenOutTrigger(amountIn, amountOutLimit) {
+    async (amountIn, amountOutLimit) => {
       AmountMath.coerce(actualBrandIn, amountIn);
       AmountMath.coerce(actualBrandOut, amountOutLimit);
 
@@ -273,12 +279,20 @@ export function makeOnewayPriceAuthorityKit(opts) {
           const record = await E(notifier).getUpdateSince(updateCount);
 
           // We create a quote inline.
-          const quote = createQuote(calcAmountOut => ({
-            amountIn,
-            amountOut: calcAmountOut(amountIn),
-          }));
+          let quote;
+          // createQuote can throw if priceAuthority is replaced.
+
+          try {
+            quote = createQuote(calcAmountOut => ({
+              amountIn,
+              amountOut: calcAmountOut(amountIn),
+            }));
+          } catch (e) {
+            // fall through
+          }
+
           if (!quote) {
-            throw Fail`createQuote returned falsey`;
+            throw Fail`createQuote returned nothing`;
           }
 
           const value = await quote;
@@ -336,6 +350,7 @@ export function makeOnewayPriceAuthorityKit(opts) {
         deadline,
         Far('wakeObj', {
           async wake(timestamp) {
+            await null;
             try {
               const quoteP = createQuote(calcAmountOut => ({
                 amountIn,
@@ -368,4 +383,4 @@ export function makeOnewayPriceAuthorityKit(opts) {
   });
 
   return { priceAuthority, adminFacet: { fireTriggers } };
-}
+};

package/src/contractSupport/priceAuthorityInitial.d.ts

@@ -1,3 +1,4 @@
-export function makeInitialTransform(priceOutPerIn: Ratio, priceAuthority: PriceAuthority, quoteMint: ERef<Mint<'set'>>, brandIn: Brand<'nat'>, brandOut: Brand<'nat'>): PriceAuthority;
-export type EOnly<T> = import('@endo/eventual-send').EOnly<T>;
+export function makeInitialTransform(priceOutPerIn: Ratio, priceAuthority: PriceAuthority, quoteMint: globalThis.ERef<globalThis.Mint<"set", PriceDescription>>, brandIn: Brand<"nat">, brandOut: Brand<"nat">): PriceAuthority;
+import type { PriceAuthority } from '@agoric/zoe/tools/types.js';
+import type { PriceDescription } from '@agoric/zoe/tools/types.js';
 //# sourceMappingURL=priceAuthorityInitial.d.ts.map

package/src/contractSupport/priceAuthorityInitial.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"priceAuthorityInitial.d.ts","sourceRoot":"","sources":["priceAuthorityInitial.js"],"names":[],"mappings":"AA2BO,oDAPI,KAAK,kBACL,cAAc,aACd,KAAK,KAAK,KAAK,CAAC,CAAC,WACjB,MAAM,KAAK,CAAC,YACZ,MAAM,KAAK,CAAC,GACV,cAAc,CAyF1B;uBAtGyB,OAAO,qBAAqB,EAAE,KAAK,CAAC,CAAC,CAAC"}
+{"version":3,"file":"priceAuthorityInitial.d.ts","sourceRoot":"","sources":["priceAuthorityInitial.js"],"names":[],"mappings":"AA8BO,oDAPI,KAAK,iHAGL,KAAK,CAAC,KAAK,CAAC,YACZ,KAAK,CAAC,KAAK,CAAC,kBA0FtB;oCAvG4F,4BAA4B;sCAA5B,4BAA4B"}

package/src/contractSupport/priceAuthorityInitial.js

@@ -1,5 +1,6 @@
 // @ts-check
 // @jessie-check
+/* eslint @typescript-eslint/no-floating-promises: "warn" */
 
 import { E } from '@endo/far';
 import { Far } from '@endo/marshal';
@@ -10,7 +11,9 @@ import { AmountMath } from '@agoric/ertp';
 import { multiplyBy } from './ratio.js';
 import { mintQuote } from './priceAuthorityTransform.js';
 
-/** @template T @typedef {import('@endo/eventual-send').EOnly<T>} EOnly */
+/**
+ * @import {PriceAuthority, PriceDescription, PriceQuote, PriceQuoteValue, PriceQuery,} from '@agoric/zoe/tools/types.js';
+ */
 
 /**
  * Override `makeQuoteNotifier`, `quoteGiven` to provide an initial price
@@ -20,7 +23,7 @@ import { mintQuote } from './priceAuthorityTransform.js';
  *
  * @param {Ratio} priceOutPerIn
  * @param {PriceAuthority} priceAuthority
- * @param {ERef<Mint<'set'>>} quoteMint
+ * @param {ERef<Mint<'set', PriceDescription>>} quoteMint
  * @param {Brand<'nat'>} brandIn
  * @param {Brand<'nat'>} brandOut
  * @returns {PriceAuthority}

package/src/contractSupport/priceAuthorityQuoteMint.d.ts

@@ -1,2 +1,3 @@
-export function provideQuoteMint(baggage: MapStore<string, unknown>): Mint<"set">;
+export function provideQuoteMint(baggage: import("@agoric/vat-data").Baggage): globalThis.ERef<globalThis.Mint<"set", PriceDescription>>;
+import type { PriceDescription } from '@agoric/zoe/tools/types.js';
 //# sourceMappingURL=priceAuthorityQuoteMint.d.ts.map

package/src/contractSupport/priceAuthorityQuoteMint.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"priceAuthorityQuoteMint.d.ts","sourceRoot":"","sources":["priceAuthorityQuoteMint.js"],"names":[],"mappings":"AAWO,kFAsBN"}
+{"version":3,"file":"priceAuthorityQuoteMint.d.ts","sourceRoot":"","sources":["priceAuthorityQuoteMint.js"],"names":[],"mappings":"AAaO,0CAHI,OAAO,kBAAkB,EAAE,OAAO,6DAmB5C;sCAxB0G,4BAA4B"}

package/src/contractSupport/priceAuthorityQuoteMint.js

@@ -1,34 +1,30 @@
-import {
-  AssetKind,
-  makeDurableIssuerKit,
-  prepareIssuerKit,
-} from '@agoric/ertp';
-import { makeScalarBigMapStore } from '@agoric/vat-data';
+import { AssetKind, prepareIssuerKit } from '@agoric/ertp';
+import { provideDurableMapStore } from '@agoric/vat-data';
+
+/**
+ * @import {EOnly} from '@endo/eventual-send';
+ * @import {MutableQuote, PriceAuthority, PriceDescription, PriceQuote, PriceQuoteValue, PriceQuery,} from '@agoric/zoe/tools/types.js';
+ */
 
 /**
  *
  * @param {import('@agoric/vat-data').Baggage} baggage
+ * @returns {ERef<Mint<'set', PriceDescription>>}
  */
 export const provideQuoteMint = baggage => {
-  /** @type {ERef<Mint<'set'>>} */
-  let baggageQuoteMint;
-  if (baggage.has(`quoteMintIssuerBaggage`)) {
-    const issuerBaggage = baggage.get(`quoteMintIssuerBaggage`);
-    baggageQuoteMint = /** @type {Mint<'set'>} */ (
-      prepareIssuerKit(issuerBaggage).mint
-    );
-  } else {
-    const issuerBaggage = makeScalarBigMapStore(
-      `scaledPriceAuthority quoteMintIssuerBaggage`,
-      { durable: true },
-    );
-    baggage.init(`quoteMintIssuerBaggage`, issuerBaggage);
-    baggageQuoteMint = makeDurableIssuerKit(
-      issuerBaggage,
-      'quote',
-      AssetKind.SET,
-    ).mint;
-  }
-
-  return baggageQuoteMint;
+  const issuerBaggage = provideDurableMapStore(
+    baggage,
+    'quoteMintIssuerBaggage',
+  );
+  /** @type {IssuerKit<'set', PriceDescription>} */
+  // @ts-expect-error cast
+  const issuerKit = prepareIssuerKit(
+    issuerBaggage,
+    'quote',
+    AssetKind.SET,
+    undefined,
+    undefined,
+    { recoverySetsOption: 'noRecoverySets' },
+  );
+  return issuerKit.mint;
 };

package/src/contractSupport/priceAuthorityTransform.d.ts

@@ -1,15 +1,17 @@
-export function mintQuote(quoteBrand: Brand<'set'>, amountIn: Amount<'nat'>, amountOut: Amount<'nat'>, timer: ERef<import('@agoric/time/src/types').TimerService>, timestamp: import('@agoric/time').Timestamp, quoteMint: ERef<Mint<'set'>>): Promise<PriceQuote>;
+export function mintQuote(quoteBrand: Brand<"set">, amountIn: Amount<"nat">, amountOut: Amount<"nat">, timer: import("@agoric/time").TimerService, timestamp: import("@agoric/time").TimestampRecord, quoteMint: globalThis.ERef<globalThis.Mint<"set", PriceDescription>>): Promise<PriceQuote>;
 export function makePriceAuthorityTransform({ quoteMint, sourcePriceAuthority, sourceBrandIn, sourceBrandOut, actualBrandIn, actualBrandOut, makeSourceAmountIn, makeSourceAmountOut, transformSourceAmountIn, transformSourceAmountOut, }: {
-    quoteMint: ERef<Mint<'set'>>;
-    sourcePriceAuthority: ERef<PriceAuthority>;
-    sourceBrandIn: Brand<'nat'>;
-    sourceBrandOut: Brand<'nat'>;
-    actualBrandIn?: Brand<"nat"> | undefined;
-    actualBrandOut?: Brand<"nat"> | undefined;
-    makeSourceAmountIn?: ((amountIn: Amount<'nat'>) => Amount<'nat'>) | undefined;
-    makeSourceAmountOut?: ((amountOut: Amount<'nat'>) => Amount<'nat'>) | undefined;
-    transformSourceAmountIn?: ((sourceAmountIn: Amount<'nat'>) => Amount<'nat'>) | undefined;
-    transformSourceAmountOut?: ((sourceAmountOut: Amount<'nat'>) => Amount<'nat'>) | undefined;
+    quoteMint: globalThis.ERef<globalThis.Mint<"set", PriceDescription>>;
+    sourcePriceAuthority: globalThis.ERef<PriceAuthority>;
+    sourceBrandIn: Brand<"nat">;
+    sourceBrandOut: Brand<"nat">;
+    actualBrandIn?: globalThis.Brand<"nat"> | undefined;
+    actualBrandOut?: globalThis.Brand<"nat"> | undefined;
+    makeSourceAmountIn?: ((amountIn: Amount<"nat">) => Amount<"nat">) | undefined;
+    makeSourceAmountOut?: ((amountOut: Amount<"nat">) => Amount<"nat">) | undefined;
+    transformSourceAmountIn?: ((sourceAmountIn: Amount<"nat">) => Amount<"nat">) | undefined;
+    transformSourceAmountOut?: ((sourceAmountOut: Amount<"nat">) => Amount<"nat">) | undefined;
 }): Promise<PriceAuthority>;
-export type EOnly<T> = import('@endo/eventual-send').EOnly<T>;
+import type { PriceDescription } from '@agoric/zoe/tools/types.js';
+import type { PriceQuote } from '@agoric/zoe/tools/types.js';
+import type { PriceAuthority } from '@agoric/zoe/tools/types.js';
 //# sourceMappingURL=priceAuthorityTransform.d.ts.map

package/src/contractSupport/priceAuthorityTransform.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"priceAuthorityTransform.d.ts","sourceRoot":"","sources":["priceAuthorityTransform.js"],"names":[],"mappings":"AAiBO,sCARI,MAAM,KAAK,CAAC,YACZ,OAAO,KAAK,CAAC,aACb,OAAO,KAAK,CAAC,SACb,KAAK,OAAO,wBAAwB,EAAE,YAAY,CAAC,aACnD,OAAO,cAAc,EAAE,SAAS,aAChC,KAAK,KAAK,KAAK,CAAC,CAAC,GACf,QAAQ,UAAU,CAAC,CAmB/B;AAeM;IAX4B,SAAS,EAAjC,KAAK,KAAK,KAAK,CAAC,CAAC;IACU,oBAAoB,EAA/C,KAAK,cAAc,CAAC;IACD,aAAa,EAAhC,MAAM,KAAK,CAAC;IACO,cAAc,EAAjC,MAAM,KAAK,CAAC;IACQ,aAAa;IACb,cAAc;IACgB,kBAAkB,eAAzD,OAAO,KAAK,CAAC,KAAK,OAAO,KAAK,CAAC;IACS,mBAAmB,gBAA1D,OAAO,KAAK,CAAC,KAAK,OAAO,KAAK,CAAC;IACa,uBAAuB,qBAA9D,OAAO,KAAK,CAAC,KAAK,OAAO,KAAK,CAAC;IACS,wBAAwB,sBAA/D,OAAO,KAAK,CAAC,KAAK,OAAO,KAAK,CAAC;4BA6N3D;uBAtQyB,OAAO,qBAAqB,EAAE,KAAK,CAAC,CAAC,CAAC"}
+{"version":3,"file":"priceAuthorityTransform.d.ts","sourceRoot":"","sources":["priceAuthorityTransform.js"],"names":[],"mappings":"AAoBO,sCARI,KAAK,CAAC,KAAK,CAAC,YACZ,MAAM,CAAC,KAAK,CAAC,aACb,MAAM,CAAC,KAAK,CAAC,SACb,OAAO,cAAc,EAAE,YAAY,aACnC,OAAO,cAAc,EAAE,eAAe,6FAqBhD;AAeM;;;mBATI,KAAK,CAAC,KAAK,CAAC;oBACZ,KAAK,CAAC,KAAK,CAAC;;;qCAGD,MAAM,CAAC,KAAK,CAAC,KAAK,MAAM,CAAC,KAAK,CAAC;uCAC9B,MAAM,CAAC,KAAK,CAAC,KAAK,MAAM,CAAC,KAAK,CAAC;gDAC1B,MAAM,CAAC,KAAK,CAAC,KAAK,MAAM,CAAC,KAAK,CAAC;kDAC9B,MAAM,CAAC,KAAK,CAAC,KAAK,MAAM,CAAC,KAAK,CAAC;4BA4N3D;sCAtQ6E,4BAA4B;gCAA5B,4BAA4B;oCAA5B,4BAA4B"}

package/src/contractSupport/priceAuthorityTransform.js

@@ -4,15 +4,18 @@ import { Fail, assert } from '@agoric/assert';
 import { AmountMath } from '@agoric/ertp';
 import { makeNotifier } from '@agoric/notifier';
 
-/** @template T @typedef {import('@endo/eventual-send').EOnly<T>} EOnly */
+/**
+ * @import {EOnly} from '@endo/eventual-send';
+ * @import {MutableQuote, PriceAuthority, PriceQuote, PriceDescription,} from '@agoric/zoe/tools/types.js';
+ */
 
 /**
  * @param {Brand<'set'>} quoteBrand
  * @param {Amount<'nat'>} amountIn
  * @param {Amount<'nat'>} amountOut
- * @param {ERef<import('@agoric/time/src/types').TimerService>} timer
- * @param {import('@agoric/time').Timestamp} timestamp
- * @param {ERef<Mint<'set'>>} quoteMint
+ * @param {import('@agoric/time').TimerService} timer
+ * @param {import('@agoric/time').TimestampRecord} timestamp
+ * @param {ERef<Mint<'set', PriceDescription>>} quoteMint
  * @returns {Promise<PriceQuote>}
  */
 export const mintQuote = async (
@@ -36,7 +39,7 @@ export const mintQuote = async (
 
 /**
  * @param {object} opts
- * @param {ERef<Mint<'set'>>} opts.quoteMint
+ * @param {ERef<Mint<'set', PriceDescription>>} opts.quoteMint
  * @param {ERef<PriceAuthority>} opts.sourcePriceAuthority
  * @param {Brand<'nat'>} opts.sourceBrandIn
  * @param {Brand<'nat'>} opts.sourceBrandOut
@@ -87,9 +90,8 @@ export const makePriceAuthorityTransform = async ({
       sourceBrandOut,
     );
 
-    const { value: sourceQuoteValue } = await E(sourceQuoteIssuer).getAmountOf(
-      sourceQuotePayment,
-    );
+    const { value: sourceQuoteValue } =
+      await E(sourceQuoteIssuer).getAmountOf(sourceQuotePayment);
 
     sourceQuoteValue.length === 1 ||
       Fail`sourceQuoteValue.length ${sourceQuoteValue.length} is not 1`;

package/src/contractSupport/priceQuote.d.ts

@@ -1,7 +1,9 @@
 export function getPriceDescription(quote: PriceQuote): PriceDescription;
-export function getAmountIn(quote: PriceQuote): Amount<"nat">;
-export function getAmountOut(quote: PriceQuote): Amount<"nat">;
-/** @type {(quote: PriceQuote) => import('@agoric/time/src/types').Timestamp} */
-export const getTimestamp: (quote: PriceQuote) => import('@agoric/time/src/types').Timestamp;
-export function unitAmount(brand: Brand<'nat'>): Promise<Amount<"nat">>;
+export function getAmountIn(quote: PriceQuote): import("@agoric/ertp/src/types.js").NatAmount;
+export function getAmountOut(quote: PriceQuote): import("@agoric/ertp/src/types.js").NatAmount;
+/** @type {(quote: PriceQuote) => import('@agoric/time').Timestamp} */
+export const getTimestamp: (quote: PriceQuote) => import("@agoric/time").Timestamp;
+export function unitAmount(brand: Brand<"nat">): Promise<import("@agoric/ertp/src/types.js").NatAmount>;
+import type { PriceQuote } from '@agoric/zoe/tools/types.js';
+import type { PriceDescription } from '@agoric/zoe/tools/types.js';
 //# sourceMappingURL=priceQuote.d.ts.map

package/src/contractSupport/priceQuote.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"priceQuote.d.ts","sourceRoot":"","sources":["priceQuote.js"],"names":[],"mappings":"AAiBO,2CAHI,UAAU,GACR,gBAAgB,CAM5B;AAGM,mCADK,UAAU,iBACiD;AAEhE,oCADK,UAAU,iBACmD;AACzE,gFAAgF;AAChF,mCADmB,UAAU,KAAK,OAAO,wBAAwB,EAAE,SAAS,CACF;AAGnE,kCADK,MAAM,KAAK,CAAC,0BAMvB"}
+{"version":3,"file":"priceQuote.d.ts","sourceRoot":"","sources":["priceQuote.js"],"names":[],"mappings":"AAqBO,yEAIN;AAGM,8FAAgE;AAEhE,+FAAkE;AACzE,sEAAsE;AACtE,kDADkC,OAAO,cAAc,EAAE,SAAS,CACQ;AAGnE,kCADK,KAAK,CAAC,KAAK,CAAC,0DAMvB;gCAjC4F,4BAA4B;sCAA5B,4BAA4B"}

package/src/contractSupport/priceQuote.js

@@ -4,6 +4,10 @@ import { AmountMath } from '@agoric/ertp';
 import { Nat } from '@endo/nat';
 import { E } from '@endo/eventual-send';
 
+/**
+ * @import {PriceAuthority, PriceDescription, PriceQuote, PriceQuoteValue, PriceQuery,} from '@agoric/zoe/tools/types.js';
+ */
+
 const { Fail } = assert;
 
 // PriceAuthorities return quotes as a pair of an amount and a payment, both
@@ -25,7 +29,7 @@ export const getPriceDescription = quote => {
 export const getAmountIn = quote => getPriceDescription(quote).amountIn;
 /** @param {PriceQuote} quote */
 export const getAmountOut = quote => getPriceDescription(quote).amountOut;
-/** @type {(quote: PriceQuote) => import('@agoric/time/src/types').Timestamp} */
+/** @type {(quote: PriceQuote) => import('@agoric/time').Timestamp} */
 export const getTimestamp = quote => getPriceDescription(quote).timestamp;
 
 /** @param {Brand<'nat'>} brand */

package/src/contractSupport/ratio.d.ts

@@ -1,5 +1,5 @@
 export function assertIsRatio(ratio: any): void;
-export function makeRatio(numerator: bigint, numeratorBrand: Brand, denominator?: bigint | undefined, denominatorBrand?: Brand<AssetKind> | undefined): Ratio;
+export function makeRatio(numerator: bigint, numeratorBrand: Brand, denominator?: bigint | undefined, denominatorBrand?: globalThis.Brand | undefined): Ratio;
 export function makeRatioFromAmounts(numeratorAmount: Amount, denominatorAmount: Amount): Ratio;
 /** @type {ScaleAmount} */
 export const floorMultiplyBy: ScaleAmount;
@@ -21,7 +21,7 @@ export function oneMinus(ratio: Ratio): Ratio;
 export function ratioGTE(left: Ratio, right: Ratio): boolean;
 export function ratiosSame(left: Ratio, right: Ratio): boolean;
 export function quantize(ratio: Ratio, newDen: bigint): Ratio;
-export function parseRatio(numeric: ParsableNumber, numeratorBrand: Brand, denominatorBrand?: Brand<AssetKind> | undefined): Ratio;
+export function parseRatio(numeric: ParsableNumber, numeratorBrand: Brand, denominatorBrand?: globalThis.Brand | undefined): Ratio;
 export function assertParsableNumber(specimen: unknown): asserts specimen is ParsableNumber;
 export function ratioToNumber(ratio: Ratio): number;
 export type ParsableNumber = bigint | number | string;

package/src/contractSupport/ratio.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ratio.d.ts","sourceRoot":"","sources":["ratio.js"],"names":[],"mappings":"AAwCO,gDAcN;AASM,qCANI,MAAM,kBACN,KAAK,sFAGH,KAAK,CAgBjB;AAOM,sDAJI,MAAM,qBACN,MAAM,GACJ,KAAK,CAYjB;AAwBD,0BAA0B;AAC1B,8BADW,WAAW,CAGpB;AAEF,0BAA0B;AAC1B,6BADW,WAAW,CAGpB;AAEF,0BAA0B;AAC1B,yBADW,WAAW,CAGpB;AAwBF,0BAA0B;AAC1B,4BADW,WAAW,CAGpB;AAEF,0BAA0B;AAC1B,2BADW,WAAW,CAGpB;AAEF,0BAA0B;AAC1B,uBADW,WAAW,CAGpB;AAMK,mCAHI,KAAK,GACH,KAAK,CAWjB;AAOM,gCAJI,KAAK,SACL,KAAK,GACH,KAAK,CAwBjB;AAOM,qCAJI,KAAK,SACL,KAAK,GACH,KAAK,CAmBjB;AAOM,qCAJI,KAAK,SACL,KAAK,GACH,KAAK,CA8BjB;AAQM,gCAHI,KAAK,GACH,KAAK,CAcjB;AAOM,+BAJI,KAAK,SACL,KAAK,GACH,OAAO,CAkBnB;AASM,iCAJI,KAAK,SACL,KAAK,GACH,OAAO,CAOnB;AASM,gCAJI,KAAK,UACL,MAAM,GACJ,KAAK,CAajB;AAaM,oCALI,cAAc,kBACd,KAAK,oDAEH,KAAK,CAmBjB;AAOM,+CAHI,OAAO,sCAMjB;AAQM,qCAHI,KAAK,GACH,MAAM,CAMlB;6BAjDa,MAAM,GAAG,MAAM,GAAG,MAAM"}
+{"version":3,"file":"ratio.d.ts","sourceRoot":"","sources":["ratio.js"],"names":[],"mappings":"AAwCO,gDAcN;AASM,qCANI,MAAM,kBACN,KAAK,sFAGH,KAAK,CAejB;AAOM,sDAJI,MAAM,qBACN,MAAM,GACJ,KAAK,CAYjB;AA2BD,0BAA0B;AAC1B,8BADW,WAAW,CAGpB;AAEF,0BAA0B;AAC1B,6BADW,WAAW,CAGpB;AAEF,0BAA0B;AAC1B,yBADW,WAAW,CAGpB;AA2BF,0BAA0B;AAC1B,4BADW,WAAW,CAGpB;AAEF,0BAA0B;AAC1B,2BADW,WAAW,CAGpB;AAEF,0BAA0B;AAC1B,uBADW,WAAW,CAGpB;AAMK,mCAHI,KAAK,GACH,KAAK,CAWjB;AAOM,gCAJI,KAAK,SACL,KAAK,GACH,KAAK,CAwBjB;AAOM,qCAJI,KAAK,SACL,KAAK,GACH,KAAK,CAmBjB;AAOM,qCAJI,KAAK,SACL,KAAK,GACH,KAAK,CA8BjB;AAQM,gCAHI,KAAK,GACH,KAAK,CAcjB;AAOM,+BAJI,KAAK,SACL,KAAK,GACH,OAAO,CAkBnB;AASM,iCAJI,KAAK,SACL,KAAK,GACH,OAAO,CAOnB;AASM,gCAJI,KAAK,UACL,MAAM,GACJ,KAAK,CAajB;AAaM,oCALI,cAAc,kBACd,KAAK,oDAEH,KAAK,CAmBjB;AAMM,+CAHI,OAAO,GACL,OAAO,CAAC,QAAQ,IAAI,cAAc,CAK9C;AAQM,qCAHI,KAAK,GACH,MAAM,CAMlB;6BAhDa,MAAM,GAAG,MAAM,GAAG,MAAM"}

package/src/contractSupport/ratio.js

@@ -1,4 +1,4 @@
-import './types.js';
+/// <reference path="./types-ambient.js" />
 import { q, Fail } from '@agoric/assert';
 import { AmountMath } from '@agoric/ertp';
 import { assertRecord } from '@endo/marshal';
@@ -70,7 +70,6 @@ export const makeRatio = (
   denominator > 0n ||
     Fail`No infinite ratios! Denominator was 0 ${q(denominatorBrand)}`;
 
-  // @ts-expect-error cast to return type because make() ensures
   return harden({
     numerator: AmountMath.make(numeratorBrand, numerator),
     denominator: AmountMath.make(denominatorBrand, denominator),
@@ -98,6 +97,7 @@ export const makeRatioFromAmounts = (numeratorAmount, denominatorAmount) => {
  * @param {Amount<'nat'>} amount
  * @param {Ratio} ratio
  * @param {*} divideOp
+ * @returns {Amount<'nat'>}
  */
 const multiplyHelper = (amount, ratio, divideOp) => {
   AmountMath.coerce(amount.brand, amount);
@@ -107,12 +107,14 @@ const multiplyHelper = (amount, ratio, divideOp) => {
       ratio.denominator.brand,
     )}`;
 
-  return AmountMath.make(
-    ratio.numerator.brand,
-    divideOp(
-      multiply(amount.value, ratio.numerator.value),
-      ratio.denominator.value,
-    ),
+  return /** @type {Amount<'nat'>} */ (
+    AmountMath.make(
+      ratio.numerator.brand,
+      divideOp(
+        multiply(amount.value, ratio.numerator.value),
+        ratio.denominator.value,
+      ),
+    )
   );
 };
 
@@ -135,6 +137,7 @@ export const multiplyBy = (amount, ratio) => {
  * @param {Amount<'nat'>} amount
  * @param {Ratio} ratio
  * @param {*} divideOp
+ * @returns {Amount<'nat'>}
  */
 const divideHelper = (amount, ratio, divideOp) => {
   AmountMath.coerce(amount.brand, amount);
@@ -144,12 +147,14 @@ const divideHelper = (amount, ratio, divideOp) => {
       ratio.numerator.brand,
     )}`;
 
-  return AmountMath.make(
-    ratio.denominator.brand,
-    divideOp(
-      multiply(amount.value, ratio.denominator.value),
-      ratio.numerator.value,
-    ),
+  return /** @type {Amount<'nat'>} */ (
+    AmountMath.make(
+      ratio.denominator.brand,
+      divideOp(
+        multiply(amount.value, ratio.denominator.value),
+        ratio.numerator.value,
+      ),
+    )
   );
 };
 
@@ -378,7 +383,6 @@ export const parseRatio = (
   );
 };
 
-// eslint-disable-next-line jsdoc/require-returns-check
 /**
  * @param {unknown} specimen
  * @returns {asserts specimen is ParsableNumber}