Struct hotshot::HotShotInitializer

pub struct HotShotInitializer<TYPES: NodeType> {

    pub(crate) inner: Leaf2<TYPES>,
    pub(crate) instance_state: TYPES::InstanceState,
    pub(crate) validated_state: Option<Arc<TYPES::ValidatedState>>,
    pub(crate) state_delta: Option<Arc<<TYPES::ValidatedState as ValidatedState<TYPES>>::Delta>>,
    pub(crate) start_view: TYPES::View,
    pub(crate) start_epoch: TYPES::Epoch,
    pub(crate) actioned_view: TYPES::View,
    pub(crate) high_qc: QuorumCertificate2<TYPES>,
    pub(crate) next_epoch_high_qc: Option<NextEpochQuorumCertificate2<TYPES>>,
    pub(crate) decided_upgrade_certificate: Option<UpgradeCertificate<TYPES>>,
    pub(crate) undecided_leaves: Vec<Leaf2<TYPES>>,
    pub(crate) undecided_state: BTreeMap<TYPES::View, View<TYPES>>,
    pub(crate) saved_proposals: BTreeMap<TYPES::View, Proposal<TYPES, QuorumProposal2<TYPES>>>,
}

initializer struct for creating starting block

Fields

inner: Leaf2<TYPES>

the leaf specified initialization

instance_state: TYPES::InstanceState

Instance-level state.

validated_state: Option<Arc<TYPES::ValidatedState>>

Optional validated state.

If it’s given, we’ll use it to construct the SystemContext. Otherwise, we’ll construct the state from the block header.

state_delta: Option<Arc<<TYPES::ValidatedState as ValidatedState<TYPES>>::Delta>>

Optional state delta.

If it’s given, we’ll use it to construct the SystemContext.

start_view: TYPES::View

Starting view number that should be equivalent to the view the node shut down with last.

start_epoch: TYPES::Epoch

Starting epoch number that should be equivalent to the epoch the node shut down with last.

actioned_view: TYPES::View

The view we last performed an action in. An action is Proposing or voting for Either the quorum or DA.

high_qc: QuorumCertificate2<TYPES>

Highest QC that was seen, for genesis it’s the genesis QC. It should be for a view greater than inners view number for the non genesis case because we must have seen higher QCs to decide on the leaf.

next_epoch_high_qc: Option<NextEpochQuorumCertificate2<TYPES>>

Next epoch highest QC that was seen. This is needed to propose during epoch transition after restart.

decided_upgrade_certificate: Option<UpgradeCertificate<TYPES>>

Previously decided upgrade certificate; this is necessary if an upgrade has happened and we are not restarting with the new version

undecided_leaves: Vec<Leaf2<TYPES>>

Undecided leaves that were seen, but not yet decided on. These allow a restarting node to vote and propose right away if they didn’t miss anything while down.

undecided_state: BTreeMap<TYPES::View, View<TYPES>>

Not yet decided state

saved_proposals: BTreeMap<TYPES::View, Proposal<TYPES, QuorumProposal2<TYPES>>>

Proposals we have sent out to provide to others for catchup

Implementations

impl<TYPES: NodeType> HotShotInitializer<TYPES>

pub async fn from_genesis<V: Versions>( instance_state: TYPES::InstanceState, ) -> Result<Self, HotShotError<TYPES>>

initialize from genesis

Errors

If we are unable to apply the genesis block to the default state

pub fn from_reload( anchor_leaf: Leaf2<TYPES>, instance_state: TYPES::InstanceState, validated_state: Option<Arc<TYPES::ValidatedState>>, start_view: TYPES::View, start_epoch: TYPES::Epoch, actioned_view: TYPES::View, saved_proposals: BTreeMap<TYPES::View, Proposal<TYPES, QuorumProposal2<TYPES>>>, high_qc: QuorumCertificate2<TYPES>, next_epoch_high_qc: Option<NextEpochQuorumCertificate2<TYPES>>, decided_upgrade_certificate: Option<UpgradeCertificate<TYPES>>, undecided_leaves: Vec<Leaf2<TYPES>>, undecided_state: BTreeMap<TYPES::View, View<TYPES>>, ) -> Self

Reload previous state based on most recent leaf and the instance-level state.

Arguments

• start_view - The minimum view number that we are confident won’t lead to a double vote after restart.
• validated_state - Optional validated state that if given, will be used to construct the SystemContext.

Trait Implementations

impl<TYPES: Clone + NodeType> Clone for HotShotInitializer<TYPES>

where TYPES::InstanceState: Clone, TYPES::ValidatedState: Clone, TYPES::View: Clone, TYPES::Epoch: Clone,

fn clone(&self) -> HotShotInitializer<TYPES>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.