[Java] Update batteries and tests to LDK 0.0.117

[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 8d311b29be3fc644912b971a8057d795d1f983e0..05913a2f797d130989fc58a415ec5c6fa64bae16 100644 (file)
--- a/src/main/java/org/ldk/structs/ChannelMonitorUpdate.java
+++ b/src/main/java/org/ldk/structs/ChannelMonitorUpdate.java
@@ -9,8 +9,13 @@ import javax.annotation.Nullable;
 
 
 /**
- * An update generated by the underlying Channel itself which contains some new information the
- * ChannelMonitor should be made aware of.
+ * 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 {
@@ -24,15 +29,19 @@ public class ChannelMonitorUpdate extends CommonBase {
        /**
         * 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.
+        * increasing and increase by one for each new update, with two exceptions specified below.
         * 
         * This sequence number is also used to track up to which points updates which returned
-        * ChannelMonitorUpdateErr::TemporaryFailure have been applied to all copies of a given
+        * [`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.
+        * The only instances we allow where update_id values are not strictly increasing have a
+        * special update ID of [`CLOSED_CHANNEL_UPDATE_ID`]. This update ID is used for updates that
+        * will force close the channel by broadcasting the latest commitment transaction or
+        * special post-force-close updates, like providing preimages necessary to claim outputs on the
+        * broadcast commitment transaction. 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);
@@ -43,15 +52,19 @@ public class ChannelMonitorUpdate extends CommonBase {
        /**
         * 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.
+        * increasing and increase by one for each new update, with two exceptions specified below.
         * 
         * This sequence number is also used to track up to which points updates which returned
-        * ChannelMonitorUpdateErr::TemporaryFailure have been applied to all copies of a given
+        * [`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.
+        * The only instances we allow where update_id values are not strictly increasing have a
+        * special update ID of [`CLOSED_CHANNEL_UPDATE_ID`]. This update ID is used for updates that
+        * will force close the channel by broadcasting the latest commitment transaction or
+        * special post-force-close updates, like providing preimages necessary to claim outputs on the
+        * broadcast commitment transaction. 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);
@@ -77,6 +90,23 @@ public class ChannelMonitorUpdate extends CommonBase {
                return ret_hu_conv;
        }
 
+       /**
+        * Checks if two ChannelMonitorUpdates contain equal inner contents.
+        * This ignores pointers and is_owned flags and looks at the values in fields.
+        * Two objects with NULL inner values will be considered "equal" here.
+        */
+       public boolean eq(org.ldk.structs.ChannelMonitorUpdate b) {
+               boolean ret = bindings.ChannelMonitorUpdate_eq(this.ptr, b == null ? 0 : b.ptr);
+               Reference.reachabilityFence(this);
+               Reference.reachabilityFence(b);
+               if (this != null) { this.ptrs_to.add(b); };
+               return ret;
+       }
+
+       @Override public boolean equals(Object o) {
+               if (!(o instanceof ChannelMonitorUpdate)) return false;
+               return this.eq((ChannelMonitorUpdate)o);
+       }
        /**
         * Serialize the ChannelMonitorUpdate object into a byte array which can be read by ChannelMonitorUpdate_read
         */