Update java bindings with new generator and new upstream code
[ldk-java] / src / main / java / org / ldk / structs / DataLossProtect.java
index 4d0e79d4921dfa4bc9e495186cf4fa6132633046..17d56110628546872c8f043764f2b37cfff44f95 100644 (file)
@@ -5,6 +5,13 @@ import org.ldk.enums.*;
 import org.ldk.util.*;
 import java.util.Arrays;
 
+
+/**
+ * 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,24 +21,41 @@ 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);
        }
 
+       /**
+        * Constructs a new DataLossProtect given each field
+        */
        public static DataLossProtect constructor_new(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);
@@ -39,6 +63,9 @@ public class DataLossProtect extends CommonBase {
                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);