Enum hotshot::types::EventType

#[non_exhaustive]
pub enum EventType<TYPES>
where
    TYPES: NodeType,
{
    Error {
        error: Arc<HotShotError<TYPES>>,
    },
    Decide {
        leaf_chain: Arc<Vec<LeafInfo<TYPES>>>,
        qc: Arc<SimpleCertificate<TYPES, QuorumData<TYPES>, SuccessThreshold>>,
        block_size: Option<u64>,
    },
    ReplicaViewTimeout {
        view_number: <TYPES as NodeType>::Time,
    },
    ViewFinished {
        view_number: <TYPES as NodeType>::Time,
    },
    ViewTimeout {
        view_number: <TYPES as NodeType>::Time,
    },
    Transactions {
        transactions: Vec<<TYPES as NodeType>::Transaction>,
    },
    DaProposal {
        proposal: Proposal<TYPES, DaProposal<TYPES>>,
        sender: <TYPES as NodeType>::SignatureKey,
    },
    QuorumProposal {
        proposal: Proposal<TYPES, QuorumProposal<TYPES>>,
        sender: <TYPES as NodeType>::SignatureKey,
    },
    UpgradeProposal {
        proposal: Proposal<TYPES, UpgradeProposal<TYPES>>,
        sender: <TYPES as NodeType>::SignatureKey,
    },
    ExternalMessageReceived(Vec<u8>),
}

The type and contents of a status event emitted by a HotShot instance

This enum does not include metadata shared among all variants, such as the stage and view number, and is thus always returned wrapped in an Event.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Error

Fields

error: Arc<HotShotError<TYPES>>

The underlying error

A view encountered an error and was interrupted

Decide

Fields

leaf_chain: Arc<Vec<LeafInfo<TYPES>>>

The chain of Leafs that were committed by this decision

This list is sorted in reverse view number order, with the newest (highest view number) block first in the list.

This list may be incomplete if the node is currently performing catchup. Vid Info for a decided view may be missing if this node never saw it’s share.

qc: Arc<SimpleCertificate<TYPES, QuorumData<TYPES>, SuccessThreshold>>

The QC signing the most recent leaf in leaf_chain.

Note that the QC for each additional leaf in the chain can be obtained from the leaf before it using

block_size: Option<u64>

Optional information of the number of transactions in the block, for logging purposes.

A new decision event was issued

ReplicaViewTimeout

Fields

view_number: <TYPES as NodeType>::Time

The view that timed out

A replica task was canceled by a timeout interrupt

ViewFinished

Fields

view_number: <TYPES as NodeType>::Time

The view number that has just finished

The view has finished. If values were decided on, a Decide event will also be emitted.

ViewTimeout

Fields

view_number: <TYPES as NodeType>::Time

The view that timed out

The view timed out

Transactions

Fields

transactions: Vec<<TYPES as NodeType>::Transaction>

The list of transactions

New transactions were received from the network or submitted to the network by us

DaProposal

Fields

proposal: Proposal<TYPES, DaProposal<TYPES>>

Contents of the proposal

sender: <TYPES as NodeType>::SignatureKey

Public key of the leader submitting the proposal

DA proposal was received from the network or submitted to the network by us

QuorumProposal

Fields

proposal: Proposal<TYPES, QuorumProposal<TYPES>>

Contents of the proposal

sender: <TYPES as NodeType>::SignatureKey

Public key of the leader submitting the proposal

Quorum proposal was received from the network or submitted to the network by us

UpgradeProposal

Fields

proposal: Proposal<TYPES, UpgradeProposal<TYPES>>

Contents of the proposal

sender: <TYPES as NodeType>::SignatureKey

Public key of the leader submitting the proposal

Upgrade proposal was received from the network or submitted to the network by us

ExternalMessageReceived(Vec<u8>)

A message destined for external listeners was received

Trait Implementations

impl<TYPES> Clone for EventType<TYPES>

where TYPES: Clone + NodeType, <TYPES as NodeType>::Time: Clone, <TYPES as NodeType>::Transaction: Clone, <TYPES as NodeType>::SignatureKey: Clone,

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<TYPES> Debug for EventType<TYPES>

where TYPES: Debug + NodeType, <TYPES as NodeType>::Time: Debug, <TYPES as NodeType>::Transaction: Debug, <TYPES as NodeType>::SignatureKey: Debug,

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

Formats the value using the given formatter.

impl<'de, TYPES> Deserialize<'de> for EventType<TYPES>

where TYPES: NodeType,

fn deserialize<__D>( __deserializer: __D ) -> Result<EventType<TYPES>, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<TYPES> Serialize for EventType<TYPES>

where TYPES: NodeType + Serialize, <TYPES as NodeType>::Time: Serialize, <TYPES as NodeType>::SignatureKey: Serialize,

fn serialize<__S>( &self, __serializer: __S ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.