Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: initialize genesis denom with 18 decimals by default #51

Merged
merged 1 commit into from
Aug 21, 2024

Conversation

beer-1
Copy link
Collaborator

@beer-1 beer-1 commented Aug 21, 2024

Description

This update will allow the chain be initialized with 18 decimals genesis token.

Closes: #XXXX


Author Checklist

All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.

I have...

  • included the correct type prefix in the PR title, you can find examples of the prefixes below:
  • confirmed ! in the type prefix if API or client breaking change
  • targeted the correct branch
  • provided a link to the relevant issue or specification
  • reviewed "Files changed" and left comments if necessary
  • included the necessary unit and integration tests
  • updated the relevant documentation or specification, including comments for documenting Go code
  • confirmed all CI checks have passed

Reviewers Checklist

All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.

I have...

  • confirmed the correct type prefix in the PR title
  • confirmed all author checklist items have been addressed
  • reviewed state machine logic, API design and naming, documentation is accurate, tests and test coverage

Summary by CodeRabbit

  • New Features

    • Enhanced ERC20 token management with flexible decimal precision during creation.
    • Introduced new initialization method for the EVM state to accommodate decimal values.
  • Bug Fixes

    • Improved accuracy of transaction fee calculations by incorporating dynamic decimal handling.
  • Documentation

    • Updated method signatures in the IERC20Keeper interface to reflect new decimals parameter for ERC20 creation.

@beer-1 beer-1 self-assigned this Aug 21, 2024
@beer-1 beer-1 requested a review from a team as a code owner August 21, 2024 07:49
Copy link

coderabbitai bot commented Aug 21, 2024

Walkthrough

The recent changes enhance the functionality of the EVM keeper package, focusing on ERC20 token management by introducing decimal precision handling. Key updates include modifying the TestKeepers struct to store decimal values, altering ERC20 creation methods to accept decimals, and refining transaction fee calculations to support dynamic decimal adjustments. Overall, these enhancements allow for more flexible and precise token management, improving the testing and operational capabilities of the EVM framework.

Changes

Files Change Summary
x/evm/keeper/common_test.go Updated TestKeepers struct to include a Decimals field; modified _createTestInput to initialize decimals dynamically; changed initialization method to accept decimals.
x/evm/keeper/erc20.go Changed MintCoins to pass decimal places to CreateERC20; updated CreateERC20 method to accept decimals for improved token creation flexibility.
x/evm/keeper/genesis.go Introduced InitializeWithDecimals method for better ERC20 initialization; modified the existing Initialize method to use this new method, enhancing token creation during genesis.
x/evm/keeper/txutils_test.go Adjusted transaction fee calculations to utilize dynamic decimals; modified assertions for more precise fee handling in test scenarios.
x/evm/types/expected_keeper.go Updated CreateERC20 method in IERC20Keeper interface to include a decimals parameter, enhancing the interface's functionality for token creation.

Sequence Diagram(s)

sequenceDiagram
    participant TestKeepers
    participant ERC20Keeper
    participant Keeper
    participant IERC20Keeper

    TestKeepers->>Keeper: Initialize with Decimals
    Keeper->>ERC20Keeper: CreateERC20 with Decimals
    ERC20Keeper->>IERC20Keeper: Call CreateERC20
    Note over IERC20Keeper: CreateERC20 now has Decimals parameter
Loading

🐰 In the land of code, where tokens play,
New decimals hop in, brightening the day!
With tests that adjust and fees that align,
Our rabbit crew cheers, "It's all looking fine!"
From minting to creating, all snug and neat,
Let's celebrate changes, oh what a treat! 🥕✨


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
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • 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 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 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 for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

codecov bot commented Aug 21, 2024

Codecov Report

Attention: Patch coverage is 83.33333% with 1 line in your changes missing coverage. Please review.

Project coverage is 26.31%. Comparing base (7dd9388) to head (1f59e4b).
Report is 2 commits behind head on main.

