Struct HotShotInitializer 

pub struct HotShotInitializer<TYPES: NodeType> {
    instance_state: TYPES::InstanceState,
    epoch_height: u64,
    anchor_leaf: Leaf2<TYPES>,
    anchor_state: Arc<TYPES::ValidatedState>,
    start_view: ViewNumber,
    last_actioned_view: ViewNumber,
    high_qc: QuorumCertificate2<TYPES>,
    saved_proposals: BTreeMap<ViewNumber, Proposal<TYPES, QuorumProposalWrapper<TYPES>>>,
    decided_upgrade_certificate: Option<UpgradeCertificate<TYPES>>,
    state_cert: Option<LightClientStateUpdateCertificateV2<TYPES>>,
    start_epoch_info: Vec<InitializerEpochInfo<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

start_view: ViewNumber

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

last_actioned_view: ViewNumber

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.

saved_proposals: BTreeMap<ViewNumber, 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

state_cert: Option<LightClientStateUpdateCertificateV2<TYPES>>

The last formed light client state update certificate if there’s any

start_epoch_info: Vec<InitializerEpochInfo<TYPES>>

Saved epoch information. This must be sorted ascending by epoch.

Implementations

impl<TYPES: NodeType> HotShotInitializer<TYPES>

pub async fn from_genesis( instance_state: TYPES::InstanceState, epoch_height: u64, start_epoch_info: Vec<InitializerEpochInfo<TYPES>>, upgrade: Upgrade, ) -> Result<Self, HotShotError<TYPES>>

initialize from genesis

Errors

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

pub fn load( instance_state: TYPES::InstanceState, epoch_height: u64, start_epoch_info: Vec<InitializerEpochInfo<TYPES>>, (anchor_leaf, anchor_state): InitializerAnchor<TYPES>, start_view: ViewNumber, high_qc: QuorumCertificate2<TYPES>, last_actioned_view: ViewNumber, saved_proposals: BTreeMap<ViewNumber, Proposal<TYPES, QuorumProposalWrapper<TYPES>>>, decided_upgrade_certificate: Option<UpgradeCertificate<TYPES>>, state_cert: Option<LightClientStateUpdateCertificateV2<TYPES>>, ) -> Self

Create a HotShotInitializer from the given information.

The anchor’s validated state may be supplied by callers that have it (e.g. a full genesis state); when absent, a sparse state is constructed from the anchor leaf’s header.

pub fn instance_state(&self) -> &TYPES::InstanceState

Instance-level state.

pub fn epoch_height(&self) -> u64

Epoch height.

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

The anchor (last decided) leaf.

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

ValidatedState for the anchor leaf.

pub fn start_view(&self) -> ViewNumber

The view to start consensus from.

pub fn last_actioned_view(&self) -> ViewNumber

The view we last proposed or voted in.

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

Highest QC that was seen.

pub fn saved_proposals( &self, ) -> &BTreeMap<ViewNumber, Proposal<TYPES, QuorumProposalWrapper<TYPES>>>

Proposals we have sent out to provide to others for catchup.

pub fn decided_upgrade_certificate(&self) -> Option<&UpgradeCertificate<TYPES>>

The upgrade certificate consensus has decided, if there is one.

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

The last formed light client state update certificate, if there is any.

pub fn start_epoch_info(&self) -> &[InitializerEpochInfo<TYPES>]

The epoch roots and DRB results persistence holds.

Trait Implementations

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

where TYPES::InstanceState: Clone, TYPES::ValidatedState: Clone,

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

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

where TYPES::InstanceState: Debug, TYPES::ValidatedState: Debug,

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

Formats the value using the given formatter.