Skip to content

Commit

Permalink
cleanup
Browse files Browse the repository at this point in the history
  • Loading branch information
pawanjay176 committed Sep 4, 2024
1 parent e71020e commit 52bb581
Show file tree
Hide file tree
Showing 5 changed files with 30 additions and 12 deletions.
5 changes: 3 additions & 2 deletions beacon_node/beacon_chain/src/kzg_utils.rs
Original file line number Diff line number Diff line change
Expand Up @@ -188,8 +188,9 @@ fn build_data_column_sidecars<E: EthSpec>(
spec: &ChainSpec,
) -> Result<DataColumnSidecarList<E>, String> {
let number_of_columns = spec.number_of_columns;
let max_blobs_per_block =
spec.max_blobs_per_block(signed_block_header.message.slot.epoch(E::slots_per_epoch())) as usize;
let max_blobs_per_block = spec
.max_blobs_per_block(signed_block_header.message.slot.epoch(E::slots_per_epoch()))
as usize;
let mut columns = vec![Vec::with_capacity(max_blobs_per_block); number_of_columns];
let mut column_kzg_proofs = vec![Vec::with_capacity(max_blobs_per_block); number_of_columns];

Expand Down
8 changes: 4 additions & 4 deletions beacon_node/lighthouse_network/src/rpc/methods.rs
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ pub const MAX_ERROR_LEN: u64 = 256;
/// The max number of blobs we expect in the configs to set for compile time params.
/// Note: This value is an estimate that we should use only for rate limiting,
/// bounds checking and other non-consensus critical operations.
///
///
/// For exact value, we should always check the chainspec.
pub const MAX_BLOBS_PER_BLOCK_CEILING: u64 = 16;

Expand Down Expand Up @@ -335,11 +335,11 @@ pub struct BlobsByRangeRequest {
impl BlobsByRangeRequest {
/// This function provides an upper bound on number of blobs expected in
/// a certain slot range.
///
///
/// Note: **must not** use for anything consensus critical, only for
/// bounds checking and rate limiting.
/// bounds checking and rate limiting.
pub fn max_blobs_requested<E: EthSpec>(&self) -> u64 {
self.count.saturating_mul(MAX_BLOBS_PER_BLOCK_CEILING as u64)
self.count.saturating_mul(MAX_BLOBS_PER_BLOCK_CEILING)
}
}

Expand Down
4 changes: 2 additions & 2 deletions beacon_node/network/src/sync/network_context.rs
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,8 @@ use std::time::Duration;
use tokio::sync::mpsc;
use types::blob_sidecar::FixedBlobSidecarList;
use types::{
BlobSidecar, ColumnIndex, DataColumnSidecar, DataColumnSidecarList, EthSpec,
Hash256, SignedBeaconBlock, Slot,
BlobSidecar, ColumnIndex, DataColumnSidecar, DataColumnSidecarList, EthSpec, Hash256,
SignedBeaconBlock, Slot,
};

pub mod custody;
Expand Down
2 changes: 1 addition & 1 deletion consensus/types/src/blob_sidecar.rs
Original file line number Diff line number Diff line change
Expand Up @@ -265,7 +265,7 @@ impl<E: EthSpec> BlobSidecar<E> {
}

pub type BlobSidecarList<E> = RuntimeVariableList<Arc<BlobSidecar<E>>>;
/// Alias for a non length-constrained list of `BlobSidecar`s.
/// Alias for a non length-constrained list of `BlobSidecar`s.
pub type FixedBlobSidecarList<E> = RuntimeFixedList<Option<Arc<BlobSidecar<E>>>>;
pub type BlobsList<E> = VariableList<Blob<E>, <E as EthSpec>::MaxBlobCommitmentsPerBlock>;

Expand Down
23 changes: 20 additions & 3 deletions consensus/types/src/runtime_var_list.rs
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,11 @@ use std::slice::SliceIndex;
/// An ordered, heap-allocated, variable-length, homogeneous collection of `T`, with no more than
/// `max_len` values.
///
/// In cases where the `max_length` of the container is unknown at time of initialization, we provide
/// a `Self::empty_uninitialized` constructor that initializes a runtime list without setting the max_len.
///
/// To ensure there are no inconsistent states, we do not allow any mutating operation if `max_len` is not set.
///
/// ## Example
///
/// ```
Expand All @@ -35,6 +40,16 @@ use std::slice::SliceIndex;
///
/// // Push a value to if it _does_ exceed the maximum.
/// assert!(long.push(6).is_err());
///
/// let mut uninit = RuntimeVariableList::empty_unitialized();
/// assert!(uninit.push(5).is_err());
///
/// // Set max_len to allow mutation.
/// uninit.set_max_len(5usize);
///
/// uninit.push(5).unwrap();
/// assert_eq!(&uninit[..], &[5]);
///
/// ```
#[derive(Debug, Clone, Serialize, Deserialize, Derivative)]
#[derivative(PartialEq, Eq, Hash(bound = "T: std::hash::Hash"))]
Expand Down Expand Up @@ -73,7 +88,7 @@ impl<T> RuntimeVariableList<T> {
}
}

/// Create an empty list.
/// Create an empty list with the given `max_len`.
pub fn empty(max_len: usize) -> Self {
Self {
vec: vec![],
Expand All @@ -95,7 +110,7 @@ impl<T> RuntimeVariableList<T> {
/// Returns an instance of `Self` with max_len = None.
///
/// No mutating operation can be performed on an uninitialized instance
/// without first setting max_len.
/// without first setting `max_len`.
pub fn empty_uninitialized() -> Self {
Self {
vec: vec![],
Expand Down Expand Up @@ -129,7 +144,7 @@ impl<T> RuntimeVariableList<T> {
/// Returns `Err(())` when appending `value` would exceed the maximum length.
pub fn push(&mut self, value: T) -> Result<(), Error> {
let Some(max_len) = self.max_len else {
// TODO(pawan): set a better error
// TODO(pawan): set a better error?
return Err(Error::MissingLengthInformation);
};
if self.vec.len() < max_len {
Expand Down Expand Up @@ -247,6 +262,7 @@ where
}
}

/// Emulates a SSZ `Vector`.
#[derive(Clone, Debug)]
pub struct RuntimeFixedList<T> {
vec: Vec<T>,
Expand All @@ -267,6 +283,7 @@ impl<T: Clone + Default> RuntimeFixedList<T> {
self.vec.as_slice()
}

#[allow(clippy::len_without_is_empty)]
pub fn len(&self) -> usize {
self.len
}
Expand Down

0 comments on commit 52bb581

Please sign in to comment.