1use alloy_consensus::BlockHeader;
2use alloy_primitives::{BlockHash, BlockNumber, Bytes, B256};
3use futures_util::StreamExt;
4use reth_config::config::EtlConfig;
5use reth_db_api::{
6 cursor::{DbCursorRO, DbCursorRW},
7 table::Value,
8 tables,
9 transaction::{DbTx, DbTxMut},
10 DbTxUnwindExt, RawKey, RawTable, RawValue,
11};
12use reth_etl::Collector;
13use reth_network_p2p::headers::{
14 downloader::{HeaderDownloader, HeaderSyncGap, SyncTarget},
15 error::HeadersDownloaderError,
16};
17use reth_primitives_traits::{serde_bincode_compat, FullBlockHeader, NodePrimitives, SealedHeader};
18use reth_provider::{
19 providers::StaticFileWriter, BlockHashReader, DBProvider, HeaderProvider,
20 HeaderSyncGapProvider, StaticFileProviderFactory,
21};
22use reth_stages_api::{
23 CheckpointBlockRange, EntitiesCheckpoint, ExecInput, ExecOutput, HeadersCheckpoint, Stage,
24 StageCheckpoint, StageError, StageId, UnwindInput, UnwindOutput,
25};
26use reth_static_file_types::StaticFileSegment;
27use reth_storage_errors::provider::ProviderError;
28use std::task::{ready, Context, Poll};
29
30use tokio::sync::watch;
31use tracing::*;
32
33#[derive(Debug)]
45pub struct HeaderStage<Provider, Downloader: HeaderDownloader> {
46 provider: Provider,
48 downloader: Downloader,
50 tip: watch::Receiver<B256>,
54 sync_gap: Option<HeaderSyncGap<Downloader::Header>>,
56 hash_collector: Collector<BlockHash, BlockNumber>,
58 header_collector: Collector<BlockNumber, Bytes>,
60 is_etl_ready: bool,
62}
63
64impl<Provider, Downloader> HeaderStage<Provider, Downloader>
67where
68 Downloader: HeaderDownloader,
69{
70 pub fn new(
72 database: Provider,
73 downloader: Downloader,
74 tip: watch::Receiver<B256>,
75 etl_config: EtlConfig,
76 ) -> Self {
77 Self {
78 provider: database,
79 downloader,
80 tip,
81 sync_gap: None,
82 hash_collector: Collector::new(etl_config.file_size / 2, etl_config.dir.clone()),
83 header_collector: Collector::new(etl_config.file_size / 2, etl_config.dir),
84 is_etl_ready: false,
85 }
86 }
87
88 fn write_headers<P>(&mut self, provider: &P) -> Result<BlockNumber, StageError>
93 where
94 P: DBProvider<Tx: DbTxMut> + StaticFileProviderFactory,
95 Downloader: HeaderDownloader<Header = <P::Primitives as NodePrimitives>::BlockHeader>,
96 <P::Primitives as NodePrimitives>::BlockHeader: Value + FullBlockHeader,
97 {
98 let total_headers = self.header_collector.len();
99
100 info!(target: "sync::stages::headers", total = total_headers, "Writing headers");
101
102 let static_file_provider = provider.static_file_provider();
103
104 let mut last_header_number = static_file_provider
107 .get_highest_static_file_block(StaticFileSegment::Headers)
108 .unwrap_or_default();
109
110 let mut td = static_file_provider
112 .header_td_by_number(last_header_number)?
113 .ok_or(ProviderError::TotalDifficultyNotFound(last_header_number))?;
114
115 let mut writer = static_file_provider.latest_writer(StaticFileSegment::Headers)?;
118 let interval = (total_headers / 10).max(1);
119 for (index, header) in self.header_collector.iter()?.enumerate() {
120 let (_, header_buf) = header?;
121
122 if index > 0 && index.is_multiple_of(interval) && total_headers > 100 {
123 info!(target: "sync::stages::headers", progress = %format!("{:.2}%", (index as f64 / total_headers as f64) * 100.0), "Writing headers");
124 }
125
126 let sealed_header: SealedHeader<Downloader::Header> =
127 bincode::deserialize::<serde_bincode_compat::SealedHeader<'_, _>>(&header_buf)
128 .map_err(|err| StageError::Fatal(Box::new(err)))?
129 .into();
130
131 let (header, header_hash) = sealed_header.split_ref();
132 if header.number() == 0 {
133 continue
134 }
135 last_header_number = header.number();
136
137 td += header.difficulty();
139
140 writer.append_header(header, td, header_hash)?;
142 }
143
144 info!(target: "sync::stages::headers", total = total_headers, "Writing headers hash index");
145
146 let mut cursor_header_numbers =
147 provider.tx_ref().cursor_write::<RawTable<tables::HeaderNumbers>>()?;
148 let mut first_sync = false;
149
150 if provider.tx_ref().entries::<RawTable<tables::HeaderNumbers>>()? == 1 {
153 if let Some((hash, block_number)) = cursor_header_numbers.last()? {
154 if block_number.value()? == 0 {
155 self.hash_collector.insert(hash.key()?, 0)?;
156 cursor_header_numbers.delete_current()?;
157 first_sync = true;
158 }
159 }
160 }
161
162 for (index, hash_to_number) in self.hash_collector.iter()?.enumerate() {
165 let (hash, number) = hash_to_number?;
166
167 if index > 0 && index.is_multiple_of(interval) && total_headers > 100 {
168 info!(target: "sync::stages::headers", progress = %format!("{:.2}%", (index as f64 / total_headers as f64) * 100.0), "Writing headers hash index");
169 }
170
171 if first_sync {
172 cursor_header_numbers.append(
173 RawKey::<BlockHash>::from_vec(hash),
174 &RawValue::<BlockNumber>::from_vec(number),
175 )?;
176 } else {
177 cursor_header_numbers.upsert(
178 RawKey::<BlockHash>::from_vec(hash),
179 &RawValue::<BlockNumber>::from_vec(number),
180 )?;
181 }
182 }
183
184 Ok(last_header_number)
185 }
186}
187
188impl<Provider, P, D> Stage<Provider> for HeaderStage<P, D>
189where
190 Provider: DBProvider<Tx: DbTxMut> + StaticFileProviderFactory,
191 P: HeaderSyncGapProvider<Header = <Provider::Primitives as NodePrimitives>::BlockHeader>,
192 D: HeaderDownloader<Header = <Provider::Primitives as NodePrimitives>::BlockHeader>,
193 <Provider::Primitives as NodePrimitives>::BlockHeader: FullBlockHeader + Value,
194{
195 fn id(&self) -> StageId {
197 StageId::Headers
198 }
199
200 fn poll_execute_ready(
201 &mut self,
202 cx: &mut Context<'_>,
203 input: ExecInput,
204 ) -> Poll<Result<(), StageError>> {
205 let current_checkpoint = input.checkpoint();
206
207 if self.is_etl_ready {
209 return Poll::Ready(Ok(()))
210 }
211
212 let local_head = self.provider.local_tip_header(current_checkpoint.block_number)?;
214 let target = SyncTarget::Tip(*self.tip.borrow());
215 let gap = HeaderSyncGap { local_head, target };
216 let tip = gap.target.tip();
217
218 if gap.is_closed() {
220 info!(
221 target: "sync::stages::headers",
222 checkpoint = %current_checkpoint.block_number,
223 target = ?tip,
224 "Target block already reached"
225 );
226 self.is_etl_ready = true;
227 self.sync_gap = Some(gap);
228 return Poll::Ready(Ok(()))
229 }
230
231 debug!(target: "sync::stages::headers", ?tip, head = ?gap.local_head.hash(), "Commencing sync");
232 let local_head_number = gap.local_head.number();
233
234 if self.sync_gap != Some(gap.clone()) {
236 self.sync_gap = Some(gap.clone());
237 self.downloader.update_sync_gap(gap.local_head, gap.target);
238 }
239
240 loop {
242 match ready!(self.downloader.poll_next_unpin(cx)) {
243 Some(Ok(headers)) => {
244 info!(target: "sync::stages::headers", total = headers.len(), from_block = headers.first().map(|h| h.number()), to_block = headers.last().map(|h| h.number()), "Received headers");
245 for header in headers {
246 let header_number = header.number();
247
248 self.hash_collector.insert(header.hash(), header_number)?;
249 self.header_collector.insert(
250 header_number,
251 Bytes::from(
252 bincode::serialize(&serde_bincode_compat::SealedHeader::from(
253 &header,
254 ))
255 .map_err(|err| StageError::Fatal(Box::new(err)))?,
256 ),
257 )?;
258
259 if header_number == local_head_number + 1 {
262 self.is_etl_ready = true;
263 return Poll::Ready(Ok(()))
264 }
265 }
266 }
267 Some(Err(HeadersDownloaderError::DetachedHead { local_head, header, error })) => {
268 error!(target: "sync::stages::headers", %error, "Cannot attach header to head");
269 self.sync_gap = None;
270 return Poll::Ready(Err(StageError::DetachedHead {
271 local_head: Box::new(local_head.block_with_parent()),
272 header: Box::new(header.block_with_parent()),
273 error,
274 }))
275 }
276 None => {
277 self.sync_gap = None;
278 return Poll::Ready(Err(StageError::ChannelClosed))
279 }
280 }
281 }
282 }
283
284 fn execute(&mut self, provider: &Provider, input: ExecInput) -> Result<ExecOutput, StageError> {
287 let current_checkpoint = input.checkpoint();
288
289 if self.sync_gap.take().ok_or(StageError::MissingSyncGap)?.is_closed() {
290 self.is_etl_ready = false;
291 return Ok(ExecOutput::done(current_checkpoint))
292 }
293
294 if !self.is_etl_ready {
296 return Err(StageError::MissingDownloadBuffer)
297 }
298
299 self.is_etl_ready = false;
301
302 let to_be_processed = self.hash_collector.len() as u64;
304 let last_header_number = self.write_headers(provider)?;
305
306 self.hash_collector.clear();
308 self.header_collector.clear();
309
310 Ok(ExecOutput {
311 checkpoint: StageCheckpoint::new(last_header_number).with_headers_stage_checkpoint(
312 HeadersCheckpoint {
313 block_range: CheckpointBlockRange {
314 from: input.checkpoint().block_number,
315 to: last_header_number,
316 },
317 progress: EntitiesCheckpoint {
318 processed: input.checkpoint().block_number + to_be_processed,
319 total: last_header_number,
320 },
321 },
322 ),
323 done: true,
326 })
327 }
328
329 fn unwind(
331 &mut self,
332 provider: &Provider,
333 input: UnwindInput,
334 ) -> Result<UnwindOutput, StageError> {
335 self.sync_gap.take();
336
337 provider
341 .tx_ref()
342 .unwind_table_by_walker::<tables::CanonicalHeaders, tables::HeaderNumbers>(
343 (input.unwind_to + 1)..,
344 )?;
345 provider.tx_ref().unwind_table_by_num::<tables::CanonicalHeaders>(input.unwind_to)?;
346 provider
347 .tx_ref()
348 .unwind_table_by_num::<tables::HeaderTerminalDifficulties>(input.unwind_to)?;
349 let unfinalized_headers_unwound =
350 provider.tx_ref().unwind_table_by_num::<tables::Headers>(input.unwind_to)?;
351
352 let static_file_provider = provider.static_file_provider();
355 let highest_block = static_file_provider
356 .get_highest_static_file_block(StaticFileSegment::Headers)
357 .unwrap_or_default();
358 let static_file_headers_to_unwind = highest_block - input.unwind_to;
359 for block_number in (input.unwind_to + 1)..=highest_block {
360 let hash = static_file_provider.block_hash(block_number)?;
361 if let Some(header_hash) = hash {
367 provider.tx_ref().delete::<tables::HeaderNumbers>(header_hash, None)?;
368 }
369 }
370
371 let mut writer = static_file_provider.latest_writer(StaticFileSegment::Headers)?;
373 writer.prune_headers(static_file_headers_to_unwind)?;
374
375 let stage_checkpoint =
378 input.checkpoint.headers_stage_checkpoint().map(|stage_checkpoint| HeadersCheckpoint {
379 block_range: stage_checkpoint.block_range,
380 progress: EntitiesCheckpoint {
381 processed: stage_checkpoint.progress.processed.saturating_sub(
382 static_file_headers_to_unwind + unfinalized_headers_unwound as u64,
383 ),
384 total: stage_checkpoint.progress.total,
385 },
386 });
387
388 let mut checkpoint = StageCheckpoint::new(input.unwind_to);
389 if let Some(stage_checkpoint) = stage_checkpoint {
390 checkpoint = checkpoint.with_headers_stage_checkpoint(stage_checkpoint);
391 }
392
393 Ok(UnwindOutput { checkpoint })
394 }
395}
396
397#[cfg(test)]
398mod tests {
399 use super::*;
400 use crate::test_utils::{
401 stage_test_suite, ExecuteStageTestRunner, StageTestRunner, UnwindStageTestRunner,
402 };
403 use alloy_primitives::B256;
404 use assert_matches::assert_matches;
405 use reth_ethereum_primitives::BlockBody;
406 use reth_execution_types::ExecutionOutcome;
407 use reth_primitives_traits::{RecoveredBlock, SealedBlock};
408 use reth_provider::{BlockWriter, ProviderFactory, StaticFileProviderFactory};
409 use reth_stages_api::StageUnitCheckpoint;
410 use reth_testing_utils::generators::{self, random_header, random_header_range};
411 use reth_trie::{updates::TrieUpdates, HashedPostStateSorted};
412 use std::sync::Arc;
413 use test_runner::HeadersTestRunner;
414
415 mod test_runner {
416 use super::*;
417 use crate::test_utils::{TestRunnerError, TestStageDB};
418 use reth_consensus::test_utils::TestConsensus;
419 use reth_downloaders::headers::reverse_headers::{
420 ReverseHeadersDownloader, ReverseHeadersDownloaderBuilder,
421 };
422 use reth_network_p2p::test_utils::{TestHeaderDownloader, TestHeadersClient};
423 use reth_provider::{test_utils::MockNodeTypesWithDB, BlockNumReader};
424 use tokio::sync::watch;
425
426 pub(crate) struct HeadersTestRunner<D: HeaderDownloader> {
427 pub(crate) client: TestHeadersClient,
428 channel: (watch::Sender<B256>, watch::Receiver<B256>),
429 downloader_factory: Box<dyn Fn() -> D + Send + Sync + 'static>,
430 db: TestStageDB,
431 }
432
433 impl Default for HeadersTestRunner<TestHeaderDownloader> {
434 fn default() -> Self {
435 let client = TestHeadersClient::default();
436 Self {
437 client: client.clone(),
438 channel: watch::channel(B256::ZERO),
439
440 downloader_factory: Box::new(move || {
441 TestHeaderDownloader::new(client.clone(), 1000, 1000)
442 }),
443 db: TestStageDB::default(),
444 }
445 }
446 }
447
448 impl<D: HeaderDownloader<Header = alloy_consensus::Header> + 'static> StageTestRunner
449 for HeadersTestRunner<D>
450 {
451 type S = HeaderStage<ProviderFactory<MockNodeTypesWithDB>, D>;
452
453 fn db(&self) -> &TestStageDB {
454 &self.db
455 }
456
457 fn stage(&self) -> Self::S {
458 HeaderStage::new(
459 self.db.factory.clone(),
460 (*self.downloader_factory)(),
461 self.channel.1.clone(),
462 EtlConfig::default(),
463 )
464 }
465 }
466
467 impl<D: HeaderDownloader<Header = alloy_consensus::Header> + 'static> ExecuteStageTestRunner
468 for HeadersTestRunner<D>
469 {
470 type Seed = Vec<SealedHeader>;
471
472 fn seed_execution(&mut self, input: ExecInput) -> Result<Self::Seed, TestRunnerError> {
473 let mut rng = generators::rng();
474 let start = input.checkpoint().block_number;
475 let headers = random_header_range(&mut rng, 0..start + 1, B256::ZERO);
476 let head = headers.last().cloned().unwrap();
477 self.db.insert_headers_with_td(headers.iter())?;
478
479 let end = input.target.unwrap_or_default() + 1;
481
482 if start + 1 >= end {
483 return Ok(Vec::default())
484 }
485
486 let mut headers = random_header_range(&mut rng, start + 1..end, head.hash());
487 headers.insert(0, head);
488 Ok(headers)
489 }
490
491 fn validate_execution(
493 &self,
494 input: ExecInput,
495 output: Option<ExecOutput>,
496 ) -> Result<(), TestRunnerError> {
497 let initial_checkpoint = input.checkpoint().block_number;
498 match output {
499 Some(output) if output.checkpoint.block_number > initial_checkpoint => {
500 let provider = self.db.factory.provider()?;
501 let mut td = provider
502 .header_td_by_number(initial_checkpoint.saturating_sub(1))?
503 .unwrap_or_default();
504
505 for block_num in initial_checkpoint..output.checkpoint.block_number {
506 let hash = provider.block_hash(block_num)?.expect("no header hash");
508
509 assert_eq!(provider.block_number(hash)?, Some(block_num));
511
512 let header = provider.header_by_number(block_num)?;
514 assert!(header.is_some());
515 let header = SealedHeader::seal_slow(header.unwrap());
516 assert_eq!(header.hash(), hash);
517
518 td += header.difficulty;
520 assert_eq!(provider.header_td_by_number(block_num)?, Some(td));
521 }
522 }
523 _ => self.check_no_header_entry_above(initial_checkpoint)?,
524 };
525 Ok(())
526 }
527
528 async fn after_execution(&self, headers: Self::Seed) -> Result<(), TestRunnerError> {
529 self.client.extend(headers.iter().map(|h| h.clone_header())).await;
530 let tip = if headers.is_empty() {
531 let tip = random_header(&mut generators::rng(), 0, None);
532 self.db.insert_headers(std::iter::once(&tip))?;
533 tip.hash()
534 } else {
535 headers.last().unwrap().hash()
536 };
537 self.send_tip(tip);
538 Ok(())
539 }
540 }
541
542 impl<D: HeaderDownloader<Header = alloy_consensus::Header> + 'static> UnwindStageTestRunner
543 for HeadersTestRunner<D>
544 {
545 fn validate_unwind(&self, input: UnwindInput) -> Result<(), TestRunnerError> {
546 self.check_no_header_entry_above(input.unwind_to)
547 }
548 }
549
550 impl HeadersTestRunner<ReverseHeadersDownloader<TestHeadersClient>> {
551 pub(crate) fn with_linear_downloader() -> Self {
552 let client = TestHeadersClient::default();
553 Self {
554 client: client.clone(),
555 channel: watch::channel(B256::ZERO),
556 downloader_factory: Box::new(move || {
557 ReverseHeadersDownloaderBuilder::default()
558 .stream_batch_size(500)
559 .build(client.clone(), Arc::new(TestConsensus::default()))
560 }),
561 db: TestStageDB::default(),
562 }
563 }
564 }
565
566 impl<D: HeaderDownloader> HeadersTestRunner<D> {
567 pub(crate) fn check_no_header_entry_above(
568 &self,
569 block: BlockNumber,
570 ) -> Result<(), TestRunnerError> {
571 self.db
572 .ensure_no_entry_above_by_value::<tables::HeaderNumbers, _>(block, |val| val)?;
573 self.db.ensure_no_entry_above::<tables::CanonicalHeaders, _>(block, |key| key)?;
574 self.db.ensure_no_entry_above::<tables::Headers, _>(block, |key| key)?;
575 self.db.ensure_no_entry_above::<tables::HeaderTerminalDifficulties, _>(
576 block,
577 |num| num,
578 )?;
579 Ok(())
580 }
581
582 pub(crate) fn send_tip(&self, tip: B256) {
583 self.channel.0.send(tip).expect("failed to send tip");
584 }
585 }
586 }
587
588 stage_test_suite!(HeadersTestRunner, headers);
589
590 #[tokio::test]
593 async fn execute_with_linear_downloader_unwind() {
594 let mut runner = HeadersTestRunner::with_linear_downloader();
595 let (checkpoint, previous_stage) = (1000, 1200);
596 let input = ExecInput {
597 target: Some(previous_stage),
598 checkpoint: Some(StageCheckpoint::new(checkpoint)),
599 };
600 let headers = runner.seed_execution(input).expect("failed to seed execution");
601 let rx = runner.execute(input);
602
603 runner.client.extend(headers.iter().rev().map(|h| h.clone_header())).await;
604
605 let tip = headers.last().unwrap();
607 runner.send_tip(tip.hash());
608
609 let result = rx.await.unwrap();
610 runner.db().factory.static_file_provider().commit().unwrap();
611 assert_matches!(result, Ok(ExecOutput { checkpoint: StageCheckpoint {
612 block_number,
613 stage_checkpoint: Some(StageUnitCheckpoint::Headers(HeadersCheckpoint {
614 block_range: CheckpointBlockRange {
615 from,
616 to
617 },
618 progress: EntitiesCheckpoint {
619 processed,
620 total,
621 }
622 }))
623 }, done: true }) if block_number == tip.number &&
624 from == checkpoint && to == previous_stage &&
625 processed == checkpoint + headers.len() as u64 - 1 && total == tip.number
627 );
628 assert!(runner.validate_execution(input, result.ok()).is_ok(), "validation failed");
629 assert!(runner.stage().hash_collector.is_empty());
630 assert!(runner.stage().header_collector.is_empty());
631
632 let sealed_headers =
634 random_header_range(&mut generators::rng(), tip.number..tip.number + 10, tip.hash());
635
636 let sealed_blocks = sealed_headers
638 .iter()
639 .map(|header| {
640 RecoveredBlock::new_sealed(
641 SealedBlock::from_sealed_parts(header.clone(), BlockBody::default()),
642 vec![],
643 )
644 })
645 .collect();
646
647 let provider = runner.db().factory.provider_rw().unwrap();
649 provider
650 .append_blocks_with_state(
651 sealed_blocks,
652 &ExecutionOutcome::default(),
653 HashedPostStateSorted::default(),
654 TrieUpdates::default(),
655 )
656 .unwrap();
657 provider.commit().unwrap();
658
659 let unwind_input = UnwindInput {
661 checkpoint: StageCheckpoint::new(tip.number + 10),
662 unwind_to: tip.number,
663 bad_block: None,
664 };
665
666 let unwind_output = runner.unwind(unwind_input).await.unwrap();
667 assert_eq!(unwind_output.checkpoint.block_number, tip.number);
668
669 assert!(runner.validate_unwind(unwind_input).is_ok());
671 }
672
673 #[tokio::test]
675 async fn execute_with_linear_downloader() {
676 let mut runner = HeadersTestRunner::with_linear_downloader();
677 let (checkpoint, previous_stage) = (1000, 1200);
678 let input = ExecInput {
679 target: Some(previous_stage),
680 checkpoint: Some(StageCheckpoint::new(checkpoint)),
681 };
682 let headers = runner.seed_execution(input).expect("failed to seed execution");
683 let rx = runner.execute(input);
684
685 runner.client.extend(headers.iter().rev().map(|h| h.clone_header())).await;
686
687 let tip = headers.last().unwrap();
689 runner.send_tip(tip.hash());
690
691 let result = rx.await.unwrap();
692 runner.db().factory.static_file_provider().commit().unwrap();
693 assert_matches!(result, Ok(ExecOutput { checkpoint: StageCheckpoint {
694 block_number,
695 stage_checkpoint: Some(StageUnitCheckpoint::Headers(HeadersCheckpoint {
696 block_range: CheckpointBlockRange {
697 from,
698 to
699 },
700 progress: EntitiesCheckpoint {
701 processed,
702 total,
703 }
704 }))
705 }, done: true }) if block_number == tip.number &&
706 from == checkpoint && to == previous_stage &&
707 processed == checkpoint + headers.len() as u64 - 1 && total == tip.number
709 );
710 assert!(runner.validate_execution(input, result.ok()).is_ok(), "validation failed");
711 assert!(runner.stage().hash_collector.is_empty());
712 assert!(runner.stage().header_collector.is_empty());
713 }
714}