PundiAI / fx-core

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

chore: rename cross chain to crosschain #750

Closed zakir-code closed 4 days ago

zakir-code commented 4 days ago

Summary by CodeRabbit

coderabbitai[bot] commented 4 days ago

Walkthrough

The pull request includes extensive renaming and restructuring of the CrossChain terminology across multiple files in the codebase. This involves changing instances of CrossChain to Crosschain for consistency in naming conventions, affecting structs, interfaces, variables, and method signatures. Additionally, some methods have been updated to enhance error handling, particularly by introducing error return types. The overall functionality and logic of the code remain unchanged, focusing primarily on standardizing naming conventions and improving clarity.

Changes

File Path Change Summary
app/keepers/keepers.go Renamed CrossChainKeepers to CrosschainKeepers, and precompileRouter to crosschainPrecompileRouter.
app/modules.go Updated method call from app.CrossChainKeepers.ToSlice() to app.CrosschainKeepers.ToSlice().
contract/ICrossChain.go Renamed ICrossChain and related variables/types to ICrosschain.
contract/compile.sh Updated contract names from ICrossChain to ICrosschain and CrossChainTest to CrosschainTest.
contract/contract.go Renamed constant CrossChainAddress to CrosschainAddress.
solidity/contracts/bridge/BridgeFeeOracle.sol Updated import statement from ICrossChain to ICrosschain.
solidity/contracts/bridge/ICrosschain.sol Renamed interface from ICrossChain to ICrosschain.
solidity/contracts/test/CrosschainTest.sol Updated references to ICrossChain to ICrosschain, and renamed contract from CrossChainTest to CrosschainTest.
tests/contract/CrossChainTest.go Renamed CrossChainTest references to CrosschainTest.
x/crosschain/keeper/bridge_call_out.go Renamed method CrossChainBaseCoin to CrosschainBaseCoin.
x/crosschain/keeper/keeper_router.go Updated comment for NewRouterKeeper from "cross chain keeper" to "crosschain keeper".
x/crosschain/keeper/keeper_test.go Renamed method CrossChainParams to CrosschainParams.
x/crosschain/keeper/many_to_one.go Changed return type of AfterIBCAckSuccess from void to error.
x/crosschain/keeper/msg_server_router.go Updated error message from "Unrecognized cross chain type" to "Unrecognized crosschain type".
x/crosschain/precompile/bridge_call_test.go Renamed interface ICrossChainBridgeCallEvent to ICrosschainBridgeCallEvent.
x/crosschain/precompile/contract.go Renamed method NewCrossChainMethod to NewCrosschainMethod.
x/crosschain/precompile/contract_test.go Renamed method CrossChainKeepers to CrosschainKeepers.
x/crosschain/precompile/crosschain.go Renamed CrossChainMethod to CrosschainMethod and updated related method signatures.
x/crosschain/precompile/crosschain_test.go Renamed test function from TestCrossChainABI to TestCrosschainABI.
x/crosschain/precompile/expected_keepers.go Renamed method CrossChainBaseCoin to CrosschainBaseCoin.
x/crosschain/precompile/has_oracle_test.go Renamed test function from TestCrossChainHasOracleABI to TestCrosschainHasOracleABI.
x/crosschain/precompile/is_oracle_online_test.go Renamed test function from TestCrossChainIsOracleOnlineABI to TestCrosschainIsOracleOnlineABI.
x/crosschain/precompile/keeper.go Renamed parameter crossChainKeeper to crosschainKeeper.
x/crosschain/types/contract.go Renamed variables crossChainAddress and crossChainABI to crosschainAddress and crosschainABI.
x/crosschain/types/external_address.go Updated error messages from "cross chain" to "crosschain" in multiple functions.
x/crosschain/types/legacy.go Changed error message in UpdateChainOraclesProposal from "unrecognized cross chain name" to "unrecognized crosschain name".
x/crosschain/types/msgs.go Renamed interface CrossChainMsg to CrosschainMsg and updated error messages in validation methods.
x/crosschain/types/msgs_test.go Updated error messages in validation tests for various message types.
x/erc20/types/token.go Changed comment from "todo" to "TODO" in BridgeDenom method.
x/gov/keeper/keeper_test.go Renamed test case from "set CrossChainParam" to "set CrosschainParam".
x/ibc/middleware/keeper/keeper.go Renamed field crossChainKeeper to crosschainKeeper.
x/ibc/middleware/keeper/relay.go Updated references from crossChainKeeper to crosschainKeeper in multiple methods.
x/ibc/middleware/types/expected_keepers.go Renamed interface CrossChainKeeper to CrosschainKeeper, updated method signature to include error return type.

Possibly related PRs

🐰 In the land of code, where changes abound,
A rabbit hops softly, with new names profound.
Crosschain is here, clear as can be,
With functions renamed, oh what a spree!
Consistency reigns, like carrots in rows,
In the garden of logic, where clarity grows! 🌱✨


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.
fx0x55 commented 4 days ago

@coderabbitai full review

coderabbitai[bot] commented 4 days ago
:white_check_mark: Actions performed Full review triggered.