Files Patch % Lines
x/evm/keeper/genesis.go 66.66% 1 Missing ⚠️
Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main      #51      +/-   ##
==========================================
- Coverage   26.32%   26.31%   -0.01%     
==========================================
  Files         111      111              
  Lines       11868    11870       +2     
==========================================
  Hits         3124     3124              
- Misses       8299     8301       +2     
  Partials      445      445              
Files Coverage Δ
x/evm/keeper/erc20.go 43.09% <100.00%> (ø)
x/evm/keeper/genesis.go 50.45% <66.66%> (-0.95%) ⬇️

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 7dd9388 and 1f59e4b.

Files selected for processing (5)
  • x/evm/keeper/common_test.go (3 hunks)
  • x/evm/keeper/erc20.go (3 hunks)
  • x/evm/keeper/genesis.go (2 hunks)
  • x/evm/keeper/txutils_test.go (7 hunks)
  • x/evm/types/expected_keeper.go (1 hunks)
Additional context used
GitHub Check: codecov/patch
x/evm/keeper/genesis.go

[warning] 21-21: x/evm/keeper/genesis.go#L21
Added line #L21 was not covered by tests

Additional comments not posted (13)
x/evm/types/expected_keeper.go (1)

72-72: Verify implementations of IERC20Keeper.

The CreateERC20 method signature has been updated to include a decimals parameter. Ensure all implementations of IERC20Keeper are updated to handle this new parameter.

Run the following script to find all implementations of IERC20Keeper:

x/evm/keeper/genesis.go (1)

Line range hint 24-48: Ensure error handling consistency in InitializeWithDecimals.

The method InitializeWithDecimals handles errors consistently, but ensure that any additional logic added in the future maintains this consistency.

Tools
GitHub Check: codecov/patch

[warning] 21-21: x/evm/keeper/genesis.go#L21
Added line #L21 was not covered by tests

x/evm/keeper/txutils_test.go (6)

32-37: LGTM! Dynamic fee calculation is correctly implemented.

The dynamic calculation of feeAmount based on decimals enhances precision.


48-50: LGTM! Correct use of decimals in gasFeeCap and value.

The use of decimals in the conversion functions ensures accurate unit representation.


97-97: LGTM! Correct assertion of transaction fee.

The assertion using math.NewIntFromBigInt(feeAmount).AddRaw(1) aligns with the new fee calculation logic.


124-130: LGTM! Dynamic fee calculation is correctly implemented.

The dynamic calculation of feeAmount based on decimals enhances precision.


140-142: LGTM! Correct use of decimals in gasFeeCap and value.

The use of decimals in the conversion functions ensures accurate unit representation.


187-187: LGTM! Correct assertion of transaction fee.

The assertion using math.NewIntFromBigInt(feeAmount).AddRaw(1) aligns with the new fee calculation logic.

x/evm/keeper/common_test.go (3)

145-145: LGTM! Addition of Decimals field in TestKeepers.

The Decimals field allows for flexible handling of decimal values in tests.


275-281: LGTM! Dynamic initialization of decimals.

The logic for initializing decimals introduces variability, enhancing test scenarios.


287-287: LGTM! Correct assignment of Decimals in TestKeepers.

The assignment ensures that the TestKeepers struct accurately reflects the initialized state.

x/evm/keeper/erc20.go (2)

301-301: LGTM! Explicit decimal specification in MintCoins.

The call to CreateERC20 with a decimals parameter enhances control over token properties.


Line range hint 327-346: LGTM! Correct handling of decimals in CreateERC20.

The inclusion of the decimals parameter in the ABI packing process aligns with standard tokenomics practices.

x/evm/keeper/genesis.go Show resolved Hide resolved
Copy link
Contributor

@Vritra4 Vritra4 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@Vritra4 Vritra4 merged commit 4adcd17 into main Aug 21, 2024
8 checks passed
@Vritra4 Vritra4 deleted the feat/genesis-denom-with-18-decimals branch August 21, 2024 08:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants