Struct WarpSync

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

Warp sync state machine. Accumulates warp proofs and state.

Implementations

impl<B, Client> WarpSync<B, Client>

where B: BlockT, Client: HeaderBackend<B> + 'static,

pub const STRATEGY_KEY: StrategyKey

Strategy key used by warp sync.

pub fn new( client: Arc<Client>, warp_sync_config: WarpSyncConfig<B>, protocol_name: Option<ProtocolName>, block_downloader: Arc<dyn BlockDownloader<B>>, ) -> Self

Create a new instance. When passing a warp sync provider we will be checking for proof and authorities. Alternatively we can pass a target block when we want to skip downloading proofs, in this case we will continue polling until the target block is known.

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

Notify that a new peer has connected.

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

Notify that a peer has disconnected.

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 on_generic_response( &mut self, peer_id: &PeerId, protocol_name: ProtocolName, response: Box<dyn Any + Send>, )

pub fn on_warp_proof_response( &mut self, peer_id: &PeerId, response: EncodedProof, )

Process warp proof response.

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

Process (target) block response.

pub fn progress(&self) -> WarpSyncProgress<B>

Returns warp sync estimated progress (stage, bytes received).

pub fn num_peers(&self) -> usize

Get the number of peers known to warp sync.

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

Returns the current sync status.

pub fn actions( &mut self, network_service: &NetworkServiceHandle, ) -> impl Iterator<Item = SyncingAction<B>>

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

pub fn take_result(&mut self) -> Option<WarpSyncResult<B>>

Take the result of finished warp sync, returning None if the sync was unsuccessful.