Struct ChainMonitor

pub struct ChainMonitor {
    pub funding_outpoint: OutPoint,
    pub state: Arc<Mutex<State>>,
    /* private fields */
}

Keep track of channel on-chain events. Note that this object has refcounted state, so is lightweight to clone.

Fields

funding_outpoint: OutPoint

the first funding outpoint, used to identify the channel / channel monitor

state: Arc<Mutex<State>>

the monitor state

Implementations

impl ChainMonitor

pub fn as_base(&self) -> ChainMonitorBase

Get the base

pub fn get_state(&self) -> MutexGuard<'_, State>

Get the locked state

pub fn add_funding(&self, tx: &Transaction, vout: u32)

Add a funding transaction to keep track of For dual-funding

pub fn funding_depth(&self) -> u32

Returns the number of confirmations of the funding transaction, or zero if it wasn’t confirmed yet.

pub fn funding_double_spent_depth(&self) -> u32

Returns the number of confirmations of a double-spend of the funding transaction or zero if it wasn’t double-spent.

pub fn closing_depth(&self) -> u32

Returns the number of confirmations of the closing transaction, or zero

pub fn is_done(&self) -> bool

Whether this channel can be forgotten:

• mutual close is confirmed
• unilateral close is swept
• funding transaction is double-spent and enough confirmations have passed

Trait Implementations

impl ChainListener for ChainMonitor

type Key = OutPoint

The key type

fn key(&self) -> &Self::Key

The key

fn on_add_block( &self, txs: &[Transaction], block_hash: &BlockHash, ) -> (Vec<OutPoint>, Vec<OutPoint>)

A block was added via a compact proof. The listener returns outpoints to watch in the future, and outpoints to stop watching.

fn on_add_streamed_block_end( &self, block_hash: &BlockHash, ) -> (Vec<OutPoint>, Vec<OutPoint>)

A block was added via streaming (see on_block_chunk). The listener returns outpoints to watch in the future, and outpoints to stop watching. The decoded block hash is also returned.

fn on_remove_block( &self, txs: &[Transaction], block_hash: &BlockHash, ) -> (Vec<OutPoint>, Vec<OutPoint>)

A block was deleted via a compact proof. The listener returns the same thing as on_add_block, so that the changes can be reverted. The decoded block hash is also returned.

fn on_remove_streamed_block_end( &self, block_hash: &BlockHash, ) -> (Vec<OutPoint>, Vec<OutPoint>)

A block was deleted via streaming (see on_block_chunk). The listener returns the same thing as on_add_block, so that the changes can be reverted.

fn on_push<F>(&self, f: F)

where F: FnOnce(&mut dyn Listener),

Get the block push decoder listener

impl Clone for ChainMonitor

fn clone(&self) -> ChainMonitor

Returns a copy of the value.

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

Performs copy-assignment from source.

impl SendSync for ChainMonitor