Add blinded blocks v2 (#352)

Author: jclapis

crates/cli/src/docker_init.rs

@@ -17,7 +17,7 @@ use cb_common::{
         SIGNER_DIR_SECRETS_ENV, SIGNER_ENDPOINT_ENV, SIGNER_KEYS_ENV, SIGNER_MODULE_NAME,
         SIGNER_PORT_DEFAULT, SIGNER_URL_ENV,
     },
-    pbs::{BUILDER_API_PATH, GET_STATUS_PATH},
+    pbs::{BUILDER_V1_API_PATH, GET_STATUS_PATH},
     signer::{ProxyStore, SignerLoader},
     types::ModuleId,
     utils::random_jwt_secret,
@@ -308,7 +308,7 @@ pub async fn handle_docker_init(config_path: PathBuf, output_dir: PathBuf) -> Re
         healthcheck: Some(Healthcheck {
             test: Some(HealthcheckTest::Single(format!(
                 "curl -f http://localhost:{}{}{}",
-                cb_config.pbs.pbs_config.port, BUILDER_API_PATH, GET_STATUS_PATH
+                cb_config.pbs.pbs_config.port, BUILDER_V1_API_PATH, GET_STATUS_PATH
             ))),
             interval: Some("30s".into()),
             timeout: Some("5s".into()),

crates/common/src/pbs/builder.rs

@@ -0,0 +1,30 @@
+use std::fmt::{Display, Formatter, Result};
+
+use serde::{Deserialize, Serialize};
+
+use crate::pbs::{BUILDER_V1_API_PATH, BUILDER_V2_API_PATH};
+
+// Version of the builder API for various routes
+#[derive(Debug, Copy, Clone, Serialize, Deserialize, PartialEq, Eq)]
+#[serde(rename_all = "lowercase")]
+pub enum BuilderApiVersion {
+    V1 = 1,
+    V2,
+}
+impl BuilderApiVersion {
+    pub const fn path(&self) -> &'static str {
+        match self {
+            BuilderApiVersion::V1 => BUILDER_V1_API_PATH,
+            BuilderApiVersion::V2 => BUILDER_V2_API_PATH,
+        }
+    }
+}
+impl Display for BuilderApiVersion {
+    fn fmt(&self, f: &mut Formatter<'_>) -> Result {
+        let s = match self {
+            BuilderApiVersion::V1 => "v1",
+            BuilderApiVersion::V2 => "v2",
+        };
+        write!(f, "{}", s)
+    }
+}

crates/common/src/pbs/constants.rs

@@ -1,6 +1,7 @@
 use crate::constants::COMMIT_BOOST_VERSION;
 
-pub const BUILDER_API_PATH: &str = "/eth/v1/builder";
+pub const BUILDER_V1_API_PATH: &str = "/eth/v1/builder";
+pub const BUILDER_V2_API_PATH: &str = "/eth/v2/builder";
 
 pub const GET_HEADER_PATH: &str = "/header/{slot}/{parent_hash}/{pubkey}";
 pub const GET_STATUS_PATH: &str = "/status";

crates/common/src/pbs/event.rs

@@ -20,7 +20,7 @@ use super::{
 };
 use crate::{
     config::{load_optional_env_var, BUILDER_URLS_ENV, HTTP_TIMEOUT_SECONDS_DEFAULT},
-    pbs::BUILDER_EVENTS_PATH,
+    pbs::{BuilderApiVersion, BUILDER_EVENTS_PATH},
 };
 
 #[derive(Debug, Clone, Serialize, Deserialize)]
@@ -29,8 +29,9 @@ pub enum BuilderEvent {
     GetHeaderResponse(Box<Option<GetHeaderResponse>>),
     GetStatusEvent,
     GetStatusResponse,
-    SubmitBlockRequest(Box<SignedBlindedBeaconBlock>),
-    SubmitBlockResponse(Box<SubmitBlindedBlockResponse>),
+    SubmitBlockRequest(Box<SignedBlindedBeaconBlock>, BuilderApiVersion),
+    SubmitBlockResponseV1(Box<SubmitBlindedBlockResponse>),
+    SubmitBlockResponseV2,
     MissedPayload {
         /// Hash for the block for which no payload was received
         block_hash: B256,

crates/common/src/pbs/mod.rs

@@ -1,9 +1,11 @@
+mod builder;
 mod constants;
 pub mod error;
 mod event;
 mod relay;
 mod types;
 
+pub use builder::*;
 pub use constants::*;
 pub use event::*;
 pub use relay::*;

crates/common/src/pbs/relay.rs

@@ -10,11 +10,11 @@ use serde::{Deserialize, Serialize};
 use url::Url;
 
 use super::{
-    constants::{BUILDER_API_PATH, GET_STATUS_PATH, REGISTER_VALIDATOR_PATH, SUBMIT_BLOCK_PATH},
+    constants::{GET_STATUS_PATH, REGISTER_VALIDATOR_PATH, SUBMIT_BLOCK_PATH},
     error::PbsError,
     HEADER_VERSION_KEY, HEADER_VERSION_VALUE,
 };
-use crate::{config::RelayConfig, DEFAULT_REQUEST_TIMEOUT};
+use crate::{config::RelayConfig, pbs::BuilderApiVersion, DEFAULT_REQUEST_TIMEOUT};
 
 /// A parsed entry of the relay url in the format: scheme://pubkey@host
 #[derive(Debug, Clone)]
@@ -101,8 +101,12 @@ impl RelayClient {
 
         Ok(url)
     }
-    pub fn builder_api_url(&self, path: &str) -> Result<Url, PbsError> {
-        self.get_url(&format!("{BUILDER_API_PATH}{path}"))
+    pub fn builder_api_url(
+        &self,
+        path: &str,
+        api_version: BuilderApiVersion,
+    ) -> Result<Url, PbsError> {
+        self.get_url(&format!("{}{path}", api_version.path()))
     }
 
     pub fn get_header_url(
@@ -111,19 +115,22 @@ impl RelayClient {
         parent_hash: B256,
         validator_pubkey: BlsPublicKey,
     ) -> Result<Url, PbsError> {
-        self.builder_api_url(&format!("/header/{slot}/{parent_hash}/{validator_pubkey}"))
+        self.builder_api_url(
+            &format!("/header/{slot}/{parent_hash}/{validator_pubkey}"),
+            BuilderApiVersion::V1,
+        )
     }
 
     pub fn get_status_url(&self) -> Result<Url, PbsError> {
-        self.builder_api_url(GET_STATUS_PATH)
+        self.builder_api_url(GET_STATUS_PATH, BuilderApiVersion::V1)
     }
 
     pub fn register_validator_url(&self) -> Result<Url, PbsError> {
-        self.builder_api_url(REGISTER_VALIDATOR_PATH)
+        self.builder_api_url(REGISTER_VALIDATOR_PATH, BuilderApiVersion::V1)
     }
 
-    pub fn submit_block_url(&self) -> Result<Url, PbsError> {
-        self.builder_api_url(SUBMIT_BLOCK_PATH)
+    pub fn submit_block_url(&self, api_version: BuilderApiVersion) -> Result<Url, PbsError> {
+        self.builder_api_url(SUBMIT_BLOCK_PATH, api_version)
     }
 }
 

crates/common/src/pbs/types/beacon_block.rs

@@ -99,7 +99,7 @@ mod tests {
     // this is from mev-boost test data
     fn test_signed_blinded_block_fb_electra() {
         let data = include_str!("testdata/signed-blinded-beacon-block-electra.json");
-        let block = test_encode_decode::<SignedBlindedBeaconBlock>(&data);
+        let block = test_encode_decode::<SignedBlindedBeaconBlock>(data);
         assert!(matches!(block.message, BlindedBeaconBlock::Electra(_)));
     }
 
@@ -166,7 +166,7 @@ mod tests {
     // this is dummy data generated with https://github.com/attestantio/go-eth2-client
     fn test_signed_blinded_block_ssz() {
         let data_json = include_str!("testdata/signed-blinded-beacon-block-electra-2.json");
-        let block_json = test_encode_decode::<SignedBlindedBeaconBlock>(&data_json);
+        let block_json = test_encode_decode::<SignedBlindedBeaconBlock>(data_json);
         assert!(matches!(block_json.message, BlindedBeaconBlock::Electra(_)));
 
         let data_ssz = include_bytes!("testdata/signed-blinded-beacon-block-electra-2.ssz");
@@ -181,7 +181,7 @@ mod tests {
     // this is dummy data generated with https://github.com/attestantio/go-builder-client
     fn test_execution_payload_block_ssz() {
         let data_json = include_str!("testdata/execution-payload-electra.json");
-        let block_json = test_encode_decode::<PayloadAndBlobsElectra>(&data_json);
+        let block_json = test_encode_decode::<PayloadAndBlobsElectra>(data_json);
 
         let data_ssz = include_bytes!("testdata/execution-payload-electra.ssz");
         let data_ssz = alloy::primitives::hex::decode(data_ssz).unwrap();

crates/common/src/pbs/types/execution_payload.rs

@@ -129,7 +129,7 @@ mod tests {
             "excess_blob_gas": "95158272"
         }"#;
 
-        let parsed = test_encode_decode::<ExecutionPayloadHeader<ElectraSpec>>(&data);
+        let parsed = test_encode_decode::<ExecutionPayloadHeader<ElectraSpec>>(data);
 
         assert_eq!(
             parsed.parent_hash,

crates/common/src/pbs/types/get_header.rs

@@ -166,7 +166,7 @@ mod tests {
             }
         }"#;
 
-        let parsed = test_encode_decode::<GetHeaderResponse>(&data);
+        let parsed = test_encode_decode::<GetHeaderResponse>(data);
         let VersionedResponse::Electra(parsed) = parsed;
 
         assert_eq!(parsed.message.value, U256::from(1));
@@ -187,7 +187,7 @@ mod tests {
         let data_json = include_str!("testdata/get-header-response.json");
         let block_json = test_encode_decode::<
             SignedExecutionPayloadHeader<ExecutionPayloadHeaderMessageElectra>,
-        >(&data_json);
+        >(data_json);
 
         let data_ssz = include_bytes!("testdata/get-header-response.ssz");
         let data_ssz = alloy::primitives::hex::decode(data_ssz).unwrap();

crates/common/src/signer/store.rs

@@ -542,12 +542,12 @@ mod test {
             .join(consensus_signer.pubkey().to_string())
             .join("TEST_MODULE")
             .join("bls")
-            .join(format!("{}.json", proxy_signer.pubkey().to_string()));
+            .join(format!("{}.json", proxy_signer.pubkey()));
         let sig_path = keys_path
             .join(consensus_signer.pubkey().to_string())
             .join("TEST_MODULE")
             .join("bls")
-            .join(format!("{}.sig", proxy_signer.pubkey().to_string()));
+            .join(format!("{}.sig", proxy_signer.pubkey()));
         let pass_path = secrets_path
             .join(consensus_signer.pubkey().to_string())
             .join("TEST_MODULE")
@@ -674,7 +674,7 @@ mod test {
                         .join(consensus_signer.pubkey().to_string())
                         .join("TEST_MODULE")
                         .join("bls")
-                        .join(format!("{}.sig", proxy_signer.pubkey().to_string()))
+                        .join(format!("{}.sig", proxy_signer.pubkey()))
                 )
                 .unwrap()
             )