rethresult & retherror

paradigmxyz · Sep 21, 2023 · f63dc8e · f63dc8e
1 parent 6199c49
commit f63dc8e
Show file tree

Hide file tree

Showing 5 changed files with 23 additions and 24 deletions.
diff --git a/crates/consensus/beacon/src/engine/hooks/mod.rs b/crates/consensus/beacon/src/engine/hooks/mod.rs
@@ -9,7 +9,7 @@ pub(crate) use controller::{EngineHooksController, PolledHook};
 
 mod prune;
 pub use prune::PruneHook;
-use reth_interfaces::RethError;
+use reth_interfaces::{RethError, RethResult};
 
 mod snapshot;
 pub use snapshot::SnapshotHook;
@@ -44,7 +44,7 @@ pub trait EngineHook: Send + Sync + 'static {
         &mut self,
         cx: &mut Context<'_>,
         ctx: EngineContext,
-    ) -> Poll<reth_interfaces::Result<(EngineHookEvent, Option<EngineHookAction>)>>;
+    ) -> Poll<RethResult<(EngineHookEvent, Option<EngineHookAction>)>>;
 
     /// Returns [db access level][`EngineHookDBAccessLevel`] the hook needs.
     fn db_access_level(&self) -> EngineHookDBAccessLevel;

