feat: remove cometbft dependency to GenesisDoc by randygrok · Pull Request #2091 · evstack/ev-node

randygrok · 2025-03-19T09:45:16Z

Overview

Remove dependendency from cometbft GenesisDoc.
Update Genesis struct to mirror ADR 016

Summary by CodeRabbit

Documentation
- Added comprehensive guides for the Block Manager and Full Node services, detailing configuration, synchronization, and operational workflows.
Refactor
- Streamlined genesis configuration handling with a new, flexible structure to improve state initialization and cryptographic key management.
- Simplified node startup and block syncing processes for enhanced reliability.
Tests
- Updated test suites to align with the revamped genesis handling and synchronization improvements.
Chores
- Cleaned up outdated initialization methods and redundant test cases to ensure a more maintainable integration process.

coderabbitai · 2025-03-19T09:45:47Z

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

This update introduces comprehensive documentation for the Block Manager and refactors the genesis handling throughout the codebase. The changes transition from legacy genesis types (e.g., RollkitGenesis and cmtypes.GenesisDoc) to a new, unified genesis.Genesis type. Function signatures, state initialization, and test cases across block management, node components, sync services, and dummy clients have been updated accordingly. Additionally, a new genesis package has been created to provide constructors, validation, and IO operations.

Changes

File(s)	Change Summary
`block/block-manager.md`	New documentation detailing the Block Manager's operations including block production (normal and lazy modes), syncing, DA publication with retry, state updates, and fault handling.
`block/manager.go`, `block/manager_test.go`, `block/sync_service.go`	Refactored genesis handling from legacy types to `genesis.Genesis`; updated function signatures, state initialization, and block sync logic.
`cmd/rollkit/.../run_node.go`, `cmd/rollkit/.../run_node_test.go`	Simplified genesis loading and node file initialization by switching to direct usage of `genesispkg.LoadGenesis` and `genesispkg.NewGenesis`.
`node/...` (full.go, full_node.md, full_node_integration_test.go, helpers_test.go, light.go, node.go, node_integration_test.go, node_test.go)	Transitioned node components to the new genesis type; adjusted method signatures and test calls to handle additional return values from `GetGenesisWithPrivkey` and adopt `genesispkg.NewGenesis`.
`core/da/dummy_client_test.go`, `core/da/dummy_test.go`	Adjusted parameters for dummy client/data retrieval methods (e.g., switching height arguments from 1 to 0).
`core/go.mod`, `types/state.go`, `types/utils.go`	Updated state initialization and utility functions by renaming ed25519 references and modifying the signature/logic of `GetGenesisWithPrivkey`; minor formatting tweaks in go.mod.
`pkg/genesis/...` (genesis.go, genesis_test.go, io.go, io_test.go)	Introduced a new genesis package featuring the `Genesis` struct, supporting types (e.g., `GenesisExtraData`, `ValidatorInfo`), constructors (`NewGenesis`), validation, and IO functions for loading/saving genesis configurations, along with corresponding tests.

Sequence Diagram(s)

sequenceDiagram
    participant BM as Block Manager
    participant GS as Genesis Module
    participant Exec as Executor
    participant DA as DA Network
    participant Store as Storage

    BM->>GS: Load genesis config (NewGenesis/LoadGenesis)
    GS-->>BM: Return genesis data
    BM->>Exec: Initialize state using genesis data
    BM->>BM: Determine production mode (Normal or Lazy)
    BM->>DA: Publish block (with exponential backoff on failure)
    DA-->>BM: Acknowledge block publication
    BM->>Store: Save block and update state

Possibly related PRs

feat: header/data and sequencer/block-builder separation #1789: Enhances block management logic and data processing, aligning with the updated Block Manager documentation and functionality.
feat: remove event bus #2011: Involves modifications to block/manager.go with new genesis types, closely related to the current genesis refactoring.
fix: Fix vote extension issues, add custom logic to handle secp256k1, fix rpc nilptr issues #1717: Adjusts Block Manager implementations with changes to private key handling and vote extension logic, sharing context with these changes.

