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: check dust amount zero #146

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix: check dust amount zero #146

wants to merge 1 commit into from

Conversation

djm07073
Copy link
Contributor

@djm07073 djm07073 commented Jan 20, 2025

Summary by CodeRabbit

  • Bug Fixes
    • Enhanced decimal conversion validation to prevent dust amounts during token conversions
    • Added stricter input validation to ensure precise token amount transfers

@djm07073 djm07073 requested a review from a team as a code owner January 20, 2025 04:15
Copy link

coderabbitai bot commented Jan 20, 2025

Walkthrough

The pull request introduces a new validation check in the _convertDecimal function of the ERC20Wrapper contract. The modification adds a requirement to ensure that the input amount is perfectly divisible by a calculated factor, preventing potential issues with fractional token amounts during decimal conversion. This change enhances the function's input validation without altering the core conversion logic.

Changes

File Change Summary
x/evm/contracts/erc20_wrapper/ERC20Wrapper.sol Added a require statement to check that the input amount is divisible by the calculated factor

Poem

🐰 A Rabbit's Decimal Dance 🧮

No dusty amounts shall pass my gate,
Divisibility is now my mate!
Fractions flee, precision reigns supreme,
In tokens' conversion, a mathematical dream!
Clean numbers only, that's my decree! 🎉


🪧 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>, please review it.
    • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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 using 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 generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

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

@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

🧹 Nitpick comments (1)
x/evm/contracts/erc20_wrapper/ERC20Wrapper.sol (1)

175-175: LGTM! Important security check for preventing dust amounts.

The added validation ensures that no value is lost during decimal conversion when scaling down token amounts. This is crucial for maintaining precise token accounting in cross-chain transfers.

Consider making the error message more descriptive:

-require(amount % factor == 0, "dust amount should be zero");
+require(amount % factor == 0, "amount must be perfectly divisible when converting to lower decimal places");
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between cf697fb and a925bbf.

📒 Files selected for processing (1)
  • x/evm/contracts/erc20_wrapper/ERC20Wrapper.sol (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: Analyze (go)
🔇 Additional comments (1)
x/evm/contracts/erc20_wrapper/ERC20Wrapper.sol (1)

174-177: Verify the impact on existing wrap/unwrap operations.

The new dust check affects token conversions when the source token has more decimals than the wrapped token (WRAPPED_DECIMAL = 6). Ensure this doesn't break existing integrations.

Let's analyze the potential impact:

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.

1 participant