Struct VoteCollector 

pub struct VoteCollector<T: NodeType, S: Tally<T>> {
    accumulators: JoinMap<(ViewNumber, EpochNumber), Option<S::Output>>,
    ballot_boxes: BTreeMap<(ViewNumber, EpochNumber), UnboundedSender<S::Vote>>,
    pending: BTreeMap<(ViewNumber, EpochNumber), HashMap<T::SignatureKey, S::Vote>>,
    completed: BTreeSet<(ViewNumber, EpochNumber)>,
    signers: BTreeMap<(ViewNumber, EpochNumber), HashSet<T::SignatureKey>>,
    lower_bound: ViewNumber,
    membership: EpochMembershipCoordinator<T>,
    upgrade_lock: UpgradeLock<T>,
}

Collects votes per view and epoch and forms certificate(s) using the strategy S.

Fields

accumulators: JoinMap<(ViewNumber, EpochNumber), Option<S::Output>>

Tasks collecting votes and forming certificates.

ballot_boxes: BTreeMap<(ViewNumber, EpochNumber), UnboundedSender<S::Vote>>

Where callers submit their votes.

pending: BTreeMap<(ViewNumber, EpochNumber), HashMap<T::SignatureKey, S::Vote>>

Votes for epochs we have yet to resolve, deduplicated by signer.

completed: BTreeSet<(ViewNumber, EpochNumber)>

The view and epoch pairs that formed a valid certificate already.

signers: BTreeMap<(ViewNumber, EpochNumber), HashSet<T::SignatureKey>>

The signers per view and epoch.

lower_bound: ViewNumber

The GC threshold.

membership: EpochMembershipCoordinator<T>

upgrade_lock: UpgradeLock<T>

Implementations

impl<T: NodeType, S: Tally<T>> VoteCollector<T, S>

where <S as Tally<T>>::Vote: Ballot<Signer = T::SignatureKey>,

pub fn new(mc: EpochMembershipCoordinator<T>, lock: UpgradeLock<T>) -> Self

pub async fn next(&mut self) -> Option<S::Output>

pub fn accumulate_vote(&mut self, vote: S::Vote) -> Option<EpochNumber>

Count vote, or hold it until the committees of its epochs are known.

Returns the epoch whose committee a held vote waits for, so that the caller can drive its catchup.

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

Record that view’s certificate in epoch was obtained by other means, e.g. from the network, so the tally for it stops.

Drops the ballot box and buffered votes and aborts the tally. A tally mid-way through a blocking hop finishes that hop and has its certificate discarded by Self::next. signers is left in place so the timeout diagnostics keep what the tally saw.

pub fn retry_pending_votes(&mut self)

pub fn gc(&mut self, view: ViewNumber)

impl<T, V, Th> VoteCollector<T, SimpleTally<T, V, Th>>

where T: NodeType, V: Vote<T> + Send + 'static, V::Commitment: 'static, Th: Threshold<T> + Send + 'static, SimpleCertificate<T, <V as Vote<T>>::Commitment, Th>: Certificate<T, V::Commitment, Voteable = V::Commitment> + HasEpoch + Send + 'static,

pub fn stats(&self, view: ViewNumber) -> Vec<(EpochNumber, VoteStats)>

What every epoch that voted in view has collected.

Each entry counts the unique signers routed to view’s tally under that epoch and, where the epoch still resolves, sums their stake against its cert threshold. Votes name their own epoch, so a view can hold more than one entry; that means its votes are split across committees and neither tally need reach its threshold. Looks up each signer’s stake on demand, only intended for rare paths like timeout diagnostics.

An epoch that has signers always yields an entry, so an empty result means no vote was received for view and nothing weaker.