Merge pull request #2 from sigp/top-bid-ws-stream

Top bid ws stream

Author: realbigsean

Cargo.toml

@@ -11,18 +11,20 @@ members = [
 
 [workspace.dependencies]
 async-trait = "0.1"
-axum = "0.7"
+axum = { version = "0.7", features = ["ws"] }
 bytes = "1.6"
 eth2 = { git = "https://github.com/realbigsean/lighthouse.git", rev = "10ce60633859ab4f20308ef42bb88e219e09fee5" }
 ethereum_serde_utils = "0.5.2"
 ethereum_ssz = "0.5.4"
 ethereum_ssz_derive = "0.5.4"
+futures = "0.3.30"
 http = "1"
 reqwest = { version = "0.12.5", features = ["json"] }
 serde = { version = "1.0", features = ["derive"] }
 serde_json = { version = "1", features = ["raw_value"] }
 superstruct = "0.8"
 tokio = { version = "1", default-features = false, features = ["signal", "rt-multi-thread"] }
+tokio-tungstenite = "0.24.0"
 tracing = { version = "0.1", features = ["attributes"] }
 types = { git = "https://github.com/realbigsean/lighthouse.git", rev = "10ce60633859ab4f20308ef42bb88e219e09fee5" }
 rand = "0.8"

relay-api-types/src/lib.rs

@@ -4,8 +4,10 @@ use serde_utils::quoted_u64::Quoted;
 use ssz_derive::{Decode, Encode};
 pub use types::{
     superstruct, Address, EthSpec, ExecutionBlockHash, ExecutionPayloadBellatrix,
-    ExecutionPayloadCapella, ExecutionPayloadDeneb, ExecutionPayloadElectra, MainnetEthSpec,
-    MinimalEthSpec, PublicKeyBytes, Signature, SignedValidatorRegistrationData, Slot, Uint256,
+    ExecutionPayloadCapella, ExecutionPayloadDeneb, ExecutionPayloadElectra,
+    ExecutionPayloadHeaderBellatrix, ExecutionPayloadHeaderCapella, ExecutionPayloadHeaderDeneb,
+    ExecutionPayloadHeaderElectra, MainnetEthSpec, MinimalEthSpec, PublicKeyBytes, Signature,
+    SignedValidatorRegistrationData, Slot, Uint256,
 };
 
 // Builder API requests
@@ -108,13 +110,96 @@ pub struct GetValidatorRegistrationQueryParams {
     pub pubkey: PublicKeyBytes,
 }
 
+#[superstruct(
+    variants(Bellatrix, Capella, Deneb, Electra),
+    variant_attributes(
+        derive(Debug, Clone, Serialize, Deserialize, Encode, Decode),
+        serde(bound = "E: EthSpec", deny_unknown_fields),
+    ),
+    map_into(ExecutionPayloadHeader),
+    map_ref_into(ExecutionPayloadHeader)
+)]
+#[derive(Debug, Clone, Serialize, Deserialize, Encode, Decode)]
+#[serde(bound = "E: EthSpec", untagged)]
+#[ssz(enum_behaviour = "transparent")]
+pub struct HeaderSubmission<E: EthSpec> {
+    bid_trace: BidTraceV1,
+    #[superstruct(flatten)]
+    execution_payload_header: ExecutionPayloadHeader<E>,
+    #[superstruct(only(Deneb))]
+    blobs_bundle: BlobsBundle<E>,
+}
+
+#[superstruct(
+    variants(Bellatrix, Capella, Deneb, Electra),
+    variant_attributes(
+        derive(Debug, Clone, Serialize, Deserialize, Encode, Decode),
+        serde(bound = "E: EthSpec", deny_unknown_fields),
+    ),
+    map_into(ExecutionPayloadHeader),
+    map_ref_into(ExecutionPayloadHeader)
+)]
+#[derive(Debug, Clone, Serialize, Deserialize, Encode, Decode)]
+#[serde(bound = "E: EthSpec", untagged)]
+#[ssz(enum_behaviour = "transparent")]
+pub struct SignedHeaderSubmission<E: EthSpec> {
+    #[superstruct(flatten)]
+    message: HeaderSubmission<E>,
+    signature: Signature,
+}
+
+#[derive(Debug, Clone, Serialize, Deserialize, Encode, Decode)]
+pub struct Cancellation {
+    #[serde(with = "serde_utils::quoted_u64")]
+    pub slot: u64,
+    pub parent_hash: ExecutionBlockHash,
+    pub proposer_public_key: PublicKeyBytes,
+    pub builder_public_key: PublicKeyBytes,
+}
+
+#[derive(Debug, Clone, Serialize, Deserialize, Encode, Decode)]
+pub struct SignedCancellation {
+    pub message: Cancellation,
+    pub signature: Signature,
+}
+
+// Websockets types
+#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
+pub struct TopBidUpdate {
+    #[serde(with = "serde_utils::quoted_u64")]
+    timestamp: u64,
+    slot: Slot,
+    #[serde(with = "serde_utils::quoted_u64")]
+    block_number: u64,
+    block_hash: ExecutionBlockHash,
+    parent_hash: ExecutionBlockHash,
+    builder_pubkey: PublicKeyBytes,
+    fee_recipient: Address,
+    #[serde(with = "serde_utils::quoted_u256")]
+    value: Uint256,
+}
+
 // Builder API responses
