Update java bindings with new generator and new upstream code
[ldk-java] / src / main / java / org / ldk / structs / DirectedChannelTransactionParameters.java
index 2358c61524b4d5b2bf594e6648ba5811cf721dd7..17b9ab0b5def05bb7319060eda65f9a33db4db3f 100644 (file)
@@ -5,6 +5,14 @@ import org.ldk.enums.*;
 import org.ldk.util.*;
 import java.util.Arrays;
 
+
+/**
+ * Static channel fields used to build transactions given per-commitment fields, organized by
+ * broadcaster/countersignatory.
+ * 
+ * This is derived from the holder/counterparty-organized ChannelTransactionParameters via the
+ * as_holder_broadcastable and as_counterparty_broadcastable functions.
+ */
 @SuppressWarnings("unchecked") // We correctly assign various generic arrays
 public class DirectedChannelTransactionParameters extends CommonBase {
        DirectedChannelTransactionParameters(Object _dummy, long ptr) { super(ptr); }
@@ -14,6 +22,9 @@ public class DirectedChannelTransactionParameters extends CommonBase {
                if (ptr != 0) { bindings.DirectedChannelTransactionParameters_free(ptr); }
        }
 
+       /**
+        * Get the channel pubkeys for the broadcaster
+        */
        public ChannelPublicKeys broadcaster_pubkeys() {
                long ret = bindings.DirectedChannelTransactionParameters_broadcaster_pubkeys(this.ptr);
                ChannelPublicKeys ret_hu_conv = new ChannelPublicKeys(null, ret);
@@ -21,6 +32,9 @@ public class DirectedChannelTransactionParameters extends CommonBase {
                return ret_hu_conv;
        }
 
+       /**
+        * Get the channel pubkeys for the countersignatory
+        */
        public ChannelPublicKeys countersignatory_pubkeys() {
                long ret = bindings.DirectedChannelTransactionParameters_countersignatory_pubkeys(this.ptr);
                ChannelPublicKeys ret_hu_conv = new ChannelPublicKeys(null, ret);
@@ -28,16 +42,29 @@ public class DirectedChannelTransactionParameters extends CommonBase {
                return ret_hu_conv;
        }
 
+       /**
+        * Get the contest delay applicable to the transactions.
+        * Note that the contest delay was selected by the countersignatory.
+        */
        public short contest_delay() {
                short ret = bindings.DirectedChannelTransactionParameters_contest_delay(this.ptr);
                return ret;
        }
 
+       /**
+        * Whether the channel is outbound from the broadcaster.
+        * 
+        * The boolean representing the side that initiated the channel is
+        * an input to the commitment number obscure factor computation.
+        */
        public boolean is_outbound() {
                boolean ret = bindings.DirectedChannelTransactionParameters_is_outbound(this.ptr);
                return ret;
        }
 
+       /**
+        * The funding outpoint
+        */
        public OutPoint funding_outpoint() {
                long ret = bindings.DirectedChannelTransactionParameters_funding_outpoint(this.ptr);
                OutPoint ret_hu_conv = new OutPoint(null, ret);