@agoric/fast-usdc 0.1.1-dev-23120a9.0 → 0.1.1-dev-419df4e.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@agoric/fast-usdc",
-  "version": "0.1.1-dev-23120a9.0+23120a9",
+  "version": "0.1.1-dev-419df4e.0+419df4e",
   "description": "CLI and library for Fast USDC product",
   "type": "module",
   "files": [
@@ -21,9 +21,9 @@
     "lint:eslint": "eslint ."
   },
   "devDependencies": {
-    "@agoric/swingset-liveslots": "0.10.3-dev-23120a9.0+23120a9",
-    "@agoric/vats": "0.15.2-dev-23120a9.0+23120a9",
-    "@agoric/zone": "0.2.3-dev-23120a9.0+23120a9",
+    "@agoric/swingset-liveslots": "0.10.3-dev-419df4e.0+419df4e",
+    "@agoric/vats": "0.15.2-dev-419df4e.0+419df4e",
+    "@agoric/zone": "0.2.3-dev-419df4e.0+419df4e",
     "@fast-check/ava": "^2.0.1",
     "ava": "^5.3.0",
     "c8": "^10.1.2",
@@ -31,15 +31,15 @@
     "ts-blank-space": "^0.4.1"
   },
   "dependencies": {
-    "@agoric/client-utils": "0.1.1-dev-23120a9.0+23120a9",
-    "@agoric/ertp": "0.16.3-dev-23120a9.0+23120a9",
-    "@agoric/internal": "0.3.3-dev-23120a9.0+23120a9",
-    "@agoric/notifier": "0.6.3-dev-23120a9.0+23120a9",
-    "@agoric/orchestration": "0.1.1-dev-23120a9.0+23120a9",
-    "@agoric/store": "0.9.3-dev-23120a9.0+23120a9",
-    "@agoric/vat-data": "0.5.3-dev-23120a9.0+23120a9",
-    "@agoric/vow": "0.1.1-dev-23120a9.0+23120a9",
-    "@agoric/zoe": "0.26.3-dev-23120a9.0+23120a9",
+    "@agoric/client-utils": "0.1.1-dev-419df4e.0+419df4e",
+    "@agoric/ertp": "0.16.3-dev-419df4e.0+419df4e",
+    "@agoric/internal": "0.3.3-dev-419df4e.0+419df4e",
+    "@agoric/notifier": "0.6.3-dev-419df4e.0+419df4e",
+    "@agoric/orchestration": "0.1.1-dev-419df4e.0+419df4e",
+    "@agoric/store": "0.9.3-dev-419df4e.0+419df4e",
+    "@agoric/vat-data": "0.5.3-dev-419df4e.0+419df4e",
+    "@agoric/vow": "0.1.1-dev-419df4e.0+419df4e",
+    "@agoric/zoe": "0.26.3-dev-419df4e.0+419df4e",
     "@cosmjs/proto-signing": "^0.32.4",
     "@cosmjs/stargate": "^0.32.4",
     "@endo/base64": "^1.0.9",
@@ -78,5 +78,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "23120a923c2bd3ca182291df2080214fbd5f20ca"
+  "gitHead": "419df4ee7ce03499f30e7327c74e95a338201023"
 }

package/src/cli/bridge-action.js

@@ -0,0 +1,32 @@
+import { boardSlottingMarshaller } from '@agoric/client-utils';
+
+/**
+ * @import {BridgeAction} from '@agoric/smart-wallet/src/smartWallet.js';
+ */
+
+const marshaller = boardSlottingMarshaller();
+
+/**
+ * @param {BridgeAction} bridgeAction
+ * @param {Pick<import('stream').Writable,'write'>} stdout
+ */
+const outputAction = (bridgeAction, stdout) => {
+  const capData = marshaller.toCapData(harden(bridgeAction));
+  stdout.write(JSON.stringify(capData));
+  stdout.write('\n');
+};
+
+export const sendHint =
+  'Now use `agoric wallet send ...` to sign and broadcast the offer.\n';
+
+/**
+ * @param {BridgeAction} bridgeAction
+ * @param {{
+ *   stdout: Pick<import('stream').Writable,'write'>,
+ *   stderr: Pick<import('stream').Writable,'write'>,
+ * }} io
+ */
+export const outputActionAndHint = (bridgeAction, { stdout, stderr }) => {
+  outputAction(bridgeAction, stdout);
+  stderr.write(sendHint);
+};

