reth_prune/segments/
set.rs

1use crate::segments::{
2    user::ReceiptsByLogs, AccountHistory, Bodies, Segment, SenderRecovery, StorageHistory,
3    TransactionLookup, UserReceipts,
4};
5use reth_db_api::{table::Value, transaction::DbTxMut};
6use reth_primitives_traits::NodePrimitives;
7use reth_provider::{
8    providers::StaticFileProvider, BlockReader, ChainStateBlockReader, DBProvider,
9    PruneCheckpointReader, PruneCheckpointWriter, RocksDBProviderFactory,
10    StaticFileProviderFactory,
11};
12use reth_prune_types::PruneModes;
13use reth_storage_api::{ChangeSetReader, StorageChangeSetReader, StorageSettingsCache};
14
15/// Collection of [`Segment`]. Thread-safe, allocated on the heap.
16#[derive(Debug)]
17pub struct SegmentSet<Provider> {
18    inner: Vec<Box<dyn Segment<Provider>>>,
19}
20
21impl<Provider> SegmentSet<Provider> {
22    /// Returns empty [`SegmentSet`] collection.
23    pub fn new() -> Self {
24        Self::default()
25    }
26
27    /// Adds new [`Segment`] to collection.
28    pub fn segment<S: Segment<Provider> + 'static>(mut self, segment: S) -> Self {
29        self.inner.push(Box::new(segment));
30        self
31    }
32
33    /// Adds new [Segment] to collection if it's [Some].
34    pub fn segment_opt<S: Segment<Provider> + 'static>(self, segment: Option<S>) -> Self {
35        if let Some(segment) = segment {
36            return self.segment(segment)
37        }
38        self
39    }
40
41    /// Consumes [`SegmentSet`] and returns a [Vec].
42    pub fn into_vec(self) -> Vec<Box<dyn Segment<Provider>>> {
43        self.inner
44    }
45}
46
47impl<Provider> SegmentSet<Provider>
48where
49    Provider: StaticFileProviderFactory<
50            Primitives: NodePrimitives<SignedTx: Value, Receipt: Value, BlockHeader: Value>,
51        > + DBProvider<Tx: DbTxMut>
52        + PruneCheckpointWriter
53        + PruneCheckpointReader
54        + BlockReader
55        + ChainStateBlockReader
56        + StorageSettingsCache
57        + ChangeSetReader
58        + StorageChangeSetReader
59        + RocksDBProviderFactory,
60{
61    /// Creates a [`SegmentSet`] from an existing components, such as [`StaticFileProvider`] and
62    /// [`PruneModes`].
63    pub fn from_components(
64        _static_file_provider: StaticFileProvider<Provider::Primitives>,
65        prune_modes: PruneModes,
66    ) -> Self {
67        let PruneModes {
68            sender_recovery,
69            transaction_lookup,
70            receipts,
71            account_history,
72            storage_history,
73            bodies_history,
74            receipts_log_filter,
75        } = prune_modes;
76
77        Self::default()
78            // Transaction lookup must run before bodies because it needs to read transaction
79            // data from static files before bodies deletes them.
80            .segment_opt(transaction_lookup.map(TransactionLookup::new))
81            // Bodies
82            .segment_opt(bodies_history.map(|mode| Bodies::new(mode, transaction_lookup)))
83            // Account history
84            .segment_opt(account_history.map(AccountHistory::new))
85            // Storage history
86            .segment_opt(storage_history.map(StorageHistory::new))
87            // User receipts
88            .segment_opt(receipts.map(UserReceipts::new))
89            // Receipts by logs
90            .segment_opt(
91                (!receipts_log_filter.is_empty())
92                    .then(|| ReceiptsByLogs::new(receipts_log_filter.clone())),
93            )
94            // Sender recovery
95            .segment_opt(sender_recovery.map(SenderRecovery::new))
96    }
97}
98
99impl<Provider> Default for SegmentSet<Provider> {
100    fn default() -> Self {
101        Self { inner: Vec::new() }
102    }
103}
reth_prune/segments/set.rs

reth_prune/segments/
set.rs
