@agoric/fast-usdc 0.1.1-other-dev-3eb1a1d.0 → 0.2.0-u18.0

package/README.md

@@ -56,3 +56,46 @@ sequenceDiagram
 
     A->>TF: notify(evidence)
 ```
+
+# Status Manager
+
+### Pending Advance State Diagram
+
+*Transactions are qualified by the OCW and EventFeed before arriving to the Advancer.*
+
+```mermaid
+stateDiagram-v2
+  [*] --> Observed: observe()
+  [*] --> Advancing: advancing()
+
+  Advancing --> Advanced: advanceOutcome(...true)
+  Advancing --> AdvanceFailed: advanceOutcome(...false)
+
+  Observed --> [*]: dequeueStatus()
+  Advanced --> [*]: dequeueStatus()
+  AdvanceFailed --> [*]: dequeueStatus()
+
+  note right of [*]
+    After dequeueStatus():
+    Transaction is removed 
+    from pendingTxs store.
+    Settler will .disburse()
+    or .forward()
+  end note
+```
+
+### Complete state diagram (starting from Transaction Feed into Advancer)
+
+```mermaid
+stateDiagram-v2
+  Observed --> AdvanceSkipped : Risks identified
+  Observed --> Advancing : No risks, can advance
+  Observed --> Forwarding : No risks, Mint deposited before advance
+  Forwarding --> Forwarded
+  Advancing --> Advanced
+  Advanced --> Disbursed
+  AdvanceSkipped --> Forwarding : Mint deposited
+  AdvanceFailed --> Forwarding : Mint deposited
+  Advancing --> AdvanceFailed
+  Forwarding --> ForwardFailed
+```

package/package.json

@@ -1,11 +1,12 @@
 {
   "name": "@agoric/fast-usdc",
-  "version": "0.1.1-other-dev-3eb1a1d.0+3eb1a1d",
+  "version": "0.2.0-u18.0",
   "description": "CLI and library for Fast USDC product",
   "type": "module",
   "files": [
     "contract",
-    "src"
+    "src",
+    "tools"
   ],
   "bin": {
     "fast-usdc": "./src/cli/bin.js"
@@ -21,25 +22,26 @@
     "lint:eslint": "eslint ."
   },
   "devDependencies": {
-    "@agoric/swingset-liveslots": "0.10.3-other-dev-3eb1a1d.0+3eb1a1d",
-    "@agoric/vats": "0.15.2-other-dev-3eb1a1d.0+3eb1a1d",
-    "@agoric/zone": "0.2.3-other-dev-3eb1a1d.0+3eb1a1d",
+    "@agoric/swingset-liveslots": "^0.10.3-u18.1",
+    "@agoric/vats": "^0.16.0-u18.5",
+    "@agoric/zone": "^0.3.0-u18.1",
     "@fast-check/ava": "^2.0.1",
     "ava": "^5.3.0",
     "c8": "^10.1.2",
     "execa": "9.1.0",
-    "ts-blank-space": "^0.4.1"
+    "ts-blank-space": "^0.4.4"
   },
   "dependencies": {
-    "@agoric/client-utils": "0.1.1-other-dev-3eb1a1d.0+3eb1a1d",
-    "@agoric/ertp": "0.16.3-other-dev-3eb1a1d.0+3eb1a1d",
-    "@agoric/internal": "0.3.3-other-dev-3eb1a1d.0+3eb1a1d",
-    "@agoric/notifier": "0.6.3-other-dev-3eb1a1d.0+3eb1a1d",
-    "@agoric/orchestration": "0.1.1-other-dev-3eb1a1d.0+3eb1a1d",
-    "@agoric/store": "0.9.3-other-dev-3eb1a1d.0+3eb1a1d",
-    "@agoric/vat-data": "0.5.3-other-dev-3eb1a1d.0+3eb1a1d",
-    "@agoric/vow": "0.1.1-other-dev-3eb1a1d.0+3eb1a1d",
-    "@agoric/zoe": "0.26.3-other-dev-3eb1a1d.0+3eb1a1d",
+    "@agoric/client-utils": "^0.2.0-u18.0",
+    "@agoric/cosmic-proto": "^0.5.0-u18.5",
+    "@agoric/ertp": "^0.16.3-u18.1",
+    "@agoric/internal": "^0.4.0-u18.1",
+    "@agoric/notifier": "^0.7.0-u18.1",
+    "@agoric/orchestration": "^0.2.0-u18.5",
+    "@agoric/store": "^0.9.3-u18.1",
+    "@agoric/vat-data": "^0.5.3-u18.1",
+    "@agoric/vow": "^0.2.0-u18.1",
+    "@agoric/zoe": "^0.26.3-u18.1",
     "@cosmjs/proto-signing": "^0.32.4",
     "@cosmjs/stargate": "^0.32.4",
     "@endo/base64": "^1.0.9",
@@ -49,6 +51,7 @@
     "@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",
@@ -78,5 +81,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "3eb1a1d2d75b2b4a94807cd3bf759bc9fc531f05"
+  "gitHead": "f8c45b8a2e29a51522a81a6692af25b2d7f6b50f"
 }

package/src/cli/bridge-action.js

@@ -0,0 +1,40 @@
+import { boardSlottingMarshaller } from '@agoric/client-utils';
+
+/**
+ * @import {BridgeAction} from '@agoric/smart-wallet/src/smartWallet.js';
+ */
+
+const defaultMarshaller = boardSlottingMarshaller();
+
+/** @typedef {ReturnType<boardSlottingMarshaller>} BoardSlottingMarshaller */
+
+/**
+ * @param {BridgeAction} bridgeAction
+ * @param {Pick<import('stream').Writable,'write'>} stdout
+ * @param {BoardSlottingMarshaller} marshaller
+ */
+const outputAction = (bridgeAction, stdout, marshaller) => {
+  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
+ * @param {BoardSlottingMarshaller | undefined} marshaller
+ */
+export const outputActionAndHint = (
+  bridgeAction,
+  { stdout, stderr },
+  marshaller = defaultMarshaller,
+) => {
+  outputAction(bridgeAction, stdout, marshaller);
+  stderr.write(sendHint);
+};

package/src/cli/cli.js

@@ -1,9 +1,6 @@
-import { assertParsableNumber } from '@agoric/zoe/src/contractSupport/ratio.js';
-import {
-  Command,
-  InvalidArgumentError,
-  InvalidOptionArgumentError,
-} from 'commander';
+/* eslint-env node */
+/* global globalThis */
+import { Command } from 'commander';
 import { existsSync, mkdirSync, readFileSync } from 'fs';
 import { fileURLToPath } from 'url';
 import { dirname, resolve } from 'path';
@@ -12,9 +9,12 @@ 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';
+import { addLPCommands } from './lp-commands.js';
 
 const packageJson = JSON.parse(
   readFileSync(
@@ -32,6 +32,11 @@ export const initProgram = (
   writeFile = writeAsync,
   mkdir = mkdirSync,
   exists = existsSync,
+  fetch = globalThis.fetch,
+  stdout = process.stdout,
+  stderr = process.stderr,
+  env = process.env,
+  now = () => Date.now(),
 ) => {
   const program = new Command();
 
@@ -45,153 +50,36 @@ 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 = () =>
-    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);
-    });
-
-  /** @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;
+  const makeConfigFile = () => {
+    const getConfigPath = () => {
+      const { home: configDir } = program.opts();
+      return `${configDir}config.json`;
+    };
+    return makeFile(getConfigPath(), readFile, writeFile, mkdir, exists);
   };
 
-  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
-    });
+  program.addHelpText(
+    'afterAll',
+    `
+  Agoric test networks provide configuration info at, for example,
+
+  https://devnet.agoric.net/network-config
+
+  To use RPC endpoints from such a configuration, use:
+  export AGORIC_NET=devnet
+
+  Use AGORIC_NET=local or leave it unset to use localhost and chain id agoriclocal.
+  `,
+  );
+  addConfigCommands(program, configHelpers, makeConfigFile);
+  addOperatorCommands(program, {
+    fetch,
+    stdout,
+    stderr,
+    env,
+    now,
+  });
+  addLPCommands(program, { fetch, stdout, stderr, env, now });
 
   program
     .command('transfer')
@@ -203,7 +91,12 @@ export const initProgram = (
         /** @type {string} */ amount,
         /** @type {string} */ destination,
       ) => {
+        const start = now();
         await transferHelpers.transfer(makeConfigFile(), amount, destination);
+        const duration = now() - start;
+        stdout.write(
+          `Transfer finished in ${(duration / 1000).toFixed(1)} seconds`,
+        );
       },
     );
 

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

@@ -1,24 +1,32 @@
 import * as readline from 'node:readline/promises';
 import { stdin as input, stdout as output } from 'node:process';
 
+/**
+   @typedef {{
+    bech32Prefix: string,
+    api: string,
+    USDCDenom: string
+  }} DestinationChain
+ */
+
 /**
    @typedef {{
     nobleSeed: string,
     ethSeed: string,
     nobleToAgoricChannel: string,
-    agoricRpc: string,
     nobleApi: string,
     nobleRpc: string,
     ethRpc: string,
     tokenMessengerAddress: string,
     tokenAddress: string
+    destinationChains?: DestinationChain[]
   }} 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 +60,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 +91,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 +105,3 @@ const show = async (/** @type {file} */ configFile, out = console) => {
   out.log(`Config found at ${configFile.path}:`);
   out.log(contents);
 };
-
-export default { init, update, show };