@agoric/inter-protocol 0.16.2-dev-b05c226.0 → 0.16.2-dev-6bce049.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@agoric/inter-protocol",
-  "version": "0.16.2-dev-b05c226.0+b05c226",
+  "version": "0.16.2-dev-6bce049.0+6bce049",
   "description": "Core cryptoeconomy contracts",
   "type": "module",
   "main": "src/index.js",
@@ -30,29 +30,28 @@
   },
   "homepage": "https://github.com/Agoric/agoric-sdk#readme",
   "dependencies": {
-    "@agoric/assert": "0.6.1-dev-b05c226.0+b05c226",
-    "@agoric/ertp": "0.16.3-dev-b05c226.0+b05c226",
-    "@agoric/governance": "0.10.4-dev-b05c226.0+b05c226",
-    "@agoric/internal": "0.3.3-dev-b05c226.0+b05c226",
-    "@agoric/notifier": "0.6.3-dev-b05c226.0+b05c226",
-    "@agoric/store": "0.9.3-dev-b05c226.0+b05c226",
-    "@agoric/time": "0.3.3-dev-b05c226.0+b05c226",
-    "@agoric/vat-data": "0.5.3-dev-b05c226.0+b05c226",
-    "@agoric/vats": "0.15.2-dev-b05c226.0+b05c226",
-    "@agoric/zoe": "0.26.3-dev-b05c226.0+b05c226",
+    "@agoric/assert": "0.6.1-dev-6bce049.0+6bce049",
+    "@agoric/ertp": "0.16.3-dev-6bce049.0+6bce049",
+    "@agoric/governance": "0.10.4-dev-6bce049.0+6bce049",
+    "@agoric/internal": "0.3.3-dev-6bce049.0+6bce049",
+    "@agoric/notifier": "0.6.3-dev-6bce049.0+6bce049",
+    "@agoric/store": "0.9.3-dev-6bce049.0+6bce049",
+    "@agoric/time": "0.3.3-dev-6bce049.0+6bce049",
+    "@agoric/vat-data": "0.5.3-dev-6bce049.0+6bce049",
+    "@agoric/vats": "0.15.2-dev-6bce049.0+6bce049",
+    "@agoric/zoe": "0.26.3-dev-6bce049.0+6bce049",
     "@endo/captp": "^3.1.1",
     "@endo/eventual-send": "^0.17.2",
     "@endo/far": "^0.2.18",
     "@endo/marshal": "^0.8.5",
     "@endo/nat": "^4.1.27",
-    "agoric": "0.21.2-dev-b05c226.0+b05c226",
     "jessie.js": "^0.3.2"
   },
   "devDependencies": {
-    "@agoric/deploy-script-support": "0.10.4-dev-b05c226.0+b05c226",
-    "@agoric/smart-wallet": "0.5.4-dev-b05c226.0+b05c226",
-    "@agoric/swingset-liveslots": "0.10.3-dev-b05c226.0+b05c226",
-    "@agoric/swingset-vat": "0.32.3-dev-b05c226.0+b05c226",
+    "@agoric/deploy-script-support": "0.10.4-dev-6bce049.0+6bce049",
+    "@agoric/smart-wallet": "0.5.4-dev-6bce049.0+6bce049",
+    "@agoric/swingset-liveslots": "0.10.3-dev-6bce049.0+6bce049",
+    "@agoric/swingset-vat": "0.32.3-dev-6bce049.0+6bce049",
     "@endo/bundle-source": "^2.5.1",
     "@endo/init": "^0.5.56",
     "@endo/promise-kit": "^0.2.56",
@@ -73,12 +72,11 @@
     "files": [
       "test/**/test-*.js"
     ],
-    "concurrency": 2,
     "workerThreads": false,
     "timeout": "10m"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "b05c226c053703540fb51df1e274ac6cf5e00b50"
+  "gitHead": "6bce049552bcc46666a9f2eb4afac8a017b5f3d4"
 }

package/src/clientSupport.js

