PundiAI / fx-core

https://functionx.gitbook.io
Apache License 2.0
21 stars 14 forks source link

refactor(ibc): refine the conversion logic between ibc coin and base coin during ibc transfer #723

Closed zakir-code closed 1 week ago

zakir-code commented 1 week ago

Summary by CodeRabbit

coderabbitai[bot] commented 1 week ago

Walkthrough

The pull request encompasses modifications across multiple files, primarily focusing on enhancing cross-chain functionality within the application. Key changes include updates to the Makefile for linting checks, the introduction of new methods and parameters in various keeper files, and the restructuring of interfaces to accommodate cross-chain operations. Additionally, several test cases have been removed or modified to align with these changes, indicating a shift in the testing strategy for cross-chain functionality.

Changes

File Path Change Summary
Makefile Updated the check-no-lint target to change the threshold for nolint or #nosec comments from 32 to 31 occurrences.
app/keepers/keepers.go Modified NewAppKeeper to include EthKeeper in NewPrecompiledContract and updated IBCMiddlewareKeeper to use EthKeeper instead of Erc20Keeper.
types/target.go Added a new method String() to the FxTarget struct for string representation based on the isIBC field.
x/crosschain/keeper/abci_test.go Added import for ibctransfertypes, updated TestABCIEndBlockDepositClaim to include denomTrace and ibcDenom, and modified TestOracleUpdate to accommodate new token handling.
x/crosschain/keeper/keeper_v1_test.go Introduced SetIBCDenom method to KeeperTestSuite for setting up IBC denomination traces.
x/crosschain/keeper/many_to_one.go Added methods for handling IBC coins, including IBCCoinToBaseCoin, BaseCoinToIBCCoin, IBCCoinToEvm, IBCCoinRefund, and AfterIBCAckSuccess. Modified BaseDenomToBridgeDenom for IBC token checks.
x/crosschain/keeper/send_to_fx.go Updated SendToFxExecuted, RelayTransferHandler, and transferIBCHandler methods to enhance coin transfer handling and introduced telemetry metrics.
x/crosschain/mock/expected_keepers_mocks.go Added new methods to MockErc20Keeper and MockIBCTransferKeeper, including DeleteIBCTransferRelation, IbcRefund, and GetDenomTrace.
x/crosschain/precompile/contract.go Updated NewPrecompiledContract to include a new crossChainKeeper parameter.
x/crosschain/precompile/crosschain_test.go Removed multiple test cases from TestCrossChainIBC and TestCrossChainIBCExternal, indicating a simplification of the testing strategy.
x/crosschain/precompile/expected_keepers.go Introduced CrossChainKeeper interface with a method for converting base coins to IBC coins.
x/crosschain/precompile/keeper.go Added crossChainKeeper field to Keeper struct and modified ibcTransfer method to include coin conversion logic.
x/crosschain/types/expected_keepers.go Added methods to Erc20Keeper and IBCTransferKeeper interfaces, and introduced a new import for tmbytes.
x/erc20/keeper/transfer_relation.go Renamed RefundAfter to IbcRefund and changed its return type to error, simplifying the refund process.
x/ibc/middleware/keeper/keeper.go Removed refundHook and erc20Keeper fields from Keeper struct, added crossChainKeeper, and updated NewKeeper constructor accordingly.
x/ibc/middleware/keeper/relay.go Modified OnRecvPacket, OnAcknowledgementPacket, and refundPacketTokenHook methods to streamline IBC handling and remove previous checks for refundHook.
x/ibc/middleware/keeper/relay_test.go Removed several import statements and commented out the TestOnRecvPacket function, along with updates to address handling in test cases.
x/ibc/middleware/types/expected_keepers.go Introduced CrossChainKeeper interface, removed RefundHook and Erc20Keeper interfaces, and added relevant methods for cross-chain operations.

Possibly related PRs

🐰 In the meadow, where the bunnies play,
New changes hop in, brightening the day.
With coins that cross from here to there,
Our code's now spry, with nary a care!
Let's cheer for the keepers, the tests, and the fun,
For cross-chain magic has only begun! 🐇✨


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](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
🪧 Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , 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 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.