Struct hotshot::HotShotInitializer

pub struct HotShotInitializer<TYPES: NodeType> {

    pub instance_state: TYPES::InstanceState,
    pub epoch_height: u64,
    pub anchor_leaf: Leaf2<TYPES>,
    pub anchor_state: Arc<TYPES::ValidatedState>,
    pub anchor_state_delta: Option<Arc<<TYPES::ValidatedState as ValidatedState<TYPES>>::Delta>>,
    pub start_view: TYPES::View,
    pub last_actioned_view: TYPES::View,
    pub start_epoch: Option<TYPES::Epoch>,
    pub high_qc: QuorumCertificate2<TYPES>,
    pub next_epoch_high_qc: Option<NextEpochQuorumCertificate2<TYPES>>,
    pub saved_proposals: BTreeMap<TYPES::View, Proposal<TYPES, QuorumProposalWrapper<TYPES>>>,
    pub decided_upgrade_certificate: Option<UpgradeCertificate<TYPES>>,
    pub undecided_leaves: BTreeMap<TYPES::View, Leaf2<TYPES>>,
    pub undecided_state: BTreeMap<TYPES::View, View<TYPES>>,
    pub saved_vid_shares: VidShares<TYPES>,
}

initializer struct for creating starting block

Fields

instance_state: TYPES::InstanceState

Instance-level state.

epoch_height: u64

Epoch height

anchor_leaf: Leaf2<TYPES>

the anchor leaf for the hotshot initializer

anchor_state: Arc<TYPES::ValidatedState>

ValidatedState for the anchor leaf

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

ValidatedState::Delta for the anchor leaf, optional.

start_view: TYPES::View

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

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.

start_epoch: Option<TYPES::Epoch>

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

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.

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

Proposals we have sent out to provide to others for catchup

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: BTreeMap<TYPES::View, 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_vid_shares: VidShares<TYPES>

Saved VID shares

Implementations

impl<TYPES: NodeType> HotShotInitializer<TYPES>

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

initialize from genesis

Errors

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

pub fn update_undecided(self) -> Self

Use saved proposals to update undecided leaves and state

pub fn load( instance_state: TYPES::InstanceState, epoch_height: u64, anchor_leaf: Leaf2<TYPES>, (start_view, start_epoch): (TYPES::View, Option<TYPES::Epoch>), (high_qc, next_epoch_high_qc): (QuorumCertificate2<TYPES>, Option<NextEpochQuorumCertificate2<TYPES>>), saved_proposals: BTreeMap<TYPES::View, Proposal<TYPES, QuorumProposalWrapper<TYPES>>>, saved_vid_shares: VidShares<TYPES>, decided_upgrade_certificate: Option<UpgradeCertificate<TYPES>>, ) -> Self

Create a HotShotInitializer from the given information.

This function uses the anchor leaf to set the initial validated state, and populates undecided_leaves and undecided_state using saved_proposals.

If you are able to or would prefer to set these yourself, you should use the HotShotInitializer constructor directly.

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.