feat: Added preconf forwarding and TaikoArgs; updated dependencies

johntaiko · johntaiko · commit 5acc32aa519a · 2024-12-26T17:08:16.000+08:00
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/crates/node/core/src/args/mod.rs b/crates/node/core/src/args/mod.rs
@@ -58,3 +58,6 @@ pub use benchmark_args::BenchmarkArgs;
 
 mod error;
 pub mod types;
+
+mod taiko;
+pub use taiko::TaikoArgs;
diff --git a/crates/node/core/src/args/rpc_server.rs b/crates/node/core/src/args/rpc_server.rs
@@ -21,6 +21,8 @@ use crate::args::{
     GasPriceOracleArgs, RpcStateCacheArgs,
 };
 
+use super::TaikoArgs;
+
 /// Default max number of subscriptions per connection.
 pub(crate) const RPC_DEFAULT_MAX_SUBS_PER_CONN: u32 = 1024;
 
@@ -197,6 +199,10 @@ pub struct RpcServerArgs {
     /// Gas price oracle configuration.
     #[command(flatten)]
     pub gas_price_oracle: GasPriceOracleArgs,
+
+    /// Taiko additional configuration.
+    #[command(flatten)]
+    pub taiko: TaikoArgs,
 }
 
 impl RpcServerArgs {
@@ -332,6 +338,7 @@ impl Default for RpcServerArgs {
             rpc_state_cache: RpcStateCacheArgs::default(),
             rpc_proof_permits: constants::DEFAULT_PROOF_PERMITS,
             builder_disallow: Default::default(),
+            taiko: TaikoArgs::default(),
         }
     }
 }
