Improve handling of "version" string from Etherscan #545

ggrieco-tob · 2024-02-07T12:32:53Z

crytic-compile fails to compile correctly contracts such as:

$ crytic-compile optim:0x7f5c764cbc14f9669b88837ca1490cca17c31607
Traceback (most recent call last):
  File "/home/g/.local/bin/crytic-compile", line 8, in <module>
    sys.exit(main())
  File "/home/g/.local/lib/python3.10/site-packages/crytic_compile/__main__.py", line 221, in main
    compilations = compile_all(**vars(args))
  File "/home/g/.local/lib/python3.10/site-packages/crytic_compile/crytic_compile.py", line 718, in compile_all
    compilations.append(CryticCompile(target, **kwargs))
  File "/home/g/.local/lib/python3.10/site-packages/crytic_compile/crytic_compile.py", line 207, in __init__
    self._compile(**kwargs)
  File "/home/g/.local/lib/python3.10/site-packages/crytic_compile/crytic_compile.py", line 629, in _compile
    self._platform.compile(self, **kwargs)
  File "/home/g/.local/lib/python3.10/site-packages/crytic_compile/platform/etherscan.py", line 356, in compile
    compiler_version = re.findall(
IndexError: list index out of range

This is caused by the fact that the compiler version is v0.7.6, which does not contain any +.

Summary by CodeRabbit

Bug Fixes
- Improved handling of version identifiers containing special characters for accurate processing.

coderabbitai · 2024-02-07T12:33:59Z

Walkthrough

The recent update focuses on improving the handling of specific version formats in the etherscan.py script. Specifically, it addresses a scenario where the version string includes a + character, ensuring that such versions are correctly processed and interpreted by the system.

Changes

File	Change Summary
`.../etherscan.py`	Modified `_convert_version` to correctly handle `+` in versions.

🐰✨
In the realm of code, where versions intertwine,
A rabbit hopped in, making the etherscan shine.
With a tweak and a hop, it fixed the +,
Now versions flow smoothly, without any fuss.
🌟🐾

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 your favorite social media?

Share

Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>.
- Generate unit-tests for this file.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit tests for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai generate interesting stats about this repository from git and render them as a table.
- @coderabbitai show all the console.log statements in this repository.
- @coderabbitai read src/utils.ts and generate unit tests.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

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

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

coderabbitai

Review Status

Actionable comments generated: 1

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between 1b2998e and cf981c7.

Files selected for processing (1)

crytic_compile/platform/etherscan.py (1 hunks)

coderabbitai · 2024-02-07T12:35:34Z

crytic_compile/platform/etherscan.py

+    if "+" in version:
+        return version[1 : version.find("+")]
+    return version


The _convert_version function now handles version strings without a + character by returning the entire string if the + character is not found. This change correctly addresses the issue described in the PR objectives. However, the function unnecessarily slices the version string from index 1, which could remove the first character of the version string unintentionally. This could lead to incorrect version handling if the version string does not start with 'v' or if the character is essential.

- return version[1 : version.find("+")] + return version[: version.find("+")]

Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change

if "+" in version:

return version[1 : version.find("+")]

return version

if "+" in version:

return version[: version.find("+")]

return version

elopez · 2024-02-07T12:46:16Z

crytic_compile/platform/etherscan.py

-    return version[1 : version.find("+")]
+    if "+" in version:
+        return version[1 : version.find("+")]
+    return version


Do versions with no "+" also have no "v" in the beginning? With this change, versions without "+" won't have the first character removed.

This was not really necessary (as the code worked with the v), but I pushed a quick fix for it anyway.

coderabbitai

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between cf981c7 and ad9bf30.

Files selected for processing (1)

crytic_compile/platform/etherscan.py (1 hunks)

Files skipped from review as they are similar to previous changes (1)

crytic_compile/platform/etherscan.py

Improve handling of "version" string from Etherscan

cf981c7

ggrieco-tob requested review from montyly, 0xalpharush and bohendo as code owners February 7, 2024 12:32

coderabbitai bot reviewed Feb 7, 2024

View reviewed changes

elopez requested changes Feb 7, 2024

View reviewed changes

Update etherscan.py

1bc8da8

elopez approved these changes Feb 7, 2024

View reviewed changes

fixed lint

ad9bf30

coderabbitai bot reviewed Feb 7, 2024

View reviewed changes

0xalpharush added this pull request to the merge queue Feb 7, 2024

Merged via the queue into master with commit c0ad9f5 Feb 7, 2024
60 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Improve handling of "version" string from Etherscan #545

Improve handling of "version" string from Etherscan #545

ggrieco-tob commented Feb 7, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Feb 7, 2024 •

edited

Loading

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (`.coderabbit.yaml`)

CodeRabbit Discord Community

coderabbitai bot left a comment

coderabbitai bot Feb 7, 2024

elopez Feb 7, 2024 •

edited

Loading

ggrieco-tob Feb 7, 2024

coderabbitai bot left a comment

Improve handling of "version" string from Etherscan #545

Improve handling of "version" string from Etherscan #545

Conversation

ggrieco-tob commented Feb 7, 2024 • edited by coderabbitai bot Loading

Summary by CodeRabbit

coderabbitai bot commented Feb 7, 2024 • edited Loading

Walkthrough

Changes

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (.coderabbit.yaml)

CodeRabbit Discord Community

coderabbitai bot left a comment

Choose a reason for hiding this comment

coderabbitai bot Feb 7, 2024

Choose a reason for hiding this comment

elopez Feb 7, 2024 • edited Loading

Choose a reason for hiding this comment

ggrieco-tob Feb 7, 2024

Choose a reason for hiding this comment

coderabbitai bot left a comment

Choose a reason for hiding this comment

ggrieco-tob commented Feb 7, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Feb 7, 2024 •

edited

Loading

CodeRabbit Configration File (`.coderabbit.yaml`)

elopez Feb 7, 2024 •

edited

Loading