BindGen - local contracts refactor

[Spacesai1or]

This PR is refactoring the existing bindings generation code to better fit with an extension of the code to allow for bindings created for remotely sourced contracts (#8281). For the most part, the original code isn't modified other than breaking out code into smaller functions

[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.

[Spacesai1or]

Currently blocked by #8269

[coderabbitai]

Walkthrough

Walkthrough

The changes involve a significant update to the Go package responsible for generating Ethereum smart contract bindings. A new bindgen tool has been introduced, replacing the previous generation command. This tool comes with new CLI flags and altered functions for error handling and logging. The Makefile has been updated to accommodate these changes. Additionally, the visibility of certain functions has been modified to be public, as indicated by the capitalization of their names.

Changes

File Path	Change Summary
op-bindings/Makefile	Updated build process to use new bindgen tool with additional parameters for binding generation.
op-bindings/bindgen/generator_local.go	Added new types and functions for generating bindings and metadata for local contracts, with error handling and logging.
op-bindings/bindgen/main.go	Introduced new main package with types and functions for setting up binding generation, including CLI flags and configuration parsing.
op-bindings/bindgen/utils.go	New package with functions for reading contracts, handling artifacts, and generating Go bindings using abigen.
indexer/config/devnet.go op-e2e/config/init.go	Renamed findMonorepoRoot to FindMonorepoRoot to make the function public.

---

Tips

Chat with CodeRabbit Bot (@coderabbitai)

• If you reply to a review comment from CodeRabbit, the bot will automatically respond.
• To engage with CodeRabbit bot directly around the specific lines of code in the PR, mention @coderabbitai in your review comment
• Note: Review comments are made on code diffs or files, not on the PR overview.
• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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.

Note: For conversation with the bot, please use the review comments on code diffs or files.

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

[coderabbitai]

Review Status

Actionable comments generated: 4

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between ec6a2bd and a36df5d.

Files ignored due to filter (1)

• op-bindings/artifacts.json

Files selected for processing (4)

• op-bindings/Makefile (2 hunks)
• op-bindings/bindgen/generator_local.go (1 hunks)
• op-bindings/bindgen/main.go (1 hunks)
• op-bindings/bindgen/utils.go (1 hunks)

Additional comments: 5

op-bindings/Makefile (4)

• 9-9: The all target correctly depends on bindgen-local as per the changes described.

• 26-36: The bindgen-generate-local rule correctly invokes the Go script with the necessary parameters.

• 24-24: The bindgen-local target correctly depends on compile and bindgen-generate-local.

• 38-39: The mkdir target is correctly defined to ensure the necessary directory exists.

op-bindings/bindgen/utils.go (1)

• 110-111: Ensure that the abigen tool is installed and available in the system's PATH as the genContractBindings function relies on it.

[hamdiallam]

Looks really great! Left a few comments

[hamdiallam]

Looks good after another pass, great code!

Mainly reviewed by just looking at the logic & not actually running it locally to verify -- i'm sure you've verified expected behavior locally

[mslipper]

I've verified that these changes are drop-in replacements for the existing bindings functionality, and generate the same output as the original bindings script. LGTM.