NibiruChain / nibiru

Nibiru Chain: The breakthrough smart contract platform ushering in the next era of money. Nibiru powers an ecosystem of dApps including perps, RWAs, and more.
https://nibiru.fi
Apache License 2.0
178 stars 208 forks source link

feat(evm): msg to send bank coin to erc20 #1956

Closed onikonychev closed 1 day ago

onikonychev commented 1 week ago

Summary by CodeRabbit

coderabbitai[bot] commented 1 week ago

Walkthrough

This update introduces functionality for sending bank coins as ERC20 tokens within the EVM module. This feature is driven by the creation and transfer of "FunTokens" and involves changes in the event definitions, message handling, CLI commands, and key module functions. Additionally, various tests and utility functions have been refactored or added to ensure this new feature operates smoothly.

Changes

File/Directory Summary of Changes
CHANGELOG.md Added description of new features related to bank coin to ERC20 functionality.
proto/eth/evm/v1/events.proto, proto/eth/evm/v1/tx.proto Updated to include new message definitions and RPC endpoints.
x/evm/cli/cli.go Added CLI commands for creating ERC20 tokens from bank coins and sending them.
x/evm/deps.go Updated AccountKeeper interface to include SetModuleAccount and GetModuleAccount methods.
x/evm/evmmodule/genesis.go Modified InitGenesis function to use GetModuleAccount.
x/evm/keeper/erc20_test.go Added tests for sending FunTokens from bank coins to ERC20 contracts.
x/evm/keeper/msg_server.go Modified CreateFunToken function and added SendFunTokenToEvm function.
x/evm/msg.go Adjusted validation logic and signer handling for new message types.
x/evm/keeper/erc20.go Refactored LoadERC20BigInt function to include commit control.
x/evm/evmtest/eth_test.go, x/evm/evmtest/smart_contract_test.go Renamed structs and functions for better clarity. Added tests for ERC20 helper functions.
New changeset: x/evm/precompile/funtoken_test.go Removed CreateFunTokenForBankCoin, refactored function calls, and adjusted ERC20 minting test cases.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant CLI
    participant TxHandler
    participant EVMModule
    participant EventManager

    User ->> CLI: issue CmdCreateFunTokenFromBankCoin
    CLI ->> TxHandler: Broadcast MsgCreateFunToken
    TxHandler ->> EVMModule: Process MsgCreateFunToken
    EVMModule ->> EventManager: Emit EventFunTokenFromBankCoin

    User ->> CLI: issue SendFunTokenToEvm
    CLI ->> TxHandler: Broadcast MsgSendFunTokenToEvm
    TxHandler ->> EVMModule: Process MsgSendFunTokenToEvm
    EVMModule ->> EventManager: Emit EventSendFunTokenToEvm

Possibly related issues

Poem

In the realm where tokens weave, FunTokens now can achieve, To ERC20 they shall transform, In a dance that becomes the norm. New commands for coins to flow, Watch the CLI magic grow! 🌟


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 .` - `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.` - `@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 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 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. 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](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](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
codecov[bot] commented 2 days ago

Codecov Report

Attention: Patch coverage is 77.66990% with 23 lines in your changes missing coverage. Please review.

Project coverage is 65.66%. Comparing base (a5ff022) to head (b8e1b59).

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #1956 +/- ## ========================================== + Coverage 65.31% 65.66% +0.35% ========================================== Files 256 256 Lines 16295 16392 +97 ========================================== + Hits 10643 10764 +121 + Misses 4857 4829 -28 - Partials 795 799 +4 ``` | [Files](https://app.codecov.io/gh/NibiruChain/nibiru/pull/1956?dropdown=coverage&src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=NibiruChain) | Coverage Ξ” | | |---|---|---| | [x/evm/keeper/erc20.go](https://app.codecov.io/gh/NibiruChain/nibiru/pull/1956?src=pr&el=tree&filepath=x%2Fevm%2Fkeeper%2Ferc20.go&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=NibiruChain#diff-eC9ldm0va2VlcGVyL2VyYzIwLmdv) | `83.17% <100.00%> (+18.24%)` | :arrow_up: | | [x/evm/precompile/funtoken.go](https://app.codecov.io/gh/NibiruChain/nibiru/pull/1956?src=pr&el=tree&filepath=x%2Fevm%2Fprecompile%2Ffuntoken.go&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=NibiruChain#diff-eC9ldm0vcHJlY29tcGlsZS9mdW50b2tlbi5nbw==) | `54.83% <ΓΈ> (ΓΈ)` | | | [x/evm/evmtest/erc20.go](https://app.codecov.io/gh/NibiruChain/nibiru/pull/1956?src=pr&el=tree&filepath=x%2Fevm%2Fevmtest%2Ferc20.go&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=NibiruChain#diff-eC9ldm0vZXZtdGVzdC9lcmMyMC5nbw==) | `84.78% <94.59%> (+84.78%)` | :arrow_up: | | [x/evm/keeper/msg\_server.go](https://app.codecov.io/gh/NibiruChain/nibiru/pull/1956?src=pr&el=tree&filepath=x%2Fevm%2Fkeeper%2Fmsg_server.go&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=NibiruChain#diff-eC9ldm0va2VlcGVyL21zZ19zZXJ2ZXIuZ28=) | `69.62% <88.88%> (+3.09%)` | :arrow_up: | | [x/evm/msg.go](https://app.codecov.io/gh/NibiruChain/nibiru/pull/1956?src=pr&el=tree&filepath=x%2Fevm%2Fmsg.go&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=NibiruChain#diff-eC9ldm0vbXNnLmdv) | `65.13% <0.00%> (-3.98%)` | :arrow_down: | ... and [2 files with indirect coverage changes](https://app.codecov.io/gh/NibiruChain/nibiru/pull/1956/indirect-changes?src=pr&el=tree-more&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=NibiruChain)