Struct ChainSync

pub struct ChainSync<B: BlockT, Client> { /* private fields */ }

The main data structure which contains all the state for a chains active syncing strategy.

Implementations

impl<B, Client> ChainSync<B, Client>

where B: BlockT, Client: HeaderBackend<B> + BlockBackend<B> + HeaderMetadata<B, Error = Error> + ProofProvider<B> + Send + Sync + 'static,

pub const STRATEGY_KEY: StrategyKey

Strategy key used by chain sync.

pub fn new( mode: ChainSyncMode, client: Arc<Client>, max_parallel_downloads: u32, max_blocks_per_request: u32, state_request_protocol_name: ProtocolName, block_downloader: Arc<dyn BlockDownloader<B>>, metrics_registry: Option<&Registry>, initial_peers: impl Iterator<Item = (PeerId, B::Hash, NumberFor<B>)>, ) -> Result<Self, ClientError>

Create a new instance.

Trait Implementations

impl<B, Client> SyncingStrategy<B> for ChainSync<B, Client>

where B: BlockT, Client: HeaderBackend<B> + BlockBackend<B> + HeaderMetadata<B, Error = Error> + ProofProvider<B> + Send + Sync + 'static,

fn add_peer( &mut self, peer_id: PeerId, best_hash: B::Hash, best_number: NumberFor<B>, )

Notify syncing state machine that a new sync peer has connected.

fn remove_peer(&mut self, peer_id: &PeerId)

Notify that a sync peer has disconnected.

fn on_validated_block_announce( &mut self, is_best: bool, peer_id: PeerId, announce: &BlockAnnounce<B::Header>, ) -> Option<(B::Hash, NumberFor<B>)>

Submit a validated block announcement.

fn set_sync_fork_request( &mut self, peers: Vec<PeerId>, hash: &B::Hash, number: NumberFor<B>, )

Configure an explicit fork sync request in case external code has detected that there is a stale fork missing.

fn request_justification(&mut self, hash: &B::Hash, number: NumberFor<B>)

Request extra justification.

fn clear_justification_requests(&mut self)

Clear extra justification requests.

fn on_justification_import( &mut self, hash: B::Hash, number: NumberFor<B>, success: bool, )

Report a justification import (successful or not).

fn on_generic_response( &mut self, peer_id: &PeerId, key: StrategyKey, protocol_name: ProtocolName, response: Box<dyn Any + Send>, )

Process generic response.

fn on_blocks_processed( &mut self, imported: usize, count: usize, results: Vec<(Result<BlockImportStatus<NumberFor<B>>, BlockImportError>, B::Hash)>, )

A batch of blocks that have been processed, with or without errors.

fn on_block_finalized(&mut self, hash: &B::Hash, number: NumberFor<B>)

Notify a syncing strategy that a block has been finalized.

fn update_chain_info(&mut self, best_hash: &B::Hash, best_number: NumberFor<B>)

Inform sync about a new best imported block.

fn is_major_syncing(&self) -> bool

fn num_peers(&self) -> usize

Get the number of peers known to the syncing strategy.

fn status(&self) -> SyncStatus<B>

Returns the current sync status.

fn num_downloaded_blocks(&self) -> usize

Get the total number of downloaded blocks.

fn num_sync_requests(&self) -> usize

Get an estimate of the number of parallel sync requests.

fn actions( &mut self, network_service: &NetworkServiceHandle, ) -> Result<Vec<SyncingAction<B>>, ClientError>

Get actions that should be performed by the owner on the strategy’s behalf