fix(config): prints error when accessing invalid etherscan config

[andelf]

Motivation

If any [etherscan] config entry has a wrong name, then the whole [etherscan] becomes unreachable.

This is difficult to debug since the only error message is "Error: Invalid API Key".
Actually user has already provided a correct key.

To reproduce, add the following to ~/.foundry/foundry.toml:

[etherscan]

eth = { key = "xx" }
bsc = { key = "xx" }
arbi = { key = "xxxx" } # NOTE: the name "arbi" is an invalid chain name. This entry invalidates the whole `[etherscan]` section.

Then all etherscan operations becomes "Invalid API Key" errors.

Solution

• Skip invalid entry in ResolvedEtherscanConfig and prints error log. -- the config unit tests depend on this behaviour
• print an error message to denote that [etherscan] section is invalid

PR Checklist

• Added Tests
• Added Documentation
• Breaking changes

[zerosnacks]

Hi @andelf thanks for your PR!

Would you mind changing warn! to let _ = sh_warn!(..)

This will make it so the warning is outputted to the user's terminal rather than to the tracing target for internal debugging

Would you mind adding a unit test that validates the change?

Thanks!

[andelf]

It's deeply coupled with other config testings. So I guess it would be better to refuse invalid config and output errors.

[andelf]

comments addressed. PTAL.

[zerosnacks]

Perhaps I'm missing something but running the example case in your description with the current version of Foundry results in:

Error: At least one of `url` or `chain` must be present for Etherscan config with unknown alias `arbi`

or alternatively if the key is incorrect or missing

Error: failed to extract foundry config:
foundry config error: missing field `key` for setting `etherscan.arbi`

https://book.getfoundry.sh/reference/config/etherscan specifically states the ability to specify custom chains (even if incorrect) and will throw this error

Would you mind giving a brief example of the issue that produces the reported error?

[andelf]

@zerosnacks It's counterintuitive that another invalid name in [etherscan] will disable all the other "key" settings.
Previously, cast source will fail silently printing a message saying "Error: Invalid API Key". Actually no key is used.

conditions:

• Anther name with higher ordering: "arb" is greater than something like "bsc": BTreeMap is used to store the values.
• cast source uses a .ok() after an Error type with chaining-call style.(where this PR added the error message).

[andelf]

This check does not match the later api_key assignment.
In my case, this check fails, but config.get_etherscan_api_key works.