@agoric/fast-usdc 0.1.1-dev-7e9048c.0 → 0.1.1-dev-44f449b.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@agoric/fast-usdc",
-  "version": "0.1.1-dev-7e9048c.0+7e9048c",
+  "version": "0.1.1-dev-44f449b.0+44f449b",
   "description": "CLI and library for Fast USDC product",
   "type": "module",
   "files": [
@@ -22,9 +22,9 @@
     "lint:eslint": "eslint ."
   },
   "devDependencies": {
-    "@agoric/swingset-liveslots": "0.10.3-dev-7e9048c.0+7e9048c",
-    "@agoric/vats": "0.15.2-dev-7e9048c.0+7e9048c",
-    "@agoric/zone": "0.2.3-dev-7e9048c.0+7e9048c",
+    "@agoric/swingset-liveslots": "0.10.3-dev-44f449b.0+44f449b",
+    "@agoric/vats": "0.15.2-dev-44f449b.0+44f449b",
+    "@agoric/zone": "0.2.3-dev-44f449b.0+44f449b",
     "@fast-check/ava": "^2.0.1",
     "ava": "^5.3.0",
     "c8": "^10.1.2",
@@ -32,16 +32,16 @@
     "ts-blank-space": "^0.4.4"
   },
   "dependencies": {
-    "@agoric/client-utils": "0.1.1-dev-7e9048c.0+7e9048c",
-    "@agoric/cosmic-proto": "0.4.1-dev-7e9048c.0+7e9048c",
-    "@agoric/ertp": "0.16.3-dev-7e9048c.0+7e9048c",
-    "@agoric/internal": "0.3.3-dev-7e9048c.0+7e9048c",
-    "@agoric/notifier": "0.6.3-dev-7e9048c.0+7e9048c",
-    "@agoric/orchestration": "0.1.1-dev-7e9048c.0+7e9048c",
-    "@agoric/store": "0.9.3-dev-7e9048c.0+7e9048c",
-    "@agoric/vat-data": "0.5.3-dev-7e9048c.0+7e9048c",
-    "@agoric/vow": "0.1.1-dev-7e9048c.0+7e9048c",
-    "@agoric/zoe": "0.26.3-dev-7e9048c.0+7e9048c",
+    "@agoric/client-utils": "0.1.1-dev-44f449b.0+44f449b",
+    "@agoric/cosmic-proto": "0.4.1-dev-44f449b.0+44f449b",
+    "@agoric/ertp": "0.16.3-dev-44f449b.0+44f449b",
+    "@agoric/internal": "0.3.3-dev-44f449b.0+44f449b",
+    "@agoric/notifier": "0.6.3-dev-44f449b.0+44f449b",
+    "@agoric/orchestration": "0.1.1-dev-44f449b.0+44f449b",
+    "@agoric/store": "0.9.3-dev-44f449b.0+44f449b",
+    "@agoric/vat-data": "0.5.3-dev-44f449b.0+44f449b",
+    "@agoric/vow": "0.1.1-dev-44f449b.0+44f449b",
+    "@agoric/zoe": "0.26.3-dev-44f449b.0+44f449b",
     "@cosmjs/proto-signing": "^0.32.4",
     "@cosmjs/stargate": "^0.32.4",
     "@endo/base64": "^1.0.9",
@@ -81,5 +81,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "7e9048c1ef18f3a0530417839cfddba40da8ebda"
+  "gitHead": "44f449b7fa1c9b8051d98e567c350fce37e33f83"
 }

package/src/distribute-fees.core.js

