@agoric/fast-usdc 0.2.0-upgrade-18a-dev-61134db.0 → 0.2.0-upgrade-19-dev-0754752.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@agoric/fast-usdc",
-  "version": "0.2.0-upgrade-18a-dev-61134db.0+61134db",
+  "version": "0.2.0-upgrade-19-dev-0754752.0+0754752",
   "description": "CLI and library for Fast USDC product",
   "type": "module",
   "files": [
@@ -8,6 +8,7 @@
     "src",
     "tools"
   ],
+  "main": "src/main.js",
   "bin": {
     "fast-usdc": "./src/cli/bin.js"
   },
@@ -22,9 +23,9 @@
     "lint:eslint": "eslint ."
   },
   "devDependencies": {
-    "@agoric/swingset-liveslots": "0.10.3-upgrade-18a-dev-61134db.0+61134db",
-    "@agoric/vats": "0.16.0-upgrade-18a-dev-61134db.0+61134db",
-    "@agoric/zone": "0.3.0-upgrade-18a-dev-61134db.0+61134db",
+    "@agoric/swingset-liveslots": "0.10.3-upgrade-19-dev-0754752.0+0754752",
+    "@agoric/vats": "0.16.0-upgrade-19-dev-0754752.0+0754752",
+    "@agoric/zone": "0.3.0-upgrade-19-dev-0754752.0+0754752",
     "@fast-check/ava": "^2.0.1",
     "ava": "^5.3.0",
     "c8": "^10.1.2",
@@ -32,29 +33,29 @@
     "ts-blank-space": "^0.4.4"
   },
   "dependencies": {
-    "@agoric/client-utils": "0.2.0-upgrade-18a-dev-61134db.0+61134db",
-    "@agoric/cosmic-proto": "0.5.0-upgrade-18a-dev-61134db.0+61134db",
-    "@agoric/ertp": "0.16.3-upgrade-18a-dev-61134db.0+61134db",
-    "@agoric/internal": "0.4.0-upgrade-18a-dev-61134db.0+61134db",
-    "@agoric/notifier": "0.7.0-upgrade-18a-dev-61134db.0+61134db",
-    "@agoric/orchestration": "0.2.0-upgrade-18a-dev-61134db.0+61134db",
-    "@agoric/store": "0.9.3-upgrade-18a-dev-61134db.0+61134db",
-    "@agoric/vat-data": "0.5.3-upgrade-18a-dev-61134db.0+61134db",
-    "@agoric/vow": "0.2.0-upgrade-18a-dev-61134db.0+61134db",
-    "@agoric/zoe": "0.26.3-upgrade-18a-dev-61134db.0+61134db",
+    "@agoric/client-utils": "0.2.0-upgrade-19-dev-0754752.0+0754752",
+    "@agoric/cosmic-proto": "0.5.0-upgrade-19-dev-0754752.0+0754752",
+    "@agoric/ertp": "0.16.3-upgrade-19-dev-0754752.0+0754752",
+    "@agoric/internal": "0.4.0-upgrade-19-dev-0754752.0+0754752",
+    "@agoric/notifier": "0.7.0-upgrade-19-dev-0754752.0+0754752",
+    "@agoric/orchestration": "0.2.0-upgrade-19-dev-0754752.0+0754752",
+    "@agoric/store": "0.9.3-upgrade-19-dev-0754752.0+0754752",
+    "@agoric/vat-data": "0.5.3-upgrade-19-dev-0754752.0+0754752",
+    "@agoric/vow": "0.2.0-upgrade-19-dev-0754752.0+0754752",
+    "@agoric/zoe": "0.27.0-upgrade-19-dev-0754752.0+0754752",
     "@cosmjs/proto-signing": "^0.32.4",
     "@cosmjs/stargate": "^0.32.4",
     "@endo/base64": "^1.0.9",
-    "@endo/common": "^1.2.8",
-    "@endo/errors": "^1.2.8",
-    "@endo/eventual-send": "^1.2.8",
-    "@endo/far": "^1.1.9",
-    "@endo/init": "^1.1.7",
-    "@endo/marshal": "^1.6.2",
-    "@endo/nat": "^5.0.13",
-    "@endo/pass-style": "^1.4.7",
-    "@endo/patterns": "^1.4.7",
-    "@endo/promise-kit": "^1.1.8",
+    "@endo/common": "^1.2.9",
+    "@endo/errors": "^1.2.9",
+    "@endo/eventual-send": "^1.3.0",
+    "@endo/far": "^1.1.10",
+    "@endo/init": "^1.1.8",
+    "@endo/marshal": "^1.6.3",
+    "@endo/nat": "^5.0.14",
+    "@endo/pass-style": "^1.4.8",
+    "@endo/patterns": "^1.4.8",
+    "@endo/promise-kit": "^1.1.9",
     "@nick134-bit/noblejs": "0.0.2",
     "bech32": "^2.0.0",
     "commander": "^12.1.0",
@@ -81,5 +82,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "61134dbe832b81ad609b1218fb0859f2222fa1ef"
+  "gitHead": "07547522e9d8a06692fa5ff12c35230ddb4b252b"
 }

