search

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): Tx to create FunToken mapping from ERC20, contract embeds, and ERC20 queries. #1950

Closed Unique-Divine closed 2 days ago

Unique-Divine commented 1 week ago

Purpose / Abstract

Summary of Changes

  1. Implements a simple Solidity contract inheriting OpenZeppelin's ERC20.sol that serves as the ABI embed for queries of ERC20 metadata
  2. Implements a tx msg that can create a FunToken mapping from an existing ERC20.
  3. Adapts the DeployContract helper function from the evmtest package to accept variadic arguments that will be passed to the constructor of the EVM contract. This is useful for deploying more complex contract types in tests.

Summary by CodeRabbit

coderabbitai[bot] commented 1 week ago

Walkthrough

The recent changes introduce comprehensive updates to the Ethereum Virtual Machine (EVM) functionality, primarily focusing on facilitating the creation of FunToken mappings from existing ERC20 tokens and bank coins. This includes renaming constants, updating structures and methods for compatibility, embedding Solidity contracts for enhanced token functionalities, and revamping testing mechanisms. These changes expand the EVM module's interoperability and functionality within the ecosystem.

Changes

File(s) Change Summary
server_config.go Renamed DefaultGasCap to DefaultEthCallGasLimit and updated the gas limit value.
eth/rpc/rpcapi/eth_api_test.go Updated imports and modified contract data assignment using embeds.CompiledEvmContract.
proto/eth/evm/v1/tx.proto Added CreateFunToken RPC method, and new message types MsgCreateFunToken and MsgCreateFunTokenResponse.
x/evm/const.go, x/evm/deps.go Updated import paths and function signatures for compatibility with gethcommon.
x/evm/embeds/... Introduced new Solidity contract ERC20Minter, added Hardhat project samples, and embedded contract management.
x/evm/evm_test.go Added new test function TestModuleAddressEVM for module address generation.
x/evm/json_tx_args.go Updated JsonTxArgs struct to accept both "data" and "input" fields for backwards compatibility.
x/evm/keeper/... Added functionality for creating ERC20 tokens from bank coins, new methods in keeper package, and unit tests.
x/common/testutil/cli/network.go Adjusted timeout value in a time.Sleep call to address address-in-use errors more effectively.

Sequence Diagram(s)

sequenceDiagram
  participant User
  participant Client
  participant EVM Module
  participant Bank Module

  User->>Client: Request creation of FunToken from ERC20 token
  Client->>EVM Module: Initiate CreateFunToken RPC
  EVM Module->>EVM Module: Validate inputs and deploy FunToken contract
  EVM Module->>Bank Module: Store ERC20 token metadata
  Bank Module-->>EVM Module: Confirmation of metadata storage
  EVM Module-->>Client: Response with FunToken details
  Client-->>User: FunToken creation successful

Assessment against linked issues

Objective Addressed Explanation
Implement CreateFunTokenFromERC20 (Issue #1941) ✅
Implement CreateFunTokenFromCoin (Issue #1942) ✅

Poem

In the world of blocks and chains,
A token's magic now remains.
From ERC20 seeds, it sprouts,
And bank coins, too, with joyous shouts.
The FunToken's dance, a sight to see,
Ethereum dreams in harmony.

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 1 week ago

Codecov Report

Attention: Patch coverage is 64.59459% with 131 lines in your changes missing coverage. Please review.

Project coverage is 65.34%. Comparing base (1b758bb) to head (97f21cf). Report is 1 commits behind head on main.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #1950 +/- ## ========================================== + Coverage 64.83% 65.34% +0.50% ========================================== Files 253 253 Lines 16065 16092 +27 ========================================== + Hits 10416 10515 +99 + Misses 4892 4805 -87 - Partials 757 772 +15 ``` | [Files](https://app.codecov.io/gh/NibiruChain/nibiru/pull/1950?dropdown=coverage&src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=NibiruChain) | Coverage Δ | | |---|---|---| | [x/common/testutil/cli/network.go](https://app.codecov.io/gh/NibiruChain/nibiru/pull/1950?src=pr&el=tree&filepath=x%2Fcommon%2Ftestutil%2Fcli%2Fnetwork.go&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=NibiruChain#diff-eC9jb21tb24vdGVzdHV0aWwvY2xpL25ldHdvcmsuZ28=) | `76.98% <100.00%> (+0.12%)` | :arrow_up: | | [x/evm/json\_tx\_args.go](https://app.codecov.io/gh/NibiruChain/nibiru/pull/1950?src=pr&el=tree&filepath=x%2Fevm%2Fjson_tx_args.go&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=NibiruChain#diff-eC9ldm0vanNvbl90eF9hcmdzLmdv) | `98.49% <ø> (ø)` | | | [x/evm/keeper/precompiles.go](https://app.codecov.io/gh/NibiruChain/nibiru/pull/1950?src=pr&el=tree&filepath=x%2Fevm%2Fkeeper%2Fprecompiles.go&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=NibiruChain#diff-eC9ldm0va2VlcGVyL3ByZWNvbXBpbGVzLmdv) | `0.00% <ø> (ø)` | | | [x/evm/const.go](https://app.codecov.io/gh/NibiruChain/nibiru/pull/1950?src=pr&el=tree&filepath=x%2Fevm%2Fconst.go&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=NibiruChain#diff-eC9ldm0vY29uc3QuZ28=) | `60.00% <75.00%> (+60.00%)` | :arrow_up: | | [x/evm/keeper/erc20\_from\_coin.go](https://app.codecov.io/gh/NibiruChain/nibiru/pull/1950?src=pr&el=tree&filepath=x%2Fevm%2Fkeeper%2Ferc20_from_coin.go&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=NibiruChain#diff-eC9ldm0va2VlcGVyL2VyYzIwX2Zyb21fY29pbi5nbw==) | `76.00% <76.00%> (ø)` | | | [x/evm/keeper/msg\_server.go](https://app.codecov.io/gh/NibiruChain/nibiru/pull/1950?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=) | `62.99% <54.83%> (+1.71%)` | :arrow_up: | | [x/evm/msg.go](https://app.codecov.io/gh/NibiruChain/nibiru/pull/1950?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) | `69.10% <5.26%> (-5.46%)` | :arrow_down: | | [x/evm/embeds/embeds.go](https://app.codecov.io/gh/NibiruChain/nibiru/pull/1950?src=pr&el=tree&filepath=x%2Fevm%2Fembeds%2Fembeds.go&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=NibiruChain#diff-eC9ldm0vZW1iZWRzL2VtYmVkcy5nbw==) | `66.17% <66.17%> (ø)` | | | [x/evm/keeper/erc20.go](https://app.codecov.io/gh/NibiruChain/nibiru/pull/1950?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) | `82.69% <82.69%> (ø)` | | | [x/evm/evmtest/tx.go](https://app.codecov.io/gh/NibiruChain/nibiru/pull/1950?src=pr&el=tree&filepath=x%2Fevm%2Fevmtest%2Ftx.go&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=NibiruChain#diff-eC9ldm0vZXZtdGVzdC90eC5nbw==) | `0.00% <0.00%> (ø)` | | ... and [3 files with indirect coverage changes](https://app.codecov.io/gh/NibiruChain/nibiru/pull/1950/indirect-changes?src=pr&el=tree-more&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=NibiruChain)