Struct sc_network_sync::warp::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> + ProofProvider<B> + 'static,

pub fn new(client: Arc<Client>, warp_sync_params: WarpSyncParams<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 poll(&mut self, cx: &mut Context<'_>)

Poll to make progress.

This only makes progress when phase = Phase::PendingTargetBlock and the pending block was sent.

pub fn import_state(&mut self, response: StateResponse) -> ImportResult<B>

Validate and import a state response.

pub fn import_warp_proof( &mut self, response: EncodedProof, ) -> WarpProofImportResult

Validate and import a warp proof response.

pub fn import_target_block( &mut self, block: BlockData<B>, ) -> TargetBlockImportResult

Import the target block body.

pub fn next_state_request(&self) -> Option<StateRequest>

Produce next state request.

pub fn next_warp_proof_request(&self) -> Option<WarpProofRequest<B>>

Produce next warp proof request.

pub fn next_target_block_request( &self, ) -> Option<(NumberFor<B>, BlockRequest<B>)>

Produce next target block request.

pub fn target_block_hash(&self) -> Option<B::Hash>

Return target block hash if it is known.

pub fn target_block_number(&self) -> Option<NumberFor<B>>

Return target block number if it is known.

pub fn is_complete(&self) -> bool

Check if the state is complete.

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

Returns state sync estimated progress (percentage, bytes)