chore: clearer error message when function signature does not contain parentheses #9478
Conversation
yipu3
requested review from
DaniPopes,
klkvr,
mattsse,
grandizzy,
yash-atreya and
zerosnacks
as code owners
Co-authored-by: Yash Atreya <[email protected]>
|
Thanks! |
zerosnacks
changed the title
| } | ||
|
|
||
| let func = if sig.contains('(') { | ||
| // a regular function signature with parentheses | ||
| get_func(sig)? | ||
| } else { | ||
| let etherscan_api_key = etherscan_api_key.ok_or_eyre( | ||
| "If you wish to fetch function data from EtherScan, please provide an API key.", | ||
| "Function signature does not contain parentheses. If you wish to fetch function data from Etherscan, please provide an API key.", |
There was a problem hiding this comment.
Doesn't make sense to include it in this error message to be honest
Should rather be different message or fall-through condition in this else block, not part of this error for handling missing Etherscan API key (which is valid on its own)
There was a problem hiding this comment.
Maybe when the signature does not contain parentheses the code try to treat the string as the function name and want to fetch the signature from Etherscan?
I think this message can help users that wrongly omit parentheses solve the problem faster without misleading info.
There was a problem hiding this comment.
I don't think there is actually a problem with omitting parentheses here
You are having this issue because you need to pass an Etherscan API key and RPC URL.
The function deposit is also not a method on the Uniswap V2 Router but rather on WETH.
cast call 0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2 'deposit' --etherscan-api-key <API_KEY> --rpc-url <RPC_URL>
cast call 0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2 'deposit()' --etherscan-api-key <API_KEY> --rpc-url <RPC_URL>
yield the same result 0x, which is expected
cast call 0x7a250d5630B4cF539739dF2C5dAcb4c659F2488D 'factory' --etherscan-api-key <API_KEY> --rpc-url <RPC_URL>
yields: 0x5C69bEe701ef814a2B6a3EDD4B1652CB9cc5aA6f
whereas
cast call 0x7a250d5630B4cF539739dF2C5dAcb4c659F2488D 'factory()' --etherscan-api-key <API_KEY> --rpc-url <RPC_URL>
yields: 0x0000000000000000000000005c69bee701ef814a2b6a3edd4b1652cb9cc5aa6f
There was a problem hiding this comment.
I guess it could be explained further that factory() is providing the full signature, while factory without parens is requesting a function called factory which can only be retrieved from an outside source
There was a problem hiding this comment.
My issue is when I wrongly omit the parentheses, the printed error message does not direct me to fix the problem.
There was a problem hiding this comment.
@yipu3 per comments above, we discussed a better UX would be to warn that the function will be retrieved from outside source, do you want to update the PR to reflect this? thanks
There was a problem hiding this comment.
How about this:
Function is pure name. The signature will be retrieved from outside source, please provide an Etherscan API key.
Any suggestion?
Motivation
Closes #9479
When I wrongly input a function signature without parentheses:
./target/debug/cast call 0x7a250d5630B4cF539739dF2C5dAcb4c659F2488D 'deposit'The error message is a bit of confusing:
Which costs me some time to figure out what's the point.
A clearer error message is needed.
Solution
Change the message into: