Struct nakamoto_p2p::protocol::spvmgr::SpvManager

pub struct SpvManager<F, U> { /* fields omitted */ }

A compact block filter manager.

Implementations

impl<F: Filters, U: SyncFilters + Events + SetTimeout> SpvManager<F, U>

pub fn new(config: Config, rng: Rng, filters: F, upstream: U) -> Self

Create a new filter manager.

pub fn initialize<T: BlockTree>(&mut self, now: LocalTime, tree: &T)

Initialize the spv manager. Should only be called once.

pub fn idle<T: BlockTree>(&mut self, now: LocalTime, tree: &T)

Called periodically. Triggers syncing if necessary.

pub fn received_timeout<T: BlockTree>(&mut self, now: LocalTime, tree: &T)

A timeout was received.

pub fn rollback(&mut self, n: usize) -> Result<(), Error>

Rollback filter header chain by a given number of headers.

pub fn get_cfilters<T: BlockTree>(&mut self, range: Range<Height>, tree: &T)

Send a getcfilters message to a random peer.

Panics if there are no peers available.

pub fn received_cfheaders<T: BlockTree>(
    &mut self,
    from: &PeerId,
    msg: CFHeaders,
    tree: &T,
    time: LocalTime
) -> Result<Height, Error>

Handle a cfheaders message from a peer.

pub fn received_getcfheaders<T: BlockTree>(
    &mut self,
    from: &PeerId,
    msg: GetCFHeaders,
    tree: &T
) -> Result<(), Error>

Handle a getcfheaders message from a peer.

pub fn received_cfilter<T: BlockTree>(
    &mut self,
    from: &PeerId,
    msg: CFilter,
    tree: &T
) -> Result<(), Error>

Handle a cfilter message.

pub fn received_getcfilters<T: BlockTree>(
    &mut self,
    _addr: &PeerId,
    msg: GetCFilters,
    _tree: &T
)

Handle getcfilters message.

pub fn peer_disconnected(&mut self, id: &PeerId)

Called when a peer disconnected.

pub fn peer_negotiated<T: BlockTree>(
    &mut self,
    id: PeerId,
    height: Height,
    services: ServiceFlags,
    link: Link,
    clock: &impl Clock,
    tree: &T
)

Called when a new peer was negotiated.

pub fn send_getcfheaders<T: BlockTree>(
    &mut self,
    range: Range<Height>,
    tree: &T,
    time: LocalTime
) -> Option<(PeerId, Height, BlockHash)>

Send a getcfheaders message to a random peer.

pub fn sync<T: BlockTree>(&mut self, tree: &T, time: LocalTime)

Attempt to sync the filter header chain.

Trait Implementations

impl<F: Debug, U: Debug> Debug for SpvManager<F, U>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.