[Java] Update auto-generated Java bindings

[ldk-java] / src / main / java / org / ldk / structs / ChannelMonitorUpdate.java

diff --git a/src/main/java/org/ldk/structs/ChannelMonitorUpdate.java b/src/main/java/org/ldk/structs/ChannelMonitorUpdate.java
index 179a200d9824857ac849d8120f246426c65e29ca..cbf5769feaf658677d3ea2d743f1a5701d94351f 100644 (file)
--- a/src/main/java/org/ldk/structs/ChannelMonitorUpdate.java
+++ b/src/main/java/org/ldk/structs/ChannelMonitorUpdate.java
@@ -4,7 +4,19 @@ 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;
 
+
+/**
+ * An update generated by the underlying channel itself which contains some new information the
+ * [`ChannelMonitor`] should be made aware of.
+ * 
+ * Because this represents only a small number of updates to the underlying state, it is generally
+ * much smaller than a full [`ChannelMonitor`]. However, for large single commitment transaction
+ * updates (e.g. ones during which there are hundreds of HTLCs pending on the commitment
+ * transaction), a single update may reach upwards of 1 MiB in serialized size.
+ */
 @SuppressWarnings("unchecked") // We correctly assign various generic arrays
 public class ChannelMonitorUpdate extends CommonBase {
        ChannelMonitorUpdate(Object _dummy, long ptr) { super(ptr); }
@@ -14,29 +26,82 @@ public class ChannelMonitorUpdate extends CommonBase {
                if (ptr != 0) { bindings.ChannelMonitorUpdate_free(ptr); }
        }
 
+       /**
+        * The sequence number of this update. Updates *must* be replayed in-order according to this
+        * sequence number (and updates may panic if they are not). The update_id values are strictly
+        * increasing and increase by one for each new update, with one exception specified below.
+        * 
+        * This sequence number is also used to track up to which points updates which returned
+        * [`ChannelMonitorUpdateStatus::InProgress`] have been applied to all copies of a given
+        * ChannelMonitor when ChannelManager::channel_monitor_updated is called.
+        * 
+        * The only instance where update_id values are not strictly increasing is the case where we
+        * allow post-force-close updates with a special update ID of [`CLOSED_CHANNEL_UPDATE_ID`]. See
+        * its docs for more details.
+        * 
+        * [`ChannelMonitorUpdateStatus::InProgress`]: super::ChannelMonitorUpdateStatus::InProgress
+        */
        public long get_update_id() {
                long ret = bindings.ChannelMonitorUpdate_get_update_id(this.ptr);
+               Reference.reachabilityFence(this);
                return ret;
        }
 
+       /**
+        * The sequence number of this update. Updates *must* be replayed in-order according to this
+        * sequence number (and updates may panic if they are not). The update_id values are strictly
+        * increasing and increase by one for each new update, with one exception specified below.
+        * 
+        * This sequence number is also used to track up to which points updates which returned
+        * [`ChannelMonitorUpdateStatus::InProgress`] have been applied to all copies of a given
+        * ChannelMonitor when ChannelManager::channel_monitor_updated is called.
+        * 
+        * The only instance where update_id values are not strictly increasing is the case where we
+        * allow post-force-close updates with a special update ID of [`CLOSED_CHANNEL_UPDATE_ID`]. See
+        * its docs for more details.
+        * 
+        * [`ChannelMonitorUpdateStatus::InProgress`]: super::ChannelMonitorUpdateStatus::InProgress
+        */
        public void set_update_id(long val) {
                bindings.ChannelMonitorUpdate_set_update_id(this.ptr, val);
+               Reference.reachabilityFence(this);
+               Reference.reachabilityFence(val);
+       }
+
+       long clone_ptr() {
+               long ret = bindings.ChannelMonitorUpdate_clone_ptr(this.ptr);
+               Reference.reachabilityFence(this);
+               return ret;
        }
 
+       /**
+        * Creates a copy of the ChannelMonitorUpdate
+        */
        public ChannelMonitorUpdate clone() {
                long ret = bindings.ChannelMonitorUpdate_clone(this.ptr);
-               ChannelMonitorUpdate ret_hu_conv = new ChannelMonitorUpdate(null, ret);
-               ret_hu_conv.ptrs_to.add(this);
+               Reference.reachabilityFence(this);
+               if (ret >= 0 && ret <= 4096) { return null; }
+               org.ldk.structs.ChannelMonitorUpdate ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new org.ldk.structs.ChannelMonitorUpdate(null, ret); }
+               if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(this); };
                return ret_hu_conv;
        }
 
+       /**
+        * Serialize the ChannelMonitorUpdate object into a byte array which can be read by ChannelMonitorUpdate_read
+        */
        public byte[] write() {
                byte[] ret = bindings.ChannelMonitorUpdate_write(this.ptr);
+               Reference.reachabilityFence(this);
                return ret;
        }
 
-       public static Result_ChannelMonitorUpdateDecodeErrorZ constructor_read(byte[] ser) {
+       /**
+        * Read a ChannelMonitorUpdate from a byte array, created by ChannelMonitorUpdate_write
+        */
+       public static Result_ChannelMonitorUpdateDecodeErrorZ read(byte[] ser) {
                long ret = bindings.ChannelMonitorUpdate_read(ser);
+               Reference.reachabilityFence(ser);
+               if (ret >= 0 && ret <= 4096) { return null; }
                Result_ChannelMonitorUpdateDecodeErrorZ ret_hu_conv = Result_ChannelMonitorUpdateDecodeErrorZ.constr_from_ptr(ret);
                return ret_hu_conv;
        }