X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=blobdiff_plain;f=src%2Fmain%2Fjava%2Forg%2Fldk%2Fstructs%2FCommitmentSigned.java;fp=src%2Fmain%2Fjava%2Forg%2Fldk%2Fstructs%2FCommitmentSigned.java;h=35100476bd2f7112cb7042c92a1222fed73cfb8e;hb=1b870a3ffab1c0024411e30102bc6d198300f095;hp=b14e1ca416d28204e5dfd9ba858120bc07850ff0;hpb=246459dcbc3be28c38b4951140a5933f4b3aa024;p=ldk-java

diff --git a/src/main/java/org/ldk/structs/CommitmentSigned.java b/src/main/java/org/ldk/structs/CommitmentSigned.java
index b14e1ca4..35100476 100644
--- a/src/main/java/org/ldk/structs/CommitmentSigned.java
+++ b/src/main/java/org/ldk/structs/CommitmentSigned.java
@@ -5,6 +5,10 @@ import org.ldk.enums.*;
 import org.ldk.util.*;
 import java.util.Arrays;
 
+
+/**
+ * A commitment_signed message to be sent or received from a peer
+ */
 @SuppressWarnings("unchecked") // We correctly assign various generic arrays
 public class CommitmentSigned extends CommonBase {
 	CommitmentSigned(Object _dummy, long ptr) { super(ptr); }
@@ -14,28 +18,46 @@ public class CommitmentSigned extends CommonBase {
 		if (ptr != 0) { bindings.CommitmentSigned_free(ptr); }
 	}
 
+	/**
+	 * The channel ID
+	 */
 	public byte[] get_channel_id() {
 		byte[] ret = bindings.CommitmentSigned_get_channel_id(this.ptr);
 		return ret;
 	}
 
+	/**
+	 * The channel ID
+	 */
 	public void set_channel_id(byte[] val) {
 		bindings.CommitmentSigned_set_channel_id(this.ptr, val);
 	}
 
+	/**
+	 * A signature on the commitment transaction
+	 */
 	public byte[] get_signature() {
 		byte[] ret = bindings.CommitmentSigned_get_signature(this.ptr);
 		return ret;
 	}
 
+	/**
+	 * A signature on the commitment transaction
+	 */
 	public void set_signature(byte[] val) {
 		bindings.CommitmentSigned_set_signature(this.ptr, val);
 	}
 
+	/**
+	 * Signatures on the HTLC transactions
+	 */
 	public void set_htlc_signatures(byte[][] val) {
 		bindings.CommitmentSigned_set_htlc_signatures(this.ptr, val);
 	}
 
+	/**
+	 * Constructs a new CommitmentSigned given each field
+	 */
 	public static CommitmentSigned constructor_new(byte[] channel_id_arg, byte[] signature_arg, byte[][] htlc_signatures_arg) {
 		long ret = bindings.CommitmentSigned_new(channel_id_arg, signature_arg, htlc_signatures_arg);
 		CommitmentSigned ret_hu_conv = new CommitmentSigned(null, ret);
@@ -43,6 +65,9 @@ public class CommitmentSigned extends CommonBase {
 		return ret_hu_conv;
 	}
 
+	/**
+	 * Creates a copy of the CommitmentSigned
+	 */
 	public CommitmentSigned clone() {
 		long ret = bindings.CommitmentSigned_clone(this.ptr);
 		CommitmentSigned ret_hu_conv = new CommitmentSigned(null, ret);
@@ -50,11 +75,17 @@ public class CommitmentSigned extends CommonBase {
 		return ret_hu_conv;
 	}
 
+	/**
+	 * Serialize the CommitmentSigned object into a byte array which can be read by CommitmentSigned_read
+	 */
 	public byte[] write() {
 		byte[] ret = bindings.CommitmentSigned_write(this.ptr);
 		return ret;
 	}
 
+	/**
+	 * Read a CommitmentSigned from a byte array, created by CommitmentSigned_write
+	 */
 	public static Result_CommitmentSignedDecodeErrorZ constructor_read(byte[] ser) {
 		long ret = bindings.CommitmentSigned_read(ser);
 		Result_CommitmentSignedDecodeErrorZ ret_hu_conv = Result_CommitmentSignedDecodeErrorZ.constr_from_ptr(ret);