X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=blobdiff_plain;f=src%2Fmain%2Fjava%2Forg%2Fldk%2Fstructs%2FChainMonitor.java;h=c3ccf961b96766344fa394a30743c9928c84f686;hb=c6bac88847b7c09560af81f00ba8dd3c2ebe3a19;hp=a32ef2d3fad316b3a78f8d9129954534cc10772e;hpb=1b870a3ffab1c0024411e30102bc6d198300f095;p=ldk-java

diff --git a/src/main/java/org/ldk/structs/ChainMonitor.java b/src/main/java/org/ldk/structs/ChainMonitor.java
index a32ef2d3..c3ccf961 100644
--- a/src/main/java/org/ldk/structs/ChainMonitor.java
+++ b/src/main/java/org/ldk/structs/ChainMonitor.java
@@ -4,6 +4,7 @@ import org.ldk.impl.bindings;
 import org.ldk.enums.*;
 import org.ldk.util.*;
 import java.util.Arrays;
+import javax.annotation.Nullable;
 
 
 /**
@@ -14,9 +15,8 @@ import java.util.Arrays;
  * or used independently to monitor channels remotely. See the [module-level documentation] for
  * details.
  * 
- * [`chain::Watch`]: ../trait.Watch.html
- * [`ChannelManager`]: ../../ln/channelmanager/struct.ChannelManager.html
- * [module-level documentation]: index.html
+ * [`ChannelManager`]: crate::ln::channelmanager::ChannelManager
+ * [module-level documentation]: crate::chain::chainmonitor
  */
 @SuppressWarnings("unchecked") // We correctly assign various generic arrays
 public class ChainMonitor extends CommonBase {
@@ -28,56 +28,124 @@ public class ChainMonitor extends CommonBase {
 	}
 
 	/**
-	 * Dispatches to per-channel monitors, which are responsible for updating their on-chain view
-	 * of a channel and reacting accordingly based on transactions in the connected block. See
-	 * [`ChannelMonitor::block_connected`] for details. Any HTLCs that were resolved on chain will
-	 * be returned by [`chain::Watch::release_pending_monitor_events`].
+	 * Creates a new `ChainMonitor` used to watch on-chain activity pertaining to channels.
 	 * 
-	 * Calls back to [`chain::Filter`] if any monitor indicated new outputs to watch. Subsequent
-	 * calls must not exclude any transactions matching the new outputs nor any in-block
-	 * descendants of such transactions. It is not necessary to re-fetch the block to obtain
-	 * updated `txdata`.
+	 * 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 >= 0 && ret <= 4096) { return null; }
+		ChainMonitor ret_hu_conv = null; if (ret < 0 || ret > 4096) { 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`]).
 	 * 
-	 * [`ChannelMonitor::block_connected`]: ../channelmonitor/struct.ChannelMonitor.html#method.block_connected
-	 * [`chain::Watch::release_pending_monitor_events`]: ../trait.Watch.html#tymethod.release_pending_monitor_events
-	 * [`chain::Filter`]: ../trait.Filter.html
+	 * See [`ChannelMonitor::get_claimable_balances`] for more details on the exact criteria for
+	 * inclusion in the return value.
 	 */
-	public void block_connected(byte[] header, TwoTuple<Long, byte[]>[] txdata, int height) {
-		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);
-		/* TODO 2 TwoTuple<Long, byte[]>  */;
+	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;
 	}
 
 	/**
-	 * Dispatches to per-channel monitors, which are responsible for updating their on-chain view
-	 * of a channel based on the disconnected block. See [`ChannelMonitor::block_disconnected`] for
-	 * details.
+	 * Gets the [`LockedChannelMonitor`] for a given funding outpoint, returning an `Err` if no
+	 * such [`ChannelMonitor`] is currently being monitored for.
 	 * 
-	 * [`ChannelMonitor::block_disconnected`]: ../channelmonitor/struct.ChannelMonitor.html#method.block_disconnected
+	 * Note that the result holds a mutex over our monitor set, and should not be held
+	 * indefinitely.
 	 */
