Struct finality_grandpa::voter::Voter

pub struct Voter<H, N, E: Environment<H, N>, GlobalIn, GlobalOut>where
    H: Clone + Eq + Ord + Debug,
    N: Copy + BlockNumberOps + Debug,
    GlobalIn: Stream<Item = Result<CommunicationIn<H, N, E::Signature, E::Id>, E::Error>> + Unpin,
    GlobalOut: Sink<CommunicationOut<H, N, E::Signature, E::Id>, Error = E::Error> + Unpin,{ /* private fields */ }

A future that maintains and multiplexes between different rounds, and caches votes.

This voter also implements the commit protocol. The commit protocol allows a node to broadcast a message that finalizes a given block and includes a set of precommits as proof.

• When a round is completable and we precommitted we start a commit timer and start accepting commit messages;
• When we receive a commit message if it targets a block higher than what we’ve finalized we validate it and import its precommits if valid;
• When our commit timer triggers we check if we’ve received any commit message for a block equal to what we’ve finalized, if we haven’t then we broadcast a commit.

Additionally, we also listen to commit messages from rounds that aren’t currently running, we validate the commit and dispatch a finalization notification (if any) to the environment.

Implementations

impl<'a, H, N, E, GlobalIn, GlobalOut> Voter<H, N, E, GlobalIn, GlobalOut>where
    H: Clone + Ord + Debug + Sync + Send + 'a,
    N: BlockNumberOps + Sync + Send,
    E: Environment<H, N> + Sync + Send + 'a,
    GlobalIn: Stream<Item = Result<CommunicationIn<H, N, E::Signature, E::Id>, E::Error>> + Unpin,
    GlobalOut: Sink<CommunicationOut<H, N, E::Signature, E::Id>, Error = E::Error> + Unpin,

pub fn voter_state(&self) -> Box<dyn VoterState<E::Id> + Send + Sync + 'a>where
    <E as Environment<H, N>>::Signature: Send,
    <E as Environment<H, N>>::Id: Hash + Send,
    <E as Environment<H, N>>::Timer: Send,
    <E as Environment<H, N>>::Out: Send,
    <E as Environment<H, N>>::In: Send,

Returns an object allowing to query the voter state.

impl<H, N, E: Environment<H, N>, GlobalIn, GlobalOut> Voter<H, N, E, GlobalIn, GlobalOut>where
    H: Clone + Eq + Ord + Debug,
    N: Copy + BlockNumberOps + Debug,
    GlobalIn: Stream<Item = Result<CommunicationIn<H, N, E::Signature, E::Id>, E::Error>> + Unpin,
    GlobalOut: Sink<CommunicationOut<H, N, E::Signature, E::Id>, Error = E::Error> + Unpin,

pub fn new(
    env: Arc<E>,
    voters: VoterSet<E::Id>,
    global_comms: (GlobalIn, GlobalOut),
    last_round_number: u64,
    last_round_votes: Vec<SignedMessage<H, N, E::Signature, E::Id>>,
    last_round_base: (H, N),
    last_finalized: (H, N)
) -> Self

Create new Voter tracker with given round number and base block.

Provide data about the last completed round. If there is no known last completed round, the genesis state (round number 0, no votes, genesis base), should be provided. When available, all messages required to complete the last round should be provided.

The input stream for commit messages should provide commits which correspond to known blocks only (including all its precommits). It is also responsible for validating the signature data in commit messages.

Trait Implementations

impl<H, N, E: Environment<H, N>, GlobalIn, GlobalOut> Future for Voter<H, N, E, GlobalIn, GlobalOut>where
    H: Clone + Eq + Ord + Debug,
    N: Copy + BlockNumberOps + Debug,
    GlobalIn: Stream<Item = Result<CommunicationIn<H, N, E::Signature, E::Id>, E::Error>> + Unpin,
    GlobalOut: Sink<CommunicationOut<H, N, E::Signature, E::Id>, Error = E::Error> + Unpin,

type Output = Result<(), <E as Environment<H, N>>::Error>

The type of value produced on completion.

fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Result<(), E::Error>>

Attempt to resolve the future to a final value, registering the current task for wakeup if the value is not yet available.

impl<H, N, E: Environment<H, N>, GlobalIn, GlobalOut> Unpin for Voter<H, N, E, GlobalIn, GlobalOut>where
    H: Clone + Eq + Ord + Debug,
    N: Copy + BlockNumberOps + Debug,
    GlobalIn: Stream<Item = Result<CommunicationIn<H, N, E::Signature, E::Id>, E::Error>> + Unpin,
    GlobalOut: Sink<CommunicationOut<H, N, E::Signature, E::Id>, Error = E::Error> + Unpin,