Struct lightning::chain::chainmonitor::ChainMonitor

pub struct ChainMonitor<ChannelSigner: Sign, C: Deref, T: Deref, F: Deref, L: Deref, P: Deref> where
    C::Target: Filter,
    T::Target: BroadcasterInterface,
    F::Target: FeeEstimator,
    L::Target: Logger,
    P::Target: Persist<ChannelSigner>,  {
    pub monitors: RwLock<HashMap<OutPoint, ChannelMonitor<ChannelSigner>>>,
    // some fields omitted
}

An implementation of chain::Watch for monitoring channels.

Connected and disconnected blocks must be provided to ChainMonitor as documented by chain::Watch. May be used in conjunction with ChannelManager to monitor channels locally or used independently to monitor channels remotely. See the module-level documentation for details.

Fields

monitors: RwLock<HashMap<OutPoint, ChannelMonitor<ChannelSigner>>>

The monitors

Implementations

impl<ChannelSigner: Sign, C: Deref, T: Deref, F: Deref, L: Deref, P: Deref> ChainMonitor<ChannelSigner, C, T, F, L, P> where
    C::Target: Filter,
    T::Target: BroadcasterInterface,
    F::Target: FeeEstimator,
    L::Target: Logger,
    P::Target: Persist<ChannelSigner>, 

pub fn block_connected(
    &self,
    header: &BlockHeader,
    txdata: &TransactionData<'_>,
    height: u32
)

Dispatches to per-channel monitors, which are responsible for updating their on-chain view of a channel and reacting accordingly based on transactions in the connected block. See ChannelMonitor::block_connected for details. Any HTLCs that were resolved on chain will be returned by chain::Watch::release_pending_monitor_events.

Calls back to chain::Filter if any monitor indicated new outputs to watch. Subsequent calls must not exclude any transactions matching the new outputs nor any in-block descendants of such transactions. It is not necessary to re-fetch the block to obtain updated txdata.

pub fn block_disconnected(&self, header: &BlockHeader, disconnected_height: u32)

Dispatches to per-channel monitors, which are responsible for updating their on-chain view of a channel based on the disconnected block. See ChannelMonitor::block_disconnected for details.

pub fn new(
    chain_source: Option<C>,
    broadcaster: T,
    logger: L,
    feeest: F,
    persister: P
) -> Self

Creates a new ChainMonitor used to watch on-chain activity pertaining to channels.

When an optional chain source implementing chain::Filter is provided, the chain monitor will call back to it indicating transactions and outputs of interest. This allows clients to pre-filter blocks or only fetch blocks matching a compact filter. Otherwise, clients may always need to fetch full blocks absent another means for determining which blocks contain transactions relevant to the watched channels.

Trait Implementations

impl<ChannelSigner: Sign, C: Deref, T: Deref, F: Deref, L: Deref, P: Deref> EventsProvider for ChainMonitor<ChannelSigner, C, T, F, L, P> where
    C::Target: Filter,
    T::Target: BroadcasterInterface,
    F::Target: FeeEstimator,
    L::Target: Logger,
    P::Target: Persist<ChannelSigner>, 

fn get_and_clear_pending_events(&self) -> Vec<Event>

Gets the list of pending events which were generated by previous actions, clearing the list in the process.

impl<ChannelSigner: Sign, C: Deref + Send + Sync, T: Deref + Send + Sync, F: Deref + Send + Sync, L: Deref + Send + Sync, P: Deref + Send + Sync> Listen for ChainMonitor<ChannelSigner, C, T, F, L, P> where
    ChannelSigner: Sign,
    C::Target: Filter,
    T::Target: BroadcasterInterface,
    F::Target: FeeEstimator,
    L::Target: Logger,
    P::Target: Persist<ChannelSigner>, 

fn block_connected(&self, block: &Block, height: u32)

Notifies the listener that a block was added at the given height.

fn block_disconnected(&self, header: &BlockHeader, height: u32)

Notifies the listener that a block was removed at the given height.

impl<ChannelSigner: Sign, C: Deref + Sync + Send, T: Deref + Sync + Send, F: Deref + Sync + Send, L: Deref + Sync + Send, P: Deref + Sync + Send> Watch<ChannelSigner> for ChainMonitor<ChannelSigner, C, T, F, L, P> where
    C::Target: Filter,
    T::Target: BroadcasterInterface,
    F::Target: FeeEstimator,
    L::Target: Logger,
    P::Target: Persist<ChannelSigner>, 

fn watch_channel(
    &self,
    funding_outpoint: OutPoint,
    monitor: ChannelMonitor<ChannelSigner>
) -> Result<(), ChannelMonitorUpdateErr>

Adds the monitor that watches the channel referred to by the given outpoint.

Calls back to chain::Filter with the funding transaction and outputs to watch.

Note that we persist the given ChannelMonitor while holding the ChainMonitor monitors lock.

fn update_channel(
    &self,
    funding_txo: OutPoint,
    update: ChannelMonitorUpdate
) -> Result<(), ChannelMonitorUpdateErr>

Note that we persist the given ChannelMonitor update while holding the ChainMonitor monitors lock.

fn release_pending_monitor_events(&self) -> Vec<MonitorEvent>

Returns any monitor events since the last call. Subsequent calls must only return new events.