Struct vapcore_sync::light_sync::LightSync

pub struct LightSync<L: AsLightClient> { /* fields omitted */ }

Light client synchronization manager. See module docs for more details.

Implementations

impl<L: AsLightClient> LightSync<L>

pub fn new(client: Arc<L>) -> Result<Self, Error>

Create a new instance of LightSync.

This won’t do anything until registered as a handler so it can act on events.

Trait Implementations

impl<L: AsLightClient + Send + Sync> Handler for LightSync<L>

fn on_connect(
    &self,
    ctx: &dyn EventContext,
    status: &Status,
    capabilities: &Capabilities
) -> PeerStatus

Called when a peer connects.

fn on_disconnect(&self, ctx: &dyn EventContext, unfulfilled: &[ReqId])

Called when a peer disconnects, with a list of unfulfilled request IDs as of yet.

fn on_announcement(&self, ctx: &dyn EventContext, announcement: &Announcement)

Called when a peer makes an announcement.

fn on_responses(
    &self,
    ctx: &dyn EventContext,
    req_id: ReqId,
    responses: &[Response]
)

Called when a peer responds to requests. Responses not guaranteed to contain valid data and are not yet checked against the requests they correspond to.

fn tick(&self, ctx: &dyn BasicContext)

Called to “tick” the handler periodically.

pub fn on_transactions(
    &self,
    _ctx: &dyn EventContext,
    _relay: &[UnverifiedTransaction]
)

Called when a peer requests relay of some transactions.

pub fn on_transaction_proof(
    &self,
    _ctx: &dyn EventContext,
    _req_id: ReqId,
    _state_items: &[Vec<u8, Global>]
)

Called when a peer responds with a transaction proof. Each proof is a vector of state items.

pub fn on_abort(&self)

Called on abort. This signals to handlers that they should clean up and ignore peers.

impl<L: AsLightClient> SyncInfo for LightSync<L>

fn highest_block(&self) -> Option<u64>

Get the highest block advertised on the network.

fn start_block(&self) -> u64

Get the block number at the time of sync start.

fn is_major_importing(&self) -> bool

Whether major sync is underway.

fn sync_notification(&self) -> Notification<ChainSyncState>

returns the receieving end of a futures::mpsc unbounded channel poll the channel for changes to sync state