feat(abigen): Add solc binary fallback for Apple Silicon #3455

devin-ai-integration · 2024-12-12T02:40:59Z

Improves solc binary management with better error handling and context propagation.

Link to Devin run: https://app.devin.ai/sessions/73d247fe22324ab89be91a315e5ff41f

- Add architecture detection for Apple Silicon - Implement solc binary download with checksum verification - Add caching in ~/.cache/solc/ - Update documentation Fixes #3366 Co-Authored-By: [email protected] <[email protected]>

devin-ai-integration · 2024-12-12T02:41:03Z

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

Address comments on this PR
Look at CI failures and help fix them

⚙️ Control Options:

Disable automatic comment and CI monitoring

Add "(aside)" to your comment to have me ignore it.

coderabbitai · 2024-12-12T02:41:07Z

Important

Review skipped

Bot user detected.

To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

The changes in this pull request enhance the abigen tool's documentation and functionality, particularly for users on Apple Silicon Macs. The documentation clarifies usage instructions and expands on the fallback mechanism for compiling Solidity contracts. The code modifications introduce a binary manager for Solidity compiler binaries, improve error handling, and implement a caching system. New functions and tests are added to ensure robust management of the compilation process and to verify the integrity of downloaded binaries.

Changes

File Path	Change Summary
tools/abigen/README.md	Updated documentation for `abigen`, clarifying usage instructions, improving compatibility for Apple Silicon, and expanding on error handling related to `go.mod` package updates. Added details on WASM support.
tools/abigen/internal/generate.go	Enhanced Solidity contract compilation functionality, added new compilation strategies, improved error handling, and introduced helper functions for file operations. Renamed `optimizerRuns` to `optimizeRuns`.
tools/abigen/internal/solc/binary.go	Introduced functionality for managing Solidity compiler binaries, including downloading, caching, and verifying binaries across platforms. Defined structures and methods for binary management.
tools/abigen/internal/solc/binary_test.go	Added unit tests for the `solc` package, validating the functionality of the `BinaryManager` and related methods, ensuring robust testing of binary management features.

Assessment against linked issues

Objective	Addressed	Explanation
Implement a fallback mechanism for solc downloads (3366)	✅
Cache downloaded versions to avoid repeated downloads (3366)	✅
Verify checksums for security (3366)	✅
Support version selection similar to Docker implementation (3366)	❌	No explicit version selection mechanism was introduced in the changes.

Possibly related PRs

platform bump [SLT-452] #3365: Addresses issues related to Docker-based tools on macOS with Apple Silicon, relevant to the updates on compatibility and fallback mechanisms in this PR.

Suggested labels

size/xs

Poem

In the meadow where the code does play,
A rabbit hops, brightening the day.
With binaries cached and checksums tight,
Apple Silicon shines, oh what a sight!
The abigen tool now leaps with grace,
Compiling contracts at a faster pace! 🐇✨

🪧 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>, please review it.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
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 testing code 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

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 using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

codecov · 2024-12-12T02:44:13Z

Codecov Report

Attention: Patch coverage is 0% with 7 lines in your changes missing coverage. Please review.

Project coverage is 22.00038%. Comparing base (40cd70b) to head (b0f0d41).
Report is 7 commits behind head on master.

Files with missing lines	Patch %	Lines
core/commandline/shell.go	0.00000%	7 Missing ⚠️

❗ There is a different number of reports uploaded between BASE (40cd70b) and HEAD (b0f0d41). Click for more details.

HEAD has 2 uploads less than BASE

Flag BASE (40cd70b) HEAD (b0f0d41)

cctp-relayer 2 1

scribe 2 1

Additional details and impacted files

@@                 Coverage Diff                  @@
##              master       #3455          +/-   ##
====================================================
- Coverage   34.04255%   22.00038%   -12.04217%     
====================================================
  Files            388         502         +114     
  Lines          24581       41922       +17341     
====================================================
+ Hits            8368        9223         +855     
- Misses         15472       31762       +16290     
- Partials         741         937         +196

Flag	Coverage Δ
cctp-relayer	`31.97848% <ø> (ø)`
core	`58.76168% <0.00000%> (-0.01718%)`	⬇️
ethergo	`47.30531% <ø> (-0.05272%)`	⬇️
explorer	`4.93656% <ø> (?)`
git-changes-action	`23.48315% <ø> (ø)`
omnirpc	`32.65401% <ø> (ø)`
opbot	`0.18282% <ø> (ø)`
promexporter	`6.81642% <ø> (ø)`
screener-api	`29.95090% <ø> (+0.49099%)`	⬆️
scribe	`18.18182% <ø> (ø)`

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