package/src/add-operators.core.js

@@ -0,0 +1,63 @@
+import { makeTracer } from '@agoric/internal';
+import { inviteOracles } from './utils/core-eval.js';
+
+/**
+ * @import {ManifestBundleRef} from '@agoric/deploy-script-support/src/externalTypes.js'
+ * @import {BootstrapManifest} from '@agoric/vats/src/core/lib-boot.js'
+ * @import {LegibleCapData} from './utils/config-marshal.js'
+ * @import {FastUSDCConfig} from './types.js'
+ * @import {FastUSDCCorePowers, FastUSDCKit} from './start-fast-usdc.core.js';
+ */
+
+const trace = makeTracer('FUSD-AddOperators', true);
+
+/**
+ * @throws if oracle smart wallets are not yet provisioned
+ *
+ * @param {BootstrapPowers & FastUSDCCorePowers } powers
+ * @param {{ options: LegibleCapData<FastUSDCConfig> }} config
+ */
+export const addOperators = async (
+  { consume: { namesByAddress, fastUsdcKit } },
+  config,
+) => {
+  trace(addOperators.name);
+
+  const kit = await fastUsdcKit;
+
+  const { creatorFacet } = kit;
+
+  trace(config);
+
+  // @ts-expect-error XXX LegibleCapData typedef
+  const { oracles } = config.options.structure;
+
+  await inviteOracles({ creatorFacet, namesByAddress }, oracles);
+};
+harden(addOperators);
+
+/**
+ * @param {{
+ *   restoreRef: (b: ERef<ManifestBundleRef>) => Promise<Installation>;
+ * }} utils
+ * @param {{
+ *   options: LegibleCapData<FastUSDCConfig>;
+ * }} param1
+ */
+export const getManifestForAddOperators = ({ restoreRef: _ }, { options }) => {
+  return {
+    /** @type {BootstrapManifest} */
+    manifest: {
+      [addOperators.name]: {
+        consume: {
+          fastUsdcKit: true,
+
+          // widely shared: name services
+          agoricNames: true,
+          namesByAddress: true,
+        },
+      },
+    },
+    options,
+  };
+};

package/src/cli/cli.js

@@ -13,7 +13,7 @@ import { addConfigCommands } from './config-commands.js';
 import { addOperatorCommands } from './operator-commands.js';
 import * as configLib from './config.js';
 import transferLib from './transfer.js';
