Struct ConsensusUpgradableReadLockGuard

pub struct ConsensusUpgradableReadLockGuard<'a, TYPES: NodeType> {
    lock_guard: ManuallyDrop<RwLockUpgradableReadGuard<'a, Consensus<TYPES>>>,
    taken: bool,
}

A thin wrapper around RwLockUpgradableReadGuard for Consensus that leaves debug traces when the lock is freed or upgraded

Fields

lock_guard: ManuallyDrop<RwLockUpgradableReadGuard<'a, Consensus<TYPES>>>

Inner RwLockUpgradableReadGuard

taken: bool

A helper bool to indicate whether inner lock has been unsafely taken or not

Implementations

impl<'a, TYPES: NodeType> ConsensusUpgradableReadLockGuard<'a, TYPES>

pub fn new(lock_guard: RwLockUpgradableReadGuard<'a, Consensus<TYPES>>) -> Self

Creates a new instance of ConsensusUpgradableReadLockGuard with the same name as parent OuterConsensus

pub async fn upgrade(guard: Self) -> ConsensusWriteLockGuard<'a, TYPES>

Upgrades the inner RwLockUpgradableReadGuard and leaves debug traces

Methods from Deref<Target = Consensus<TYPES>>

pub fn cur_view(&self) -> TYPES::View

Get the current view.

pub fn cur_epoch(&self) -> Option<TYPES::Epoch>

Get the current epoch.

pub fn last_decided_view(&self) -> TYPES::View

Get the last decided view.

pub fn locked_view(&self) -> TYPES::View

Get the locked view.

pub fn high_qc(&self) -> &QuorumCertificate2<TYPES>

Get the high QC.

pub fn transition_qc( &self, ) -> Option<&(QuorumCertificate2<TYPES>, NextEpochQuorumCertificate2<TYPES>)>

Get the transition QC.

pub fn state_cert(&self) -> Option<&LightClientStateUpdateCertificate<TYPES>>

Get the current light client state certificate

pub fn next_epoch_high_qc(&self) -> Option<&NextEpochQuorumCertificate2<TYPES>>

Get the next epoch high QC.

pub fn validated_state_map(&self) -> &BTreeMap<TYPES::View, View<TYPES>>

Get the validated state map.

pub fn saved_leaves(&self) -> &CommitmentMap<Leaf2<TYPES>>

Get the saved leaves.

pub fn saved_payloads( &self, ) -> &BTreeMap<TYPES::View, Arc<PayloadWithMetadata<TYPES>>>

Get the saved payloads.

pub fn vid_shares(&self) -> &VidShares<TYPES>

Get the vid shares.

pub fn saved_da_certs(&self) -> &HashMap<TYPES::View, DaCertificate2<TYPES>>

Get the saved DA certs.

pub fn last_proposals( &self, ) -> &BTreeMap<TYPES::View, Proposal<TYPES, QuorumProposalWrapper<TYPES>>>

Get the map of our recent proposals

pub async fn parent_leaf_info( &self, leaf: &Leaf2<TYPES>, public_key: &TYPES::SignatureKey, ) -> Option<LeafInfo<TYPES>>

Get the parent Leaf Info from a given leaf and our public key. Returns None if we don’t have the data in out state

pub fn visit_leaf_ancestors<F>( &self, start_from: TYPES::View, terminator: Terminator<TYPES::View>, ok_when_finished: bool, f: F, ) -> Result<(), HotShotError<TYPES>>

where F: FnMut(&Leaf2<TYPES>, Arc<<TYPES as NodeType>::ValidatedState>, Option<Arc<<<TYPES as NodeType>::ValidatedState as ValidatedState<TYPES>>::Delta>>) -> bool,

gather information from the parent chain of leaves

Errors

If the leaf or its ancestors are not found in storage

pub fn decided_leaf(&self) -> Leaf2<TYPES>

Gets the last decided leaf.

Panics

if the last decided view’s leaf does not exist in the state map or saved leaves, which should never happen.

pub fn undecided_leaves(&self) -> Vec<Leaf2<TYPES>>

pub fn state( &self, view_number: TYPES::View, ) -> Option<&Arc<TYPES::ValidatedState>>

Gets the validated state with the given view number, if in the state map.

pub fn state_and_delta(&self, view_number: TYPES::View) -> StateAndDelta<TYPES>

Gets the validated state and state delta with the given view number, if in the state map.

pub fn decided_state(&self) -> Arc<TYPES::ValidatedState>

Gets the last decided validated state.

Panics

If the last decided view’s state does not exist in the state map, which should never happen.

pub fn is_epoch_transition(&self, leaf_commit: LeafCommitment<TYPES>) -> bool

Returns true if a given leaf is for the epoch transition

pub fn is_high_qc_for_epoch_transition(&self) -> bool

Returns true if our high QC is for one of the epoch transition blocks

pub fn check_eqc( &self, proposed_leaf: &Leaf2<TYPES>, parent_leaf: &Leaf2<TYPES>, ) -> bool

Returns true if the parent_leaf formed an eQC for the previous epoch to the proposed_leaf

pub fn is_high_qc_ge_root_block(&self) -> bool

Returns true if our high QC is for the block equal or greater than the root epoch block

Trait Implementations

impl<TYPES: NodeType> Deref for ConsensusUpgradableReadLockGuard<'_, TYPES>

type Target = Consensus<TYPES>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<TYPES: NodeType> Drop for ConsensusUpgradableReadLockGuard<'_, TYPES>

fn drop(&mut self)

Executes the destructor for this type.