chore: update CLAUDE.md which was severly out of date - #3154
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Updates CLAUDE.md to reflect the current BeaconKit architecture and developer workflow, replacing an outdated and overly long guide with a shorter, commit-verified reference aligned with the repo’s current layout and operational model.
Changes:
- Rewrote the repository overview to match BeaconKit’s CometBFT/SBT-driven slot pacing and current execution-client expectations.
- Refreshed the directory map, key commands (build/run/test), and configuration/environment-variable guidance.
- Updated architecture notes (ABCI++ flow, services, state transition, execution engine, forks/deposits, storage, halt mechanism) and condensed “gotchas”.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| Key differences from a standard Ethereum beacon chain: | ||
|
|
||
| - CometBFT height maps 1:1 to beacon slot. Heights are sequential, with no gaps and no missed slots. | ||
| - No fixed 12s slots. Block pacing is driven by SBT (stable block time) via ABCI `NextBlockDelay` (`consensus/cometbft/service/delay/`, target 2s). `timeout_commit` is deprecated and forced to 0. Propose/prevote/precommit timeouts have enforced 2000ms minimums (`consensus/cometbft/service/configs.go`). |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #3154 +/- ##
==========================================
- Coverage 63.11% 63.10% -0.02%
==========================================
Files 372 372
Lines 15549 15549
==========================================
- Hits 9814 9812 -2
- Misses 4775 4777 +2
Partials 960 960 🚀 New features to boost your workflow:
|
bar-bera
approved these changes
Aug 10, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Noticed the
CLAUDE.mdfile was severely out of date and was wrong in many places, much too long and hadn't been updated in over a year.