cloudflare-workers-and-pages · 2024-12-12T02:46:25Z

Deploying sanguine-fe with Cloudflare Pages

Latest commit:	`b0f0d41`
Status:	✅ Deploy successful!
Preview URL:	https://15e86d99.sanguine-fe.pages.dev
Branch Preview URL:	https://devin-1733968581-apple-silic.sanguine-fe.pages.dev

View logs

Co-Authored-By: [email protected] <[email protected]>

…nager Co-Authored-By: [email protected] <[email protected]>

Co-Authored-By: [email protected] <[email protected]>

…y manager Co-Authored-By: [email protected] <[email protected]>

trajan0x · 2024-12-12T14:18:26Z

@coderabbitai review

coderabbitai · 2024-12-12T14:18:32Z

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

Co-Authored-By: [email protected] <[email protected]>

- Add detailed error messages for checksum verification - Validate Docker binary path and arguments - Improve error wrapping throughout the codebase - Add comprehensive test coverage for binary verification Co-Authored-By: [email protected] <[email protected]>

Co-Authored-By: [email protected] <[email protected]>

…error messages Co-Authored-By: [email protected] <[email protected]>

Co-Authored-By: [email protected] <[email protected]>

…lues Co-Authored-By: [email protected] <[email protected]>

Co-Authored-By: [email protected] <[email protected]>

…e generated contracts Co-Authored-By: [email protected] <[email protected]>

github-actions · 2025-01-03T02:38:17Z

This PR is stale because it has been open 14 days with no activity. Remove stale label or comment or this will be closed in 5 days.

feat(abigen): Add solc binary fallback for Apple Silicon

b9b52a1

- Add architecture detection for Apple Silicon - Implement solc binary download with checksum verification - Add caching in ~/.cache/solc/ - Update documentation Fixes #3366 Co-Authored-By: [email protected] <[email protected]>

devin-ai-integration bot requested a review from trajan0x as a code owner December 12, 2024 02:40

github-actions bot added go Pull requests that update Go code size/m labels Dec 12, 2024

github-actions bot added needs-go-generate-contrib/promexporter needs-go-generate-services/scribe needs-go-generate-services/rfq needs-go-generate-services/explorer needs-go-generate-agents labels Dec 12, 2024

devin-ai-integration bot and others added 5 commits December 12, 2024 12:28

fix(abigen): Fix error handling in solc binary manager

f5eaf03

Co-Authored-By: [email protected] <[email protected]>

test(abigen): Add comprehensive test cases for solc binary manager

b76b338

Co-Authored-By: [email protected] <[email protected]>

refactor(abigen): Extract platform validation logic in solc binary ma…

d15b3a7

…nager Co-Authored-By: [email protected] <[email protected]>

fix(abigen): Improve path handling and validation in generate.go

6e75b19

Co-Authored-By: [email protected] <[email protected]>

test(abigen): Update test cases for platform validation in solc binar…

d6c9a8e

…y manager Co-Authored-By: [email protected] <[email protected]>

devin-ai-integration bot and others added 2 commits December 12, 2024 14:21

refactor(abigen): Reduce cyclomatic complexity in downloadAndVerify

7fbd919

Co-Authored-By: [email protected] <[email protected]>

fix(abigen): Fix CI issues and improve solc binary management

449154d

Co-Authored-By: [email protected] <[email protected]>

github-actions bot added size/l and removed size/m labels Dec 12, 2024

devin-ai-integration bot and others added 6 commits December 12, 2024 17:48

fix(abigen): Fix empty file handling and improve checksum verification

03b0de6

Co-Authored-By: [email protected] <[email protected]>

fix(abigen): Improve context handling in solc binary manager

eeaf056

Co-Authored-By: [email protected] <[email protected]>

chore: Update golangci-lint configuration to use supported linters

deea1cb

Co-Authored-By: [email protected] <[email protected]>

fix(abigen): Improve solc binary management and context handling

348309e

Co-Authored-By: [email protected] <[email protected]>

fix(abigen): Fix context handling and command registration

b6308aa

Co-Authored-By: [email protected] <[email protected]>

devin-ai-integration bot and others added 2 commits December 12, 2024 21:50

fix(abigen): Make checksum verification case-insensitive and improve …

9f0a219

…error messages Co-Authored-By: [email protected] <[email protected]>