diff --git a/crates/node/core/src/args/taiko.rs b/crates/node/core/src/args/taiko.rs
@@ -0,0 +1,11 @@
+//! Taiko arguments
+
+use clap::Args;
+/// Parameters for debugging purposes
+#[derive(Debug, Default, Clone, Args, PartialEq, Eq)]
+#[command(next_help_heading = "Taiko")]
+pub struct TaikoArgs {
+    /// The URL of the preconf forwarding server
+    #[arg(long = "taiko.preconf-forwarding-server", default_value = None)]
+    pub preconf_forwarding_server: Option<String>,
+}
diff --git a/crates/rpc/rpc-builder/src/config.rs b/crates/rpc/rpc-builder/src/config.rs
@@ -103,6 +103,7 @@ impl RethRpcServerConfig for RpcServerArgs {
             .state_cache(self.state_cache_config())
             .gpo_config(self.gas_price_oracle_config())
             .proof_permits(self.rpc_proof_permits)
+            .preconf_forwarding_server(self.taiko.preconf_forwarding_server.clone())
     }
 
     fn flashbots_config(&self) -> ValidationApiConfig {
diff --git a/crates/rpc/rpc-builder/src/lib.rs b/crates/rpc/rpc-builder/src/lib.rs
@@ -1241,7 +1241,7 @@ pub struct RpcModuleConfigBuilder {
 
 impl RpcModuleConfigBuilder {
     /// Configures a custom eth namespace config
-    pub const fn eth(mut self, eth: EthConfig) -> Self {
+    pub fn eth(mut self, eth: EthConfig) -> Self {
         self.eth = Some(eth);
         self
     }
@@ -1371,7 +1371,7 @@ where
             pool.clone(),
             network.clone(),
             evm_config,
-            config.eth,
+            config.eth.clone(),
             executor.clone(),
             events.clone(),
             eth_api_builder,
diff --git a/crates/rpc/rpc-eth-types/src/builder/config.rs b/crates/rpc/rpc-eth-types/src/builder/config.rs
@@ -15,7 +15,7 @@ use serde::{Deserialize, Serialize};
 pub const DEFAULT_STALE_FILTER_TTL: Duration = Duration::from_secs(5 * 60);
 
 /// Additional config values for the eth namespace.
-#[derive(Debug, Clone, Copy, Eq, PartialEq, Serialize, Deserialize)]
+#[derive(Debug, Clone, Eq, PartialEq, Serialize, Deserialize)]
 pub struct EthConfig {
     /// Settings for the caching layer
     pub cache: EthStateCacheConfig,
@@ -42,6 +42,8 @@ pub struct EthConfig {
     pub fee_history_cache: FeeHistoryCacheConfig,
     /// The maximum number of getproof calls that can be executed concurrently.
     pub proof_permits: usize,
+    /// The preconf server url for forwarding
+    pub preconf_forwarding_server: Option<String>,
 }
 
 impl EthConfig {
@@ -68,6 +70,7 @@ impl Default for EthConfig {
             stale_filter_ttl: DEFAULT_STALE_FILTER_TTL,
             fee_history_cache: FeeHistoryCacheConfig::default(),
             proof_permits: DEFAULT_PROOF_PERMITS,
+            preconf_forwarding_server: None,
         }
     }
 }
@@ -126,6 +129,12 @@ impl EthConfig {
         self.proof_permits = permits;
         self
     }
+
+    /// Configures the preconf forwarding server
+    pub fn preconf_forwarding_server(mut self, server: Option<String>) -> Self {
+        self.preconf_forwarding_server = server;
+        self
+    }
 }
 
 /// Config for the filter
diff --git a/crates/rpc/rpc/Cargo.toml b/crates/rpc/rpc/Cargo.toml
@@ -61,6 +61,7 @@ alloy-rpc-types-txpool.workspace = true
 alloy-rpc-types-admin.workspace = true
 alloy-rpc-types-engine.workspace = true
 alloy-serde.workspace = true
+alloy-provider.workspace = true
 revm = { workspace = true, features = [
     "optional_block_gas_limit",
     "optional_eip3607",
@@ -92,6 +93,10 @@ rand.workspace = true
 serde.workspace = true
 thiserror.workspace = true
 derive_more.workspace = true
+# reqwest
+reqwest = { workspace = true, default-features = false, features = [
+    "rustls-tls-native-roots",
+] }
 
 [dev-dependencies]
 reth-evm-ethereum.workspace = true
diff --git a/crates/rpc/rpc/src/eth/core.rs b/crates/rpc/rpc/src/eth/core.rs
@@ -7,7 +7,9 @@ use alloy_consensus::BlockHeader;
 use alloy_eips::BlockNumberOrTag;
 use alloy_network::Ethereum;
 use alloy_primitives::U256;
+use alloy_provider::{ProviderBuilder, ReqwestProvider};
 use derive_more::Deref;
+use reqwest::Url;
 use reth_primitives::NodePrimitives;
 use reth_provider::{
     BlockReader, BlockReaderIdExt, CanonStateSubscriptions, ChainSpecProvider, L1OriginReader,
@@ -76,6 +78,7 @@ where
         fee_history_cache: FeeHistoryCache,
         evm_config: EvmConfig,
         proof_permits: usize,
+        preconf_forwarding_server: Option<String>,
     ) -> Self {
         let inner = EthApiInner::new(
             provider,
@@ -91,6 +94,7 @@ where
             evm_config,
             TokioTaskExecutor::default(),
             proof_permits,
+            preconf_forwarding_server,
         );
 
         Self { inner: Arc::new(inner), tx_resp_builder: EthTxBuilder }
@@ -134,6 +138,7 @@ where
             ctx.evm_config.clone(),
             ctx.executor.clone(),
             ctx.config.proof_permits,
+            ctx.config.preconf_forwarding_server.clone(),
         );
 
         Self { inner: Arc::new(inner), tx_resp_builder: EthTxBuilder }
@@ -270,6 +275,9 @@ pub struct EthApiInner<Provider: BlockReader, Pool, Network, EvmConfig> {
 
     /// Guard for getproof calls
     blocking_task_guard: BlockingTaskGuard,
+
+    /// The preconfigured forwarding server
+    preconf_forwarding_server: Option<ReqwestProvider>,
 }
 
 impl<Provider, Pool, Network, EvmConfig> EthApiInner<Provider, Pool, Network, EvmConfig>
@@ -292,6 +300,7 @@ where
         evm_config: EvmConfig,
         task_spawner: impl TaskSpawner + 'static,
         proof_permits: usize,
+        preconf_forwarding_server: Option<String>,
     ) -> Self {
         let signers = parking_lot::RwLock::new(Default::default());
         // get the block number of the latest block
@@ -321,6 +330,8 @@ where
             fee_history_cache,
             evm_config,
             blocking_task_guard: BlockingTaskGuard::new(proof_permits),
+            preconf_forwarding_server: preconf_forwarding_server
+                .map(|url| ProviderBuilder::default().on_http(Url::parse(&url).unwrap())),
         }
     }
 }
@@ -428,6 +439,12 @@ where
     pub const fn blocking_task_guard(&self) -> &BlockingTaskGuard {
         &self.blocking_task_guard
     }
+
+    /// Returns reference to [`BlockingTaskGuard`].
+    #[inline]
+    pub const fn preconf_forwarding_server(&self) -> Option<&ReqwestProvider> {
+        self.preconf_forwarding_server.as_ref()
+    }
 }
 
 #[cfg(test)]
@@ -491,6 +508,7 @@ mod tests {
             fee_history_cache,
             evm_config,
             DEFAULT_PROOF_PERMITS,
+            None,
         )
     }
 
