X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=blobdiff_plain;f=src%2Fmain%2Fjava%2Forg%2Fldk%2Fstructs%2FHTLCUpdate.java;h=96789c0a81fc95b653bb09802340fc073ee484d2;hb=1854b5cebef22ace9e9e4dd191f609818df9ce08;hp=f860f5dd8d464efbb8c23af4ee182f3a0d4d12ae;hpb=fed2245c60159f6c074c9ed5c0f3ce273ad9841b;p=ldk-java

diff --git a/src/main/java/org/ldk/structs/HTLCUpdate.java b/src/main/java/org/ldk/structs/HTLCUpdate.java
index f860f5dd..96789c0a 100644
--- a/src/main/java/org/ldk/structs/HTLCUpdate.java
+++ b/src/main/java/org/ldk/structs/HTLCUpdate.java
@@ -4,7 +4,15 @@ 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;
 
+
+/**
+ * Simple structure sent back by `chain::Watch` when an HTLC from a forward channel is detected on
+ * chain. Used to update the corresponding HTLC in the backward channel. Failing to pass the
+ * preimage claim backward will lead to loss of funds.
+ */
 @SuppressWarnings("unchecked") // We correctly assign various generic arrays
 public class HTLCUpdate extends CommonBase {
 	HTLCUpdate(Object _dummy, long ptr) { super(ptr); }
@@ -14,22 +22,41 @@ public class HTLCUpdate extends CommonBase {
 		if (ptr != 0) { bindings.HTLCUpdate_free(ptr); }
 	}
 
+	long clone_ptr() {
+		long ret = bindings.HTLCUpdate_clone_ptr(this.ptr);
+		Reference.reachabilityFence(this);
+		return ret;
+	}
+
+	/**
+	 * Creates a copy of the HTLCUpdate
+	 */
 	public HTLCUpdate clone() {
 		long ret = bindings.HTLCUpdate_clone(this.ptr);
-		HTLCUpdate ret_hu_conv = new HTLCUpdate(null, ret);
+		Reference.reachabilityFence(this);
+		if (ret >= 0 && ret <= 4096) { return null; }
+		HTLCUpdate ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new HTLCUpdate(null, ret); }
 		ret_hu_conv.ptrs_to.add(this);
 		return ret_hu_conv;
 	}
 
+	/**
+	 * Serialize the HTLCUpdate object into a byte array which can be read by HTLCUpdate_read
+	 */
 	public byte[] write() {
 		byte[] ret = bindings.HTLCUpdate_write(this.ptr);
+		Reference.reachabilityFence(this);
 		return ret;
 	}
 
-	public static HTLCUpdate constructor_read(byte[] ser) {
+	/**
+	 * Read a HTLCUpdate from a byte array, created by HTLCUpdate_write
+	 */
+	public static Result_HTLCUpdateDecodeErrorZ read(byte[] ser) {
 		long ret = bindings.HTLCUpdate_read(ser);
-		HTLCUpdate ret_hu_conv = new HTLCUpdate(null, ret);
-		ret_hu_conv.ptrs_to.add(ret_hu_conv);
+		Reference.reachabilityFence(ser);
+		if (ret >= 0 && ret <= 4096) { return null; }
+		Result_HTLCUpdateDecodeErrorZ ret_hu_conv = Result_HTLCUpdateDecodeErrorZ.constr_from_ptr(ret);
 		return ret_hu_conv;
 	}