feat(fast-usdc): operator attest cli command #10610

dckc · 2024-12-03T08:06:17Z

closes: #10567

Description

Fill in the operator attest action and test it.

Security Considerations

none; it writes to stdout

Scaling / Upgrade Considerations

none

Documentation Considerations

$ yarn fast-usdc operator attest --help
Usage: fast-usdc operator attest [options]

Attest to an observed Fast USDC transfer

Options:
  --previousOfferId <string>    Offer id
  --forwardingChannel <string>  Channel id
  --recipientAddress <string>   bech32 address
  --blockHash <0xhex>           hex hash
  --blockNumber <number>        number
  --blockTimestamp <number>     number
  --chainId <string>            chain id
  --amount <number>             number
  --forwardingAddress <string>  bech32 address
  --txHash <0xhexo>             hex hash
  --offerId <string>            Offer id (default: "operatorAttest-1733212600270")
  -h, --help                    display help for command

It's quite minimalistic. It requires a --previousOfferId without providing a find-continuing-id sub-command.

It doesn't handle sign/broadcast nor reporting the outcome of the offer. I suppose agops perf satisfaction is available for that; I just hope don't end up relying on agops in production use.

Testing Considerations

One happy-path test, using injected io, to check that the bridgeAction that it writes is as expected.

  ✔ fast-usdc operator attest sub-command
    ℹ node fast-usdc operator attest --previousOfferId 123 --forwardingChannel channel-21 --recipientAddress agoric16kv2g7snfc4q24vg3pjdlnnqgngtjpwtetd2h689nz09lcklvh5s8u37ek?EUD=dydx183dejcnmkka5dzcu9xw6mywq0p2m5peks28men --amount 300000000 --forwardingAddress noble1x0ydg69dh6fqvr27xjvp6maqmrldam6yfelktz --blockHash 0x80d7343e04f8160892e94f02d6a9b9f255663ed0ac34caca98544c8143fee699 --blockNumber 21037669 --blockTimestamp 1730762099 --txHash 0xd81bc6105b60a234c7c50ac17816ebcd5561d366df8bf3be59ff387552761799 --chainId 1

dckc · 2024-12-03T08:08:36Z

I expect to squash at least some of these commits.

I iterated on the design a bit and I don't want to throw away the exploration until there's more buy-in on the details.

cloudflare-workers-and-pages · 2024-12-03T17:13:36Z

Deploying agoric-sdk with Cloudflare Pages

Latest commit:	`918eabe`
Status:	✅ Deploy successful!
Preview URL:	https://96647bc6.agoric-sdk.pages.dev
Branch Preview URL:	https://dc-tx-feed-cli.agoric-sdk.pages.dev

View logs

samsiegart

The changes requested are mostly for the test helpers, but also consider the env feedback and broadcasting the txn

samsiegart · 2024-12-03T17:24:44Z

packages/fast-usdc/test/cli/operator-commands.test.ts

+
+const marshalData = makeMarshal(_v => assert.fail('data only'));
+
+const mockStream = <T extends Writable>(buf: string[]): T =>


Could you please put this in testing/mocks? It's better than the existing mockOut thing so should be used going forward.

We don't export testing from packages. Mocks are often useful outside a package so consider fast-usdc/tools/testingMocks.js or somesuch.

samsiegart · 2024-12-03T17:26:31Z

packages/fast-usdc/test/cli/operator-commands.test.ts