fix(abigen): Fix context handling and improve solc binary management

40ba0b0

Co-Authored-By: [email protected] <[email protected]>

github-actions bot added the needs-go-generate-ethergo label Dec 12, 2024

devin-ai-integration bot and others added 10 commits December 12, 2024 22:59

chore(tools): Add golangci-lint configuration to handle test imports

6094641

Co-Authored-By: [email protected] <[email protected]>

fix(abigen): Improve checksum verification and error messages

6d437c4

Co-Authored-By: [email protected] <[email protected]>

fix(tools): Fix yaml-lint errors by adding single quotes to string va…

d083893

…lues Co-Authored-By: [email protected] <[email protected]>

fix(abigen): Replace context.Background() with t.Context() in tests

1eb58cc

Co-Authored-By: [email protected] <[email protected]>

fix(abigen): Fix test suite setup and improve solc compilation strategy

c66300f

Co-Authored-By: [email protected] <[email protected]>

fix(tools): Fix lint issues and improve test coverage

49111f1

Co-Authored-By: [email protected] <[email protected]>

fix(tools): Fix field alignment and shadow variables

bb48e05

Co-Authored-By: [email protected] <[email protected]>

fix: Address lint issues and field alignment

ee58481

Co-Authored-By: [email protected] <[email protected]>

fix(tools): Update file permission constants for improved security

2814e92

Co-Authored-By: [email protected] <[email protected]>

fix: Revert golangci and ratelimiter changes per review feedback

bcaf693

Co-Authored-By: [email protected] <[email protected]>

github-actions bot removed the needs-go-generate-contrib/promexporter label Dec 19, 2024

devin-ai-integration bot and others added 4 commits December 19, 2024 17:29

chore: Revert golangci-lint configuration changes

270c8ad

Co-Authored-By: [email protected] <[email protected]>

Merge branch 'master' into devin/1733968581-apple-silicon-solc-fallback

0461c69

Co-Authored-By: [email protected] <[email protected]>

chore: Regenerate fastbridge contract files to resolve merge conflicts

74f9d9d

Co-Authored-By: [email protected] <[email protected]>

chore: Add generated files from go generate

b4d93c3

Co-Authored-By: [email protected] <[email protected]>

devin-ai-integration bot requested review from dwasse, aureliusbtc and ChiTimesChi as code owners December 19, 2024 21:34

github-actions bot added the M-deps label Dec 19, 2024

fix(tools): Fix integer overflow in binary download backoff and updat…

b0f0d41

…e generated contracts Co-Authored-By: [email protected] <[email protected]>

github-actions bot added the Stale label Jan 3, 2025

github-actions bot closed this Jan 9, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(abigen): Add solc binary fallback for Apple Silicon #3455

feat(abigen): Add solc binary fallback for Apple Silicon #3455

devin-ai-integration bot commented Dec 12, 2024 •

edited

Loading

devin-ai-integration bot commented Dec 12, 2024

coderabbitai bot commented Dec 12, 2024 •

edited

Loading

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

Documentation and Community

codecov bot commented Dec 12, 2024 •

edited

Loading

cloudflare-workers-and-pages bot commented Dec 12, 2024 •

edited

Loading

trajan0x commented Dec 12, 2024

coderabbitai bot commented Dec 12, 2024

github-actions bot commented Jan 3, 2025

feat(abigen): Add solc binary fallback for Apple Silicon #3455

feat(abigen): Add solc binary fallback for Apple Silicon #3455

Conversation

devin-ai-integration bot commented Dec 12, 2024 • edited Loading

devin-ai-integration bot commented Dec 12, 2024

🤖 Devin AI Engineer

coderabbitai bot commented Dec 12, 2024 • edited Loading

Review skipped

Walkthrough

Changes

Assessment against linked issues

Possibly related PRs

Suggested labels

Poem

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

Documentation and Community

codecov bot commented Dec 12, 2024 • edited Loading

Codecov Report

cloudflare-workers-and-pages bot commented Dec 12, 2024 • edited Loading

Deploying sanguine-fe with Cloudflare Pages

trajan0x commented Dec 12, 2024

coderabbitai bot commented Dec 12, 2024

github-actions bot commented Jan 3, 2025

devin-ai-integration bot commented Dec 12, 2024 •

edited

Loading

coderabbitai bot commented Dec 12, 2024 •

edited

Loading

codecov bot commented Dec 12, 2024 •

edited

Loading

cloudflare-workers-and-pages bot commented Dec 12, 2024 •

edited

Loading