Struct StateStrategy

pub struct StateStrategy<B: BlockT> { /* private fields */ }

Syncing strategy that downloads and imports a recent state directly.

Implementations

impl<B: BlockT> StateStrategy<B>

pub const STRATEGY_KEY: StrategyKey

Strategy key used by state sync.

pub fn new<Client>( client: Arc<Client>, target_header: B::Header, target_body: Option<Vec<B::Extrinsic>>, target_justifications: Option<Justifications>, skip_proof: bool, initial_peers: impl Iterator<Item = (PeerId, NumberFor<B>)>, protocol_name: ProtocolName, ) -> Self

where Client: ProofProvider<B> + Send + Sync + 'static,

Create a new instance.

pub fn new_with_provider( state_sync_provider: Box<dyn StateSyncProvider<B>>, initial_peers: impl Iterator<Item = (PeerId, NumberFor<B>)>, protocol_name: ProtocolName, ) -> Self

Create a new instance with a custom state sync provider.

Note: In most cases, users should use StateStrategy::new. This method is intended for custom sync strategies and advanced use cases.

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_state_response(&mut self, peer_id: &PeerId, response: Vec<u8>)

Process state 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.

Normally this should be called when target block with state is imported.

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.

pub fn is_succeeded(&self) -> bool

Check if state sync has succeeded.