fix: blockchain provider (#20)

Author: prestwich

crates/rpc/src/ctx/full.rs

@@ -4,7 +4,7 @@ use alloy::{
     eips::BlockId,
 };
 use reth::{
-    providers::{ProviderFactory, ProviderResult},
+    providers::{ProviderFactory, ProviderResult, providers::BlockchainProvider},
     rpc::server_types::eth::{EthApiError, EthConfig},
     tasks::{TaskExecutor, TaskSpawner},
 };
@@ -32,18 +32,30 @@ where
     Signet: Pnt,
 {
     /// Create a new `RpcCtx`.
+    ///
+    /// ## WARNING
+    ///
+    /// The [`BlockchainProvider`] passed in MUST be receiving updates from the
+    /// node wrt canonical chain changes. Some task MUST be calling relevant
+    /// [`CanonChainTracker`] methods on a clone of this [`BlockchainProvider`],
+    ///
+    /// If this is not correctly set up, [`BlockId`] resolution for `latest`,
+    /// `safe,` finalized, etc will not work correctly.
+    ///
+    /// [`CanonChainTracker`]: reth::providers::CanonChainTracker
     pub fn new<Tasks>(
         host: Host,
         constants: SignetSystemConstants,
         factory: ProviderFactory<Signet>,
+        provider: BlockchainProvider<Signet>,
         eth_config: EthConfig,
         tx_cache: Option<TxCache>,
         spawner: Tasks,
     ) -> ProviderResult<Self>
     where
         Tasks: TaskSpawner + Clone + 'static,
     {
-        RpcCtxInner::new(host, constants, factory, eth_config, tx_cache, spawner)
+        RpcCtxInner::new(host, constants, factory, provider, eth_config, tx_cache, spawner)
             .map(|inner| Self { inner: Arc::new(inner) })
     }
 }
@@ -87,18 +99,30 @@ where
     Signet: Pnt,
 {
     /// Create a new `RpcCtxInner`.
+    ///
+    /// ## WARNING
+    ///
+    /// The [`BlockchainProvider`] passed in MUST be receiving updates from the
+    /// node wrt canonical chain changes. Some task MUST be calling relevant
+    /// [`CanonChainTracker`] methods on a clone of this [`BlockchainProvider`],
+    ///
+    /// If this is not correctly set up, [`BlockId`] resolution for `latest`,
+    /// `safe,` finalized, etc will not work correctly.
+    ///
+    /// [`CanonChainTracker`]: reth::providers::CanonChainTracker
     pub fn new<Tasks>(
         host: Host,
         constants: SignetSystemConstants,
         factory: ProviderFactory<Signet>,
+        provider: BlockchainProvider<Signet>,
         eth_config: EthConfig,
         tx_cache: Option<TxCache>,
         spawner: Tasks,
     ) -> ProviderResult<Self>
     where
         Tasks: TaskSpawner + Clone + 'static,
     {
-        SignetCtx::new(constants, factory, eth_config, tx_cache, spawner)
+        SignetCtx::new(constants, factory, provider, eth_config, tx_cache, spawner)
             .map(|signet| Self { host, signet })
     }
 

crates/rpc/src/ctx/signet.rs

@@ -93,18 +93,28 @@ where
 {
     /// Instantiate a new `SignetCtx`, spawning necessary tasks to keep the
     /// relevant caches up to date.
+    ///
+    /// ## WARNING
+    ///
+    /// The [`BlockchainProvider`] passed in MUST be receiving updates from the
+    /// node wrt canonical chain changes. Some task MUST be calling relevant
+    /// [`CanonChainTracker`] methods on a clone of this [`BlockchainProvider`],
+    ///
+    /// If this is not correctly set up, [`BlockId`] resolution for `latest`,
+    /// `safe,` finalized, etc will not work correctly.
+    ///
+    /// [`CanonChainTracker`]: reth::providers::CanonChainTracker
     pub fn new<Tasks>(
         constants: SignetSystemConstants,
         factory: ProviderFactory<Inner>,
+        provider: BlockchainProvider<Inner>,
         eth_config: EthConfig,
         tx_cache: Option<TxCache>,
         spawner: Tasks,
     ) -> ProviderResult<Self>
     where
         Tasks: TaskSpawner + Clone + 'static,
     {
-        let provider = BlockchainProvider::new(factory.clone())?;
-
         let cache = EthStateCache::spawn_with(provider.clone(), eth_config.cache, spawner.clone());
         let gas_oracle =
             GasPriceOracle::new(provider.clone(), eth_config.gas_oracle, cache.clone());