Merge pull request #227 from ralexstokes/docs-logging

misc clean ups
ralexstokes · May 1, 2024 · 8839751 · 8839751
2 parents a03a230 + cabe308
commit 8839751
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 1 deletion.
diff --git a/mev-boost-rs/src/relay_mux.rs b/mev-boost-rs/src/relay_mux.rs
@@ -200,7 +200,6 @@ impl BlindedBlockProvider for RelayMux {
             return Err(Error::NoBidPrepared(auction_request.clone()))
         }
 
-        // TODO: change `value` so it does the copy internally
         let mut best_bid_indices =
             select_best_bids(bids.iter().map(|(_, bid)| bid.message.value()).enumerate());
 

diff --git a/mev-rs/src/types/auction_request.rs b/mev-rs/src/types/auction_request.rs
@@ -1,11 +1,15 @@
 use ethereum_consensus::primitives::{BlsPublicKey, Hash32, Slot};
 
+/// Describes a single unique auction.
 #[derive(Debug, Default, Clone, PartialEq, Eq, Hash)]
 #[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
 pub struct AuctionRequest {
+    /// Slot for the proposal
     #[serde(with = "crate::serde::as_str")]
     pub slot: Slot,
+    /// Hash of the parent block for the proposal
     pub parent_hash: Hash32,
+    /// Public key of the proposer for the proposal
     pub public_key: BlsPublicKey,
 }