Class ChainMonitor


  • public class ChainMonitor
    extends Object
    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. [`ChannelManager`]: crate::ln::channelmanager::ChannelManager [module-level documentation]: crate::chain::chainmonitor
    • Method Detail

      • of

        public static ChainMonitor of​(Option_FilterZ chain_source,
                                      BroadcasterInterface broadcaster,
                                      Logger logger,
                                      FeeEstimator feeest,
                                      Persist persister)
        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.
      • get_claimable_balances

        public Balance[] get_claimable_balances​(ChannelDetails[] ignored_channels)
        Gets the balances in the contained [`ChannelMonitor`]s which are claimable on-chain or claims which are awaiting confirmation. Includes the balances from each [`ChannelMonitor`] *except* those included in `ignored_channels`, allowing you to filter out balances from channels which are still open (and whose balance should likely be pulled from the [`ChannelDetails`]). See [`ChannelMonitor::get_claimable_balances`] for more details on the exact criteria for inclusion in the return value.
      • as_Listen

        public Listen as_Listen()
        Constructs a new Listen which calls the relevant methods on this_arg. This copies the `inner` pointer in this_arg and thus the returned Listen must be freed before this_arg is
      • as_Confirm

        public Confirm as_Confirm()
        Constructs a new Confirm which calls the relevant methods on this_arg. This copies the `inner` pointer in this_arg and thus the returned Confirm must be freed before this_arg is
      • as_Watch

        public Watch as_Watch()
        Constructs a new Watch which calls the relevant methods on this_arg. This copies the `inner` pointer in this_arg and thus the returned Watch must be freed before this_arg is
      • as_EventsProvider

        public EventsProvider as_EventsProvider()
        Constructs a new EventsProvider which calls the relevant methods on this_arg. This copies the `inner` pointer in this_arg and thus the returned EventsProvider must be freed before this_arg is