Struct TipWatcher 

pub struct TipWatcher { /* private fields */ }

Implementations

impl TipWatcher

pub async fn start_poll<S: TipSource + 'static>( source: Arc<S>, poll_interval: Duration, ) -> Result<Self>

pub async fn start_zmq<S: TipSource + 'static>( source: Arc<S>, zmq_endpoint: &str, reconcile_interval: Duration, ) -> Result<Self>

Start a watcher that follows the chain tip of source.

The watcher has two sources of tip updates and trusts both.

bitcoind announces the hash of each new block on zmq_endpoint. The watcher makes this hash the new tip and increases the height by one. No backend call is necessary for this update.

After each reconcile_interval, the watcher reads the tip from source. A changed value becomes the new tip. This read corrects the tip after a lost notification or a reorg.

pub fn tip(&self) -> BlockRef

pub fn subscribe(&self) -> TipSubscription

Subscribe to tip changes.

The subscription keeps the watcher task alive.

pub async fn wait_for_height(&self, height: u32) -> Result<BlockRef>

Wait until the tip reaches the given height.

pub fn stop(&self)

Trait Implementations

impl Clone for TipWatcher

fn clone(&self) -> TipWatcher

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.