Skip to content

Conversation

@mkysel
Copy link
Collaborator

@mkysel mkysel commented May 27, 2025

Remove binary file requirements from abigen script and eliminate contract deployment functionality from generated Go bindings

The changes remove binary file (.bin.json) handling from the contract code generation process and eliminate deployment functionality from all generated Go contract bindings:

• Modified dev/gen/abi script to remove binary file downloading and the --bin parameter from go tool abigen command
• Removed Bin fields, binary variables, and Deploy* functions from seven contract bindings: GroupMessageBroadcaster, IdentityUpdateBroadcaster, NodeRegistry, PayerRegistry, PayerReportManager, RateRegistry, and SettlementChainParameterRegistry
• Generated Go bindings now only contain ABI-based functionality for interacting with existing contracts, not deploying new ones

📍Where to Start

Start with the dev/gen/abi script to understand how the binary file requirements were removed from the code generation process.


Macroscope summarized 3bd15c0.

Summary by CodeRabbit

  • Refactor
    • Removed deprecated contract deployment features from several modules, streamlining the interface for interacting with existing smart contracts.
  • Chores
    • Cleaned up legacy variables and functions related to contract deployment to improve maintainability.

@mkysel mkysel requested a review from a team as a code owner May 27, 2025 16:16
@coderabbitai
Copy link
Contributor

coderabbitai bot commented May 27, 2025

Walkthrough

This change removes all deprecated contract deployment functions and associated compiled bytecode variables from several Ethereum contract binding packages. The affected packages now only provide bindings for interacting with already deployed contracts, and no longer support deploying new contract instances directly through their Go APIs.

Changes

File(s) Change Summary
pkg/abi/groupmessagebroadcaster/GroupMessageBroadcaster.go Removed GroupMessageBroadcasterBin variable and DeployGroupMessageBroadcaster function.
pkg/abi/identityupdatebroadcaster/IdentityUpdateBroadcaster.go Removed IdentityUpdateBroadcasterBin variable and DeployIdentityUpdateBroadcaster function.
pkg/abi/noderegistry/NodeRegistry.go Removed NodeRegistryBin variable and DeployNodeRegistry function.
pkg/abi/payerregistry/PayerRegistry.go Removed PayerRegistryBin variable and DeployPayerRegistry function.
pkg/abi/payerreportmanager/PayerReportManager.go Removed PayerReportManagerBin variable and DeployPayerReportManager function.
pkg/abi/rateregistry/RateRegistry.go Removed RateRegistryBin variable and DeployRateRegistry function.
pkg/abi/settlementchainparameterregistry/SettlementChainParameterRegistry.go Removed SettlementChainParameterRegistryBin variable and DeploySettlementChainParameterRegistry function.

Possibly related PRs

  • Use pre-baked image for all anvil-based tests #823: Removes dynamic contract deployments in tests and replaces them with pre-baked contract addresses and images, making the deployment functions and bytecode variables obsolete, which are now removed in this PR.

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between cc8f71d and 3bd15c0.

⛔ Files ignored due to path filters (1)
  • dev/gen/abi is excluded by !**/gen/**
📒 Files selected for processing (7)
  • pkg/abi/groupmessagebroadcaster/GroupMessageBroadcaster.go (0 hunks)
  • pkg/abi/identityupdatebroadcaster/IdentityUpdateBroadcaster.go (0 hunks)
  • pkg/abi/noderegistry/NodeRegistry.go (0 hunks)
  • pkg/abi/payerregistry/PayerRegistry.go (0 hunks)
  • pkg/abi/payerreportmanager/PayerReportManager.go (0 hunks)
  • pkg/abi/rateregistry/RateRegistry.go (0 hunks)
  • pkg/abi/settlementchainparameterregistry/SettlementChainParameterRegistry.go (0 hunks)
💤 Files with no reviewable changes (7)
  • pkg/abi/groupmessagebroadcaster/GroupMessageBroadcaster.go
  • pkg/abi/identityupdatebroadcaster/IdentityUpdateBroadcaster.go
  • pkg/abi/payerreportmanager/PayerReportManager.go
  • pkg/abi/payerregistry/PayerRegistry.go
  • pkg/abi/settlementchainparameterregistry/SettlementChainParameterRegistry.go
  • pkg/abi/rateregistry/RateRegistry.go
  • pkg/abi/noderegistry/NodeRegistry.go
⏰ Context from checks skipped due to timeout of 90000ms (4)
  • GitHub Check: Push Docker Images to GitHub Packages (xmtpd-cli)
  • GitHub Check: Push Docker Images to GitHub Packages (xmtpd)
  • GitHub Check: Upgrade Tests
  • GitHub Check: Test (Node)
✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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>, please review it.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @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.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • 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/schema.v2.json

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.

@graphite-app
Copy link

graphite-app bot commented May 27, 2025

How to use the Graphite Merge Queue

Add either label to this PR to merge it via the merge queue:

  • Queue - adds this PR to the back of the merge queue
  • Hotfix - for urgent hot fixes, skip the queue and merge this PR next

You must have a Graphite account in order to use the merge queue. Sign up using this link.

An organization admin has enabled the Graphite Merge Queue in this repository.

Please do not merge from GitHub as this will restart CI on PRs being processed by the merge queue.

@mkysel mkysel merged commit 92b270d into main May 27, 2025
10 checks passed
@mkysel mkysel deleted the mkysel/no-bin branch May 27, 2025 16:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants