Struct lightning::ln::channelmonitor::SimpleManyChannelMonitor

pub struct SimpleManyChannelMonitor<Key> { /* fields omitted */ }

A simple implementation of a ManyChannelMonitor and ChainListener. Can be used to create a watchtower or watch our own channels.

Note that you must provide your own key by which to refer to channels.

If you're accepting remote monitors (ie are implementing a watchtower), you must verify that users cannot overwrite a given channel by providing a duplicate key. ie you should probably index by a PublicKey which is required to sign any updates.

If you're using this for local monitoring of your own channels, you probably want to use OutPoint as the key, which will give you a ManyChannelMonitor implementation.

Methods

impl<Key: Send + Eq + Hash + 'static> SimpleManyChannelMonitor<Key>

pub fn new(
    chain_monitor: Arc<dyn ChainWatchInterface>,
    broadcaster: Arc<dyn BroadcasterInterface>,
    logger: Arc<dyn Logger>,
    feeest: Arc<dyn FeeEstimator>
) -> Arc<SimpleManyChannelMonitor<Key>>

Creates a new object which can be used to monitor several channels given the chain interface with which to register to receive notifications.

pub fn add_update_monitor_by_key(
    &self,
    key: Key,
    monitor: ChannelMonitor
) -> Result<(), MonitorUpdateError>

Adds or updates the monitor which monitors the channel referred to by the given key.

Trait Implementations

impl<'a, Key: Send + Eq + Hash> ChainListener for SimpleManyChannelMonitor<Key>

fn block_connected(
    &self,
    header: &BlockHeader,
    height: u32,
    txn_matched: &[&Transaction],
    _indexes_of_txn_matched: &[u32]
)

Notifies a listener that a block was connected. Note that if a new transaction/outpoint is watched during a block_connected call, the block must be re-scanned with the new transaction/outpoints and block_connected should be called again with the same header and (at least) the new transactions.

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

Notifies a listener that a block was disconnected. Unlike block_connected, this must never be called twice for the same disconnect event. Height must be the one of the block which was disconnected (not new height of the best chain)

impl<Key: Send + Eq + Hash> EventsProvider for SimpleManyChannelMonitor<Key>

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 ManyChannelMonitor for SimpleManyChannelMonitor<OutPoint>

fn add_update_monitor(
    &self,
    funding_txo: OutPoint,
    monitor: ChannelMonitor
) -> Result<(), ChannelMonitorUpdateErr>

Adds or updates a monitor for the given funding_txo.

fn fetch_pending_htlc_updated(&self) -> Vec<HTLCUpdate>

Used by ChannelManager to get list of HTLC resolved onchain and which needed to be updated with success or failure backward