refactor: make submit task a config option

Author: prestwich

bin/builder.rs

@@ -1,10 +1,7 @@
 use builder::{
     config::BuilderConfig,
     service::serve_builder,
-    tasks::{
-        block::sim::Simulator, cache::CacheTasks, env::EnvTask, metrics::MetricsTask,
-        submit::BuilderHelperTask,
-    },
+    tasks::{block::sim::Simulator, cache::CacheTasks, env::EnvTask, metrics::MetricsTask},
 };
 use init4_bin_base::{
     deps::tracing::{info, info_span},
@@ -36,24 +33,16 @@ async fn main() -> eyre::Result<()> {
     let cache_system = cache_tasks.spawn();
 
     // Prep providers and contracts
-    let (host_provider, quincey) =
-        tokio::try_join!(config.connect_host_provider(), config.connect_quincey())?;
-    let zenith = config.connect_zenith(host_provider.clone());
+    let host_provider = config.connect_host_provider().await?;
 
     // Set up the metrics task
-    let metrics = MetricsTask { host_provider: host_provider.clone() };
+    let metrics = MetricsTask { host_provider };
     let (tx_channel, metrics_jh) = metrics.spawn();
 
-    // Make a Tx submission task
-    let submit = BuilderHelperTask {
-        zenith,
-        quincey,
-        config: config.clone(),
-        outbound_tx_channel: tx_channel,
-    };
-
-    // Set up tx submission
-    let (submit_channel, submit_jh) = submit.spawn();
+    // Set up the submit task. This will be either a Flashbots task or a
+    // BuilderHelper task depending on whether a Flashbots endpoint is
+    // configured.
+    let (submit_channel, submit_jh) = config.spawn_submit_task(tx_channel).await?;
 
     // Set up the simulator
     let sim = Simulator::new(&config, ru_provider.clone(), block_env);

src/config.rs

@@ -1,7 +1,13 @@
-use crate::{quincey::Quincey, tasks::block::cfg::SignetCfgEnv};
+use crate::{
+    quincey::Quincey,
+    tasks::{
+        block::{cfg::SignetCfgEnv, sim::SimResult},
+        submit::{BuilderHelperTask, FlashbotsTask},
+    },
+};
 use alloy::{
     network::{Ethereum, EthereumWallet},
-    primitives::Address,
+    primitives::{Address, TxHash},
     providers::{
         Identity, ProviderBuilder, RootProvider,
         fillers::{
@@ -24,7 +30,7 @@ use init4_bin_base::{
 use signet_constants::SignetSystemConstants;
 use signet_zenith::Zenith;
 use std::borrow::Cow;
-use tokio::join;
+use tokio::{join, sync::mpsc::UnboundedSender, task::JoinHandle};
 
 /// Type alias for the provider used to simulate against rollup state.
 pub type RuProvider = RootProvider<Ethereum>;
@@ -168,7 +174,13 @@ pub struct BuilderConfig {
 impl BuilderConfig {
     /// Connect to the Builder signer.
     pub async fn connect_builder_signer(&self) -> Result<LocalOrAws, SignerError> {
-        LocalOrAws::load(&self.builder_key, Some(self.host_chain_id)).await
+        static ONCE: tokio::sync::OnceCell<LocalOrAws> = tokio::sync::OnceCell::const_new();
+
+        ONCE.get_or_try_init(|| async {
+            LocalOrAws::load(&self.builder_key, Some(self.host_chain_id)).await
+        })
+        .await
+        .cloned()
     }
 
     /// Connect to the Sequencer signer.
@@ -282,4 +294,28 @@ impl BuilderConfig {
             .build(self.connect_builder_signer().await?)
             .ok_or_else(|| eyre::eyre!("Flashbots is not configured"))
     }
+
+    /// Spawn a submit task, either Flashbots or BuilderHelper depending on
+    /// configuration.
+    pub async fn spawn_submit_task(
+        &self,
+        tx_channel: UnboundedSender<TxHash>,
+    ) -> eyre::Result<(UnboundedSender<SimResult>, JoinHandle<()>)> {
+        // If we have a flashbots endpoint, use that
+        if self.flashbots.flashbots_endpoint.is_some() {
+            // Make a Flashbots submission task
+            let submit = FlashbotsTask::new(self.clone(), tx_channel).await?;
+
+            // Set up flashbots submission
+            let (submit_channel, submit_jh) = submit.spawn();
+            return Ok((submit_channel, submit_jh));
+        }
+
+        // Make a Tx submission task
+        let submit = BuilderHelperTask::new(self.clone(), tx_channel).await?;
+
+        // Set up tx submission
+        let (submit_channel, submit_jh) = submit.spawn();
+        Ok((submit_channel, submit_jh))
+    }
 }

src/tasks/submit/builder_helper.rs

@@ -73,16 +73,27 @@ pub enum ControlFlow {
 #[derive(Debug)]
 pub struct BuilderHelperTask {
     /// Zenith
-    pub zenith: ZenithInstance,
+    zenith: ZenithInstance,
     /// Quincey
-    pub quincey: Quincey,
+    quincey: Quincey,
     /// Config
-    pub config: crate::config::BuilderConfig,
+    config: crate::config::BuilderConfig,
     /// Channel over which to send pending transactions
-    pub outbound_tx_channel: mpsc::UnboundedSender<TxHash>,
+    outbound_tx_channel: mpsc::UnboundedSender<TxHash>,
 }
 
 impl BuilderHelperTask {
+    /// Returns a new `BuilderHelperTask`
+    pub async fn new(
+        config: crate::config::BuilderConfig,
+        outbound: mpsc::UnboundedSender<TxHash>,
+    ) -> eyre::Result<Self> {
+        let (quincey, host_provider) =
+            tokio::try_join!(config.connect_quincey(), config.connect_host_provider())?;
+        let zenith = config.connect_zenith(host_provider);
+        Ok(Self { zenith, quincey, config, outbound_tx_channel: outbound })
+    }
+
     /// Get the provider from the zenith instance
     const fn provider(&self) -> &HostProvider {
         self.zenith.provider()