Commit 88b3e5e
committed
docs: document UnknownBlockSync vs UnknownChainSync split
Medium issue ChainSafe#9 from REVIEW.md: two overlapping unknown-block mechanisms
existed without clear documentation of which to use when.
Add detailed module-level doc to unknown_block.zig explaining:
- UnknownBlockSync: triggered by gossip blocks with unknown parent;
stores full block bytes; resolves by parent chain walk + recursive import
- UnknownChainSync: triggered by unknown roots from attestations/status;
no block bytes, only roots; resolves by backwards header chain to
fork choice, then triggers forward range sync
- The key distinction: UnknownBlockSync has the block, UnknownChainSync
does not. They are complementary, not redundant.
🤖 Generated with AI assistance1 parent b0e7838 commit 88b3e5e
1 file changed
+26
-0
lines changed| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
10 | 10 | | |
11 | 11 | | |
12 | 12 | | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
| 30 | + | |
| 31 | + | |
| 32 | + | |
| 33 | + | |
| 34 | + | |
| 35 | + | |
| 36 | + | |
| 37 | + | |
| 38 | + | |
13 | 39 | | |
14 | 40 | | |
15 | 41 | | |
| |||
0 commit comments