Enum polkadot_node_subsystem_types::messages::CollatorProtocolMessage

pub enum CollatorProtocolMessage {
    CollateOn(ParaId),
    DistributeCollation(CandidateReceipt, Hash, PoV, Option<Sender<CollationSecondedSignal>>),
    ReportCollator(CollatorId),
    NetworkBridgeUpdate(NetworkBridgeEvent<CollatorProtocolMessage>),
    Invalid(Hash, CandidateReceipt),
    Seconded(Hash, SignedFullStatement),
    Backed {
        para_id: ParaId,
        para_head: Hash,
    },
}

Messages received by the Collator Protocol subsystem.

Variants

CollateOn(ParaId)

Signal to the collator protocol that it should connect to validators with the expectation of collating on the given para. This is only expected to be called once, early on, if at all, and only by the Collation Generation subsystem. As such, it will overwrite the value of the previous signal.

This should be sent before any DistributeCollation message.

DistributeCollation(CandidateReceipt, Hash, PoV, Option<Sender<CollationSecondedSignal>>)

Provide a collation to distribute to validators with an optional result sender. The second argument is the parent head-data hash.

The result sender should be informed when at least one parachain validator seconded the collation. It is also completely okay to just drop the sender.

ReportCollator(CollatorId)

Report a collator as having provided an invalid collation. This should lead to disconnect and blacklist of the collator.

NetworkBridgeUpdate(NetworkBridgeEvent<CollatorProtocolMessage>)

Get a network bridge update.

Invalid(Hash, CandidateReceipt)

We recommended a particular candidate to be seconded, but it was invalid; penalize the collator.

The hash is the relay parent.

Seconded(Hash, SignedFullStatement)

The candidate we recommended to be seconded was validated successfully.

The hash is the relay parent.

Backed

Fields

para_id: ParaId

Candidate’s para id.

para_head: Hash

Hash of the para head generated by candidate.

The candidate received enough validity votes from the backing group.

Trait Implementations

impl Debug for CollatorProtocolMessage

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

Formats the value using the given formatter.

impl Default for CollatorProtocolMessage

fn default() -> Self

Returns the “default value” for a type.

impl From<NetworkBridgeEvent<Versioned<CollatorProtocolMessage, CollatorProtocolMessage>>> for CollatorProtocolMessage

fn from( original: NetworkBridgeEvent<CollatorProtocolMessage> ) -> CollatorProtocolMessage

Converts to this type from the input type.