@agoric/fast-usdc 0.1.1-dev-340ef0d.0 → 0.1.1-dev-c1ae023.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@agoric/fast-usdc",
-  "version": "0.1.1-dev-340ef0d.0+340ef0d",
+  "version": "0.1.1-dev-c1ae023.0+c1ae023",
   "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-340ef0d.0+340ef0d",
-    "@agoric/vats": "0.15.2-dev-340ef0d.0+340ef0d",
-    "@agoric/zone": "0.2.3-dev-340ef0d.0+340ef0d",
+    "@agoric/swingset-liveslots": "0.10.3-dev-c1ae023.0+c1ae023",
+    "@agoric/vats": "0.15.2-dev-c1ae023.0+c1ae023",
+    "@agoric/zone": "0.2.3-dev-c1ae023.0+c1ae023",
     "@fast-check/ava": "^2.0.1",
     "ava": "^5.3.0",
     "c8": "^10.1.2",
@@ -32,15 +32,15 @@
     "ts-blank-space": "^0.4.4"
   },
   "dependencies": {
-    "@agoric/client-utils": "0.1.1-dev-340ef0d.0+340ef0d",
-    "@agoric/ertp": "0.16.3-dev-340ef0d.0+340ef0d",
-    "@agoric/internal": "0.3.3-dev-340ef0d.0+340ef0d",
-    "@agoric/notifier": "0.6.3-dev-340ef0d.0+340ef0d",
-    "@agoric/orchestration": "0.1.1-dev-340ef0d.0+340ef0d",
-    "@agoric/store": "0.9.3-dev-340ef0d.0+340ef0d",
-    "@agoric/vat-data": "0.5.3-dev-340ef0d.0+340ef0d",
-    "@agoric/vow": "0.1.1-dev-340ef0d.0+340ef0d",
-    "@agoric/zoe": "0.26.3-dev-340ef0d.0+340ef0d",
+    "@agoric/client-utils": "0.1.1-dev-c1ae023.0+c1ae023",
+    "@agoric/ertp": "0.16.3-dev-c1ae023.0+c1ae023",
+    "@agoric/internal": "0.3.3-dev-c1ae023.0+c1ae023",
+    "@agoric/notifier": "0.6.3-dev-c1ae023.0+c1ae023",
+    "@agoric/orchestration": "0.1.1-dev-c1ae023.0+c1ae023",
+    "@agoric/store": "0.9.3-dev-c1ae023.0+c1ae023",
+    "@agoric/vat-data": "0.5.3-dev-c1ae023.0+c1ae023",
+    "@agoric/vow": "0.1.1-dev-c1ae023.0+c1ae023",
+    "@agoric/zoe": "0.26.3-dev-c1ae023.0+c1ae023",
     "@cosmjs/proto-signing": "^0.32.4",
     "@cosmjs/stargate": "^0.32.4",
     "@endo/base64": "^1.0.9",
@@ -80,5 +80,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "340ef0d3a3b0d80ed847fc7a78c805f0c589c7c9"
+  "gitHead": "c1ae023438eb7cdf0c84bc5e21e6b682ec9fbd36"
 }

package/src/cli/bridge-action.js

@@ -4,13 +4,16 @@ import { boardSlottingMarshaller } from '@agoric/client-utils';
  * @import {BridgeAction} from '@agoric/smart-wallet/src/smartWallet.js';
  */
 
-const marshaller = boardSlottingMarshaller();
+const defaultMarshaller = boardSlottingMarshaller();
+
+/** @typedef {ReturnType<boardSlottingMarshaller>} BoardSlottingMarshaller */
 
 /**
  * @param {BridgeAction} bridgeAction
  * @param {Pick<import('stream').Writable,'write'>} stdout
+ * @param {BoardSlottingMarshaller} marshaller
  */
-const outputAction = (bridgeAction, stdout) => {
+const outputAction = (bridgeAction, stdout, marshaller) => {
   const capData = marshaller.toCapData(harden(bridgeAction));
   stdout.write(JSON.stringify(capData));
   stdout.write('\n');
@@ -25,8 +28,13 @@ export const sendHint =
  *   stdout: Pick<import('stream').Writable,'write'>,
  *   stderr: Pick<import('stream').Writable,'write'>,
  * }} io
+ * @param {BoardSlottingMarshaller | undefined} marshaller
  */
