feat(cast): cast send tries to decode custom errors

[rplusq]

Co-authored-by: Howard [email protected]

Motivation

Even though issue #8606 is partially solved, this would be an improvement over the UX. Only applies this for custom errors

Nightly cast send:

cast send 0x5FbDB2315678afecb367f032d93F642f64180aa3 "setValue(uint256)" 101 --private-key=0xac0974bec39a17e36ba4a6b4d238ff944bacb478cbed5efcae784d7bf4f2ff80
Error:
server returned an error response: error code 3: execution reverted: custom error 7a0e1985:ed, data: "0x7a0e198500000000000000000000000000000000000000000000000000000000000000650000000000000000000000000000000000000000000000000000000000000064"

Our PR:

cast send 0x5FbDB2315678afecb367f032d93F642f64180aa3 "setValue(uint256)" 101 --private-key=0xac0974bec39a17e36ba4a6b4d238ff944bacb478cbed5efcae784d7bf4f2ff80

Error: 
Reverted with custom error: 
 Possible methods:
 - ValueTooHigh(uint256,uint256)
 ------------
 [000]: 0000000000000000000000000000000000000000000000000000000000000065
 [020]: 0000000000000000000000000000000000000000000000000000000000000064


Context:
- server returned an error response: error code 3: execution reverted: custom error 7a0e1985:ed, data: "0x7a0e198500000000000000000000000000000000000000000000000000000000000000650000000000000000000000000000000000000000000000000000000000000064"

Solution

Using pretty_calldata to decode the custom error.

[rplusq]

Thinking it solves #8603 as well

[zerosnacks]

Thanks for your PR! LGTM

Confirming previously:

cast send 0x5FbDB2315678afecb367f032d93F642f64180aa3 "setValue(uint256)" 101 --private-key=0xac0974bec39a17e36ba4a6b4d238ff944bacb478cbed5efcae784d7bf4f2ff80
Error: 
server returned an error response: error code 3: execution reverted: custom error 0x7a0e1985: ed, data: "0x7a0e198500000000000000000000000000000000000000000000000000000000000000650000000000000000000000000000000000000000000000000000000000000064"

cast send 0x5FbDB2315678afecb367f032d93F642f64180aa3 "setValue(uint256)" 101 --private-key=0xac0974bec39a17e36ba4a6b4d238ff944bacb478cbed5efcae784d7bf4f2ff80
Error: 
Reverted with custom error: 
 Possible methods:
 - ValueTooHigh(uint256,uint256)
 ------------
 [000]: 0000000000000000000000000000000000000000000000000000000000000065
 [020]: 0000000000000000000000000000000000000000000000000000000000000064


Context:
- server returned an error response: error code 3: execution reverted: custom error 0x7a0e1985: ed, data: "0x7a0e198500000000000000000000000000000000000000000000000000000000000000650000000000000000000000000000000000000000000000000000000000000064"

[rplusq]

You can try in Sepolia at https://sepolia.etherscan.io/address/0xbabec3df164f14672c08aa277af9936532c283ba (verified for debugging)

UnknownError (not uploaded in OpenChain Signatures)

cast send 0xbabeC3dF164f14672c08AA277Af9936532c283Ba 'setValueUnknownError(uint256)' 101 --account rplusq.eth`
Enter keystore password:
Error: 
Reverted with custom error: 
 Method: a0370657
 ------------
 [000]: 0000000000000000000000000000000000000000000000000000000000000065
 [020]: 0000000000000000000000000000000000000000000000000000000000000064


Context:
- server returned an error response: error code 3: execution reverted: custom error a0370657:ed, data: "0xa037065700000000000000000000000000000000000000000000000000000000000000650000000000000000000000000000000000000000000000000000000000000064"

KnownError (uploaded in OpenChain Signatures)

cast send 0xbabeC3dF164f14672c08AA277Af9936532c283Ba 'setValueKnownError(uint256)' 101 --account rplusq.eth`
Enter keystore password:
Error: 
Reverted with custom error: 
 Possible methods:
 - ValueTooHigh(uint256,uint256)
 ------------
 [000]: 0000000000000000000000000000000000000000000000000000000000000065
 [020]: 0000000000000000000000000000000000000000000000000000000000000064


Context:
- server returned an error response: error code 3: execution reverted: custom error 7a0e1985:ed, data: "0x7a0e198500000000000000000000000000000000000000000000000000000000000000650000000000000000000000000000000000000000000000000000000000000064"

[grandizzy]

I think would worth adding a test similar with this one which starts anvil

foundry/crates/cast/tests/cli/main.rs

Lines 1290 to 1294 in ccabf8b

	casttest!(send_eip7702, async |_prj, cmd| {
	let (_api, handle) =
	anvil::spawn(NodeConfig::test().with_hardfork(Some(EthereumHardfork::PragueEOF.into())))
	.await;
	let endpoint = handle.http_endpoint();

, deploys contract, calls a fn that always revert with a custom error and make sure output is expected

foundry/crates/cast/tests/cli/main.rs

Lines 1308 to 1312 in ccabf8b

	cmd.cast_fuse()
	.args(["code", "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266", "--rpc-url", &endpoint])
	.assert_success()
	.stdout_eq(str![[r#"
	0xef010070997970c51812dc3a010c7d01b50e0d17dc79c8

Since #8603 is mentioned, I see in issue description that reporter says custom error used to be displayed in old version of cast, so wonder if it's not only a regression and could avoid fetching signatures from openchain...

[rplusq]

I think would worth adding a test similar with this one which starts anvil

Sounds good, will add

Since #8603 is mentioned, I see in issue description that reporter says custom error used to be displayed in old version of cast, so wonder if it's not only a regression and could avoid fetching signatures from openchain...

Yep, that was eventually fixed. The addition to fetch signatures from openchain I added to make those more readable when possible. It's opinionated of course, but I think it improves the ux.

[rplusq]

@grandizzy any idea why my test keeps failing? Seems like something is missing and I cannot figure it out

[grandizzy]

@grandizzy any idea why my test keeps failing? Seems like something is missing and I cannot figure it out

you can run test with SNAPSHOTS=override but since that's not relevant for test you could just redact as

        .stderr_eq(str![[r#"
Error: 
Reverted with custom error: 
 Possible methods:
 - ValueTooHigh(uint256,uint256)
 ------------
 [000]: 0000000000000000000000000000000000000000000000000000000000000065
 [020]: 0000000000000000000000000000000000000000000000000000000000000064
...
"#]]);

[rplusq]

Fixed, thanks @grandizzy

[rplusq]

Not sure if this PR will solve #8348. My PR is currently limited to cast send, though would be interested in making it more generic for the rest of the stack.

cc: @jenpaff

[jenpaff]

Not sure if this PR will solve #8348. My PR is currently limited to cast send, though would be interested in making it more generic for the rest of the stack.

cc: @jenpaff

Thanks for flagging, let me reopen then & re-evaluate

to re-review

[rplusq]

@zerosnacks @grandizzy trying to get this merged, would've been useful for me a couple of times already and it's been pending for almost 3 months

[zerosnacks]

Hi @rplusq,

My apologies for the delay. The reason why the PR has been open for some time is because there has been an ongoing discussion around what the PR is attempting to achieve and whether there are better ways to address the core issue.

We've decided not to move ahead with the approach of this PR. Instead we've added cast decode-error in #9428 which handles the resolving of custom errors by either --sig, local cache and the openchain API

The proposed way of enabling what this PR is attempting to achieve is by piping the output of cast send through cast decode-error as follows (or manually):

$ forge selectors cache

$ cast send 0x5FbDB2315678afecb367f032d93F642f64180aa3 "setValue(uint256)" 101 --private-key=0xac0974bec39a17e36ba4a6b4d238ff944bacb478cbed5efcae784d7bf4f2ff80 2>&1 | grep -oP '(?<=data: ")0x[0-9a-fA-F]+' | xargs -I{} cast decode-error {}'

It was not an easy decision considering the time and effort you've spend on this PR and for that we apologize. For the future we aim for quicker feedback loops.