Skip to content

Conversation

@tuxcanfly
Copy link
Contributor

@tuxcanfly tuxcanfly commented Oct 24, 2023

Overview

This PR documents the specifications for the validator set.

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

  • Documentation
    • Added a new document explaining the validator selection scheme in the Rollkit repository, including initialization, priority-based system for block proposers, and validator set management.

@codecov
Copy link

codecov bot commented Oct 24, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (cb1052a) 52.73% compared to head (0dad209) 52.65%.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1279      +/-   ##
==========================================
- Coverage   52.73%   52.65%   -0.09%     
==========================================
  Files          52       52              
  Lines        6222     6222              
==========================================
- Hits         3281     3276       -5     
- Misses       2630     2634       +4     
- Partials      311      312       +1     

see 1 file with indirect coverage changes

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

@tuxcanfly tuxcanfly force-pushed the tux/sequencer-specs branch from 2bbb573 to 6274b44 Compare October 25, 2023 15:54
@nashqueue nashqueue marked this pull request as ready for review October 27, 2023 16:01
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Oct 27, 2023

Walkthrough

This update introduces a comprehensive document detailing the validator selection scheme in the Rollkit repository. It provides an in-depth explanation of the initialization of validators, the priority-based system for block proposers, and the management of validator sets, along with communication formats and implementation assumptions.

Changes

File Summary
state/validators.md Introduced a new document, "Sequencer Selection Scheme", explaining the validator selection process in the Rollkit repository. It covers the initialization of validators, priority-based block proposer selection, validator set management, communication format, assumptions, and implementation details. No changes were made to the codebase.

Poem

🍂 As autumn leaves gently fall,
A new doc enters the hall.
Validators, sequencers, all in a row,
In Rollkit's dance, they steal the show.
📜 With wisdom scribed on every page,
It's a guide for the blockchain age.
So let's celebrate this grand addition,
A beacon in our code's mission. 🎉
As we hop into the season's delight,
Under the soft November moonlight. 🌙
Here's to progress, steady and bright,
CodeRabbit, signing off for the night. 🐇


Tips

Chat with CodeRabbit Bot (@coderabbitai)

  • If you reply to a review comment from CodeRabbit, the bot will automatically respond.
  • To engage with CodeRabbit bot directly around the specific lines of code in the PR, mention @coderabbitai in your review comment
  • Note: Review comments are made on code diffs or files, not on the PR overview.
  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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 help to get help.
  • @coderabbitai resolve to resolve all the CodeRabbit review comments.

Note: For conversation with the bot, please use the review comments on code diffs or files.

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

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 517e6cb and 6274b44.
Files selected for processing (1)
  • state/validators.md (1} hunks)
Files skipped from review due to trivial changes (1)
  • state/validators.md

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 d916f48 and 484094c.
Files selected for processing (1)
  • state/validators.md (1 hunks)
Files skipped from review due to trivial changes (1)
  • state/validators.md

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 91997fe and a650557.
Files selected for processing (1)
  • state/validators.md (1 hunks)
Files skipped from review due to trivial changes (1)
  • state/validators.md

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 a650557 and a613043.
Files selected for processing (1)
  • state/validators.md (1 hunks)
Files skipped from review due to trivial changes (1)
  • state/validators.md

@tuxcanfly tuxcanfly force-pushed the tux/sequencer-specs branch from a613043 to 5b8ca34 Compare November 1, 2023 23:33
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 f133b08 and 5b8ca34.
Files selected for processing (1)
  • state/validators.md (1 hunks)
Files skipped from review due to trivial changes (1)
  • state/validators.md

MSevey
MSevey previously approved these changes Nov 2, 2023
@tuxcanfly tuxcanfly force-pushed the tux/sequencer-specs branch from 5b8ca34 to 84e3cdb Compare November 3, 2023 14:29
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 cb1052a and 84e3cdb.
Files selected for processing (1)
  • state/validators.md (1 hunks)
Files skipped from review due to trivial changes (1)
  • state/validators.md

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 84e3cdb and 0dad209.
Files selected for processing (1)
  • state/validators.md (1 hunks)
Files skipped from review due to trivial changes (1)
  • state/validators.md

@Manav-Aggarwal Manav-Aggarwal requested a review from MSevey November 3, 2023 15:17
@Manav-Aggarwal Manav-Aggarwal added this pull request to the merge queue Nov 3, 2023
Merged via the queue into main with commit a76604a Nov 3, 2023
@Manav-Aggarwal Manav-Aggarwal deleted the tux/sequencer-specs branch November 3, 2023 16:23
gupadhyaya pushed a commit that referenced this pull request Nov 8, 2023
## Overview

This PR documents the specifications for the validator set.

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


<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit

- **Documentation**
- Added a new document explaining the validator selection scheme in the
Rollkit repository, including initialization, priority-based system for
block proposers, and validator set management.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->

---------

Co-authored-by: Manav Aggarwal <manavaggarwal1234@gmail.com>
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