Merge pull request #119 from TheBlueMatt/main
[ldk-java] / src / main / java / org / ldk / structs / ChannelMonitorUpdate.java
index c221d1050aa482a480bafa567f35db6b08e3fb68..876049c44a1d9f617b0408bc4317f641ba55da39 100644 (file)
@@ -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 {
@@ -72,8 +77,8 @@ public class ChannelMonitorUpdate extends CommonBase {
                long ret = bindings.ChannelMonitorUpdate_clone(this.ptr);
                Reference.reachabilityFence(this);
                if (ret >= 0 && ret <= 4096) { return null; }
-               ChannelMonitorUpdate ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new ChannelMonitorUpdate(null, ret); }
-               ret_hu_conv.ptrs_to.add(this);
+               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;
        }