Struct hotshot_types::consensus::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) -> 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 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<[u8]>>

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, QuorumProposal2<TYPES>>>

Get the map of our recent proposals

pub 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 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_qc_forming_eqc(&self, qc: &QuorumCertificate2<TYPES>) -> bool

Return true if the QC takes part in forming an eQC, i.e. it is one of the 3-chain certificates but not the eQC itself

pub fn is_high_qc_forming_eqc(&self) -> bool

Returns true if our high qc is forming an eQC

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

Return true if the given leaf takes part in forming an eQC, i.e. it is one of the 3-chain leaves but not the eQC leaf itself

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

Returns true if the given leaf can form an extended Quorum Certificate The Extended Quorum Certificate (eQC) is the third Quorum Certificate formed in three consecutive views for the last block in the epoch.

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

Returns true if a given leaf is for the last block in the epoch

pub fn is_high_qc_for_last_block(&self) -> bool

Returns true if our high QC is for the last block in the epoch

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

Trait Implementations

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

fn drop(&mut self)

Executes the destructor for this type.

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

type Target = Consensus<TYPES>

The resulting type after dereferencing.

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

Dereferences the value.