-export const outputActionAndHint = (bridgeAction, { stdout, stderr }) => {
-  outputAction(bridgeAction, stdout);
+export const outputActionAndHint = (
+  bridgeAction,
+  { stdout, stderr },
+  marshaller = defaultMarshaller,
+) => {
+  outputAction(bridgeAction, stdout, marshaller);
   stderr.write(sendHint);
 };

package/src/cli/cli.js

@@ -1,11 +1,6 @@
 /* eslint-env node */
 /* global globalThis */
-import { assertParsableNumber } from '@agoric/zoe/src/contractSupport/ratio.js';
-import {
-  Command,
-  InvalidArgumentError,
-  InvalidOptionArgumentError,
-} from 'commander';
+import { Command } from 'commander';
 import { existsSync, mkdirSync, readFileSync } from 'fs';
 import { fileURLToPath } from 'url';
 import { dirname, resolve } from 'path';
@@ -19,6 +14,7 @@ import { addOperatorCommands } from './operator-commands.js';
 import * as configLib from './config.js';
 import transferLib from './transfer.js';
 import { makeFile } from '../util/file.js';
+import { addLPCommands } from './lp-commands.js';
 
 const packageJson = JSON.parse(
   readFileSync(
@@ -83,51 +79,7 @@ export const initProgram = (
     env,
     now,
   });
-
-  /** @param {string} value */
-  const parseDecimal = value => {
-    try {
-      assertParsableNumber(value);
-    } catch {
-      throw new InvalidArgumentError('Not a decimal number.');
-    }
-    return value;
-  };
-
-  /**
-   * @param {string} str
-   * @returns {'auto' | number}
-   */
-  const parseFee = str => {
-    if (str === 'auto') return 'auto';
-    const num = parseFloat(str);
-    if (Number.isNaN(num)) {
-      throw new InvalidOptionArgumentError('Fee must be a number.');
-    }
-    return num;
-  };
-
-  program
-    .command('deposit')
-    .description('Offer assets to the liquidity pool')
-    .argument('<give>', 'USDC to give', parseDecimal)
-    .option('--id [offer-id]', 'Offer ID')
-    .option('--fee [fee]', 'Cosmos fee', parseFee)
-    .action(() => {
-      console.error('TODO actually send deposit');
-      // TODO: Implement deposit logic
-    });
-
-  program
-    .command('withdraw')
-    .description('Withdraw assets from the liquidity pool')
-    .argument('<want>', 'USDC to withdraw', parseDecimal)
-    .option('--id [offer-id]', 'Offer ID')
-    .option('--fee [fee]', 'Cosmos fee', parseFee)
-    .action(() => {
-      console.error('TODO actually send withdrawal');
-      // TODO: Implement withdraw logic
-    });
+  addLPCommands(program, { fetch, stdout, stderr, env, now });
 
   program
     .command('transfer')

package/src/cli/lp-commands.js

@@ -0,0 +1,171 @@
+/**
+ * @import {Command} from 'commander';
+ * @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';
+ */
+
+import { fetchEnvNetworkConfig, makeVstorageKit } from '@agoric/client-utils';
+import { InvalidArgumentError } from 'commander';
+import {
+  assertParsableNumber,
+  ceilDivideBy,
+  multiplyBy,
+  parseRatio,
+} from '@agoric/zoe/src/contractSupport/ratio.js';
+import { AmountMath } from '@agoric/ertp';
+import { outputActionAndHint } from './bridge-action.js';
+
+/** @param {string} arg */
+const parseDecimal = arg => {
+  try {
+    assertParsableNumber(arg);
+    const n = Number(arg);
+    return n;
+  } catch {
+    throw new InvalidArgumentError('Not a number');
+  }
+};
+
+/**
+ * @param {string} amountString
+ * @param {Brand} usdc
+ */
+const parseUSDCAmount = (amountString, usdc) => {
+  const USDC_DECIMALS = 6;
+  const unit = AmountMath.make(usdc, 10n ** BigInt(USDC_DECIMALS));
+  return multiplyBy(unit, parseRatio(amountString, usdc));
+};
+
+/**
+ * @param {Command} program
+ * @param {{
+ *   fetch?: Window['fetch'];
+ *   vstorageKit?: Awaited<ReturnType<typeof makeVstorageKit>>;
+ *   stdout: typeof process.stdout;
+ *   stderr: typeof process.stderr;
+ *   env: typeof process.env;
+ *   now: typeof Date.now;
+ * }} io
+ */
+export const addLPCommands = (
+  program,
+  { fetch, vstorageKit, stderr, stdout, env, now },
+) => {
+  const loadVsk = async () => {
+    if (vstorageKit) {
+      return vstorageKit;
+    }
+    assert(fetch);
+    const networkConfig = await fetchEnvNetworkConfig({ env, fetch });
+    return makeVstorageKit({ fetch }, networkConfig);
+  };
+  /** @type {undefined | ReturnType<typeof loadVsk>} */
+  let vskP;
+
+  program
+    .command('deposit')
+    .description('Deposit USDC into pool')
+    .addHelpText(
+      'after',
+      '\nPipe the STDOUT to a file such as deposit.json, then use the Agoric CLI to broadcast it:\n  agoric wallet send --offer deposit.json --from gov1 --keyring-backend="test"',
+    )
+    .requiredOption('--amount <number>', 'USDC amount', parseDecimal)
+    .option('--offerId <string>', 'Offer id', String, `lpDeposit-${now()}`)
+    .action(async opts => {
+      vskP ||= loadVsk();
+      const vsk = await vskP;
+      /** @type {Brand<'nat'>} */
+      // @ts-expect-error it doesnt recognize usdc as a Brand type
+      const usdc = vsk.agoricNames.brand.USDC;
+      assert(usdc, 'USDC brand not in agoricNames');
+
+      const usdcAmount = parseUSDCAmount(opts.amount, usdc);
+
+      /** @type {USDCProposalShapes['deposit']} */
+      const proposal = {
+        give: {
+          USDC: usdcAmount,
+        },
+      };
+
+      /** @type {OfferSpec} */
+      const offer = {
+        id: opts.offerId,
+        invitationSpec: {
+          source: 'agoricContract',
+          instancePath: ['fastUsdc'],
+          callPipe: [['makeDepositInvitation', []]],
+        },
+        proposal,
+      };
+
+      /** @type {ExecuteOfferAction} */
+      const bridgeAction = {
+        method: 'executeOffer',
+        offer,
+      };
+
+      outputActionAndHint(bridgeAction, { stderr, stdout }, vsk.marshaller);
+    });
+
+  program
+    .command('withdraw')
+    .description("Withdraw USDC from the LP's pool share")
+    .addHelpText(
+      'after',
+      '\nPipe the STDOUT to a file such as withdraw.json, then use the Agoric CLI to broadcast it:\n  agoric wallet send --offer withdraw.json --from gov1 --keyring-backend="test"',
+    )
+    .requiredOption('--amount <number>', 'USDC amount', parseDecimal)
+    .option('--offerId <string>', 'Offer id', String, `lpWithdraw-${now()}`)
+    .action(async opts => {
+      vskP ||= loadVsk();
+      const vsk = await vskP;
+
+      /** @type {Brand<'nat'>} */
+      // @ts-expect-error it doesnt recognize FastLP as a Brand type
+      const poolShare = vsk.agoricNames.brand.FastLP;
+      assert(poolShare, 'FastLP brand not in agoricNames');
+
+      /** @type {Brand<'nat'>} */
+      // @ts-expect-error it doesnt recognize usdc as a Brand type
+      const usdc = vsk.agoricNames.brand.USDC;
+      assert(usdc, 'USDC brand not in agoricNames');
+
+      const usdcAmount = parseUSDCAmount(opts.amount, usdc);
+
+      /** @type {import('../types.js').PoolMetrics} */
+      // @ts-expect-error it treats this as "unknown"
+      const metrics = await vsk.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,
+      };
+
+      outputActionAndHint(
+        { method: 'executeOffer', offer },
+        { stderr, stdout },
+        vsk.marshaller,
+      );
+    });
+
+  return program;
+};

package/src/cli/operator-commands.js

@@ -80,6 +80,10 @@ export const addOperatorCommands = (
   operator
     .command('attest')
     .description('Attest to an observed Fast USDC transfer')
+    .addHelpText(
+      'after',
+      '\nPipe the STDOUT to a file such as attest.json, then use the Agoric CLI to broadcast it:\n  agoric wallet send --offer attest.json --from gov1 --keyring-backend="test"',
+    )
     .requiredOption('--previousOfferId <string>', 'Offer id', String)
     .requiredOption('--forwardingChannel <string>', 'Channel id', String)
     .requiredOption('--recipientAddress <string>', 'bech32 address', String)

package/src/exos/status-manager.js

@@ -13,21 +13,29 @@ import { PendingTxStatus, TxStatus } from '../constants.js';
 /**
  * @import {MapStore, SetStore} from '@agoric/store';
  * @import {Zone} from '@agoric/zone';
- * @import {CctpTxEvidence, NobleAddress, SeenTxKey, PendingTxKey, PendingTx, EvmHash, LogFn} from '../types.js';
+ * @import {CctpTxEvidence, NobleAddress, PendingTx, EvmHash, LogFn} from '../types.js';
+ */
+
+/**
+ * @typedef {`pendingTx:${bigint}:${NobleAddress}`} PendingTxKey
+ * The string template is for developer visibility but not meant to ever be parsed.
+ *
+ * @typedef {`seenTx:${string}:${EvmHash}`} SeenTxKey
+ * The string template is for developer visibility but not meant to ever be parsed.
  */
 
 /**
  * Create the key for the pendingTxs MapStore.
  *
- * The key is a composite of `txHash` and `chainId` and not meant to be
- * parsable.
+ * The key is a composite but not meant to be parsable.
  *
  * @param {NobleAddress} addr
  * @param {bigint} amount
  * @returns {PendingTxKey}
  */
 const makePendingTxKey = (addr, amount) =>
-  `pendingTx:${JSON.stringify([addr, String(amount)])}`;
+  // amount can't contain colon
+  `pendingTx:${amount}:${addr}`;
 
 /**
  * Get the key for the pendingTxs MapStore.
@@ -43,15 +51,15 @@ const pendingTxKeyOf = evidence => {
 /**
  * Get the key for the seenTxs SetStore.
  *
- * The key is a composite of `NobleAddress` and transaction `amount` and not
- * meant to be parsable.
+ * The key is a composite but not meant to be parsable.
  *
  * @param {CctpTxEvidence} evidence
  * @returns {SeenTxKey}
  */
 const seenTxKeyOf = evidence => {
   const { txHash, chainId } = evidence;
-  return `seenTx:${JSON.stringify([txHash, chainId])}`;
+  // chainId can't contain colon
+  return `seenTx:${chainId}:${txHash}`;
 };
 
 /**
@@ -68,12 +76,12 @@ const seenTxKeyOf = evidence => {
  * XXX consider separate facets for `Advancing` and `Settling` capabilities.
  *
  * @param {Zone} zone
- * @param {() => Promise<StorageNode>} makeStatusNode
+ * @param {ERef<StorageNode>} transactionsNode
  * @param {StatusManagerPowers} caps
  */
 export const prepareStatusManager = (
   zone,
-  makeStatusNode,
+  transactionsNode,
   {
     log = makeTracer('Advancer', true),
   } = /** @type {StatusManagerPowers} */ ({}),
@@ -93,9 +101,8 @@ export const prepareStatusManager = (
    * @param {CctpTxEvidence['txHash']} hash
    * @param {TxStatus} status
    */
-  const recordStatus = (hash, status) => {
-    const statusNodeP = makeStatusNode();
-    const txnNodeP = E(statusNodeP).makeChildNode(hash);
+  const publishStatus = (hash, status) => {
+    const txnNodeP = E(transactionsNode).makeChildNode(hash);
     // Don't await, just writing to vstorage.
     void E(txnNodeP).setValue(status);
   };
@@ -109,7 +116,7 @@ export const prepareStatusManager = (
    * @param {CctpTxEvidence} evidence
    * @param {PendingTxStatus} status
    */
-  const recordPendingTx = (evidence, status) => {
+  const initPendingTx = (evidence, status) => {
     const seenKey = seenTxKeyOf(evidence);
     if (seenTxs.has(seenKey)) {
       throw makeError(`Transaction already seen: ${q(seenKey)}`);
@@ -121,9 +128,31 @@ export const prepareStatusManager = (
       pendingTxKeyOf(evidence),
       harden({ ...evidence, status }),
     );
-    recordStatus(evidence.txHash, status);
+    publishStatus(evidence.txHash, status);
   };
 
+  /**
+   * Update the pending transaction status.
+   *
+   * @param {{sender: NobleAddress, amount: bigint}} keyParts
+   * @param {PendingTxStatus} status
+   */
+  function setPendingTxStatus({ sender, amount }, status) {
+    const key = makePendingTxKey(sender, amount);
+    pendingTxs.has(key) || Fail`no advancing tx with ${{ sender, amount }}`;
+    const pending = pendingTxs.get(key);
+    const ix = pending.findIndex(tx => tx.status === PendingTxStatus.Advancing);
+    ix >= 0 || Fail`no advancing tx with ${{ sender, amount }}`;
+    const [prefix, tx, suffix] = [
+      pending.slice(0, ix),
+      pending[ix],
+      pending.slice(ix + 1),
+    ];
+    const txpost = { ...tx, status };
+    pendingTxs.set(key, harden([...prefix, txpost, ...suffix]));
+    publishStatus(tx.txHash, status);
+  }
+
   return zone.exo(
     'Fast USDC Status Manager',
     M.interface('StatusManagerI', {
@@ -156,10 +185,13 @@ export const prepareStatusManager = (
     {
       /**
        * Add a new transaction with ADVANCING status
+       *
+       * NB: this acts like observe() but skips recording the OBSERVED state
+       *
        * @param {CctpTxEvidence} evidence
        */
       advance(evidence) {
-        recordPendingTx(evidence, PendingTxStatus.Advancing);
+        initPendingTx(evidence, PendingTxStatus.Advancing);
       },
 
       /**
@@ -171,24 +203,10 @@ export const prepareStatusManager = (
        * @throws {Error} if nothing to advance
        */
       advanceOutcome(sender, amount, success) {
-        const key = makePendingTxKey(sender, amount);
-        pendingTxs.has(key) || Fail`no advancing tx with ${{ sender, amount }}`;
-        const pending = pendingTxs.get(key);
-        const ix = pending.findIndex(
-          tx => tx.status === PendingTxStatus.Advancing,
+        setPendingTxStatus(
+          { sender, amount },
+          success ? PendingTxStatus.Advanced : PendingTxStatus.AdvanceFailed,
         );
-        ix >= 0 || Fail`no advancing tx with ${{ sender, amount }}`;
-        const [prefix, tx, suffix] = [
-          pending.slice(0, ix),
-          pending[ix],
-          pending.slice(ix + 1),
-        ];
-        const status = success
-          ? PendingTxStatus.Advanced
-          : PendingTxStatus.AdvanceFailed;
-        const txpost = { ...tx, status };
-        pendingTxs.set(key, harden([...prefix, txpost, ...suffix]));
-        recordStatus(tx.txHash, status);
       },
 
       /**
@@ -196,7 +214,7 @@ export const prepareStatusManager = (
        * @param {CctpTxEvidence} evidence
        */
       observe(evidence) {
-        recordPendingTx(evidence, PendingTxStatus.Observed);
+        initPendingTx(evidence, PendingTxStatus.Observed);
       },
 
       /**
@@ -247,7 +265,7 @@ export const prepareStatusManager = (
        * @param {EvmHash} txHash
        */
       disbursed(txHash) {
-        recordStatus(txHash, TxStatus.Disbursed);
+        publishStatus(txHash, TxStatus.Disbursed);
       },
 
       /**
@@ -259,7 +277,7 @@ export const prepareStatusManager = (
        */
       forwarded(txHash, address, amount) {
         if (txHash) {
-          recordStatus(txHash, TxStatus.Forwarded);
+          publishStatus(txHash, TxStatus.Forwarded);
         } else {
           // TODO store (early) `Minted` transactions to check against incoming evidence
           log(

package/src/fast-usdc.contract.js

@@ -95,8 +95,8 @@ export const contract = async (zcf, privateArgs, zone, tools) => {
     marshaller,
   );
 
-  const makeStatusNode = () => E(storageNode).makeChildNode(STATUS_NODE);
-  const statusManager = prepareStatusManager(zone, makeStatusNode);
+  const statusNode = E(storageNode).makeChildNode(STATUS_NODE);
+  const statusManager = prepareStatusManager(zone, statusNode);
 
   const { USDC } = terms.brands;
   const { withdrawToSeat } = tools.zoeTools;

package/src/types.ts

@@ -38,12 +38,6 @@ export interface PendingTx extends CctpTxEvidence {
   status: PendingTxStatus;
 }
 
-/** internal key for `StatusManager` exo */
-export type PendingTxKey = `pendingTx:${string}`;
-
-/** internal key for `StatusManager` exo */
-export type SeenTxKey = `seenTx:${string}`;
-
 export type FeeConfig = {
   flat: Amount<'nat'>;
   variableRate: Ratio;

package/src/util/agoric.js

@@ -5,7 +5,7 @@ export const queryFastUSDCLocalChainAccount = async (
   out = console,
 ) => {
   const agoricAddr = await vstorage.readLatest(
-    'published.fastUSDC.settlementAccount',
+    'published.fastUsdc.settlementAccount',
   );
   out.log(`Got Fast USDC Local Chain Account ${agoricAddr}`);
   return agoricAddr;