X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=blobdiff_plain;f=src%2Fmain%2Fjava%2Forg%2Fldk%2Fstructs%2FWatch.java;fp=src%2Fmain%2Fjava%2Forg%2Fldk%2Fstructs%2FWatch.java;h=85602ac83a4135f09079c490791dcf1242224bc9;hb=17113550a5fefab21f39f27fbfe02646b8db53ae;hp=c9b156fbd5146997e446ae25ae8fc4c74e3bc479;hpb=d69a40d071871d3c0e4160744202c6e85941a4cc;p=ldk-java

diff --git a/src/main/java/org/ldk/structs/Watch.java b/src/main/java/org/ldk/structs/Watch.java
index c9b156fb..85602ac8 100644
--- a/src/main/java/org/ldk/structs/Watch.java
+++ b/src/main/java/org/ldk/structs/Watch.java
@@ -5,6 +5,29 @@ import org.ldk.enums.*;
 import org.ldk.util.*;
 import java.util.Arrays;
 
+/**
+ * The `Watch` trait defines behavior for watching on-chain activity pertaining to channels as
+ * blocks are connected and disconnected.
+ * 
+ * Each channel is associated with a [`ChannelMonitor`]. Implementations of this trait are
+ * responsible for maintaining a set of monitors such that they can be updated accordingly as
+ * channel state changes and HTLCs are resolved. See method documentation for specific
+ * requirements.
+ * 
+ * Implementations **must** ensure that updates are successfully applied and persisted upon method
+ * completion. If an update fails with a [`PermanentFailure`], then it must immediately shut down
+ * without taking any further action such as persisting the current state.
+ * 
+ * If an implementation maintains multiple instances of a channel's monitor (e.g., by storing
+ * backup copies), then it must ensure that updates are applied across all instances. Otherwise, it
+ * could result in a revoked transaction being broadcast, allowing the counterparty to claim all
+ * funds in the channel. See [`ChannelMonitorUpdateErr`] for more details about how to handle
+ * multiple instances.
+ * 
+ * [`ChannelMonitor`]: channelmonitor/struct.ChannelMonitor.html
+ * [`ChannelMonitorUpdateErr`]: channelmonitor/enum.ChannelMonitorUpdateErr.html
+ * [`PermanentFailure`]: channelmonitor/enum.ChannelMonitorUpdateErr.html#variant.PermanentFailure
+ */
 @SuppressWarnings("unchecked") // We correctly assign various generic arrays
 public class Watch extends CommonBase {
 	final bindings.LDKWatch bindings_instance;
@@ -20,8 +43,32 @@ public class Watch extends CommonBase {
 	}
 
 	public static interface WatchInterface {
+		/**
+		 * Watches a channel identified by `funding_txo` using `monitor`.
+		 * 
+		 * Implementations are responsible for watching the chain for the funding transaction along
+		 * with any spends of outputs returned by [`get_outputs_to_watch`]. In practice, this means
+		 * calling [`block_connected`] and [`block_disconnected`] on the monitor.
+		 * 
+		 * [`get_outputs_to_watch`]: channelmonitor/struct.ChannelMonitor.html#method.get_outputs_to_watch
+		 * [`block_connected`]: channelmonitor/struct.ChannelMonitor.html#method.block_connected
+		 * [`block_disconnected`]: channelmonitor/struct.ChannelMonitor.html#method.block_disconnected
+		 */
 		Result_NoneChannelMonitorUpdateErrZ watch_channel(OutPoint funding_txo, ChannelMonitor monitor);
+		/**
+		 * Updates a channel identified by `funding_txo` by applying `update` to its monitor.
+		 * 
+		 * Implementations must call [`update_monitor`] with the given update. See
+		 * [`ChannelMonitorUpdateErr`] for invariants around returning an error.
+		 * 
+		 * [`update_monitor`]: channelmonitor/struct.ChannelMonitor.html#method.update_monitor
+		 * [`ChannelMonitorUpdateErr`]: channelmonitor/enum.ChannelMonitorUpdateErr.html
+		 */
 		Result_NoneChannelMonitorUpdateErrZ update_channel(OutPoint funding_txo, ChannelMonitorUpdate update);
+		/**
+		 * Returns any monitor events since the last call. Subsequent calls must only return new
+		 * events.
+		 */
 		MonitorEvent[] release_pending_monitor_events();
 	}
 	private static class LDKWatchHolder { Watch held; }
@@ -55,6 +102,17 @@ public class Watch extends CommonBase {
 		});
 		return impl_holder.held;
 	}
+	/**
+	 * Watches a channel identified by `funding_txo` using `monitor`.
+	 * 
+	 * Implementations are responsible for watching the chain for the funding transaction along
+	 * with any spends of outputs returned by [`get_outputs_to_watch`]. In practice, this means
+	 * calling [`block_connected`] and [`block_disconnected`] on the monitor.
+	 * 
+	 * [`get_outputs_to_watch`]: channelmonitor/struct.ChannelMonitor.html#method.get_outputs_to_watch
+	 * [`block_connected`]: channelmonitor/struct.ChannelMonitor.html#method.block_connected
+	 * [`block_disconnected`]: channelmonitor/struct.ChannelMonitor.html#method.block_disconnected
+	 */
 	public Result_NoneChannelMonitorUpdateErrZ watch_channel(OutPoint funding_txo, ChannelMonitor monitor) {
 		long ret = bindings.Watch_watch_channel(this.ptr, funding_txo == null ? 0 : funding_txo.ptr & ~1, monitor == null ? 0 : monitor.ptr & ~1);
 		Result_NoneChannelMonitorUpdateErrZ ret_hu_conv = Result_NoneChannelMonitorUpdateErrZ.constr_from_ptr(ret);
@@ -63,6 +121,15 @@ public class Watch extends CommonBase {
 		return ret_hu_conv;
 	}
 
+	/**
+	 * Updates a channel identified by `funding_txo` by applying `update` to its monitor.
+	 * 
+	 * Implementations must call [`update_monitor`] with the given update. See
+	 * [`ChannelMonitorUpdateErr`] for invariants around returning an error.
+	 * 
+	 * [`update_monitor`]: channelmonitor/struct.ChannelMonitor.html#method.update_monitor
+	 * [`ChannelMonitorUpdateErr`]: channelmonitor/enum.ChannelMonitorUpdateErr.html
+	 */
 	public Result_NoneChannelMonitorUpdateErrZ update_channel(OutPoint funding_txo, ChannelMonitorUpdate update) {
 		long ret = bindings.Watch_update_channel(this.ptr, funding_txo == null ? 0 : funding_txo.ptr & ~1, update == null ? 0 : update.ptr & ~1);
 		Result_NoneChannelMonitorUpdateErrZ ret_hu_conv = Result_NoneChannelMonitorUpdateErrZ.constr_from_ptr(ret);
@@ -71,6 +138,10 @@ public class Watch extends CommonBase {
 		return ret_hu_conv;
 	}
 
+	/**
+	 * Returns any monitor events since the last call. Subsequent calls must only return new
+	 * events.
+	 */
 	public MonitorEvent[] release_pending_monitor_events() {
 		long[] ret = bindings.Watch_release_pending_monitor_events(this.ptr);
 		MonitorEvent[] ret_conv_14_arr = new MonitorEvent[ret.length];