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

diff --git a/src/main/java/org/ldk/structs/ChainMonitor.java b/src/main/java/org/ldk/structs/ChainMonitor.java
index 737433d8..a32ef2d3 100644
--- a/src/main/java/org/ldk/structs/ChainMonitor.java
+++ b/src/main/java/org/ldk/structs/ChainMonitor.java
@@ -5,6 +5,19 @@ import org.ldk.enums.*;
 import org.ldk.util.*;
 import java.util.Arrays;
 
+
+/**
+ * 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.
+ * 
+ * [`chain::Watch`]: ../trait.Watch.html
+ * [`ChannelManager`]: ../../ln/channelmanager/struct.ChannelManager.html
+ * [module-level documentation]: index.html
+ */
 @SuppressWarnings("unchecked") // We correctly assign various generic arrays
 public class ChainMonitor extends CommonBase {
 	ChainMonitor(Object _dummy, long ptr) { super(ptr); }
@@ -14,15 +27,48 @@ public class ChainMonitor extends CommonBase {
 		if (ptr != 0) { bindings.ChainMonitor_free(ptr); }
 	}
 
+	/**
+	 * 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`].
+	 * 
+	 * 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`.
+	 * 
+	 * [`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
+	 */
 	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[]>  */;
 	}
 
+	/**
+	 * 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.
+	 * 
+	 * [`ChannelMonitor::block_disconnected`]: ../channelmonitor/struct.ChannelMonitor.html#method.block_disconnected
+	 */
 	public void block_disconnected(byte[] header, int disconnected_height) {
 		bindings.ChainMonitor_block_disconnected(this.ptr, header, disconnected_height);
 	}
 
+	/**
+	 * 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.
+	 * 
+	 * [`chain::Filter`]: ../trait.Filter.html
+	 */
 	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);
@@ -35,6 +81,10 @@ public class ChainMonitor extends CommonBase {
 		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() {
 		long ret = bindings.ChainMonitor_as_Watch(this.ptr);
 		Watch ret_hu_conv = new Watch(null, ret);
@@ -42,6 +92,10 @@ public class ChainMonitor extends CommonBase {
 		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() {
 		long ret = bindings.ChainMonitor_as_EventsProvider(this.ptr);
 		EventsProvider ret_hu_conv = new EventsProvider(null, ret);