feat: optional adjustment data for optimistic v3 (#787)

## 📝 Summary

Optional bid adjustment data for optimistic v3.

## ✅ I have completed the following steps:

* [x] Run `make lint`
* [x] Run `make test`
* [ ] Added tests (if applicable)

Author: efbig

crates/rbuilder-primitives/src/mev_boost/submit_header.rs

@@ -64,16 +64,7 @@ pub enum HeaderSubmission {
 }
 
 /// Electra header submission.
-#[derive(
-    PartialEq,
-    Eq,
-    Clone,
-    Debug,
-    serde::Serialize,
-    serde::Deserialize,
-    ssz_derive::Encode,
-    ssz_derive::Decode,
-)]
+#[derive(PartialEq, Eq, Clone, Debug, serde::Serialize, serde::Deserialize)]
 pub struct HeaderSubmissionElectra {
     /// Bid trace.
     pub bid_trace: BidTrace,
@@ -84,7 +75,104 @@ pub struct HeaderSubmissionElectra {
     /// Blob KZG commitments.
     pub commitments: Vec<alloy_consensus::Bytes48>,
     /// Bid adjustment data V2.
-    pub adjustment_data: BidAdjustmentDataV2,
+    pub adjustment_data: Option<BidAdjustmentDataV2>,
+}
+
+impl ssz::Encode for HeaderSubmissionElectra {
+    fn is_ssz_fixed_len() -> bool {
+        false
+    }
+
+    fn ssz_append(&self, buf: &mut Vec<u8>) {
+        let mut offset = <BidTrace as ssz::Encode>::ssz_fixed_len()
+            + <ExecutionPayloadHeaderElectra as ssz::Encode>::ssz_fixed_len()
+            + <ExecutionRequestsV4 as ssz::Encode>::ssz_fixed_len()
+            + <Vec<alloy_consensus::Bytes48> as ssz::Encode>::ssz_fixed_len();
+        if self.adjustment_data.is_some() {
+            offset += <BidAdjustmentDataV2 as ssz::Encode>::ssz_fixed_len();
+        }
+
+        let mut encoder = ssz::SszEncoder::container(buf, offset);
+
+        encoder.append(&self.bid_trace);
+        encoder.append(&self.execution_payload_header);
+        encoder.append(&self.execution_requests);
+        encoder.append(&self.commitments);
+        if let Some(adjustment) = &self.adjustment_data {
+            encoder.append(&adjustment);
+        }
+
+        encoder.finalize();
+    }
+
+    fn ssz_bytes_len(&self) -> usize {
+        let mut len = <BidTrace as ssz::Encode>::ssz_bytes_len(&self.bid_trace)
+            + <ExecutionPayloadHeaderElectra as ssz::Encode>::ssz_bytes_len(
+                &self.execution_payload_header,
+            )
+            + <ExecutionRequestsV4 as ssz::Encode>::ssz_bytes_len(&self.execution_requests)
+            + <Vec<alloy_consensus::Bytes48> as ssz::Encode>::ssz_bytes_len(&self.commitments);
+        if let Some(adjustment) = &self.adjustment_data {
+            len += <BidAdjustmentDataV2 as ssz::Encode>::ssz_bytes_len(adjustment);
+        }
+        len
+    }
+}
+
+impl ssz::Decode for HeaderSubmissionElectra {
+    fn is_ssz_fixed_len() -> bool {
+        false
+    }
+
+    fn from_ssz_bytes(bytes: &[u8]) -> Result<Self, ssz::DecodeError> {
+        #[derive(ssz_derive::Decode)]
+        struct HeaderSubmissionElectraSszHelper {
+            bid_trace: BidTrace,
+            execution_payload_header: ExecutionPayloadHeaderElectra,
+            execution_requests: ExecutionRequestsV4,
+            commitments: Vec<alloy_consensus::Bytes48>,
+            adjustment_data: BidAdjustmentDataV2,
+        }
+
+        #[derive(ssz_derive::Decode)]
+        struct HeaderSubmissionElectraNoAdjustmentsSszHelper {
+            bid_trace: BidTrace,
+            execution_payload_header: ExecutionPayloadHeaderElectra,
+            execution_requests: ExecutionRequestsV4,
+            commitments: Vec<alloy_consensus::Bytes48>,
+        }
+
+        if let Ok(submission) = HeaderSubmissionElectraSszHelper::from_ssz_bytes(bytes) {
+            let HeaderSubmissionElectraSszHelper {
+                bid_trace,
+                execution_payload_header,
+                execution_requests,
+                commitments,
+                adjustment_data,
+            } = submission;
+            Ok(Self {
+                bid_trace,
+                execution_payload_header,
+                execution_requests,
+                commitments,
+                adjustment_data: Some(adjustment_data),
+            })
+        } else {
+            let HeaderSubmissionElectraNoAdjustmentsSszHelper {
+                bid_trace,
+                execution_payload_header,
+                execution_requests,
+                commitments,
+            } = HeaderSubmissionElectraNoAdjustmentsSszHelper::from_ssz_bytes(bytes)?;
+            Ok(Self {
+                bid_trace,
+                execution_payload_header,
+                execution_requests,
+                commitments,
+                adjustment_data: None,
+            })
+        }
+    }
 }
 
 /// Electra execution payload header.

crates/rbuilder/src/live_builder/block_output/relay_submit.rs

@@ -361,10 +361,12 @@ fn create_optimistic_v3_request(
     builder_url: &[u8],
     request: &SubmitBlockRequest,
     maybe_adjustment_data: Option<&BidAdjustmentData>,
+    adjustment_data_required: bool,
 ) -> eyre::Result<HeaderSubmissionOptimisticV3> {
-    let Some(adjustment_data) = maybe_adjustment_data else {
-        eyre::bail!("adjustment data must exist")
-    };
+    let maybe_adjustment_data_v2 = maybe_adjustment_data.map(|d| d.clone().into_v2());
+    if maybe_adjustment_data_v2.is_none() && adjustment_data_required {
+        eyre::bail!("adjustment data is required")
+    }
 
     let header_submission = match request {
         SubmitBlockRequest::Electra(request) => {
@@ -374,7 +376,7 @@ fn create_optimistic_v3_request(
                 execution_payload_header: header,
                 execution_requests: request.execution_requests.clone(),
                 commitments: request.blobs_bundle.commitments.clone(),
-                adjustment_data: adjustment_data.clone().into_v2(),
+                adjustment_data: maybe_adjustment_data_v2,
             })
         }
         SubmitBlockRequest::Fulu(request) => {
@@ -384,7 +386,7 @@ fn create_optimistic_v3_request(
                 execution_payload_header: header,
                 execution_requests: request.execution_requests.clone(),
                 commitments: request.blobs_bundle.commitments.clone(),
-                adjustment_data: adjustment_data.clone().into_v2(),
+                adjustment_data: maybe_adjustment_data_v2,
             })
         }
         _ => eyre::bail!("optimistic v3 submission is not supported for this fork"),
@@ -440,6 +442,7 @@ fn submit_block_to_relays(
                     &config.builder_url,
                     request,
                     maybe_adjustment_data,
+                    relay.optimistic_v3_bid_adjustment_required(),
                 )
                 .map(|request| (config.clone(), request))
                 .inspect_err(|error| {

crates/rbuilder/src/live_builder/config.rs

@@ -231,7 +231,6 @@ impl L1Config {
                     client.clone(),
                     relay_config.name.clone(),
                     submit_config,
-                    relay_config.optimistic_v3,
                     relay_config.mode == RelayMode::Test,
                 )?);
             } else {
@@ -384,7 +383,11 @@ impl L1Config {
         )?;
 
         let mut optimistic_v3_config = None;
-        if self.relays.iter().any(|r| r.optimistic_v3) {
+        if self
+            .relays
+            .iter()
+            .any(|r| r.submit_config.as_ref().is_some_and(|c| c.optimistic_v3))
+        {
             let address = SocketAddr::V4(SocketAddrV4::new(
                 self.optimistic_v3_server_ip,
                 self.optimistic_v3_server_port,
@@ -905,6 +908,8 @@ lazy_static! {
                     optimistic: false,
                     interval_between_submissions_ms: Some(250),
                     max_bid_eth: None,
+                    optimistic_v3: false,
+                    optimistic_v3_bid_adjustment_required: false,
                 }),
                 priority: Some(0),
                 authorization_header: None,
@@ -915,7 +920,6 @@ lazy_static! {
                 bloxroute_rproxy_regions: Vec::new(),
                 ask_for_filtering_validators: None,
                 can_ignore_gas_limit: None,
-                optimistic_v3: false,
             },
         );
         map.insert(
@@ -931,6 +935,8 @@ lazy_static! {
                     optimistic: true,
                     interval_between_submissions_ms: None,
                     max_bid_eth: None,
+                    optimistic_v3: false,
+                    optimistic_v3_bid_adjustment_required: false,
                 }),
                 priority: Some(0),
                 authorization_header: None,
@@ -941,7 +947,6 @@ lazy_static! {
                 bloxroute_rproxy_regions: Vec::new(),
                 ask_for_filtering_validators: None,
                 can_ignore_gas_limit: None,
-                optimistic_v3: false,
             },
         );
         map.insert(
@@ -957,6 +962,8 @@ lazy_static! {
                     optimistic: true,
                     interval_between_submissions_ms: None,
                     max_bid_eth: None,
+                    optimistic_v3: false,
+                    optimistic_v3_bid_adjustment_required: false,
                 }),
                 priority: Some(0),
                 authorization_header: None,
@@ -967,7 +974,6 @@ lazy_static! {
                 bloxroute_rproxy_regions: Vec::new(),
                 ask_for_filtering_validators: None,
                 can_ignore_gas_limit: None,
-                optimistic_v3: false,
             },
         );
         map.insert(
@@ -983,7 +989,10 @@ lazy_static! {
                     optimistic: true,
                     interval_between_submissions_ms: None,
                     max_bid_eth: None,
-                }),                priority: Some(0),
+                    optimistic_v3: false,
+                    optimistic_v3_bid_adjustment_required: false,
+                }),
+                priority: Some(0),
                 authorization_header: None,
                 builder_id_header: None,
                 api_token_header: None,
