1 package org.ldk.structs;
3 import org.ldk.impl.bindings;
4 import org.ldk.enums.*;
6 import java.util.Arrays;
7 import java.lang.ref.Reference;
8 import javax.annotation.Nullable;
12 * A ChannelMonitor handles chain events (blocks connected and disconnected) and generates
13 * on-chain transactions to ensure no loss of funds occurs.
15 * You MUST ensure that no ChannelMonitors for a given channel anywhere contain out-of-date
16 * information and are actively monitoring the chain.
18 * Note that the deserializer is only implemented for (BlockHash, ChannelMonitor), which
19 * tells you the last block hash which was block_connect()ed. You MUST rescan any blocks along
20 * the \"reorg path\" (ie disconnecting blocks until you find a common ancestor from both the
21 * returned block hash and the the current chain and then reconnecting blocks to get to the
22 * best chain) upon deserializing the object!
24 @SuppressWarnings("unchecked") // We correctly assign various generic arrays
25 public class ChannelMonitor extends CommonBase {
26 ChannelMonitor(Object _dummy, long ptr) { super(ptr); }
27 @Override @SuppressWarnings("deprecation")
28 protected void finalize() throws Throwable {
30 if (ptr != 0) { bindings.ChannelMonitor_free(ptr); }
34 long ret = bindings.ChannelMonitor_clone_ptr(this.ptr);
35 Reference.reachabilityFence(this);
40 * Creates a copy of the ChannelMonitor
42 public ChannelMonitor clone() {
43 long ret = bindings.ChannelMonitor_clone(this.ptr);
44 Reference.reachabilityFence(this);
45 if (ret >= 0 && ret <= 4096) { return null; }
46 org.ldk.structs.ChannelMonitor ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new org.ldk.structs.ChannelMonitor(null, ret); }
47 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(this); };
52 * Serialize the ChannelMonitor object into a byte array which can be read by ChannelMonitor_read
54 public byte[] write() {
55 byte[] ret = bindings.ChannelMonitor_write(this.ptr);
56 Reference.reachabilityFence(this);
61 * Updates a ChannelMonitor on the basis of some new information provided by the Channel
64 * panics if the given update is not the next update by update_id.
66 public Result_NoneNoneZ update_monitor(org.ldk.structs.ChannelMonitorUpdate updates, org.ldk.structs.BroadcasterInterface broadcaster, org.ldk.structs.FeeEstimator fee_estimator, org.ldk.structs.Logger logger) {
67 long ret = bindings.ChannelMonitor_update_monitor(this.ptr, updates == null ? 0 : updates.ptr, broadcaster.ptr, fee_estimator.ptr, logger.ptr);
68 Reference.reachabilityFence(this);
69 Reference.reachabilityFence(updates);
70 Reference.reachabilityFence(broadcaster);
71 Reference.reachabilityFence(fee_estimator);
72 Reference.reachabilityFence(logger);
73 if (ret >= 0 && ret <= 4096) { return null; }
74 Result_NoneNoneZ ret_hu_conv = Result_NoneNoneZ.constr_from_ptr(ret);
75 if (this != null) { this.ptrs_to.add(updates); };
76 if (this != null) { this.ptrs_to.add(broadcaster); };
77 if (this != null) { this.ptrs_to.add(fee_estimator); };
78 if (this != null) { this.ptrs_to.add(logger); };
83 * Gets the update_id from the latest ChannelMonitorUpdate which was applied to this
86 public long get_latest_update_id() {
87 long ret = bindings.ChannelMonitor_get_latest_update_id(this.ptr);
88 Reference.reachabilityFence(this);
93 * Gets the funding transaction outpoint of the channel this ChannelMonitor is monitoring for.
95 public TwoTuple_OutPointCVec_u8ZZ get_funding_txo() {
96 long ret = bindings.ChannelMonitor_get_funding_txo(this.ptr);
97 Reference.reachabilityFence(this);
98 if (ret >= 0 && ret <= 4096) { return null; }
99 TwoTuple_OutPointCVec_u8ZZ ret_hu_conv = new TwoTuple_OutPointCVec_u8ZZ(null, ret);
100 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(this); };
105 * Gets a list of txids, with their output scripts (in the order they appear in the
106 * transaction), which we must learn about spends of via block_connected().
108 public TwoTuple_ThirtyTwoBytesCVec_C2Tuple_u32CVec_u8ZZZZ[] get_outputs_to_watch() {
109 long[] ret = bindings.ChannelMonitor_get_outputs_to_watch(this.ptr);
110 Reference.reachabilityFence(this);
111 int ret_conv_52_len = ret.length;
112 TwoTuple_ThirtyTwoBytesCVec_C2Tuple_u32CVec_u8ZZZZ[] ret_conv_52_arr = new TwoTuple_ThirtyTwoBytesCVec_C2Tuple_u32CVec_u8ZZZZ[ret_conv_52_len];
113 for (int a = 0; a < ret_conv_52_len; a++) {
114 long ret_conv_52 = ret[a];
115 TwoTuple_ThirtyTwoBytesCVec_C2Tuple_u32CVec_u8ZZZZ ret_conv_52_hu_conv = new TwoTuple_ThirtyTwoBytesCVec_C2Tuple_u32CVec_u8ZZZZ(null, ret_conv_52);
116 if (ret_conv_52_hu_conv != null) { ret_conv_52_hu_conv.ptrs_to.add(this); };
117 ret_conv_52_arr[a] = ret_conv_52_hu_conv;
119 return ret_conv_52_arr;
123 * Loads the funding txo and outputs to watch into the given `chain::Filter` by repeatedly
124 * calling `chain::Filter::register_output` and `chain::Filter::register_tx` until all outputs
125 * have been registered.
127 public void load_outputs_to_watch(org.ldk.structs.Filter filter, org.ldk.structs.Logger logger) {
128 bindings.ChannelMonitor_load_outputs_to_watch(this.ptr, filter.ptr, logger.ptr);
129 Reference.reachabilityFence(this);
130 Reference.reachabilityFence(filter);
131 Reference.reachabilityFence(logger);
132 if (this != null) { this.ptrs_to.add(filter); };
133 if (this != null) { this.ptrs_to.add(logger); };
137 * Get the list of HTLCs who's status has been updated on chain. This should be called by
138 * ChannelManager via [`chain::Watch::release_pending_monitor_events`].
140 public MonitorEvent[] get_and_clear_pending_monitor_events() {
141 long[] ret = bindings.ChannelMonitor_get_and_clear_pending_monitor_events(this.ptr);
142 Reference.reachabilityFence(this);
143 int ret_conv_14_len = ret.length;
144 MonitorEvent[] ret_conv_14_arr = new MonitorEvent[ret_conv_14_len];
145 for (int o = 0; o < ret_conv_14_len; o++) {
146 long ret_conv_14 = ret[o];
147 org.ldk.structs.MonitorEvent ret_conv_14_hu_conv = org.ldk.structs.MonitorEvent.constr_from_ptr(ret_conv_14);
148 if (ret_conv_14_hu_conv != null) { ret_conv_14_hu_conv.ptrs_to.add(this); };
149 ret_conv_14_arr[o] = ret_conv_14_hu_conv;
151 return ret_conv_14_arr;
155 * Processes [`SpendableOutputs`] events produced from each [`ChannelMonitor`] upon maturity.
157 * For channels featuring anchor outputs, this method will also process [`BumpTransaction`]
158 * events produced from each [`ChannelMonitor`] while there is a balance to claim onchain
159 * within each channel. As the confirmation of a commitment transaction may be critical to the
160 * safety of funds, we recommend invoking this every 30 seconds, or lower if running in an
161 * environment with spotty connections, like on mobile.
163 * An [`EventHandler`] may safely call back to the provider, though this shouldn't be needed in
164 * order to handle these events.
166 * [`SpendableOutputs`]: crate::events::Event::SpendableOutputs
167 * [`BumpTransaction`]: crate::events::Event::BumpTransaction
169 public void process_pending_events(org.ldk.structs.EventHandler handler) {
170 bindings.ChannelMonitor_process_pending_events(this.ptr, handler.ptr);
171 Reference.reachabilityFence(this);
172 Reference.reachabilityFence(handler);
173 if (this != null) { this.ptrs_to.add(handler); };
177 * Gets the counterparty's initial commitment transaction. The returned commitment
178 * transaction is unsigned. This is intended to be called during the initial persistence of
179 * the monitor (inside an implementation of [`Persist::persist_new_channel`]), to allow for
180 * watchtowers in the persistence pipeline to have enough data to form justice transactions.
182 * This is similar to [`Self::counterparty_commitment_txs_from_update`], except
183 * that for the initial commitment transaction, we don't have a corresponding update.
185 * This will only return `Some` for channel monitors that have been created after upgrading
188 * [`Persist::persist_new_channel`]: crate::chain::chainmonitor::Persist::persist_new_channel
190 * Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
193 public CommitmentTransaction initial_counterparty_commitment_tx() {
194 long ret = bindings.ChannelMonitor_initial_counterparty_commitment_tx(this.ptr);
195 Reference.reachabilityFence(this);
196 if (ret >= 0 && ret <= 4096) { return null; }
197 org.ldk.structs.CommitmentTransaction ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new org.ldk.structs.CommitmentTransaction(null, ret); }
198 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(this); };
203 * Gets all of the counterparty commitment transactions provided by the given update. This
204 * may be empty if the update doesn't include any new counterparty commitments. Returned
205 * commitment transactions are unsigned.
207 * This is provided so that watchtower clients in the persistence pipeline are able to build
208 * justice transactions for each counterparty commitment upon each update. It's intended to be
209 * used within an implementation of [`Persist::update_persisted_channel`], which is provided
210 * with a monitor and an update. Once revoked, signing a justice transaction can be done using
211 * [`Self::sign_to_local_justice_tx`].
213 * It is expected that a watchtower client may use this method to retrieve the latest counterparty
214 * commitment transaction(s), and then hold the necessary data until a later update in which
215 * the monitor has been updated with the corresponding revocation data, at which point the
216 * monitor can sign the justice transaction.
218 * This will only return a non-empty list for monitor updates that have been created after
219 * upgrading to LDK 0.0.117+. Note that no restriction lies on the monitors themselves, which
220 * may have been created prior to upgrading.
222 * [`Persist::update_persisted_channel`]: crate::chain::chainmonitor::Persist::update_persisted_channel
224 public CommitmentTransaction[] counterparty_commitment_txs_from_update(org.ldk.structs.ChannelMonitorUpdate update) {
225 long[] ret = bindings.ChannelMonitor_counterparty_commitment_txs_from_update(this.ptr, update == null ? 0 : update.ptr);
226 Reference.reachabilityFence(this);
227 Reference.reachabilityFence(update);
228 int ret_conv_23_len = ret.length;
229 CommitmentTransaction[] ret_conv_23_arr = new CommitmentTransaction[ret_conv_23_len];
230 for (int x = 0; x < ret_conv_23_len; x++) {
231 long ret_conv_23 = ret[x];
232 org.ldk.structs.CommitmentTransaction ret_conv_23_hu_conv = null; if (ret_conv_23 < 0 || ret_conv_23 > 4096) { ret_conv_23_hu_conv = new org.ldk.structs.CommitmentTransaction(null, ret_conv_23); }
233 if (ret_conv_23_hu_conv != null) { ret_conv_23_hu_conv.ptrs_to.add(this); };
234 ret_conv_23_arr[x] = ret_conv_23_hu_conv;
236 if (this != null) { this.ptrs_to.add(update); };
237 return ret_conv_23_arr;
241 * Wrapper around [`EcdsaChannelSigner::sign_justice_revoked_output`] to make
242 * signing the justice transaction easier for implementors of
243 * [`chain::chainmonitor::Persist`]. On success this method returns the provided transaction
244 * signing the input at `input_idx`. This method will only produce a valid signature for
245 * a transaction spending the `to_local` output of a commitment transaction, i.e. this cannot
246 * be used for revoked HTLC outputs.
248 * `Value` is the value of the output being spent by the input at `input_idx`, committed
249 * in the BIP 143 signature.
251 * This method will only succeed if this monitor has received the revocation secret for the
252 * provided `commitment_number`. If a commitment number is provided that does not correspond
253 * to the commitment transaction being revoked, this will return a signed transaction, but
254 * the signature will not be valid.
256 * [`EcdsaChannelSigner::sign_justice_revoked_output`]: crate::sign::ecdsa::EcdsaChannelSigner::sign_justice_revoked_output
257 * [`Persist`]: crate::chain::chainmonitor::Persist
259 public Result_TransactionNoneZ sign_to_local_justice_tx(byte[] justice_tx, long input_idx, long value, long commitment_number) {
260 long ret = bindings.ChannelMonitor_sign_to_local_justice_tx(this.ptr, justice_tx, input_idx, value, commitment_number);
261 Reference.reachabilityFence(this);
262 Reference.reachabilityFence(justice_tx);
263 Reference.reachabilityFence(input_idx);
264 Reference.reachabilityFence(value);
265 Reference.reachabilityFence(commitment_number);
266 if (ret >= 0 && ret <= 4096) { return null; }
267 Result_TransactionNoneZ ret_hu_conv = Result_TransactionNoneZ.constr_from_ptr(ret);
272 * Gets the `node_id` of the counterparty for this channel.
274 * Will be `None` for channels constructed on LDK versions prior to 0.0.110 and always `Some`
277 * Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
280 public byte[] get_counterparty_node_id() {
281 byte[] ret = bindings.ChannelMonitor_get_counterparty_node_id(this.ptr);
282 Reference.reachabilityFence(this);
287 * Used by [`ChannelManager`] deserialization to broadcast the latest holder state if its copy
288 * of the channel state was out-of-date.
290 * You may also use this to broadcast the latest local commitment transaction, either because
291 * a monitor update failed or because we've fallen behind (i.e. we've received proof that our
292 * counterparty side knows a revocation secret we gave them that they shouldn't know).
294 * Broadcasting these transactions in the second case is UNSAFE, as they allow counterparty
295 * side to punish you. Nevertheless you may want to broadcast them if counterparty doesn't
296 * close channel with their commitment transaction after a substantial amount of time. Best
297 * may be to contact the other node operator out-of-band to coordinate other options available
300 * [`ChannelManager`]: crate::ln::channelmanager::ChannelManager
302 public byte[][] get_latest_holder_commitment_txn(org.ldk.structs.Logger logger) {
303 byte[][] ret = bindings.ChannelMonitor_get_latest_holder_commitment_txn(this.ptr, logger.ptr);
304 Reference.reachabilityFence(this);
305 Reference.reachabilityFence(logger);
306 if (this != null) { this.ptrs_to.add(logger); };
311 * Processes transactions in a newly connected block, which may result in any of the following:
312 * - update the monitor's state against resolved HTLCs
313 * - punish the counterparty in the case of seeing a revoked commitment transaction
314 * - force close the channel and claim/timeout incoming/outgoing HTLCs if near expiration
315 * - detect settled outputs for later spending
316 * - schedule and bump any in-flight claims
318 * Returns any new outputs to watch from `txdata`; after called, these are also included in
319 * [`get_outputs_to_watch`].
321 * [`get_outputs_to_watch`]: #method.get_outputs_to_watch
323 public TwoTuple_ThirtyTwoBytesCVec_C2Tuple_u32TxOutZZZ[] block_connected(byte[] header, TwoTuple_usizeTransactionZ[] txdata, int height, org.ldk.structs.BroadcasterInterface broadcaster, org.ldk.structs.FeeEstimator fee_estimator, org.ldk.structs.Logger logger) {
324 long[] ret = bindings.ChannelMonitor_block_connected(this.ptr, InternalUtils.check_arr_len(header, 80), txdata != null ? Arrays.stream(txdata).mapToLong(txdata_conv_28 -> txdata_conv_28 != null ? txdata_conv_28.ptr : 0).toArray() : null, height, broadcaster.ptr, fee_estimator.ptr, logger.ptr);
325 Reference.reachabilityFence(this);
326 Reference.reachabilityFence(header);
327 Reference.reachabilityFence(txdata);
328 Reference.reachabilityFence(height);
329 Reference.reachabilityFence(broadcaster);
330 Reference.reachabilityFence(fee_estimator);
331 Reference.reachabilityFence(logger);
332 int ret_conv_49_len = ret.length;
333 TwoTuple_ThirtyTwoBytesCVec_C2Tuple_u32TxOutZZZ[] ret_conv_49_arr = new TwoTuple_ThirtyTwoBytesCVec_C2Tuple_u32TxOutZZZ[ret_conv_49_len];
334 for (int x = 0; x < ret_conv_49_len; x++) {
335 long ret_conv_49 = ret[x];
336 TwoTuple_ThirtyTwoBytesCVec_C2Tuple_u32TxOutZZZ ret_conv_49_hu_conv = new TwoTuple_ThirtyTwoBytesCVec_C2Tuple_u32TxOutZZZ(null, ret_conv_49);
337 if (ret_conv_49_hu_conv != null) { ret_conv_49_hu_conv.ptrs_to.add(this); };
338 ret_conv_49_arr[x] = ret_conv_49_hu_conv;
340 if (this != null) { this.ptrs_to.add(broadcaster); };
341 if (this != null) { this.ptrs_to.add(fee_estimator); };
342 if (this != null) { this.ptrs_to.add(logger); };
343 return ret_conv_49_arr;
347 * Determines if the disconnected block contained any transactions of interest and updates
350 public void block_disconnected(byte[] header, int height, org.ldk.structs.BroadcasterInterface broadcaster, org.ldk.structs.FeeEstimator fee_estimator, org.ldk.structs.Logger logger) {
351 bindings.ChannelMonitor_block_disconnected(this.ptr, InternalUtils.check_arr_len(header, 80), height, broadcaster.ptr, fee_estimator.ptr, logger.ptr);
352 Reference.reachabilityFence(this);
353 Reference.reachabilityFence(header);
354 Reference.reachabilityFence(height);
355 Reference.reachabilityFence(broadcaster);
356 Reference.reachabilityFence(fee_estimator);
357 Reference.reachabilityFence(logger);
358 if (this != null) { this.ptrs_to.add(broadcaster); };
359 if (this != null) { this.ptrs_to.add(fee_estimator); };
360 if (this != null) { this.ptrs_to.add(logger); };
364 * Processes transactions confirmed in a block with the given header and height, returning new
365 * outputs to watch. See [`block_connected`] for details.
367 * Used instead of [`block_connected`] by clients that are notified of transactions rather than
368 * blocks. See [`chain::Confirm`] for calling expectations.
370 * [`block_connected`]: Self::block_connected
372 public TwoTuple_ThirtyTwoBytesCVec_C2Tuple_u32TxOutZZZ[] transactions_confirmed(byte[] header, TwoTuple_usizeTransactionZ[] txdata, int height, org.ldk.structs.BroadcasterInterface broadcaster, org.ldk.structs.FeeEstimator fee_estimator, org.ldk.structs.Logger logger) {
373 long[] ret = bindings.ChannelMonitor_transactions_confirmed(this.ptr, InternalUtils.check_arr_len(header, 80), txdata != null ? Arrays.stream(txdata).mapToLong(txdata_conv_28 -> txdata_conv_28 != null ? txdata_conv_28.ptr : 0).toArray() : null, height, broadcaster.ptr, fee_estimator.ptr, logger.ptr);
374 Reference.reachabilityFence(this);
375 Reference.reachabilityFence(header);
376 Reference.reachabilityFence(txdata);
377 Reference.reachabilityFence(height);
378 Reference.reachabilityFence(broadcaster);
379 Reference.reachabilityFence(fee_estimator);
380 Reference.reachabilityFence(logger);
381 int ret_conv_49_len = ret.length;
382 TwoTuple_ThirtyTwoBytesCVec_C2Tuple_u32TxOutZZZ[] ret_conv_49_arr = new TwoTuple_ThirtyTwoBytesCVec_C2Tuple_u32TxOutZZZ[ret_conv_49_len];
383 for (int x = 0; x < ret_conv_49_len; x++) {
384 long ret_conv_49 = ret[x];
385 TwoTuple_ThirtyTwoBytesCVec_C2Tuple_u32TxOutZZZ ret_conv_49_hu_conv = new TwoTuple_ThirtyTwoBytesCVec_C2Tuple_u32TxOutZZZ(null, ret_conv_49);
386 if (ret_conv_49_hu_conv != null) { ret_conv_49_hu_conv.ptrs_to.add(this); };
387 ret_conv_49_arr[x] = ret_conv_49_hu_conv;
389 if (this != null) { this.ptrs_to.add(broadcaster); };
390 if (this != null) { this.ptrs_to.add(fee_estimator); };
391 if (this != null) { this.ptrs_to.add(logger); };
392 return ret_conv_49_arr;
396 * Processes a transaction that was reorganized out of the chain.
398 * Used instead of [`block_disconnected`] by clients that are notified of transactions rather
399 * than blocks. See [`chain::Confirm`] for calling expectations.
401 * [`block_disconnected`]: Self::block_disconnected
403 public void transaction_unconfirmed(byte[] txid, org.ldk.structs.BroadcasterInterface broadcaster, org.ldk.structs.FeeEstimator fee_estimator, org.ldk.structs.Logger logger) {
404 bindings.ChannelMonitor_transaction_unconfirmed(this.ptr, InternalUtils.check_arr_len(txid, 32), broadcaster.ptr, fee_estimator.ptr, logger.ptr);
405 Reference.reachabilityFence(this);
406 Reference.reachabilityFence(txid);
407 Reference.reachabilityFence(broadcaster);
408 Reference.reachabilityFence(fee_estimator);
409 Reference.reachabilityFence(logger);
410 if (this != null) { this.ptrs_to.add(broadcaster); };
411 if (this != null) { this.ptrs_to.add(fee_estimator); };
412 if (this != null) { this.ptrs_to.add(logger); };
416 * Updates the monitor with the current best chain tip, returning new outputs to watch. See
417 * [`block_connected`] for details.
419 * Used instead of [`block_connected`] by clients that are notified of transactions rather than
420 * blocks. See [`chain::Confirm`] for calling expectations.
422 * [`block_connected`]: Self::block_connected
424 public TwoTuple_ThirtyTwoBytesCVec_C2Tuple_u32TxOutZZZ[] best_block_updated(byte[] header, int height, org.ldk.structs.BroadcasterInterface broadcaster, org.ldk.structs.FeeEstimator fee_estimator, org.ldk.structs.Logger logger) {
425 long[] ret = bindings.ChannelMonitor_best_block_updated(this.ptr, InternalUtils.check_arr_len(header, 80), height, broadcaster.ptr, fee_estimator.ptr, logger.ptr);
426 Reference.reachabilityFence(this);
427 Reference.reachabilityFence(header);
428 Reference.reachabilityFence(height);
429 Reference.reachabilityFence(broadcaster);
430 Reference.reachabilityFence(fee_estimator);
431 Reference.reachabilityFence(logger);
432 int ret_conv_49_len = ret.length;
433 TwoTuple_ThirtyTwoBytesCVec_C2Tuple_u32TxOutZZZ[] ret_conv_49_arr = new TwoTuple_ThirtyTwoBytesCVec_C2Tuple_u32TxOutZZZ[ret_conv_49_len];
434 for (int x = 0; x < ret_conv_49_len; x++) {
435 long ret_conv_49 = ret[x];
436 TwoTuple_ThirtyTwoBytesCVec_C2Tuple_u32TxOutZZZ ret_conv_49_hu_conv = new TwoTuple_ThirtyTwoBytesCVec_C2Tuple_u32TxOutZZZ(null, ret_conv_49);
437 if (ret_conv_49_hu_conv != null) { ret_conv_49_hu_conv.ptrs_to.add(this); };
438 ret_conv_49_arr[x] = ret_conv_49_hu_conv;
440 if (this != null) { this.ptrs_to.add(broadcaster); };
441 if (this != null) { this.ptrs_to.add(fee_estimator); };
442 if (this != null) { this.ptrs_to.add(logger); };
443 return ret_conv_49_arr;
447 * Returns the set of txids that should be monitored for re-organization out of the chain.
449 public ThreeTuple_ThirtyTwoBytesu32COption_ThirtyTwoBytesZZ[] get_relevant_txids() {
450 long[] ret = bindings.ChannelMonitor_get_relevant_txids(this.ptr);
451 Reference.reachabilityFence(this);
452 int ret_conv_54_len = ret.length;
453 ThreeTuple_ThirtyTwoBytesu32COption_ThirtyTwoBytesZZ[] ret_conv_54_arr = new ThreeTuple_ThirtyTwoBytesu32COption_ThirtyTwoBytesZZ[ret_conv_54_len];
454 for (int c = 0; c < ret_conv_54_len; c++) {
455 long ret_conv_54 = ret[c];
456 ThreeTuple_ThirtyTwoBytesu32COption_ThirtyTwoBytesZZ ret_conv_54_hu_conv = new ThreeTuple_ThirtyTwoBytesu32COption_ThirtyTwoBytesZZ(null, ret_conv_54);
457 if (ret_conv_54_hu_conv != null) { ret_conv_54_hu_conv.ptrs_to.add(this); };
458 ret_conv_54_arr[c] = ret_conv_54_hu_conv;
460 return ret_conv_54_arr;
464 * Gets the latest best block which was connected either via the [`chain::Listen`] or
465 * [`chain::Confirm`] interfaces.
467 public BestBlock current_best_block() {
468 long ret = bindings.ChannelMonitor_current_best_block(this.ptr);
469 Reference.reachabilityFence(this);
470 if (ret >= 0 && ret <= 4096) { return null; }
471 org.ldk.structs.BestBlock ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new org.ldk.structs.BestBlock(null, ret); }
472 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(this); };
477 * Triggers rebroadcasts/fee-bumps of pending claims from a force-closed channel. This is
478 * crucial in preventing certain classes of pinning attacks, detecting substantial mempool
479 * feerate changes between blocks, and ensuring reliability if broadcasting fails. We recommend
480 * invoking this every 30 seconds, or lower if running in an environment with spotty
481 * connections, like on mobile.
483 public void rebroadcast_pending_claims(org.ldk.structs.BroadcasterInterface broadcaster, org.ldk.structs.FeeEstimator fee_estimator, org.ldk.structs.Logger logger) {
484 bindings.ChannelMonitor_rebroadcast_pending_claims(this.ptr, broadcaster.ptr, fee_estimator.ptr, logger.ptr);
485 Reference.reachabilityFence(this);
486 Reference.reachabilityFence(broadcaster);
487 Reference.reachabilityFence(fee_estimator);
488 Reference.reachabilityFence(logger);
489 if (this != null) { this.ptrs_to.add(broadcaster); };
490 if (this != null) { this.ptrs_to.add(fee_estimator); };
491 if (this != null) { this.ptrs_to.add(logger); };
495 * Returns the descriptors for relevant outputs (i.e., those that we can spend) within the
496 * transaction if they exist and the transaction has at least [`ANTI_REORG_DELAY`]
497 * confirmations. For [`SpendableOutputDescriptor::DelayedPaymentOutput`] descriptors to be
498 * returned, the transaction must have at least `max(ANTI_REORG_DELAY, to_self_delay)`
501 * Descriptors returned by this method are primarily exposed via [`Event::SpendableOutputs`]
502 * once they are no longer under reorg risk. This method serves as a way to retrieve these
503 * descriptors at a later time, either for historical purposes, or to replay any
504 * missed/unhandled descriptors. For the purpose of gathering historical records, if the
505 * channel close has fully resolved (i.e., [`ChannelMonitor::get_claimable_balances`] returns
506 * an empty set), you can retrieve all spendable outputs by providing all descendant spending
507 * transactions starting from the channel's funding transaction and going down three levels.
509 * `tx` is a transaction we'll scan the outputs of. Any transaction can be provided. If any
510 * outputs which can be spent by us are found, at least one descriptor is returned.
512 * `confirmation_height` must be the height of the block in which `tx` was included in.
514 public SpendableOutputDescriptor[] get_spendable_outputs(byte[] tx, int confirmation_height) {
515 long[] ret = bindings.ChannelMonitor_get_spendable_outputs(this.ptr, tx, confirmation_height);
516 Reference.reachabilityFence(this);
517 Reference.reachabilityFence(tx);
518 Reference.reachabilityFence(confirmation_height);
519 int ret_conv_27_len = ret.length;
520 SpendableOutputDescriptor[] ret_conv_27_arr = new SpendableOutputDescriptor[ret_conv_27_len];
521 for (int b = 0; b < ret_conv_27_len; b++) {
522 long ret_conv_27 = ret[b];
523 org.ldk.structs.SpendableOutputDescriptor ret_conv_27_hu_conv = org.ldk.structs.SpendableOutputDescriptor.constr_from_ptr(ret_conv_27);
524 if (ret_conv_27_hu_conv != null) { ret_conv_27_hu_conv.ptrs_to.add(this); };
525 ret_conv_27_arr[b] = ret_conv_27_hu_conv;
527 return ret_conv_27_arr;
531 * Gets the balances in this channel which are either claimable by us if we were to
532 * force-close the channel now or which are claimable on-chain (possibly awaiting
535 * Any balances in the channel which are available on-chain (excluding on-chain fees) are
536 * included here until an [`Event::SpendableOutputs`] event has been generated for the
537 * balance, or until our counterparty has claimed the balance and accrued several
538 * confirmations on the claim transaction.
540 * Note that for `ChannelMonitors` which track a channel which went on-chain with versions of
541 * LDK prior to 0.0.111, not all or excess balances may be included.
543 * See [`Balance`] for additional details on the types of claimable balances which
544 * may be returned here and their meanings.
546 public Balance[] get_claimable_balances() {
547 long[] ret = bindings.ChannelMonitor_get_claimable_balances(this.ptr);
548 Reference.reachabilityFence(this);
549 int ret_conv_9_len = ret.length;
550 Balance[] ret_conv_9_arr = new Balance[ret_conv_9_len];
551 for (int j = 0; j < ret_conv_9_len; j++) {
552 long ret_conv_9 = ret[j];
553 org.ldk.structs.Balance ret_conv_9_hu_conv = org.ldk.structs.Balance.constr_from_ptr(ret_conv_9);
554 if (ret_conv_9_hu_conv != null) { ret_conv_9_hu_conv.ptrs_to.add(this); };
555 ret_conv_9_arr[j] = ret_conv_9_hu_conv;
557 return ret_conv_9_arr;