Struct sc_network_sync::ChainSync
source · pub struct ChainSync<B: BlockT, Client> { /* private fields */ }
Expand description
The main data structure which contains all the state for a chains active syncing strategy.
Implementations§
source§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,
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,
sourcepub 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,
max_blocks_per_request: u32,
warp_sync_params: Option<WarpSyncParams<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, NonDefaultSetConfig), ClientError>
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, max_blocks_per_request: u32, warp_sync_params: Option<WarpSyncParams<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, NonDefaultSetConfig), ClientError>
Create a new instance.
sourcepub 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
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§
source§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,
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,
source§fn status(&self) -> SyncStatus<B>
fn status(&self) -> SyncStatus<B>
Returns the current sync status.
source§fn peer_info(&self, who: &PeerId) -> Option<PeerInfo<B>>
fn peer_info(&self, who: &PeerId) -> Option<PeerInfo<B>>
Returns the state of the sync of the given peer. Read more
source§fn num_sync_requests(&self) -> usize
fn num_sync_requests(&self) -> usize
Number of active forks requests. This includes
requests that are pending or could be issued right away.
source§fn num_downloaded_blocks(&self) -> usize
fn num_downloaded_blocks(&self) -> usize
Number of downloaded blocks.
source§fn num_peers(&self) -> usize
fn num_peers(&self) -> usize
Returns the current number of peers stored within this state machine.
source§fn num_active_peers(&self) -> usize
fn num_active_peers(&self) -> usize
Returns the number of peers we’re connected to and that are being queried.
source§fn new_peer(
&mut self,
who: PeerId,
best_hash: B::Hash,
best_number: NumberFor<B>,
) -> Result<Option<BlockRequest<B>>, BadPeer>
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. Read more
source§fn update_chain_info(&mut self, best_hash: &B::Hash, best_number: NumberFor<B>)
fn update_chain_info(&mut self, best_hash: &B::Hash, best_number: NumberFor<B>)
Signal that a new best block has been imported.
source§fn request_justification(&mut self, hash: &B::Hash, number: NumberFor<B>)
fn request_justification(&mut self, hash: &B::Hash, number: NumberFor<B>)
Schedule a justification request for the given block.
source§fn clear_justification_requests(&mut self)
fn clear_justification_requests(&mut self)
Clear all pending justification requests.
source§fn set_sync_fork_request(
&mut self,
peers: Vec<PeerId>,
hash: &B::Hash,
number: NumberFor<B>,
)
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.
source§fn on_block_data(
&mut self,
who: &PeerId,
request: Option<BlockRequest<B>>,
response: BlockResponse<B>,
) -> Result<OnBlockData<B>, BadPeer>
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. Read more
source§fn on_block_justification(
&mut self,
who: PeerId,
response: BlockResponse<B>,
) -> Result<OnBlockJustification<B>, BadPeer>
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. Read more
source§fn on_justification_import(
&mut self,
hash: B::Hash,
number: NumberFor<B>,
success: bool,
)
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.
source§fn on_block_finalized(&mut self, hash: &B::Hash, number: NumberFor<B>)
fn on_block_finalized(&mut self, hash: &B::Hash, number: NumberFor<B>)
Notify about finalization of the given block.
source§fn push_block_announce_validation(
&mut self,
who: PeerId,
hash: B::Hash,
announce: BlockAnnounce<B::Header>,
is_best: bool,
)
fn push_block_announce_validation( &mut self, who: PeerId, hash: B::Hash, announce: BlockAnnounce<B::Header>, is_best: bool, )
Push a block announce validation. Read more
source§fn poll_block_announce_validation(
&mut self,
cx: &mut Context<'_>,
) -> Poll<PollBlockAnnounceValidation<B::Header>>
fn poll_block_announce_validation( &mut self, cx: &mut Context<'_>, ) -> Poll<PollBlockAnnounceValidation<B::Header>>
Poll block announce validation. Read more
source§fn peer_disconnected(&mut self, who: &PeerId)
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.
source§fn block_response_into_blocks(
&self,
request: &BlockRequest<B>,
response: OpaqueBlockResponse,
) -> Result<Vec<BlockData<B>>, String>
fn block_response_into_blocks( &self, request: &BlockRequest<B>, response: OpaqueBlockResponse, ) -> Result<Vec<BlockData<B>>, String>
Access blocks from implementation-specific block response.
source§fn poll(
&mut self,
cx: &mut Context<'_>,
) -> Poll<PollBlockAnnounceValidation<B::Header>>
fn poll( &mut self, cx: &mut Context<'_>, ) -> Poll<PollBlockAnnounceValidation<B::Header>>
Advance the state of
ChainSync
Read moresource§fn send_block_request(&mut self, who: PeerId, request: BlockRequest<B>)
fn send_block_request(&mut self, who: PeerId, request: BlockRequest<B>)
Send block request to peer
Auto Trait Implementations§
impl<B, Client> !Freeze for ChainSync<B, Client>
impl<B, Client> !RefUnwindSafe for ChainSync<B, Client>
impl<B, Client> Send for ChainSync<B, Client>
impl<B, Client> !Sync for ChainSync<B, Client>
impl<B, Client> Unpin for ChainSync<B, Client>
impl<B, Client> !UnwindSafe for ChainSync<B, Client>
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
source§impl<T> CheckedConversion for T
impl<T> CheckedConversion for T
source§impl<T> FmtForward for T
impl<T> FmtForward for T
source§fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
Causes
self
to use its Binary
implementation when Debug
-formatted.source§fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
Causes
self
to use its Display
implementation when
Debug
-formatted.source§fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
Causes
self
to use its LowerExp
implementation when
Debug
-formatted.source§fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
Causes
self
to use its LowerHex
implementation when
Debug
-formatted.source§fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
Causes
self
to use its Octal
implementation when Debug
-formatted.source§fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
Causes
self
to use its Pointer
implementation when
Debug
-formatted.source§fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
Causes
self
to use its UpperExp
implementation when
Debug
-formatted.source§fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
Causes
self
to use its UpperHex
implementation when
Debug
-formatted.source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
Converts
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
Converts
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§impl<T, Outer> IsWrappedBy<Outer> for T
impl<T, Outer> IsWrappedBy<Outer> for T
source§impl<T> Pipe for Twhere
T: ?Sized,
impl<T> Pipe for Twhere
T: ?Sized,
source§fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
Pipes by value. This is generally the method you want to use. Read more
source§fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
Borrows
self
and passes that borrow into the pipe function. Read moresource§fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
Mutably borrows
self
and passes that borrow into the pipe function. Read moresource§fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
source§fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R,
) -> R
fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
source§fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
Borrows
self
, then passes self.as_ref()
into the pipe function.source§fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
Mutably borrows
self
, then passes self.as_mut()
into the pipe
function.source§fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
Borrows
self
, then passes self.deref()
into the pipe function.source§impl<T> Pointable for T
impl<T> Pointable for T
source§impl<T> SaturatedConversion for T
impl<T> SaturatedConversion for T
source§fn saturated_from<T>(t: T) -> Selfwhere
Self: UniqueSaturatedFrom<T>,
fn saturated_from<T>(t: T) -> Selfwhere
Self: UniqueSaturatedFrom<T>,
source§fn saturated_into<T>(self) -> Twhere
Self: UniqueSaturatedInto<T>,
fn saturated_into<T>(self) -> Twhere
Self: UniqueSaturatedInto<T>,
Consume self to return an equivalent value of
T
. Read moresource§impl<T> Tap for T
impl<T> Tap for T
source§fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
Immutable access to the
Borrow<B>
of a value. Read moresource§fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
Mutable access to the
BorrowMut<B>
of a value. Read moresource§fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
Immutable access to the
AsRef<R>
view of a value. Read moresource§fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
Mutable access to the
AsMut<R>
view of a value. Read moresource§fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
Immutable access to the
Deref::Target
of a value. Read moresource§fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
Mutable access to the
Deref::Target
of a value. Read moresource§fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
Calls
.tap()
only in debug builds, and is erased in release builds.source§fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
Calls
.tap_mut()
only in debug builds, and is erased in release
builds.source§fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
Calls
.tap_borrow()
only in debug builds, and is erased in release
builds.source§fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
Calls
.tap_borrow_mut()
only in debug builds, and is erased in release
builds.source§fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
Calls
.tap_ref()
only in debug builds, and is erased in release
builds.source§fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
Calls
.tap_ref_mut()
only in debug builds, and is erased in release
builds.source§fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
Calls
.tap_deref()
only in debug builds, and is erased in release
builds.source§impl<S, T> UncheckedInto<T> for Swhere
T: UncheckedFrom<S>,
impl<S, T> UncheckedInto<T> for Swhere
T: UncheckedFrom<S>,
source§fn unchecked_into(self) -> T
fn unchecked_into(self) -> T
The counterpart to
unchecked_from
.source§impl<T, S> UniqueSaturatedInto<T> for S
impl<T, S> UniqueSaturatedInto<T> for S
source§fn unique_saturated_into(self) -> T
fn unique_saturated_into(self) -> T
Consume self to return an equivalent value of
T
.