X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=blobdiff_plain;f=src%2Fmain%2Fjava%2Forg%2Fldk%2Fstructs%2FHTLCOutputInCommitment.java;h=55f2cb22660b110e45e1046c135075223d56e865;hb=c6bac88847b7c09560af81f00ba8dd3c2ebe3a19;hp=daa1c42d5d0499044cdda92f5db7d0c6cafebcb2;hpb=fed2245c60159f6c074c9ed5c0f3ce273ad9841b;p=ldk-java

diff --git a/src/main/java/org/ldk/structs/HTLCOutputInCommitment.java b/src/main/java/org/ldk/structs/HTLCOutputInCommitment.java
index daa1c42d..55f2cb22 100644
--- a/src/main/java/org/ldk/structs/HTLCOutputInCommitment.java
+++ b/src/main/java/org/ldk/structs/HTLCOutputInCommitment.java
@@ -4,7 +4,12 @@ import org.ldk.impl.bindings;
 import org.ldk.enums.*;
 import org.ldk.util.*;
 import java.util.Arrays;
+import javax.annotation.Nullable;
 
+
+/**
+ * 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); }
@@ -14,58 +19,133 @@ public class HTLCOutputInCommitment extends CommonBase {
 		if (ptr != 0) { bindings.HTLCOutputInCommitment_free(ptr); }
 	}
 
-	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;
-	}
-
+	/**
+	 * 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;
 	}
 
+	/**
+	 * 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);
 	}
 
+	/**
+	 * 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;
 	}
 
+	/**
+	 * 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);
 	}
 
+	/**
+	 * 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;
 	}
 
+	/**
+	 * The CLTV lock-time at which this HTLC expires.
+	 */
 	public void set_cltv_expiry(int val) {
 		bindings.HTLCOutputInCommitment_set_cltv_expiry(this.ptr, val);
 	}
 
+	/**
+	 * 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;
 	}
 
+	/**
+	 * The hash of the preimage which unlocks this HTLC.
+	 */
 	public void set_payment_hash(byte[] val) {
 		bindings.HTLCOutputInCommitment_set_payment_hash(this.ptr, val);
 	}
 
+	/**
+	 * 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);
+		if (ret >= 0 && ret <= 4096) { return null; }
+		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 of(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);
+		if (ret >= 0 && ret <= 4096) { return null; }
+		HTLCOutputInCommitment ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new HTLCOutputInCommitment(null, ret); }
+		ret_hu_conv.ptrs_to.add(ret_hu_conv);
+		return ret_hu_conv;
+	}
+
+	/**
+	 * Creates a copy of the HTLCOutputInCommitment
+	 */
+	public HTLCOutputInCommitment clone() {
+		long ret = bindings.HTLCOutputInCommitment_clone(this.ptr);
+		if (ret >= 0 && ret <= 4096) { return null; }
+		HTLCOutputInCommitment ret_hu_conv = null; if (ret < 0 || ret > 4096) { 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;
 	}
 
-	public static HTLCOutputInCommitment constructor_read(byte[] ser) {
+	/**
+	 * Read a HTLCOutputInCommitment from a byte array, created by HTLCOutputInCommitment_write
+	 */
+	public static Result_HTLCOutputInCommitmentDecodeErrorZ read(byte[] ser) {
 		long ret = bindings.HTLCOutputInCommitment_read(ser);
-		HTLCOutputInCommitment ret_hu_conv = new HTLCOutputInCommitment(null, ret);
-		ret_hu_conv.ptrs_to.add(ret_hu_conv);
+		if (ret >= 0 && ret <= 4096) { return null; }
+		Result_HTLCOutputInCommitmentDecodeErrorZ ret_hu_conv = Result_HTLCOutputInCommitmentDecodeErrorZ.constr_from_ptr(ret);
 		return ret_hu_conv;
 	}