Block processing cleanup (#4153)

* Implements Ord for BlobSidecar based on index

* Use BTreeMap for gossip cache to maintain blob order by index

* fmt

* Another panic fix

beacon_node/beacon_chain/src/blob_verification.rs

@@ -263,11 +263,26 @@ pub fn validate_blob_sidecar_for_gossip<T: BeaconChainTypes>(
     })
 }
 
-#[derive(Debug, Clone)]
+/// Wrapper over a `BlobSidecar` for which we have completed kzg verification.
+/// i.e. `verify_blob_kzg_proof(blob, commitment, proof) == true`.
+#[derive(Debug, Derivative, Clone)]
+#[derivative(PartialEq, Eq)]
 pub struct KzgVerifiedBlob<T: EthSpec> {
     blob: Arc<BlobSidecar<T>>,
 }
 
+impl<T: EthSpec> PartialOrd for KzgVerifiedBlob<T> {
+    fn partial_cmp(&self, other: &Self) -> Option<std::cmp::Ordering> {
+        self.blob.partial_cmp(&other.blob)
+    }
+}
+
+impl<T: EthSpec> Ord for KzgVerifiedBlob<T> {
+    fn cmp(&self, other: &Self) -> std::cmp::Ordering {
+        self.blob.cmp(&other.blob)
+    }
+}
+
 impl<T: EthSpec> KzgVerifiedBlob<T> {
     pub fn to_blob(self) -> Arc<BlobSidecar<T>> {
         self.blob
@@ -284,8 +299,14 @@ impl<T: EthSpec> KzgVerifiedBlob<T> {
     pub fn block_root(&self) -> Hash256 {
         self.blob.block_root
     }
+    pub fn blob_index(&self) -> u64 {
+        self.blob.index
+    }
 }
 
+/// Complete kzg verification for a `GossipVerifiedBlob`.
+///
+/// Returns an error if the kzg verification check fails.
 pub fn verify_kzg_for_blob<T: EthSpec>(
     blob: GossipVerifiedBlob<T>,
     kzg: &Kzg,
@@ -305,6 +326,11 @@ pub fn verify_kzg_for_blob<T: EthSpec>(
     }
 }
 
+/// Complete kzg verification for a list of `BlobSidecar`s.
+/// Returns an error if any of the `BlobSidecar`s fails kzg verification.
+///
+/// Note: This function should be preferred over calling `verify_kzg_for_blob`
+/// in a loop since this function kzg verifies a list of blobs more efficiently.
 pub fn verify_kzg_for_blob_list<T: EthSpec>(
     blob_list: BlobSidecarList<T>,
     kzg: &Kzg,
@@ -344,6 +370,7 @@ pub enum MaybeAvailableBlock<E: EthSpec> {
     AvailabilityPending(AvailabilityPendingBlock<E>),
 }
 
+/// Trait for common block operations.
 pub trait AsBlock<E: EthSpec> {
     fn slot(&self) -> Slot;
     fn epoch(&self) -> Epoch;

beacon_node/beacon_chain/src/block_verification.rs

@@ -784,14 +784,14 @@ impl<E: EthSpec> AvailabilityPendingExecutedBlock<E> {
         self.get_filtered_blob_ids(|_| true)
     }
 
-    pub fn get_filtered_blob_ids(&self, filter: impl Fn(usize) -> bool) -> Vec<BlobIdentifier> {
+    pub fn get_filtered_blob_ids(&self, filter: impl Fn(u64) -> bool) -> Vec<BlobIdentifier> {
         let num_blobs_expected = self.num_blobs_expected();
         let mut blob_ids = Vec::with_capacity(num_blobs_expected);
-        for i in 0..num_blobs_expected {
+        for i in 0..num_blobs_expected as u64 {
             if filter(i) {
                 blob_ids.push(BlobIdentifier {
                     block_root: self.import_data.block_root,
-                    index: i as u64,
+                    index: i,
                 });
             }
         }

beacon_node/beacon_chain/src/data_availability_checker.rs

@@ -11,7 +11,7 @@ use slot_clock::SlotClock;
 use ssz_types::{Error, VariableList};
 use state_processing::per_block_processing::deneb::deneb::verify_kzg_commitments_against_transactions;
 use std::collections::hash_map::{Entry, OccupiedEntry};
-use std::collections::HashMap;
+use std::collections::{BTreeMap, HashMap};
 use std::sync::Arc;
 use types::beacon_block_body::KzgCommitments;
 use types::blob_sidecar::{BlobIdentifier, BlobSidecar};
@@ -54,37 +54,51 @@ impl From<ssz_types::Error> for AvailabilityCheckError {
 ///  - blocks that have been fully verified and only require a data availability check
 pub struct DataAvailabilityChecker<T: EthSpec, S: SlotClock> {
     rpc_blob_cache: RwLock<HashMap<BlobIdentifier, Arc<BlobSidecar<T>>>>,
-    gossip_blob_cache: Mutex<HashMap<Hash256, GossipBlobCache<T>>>,
+    gossip_availability_cache: Mutex<HashMap<Hash256, GossipAvailabilityCache<T>>>,
     slot_clock: S,
     kzg: Option<Arc<Kzg>>,
     spec: ChainSpec,
 }
 
-struct GossipBlobCache<T: EthSpec> {
+/// Caches partially available blobs and execution verified blocks corresponding
-    verified_blobs: Vec<KzgVerifiedBlob<T>>,
+/// to a given `block_hash` that are received over gossip.
+///
+/// The blobs are all gossip and kzg verified.
+/// The block has completed all verifications except the availability check.
+struct GossipAvailabilityCache<T: EthSpec> {
+    /// We use a `BTreeMap` here to maintain the order of `BlobSidecar`s based on index.
+    verified_blobs: BTreeMap<u64, KzgVerifiedBlob<T>>,
     executed_block: Option<AvailabilityPendingExecutedBlock<T>>,
 }
 
-impl<T: EthSpec> GossipBlobCache<T> {
+impl<T: EthSpec> GossipAvailabilityCache<T> {
     fn new_from_blob(blob: KzgVerifiedBlob<T>) -> Self {
+        let mut verified_blobs = BTreeMap::new();
+        verified_blobs.insert(blob.blob_index(), blob);
         Self {
-            verified_blobs: vec![blob],
+            verified_blobs,
             executed_block: None,
         }
     }
 
     fn new_from_block(block: AvailabilityPendingExecutedBlock<T>) -> Self {
         Self {
-            verified_blobs: vec![],
+            verified_blobs: BTreeMap::new(),
             executed_block: Some(block),
         }
     }
 
+    /// Returns `true` if the cache has all blobs corresponding to the
+    /// kzg commitments in the block.
     fn has_all_blobs(&self, block: &AvailabilityPendingExecutedBlock<T>) -> bool {
         self.verified_blobs.len() == block.num_blobs_expected()
     }
 }
 
+/// This type is returned after adding a block / blob to the `DataAvailabilityChecker`.
+///
+/// Indicates if the block is fully `Available` or if we need blobs or blocks
+///  to "complete" the requirements for an `AvailableBlock`.
 pub enum Availability<T: EthSpec> {
     PendingBlobs(Vec<BlobIdentifier>),
     PendingBlock(Hash256),
@@ -92,6 +106,8 @@ pub enum Availability<T: EthSpec> {
 }
 
 impl<T: EthSpec> Availability<T> {
+    /// Returns all the blob identifiers associated with an  `AvailableBlock`.
+    /// Returns `None` if avaiability hasn't been fully satisfied yet.
     pub fn get_available_blob_ids(&self) -> Option<Vec<BlobIdentifier>> {
         if let Self::Available(block) = self {
             Some(block.get_all_blob_ids())
@@ -105,7 +121,7 @@ impl<T: EthSpec, S: SlotClock> DataAvailabilityChecker<T, S> {
     pub fn new(slot_clock: S, kzg: Option<Arc<Kzg>>, spec: ChainSpec) -> Self {
         Self {
             rpc_blob_cache: <_>::default(),
-            gossip_blob_cache: <_>::default(),
+            gossip_availability_cache: <_>::default(),
             slot_clock,
             kzg,
             spec,
@@ -117,9 +133,9 @@ impl<T: EthSpec, S: SlotClock> DataAvailabilityChecker<T, S> {
         self.rpc_blob_cache.read().get(blob_id).cloned()
     }
 
-    /// This first validate the KZG commitments included in the blob sidecar.
+    /// This first validates the KZG commitments included in the blob sidecar.
     /// Check if we've cached other blobs for this block. If it completes a set and we also
-    /// have a block cached, return the Availability variant triggering block import.
+    /// have a block cached, return the `Availability` variant triggering block import.
     /// Otherwise cache the blob sidecar.
     ///
     /// This should only accept gossip verified blobs, so we should not have to worry about dupes.
@@ -138,7 +154,7 @@ impl<T: EthSpec, S: SlotClock> DataAvailabilityChecker<T, S> {
 
         let blob = kzg_verified_blob.clone_blob();
 
-        let mut blob_cache = self.gossip_blob_cache.lock();
+        let mut blob_cache = self.gossip_availability_cache.lock();
 
         // Gossip cache.
         let availability = match blob_cache.entry(blob.block_root) {
@@ -149,7 +165,7 @@ impl<T: EthSpec, S: SlotClock> DataAvailabilityChecker<T, S> {
 
                 cache
                     .verified_blobs
-                    .insert(blob.index as usize, kzg_verified_blob);
+                    .insert(kzg_verified_blob.blob_index(), kzg_verified_blob);
 
                 if let Some(executed_block) = cache.executed_block.take() {
                     self.check_block_availability_maybe_cache(occupied_entry, executed_block)?
@@ -159,7 +175,7 @@ impl<T: EthSpec, S: SlotClock> DataAvailabilityChecker<T, S> {
             }
             Entry::Vacant(vacant_entry) => {
                 let block_root = kzg_verified_blob.block_root();
-                vacant_entry.insert(GossipBlobCache::new_from_blob(kzg_verified_blob));
+                vacant_entry.insert(GossipAvailabilityCache::new_from_blob(kzg_verified_blob));
                 Availability::PendingBlock(block_root)
             }
         };
@@ -181,7 +197,7 @@ impl<T: EthSpec, S: SlotClock> DataAvailabilityChecker<T, S> {
         &self,
         executed_block: AvailabilityPendingExecutedBlock<T>,
     ) -> Result<Availability<T>, AvailabilityCheckError> {
-        let mut guard = self.gossip_blob_cache.lock();
+        let mut guard = self.gossip_availability_cache.lock();
         let entry = guard.entry(executed_block.import_data.block_root);
 
         let availability = match entry {
@@ -190,7 +206,7 @@ impl<T: EthSpec, S: SlotClock> DataAvailabilityChecker<T, S> {
             }
             Entry::Vacant(vacant_entry) => {
                 let all_blob_ids = executed_block.get_all_blob_ids();
-                vacant_entry.insert(GossipBlobCache::new_from_block(executed_block));
+                vacant_entry.insert(GossipAvailabilityCache::new_from_block(executed_block));
                 Availability::PendingBlobs(all_blob_ids)
             }
         };
@@ -204,9 +220,16 @@ impl<T: EthSpec, S: SlotClock> DataAvailabilityChecker<T, S> {
         Ok(availability)
     }
 
+    /// Checks if the provided `executed_block` contains all required blobs to be considered an
+    /// `AvailableBlock` based on blobs that are cached.
+    ///
+    /// Returns an error if there was an error when matching the block commitments against blob commitments.
+    ///
+    /// Returns `Ok(Availability::Available(_))` if all blobs for the block are present in cache.
+    /// Returns `Ok(Availability::PendingBlobs(_))` if all corresponding blobs have not been received in the cache.
     fn check_block_availability_maybe_cache(
         &self,
-        mut occupied_entry: OccupiedEntry<Hash256, GossipBlobCache<T>>,
+        mut occupied_entry: OccupiedEntry<Hash256, GossipAvailabilityCache<T>>,
         executed_block: AvailabilityPendingExecutedBlock<T>,
     ) -> Result<Availability<T>, AvailabilityCheckError> {
         if occupied_entry.get().has_all_blobs(&executed_block) {
@@ -216,9 +239,13 @@ impl<T: EthSpec, S: SlotClock> DataAvailabilityChecker<T, S> {
                 payload_verification_outcome,
             } = executed_block;
 
-            let cache = occupied_entry.remove();
+            let GossipAvailabilityCache {
+                verified_blobs,
+                executed_block: _,
+            } = occupied_entry.remove();
+            let verified_blobs = verified_blobs.into_values().collect();
 
-            let available_block = self.make_available(block, cache.verified_blobs)?;
+            let available_block = self.make_available(block, verified_blobs)?;
             Ok(Availability::Available(Box::new(
                 AvailableExecutedBlock::new(
                     available_block,
@@ -227,18 +254,18 @@ impl<T: EthSpec, S: SlotClock> DataAvailabilityChecker<T, S> {
                 ),
             )))
         } else {
-            let cache = occupied_entry.get_mut();
+            let cached_entry = occupied_entry.get_mut();
 
             let missing_blob_ids = executed_block
-                .get_filtered_blob_ids(|index| cache.verified_blobs.get(index).is_none());
+                .get_filtered_blob_ids(|index| cached_entry.verified_blobs.get(&index).is_none());
 
-            let _ = cache.executed_block.insert(executed_block);
+            let _ = cached_entry.executed_block.insert(executed_block);
 
             Ok(Availability::PendingBlobs(missing_blob_ids))
         }
     }
 
-    /// Checks if a block is available, returns a MaybeAvailableBlock enum that may include the fully
+    /// Checks if a block is available, returns a `MaybeAvailableBlock` that may include the fully
     /// available block.
     pub fn check_availability(
         &self,
@@ -321,11 +348,11 @@ impl<T: EthSpec, S: SlotClock> DataAvailabilityChecker<T, S> {
 
     /// Verifies an AvailabilityPendingBlock against a set of KZG verified blobs.
     /// This does not check whether a block *should* have blobs, these checks should must have been
-    /// completed when producing the AvailabilityPendingBlock.
+    /// completed when producing the `AvailabilityPendingBlock`.
     pub fn make_available(
         &self,
         block: AvailabilityPendingBlock<T>,
-        blobs: KzgVerifiedBlobList<T>,
+        blobs: Vec<KzgVerifiedBlob<T>>,
     ) -> Result<AvailableBlock<T>, AvailabilityCheckError> {
         let block_kzg_commitments = block.kzg_commitments()?;
         if blobs.len() != block_kzg_commitments.len() {
@@ -428,6 +455,12 @@ pub enum BlobRequirements {
     PreDeneb,
 }
 
+/// A wrapper over a `SignedBeaconBlock` where we have not verified availability of
+/// corresponding `BlobSidecar`s and hence, is not ready for import into fork choice.
+///
+/// Note: This wrapper does not necessarily correspond to a pre-deneb block as a pre-deneb
+/// block that is ready for import will be of type `AvailableBlock` with its `blobs` field
+/// set to `VerifiedBlobs::PreDeneb`.
 #[derive(Clone, Debug, PartialEq)]
 pub struct AvailabilityPendingBlock<E: EthSpec> {
     block: Arc<SignedBeaconBlock<E>>,
@@ -452,6 +485,20 @@ impl<E: EthSpec> AvailabilityPendingBlock<E> {
     }
 }
 
+#[derive(Clone, Debug, PartialEq)]
+pub enum VerifiedBlobs<E: EthSpec> {
+    /// These blobs are available.
+    Available(BlobSidecarList<E>),
+    /// This block is from outside the data availability boundary so doesn't require
+    /// a data availability check.
+    NotRequired,
+    /// The block's `kzg_commitments` field is empty so it does not contain any blobs.
+    EmptyBlobs,
+    /// This is a block prior to the 4844 fork, so doesn't require any blobs
+    PreDeneb,
+}
+
+/// A fully available block that is ready to be imported into fork choice.
 #[derive(Clone, Debug, PartialEq)]
 pub struct AvailableBlock<E: EthSpec> {
     block: Arc<SignedBeaconBlock<E>>,
@@ -473,19 +520,6 @@ impl<E: EthSpec> AvailableBlock<E> {
     }
 }
 
-#[derive(Clone, Debug, PartialEq)]
-pub enum VerifiedBlobs<E: EthSpec> {
-    /// These blobs are available.
-    Available(BlobSidecarList<E>),
-    /// This block is from outside the data availability boundary so doesn't require
-    /// a data availability check.
-    NotRequired,
-    /// The block's `kzg_commitments` field is empty so it does not contain any blobs.
-    EmptyBlobs,
-    /// This is a block prior to the 4844 fork, so doesn't require any blobs
-    PreDeneb,
-}
-
 impl<E: EthSpec> AsBlock<E> for AvailableBlock<E> {
     fn slot(&self) -> Slot {
         self.block.slot()

beacon_node/lighthouse_network/src/types/pubsub.rs

@@ -12,7 +12,7 @@ use types::{
     Attestation, AttesterSlashing, EthSpec, ForkContext, ForkName, LightClientFinalityUpdate,
     LightClientOptimisticUpdate, ProposerSlashing, SignedAggregateAndProof, SignedBeaconBlock,
     SignedBeaconBlockAltair, SignedBeaconBlockBase, SignedBeaconBlockCapella,
-    SignedBeaconBlockMerge, SignedBlobSidecar, SignedBlsToExecutionChange,
+    SignedBeaconBlockDeneb, SignedBeaconBlockMerge, SignedBlobSidecar, SignedBlsToExecutionChange,
     SignedContributionAndProof, SignedVoluntaryExit, SubnetId, SyncCommitteeMessage, SyncSubnetId,
 };
 
@@ -184,16 +184,14 @@ impl<T: EthSpec> PubsubMessage<T> {
                                     SignedBeaconBlockMerge::from_ssz_bytes(data)
                                         .map_err(|e| format!("{:?}", e))?,
                                 ),
-                                Some(ForkName::Deneb) => {
-                                    return Err(
-                                        "beacon_block topic is not used from deneb fork onwards"
-                                            .to_string(),
-                                    )
-                                }
                                 Some(ForkName::Capella) => SignedBeaconBlock::<T>::Capella(
                                     SignedBeaconBlockCapella::from_ssz_bytes(data)
                                         .map_err(|e| format!("{:?}", e))?,
                                 ),
+                                Some(ForkName::Deneb) => SignedBeaconBlock::<T>::Deneb(
+                                    SignedBeaconBlockDeneb::from_ssz_bytes(data)
+                                        .map_err(|e| format!("{:?}", e))?,
+                                ),
                                 None => {
                                     return Err(format!(
                                         "Unknown gossipsub fork digest: {:?}",

consensus/types/src/blob_sidecar.rs

@@ -17,6 +17,18 @@ pub struct BlobIdentifier {
     pub index: u64,
 }
 
+impl PartialOrd for BlobIdentifier {
+    fn partial_cmp(&self, other: &Self) -> Option<std::cmp::Ordering> {
+        self.index.partial_cmp(&other.index)
+    }
+}
+
+impl Ord for BlobIdentifier {
+    fn cmp(&self, other: &Self) -> std::cmp::Ordering {
+        self.index.cmp(&other.index)
+    }
+}
+
 #[derive(
     Debug,
     Clone,
@@ -32,7 +44,7 @@ pub struct BlobIdentifier {
 )]
 #[serde(bound = "T: EthSpec")]
 #[arbitrary(bound = "T: EthSpec")]
-#[derivative(PartialEq, Hash(bound = "T: EthSpec"))]
+#[derivative(PartialEq, Eq, Hash(bound = "T: EthSpec"))]
 pub struct BlobSidecar<T: EthSpec> {
     pub block_root: Hash256,
     #[serde(with = "eth2_serde_utils::quoted_u64")]
@@ -47,6 +59,18 @@ pub struct BlobSidecar<T: EthSpec> {
     pub kzg_proof: KzgProof,
 }
 
+impl<T: EthSpec> PartialOrd for BlobSidecar<T> {
+    fn partial_cmp(&self, other: &Self) -> Option<std::cmp::Ordering> {
+        self.index.partial_cmp(&other.index)
+    }
+}
+
+impl<T: EthSpec> Ord for BlobSidecar<T> {
+    fn cmp(&self, other: &Self) -> std::cmp::Ordering {
+        self.index.cmp(&other.index)
+    }
+}
+
 pub type BlobSidecarList<T> = VariableList<Arc<BlobSidecar<T>>, <T as EthSpec>::MaxBlobsPerBlock>;
 pub type Blobs<T> = VariableList<Blob<T>, <T as EthSpec>::MaxExtraDataBytes>;