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

Add From<FPDecimal> for Uint256 for FPDecimal #217

Open
wants to merge 2 commits into
base: dev
Choose a base branch
from

Conversation

Aursen
Copy link
Contributor

@Aursen Aursen commented Mar 29, 2024

Closes #216

Summary by CodeRabbit

  • New Features

    • Enabled conversion from FPDecimal to Uint256 for improved compatibility.
  • Tests

    • Added tests to ensure accurate conversion from FPDecimal to Uint256.

Copy link

coderabbitai bot commented Mar 29, 2024

Walkthrough

The changes introduce a conversion implementation from FPDecimal to Uint256 in the fp_decimal module. This addition simplifies the process of converting between these types, particularly useful in macros. A corresponding test ensures the correctness of this new feature.

Changes

File Path Change Summary
packages/injective-math/src/fp_decimal/... Added impl From<FPDecimal> for Uint256 and a test function test_into_u256() for this conversion.

Sequence Diagram(s) (Beta)

sequenceDiagram
    participant Client
    participant FPDecimal
    participant Uint256

    Client->>FPDecimal: Create FPDecimal instance
    Client->>Uint256: Convert FPDecimal to Uint256 using From trait
    Uint256-->>Client: Return Uint256 instance
Loading

Assessment against linked issues

Objective Addressed Explanation
Implement the trait From<FPDecimal> for Uint256 (Issue #216)
Ensure conversion correctness with a test function (Issue #216)

Poem

In code's vast and endless sea,
A decimal finds its way to be,
From floating points to numbers grand,
Uint256 now close at hand.
With tests to guide and keep it true,
Our macros cheer, a job well due.
🎉✨


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 Configration 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: 1

Review Status

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 944c0f7 and e81d062.
Files selected for processing (1)
  • packages/injective-math/src/fp_decimal/mod.rs (1 hunks)
Additional Context Used

@maxrobot
Copy link
Contributor

Hi @Aursen it'd be good if you added some test cases for this prior to merging.

@Aursen
Copy link
Contributor Author

Aursen commented May 29, 2024

Hi @Aursen it'd be good if you added some test cases for this prior to merging.

Yeah sure let me add it

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: 2

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between e81d062 and 716d0fd.

Files selected for processing (1)
  • packages/injective-math/src/fp_decimal/mod.rs (2 hunks)

Comment on lines +75 to +78
impl From<FPDecimal> for Uint256 {
fn from(value: FPDecimal) -> Self {
value.to_u256()
}
Copy link

Choose a reason for hiding this comment

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

Add documentation for the From<FPDecimal> for Uint256 implementation.

It's important to document how the conversion handles the sign of FPDecimal and any potential edge cases. This will help future developers understand the conversion process better and ensure correct usage.

Comment on lines +465 to +475
#[test]
fn test_into_u256() {
let fp_decimal: Uint256 = FPDecimal {
num: U256::from(12345u64),
sign: 1, // Assuming it's always positive
}
.into();
let u256 = Uint256::from(12345u64);

assert_eq!(u256, fp_decimal)
}
Copy link

Choose a reason for hiding this comment

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

Enhance the test coverage for test_into_u256.

The current test only covers a basic positive number conversion. Consider adding tests for edge cases such as large numbers, negative numbers, and zero to ensure the robustness of the conversion process.

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.

The trait From<FPDecimal> for Uint256 is not implemented for FPDecimal
2 participants