Struct Coordinator 

pub struct Coordinator<T: NodeType, S> {

    membership_coordinator: EpochMembershipCoordinator<T>,
    consensus: Consensus<T>,
    network: Cliquenet<T>,
    state_manager: StateManager<T>,
    client: CoordinatorClient<T>,
    vid_disperser: VidDisperser<T>,
    vid_reconstructor: VidReconstructor<T>,
    vid_fragment_accumulator: VidFragmentAccumulator<T>,
    vote1_collector: VoteCollector<T, SimpleTally<T, QuorumVote2<T>, SuccessThreshold>>,
    vote2_collector: VoteCollector<T, SimpleTally<T, Vote2<T>, SuccessThreshold>>,
    timeout_collector: VoteCollector<T, SimpleTally<T, TimeoutVote2<T>, SuccessThreshold>>,
    timeout_one_honest_collector: VoteCollector<T, SimpleTally<T, TimeoutVote2<T>, OneHonestThreshold>>,
    timeout3_collector: VoteCollector<T, TimeoutTally<T, SuccessThreshold>>,
    timeout_one_honest3_collector: VoteCollector<T, TimeoutTally<T, OneHonestThreshold>>,
    epoch_root_collector: VoteCollector<T, EpochRootTally<T>>,
    upgrade_vote_collector: VoteCollector<T, UpgradeTally<T>>,
    upgrade_protocol: UpgradeProtocol<T>,
    cert_verifiers: CertVerifiers<T>,
    epoch_manager: EpochManager<T>,
    block_builder: BlockBuilder<T>,
    proposal_validator: ProposalValidator<T>,
    share_validator: VidShareValidator<T>,
    storage: Storage<T, S>,
    outbox: Outbox<ConsensusOutput<T>>,
    external_tx: UnboundedSender<OpaqueMessage<T::SignatureKey>>,
    public_key: T::SignatureKey,
    node_id: KeyPrefix,
    timer: Timer,
    pending_proposal_fetches: PendingProposalFetches<T>,
    requested_missing_proposals: HashMap<ProposalFetchKey<T>, ViewNumber>,
    fetcher: Fetcher<T>,
    server: Server<T>,
    da_payloads: BTreeMap<(ViewNumber, VidCommitment2), PendingDa<T>>,
    built_dispersals: BTreeMap<(ViewNumber, EpochNumber, VidCommitment2), BuiltDispersal<T>>,
    metrics: Option<Metrics>,
    participation: ParticipationTracker<T>,
    voted_view: Option<ViewNumber>,
    last_timeout_view: Option<ViewNumber>,
    view_started: Option<(ViewNumber, EpochNumber, Instant)>,
    proposal_received_at: Option<(ViewNumber, Instant)>,
    invalid_certs_at_decide: u64,
    payload_txn_bytes: BTreeMap<ViewNumber, usize>,
}

Fields

membership_coordinator: EpochMembershipCoordinator<T>

consensus: Consensus<T>

network: Cliquenet<T>

state_manager: StateManager<T>

client: CoordinatorClient<T>

vid_disperser: VidDisperser<T>

vid_reconstructor: VidReconstructor<T>

vid_fragment_accumulator: VidFragmentAccumulator<T>

vote1_collector: VoteCollector<T, SimpleTally<T, QuorumVote2<T>, SuccessThreshold>>

vote2_collector: VoteCollector<T, SimpleTally<T, Vote2<T>, SuccessThreshold>>

timeout_collector: VoteCollector<T, SimpleTally<T, TimeoutVote2<T>, SuccessThreshold>>

timeout_one_honest_collector: VoteCollector<T, SimpleTally<T, TimeoutVote2<T>, OneHonestThreshold>>

timeout3_collector: VoteCollector<T, TimeoutTally<T, SuccessThreshold>>

timeout_one_honest3_collector: VoteCollector<T, TimeoutTally<T, OneHonestThreshold>>

epoch_root_collector: VoteCollector<T, EpochRootTally<T>>

upgrade_vote_collector: VoteCollector<T, UpgradeTally<T>>

upgrade_protocol: UpgradeProtocol<T>

cert_verifiers: CertVerifiers<T>

epoch_manager: EpochManager<T>