@@ -9,29 +9,31 @@ import { parseRatio } from '@agoric/zoe/src/contractSupport/ratio.js';
 const COSMOS_UNIT = 1_000_000n;
 const scaleDecimals = num => BigInt(num * Number(COSMOS_UNIT));
 
+// TODO use '@satisfies" in TS 5.1 to make sure these each conform to OfferMaker interface
+
 // NB: not really a Proposal because the brands are not remotes
 // Instead they're copyRecord like  "{"boardId":"board0257","iface":"Alleged: IST brand"}" to pass through the boardId
 // mustMatch(harden(proposal), ProposalShape);
 /**
  * Give/want
  *
- * @param {Record<string, Brand>} brands
+ * @param {Pick<import('@agoric/vats/tools/board-utils.js').AgoricNamesRemotes, 'brand'>} agoricNames
  * @param {{ giveMinted?: number, wantMinted?: number } | { collateralBrandKey: string, giveCollateral?: number, wantCollateral?: number }} opts
  * @returns {Proposal}
  */
-const makeVaultProposal = (brands, opts) => {
+const makeVaultProposal = ({ brand }, opts) => {
   const proposal = { give: {}, want: {} };
 
   if ('giveCollateral' in opts && opts.giveCollateral) {
     const { collateralBrandKey } = opts;
     proposal.give.Collateral = {
-      brand: brands[collateralBrandKey],
+      brand: brand[collateralBrandKey],
       value: scaleDecimals(opts.giveCollateral),
     };
   }
   if ('giveMinted' in opts && opts.giveMinted) {
     proposal.give.Minted = {
-      brand: brands.IST,
+      brand: brand.IST,
       value: scaleDecimals(opts.giveMinted),
     };
   }
@@ -39,13 +41,13 @@ const makeVaultProposal = (brands, opts) => {
   if ('wantCollateral' in opts && opts.wantCollateral) {
     const { collateralBrandKey } = opts;
     proposal.want.Collateral = {
-      brand: brands[collateralBrandKey],
+      brand: brand[collateralBrandKey],
       value: scaleDecimals(opts.wantCollateral),
     };
   }
   if ('wantMinted' in opts && opts.wantMinted) {
     proposal.want.Minted = {
-      brand: brands.IST,
+      brand: brand.IST,
       value: scaleDecimals(opts.wantMinted),
     };
   }
@@ -54,18 +56,18 @@ const makeVaultProposal = (brands, opts) => {
 };
 
 /**
- * @param {Record<string, Brand>} brands
+ * @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}
  */
-const makeOpenOffer = (brands, opts) => {
-  const proposal = makeVaultProposal(brands, opts);
+const makeOpenOffer = ({ brand }, opts) => {
+  const proposal = makeVaultProposal({ brand }, opts);
 
   // NB: not really a Proposal because the brands are not remotes
   // Instead they're copyRecord like  "{"boardId":"board0257","iface":"Alleged: IST brand"}" to pass through the boardId
   // mustMatch(harden(proposal), ProposalShape);
 
-  const collateralBrand = brands[opts.collateralBrandKey];
+  const collateralBrand = brand[opts.collateralBrandKey];
 
   return {
     id: opts.offerId,
@@ -82,16 +84,16 @@ const makeOpenOffer = (brands, opts) => {
 };
 
 /**
- * @param {Record<string, Brand>} brands
+ * @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}
  */
-const makeAdjustOffer = (brands, opts, previousOffer) => {
+const makeAdjustOffer = ({ brand }, opts, previousOffer) => {
   // NB: not really a Proposal because the brands are not remotes
   // Instead they're copyRecord like  "{"boardId":"board0257","iface":"Alleged: IST brand"}" to pass through the boardId
   // mustMatch(harden(proposal), ProposalShape);
-  const proposal = makeVaultProposal(brands, opts);
+  const proposal = makeVaultProposal({ brand }, opts);
 
   return {
     id: opts.offerId,
@@ -105,13 +107,13 @@ const makeAdjustOffer = (brands, opts, previousOffer) => {
 };
 
 /**
- * @param {Record<string, Brand>} brands
+ * @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}
  */
-const makeCloseOffer = (brands, opts, previousOffer) => {
-  const proposal = makeVaultProposal(brands, opts);
+const makeCloseOffer = ({ brand }, opts, previousOffer) => {
+  const proposal = makeVaultProposal({ brand }, opts);
 
   return {
     id: opts.offerId,
@@ -171,19 +173,19 @@ const makePsmProposal = (brands, opts, fee = 0, anchor = 'AUSD') => {
 };
 
 /**
+ * @param {Pick<import('@agoric/vats/tools/board-utils.js').AgoricNamesRemotes, 'brand'>} agoricNames
  * @param {Instance} instance
- * @param {Record<string, Brand>} brands
  * @param {{ offerId: string, feePct?: number, pair: [string, string] } &
  *         ({ wantMinted: number } | { giveMinted: number })} opts
  * @returns {import('@agoric/smart-wallet/src/offers.js').OfferSpec}
  */
-const makePsmSwapOffer = (instance, brands, opts) => {
+const makePsmSwapOffer = ({ brand }, instance, opts) => {
   const method =
     'wantMinted' in opts
       ? 'makeWantMintedInvitation'
       : 'makeGiveMintedInvitation'; // ref psm.js
   const proposal = makePsmProposal(
-    brands,
+    brand,
     opts,
     opts.feePct ? opts.feePct / 100 : undefined,
     opts.pair[1],
@@ -205,13 +207,53 @@ const makePsmSwapOffer = (instance, brands, opts) => {
 };
 
 /**
- * @param {Record<string, Brand>} _brands
+ * @param {{
+ *   brand: Record<string, Brand>,
+ *   vbankAsset: Record<string, { brand: Brand, displayInfo: DisplayInfo }>,
+ * }} agoricNames
+ * @param {(msg: string) => Error} makeError error constructor
+ * @returns {(a: string) => Amount<'nat'>}
+ */
+export const makeParseAmount =
+  (agoricNames, makeError = msg => RangeError(msg)) =>
+  opt => {
+    assert.typeof(opt, 'string', 'parseAmount expected string');
+    const m = opt.match(/^(?<value>[\d_]+(\.[\d_]+)?)(?<brand>[A-Z]\w*?)$/);
+    if (!m || !m.groups) {
+      throw makeError(`invalid amount: ${opt}`);
+    }
+    const anyBrand = agoricNames.brand[m.groups.brand];
+    if (!anyBrand) {
+      throw makeError(`unknown brand: ${m.groups.brand}`);
+    }
+    const assetDesc = Object.values(agoricNames.vbankAsset).find(
+      d => d.brand === anyBrand,
+    );
+    if (!assetDesc) {
+      throw makeError(`unknown brand: ${m.groups.brand}`);
+    }
+    const { displayInfo } = assetDesc;
+    if (!displayInfo.decimalPlaces || displayInfo.assetKind !== 'nat') {
+      throw makeError(`bad brand: ${displayInfo}`);
+    }
+    const value = BigInt(
+      Number(m.groups.value.replace(/_/g, '')) *
+        10 ** displayInfo.decimalPlaces,
+    );
+    /** @type {Brand<'nat'>} */
+    // @ts-expect-error dynamic cast
+    const natBrand = anyBrand;
+    const amt = { value, brand: natBrand };
+    return amt;
+  };
+
+/**
+ * @param {Pick<import('@agoric/vats/tools/board-utils.js').AgoricNamesRemotes, 'brand' | 'vbankAsset'>} agoricNames
  * @param {{
  *   offerId: string,
  *   give: string,
  *   maxBuy: string,
  *   wantMinimum?: string,
- *   parseAmount: (x: string) => Amount<'nat'>,
  * } & ({
  *   price: number,
  * } | {
@@ -219,14 +261,13 @@ const makePsmSwapOffer = (instance, brands, opts) => {
  * })} opts
  * @returns {import('@agoric/smart-wallet/src/offers.js').OfferSpec}
  */
-const makeBidOffer = (_brands, opts) => {
-  assert.typeof(opts.parseAmount, 'function');
+const makeBidOffer = (agoricNames, opts) => {
   assertAllDefined({
     offerId: opts.offerId,
     give: opts.give,
     maxBuy: opts.maxBuy,
   });
-  const { parseAmount } = opts;
+  const parseAmount = makeParseAmount(agoricNames);
   const proposal = {
     give: { Bid: parseAmount(opts.give) },
     ...(opts.wantMinimum
@@ -276,7 +317,7 @@ const makeBidOffer = (_brands, opts) => {
 };
 
 /**
- * @param {Record<string, Brand>} brands
+ * @param {Pick<import('@agoric/vats/tools/board-utils.js').AgoricNamesRemotes, 'brand'>} agoricNames
  * @param {{
  *   offerId: string,
  *   give: number,
@@ -284,11 +325,11 @@ const makeBidOffer = (_brands, opts) => {
  * }} opts
  * @returns {import('@agoric/smart-wallet/src/offers.js').OfferSpec}
  */
-const makeAddCollateralOffer = (brands, opts) => {
+const makeAddCollateralOffer = ({ brand }, opts) => {
   /** @type {AmountKeywordRecord} */
   const give = {
     Collateral: AmountMath.make(
-      brands[opts.collateralBrandKey],
+      brand[opts.collateralBrandKey],
       scaleDecimals(opts.give),
     ),
   };
@@ -308,7 +349,7 @@ const makeAddCollateralOffer = (brands, opts) => {
 
 /**
  *
- * @param {Record<string, Brand>} _brands
+ * @param {unknown} _agoricNames
  * @param {{
  *   offerId: string,
  *   roundId?: bigint,
@@ -317,7 +358,7 @@ const makeAddCollateralOffer = (brands, opts) => {
  * @param {string} previousOffer
  * @returns {import('@agoric/smart-wallet/src/offers.js').OfferSpec}
  */
-const makePushPriceOffer = (_brands, opts, previousOffer) => {
+const makePushPriceOffer = (_agoricNames, opts, previousOffer) => {
   return {
     id: opts.offerId,
     invitationSpec: {
@@ -332,48 +373,6 @@ const makePushPriceOffer = (_brands, opts, previousOffer) => {
   };
 };
 
-// TODO DRY with CLI wallet.js
-/**
- * @param {{
- *   brand: Record<string, Brand>,
- *   vbankAsset: Record<string, { brand: Brand, displayInfo: DisplayInfo }>,
- * }} agoricNames
- * @param {(msg: string) => Error} makeError error constructor
- * @returns {(a: string) => Amount<'nat'>}
- */
-export const makeParseAmount =
-  (agoricNames, makeError = msg => RangeError(msg)) =>
-  opt => {
-    assert.typeof(opt, 'string', 'parseAmount expected string');
-    const m = opt.match(/^(?<value>[\d_]+(\.[\d_]+)?)(?<brand>[A-Z]\w*?)$/);
-    if (!m || !m.groups) {
-      throw makeError(`invalid amount: ${opt}`);
-    }
-    const anyBrand = agoricNames.brand[m.groups.brand];
-    if (!anyBrand) {
-      throw makeError(`unknown brand: ${m.groups.brand}`);
-    }
-    const assetDesc = Object.values(agoricNames.vbankAsset).find(
-      d => d.brand === anyBrand,
-    );
-    if (!assetDesc) {
-      throw makeError(`unknown brand: ${m.groups.brand}`);
-    }
-    const { displayInfo } = assetDesc;
-    if (!displayInfo.decimalPlaces || displayInfo.assetKind !== 'nat') {
-      throw makeError(`bad brand: ${displayInfo}`);
-    }
-    const value = BigInt(
-      Number(m.groups.value.replace(/_/g, '')) *
-        10 ** displayInfo.decimalPlaces,
-    );
-    /** @type {Brand<'nat'>} */
-    // @ts-expect-error dynamic cast
-    const natBrand = anyBrand;
-    const amt = { value, brand: natBrand };
-    return amt;
-  };
-
 export const Offers = {
   auction: {
     Bid: makeBidOffer,