refactor: use bridgeCallback

[zakir-code]

Summary by CodeRabbit

• New Features

  • Introduced IBridgeCallback functionality for interacting with Ethereum contracts.
  • Added CoinsToBridgeCallTokens function to convert sdk.Coins to bridge call tokens.
  • Introduced PackBridgeCallback function for packing arguments in bridge callback operations.
  • Added GetCallbackFrom method to retrieve callback addresses.

• Improvements

  • Enhanced BridgeCallHandler function to handle memo parameters.
  • Added new test cases to validate bridge callback data packing.

• Bug Fixes

  • Updated logic in BridgeCallTransferAndCallEvm to correctly manage memo parameters.

[coderabbitai]

Walkthrough

The changes introduce a new Ethereum contract IBridgeCallback and its associated functionalities, including binding, interaction methods, and session management. Additionally, the cross-chain module has been updated to handle bridge callback operations, including token conversion, memo handling, and ABI packing. New tests and mock methods ensure the correctness of these features.

Changes

File Path	Change Summary
contract/IBridgeCallback.go	Added bindings and interaction methods for the IBridgeCallback Ethereum contract.
contract/compile.sh	Included IBridgeCallback in the contracts array for compilation.
contract/contract.go	Added GetBridgeCallBridgeCallback() function to retrieve specific ABI for bridge callbacks.
x/crosschain/keeper/bridge_call_in.go	Updated BridgeCallHandler logic, added memo handling, and introduced token conversion function.
x/crosschain/keeper/bridge_call_in_test.go	Added imports, updated BridgeCallHandler test expectations, and introduced token conversion tests.
x/crosschain/keeper/keeper.go	Added GetCallbackFrom() method to the Keeper struct.
x/crosschain/mock/expected_keepers_mocks.go	Added mocked GetTokenPair method in MockErc20Keeper.
x/crosschain/types/abi.go	Introduced PackBridgeCallback function for packing bridge callback arguments.
x/crosschain/types/abi_test.go	Added tests for PackBridgeCallback function.
x/crosschain/types/expected_keepers.go	Added GetTokenPair method to the Erc20Keeper interface.
x/crosschain/types/msgs.go	Added MustMemo() method to MsgBridgeCallClaim for memo data handling.

A bridge of code, both near and far,
Tokens dance like twinkling stars.
From memos packed to callbacks clear,
Cross-chain whispers, loud and near.
In tests and mocks, we trust and cheer,
For seamless flows, we engineer.

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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 an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to full the review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @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.

[coderabbitai]

Actionable comments posted: 3

Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 6df6c36 and 69196a4.

Files selected for processing (11)

• contract/IBridgeCallback.go (1 hunks)
• contract/compile.sh (1 hunks)
• contract/contract.go (2 hunks)
• x/crosschain/keeper/bridge_call_in.go (5 hunks)
• x/crosschain/keeper/bridge_call_in_test.go (3 hunks)
• x/crosschain/keeper/keeper.go (1 hunks)
• x/crosschain/mock/expected_keepers_mocks.go (1 hunks)
• x/crosschain/types/abi.go (1 hunks)
• x/crosschain/types/abi_test.go (1 hunks)
• x/crosschain/types/expected_keepers.go (1 hunks)
• x/crosschain/types/msgs.go (1 hunks)

Additional comments not posted (15)

x/crosschain/types/abi.go (1)

11-21: The implementation of PackBridgeCallback correctly packs the parameters for a bridge callback operation. This function is crucial for ensuring that the data is correctly formatted for blockchain transactions. The use of contract.GetBridgeCallBridgeCallback().Pack suggests a well-structured approach to handling ABI packing, which is essential for interacting with smart contracts.

contract/compile.sh (1)

34-34: Adding IBridgeCallback to the contracts array ensures that it is compiled along with other contracts. This change is necessary for the new functionality introduced in the PR and aligns with the PR's objectives to enhance Ethereum contract interactions.

x/crosschain/types/abi_test.go (1)

14-66: The test TestPackBridgeCallback is well-structured and covers the functionality of the PackBridgeCallback function comprehensively. It checks both the success scenario and the error handling, which is crucial for ensuring the robustness of the packing functionality. The use of structured inputs and expected outputs helps in understanding the test flow and ensures that the function behaves as expected under different conditions.
[APROVED]

x/crosschain/keeper/keeper.go (1)

67-69: The method GetCallbackFrom is a straightforward getter for the callbackFrom field. It's a simple yet essential addition for retrieving the address used for callbacks, which is likely used across various operations in the keeper. This method enhances the modularity and encapsulation of the keeper's functionality.

x/crosschain/keeper/bridge_call_in_test.go (2)

46-53: The test modifications in TestBridgeCallHandler are aligned with the changes in the keeper logic. The addition of mock expectations for GetTokenPair and CallEVM reflects the updated logic in the BridgeCallHandler function, ensuring that the tests remain relevant and effective in verifying the new functionality. It's good to see thorough testing of error handling and refund logic, which are critical aspects of transaction handling.

---

113-132: The new test Test_CoinsToBridgeCallTokens effectively tests the conversion of sdk.Coins to bridge call tokens. The detailed assertions check both the tokens and amounts, ensuring that the conversion logic is correctly implemented. This test is crucial for validating the new utility function and its integration with the ERC20 keeper.

x/crosschain/types/expected_keepers.go (1)

72-72: The addition of GetTokenPair to the Erc20Keeper interface is a necessary update to support the new functionalities related to token handling in the cross-chain operations. This method will likely be used extensively to fetch token pair information, which is crucial for various operations involving ERC20 tokens.

x/crosschain/keeper/bridge_call_in.go (2)

67-67: Parameter addition to function signature.

The addition of the memo parameter to BridgeCallTransferAndCallEvm aligns with the PR objectives to handle additional data.

---

162-176: New function implementation.

The implementation of CoinsToBridgeCallTokens correctly converts sdk.Coins to bridge call tokens. Ensure comprehensive unit tests cover edge cases, such as zero amounts or invalid denominations.

contract/IBridgeCallback.go (3)

33-35: Metadata declaration for Ethereum contract.

The metadata for IBridgeCallback is correctly defined with appropriate ABI details. This is crucial for the contract's interaction with the Ethereum blockchain.

---

101-107: Creation of a new contract instance.

The function NewIBridgeCallback properly initializes a new instance of the contract with all necessary bindings. This is essential for interacting with the contract on the blockchain.

---

183-202: Implementation of the BridgeCallback transaction method.

The BridgeCallback method is implemented across different contract interaction styles (raw, session, transactor), providing flexibility in contract operations.

contract/contract.go (2)

48-48: Initialization of bridgeCallBridgeCallback looks correct and follows the established pattern for ABI initialization.

---

82-84: The function GetBridgeCallBridgeCallback correctly returns the ABI for bridge callbacks, aligning with the new functionality introduced in the PR.

x/crosschain/mock/expected_keepers_mocks.go (1)

526-533: The implementation of GetTokenPair in MockErc20Keeper correctly mocks the expected behavior as per the interface it represents. Ensure that the actual Erc20Keeper has a corresponding method with the same signature.