+import { makeMarshal } from '@endo/marshal';
+import type { Writable } from 'node:stream';
+
+export const flags = (


Consider: adding this to a new testing/helpers.ts (or similar) file.

samsiegart · 2024-12-03T17:28:55Z

packages/fast-usdc/src/cli/operator-commands.js

+        proposal: {},
+      };
+
+      outputActionAndHint(


I guess this is okay for now, would be great if it just went ahead and did the tx. There's an example here of it broadcasting a noble tx: https://github.com/Agoric/agoric-sdk/blob/master/packages/fast-usdc/src/util/noble.js#L46. This feedback is optional.

It would be great but there's also the matter of managing key material which is already in agd.

That's understandable, it's reasonable to assume this will be run in an environment with agd already. For noble, I didn't want to require nobled, so I added it.

I do hope @agoric/client-utils will sort of standardize on the signAndBroadcast(addr, [msg], ...) API. It's an interface that can be implemented using either agd or keplr as well as cosmjs.

something like:

makeAgd({execFile}).withOpts({keyringBackend: 'test'}).account('gov1').signAndBroadcast(...)

Good idea. I've added that to

transaction signing support without agd #5912

samsiegart · 2024-12-03T17:41:29Z

packages/fast-usdc/src/cli/operator-commands.js

-        env: process.env,
-        fetch,
-      });
+      const networkConfig = await fetchEnvNetworkConfig({ env, fetch });


I guess env was introduced at some point. It's not great to have both env and a config file that can conflict. I'd ask that we at least make

agoric-sdk/packages/fast-usdc/src/cli/transfer.js

Lines 30 to 32 in ef82fbf

vstorage ||= makeVStorage(

{ fetch },

{ chainName: 'agoric', rpcAddrs: [config.agoricRpc] },

use fetchEnvNetworkConfig also, and remove agoricRpc from the config file. Also, not sure how well documented the env thing is, might be worth adding to a README or help command somehow, even if the only intended user is "us".

I guess env was introduced at some point.

Reading from AGORIC_NET from env has been in the agoric command for years. #10570 gave getNetworkConfig a more accurate name of fetchEnvNetworkConfig.

use fetchEnvNetworkConfig also

I support this suggestion and the rationale.

Also, not sure how well documented the env thing is, might be worth adding to a README or help command somehow, even if the only intended user is "us".

The intended user of fetchEnvNetworkConfig is anyone developing a CLI tool that wants to use AGORIC_NET env var to pick the network. +1 to adding to this CLI tool that it observes AGORIC_NET env var.

If this PR keeps the "closes" line then I think the help should be included. Alternately it can be saved for another PR and the issue left open.

Ok. I migrated transfer to use AGORIC_NET and added an epilogue to the help text for all commands:

$ yarn -s fast-usdc transfer --help Usage: fast-usdc transfer [options] <amount> <dest> Transfer USDC from Ethereum/L2 to Cosmos via Fast USDC Arguments: amount Amount to transfer denominated in uusdc dest Destination address in Cosmos Options: -h, --help display help for command 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.

turadg · 2024-12-03T17:57:49Z

packages/fast-usdc/src/cli/cli.js

@@ -1,3 +1,5 @@
+/* eslint-env node */
+/* global globalThis */


would s/globalThis/global work?

My impression is that globalThis is more portable than global:

The globalThis property provides a standard way of accessing the global this value (and hence the global object itself) across environments. -- globalThis - JavaScript | MDN

This runs only in a Node env anyway. There's no scenario in which cli.js runs in a browser.

I guess I'm not familiar with when to use global. I don't recall using it. Checking nodejs docs, I see:

Stability: 3 - Legacy. Use globalThis instead.

TIL

I wonder why eslint-env node doesn't include it

turadg · 2024-12-03T17:58:37Z

packages/fast-usdc/src/cli/operator-commands.js

@@ -1,18 +1,42 @@
-/* eslint-env node */


I maintain that CLI modules that are never exported from the package should have access to Node env. The work is done so I won't request that it be reverted.

I see further down that you use the params to mock for testing. I'm sympathetic to that, though I wonder if we'd be better off with testing the actual CLI using execa.

packages/fast-usdc/src/cli/operator-commands.js

using a LegibleCapData blob arg

dckc requested review from turadg and samsiegart December 3, 2024 08:06

dckc requested a review from a team as a code owner December 3, 2024 08:06

samsiegart requested changes Dec 3, 2024

View reviewed changes

turadg reviewed Dec 3, 2024

View reviewed changes

turadg approved these changes Dec 3, 2024

View reviewed changes

dckc requested a review from samsiegart December 3, 2024 21:58

dckc added the automerge:squash Automatically squash merge label Dec 3, 2024

samsiegart approved these changes Dec 3, 2024

View reviewed changes

dckc added automerge:rebase Automatically rebase updates, then merge and removed automerge:squash Automatically squash merge labels Dec 4, 2024

dckc force-pushed the dc-tx-feed-cli branch from f48b752 to c604726 Compare December 4, 2024 03:37

dckc added 11 commits December 4, 2024 03:58

refactor(fast-usdc): inject io to addOperatorCommands

5d4f84c

feat(fast-usdc): operator attest cli command

448aa3a

using a LegibleCapData blob arg

chore(fast-usdc): use an arg for each evidence property

c6a2123

chore: don't kludge fromCapData

f1df99f

chore: avoid magic strings in attest test

11df834

refactor: mockStream, concise flags

843ad24

refactor: move mockStream(...) to fast-usdc/tools/

ccb969e

refactor: move flags() to fast-usdc/tools/

8674c75

chore: use AGORIC_NET for agoric RPC endpoint in transfer cmd

13e68a9

docs(fast-usdc): add cli help text re AGORIC_NET

4c92dbb

chore(fast-usdc): regen snapshots with AGORIC_NET docs

918eabe

dckc force-pushed the dc-tx-feed-cli branch from c604726 to 918eabe Compare December 4, 2024 03:58

mergify bot merged commit d6a7ffb into master Dec 4, 2024
81 checks passed

mergify bot deleted the dc-tx-feed-cli branch December 4, 2024 04:43

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(fast-usdc): operator attest cli command #10610

feat(fast-usdc): operator attest cli command #10610

dckc commented Dec 3, 2024 •

edited

Loading

dckc commented Dec 3, 2024

cloudflare-workers-and-pages bot commented Dec 3, 2024 •

edited

Loading

samsiegart left a comment

samsiegart Dec 3, 2024

turadg Dec 3, 2024

samsiegart Dec 3, 2024

samsiegart Dec 3, 2024

turadg Dec 3, 2024

samsiegart Dec 3, 2024

dckc Dec 3, 2024 •

edited

Loading

turadg Dec 3, 2024

samsiegart Dec 3, 2024

turadg Dec 3, 2024 •

edited by dckc

Loading

dckc Dec 3, 2024

turadg Dec 3, 2024

dckc Dec 3, 2024

turadg Dec 3, 2024 •

edited

Loading

dckc Dec 4, 2024

turadg Dec 4, 2024 •

edited

Loading

turadg Dec 3, 2024


		const marshalData = makeMarshal(_v => assert.fail('data only'));

		const mockStream = <T extends Writable>(buf: string[]): T =>

	vstorage \|\|= makeVStorage(
	{ fetch },
	{ chainName: 'agoric', rpcAddrs: [config.agoricRpc] },

feat(fast-usdc): operator attest cli command #10610

feat(fast-usdc): operator attest cli command #10610

Conversation

dckc commented Dec 3, 2024 • edited Loading

Description

Security Considerations

Scaling / Upgrade Considerations

Documentation Considerations

Testing Considerations

dckc commented Dec 3, 2024

cloudflare-workers-and-pages bot commented Dec 3, 2024 • edited Loading

Deploying agoric-sdk with Cloudflare Pages

samsiegart left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dckc Dec 3, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

turadg Dec 3, 2024 • edited by dckc Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

turadg Dec 3, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

turadg Dec 4, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dckc commented Dec 3, 2024 •

edited

Loading

cloudflare-workers-and-pages bot commented Dec 3, 2024 •

edited

Loading

dckc Dec 3, 2024 •

edited

Loading

turadg Dec 3, 2024 •

edited by dckc

Loading

turadg Dec 3, 2024 •

edited

Loading

turadg Dec 4, 2024 •

edited

Loading