Struct sc_network_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
    Self: ChainSyncT<B>,
    B: BlockT,
    Client: HeaderBackend<B> + BlockBackend<B> + HeaderMetadata<B, Error = Error> + ProofProvider<B> + Send + Sync + 'static,

pub fn new(
    mode: SyncMode,
    client: Arc<Client>,
    protocol_id: ProtocolId,
    fork_id: &Option<String>,
    roles: Roles,
    block_announce_validator: Box<dyn BlockAnnounceValidator<B> + Send>,
    max_parallel_downloads: u32,
    warp_sync_provider: Option<Arc<dyn WarpSyncProvider<B>>>,
    metrics_registry: Option<&Registry>,
    network_service: NetworkServiceHandle,
    import_queue: Box<dyn ImportQueueService<B>>,
    block_request_protocol_name: ProtocolName,
    state_request_protocol_name: ProtocolName,
    warp_sync_protocol_name: Option<ProtocolName>
) -> Result<(Self, ChainSyncInterfaceHandle<B>, NonDefaultSetConfig), ClientError>

Create a new instance.

pub fn get_block_announce_proto_config(
    protocol_id: ProtocolId,
    fork_id: &Option<String>,
    roles: Roles,
    best_number: NumberFor<B>,
    best_hash: B::Hash,
    genesis_hash: B::Hash
) -> NonDefaultSetConfig

Get config for the block announcement protocol

pub fn on_state_response(
    &mut self,
    peer_id: PeerId,
    response: OpaqueStateResponse
) -> Option<ImportResult<B>>

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

Trait Implementations

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

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

Returns the current sync status.

fn peer_info(&self, who: &PeerId) -> Option<PeerInfo<B>>

Returns the state of the sync of the given peer.

fn num_sync_requests(&self) -> usize

Number of active forks requests. This includes requests that are pending or could be issued right away.

fn num_downloaded_blocks(&self) -> usize

Number of downloaded blocks.

fn num_peers(&self) -> usize

Returns the current number of peers stored within this state machine.

fn num_active_peers(&self) -> usize

Returns the number of peers we’re connected to and that are being queried.

fn new_peer(
    &mut self,
    who: PeerId,
    best_hash: B::Hash,
    best_number: NumberFor<B>
) -> Result<Option<BlockRequest<B>>, BadPeer>

Handle a new connected peer.

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

Signal that a new best block has been imported.

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

Schedule a justification request for the given block.

fn clear_justification_requests(&mut self)

Clear all pending justification requests.

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

Request syncing for the given block from given set of peers.

fn on_block_data(
    &mut self,
    who: &PeerId,
    request: Option<BlockRequest<B>>,
    response: BlockResponse<B>
) -> Result<OnBlockData<B>, BadPeer>

Handle a response from the remote to a block request that we made.

fn process_block_response_data(
    &mut self,
    blocks_to_import: Result<OnBlockData<B>, BadPeer>
)

Procss received block data.

fn on_block_justification(
    &mut self,
    who: PeerId,
    response: BlockResponse<B>
) -> Result<OnBlockJustification<B>, BadPeer>

Handle a response from the remote to a justification request that we made.

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

Call this when a justification has been processed by the import queue, with or without errors.

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

Notify about finalization of the given block.

fn push_block_announce_validation(
    &mut self,
    who: PeerId,
    hash: B::Hash,
    announce: BlockAnnounce<B::Header>,
    is_best: bool
)

Push a block announce validation.

fn poll_block_announce_validation(
    &mut self,
    cx: &mut Context<'_>
) -> Poll<PollBlockAnnounceValidation<B::Header>>

Poll block announce validation.

fn peer_disconnected(&mut self, who: &PeerId)

Call when a peer has disconnected. Canceled obsolete block request may result in some blocks being ready for import, so this functions checks for such blocks and returns them.

fn metrics(&self) -> Metrics

Return some key metrics.

fn block_response_into_blocks(
    &self,
    request: &BlockRequest<B>,
    response: OpaqueBlockResponse
) -> Result<Vec<BlockData<B>>, String>

Access blocks from implementation-specific block response.

fn poll(
    &mut self,
    cx: &mut Context<'_>
) -> Poll<PollBlockAnnounceValidation<B::Header>>

Advance the state of ChainSync

fn send_block_request(&mut self, who: PeerId, request: BlockRequest<B>)

Send block request to peer