[Java] Update auto-generated bindings
[ldk-java] / src / main / java / org / ldk / structs / Watch.java
index 9bf7a60359be09b15536c8e630bcf3782c089aa9..8888d28d42d2e973054a933dd9b9404858226b7e 100644 (file)
@@ -4,6 +4,7 @@ import org.ldk.impl.bindings;
 import org.ldk.enums.*;
 import org.ldk.util.*;
 import java.util.Arrays;
+import java.lang.ref.Reference;
 import javax.annotation.Nullable;
 
 /**
@@ -25,9 +26,7 @@ import javax.annotation.Nullable;
  * funds in the channel. See [`ChannelMonitorUpdateErr`] for more details about how to handle
  * multiple instances.
  * 
- * [`ChannelMonitor`]: channelmonitor::ChannelMonitor
- * [`ChannelMonitorUpdateErr`]: channelmonitor::ChannelMonitorUpdateErr
- * [`PermanentFailure`]: channelmonitor::ChannelMonitorUpdateErr::PermanentFailure
+ * [`PermanentFailure`]: ChannelMonitorUpdateErr::PermanentFailure
  */
 @SuppressWarnings("unchecked") // We correctly assign various generic arrays
 public class Watch extends CommonBase {
@@ -51,6 +50,9 @@ public class Watch extends CommonBase {
                 * with any spends of outputs returned by [`get_outputs_to_watch`]. In practice, this means
                 * calling [`block_connected`] and [`block_disconnected`] on the monitor.
                 * 
+                * Note: this interface MUST error with `ChannelMonitorUpdateErr::PermanentFailure` if
+                * the given `funding_txo` has previously been registered via `watch_channel`.
+                * 
                 * [`get_outputs_to_watch`]: channelmonitor::ChannelMonitor::get_outputs_to_watch
                 * [`block_connected`]: channelmonitor::ChannelMonitor::block_connected
                 * [`block_disconnected`]: channelmonitor::ChannelMonitor::block_disconnected
@@ -63,12 +65,18 @@ public class Watch extends CommonBase {
                 * [`ChannelMonitorUpdateErr`] for invariants around returning an error.
                 * 
                 * [`update_monitor`]: channelmonitor::ChannelMonitor::update_monitor
-                * [`ChannelMonitorUpdateErr`]: channelmonitor::ChannelMonitorUpdateErr
                 */
                Result_NoneChannelMonitorUpdateErrZ update_channel(OutPoint funding_txo, ChannelMonitorUpdate update);
                /**
                 * Returns any monitor events since the last call. Subsequent calls must only return new
                 * events.
+                * 
+                * Note that after any block- or transaction-connection calls to a [`ChannelMonitor`], no
+                * further events may be returned here until the [`ChannelMonitor`] has been fully persisted
+                * to disk.
+                * 
+                * For details on asynchronous [`ChannelMonitor`] updating and returning
+                * [`MonitorEvent::UpdateCompleted`] here, see [`ChannelMonitorUpdateErr::TemporaryFailure`].
                 */
                MonitorEvent[] release_pending_monitor_events();
        }
@@ -77,26 +85,29 @@ public class Watch extends CommonBase {
                final LDKWatchHolder impl_holder = new LDKWatchHolder();
                impl_holder.held = new Watch(new bindings.LDKWatch() {
                        @Override public long watch_channel(long funding_txo, long monitor) {
-                               OutPoint funding_txo_hu_conv = new OutPoint(null, funding_txo);
+                               OutPoint funding_txo_hu_conv = null; if (funding_txo < 0 || funding_txo > 4096) { funding_txo_hu_conv = new OutPoint(null, funding_txo); }
                                funding_txo_hu_conv.ptrs_to.add(this);
-                               ChannelMonitor monitor_hu_conv = new ChannelMonitor(null, monitor);
+                               ChannelMonitor monitor_hu_conv = null; if (monitor < 0 || monitor > 4096) { monitor_hu_conv = new ChannelMonitor(null, monitor); }
                                monitor_hu_conv.ptrs_to.add(this);
                                Result_NoneChannelMonitorUpdateErrZ ret = arg.watch_channel(funding_txo_hu_conv, monitor_hu_conv);
-                               long result = ret != null ? ret.ptr : 0;
+                               Reference.reachabilityFence(arg);
+                               long result = ret == null ? 0 : ret.clone_ptr();
                                return result;
                        }
                        @Override public long update_channel(long funding_txo, long update) {
-                               OutPoint funding_txo_hu_conv = new OutPoint(null, funding_txo);
+                               OutPoint funding_txo_hu_conv = null; if (funding_txo < 0 || funding_txo > 4096) { funding_txo_hu_conv = new OutPoint(null, funding_txo); }
                                funding_txo_hu_conv.ptrs_to.add(this);
-                               ChannelMonitorUpdate update_hu_conv = new ChannelMonitorUpdate(null, update);
+                               ChannelMonitorUpdate update_hu_conv = null; if (update < 0 || update > 4096) { update_hu_conv = new ChannelMonitorUpdate(null, update); }
                                update_hu_conv.ptrs_to.add(this);
                                Result_NoneChannelMonitorUpdateErrZ ret = arg.update_channel(funding_txo_hu_conv, update_hu_conv);
-                               long result = ret != null ? ret.ptr : 0;
+                               Reference.reachabilityFence(arg);
+                               long result = ret == null ? 0 : ret.clone_ptr();
                                return result;
                        }
                        @Override public long[] release_pending_monitor_events() {
                                MonitorEvent[] ret = arg.release_pending_monitor_events();
-                               long[] result = ret != null ? Arrays.stream(ret).mapToLong(ret_conv_14 -> ret_conv_14.ptr).toArray() : null;
+                               Reference.reachabilityFence(arg);
+                               long[] result = ret != null ? Arrays.stream(ret).mapToLong(ret_conv_14 -> ret_conv_14 == null ? 0 : ret_conv_14.clone_ptr()).toArray() : null;
                                return result;
                        }
                });
@@ -109,13 +120,19 @@ public class Watch extends CommonBase {
         * with any spends of outputs returned by [`get_outputs_to_watch`]. In practice, this means
         * calling [`block_connected`] and [`block_disconnected`] on the monitor.
         * 
+        * Note: this interface MUST error with `ChannelMonitorUpdateErr::PermanentFailure` if
+        * the given `funding_txo` has previously been registered via `watch_channel`.
+        * 
         * [`get_outputs_to_watch`]: channelmonitor::ChannelMonitor::get_outputs_to_watch
         * [`block_connected`]: channelmonitor::ChannelMonitor::block_connected
         * [`block_disconnected`]: channelmonitor::ChannelMonitor::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);
-               if (ret >= 0 && ret < 1024) { return null; }
+               Reference.reachabilityFence(this);
+               Reference.reachabilityFence(funding_txo);
+               Reference.reachabilityFence(monitor);
+               if (ret >= 0 && ret <= 4096) { return null; }
                Result_NoneChannelMonitorUpdateErrZ ret_hu_conv = Result_NoneChannelMonitorUpdateErrZ.constr_from_ptr(ret);
                return ret_hu_conv;
        }
@@ -127,11 +144,13 @@ public class Watch extends CommonBase {
         * [`ChannelMonitorUpdateErr`] for invariants around returning an error.
         * 
         * [`update_monitor`]: channelmonitor::ChannelMonitor::update_monitor
-        * [`ChannelMonitorUpdateErr`]: channelmonitor::ChannelMonitorUpdateErr
         */
        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);
-               if (ret >= 0 && ret < 1024) { return null; }
+               Reference.reachabilityFence(this);
+               Reference.reachabilityFence(funding_txo);
+               Reference.reachabilityFence(update);
+               if (ret >= 0 && ret <= 4096) { return null; }
                Result_NoneChannelMonitorUpdateErrZ ret_hu_conv = Result_NoneChannelMonitorUpdateErrZ.constr_from_ptr(ret);
                return ret_hu_conv;
        }
@@ -139,13 +158,22 @@ public class Watch extends CommonBase {
        /**
         * Returns any monitor events since the last call. Subsequent calls must only return new
         * events.
+        * 
+        * Note that after any block- or transaction-connection calls to a [`ChannelMonitor`], no
+        * further events may be returned here until the [`ChannelMonitor`] has been fully persisted
+        * to disk.
+        * 
+        * For details on asynchronous [`ChannelMonitor`] updating and returning
+        * [`MonitorEvent::UpdateCompleted`] here, see [`ChannelMonitorUpdateErr::TemporaryFailure`].
         */
        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];
-               for (int o = 0; o < ret.length; o++) {
+               Reference.reachabilityFence(this);
+               int ret_conv_14_len = ret.length;
+               MonitorEvent[] ret_conv_14_arr = new MonitorEvent[ret_conv_14_len];
+               for (int o = 0; o < ret_conv_14_len; o++) {
                        long ret_conv_14 = ret[o];
-                       MonitorEvent ret_conv_14_hu_conv = MonitorEvent.constr_from_ptr(ret_conv_14);
+                       org.ldk.structs.MonitorEvent ret_conv_14_hu_conv = org.ldk.structs.MonitorEvent.constr_from_ptr(ret_conv_14);
                        ret_conv_14_hu_conv.ptrs_to.add(this);
                        ret_conv_14_arr[o] = ret_conv_14_hu_conv;
                }