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

diff --git a/src/main/java/org/ldk/structs/HolderCommitmentTransaction.java b/src/main/java/org/ldk/structs/HolderCommitmentTransaction.java
index 2ca98f51..455c1ed2 100644
--- a/src/main/java/org/ldk/structs/HolderCommitmentTransaction.java
+++ b/src/main/java/org/ldk/structs/HolderCommitmentTransaction.java
@@ -5,6 +5,12 @@ import org.ldk.enums.*;
 import org.ldk.util.*;
 import java.util.Arrays;
 
+
+/**
+ * Information needed to build and sign a holder's commitment transaction.
+ * 
+ * The transaction is only signed once we are ready to broadcast.
+ */
 @SuppressWarnings("unchecked") // We correctly assign various generic arrays
 public class HolderCommitmentTransaction extends CommonBase {
 	HolderCommitmentTransaction(Object _dummy, long ptr) { super(ptr); }
@@ -14,19 +20,31 @@ public class HolderCommitmentTransaction extends CommonBase {
 		if (ptr != 0) { bindings.HolderCommitmentTransaction_free(ptr); }
 	}
 
+	/**
+	 * Our counterparty's signature for the transaction
+	 */
 	public byte[] get_counterparty_sig() {
 		byte[] ret = bindings.HolderCommitmentTransaction_get_counterparty_sig(this.ptr);
 		return ret;
 	}
 
+	/**
+	 * Our counterparty's signature for the transaction
+	 */
 	public void set_counterparty_sig(byte[] val) {
 		bindings.HolderCommitmentTransaction_set_counterparty_sig(this.ptr, val);
 	}
 
+	/**
+	 * All non-dust counterparty HTLC signatures, in the order they appear in the transaction
+	 */
 	public void set_counterparty_htlc_sigs(byte[][] val) {
 		bindings.HolderCommitmentTransaction_set_counterparty_htlc_sigs(this.ptr, val);
 	}
 
+	/**
+	 * Creates a copy of the HolderCommitmentTransaction
+	 */
 	public HolderCommitmentTransaction clone() {
 		long ret = bindings.HolderCommitmentTransaction_clone(this.ptr);
 		HolderCommitmentTransaction ret_hu_conv = new HolderCommitmentTransaction(null, ret);
@@ -34,17 +52,27 @@ public class HolderCommitmentTransaction extends CommonBase {
 		return ret_hu_conv;
 	}
 
+	/**
+	 * Serialize the HolderCommitmentTransaction object into a byte array which can be read by HolderCommitmentTransaction_read
+	 */
 	public byte[] write() {
 		byte[] ret = bindings.HolderCommitmentTransaction_write(this.ptr);
 		return ret;
 	}
 
+	/**
+	 * Read a HolderCommitmentTransaction from a byte array, created by HolderCommitmentTransaction_write
+	 */
 	public static Result_HolderCommitmentTransactionDecodeErrorZ constructor_read(byte[] ser) {
 		long ret = bindings.HolderCommitmentTransaction_read(ser);
 		Result_HolderCommitmentTransactionDecodeErrorZ ret_hu_conv = Result_HolderCommitmentTransactionDecodeErrorZ.constr_from_ptr(ret);
 		return ret_hu_conv;
 	}
 
+	/**
+	 * Create a new holder transaction with the given counterparty signatures.
+	 * The funding keys are used to figure out which signature should go first when building the transaction for broadcast.
+	 */
 	public static HolderCommitmentTransaction constructor_new(CommitmentTransaction commitment_tx, byte[] counterparty_sig, byte[][] counterparty_htlc_sigs, byte[] holder_funding_key, byte[] counterparty_funding_key) {
 		long ret = bindings.HolderCommitmentTransaction_new(commitment_tx == null ? 0 : commitment_tx.ptr & ~1, counterparty_sig, counterparty_htlc_sigs, holder_funding_key, counterparty_funding_key);
 		HolderCommitmentTransaction ret_hu_conv = new HolderCommitmentTransaction(null, ret);