Enum Plan 

pub enum Plan<P: PublicKey> {
    Prepare {
        round: Round,
    },
    Propose {
        round: Round,
    },
    Forward {
        round: Round,
        recipients: Recipients<P>,
    },
}

Describes how a payload should be broadcast to the network.

Variants

Prepare

Early broadcast of a held term-start candidate to all participants.

Requested when a crate::Handoff::Stage candidate is held for its parent’s certification. The proposer has not voted for the candidate and may still abandon it for one built on a replacement parent, so this plan commits to nothing. A relay may defer the send to the matching Plan::Propose.

Fields

round: Round

The round in which the candidate was built.

Propose

Broadcast of a proposed block to all participants.

Requested before the proposer’s notarize vote is durable: a proposer that crashes and restarts may emit this plan again with a different payload for the same round. Consumers must tolerate multiple candidates per round (at most one is ever referenced by the proposer’s signed votes).

The proposer’s notarize vote follows this plan. A relay that already sent the payload for the matching Plan::Prepare does not send it again.

Fields

round: Round

The round in which the block was proposed.

Forward

Forward a block to a specific set of peers.

Requested only for a proposal already backed by a certificate. Forwarding is best-effort help for lagging peers and advertises nothing about the sender’s own state, so it needs no durability ordering.

Fields

round: Round

The round in which the forwarded block was proposed.

recipients: Recipients<P>

The recipients to forward the block to.