Enum lumina_node::events::NodeEvent

#[non_exhaustive]
pub enum NodeEvent {
    ConnectingToBootnodes,
    PeerConnected {
        id: PeerId,
        trusted: bool,
    },
    PeerDisconnected {
        id: PeerId,
        trusted: bool,
    },
    SamplingStarted {
        height: u64,
        square_width: u16,
        shares: Vec<(u16, u16)>,
    },
    ShareSamplingResult {
        height: u64,
        square_width: u16,
        row: u16,
        column: u16,
        accepted: bool,
    },
    SamplingFinished {
        height: u64,
        accepted: bool,
        took: Duration,
    },
    FatalDaserError {
        error: String,
    },
    AddedHeaderFromHeaderSub {
        height: u64,
    },
    FetchingHeadHeaderStarted,
    FetchingHeadHeaderFinished {
        height: u64,
        took: Duration,
    },
    FetchingHeadersStarted {
        from_height: u64,
        to_height: u64,
    },
    FetchingHeadersFinished {
        from_height: u64,
        to_height: u64,
        took: Duration,
    },
    FetchingHeadersFailed {
        from_height: u64,
        to_height: u64,
        error: String,
        took: Duration,
    },
    FatalSyncerError {
        error: String,
    },
    PrunedHeaders {
        to_height: u64,
    },
    FatalPrunerError {
        error: String,
    },
    NetworkCompromised,
}

The events that Node can generate.

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.

ConnectingToBootnodes

Node is connecting to bootnodes

PeerConnected

Peer just connected

Fields

id: PeerId

The ID of the peer.

trusted: bool

Whether peer was in the trusted list or not.

PeerDisconnected

Peer just disconnected

Fields

id: PeerId

The ID of the peer.

trusted: bool

Whether peer was in the trusted list or not.

SamplingStarted

Sampling just started.

Fields

height: u64

The block height that will be sampled.

square_width: u16

The square width of the block.

shares: Vec<(u16, u16)>

The coordinates of the shares that will be sampled.

ShareSamplingResult

A share was sampled.

Fields

height: u64

The block height of the share.

square_width: u16

The square width of the block.

row: u16

The row of the share.

column: u16

The column of the share.

accepted: bool

The result of the sampling of the share.

SamplingFinished

Sampling just finished.

Fields

height: u64

The block height that was sampled.

accepted: bool

The overall result of the sampling.

took: Duration

How much time sampling took.

FatalDaserError

Data sampling fatal error.

Fields

error: String

A human readable error.

AddedHeaderFromHeaderSub

A new header was added from HeaderSub.

Fields

height: u64

The height of the header.

FetchingHeadHeaderStarted

Fetching header of network head just started.

FetchingHeadHeaderFinished

Fetching header of network head just finished.

Fields

height: u64

The height of the network head.

took: Duration

How much time fetching took.

FetchingHeadersStarted

Fetching headers of a specific block range just started.

Fields

from_height: u64

Start of the range.

to_height: u64

End of the range (included).

FetchingHeadersFinished

Fetching headers of a specific block range just finished.

Fields

from_height: u64

Start of the range.

to_height: u64

End of the range (included).

took: Duration

How much time fetching took.

FetchingHeadersFailed

Fetching headers of a specific block range just failed.

Fields

from_height: u64

Start of the range.

to_height: u64

End of the range (included).

error: String

A human readable error.

took: Duration

How much time fetching took.

FatalSyncerError

Header syncing fatal error.

Fields

error: String

A human readable error.

PrunedHeaders

Pruned headers up to and including specified height.

Fields

to_height: u64

Last header height that was pruned

FatalPrunerError

Pruning fatal error.

Fields

error: String

A human readable error.

NetworkCompromised

Network was compromised.

This happens when a valid bad encoding fraud proof is received. Ideally it would never happen, but protection needs to exist. In case of compromised network, syncing and data sampling will stop immediately.

Implementations

impl NodeEvent

pub fn is_error(&self) -> bool

Returns true if the event indicates an error.

Trait Implementations

impl Clone for NodeEvent

fn clone(&self) -> NodeEvent

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for NodeEvent

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

Formats the value using the given formatter.

impl Display for NodeEvent

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

Formats the value using the given formatter.

impl Serialize for NodeEvent

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

where __S: Serializer,

Serialize this value into the given Serde serializer.