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 = CommunicationIn<H, N, E::Signature, E::Id>, Error = E::Error>,
    GlobalOut: Sink<SinkItem = CommunicationOut<H, N, E::Signature, E::Id>, SinkError = E::Error>,  { /* fields omitted */ }

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.

Methods

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 = CommunicationIn<H, N, E::Signature, E::Id>, Error = E::Error>,
    GlobalOut: Sink<SinkItem = CommunicationOut<H, N, E::Signature, E::Id>, SinkError = E::Error>, 

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 = CommunicationIn<H, N, E::Signature, E::Id>, Error = E::Error>,
    GlobalOut: Sink<SinkItem = CommunicationOut<H, N, E::Signature, E::Id>, SinkError = E::Error>, 

type Item = ()

The type of value that this future will resolved with if it is successful.

type Error = E::Error

The type of error that this future will resolve with if it fails in a normal fashion.

fn poll(&mut self) -> Poll<(), E::Error>

Query this future to see if its value has become available, registering interest if it is not.

fn wait(self) -> Result<Self::Item, Self::Error>

Block the current thread until this future is resolved.

fn map<F, U>(self, f: F) -> Map<Self, F> where
    F: FnOnce(Self::Item) -> U, 

Map this future's result to a different type, returning a new future of the resulting type.

fn map_err<F, E>(self, f: F) -> MapErr<Self, F> where
    F: FnOnce(Self::Error) -> E, 

Map this future's error to a different error, returning a new future.

fn from_err<E>(self) -> FromErr<Self, E> where
    E: From<Self::Error>, 

Map this future's error to any error implementing From for this future's Error, returning a new future.

fn then<F, B>(self, f: F) -> Then<Self, B, F> where
    B: IntoFuture,
    F: FnOnce(Result<Self::Item, Self::Error>) -> B, 

Chain on a computation for when a future finished, passing the result of the future to the provided closure f.

fn and_then<F, B>(self, f: F) -> AndThen<Self, B, F> where
    B: IntoFuture<Error = Self::Error>,
    F: FnOnce(Self::Item) -> B, 

Execute another future after this one has resolved successfully.

fn or_else<F, B>(self, f: F) -> OrElse<Self, B, F> where
    B: IntoFuture<Item = Self::Item>,
    F: FnOnce(Self::Error) -> B, 

Execute another future if this one resolves with an error.

fn select<B>(self, other: B) -> Select<Self, <B as IntoFuture>::Future> where
    B: IntoFuture<Item = Self::Item, Error = Self::Error>, 

Waits for either one of two futures to complete.

fn select2<B>(self, other: B) -> Select2<Self, <B as IntoFuture>::Future> where
    B: IntoFuture, 

Waits for either one of two differently-typed futures to complete.

fn join<B>(self, other: B) -> Join<Self, <B as IntoFuture>::Future> where
    B: IntoFuture<Error = Self::Error>, 

Joins the result of two futures, waiting for them both to complete.

fn join3<B, C>(
    self,
    b: B,
    c: C
) -> Join3<Self, <B as IntoFuture>::Future, <C as IntoFuture>::Future> where
    B: IntoFuture<Error = Self::Error>,
    C: IntoFuture<Error = Self::Error>, 

Same as join, but with more futures.

fn join4<B, C, D>(
    self,
    b: B,
    c: C,
    d: D
) -> Join4<Self, <B as IntoFuture>::Future, <C as IntoFuture>::Future, <D as IntoFuture>::Future> where
    B: IntoFuture<Error = Self::Error>,
    C: IntoFuture<Error = Self::Error>,
    D: IntoFuture<Error = Self::Error>, 

Same as join, but with more futures.

fn join5<B, C, D, E>(
    self,
    b: B,
    c: C,
    d: D,
    e: E
) -> Join5<Self, <B as IntoFuture>::Future, <C as IntoFuture>::Future, <D as IntoFuture>::Future, <E as IntoFuture>::Future> where
    B: IntoFuture<Error = Self::Error>,
    C: IntoFuture<Error = Self::Error>,
    D: IntoFuture<Error = Self::Error>,
    E: IntoFuture<Error = Self::Error>, 

Same as join, but with more futures.

fn into_stream(self) -> IntoStream<Self>

Convert this future into a single element stream.

fn flatten(self) -> Flatten<Self> where
    Self::Item: IntoFuture,
    <Self::Item as IntoFuture>::Error: From<Self::Error>, 

Flatten the execution of this future when the successful result of this future is itself another future.

fn flatten_stream(self) -> FlattenStream<Self> where
    Self::Item: Stream,
    <Self::Item as Stream>::Error == Self::Error, 

Flatten the execution of this future when the successful result of this future is a stream.

fn fuse(self) -> Fuse<Self>

Fuse a future such that poll will never again be called once it has completed.

fn inspect<F>(self, f: F) -> Inspect<Self, F> where
    F: FnOnce(&Self::Item), 

Do something with the item of a future, passing it on.

fn catch_unwind(self) -> CatchUnwind<Self> where
    Self: UnwindSafe, 

Catches unwinding panics while polling the future.

fn shared(self) -> Shared<Self>

Create a cloneable handle to this future where all handles will resolve to the same result.