diff --git a/crates/rpc/rpc/src/eth/helpers/state.rs b/crates/rpc/rpc/src/eth/helpers/state.rs
@@ -71,6 +71,7 @@ mod tests {
             FeeHistoryCache::new(FeeHistoryCacheConfig::default()),
             evm_config,
             DEFAULT_PROOF_PERMITS,
+            None,
         )
     }
 
@@ -97,6 +98,7 @@ mod tests {
             FeeHistoryCache::new(FeeHistoryCacheConfig::default()),
             evm_config,
             DEFAULT_PROOF_PERMITS,
+            None,
         )
     }
 
diff --git a/crates/rpc/rpc/src/eth/helpers/transaction.rs b/crates/rpc/rpc/src/eth/helpers/transaction.rs
@@ -1,11 +1,18 @@
 //! Contains RPC handler implementations specific to transactions
 
+use std::future::Future;
+
+use alloy_primitives::Bytes;
+use alloy_provider::Provider;
 use reth_provider::{BlockReader, BlockReaderIdExt, ProviderTx, TransactionsProvider};
 use reth_rpc_eth_api::{
     helpers::{EthSigner, EthTransactions, LoadTransaction, SpawnBlocking},
-    FullEthApiTypes, RpcNodeCoreExt,
+    EthApiTypes, FromEthApiError, FullEthApiTypes, RpcNodeCore, RpcNodeCoreExt,
 };
-use reth_transaction_pool::TransactionPool;
+use reth_rpc_eth_types::{utils::recover_raw_transaction, EthApiError};
+use reth_rpc_server_types::result::internal_rpc_err;
+use reth_transaction_pool::{PoolTransaction, TransactionOrigin, TransactionPool};
+use revm_primitives::B256;
 
 use crate::EthApi;
 
@@ -14,11 +21,48 @@ impl<Provider, Pool, Network, EvmConfig> EthTransactions
 where
     Self: LoadTransaction<Provider: BlockReaderIdExt>,
     Provider: BlockReader<Transaction = ProviderTx<Self::Provider>>,
+    <Self as RpcNodeCore>::Pool: TransactionPool,
 {
     #[inline]
     fn signers(&self) -> &parking_lot::RwLock<Vec<Box<dyn EthSigner<ProviderTx<Self::Provider>>>>> {
         self.inner.signers()
     }
+
+    #[inline]
+    #[allow(clippy::manual_async_fn)]
+    fn send_raw_transaction(
+        &self,
+        tx: Bytes,
+    ) -> impl Future<Output = Result<B256, Self::Error>> + Send {
+        async move {
+            // TODO: forwarding tx
+            if let Some(client) = self.preconf_forwarding_server() {
+                return client
+                    .send_raw_transaction(&tx)
+                    .await
+                    .map_err(|err| internal_rpc_err(err.to_string()))
+                    .map_err(EthApiError::other)
+                    .map_err(Into::into)?
+                    .watch()
+                    .await
+                    .map_err(|err| internal_rpc_err(err.to_string()))
+                    .map_err(EthApiError::other)
+                    .map_err(Into::into);
+            }
+            let recovered = recover_raw_transaction(&tx)?;
+            let pool_transaction =
+                <Self::Pool as TransactionPool>::Transaction::from_pooled(recovered);
+
+            // submit the transaction to the pool with a `Local` origin
+            let hash = self
+                .pool()
+                .add_transaction(TransactionOrigin::Local, pool_transaction)
+                .await
+                .map_err(<Self as EthApiTypes>::Error::from_eth_err)?;
+
+            Ok(hash)
+        }
+    }
 }
 
 impl<Provider, Pool, Network, EvmConfig> LoadTransaction
@@ -74,6 +118,7 @@ mod tests {
             fee_history_cache,
             evm_config,
             DEFAULT_PROOF_PERMITS,
+            None,
         );
 
         // https://etherscan.io/tx/0xa694b71e6c128a2ed8e2e0f6770bddbe52e3bb8f10e8472f9a79ab81497a8b5d

Original file line number	Diff line number	Diff line change
`@@ -21,6 +21,8 @@ use crate::args::{`
`21`	`21`	`GasPriceOracleArgs, RpcStateCacheArgs,`
`22`	`22`	`};`
`23`	`23`
	`24`	`+use super::TaikoArgs;`
	`25`	`+`
`24`	`26`	`/// Default max number of subscriptions per connection.`
`25`	`27`	`pub(crate) const RPC_DEFAULT_MAX_SUBS_PER_CONN: u32 = 1024;`
`26`	`28`
`@@ -197,6 +199,10 @@ pub struct RpcServerArgs {`
`197`	`199`	`/// Gas price oracle configuration.`
`198`	`200`	`#[command(flatten)]`
`199`	`201`	`pub gas_price_oracle: GasPriceOracleArgs,`
	`202`	`+`
	`203`	`+ /// Taiko additional configuration.`
	`204`	`+ #[command(flatten)]`
	`205`	`+ pub taiko: TaikoArgs,`
