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(batcher): include checksum in zlib-compressed channel encoding #395

Merged
merged 1 commit into from
Nov 29, 2024

Conversation

0xbenyun
Copy link
Contributor

@0xbenyun 0xbenyun commented Nov 21, 2024

Description

This PR addresses an issue in the batcher where the checksum was not being included during the compression of rlp_spanbatches using zlib. The checksum is now correctly included in the compressed data.

This work originated from an investigation into a derivation failure observed in Kona, during which it was discovered that the checksum was missing in the compressed output.

Additionally, a related upstream PR #10002, primarily focused on optimization and refactoring, also resolved this checksum issue as part of its broader changes.

Copy link
Contributor

coderabbitai bot commented Nov 21, 2024

Important

Review skipped

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

🗂️ Base branches to auto review (2)
  • dev
  • main

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.


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

@0xbenyun 0xbenyun force-pushed the fix/checksum-channel-encoding branch from b3c6d6f to 808998f Compare November 22, 2024 00:11
@0xbenyun 0xbenyun marked this pull request as ready for review November 22, 2024 00:38
@0xbenyun 0xbenyun requested a review from a team as a code owner November 22, 2024 00:38
@0xbenyun 0xbenyun force-pushed the fix/checksum-channel-encoding branch from 808998f to c27a652 Compare November 22, 2024 00:43
@0xbenyun 0xbenyun force-pushed the fix/checksum-channel-encoding branch from c27a652 to 29cbab7 Compare November 22, 2024 06:05
@kangsorang
Copy link
Contributor

I think the batch derivation process involves a read through zlib.Reader and that includes checksum verification.
I'm curious to know how BatchReader's behavior has passed this checksum issue so far.

Copy link
Contributor

@sm-stack sm-stack left a comment

Choose a reason for hiding this comment

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

LGTM

@0xbenyun
Copy link
Contributor Author

I think the batch derivation process involves a read through zlib.Reader and that includes checksum verification. I'm curious to know how BatchReader's behavior has passed this checksum issue so far.

I have confirmed that the zlib.Reader in Go does not always verify the checksum in all cases. Therefore, in BatchReader, it performs decompression without checking the checksum, regardless of its presence.

Copy link
Contributor

@kangsorang kangsorang left a comment

Choose a reason for hiding this comment

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

LGTM

@0xbenyun 0xbenyun requested review from Pangssu and seolaoh November 27, 2024 07:19
@seolaoh seolaoh merged commit 7cc02bb into feat/zkvm-fault-proof Nov 29, 2024
3 checks passed
@seolaoh seolaoh deleted the fix/checksum-channel-encoding branch November 29, 2024 10:20
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.

5 participants