fix(verify): make verification result an option to handle blockscout's format
#2426
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
mattsse
requested changes
May 22, 2023
ethers-etherscan/src/contract.rs
Outdated
| if resp.result.starts_with("Max rate limit reached") { | ||
| let resp: Response<Option<String>> = self.get_json(&query).await?; | ||
|
|
||
| let result = resp.result.unwrap_or("".to_string()); |
There was a problem hiding this comment.
null will now always be a serde error,
I'd rather have a new error variant for EmptyResult or something
There was a problem hiding this comment.
done in 94ad922 — we now bubble up the error with an EmptyResult variant
2 tasks
mattsse
approved these changes
May 22, 2023
DaniPopes
reviewed
May 23, 2023
ethers-etherscan/src/errors.rs
Outdated
Comment on lines
26
to
27
| #[error("Response result is unexpectedly empty")] | ||
| EmptyResult { status: String, message: String }, |
There was a problem hiding this comment.
Should the error message include status or message?
There was a problem hiding this comment.
Oh yeah, let's include both! the status should only be a number so it's short. The message is what actually has the error
DaniPopes
approved these changes
May 23, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation
I've been investigating verification issues due to foundry-rs/foundry#4909 — and it turns out that blockscout, unlike etherscan, likes to return
nullon theresultfield sometimes, instead of an empty string onmessageand the actual message on theresultfield, like etherscan. This in turn introduced a bug when detecting if a contract was already verified as it expects that the blockscout format is identical to etherscan's.To be a bit more specifc, this format is returned by blockscout when a contract is not verified, and this is not what etherscan returns (see the
nullin result):While making a blockscout verification client might be the "best" fix, this is a slight difference in formats and I opted for this solution instead. We can handle separating blockscout & etherscan verification later.
Solution
Parses the
resultfield from the API response as an Option instead of just a string, to handle cases where result isnull.