-	public void block_disconnected(byte[] header, int disconnected_height) {
-		bindings.ChainMonitor_block_disconnected(this.ptr, header, disconnected_height);
+	public Result_LockedChannelMonitorNoneZ get_monitor(OutPoint funding_txo) {
+		long ret = bindings.ChainMonitor_get_monitor(this.ptr, funding_txo == null ? 0 : funding_txo.ptr & ~1);
+		if (ret >= 0 && ret <= 4096) { return null; }
+		Result_LockedChannelMonitorNoneZ ret_hu_conv = Result_LockedChannelMonitorNoneZ.constr_from_ptr(ret);
+		return ret_hu_conv;
 	}
 
 	/**
-	 * Creates a new `ChainMonitor` used to watch on-chain activity pertaining to channels.
+	 * Lists the funding outpoint of each [`ChannelMonitor`] being monitored.
 	 * 
-	 * 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.
+	 * Note that [`ChannelMonitor`]s are not removed when a channel is closed as they are always
+	 * monitoring for on-chain state resolutions.
+	 */
+	public OutPoint[] list_monitors() {
+		long[] ret = bindings.ChainMonitor_list_monitors(this.ptr);
+		OutPoint[] ret_conv_10_arr = new OutPoint[ret.length];
+		for (int k = 0; k < ret.length; k++) {
+			long ret_conv_10 = ret[k];
+			OutPoint ret_conv_10_hu_conv = null; if (ret_conv_10 < 0 || ret_conv_10 > 4096) { ret_conv_10_hu_conv = new OutPoint(null, ret_conv_10); }
+			ret_conv_10_hu_conv.ptrs_to.add(this);
+			ret_conv_10_arr[k] = ret_conv_10_hu_conv;
+		}
+		return ret_conv_10_arr;
+	}
+
+	/**
+	 * Indicates the persistence of a [`ChannelMonitor`] has completed after
+	 * [`ChannelMonitorUpdateErr::TemporaryFailure`] was returned from an update operation.
+	 * 
+	 * Thus, the anticipated use is, at a high level:
+	 * 1) This [`ChainMonitor`] calls [`Persist::update_persisted_channel`] which stores the
+	 * update to disk and begins updating any remote (e.g. watchtower/backup) copies,
+	 * returning [`ChannelMonitorUpdateErr::TemporaryFailure`],
+	 * 2) once all remote copies are updated, you call this function with the
+	 * `completed_update_id` that completed, and once all pending updates have completed the
+	 * channel will be re-enabled.
 	 * 
-	 * [`chain::Filter`]: ../trait.Filter.html
+	 * Returns an [`APIError::APIMisuseError`] if `funding_txo` does not match any currently
+	 * registered [`ChannelMonitor`]s.
 	 */
-	public static ChainMonitor constructor_new(Filter chain_source, BroadcasterInterface broadcaster, Logger logger, FeeEstimator feeest, Persist persister) {
-		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);
-		ChainMonitor ret_hu_conv = new ChainMonitor(null, ret);
-		ret_hu_conv.ptrs_to.add(ret_hu_conv);
-		ret_hu_conv.ptrs_to.add(chain_source);
-		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);
+	public Result_NoneAPIErrorZ channel_monitor_updated(OutPoint funding_txo, MonitorUpdateId completed_update_id) {
+		long ret = bindings.ChainMonitor_channel_monitor_updated(this.ptr, funding_txo == null ? 0 : funding_txo.ptr & ~1, completed_update_id == null ? 0 : completed_update_id.ptr & ~1);
+		if (ret >= 0 && ret <= 4096) { return null; }
+		Result_NoneAPIErrorZ ret_hu_conv = Result_NoneAPIErrorZ.constr_from_ptr(ret);
+		return ret_hu_conv;
+	}
+
+	/**
+	 * 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 >= 0 && ret <= 4096) { return null; }
+		Listen ret_hu_conv = new Listen(null, ret);
+		ret_hu_conv.ptrs_to.add(this);
+		return ret_hu_conv;
+	}
+
+	/**
+	 * 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 >= 0 && ret <= 4096) { return null; }
+		Confirm ret_hu_conv = new Confirm(null, ret);
+		ret_hu_conv.ptrs_to.add(this);
 		return ret_hu_conv;
 	}
 
@@ -87,6 +155,7 @@ public class ChainMonitor extends CommonBase {
 	 */
 	public Watch as_Watch() {
 		long ret = bindings.ChainMonitor_as_Watch(this.ptr);
+		if (ret >= 0 && ret <= 4096) { return null; }
 		Watch ret_hu_conv = new Watch(null, ret);
 		ret_hu_conv.ptrs_to.add(this);
 		return ret_hu_conv;
@@ -98,6 +167,7 @@ public class ChainMonitor extends CommonBase {
 	 */
 	public EventsProvider as_EventsProvider() {
 		long ret = bindings.ChainMonitor_as_EventsProvider(this.ptr);
+		if (ret >= 0 && ret <= 4096) { return null; }
 		EventsProvider ret_hu_conv = new EventsProvider(null, ret);
 		ret_hu_conv.ptrs_to.add(this);
 		return ret_hu_conv;