import org.ldk.impl.bindings;
import org.ldk.enums.*;
+import org.ldk.util.*;
+import java.util.Arrays;
+import javax.annotation.Nullable;
+
+/**
+ * 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
+ */
+@SuppressWarnings("unchecked") // We correctly assign various generic arrays
public class ChainMonitor extends CommonBase {
ChainMonitor(Object _dummy, long ptr) { super(ptr); }
@Override @SuppressWarnings("deprecation")
protected void finalize() throws Throwable {
- bindings.ChainMonitor_free(ptr); super.finalize();
+ super.finalize();
+ if (ptr != 0) { bindings.ChainMonitor_free(ptr); }
+ }
+
+ /**
+ * 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.
+ */
+ public static ChainMonitor of(Option_FilterZ chain_source, BroadcasterInterface broadcaster, Logger logger, FeeEstimator feeest, Persist persister) {
+ long ret = bindings.ChainMonitor_new(chain_source.ptr, broadcaster == null ? 0 : broadcaster.ptr, logger == null ? 0 : logger.ptr, feeest == null ? 0 : feeest.ptr, persister == null ? 0 : persister.ptr);
+ if (ret < 1024) { return null; }
+ ChainMonitor ret_hu_conv = new ChainMonitor(null, ret);
+ ret_hu_conv.ptrs_to.add(ret_hu_conv);
+ ret_hu_conv.ptrs_to.add(broadcaster);
+ ret_hu_conv.ptrs_to.add(logger);
+ ret_hu_conv.ptrs_to.add(feeest);
+ ret_hu_conv.ptrs_to.add(persister);
+ return ret_hu_conv;
+ }
+
+ /**
+ * 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.
+ */
+ public Balance[] get_claimable_balances(ChannelDetails[] ignored_channels) {
+ long[] ret = bindings.ChainMonitor_get_claimable_balances(this.ptr, ignored_channels != null ? Arrays.stream(ignored_channels).mapToLong(ignored_channels_conv_16 -> ignored_channels_conv_16 == null ? 0 : ignored_channels_conv_16.ptr & ~1).toArray() : null);
+ Balance[] ret_conv_9_arr = new Balance[ret.length];
+ for (int j = 0; j < ret.length; j++) {
+ long ret_conv_9 = ret[j];
+ Balance ret_conv_9_hu_conv = Balance.constr_from_ptr(ret_conv_9);
+ ret_conv_9_hu_conv.ptrs_to.add(this);
+ ret_conv_9_arr[j] = ret_conv_9_hu_conv;
+ }
+ return ret_conv_9_arr;
}
- // Skipped ChainMonitor_block_connected
- public void block_disconnected(byte[] header, int disconnected_height) {
- bindings.ChainMonitor_block_disconnected(this.ptr, header, disconnected_height);
+ /**
+ * 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
+ */
+ public Listen as_Listen() {
+ long ret = bindings.ChainMonitor_as_Listen(this.ptr);
+ if (ret < 1024) { return null; }
+ Listen ret_hu_conv = new Listen(null, ret);
+ ret_hu_conv.ptrs_to.add(this);
+ return ret_hu_conv;
}
- public ChainMonitor(Filter chain_source, BroadcasterInterface broadcaster, Logger logger, FeeEstimator feeest) {
- super(bindings.ChainMonitor_new(chain_source.ptr, broadcaster.ptr, logger.ptr, feeest.ptr));
- this.ptrs_to.add(chain_source);
- this.ptrs_to.add(broadcaster);
- this.ptrs_to.add(logger);
- this.ptrs_to.add(feeest);
+ /**
+ * 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
+ */
+ public Confirm as_Confirm() {
+ long ret = bindings.ChainMonitor_as_Confirm(this.ptr);
+ if (ret < 1024) { return null; }
+ Confirm ret_hu_conv = new Confirm(null, ret);
+ ret_hu_conv.ptrs_to.add(this);
+ return ret_hu_conv;
}
+ /**
+ * 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
+ */
public Watch as_Watch() {
- Watch ret = new Watch(null, bindings.ChainMonitor_as_Watch(this.ptr));
- ret.ptrs_to.add(this);
- return ret;
+ long ret = bindings.ChainMonitor_as_Watch(this.ptr);
+ if (ret < 1024) { return null; }
+ Watch ret_hu_conv = new Watch(null, ret);
+ ret_hu_conv.ptrs_to.add(this);
+ return ret_hu_conv;
}
+ /**
+ * 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
+ */
public EventsProvider as_EventsProvider() {
- EventsProvider ret = new EventsProvider(null, bindings.ChainMonitor_as_EventsProvider(this.ptr));
- ret.ptrs_to.add(this);
- return ret;
+ long ret = bindings.ChainMonitor_as_EventsProvider(this.ptr);
+ if (ret < 1024) { return null; }
+ EventsProvider ret_hu_conv = new EventsProvider(null, ret);
+ ret_hu_conv.ptrs_to.add(this);
+ return ret_hu_conv;
}
}
projects / ldk-java / blobdiff