X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=blobdiff_plain;f=src%2Fmain%2Fjava%2Forg%2Fldk%2Fstructs%2FHolderCommitmentTransaction.java;h=455c1ed2f9928248d251054cc615593b9580a448;hb=17113550a5fefab21f39f27fbfe02646b8db53ae;hp=eb8dbe0c6a547d4d9f302916e4075c0ded30a9e2;hpb=aa0e2aade37133339f4113a0cd7465b111f0a0d0;p=ldk-java diff --git a/src/main/java/org/ldk/structs/HolderCommitmentTransaction.java b/src/main/java/org/ldk/structs/HolderCommitmentTransaction.java index eb8dbe0c..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,71 +20,64 @@ public class HolderCommitmentTransaction extends CommonBase { if (ptr != 0) { bindings.HolderCommitmentTransaction_free(ptr); } } - public static HolderCommitmentTransaction constructor_clone(HolderCommitmentTransaction orig) { - long ret = bindings.HolderCommitmentTransaction_clone(orig == null ? 0 : orig.ptr & ~1); - HolderCommitmentTransaction ret_hu_conv = new HolderCommitmentTransaction(null, ret); - ret_hu_conv.ptrs_to.add(orig); - return ret_hu_conv; - } - - // Skipped HolderCommitmentTransaction_get_unsigned_tx - // Skipped HolderCommitmentTransaction_set_unsigned_tx + /** + * 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); } - public int get_feerate_per_kw() { - int ret = bindings.HolderCommitmentTransaction_get_feerate_per_kw(this.ptr); - return ret; + /** + * 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); } - public void set_feerate_per_kw(int val) { - bindings.HolderCommitmentTransaction_set_feerate_per_kw(this.ptr, val); - } - - public void set_per_htlc(TwoTuple[] val) { - bindings.HolderCommitmentTransaction_set_per_htlc(this.ptr, Arrays.stream(val).mapToLong(arr_conv_42 -> bindings.C2Tuple_HTLCOutputInCommitmentSignatureZ_new(arr_conv_42.a == null ? 0 : arr_conv_42.a.ptr & ~1/*XXX: this.ptrs_to.add(arr_conv_42_a)*/, arr_conv_42.b)).toArray()); - /* TODO 2 TwoTuple */; - } - - // Skipped HolderCommitmentTransaction_new_missing_holder_sig - public TxCreationKeys trust_key_derivation() { - long ret = bindings.HolderCommitmentTransaction_trust_key_derivation(this.ptr); - TxCreationKeys ret_hu_conv = new TxCreationKeys(null, ret); + /** + * Creates a copy of the HolderCommitmentTransaction + */ + public HolderCommitmentTransaction clone() { + long ret = bindings.HolderCommitmentTransaction_clone(this.ptr); + HolderCommitmentTransaction ret_hu_conv = new HolderCommitmentTransaction(null, ret); + ret_hu_conv.ptrs_to.add(this); return ret_hu_conv; } - public byte[] txid() { - byte[] ret = bindings.HolderCommitmentTransaction_txid(this.ptr); + /** + * 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; } - public byte[] get_holder_sig(byte[] funding_key, byte[] funding_redeemscript, long channel_value_satoshis) { - byte[] ret = bindings.HolderCommitmentTransaction_get_holder_sig(this.ptr, funding_key, funding_redeemscript, channel_value_satoshis); - return ret; - } - - public Result_CVec_SignatureZNoneZ get_htlc_sigs(byte[] htlc_base_key, short counterparty_selected_contest_delay) { - long ret = bindings.HolderCommitmentTransaction_get_htlc_sigs(this.ptr, htlc_base_key, counterparty_selected_contest_delay); - Result_CVec_SignatureZNoneZ ret_hu_conv = Result_CVec_SignatureZNoneZ.constr_from_ptr(ret); - ret_hu_conv.ptrs_to.add(this); + /** + * 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; } - public byte[] write(HolderCommitmentTransaction obj) { - byte[] ret = bindings.HolderCommitmentTransaction_write(obj == null ? 0 : obj.ptr & ~1); - this.ptrs_to.add(obj); - return ret; - } - - public static HolderCommitmentTransaction constructor_read(byte[] ser) { - long ret = bindings.HolderCommitmentTransaction_read(ser); + /** + * 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); + ret_hu_conv.ptrs_to.add(ret_hu_conv); + ret_hu_conv.ptrs_to.add(commitment_tx); return ret_hu_conv; }