Struct sc_network_sync::strategy::chain_sync::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 fn new( mode: ChainSyncMode, client: Arc<Client>, max_parallel_downloads: u32, max_blocks_per_request: u32, metrics_registry: Option<Registry>, initial_peers: impl Iterator<Item = (PeerId, B::Hash, NumberFor<B>)>, ) -> Result<Self, ClientError>

Create a new instance.

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

Returns the current sync status.

pub fn num_sync_requests(&self) -> usize

Get an estimate of the number of parallel sync requests.

pub fn num_downloaded_blocks(&self) -> usize

Get the total number of downloaded blocks.

pub fn num_peers(&self) -> usize

Get the number of peers known to the syncing state machine.

pub 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.

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

Inform sync about a new best imported block.

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

Request extra justification.

pub fn clear_justification_requests(&mut self)

Clear extra justification requests.

pub 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.

Note that this function should not be used for recent blocks. Sync should be able to download all the recent forks normally.

Passing empty peers set effectively removes the sync request.

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

Report a justification import (successful or not).

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

Notify sync that a block has been finalized.

pub 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.

Returns new best hash & best number of the peer if they are updated.

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

Notify that a sync peer has disconnected.

pub fn report_metrics(&self)

Report prometheus metrics.

pub fn on_block_response( &mut self, peer_id: PeerId, request: BlockRequest<B>, blocks: Vec<BlockData<B>>, )

Submit blocks received in a response.

pub fn on_state_response( &mut self, peer_id: PeerId, response: OpaqueStateResponse, )

Submit a state received in a response.

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

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

Call this when a batch of blocks have been processed by the import queue, with or without errors.

pub fn actions(&mut self) -> impl Iterator<Item = ChainSyncAction<B>>

Get pending actions to perform.