-import { makeFile } from '../util/file.js';
+import { makeFile } from './util/file.js';
 import { addLPCommands } from './lp-commands.js';
 
 const packageJson = JSON.parse(

package/src/cli/config-commands.js

@@ -1,6 +1,6 @@
 /**
  * @import {Command} from 'commander';
- * @import {File} from '../util/file.js';
+ * @import {File} from './util/file.js';
  * @import * as ConfigHelpers from './config.js';
  */
 /**

package/src/cli/config.js

@@ -23,7 +23,7 @@ import { stdin as input, stdout as output } from 'node:process';
   }} ConfigOpts
  */
 
-/** @import { File } from '../util/file' */
+/** @import { File } from './util/file' */
 
 export const init = async (
   /** @type {File} */ configFile,

package/src/cli/lp-commands.js

@@ -1,6 +1,7 @@
 /* eslint-env node */
 /**
  * @import {Command} from 'commander';
+ * @import {Amount, Brand} from '@agoric/ertp';
  * @import {OfferSpec} from '@agoric/smart-wallet/src/offers.js';
  * @import {ExecuteOfferAction} from '@agoric/smart-wallet/src/smartWallet.js';
  * @import {USDCProposalShapes} from '../pool-share-math.js';
@@ -14,11 +15,13 @@ import { AmountMath } from '@agoric/ertp';
 import {
   assertParsableNumber,
   ceilDivideBy,
+  floorDivideBy,
   multiplyBy,
   parseRatio,
 } from '@agoric/zoe/src/contractSupport/ratio.js';
 import { InvalidArgumentError } from 'commander';
 import { outputActionAndHint } from './bridge-action.js';
+import { Offers } from '../clientSupport.js';
 
 export const delay = ms => new Promise(resolve => setTimeout(resolve, ms));
 
@@ -81,30 +84,27 @@ export const addLPCommands = (
     .action(async opts => {
       swkP ||= loadSwk();
       const swk = await swkP;
+
       /** @type {Brand<'nat'>} */
       // @ts-expect-error it doesnt recognize usdc as a Brand type
       const usdc = swk.agoricNames.brand.USDC;
       assert(usdc, 'USDC brand not in agoricNames');
 
+      /** @type {Brand<'nat'>} */
+      // @ts-expect-error it doesnt recognize FastLP as a Brand type
+      const poolShare = swk.agoricNames.brand.FastLP;
+      assert(poolShare, 'FastLP brand not in agoricNames');
+
       const usdcAmount = parseUSDCAmount(opts.amount, usdc);
 
-      /** @type {USDCProposalShapes['deposit']} */
-      const proposal = {
-        give: {
-          USDC: usdcAmount,
-        },
-      };
+      const metrics = await swk.readPublished('fastUsdc.poolMetrics');
+      const fastLPAmount = floorDivideBy(usdcAmount, metrics.shareWorth);
 
-      /** @type {OfferSpec} */
-      const offer = {
-        id: opts.offerId,
-        invitationSpec: {
-          source: 'agoricContract',
-          instancePath: ['fastUsdc'],
-          callPipe: [['makeDepositInvitation', []]],
-        },
-        proposal,
-      };
+      const offer = Offers.fastUsdc.Deposit(swk.agoricNames, {
+        offerId: opts.offerId,
+        fastLPAmount: fastLPAmount.value,
+        usdcAmount: usdcAmount.value,
+      });
 
       /** @type {ExecuteOfferAction} */
       const bridgeAction = {
@@ -125,7 +125,6 @@ export const addLPCommands = (
     .requiredOption('--amount <number>', 'USDC amount', parseDecimal)
     .option('--offerId <string>', 'Offer id', String, `lpWithdraw-${now()}`)
     .action(async opts => {
-      swkP ||= loadSwk();
       swkP ||= loadSwk();
       const swk = await swkP;
 
@@ -141,31 +140,14 @@ export const addLPCommands = (
 
       const usdcAmount = parseUSDCAmount(opts.amount, usdc);
 
-      /** @type {import('../types.js').PoolMetrics} */
-      // @ts-expect-error it treats this as "unknown"
       const metrics = await swk.readPublished('fastUsdc.poolMetrics');
       const fastLPAmount = ceilDivideBy(usdcAmount, metrics.shareWorth);
 
-      /** @type {USDCProposalShapes['withdraw']} */
-      const proposal = {
-        give: {
-          PoolShare: fastLPAmount,
-        },
-        want: {
-          USDC: usdcAmount,
-        },
-      };
-
-      /** @type {OfferSpec} */
-      const offer = {
-        id: opts.offerId,
-        invitationSpec: {
-          source: 'agoricContract',
-          instancePath: ['fastUsdc'],
-          callPipe: [['makeWithdrawInvitation', []]],
-        },
-        proposal,
-      };
+      const offer = Offers.fastUsdc.Withdraw(swk.agoricNames, {
+        offerId: opts.offerId,
+        fastLPAmount: fastLPAmount.value,
+        usdcAmount: usdcAmount.value,
+      });
 
       outputActionAndHint(
         { method: 'executeOffer', offer },

package/src/cli/operator-commands.js

@@ -96,6 +96,7 @@ export const addOperatorCommands = (
     .requiredOption('--recipientAddress <string>', 'bech32 address', String)
     .requiredOption('--blockHash <0xhex>', 'hex hash', parseHex)
     .requiredOption('--blockNumber <number>', 'number', parseNat)
+    .requiredOption('--blockTimestamp <number>', 'number', parseNat)
     .requiredOption('--chainId <string>', 'chain id', Number)
     .requiredOption('--amount <number>', 'number', parseNat)
     .requiredOption('--forwardingAddress <string>', 'bech32 address', String)

package/src/cli/transfer.js

@@ -7,16 +7,16 @@ import {
   pickEndpoint,
 } from '@agoric/client-utils';
 import { encodeAddressHook } from '@agoric/cosmic-proto/address-hooks.js';
-import { queryFastUSDCLocalChainAccount } from '../util/agoric.js';
-import { depositForBurn, makeProvider } from '../util/cctp.js';
+import { queryFastUSDCLocalChainAccount } from './util/agoric.js';
+import { depositForBurn, makeProvider } from './util/cctp.js';
 import {
   makeSigner,
   queryForwardingAccount,
   registerFwdAccount,
-} from '../util/noble.js';
-import { queryUSDCBalance } from '../util/bank.js';
+} from './util/noble.js';
+import { queryUSDCBalance } from './util/bank.js';
 
-/** @import { File } from '../util/file' */
+/** @import { File } from './util/file' */
 /** @import { VStorage } from '@agoric/client-utils' */
 /** @import { SigningStargateClient } from '@cosmjs/stargate' */
 /** @import { JsonRpcProvider as ethProvider } from 'ethers' */

package/src/clientSupport.js

@@ -0,0 +1,98 @@
+// @ts-check
+import { assertAllDefined } from '@agoric/internal';
+
+/**
+ * @import {USDCProposalShapes} from './pool-share-math.js';
+ */
+
+/**
+ * @param {Pick<
+ *   import('@agoric/vats/tools/board-utils.js').AgoricNamesRemotes,
+ *   'brand'
+ * >} agoricNames
+ * @param {object} opts
+ * @param {string} opts.offerId
+ * @param {bigint} opts.fastLPAmount
+ * @param {bigint} opts.usdcAmount
+ * @returns {import('@agoric/smart-wallet/src/offers.js').OfferSpec & {proposal: USDCProposalShapes['deposit']}}
+ */
+const makeDepositOffer = ({ brand }, { offerId, fastLPAmount, usdcAmount }) => {
+  assertAllDefined({ offerId, fastLPAmount, usdcAmount });
+
+  return {
+    id: offerId,
+    invitationSpec: {
+      source: 'agoricContract',
+      instancePath: ['fastUsdc'],
+      callPipe: [['makeDepositInvitation']],
+    },
+    /** @type {USDCProposalShapes['deposit']} */
+    // @ts-expect-error https://github.com/Agoric/agoric-sdk/issues/10491
+    proposal: {
+      give: {
+        USDC: {
+          brand: brand.USDC,
+          value: usdcAmount,
+        },
+      },
+      want: {
+        PoolShare: {
+          brand: brand.FastLP,
+          value: fastLPAmount,
+        },
+      },
+    },
+  };
+};
+
+/**
+ * @param {Pick<
+ *   import('@agoric/vats/tools/board-utils.js').AgoricNamesRemotes,
+ *   'brand'
+ * >} agoricNames
+ * @param {object} opts
+ * @param {string} opts.offerId
+ * @param {bigint} opts.fastLPAmount
+ * @param {bigint} opts.usdcAmount
+ * @returns {import('@agoric/smart-wallet/src/offers.js').OfferSpec}
+ */
+const makeWithdrawOffer = (
+  { brand },
+  { offerId, fastLPAmount, usdcAmount },
+) => ({
+  id: offerId,
+  invitationSpec: {
+    source: 'agoricContract',
+    instancePath: ['fastUsdc'],
+    callPipe: [['makeWithdrawInvitation']],
+  },
+  proposal: {
+    give: {
+      PoolShare: {
+        // @ts-expect-error https://github.com/Agoric/agoric-sdk/issues/10491
+        brand: brand.FastLP,
+        value: fastLPAmount,
+      },
+    },
+    want: {
+      USDC: {
+        // @ts-expect-error https://github.com/Agoric/agoric-sdk/issues/10491
+        brand: brand.USDC,
+        value: usdcAmount,
+      },
+    },
+  },
+});
+
+/**
+ * @satisfies {Record<
+ *   string,
+ *   Record<string, import('@agoric/smart-wallet/src/types.js').OfferMaker>
+ * >}
+ */
+export const Offers = {
+  fastUsdc: {
+    Deposit: makeDepositOffer,
+    Withdraw: makeWithdrawOffer,
+  },
+};

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 };
+};