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: decimal issue #331

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

fix: decimal issue #331

wants to merge 1 commit into from

Conversation

chalabi2
Copy link
Collaborator

@chalabi2 chalabi2 commented Feb 27, 2025

Description

This PR fixes an issue where a user provides more decimals in an input then the tokens base exponent.

Example:

Tokenn is MFX wich is 10^6 decimal places. User inputs 1.1234567 <- that number causes the app to error.

Solution:

This PR makes it so the number is rounded up to 1.123457

const roundedAmount = amount.toFixed(maxDigits);

Summary by CodeRabbit

  • Bug Fixes
    • Enhanced numerical conversion accuracy by introducing proper rounding to ensure consistent precision for value transformations.

Copy link
Contributor

coderabbitai bot commented Feb 27, 2025

Walkthrough

This pull request updates the parseNumberToBigInt function in utils/maths.ts. The function now rounds the input number string to maxDigits decimal places using toFixed before multiplying by the precision factor and converting to a BigInt. Error handling for non-finite values remains unchanged, and the function signature stays the same.

Changes

File Change Summary
utils/maths.ts Updated parseNumberToBigInt: now rounds the input to maxDigits decimal places using toFixed, multiplies by a precision factor, and then converts the result to a BigInt. Error handling is preserved.

Possibly related PRs

Suggested labels

enhancement

Suggested reviewers

  • fmorency

Poem

I'm a rabbit with a code delight,
Hop-scotching through numbers so bright.
With rounding steps and BigInt might,
I cheer each line in the digital light.
Hoppity changes, all set just right!
🥕💻


📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between f528c65 and 85ea7bd.

📒 Files selected for processing (1)
  • utils/maths.ts (1 hunks)
🧰 Additional context used
🪛 GitHub Check: codecov/patch
utils/maths.ts

[warning] 41-44: utils/maths.ts#L41-L44
Added lines #L41 - L44 were not covered by tests

⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: build
  • GitHub Check: build
🔇 Additional comments (1)
utils/maths.ts (1)

41-44: Good fix for handling excessive decimal places.

The implementation correctly rounds the input amount to the specified maximum number of decimal places before converting to base units, which solves the issue with users inputting numbers with more decimal places than allowed (like 1.1234567 for a token with 6 decimal places).

Two suggestions:

  1. Consider using BigNumber's built-in decimal handling instead of string conversion:
const b = amount.decimalPlaces(maxDigits).times(precision).toFixed(0);
  1. The static analysis shows these lines aren't covered by tests. Consider adding tests with inputs containing excessive decimal places to verify this fix.
🧰 Tools
🪛 GitHub Check: codecov/patch

[warning] 41-44: utils/maths.ts#L41-L44
Added lines #L41 - L44 were not covered by tests

✨ Finishing Touches
  • 📝 Generate Docstrings

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>, 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.
  • @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

codecov bot commented Feb 27, 2025

Codecov Report

Attention: Patch coverage is 0% with 4 lines in your changes missing coverage. Please review.

Project coverage is 52.95%. Comparing base (f528c65) to head (85ea7bd).

Files with missing lines Patch % Lines
utils/maths.ts 0.00% 4 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main     #331      +/-   ##
==========================================
- Coverage   52.96%   52.95%   -0.01%     
==========================================
  Files         220      220              
  Lines       17096    17099       +3     
==========================================
  Hits         9055     9055              
- Misses       8041     8044       +3     

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

@hansl
Copy link
Contributor

hansl commented Feb 27, 2025

Can you please add a couple unit tests for parseNumberToBigInt? Prevent regressions in the future...

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