X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=blobdiff_plain;f=src%2Fmain%2Fjava%2Forg%2Fldk%2Fstructs%2FChannelMonitorUpdate.java;h=cbf5769feaf658677d3ea2d743f1a5701d94351f;hb=300b54d26fe5ed89f472ef821ebf67d56c917e49;hp=15542a97eec783a8e352effa842231fefc5a76ab;hpb=3d559f3266fde7c6a21248c10d9a7145125b5e69;p=ldk-java

diff --git a/src/main/java/org/ldk/structs/ChannelMonitorUpdate.java b/src/main/java/org/ldk/structs/ChannelMonitorUpdate.java
index 15542a97..cbf5769f 100644
--- a/src/main/java/org/ldk/structs/ChannelMonitorUpdate.java
+++ b/src/main/java/org/ldk/structs/ChannelMonitorUpdate.java
@@ -2,30 +2,108 @@ package org.ldk.structs;
 
 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); }
 	@Override @SuppressWarnings("deprecation")
 	protected void finalize() throws Throwable {
-		bindings.ChannelMonitorUpdate_free(ptr); super.finalize();
+		super.finalize();
+		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;
 	}
 
-	public ChannelMonitorUpdate(ChannelMonitorUpdate orig) {
-		super(bindings.ChannelMonitorUpdate_clone(orig.ptr & ~1));
-		this.ptrs_to.add(orig);
+	/**
+	 * Creates a copy of the ChannelMonitorUpdate
+	 */
+	public ChannelMonitorUpdate clone() {
+		long ret = bindings.ChannelMonitorUpdate_clone(this.ptr);
+		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;
 	}
 
-	public long get_update_id(ChannelMonitorUpdate this_ptr) {
-		long ret = bindings.ChannelMonitorUpdate_get_update_id(this_ptr.ptr & ~1);
-		this.ptrs_to.add(this_ptr);
+	/**
+	 * 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 void set_update_id(ChannelMonitorUpdate this_ptr, long val) {
-		bindings.ChannelMonitorUpdate_set_update_id(this_ptr.ptr & ~1, val);
-		this.ptrs_to.add(this_ptr);
+	/**
+	 * 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;
 	}
 
-	// Skipped ChannelMonitorUpdate_write
-	// Skipped ChannelMonitorUpdate_read
 }