Init etherscan client

[Spacesai1or]

This PR introduces an Etherscan API wrapper to be used by #8281 to sourced information about contracts to create Go bindings

[Spacesai1or]

Current dependencies on/for this PR:

• develop
  • PR BindGen - local contracts refactor #8279
    • PR Init etherscan client #8280 👈
      • PR Init remote contract generation #8281
        • PR Add deployed bytecode retrieval mitigation #8282
          • PR Bindings and metadata overwrite warning #8283
            • PR Init new bindings #8284
              • PR L2 genesis generation updates #8285
                • PR Init BindGen unit tests #8650
                  • PR Init BindGen E2E tests #8651

This stack of pull requests is managed by Graphite.

[semgrep-app]

Semgrep found 1 import-text-template finding:

• op-bindings/bindgen/generator_local.go: L12

When working with web applications that involve rendering user-generated content, it's important to properly escape any HTML content to prevent Cross-Site Scripting (XSS) attacks. In Go, the text/template package does not automatically escape HTML content, which can leave your application vulnerable to these types of attacks. To mitigate this risk, it's recommended to use the html/template package instead, which provides built-in functionality for HTML escaping. By using html/template to render your HTML content, you can help to ensure that your web application is more secure and less susceptible to XSS vulnerabilities.

_{Ignore this finding from import-text-template.}

[coderabbitai]

Walkthrough

Walkthrough

The update to the Etherscan client in Go introduces enhanced functionality and error handling. It incorporates a retry mechanism for API calls, extends the client with new types and functions for fetching ABI, bytecode, and transaction information, and adjusts its initialization to require an API key. The changes aim to improve the robustness of interactions with Etherscan's API and RPC endpoints by handling rate limits and retries.

Changes

File Path	Change Summary
.../etherscan/client.go	Added op-service/retry import, new types (apiResponse, rpcResponse, TxInfo), constants for retries and rate limit errors, apiKey parameter in NewClient, and new functions for fetching ABI, bytecode, and transactions.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on X ?

---

Tips

Chat with CodeRabbit Bot (@coderabbitai)

• You can reply to a review comment made by CodeRabbit.
• You can tag CodeRabbit on specific lines of code or files in the PR by tagging @coderabbitai in a comment.
• You can tag @coderabbitai in a PR comment and ask one-off questions about the PR and the codebase. Use quoted replies to pass the context for follow-up questions.

CodeRabbit Commands (invoked as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• The JSON schema for the configuration file is available here.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/coderabbit-overrides.v2.json

[hamdiallam]

Looks good! Any unit tests you can add? Can hardcode some sample responses in the unit tests themselves to mock out the actual rpc call

nw if you'd just want to leverage manual tests

[mslipper]

A couple of things I suggest fixing here before merge. In addition - have you looked at https://github.com/nanmu42/etherscan-api? Could be useful to pull that in as a dep and not have to maintain this at all.

[Spacesai1or]

...have you looked at nanmu42/etherscan-api? Could be useful to pull that in as a dep and not have to maintain this at all.

@mslipper I hadn't considered using a third-party package. I think the wrapper this PR introduces is pretty minimal, providing just what we need and should be low effort to maintain if Etherscan makes an API change (most likely just requiring a route change). The package you linked had it's last code update a year ago (with most of the code not being touched in 2 - 5 years, and the author doesn't seem very active on Github), and I'm concerned with introducing a dependency that isn't actively being developed and appears to have low usage. I also looked for alternative packages, but didn't find anything better

Unless you feel strongly about replacing this PR with the linked package, I prefer we keep the API wrapper as is, and reconsider replacing it with the linked package if a future situation calls for it

[mslipper]

Ok let's keep the API wrapper as-is.