Skip to content

docs: Header and data separation ADR#2061

Merged
Manav-Aggarwal merged 9 commits intofeature/exec_apifrom
header-data-separation-adr
Mar 20, 2025
Merged

docs: Header and data separation ADR#2061
Manav-Aggarwal merged 9 commits intofeature/exec_apifrom
header-data-separation-adr

Conversation

@Manav-Aggarwal
Copy link
Copy Markdown
Member

@Manav-Aggarwal Manav-Aggarwal commented Mar 11, 2025

Overview

Closes: #2046

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Mar 11, 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.


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

@RollkitBot RollkitBot requested review from a team, MSevey, gupadhyaya and tuxcanfly and removed request for a team March 11, 2025 22:22
@github-project-automation github-project-automation bot moved this to Done in Evolve Mar 11, 2025
@Manav-Aggarwal Manav-Aggarwal changed the base branch from main to feature/exec_api March 11, 2025 22:25
@Manav-Aggarwal Manav-Aggarwal force-pushed the header-data-separation-adr branch from b3b6e35 to 743d9c1 Compare March 11, 2025 22:27
@Manav-Aggarwal Manav-Aggarwal moved this from Done to In Progress in Evolve Mar 11, 2025
@Manav-Aggarwal Manav-Aggarwal moved this from In Progress to For Review in Evolve Mar 11, 2025
@Manav-Aggarwal Manav-Aggarwal changed the title Header and data separation ADR docs: Header and data separation ADR Mar 11, 2025
@codecov
Copy link
Copy Markdown

codecov bot commented Mar 11, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 23.98%. Comparing base (2262207) to head (ec4988a).
Report is 13 commits behind head on feature/exec_api.

Additional details and impacted files
@@                 Coverage Diff                  @@
##           feature/exec_api    #2061      +/-   ##
====================================================
- Coverage             24.11%   23.98%   -0.13%     
====================================================
  Files                    52       54       +2     
  Lines                  8231     8292      +61     
====================================================
+ Hits                   1985     1989       +4     
- Misses                 6089     6141      +52     
- Partials                157      162       +5     

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

🚀 New features to boost your workflow:
  • Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Copy link
Copy Markdown
Contributor

@tac0turtle tac0turtle left a comment

Choose a reason for hiding this comment

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

nice job, left some comments/questions


Before, only the entire `Block` struct composed of both header and data was submitted to the DA layer but after the separation, the `SignedHeader` and `Data` are submitted separately to the DA layer. The `SignedHeader` is linked to the `Data` via a Data commitment from the DA layer.

In addition, before the `Block` and `SignedHeader` were both gossipped over a p2p layer to full nodes as well. But after the separation, `SignedHeader` and `Data` are gossipped over the p2p layer since the `Block` struct does not exist anymore and is broken down.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

can you touch on how sync works? can data be applied while waiting for signed header?

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

yes, updated.

@Manav-Aggarwal Manav-Aggarwal force-pushed the header-data-separation-adr branch from 854f898 to dea10d6 Compare March 13, 2025 09:11
@Manav-Aggarwal Manav-Aggarwal force-pushed the header-data-separation-adr branch from 2f2bfe1 to c0b6c54 Compare March 20, 2025 14:30
@Manav-Aggarwal Manav-Aggarwal force-pushed the header-data-separation-adr branch from 75b8859 to ec4988a Compare March 20, 2025 14:31
@github-actions
Copy link
Copy Markdown
Contributor

PR Preview Action v1.6.0

🚀 View preview at
https://rollkit.github.io/rollkit/pr-preview/pr-2061/

Built to branch gh-pages at 2025-03-20 14:31 UTC.
Preview will be ready when the GitHub Pages deployment is complete.

@Manav-Aggarwal Manav-Aggarwal merged commit bced847 into feature/exec_api Mar 20, 2025
21 of 23 checks passed
@Manav-Aggarwal Manav-Aggarwal deleted the header-data-separation-adr branch March 20, 2025 14:33
@github-project-automation github-project-automation bot moved this from For Review to Done in Evolve Mar 20, 2025
tzdybal pushed a commit that referenced this pull request Mar 24, 2025
<!--
Please read and fill out this form before submitting your PR.

Please make sure you have reviewed our contributors guide before
submitting your
first PR.

NOTE: PR titles should follow semantic commits:
https://www.conventionalcommits.org/en/v1.0.0/
-->

## Overview

Closes: #2046

<!-- 
Please provide an explanation of the PR, including the appropriate
context,
background, goal, and rationale. If there is an issue with this
information,
please provide a tl;dr and link the issue. 

Ex: Closes #<issue number>
-->
@tac0turtle tac0turtle removed this from Evolve Apr 24, 2025
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.

4 participants