+#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
+#[serde(rename_all = "kebab-case")]
+pub enum Filtering {
+    Regional,
+    Global,
+}
+
+#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
+pub struct ValidatorPreferences {
+    filtering: Filtering,
+    trusted_builders: Option<Vec<String>>,
+}
+
 #[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
 pub struct ValidatorsResponse {
     pub slot: Slot,
     #[serde(with = "serde_utils::quoted_u64")]
     pub validator_index: u64,
     pub entry: SignedValidatorRegistrationData,
+    pub preferences: Option<ValidatorPreferences>,
 }
 
 // Data API responses
@@ -156,15 +241,6 @@ pub struct BidTraceV2WithTimestamp {
 }
 
 // Response types common
-
-#[derive(Debug, PartialEq, Serialize, Deserialize)]
-#[serde(untagged)]
-#[must_use]
-pub enum Response<T> {
-    Success(T),
-    Error(ErrorResponse),
-}
-
 #[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)]
 pub struct ErrorResponse {
     pub code: u16,
@@ -173,11 +249,18 @@ pub struct ErrorResponse {
     pub stacktraces: Option<Vec<String>>,
 }
 
+pub fn custom_internal_err(message: String) -> ErrorResponse {
+    ErrorResponse {
+        code: 500,
+        message,
+        stacktraces: None,
+    }
+}
+
 // Builder API response types
-pub type GetValidatorsResponse = Response<Vec<ValidatorsResponse>>;
-pub type SubmitBlockResponse = Response<()>;
+pub type GetValidatorsResponse = Vec<ValidatorsResponse>;
 
 // Data API response types
-pub type GetDeliveredPayloadsResponse = Response<Vec<BidTraceV2>>;
-pub type GetReceivedBidsResponse = Response<Vec<BidTraceV2WithTimestamp>>;
-pub type GetValidatorRegistrationResponse = Response<SignedValidatorRegistrationData>;
+pub type GetDeliveredPayloadsResponse = Vec<BidTraceV2>;
+pub type GetReceivedBidsResponse = Vec<BidTraceV2WithTimestamp>;
+pub type GetValidatorRegistrationResponse = SignedValidatorRegistrationData;

relay-client/Cargo.toml

@@ -4,9 +4,11 @@ version = "0.1.0"
 edition = "2021"
 
 [dependencies]
+futures.workspace = true
 http.workspace = true
-relay-api-types = { version = "0.1.0", path = "../relay-api-types" }
+relay-api-types = { path = "../relay-api-types" }
 reqwest.workspace = true
 serde.workspace = true
 serde_json.workspace = true
+tokio-tungstenite.workspace = true
 types.workspace = true