reth_prune/segments/
set.rs

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

reth_prune/segments/
set.rs
