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 * [`ChannelManager`]: crate::ln::channelmanager::ChannelManager
18 * [module-level documentation]: crate::chain::chainmonitor
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 {
26 if (ptr != 0) { bindings.ChainMonitor_free(ptr); }
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`].
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
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[]> */;
46 * Dispatches to per-channel monitors, which are responsible for updating their on-chain view
47 * of a channel and reacting accordingly to newly confirmed transactions. For details, see
48 * [`ChannelMonitor::transactions_confirmed`].
50 * Used instead of [`block_connected`] by clients that are notified of transactions rather than
51 * blocks. May be called before or after [`update_best_block`] for transactions in the
52 * corresponding block. See [`update_best_block`] for further calling expectations.
54 * [`block_connected`]: Self::block_connected
55 * [`update_best_block`]: Self::update_best_block
57 public void transactions_confirmed(byte[] header, TwoTuple<Long, byte[]>[] txdata, int height) {
58 bindings.ChainMonitor_transactions_confirmed(this.ptr, header, Arrays.stream(txdata).mapToLong(txdata_conv_24 -> bindings.C2Tuple_usizeTransactionZ_new(txdata_conv_24.a, txdata_conv_24.b)).toArray(), height);
59 /* TODO 2 TwoTuple<Long, byte[]> */;
63 * Dispatches to per-channel monitors, which are responsible for updating their on-chain view
64 * of a channel and reacting accordingly based on the new chain tip. For details, see
65 * [`ChannelMonitor::update_best_block`].
67 * Used instead of [`block_connected`] by clients that are notified of transactions rather than
68 * blocks. May be called before or after [`transactions_confirmed`] for the corresponding
71 * Must be called after new blocks become available for the most recent block. Intermediary
72 * blocks, however, may be safely skipped. In the event of a chain re-organization, this only
73 * needs to be called for the most recent block assuming `transaction_unconfirmed` is called
74 * for any affected transactions.
76 * [`block_connected`]: Self::block_connected
77 * [`transactions_confirmed`]: Self::transactions_confirmed
78 * [`transaction_unconfirmed`]: Self::transaction_unconfirmed
80 public void update_best_block(byte[] header, int height) {
81 bindings.ChainMonitor_update_best_block(this.ptr, header, height);
85 * Dispatches to per-channel monitors, which are responsible for updating their on-chain view
86 * of a channel based on the disconnected block. See [`ChannelMonitor::block_disconnected`] for
89 public void block_disconnected(byte[] header, int disconnected_height) {
90 bindings.ChainMonitor_block_disconnected(this.ptr, header, disconnected_height);
94 * Dispatches to per-channel monitors, which are responsible for updating their on-chain view
95 * of a channel based on transactions unconfirmed as a result of a chain reorganization. See
96 * [`ChannelMonitor::transaction_unconfirmed`] for details.
98 * Used instead of [`block_disconnected`] by clients that are notified of transactions rather
99 * than blocks. May be called before or after [`update_best_block`] for transactions in the
100 * corresponding block. See [`update_best_block`] for further calling expectations.
102 * [`block_disconnected`]: Self::block_disconnected
103 * [`update_best_block`]: Self::update_best_block
105 public void transaction_unconfirmed(byte[] txid) {
106 bindings.ChainMonitor_transaction_unconfirmed(this.ptr, txid);
110 * Returns the set of txids that should be monitored for re-organization out of the chain.
112 public byte[][] get_relevant_txids() {
113 byte[][] ret = bindings.ChainMonitor_get_relevant_txids(this.ptr);
118 * Creates a new `ChainMonitor` used to watch on-chain activity pertaining to channels.
120 * When an optional chain source implementing [`chain::Filter`] is provided, the chain monitor
121 * will call back to it indicating transactions and outputs of interest. This allows clients to
122 * pre-filter blocks or only fetch blocks matching a compact filter. Otherwise, clients may
123 * always need to fetch full blocks absent another means for determining which blocks contain
124 * transactions relevant to the watched channels.
126 public static ChainMonitor constructor_new(Filter chain_source, BroadcasterInterface broadcaster, Logger logger, FeeEstimator feeest, Persist persister) {
127 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);
128 ChainMonitor ret_hu_conv = new ChainMonitor(null, ret);
129 ret_hu_conv.ptrs_to.add(ret_hu_conv);
130 ret_hu_conv.ptrs_to.add(chain_source);
131 ret_hu_conv.ptrs_to.add(broadcaster);
132 ret_hu_conv.ptrs_to.add(logger);
133 ret_hu_conv.ptrs_to.add(feeest);
134 ret_hu_conv.ptrs_to.add(persister);
139 * Constructs a new Watch which calls the relevant methods on this_arg.
140 * This copies the `inner` pointer in this_arg and thus the returned Watch must be freed before this_arg is
142 public Watch as_Watch() {
143 long ret = bindings.ChainMonitor_as_Watch(this.ptr);
144 Watch ret_hu_conv = new Watch(null, ret);
145 ret_hu_conv.ptrs_to.add(this);
150 * Constructs a new EventsProvider which calls the relevant methods on this_arg.
151 * This copies the `inner` pointer in this_arg and thus the returned EventsProvider must be freed before this_arg is
153 public EventsProvider as_EventsProvider() {
154 long ret = bindings.ChainMonitor_as_EventsProvider(this.ptr);
155 EventsProvider ret_hu_conv = new EventsProvider(null, ret);
156 ret_hu_conv.ptrs_to.add(this);