Subsidy value propagated on tbv stream. (#767)

## 📝 Summary

Subsidy is propagated from the bidder to the tbv stream since it's an
important info if the bid.

## ✅ I have completed the following steps:

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

Author: ZanCorDX

crates/rbuilder-operator/src/bidding_service_wrapper/fast_streams/types.rs

@@ -1,6 +1,6 @@
 //! Types used to communicate with the bidding service via iceoryx.
 //! They are mostly mappings of the originals but supporting ZeroCopySend.
-use alloy_primitives::U256;
+use alloy_primitives::{I256, U256};
 use bid_scraper::types::ScrapedRelayBlockBid;
 use iceoryx2::prelude::ZeroCopySend;
 use iceoryx2_bb_container::byte_string::FixedSizeByteString;
@@ -196,6 +196,7 @@ pub struct SlotBidderSealBidCommandRPC {
     pub session_id: u64,
     pub block_id: u64,
     pub payout_tx_value: [u8; U256_DATA_LENGTH],
+    pub subsidy: [u8; U256_DATA_LENGTH],
     pub seen_competition_bid: Option<[u8; U256_DATA_LENGTH]>,
     /// When this bid is a reaction so some event (eg: new block, new competition bid) we put here
     /// the creation time of that event so we can measure our reaction time.
@@ -213,6 +214,7 @@ impl From<SlotBidderSealBidCommandWithSessionId> for SlotBidderSealBidCommandRPC
                 .0
                 .trigger_creation_time
                 .map(offset_datetime_to_timestamp_us),
+            subsidy: value.0.subsidy.to_le_bytes(),
         }
     }
 }
