refactor: introduce a chill type alias

Author: prestwich

crates/db/src/aliases.rs

@@ -0,0 +1,5 @@
+use reth::providers::DatabaseProviderRW;
+use signet_node_types::SignetNodeTypes;
+
+/// A Convenience alias for a [`DatabaseProviderRW`] using [`SignetNodeTypes`].
+pub type SignetDbRw<Db> = DatabaseProviderRW<Db, SignetNodeTypes<Db>>;

crates/db/src/journal/mod.rs

@@ -3,38 +3,35 @@
 mod r#trait;
 pub use r#trait::JournalDb;
 
+use crate::SignetDbRw;
 use futures_util::{Stream, StreamExt};
-use reth::providers::{DatabaseProviderRW, ProviderResult};
-use signet_node_types::{NodeTypesDbTrait, SignetNodeTypes};
+use reth::providers::ProviderResult;
+use signet_node_types::NodeTypesDbTrait;
 use std::sync::Arc;
 use tokio::task::JoinHandle;
 use trevm::journal::BlockUpdate;
 
 /// A task that ingests journals into a reth database.
 #[derive(Debug)]
 pub struct JournalIngestor<Db: NodeTypesDbTrait> {
-    db: Arc<DatabaseProviderRW<Db, SignetNodeTypes<Db>>>,
+    db: Arc<SignetDbRw<Db>>,
 }
 
