Enum hotshot_types::event::EventType

#[non_exhaustive]
pub enum EventType<TYPES: NodeType> {
    Error {
        error: Arc<HotShotError<TYPES>>,
    },
    Decide {
        leaf_chain: Arc<LeafChain<TYPES>>,
        qc: Arc<QuorumCertificate2<TYPES>>,
        block_size: Option<u64>,
    },
    ReplicaViewTimeout {
        view_number: TYPES::View,
    },
    ViewFinished {
        view_number: TYPES::View,
    },
    ViewTimeout {
        view_number: TYPES::View,
    },
    Transactions {
        transactions: Vec<TYPES::Transaction>,
    },
    DaProposal {
        proposal: Proposal<TYPES, DaProposal2<TYPES>>,
        sender: TYPES::SignatureKey,
    },
    QuorumProposal {
        proposal: Proposal<TYPES, QuorumProposal2<TYPES>>,
        sender: TYPES::SignatureKey,
    },
    UpgradeProposal {
        proposal: Proposal<TYPES, UpgradeProposal<TYPES>>,
        sender: TYPES::SignatureKey,
    },
    ExternalMessageReceived {
        sender: TYPES::SignatureKey,
        data: 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

A view encountered an error and was interrupted

Fields

error: Arc<HotShotError<TYPES>>

The underlying error

Decide

A new decision event was issued

Fields

leaf_chain: Arc<LeafChain<TYPES>>

The chain of Leaves 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<QuorumCertificate2<TYPES>>

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.

ReplicaViewTimeout

A replica task was canceled by a timeout interrupt

Fields

view_number: TYPES::View

The view that timed out

ViewFinished

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

Fields

view_number: TYPES::View

The view number that has just finished

ViewTimeout

The view timed out

Fields

view_number: TYPES::View

The view that timed out

Transactions

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

Fields

transactions: Vec<TYPES::Transaction>

The list of transactions

DaProposal

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

Fields

proposal: Proposal<TYPES, DaProposal2<TYPES>>

Contents of the proposal

sender: TYPES::SignatureKey

Public key of the leader submitting the proposal

QuorumProposal

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

Fields

proposal: Proposal<TYPES, QuorumProposal2<TYPES>>

Contents of the proposal

sender: TYPES::SignatureKey

Public key of the leader submitting the proposal

UpgradeProposal

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

Fields

proposal: Proposal<TYPES, UpgradeProposal<TYPES>>

Contents of the proposal

sender: TYPES::SignatureKey

Public key of the leader submitting the proposal

ExternalMessageReceived

A message destined for external listeners was received

Fields

sender: TYPES::SignatureKey

Public Key of the message sender

data: Vec<u8>

Serialized data of the message

Trait Implementations

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

where TYPES::View: Clone, TYPES::Transaction: Clone, TYPES::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 + NodeType> Debug for EventType<TYPES>

where TYPES::View: Debug, TYPES::Transaction: Debug, TYPES::SignatureKey: Debug,

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

Formats the value using the given formatter.

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

where TYPES: NodeType,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<TYPES> Serialize for EventType<TYPES>

where TYPES: Serialize + NodeType, TYPES::View: Serialize, TYPES::SignatureKey: Serialize,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.