@@ -0,0 +1,93 @@
+/** @file core eval module to collect fees. */
+import { AmountMath } from '@agoric/ertp';
+import { floorMultiplyBy } from '@agoric/zoe/src/contractSupport/index.js';
+import { E } from '@endo/far';
+import { makeTracer } from '@agoric/internal';
+import { fromExternalConfig } from './utils/config-marshal.js';
+
+/**
+ * @import {DepositFacet} from '@agoric/ertp';
+ * @import {FastUSDCCorePowers} from '@agoric/fast-usdc/src/start-fast-usdc.core.js';
+ * @import {CopyRecord} from '@endo/pass-style'
+ * @import {BootstrapManifestPermit} from '@agoric/vats/src/core/lib-boot.js'
+ * @import {LegibleCapData} from './utils/config-marshal.js'
+ */
+
+/**
+ * @typedef {{ destinationAddress: string } &
+ *  ({ feePortion: Ratio} | {fixedFees: Amount<'nat'>}) &
+ *  CopyRecord
+ * } FeeDistributionTerms
+ */
+
+const kwUSDC = 'USDC'; // keyword in AmountKeywordRecord
+const issUSDC = 'USDC'; // issuer name
+
+const trace = makeTracer('FUCF', true);
+
+/**
+ * @param {BootstrapPowers & FastUSDCCorePowers } permittedPowers
+ * @param {{ options: LegibleCapData<{ feeTerms: FeeDistributionTerms}> }} config
+ */
+export const distributeFees = async (permittedPowers, config) => {
+  trace('distributeFees...', config.options);
+
+  const { agoricNames, namesByAddress, zoe } = permittedPowers.consume;
+  /** @type {Brand<'nat'>} */
+  const usdcBrand = await E(agoricNames).lookup('brand', issUSDC);
+  /** @type {{ feeTerms: FeeDistributionTerms}} */
+  const { feeTerms: terms } = fromExternalConfig(config.options, {
+    USDC: usdcBrand,
+  });
+
+  const { creatorFacet } = await permittedPowers.consume.fastUsdcKit;
+  const want = {
+    [kwUSDC]: await ('fixedFees' in terms
+      ? terms.fixedFees
+      : E(creatorFacet)
+          .getContractFeeBalance()
+          .then(balance => floorMultiplyBy(balance, terms.feePortion))),
+  };
+  const proposal = harden({ want });
+
+  /** @type {DepositFacet} */
+  const depositFacet = await E(namesByAddress).lookup(
+    terms.destinationAddress,
+    'depositFacet',
+  );
+  trace('to:', terms.destinationAddress, depositFacet);
+
+  const toWithdraw = await E(creatorFacet).makeWithdrawFeesInvitation();
+  trace('invitation:', toWithdraw, 'proposal:', proposal);
+  const seat = E(zoe).offer(toWithdraw, proposal);
+  const result = await E(seat).getOfferResult();
+  trace('offer result', result);
+  const payout = await E(seat).getPayout(kwUSDC);
+  /** @type {Amount<'nat'>} */
+  // @ts-expect-error USDC is a nat brand
+  const rxd = await E(depositFacet).receive(payout);
+  trace('received', rxd);
+  if (!AmountMath.isGTE(rxd, proposal.want[kwUSDC])) {
+    trace('🚨 expected', proposal.want[kwUSDC], 'got', rxd);
+  }
+  trace('done');
+};
+harden(distributeFees);
+
+/** @satisfies {BootstrapManifestPermit} */
+const permit = {
+  consume: {
+    fastUsdcKit: true,
+    agoricNames: true,
+    namesByAddress: true,
+    zoe: true,
+  },
+};
+
+/**
+ * @param {unknown} _utils
+ * @param {Parameters<typeof distributeFees>[1]} config
+ */
+export const getManifestForDistributeFees = (_utils, { options }) => {
+  return { manifest: { [distributeFees.name]: permit }, options };
+};

package/src/exos/liquidity-pool.js