Suggested labels

T:dependencies

Suggested reviewers

tuxcanfly
gupadhyaya
Manav-Aggarwal
tzdybal

Poem

I’m a rabbit hopping through the code,
In genesis fields where new blocks are sowed.
The Block Manager sings in lazy or normal mode,
As updates streamline each injected node.
With hoppy joy, I cheer these changes bright—
May our network thrive by day and night!
🐇✨

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 plan to trigger planning for file edits and PR creation.
@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.

codecov · 2025-03-19T14:21:01Z

Codecov Report

Attention: Patch coverage is 49.61832% with 66 lines in your changes missing coverage. Please review.

Project coverage is 23.17%. Comparing base (2262207) to head (4f1d4f2).
Report is 18 commits behind head on feature/exec_api.

Files with missing lines	Patch %	Lines
types/utils.go	9.52%	19 Missing ⚠️
cmd/rollkit/commands/run_node.go	46.15%	13 Missing and 1 partial ⚠️
pkg/genesis/genesis.go	52.38%	10 Missing ⚠️
pkg/genesis/io.go	73.52%	6 Missing and 3 partials ⚠️
block/sync_service.go	0.00%	7 Missing ⚠️
types/state.go	0.00%	4 Missing ⚠️
block/manager.go	75.00%	2 Missing ⚠️
node/full.go	90.00%	1 Missing ⚠️

Additional details and impacted files

@@                 Coverage Diff                  @@
##           feature/exec_api    #2091      +/-   ##
====================================================
- Coverage             24.11%   23.17%   -0.95%     
====================================================
  Files                    52       54       +2     
  Lines                  8231     8182      -49     
====================================================
- Hits                   1985     1896      -89     
- Misses                 6089     6123      +34     
- Partials                157      163       +6

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

…sis-clean

core/execution/execution.go

core/go.mod

core/go.sum

…sis-clean

randygrok · 2025-03-24T19:19:56Z

@coderabbitai summary

coderabbitai · 2025-03-24T19:20:02Z

✅ Actions performed

Summary regeneration triggered.

tac0turtle

Almost there. Not sure if startheight should be start time, using height for time is confusing

block/block-manager.md

cmd/rollkit/commands/run_node.go

core/da/dummy_test.go

tac0turtle · 2025-03-24T21:15:21Z

pkg/genesis/genesis.go

