@agoric/inter-protocol 0.16.1 → 0.16.2-calypso-dev-84eb287.0

package/src/auction/sortedOffers.js

@@ -13,12 +13,13 @@ const { Fail } = assert;
 
 /**
  * @file we use a floating point representation of the price or rate as the
- * first part of the key in the store. The second part is the sequence number of
- * the bid, but it doesn't matter for sorting. When we retrieve multiple bids,
- * it's only by bid value, so we don't care how the sequence numbers sort.
+ *   first part of the key in the store. The second part is the sequence number
+ *   of the bid, but it doesn't matter for sorting. When we retrieve multiple
+ *   bids, it's only by bid value, so we don't care how the sequence numbers
+ *   sort.
  *
- * We take advantage of the fact that encodeData takes a passable and turns it
- * into a sort key. Arrays of passable data sort like composite keys.
+ *   We take advantage of the fact that encodeData takes a passable and turns it
+ *   into a sort key. Arrays of passable data sort like composite keys.
  */
 
 /**
@@ -39,7 +40,7 @@ export const toPartialOfferKey = offerPrice => {
  * @param {Ratio} offerPrice IST/collateral
  * @param {bigint} sequenceNumber
  * @returns {string} lexically sortable string in which highest price is first,
- *    ties will be broken by sequenceNumber of offer
+ *   ties will be broken by sequenceNumber of offer
  */
 export const toPriceOfferKey = (offerPrice, sequenceNumber) => {
   mustMatch(offerPrice, RatioShape);
@@ -87,6 +88,7 @@ const bidScalingRatioFromKey = (bidScaleFloat, numBrand, useDecimals) => {
  * @returns {[normalizedPrice: Ratio, sequenceNumber: bigint]}
  */
 export const fromPriceOfferKey = (key, numBrand, denomBrand, useDecimals) => {
+  // @ts-expect-error XXX
   const [pricePart, sequenceNumberPart] = decodeData(key);
   return [
     priceRatioFromFloat(pricePart, numBrand, denomBrand, useDecimals),
@@ -107,7 +109,7 @@ export const toBidScalingComparator = rate => {
  * @param {Ratio} rate discount/markup rate expressed as a ratio IST/IST
  * @param {bigint} sequenceNumber
  * @returns {string} lexically sortable string in which highest price is first,
- *    ties will be broken by sequenceNumber of offer
+ *   ties will be broken by sequenceNumber of offer
  */
 export const toScaledRateOfferKey = (rate, sequenceNumber) => {
   mustMatch(rate, RatioShape);

package/src/auction/util.d.ts

@@ -0,0 +1,32 @@
+/** @import {PriceAuthority, PriceDescription, PriceQuote, PriceQuoteValue, PriceQuery,} from '@agoric/zoe/tools/types.js'; */
+/**
+ * Constants for Auction State.
+ *
+ * @type {{ ACTIVE: 'active'; WAITING: 'waiting' }}
+ */
+export const AuctionState: {
+    ACTIVE: "active";
+    WAITING: "waiting";
+};
+export function makeBrandedRatioPattern(numeratorAmountShape: {
+    brand: Brand;
+    value: Pattern;
+}, denominatorAmountShape: {
+    brand: Brand;
+    value: Pattern;
+}): {
+    numerator: {
+        brand: Brand;
+        value: Pattern;
+    };
+    denominator: {
+        brand: Brand;
+        value: Pattern;
+    };
+};
+export function isScaledBidPriceHigher(bidScaling: Ratio, currentPrice: Ratio, oraclePrice: Ratio): boolean;
+/** @type {(quote: PriceQuote) => Ratio} */
+export const priceFrom: (quote: PriceQuote) => Ratio;
+export function makeCancelTokenMaker(name: any): () => import("@endo/marshal").RemotableObject<`Alleged: ${string}`> & import("@endo/eventual-send").RemotableBrand<{}, {}>;
+import type { PriceQuote } from '@agoric/zoe/tools/types.js';
+//# sourceMappingURL=util.d.ts.map

package/src/auction/util.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"util.d.ts","sourceRoot":"","sources":["util.js"],"names":[],"mappings":"AASA,8HAA8H;AAE9H;;;;GAIG;AACH,2BAFU;IAAE,MAAM,EAAE,QAAQ,CAAC;IAAC,OAAO,EAAE,SAAS,CAAA;CAAE,CAKhD;AAMK,8DAHI;IAAE,KAAK,EAAE,KAAK,CAAC;IAAC,KAAK,EAAE,OAAO,CAAA;CAAE,0BAChC;IAAE,KAAK,EAAE,KAAK,CAAC;IAAC,KAAK,EAAE,OAAO,CAAA;CAAE;;eADvB,KAAK;eAAS,OAAO;;;eACrB,KAAK;eAAS,OAAO;;EAUxC;AASM,mDANI,KAAK,gBACL,KAAK,eACL,KAAK,GACH,OAAO,CAI6C;AAEjE,2CAA2C;AAC3C,wBADW,CAAC,KAAK,EAAE,UAAU,KAAK,KAAK,CAKnC;AAEG,4KAIN;gCA/C6F,4BAA4B"}

package/src/auction/util.js

@@ -7,10 +7,12 @@ import {
 } from '@agoric/zoe/src/contractSupport/index.js';
 import { Far } from '@endo/marshal';
 
+/** @import {PriceAuthority, PriceDescription, PriceQuote, PriceQuoteValue, PriceQuery,} from '@agoric/zoe/tools/types.js'; */
+
 /**
  * Constants for Auction State.
  *
- * @type {{ ACTIVE: 'active', WAITING: 'waiting' }}
+ * @type {{ ACTIVE: 'active'; WAITING: 'waiting' }}
  */
 export const AuctionState = {
   ACTIVE: 'active',
@@ -18,8 +20,8 @@ export const AuctionState = {
 };
 
 /**
- * @param {{ brand: Brand, value: Pattern }} numeratorAmountShape
- * @param {{ brand: Brand, value: Pattern }} denominatorAmountShape
+ * @param {{ brand: Brand; value: Pattern }} numeratorAmountShape
+ * @param {{ brand: Brand; value: Pattern }} denominatorAmountShape
  */
 export const makeBrandedRatioPattern = (
   numeratorAmountShape,
@@ -36,7 +38,7 @@ export const makeBrandedRatioPattern = (
  * @param {Ratio} currentPrice
  * @param {Ratio} oraclePrice
  * @returns {boolean} TRUE iff the discount(/markup) applied to the price is
- *          higher than the quote.
+ *   higher than the quote.
  */
 export const isScaledBidPriceHigher = (bidScaling, currentPrice, oraclePrice) =>
   ratioGTE(multiplyRatios(oraclePrice, bidScaling), currentPrice);

package/src/clientSupport.d.ts

@@ -0,0 +1,167 @@
+export function lookupOfferIdForVault(vaultId: string, currentP: Promise<import("@agoric/smart-wallet/src/smartWallet.js").CurrentWalletRecord>): Promise<string>;
+export function makeParseAmount(agoricNames: Pick<import("@agoric/vats/tools/board-utils.js").AgoricNamesRemotes, "brand" | "vbankAsset">, makeError?: (msg: string) => Error): (a: string) => Amount<"nat">;
+export namespace Offers {
+    namespace auction {
+        export { makeBidOffer as Bid };
+    }
+    namespace fluxAggregator {
+        export { makePushPriceOffer as PushPrice };
+    }
+    namespace psm {
+        export { makePsmSwapOffer as swap };
+    }
+    namespace vaults {
+        export { makeOpenOffer as OpenVault };
+        export { makeAdjustOffer as AdjustBalances };
+        export { makeCloseOffer as CloseVault };
+    }
+    namespace reserve {
+        export { makeAddCollateralOffer as AddCollateral };
+    }
+}
+/**
+ * @param {Pick<
+ *   import('@agoric/vats/tools/board-utils.js').AgoricNamesRemotes,
+ *   'brand' | 'vbankAsset'
+ * >} agoricNames
+ * @param {{
+ *   offerId: string;
+ *   give: string;
+ *   maxBuy: string;
+ *   wantMinimum?: string;
+ * } & (
+ *   | {
+ *       price: number;
+ *     }
+ *   | {
+ *       discount: number; // -1 to 1. e.g. 0.10 for 10% discount, -0.05 for 5% markup
+ *     }
+ * )} opts
+ * @returns {import('@agoric/smart-wallet/src/offers.js').OfferSpec}
+ */
+declare function makeBidOffer(agoricNames: Pick<import("@agoric/vats/tools/board-utils.js").AgoricNamesRemotes, "brand" | "vbankAsset">, opts: {
+    offerId: string;
+    give: string;
+    maxBuy: string;
+    wantMinimum?: string;
+} & ({
+    price: number;
+} | {
+    discount: number;
+})): import("@agoric/smart-wallet/src/offers.js").OfferSpec;
+/**
+ * @param {unknown} _agoricNames
+ * @param {{
+ *   offerId: string;
+ *   roundId?: bigint;
+ *   unitPrice: bigint;
+ * }} opts
+ * @param {string} previousOffer
+ * @returns {import('@agoric/smart-wallet/src/offers.js').OfferSpec}
+ */
+declare function makePushPriceOffer(_agoricNames: unknown, opts: {
+    offerId: string;
+    roundId?: bigint;
+    unitPrice: bigint;
+}, previousOffer: string): import("@agoric/smart-wallet/src/offers.js").OfferSpec;
+/**
+ * @param {Pick<
+ *   import('@agoric/vats/tools/board-utils.js').AgoricNamesRemotes,
+ *   'brand'
+ * >} agoricNames
+ * @param {Instance} instance
+ * @param {{ offerId: string; feePct?: number; pair: [string, string] } & (
+ *   | { wantMinted: number }
+ *   | { giveMinted: number }
+ * )} opts
+ * @returns {import('@agoric/smart-wallet/src/offers.js').OfferSpec}
+ */
+declare function makePsmSwapOffer({ brand }: Pick<import("@agoric/vats/tools/board-utils.js").AgoricNamesRemotes, "brand">, instance: Instance, opts: {
+    offerId: string;
+    feePct?: number;
+    pair: [string, string];
+} & ({
+    wantMinted: number;
+} | {
+    giveMinted: number;
+})): import("@agoric/smart-wallet/src/offers.js").OfferSpec;
+/**
+ * @param {Pick<
+ *   import('@agoric/vats/tools/board-utils.js').AgoricNamesRemotes,
+ *   'brand'
+ * >} agoricNames
+ * @param {{
+ *   offerId: string;
+ *   wantMinted: number;
+ *   giveCollateral: number;
+ *   collateralBrandKey: string;
+ * }} opts
+ * @returns {import('@agoric/smart-wallet/src/offers.js').OfferSpec}
+ */
+declare function makeOpenOffer({ brand }: Pick<import("@agoric/vats/tools/board-utils.js").AgoricNamesRemotes, "brand">, opts: {
+    offerId: string;
+    wantMinted: number;
+    giveCollateral: number;
+    collateralBrandKey: string;
+}): import("@agoric/smart-wallet/src/offers.js").OfferSpec;
+/**
+ * @param {Pick<
+ *   import('@agoric/vats/tools/board-utils.js').AgoricNamesRemotes,
+ *   'brand'
+ * >} agoricNames
+ * @param {{
+ *   offerId: string;
+ *   collateralBrandKey?: string;
+ *   giveCollateral?: number;
+ *   wantCollateral?: number;
+ *   giveMinted?: number;
+ *   wantMinted?: number;
+ * }} opts
+ * @param {string} previousOffer
+ * @returns {import('@agoric/smart-wallet/src/offers.js').OfferSpec}
+ */
+declare function makeAdjustOffer({ brand }: Pick<import("@agoric/vats/tools/board-utils.js").AgoricNamesRemotes, "brand">, opts: {
+    offerId: string;
+    collateralBrandKey?: string;
+    giveCollateral?: number;
+    wantCollateral?: number;
+    giveMinted?: number;
+    wantMinted?: number;
+}, previousOffer: string): import("@agoric/smart-wallet/src/offers.js").OfferSpec;
+/**
+ * @param {Pick<
+ *   import('@agoric/vats/tools/board-utils.js').AgoricNamesRemotes,
+ *   'brand'
+ * >} agoricNames
+ * @param {{
+ *   offerId: string;
+ *   collateralBrandKey?: string;
+ *   giveMinted: number;
+ * }} opts
+ * @param {string} previousOffer
+ * @returns {import('@agoric/smart-wallet/src/offers.js').OfferSpec}
+ */
+declare function makeCloseOffer({ brand }: Pick<import("@agoric/vats/tools/board-utils.js").AgoricNamesRemotes, "brand">, opts: {
+    offerId: string;
+    collateralBrandKey?: string;
+    giveMinted: number;
+}, previousOffer: string): import("@agoric/smart-wallet/src/offers.js").OfferSpec;
+/**
+ * @param {Pick<
+ *   import('@agoric/vats/tools/board-utils.js').AgoricNamesRemotes,
+ *   'brand'
+ * >} agoricNames
+ * @param {{
+ *   offerId: string;
+ *   give: number;
+ *   collateralBrandKey: string;
+ * }} opts
+ * @returns {import('@agoric/smart-wallet/src/offers.js').OfferSpec}
+ */
+declare function makeAddCollateralOffer({ brand }: Pick<import("@agoric/vats/tools/board-utils.js").AgoricNamesRemotes, "brand">, opts: {
+    offerId: string;
+    give: number;
+    collateralBrandKey: string;
+}): import("@agoric/smart-wallet/src/offers.js").OfferSpec;
+export {};
+//# sourceMappingURL=clientSupport.d.ts.map

package/src/clientSupport.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"clientSupport.d.ts","sourceRoot":"","sources":["clientSupport.js"],"names":[],"mappings":"AAsKO,+CANI,MAAM,YACN,OAAO,CACjB,OAAW,yCAAyC,EAAE,mBAAmB,CACtE,GACS,OAAO,CAAC,MAAM,CAAC,CAW3B;AAmFM,6CAPI,IAAI,CACd,OAAW,mCAAmC,EAAE,kBAAkB,EAClE,OAAW,GAAG,YAAY,CACvB,cACO,CAAC,GAAG,EAAE,MAAM,KAAK,KAAK,GACpB,CAAC,CAAC,EAAE,MAAM,KAAK,MAAM,CAAC,KAAK,CAAC,CAmCtC;;;;;;;;;;;;;;;;;;;;AAEH;;;;;;;;;;;;;;;;;;;GAmBG;AACH,2CAnBW,IAAI,CACd,OAAW,mCAAmC,EAAE,kBAAkB,EAClE,OAAW,GAAG,YAAY,CACvB,QACO;IACV,OAAW,EAAE,MAAM,CAAC;IACpB,IAAQ,EAAE,MAAM,CAAC;IACjB,MAAU,EAAE,MAAM,CAAC;IACnB,WAAe,CAAC,EAAE,MAAM,CAAC;CACtB,GAAG,CACA;IACN,KAAa,EAAE,MAAM,CAAC;CACf,GACD;IACN,QAAgB,EAAE,MAAM,CAAC;CAClB,CACJ,GACS,OAAO,oCAAoC,EAAE,SAAS,CAuDlE;AAqCD;;;;;;;;;GASG;AACH,kDATW,OAAO,QACP;IACV,OAAW,EAAE,MAAM,CAAC;IACpB,OAAW,CAAC,EAAE,MAAM,CAAC;IACrB,SAAa,EAAE,MAAM,CAAC;CACnB,iBACO,MAAM,GACJ,OAAO,oCAAoC,EAAE,SAAS,CAelE;AAxND;;;;;;;;;;;GAWG;AACH,6CAXW,IAAI,CACd,OAAW,mCAAmC,EAAE,kBAAkB,EAClE,OAAW,CACR,YACO,QAAQ,QACR;IAAE,OAAO,EAAE,MAAM,CAAC;IAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;CAAE,GAAG,CACnE;IAAE,UAAU,EAAE,MAAM,CAAA;CAAE,GACtB;IAAE,UAAU,EAAE,MAAM,CAAA;CAAE,CACzB,GACS,OAAO,oCAAoC,EAAE,SAAS,CA4BlE;AAzLD;;;;;;;;;;;;GAYG;AACH,0CAZW,IAAI,CACd,OAAW,mCAAmC,EAAE,kBAAkB,EAClE,OAAW,CACR,QACO;IACV,OAAW,EAAE,MAAM,CAAC;IACpB,UAAc,EAAE,MAAM,CAAC;IACvB,cAAkB,EAAE,MAAM,CAAC;IAC3B,kBAAsB,EAAE,MAAM,CAAC;CAC5B,GACS,OAAO,oCAAoC,EAAE,SAAS,CAuBlE;AAED;;;;;;;;;;;;;;;GAeG;AACH,4CAfW,IAAI,CACd,OAAW,mCAAmC,EAAE,kBAAkB,EAClE,OAAW,CACR,QACO;IACV,OAAW,EAAE,MAAM,CAAC;IACpB,kBAAsB,CAAC,EAAE,MAAM,CAAC;IAChC,cAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,cAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,UAAc,CAAC,EAAE,MAAM,CAAC;IACxB,UAAc,CAAC,EAAE,MAAM,CAAC;CACrB,iBACO,MAAM,GACJ,OAAO,oCAAoC,EAAE,SAAS,CAiBlE;AAED;;;;;;;;;;;;GAYG;AACH,2CAZW,IAAI,CACd,OAAW,mCAAmC,EAAE,kBAAkB,EAClE,OAAW,CACR,QACO;IACV,OAAW,EAAE,MAAM,CAAC;IACpB,kBAAsB,CAAC,EAAE,MAAM,CAAC;IAChC,UAAc,EAAE,MAAM,CAAC;CACpB,iBACO,MAAM,GACJ,OAAO,oCAAoC,EAAE,SAAS,CAclE;AAmND;;;;;;;;;;;GAWG;AACH,mDAXW,IAAI,CACd,OAAW,mCAAmC,EAAE,kBAAkB,EAClE,OAAW,CACR,QACO;IACV,OAAW,EAAE,MAAM,CAAC;IACpB,IAAQ,EAAE,MAAM,CAAC;IACjB,kBAAsB,EAAE,MAAM,CAAC;CAC5B,GACS,OAAO,oCAAoC,EAAE,SAAS,CAuBlE"}