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

Disable ISRs in Block Data #1532

Merged
merged 1 commit into from
Feb 8, 2024
Merged

Disable ISRs in Block Data #1532

merged 1 commit into from
Feb 8, 2024

Conversation

Manav-Aggarwal
Copy link
Member

@Manav-Aggarwal Manav-Aggarwal commented Feb 8, 2024

Overview

Closes: #1531

Checklist

  • New and updated code has appropriate documentation
  • New and updated code has new and/or updated testing
  • Required CI checks are passing
  • Visual proof for any user facing features like CLI or documentation updates
  • Linked issues closed with keywords

Summary by CodeRabbit

  • Refactor
    • Temporarily disabled the handling of IntermediateStateRoots across various components of the system.
  • Tests
    • Adjusted tests to skip scenarios involving IntermediateStateRoots.
  • Documentation
    • Updated internal documentation to reflect temporary changes in data structure handling.

Copy link
Contributor

coderabbitai bot commented Feb 8, 2024

Walkthrough

The series of changes across multiple files in the Rollkit repository primarily focus on commenting out or temporarily removing the handling of Intermediate State Roots (ISRs) from various components. This adjustment is made to reduce rollup block size and streamline the codebase, with provisions for easy re-integration of ISRs in the future when required, particularly in anticipation of Fraud Proofs. The modifications touch upon proto definitions, state execution, data structuring, serialization, and associated tests.

Changes

File(s) Summary of Changes
proto/rollkit/rollkit.proto Commented out intermediate_state_roots declaration in Data message.
state/executor.go Commented out assignment of IntermediateStateRoots in CreateBlock method.
types/block.go, types/utils.go Adjusted Data struct by commenting out IntermediateStateRoots and related handling.
types/serialization.go, types/serialization_test.go Commented out handling and testing of IntermediateStateRoots.
types/tx_test.go Added t.Skip() to tests involving ISRs.

Assessment against linked issues

Objective Addressed Explanation
Remove ISRs for Rollkit vA while making it easy to add back later (#1531)

Poem

In the code where bytes do weave,
A rabbit hopped, a trick up sleeve.
🌿 Removed ISRs, quite sleek and neat,
🚀 For Rollkit's future, a feat so sweet.

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-tests for this file.
  • 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 tests 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 from git and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit tests.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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 a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @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.
  • The JSON schema for the configuration file is available here.
  • 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

Copy link
Contributor

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

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 03f631c and 2b9cfef.
Files ignored due to path filters (1)
  • types/pb/rollkit/rollkit.pb.go is excluded by: !**/*.pb.go
Files selected for processing (7)
  • proto/rollkit/rollkit.proto (1 hunks)
  • state/executor.go (1 hunks)
  • types/block.go (1 hunks)
  • types/serialization.go (2 hunks)
  • types/serialization_test.go (1 hunks)
  • types/tx_test.go (2 hunks)
  • types/utils.go (1 hunks)
Files skipped from review due to trivial changes (1)
  • types/tx_test.go
Additional comments: 9
proto/rollkit/rollkit.proto (1)
  • 73-73: LGTM!
types/block.go (1)
  • 34-35: LGTM!
types/serialization_test.go (1)
  • 78-79: LGTM!
types/serialization.go (2)
  • 194-195: LGTM!
  • 218-218: LGTM!
types/utils.go (3)
  • 317-319: LGTM!
  • 325-325: LGTM!
  • 331-331: LGTM!
state/executor.go (1)
  • 127-128: LGTM!

@Manav-Aggarwal Manav-Aggarwal added the T:code-hygiene General cleanup and restructuring of code to provide clarity, flexibility, and modularity. label Feb 8, 2024
@Manav-Aggarwal Manav-Aggarwal added this pull request to the merge queue Feb 8, 2024
Merged via the queue into main with commit 76a199a Feb 8, 2024
26 checks passed
@Manav-Aggarwal Manav-Aggarwal deleted the manav/remove_ISRs_for_vA branch February 8, 2024 15:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
T:code-hygiene General cleanup and restructuring of code to provide clarity, flexibility, and modularity.
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

Remove ISRs in Block Data while keeping it easy to add back later
3 participants