diff --git a/crates/consensus/beacon/src/engine/hooks/prune.rs b/crates/consensus/beacon/src/engine/hooks/prune.rs
@@ -9,7 +9,7 @@ use crate::{
 use futures::FutureExt;
 use metrics::Counter;
 use reth_db::database::Database;
-use reth_interfaces::RethError;
+use reth_interfaces::{RethError, RethResult};
 use reth_primitives::BlockNumber;
 use reth_prune::{Pruner, PrunerError, PrunerWithResult};
 use reth_tasks::TaskSpawner;
@@ -43,7 +43,7 @@ impl<DB: Database + 'static> PruneHook<DB> {
     fn poll_pruner(
         &mut self,
         cx: &mut Context<'_>,
-    ) -> Poll<reth_interfaces::Result<(EngineHookEvent, Option<EngineHookAction>)>> {
+    ) -> Poll<RethResult<(EngineHookEvent, Option<EngineHookAction>)>> {
         let result = match self.pruner_state {
             PrunerState::Idle(_) => return Poll::Pending,
             PrunerState::Running(ref mut fut) => {
@@ -125,7 +125,7 @@ impl<DB: Database + 'static> EngineHook for PruneHook<DB> {
         &mut self,
         cx: &mut Context<'_>,
         ctx: EngineContext,
-    ) -> Poll<reth_interfaces::Result<(EngineHookEvent, Option<EngineHookAction>)>> {
+    ) -> Poll<RethResult<(EngineHookEvent, Option<EngineHookAction>)>> {
         // Try to spawn a pruner
         match self.try_spawn_pruner(ctx.tip_block_number) {
             Some((EngineHookEvent::NotReady, _)) => return Poll::Pending,

diff --git a/crates/consensus/beacon/src/engine/hooks/snapshot.rs b/crates/consensus/beacon/src/engine/hooks/snapshot.rs
@@ -8,6 +8,7 @@ use crate::{
 };
 use futures::FutureExt;
 use reth_db::database::Database;
+use reth_interfaces::{RethError, RethResult};
 use reth_primitives::BlockNumber;
 use reth_snapshot::{Snapshotter, SnapshotterError, SnapshotterWithResult};
 use reth_tasks::TaskSpawner;
@@ -36,7 +37,7 @@ impl<DB: Database + 'static> SnapshotHook<DB> {
     fn poll_snapshotter(
         &mut self,
         cx: &mut Context<'_>,
-    ) -> Poll<reth_interfaces::Result<(EngineHookEvent, Option<EngineHookAction>)>> {
+    ) -> Poll<RethResult<(EngineHookEvent, Option<EngineHookAction>)>> {
         let result = match self.state {
             SnapshotterState::Idle(_) => return Poll::Pending,
             SnapshotterState::Running(ref mut fut) => {
@@ -55,12 +56,8 @@ impl<DB: Database + 'static> SnapshotHook<DB> {
                             EngineHookError::Internal(Box::new(err))
                         }
                         SnapshotterError::Interface(err) => err.into(),
-                        SnapshotterError::Database(err) => {
-                            reth_interfaces::Error::Database(err).into()
-                        }
-                        SnapshotterError::Provider(err) => {
-                            reth_interfaces::Error::Provider(err).into()
-                        }
+                        SnapshotterError::Database(err) => RethError::Database(err).into(),
+                        SnapshotterError::Provider(err) => RethError::Provider(err).into(),
                     })),
                 }
             }
@@ -86,7 +83,7 @@ impl<DB: Database + 'static> SnapshotHook<DB> {
     fn try_spawn_snapshotter(
         &mut self,
         finalized_block_number: BlockNumber,
-    ) -> reth_interfaces::Result<Option<(EngineHookEvent, Option<EngineHookAction>)>> {
+    ) -> RethResult<Option<(EngineHookEvent, Option<EngineHookAction>)>> {
         Ok(match &mut self.state {
             SnapshotterState::Idle(snapshotter) => {
                 let Some(mut snapshotter) = snapshotter.take() else { return Ok(None) };
@@ -125,7 +122,7 @@ impl<DB: Database + 'static> EngineHook for SnapshotHook<DB> {
         &mut self,
         cx: &mut Context<'_>,
         ctx: EngineContext,
-    ) -> Poll<reth_interfaces::Result<(EngineHookEvent, Option<EngineHookAction>)>> {
+    ) -> Poll<RethResult<(EngineHookEvent, Option<EngineHookAction>)>> {
         let Some(finalized_block_number) = ctx.finalized_block_number else {
             return Poll::Ready(Ok((EngineHookEvent::NotReady, None)))
         };

diff --git a/crates/snapshot/src/error.rs b/crates/snapshot/src/error.rs
@@ -1,4 +1,5 @@
 use reth_db::DatabaseError;
+use reth_interfaces::RethError;
 use reth_provider::ProviderError;
 use thiserror::Error;
 
@@ -8,7 +9,7 @@ pub enum SnapshotterError {
     InconsistentData(&'static str),
 
     #[error("An interface error occurred.")]
-    Interface(#[from] reth_interfaces::Error),
+    Interface(#[from] RethError),
 
     #[error(transparent)]
     Database(#[from] DatabaseError),

diff --git a/crates/snapshot/src/snapshotter.rs b/crates/snapshot/src/snapshotter.rs
@@ -2,6 +2,7 @@
 
 use crate::SnapshotterError;
 use reth_db::database::Database;
+use reth_interfaces::{RethError, RethResult};
 use reth_primitives::{BlockNumber, ChainSpec, TxNumber};
 use reth_provider::{BlockReader, ProviderFactory};
 use std::{ops::RangeInclusive, sync::Arc};
@@ -96,7 +97,7 @@ impl<DB: Database> Snapshotter<DB> {
     pub fn get_snapshot_targets(
         &self,
         finalized_block_number: BlockNumber,
-    ) -> reth_interfaces::Result<SnapshotTargets> {
+    ) -> RethResult<SnapshotTargets> {
         let provider = self.provider_factory.provider()?;
 
         // Round down `finalized_block_number` to a multiple of `block_interval`
@@ -107,7 +108,7 @@ impl<DB: Database> Snapshotter<DB> {
 
         let to_tx_number = provider
             .block_body_indices(to_block_number)?
-            .ok_or(reth_interfaces::Error::Custom(
+            .ok_or(RethError::Custom(
                 "Block body indices for current block number not found".to_string(),
             ))?
             .last_tx_num();
@@ -128,7 +129,7 @@ impl<DB: Database> Snapshotter<DB> {
             if let Some(previous_block_number) = self.highest_snapshots.receipts {
                 provider
                     .block_body_indices(previous_block_number)?
-                    .ok_or(reth_interfaces::Error::Custom(
+                    .ok_or(RethError::Custom(
                         "Block body indices for previous block number not found".to_string(),
                     ))?
                     .next_tx_num()
@@ -143,7 +144,7 @@ impl<DB: Database> Snapshotter<DB> {
             } else if let Some(previous_block_number) = self.highest_snapshots.transactions {
                 provider
                     .block_body_indices(previous_block_number)?
-                    .ok_or(reth_interfaces::Error::Custom(
+                    .ok_or(RethError::Custom(
                         "Block body indices for previous block number not found".to_string(),
                     ))?
                     .next_tx_num()
@@ -179,7 +180,10 @@ impl<DB: Database> Snapshotter<DB> {
 mod tests {
     use crate::{snapshotter::SnapshotTargets, Snapshotter};
     use assert_matches::assert_matches;
-    use reth_interfaces::test_utils::{generators, generators::random_block_range};
+    use reth_interfaces::{
+        test_utils::{generators, generators::random_block_range},
+        RethError,
+    };
     use reth_primitives::{H256, MAINNET};
     use reth_stages::test_utils::TestTransaction;
 
@@ -194,10 +198,7 @@ mod tests {
         let mut snapshotter = Snapshotter::new(tx.inner_raw(), MAINNET.clone(), 2);
 
         // Block body indices not found
-        assert_matches!(
-            snapshotter.get_snapshot_targets(5),
-            Err(reth_interfaces::Error::Custom(_))
-        );
+        assert_matches!(snapshotter.get_snapshot_targets(5), Err(RethError::Custom(_)));
 
         // Snapshot targets has data per part up to the passed finalized block number
         let targets = snapshotter.get_snapshot_targets(1).expect("get snapshot targets");