@@ -222,6 +224,7 @@ impl From<SlotBidderSealBidCommandRPC> for SlotBidderSealBidCommand {
         SlotBidderSealBidCommand {
             block_id: BuiltBlockId(val.block_id),
             payout_tx_value: U256::from_le_bytes(val.payout_tx_value),
+            subsidy: I256::from_le_bytes(val.subsidy),
             seen_competition_bid: val.seen_competition_bid.map(|k| U256::from_le_bytes(k)),
             trigger_creation_time: val
                 .trigger_creation_time_us

crates/rbuilder-operator/src/true_block_value_push/best_true_value_observer.rs

@@ -83,6 +83,7 @@ impl BidObserver for BestTrueValueObserver {
             slot_data.slot(),
             built_block_trace.true_bid_value,
             built_block_trace.bid_value,
+            built_block_trace.subsidy,
             builder_name,
             slot_data.timestamp().unix_timestamp() as u64,
         );

crates/rbuilder-operator/src/true_block_value_push/best_true_value_pusher.rs

@@ -1,9 +1,10 @@
 //! This module is responsible for syncing the best true value bid between the local state and redis.
 
-use alloy_primitives::U256;
+use alloy_primitives::{I256, U256};
 
 use parking_lot::Mutex;
 use rbuilder::utils::{
+    i256decimal_serde_helper,
     reconnect::{run_loop_with_reconnect, RunCommand},
     u256decimal_serde_helper,
 };
@@ -27,6 +28,9 @@ pub struct BuiltBlockInfo {
     /// Bid we made to the relay.
     #[serde(with = "u256decimal_serde_helper")]
     pub bid: U256,
+    #[serde(with = "i256decimal_serde_helper")]
+    pub subsidy: I256,
+
     pub builder: String,
     pub slot_end_timestamp: u64,
 }
@@ -37,6 +41,7 @@ impl BuiltBlockInfo {
         slot_number: u64,
         best_true_value: U256,
         bid: U256,
+        subsidy: I256,
         builder: String,
         slot_end_timestamp: u64,
     ) -> Self {
@@ -46,6 +51,7 @@ impl BuiltBlockInfo {
             slot_number,
             best_true_value,
             bid,
+            subsidy,
             builder,
             slot_end_timestamp,
         }

crates/rbuilder/src/building/builders/block_building_helper.rs

@@ -1,4 +1,4 @@
-use alloy_primitives::{utils::format_ether, Address, TxHash, U256};
+use alloy_primitives::{utils::format_ether, Address, TxHash, I256, U256};
 use reth_provider::StateProvider;
 use std::{
     cmp::max,
@@ -68,10 +68,12 @@ pub trait BlockBuildingHelper: Send + Sync {
     /// Finalize block for submission.
     /// if adjust_finalized_block is implemented, finalize_blocks should prepare helper
     /// for faster adjustments.
+    /// subsidy is how much of payout_tx_value we consider to be subsidy.
     fn finalize_block(
         &mut self,
         local_ctx: &mut ThreadBlockBuildingContext,
         payout_tx_value: U256,
+        subsidy: I256,
         seen_competition_bid: Option<U256>,
     ) -> Result<FinalizeBlockResult, BlockBuildingHelperError>;
 
@@ -96,6 +98,7 @@ pub trait BlockBuildingHelper: Send + Sync {
         &mut self,
         local_ctx: &mut ThreadBlockBuildingContext,
         payout_tx_value: U256,
+        subsidy: I256,
         seen_competition_bid: Option<U256>,
     ) -> Result<FinalizeBlockResult, BlockBuildingHelperError>;
 }
@@ -337,6 +340,7 @@ impl<
         &mut self,
         local_ctx: &mut ThreadBlockBuildingContext,
         payout_tx_value: U256,
+        subsidy: I256,
         adjust_finalized_block: bool,
         finalize_revert_state: &mut FinalizeRevertStateCurrentIteration,
     ) -> Result<(), BlockBuildingHelperError> {
@@ -364,6 +368,7 @@ impl<
             .unwrap_or_default();
 
         self.built_block_trace.bid_value = max(bid_value, fee_recipient_balance_diff);
+        self.built_block_trace.subsidy = subsidy;
         self.built_block_trace.true_bid_value = true_value;
         self.built_block_trace.mev_blocker_price = self.building_context().mev_blocker_price;
         Ok(())
@@ -373,6 +378,7 @@ impl<
         &mut self,
         local_ctx: &mut ThreadBlockBuildingContext,
         payout_tx_value: U256,
+        subsidy: I256,
         seen_competition_bid: Option<U256>,
         adjust_finalized_block: bool,
     ) -> Result<FinalizeBlockResult, BlockBuildingHelperError> {
@@ -403,6 +409,7 @@ impl<
         self.finalize_block_execution(
             local_ctx,
             payout_tx_value,
+            subsidy,
             adjust_finalized_block,
             &mut finalize_adjustment_state.revert_state,
         )?;
@@ -590,9 +597,16 @@ impl<
         &mut self,
         local_ctx: &mut ThreadBlockBuildingContext,
         payout_tx_value: U256,
+        subsidy: I256,
         seen_competition_bid: Option<U256>,
     ) -> Result<FinalizeBlockResult, BlockBuildingHelperError> {
-        self.finalize_block_impl(local_ctx, payout_tx_value, seen_competition_bid, false)
+        self.finalize_block_impl(
+            local_ctx,
+            payout_tx_value,
+            subsidy,
+            seen_competition_bid,
+            false,
+        )
     }
 
     fn built_block_trace(&self) -> &BuiltBlockTrace {
@@ -624,8 +638,15 @@ impl<
         &mut self,
         local_ctx: &mut ThreadBlockBuildingContext,
         payout_tx_value: U256,
+        subsidy: I256,
         seen_competition_bid: Option<U256>,
     ) -> Result<FinalizeBlockResult, BlockBuildingHelperError> {
-        self.finalize_block_impl(local_ctx, payout_tx_value, seen_competition_bid, true)
+        self.finalize_block_impl(
+            local_ctx,
+            payout_tx_value,
+            subsidy,
+            seen_competition_bid,
+            true,
+        )
     }
 }

crates/rbuilder/src/building/builders/block_building_helper_stats_logger.rs

@@ -4,7 +4,7 @@ use std::{
     time::{Duration, Instant},
 };
 
-use alloy_primitives::{utils::format_ether, U256};
+use alloy_primitives::{utils::format_ether, I256, U256};
 
 use crate::{
     building::{builders::block_building_helper::BlockBuildingHelper, ThreadBlockBuildingContext},
@@ -208,6 +208,7 @@ impl BlockBuildingHelper for BlockBuildingHelperStatsLogger<'_> {
         &mut self,
         _local_ctx: &mut crate::building::ThreadBlockBuildingContext,
         _payout_tx_value: alloy_primitives::U256,
+        _subsidy: alloy_primitives::I256,
         _seen_competition_bid: Option<alloy_primitives::U256>,
     ) -> Result<FinalizeBlockResult, BlockBuildingHelperError> {
         panic!("finalize_block not implemented. This is only for testing.");
@@ -238,6 +239,7 @@ impl BlockBuildingHelper for BlockBuildingHelperStatsLogger<'_> {
         &mut self,
         _local_ctx: &mut ThreadBlockBuildingContext,
         _payout_tx_value: U256,
+        _subsidy: I256,
         _seen_competition_bid: Option<U256>,
     ) -> Result<FinalizeBlockResult, BlockBuildingHelperError> {
         unimplemented!()

crates/rbuilder/src/building/builders/mock_block_building_helper.rs

@@ -7,7 +7,7 @@ use crate::{
     provider::RootHasher,
     roothash::RootHashError,
 };
-use alloy_primitives::{Address, Bytes, B256, U256};
+use alloy_primitives::{Address, Bytes, B256, I256, U256};
 use eth_sparse_mpt::utils::{HashMap, HashSet};
 use rbuilder_primitives::{order_statistics::OrderStatistics, SimValue, SimulatedOrder};
 use reth_primitives::SealedBlock;
@@ -85,11 +85,13 @@ impl BlockBuildingHelper for MockBlockBuildingHelper {
         &mut self,
         _local_ctx: &mut ThreadBlockBuildingContext,
         payout_tx_value: U256,
+        subsidy: I256,
         seen_competition_bid: Option<U256>,
     ) -> Result<FinalizeBlockResult, BlockBuildingHelperError> {
         self.built_block_trace.update_orders_sealed_at();
         self.built_block_trace.seen_competition_bid = seen_competition_bid;
         self.built_block_trace.bid_value = payout_tx_value;
+        self.built_block_trace.subsidy = subsidy;
         let block = Block {
             builder_name: "BlockBuildingHelper".to_string(),
             trace: self.built_block_trace.clone(),
@@ -127,6 +129,7 @@ impl BlockBuildingHelper for MockBlockBuildingHelper {
         &mut self,
         _local_ctx: &mut ThreadBlockBuildingContext,
         _payout_tx_value: U256,
+        _subsidy: I256,
         _seen_competition_bid: Option<U256>,
     ) -> Result<FinalizeBlockResult, BlockBuildingHelperError> {
         unimplemented!()

crates/rbuilder/src/building/builders/ordering_builder.rs

@@ -25,6 +25,7 @@ use crate::{
     utils::NonceCache,
 };
 use ahash::{HashMap, HashSet};
+use alloy_primitives::I256;
 use derivative::Derivative;
 use rbuilder_primitives::{AccountNonce, OrderId, SimValue, SimulatedOrder};
 use reth_provider::StateProvider;
@@ -198,7 +199,7 @@ where
 
     let payout_tx_value = block_builder.true_block_value()?;
     let finalize_block_result =
-        block_builder.finalize_block(&mut local_ctx, payout_tx_value, None)?;
+        block_builder.finalize_block(&mut local_ctx, payout_tx_value, I256::ZERO, None)?;
     Ok(finalize_block_result.block)
 }
 

crates/rbuilder/src/building/builders/parallel_builder/mod.rs

@@ -7,6 +7,7 @@ pub mod order_intake_store;
 pub mod results_aggregator;
 pub mod simulation_cache;
 pub mod task;
+use alloy_primitives::I256;
 pub use groups::*;
 
 use ahash::HashMap;
@@ -377,6 +378,7 @@ where
     let finalize_block_result = block_building_helper.finalize_block(
         &mut block_building_result_assembler.local_ctx,
         payout_tx_value,
+        I256::ZERO,
         None,
     )?;
     let building_duration = building_start.elapsed();

crates/rbuilder/src/building/built_block_trace.rs

@@ -2,7 +2,7 @@ use crate::building::builders::BuiltBlockId;
 
 use super::ExecutionResult;
 use ahash::{AHasher, HashMap, HashSet};
-use alloy_primitives::{Address, TxHash, U256};
+use alloy_primitives::{Address, TxHash, I256, U256};
 use rbuilder_primitives::{
     order_statistics::OrderStatistics, Order, OrderId, OrderReplacementKey, SimulatedOrder,
 };
@@ -18,6 +18,8 @@ pub struct BuiltBlockTrace {
     pub included_orders: Vec<ExecutionResult>,
     /// How much we bid (pay to the validator)
     pub bid_value: U256,
+    /// Subsidy used in the bid.
+    pub subsidy: I256,
     /// coinbase balance delta before the payout tx.
     pub coinbase_reward: U256,
     /// True block value (coinbase balance delta) excluding the cost of the payout to validator
@@ -96,6 +98,7 @@ impl BuiltBlockTrace {
             sent_to_sealer: OffsetDateTime::now_utc(),
             picked_by_sealer_at: OffsetDateTime::now_utc(),
             build_block_id,
+            subsidy: I256::ZERO,
         }
     }
 

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

@@ -1,6 +1,6 @@
 use std::sync::Arc;
 
-use alloy_primitives::{BlockHash, BlockNumber, U256};
+use alloy_primitives::{BlockHash, BlockNumber, I256, U256};
 use bid_scraper::{
     bid_sender::{BidSender, BidSenderError},
     types::ScrapedRelayBlockBid,
@@ -104,6 +104,8 @@ impl BuiltBlockDescriptorForSlotBidder {
 pub struct SlotBidderSealBidCommand {
     pub block_id: BuiltBlockId,
     pub payout_tx_value: U256,
+    /// Subsidy used in the bid.
+    pub subsidy: I256,
     pub seen_competition_bid: Option<U256>,
     /// When this bid is a reaction so some event (eg: new block, new competition bid) we put here
     /// the creation time of that event so we can measure our reaction time.