X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=blobdiff_plain;ds=sidebyside;f=src%2Fmain%2Fjava%2Forg%2Fldk%2Fstructs%2FDataLossProtect.java;h=3c625d07c7054bec59ae351df118c9908c2fa365;hb=b9716bc7ee492882e4643c9365971fef3761989f;hp=63db5eef41e4c627b6438f7d2efca0dfecd1ba6e;hpb=fed2245c60159f6c074c9ed5c0f3ce273ad9841b;p=ldk-java

diff --git a/src/main/java/org/ldk/structs/DataLossProtect.java b/src/main/java/org/ldk/structs/DataLossProtect.java
index 63db5eef..3c625d07 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,36 +22,58 @@ public class DataLossProtect extends CommonBase {
 		if (ptr != 0) { bindings.DataLossProtect_free(ptr); }
 	}
 
-	public DataLossProtect clone() {
-		long ret = bindings.DataLossProtect_clone(this.ptr);
-		DataLossProtect ret_hu_conv = new DataLossProtect(null, ret);
-		ret_hu_conv.ptrs_to.add(this);
-		return ret_hu_conv;
-	}
-
+	/**
+	 * 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);
+		if (ret < 1024) { return null; }
 		DataLossProtect 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);
+		if (ret < 1024) { return null; }
+		DataLossProtect ret_hu_conv = new DataLossProtect(null, ret);
+		ret_hu_conv.ptrs_to.add(this);
+		return ret_hu_conv;
+	}
+
 }