From 607186de716b5c2985142b60a3f3e52d142f003e Mon Sep 17 00:00:00 2001
From: chirag-bgh <76247491+chirag-bgh@users.noreply.github.com>
Date: Wed, 26 Apr 2023 02:00:13 +0530
Subject: [PATCH] feat: add best_block_number call to BlockIdProvider (#2358)

---
 crates/rpc/rpc/src/eth/filter.rs                  |  2 +-
 crates/storage/provider/src/providers/database.rs | 12 ++++++++----
 crates/storage/provider/src/providers/mod.rs      |  4 ++++
 crates/storage/provider/src/test_utils/mock.rs    | 13 ++++++++++++-
 crates/storage/provider/src/test_utils/noop.rs    |  4 ++++
 crates/storage/provider/src/traits/block_id.rs    |  5 ++++-
 6 files changed, 33 insertions(+), 7 deletions(-)

diff --git a/crates/rpc/rpc/src/eth/filter.rs b/crates/rpc/rpc/src/eth/filter.rs
index 0c1f60f478..e3a52447d3 100644
--- a/crates/rpc/rpc/src/eth/filter.rs
+++ b/crates/rpc/rpc/src/eth/filter.rs
@@ -228,7 +228,7 @@ where
 
     /// Installs a new filter and returns the new identifier.
     async fn install_filter(&self, kind: FilterKind) -> RpcResult<FilterId> {
-        let last_poll_block_number = self.client.chain_info().to_rpc_result()?.best_number;
+        let last_poll_block_number = self.client.best_block_number().to_rpc_result()?;
         let id = FilterId::from(self.id_provider.next_id());
         let mut filters = self.active_filters.inner.lock().await;
         filters.insert(
diff --git a/crates/storage/provider/src/providers/database.rs b/crates/storage/provider/src/providers/database.rs
index 04ff715060..f7cdccda61 100644
--- a/crates/storage/provider/src/providers/database.rs
+++ b/crates/storage/provider/src/providers/database.rs
@@ -139,13 +139,17 @@ impl<DB: Database> BlockHashProvider for ShareableDatabase<DB> {
 
 impl<DB: Database> BlockIdProvider for ShareableDatabase<DB> {
     fn chain_info(&self) -> Result<ChainInfo> {
-        let best_number = self
+        let best_number = self.best_block_number()?;
+        let best_hash = self.block_hash(best_number)?.unwrap_or_default();
+        Ok(ChainInfo { best_hash, best_number, last_finalized: None, safe_finalized: None })
+    }
+
+    fn best_block_number(&self) -> Result<BlockNumber> {
+        Ok(self
             .db
             .view(|tx| tx.get::<tables::SyncStage>("Finish".to_string()))?
             .map_err(Into::<reth_interfaces::db::Error>::into)?
-            .unwrap_or_default();
-        let best_hash = self.block_hash(best_number)?.unwrap_or_default();
-        Ok(ChainInfo { best_hash, best_number, last_finalized: None, safe_finalized: None })
+            .unwrap_or_default())
     }
 
     fn block_number(&self, hash: H256) -> Result<Option<BlockNumber>> {
diff --git a/crates/storage/provider/src/providers/mod.rs b/crates/storage/provider/src/providers/mod.rs
index f619d81c6e..072238e6c5 100644
--- a/crates/storage/provider/src/providers/mod.rs
+++ b/crates/storage/provider/src/providers/mod.rs
@@ -99,6 +99,10 @@ where
         self.database.chain_info()
     }
 
+    fn best_block_number(&self) -> Result<BlockNumber> {
+        self.database.best_block_number()
+    }
+
     fn convert_block_number(&self, num: BlockNumberOrTag) -> Result<Option<BlockNumber>> {
         let num = match num {
             BlockNumberOrTag::Latest => self.chain_info()?.best_number,
diff --git a/crates/storage/provider/src/test_utils/mock.rs b/crates/storage/provider/src/test_utils/mock.rs
index 0fc632de68..9135271fbe 100644
--- a/crates/storage/provider/src/test_utils/mock.rs
+++ b/crates/storage/provider/src/test_utils/mock.rs
@@ -222,10 +222,12 @@ impl BlockHashProvider for MockEthProvider {
 
 impl BlockIdProvider for MockEthProvider {
     fn chain_info(&self) -> Result<ChainInfo> {
+        let best_block_number = self.best_block_number()?;
         let lock = self.headers.lock();
+
         Ok(lock
             .iter()
-            .max_by_key(|h| h.1.number)
+            .find(|(_, header)| header.number == best_block_number)
             .map(|(hash, header)| ChainInfo {
                 best_hash: *hash,
                 best_number: header.number,
@@ -235,6 +237,15 @@ impl BlockIdProvider for MockEthProvider {
             .expect("provider is empty"))
     }
 
+    fn best_block_number(&self) -> Result<BlockNumber> {
+        let lock = self.headers.lock();
+        Ok(lock
+            .iter()
+            .max_by_key(|h| h.1.number)
+            .map(|(_, header)| header.number)
+            .expect("provider is empty"))
+    }
+
     fn block_number(&self, hash: H256) -> Result<Option<reth_primitives::BlockNumber>> {
         let lock = self.blocks.lock();
         let num = lock.iter().find_map(|(h, b)| (*h == hash).then_some(b.number));
diff --git a/crates/storage/provider/src/test_utils/noop.rs b/crates/storage/provider/src/test_utils/noop.rs
index d243590330..2fb397847b 100644
--- a/crates/storage/provider/src/test_utils/noop.rs
+++ b/crates/storage/provider/src/test_utils/noop.rs
@@ -33,6 +33,10 @@ impl BlockIdProvider for NoopProvider {
         Ok(ChainInfo::default())
     }
 
+    fn best_block_number(&self) -> Result<BlockNumber> {
+        Ok(0)
+    }
+
     fn block_number(&self, _hash: H256) -> Result<Option<BlockNumber>> {
         Ok(None)
     }
diff --git a/crates/storage/provider/src/traits/block_id.rs b/crates/storage/provider/src/traits/block_id.rs
index 42a9fa89ad..7ee5c43989 100644
--- a/crates/storage/provider/src/traits/block_id.rs
+++ b/crates/storage/provider/src/traits/block_id.rs
@@ -1,6 +1,6 @@
 use super::BlockHashProvider;
 use reth_interfaces::Result;
-use reth_primitives::{BlockId, BlockNumberOrTag, ChainInfo, H256};
+use reth_primitives::{BlockId, BlockNumber, BlockNumberOrTag, ChainInfo, H256};
 
 /// Client trait for transforming [BlockId].
 #[auto_impl::auto_impl(&, Arc)]
@@ -8,6 +8,9 @@ pub trait BlockIdProvider: BlockHashProvider + Send + Sync {
     /// Returns the current info for the chain.
     fn chain_info(&self) -> Result<ChainInfo>;
 
+    /// Returns the best block number in the chain.
+    fn best_block_number(&self) -> Result<BlockNumber>;
+
     /// Converts the `BlockNumberOrTag` variants.
     fn convert_block_number(
         &self,