FU oracle operator CLI (#10570)

refs: #10567 ## Description This sets up a CLI for transaction oracle operators. It has tests but I don't expect them to pass yet. I think this is worth landing to get the CLI scaffolded and the refactorings of agoric-cli to client-utils that support it. In particular moving the `AGORIC_NET` convention down to `client-utils` in a cli.js module and other network config helpers in network-config.js. It will also help to DRY out the 'test-lib' code in a3p proposals that was copied from agoric-cli (e.g. `rpc.js`) cc @anilhelvaci ### Security Considerations agoric-cli will source its network config lookup function from another package. That's a potential supply chain weakness but it's the same org as the agoric-cli and it's very unlikely only one would be compromised if either were. ### Scaling Considerations none ### Documentation Considerations Includes CLI help and a demonstration test ### Testing Considerations I added a test that runs in CI but doesn't cause a failure so that this can live in master while we build it out ### Upgrade Considerations none
Agoric · Nov 27, 2024 · a2e9363 · a2e9363
2 parents 23120a9 + 18a8219
commit a2e9363
Show file tree

Hide file tree

Showing 42 changed files with 379 additions and 205 deletions.
diff --git a/a3p-integration/package.json b/a3p-integration/package.json
@@ -19,6 +19,6 @@
     "@agoric/synthetic-chain": "^0.4.3",
     "@types/better-sqlite3": "^7.6.11"
   },
-  "packageManager": "[email protected].1",
+  "packageManager": "[email protected].3",
   "license": "Apache-2.0"
 }
diff --git a/a3p-integration/proposals/f:fast-usdc/package.json b/a3p-integration/proposals/f:fast-usdc/package.json
@@ -26,5 +26,5 @@
   "scripts": {
     "agops": "yarn --cwd /usr/src/agoric-sdk/ --silent agops"
   },
-  "packageManager": "yarn@4.2.2"
+  "packageManager": "yarn@4.5.3"
 }
diff --git a/a3p-integration/proposals/f:fast-usdc/test-cli.sh b/a3p-integration/proposals/f:fast-usdc/test-cli.sh
@@ -0,0 +1,15 @@
+#!/bin/bash
+
+# FIXME these commands are run against the `@agoric/fast-usdc` pulled from NPM
+# but should be run against the local SDK. The `yarn link` command described in
+# a3p-integration/README.md is supposed to make that work but it's not working.
+
+yarn @agoric/fast-usdc operator accept >| accept.json
+cat accept.json
+yarn agoric wallet send --offer accept.json --from gov1 --keyring-backend="test"
+ACCEPT_OFFER_ID=$(agoric wallet extract-id --offer accept.json)
+
+# FIXME attest something
+yarn @agoric/fast-usdc operator attest --previousOfferId "$ACCEPT_OFFER_ID" >| attest.json
+cat attest.json
+yarn agoric wallet send --offer attest.json --from gov1 --keyring-backend="test"
diff --git a/a3p-integration/proposals/f:fast-usdc/test.sh b/a3p-integration/proposals/f:fast-usdc/test.sh
@@ -1,2 +1,5 @@
 #!/bin/bash
 yarn ava
+
+# TODO get CLI test passing and part of CI
+./test-cli.sh || echo "CLI test failed"
diff --git a/a3p-integration/proposals/f:fast-usdc/yarn.lock b/a3p-integration/proposals/f:fast-usdc/yarn.lock
@@ -4140,11 +4140,11 @@ __metadata:
 
 "typescript@patch:typescript@npm%3A5.1.6 - 5.6.x#optional!builtin<compat/typescript>":
   version: 5.6.3
-  resolution: "typescript@patch:typescript@npm%3A5.6.3#optional!builtin<compat/typescript>::version=5.6.3&hash=b45daf"
+  resolution: "typescript@patch:typescript@npm%3A5.6.3#optional!builtin<compat/typescript>::version=5.6.3&hash=8c6c40"
   bin:
     tsc: bin/tsc
     tsserver: bin/tsserver
