feat: integrate builder (#6611)

examples/custom-payload-builder/Cargo.toml

@@ -5,17 +5,15 @@ publish = false
 edition.workspace = true
 license.workspace = true
 
-# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
-
 [dependencies]
 reth.workspace = true
 reth-primitives.workspace = true
 reth-node-api.workspace = true
 reth-basic-payload-builder.workspace = true
 reth-payload-builder.workspace = true
+reth-node-ethereum.workspace = true
+reth-ethereum-payload-builder.workspace = true
 
 tracing.workspace = true
-clap = { workspace = true, features = ["derive"] }
 futures-util.workspace = true
-eyre.workspace = true
-tokio.workspace = true
+eyre.workspace = true

examples/custom-payload-builder/src/main.rs

@@ -8,58 +8,40 @@
 //! ```
 //!
 //! This launch the regular reth node overriding the engine api payload builder with our custom.
-use clap::Parser;
+
+#![warn(unused_crate_dependencies)]
+
 use generator::EmptyBlockPayloadJobGenerator;
 use reth::{
-    cli::{
-        components::RethNodeComponents,
-        config::PayloadBuilderConfig,
-        ext::{NoArgsCliExt, RethNodeCommandConfig},
-        Cli,
-    },
+    builder::{components::PayloadServiceBuilder, node::FullNodeTypes, BuilderContext},
+    cli::{config::PayloadBuilderConfig, Cli},
     payload::PayloadBuilderHandle,
     providers::CanonStateSubscriptions,
-    tasks::TaskSpawner,
+    transaction_pool::TransactionPool,
 };
-use reth_basic_payload_builder::{BasicPayloadJobGeneratorConfig, PayloadBuilder};
-use reth_node_api::EngineTypes;
+use reth_basic_payload_builder::BasicPayloadJobGeneratorConfig;
+use reth_node_ethereum::{EthEngineTypes, EthereumNode};
 use reth_payload_builder::PayloadBuilderService;
 
 pub mod generator;
 pub mod job;
 
-fn main() {
-    Cli::<NoArgsCliExt<MyCustomBuilder>>::parse()
-        .with_node_extension(MyCustomBuilder::default())
-        .run()
-        .unwrap();
-}
-
-/// Our custom cli args extension that adds one flag to reth default CLI.
 #[derive(Debug, Clone, Copy, Default)]
 #[non_exhaustive]
-struct MyCustomBuilder;
+pub struct CustomPayloadBuilder;
 
-impl RethNodeCommandConfig for MyCustomBuilder {
-    fn spawn_payload_builder_service<Conf, Reth, Builder, Engine>(
-        &mut self,
-        conf: &Conf,
-        components: &Reth,
-        payload_builder: Builder,
-    ) -> eyre::Result<PayloadBuilderHandle<Engine>>
-    where
-        Conf: PayloadBuilderConfig,
-        Reth: RethNodeComponents,
-        Engine: EngineTypes + 'static,
-        Builder: PayloadBuilder<
-                Reth::Pool,
-                Reth::Provider,
-                Attributes = Engine::PayloadBuilderAttributes,
-                BuiltPayload = Engine::BuiltPayload,
-            > + Unpin
-            + 'static,
-    {
+impl<Node, Pool> PayloadServiceBuilder<Node, Pool> for CustomPayloadBuilder
+where
+    Node: FullNodeTypes<Engine = EthEngineTypes>,
+    Pool: TransactionPool + Unpin + 'static,
+{
+    async fn spawn_payload_service(
+        self,
+        ctx: &BuilderContext<Node>,
+        pool: Pool,
+    ) -> eyre::Result<PayloadBuilderHandle<Node::Engine>> {
         tracing::info!("Spawning a custom payload builder");
+        let conf = ctx.payload_builder_config();
 
         let payload_job_config = BasicPayloadJobGeneratorConfig::default()
             .interval(conf.interval())
@@ -69,23 +51,38 @@ impl RethNodeCommandConfig for MyCustomBuilder {
             .max_gas_limit(conf.max_gas_limit());
 
         let payload_generator = EmptyBlockPayloadJobGenerator::with_builder(
-            components.provider(),
-            components.pool(),
-            components.task_executor(),
+            ctx.provider().clone(),
+            pool,
+            ctx.task_executor().clone(),
             payload_job_config,
-            components.chain_spec().clone(),
-            payload_builder,
+            ctx.chain_spec().clone(),
+            reth_ethereum_payload_builder::EthereumPayloadBuilder::default(),
         );
 
-        let (payload_service, payload_builder) = PayloadBuilderService::new(
-            payload_generator,
-            components.events().canonical_state_stream(),
-        );
+        let (payload_service, payload_builder) =
+            PayloadBuilderService::new(payload_generator, ctx.provider().canonical_state_stream());
 
-        components
-            .task_executor()
+        ctx.task_executor()
             .spawn_critical("custom payload builder service", Box::pin(payload_service));
 
         Ok(payload_builder)
     }
 }
+
+fn main() {
+    Cli::parse_args()
+        .run(|builder, _| async move {
+            let handle = builder
+                .with_types(EthereumNode::default())
+                // Configure the components of the node
+                // use default ethereum components but use our custom payload builder
+                .with_components(
+                    EthereumNode::components().payload(CustomPayloadBuilder::default()),
+                )
+                .launch()
+                .await?;
+
+            handle.wait_for_node_exit().await
+        })
+        .unwrap();
+}