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

fix: remove immutable property for decimal in zrc20 #332

Merged
merged 4 commits into from
Aug 16, 2024

Conversation

lumtis
Copy link
Member

@lumtis lumtis commented Aug 16, 2024

To keep the storage layout compatible with zrc20 v1

Summary by CodeRabbit

  • New Features

    • The decimal precision for tokens can now be adjusted post-deployment, allowing for greater flexibility in token transactions.
  • Impacts

    • This change may enhance interactions with other contracts and improve the overall functionality of token-related operations.

Copy link
Contributor

coderabbitai bot commented Aug 16, 2024

Important

Review skipped

Review was skipped due to path filters

Files ignored due to path filters (6)
  • v2/pkg/gatewayevmzevm.t.sol/gatewayevmzevmtest.go is excluded by !v2/pkg/**
  • v2/pkg/gatewayzevm.t.sol/gatewayzevminboundtest.go is excluded by !v2/pkg/**
  • v2/pkg/gatewayzevm.t.sol/gatewayzevmoutboundtest.go is excluded by !v2/pkg/**
  • v2/pkg/zrc20.sol/zrc20.go is excluded by !v2/pkg/**
  • v2/pkg/zrc20.t.sol/zrc20test.go is excluded by !v2/pkg/**
  • v2/types/factories/ZRC20.sol/ZRC20__factory.ts is excluded by !v2/types/**

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

Walkthrough

The recent changes to the ZRC20 contract primarily involve the alteration of the _decimals variable from being immutable to a standard uint8. This modification allows the _decimals value to be adjusted post-deployment, which impacts the contract's handling of decimal precision for token transactions. Such flexibility could influence the interoperability of the token with other contracts and applications requiring specific decimal calculations.

Changes

File Change Summary
v2/contracts/zevm/ZRC20.sol Changed _decimals from uint8 private immutable to uint8 private, allowing post-deployment modification.

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
Contributor

@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: 0

Outside diff range, codebase verification and nitpick comments (1)
v2/contracts/zevm/ZRC20.sol (1)

46-46: Consider the implications of making _decimals mutable.

Changing _decimals from immutable to a standard uint8 allows it to be modified after deployment. This flexibility can be useful but also poses risks:

  • Interoperability: Ensure that any systems or contracts interacting with this token can handle changes in decimal precision.
  • Consistency: Consider adding mechanisms to manage or restrict changes to _decimals to prevent unexpected behavior.

Evaluate whether additional safeguards or documentation are needed to address these concerns.

Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 7e43787 and 8cf517c.

Files selected for processing (1)
  • v2/contracts/zevm/ZRC20.sol (1 hunks)

@codecov-commenter
Copy link

codecov-commenter commented Aug 16, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 82.35%. Comparing base (7e43787) to head (7eb673c).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #332   +/-   ##
=======================================
  Coverage   82.35%   82.35%           
=======================================
  Files           7        7           
  Lines         306      306           
  Branches       99       99           
=======================================
  Hits          252      252           
  Misses         54       54           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@lumtis lumtis marked this pull request as draft August 16, 2024 14:28
@lumtis lumtis marked this pull request as ready for review August 16, 2024 14:58
@lumtis
Copy link
Member Author

lumtis commented Aug 16, 2024

Forgot to generate, fixed now, the test in node works

@skosito skosito merged commit 100d765 into main Aug 16, 2024
14 checks passed
@skosito skosito deleted the fix/zrc20-immutable-decimal branch August 16, 2024 18:10
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.

4 participants