blockworks-foundation
/
solana
mirror of https://github.com/blockworks-foundation/solana.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

doc: ledger: SlotMeta: Clarify `consumed` and `completed_data_indexes` (#29886)

This commit is contained in:
Illia Bobyr 2023-01-26 16:30:09 -08:00 committed by GitHub
parent efb8a53b28
commit 3bd389149c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 19 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
ledger/src/blockstore_meta.rs
View File

@ -50,34 +50,36 @@ impl Default for ConnectedFlags {
} }
#[derive(Clone, Debug, Default, Deserialize, Serialize, Eq, PartialEq)] #[derive(Clone, Debug, Default, Deserialize, Serialize, Eq, PartialEq)]
// The Meta column family /// The Meta column family
pub struct SlotMeta { pub struct SlotMeta {
// The number of slots above the root (the genesis block). The first /// The number of slots above the root (the genesis block). The first
// slot has slot 0. /// slot has slot 0.
pub slot: Slot, pub slot: Slot,
// The total number of consecutive shreds starting from index 0 /// The total number of consecutive shreds starting from index 0 we have received for this slot.
// we have received for this slot. /// At the same time, it is also an index of the first missing shred for this slot, while the
/// slot is incomplete.
pub consumed: u64, pub consumed: u64,
// The index *plus one* of the highest shred received for this slot. Useful /// The index *plus one* of the highest shred received for this slot. Useful
// for checking if the slot has received any shreds yet, and to calculate the /// for checking if the slot has received any shreds yet, and to calculate the
// range where there is one or more holes: `(consumed..received)`. /// range where there is one or more holes: `(consumed..received)`.
pub received: u64, pub received: u64,
// The timestamp of the first time a shred was added for this slot /// The timestamp of the first time a shred was added for this slot
pub first_shred_timestamp: u64, pub first_shred_timestamp: u64,
// The index of the shred that is flagged as the last shred for this slot. /// The index of the shred that is flagged as the last shred for this slot.
// None until the shred with LAST_SHRED_IN_SLOT flag is received. /// None until the shred with LAST_SHRED_IN_SLOT flag is received.
#[serde(with = "serde_compat")] #[serde(with = "serde_compat")]
pub last_index: Option<u64>, pub last_index: Option<u64>,
// The slot height of the block this one derives from. /// The slot height of the block this one derives from.
// The parent slot of the head of a detached chain of slots is None. /// The parent slot of the head of a detached chain of slots is None.
#[serde(with = "serde_compat")] #[serde(with = "serde_compat")]
pub parent_slot: Option<Slot>, pub parent_slot: Option<Slot>,
// The list of slots, each of which contains a block that derives /// The list of slots, each of which contains a block that derives
// from this one. /// from this one.
pub next_slots: Vec<Slot>, pub next_slots: Vec<Slot>,
// Connected status flags of this slot /// Connected status flags of this slot
pub connected_flags: ConnectedFlags, pub connected_flags: ConnectedFlags,
// Shreds indices which are marked data complete. /// Shreds indices which are marked data complete. That is, those that have the
/// [`ShredFlags::DATA_COMPLETE_SHRED`][`crate::shred::ShredFlags::DATA_COMPLETE_SHRED`] set.
pub completed_data_indexes: BTreeSet<u32>, pub completed_data_indexes: BTreeSet<u32>,
} }