Skip to content

feat: implement builder pattern for CustomOpPayloadBuilder #516

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: develop
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
77 changes: 77 additions & 0 deletions crates/op-rbuilder/src/custom_payload_builder.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
use crate::tx_signer::Signer;
use url::Url;

#[derive(Debug, Clone, Default)]
#[non_exhaustive]
pub struct CustomOpPayloadBuilderBuilder {
pub builder_signer: Option<Signer>,
pub flashblocks_ws_url: Option<String>,
pub chain_block_time: Option<u64>,
pub flashblock_block_time: Option<u64>,
pub supervisor_url: Option<Url>,
pub supervisor_safety_level: Option<String>,
}

impl CustomOpPayloadBuilderBuilder {
pub fn new() -> Self {
Self::default()
}

pub fn builder_signer(mut self, signer: Option<Signer>) -> Self {
self.builder_signer = signer;
self
}

pub fn supervisor_url(mut self, url: Option<Url>) -> Self {
self.supervisor_url = url;
self
}

pub fn supervisor_safety_level(mut self, level: Option<String>) -> Self {
self.supervisor_safety_level = level;
self
}

pub fn flashblocks_ws_url(mut self, url: String) -> Self {
self.flashblocks_ws_url = Some(url);
self
}

pub fn chain_block_time(mut self, time: u64) -> Self {
self.chain_block_time = Some(time);
self
}

pub fn flashblock_block_time(mut self, time: u64) -> Self {
self.flashblock_block_time = Some(time);
self
}

pub fn build(self) -> CustomOpPayloadBuilder {
CustomOpPayloadBuilder {
builder_signer: self.builder_signer,
#[cfg(feature = "flashblocks")]
flashblocks_ws_url: self.flashblocks_ws_url.unwrap_or_default(),
#[cfg(feature = "flashblocks")]
chain_block_time: self.chain_block_time.unwrap_or_default(),
#[cfg(feature = "flashblocks")]
flashblock_block_time: self.flashblock_block_time.unwrap_or_default(),
supervisor_url: self.supervisor_url,
supervisor_safety_level: self.supervisor_safety_level,
}
}
}

#[derive(Debug, Clone, Default)]
#[non_exhaustive]
pub struct CustomOpPayloadBuilder {
pub builder_signer: Option<Signer>,
#[cfg(feature = "flashblocks")]
pub flashblocks_ws_url: String,
#[cfg(feature = "flashblocks")]
pub chain_block_time: u64,
#[cfg(feature = "flashblocks")]
pub flashblock_block_time: u64,
pub supervisor_url: Option<Url>,
pub supervisor_safety_level: Option<String>,
}
23 changes: 13 additions & 10 deletions crates/op-rbuilder/src/main.rs
Original file line number Diff line number Diff line change
@@ -1,18 +1,20 @@
use clap::Parser;
use custom_payload_builder::CustomOpPayloadBuilderBuilder;
use monitoring::Monitoring;
use reth::providers::CanonStateSubscriptions;
use reth_optimism_cli::{chainspec::OpChainSpecParser, Cli};
use reth_optimism_node::node::OpAddOnsBuilder;
use reth_optimism_node::OpNode;

#[cfg(not(feature = "flashblocks"))]
use custom_payload_builder::CustomOpPayloadBuilder;
#[cfg(feature = "flashblocks")]
use payload_builder::CustomOpPayloadBuilder;
#[cfg(not(feature = "flashblocks"))]
use payload_builder_vanilla::CustomOpPayloadBuilder;
use reth_transaction_pool::TransactionPool;

