Trait ForkChoiceSubscriptions

pub trait ForkChoiceSubscriptions: Send + Sync {
    type Header: Clone + Send + Sync + 'static;

    // Required methods
    fn subscribe_safe_block(&self) -> ForkChoiceNotifications<Self::Header>;
    fn subscribe_finalized_block(&self) -> ForkChoiceNotifications<Self::Header>;

    // Provided methods
    fn safe_block_stream(&self) -> ForkChoiceStream<SealedHeader<Self::Header>> { ... }
    fn finalized_block_stream(
        &self,
    ) -> ForkChoiceStream<SealedHeader<Self::Header>> { ... }
}

A trait that allows to register to fork choice related events and get notified when a new fork choice is available.

Required Associated Types

type Header: Clone + Send + Sync + 'static

Block Header type.

Required Methods

fn subscribe_safe_block(&self) -> ForkChoiceNotifications<Self::Header>

Get notified when a new safe block of the chain is selected.

fn subscribe_finalized_block(&self) -> ForkChoiceNotifications<Self::Header>

Get notified when a new finalized block of the chain is selected.

Provided Methods

fn safe_block_stream(&self) -> ForkChoiceStream<SealedHeader<Self::Header>>

Convenience method to get a stream of the new safe blocks of the chain.

fn finalized_block_stream(&self) -> ForkChoiceStream<SealedHeader<Self::Header>>

Convenience method to get a stream of the new finalized blocks of the chain.

Implementations on Foreign Types

impl<C: Send + Sync, N: NodePrimitives> ForkChoiceSubscriptions for NoopProvider<C, N>

type Header = <N as NodePrimitives>::BlockHeader

fn subscribe_safe_block(&self) -> ForkChoiceNotifications<N::BlockHeader>

fn subscribe_finalized_block(&self) -> ForkChoiceNotifications<N::BlockHeader>

Implementors