block_builder: BlockBuilder<T>

proposal_validator: ProposalValidator<T>

share_validator: VidShareValidator<T>

storage: Storage<T, S>

outbox: Outbox<ConsensusOutput<T>>

external_tx: UnboundedSender<OpaqueMessage<T::SignatureKey>>

Forwards external messages on arrival, independent of consensus inputs.

public_key: T::SignatureKey

node_id: KeyPrefix

timer: Timer

pending_proposal_fetches: PendingProposalFetches<T>

requested_missing_proposals: HashMap<ProposalFetchKey<T>, ViewNumber>

Proposals asked for, with the view this node was in when it last asked.

fetcher: Fetcher<T>

server: Server<T>

da_payloads: BTreeMap<(ViewNumber, VidCommitment2), PendingDa<T>>

built_dispersals: BTreeMap<(ViewNumber, EpochNumber, VidCommitment2), BuiltDispersal<T>>

Dispersals the block builder computed, until consensus asks to disperse their block.

metrics: Option<Metrics>

participation: ParticipationTracker<T>

voted_view: Option<ViewNumber>

last_timeout_view: Option<ViewNumber>

View of the last timer fire that counted towards participation and timeout metrics, so a re-fire for the same (stuck) view doesn’t double-count it.

view_started: Option<(ViewNumber, EpochNumber, Instant)>

proposal_received_at: Option<(ViewNumber, Instant)>

invalid_certs_at_decide: u64

payload_txn_bytes: BTreeMap<ViewNumber, usize>

Implementations

impl<T: NodeType, S> Coordinator<T, S>

pub fn builder() -> CoordinatorBuilder<T, S>

Create an instance of Coordinator using the builder syntax

impl<T, S> Coordinator<T, S>

where T: NodeType, S: NewProtocolStorage<T>,

pub fn start(&mut self)

Emit ViewChanged(current_view + 1) and, if leader, a RequestBlockAndHeader.

pub async fn stop(self)

pub async fn next_consensus_input( &mut self, ) -> Result<ConsensusInput<T>, CoordinatorError>

fn on_payload_obtained(&mut self, out: ObtainedPayload<T>) -> ConsensusInput<T>

pub fn apply_consensus(&mut self, input: ConsensusInput<T>)

pub fn process_consensus_output( &mut self, output: ConsensusOutput<T>, ) -> Result<(), CoordinatorError>

pub fn node_id(&self) -> &KeyPrefix

pub fn outbox(&self) -> &Outbox<ConsensusOutput<T>>

pub fn outbox_mut(&mut self) -> &mut Outbox<ConsensusOutput<T>>

pub fn current_view(&self) -> ViewNumber

pub fn last_decided_leaf(&self) -> &Leaf2<T>

pub fn state(&self, v: ViewNumber) -> Option<&StateEntry<T>>

pub fn client_api(&self) -> &ClientApi<T>

pub fn bump_network_epoch(&mut self, epoch: EpochNumber)

Refresh the network’s peer window for epoch.

The coordinator does this itself whenever a proposal validates, but before its event loop is started callers can trigger this explicitly to keep the network up to date.

pub(crate) fn on_network_message( &mut self, message: Message<T, Unchecked>, ) -> Option<ConsensusInput<T>>

fn on_state_manager_output( &mut self, output: StateManagerOutput<T>, ) -> Option<ConsensusInput<T>>

fn slot_for(&self, view: ViewNumber) -> ViewNumber

The slot for a message about view.

A node can send a message about a later view than its own: it enters a view only after rebuilding the parent block. Every view change drops queued messages more than one slot below the new view, so such a message takes its own view to survive the view changes the node still has to make. A message about an earlier view takes the current view, which is never below that bound.