package/src/cli/cli.js

@@ -12,7 +12,9 @@ import {
   readFile as readAsync,
   writeFile as writeAsync,
 } from 'node:fs/promises';
-import configLib from './config.js';
+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';
 
@@ -45,108 +47,16 @@ export const initProgram = (
       `${defaultHome}/.fast-usdc/`,
     );
 
-  const config = program.command('config').description('Manage config');
-
-  const configFilename = 'config.json';
-  const getConfigPath = () => {
-    const { home: configDir } = program.opts();
-    return configDir + configFilename;
+  const makeConfigFile = () => {
+    const getConfigPath = () => {
+      const { home: configDir } = program.opts();
+      return `${configDir}config.json`;
+    };
+    return makeFile(getConfigPath(), readFile, writeFile, mkdir, exists);
   };
 
-  const makeConfigFile = () =>
-    makeFile(getConfigPath(), readFile, writeFile, mkdir, exists);
-
-  config
-    .command('show')
-    .description('Show current config')
-    .action(async () => {
-      await configHelpers.show(makeConfigFile());
-    });
-
-  config
-    .command('init')
-    .description('Set initial config values')
-    .requiredOption(
-      '--noble-seed <seed>',
-      'Seed phrase for Noble account. CAUTION: Stored unencrypted in file system',
-    )
-    .requiredOption(
-      '--eth-seed <seed>',
-      'Seed phrase for Ethereum account. CAUTION: Stored unencrypted in file system',
-    )
-    .requiredOption(
-      '--agoric-seed <seed>',
-      'Seed phrase for Agoric LP account. CAUTION: Stored unencrypted in file system',
-    )
-    .option(
-      '--agoric-rpc [url]',
-      'Agoric RPC endpoint',
-      'http://127.0.0.1:26656',
-    )
-    .option(
-      '--agoric-api [url]',
-      'Agoric RPC endpoint',
-      'http://127.0.0.1:1317',
-    )
-    .option('--noble-rpc [url]', 'Noble RPC endpoint', 'http://127.0.0.1:26657')
-    .option('--noble-api [url]', 'Noble API endpoint', 'http://127.0.0.1:1318')
-    .option('--eth-rpc [url]', 'Ethereum RPC Endpoint', 'http://127.0.0.1:8545')
-    .option(
-      '--noble-to-agoric-channel [channel]',
-      'Channel ID on Noble for Agoric',
-      'channel-21',
-    )
-    .option(
-      '--token-messenger-address [address]',
-      'Address of TokenMessenger contract',
-      // Default to ETH mainnet contract address. For ETH sepolia, use 0x9f3B8679c73C2Fef8b59B4f3444d4e156fb70AA5
-      '0xbd3fa81b58ba92a82136038b25adec7066af3155',
-    )
-    .option(
-      '--token-contract-address [address]',
-      'Address of USDC token contract',
-      // Detault to ETH mainnet token address. For ETH sepolia, use 0x1c7D4B196Cb0C7B01d743Fbc6116a902379C7238
-      '0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48',
-    )
-    .action(async options => {
-      await configHelpers.init(makeConfigFile(), options);
-    });
-
-  config
-    .command('update')
-    .description('Update config values')
-    .option(
-      '--noble-seed [string]',
-      'Seed phrase for Noble account. CAUTION: Stored unencrypted in file system',
-    )
-    .option(
-      '--eth-seed [string]',
-      'Seed phrase for Ethereum account. CAUTION: Stored unencrypted in file system',
-    )
-    .option(
-      '--agoric-seed <seed>',
-      'Seed phrase for Agoric LP account. CAUTION: Stored unencrypted in file system',
-    )
-    .option('--agoric-rpc [url]', 'Agoric RPC endpoint')
-    .option('--agoric-api [url]', 'Agoric API endpoint')
-    .option('--noble-rpc [url]', 'Noble RPC endpoint')
-    .option('--noble-api [url]', 'Noble API endpoint')
-    .option('--eth-rpc [url]', 'Ethereum RPC Endpoint')
-    .option(
-      '--noble-to-agoric-channel [channel]',
-      'Channel ID on Noble for Agoric',
-    )
-    .option(
-      '--token-messenger-address [address]',
-      'Address of TokenMessenger contract',
-    )
-    .option(
-      '--token-contract-address [address]',
-      'Address of USDC token contract',
-    )
-    .action(async options => {
-      await configHelpers.update(makeConfigFile(), options);
-    });
+  addConfigCommands(program, configHelpers, makeConfigFile);
+  addOperatorCommands(program);
 
   /** @param {string} value */
   const parseDecimal = value => {

package/src/cli/config-commands.js

@@ -0,0 +1,108 @@
+/**
+ * @import {Command} from 'commander';
+ * @import {File} from '../util/file.js';
+ * @import * as ConfigHelpers from './config.js';
+ */
+/**
+ *
+ * @param {Command} program
+ * @param {ConfigHelpers} configHelpers
+ * @param {() => File} makeConfigFile
+ */
+export const addConfigCommands = (program, configHelpers, makeConfigFile) => {
+  const config = program.command('config').description('Manage config');
+
+  config
+    .command('show')
+    .description('Show current config')
+    .action(async () => {
+      await configHelpers.show(makeConfigFile());
+    });
+
+  config
+    .command('init')
+    .description('Set initial config values')
+    .requiredOption(
+      '--noble-seed <seed>',
+      'Seed phrase for Noble account. CAUTION: Stored unencrypted in file system',
+    )
+    .requiredOption(
+      '--eth-seed <seed>',
+      'Seed phrase for Ethereum account. CAUTION: Stored unencrypted in file system',
+    )
+    .requiredOption(
+      '--agoric-seed <seed>',
+      'Seed phrase for Agoric LP account. CAUTION: Stored unencrypted in file system',
+    )
+    .option(
+      '--agoric-rpc [url]',
+      'Agoric RPC endpoint',
+      'http://127.0.0.1:26656',
+    )
+    .option(
+      '--agoric-api [url]',
+      'Agoric RPC endpoint',
+      'http://127.0.0.1:1317',
+    )
+    .option('--noble-rpc [url]', 'Noble RPC endpoint', 'http://127.0.0.1:26657')
+    .option('--noble-api [url]', 'Noble API endpoint', 'http://127.0.0.1:1318')
+    .option('--eth-rpc [url]', 'Ethereum RPC Endpoint', 'http://127.0.0.1:8545')
+    .option(
+      '--noble-to-agoric-channel [channel]',
+      'Channel ID on Noble for Agoric',
+      'channel-21',
+    )
+    .option(
+      '--token-messenger-address [address]',
+      'Address of TokenMessenger contract',
+      // Default to ETH mainnet contract address. For ETH sepolia, use 0x9f3B8679c73C2Fef8b59B4f3444d4e156fb70AA5
+      '0xbd3fa81b58ba92a82136038b25adec7066af3155',
+    )
+    .option(
+      '--token-contract-address [address]',
+      'Address of USDC token contract',
+      // Detault to ETH mainnet token address. For ETH sepolia, use 0x1c7D4B196Cb0C7B01d743Fbc6116a902379C7238
+      '0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48',
+    )
+    .action(async options => {
+      await configHelpers.init(makeConfigFile(), options);
+    });
+
+  config
+    .command('update')
+    .description('Update config values')
+    .option(
+      '--noble-seed [string]',
+      'Seed phrase for Noble account. CAUTION: Stored unencrypted in file system',
+    )
+    .option(
+      '--eth-seed [string]',
+      'Seed phrase for Ethereum account. CAUTION: Stored unencrypted in file system',
+    )
+    .option(
+      '--agoric-seed <seed>',
+      'Seed phrase for Agoric LP account. CAUTION: Stored unencrypted in file system',
+    )
+    .option('--agoric-rpc [url]', 'Agoric RPC endpoint')
+    .option('--agoric-api [url]', 'Agoric API endpoint')
+    .option('--noble-rpc [url]', 'Noble RPC endpoint')
+    .option('--noble-api [url]', 'Noble API endpoint')
+    .option('--eth-rpc [url]', 'Ethereum RPC Endpoint')
+    .option(
+      '--noble-to-agoric-channel [channel]',
+      'Channel ID on Noble for Agoric',
+    )
+    .option(
+      '--token-messenger-address [address]',
+      'Address of TokenMessenger contract',
+    )
+    .option(
+      '--token-contract-address [address]',
+      'Address of USDC token contract',
+    )
+    .action(async options => {
+      await configHelpers.update(makeConfigFile(), options);
+    });
+
+  return config;
+};

package/src/cli/config.js

@@ -15,10 +15,10 @@ import { stdin as input, stdout as output } from 'node:process';
   }} ConfigOpts
  */
 
