X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=blobdiff_plain;f=src%2Fmain%2Fjava%2Forg%2Fldk%2Fstructs%2FCommitmentUpdate.java;h=e9e4b971bb716cb57e3c5680de69deacad8f9b97;hb=65a17b9ef4884736783566e30e075ca59b472cc7;hp=d6fdfa201655cd14e0ab1786b9c3d7f80ab3da16;hpb=9e8763c71cd61d55be7c869d973524f75209a3f3;p=ldk-java

diff --git a/src/main/java/org/ldk/structs/CommitmentUpdate.java b/src/main/java/org/ldk/structs/CommitmentUpdate.java
index d6fdfa20..e9e4b971 100644
--- a/src/main/java/org/ldk/structs/CommitmentUpdate.java
+++ b/src/main/java/org/ldk/structs/CommitmentUpdate.java
@@ -5,6 +5,11 @@ import org.ldk.enums.*;
 import org.ldk.util.*;
 import java.util.Arrays;
 
+
+/**
+ * Struct used to return values from revoke_and_ack messages, containing a bunch of commitment
+ * transaction updates if they were pending.
+ */
 @SuppressWarnings("unchecked") // We correctly assign various generic arrays
 public class CommitmentUpdate extends CommonBase {
 	CommitmentUpdate(Object _dummy, long ptr) { super(ptr); }
@@ -14,52 +19,87 @@ public class CommitmentUpdate extends CommonBase {
 		if (ptr != 0) { bindings.CommitmentUpdate_free(ptr); }
 	}
 
+	/**
+	 * update_add_htlc messages which should be sent
+	 */
 	public void set_update_add_htlcs(UpdateAddHTLC[] val) {
-		bindings.CommitmentUpdate_set_update_add_htlcs(this.ptr, Arrays.stream(val).mapToLong(arr_conv_15 -> arr_conv_15 == null ? 0 : arr_conv_15.ptr & ~1).toArray());
+		bindings.CommitmentUpdate_set_update_add_htlcs(this.ptr, Arrays.stream(val).mapToLong(val_conv_15 -> val_conv_15 == null ? 0 : val_conv_15.ptr & ~1).toArray());
 		/* TODO 2 UpdateAddHTLC  */;
 	}
 
+	/**
+	 * update_fulfill_htlc messages which should be sent
+	 */
 	public void set_update_fulfill_htlcs(UpdateFulfillHTLC[] val) {
-		bindings.CommitmentUpdate_set_update_fulfill_htlcs(this.ptr, Arrays.stream(val).mapToLong(arr_conv_19 -> arr_conv_19 == null ? 0 : arr_conv_19.ptr & ~1).toArray());
+		bindings.CommitmentUpdate_set_update_fulfill_htlcs(this.ptr, Arrays.stream(val).mapToLong(val_conv_19 -> val_conv_19 == null ? 0 : val_conv_19.ptr & ~1).toArray());
 		/* TODO 2 UpdateFulfillHTLC  */;
 	}
 
+	/**
+	 * update_fail_htlc messages which should be sent
+	 */
 	public void set_update_fail_htlcs(UpdateFailHTLC[] val) {
-		bindings.CommitmentUpdate_set_update_fail_htlcs(this.ptr, Arrays.stream(val).mapToLong(arr_conv_16 -> arr_conv_16 == null ? 0 : arr_conv_16.ptr & ~1).toArray());
+		bindings.CommitmentUpdate_set_update_fail_htlcs(this.ptr, Arrays.stream(val).mapToLong(val_conv_16 -> val_conv_16 == null ? 0 : val_conv_16.ptr & ~1).toArray());
 		/* TODO 2 UpdateFailHTLC  */;
 	}
 
+	/**
+	 * update_fail_malformed_htlc messages which should be sent
+	 */
 	public void set_update_fail_malformed_htlcs(UpdateFailMalformedHTLC[] val) {
-		bindings.CommitmentUpdate_set_update_fail_malformed_htlcs(this.ptr, Arrays.stream(val).mapToLong(arr_conv_25 -> arr_conv_25 == null ? 0 : arr_conv_25.ptr & ~1).toArray());
+		bindings.CommitmentUpdate_set_update_fail_malformed_htlcs(this.ptr, Arrays.stream(val).mapToLong(val_conv_25 -> val_conv_25 == null ? 0 : val_conv_25.ptr & ~1).toArray());
 		/* TODO 2 UpdateFailMalformedHTLC  */;
 	}
 
+	/**
+	 * An update_fee message which should be sent
+	 * 
+	 * Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
+	 */
+	@Nullable
 	public UpdateFee get_update_fee() {
 		long ret = bindings.CommitmentUpdate_get_update_fee(this.ptr);
+		if (ret < 1024) { return null; }
 		UpdateFee ret_hu_conv = new UpdateFee(null, ret);
 		ret_hu_conv.ptrs_to.add(this);
 		return ret_hu_conv;
 	}
 
-	public void set_update_fee(UpdateFee val) {
+	/**
+	 * An update_fee message which should be sent
+	 * 
+	 * Note that val (or a relevant inner pointer) may be NULL or all-0s to represent None
+	 */
+	public void set_update_fee(@Nullable UpdateFee val) {
 		bindings.CommitmentUpdate_set_update_fee(this.ptr, val == null ? 0 : val.ptr & ~1);
 		this.ptrs_to.add(val);
 	}
 
+	/**
+	 * Finally, the commitment_signed message which should be sent
+	 */
 	public CommitmentSigned get_commitment_signed() {
 		long ret = bindings.CommitmentUpdate_get_commitment_signed(this.ptr);
+		if (ret < 1024) { return null; }
 		CommitmentSigned ret_hu_conv = new CommitmentSigned(null, ret);
 		ret_hu_conv.ptrs_to.add(this);
 		return ret_hu_conv;
 	}
 
+	/**
+	 * Finally, the commitment_signed message which should be sent
+	 */
 	public void set_commitment_signed(CommitmentSigned val) {
 		bindings.CommitmentUpdate_set_commitment_signed(this.ptr, val == null ? 0 : val.ptr & ~1);
 		this.ptrs_to.add(val);
 	}
 
-	public static CommitmentUpdate constructor_new(UpdateAddHTLC[] update_add_htlcs_arg, UpdateFulfillHTLC[] update_fulfill_htlcs_arg, UpdateFailHTLC[] update_fail_htlcs_arg, UpdateFailMalformedHTLC[] update_fail_malformed_htlcs_arg, UpdateFee update_fee_arg, CommitmentSigned commitment_signed_arg) {
-		long ret = bindings.CommitmentUpdate_new(Arrays.stream(update_add_htlcs_arg).mapToLong(arr_conv_15 -> arr_conv_15 == null ? 0 : arr_conv_15.ptr & ~1).toArray(), Arrays.stream(update_fulfill_htlcs_arg).mapToLong(arr_conv_19 -> arr_conv_19 == null ? 0 : arr_conv_19.ptr & ~1).toArray(), Arrays.stream(update_fail_htlcs_arg).mapToLong(arr_conv_16 -> arr_conv_16 == null ? 0 : arr_conv_16.ptr & ~1).toArray(), Arrays.stream(update_fail_malformed_htlcs_arg).mapToLong(arr_conv_25 -> arr_conv_25 == null ? 0 : arr_conv_25.ptr & ~1).toArray(), update_fee_arg == null ? 0 : update_fee_arg.ptr & ~1, commitment_signed_arg == null ? 0 : commitment_signed_arg.ptr & ~1);
+	/**
+	 * Constructs a new CommitmentUpdate given each field
+	 */
+	public static CommitmentUpdate of(UpdateAddHTLC[] update_add_htlcs_arg, UpdateFulfillHTLC[] update_fulfill_htlcs_arg, UpdateFailHTLC[] update_fail_htlcs_arg, UpdateFailMalformedHTLC[] update_fail_malformed_htlcs_arg, UpdateFee update_fee_arg, CommitmentSigned commitment_signed_arg) {
+		long ret = bindings.CommitmentUpdate_new(Arrays.stream(update_add_htlcs_arg).mapToLong(update_add_htlcs_arg_conv_15 -> update_add_htlcs_arg_conv_15 == null ? 0 : update_add_htlcs_arg_conv_15.ptr & ~1).toArray(), Arrays.stream(update_fulfill_htlcs_arg).mapToLong(update_fulfill_htlcs_arg_conv_19 -> update_fulfill_htlcs_arg_conv_19 == null ? 0 : update_fulfill_htlcs_arg_conv_19.ptr & ~1).toArray(), Arrays.stream(update_fail_htlcs_arg).mapToLong(update_fail_htlcs_arg_conv_16 -> update_fail_htlcs_arg_conv_16 == null ? 0 : update_fail_htlcs_arg_conv_16.ptr & ~1).toArray(), Arrays.stream(update_fail_malformed_htlcs_arg).mapToLong(update_fail_malformed_htlcs_arg_conv_25 -> update_fail_malformed_htlcs_arg_conv_25 == null ? 0 : update_fail_malformed_htlcs_arg_conv_25.ptr & ~1).toArray(), update_fee_arg == null ? 0 : update_fee_arg.ptr & ~1, commitment_signed_arg == null ? 0 : commitment_signed_arg.ptr & ~1);
+		if (ret < 1024) { return null; }
 		CommitmentUpdate ret_hu_conv = new CommitmentUpdate(null, ret);
 		ret_hu_conv.ptrs_to.add(ret_hu_conv);
 		/* TODO 2 UpdateAddHTLC  */;
@@ -71,8 +111,12 @@ public class CommitmentUpdate extends CommonBase {
 		return ret_hu_conv;
 	}
 
+	/**
+	 * Creates a copy of the CommitmentUpdate
+	 */
 	public CommitmentUpdate clone() {
 		long ret = bindings.CommitmentUpdate_clone(this.ptr);
+		if (ret < 1024) { return null; }
 		CommitmentUpdate ret_hu_conv = new CommitmentUpdate(null, ret);
 		ret_hu_conv.ptrs_to.add(this);
 		return ret_hu_conv;