X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=blobdiff_plain;f=src%2Fmain%2Fjava%2Forg%2Fldk%2Fstructs%2FHTLCOutputInCommitment.java;h=52dd0caef08b820c635e7a0cd7e881518052f37a;hb=c3ae2d6897e5a809459c8d9a72a4b3aa0052c8c8;hp=9cf880099a143d7a78c390bea5d5d74753cce21d;hpb=ad15b3a4dbf3fbc7f08ef22d656bae79e8182008;p=ldk-java

diff --git a/src/main/java/org/ldk/structs/HTLCOutputInCommitment.java b/src/main/java/org/ldk/structs/HTLCOutputInCommitment.java
index 9cf88009..52dd0cae 100644
--- a/src/main/java/org/ldk/structs/HTLCOutputInCommitment.java
+++ b/src/main/java/org/ldk/structs/HTLCOutputInCommitment.java
@@ -2,67 +2,146 @@ package org.ldk.structs;
 
 import org.ldk.impl.bindings;
 import org.ldk.enums.*;
+import org.ldk.util.*;
+import java.util.Arrays;
 
+
+/**
+ * Information about an HTLC as it appears in a commitment transaction
+ */
+@SuppressWarnings("unchecked") // We correctly assign various generic arrays
 public class HTLCOutputInCommitment extends CommonBase {
 	HTLCOutputInCommitment(Object _dummy, long ptr) { super(ptr); }
 	@Override @SuppressWarnings("deprecation")
 	protected void finalize() throws Throwable {
 		super.finalize();
-		bindings.HTLCOutputInCommitment_free(ptr);
+		if (ptr != 0) { bindings.HTLCOutputInCommitment_free(ptr); }
+	}
+
+	/**
+	 * Whether the HTLC was \"offered\" (ie outbound in relation to this commitment transaction).
+	 * Note that this is not the same as whether it is ountbound *from us*. To determine that you
+	 * need to compare this value to whether the commitment transaction in question is that of
+	 * the counterparty or our own.
+	 */
+	public boolean get_offered() {
+		boolean ret = bindings.HTLCOutputInCommitment_get_offered(this.ptr);
+		return ret;
 	}
 
-	public HTLCOutputInCommitment(HTLCOutputInCommitment orig) {
-		super(bindings.HTLCOutputInCommitment_clone(orig == null ? 0 : orig.ptr & ~1));
-		this.ptrs_to.add(orig);
+	/**
+	 * Whether the HTLC was \"offered\" (ie outbound in relation to this commitment transaction).
+	 * Note that this is not the same as whether it is ountbound *from us*. To determine that you
+	 * need to compare this value to whether the commitment transaction in question is that of
+	 * the counterparty or our own.
+	 */
+	public void set_offered(boolean val) {
+		bindings.HTLCOutputInCommitment_set_offered(this.ptr, val);
 	}
 
-	public boolean get_offered(HTLCOutputInCommitment this_ptr) {
-		boolean ret = bindings.HTLCOutputInCommitment_get_offered(this_ptr == null ? 0 : this_ptr.ptr & ~1);
-		this.ptrs_to.add(this_ptr);
+	/**
+	 * The value, in msat, of the HTLC. The value as it appears in the commitment transaction is
+	 * this divided by 1000.
+	 */
+	public long get_amount_msat() {
+		long ret = bindings.HTLCOutputInCommitment_get_amount_msat(this.ptr);
 		return ret;
 	}
 
-	public void set_offered(HTLCOutputInCommitment this_ptr, boolean val) {
-		bindings.HTLCOutputInCommitment_set_offered(this_ptr == null ? 0 : this_ptr.ptr & ~1, val);
-		this.ptrs_to.add(this_ptr);
+	/**
+	 * The value, in msat, of the HTLC. The value as it appears in the commitment transaction is
+	 * this divided by 1000.
+	 */
+	public void set_amount_msat(long val) {
+		bindings.HTLCOutputInCommitment_set_amount_msat(this.ptr, val);
 	}
 
-	public long get_amount_msat(HTLCOutputInCommitment this_ptr) {
-		long ret = bindings.HTLCOutputInCommitment_get_amount_msat(this_ptr == null ? 0 : this_ptr.ptr & ~1);
-		this.ptrs_to.add(this_ptr);
+	/**
+	 * The CLTV lock-time at which this HTLC expires.
+	 */
+	public int get_cltv_expiry() {
+		int ret = bindings.HTLCOutputInCommitment_get_cltv_expiry(this.ptr);
 		return ret;
 	}
 
-	public void set_amount_msat(HTLCOutputInCommitment this_ptr, long val) {
-		bindings.HTLCOutputInCommitment_set_amount_msat(this_ptr == null ? 0 : this_ptr.ptr & ~1, val);
-		this.ptrs_to.add(this_ptr);
+	/**
+	 * The CLTV lock-time at which this HTLC expires.
+	 */
+	public void set_cltv_expiry(int val) {
+		bindings.HTLCOutputInCommitment_set_cltv_expiry(this.ptr, val);
 	}
 
-	public int get_cltv_expiry(HTLCOutputInCommitment this_ptr) {
-		int ret = bindings.HTLCOutputInCommitment_get_cltv_expiry(this_ptr == null ? 0 : this_ptr.ptr & ~1);
-		this.ptrs_to.add(this_ptr);
+	/**
+	 * The hash of the preimage which unlocks this HTLC.
+	 */
+	public byte[] get_payment_hash() {
+		byte[] ret = bindings.HTLCOutputInCommitment_get_payment_hash(this.ptr);
 		return ret;
 	}
 
-	public void set_cltv_expiry(HTLCOutputInCommitment this_ptr, int val) {
-		bindings.HTLCOutputInCommitment_set_cltv_expiry(this_ptr == null ? 0 : this_ptr.ptr & ~1, val);
-		this.ptrs_to.add(this_ptr);
+	/**
+	 * The hash of the preimage which unlocks this HTLC.
+	 */
+	public void set_payment_hash(byte[] val) {
+		bindings.HTLCOutputInCommitment_set_payment_hash(this.ptr, val);
 	}
 
-	public byte[] get_payment_hash(HTLCOutputInCommitment this_ptr) {
-		byte[] ret = bindings.HTLCOutputInCommitment_get_payment_hash(this_ptr == null ? 0 : this_ptr.ptr & ~1);
-		this.ptrs_to.add(this_ptr);
-		return ret;
+	/**
+	 * The position within the commitment transactions' outputs. This may be None if the value is
+	 * below the dust limit (in which case no output appears in the commitment transaction and the
+	 * value is spent to additional transaction fees).
+	 */
+	public Option_u32Z get_transaction_output_index() {
+		long ret = bindings.HTLCOutputInCommitment_get_transaction_output_index(this.ptr);
+		Option_u32Z ret_hu_conv = Option_u32Z.constr_from_ptr(ret);
+		ret_hu_conv.ptrs_to.add(this);
+		return ret_hu_conv;
+	}
+
+	/**
+	 * The position within the commitment transactions' outputs. This may be None if the value is
+	 * below the dust limit (in which case no output appears in the commitment transaction and the
+	 * value is spent to additional transaction fees).
+	 */
+	public void set_transaction_output_index(Option_u32Z val) {
+		bindings.HTLCOutputInCommitment_set_transaction_output_index(this.ptr, val.ptr);
+	}
+
+	/**
+	 * Constructs a new HTLCOutputInCommitment given each field
+	 */
+	public static HTLCOutputInCommitment constructor_new(boolean offered_arg, long amount_msat_arg, int cltv_expiry_arg, byte[] payment_hash_arg, Option_u32Z transaction_output_index_arg) {
+		long ret = bindings.HTLCOutputInCommitment_new(offered_arg, amount_msat_arg, cltv_expiry_arg, payment_hash_arg, transaction_output_index_arg.ptr);
+		HTLCOutputInCommitment ret_hu_conv = new HTLCOutputInCommitment(null, ret);
+		ret_hu_conv.ptrs_to.add(ret_hu_conv);
+		return ret_hu_conv;
 	}
 
-	public void set_payment_hash(HTLCOutputInCommitment this_ptr, byte[] val) {
-		bindings.HTLCOutputInCommitment_set_payment_hash(this_ptr == null ? 0 : this_ptr.ptr & ~1, val);
-		this.ptrs_to.add(this_ptr);
+	/**
+	 * Creates a copy of the HTLCOutputInCommitment
+	 */
+	public HTLCOutputInCommitment clone() {
+		long ret = bindings.HTLCOutputInCommitment_clone(this.ptr);
+		HTLCOutputInCommitment ret_hu_conv = new HTLCOutputInCommitment(null, ret);
+		ret_hu_conv.ptrs_to.add(this);
+		return ret_hu_conv;
+	}
+
+	/**
+	 * Serialize the HTLCOutputInCommitment object into a byte array which can be read by HTLCOutputInCommitment_read
+	 */
+	public byte[] write() {
+		byte[] ret = bindings.HTLCOutputInCommitment_write(this.ptr);
+		return ret;
 	}
 
-	// Skipped HTLCOutputInCommitment_write
-	public HTLCOutputInCommitment(byte[] ser) {
-		super(bindings.HTLCOutputInCommitment_read(ser));
+	/**
+	 * Read a HTLCOutputInCommitment from a byte array, created by HTLCOutputInCommitment_write
+	 */
+	public static Result_HTLCOutputInCommitmentDecodeErrorZ constructor_read(byte[] ser) {
+		long ret = bindings.HTLCOutputInCommitment_read(ser);
+		Result_HTLCOutputInCommitmentDecodeErrorZ ret_hu_conv = Result_HTLCOutputInCommitmentDecodeErrorZ.constr_from_ptr(ret);
+		return ret_hu_conv;
 	}
 
 }