docs: refresh stale architecture and structure docs#4580
Open
pinebit wants to merge 2 commits into
Open
Conversation
Update docs/architecture.md and docs/structure.md to match the current implementation: fix component interfaces to match core/interfaces.go, remove the nonexistent Signer/remote-signer component, correct the BFT fault tolerance formula, document the consensus controller and priority protocol, replace outdated DutyDB/ParSigDB data models, refresh the validator API endpoint list, and add a duty lifecycle table and supporting components section. Update the project structure doc with current packages and CLI commands. category: docs ticket: none Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Mention the pluggable consensus controller, correct the Priority and peer discovery descriptions, and add the InclusionChecker. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
|
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #4580 +/- ##
==========================================
+ Coverage 57.20% 57.22% +0.02%
==========================================
Files 245 245
Lines 33449 33449
==========================================
+ Hits 19135 19142 +7
+ Misses 11890 11880 -10
- Partials 2424 2427 +3 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
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.



Updates
docs/architecture.md,docs/structure.mdand theCLAUDE.mdarchitecture summary to match the current implementation.docs/architecture.md:Signer/remote-signer component from the workflow diagram (it does not exist in the code) and corrects the BFT fault tolerance note tot = ceil(2n/3)available and honest nodes, toleratingf = floor((n-1)/3)faulty nodes.core/interfaces.go(Scheduler, Fetcher, Consensus + ConsensusController, DutyDB, ValidatorAPI, ParSigDB, SigAgg, AggSigDB, Broadcaster) and notes that file as the source of truth.docs/structure.md:core/encode.go,app/dbindex/,p2p/discovery.go/discv5) and describes relay-based peer discovery.core/consensus,core/tracker,core/priority,core/infosync, app infrastructure libraries, eth2util and testutil subpackages) and the current CLI command tree (combine,exit,deposit,feerecipient,alpha,unsafe).CLAUDE.md:category: docs
ticket: none