Skip to content

Add POST /v2/verify/etherscan/{chainId}/{address} endpoint #2090

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 17 commits into from
Apr 23, 2025
Merged

Add POST /v2/verify/etherscan/{chainId}/{address} endpoint #2090

merged 17 commits into from
Apr 23, 2025

Conversation

manuelwedler
Copy link
Contributor

Closes #1912

As per specification: https://sourcify.stoplight.io/docs/sourcify-apiv2/ago7z944i2qg8-import-from-etherscan

Notes:

  • I reused our etherscan.common.ts logic from API v1 and refactored it. It's now called etherscan-util.ts.
  • Previously, we were compiling in order to get the contract path from Etherscan, since Etherscan does not provide this information directly. I found a solution to remove the compilation step. I added a Solidity parser which I use to parse all sources. I infer the contract path by finding the source which contains the provided contract name. I think that's the best solution we can come up with for finding the contract path.
  • Inside API v2, we first fetch the result from Etherscan within the server main thread. This is to provide better UX and return early in case we encounter an error. For example, the contract could not be verified on Etherscan. Processing the Etherscan result (including the new parsing) happens inside the workers.
  • The Etherscan API key is optional at the moment. We didn't make a final decision on this yet. We can still make it required.

@manuelwedler
Move apiv1/verification/etherscan/etherscan.commmon.ts to services/ut…
532c0b3 
…ils/etherscan-utils.ts
@manuelwedler
Move etherscan.spec.ts to apiv1/verification-handlers tests folder
5cb128e
@manuelwedler
Refactor etherscan-utils.ts and add API v2 errors
c8c93b8
@manuelwedler
Add unit tests for etherscan-util.ts
2d3462f
@manuelwedler
Fix file name
936538c
@manuelwedler
Parse Etherscan sources to find the correct contract path
78c5361 
Etherscan does not provide the contractPath of the target contract when fetching its source code. Before we were recompiling to get the contract path. This improves performance by making the compilation step obsolete.
@manuelwedler
Add POST /v2/verify/etherscan/:chainId/:address endpoint
bfbd142
@manuelwedler
Set logLevel to debug on ServerFixture
98361e2
@manuelwedler
Add integration tests for POST /v2/verify/etherscan/
1accf47
@manuelwedler
Refactor other API v2 tests to use common functions
8352e70
@manuelwedler
Downgrade chai-as-promised
8aae5ef 
Version 8 only works as esmodule but our server is not set up for that
@manuelwedler
Process Etherscan result inside worker
e6040b0 
I decided to move the processing step into the worker because parsing can be computationally expensive. Fetching from Etherscan can still be done easily inside the server main thread which provides better UX.
@manuelwedler manuelwedler force-pushed the apiv2-verify-etherscan branch from 22e3c92 to e6040b0 Compare April 17, 2025 14:40
@marcocastignoli marcocastignoli self-assigned this Apr 22, 2025
@marcocastignoli marcocastignoli moved this from Triage to Sprint - In Progress in Sourcify Public Apr 22, 2025
marcocastignoli
marcocastignoli requested changes Apr 22, 2025
View reviewed changes
Copy link
Member

@marcocastignoli marcocastignoli left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The endpoint is not present in the Swagger page: http://localhost:5555/api-docs/#/

@manuelwedler
Copy link
Contributor Author

The endpoint is not present in the Swagger page: http://localhost:5555/api-docs/#/

Good catch! Just updated the spec

marcocastignoli
marcocastignoli requested changes Apr 22, 2025
View reviewed changes
Copy link
Member

@marcocastignoli marcocastignoli left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great job! I think we can update the etherscan instances tests to use the new /v2 apis

@marcocastignoli marcocastignoli moved this from Sprint - In Progress to Sprint - Up Next in Sourcify Public Apr 22, 2025
@marcocastignoli marcocastignoli moved this from Sprint - Up Next to Sprint - In Progress in Sourcify Public Apr 22, 2025
@marcocastignoli marcocastignoli moved this from Sprint - In Progress to Sprint - Done in Sourcify Public Apr 22, 2025
@marcocastignoli marcocastignoli moved this from Sprint - Done to Sprint - Needs Review in Sourcify Public Apr 22, 2025
marcocastignoli
marcocastignoli approved these changes Apr 23, 2025
View reviewed changes
Copy link
Member

@marcocastignoli marcocastignoli left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm!! 🚀

@manuelwedler manuelwedler merged commit 534ce04 into staging Apr 23, 2025
6 checks passed
@github-project-automation github-project-automation bot moved this from Sprint - Needs Review to Sprint - Done in Sourcify Public Apr 23, 2025
@manuelwedler manuelwedler deleted the apiv2-verify-etherscan branch April 23, 2025 12:59
@marcocastignoli marcocastignoli moved this from Sprint - Done to COMPLETED in Sourcify Public Apr 24, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@marcocastignoli marcocastignoli marcocastignoli approved these changes

Assignees

@marcocastignoli marcocastignoli

Labels
None yet
Projects
Sourcify Public
Status: COMPLETED
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Implement POST /v2/verify/etherscan/{chainId}/{address} endpoint
2 participants
@manuelwedler @marcocastignoli