Struct finality_grandpa::voter::Voter [−][src]
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: 'a, N, E: 'a, GlobalIn, GlobalOut> Voter<H, N, E, GlobalIn, GlobalOut> where
H: Clone + Ord + Debug + Sync + Send,
N: BlockNumberOps + Sync + Send,
E: Environment<H, N> + Sync + Send,
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, [src]
H: Clone + Ord + Debug + Sync + Send,
N: BlockNumberOps + Sync + Send,
E: Environment<H, N> + Sync + Send,
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 + Sync,
<E as Environment<H, N>>::Id: Hash + Send + Sync,
<E as Environment<H, N>>::Timer: Send + Sync,
<E as Environment<H, N>>::Out: Send + Sync,
<E as Environment<H, N>>::In: Send + Sync, [src]
<E as Environment<H, N>>::Signature: Send + Sync,
<E as Environment<H, N>>::Id: Hash + Send + Sync,
<E as Environment<H, N>>::Timer: Send + Sync,
<E as Environment<H, N>>::Out: Send + Sync,
<E as Environment<H, N>>::In: Send + Sync,
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, [src]
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[src]
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, [src]
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::Error>
The type of value produced on completion.
fn poll(
self: Pin<&mut Self>,
cx: &mut Context<'_>
) -> Poll<Result<(), E::Error>>[src]
self: Pin<&mut Self>,
cx: &mut Context<'_>
) -> Poll<Result<(), E::Error>>
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, [src]
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,
Auto Trait Implementations
impl<H, N, E, GlobalIn, GlobalOut> !RefUnwindSafe for Voter<H, N, E, GlobalIn, GlobalOut>
impl<H, N, E, GlobalIn, GlobalOut> Send for Voter<H, N, E, GlobalIn, GlobalOut> where
E: Send + Sync,
GlobalIn: Send,
GlobalOut: Send,
H: Send + Sync,
N: Send + Sync,
<E as Environment<H, N>>::Id: Send + Sync,
<E as Environment<H, N>>::In: Send + Sync,
<E as Environment<H, N>>::Out: Send + Sync,
<E as Environment<H, N>>::Signature: Send + Sync,
<E as Environment<H, N>>::Timer: Send + Sync,
E: Send + Sync,
GlobalIn: Send,
GlobalOut: Send,
H: Send + Sync,
N: Send + Sync,
<E as Environment<H, N>>::Id: Send + Sync,
<E as Environment<H, N>>::In: Send + Sync,
<E as Environment<H, N>>::Out: Send + Sync,
<E as Environment<H, N>>::Signature: Send + Sync,
<E as Environment<H, N>>::Timer: Send + Sync,
impl<H, N, E, GlobalIn, GlobalOut> Sync for Voter<H, N, E, GlobalIn, GlobalOut> where
E: Send + Sync,
GlobalIn: Sync,
GlobalOut: Sync,
H: Send + Sync,
N: Send + Sync,
<E as Environment<H, N>>::Id: Send + Sync,
<E as Environment<H, N>>::In: Send + Sync,
<E as Environment<H, N>>::Out: Send + Sync,
<E as Environment<H, N>>::Signature: Send + Sync,
<E as Environment<H, N>>::Timer: Send + Sync,
E: Send + Sync,
GlobalIn: Sync,
GlobalOut: Sync,
H: Send + Sync,
N: Send + Sync,
<E as Environment<H, N>>::Id: Send + Sync,
<E as Environment<H, N>>::In: Send + Sync,
<E as Environment<H, N>>::Out: Send + Sync,
<E as Environment<H, N>>::Signature: Send + Sync,
<E as Environment<H, N>>::Timer: Send + Sync,
impl<H, N, E, GlobalIn, GlobalOut> !UnwindSafe for Voter<H, N, E, GlobalIn, GlobalOut>
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized, [src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized, [src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized, [src]
T: ?Sized,
pub fn borrow_mut(&mut self) -> &mut T[src]
impl<T> From<T> for T[src]
impl<T> FutureExt for T where
T: Future + ?Sized, [src]
T: Future + ?Sized,
pub fn map<U, F>(self, f: F) -> Map<Self, F> where
F: FnOnce(Self::Output) -> U, [src]
F: FnOnce(Self::Output) -> U,
pub fn map_into<U>(self) -> MapInto<Self, U> where
Self::Output: Into<U>, [src]
Self::Output: Into<U>,
pub fn then<Fut, F>(self, f: F) -> Then<Self, Fut, F> where
F: FnOnce(Self::Output) -> Fut,
Fut: Future, [src]
F: FnOnce(Self::Output) -> Fut,
Fut: Future,
pub fn left_future<B>(self) -> Either<Self, B> where
B: Future<Output = Self::Output>, [src]
B: Future<Output = Self::Output>,
pub fn right_future<A>(self) -> Either<A, Self> where
A: Future<Output = Self::Output>, [src]
A: Future<Output = Self::Output>,
pub fn into_stream(self) -> IntoStream<Self>[src]
pub fn flatten(self) -> Flatten<Self> where
Self::Output: Future, [src]
Self::Output: Future,
pub fn flatten_stream(self) -> FlattenStream<Self> where
Self::Output: Stream, [src]
Self::Output: Stream,
pub fn fuse(self) -> Fuse<Self>[src]
pub fn inspect<F>(self, f: F) -> Inspect<Self, F> where
F: FnOnce(&Self::Output), [src]
F: FnOnce(&Self::Output),
pub fn catch_unwind(self) -> CatchUnwind<Self> where
Self: UnwindSafe, [src]
Self: UnwindSafe,
pub fn shared(self) -> Shared<Self> where
Self::Output: Clone, [src]
Self::Output: Clone,
pub fn remote_handle(self) -> (Remote<Self>, RemoteHandle<Self::Output>)[src]
pub fn boxed<'a>(
self
) -> Pin<Box<dyn Future<Output = Self::Output> + 'a + Send, Global>> where
Self: Send + 'a, [src]
self
) -> Pin<Box<dyn Future<Output = Self::Output> + 'a + Send, Global>> where
Self: Send + 'a,
pub fn boxed_local<'a>(
self
) -> Pin<Box<dyn Future<Output = Self::Output> + 'a, Global>> where
Self: 'a, [src]
self
) -> Pin<Box<dyn Future<Output = Self::Output> + 'a, Global>> where
Self: 'a,
pub fn unit_error(self) -> UnitError<Self>[src]
pub fn never_error(self) -> NeverError<Self>[src]
pub fn poll_unpin(&mut self, cx: &mut Context<'_>) -> Poll<Self::Output> where
Self: Unpin, [src]
Self: Unpin,
pub fn now_or_never(self) -> Option<Self::Output>[src]
impl<T, U> Into<U> for T where
U: From<T>, [src]
U: From<T>,
impl<F> IntoFuture for F where
F: Future, [src]
F: Future,
type Output = <F as Future>::Output
🔬 This is a nightly-only experimental API. (
into_future)The output that the future will produce on completion.
type Future = F
🔬 This is a nightly-only experimental API. (
into_future)Which kind of future are we turning this into?
pub fn into_future(self) -> <F as IntoFuture>::Future[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>, [src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>[src]
impl<F, T, E> TryFuture for F where
F: Future<Output = Result<T, E>> + ?Sized, [src]
F: Future<Output = Result<T, E>> + ?Sized,
type Ok = T
The type of successful values yielded by this future
type Error = E
The type of failures yielded by this future
pub fn try_poll(
self: Pin<&mut F>,
cx: &mut Context<'_>
) -> Poll<<F as Future>::Output>[src]
self: Pin<&mut F>,
cx: &mut Context<'_>
) -> Poll<<F as Future>::Output>
impl<Fut> TryFutureExt for Fut where
Fut: TryFuture + ?Sized, [src]
Fut: TryFuture + ?Sized,
pub fn flatten_sink<Item>(self) -> FlattenSink<Self, Self::Ok> where
Self::Ok: Sink<Item>,
<Self::Ok as Sink<Item>>::Error == Self::Error, [src]
Self::Ok: Sink<Item>,
<Self::Ok as Sink<Item>>::Error == Self::Error,
pub fn map_ok<T, F>(self, f: F) -> MapOk<Self, F> where
F: FnOnce(Self::Ok) -> T, [src]
F: FnOnce(Self::Ok) -> T,
pub fn map_ok_or_else<T, E, F>(self, e: E, f: F) -> MapOkOrElse<Self, F, E> where
E: FnOnce(Self::Error) -> T,
F: FnOnce(Self::Ok) -> T, [src]
E: FnOnce(Self::Error) -> T,
F: FnOnce(Self::Ok) -> T,
pub fn map_err<E, F>(self, f: F) -> MapErr<Self, F> where
F: FnOnce(Self::Error) -> E, [src]
F: FnOnce(Self::Error) -> E,
pub fn err_into<E>(self) -> ErrInto<Self, E> where
Self::Error: Into<E>, [src]
Self::Error: Into<E>,
pub fn ok_into<U>(self) -> OkInto<Self, U> where
Self::Ok: Into<U>, [src]
Self::Ok: Into<U>,
pub fn and_then<Fut, F>(self, f: F) -> AndThen<Self, Fut, F> where
F: FnOnce(Self::Ok) -> Fut,
Fut: TryFuture<Error = Self::Error>, [src]
F: FnOnce(Self::Ok) -> Fut,
Fut: TryFuture<Error = Self::Error>,
pub fn or_else<Fut, F>(self, f: F) -> OrElse<Self, Fut, F> where
F: FnOnce(Self::Error) -> Fut,
Fut: TryFuture<Ok = Self::Ok>, [src]
F: FnOnce(Self::Error) -> Fut,
Fut: TryFuture<Ok = Self::Ok>,
pub fn inspect_ok<F>(self, f: F) -> InspectOk<Self, F> where
F: FnOnce(&Self::Ok), [src]
F: FnOnce(&Self::Ok),
pub fn inspect_err<F>(self, f: F) -> InspectErr<Self, F> where
F: FnOnce(&Self::Error), [src]
F: FnOnce(&Self::Error),
pub fn try_flatten(self) -> TryFlatten<Self, Self::Ok> where
Self::Ok: TryFuture,
<Self::Ok as TryFuture>::Error == Self::Error, [src]
Self::Ok: TryFuture,
<Self::Ok as TryFuture>::Error == Self::Error,
pub fn try_flatten_stream(self) -> TryFlattenStream<Self> where
Self::Ok: TryStream,
<Self::Ok as TryStream>::Error == Self::Error, [src]
Self::Ok: TryStream,
<Self::Ok as TryStream>::Error == Self::Error,
pub fn unwrap_or_else<F>(self, f: F) -> UnwrapOrElse<Self, F> where
F: FnOnce(Self::Error) -> Self::Ok, [src]
F: FnOnce(Self::Error) -> Self::Ok,
pub fn compat(self) -> Compat<Self> where
Self: Unpin, [src]
Self: Unpin,
pub fn into_future(self) -> IntoFuture<Self>[src]
pub fn try_poll_unpin(
&mut self,
cx: &mut Context<'_>
) -> Poll<Result<Self::Ok, Self::Error>> where
Self: Unpin, [src]
&mut self,
cx: &mut Context<'_>
) -> Poll<Result<Self::Ok, Self::Error>> where
Self: Unpin,
impl<T, U> TryInto<U> for T where
U: TryFrom<T>, [src]
U: TryFrom<T>,