/// CLI argument parsing.
pub mod args;
pub mod custom_payload_builder;
pub mod generator;
#[cfg(test)]
mod integration;
Expand All @@ -37,14 +39,15 @@ fn main() {
let op_node = OpNode::new(rollup_args.clone());
let handle = builder
.with_types::<OpNode>()
.with_components(op_node.components().payload(CustomOpPayloadBuilder::new(
builder_args.builder_signer,
builder_args.flashblocks_ws_url,
builder_args.chain_block_time,
builder_args.flashblock_block_time,
builder_args.supervisor_url,
builder_args.supervisor_safety_level,
)))
.with_components(
op_node.components().payload(
CustomOpPayloadBuilderBuilder::new()
.builder_signer(builder_args.builder_signer)
.supervisor_url(builder_args.supervisor_url)
.supervisor_safety_level(builder_args.supervisor_safety_level)
.build(),
),
)
.with_add_ons(
OpAddOnsBuilder::default()
.with_sequencer(rollup_args.sequencer_http.clone())
Expand Down
35 changes: 1 addition & 34 deletions crates/op-rbuilder/src/payload_builder.rs
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,7 @@ use std::error::Error as StdError;
use tokio_util::sync::CancellationToken;
use tracing::{debug, trace, warn};

use crate::custom_payload_builder::CustomOpPayloadBuilder;
use futures_util::FutureExt;
use futures_util::SinkExt;
use tokio::net::{TcpListener, TcpStream};
Expand All @@ -86,40 +87,6 @@ struct FlashblocksMetadata<N: NodePrimitives> {
block_number: u64,
}

#[derive(Debug, Clone, Default)]
#[non_exhaustive]
pub struct CustomOpPayloadBuilder {
#[expect(dead_code)]
builder_signer: Option<Signer>,
flashblocks_ws_url: String,
chain_block_time: u64,
flashblock_block_time: u64,
#[expect(dead_code)]
supervisor_url: Option<Url>,
#[expect(dead_code)]
supervisor_safety_level: Option<String>,
}

impl CustomOpPayloadBuilder {
pub fn new(
builder_signer: Option<Signer>,
flashblocks_ws_url: String,
chain_block_time: u64,
flashblock_block_time: u64,
supervisor_url: Option<Url>,
supervisor_safety_level: Option<String>,
) -> Self {
Self {
builder_signer,
flashblocks_ws_url,
chain_block_time,
flashblock_block_time,
supervisor_url,
supervisor_safety_level,
}
}
}

impl<Node, Pool> PayloadServiceBuilder<Node, Pool> for CustomOpPayloadBuilder
where
Node: FullNodeTypes<
Expand Down
52 changes: 1 addition & 51 deletions crates/op-rbuilder/src/payload_builder_vanilla.rs
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
use crate::custom_payload_builder::CustomOpPayloadBuilder;
use crate::{
generator::{BlockCell, BlockPayloadJobGenerator, BuildArguments, PayloadBuilder},
metrics::OpRBuilderMetrics,
Expand Down Expand Up @@ -81,57 +82,6 @@ use tokio_util::sync::CancellationToken;
use tracing::{error, info, trace, warn};
use url::Url;

#[derive(Debug, Clone, Default)]
#[non_exhaustive]
pub struct CustomOpPayloadBuilder {
builder_signer: Option<Signer>,
#[cfg(feature = "flashblocks")]
flashblocks_ws_url: String,
#[cfg(feature = "flashblocks")]
chain_block_time: u64,
#[cfg(feature = "flashblocks")]
flashblock_block_time: u64,
supervisor_url: Option<Url>,
supervisor_safety_level: Option<String>,
}

impl CustomOpPayloadBuilder {
#[cfg(feature = "flashblocks")]
pub fn new(
builder_signer: Option<Signer>,
flashblocks_ws_url: String,
chain_block_time: u64,
flashblock_block_time: u64,
supervisor_url: Option<Url>,
supervisor_safety_level: Option<String>,
) -> Self {
Self {
builder_signer,
flashblocks_ws_url,
chain_block_time,
flashblock_block_time,
supervisor_url,
supervisor_safety_level,
}
}

#[cfg(not(feature = "flashblocks"))]
pub fn new(
builder_signer: Option<Signer>,
_flashblocks_ws_url: String,
_chain_block_time: u64,
_flashblock_block_time: u64,
supervisor_url: Option<Url>,
supervisor_safety_level: Option<String>,
) -> Self {
Self {
builder_signer,
supervisor_url,
supervisor_safety_level,
}
}
}

impl<Node, Pool> PayloadServiceBuilder<Node, Pool> for CustomOpPayloadBuilder
where
Node: FullNodeTypes<
Expand Down