feat: add optimistic v3 types (#719)

## 📝 Summary

Add types for optimistic V3.

## ✅ I have completed the following steps:

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

Author: efbig

Cargo.lock

@@ -129,6 +129,11 @@ alloy-signer-local = { version = "1.0.27" }
 alloy-rpc-client = { version = "1.0.27" }
 alloy-genesis = { version = "1.0.27" }
 
+# Version required by ethereum-consensus beacon-api-client
+mev-share-sse = { git = "https://github.com/paradigmxyz/mev-share-rs", rev = "9eb2b0138ab3202b9eb3af4b19c7b3bf40b0faa8", default-features = false }
+beacon-api-client = { git = "https://github.com/ralexstokes/ethereum-consensus/", rev = "5031d31e318dd861cf3373702c5d92f085d926e4" }
+ethereum-consensus = { git = "https://github.com/ralexstokes/ethereum-consensus/", rev = "5031d31e318dd861cf3373702c5d92f085d926e4" }
+
 async-trait = { version = "0.1.83" }
 clap = { version = "4.4.3", features = ["derive", "env"] }
 clap_builder = { version = "4.5.19" }
@@ -152,6 +157,7 @@ warp = "0.3.7"
 flate2 = "1.0.35"
 prometheus = "0.13.4"
 ctor = "0.2"
+rand = "0.8"
 
 libc = { version = "0.2.161" }
 lazy_static = "1.4.0"

Cargo.toml

@@ -21,7 +21,7 @@ serde_with = { version = "3.9.0", features = ["time_0_3"] }
 chrono = "^0.4"
 futures = "^0.3"
 futures-retry = "0.6"
-rand = "^0.8"
+rand.workspace = true
 runng = "^0.3"
 reqwest = { version = "^0.11", default-features = false, features = ["rustls", "gzip", "brotli", "deflate", "json", "rustls-tls"] }
 lru = "^0.10"

crates/bid-scraper/Cargo.toml

@@ -51,7 +51,7 @@ benchmark-utils = ["dep:hash-db", "dep:triehash", "dep:flate2"]
 
 [dev-dependencies]
 criterion = { version = "0.4", features = ["html_reports"] }
-rand = { version = "0.8.5", features = ["small_rng"] }
+rand = { workspace = true, features = ["small_rng"] }
 proptest = "1.5.0"
 eth-sparse-mpt = { path = ".", features = ["benchmark-utils"] }
 

crates/eth-sparse-mpt/Cargo.toml

@@ -22,6 +22,8 @@ alloy-rpc-types-eth.workspace = true
 revm.workspace = true
 revm-inspectors.workspace = true
 
+ethereum-consensus.workspace = true
+
 # misc
 derivative = "2.2.0"
 integer-encoding = "4.0.0"
@@ -49,3 +51,6 @@ reth-primitives.workspace = true
 reth-ethereum-primitives.workspace = true
 reth-node-core.workspace = true
 reth.workspace = true
+
+[dev-dependencies]
+rand.workspace = true

crates/rbuilder-primitives/Cargo.toml

@@ -0,0 +1,86 @@
+use alloy_primitives::{Address, Bloom, Bytes, B256};
+
+/// The type representing UltraSound bid adjustments.
+#[derive(
+    PartialEq,
+    Eq,
+    Clone,
+    Debug,
+    serde::Serialize,
+    serde::Deserialize,
+    ssz_derive::Encode,
+    ssz_derive::Decode,
+)]
+pub struct BidAdjustmentData {
+    /// State root of the payload.
+    pub state_root: B256,
+    /// Transactions root of the payload.
+    pub transactions_root: B256,
+    /// Receipts root of the payload.
+    pub receipts_root: B256,
+    /// The usual builder address that pays the proposer in the last transaction of the block.
+    /// When we adjust a bid, this transaction is overwritten by a transaction from the collateral
+    /// account `fee_payer_address`. If we don't adjust the bid, `builder_address` pays the
+    /// proposer as per usual.
+    pub builder_address: Address,
+    /// The state proof for the builder account.
+    pub builder_proof: Vec<Bytes>,
+    /// The proposer's fee recipient.
+    pub fee_recipient_address: Address,
+    /// The state proof for the fee recipient account.
+    pub fee_recipient_proof: Vec<Bytes>,
+    /// The fee payer address that is custodied by the relay.
+    pub fee_payer_address: Address,
+    /// The state proof for the fee payer account.
+    pub fee_payer_proof: Vec<Bytes>,
+    /// The merkle proof for the last transaction in the block, which will be overwritten with a
+    /// payment from `fee_payer` to `fee_recipient` if we adjust the bid.
+    pub placeholder_transaction_proof: Vec<Bytes>,
+    /// The merkle proof for the receipt of the placeholder transaction. It's required for
+    /// adjusting payments to contract addresses.
+    pub placeholder_receipt_proof: Vec<Bytes>,
+}
+
+/// The type for bid adjustments in optimistic v3.
+/// Ref: <https://github.com/ultrasoundmoney/docs/blob/main/optimistic-v3.md#optimistic-v3>
+#[derive(
+    PartialEq,
+    Eq,
+    Clone,
+    Debug,
+    serde::Serialize,
+    serde::Deserialize,
+    ssz_derive::Encode,
+    ssz_derive::Decode,
+)]
+pub struct BidAdjustmentDataV2 {
+    /// Transactions root of the payload.
+    pub el_transactions_root: B256,
+    /// Withdrawals root of the payload.
+    pub el_withdrawals_root: B256,
+    /// The usual builder address that pays the proposer in the last transaction of the block.
+    /// When we adjust a bid, this transaction is overwritten by a transaction from the collateral
+    /// account `fee_payer_address`. If we don't adjust the bid, `builder_address` pays the
+    /// proposer as per usual.
+    pub builder_address: Address,
+    /// The state proof for the builder account.
+    pub builder_proof: Vec<Bytes>,
+    /// The proposer's fee recipient.
+    pub fee_recipient_address: Address,
+    /// The state proof for the fee recipient account.
+    pub fee_recipient_proof: Vec<Bytes>,
+    /// The fee payer address that is custodied by the relay.
+    pub fee_payer_address: Address,
+    /// The state proof for the fee payer account.
+    pub fee_payer_proof: Vec<Bytes>,
+    /// The merkle proof for the last transaction in the block, which will be overwritten with a
+    /// payment from `fee_payer` to `fee_recipient` if we adjust the bid.
+    pub el_placeholder_transaction_proof: Vec<Bytes>,
+    /// New in V2: SSZ merkle proof for last transaction
+    pub cl_placeholder_transaction_proof: Vec<B256>,
+    /// The merkle proof for the receipt of the placeholder transaction. It's required for
+    /// adjusting payments to contract addresses.
+    pub placeholder_receipt_proof: Vec<Bytes>,
+    /// New in V2: Logs bloom accrued until but not including the last (payment) transaction.
+    pub pre_payment_logs_bloom: Bloom,
+}