Skip to content

Turn rs-zstd into official version #51

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

Merged
merged 10 commits into from
Jun 25, 2025
Merged

Conversation

noel2004
Copy link
Member

@noel2004 noel2004 commented Apr 4, 2025

With update in zstd decompression circuit, we can fully support zstd compressed data generated from official implement, with current configurations (raw literal, no magic bytes, no custom dictionary, etc).

Since no hacking in zstd source is needed anymore once the new decompression circuit has been merged into new release of prover (maybe in the f-release?), we can turn the depending of zstd into official one safely.

NOTICE: DO NOT apply this PR before the new decompression circuit has been applied.

Summary by CodeRabbit

  • Chores
    • Updated a core dependency to a stable release version while preserving advanced experimental features for enhanced reliability.

@noel2004 noel2004 requested a review from colinlyguo April 4, 2025 12:16
Copy link

coderabbitai bot commented Apr 4, 2025

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

The changes update the dependency declaration in the libzstd/encoder/Cargo.toml file. The previous configuration referenced the zstd library from a Git repository branch (hack/mul-block), which indicated an experimental version. This reference has been replaced with a stable version specification (0.13), while retaining the flag for experimental features.

Changes

File(s) Change Summary
libzstd/encoder/Cargo.toml Updated the zstd dependency from a Git branch (hack/mul-block) to a version-based reference (0.13), while maintaining the experimental feature flag.

Poem

I'm a rabbit in the code field, swift and bright,
Hopping from branches to versions in pure delight.
Experimental flair remains in every line I see,
Stable changes whisk through like a gentle breeze.
With every commit, I nibble on bugs away,
Celebrating small wins in the world of code today!


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
🪧 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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate sequence diagram to generate a sequence diagram of the changes in 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.

zstd = { version = "0.13", features = ["experimental"]}
Copy link
Member

@colinlyguo colinlyguo Apr 4, 2025

Choose a reason for hiding this comment

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

I'm concerned that this will affect the compression of codec version < 7, thus affecting the rollup verifier's batch hash calculation. @jonastheis, would the current L1 DA syncer replace constructing local blocks and compress them to a batch? e.g., replace by getting blob raw data and decompress it, then verify against local blocks.

Copy link
Member Author

Choose a reason for hiding this comment

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

Yes. I think the later is better designation and we should finally adopt to that. Making compression more than once and expect the result is identify seems a bit danger because the result would be affected by many factors: any update of minor version, configuration etc.

Copy link
Member

Choose a reason for hiding this comment

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

Quite agree with the claim.

Copy link
Member

@colinlyguo colinlyguo Apr 17, 2025

Choose a reason for hiding this comment

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

Another comment would be, could this be replaced by Go's zstd lib?

@noel2004
Copy link
Member Author

noel2004 commented Apr 17, 2025 via email

@colinlyguo colinlyguo mentioned this pull request Jun 18, 2025
2 tasks
@colinlyguo colinlyguo changed the base branch from main to feat-support-codecv8 June 19, 2025 09:57
@colinlyguo colinlyguo changed the title [DO NOT MERGE YET] Turn rs-zstd into official version Turn rs-zstd into official version Jun 22, 2025
.expect("infallible");
// with a hack in zstd we can set window log <= 17 with single segment kept
encoder
.set_parameter(CParameter::WindowLog(17))
Copy link
Member Author

Choose a reason for hiding this comment

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

For new encoder, increase the windowLog from 17 -> 22 (128K -> 4M), it would help to improve the compressing ratio and enable us a signle frame scheme for any source data less than 4MB (should be enough in quite a long peroid)

Copy link
Member

Choose a reason for hiding this comment

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

Changed in this commit: b64a7d3 and regenerated the .a files.

@noel2004
Copy link
Member Author

Things should be ok now

@colinlyguo colinlyguo merged commit ba3a9d0 into feat-support-codecv8 Jun 25, 2025
4 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