1 package org.ldk.structs;
3 import org.ldk.impl.bindings;
4 import org.ldk.enums.*;
6 import java.util.Arrays;
10 * An implementation of [`chain::Watch`] for monitoring channels.
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
17 * [`chain::Watch`]: ../trait.Watch.html
18 * [`ChannelManager`]: ../../ln/channelmanager/struct.ChannelManager.html
19 * [module-level documentation]: index.html
21 @SuppressWarnings("unchecked") // We correctly assign various generic arrays
22 public class ChainMonitor extends CommonBase {
23 ChainMonitor(Object _dummy, long ptr) { super(ptr); }
24 @Override @SuppressWarnings("deprecation")
25 protected void finalize() throws Throwable {
27 if (ptr != 0) { bindings.ChainMonitor_free(ptr); }
31 * Dispatches to per-channel monitors, which are responsible for updating their on-chain view
32 * of a channel and reacting accordingly based on transactions in the connected block. See
33 * [`ChannelMonitor::block_connected`] for details. Any HTLCs that were resolved on chain will
34 * be returned by [`chain::Watch::release_pending_monitor_events`].
36 * Calls back to [`chain::Filter`] if any monitor indicated new outputs to watch. Subsequent
37 * calls must not exclude any transactions matching the new outputs nor any in-block
38 * descendants of such transactions. It is not necessary to re-fetch the block to obtain
41 * [`ChannelMonitor::block_connected`]: ../channelmonitor/struct.ChannelMonitor.html#method.block_connected
42 * [`chain::Watch::release_pending_monitor_events`]: ../trait.Watch.html#tymethod.release_pending_monitor_events
43 * [`chain::Filter`]: ../trait.Filter.html
45 public void block_connected(byte[] header, TwoTuple<Long, byte[]>[] txdata, int height) {
46 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);
47 /* TODO 2 TwoTuple<Long, byte[]> */;
51 * Dispatches to per-channel monitors, which are responsible for updating their on-chain view
52 * of a channel based on the disconnected block. See [`ChannelMonitor::block_disconnected`] for
55 * [`ChannelMonitor::block_disconnected`]: ../channelmonitor/struct.ChannelMonitor.html#method.block_disconnected
57 public void block_disconnected(byte[] header, int disconnected_height) {
58 bindings.ChainMonitor_block_disconnected(this.ptr, header, disconnected_height);
62 * Creates a new `ChainMonitor` used to watch on-chain activity pertaining to channels.
64 * When an optional chain source implementing [`chain::Filter`] is provided, the chain monitor
65 * will call back to it indicating transactions and outputs of interest. This allows clients to
66 * pre-filter blocks or only fetch blocks matching a compact filter. Otherwise, clients may
67 * always need to fetch full blocks absent another means for determining which blocks contain
68 * transactions relevant to the watched channels.
70 * [`chain::Filter`]: ../trait.Filter.html
72 public static ChainMonitor constructor_new(Filter chain_source, BroadcasterInterface broadcaster, Logger logger, FeeEstimator feeest, Persist persister) {
73 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);
74 ChainMonitor ret_hu_conv = new ChainMonitor(null, ret);
75 ret_hu_conv.ptrs_to.add(ret_hu_conv);
76 ret_hu_conv.ptrs_to.add(chain_source);
77 ret_hu_conv.ptrs_to.add(broadcaster);
78 ret_hu_conv.ptrs_to.add(logger);
79 ret_hu_conv.ptrs_to.add(feeest);
80 ret_hu_conv.ptrs_to.add(persister);
85 * Constructs a new Watch which calls the relevant methods on this_arg.
86 * This copies the `inner` pointer in this_arg and thus the returned Watch must be freed before this_arg is
88 public Watch as_Watch() {
89 long ret = bindings.ChainMonitor_as_Watch(this.ptr);
90 Watch ret_hu_conv = new Watch(null, ret);
91 ret_hu_conv.ptrs_to.add(this);
96 * Constructs a new EventsProvider which calls the relevant methods on this_arg.
97 * This copies the `inner` pointer in this_arg and thus the returned EventsProvider must be freed before this_arg is
99 public EventsProvider as_EventsProvider() {
100 long ret = bindings.ChainMonitor_as_EventsProvider(this.ptr);
101 EventsProvider ret_hu_conv = new EventsProvider(null, ret);
102 ret_hu_conv.ptrs_to.add(this);