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

diff --git a/src/main/java/org/ldk/structs/ChainMonitor.java b/src/main/java/org/ldk/structs/ChainMonitor.java
index 94e0f36e..1cfc04d3 100644
--- a/src/main/java/org/ldk/structs/ChainMonitor.java
+++ b/src/main/java/org/ldk/structs/ChainMonitor.java
@@ -2,38 +2,96 @@ package org.ldk.structs;
 
 import org.ldk.impl.bindings;
 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.
+ * 
+ * [`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 {
 		super.finalize();
-		bindings.ChainMonitor_free(ptr);
+		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`.
+	 */
+	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[]>  */;
 	}
 
-	// Skipped ChainMonitor_block_connected
+	/**
+	 * 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.
+	 */
 	public void block_disconnected(byte[] header, int disconnected_height) {
 		bindings.ChainMonitor_block_disconnected(this.ptr, header, disconnected_height);
 	}
 
-	public ChainMonitor(Filter chain_source, BroadcasterInterface broadcaster, Logger logger, FeeEstimator feeest) {
-		super(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));
-		this.ptrs_to.add(chain_source);
-		this.ptrs_to.add(broadcaster);
-		this.ptrs_to.add(logger);
-		this.ptrs_to.add(feeest);
+	/**
+	 * 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 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);
+		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);
+		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);
+		EventsProvider ret_hu_conv = new EventsProvider(null, ret);
+		ret_hu_conv.ptrs_to.add(this);
+		return ret_hu_conv;
 	}
 
 }