Struct lightning_signer::monitor::ChainMonitor

pub struct ChainMonitor {
    pub funding_outpoint: OutPoint,
    pub state: Arc<Mutex<State>>,
}

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 new(funding_outpoint: OutPoint, height: u32) -> Self

Create a new chain monitor. Use add_funding to really start monitoring.

pub fn new_from_persistence(funding_outpoint: OutPoint, state: State) -> Self

recreate this monitor after restoring from persistence

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

Get the locked state

pub fn add_funding_outpoint(&self, outpoint: &OutPoint)

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

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 as_chain_state(&self) -> ChainState

Convert to a ChainState, to be used for validation

Trait Implementations

impl ChainListener for ChainMonitor

fn on_add_block(&self, txs: Vec<&Transaction>) -> Vec<OutPoint>

A block was added, and zero or more transactions consume watched outpoints. The listener returns zero or more new outpoints to watch.

fn on_remove_block(&self, txs: Vec<&Transaction>)

A block was deleted. The tracker will revert any changes to the watched outpoints set.

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 Ord for ChainMonitor

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<ChainMonitor> for ChainMonitor

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialOrd<ChainMonitor> for ChainMonitor

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for ChainMonitor

impl SendSync for ChainMonitor