reth_prune/segments/
set.rs

1use crate::segments::{
2    AccountHistory, ReceiptsByLogs, Segment, SenderRecovery, StorageHistory, TransactionLookup,
3    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, DBProvider, PruneCheckpointWriter,
10    StaticFileProviderFactory,
11};
12use reth_prune_types::PruneModes;
13
14use super::{StaticFileHeaders, StaticFileReceipts, StaticFileTransactions};
15
16/// Collection of [`Segment`]. Thread-safe, allocated on the heap.
17#[derive(Debug)]
18pub struct SegmentSet<Provider> {
19    inner: Vec<Box<dyn Segment<Provider>>>,
20}
21
22impl<Provider> SegmentSet<Provider> {
23    /// Returns empty [`SegmentSet`] collection.
24    pub fn new() -> Self {
25        Self::default()
26    }
27
28    /// Adds new [`Segment`] to collection.
29    pub fn segment<S: Segment<Provider> + 'static>(mut self, segment: S) -> Self {
30        self.inner.push(Box::new(segment));
31        self
32    }
33
34    /// Adds new [Segment] to collection if it's [Some].
35    pub fn segment_opt<S: Segment<Provider> + 'static>(self, segment: Option<S>) -> Self {
36        if let Some(segment) = segment {
37            return self.segment(segment)
38        }
39        self
40    }
41
42    /// Consumes [`SegmentSet`] and returns a [Vec].
43    pub fn into_vec(self) -> Vec<Box<dyn Segment<Provider>>> {
44        self.inner
45    }
46}
47
48impl<Provider> SegmentSet<Provider>
49where
50    Provider: StaticFileProviderFactory<
51            Primitives: NodePrimitives<SignedTx: Value, Receipt: Value, BlockHeader: Value>,
52        > + DBProvider<Tx: DbTxMut>
53        + PruneCheckpointWriter
54        + BlockReader<Transaction: Encodable2718>,
55{
56    /// Creates a [`SegmentSet`] from an existing components, such as [`StaticFileProvider`] and
57    /// [`PruneModes`].
58    pub fn from_components(
59        static_file_provider: StaticFileProvider<Provider::Primitives>,
60        prune_modes: PruneModes,
61    ) -> Self {
62        let PruneModes {
63            sender_recovery,
64            transaction_lookup,
65            receipts,
66            account_history,
67            storage_history,
68            bodies_history: _,
69            receipts_log_filter,
70        } = prune_modes;
71
72        Self::default()
73            // Static file headers
74            .segment(StaticFileHeaders::new(static_file_provider.clone()))
75            // Static file transactions
76            .segment(StaticFileTransactions::new(static_file_provider.clone()))
77            // Static file receipts
78            .segment(StaticFileReceipts::new(static_file_provider))
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
