Update auto-updated Java files
[ldk-java] / src / main / java / org / ldk / structs / OpenChannel.java
index 2de4e031a009fd996e3eb089be29ca21337609f2..5d4e8870e1c8b94b577e540487cb660664e3a8f0 100644 (file)
@@ -4,7 +4,13 @@ import org.ldk.impl.bindings;
 import org.ldk.enums.*;
 import org.ldk.util.*;
 import java.util.Arrays;
+import java.lang.ref.Reference;
+import javax.annotation.Nullable;
 
+
+/**
+ * An open_channel message to be sent or received from a peer
+ */
 @SuppressWarnings("unchecked") // We correctly assign various generic arrays
 public class OpenChannel extends CommonBase {
        OpenChannel(Object _dummy, long ptr) { super(ptr); }
@@ -14,184 +20,395 @@ public class OpenChannel extends CommonBase {
                if (ptr != 0) { bindings.OpenChannel_free(ptr); }
        }
 
-       public OpenChannel clone() {
-               long ret = bindings.OpenChannel_clone(this.ptr);
-               OpenChannel ret_hu_conv = new OpenChannel(null, ret);
-               ret_hu_conv.ptrs_to.add(this);
-               return ret_hu_conv;
-       }
-
+       /**
+        * The genesis hash of the blockchain where the channel is to be opened
+        */
        public byte[] get_chain_hash() {
                byte[] ret = bindings.OpenChannel_get_chain_hash(this.ptr);
+               Reference.reachabilityFence(this);
                return ret;
        }
 
+       /**
+        * The genesis hash of the blockchain where the channel is to be opened
+        */
        public void set_chain_hash(byte[] val) {
-               bindings.OpenChannel_set_chain_hash(this.ptr, val);
+               bindings.OpenChannel_set_chain_hash(this.ptr, InternalUtils.check_arr_len(val, 32));
+               Reference.reachabilityFence(this);
+               Reference.reachabilityFence(val);
        }
 
+       /**
+        * A temporary channel ID, until the funding outpoint is announced
+        */
        public byte[] get_temporary_channel_id() {
                byte[] ret = bindings.OpenChannel_get_temporary_channel_id(this.ptr);
+               Reference.reachabilityFence(this);
                return ret;
        }
 
+       /**
+        * A temporary channel ID, until the funding outpoint is announced
+        */
        public void set_temporary_channel_id(byte[] val) {
-               bindings.OpenChannel_set_temporary_channel_id(this.ptr, val);
+               bindings.OpenChannel_set_temporary_channel_id(this.ptr, InternalUtils.check_arr_len(val, 32));
+               Reference.reachabilityFence(this);
+               Reference.reachabilityFence(val);
        }
 
+       /**
+        * The channel value
+        */
        public long get_funding_satoshis() {
                long ret = bindings.OpenChannel_get_funding_satoshis(this.ptr);
+               Reference.reachabilityFence(this);
                return ret;
        }
 
+       /**
+        * The channel value
+        */
        public void set_funding_satoshis(long val) {
                bindings.OpenChannel_set_funding_satoshis(this.ptr, val);
+               Reference.reachabilityFence(this);
+               Reference.reachabilityFence(val);
        }
 
+       /**
+        * The amount to push to the counterparty as part of the open, in milli-satoshi
+        */
        public long get_push_msat() {
                long ret = bindings.OpenChannel_get_push_msat(this.ptr);
+               Reference.reachabilityFence(this);
                return ret;
        }
 
+       /**
+        * The amount to push to the counterparty as part of the open, in milli-satoshi
+        */
        public void set_push_msat(long val) {
                bindings.OpenChannel_set_push_msat(this.ptr, val);
+               Reference.reachabilityFence(this);
+               Reference.reachabilityFence(val);
        }
 
+       /**
+        * The threshold below which outputs on transactions broadcast by sender will be omitted
+        */
        public long get_dust_limit_satoshis() {
                long ret = bindings.OpenChannel_get_dust_limit_satoshis(this.ptr);
+               Reference.reachabilityFence(this);
                return ret;
        }
 
+       /**
+        * The threshold below which outputs on transactions broadcast by sender will be omitted
+        */
        public void set_dust_limit_satoshis(long val) {
                bindings.OpenChannel_set_dust_limit_satoshis(this.ptr, val);
+               Reference.reachabilityFence(this);
+               Reference.reachabilityFence(val);
        }
 
+       /**
+        * The maximum inbound HTLC value in flight towards sender, in milli-satoshi
+        */
        public long get_max_htlc_value_in_flight_msat() {
                long ret = bindings.OpenChannel_get_max_htlc_value_in_flight_msat(this.ptr);
+               Reference.reachabilityFence(this);
                return ret;
        }
 
+       /**
+        * The maximum inbound HTLC value in flight towards sender, in milli-satoshi
+        */
        public void set_max_htlc_value_in_flight_msat(long val) {
                bindings.OpenChannel_set_max_htlc_value_in_flight_msat(this.ptr, val);
+               Reference.reachabilityFence(this);
+               Reference.reachabilityFence(val);
        }
 
+       /**
+        * The minimum value unencumbered by HTLCs for the counterparty to keep in the channel
+        */
        public long get_channel_reserve_satoshis() {
                long ret = bindings.OpenChannel_get_channel_reserve_satoshis(this.ptr);
+               Reference.reachabilityFence(this);
                return ret;
        }
 
+       /**
+        * The minimum value unencumbered by HTLCs for the counterparty to keep in the channel
+        */
        public void set_channel_reserve_satoshis(long val) {
                bindings.OpenChannel_set_channel_reserve_satoshis(this.ptr, val);
+               Reference.reachabilityFence(this);
+               Reference.reachabilityFence(val);
        }
 
+       /**
+        * The minimum HTLC size incoming to sender, in milli-satoshi
+        */
        public long get_htlc_minimum_msat() {
                long ret = bindings.OpenChannel_get_htlc_minimum_msat(this.ptr);
+               Reference.reachabilityFence(this);
                return ret;
        }
 
+       /**
+        * The minimum HTLC size incoming to sender, in milli-satoshi
+        */
        public void set_htlc_minimum_msat(long val) {
                bindings.OpenChannel_set_htlc_minimum_msat(this.ptr, val);
+               Reference.reachabilityFence(this);
+               Reference.reachabilityFence(val);
        }
 
+       /**
+        * The feerate per 1000-weight of sender generated transactions, until updated by update_fee
+        */
        public int get_feerate_per_kw() {
                int ret = bindings.OpenChannel_get_feerate_per_kw(this.ptr);
+               Reference.reachabilityFence(this);
                return ret;
        }
 
+       /**
+        * The feerate per 1000-weight of sender generated transactions, until updated by update_fee
+        */
        public void set_feerate_per_kw(int val) {
                bindings.OpenChannel_set_feerate_per_kw(this.ptr, val);
+               Reference.reachabilityFence(this);
+               Reference.reachabilityFence(val);
        }
 
+       /**
+        * The number of blocks which the counterparty will have to wait to claim on-chain funds if they broadcast a commitment transaction
+        */
        public short get_to_self_delay() {
                short ret = bindings.OpenChannel_get_to_self_delay(this.ptr);
+               Reference.reachabilityFence(this);
                return ret;
        }
 
+       /**
+        * The number of blocks which the counterparty will have to wait to claim on-chain funds if they broadcast a commitment transaction
+        */
        public void set_to_self_delay(short val) {
                bindings.OpenChannel_set_to_self_delay(this.ptr, val);
+               Reference.reachabilityFence(this);
+               Reference.reachabilityFence(val);
        }
 
+       /**
+        * The maximum number of inbound HTLCs towards sender
+        */
        public short get_max_accepted_htlcs() {
                short ret = bindings.OpenChannel_get_max_accepted_htlcs(this.ptr);
+               Reference.reachabilityFence(this);
                return ret;
        }
 
+       /**
+        * The maximum number of inbound HTLCs towards sender
+        */
        public void set_max_accepted_htlcs(short val) {
                bindings.OpenChannel_set_max_accepted_htlcs(this.ptr, val);
+               Reference.reachabilityFence(this);
+               Reference.reachabilityFence(val);
        }
 
+       /**
+        * The sender's key controlling the funding transaction
+        */
        public byte[] get_funding_pubkey() {
                byte[] ret = bindings.OpenChannel_get_funding_pubkey(this.ptr);
+               Reference.reachabilityFence(this);
                return ret;
        }
 
+       /**
+        * The sender's key controlling the funding transaction
+        */
        public void set_funding_pubkey(byte[] val) {
-               bindings.OpenChannel_set_funding_pubkey(this.ptr, val);
+               bindings.OpenChannel_set_funding_pubkey(this.ptr, InternalUtils.check_arr_len(val, 33));
+               Reference.reachabilityFence(this);
+               Reference.reachabilityFence(val);
        }
 
+       /**
+        * Used to derive a revocation key for transactions broadcast by counterparty
+        */
        public byte[] get_revocation_basepoint() {
                byte[] ret = bindings.OpenChannel_get_revocation_basepoint(this.ptr);
+               Reference.reachabilityFence(this);
                return ret;
        }
 
+       /**
+        * Used to derive a revocation key for transactions broadcast by counterparty
+        */
        public void set_revocation_basepoint(byte[] val) {
-               bindings.OpenChannel_set_revocation_basepoint(this.ptr, val);
+               bindings.OpenChannel_set_revocation_basepoint(this.ptr, InternalUtils.check_arr_len(val, 33));
+               Reference.reachabilityFence(this);
+               Reference.reachabilityFence(val);
        }
 
+       /**
+        * A payment key to sender for transactions broadcast by counterparty
+        */
        public byte[] get_payment_point() {
                byte[] ret = bindings.OpenChannel_get_payment_point(this.ptr);
+               Reference.reachabilityFence(this);
                return ret;
        }
 
+       /**
+        * A payment key to sender for transactions broadcast by counterparty
+        */
        public void set_payment_point(byte[] val) {
-               bindings.OpenChannel_set_payment_point(this.ptr, val);
+               bindings.OpenChannel_set_payment_point(this.ptr, InternalUtils.check_arr_len(val, 33));
+               Reference.reachabilityFence(this);
+               Reference.reachabilityFence(val);
        }
 
+       /**
+        * Used to derive a payment key to sender for transactions broadcast by sender
+        */
        public byte[] get_delayed_payment_basepoint() {
                byte[] ret = bindings.OpenChannel_get_delayed_payment_basepoint(this.ptr);
+               Reference.reachabilityFence(this);
                return ret;
        }
 
+       /**
+        * Used to derive a payment key to sender for transactions broadcast by sender
+        */
        public void set_delayed_payment_basepoint(byte[] val) {
-               bindings.OpenChannel_set_delayed_payment_basepoint(this.ptr, val);
+               bindings.OpenChannel_set_delayed_payment_basepoint(this.ptr, InternalUtils.check_arr_len(val, 33));
+               Reference.reachabilityFence(this);
+               Reference.reachabilityFence(val);
        }
 
+       /**
+        * Used to derive an HTLC payment key to sender
+        */
        public byte[] get_htlc_basepoint() {
                byte[] ret = bindings.OpenChannel_get_htlc_basepoint(this.ptr);
+               Reference.reachabilityFence(this);
                return ret;
        }
 
+       /**
+        * Used to derive an HTLC payment key to sender
+        */
        public void set_htlc_basepoint(byte[] val) {
-               bindings.OpenChannel_set_htlc_basepoint(this.ptr, val);
+               bindings.OpenChannel_set_htlc_basepoint(this.ptr, InternalUtils.check_arr_len(val, 33));
+               Reference.reachabilityFence(this);
+               Reference.reachabilityFence(val);
        }
 
+       /**
+        * The first to-be-broadcast-by-sender transaction's per commitment point
+        */
        public byte[] get_first_per_commitment_point() {
                byte[] ret = bindings.OpenChannel_get_first_per_commitment_point(this.ptr);
+               Reference.reachabilityFence(this);
                return ret;
        }
 
+       /**
+        * The first to-be-broadcast-by-sender transaction's per commitment point
+        */
        public void set_first_per_commitment_point(byte[] val) {
-               bindings.OpenChannel_set_first_per_commitment_point(this.ptr, val);
+               bindings.OpenChannel_set_first_per_commitment_point(this.ptr, InternalUtils.check_arr_len(val, 33));
+               Reference.reachabilityFence(this);
+               Reference.reachabilityFence(val);
        }
 
+       /**
+        * Channel flags
+        */
        public byte get_channel_flags() {
                byte ret = bindings.OpenChannel_get_channel_flags(this.ptr);
+               Reference.reachabilityFence(this);
                return ret;
        }
 
+       /**
+        * Channel flags
+        */
        public void set_channel_flags(byte val) {
                bindings.OpenChannel_set_channel_flags(this.ptr, val);
+               Reference.reachabilityFence(this);
+               Reference.reachabilityFence(val);
+       }
+
+       /**
+        * The channel type that this channel will represent. If none is set, we derive the channel
+        * type from the intersection of our feature bits with our counterparty's feature bits from
+        * the Init message.
+        * 
+        * Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
+        */
+       @Nullable
+       public ChannelTypeFeatures get_channel_type() {
+               long ret = bindings.OpenChannel_get_channel_type(this.ptr);
+               Reference.reachabilityFence(this);
+               if (ret >= 0 && ret <= 4096) { return null; }
+               ChannelTypeFeatures ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new ChannelTypeFeatures(null, ret); }
+               ret_hu_conv.ptrs_to.add(this);
+               return ret_hu_conv;
+       }
+
+       /**
+        * The channel type that this channel will represent. If none is set, we derive the channel
+        * type from the intersection of our feature bits with our counterparty's feature bits from
+        * the Init message.
+        * 
+        * Note that val (or a relevant inner pointer) may be NULL or all-0s to represent None
+        */
+       public void set_channel_type(@Nullable ChannelTypeFeatures val) {
+               bindings.OpenChannel_set_channel_type(this.ptr, val == null ? 0 : val.ptr & ~1);
+               Reference.reachabilityFence(this);
+               Reference.reachabilityFence(val);
+       }
+
+       long clone_ptr() {
+               long ret = bindings.OpenChannel_clone_ptr(this.ptr);
+               Reference.reachabilityFence(this);
+               return ret;
+       }
+
+       /**
+        * Creates a copy of the OpenChannel
+        */
+       public OpenChannel clone() {
+               long ret = bindings.OpenChannel_clone(this.ptr);
+               Reference.reachabilityFence(this);
+               if (ret >= 0 && ret <= 4096) { return null; }
+               OpenChannel ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new OpenChannel(null, ret); }
+               ret_hu_conv.ptrs_to.add(this);
+               return ret_hu_conv;
        }
 
+       /**
+        * Serialize the OpenChannel object into a byte array which can be read by OpenChannel_read
+        */
        public byte[] write() {
                byte[] ret = bindings.OpenChannel_write(this.ptr);
+               Reference.reachabilityFence(this);
                return ret;
        }
 
-       public static OpenChannel constructor_read(byte[] ser) {
+       /**
+        * Read a OpenChannel from a byte array, created by OpenChannel_write
+        */
+       public static Result_OpenChannelDecodeErrorZ read(byte[] ser) {
                long ret = bindings.OpenChannel_read(ser);
-               OpenChannel ret_hu_conv = new OpenChannel(null, ret);
-               ret_hu_conv.ptrs_to.add(ret_hu_conv);
+               Reference.reachabilityFence(ser);
+               if (ret >= 0 && ret <= 4096) { return null; }
+               Result_OpenChannelDecodeErrorZ ret_hu_conv = Result_OpenChannelDecodeErrorZ.constr_from_ptr(ret);
                return ret_hu_conv;
        }