`200`	`206`	`}`
`201`	`207`
`202`	`208`	`impl RpcServerArgs {`
`@@ -332,6 +338,7 @@ impl Default for RpcServerArgs {`
`332`	`338`	`rpc_state_cache: RpcStateCacheArgs::default(),`
`333`	`339`	`rpc_proof_permits: constants::DEFAULT_PROOF_PERMITS,`
`334`	`340`	`builder_disallow: Default::default(),`
	`341`	`+ taiko: TaikoArgs::default(),`
`335`	`342`	`}`
`336`	`343`	`}`
`337`	`344`	`}`
Original file line number	Diff line number	Diff line change
`@@ -103,6 +103,7 @@ impl RethRpcServerConfig for RpcServerArgs {`
`103`	`103`	`.state_cache(self.state_cache_config())`
`104`	`104`	`.gpo_config(self.gas_price_oracle_config())`
`105`	`105`	`.proof_permits(self.rpc_proof_permits)`
	`106`	`+ .preconf_forwarding_server(self.taiko.preconf_forwarding_server.clone())`
`106`	`107`	`}`
`107`	`108`
`108`	`109`	`fn flashbots_config(&self) -> ValidationApiConfig {`
Original file line number	Diff line number	Diff line change
`@@ -15,7 +15,7 @@ use serde::{Deserialize, Serialize};`
`15`	`15`	`pub const DEFAULT_STALE_FILTER_TTL: Duration = Duration::from_secs(5 * 60);`
`16`	`16`
`17`	`17`	`/// Additional config values for the eth namespace.`
`18`		`-#[derive(Debug, Clone, Copy, Eq, PartialEq, Serialize, Deserialize)]`
	`18`	`+#[derive(Debug, Clone, Eq, PartialEq, Serialize, Deserialize)]`
`19`	`19`	`pub struct EthConfig {`
`20`	`20`	`/// Settings for the caching layer`
`21`	`21`	`pub cache: EthStateCacheConfig,`
`@@ -42,6 +42,8 @@ pub struct EthConfig {`
`42`	`42`	`pub fee_history_cache: FeeHistoryCacheConfig,`
`43`	`43`	`/// The maximum number of getproof calls that can be executed concurrently.`
`44`	`44`	`pub proof_permits: usize,`
	`45`	`+ /// The preconf server url for forwarding`
	`46`	`+ pub preconf_forwarding_server: Option<String>,`
`45`	`47`	`}`
`46`	`48`
`47`	`49`	`impl EthConfig {`
`@@ -68,6 +70,7 @@ impl Default for EthConfig {`
`68`	`70`	`stale_filter_ttl: DEFAULT_STALE_FILTER_TTL,`
`69`	`71`	`fee_history_cache: FeeHistoryCacheConfig::default(),`
`70`	`72`	`proof_permits: DEFAULT_PROOF_PERMITS,`
	`73`	`+ preconf_forwarding_server: None,`
`71`	`74`	`}`
`72`	`75`	`}`
`73`	`76`	`}`
`@@ -126,6 +129,12 @@ impl EthConfig {`
`126`	`129`	`self.proof_permits = permits;`
`127`	`130`	`self`
`128`	`131`	`}`
	`132`	`+`
	`133`	`+ /// Configures the preconf forwarding server`
	`134`	`+ pub fn preconf_forwarding_server(mut self, server: Option<String>) -> Self {`
	`135`	`+ self.preconf_forwarding_server = server;`
	`136`	`+ self`
	`137`	`+ }`
`129`	`138`	`}`
`130`	`139`
`131`	`140`	`/// Config for the filter`
Original file line number	Diff line number	Diff line change
`@@ -71,6 +71,7 @@ mod tests {`
`71`	`71`	`FeeHistoryCache::new(FeeHistoryCacheConfig::default()),`
`72`	`72`	`evm_config,`
`73`	`73`	`DEFAULT_PROOF_PERMITS,`
	`74`	`+ None,`
`74`	`75`	`)`
`75`	`76`	`}`
`76`	`77`
`@@ -97,6 +98,7 @@ mod tests {`
`97`	`98`	`FeeHistoryCache::new(FeeHistoryCacheConfig::default()),`
`98`	`99`	`evm_config,`
`99`	`100`	`DEFAULT_PROOF_PERMITS,`
	`101`	`+ None,`
`100`	`102`	`)`
`101`	`103`	`}`
`102`	`104`