+// Genesis represents the genesis state of the blockchain
+type Genesis struct {
+	ChainID              string           `json:"chain_id"`
+	GenesisDAStartHeight time.Time        `json:"genesis_da_start_height"` // TODO: change to uint64 and remove time.Time, basically we need a mechanism to convert DAHeight to time.Time


This should be a uint64 (height) or it should be renamed to DAStartTime

yeah, this is approved to have some design, as it has some implications this change in order to get the time by DA height. @Manav-Aggarwal will propose something.

Is a temporary fix

dont follow, what is this a fix of? the adr says height not time. you will need to poll DA for the height every n seconds to see. can we put height here and open an issue for the polling. no need to do it in this pr

pkg/genesis/genesis.go

github-actions · 2025-03-24T21:40:52Z

PR Preview Action v1.6.0
🚀 View preview at https://rollkit.github.io/rollkit/pr-preview/pr-2091/
Built to branch `gh-pages` at 2025-03-24 21:40 UTC. Preview will be ready when the GitHub Pages deployment is complete.

genesis implementation poc

1654323

github-project-automation bot added this to Evolve Mar 19, 2025

github-actions bot assigned randygrok Mar 19, 2025

randygrok changed the base branch from main to feature/exec_api March 19, 2025 09:45

randygrok added 4 commits March 19, 2025 13:26

use genesis interface

c095c58

temp commit

64d7ce7

more changes

9f54416

make tests pass

cb8451b

randygrok added 2 commits March 20, 2025 15:17

fix lint

6ac0053

Merge remote-tracking branch 'origin/feature/exec_api' into feat/gene…

973c3ad

…sis-clean

randygrok changed the title ~~feat: genesis poc execution layer~~ feat: remove cometbft dependency to GenesisDoc Mar 20, 2025

tac0turtle reviewed Mar 20, 2025

View reviewed changes

core/execution/execution.go Outdated Show resolved Hide resolved

randygrok and others added 8 commits March 20, 2025 20:17

Merge branch 'feature/exec_api' into feat/genesis-clean

a6e16b7

temp commit

1fcd875

fix tests

95cfadd

rename fields in config

54db65e

add ExtraData

cc57479

genesis load

00c4281

move genesis file to pkg

2f4a20d

load genesis file

6667115

tac0turtle reviewed Mar 24, 2025

View reviewed changes

core/go.mod Show resolved Hide resolved

tac0turtle reviewed Mar 24, 2025

View reviewed changes

core/go.sum Outdated Show resolved Hide resolved

randygrok added 5 commits March 24, 2025 17:05

add io test

4038f62

update block manager cmd

8175afd

add message into execution core

795bcd3

remove go.sum

af5ee7b

Merge remote-tracking branch 'origin/feature/exec_api' into feat/gene…

e874a21

…sis-clean

randygrok marked this pull request as ready for review March 24, 2025 16:14

RollkitBot requested review from a team, Manav-Aggarwal, tuxcanfly and yarikbratashchuk and removed request for a team March 24, 2025 16:14

randygrok added 2 commits March 24, 2025 20:04

Fix lint problems

d561021

use default genesis

55c543e

randygrok added 6 commits March 24, 2025 20:25

clean markdown lint

66d60b3

bring back creation of genesis

dc510ad

revert

3e5476e

fix markdown lint

d342066

fix errors with markdown

96afdf6

fix markdown lint

a9ddcd4

tac0turtle reviewed Mar 24, 2025

View reviewed changes

randygrok added 3 commits March 24, 2025 22:35

review changes

8acbfb4

remove commented code

dd18f2d

fix md

4f1d4f2

tac0turtle merged commit c7ee8f6 into feature/exec_api Mar 25, 2025
26 checks passed

tac0turtle deleted the feat/genesis-clean branch March 25, 2025 08:18

github-project-automation bot moved this to Done in Evolve Mar 25, 2025

coderabbitai bot mentioned this pull request Apr 4, 2025

feat: exec api #1997

Merged

coderabbitai bot mentioned this pull request Apr 15, 2025

refactor: remove batch queue #2173

Merged

coderabbitai bot mentioned this pull request Apr 22, 2025

chore: generate mocks for all of core #2210

Merged

tac0turtle removed this from Evolve Apr 24, 2025

coderabbitai bot mentioned this pull request May 7, 2025

fix: Fix Validation logic #2237

Merged

Comments

Conversation

randygrok commented Mar 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Overview

Summary by CodeRabbit

Uh oh!

coderabbitai bot commented Mar 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Review skipped

Walkthrough

Changes

Sequence Diagram(s)

Possibly related PRs

Suggested labels

Suggested reviewers

Poem

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

codecov bot commented Mar 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Uh oh!

Uh oh!

Uh oh!

randygrok commented Mar 24, 2025

Uh oh!

coderabbitai bot commented Mar 24, 2025

Uh oh!

tac0turtle left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

tac0turtle Mar 24, 2025

Choose a reason for hiding this comment

Uh oh!

randygrok Mar 24, 2025

Choose a reason for hiding this comment

Uh oh!

randygrok Mar 24, 2025

Choose a reason for hiding this comment

Uh oh!

tac0turtle Mar 25, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

github-actions bot commented Mar 24, 2025

Built to branch gh-pages at 2025-03-24 21:40 UTC. Preview will be ready when the GitHub Pages deployment is complete.

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

randygrok commented Mar 19, 2025 •

edited

Loading

coderabbitai bot commented Mar 19, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

codecov bot commented Mar 19, 2025 •

edited

Loading

Built to branch `gh-pages` at 2025-03-24 21:40 UTC.
Preview will be ready when the GitHub Pages deployment is complete.