Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add bridge call refund callback #484

Merged
merged 1 commit into from
May 15, 2024
Merged

feat: add bridge call refund callback #484

merged 1 commit into from
May 15, 2024

Conversation

zakir-code
Copy link
Contributor

@zakir-code zakir-code commented May 15, 2024

Summary by CodeRabbit

  • New Features

    • Introduced Ethereum contract binding for refund callbacks.
    • Added a new interface IRefundCallback for handling refund callbacks in Solidity.
    • New event type EventTypeBridgeCallRefundOut for bridge call refunds.
  • Improvements

    • Enhanced session management for Ethereum contract interactions.
    • Improved import structure in Solidity contracts for better modularity.
  • Bug Fixes

    • Corrected event type in bridge call handling from EventTypeBridgeCallRefund to EventTypeBridgeCallRefundOut.
  • Refactor

    • Cleaned up Solidity configuration by removing one-contract-per-file rule.
    • Refactored import statements for better code organization.

Copy link

coderabbitai bot commented May 15, 2024

Walkthrough

The recent updates introduce a new Ethereum contract binding for refund callbacks, modify import statements for better modularity, and enhance the bridge call refund handling in the crosschain module. Key changes include the addition of new structs and functions for contract interactions, updates to event types, and improvements to the Keeper struct in the crosschain module for Ethereum contract interactions.

Changes

File(s) Change Summary
contract/IRefundCallback.go, contract/compile.sh, contract/contract.go Added new Ethereum contract binding for refund callbacks, updated compile script, and introduced ABI-related functions.
solidity/contracts/bridge/FxBridgeLogic.sol, solidity/contracts/bridge/FxBridgeLogicETH.sol, solidity/contracts/bridge/IBridgeCallback.sol, solidity/contracts/bridge/IRefundCallback.sol Modified import statements for better modularity and introduced a new interface for refund callbacks.
solidity/.solhint.json Removed one-contract-per-file configuration.
x/crosschain/keeper/bridge_call_in.go, x/crosschain/keeper/bridge_call_in_test.go Updated event type from EventTypeBridgeCallRefund to EventTypeBridgeCallRefundOut.
x/crosschain/keeper/bridge_call_refund.go, x/crosschain/keeper/keeper.go Enhanced bridge call refund handling and added Ethereum-related fields and imports in the Keeper struct.
x/crosschain/mock/expected_keepers_mocks.go Added GetAccount mock methods to MockEVMKeeper.
x/crosschain/types/events.go Introduced a new constant EventTypeBridgeCallRefundOut.
x/crosschain/types/expected_keepers.go Added GetAccount method to EVMKeeper interface.
x/crosschain/types/types.go Added ERC20Tokens type and methods for extracting contract addresses and amounts.
x/evm/precompiles/crosschain/bridge_call.go Modified return statement in BridgeCall function to return eventNonce.

🐇
In the world of code, where bytes do dance,
New contracts bloom, enhancing our stance.
Refunds now flow with structured grace,
Events renamed, keeping pace.
Ethereum whispers in Keeper's ear,
A bridge of logic, crystal clear.
🐰


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 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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.

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

@zakir-code
Copy link
Contributor Author

mg

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.

1 participant