@@ -992,7 +1001,6 @@ lazy_static! {
                 bloxroute_rproxy_regions: Vec::new(),
                 ask_for_filtering_validators: None,
                 can_ignore_gas_limit: None,
-                optimistic_v3: false
             },
         );
         map.insert(
@@ -1008,6 +1016,8 @@ lazy_static! {
                     optimistic: false,
                     interval_between_submissions_ms: None,
                     max_bid_eth: None,
+                    optimistic_v3: false,
+                    optimistic_v3_bid_adjustment_required: false,
                 }),
                 priority: Some(0),
                 authorization_header: None,
@@ -1018,7 +1028,6 @@ lazy_static! {
                 bloxroute_rproxy_regions: Vec::new(),
                 ask_for_filtering_validators: None,
                 can_ignore_gas_limit: None,
-                optimistic_v3: false
             },
         );
         map

crates/rbuilder/src/mev_boost/mod.rs

@@ -105,9 +105,6 @@ pub struct RelayConfig {
     /// If we submit a block with a different gas than the one the validator registered with in this relay the relay does not mind.
     /// None -> false
     pub can_ignore_gas_limit: Option<bool>,
-    /// Flag indicating whether optimistic V3 submissions should be used.
-    #[serde(default)]
-    pub optimistic_v3: bool,
 }
 
 #[derive(Debug, Clone, Deserialize, PartialEq, Eq, Default)]
@@ -120,6 +117,12 @@ pub struct RelaySubmitConfig {
     pub use_gzip_for_submit: bool,
     #[serde(default)]
     pub optimistic: bool,
+    /// Flag indicating whether optimistic V3 submissions should be used.
+    #[serde(default)]
+    pub optimistic_v3: bool,
+    /// Flag indicating whether bid adjustments are required for optimistic v3 submissions.
+    #[serde(default)]
+    pub optimistic_v3_bid_adjustment_required: bool,
     #[serde(default)]
     pub interval_between_submissions_ms: Option<u64>,
     /// Max bid we can submit to this relay. Any bid above this will be skipped.
@@ -238,6 +241,8 @@ pub struct MevBoostRelayBidSubmitter {
     cancellations: bool,
     /// Flag indicating whether optimistic v3 submissions should be used.
     optimistic_v3: bool,
+    /// Flag indicating whether bid adjustments are required for optimistic v3 submissions.
+    optimistic_v3_bid_adjustment_required: bool,
     /// Max bid we can submit to this relay. Any bid above this will be skipped.
     /// None -> No limit.
     max_bid: Option<U256>,
@@ -250,7 +255,6 @@ impl MevBoostRelayBidSubmitter {
         client: RelayClient,
         id: String,
         config: &RelaySubmitConfig,
-        optimistic_v3: bool,
         test_relay: bool,
     ) -> eyre::Result<Self> {
         let max_bid = config
@@ -272,7 +276,8 @@ impl MevBoostRelayBidSubmitter {
             optimistic: config.optimistic,
             submission_rate_limiter,
             cancellations: true,
-            optimistic_v3,
+            optimistic_v3: config.optimistic_v3,
+            optimistic_v3_bid_adjustment_required: config.optimistic_v3_bid_adjustment_required,
             max_bid,
             test_relay,
         })
@@ -294,6 +299,10 @@ impl MevBoostRelayBidSubmitter {
         self.optimistic_v3
     }
 
+    pub fn optimistic_v3_bid_adjustment_required(&self) -> bool {
+        self.optimistic_v3_bid_adjustment_required
+    }
+
     pub fn max_bid(&self) -> Option<U256> {
         self.max_bid
     }