-/** @import { file } from '../util/file' */
+/** @import { File } from '../util/file' */
 
-const init = async (
-  /** @type {file} */ configFile,
+export const init = async (
+  /** @type {File} */ configFile,
   /** @type {ConfigOpts} */ options,
   out = console,
   rl = readline.createInterface({ input, output }),
@@ -52,8 +52,8 @@ const init = async (
   await writeConfig();
 };
 
-const update = async (
-  /** @type {file} */ configFile,
+export const update = async (
+  /** @type {File} */ configFile,
   /** @type {Partial<ConfigOpts>} */ options,
   out = console,
 ) => {
@@ -83,7 +83,7 @@ const update = async (
   await updateConfig({ ...JSON.parse(file), ...options });
 };
 
-const show = async (/** @type {file} */ configFile, out = console) => {
+export const show = async (/** @type {File} */ configFile, out = console) => {
   let contents;
   await null;
   try {
@@ -97,5 +97,3 @@ const show = async (/** @type {file} */ configFile, out = console) => {
   out.log(`Config found at ${configFile.path}:`);
   out.log(contents);
 };
-
-export default { init, update, show };

package/src/cli/operator-commands.js

@@ -0,0 +1,78 @@
+/* eslint-env node */
+/**
+ * @import {Command} from 'commander';
+ * @import {OfferSpec} from '@agoric/smart-wallet/src/offers.js';
+ * @import {ExecuteOfferAction} from '@agoric/smart-wallet/src/smartWallet.js';
+ */
+
+import { fetchEnvNetworkConfig, makeVstorageKit } from '@agoric/client-utils';
+import { INVITATION_MAKERS_DESC } from '../exos/transaction-feed.js';
+import { outputActionAndHint } from './bridge-action.js';
+
+/**
+ * @param {Command} program
+ */
+export const addOperatorCommands = program => {
+  const operator = program
+    .command('operator')
+    .description('Oracle operator commands');
+
+  operator
+    .command('accept')
+    .description('Accept invitation to be an operator')
+    .addHelpText(
+      'after',
+      '\nPipe the STDOUT to a file such as accept.json, then use the Agoric CLI to broadcast it:\n  agoric wallet send --offer accept.json --from gov1 --keyring-backend="test"',
+    )
+    .option(
+      '--offerId <string>',
+      'Offer id',
+      String,
+      `operatorAccept-${Date.now()}`,
+    )
+    .action(async opts => {
+      const networkConfig = await fetchEnvNetworkConfig({
+        env: process.env,
+        fetch,
+      });
+      const vsk = await makeVstorageKit({ fetch }, networkConfig);
+      const instance = vsk.agoricNames.instance.fastUsdc;
+      assert(instance, 'fastUsdc instance not in agoricNames');
+
+      /** @type {OfferSpec} */
+      const offer = {
+        id: opts.offerId,
+        invitationSpec: {
+          source: 'purse',
+          instance,
+          description: INVITATION_MAKERS_DESC,
+        },
+        proposal: {},
+      };
+
+      /** @type {ExecuteOfferAction} */
+      const bridgeAction = {
+        method: 'executeOffer',
+        offer,
+      };
+
+      outputActionAndHint(bridgeAction, {
+        stderr: process.stderr,
+        stdout: process.stdout,
+      });
+    });
+
+  operator
+    .command('attest')
+    .description('Attest to an observed Fast USDC transfer')
+    .requiredOption('--previousOfferId <string>', 'Offer id', String)
+    .action(async options => {
+      const { previousOfferId } = options;
+      console.error(
+        'TODO: Implement attest logic for request:',
+        previousOfferId,
+      );
+    });
+
+  return operator;
+};

package/src/cli/transfer.js

@@ -9,13 +9,13 @@ import {
 } from '../util/noble.js';
 import { queryFastUSDCLocalChainAccount } from '../util/agoric.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' */
 
 const transfer = async (
-  /** @type {file} */ configFile,
+  /** @type {File} */ configFile,
   /** @type {string} */ amount,
   /** @type {string} */ destination,
   out = console,

package/src/exos/settler.js

@@ -221,7 +221,7 @@ export const prepareSettler = (
           repayer.repay(settlingSeat, split);
 
           // update status manager, marking tx `SETTLED`
-          statusManager.disbursed(txHash, sender, amount);
+          statusManager.disbursed(txHash);
         },
         /**
          * @param {EvmHash | undefined} txHash
@@ -248,7 +248,7 @@ export const prepareSettler = (
       },
       transferHandler: {
         /**
-         * @param {unknown} result
+         * @param {unknown} _result
          * @param {SettlerTransferCtx} ctx
          *
          * @typedef {{
@@ -257,7 +257,7 @@ export const prepareSettler = (
          *   amount: NatValue;
          * }} SettlerTransferCtx
          */
-        onFulfilled(result, ctx) {
+        onFulfilled(_result, ctx) {
           const { txHash, sender, amount } = ctx;
           statusManager.forwarded(txHash, sender, amount);
         },

package/src/exos/status-manager.js

@@ -1,18 +1,19 @@
 import { M } from '@endo/patterns';
 import { Fail, makeError, q } from '@endo/errors';
-
 import { appendToStoredArray } from '@agoric/store/src/stores/store-utils.js';
+import { E } from '@endo/eventual-send';
+import { makeTracer } from '@agoric/internal';
 import {
   CctpTxEvidenceShape,
   EvmHashShape,
   PendingTxShape,
 } from '../type-guards.js';
-import { PendingTxStatus } from '../constants.js';
+import { PendingTxStatus, TxStatus } from '../constants.js';
 
 /**
  * @import {MapStore, SetStore} from '@agoric/store';
  * @import {Zone} from '@agoric/zone';
- * @import {CctpTxEvidence, NobleAddress, SeenTxKey, PendingTxKey, PendingTx, EvmHash} from '../types.js';
+ * @import {CctpTxEvidence, NobleAddress, SeenTxKey, PendingTxKey, PendingTx, EvmHash, LogFn} from '../types.js';
  */
 
 /**
@@ -53,6 +54,12 @@ const seenTxKeyOf = evidence => {
   return `seenTx:${JSON.stringify([txHash, chainId])}`;
 };
 
+/**
+ * @typedef {{
+ *  log?: LogFn;
+ * }} StatusManagerPowers
+ */
+
 /**
  * The `StatusManager` keeps track of Pending and Seen Transactions
  * via {@link PendingTxStatus} states, aiding in coordination between the `Advancer`
@@ -61,8 +68,16 @@ const seenTxKeyOf = evidence => {
  * XXX consider separate facets for `Advancing` and `Settling` capabilities.
  *
  * @param {Zone} zone
+ * @param {() => Promise<StorageNode>} makeStatusNode
+ * @param {StatusManagerPowers} caps
  */
-export const prepareStatusManager = zone => {
+export const prepareStatusManager = (
+  zone,
+  makeStatusNode,
+  {
+    log = makeTracer('Advancer', true),
+  } = /** @type {StatusManagerPowers} */ ({}),
+) => {
   /** @type {MapStore<PendingTxKey, PendingTx[]>} */
   const pendingTxs = zone.mapStore('PendingTxs', {
     keyShape: M.string(),
@@ -74,6 +89,17 @@ export const prepareStatusManager = zone => {
     keyShape: M.string(),
   });
 
+  /**
+   * @param {CctpTxEvidence['txHash']} hash
+   * @param {TxStatus} status
+   */
+  const recordStatus = (hash, status) => {
+    const statusNodeP = makeStatusNode();
+    const txnNodeP = E(statusNodeP).makeChildNode(hash);
+    // Don't await, just writing to vstorage.
+    void E(txnNodeP).setValue(status);
+  };
+
   /**
    * Ensures that `txHash+chainId` has not been processed
    * and adds entry to `seenTxs` set.
@@ -95,6 +121,7 @@ export const prepareStatusManager = zone => {
       pendingTxKeyOf(evidence),
       harden({ ...evidence, status }),
     );
+    recordStatus(evidence.txHash, status);
   };
 
   return zone.exo(
@@ -118,9 +145,7 @@ export const prepareStatusManager = zone => {
           M.undefined(),
         ),
       ),
-      disbursed: M.call(EvmHashShape, M.string(), M.nat()).returns(
-        M.undefined(),
-      ),
+      disbursed: M.call(EvmHashShape).returns(M.undefined()),
       forwarded: M.call(M.opt(EvmHashShape), M.string(), M.nat()).returns(
         M.undefined(),
       ),
@@ -163,6 +188,7 @@ export const prepareStatusManager = zone => {
           : PendingTxStatus.AdvanceFailed;
         const txpost = { ...tx, status };
         pendingTxs.set(key, harden([...prefix, txpost, ...suffix]));
+        recordStatus(tx.txHash, status);
       },
 
       /**
@@ -219,12 +245,9 @@ export const prepareStatusManager = zone => {
        * Mark a transaction as `DISBURSED`
        *
        * @param {EvmHash} txHash
-       * @param {NobleAddress} address
-       * @param {bigint} amount
        */
-      disbursed(txHash, address, amount) {
-        // TODO: store txHash -> evidence for txs pending settlement?
-        console.log('TODO: vstorage update', { txHash, address, amount });
+      disbursed(txHash) {
+        recordStatus(txHash, TxStatus.Disbursed);
       },
 
       /**
@@ -235,8 +258,14 @@ export const prepareStatusManager = zone => {
        * @param {bigint} amount
        */
       forwarded(txHash, address, amount) {
-        // TODO: store txHash -> evidence for txs pending settlement?
-        console.log('TODO: vstorage update', { txHash, address, amount });
+        if (txHash) {
+          recordStatus(txHash, TxStatus.Forwarded);
+        } else {
+          // TODO store (early) `Minted` transactions to check against incoming evidence
+          log(
+            `⚠️ Forwarded minted amount ${amount} from account ${address} before it was observed.`,
+          );
+        }
       },
 
       /**

package/src/fast-usdc.contract.js

@@ -29,6 +29,8 @@ import * as flows from './fast-usdc.flows.js';
 
 const trace = makeTracer('FastUsdc');
 
+const STATUS_NODE = 'status';
+
 /**
  * @import {HostInterface} from '@agoric/async-flow';
  * @import {CosmosChainInfo, Denom, DenomDetail, OrchestrationAccount} from '@agoric/orchestration';
@@ -84,7 +86,9 @@ export const contract = async (zcf, privateArgs, zone, tools) => {
     marshaller,
   );
 
-  const statusManager = prepareStatusManager(zone);
+  const makeStatusNode = () =>
+    E(privateArgs.storageNode).makeChildNode(STATUS_NODE);
+  const statusManager = prepareStatusManager(zone, makeStatusNode);
 
   const { USDC } = terms.brands;
   const { withdrawToSeat } = tools.zoeTools;

package/src/util/file.js

@@ -27,4 +27,4 @@ export const makeFile = (
   return { read, write, exists, path };
 };
 
-/** @typedef {ReturnType<typeof makeFile>} file */
+/** @typedef {ReturnType<typeof makeFile>} File */