@@ -1,4 +1,4 @@
-import { AmountMath } from '@agoric/ertp';
+import { AmountMath, AmountShape } from '@agoric/ertp';
 import {
   makeRecorderTopic,
   TopicsRecordShape,
@@ -107,11 +107,18 @@ export const prepareLiquidityPoolKit = (zone, zcf, USDC, tools) => {
       withdrawHandler: M.interface('withdrawHandler', {
         handle: M.call(SeatShape, M.any()).returns(M.promise()),
       }),
+      withdrawFeesHandler: M.interface('withdrawFeesHandler', {
+        handle: M.call(SeatShape, M.any()).returns(M.promise()),
+      }),
       public: M.interface('public', {
         makeDepositInvitation: M.call().returns(M.promise()),
         makeWithdrawInvitation: M.call().returns(M.promise()),
         getPublicTopics: M.call().returns(TopicsRecordShape),
       }),
+      feeRecipient: M.interface('feeRecipient', {
+        getContractFeeBalance: M.call().returns(AmountShape),
+        makeWithdrawFeesInvitation: M.call().returns(M.promise()),
+      }),
     },
     /**
      * @param {ZCFMint<'nat'>} shareMint
@@ -326,6 +333,21 @@ export const prepareLiquidityPoolKit = (zone, zcf, USDC, tools) => {
           external.publishPoolMetrics();
         },
       },
+      withdrawFeesHandler: {
+        /** @param {ZCFSeat} seat */
+        async handle(seat) {
+          const { feeSeat } = this.state;
+
+          const { want } = seat.getProposal();
+          const available = feeSeat.getAmountAllocated('USDC', want.USDC.brand);
+          isGTE(available, want.USDC) ||
+            Fail`cannot withdraw ${want.USDC}; only ${available} available`;
+
+          // COMMIT POINT
+          zcf.atomicRearrange(harden([[feeSeat, seat, want]]));
+          seat.exit();
+        },
+      },
       public: {
         makeDepositInvitation() {
           return zcf.makeInvitation(
@@ -353,6 +375,22 @@ export const prepareLiquidityPoolKit = (zone, zcf, USDC, tools) => {
           };
         },
       },
+      feeRecipient: {
+        getContractFeeBalance() {
+          const { feeSeat } = this.state;
+          /** @type {Amount<'nat'>} */
+          const balance = feeSeat.getCurrentAllocation().USDC;
+          return balance;
+        },
+        makeWithdrawFeesInvitation() {
+          return zcf.makeInvitation(
+            this.facets.withdrawFeesHandler,
+            'Withdraw Fees',
+            undefined,
+            this.state.proposalShapes.withdrawFees,
+          );
+        },
+      },
     },
     {
       finish: ({ facets: { external } }) => {

package/src/fast-usdc.contract.js

@@ -161,6 +161,13 @@ export const contract = async (zcf, privateArgs, zone, tools) => {
     removeOperator(operatorId) {
       return feedKit.creator.removeOperator(operatorId);
     },
+    async getContractFeeBalance() {
+      return poolKit.feeRecipient.getContractFeeBalance();
+    },
+    /** @type {() => Promise<Invitation<unknown>>} */
+    async makeWithdrawFeesInvitation() {
+      return poolKit.feeRecipient.makeWithdrawFeesInvitation();
+    },
     async connectToNoble() {
       return vowTools.when(nobleAccountV, nobleAccount => {
         trace('nobleAccount', nobleAccount);

package/src/pool-share-math.js

@@ -44,6 +44,9 @@ export const makeParity = (numerator, denominatorBrand) => {
  *   withdraw: {
  *     give: { PoolShare: Amount<'nat'> }
  *     want: { USDC: Amount<'nat'> },
+ *   },
+ *   withdrawFees: {
+ *     want: { USDC: Amount<'nat'> }
  *   }
  * }} USDCProposalShapes
  */

package/src/start-fast-usdc.core.js

@@ -1,22 +1,22 @@
 import { deeplyFulfilledObject, makeTracer } from '@agoric/internal';
-import { Fail } from '@endo/errors';
 import { E } from '@endo/far';
-import { makeMarshal } from '@endo/marshal';
 import { FastUSDCConfigShape } from './type-guards.js';
 import { fromExternalConfig } from './utils/config-marshal.js';
-import { inviteOracles, publishFeedPolicy } from './utils/core-eval.js';
+import {
+  inviteOracles,
+  publishDisplayInfo,
+  publishFeedPolicy,
+} from './utils/core-eval.js';
 
 /**
- * @import {Amount, Brand, DepositFacet, Issuer, Payment} from '@agoric/ertp';
- * @import {TypedPattern} from '@agoric/internal'
+ * @import {Brand, Issuer} from '@agoric/ertp';
  * @import {Instance, StartParams} from '@agoric/zoe/src/zoeService/utils'
  * @import {Board} from '@agoric/vats'
  * @import {ManifestBundleRef} from '@agoric/deploy-script-support/src/externalTypes.js'
  * @import {BootstrapManifest} from '@agoric/vats/src/core/lib-boot.js'
- * @import {Passable} from '@endo/pass-style'
  * @import {LegibleCapData} from './utils/config-marshal.js'
  * @import {FastUsdcSF} from './fast-usdc.contract.js'
- * @import {FeedPolicy, FastUSDCConfig} from './types.js'
+ * @import {FastUSDCConfig} from './types.js'
  */
 
 const ShareAssetInfo = /** @type {const} */ harden({
@@ -46,26 +46,6 @@ const makePublishingStorageKit = async (path, { chainStorage, board }) => {
   return { storageNode, marshaller };
 };
 
-const BOARD_AUX = 'boardAux';
-const marshalData = makeMarshal(_val => Fail`data only`);
-/**
- * @param {Brand} brand
- * @param {Pick<BootstrapPowers['consume'], 'board' | 'chainStorage'>} powers
- */
-const publishDisplayInfo = async (brand, { board, chainStorage }) => {
-  // chainStorage type includes undefined, which doesn't apply here.
-  // @ts-expect-error UNTIL https://github.com/Agoric/agoric-sdk/issues/8247
-  const boardAux = E(chainStorage).makeChildNode(BOARD_AUX);
-  const [id, displayInfo, allegedName] = await Promise.all([
-    E(board).getId(brand),
-    E(brand).getDisplayInfo(),
-    E(brand).getAllegedName(),
-  ]);
-  const node = E(boardAux).makeChildNode(id);
-  const aux = marshalData.toCapData(harden({ allegedName, displayInfo }));
-  await E(node).setValue(JSON.stringify(aux));
-};
-
 const POOL_METRICS = 'poolMetrics';
 
 /**
@@ -79,7 +59,7 @@ const POOL_METRICS = 'poolMetrics';
  * }} FastUSDCCorePowers
  *
  * @typedef {StartedInstanceKitWithLabel & {
- *   creatorFacet: Awaited<ReturnType<FastUsdcSF>>['creatorFacet'];
+ *   creatorFacet: StartedInstanceKit<FastUsdcSF>['creatorFacet'];
  *   privateArgs: StartParams<FastUsdcSF>['privateArgs'];
  * }} FastUSDCKit
  */
@@ -245,10 +225,10 @@ export const getManifestForFastUSDC = (
           board: true,
         },
         issuer: {
-          produce: { FastLP: true }, // UNTIL #10432
+          produce: { FastLP: true },
         },
         brand: {
-          produce: { FastLP: true }, // UNTIL #10432
+          produce: { FastLP: true },
         },
         instance: {
           produce: { fastUsdc: true },

package/src/type-guards.js

@@ -34,7 +34,11 @@ export const makeProposalShapes = ({ PoolShares, USDC }) => {
     give: { PoolShare: makeNatAmountShape(PoolShares, 1n) },
     want: { USDC: makeNatAmountShape(USDC, 1n) },
   });
-  return harden({ deposit, withdraw });
+  /** @type {TypedPattern<USDCProposalShapes['withdrawFees']>} */
+  const withdrawFees = M.splitRecord({
+    want: { USDC: makeNatAmountShape(USDC, 1n) },
+  });
+  return harden({ deposit, withdraw, withdrawFees });
 };
 
 /** @type {TypedPattern<FastUsdcTerms>} */

package/src/utils/core-eval.js

@@ -6,9 +6,7 @@ import { makeMarshal } from '@endo/marshal';
 const trace = makeTracer('FUCoreEval');
 
 /**
- * @import {Amount, Brand, DepositFacet, Issuer, Payment} from '@agoric/ertp';
- * @import {Passable} from '@endo/pass-style'
- * @import {BootstrapManifest} from '@agoric/vats/src/core/lib-boot.js'
+ * @import {Brand, DepositFacet} from '@agoric/ertp';
  * @import {FastUSDCKit} from '../start-fast-usdc.core.js'
  * @import {FeedPolicy} from '../types.js'
  */
@@ -54,3 +52,22 @@ export const inviteOracles = async (
     }),
   );
 };
+
+const BOARD_AUX = 'boardAux';
+/**
+ * @param {Brand} brand
+ * @param {Pick<BootstrapPowers['consume'], 'board' | 'chainStorage'>} powers
+ */
+export const publishDisplayInfo = async (brand, { board, chainStorage }) => {
+  // chainStorage type includes undefined, which doesn't apply here.
+  // @ts-expect-error UNTIL https://github.com/Agoric/agoric-sdk/issues/8247
+  const boardAux = E(chainStorage).makeChildNode(BOARD_AUX);
+  const [id, displayInfo, allegedName] = await Promise.all([
+    E(board).getId(brand),
+    E(brand).getDisplayInfo(),
+    E(brand).getAllegedName(),
+  ]);
+  const node = E(boardAux).makeChildNode(id);
+  const aux = marshalData.toCapData(harden({ allegedName, displayInfo }));
+  await E(node).setValue(JSON.stringify(aux));
+};