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

chore: re-export fastnum and update crate version #102

Merged
merged 1 commit into from
Jan 19, 2025
Merged

chore: re-export fastnum and update crate version #102

merged 1 commit into from
Jan 19, 2025

Conversation

shuhuiluo
Copy link
Collaborator

@shuhuiluo shuhuiluo commented Jan 19, 2025

fastnum is now included to support the BigInt type via fastnum::I512. Updated the version in Cargo.toml from 4.0.0-rc to 4.0.0-rc1 to reflect the changes.

Summary by CodeRabbit

  • New Features

    • Integrated fastnum library for enhanced numerical handling
    • Updated type aliases for BigInt, BigUint, BigDecimal, and RoundingMode
  • Chores

    • Incremented package version from 4.0.0-rc to 4.0.0-rc1

`fastnum` is now included to support the `BigInt` type via `fastnum::I512`. Updated the version in `Cargo.toml` from `4.0.0-rc` to `4.0.0-rc1` to reflect the changes.
@shuhuiluo shuhuiluo requested a review from malik672 January 19, 2025 17:29
Copy link

coderabbitai bot commented Jan 19, 2025

Walkthrough

The pull request introduces updates to the Uniswap SDK Core library, focusing on version increment and numerical type modifications. The package version is bumped from 4.0.0-rc to 4.0.0-rc1, and the library now integrates the fastnum crate. This integration replaces existing type aliases with fastnum implementations for BigInt, BigUint, BigDecimal, and RoundingMode, enhancing the library's numerical handling capabilities.

Changes

File Changes
Cargo.toml Version updated from 4.0.0-rc to 4.0.0-rc1
src/lib.rs - Added pub use fastnum; to prelude
- Replaced type aliases with fastnum types:
BigIntfastnum::I512
BigUintfastnum::U512
BigDecimalfastnum::D512
RoundingModefastnum::decimal::RoundingMode

Poem

🐰 A Rabbit's Numerical Delight

Fastnum arrives with numbers bright,
Big integers dancing with might,
From rc to rc1 we leap,
Precision now runs smooth and deep,
Our SDK's math takes playful flight! 🧮


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. (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)
src/lib.rs (1)

52-52: Consider being more selective with fastnum re-exports.

Instead of re-exporting the entire fastnum crate, consider explicitly re-exporting only the types and functions that are needed by the SDK users. This would provide better control over the public API and prevent potential naming conflicts.

-pub use fastnum;
+pub use fastnum::{I512, U512, D512, decimal::RoundingMode};
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between e076788 and 54ff1b9.

📒 Files selected for processing (2)
  • Cargo.toml (1 hunks)
  • src/lib.rs (1 hunks)
✅ Files skipped from review due to trivial changes (1)
  • Cargo.toml
🔇 Additional comments (1)
src/lib.rs (1)

Line range hint 54-57: Type alias changes look good but require ecosystem verification.

The type aliases are well-structured and consistently use 512-bit types from fastnum, which is appropriate for DeFi calculations. However, since this changes core type definitions, we should verify compatibility.

Let's verify the impact on the ecosystem:

✅ Verification successful

Type alias changes are verified and safe to use

The migration from bnum to fastnum types is consistent throughout the codebase. All mathematical operations, currency calculations, and price computations maintain their precision and correctness with the new 512-bit types.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check for potential compatibility issues with the type changes

# Look for direct usage of the old types
echo "Checking for direct type usage patterns..."
rg -A 2 "(?:BigInt|BigUint|BigDecimal|RoundingMode)::?" --type rust

# Look for potential trait implementations or where clauses
echo "Checking for trait implementations and where clauses..."
ast-grep --pattern 'impl$$$for$$$where$$$'

# Look for type conversions that might be affected
echo "Checking for type conversions..."
rg -A 2 "(?:as|into|from|try_into|try_from)" --type rust

Length of output: 81744

@shuhuiluo shuhuiluo merged commit e634e74 into master Jan 19, 2025
3 checks passed
@shuhuiluo shuhuiluo deleted the c branch January 19, 2025 17:35
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