mem normalize

[thedavidmeister]

Motivation

Solution

Checks

By submitting this for review, I'm confirming I've done the following:

• made this PR as small as possible
• unit-tested any new functionality
• linked any relevant issues or PRs
• included screenshots (if this involves a front-end change)

Summary by CodeRabbit

• New Features
  • Added a normalization function that simplifies working with floating point numbers by accepting combined coefficient and exponent values.
• Tests
  • Introduced tests to ensure accurate normalization behavior and proper error handling.
• Chores
  • Updated the Solidity version directive to enforce strict compatibility with version 0.8.25.

[coderabbitai]

Walkthrough

This pull request introduces a new normalize function in the LibDecimalFloat library, which accepts a Float struct and passes its components to the existing normalization routine in LibDecimalFloatImplementation. Additionally, a new test contract (LibDecimalFloatNormalizeTest) is added to validate both the new library function and the corresponding implementation, using try-catch blocks to handle error conditions. The Solidity pragma in one of the test files is also updated to enforce the exact compiler version (0.8.25), ensuring strict version control.

Changes

File(s)	Change Summary
src/lib/LibDecimalFloat.sol	Added a new function normalize that accepts a Float struct and calls the underlying LibDecimalFloatImplementation.normalize with its fields.
test/.../LibDecimalFloat.normalize.t.sol	Introduced the LibDecimalFloatNormalizeTest contract with external functions to test normalization and a test method (testNormalizeMem) using try-catch.
test/.../LibDecimalFloat.pack.t.sol	Changed the Solidity pragma from ^0.8.25 to =0.8.25 to enforce usage of the exact compiler version.

Sequence Diagram(s)

sequenceDiagram
    participant Caller
    participant LibDecimalFloat
    participant LibDecimalFloatImpl as Implementation
    Caller->>LibDecimalFloat: normalize(Float struct)
    LibDecimalFloat->>LibDecimalFloatImpl: normalize(signedCoefficient, exponent)
    LibDecimalFloatImpl-->>LibDecimalFloat: normalized values
    LibDecimalFloat-->>Caller: normalized Float struct

Loading

Possibly related PRs

• 2025 04 04 min #25: Involves modifications to the LibDecimalFloat library by adding new functions operating on the Float struct, which aligns with the changes introduced in this pull request.

---

📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 8f5b640 and 681cc21.

📒 Files selected for processing (3)

• src/lib/LibDecimalFloat.sol (1 hunks)
• test/src/lib/LibDecimalFloat.normalize.t.sol (1 hunks)
• test/src/lib/LibDecimalFloat.pack.t.sol (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (3)

• GitHub Check: rainix (ubuntu-latest, rainix-sol-static)
• GitHub Check: rainix (ubuntu-latest, rainix-sol-test)
• GitHub Check: git-clean

🔇 Additional comments (3)

test/src/lib/LibDecimalFloat.pack.t.sol (1)

2-2: Compiler version now strictly fixed.

Changing from ^0.8.25 to =0.8.25 ensures the code will only compile with exactly version 0.8.25 of the Solidity compiler, rather than any compatible version (0.8.25+). This provides stronger guarantees about reproducible builds and consistent behavior.

src/lib/LibDecimalFloat.sol (1)

1179-1188: Good addition of memory-based normalize function.

This new normalize function is a helpful wrapper that accepts a Float struct as input, following the same pattern as other memory-based convenience functions in the library. It maintains consistency with the library's design while improving ergonomics for callers who already have a Float struct.

The implementation is straightforward and correctly passes the struct components to the underlying implementation function and returns the normalized result as a new Float struct.

test/src/lib/LibDecimalFloat.normalize.t.sol (1)

1-33: Well-structured test for the new normalize function.

This test contract follows the project's testing patterns with proper imports and structure. The test successfully validates both interface consistency and error handling between the implementation-level function and the new struct-based wrapper.

The testNormalizeMem function efficiently covers both success paths and error conditions using try-catch mechanics, ensuring the new function behaves identically to the original implementation regardless of input.

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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 plan to trigger planning for file edits and PR creation.
• @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.