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
183 stars 201 forks source link

fix: fun token state marshalling #1947

Closed k-yang closed 3 months ago

k-yang commented 3 months ago

Purpose / Abstract

Summary by CodeRabbit

coderabbitai[bot] commented 3 months ago

Walkthrough

The updates focus on refining the handling of Ethereum addresses within the EVM module by replacing the EthAddr and EthHash aliases with gethcommon.Address and gethcommon.Hash. The changes improve ID generation and error handling for FunToken, ensuring more consistent and simplified address management while adding new test functions to ensure reliable conversions and functionality.

Changes

File Change Summary
CHANGELOG.md Fixed FunToken state marshalling. No alterations to exported/public entities.
eth/hex.go Updated NewHexAddr and ToAddr signatures to use gethcommon.Address. Modified MarshalTo.
eth/hex_test.go Added TestHexAddrToString() to validate hex address conversion methods.
eth/state_encoder.go Replaced EthAddr/EthHash with gethcommon.Address/gethcommon.Hash. Updated encoders.
eth/state_encoder_test.go Changed given parameter to gethcommon.Address in TestEncoderEthAddr().
x/evm/evm.go Refactored NewFunTokenID and error handling in FunToken. Removed newFunTokenIDFromStr.
x/evm/keeper/evm_state.go Updated SetAccState and GetState to use gethcommon.Address and gethcommon.Hash.
x/evm/keeper/funtoken_state.go Modified FunTokenState structure to use []byte and evm.FunToken for indexing and encoding.
x/evm/keeper/funtoken_state_test.go Added tests for FunToken operations: TestInsertAndGet, TestCollect, and TestDelete.

Poem

Soft whispers through the code repository, Updating types with thoughtful clarity. Ethereum addresses now more clean, FunTokens validated, ensured to glean. Tests to guide, ensuring all abide, In this enhanced ether's tide. πŸ‡βœ¨


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 3 months ago

Codecov Report

Attention: Patch coverage is 70.83333% with 7 lines in your changes missing coverage. Please review.

Project coverage is 64.80%. Comparing base (422c676) to head (f3ac2f0).

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #1947 +/- ## ========================================== + Coverage 64.71% 64.80% +0.08% ========================================== Files 253 253 Lines 16053 16050 -3 ========================================== + Hits 10389 10401 +12 + Misses 4907 4892 -15 Partials 757 757 ``` | [Files](https://app.codecov.io/gh/NibiruChain/nibiru/pull/1947?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/evm\_state.go](https://app.codecov.io/gh/NibiruChain/nibiru/pull/1947?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% <100.00%> (ΓΈ)` | | | [x/evm/keeper/funtoken\_state.go](https://app.codecov.io/gh/NibiruChain/nibiru/pull/1947?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) | `92.00% <100.00%> (+48.00%)` | :arrow_up: | | [eth/hex.go](https://app.codecov.io/gh/NibiruChain/nibiru/pull/1947?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% <66.66%> (ΓΈ)` | | | [eth/state\_encoder.go](https://app.codecov.io/gh/NibiruChain/nibiru/pull/1947?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% <70.00%> (ΓΈ)` | | | [x/evm/evm.go](https://app.codecov.io/gh/NibiruChain/nibiru/pull/1947?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) | `47.05% <57.14%> (+7.05%)` | :arrow_up: |