X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=blobdiff_plain;f=src%2Fmain%2Fjava%2Forg%2Fldk%2Fstructs%2FDataLossProtect.java;h=70b3f3e16776fde4cebacaf82dab3759746b8f93;hb=c6bac88847b7c09560af81f00ba8dd3c2ebe3a19;hp=4d0e79d4921dfa4bc9e495186cf4fa6132633046;hpb=9e8763c71cd61d55be7c869d973524f75209a3f3;p=ldk-java

diff --git a/src/main/java/org/ldk/structs/DataLossProtect.java b/src/main/java/org/ldk/structs/DataLossProtect.java
index 4d0e79d4..70b3f3e1 100644
--- a/src/main/java/org/ldk/structs/DataLossProtect.java
+++ b/src/main/java/org/ldk/structs/DataLossProtect.java
@@ -4,7 +4,15 @@ import org.ldk.impl.bindings;
 import org.ldk.enums.*;
 import org.ldk.util.*;
 import java.util.Arrays;
+import javax.annotation.Nullable;
 
+
+/**
+ * Proof that the sender knows the per-commitment secret of the previous commitment transaction.
+ * This is used to convince the recipient that the channel is at a certain commitment
+ * number even if they lost that data due to a local failure.  Of course, the peer may lie
+ * and even later commitments may have been revoked.
+ */
 @SuppressWarnings("unchecked") // We correctly assign various generic arrays
 public class DataLossProtect extends CommonBase {
 	DataLossProtect(Object _dummy, long ptr) { super(ptr); }
@@ -14,34 +22,56 @@ public class DataLossProtect extends CommonBase {
 		if (ptr != 0) { bindings.DataLossProtect_free(ptr); }
 	}
 
+	/**
+	 * Proof that the sender knows the per-commitment secret of a specific commitment transaction
+	 * belonging to the recipient
+	 */
 	public byte[] get_your_last_per_commitment_secret() {
 		byte[] ret = bindings.DataLossProtect_get_your_last_per_commitment_secret(this.ptr);
 		return ret;
 	}
 
+	/**
+	 * Proof that the sender knows the per-commitment secret of a specific commitment transaction
+	 * belonging to the recipient
+	 */
 	public void set_your_last_per_commitment_secret(byte[] val) {
 		bindings.DataLossProtect_set_your_last_per_commitment_secret(this.ptr, val);
 	}
 
+	/**
+	 * The sender's per-commitment point for their current commitment transaction
+	 */
 	public byte[] get_my_current_per_commitment_point() {
 		byte[] ret = bindings.DataLossProtect_get_my_current_per_commitment_point(this.ptr);
 		return ret;
 	}
 
+	/**
+	 * The sender's per-commitment point for their current commitment transaction
+	 */
 	public void set_my_current_per_commitment_point(byte[] val) {
 		bindings.DataLossProtect_set_my_current_per_commitment_point(this.ptr, val);
 	}
 
-	public static DataLossProtect constructor_new(byte[] your_last_per_commitment_secret_arg, byte[] my_current_per_commitment_point_arg) {
+	/**
+	 * Constructs a new DataLossProtect given each field
+	 */
+	public static DataLossProtect of(byte[] your_last_per_commitment_secret_arg, byte[] my_current_per_commitment_point_arg) {
 		long ret = bindings.DataLossProtect_new(your_last_per_commitment_secret_arg, my_current_per_commitment_point_arg);
-		DataLossProtect ret_hu_conv = new DataLossProtect(null, ret);
+		if (ret >= 0 && ret <= 4096) { return null; }
+		DataLossProtect ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new DataLossProtect(null, ret); }
 		ret_hu_conv.ptrs_to.add(ret_hu_conv);
 		return ret_hu_conv;
 	}
 
+	/**
+	 * Creates a copy of the DataLossProtect
+	 */
 	public DataLossProtect clone() {
 		long ret = bindings.DataLossProtect_clone(this.ptr);
-		DataLossProtect ret_hu_conv = new DataLossProtect(null, ret);
+		if (ret >= 0 && ret <= 4096) { return null; }
+		DataLossProtect ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new DataLossProtect(null, ret); }
 		ret_hu_conv.ptrs_to.add(this);
 		return ret_hu_conv;
 	}