_ Git - ldk-java/blob - src/main/java/org/ldk/structs/ChainMonitor.java

   1 package org.ldk.structs;
   2
   3 import org.ldk.impl.bindings;
   4 import org.ldk.enums.*;
   5 import org.ldk.util.*;
   6 import java.util.Arrays;
   7
   8
   9 /**
  10  * An implementation of [`chain::Watch`] for monitoring channels.
  11  *
  12  * Connected and disconnected blocks must be provided to `ChainMonitor` as documented by
  13  * [`chain::Watch`]. May be used in conjunction with [`ChannelManager`] to monitor channels locally
  14  * or used independently to monitor channels remotely. See the [module-level documentation] for
  15  * details.
  16  *
  17  * [`ChannelManager`]: crate::ln::channelmanager::ChannelManager
  18  * [module-level documentation]: crate::chain::chainmonitor
  19  */
  20 @SuppressWarnings("unchecked") // We correctly assign various generic arrays
  21 public class ChainMonitor extends CommonBase {
  22         ChainMonitor(Object _dummy, long ptr) { super(ptr); }
  23         @Override @SuppressWarnings("deprecation")
  24         protected void finalize() throws Throwable {
  25                 super.finalize();
  26                 if (ptr != 0) { bindings.ChainMonitor_free(ptr); }
  27         }
  28
  29         /**
  30          * Dispatches to per-channel monitors, which are responsible for updating their on-chain view
  31          * of a channel and reacting accordingly based on transactions in the connected block. See
  32          * [`ChannelMonitor::block_connected`] for details. Any HTLCs that were resolved on chain will
  33          * be returned by [`chain::Watch::release_pending_monitor_events`].
  34          *
  35          * Calls back to [`chain::Filter`] if any monitor indicated new outputs to watch. Subsequent
  36          * calls must not exclude any transactions matching the new outputs nor any in-block
  37          * descendants of such transactions. It is not necessary to re-fetch the block to obtain
  38          * updated `txdata`.
  39          */
  40         public void block_connected(byte[] header, TwoTuple<Long, byte[]>[] txdata, int height) {
  41                 bindings.ChainMonitor_block_connected(this.ptr, header, Arrays.stream(txdata).mapToLong(txdata_conv_24 -> bindings.C2Tuple_usizeTransactionZ_new(txdata_conv_24.a, txdata_conv_24.b)).toArray(), height);
  42                 /* TODO 2 TwoTuple<Long, byte[]>  */;
  43         }
  44
  45         /**
  46          * Dispatches to per-channel monitors, which are responsible for updating their on-chain view
  47          * of a channel based on the disconnected block. See [`ChannelMonitor::block_disconnected`] for
  48          * details.
  49          */
  50         public void block_disconnected(byte[] header, int disconnected_height) {
  51                 bindings.ChainMonitor_block_disconnected(this.ptr, header, disconnected_height);
  52         }
  53
  54         /**
  55          * Creates a new `ChainMonitor` used to watch on-chain activity pertaining to channels.
  56          *
  57          * When an optional chain source implementing [`chain::Filter`] is provided, the chain monitor
  58          * will call back to it indicating transactions and outputs of interest. This allows clients to
  59          * pre-filter blocks or only fetch blocks matching a compact filter. Otherwise, clients may
  60          * always need to fetch full blocks absent another means for determining which blocks contain
  61          * transactions relevant to the watched channels.
  62          */
  63         public static ChainMonitor constructor_new(Filter chain_source, BroadcasterInterface broadcaster, Logger logger, FeeEstimator feeest, Persist persister) {
  64                 long ret = bindings.ChainMonitor_new(chain_source == null ? 0 : chain_source.ptr, broadcaster == null ? 0 : broadcaster.ptr, logger == null ? 0 : logger.ptr, feeest == null ? 0 : feeest.ptr, persister == null ? 0 : persister.ptr);
  65                 ChainMonitor ret_hu_conv = new ChainMonitor(null, ret);
  66                 ret_hu_conv.ptrs_to.add(ret_hu_conv);
  67                 ret_hu_conv.ptrs_to.add(chain_source);
  68                 ret_hu_conv.ptrs_to.add(broadcaster);
  69                 ret_hu_conv.ptrs_to.add(logger);
  70                 ret_hu_conv.ptrs_to.add(feeest);
  71                 ret_hu_conv.ptrs_to.add(persister);
  72                 return ret_hu_conv;
  73         }
  74
  75         /**
  76          * Constructs a new Watch which calls the relevant methods on this_arg.
  77          * This copies the `inner` pointer in this_arg and thus the returned Watch must be freed before this_arg is
  78          */
  79         public Watch as_Watch() {
  80                 long ret = bindings.ChainMonitor_as_Watch(this.ptr);
  81                 Watch ret_hu_conv = new Watch(null, ret);
  82                 ret_hu_conv.ptrs_to.add(this);
  83                 return ret_hu_conv;
  84         }
  85
  86         /**
  87          * Constructs a new EventsProvider which calls the relevant methods on this_arg.
  88          * This copies the `inner` pointer in this_arg and thus the returned EventsProvider must be freed before this_arg is
  89          */
  90         public EventsProvider as_EventsProvider() {
  91                 long ret = bindings.ChainMonitor_as_EventsProvider(this.ptr);
  92                 EventsProvider ret_hu_conv = new EventsProvider(null, ret);
  93                 ret_hu_conv.ptrs_to.add(this);
  94                 return ret_hu_conv;
  95         }
  96
  97 }