feat: search for a snapshot that fulfills a queried BlockHash or TxHash

bin/reth/src/db/snapshots/headers.rs

@@ -10,7 +10,8 @@ use reth_primitives::{
     BlockHash, ChainSpec, Header, SnapshotSegment,
 };
 use reth_provider::{
-    providers::SnapshotProvider, DatabaseProviderRO, HeaderProvider, ProviderError, ProviderFactory,
+    providers::SnapshotProvider, DatabaseProviderRO, HeaderProvider, ProviderError,
+    ProviderFactory, TransactionsProviderExt,
 };
 use reth_snapshot::{segments, segments::Segment};
 use std::{
@@ -38,9 +39,15 @@ impl Command {
         segment.snapshot::<DB>(provider, PathBuf::default(), range.clone())?;
 
         // Default name doesn't have any configuration
+        let tx_range = provider.transaction_range_by_block_range(range.clone())?;
         reth_primitives::fs::rename(
-            SnapshotSegment::Headers.filename(&range),
-            SnapshotSegment::Headers.filename_with_configuration(filters, compression, &range),
+            SnapshotSegment::Headers.filename(&range, &tx_range),
+            SnapshotSegment::Headers.filename_with_configuration(
+                filters,
+                compression,
+                &range,
+                &tx_range,
+            ),
         )?;
 
         Ok(())
@@ -61,16 +68,24 @@ impl Command {
             Filters::WithoutFilters
         };
 
-        let range = self.block_range();
+        let block_range = self.block_range();
 
-        let mut row_indexes = range.clone().collect::<Vec<_>>();
+        let mut row_indexes = block_range.clone().collect::<Vec<_>>();
         let mut rng = rand::thread_rng();
-        let path = SnapshotSegment::Headers
-            .filename_with_configuration(filters, compression, &range)
+
+        let tx_range = ProviderFactory::new(open_db_read_only(db_path, log_level)?, chain.clone())
+            .provider()?
+            .transaction_range_by_block_range(block_range.clone())?;
+
+        let path: PathBuf = SnapshotSegment::Headers
+            .filename_with_configuration(filters, compression, &block_range, &tx_range)
             .into();
         let provider = SnapshotProvider::default();
-        let jar_provider =
-            provider.get_segment_provider(SnapshotSegment::Headers, self.from, Some(path))?;
+        let jar_provider = provider.get_segment_provider_from_block(
+            SnapshotSegment::Headers,
+            self.from,
+            Some(&path),
+        )?;
         let mut cursor = jar_provider.cursor()?;
 
         for bench_kind in [BenchKind::Walk, BenchKind::RandomAll] {

bin/reth/src/db/snapshots/receipts.rs

@@ -27,21 +27,26 @@ impl Command {
         inclusion_filter: InclusionFilter,
         phf: PerfectHashingFunction,
     ) -> eyre::Result<()> {
-        let range = self.block_range();
+        let block_range = self.block_range();
         let filters = if self.with_filters {
             Filters::WithFilters(inclusion_filter, phf)
         } else {
             Filters::WithoutFilters
         };
 
-        let segment = segments::Receipts::new(compression, filters);
-
-        segment.snapshot::<DB>(provider, PathBuf::default(), range.clone())?;
+        let segment: segments::Receipts = segments::Receipts::new(compression, filters);
+        segment.snapshot::<DB>(provider, PathBuf::default(), block_range.clone())?;
 
         // Default name doesn't have any configuration
+        let tx_range = provider.transaction_range_by_block_range(block_range.clone())?;
         reth_primitives::fs::rename(
-            SnapshotSegment::Receipts.filename(&range),
-            SnapshotSegment::Receipts.filename_with_configuration(filters, compression, &range),
+            SnapshotSegment::Receipts.filename(&block_range, &tx_range),
+            SnapshotSegment::Receipts.filename_with_configuration(
+                filters,
+                compression,
+                &block_range,
+                &tx_range,
+            ),
         )?;
 
         Ok(())
@@ -62,7 +67,7 @@ impl Command {
             Filters::WithoutFilters
         };
 
-        let block_range = self.from..=(self.from + self.block_interval - 1);
+        let block_range = self.block_range();
 
         let mut rng = rand::thread_rng();
 
@@ -72,13 +77,16 @@ impl Command {
 
         let mut row_indexes = tx_range.clone().collect::<Vec<_>>();
 
-        let path = SnapshotSegment::Receipts
-            .filename_with_configuration(filters, compression, &block_range)
+        let path: PathBuf = SnapshotSegment::Receipts
+            .filename_with_configuration(filters, compression, &block_range, &tx_range)
             .into();
 
         let provider = SnapshotProvider::default();
-        let jar_provider =
-            provider.get_segment_provider(SnapshotSegment::Receipts, self.from, Some(path))?;
+        let jar_provider = provider.get_segment_provider_from_block(
+            SnapshotSegment::Receipts,
+            self.from,
+            Some(&path),
+        )?;
         let mut cursor = jar_provider.cursor()?;
 
         for bench_kind in [BenchKind::Walk, BenchKind::RandomAll] {

bin/reth/src/db/snapshots/transactions.rs

@@ -27,7 +27,7 @@ impl Command {
         inclusion_filter: InclusionFilter,
         phf: PerfectHashingFunction,
     ) -> eyre::Result<()> {
-        let range = self.block_range();
+        let block_range = self.block_range();
         let filters = if self.with_filters {
             Filters::WithFilters(inclusion_filter, phf)
         } else {
@@ -36,12 +36,18 @@ impl Command {
 
         let segment = segments::Transactions::new(compression, filters);
 
-        segment.snapshot::<DB>(provider, PathBuf::default(), range.clone())?;
+        segment.snapshot::<DB>(provider, PathBuf::default(), block_range.clone())?;
 
         // Default name doesn't have any configuration
+        let tx_range = provider.transaction_range_by_block_range(block_range.clone())?;
         reth_primitives::fs::rename(
-            SnapshotSegment::Transactions.filename(&range),
-            SnapshotSegment::Transactions.filename_with_configuration(filters, compression, &range),
+            SnapshotSegment::Transactions.filename(&block_range, &tx_range),
+            SnapshotSegment::Transactions.filename_with_configuration(
+                filters,
+                compression,
+                &block_range,
+                &tx_range,
+            ),
         )?;
 
         Ok(())
@@ -62,7 +68,7 @@ impl Command {
             Filters::WithoutFilters
         };
 
-        let block_range = self.from..=(self.from + self.block_interval - 1);
+        let block_range = self.block_range();
 
         let mut rng = rand::thread_rng();
 
@@ -72,12 +78,15 @@ impl Command {
 
         let mut row_indexes = tx_range.clone().collect::<Vec<_>>();
 
-        let path = SnapshotSegment::Transactions
-            .filename_with_configuration(filters, compression, &block_range)
+        let path: PathBuf = SnapshotSegment::Transactions
+            .filename_with_configuration(filters, compression, &block_range, &tx_range)
             .into();
         let provider = SnapshotProvider::default();
-        let jar_provider =
-            provider.get_segment_provider(SnapshotSegment::Transactions, self.from, Some(path))?;
+        let jar_provider = provider.get_segment_provider_from_block(
+            SnapshotSegment::Transactions,
+            self.from,
+            Some(&path),
+        )?;
         let mut cursor = jar_provider.cursor()?;
 
         for bench_kind in [BenchKind::Walk, BenchKind::RandomAll] {

crates/consensus/common/src/validation.rs

@@ -489,8 +489,8 @@ mod tests {
     };
     use reth_primitives::{
         constants::eip4844::DATA_GAS_PER_BLOB, hex_literal::hex, proofs, Account, Address,
-        BlockBody, BlockHash, BlockHashOrNumber, Bytes, ChainSpecBuilder, ForkCondition, Header,
-        Signature, TransactionKind, TransactionSigned, Withdrawal, MAINNET, U256,
+        BlockBody, BlockHash, BlockHashOrNumber, Bytes, ChainSpecBuilder, Header, Signature,
+        TransactionKind, TransactionSigned, Withdrawal, MAINNET, U256,
     };
     use std::ops::RangeBounds;
 

crates/interfaces/src/provider.rs

@@ -1,6 +1,8 @@
 use reth_primitives::{
-    Address, BlockHash, BlockHashOrNumber, BlockNumber, GotExpected, TxHashOrNumber, TxNumber, B256,
+    Address, BlockHash, BlockHashOrNumber, BlockNumber, GotExpected, SnapshotSegment,
+    TxHashOrNumber, TxNumber, B256,
 };
+use std::path::PathBuf;
 use thiserror::Error;
 
 /// Bundled errors variants thrown by various providers.
@@ -94,6 +96,15 @@ pub enum ProviderError {
     /// Provider does not support this particular request.
     #[error("this provider does not support this request")]
     UnsupportedProvider,
+    /// Snapshot file is not found at specified path.
+    #[error("not able to find {0} snapshot file at {1}")]
+    MissingSnapshotPath(SnapshotSegment, PathBuf),
+    /// Snapshot file is not found for requested block.
+    #[error("not able to find {0} snapshot file for block number {1}")]
+    MissingSnapshotBlock(SnapshotSegment, BlockNumber),
+    /// Snapshot file is not found for requested transaction.
+    #[error("not able to find {0} snapshot file for transaction id {1}")]
+    MissingSnapshotTx(SnapshotSegment, TxNumber),
 }
 
 /// A root mismatch error at a given block height.

crates/primitives/src/snapshot/mod.rs

@@ -4,11 +4,14 @@ mod compression;
 mod filters;
 mod segment;
 
-use alloy_primitives::BlockNumber;
+use alloy_primitives::{BlockNumber, TxNumber};
 pub use compression::Compression;
 pub use filters::{Filters, InclusionFilter, PerfectHashingFunction};
 pub use segment::{SegmentConfig, SegmentHeader, SnapshotSegment};
 
+use crate::fs::FsPathError;
+use std::{ops::RangeInclusive, path::Path};
+
 /// Default snapshot block count.
 pub const BLOCKS_PER_SNAPSHOT: u64 = 500_000;
 
@@ -35,4 +38,30 @@ impl HighestSnapshots {
             SnapshotSegment::Receipts => self.receipts,
         }
     }
+
+    /// Returns a mutable reference to a snapshot segment
+    pub fn as_mut(&mut self, segment: SnapshotSegment) -> &mut Option<BlockNumber> {
+        match segment {
+            SnapshotSegment::Headers => &mut self.headers,
+            SnapshotSegment::Transactions => &mut self.transactions,
+            SnapshotSegment::Receipts => &mut self.receipts,
+        }
+    }
+}
+
+/// Given the snapshot's location, it returns an iterator over the existing snapshots in the format
+/// of a tuple composed by the segment, block range and transaction range.
+pub fn iter_snapshots(
+    path: impl AsRef<Path>,
+) -> Result<
+    impl Iterator<Item = (SnapshotSegment, RangeInclusive<BlockNumber>, RangeInclusive<TxNumber>)>,
+    FsPathError,
+> {
+    let entries = crate::fs::read_dir(path.as_ref())?.filter_map(Result::ok);
+    Ok(entries.filter_map(|entry| {
+        if entry.metadata().map_or(false, |metadata| metadata.is_file()) {
+            return SnapshotSegment::parse_filename(&entry.file_name())
+        }
+        None
+    }))
 }