-impl<Db: NodeTypesDbTrait> From<DatabaseProviderRW<Db, SignetNodeTypes<Db>>>
-    for JournalIngestor<Db>
-{
-    fn from(value: DatabaseProviderRW<Db, SignetNodeTypes<Db>>) -> Self {
+impl<Db: NodeTypesDbTrait> From<SignetDbRw<Db>> for JournalIngestor<Db> {
+    fn from(value: SignetDbRw<Db>) -> Self {
         Self::new(value.into())
     }
 }
 
-impl<Db: NodeTypesDbTrait> From<Arc<DatabaseProviderRW<Db, SignetNodeTypes<Db>>>>
-    for JournalIngestor<Db>
-{
-    fn from(value: Arc<DatabaseProviderRW<Db, SignetNodeTypes<Db>>>) -> Self {
+impl<Db: NodeTypesDbTrait> From<Arc<SignetDbRw<Db>>> for JournalIngestor<Db> {
+    fn from(value: Arc<SignetDbRw<Db>>) -> Self {
         Self::new(value)
     }
 }
 
 impl<Db: NodeTypesDbTrait> JournalIngestor<Db> {
     /// Create a new `JournalIngestor` with the given database provider.
-    pub const fn new(db: Arc<DatabaseProviderRW<Db, SignetNodeTypes<Db>>>) -> Self {
+    pub const fn new(db: Arc<SignetDbRw<Db>>) -> Self {
         Self { db }
     }
 
@@ -71,10 +68,7 @@ impl<Db: NodeTypesDbTrait> JournalIngestor<Db> {
 }
 
 /// Ingest journals from a stream into a reth database.
-pub async fn ingest_journals<Db, S>(
-    db: Arc<DatabaseProviderRW<Db, SignetNodeTypes<Db>>>,
-    stream: S,
-) -> ProviderResult<()>
+pub async fn ingest_journals<Db, S>(db: Arc<SignetDbRw<Db>>, stream: S) -> ProviderResult<()>
 where
     Db: NodeTypesDbTrait,
     S: Stream<Item = (alloy::consensus::Header, BlockUpdate<'static>)> + Send + Unpin + 'static,

crates/db/src/lib.rs

@@ -11,6 +11,9 @@
 #![deny(unused_must_use, rust_2018_idioms)]
 #![cfg_attr(docsrs, feature(doc_cfg, doc_auto_cfg))]
 
+mod aliases;
+pub use aliases::SignetDbRw;
+
 mod chain;
 pub use chain::{DbExtractionResults, RuChain};
 

crates/db/src/provider.rs

@@ -1,5 +1,5 @@
 use crate::{
-    DataCompat, DbZenithHeader, RuChain, ZenithHeaders,
+    DataCompat, DbZenithHeader, RuChain, SignetDbRw, ZenithHeaders,
     tables::{DbSignetEvent, JournalHashes, SignetEvents},
     traits::RuWriter,
 };
@@ -11,9 +11,9 @@ use reth::{
     primitives::{Account, StaticFileSegment},
     providers::{
         AccountReader, BlockBodyIndicesProvider, BlockNumReader, BlockReader, BlockWriter, Chain,
-        DBProvider, DatabaseProviderRW, HistoryWriter, OriginalValuesKnown, ProviderError,
-        ProviderResult, StageCheckpointWriter, StateWriter, StaticFileProviderFactory,
-        StaticFileWriter, StorageLocation,
+        DBProvider, HistoryWriter, OriginalValuesKnown, ProviderError, ProviderResult,
+        StageCheckpointWriter, StateWriter, StaticFileProviderFactory, StaticFileWriter,
+        StorageLocation,
     },
 };
 use reth_db::{
@@ -25,7 +25,7 @@ use reth_db::{
 };
 use reth_prune_types::{MINIMUM_PRUNING_DISTANCE, PruneMode};
 use signet_evm::BlockResult;
-use signet_node_types::{NodeTypesDbTrait, SignetNodeTypes};
+use signet_node_types::NodeTypesDbTrait;
 use signet_types::primitives::RecoveredBlock;
 use signet_zenith::{
     Passage::{self, Enter, EnterToken},
@@ -35,7 +35,7 @@ use signet_zenith::{
 use std::ops::RangeInclusive;
 use tracing::{debug, instrument, trace, warn};
 
-impl<Db> RuWriter for DatabaseProviderRW<Db, SignetNodeTypes<Db>>
+impl<Db> RuWriter for SignetDbRw<Db>
 where
     Db: NodeTypesDbTrait,
 {

crates/db/src/traits.rs

@@ -1,13 +1,13 @@
-use crate::{DbExtractionResults, DbSignetEvent, RuChain};
+use crate::{DbExtractionResults, DbSignetEvent, RuChain, SignetDbRw};
 use alloy::primitives::{Address, B256, BlockNumber, U256};
 use itertools::Itertools;
 use reth::{
     primitives::Account,
-    providers::{DatabaseProviderRW, OriginalValuesKnown, ProviderResult, StorageLocation},
+    providers::{OriginalValuesKnown, ProviderResult, StorageLocation},
 };
 use reth_db::models::StoredBlockBodyIndices;
 use signet_evm::BlockResult;
-use signet_node_types::{NodeTypesDbTrait, SignetNodeTypes};
+use signet_node_types::NodeTypesDbTrait;
 use signet_types::primitives::RecoveredBlock;
 use signet_zenith::{Passage, Transactor, Zenith};
 use std::{collections::BTreeMap, ops::RangeInclusive};
@@ -293,7 +293,7 @@ pub trait RuWriter {
 }
 
 /// Extend the [`DatabaseProviderRW`] with a guarded commit function.
-pub trait DbProviderExt<Db>: Into<DatabaseProviderRW<Db, SignetNodeTypes<Db>>>
+pub trait DbProviderExt<Db>: Into<SignetDbRw<Db>>
 where
     Db: NodeTypesDbTrait,
 {
@@ -302,18 +302,18 @@ where
     /// transaction is rolled back.
     fn update(
         self,
-        f: impl FnOnce(&mut DatabaseProviderRW<Db, SignetNodeTypes<Db>>) -> ProviderResult<()>,
+        f: impl FnOnce(&mut SignetDbRw<Db>) -> ProviderResult<()>,
     ) -> ProviderResult<()>;
 }
 
 impl<T, Db> DbProviderExt<Db> for T
 where
     Db: NodeTypesDbTrait,
-    T: Into<DatabaseProviderRW<Db, SignetNodeTypes<Db>>>,
+    T: Into<SignetDbRw<Db>>,
 {
     fn update(
         self,
-        f: impl FnOnce(&mut DatabaseProviderRW<Db, SignetNodeTypes<Db>>) -> ProviderResult<()>,
+        f: impl FnOnce(&mut SignetDbRw<Db>) -> ProviderResult<()>,
     ) -> ProviderResult<()> {
         let mut this = self.into();
         f(&mut this)?;