fn broadcast_in( &self, slot: ViewNumber, message_type: impl Into<MessageType<T, Validated>>, ctx: &'static str, ) -> Result<(), CoordinatorError>

fn unicast_in( &self, slot: ViewNumber, recipient: &T::SignatureKey, message_type: impl Into<MessageType<T, Validated>>, ctx: &'static str, ) -> Result<(), CoordinatorError>

fn send_transactions( &mut self, forward: TransactionMessage<T>, epoch: EpochNumber, ) -> Result<(), CoordinatorError>

Sends forward to the leaders of the fanout views from its own, each leader once with the earliest of its views.

fn upcoming_leaders( &mut self, first: ViewNumber, count: u64, epoch: EpochNumber, ) -> Vec<(ViewNumber, T::SignatureKey)>

The leaders of the count views from first, each once with the earliest of its views.

fn upcoming_leader( &mut self, view: ViewNumber, epoch: EpochNumber, ) -> Option<T::SignatureKey>

The leader of an upcoming view. Consensus picks it with the epoch of the block it proposes, which is the next epoch when that block builds on its epoch’s last block. Timed out views add no block, so the latest proposal is the best guess for that parent. epoch is the fallback when there is no proposal yet or its epoch’s stake table is unknown.

fn leader( &mut self, view: ViewNumber, epoch: EpochNumber, ) -> Option<T::SignatureKey>

fn on_client_request( &mut self, request: ClientRequest<T>, ) -> Result<(), CoordinatorError>

fn record_voted_view(&mut self, view: ViewNumber)

fn on_view_changed_metrics(&mut self, view: ViewNumber, epoch: EpochNumber)

fn on_decide_metrics(&mut self, leaves: &[Leaf2<T>])

fn broadcast_proposal_fetch( &mut self, view: ViewNumber, ) -> Result<(), CoordinatorError>

Broadcast a signed proposal fetch request for view to all peers.

fn request_missing_proposal( &mut self, view: ViewNumber, leaf_commit: Commitment<Leaf2<T>>, ) -> Result<(), CoordinatorError>

fn maybe_validate_fetched_proposal( &mut self, proposal: SignedProposal<T, Proposal<T>>, )

fn notify_vid_reconstructor( &mut self, proposal: &Proposal<T>, pinned_by: PinnedBy, )

Pin the reconstructor to proposal’s payload commitment, so the shares the voters broadcast for its view can rebuild the payload.

fn gc( &mut self, epoch: EpochNumber, scope: GcScope, ) -> Result<(), CoordinatorError>

fn is_view_too_far_ahead(&self, v: ViewNumber) -> bool

We ignore votes more than MAX_VIEWS_AHEAD ahead of ours.

fn is_vote_epoch_admissible(&self, epoch: Option<EpochNumber>) -> bool

Is epoch close enough to the node’s own to tally a vote naming it?

fn is_epoch_too_far_ahead(&self, epoch: Option<EpochNumber>) -> bool

We ignore messages more than EPOCH_CHANGE_LOOKAHEAD ahead of ours.

fn is_epoch_too_far_behind(&self, epoch: EpochNumber) -> bool

We ignore messages more than EPOCH_CHANGE_LOOKBEHIND behind ours.

fn is_fragment_epoch_admissible(&self, epoch: EpochNumber) -> bool

Is epoch close enough to the node’s own to buffer a fragment naming it?

pub(crate) fn catchup_evidence(&self) -> Option<ConsensusMessage<T, Validated>>

fn on_timeout_vote( &mut self, sender: &T::SignatureKey, vote: TimeoutVote<T>, evidence: Option<CatchupEvidence<T>>, )

fn verify_advance( &mut self, sender: &T::SignatureKey, qc: Certificate1<T>, ) -> Option<EpochNumber>

Submit a Cert1 that would advance our view for verification.

A certificate at the genesis view passes the verifier unsigned, which is right only for the genesis QC, so any other one claiming that view is dropped here. Dropping it before verification rather than in consensus also keeps it out of the verifier’s completed keys, where a forgery naming the genesis epoch would shadow the genesis QC itself.

fn verify_timeout_cert( &mut self, sender: &T::SignatureKey, tc: TimeoutCertificate2<T>, ) -> Option<EpochNumber>

fn verify_timeout_cert3( &mut self, sender: &T::SignatureKey, tc: TimeoutCertificate3<T>, ) -> Option<EpochNumber>

fn send_epoch_change(&mut self, peer: &T::SignatureKey, epoch: EpochNumber)

fn send_catchup_evidence( &mut self, peer: &T::SignatureKey, stale_view: ViewNumber, )

pub fn maker<'f1, 'f2>() -> CoordinatorMaker<'f1, 'f2, T, S>