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(torii): u256 json serialization as string #3042

Merged
merged 3 commits into from
Feb 17, 2025

Conversation

Larkooo
Copy link
Collaborator

@Larkooo Larkooo commented Feb 17, 2025

Summary by CodeRabbit

  • Refactor
    • Simplified the encoding and decoding of large integer values. Instead of a detailed object structure with multiple fields, these values are now represented as a concise hexadecimal string (prefixed with "0x"), streamlining the data interchange format and potentially improving performance.

Copy link

coderabbitai bot commented Feb 17, 2025

Walkthrough

Ohayo, sensei! This update refines the handling of the U256 type in the Ty enum found in schema.rs. The changes eliminate the previous detailed serialization that split U256 into two u128 parts, and instead, it now serializes into a hex string prefixed with "0x". Deserialization follows a similar simplification by directly parsing a hex string after trimming the "0x" prefix.

Changes

File(s) Change Summary
crates/dojo/.../schema.rs Serialization: Removed conversion of U256 into high/low u128 fields; now uses a hex string with "0x" prefix.
Deserialization: Now directly parses a hex string instead of a JSON object with "high" and "low" fields.

Sequence Diagram(s)

sequenceDiagram
    participant Client as Client
    participant Serializer as U256 Serializer
    Client->>Serializer: Request Serialization (U256 value)
    Serializer->>Serializer: Format value to hex string ("0x...")
    Serializer-->>Client: Return JSON hex string
Loading
sequenceDiagram
    participant Client as Client
    participant Deserializer as U256 Deserializer
    Client->>Deserializer: Provide JSON hex string ("0x...")
    Deserializer->>Deserializer: Trim "0x" and parse hex string
    Deserializer-->>Client: Return U256 value
Loading

Possibly related PRs

Suggested reviewers

  • glihm

🪧 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.

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 details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between ce8c3f7 and 42bfa7d.

📒 Files selected for processing (1)
  • crates/dojo/types/src/schema.rs (3 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: docs
  • GitHub Check: clippy
  • GitHub Check: build
🔇 Additional comments (1)
crates/dojo/types/src/schema.rs (1)

352-352: LGTM! Simplified U256 serialization.

The change to serialize U256 as a hex string with "0x" prefix aligns with common JSON serialization patterns for large numbers.

Copy link

codecov bot commented Feb 17, 2025

Codecov Report

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

Project coverage is 56.20%. Comparing base (ce8c3f7) to head (42bfa7d).
Report is 2 commits behind head on main.

Files with missing lines Patch % Lines
crates/dojo/types/src/schema.rs 0.00% 3 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main    #3042      +/-   ##
==========================================
+ Coverage   56.19%   56.20%   +0.01%     
==========================================
  Files         437      437              
  Lines       58821    58805      -16     
==========================================
- Hits        33057    33054       -3     
+ Misses      25764    25751      -13     

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

@Larkooo
Copy link
Collaborator Author

Larkooo commented Feb 17, 2025

fixes #3040

@glihm glihm merged commit 441ba65 into dojoengine:main Feb 17, 2025
14 of 15 checks passed
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