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): EVM fungible token protobufs and encoding tests #1936

Closed Unique-Divine closed 2 weeks ago

Unique-Divine commented 2 weeks ago

Purpose / Abstract

This pull request implements the FunToken type outline in the spec for #1898 along with related key-value stores for reading and writing these coin and ERC20 mappings.

A special string type called HexAddr was added in order to maintain a safe, direct conversion between strings and the go-ethereum/common.Address (ERC-55 Ethereum address) so that we can use Eth addresses as a gogoproto.customtype

Summary by CodeRabbit

coderabbitai[bot] commented 2 weeks ago

Walkthrough

These changes introduce several enhancements to the Ethereum Virtual Machine (EVM) module within the NibiruChain project. The primary updates include the addition of a FunToken message for handling fungible tokens in Protobuf format, corresponding tests for the HexAddr, updates to type handling, initializations in the Keeper struct, and modifications to event attributes. This significantly improves how fungible tokens are managed, validated, and encoded within the system.

Changes

File(s) Summary
CHANGELOG.md Documented the addition of the EVM fungible token protobufs and tests.
e2e/evm/test/contract_send_nibi.test.ts Updated imports and type declarations for SendMethod.
eth/hex.go, eth/hex_test.go Introduced HexAddr type and related functions, along with test cases for Ethereum hex addresses.
eth/state_encoder.go Changed import paths and updated type aliases for Ethereum address and hash handling.
proto/eth/evm/v1/evm.proto Added the FunToken message to represent fungible token mappings.
proto/eth/evm/v1/genesis.proto Introduced funtoken_mappings in GenesisState to hold ERC-20 token mappings.
x/evm/access_list_test.go Added a copyright notice.
x/evm/const.go Added constants for FunToken mappings in the EVM module.
x/evm/events.go Modified several event attribute key constants.
x/evm/evm.go, x/evm/evm_test.go Introduced functions and tests for FunToken handling, including creation and validation.
x/evm/keeper/evm_state.go Clarified the documentation for the SetAccState function.
x/evm/keeper/funtoken_state.go Added FunTokenState struct and methods for managing fungible tokens.
x/evm/keeper/keeper.go Included FunTokens field in Keeper struct and initialized it in NewKeeper function.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant EVM
    participant Keeper
    participant FunTokenState

    User->>EVM: Create FunToken
    EVM->>FunTokenState: Validate and Insert FunToken
    FunTokenState-->>EVM: Validation Result
    EVM-->>User: FunToken Created

Poem

Whispers in bytes, the tokens flow, Ethereum's dance, with addresses aglow. Keeper of keys, with maps anew, FunTokens flourish, set in their cue. Nibiru's chain, the ledger's delight, Under rabbit's watch, systems take flight.

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 weeks ago

Codecov Report

Attention: Patch coverage is 60.19417% with 41 lines in your changes missing coverage. Please review.

Project coverage is 64.71%. Comparing base (4a73c37) to head (ae624cb). Report is 1 commits behind head on main.

:exclamation: Current head ae624cb differs from pull request most recent head 351442a

Please upload reports for the commit 351442a to get more accurate results.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #1936 +/- ## ========================================== - Coverage 64.74% 64.71% -0.03% ========================================== Files 250 253 +3 Lines 15953 16053 +100 ========================================== + Hits 10329 10389 +60 - Misses 4871 4907 +36 - Partials 753 757 +4 ``` | [Files](https://app.codecov.io/gh/NibiruChain/nibiru/pull/1936?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/const.go](https://app.codecov.io/gh/NibiruChain/nibiru/pull/1936?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=) | `0.00% <ø> (ø)` | | | [x/evm/keeper/evm\_state.go](https://app.codecov.io/gh/NibiruChain/nibiru/pull/1936?src=pr&el=tree&filepath=x%2Fevm%2Fkeeper%2Fevm_state.go&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=NibiruChain#diff-eC9ldm0va2VlcGVyL2V2bV9zdGF0ZS5nbw==) | `85.36% <ø> (ø)` | | | [x/evm/keeper/keeper.go](https://app.codecov.io/gh/NibiruChain/nibiru/pull/1936?src=pr&el=tree&filepath=x%2Fevm%2Fkeeper%2Fkeeper.go&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=NibiruChain#diff-eC9ldm0va2VlcGVyL2tlZXBlci5nbw==) | `75.00% <100.00%> (+0.58%)` | :arrow_up: | | [eth/state\_encoder.go](https://app.codecov.io/gh/NibiruChain/nibiru/pull/1936?src=pr&el=tree&filepath=eth%2Fstate_encoder.go&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=NibiruChain#diff-ZXRoL3N0YXRlX2VuY29kZXIuZ28=) | `80.95% <66.66%> (ø)` | | | [x/evm/evm.go](https://app.codecov.io/gh/NibiruChain/nibiru/pull/1936?src=pr&el=tree&filepath=x%2Fevm%2Fevm.go&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=NibiruChain#diff-eC9ldm0vZXZtLmdv) | `40.00% <40.00%> (ø)` | | | [eth/hex.go](https://app.codecov.io/gh/NibiruChain/nibiru/pull/1936?src=pr&el=tree&filepath=eth%2Fhex.go&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=NibiruChain#diff-ZXRoL2hleC5nbw==) | `74.07% <74.07%> (ø)` | | | [x/evm/keeper/funtoken\_state.go](https://app.codecov.io/gh/NibiruChain/nibiru/pull/1936?src=pr&el=tree&filepath=x%2Fevm%2Fkeeper%2Ffuntoken_state.go&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=NibiruChain#diff-eC9ldm0va2VlcGVyL2Z1bnRva2VuX3N0YXRlLmdv) | `44.00% <44.00%> (ø)` | |