use crate::{ providers::{state::latest::LatestStateProvider, StaticFileProvider}, to_range, traits::{BlockSource, ReceiptProvider}, BlockHashReader, BlockNumReader, BlockReader, ChainSpecProvider, DatabaseProviderFactory, EvmEnvProvider, HeaderProvider, HeaderSyncGap, HeaderSyncGapProvider, ProviderError, PruneCheckpointReader, RequestsProvider, StageCheckpointReader, StateProviderBox, StaticFileProviderFactory, TransactionVariant, TransactionsProvider, WithdrawalsProvider, }; use reth_chainspec::{ChainInfo, ChainSpec}; use reth_db::{init_db, mdbx::DatabaseArguments, DatabaseEnv}; use reth_db_api::{database::Database, models::StoredBlockBodyIndices}; use reth_errors::{RethError, RethResult}; use reth_evm::ConfigureEvmEnv; use reth_primitives::{ Address, Block, BlockHash, BlockHashOrNumber, BlockNumber, BlockWithSenders, Header, Receipt, SealedBlock, SealedBlockWithSenders, SealedHeader, StaticFileSegment, TransactionMeta, TransactionSigned, TransactionSignedNoHash, TxHash, TxNumber, Withdrawal, Withdrawals, B256, U256, }; use reth_prune_types::{PruneCheckpoint, PruneModes, PruneSegment}; use reth_stages_types::{StageCheckpoint, StageId}; use reth_storage_errors::provider::ProviderResult; use revm::primitives::{BlockEnv, CfgEnvWithHandlerCfg}; use std::{ ops::{RangeBounds, RangeInclusive}, path::Path, sync::Arc, }; use tokio::sync::watch; use tracing::trace; mod provider; pub use provider::{DatabaseProvider, DatabaseProviderRO, DatabaseProviderRW}; mod metrics; /// A common provider that fetches data from a database or static file. /// /// This provider implements most provider or provider factory traits. #[derive(Debug)] pub struct ProviderFactory { /// Database db: Arc, /// Chain spec chain_spec: Arc, /// Static File Provider static_file_provider: StaticFileProvider, /// Optional pruning configuration prune_modes: PruneModes, } impl ProviderFactory { /// Create new database provider factory. pub fn new( db: DB, chain_spec: Arc, static_file_provider: StaticFileProvider, ) -> Self { Self { db: Arc::new(db), chain_spec, static_file_provider, prune_modes: PruneModes::none() } } /// Enables metrics on the static file provider. pub fn with_static_files_metrics(mut self) -> Self { self.static_file_provider = self.static_file_provider.with_metrics(); self } /// Sets the pruning configuration for an existing [`ProviderFactory`]. pub fn with_prune_modes(mut self, prune_modes: PruneModes) -> Self { self.prune_modes = prune_modes; self } /// Returns reference to the underlying database. pub fn db_ref(&self) -> &DB { &self.db } #[cfg(any(test, feature = "test-utils"))] /// Consumes Self and returns DB pub fn into_db(self) -> Arc { self.db } } impl ProviderFactory { /// Create new database provider by passing a path. [`ProviderFactory`] will own the database /// instance. pub fn new_with_database_path>( path: P, chain_spec: Arc, args: DatabaseArguments, static_file_provider: StaticFileProvider, ) -> RethResult { Ok(Self { db: Arc::new(init_db(path, args).map_err(RethError::msg)?), chain_spec, static_file_provider, prune_modes: PruneModes::none(), }) } } impl ProviderFactory { /// Returns a provider with a created `DbTx` inside, which allows fetching data from the /// database using different types of providers. Example: [`HeaderProvider`] /// [`BlockHashReader`]. This may fail if the inner read database transaction fails to open. /// /// This sets the [`PruneModes`] to [`None`], because they should only be relevant for writing /// data. #[track_caller] pub fn provider(&self) -> ProviderResult> { Ok(DatabaseProvider::new( self.db.tx()?, self.chain_spec.clone(), self.static_file_provider.clone(), self.prune_modes.clone(), )) } /// Returns a provider with a created `DbTxMut` inside, which allows fetching and updating /// data from the database using different types of providers. Example: [`HeaderProvider`] /// [`BlockHashReader`]. This may fail if the inner read/write database transaction fails to /// open. #[track_caller] pub fn provider_rw(&self) -> ProviderResult> { Ok(DatabaseProviderRW(DatabaseProvider::new_rw( self.db.tx_mut()?, self.chain_spec.clone(), self.static_file_provider.clone(), self.prune_modes.clone(), ))) } /// State provider for latest block #[track_caller] pub fn latest(&self) -> ProviderResult { trace!(target: "providers::db", "Returning latest state provider"); Ok(Box::new(LatestStateProvider::new(self.db.tx()?, self.static_file_provider()))) } /// Storage provider for state at that given block pub fn history_by_block_number( &self, block_number: BlockNumber, ) -> ProviderResult { let state_provider = self.provider()?.state_provider_by_block_number(block_number)?; trace!(target: "providers::db", ?block_number, "Returning historical state provider for block number"); Ok(state_provider) } /// Storage provider for state at that given block hash pub fn history_by_block_hash(&self, block_hash: BlockHash) -> ProviderResult { let provider = self.provider()?; let block_number = provider .block_number(block_hash)? .ok_or(ProviderError::BlockHashNotFound(block_hash))?; let state_provider = self.provider()?.state_provider_by_block_number(block_number)?; trace!(target: "providers::db", ?block_number, %block_hash, "Returning historical state provider for block hash"); Ok(state_provider) } } impl DatabaseProviderFactory for ProviderFactory { fn database_provider_ro(&self) -> ProviderResult> { self.provider() } } impl StaticFileProviderFactory for ProviderFactory { /// Returns static file provider fn static_file_provider(&self) -> StaticFileProvider { self.static_file_provider.clone() } } impl HeaderSyncGapProvider for ProviderFactory { fn sync_gap( &self, tip: watch::Receiver, highest_uninterrupted_block: BlockNumber, ) -> ProviderResult { self.provider()?.sync_gap(tip, highest_uninterrupted_block) } } impl HeaderProvider for ProviderFactory { fn header(&self, block_hash: &BlockHash) -> ProviderResult> { self.provider()?.header(block_hash) } fn header_by_number(&self, num: BlockNumber) -> ProviderResult> { self.static_file_provider.get_with_static_file_or_database( StaticFileSegment::Headers, num, |static_file| static_file.header_by_number(num), || self.provider()?.header_by_number(num), ) } fn header_td(&self, hash: &BlockHash) -> ProviderResult> { self.provider()?.header_td(hash) } fn header_td_by_number(&self, number: BlockNumber) -> ProviderResult> { if let Some(td) = self.chain_spec.final_paris_total_difficulty(number) { // if this block is higher than the final paris(merge) block, return the final paris // difficulty return Ok(Some(td)) } self.static_file_provider.get_with_static_file_or_database( StaticFileSegment::Headers, number, |static_file| static_file.header_td_by_number(number), || self.provider()?.header_td_by_number(number), ) } fn headers_range(&self, range: impl RangeBounds) -> ProviderResult> { self.static_file_provider.get_range_with_static_file_or_database( StaticFileSegment::Headers, to_range(range), |static_file, range, _| static_file.headers_range(range), |range, _| self.provider()?.headers_range(range), |_| true, ) } fn sealed_header(&self, number: BlockNumber) -> ProviderResult> { self.static_file_provider.get_with_static_file_or_database( StaticFileSegment::Headers, number, |static_file| static_file.sealed_header(number), || self.provider()?.sealed_header(number), ) } fn sealed_headers_range( &self, range: impl RangeBounds, ) -> ProviderResult> { self.sealed_headers_while(range, |_| true) } fn sealed_headers_while( &self, range: impl RangeBounds, predicate: impl FnMut(&SealedHeader) -> bool, ) -> ProviderResult> { self.static_file_provider.get_range_with_static_file_or_database( StaticFileSegment::Headers, to_range(range), |static_file, range, predicate| static_file.sealed_headers_while(range, predicate), |range, predicate| self.provider()?.sealed_headers_while(range, predicate), predicate, ) } } impl BlockHashReader for ProviderFactory { fn block_hash(&self, number: u64) -> ProviderResult> { self.static_file_provider.get_with_static_file_or_database( StaticFileSegment::Headers, number, |static_file| static_file.block_hash(number), || self.provider()?.block_hash(number), ) } fn canonical_hashes_range( &self, start: BlockNumber, end: BlockNumber, ) -> ProviderResult> { self.static_file_provider.get_range_with_static_file_or_database( StaticFileSegment::Headers, start..end, |static_file, range, _| static_file.canonical_hashes_range(range.start, range.end), |range, _| self.provider()?.canonical_hashes_range(range.start, range.end), |_| true, ) } } impl BlockNumReader for ProviderFactory { fn chain_info(&self) -> ProviderResult { self.provider()?.chain_info() } fn best_block_number(&self) -> ProviderResult { self.provider()?.best_block_number() } fn last_block_number(&self) -> ProviderResult { self.provider()?.last_block_number() } fn block_number(&self, hash: B256) -> ProviderResult> { self.provider()?.block_number(hash) } } impl BlockReader for ProviderFactory { fn find_block_by_hash(&self, hash: B256, source: BlockSource) -> ProviderResult> { self.provider()?.find_block_by_hash(hash, source) } fn block(&self, id: BlockHashOrNumber) -> ProviderResult> { self.provider()?.block(id) } fn pending_block(&self) -> ProviderResult> { self.provider()?.pending_block() } fn pending_block_with_senders(&self) -> ProviderResult> { self.provider()?.pending_block_with_senders() } fn pending_block_and_receipts(&self) -> ProviderResult)>> { self.provider()?.pending_block_and_receipts() } fn ommers(&self, id: BlockHashOrNumber) -> ProviderResult>> { self.provider()?.ommers(id) } fn block_body_indices( &self, number: BlockNumber, ) -> ProviderResult> { self.provider()?.block_body_indices(number) } fn block_with_senders( &self, id: BlockHashOrNumber, transaction_kind: TransactionVariant, ) -> ProviderResult> { self.provider()?.block_with_senders(id, transaction_kind) } fn sealed_block_with_senders( &self, id: BlockHashOrNumber, transaction_kind: TransactionVariant, ) -> ProviderResult> { self.provider()?.sealed_block_with_senders(id, transaction_kind) } fn block_range(&self, range: RangeInclusive) -> ProviderResult> { self.provider()?.block_range(range) } fn block_with_senders_range( &self, range: RangeInclusive, ) -> ProviderResult> { self.provider()?.block_with_senders_range(range) } fn sealed_block_with_senders_range( &self, range: RangeInclusive, ) -> ProviderResult> { self.provider()?.sealed_block_with_senders_range(range) } } impl TransactionsProvider for ProviderFactory { fn transaction_id(&self, tx_hash: TxHash) -> ProviderResult> { self.provider()?.transaction_id(tx_hash) } fn transaction_by_id(&self, id: TxNumber) -> ProviderResult> { self.static_file_provider.get_with_static_file_or_database( StaticFileSegment::Transactions, id, |static_file| static_file.transaction_by_id(id), || self.provider()?.transaction_by_id(id), ) } fn transaction_by_id_no_hash( &self, id: TxNumber, ) -> ProviderResult> { self.static_file_provider.get_with_static_file_or_database( StaticFileSegment::Transactions, id, |static_file| static_file.transaction_by_id_no_hash(id), || self.provider()?.transaction_by_id_no_hash(id), ) } fn transaction_by_hash(&self, hash: TxHash) -> ProviderResult> { self.provider()?.transaction_by_hash(hash) } fn transaction_by_hash_with_meta( &self, tx_hash: TxHash, ) -> ProviderResult> { self.provider()?.transaction_by_hash_with_meta(tx_hash) } fn transaction_block(&self, id: TxNumber) -> ProviderResult> { self.provider()?.transaction_block(id) } fn transactions_by_block( &self, id: BlockHashOrNumber, ) -> ProviderResult>> { self.provider()?.transactions_by_block(id) } fn transactions_by_block_range( &self, range: impl RangeBounds, ) -> ProviderResult>> { self.provider()?.transactions_by_block_range(range) } fn transactions_by_tx_range( &self, range: impl RangeBounds, ) -> ProviderResult> { self.provider()?.transactions_by_tx_range(range) } fn senders_by_tx_range( &self, range: impl RangeBounds, ) -> ProviderResult> { self.provider()?.senders_by_tx_range(range) } fn transaction_sender(&self, id: TxNumber) -> ProviderResult> { self.provider()?.transaction_sender(id) } } impl ReceiptProvider for ProviderFactory { fn receipt(&self, id: TxNumber) -> ProviderResult> { self.static_file_provider.get_with_static_file_or_database( StaticFileSegment::Receipts, id, |static_file| static_file.receipt(id), || self.provider()?.receipt(id), ) } fn receipt_by_hash(&self, hash: TxHash) -> ProviderResult> { self.provider()?.receipt_by_hash(hash) } fn receipts_by_block(&self, block: BlockHashOrNumber) -> ProviderResult>> { self.provider()?.receipts_by_block(block) } fn receipts_by_tx_range( &self, range: impl RangeBounds, ) -> ProviderResult> { self.static_file_provider.get_range_with_static_file_or_database( StaticFileSegment::Receipts, to_range(range), |static_file, range, _| static_file.receipts_by_tx_range(range), |range, _| self.provider()?.receipts_by_tx_range(range), |_| true, ) } } impl WithdrawalsProvider for ProviderFactory { fn withdrawals_by_block( &self, id: BlockHashOrNumber, timestamp: u64, ) -> ProviderResult> { self.provider()?.withdrawals_by_block(id, timestamp) } fn latest_withdrawal(&self) -> ProviderResult> { self.provider()?.latest_withdrawal() } } impl RequestsProvider for ProviderFactory where DB: Database, { fn requests_by_block( &self, id: BlockHashOrNumber, timestamp: u64, ) -> ProviderResult> { self.provider()?.requests_by_block(id, timestamp) } } impl StageCheckpointReader for ProviderFactory { fn get_stage_checkpoint(&self, id: StageId) -> ProviderResult> { self.provider()?.get_stage_checkpoint(id) } fn get_stage_checkpoint_progress(&self, id: StageId) -> ProviderResult>> { self.provider()?.get_stage_checkpoint_progress(id) } fn get_all_checkpoints(&self) -> ProviderResult> { self.provider()?.get_all_checkpoints() } } impl EvmEnvProvider for ProviderFactory { fn fill_env_at( &self, cfg: &mut CfgEnvWithHandlerCfg, block_env: &mut BlockEnv, at: BlockHashOrNumber, evm_config: EvmConfig, ) -> ProviderResult<()> where EvmConfig: ConfigureEvmEnv, { self.provider()?.fill_env_at(cfg, block_env, at, evm_config) } fn fill_env_with_header( &self, cfg: &mut CfgEnvWithHandlerCfg, block_env: &mut BlockEnv, header: &Header, evm_config: EvmConfig, ) -> ProviderResult<()> where EvmConfig: ConfigureEvmEnv, { self.provider()?.fill_env_with_header(cfg, block_env, header, evm_config) } fn fill_cfg_env_at( &self, cfg: &mut CfgEnvWithHandlerCfg, at: BlockHashOrNumber, evm_config: EvmConfig, ) -> ProviderResult<()> where EvmConfig: ConfigureEvmEnv, { self.provider()?.fill_cfg_env_at(cfg, at, evm_config) } fn fill_cfg_env_with_header( &self, cfg: &mut CfgEnvWithHandlerCfg, header: &Header, evm_config: EvmConfig, ) -> ProviderResult<()> where EvmConfig: ConfigureEvmEnv, { self.provider()?.fill_cfg_env_with_header(cfg, header, evm_config) } } impl ChainSpecProvider for ProviderFactory where DB: Send + Sync, { fn chain_spec(&self) -> Arc { self.chain_spec.clone() } } impl PruneCheckpointReader for ProviderFactory { fn get_prune_checkpoint( &self, segment: PruneSegment, ) -> ProviderResult> { self.provider()?.get_prune_checkpoint(segment) } fn get_prune_checkpoints(&self) -> ProviderResult> { self.provider()?.get_prune_checkpoints() } } impl Clone for ProviderFactory { fn clone(&self) -> Self { Self { db: Arc::clone(&self.db), chain_spec: self.chain_spec.clone(), static_file_provider: self.static_file_provider.clone(), prune_modes: self.prune_modes.clone(), } } } #[cfg(test)] mod tests { use super::*; use crate::{ providers::{StaticFileProvider, StaticFileWriter}, test_utils::{blocks::TEST_BLOCK, create_test_provider_factory}, BlockHashReader, BlockNumReader, BlockWriter, HeaderSyncGapProvider, TransactionsProvider, }; use assert_matches::assert_matches; use rand::Rng; use reth_chainspec::ChainSpecBuilder; use reth_db::{ mdbx::DatabaseArguments, tables, test_utils::{create_test_static_files_dir, ERROR_TEMPDIR}, }; use reth_primitives::{StaticFileSegment, TxNumber, B256, U256}; use reth_prune_types::{PruneMode, PruneModes}; use reth_storage_errors::provider::ProviderError; use reth_testing_utils::{ generators, generators::{random_block, random_header}, }; use std::{ops::RangeInclusive, sync::Arc}; use tokio::sync::watch; #[test] fn common_history_provider() { let factory = create_test_provider_factory(); let _ = factory.latest(); } #[test] fn default_chain_info() { let factory = create_test_provider_factory(); let provider = factory.provider().unwrap(); let chain_info = provider.chain_info().expect("should be ok"); assert_eq!(chain_info.best_number, 0); assert_eq!(chain_info.best_hash, B256::ZERO); } #[test] fn provider_flow() { let factory = create_test_provider_factory(); let provider = factory.provider().unwrap(); provider.block_hash(0).unwrap(); let provider_rw = factory.provider_rw().unwrap(); provider_rw.block_hash(0).unwrap(); provider.block_hash(0).unwrap(); } #[test] fn provider_factory_with_database_path() { let chain_spec = ChainSpecBuilder::mainnet().build(); let (_static_dir, static_dir_path) = create_test_static_files_dir(); let factory = ProviderFactory::new_with_database_path( tempfile::TempDir::new().expect(ERROR_TEMPDIR).into_path(), Arc::new(chain_spec), DatabaseArguments::new(Default::default()), StaticFileProvider::read_write(static_dir_path).unwrap(), ) .unwrap(); let provider = factory.provider().unwrap(); provider.block_hash(0).unwrap(); let provider_rw = factory.provider_rw().unwrap(); provider_rw.block_hash(0).unwrap(); provider.block_hash(0).unwrap(); } #[test] fn insert_block_with_prune_modes() { let factory = create_test_provider_factory(); let block = TEST_BLOCK.clone(); { let provider = factory.provider_rw().unwrap(); assert_matches!( provider.insert_block(block.clone().try_seal_with_senders().unwrap()), Ok(_) ); assert_matches!( provider.transaction_sender(0), Ok(Some(sender)) if sender == block.body[0].recover_signer().unwrap() ); assert_matches!(provider.transaction_id(block.body[0].hash), Ok(Some(0))); } { let prune_modes = PruneModes { sender_recovery: Some(PruneMode::Full), transaction_lookup: Some(PruneMode::Full), ..PruneModes::none() }; let provider = factory.with_prune_modes(prune_modes).provider_rw().unwrap(); assert_matches!( provider.insert_block(block.clone().try_seal_with_senders().unwrap(),), Ok(_) ); assert_matches!(provider.transaction_sender(0), Ok(None)); assert_matches!(provider.transaction_id(block.body[0].hash), Ok(None)); } } #[test] fn take_block_transaction_range_recover_senders() { let factory = create_test_provider_factory(); let mut rng = generators::rng(); let block = random_block(&mut rng, 0, None, Some(3), None); let tx_ranges: Vec> = vec![0..=0, 1..=1, 2..=2, 0..=1, 1..=2]; for range in tx_ranges { let provider = factory.provider_rw().unwrap(); assert_matches!( provider.insert_block(block.clone().try_seal_with_senders().unwrap()), Ok(_) ); let senders = provider.take::(range.clone()); assert_eq!( senders, Ok(range .clone() .map(|tx_number| ( tx_number, block.body[tx_number as usize].recover_signer().unwrap() )) .collect()) ); let db_senders = provider.senders_by_tx_range(range); assert_eq!(db_senders, Ok(vec![])); let result = provider.take_block_transaction_range(0..=0); assert_eq!( result, Ok(vec![( 0, block.body.iter().cloned().map(|tx| tx.into_ecrecovered().unwrap()).collect() )]) ) } } #[test] fn header_sync_gap_lookup() { let factory = create_test_provider_factory(); let provider = factory.provider_rw().unwrap(); let mut rng = generators::rng(); let consensus_tip = rng.gen(); let (_tip_tx, tip_rx) = watch::channel(consensus_tip); // Genesis let checkpoint = 0; let head = random_header(&mut rng, 0, None); // Empty database assert_matches!( provider.sync_gap(tip_rx.clone(), checkpoint), Err(ProviderError::HeaderNotFound(block_number)) if block_number.as_number().unwrap() == checkpoint ); // Checkpoint and no gap let mut static_file_writer = provider.static_file_provider().latest_writer(StaticFileSegment::Headers).unwrap(); static_file_writer.append_header(head.header(), U256::ZERO, &head.hash()).unwrap(); static_file_writer.commit().unwrap(); drop(static_file_writer); let gap = provider.sync_gap(tip_rx, checkpoint).unwrap(); assert_eq!(gap.local_head, head); assert_eq!(gap.target.tip(), consensus_tip.into()); } }