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>, QuorumCertificate2<T>>>,
    vote2_collector: VoteCollector<T, SimpleTally<T, Vote2<T>, Certificate2<T>>>,
    timeout_collector: VoteCollector<T, SimpleTally<T, TimeoutVote2<T>, TimeoutCertificate2<T>>>,
    timeout_one_honest_collector: VoteCollector<T, SimpleTally<T, TimeoutVote2<T>, TimeoutOneHonest<T>>>,
    epoch_root_collector: VoteCollector<T, EpochRootTally<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>>,
    coordinator_outbox: Outbox<OpaqueMessage<T::SignatureKey>>,
    public_key: T::SignatureKey,
    node_id: KeyPrefix,
    timer: Timer,
    pending_proposal_fetches: PendingProposalFetches<T>,
    requested_missing_proposals: HashSet<ProposalFetchKey<T>>,
    da_payloads: BTreeMap<(ViewNumber, VidCommitment2), PendingDa<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>, QuorumCertificate2<T>>>

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

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

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

epoch_root_collector: VoteCollector<T, EpochRootTally<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>>

coordinator_outbox: Outbox<OpaqueMessage<T::SignatureKey>>

public_key: T::SignatureKey

node_id: KeyPrefix

timer: Timer

pending_proposal_fetches: PendingProposalFetches<T>

requested_missing_proposals: HashSet<ProposalFetchKey<T>>

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

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, seed: Option<PreCutoverSeed<T>>)

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

A pre-cutover seed is applied first, so the coordinator starts from the bridged legacy state instead of genesis. When the seed carries no QC for the last legacy view, the coordinator parks on that view instead of proposing; a bridged high QC or a timeout advances it.

pub async fn stop(self)

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

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 coordinator_outbox(&self) -> &Outbox<OpaqueMessage<T::SignatureKey>>

pub fn coordinator_outbox_mut( &mut self, ) -> &mut Outbox<OpaqueMessage<T::SignatureKey>>

pub fn current_view(&self) -> ViewNumber

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 expected_vid_param( &self, target_epoch: Option<EpochNumber>, ) -> Option<AvidmGf2Param>

The VID erasure parameters the committee fixes for target_epoch, matching what an honest disperser derives. Used to reject shares whose common.param is forged (the commitment binds ns_commits, not param). None if the committee cannot be resolved.

fn broadcast( &self, message_type: ConsensusMessage<T, Validated>, ctx: &'static str, ) -> Result<(), CoordinatorError>

fn unicast_to_leader( &mut self, view: ViewNumber, epoch: EpochNumber, msg: BlockMessage<T>, ) -> Result<(), CoordinatorError>

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 gc( &mut self, epoch: EpochNumber, scope: GcScope, ) -> Result<(), CoordinatorError>

fn apply_cutover_seed(&mut self, seed: PreCutoverSeed<T>) -> bool

Bridge legacy state into the coordinator before it starts.

Returns false when the coordinator must park on the last seeded view because the cutover view cannot be proposed off it yet. A stale seed (the coordinator has already restarted past the cutover) is ignored and the normal start path proceeds.

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

We ignore votes more than MAX_VIEWS_AHEAD ahead of ours.

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

We ignore certificates more than EPOCH_CHANGE_LOOKAHEAD ahead of ours.

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

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

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