-  checksum: 10c0/ac8307bb06bbfd08ae7137da740769b7d8c3ee5943188743bb622c621f8ad61d244767480f90fbd840277fbf152d8932aa20c33f867dea1bb5e79b187ca1a92f
+  checksum: 10c0/7c9d2e07c81226d60435939618c91ec2ff0b75fbfa106eec3430f0fcf93a584bc6c73176676f532d78c3594fe28a54b36eb40b3d75593071a7ec91301533ace7
   languageName: node
   linkType: hard
 

diff --git a/a3p-integration/proposals/n:upgrade-next/package.json b/a3p-integration/proposals/n:upgrade-next/package.json
@@ -29,7 +29,7 @@
   "scripts": {
     "agops": "yarn --cwd /usr/src/agoric-sdk/ --silent agops"
   },
-  "packageManager": "[email protected].1",
+  "packageManager": "[email protected].3",
   "devDependencies": {
     "eslint": "^8.57.0",
     "npm-run-all": "^4.1.5",

diff --git a/a3p-integration/proposals/p:upgrade-19/package.json b/a3p-integration/proposals/p:upgrade-19/package.json
@@ -29,7 +29,7 @@
   "scripts": {
     "agops": "yarn --cwd /usr/src/agoric-sdk/ --silent agops"
   },
-  "packageManager": "yarn@4.2.2",
+  "packageManager": "yarn@4.5.3",
   "devDependencies": {
     "eslint": "^8.57.0",
     "npm-run-all": "^4.1.5",

diff --git a/a3p-integration/proposals/p:upgrade-19/yarn.lock b/a3p-integration/proposals/p:upgrade-19/yarn.lock
@@ -5899,11 +5899,11 @@ __metadata:
 
 "typescript@patch:typescript@npm%3A5.1.6 - 5.6.x#optional!builtin<compat/typescript>, typescript@patch:typescript@npm%3A^5.6.3#optional!builtin<compat/typescript>":
   version: 5.6.3
-  resolution: "typescript@patch:typescript@npm%3A5.6.3#optional!builtin<compat/typescript>::version=5.6.3&hash=b45daf"
+  resolution: "typescript@patch:typescript@npm%3A5.6.3#optional!builtin<compat/typescript>::version=5.6.3&hash=8c6c40"
   bin:
     tsc: bin/tsc
     tsserver: bin/tsserver
-  checksum: 10c0/ac8307bb06bbfd08ae7137da740769b7d8c3ee5943188743bb622c621f8ad61d244767480f90fbd840277fbf152d8932aa20c33f867dea1bb5e79b187ca1a92f
+  checksum: 10c0/7c9d2e07c81226d60435939618c91ec2ff0b75fbfa106eec3430f0fcf93a584bc6c73176676f532d78c3594fe28a54b36eb40b3d75593071a7ec91301533ace7
   languageName: node
   linkType: hard
 

diff --git a/a3p-integration/proposals/s:stake-bld/package.json b/a3p-integration/proposals/s:stake-bld/package.json
@@ -23,7 +23,7 @@
   "ava": {
     "concurrency": 1
   },
-  "packageManager": "[email protected].1",
+  "packageManager": "[email protected].3",
   "devDependencies": {
     "@types/node": "^22.0.0"
   }

diff --git a/a3p-integration/proposals/z:acceptance/package.json b/a3p-integration/proposals/z:acceptance/package.json
@@ -90,7 +90,7 @@
   "scripts": {
     "agops": "yarn --cwd /usr/src/agoric-sdk/ --silent agops"
   },
-  "packageManager": "[email protected].1",
+  "packageManager": "[email protected].3",
   "devDependencies": {
     "eslint": "^8.57.0",
     "npm-run-all": "^4.1.5",

diff --git a/multichain-testing/package.json b/multichain-testing/package.json
@@ -17,7 +17,7 @@
     "starship:stop": "make stop",
     "postinstall": "patch-package"
   },
-  "packageManager": "yarn@4.1.1",
+  "packageManager": "yarn@4.5.3",
   "devDependencies": {
     "@agoric/cosmic-proto": "0.4.1-dev-08f8549.0",
     "@cosmjs/crypto": "^0.32.4",

diff --git a/packages/agoric-cli/src/commands/auction.js b/packages/agoric-cli/src/commands/auction.js
@@ -1,17 +1,16 @@
 // @ts-check
 /* eslint-env node */
-import { InvalidArgumentError } from 'commander';
+import { fetchEnvNetworkConfig, makeVstorageKit } from '@agoric/client-utils';
 import { Fail } from '@endo/errors';
-import { makeVstorageKit } from '@agoric/client-utils';
+import { InvalidArgumentError } from 'commander';
 import { outputActionAndHint } from '../lib/wallet.js';
-import { getNetworkConfig } from '../lib/network-config.js';
 
 /**
  * @import {ParamTypesMap, ParamTypesMapFromRecord} from '@agoric/governance/src/contractGovernance/typedParamManager.js'
  * @import {ParamValueForType} from '@agoric/governance/src/types.js'
  */
 
-const networkConfig = await getNetworkConfig({ env: process.env, fetch });
+const networkConfig = await fetchEnvNetworkConfig({ env: process.env, fetch });
 
 /**
  * @template {ParamTypesMap} M

diff --git a/packages/agoric-cli/src/commands/gov.js b/packages/agoric-cli/src/commands/gov.js
@@ -1,11 +1,10 @@
 // @ts-check
 /* eslint-disable func-names */
 /* eslint-env node */
-import { makeVstorageKit } from '@agoric/client-utils';
+import { fetchEnvNetworkConfig, makeVstorageKit } from '@agoric/client-utils';
 import { execFileSync as execFileSyncAmbient } from 'child_process';
 import { Command, CommanderError } from 'commander';
 import { normalizeAddressWithOptions, pollBlocks } from '../lib/chain.js';
-import { getNetworkConfig } from '../lib/network-config.js';
 import {
   findContinuingIds,
   getCurrent,
@@ -26,7 +25,7 @@ const collectValues = (val, memo) => {
 
 const defaultKeyring = process.env.AGORIC_KEYRING_BACKEND || 'test';
 
-const networkConfig = await getNetworkConfig({ env: process.env, fetch });
+const networkConfig = await fetchEnvNetworkConfig({ env: process.env, fetch });
 
 /**
  * @param {import('anylogger').Logger} _logger

diff --git a/packages/agoric-cli/src/commands/inter.js b/packages/agoric-cli/src/commands/inter.js
@@ -4,20 +4,19 @@
  */
 
 // @ts-check
-import { makeWalletUtils } from '@agoric/client-utils';
+import { fetchEnvNetworkConfig, makeWalletUtils } from '@agoric/client-utils';
 import { makeOfferSpecShape } from '@agoric/inter-protocol/src/auction/auctionBook.js';
 import { Offers } from '@agoric/inter-protocol/src/clientSupport.js';
 import { objectMap } from '@agoric/internal';
 import { M, matches } from '@endo/patterns';
 import { CommanderError, InvalidArgumentError } from 'commander';
 import { normalizeAddressWithOptions, pollBlocks } from '../lib/chain.js';
-import { getCurrent, outputActionAndHint, sendAction } from '../lib/wallet.js';
 import {
   asBoardRemote,
   bigintReplacer,
   makeAmountFormatter,
 } from '../lib/format.js';
-import { getNetworkConfig } from '../lib/network-config.js';
+import { getCurrent, outputActionAndHint, sendAction } from '../lib/wallet.js';
 
 const { values } = Object;
 
@@ -232,7 +231,7 @@ export const makeInterCommand = (
     try {
       // XXX pass fetch to getNetworkConfig() explicitly
       // await null above makes this await safe
-      const networkConfig = await getNetworkConfig({ env, fetch });
+      const networkConfig = await fetchEnvNetworkConfig({ env, fetch });
       return makeWalletUtils({ fetch, delay }, networkConfig);
     } catch (err) {
       // CommanderError is a class constructor, and so

diff --git a/packages/agoric-cli/src/commands/oracle.js b/packages/agoric-cli/src/commands/oracle.js
@@ -2,6 +2,7 @@
 /* eslint-disable func-names */
 /* eslint-env node */
 import {
+  fetchEnvNetworkConfig,
   makeVstorageKit,
   makeWalletUtils,
   storageHelper,
@@ -14,14 +15,13 @@ import * as cp from 'child_process';
 import { Command } from 'commander';
 import { inspect } from 'util';
 import { normalizeAddressWithOptions } from '../lib/chain.js';
-import { getNetworkConfig } from '../lib/network-config.js';
+import { bigintReplacer } from '../lib/format.js';
 import {
   getCurrent,
   outputAction,
   sendAction,
   sendHint,
 } from '../lib/wallet.js';
-import { bigintReplacer } from '../lib/format.js';
 
 /** @import {PriceAuthority, PriceDescription, PriceQuote, PriceQuoteValue, PriceQuery,} from '@agoric/zoe/tools/types.js'; */
 
@@ -86,7 +86,10 @@ export const makeOracleCommand = (logger, io = {}) => {
 
   const rpcTools = async () => {
     // XXX pass fetch to getNetworkConfig() explicitly
-    const networkConfig = await getNetworkConfig({ env: process.env, fetch });
+    const networkConfig = await fetchEnvNetworkConfig({
+      env: process.env,
+      fetch,
+    });
     const utils = await makeVstorageKit({ fetch }, networkConfig);
 
     const lookupPriceAggregatorInstance = ([brandIn, brandOut]) => {

diff --git a/packages/agoric-cli/src/commands/perf.js b/packages/agoric-cli/src/commands/perf.js
@@ -7,6 +7,7 @@ import {
   makeFollower,
   makeLeaderFromRpcAddresses,
 } from '@agoric/casting';
+import { fetchEnvNetworkConfig } from '@agoric/client-utils';
 import { slotToRemotable } from '@agoric/internal/src/storage-test-utils.js';
 import { boardSlottingMarshaller } from '@agoric/vats/tools/board-utils.js';
 import { Command } from 'commander';
@@ -17,12 +18,11 @@ import {
   execSwingsetTransaction,
   normalizeAddressWithOptions,
 } from '../lib/chain.js';
-import { getNetworkConfig } from '../lib/network-config.js';
 
 // tight for perf testing but less than this tends to hang.
 const SLEEP_SECONDS = 0.1;
 
-const networkConfig = await getNetworkConfig({ env: process.env, fetch });
+const networkConfig = await fetchEnvNetworkConfig({ env: process.env, fetch });
 
 /**
  * @param {import('anylogger').Logger} logger

diff --git a/packages/agoric-cli/src/commands/psm.js b/packages/agoric-cli/src/commands/psm.js
@@ -1,14 +1,17 @@
 // @ts-check
 /* eslint-disable func-names */
 /* eslint-env node */
-import { makeVstorageKit, storageHelper } from '@agoric/client-utils';
+import {
+  fetchEnvNetworkConfig,
+  makeVstorageKit,
+  storageHelper,
+} from '@agoric/client-utils';
 import { Offers } from '@agoric/inter-protocol/src/clientSupport.js';
 import { Command } from 'commander';
-import { getNetworkConfig } from '../lib/network-config.js';
-import { outputExecuteOfferAction } from '../lib/wallet.js';
 import { asPercent } from '../lib/format.js';
+import { outputExecuteOfferAction } from '../lib/wallet.js';
 
-const networkConfig = await getNetworkConfig({ env: process.env, fetch });
+const networkConfig = await fetchEnvNetworkConfig({ env: process.env, fetch });
 
 // Adapted from https://gist.github.com/dckc/8b5b2f16395cb4d7f2ff340e0bc6b610#file-psm-tool
 

diff --git a/packages/agoric-cli/src/commands/reserve.js b/packages/agoric-cli/src/commands/reserve.js
@@ -1,13 +1,12 @@
 // @ts-check
 /* eslint-disable func-names */
 /* eslint-env node */
-import { makeVstorageKit } from '@agoric/client-utils';
+import { fetchEnvNetworkConfig, makeVstorageKit } from '@agoric/client-utils';
 import { Offers } from '@agoric/inter-protocol/src/clientSupport.js';
 import { Command } from 'commander';
-import { getNetworkConfig } from '../lib/network-config.js';
 import { outputActionAndHint } from '../lib/wallet.js';
 
-const networkConfig = await getNetworkConfig({ env: process.env, fetch });
+const networkConfig = await fetchEnvNetworkConfig({ env: process.env, fetch });
 
 /**
  * @param {import('anylogger').Logger} _logger

diff --git a/packages/agoric-cli/src/commands/test-upgrade.js b/packages/agoric-cli/src/commands/test-upgrade.js
@@ -1,12 +1,11 @@
 // @ts-check
 /* eslint-env node */
-import { makeWalletUtils } from '@agoric/client-utils';
+import { fetchEnvNetworkConfig, makeWalletUtils } from '@agoric/client-utils';
 import { Fail } from '@endo/errors';
 import { CommanderError } from 'commander';
 import { normalizeAddressWithOptions } from '../lib/chain.js';
-import { getNetworkConfig } from '../lib/network-config.js';
-import { sendAction } from '../lib/wallet.js';
 import { bigintReplacer } from '../lib/format.js';
+import { sendAction } from '../lib/wallet.js';
 
 /**
  * Make commands for testing.
@@ -39,7 +38,7 @@ export const makeTestCommand = (
     try {
       // XXX pass fetch to getNetworkConfig() explicitly
       // await null above makes this await safe
-      const networkConfig = await getNetworkConfig({ env, fetch });
+      const networkConfig = await fetchEnvNetworkConfig({ env, fetch });
       return makeWalletUtils({ fetch, delay }, networkConfig);
     } catch (err) {
       // CommanderError is a class constructor, and so

diff --git a/packages/agoric-cli/src/commands/vaults.js b/packages/agoric-cli/src/commands/vaults.js
@@ -1,17 +1,16 @@
 // @ts-check
 /* eslint-disable func-names */
 /* eslint-env node */
-import { makeVstorageKit } from '@agoric/client-utils';
+import { fetchEnvNetworkConfig, makeVstorageKit } from '@agoric/client-utils';
 import {
   lookupOfferIdForVault,
   Offers,
 } from '@agoric/inter-protocol/src/clientSupport.js';
 import { Command } from 'commander';
 import { normalizeAddressWithOptions } from '../lib/chain.js';
 import { getCurrent, outputExecuteOfferAction } from '../lib/wallet.js';
-import { getNetworkConfig } from '../lib/network-config.js';
 
-const networkConfig = await getNetworkConfig({ env: process.env, fetch });
+const networkConfig = await fetchEnvNetworkConfig({ env: process.env, fetch });
 
 /**
  * @param {import('anylogger').Logger} logger

diff --git a/packages/agoric-cli/src/commands/wallet.js b/packages/agoric-cli/src/commands/wallet.js
@@ -8,7 +8,7 @@ import {
   makeLeader,
   makeLeaderFromRpcAddresses,
 } from '@agoric/casting';
-import { makeVstorageKit } from '@agoric/client-utils';
+import { makeVstorageKit, fetchEnvNetworkConfig } from '@agoric/client-utils';
 import { execFileSync } from 'child_process';
 import fs from 'fs';
 import util from 'util';
@@ -19,15 +19,14 @@ import {
   fetchSwingsetParams,
   normalizeAddressWithOptions,
 } from '../lib/chain.js';
-import { getNetworkConfig } from '../lib/network-config.js';
-import { coalesceWalletState, getCurrent } from '../lib/wallet.js';
 import {
-  summarize,
   fmtRecordOfLines,
   parseFiniteNumber,
+  summarize,
 } from '../lib/format.js';
+import { coalesceWalletState, getCurrent } from '../lib/wallet.js';
 
-const networkConfig = await getNetworkConfig({ env: process.env, fetch });
+const networkConfig = await fetchEnvNetworkConfig({ env: process.env, fetch });
 
 const SLEEP_SECONDS = 3;
 

diff --git a/packages/agoric-cli/src/helpers.js b/packages/agoric-cli/src/helpers.js
@@ -3,7 +3,8 @@
 
 /** @import { ChildProcess } from 'child_process' */
 
-export { getNetworkConfig } from './lib/network-config.js';
+// Backwards compatibility
+export { fetchEnvNetworkConfig as getNetworkConfig } from '@agoric/client-utils';
 
 export const getSDKBinaries = ({
   jsPfx = '../..',