Struct hotshot_task_impls::helpers::LeafChainTraversalOutcome

pub struct LeafChainTraversalOutcome<TYPES: NodeType> {
    pub new_locked_view_number: Option<TYPES::View>,
    pub new_decided_view_number: Option<TYPES::View>,
    pub new_decide_qc: Option<QuorumCertificate2<TYPES>>,
    pub leaf_views: Vec<LeafInfo<TYPES>>,
    pub included_txns: Option<HashSet<Commitment<<TYPES as NodeType>::Transaction>>>,
    pub decided_upgrade_cert: Option<UpgradeCertificate<TYPES>>,
}

Helper type to give names and to the output values of the leaf chain traversal operation.

Fields

new_locked_view_number: Option<TYPES::View>

The new locked view obtained from a 2 chain starting from the proposal’s parent.

new_decided_view_number: Option<TYPES::View>

The new decided view obtained from a 3 chain starting from the proposal’s parent.

new_decide_qc: Option<QuorumCertificate2<TYPES>>

The qc for the decided chain.

leaf_views: Vec<LeafInfo<TYPES>>

The decided leaves with corresponding validated state and VID info.

included_txns: Option<HashSet<Commitment<<TYPES as NodeType>::Transaction>>>

The transactions in the block payload for each leaf.

decided_upgrade_cert: Option<UpgradeCertificate<TYPES>>

The most recent upgrade certificate from one of the leaves.

Trait Implementations

impl<TYPES: Debug + NodeType> Debug for LeafChainTraversalOutcome<TYPES>

where TYPES::View: Debug,

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<TYPES: NodeType + Default> Default for LeafChainTraversalOutcome<TYPES>

We need Default to be implemented because the leaf ascension has very few failure branches, and when they do happen, we still return intermediate states. Default makes the burden of filling values easier.

fn default() -> Self

The default method for this type is to set all of the returned values to None.