_ Git - ldk-java/blob - src/main/java/org/ldk/structs/ChannelDetails.java

   1 package org.ldk.structs;
   2
   3 import org.ldk.impl.bindings;
   4 import org.ldk.enums.*;
   5 import org.ldk.util.*;
   6 import java.util.Arrays;
   7 import java.lang.ref.Reference;
   8 import javax.annotation.Nullable;
   9
  10
  11 /**
  12  * Details of a channel, as returned by ChannelManager::list_channels and ChannelManager::list_usable_channels
  13  */
  14 @SuppressWarnings("unchecked") // We correctly assign various generic arrays
  15 public class ChannelDetails extends CommonBase {
  16         ChannelDetails(Object _dummy, long ptr) { super(ptr); }
  17         @Override @SuppressWarnings("deprecation")
  18         protected void finalize() throws Throwable {
  19                 super.finalize();
  20                 if (ptr != 0) { bindings.ChannelDetails_free(ptr); }
  21         }
  22
  23         /**
  24          * The channel's ID (prior to funding transaction generation, this is a random 32 bytes,
  25          * thereafter this is the txid of the funding transaction xor the funding transaction output).
  26          * Note that this means this value is *not* persistent - it can change once during the
  27          * lifetime of the channel.
  28          */
  29         public byte[] get_channel_id() {
  30                 byte[] ret = bindings.ChannelDetails_get_channel_id(this.ptr);
  31                 Reference.reachabilityFence(this);
  32                 return ret;
  33         }
  34
  35         /**
  36          * The channel's ID (prior to funding transaction generation, this is a random 32 bytes,
  37          * thereafter this is the txid of the funding transaction xor the funding transaction output).
  38          * Note that this means this value is *not* persistent - it can change once during the
  39          * lifetime of the channel.
  40          */
  41         public void set_channel_id(byte[] val) {
  42                 bindings.ChannelDetails_set_channel_id(this.ptr, InternalUtils.check_arr_len(val, 32));
  43                 Reference.reachabilityFence(this);
  44                 Reference.reachabilityFence(val);
  45         }
  46
  47         /**
  48          * Parameters which apply to our counterparty. See individual fields for more information.
  49          */
  50         public ChannelCounterparty get_counterparty() {
  51                 long ret = bindings.ChannelDetails_get_counterparty(this.ptr);
  52                 Reference.reachabilityFence(this);
  53                 if (ret >= 0 && ret <= 4096) { return null; }
  54                 org.ldk.structs.ChannelCounterparty ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new org.ldk.structs.ChannelCounterparty(null, ret); }
  55                 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(this); };
  56                 return ret_hu_conv;
  57         }
  58
  59         /**
  60          * Parameters which apply to our counterparty. See individual fields for more information.
  61          */
  62         public void set_counterparty(org.ldk.structs.ChannelCounterparty val) {
  63                 bindings.ChannelDetails_set_counterparty(this.ptr, val == null ? 0 : val.ptr);
  64                 Reference.reachabilityFence(this);
  65                 Reference.reachabilityFence(val);
  66                 if (this != null) { this.ptrs_to.add(val); };
  67         }
  68
  69         /**
  70          * The Channel's funding transaction output, if we've negotiated the funding transaction with
  71          * our counterparty already.
  72          *
  73          * Note that, if this has been set, `channel_id` will be equivalent to
  74          * `funding_txo.unwrap().to_channel_id()`.
  75          *
  76          * Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
  77          */
  78         @Nullable
  79         public OutPoint get_funding_txo() {
  80                 long ret = bindings.ChannelDetails_get_funding_txo(this.ptr);
  81                 Reference.reachabilityFence(this);
  82                 if (ret >= 0 && ret <= 4096) { return null; }
  83                 org.ldk.structs.OutPoint ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new org.ldk.structs.OutPoint(null, ret); }
  84                 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(this); };
  85                 return ret_hu_conv;
  86         }
  87
  88         /**
  89          * The Channel's funding transaction output, if we've negotiated the funding transaction with
  90          * our counterparty already.
  91          *
  92          * Note that, if this has been set, `channel_id` will be equivalent to
  93          * `funding_txo.unwrap().to_channel_id()`.
  94          *
  95          * Note that val (or a relevant inner pointer) may be NULL or all-0s to represent None
  96          */
  97         public void set_funding_txo(@Nullable org.ldk.structs.OutPoint val) {
  98                 bindings.ChannelDetails_set_funding_txo(this.ptr, val == null ? 0 : val.ptr);
  99                 Reference.reachabilityFence(this);
 100                 Reference.reachabilityFence(val);
 101                 if (this != null) { this.ptrs_to.add(val); };
 102         }
 103
 104         /**
 105          * The features which this channel operates with. See individual features for more info.
 106          *
 107          * `None` until negotiation completes and the channel type is finalized.
 108          *
 109          * Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
 110          */
 111         @Nullable
 112         public ChannelTypeFeatures get_channel_type() {
 113                 long ret = bindings.ChannelDetails_get_channel_type(this.ptr);
 114                 Reference.reachabilityFence(this);
 115                 if (ret >= 0 && ret <= 4096) { return null; }
 116                 org.ldk.structs.ChannelTypeFeatures ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new org.ldk.structs.ChannelTypeFeatures(null, ret); }
 117                 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(this); };
 118                 return ret_hu_conv;
 119         }
 120
 121         /**
 122          * The features which this channel operates with. See individual features for more info.
 123          *
 124          * `None` until negotiation completes and the channel type is finalized.
 125          *
 126          * Note that val (or a relevant inner pointer) may be NULL or all-0s to represent None
 127          */
 128         public void set_channel_type(@Nullable org.ldk.structs.ChannelTypeFeatures val) {
 129                 bindings.ChannelDetails_set_channel_type(this.ptr, val == null ? 0 : val.ptr);
 130                 Reference.reachabilityFence(this);
 131                 Reference.reachabilityFence(val);
 132                 if (this != null) { this.ptrs_to.add(val); };
 133         }
 134
 135         /**
 136          * The position of the funding transaction in the chain. None if the funding transaction has
 137          * not yet been confirmed and the channel fully opened.
 138          *
 139          * Note that if [`inbound_scid_alias`] is set, it must be used for invoices and inbound
 140          * payments instead of this. See [`get_inbound_payment_scid`].
 141          *
 142          * For channels with [`confirmations_required`] set to `Some(0)`, [`outbound_scid_alias`] may
 143          * be used in place of this in outbound routes. See [`get_outbound_payment_scid`].
 144          *
 145          * [`inbound_scid_alias`]: Self::inbound_scid_alias
 146          * [`outbound_scid_alias`]: Self::outbound_scid_alias
 147          * [`get_inbound_payment_scid`]: Self::get_inbound_payment_scid
 148          * [`get_outbound_payment_scid`]: Self::get_outbound_payment_scid
 149          * [`confirmations_required`]: Self::confirmations_required
 150          */
 151         public Option_u64Z get_short_channel_id() {
 152                 long ret = bindings.ChannelDetails_get_short_channel_id(this.ptr);
 153                 Reference.reachabilityFence(this);
 154                 if (ret >= 0 && ret <= 4096) { return null; }
 155                 org.ldk.structs.Option_u64Z ret_hu_conv = org.ldk.structs.Option_u64Z.constr_from_ptr(ret);
 156                 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(this); };
 157                 return ret_hu_conv;
 158         }
 159
 160         /**
 161          * The position of the funding transaction in the chain. None if the funding transaction has
 162          * not yet been confirmed and the channel fully opened.
 163          *
 164          * Note that if [`inbound_scid_alias`] is set, it must be used for invoices and inbound
 165          * payments instead of this. See [`get_inbound_payment_scid`].
 166          *
 167          * For channels with [`confirmations_required`] set to `Some(0)`, [`outbound_scid_alias`] may
 168          * be used in place of this in outbound routes. See [`get_outbound_payment_scid`].
 169          *
 170          * [`inbound_scid_alias`]: Self::inbound_scid_alias
 171          * [`outbound_scid_alias`]: Self::outbound_scid_alias
 172          * [`get_inbound_payment_scid`]: Self::get_inbound_payment_scid
 173          * [`get_outbound_payment_scid`]: Self::get_outbound_payment_scid
 174          * [`confirmations_required`]: Self::confirmations_required
 175          */
 176         public void set_short_channel_id(org.ldk.structs.Option_u64Z val) {
 177                 bindings.ChannelDetails_set_short_channel_id(this.ptr, val.ptr);
 178                 Reference.reachabilityFence(this);
 179                 Reference.reachabilityFence(val);
 180                 if (this != null) { this.ptrs_to.add(val); };
 181         }
 182
 183         /**
 184          * An optional [`short_channel_id`] alias for this channel, randomly generated by us and
 185          * usable in place of [`short_channel_id`] to reference the channel in outbound routes when
 186          * the channel has not yet been confirmed (as long as [`confirmations_required`] is
 187          * `Some(0)`).
 188          *
 189          * This will be `None` as long as the channel is not available for routing outbound payments.
 190          *
 191          * [`short_channel_id`]: Self::short_channel_id
 192          * [`confirmations_required`]: Self::confirmations_required
 193          */
 194         public Option_u64Z get_outbound_scid_alias() {
 195                 long ret = bindings.ChannelDetails_get_outbound_scid_alias(this.ptr);
 196                 Reference.reachabilityFence(this);
 197                 if (ret >= 0 && ret <= 4096) { return null; }
 198                 org.ldk.structs.Option_u64Z ret_hu_conv = org.ldk.structs.Option_u64Z.constr_from_ptr(ret);
 199                 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(this); };
 200                 return ret_hu_conv;
 201         }
 202
 203         /**
 204          * An optional [`short_channel_id`] alias for this channel, randomly generated by us and
 205          * usable in place of [`short_channel_id`] to reference the channel in outbound routes when
 206          * the channel has not yet been confirmed (as long as [`confirmations_required`] is
 207          * `Some(0)`).
 208          *
 209          * This will be `None` as long as the channel is not available for routing outbound payments.
 210          *
 211          * [`short_channel_id`]: Self::short_channel_id
 212          * [`confirmations_required`]: Self::confirmations_required
 213          */
 214         public void set_outbound_scid_alias(org.ldk.structs.Option_u64Z val) {
 215                 bindings.ChannelDetails_set_outbound_scid_alias(this.ptr, val.ptr);
 216                 Reference.reachabilityFence(this);
 217                 Reference.reachabilityFence(val);
 218                 if (this != null) { this.ptrs_to.add(val); };
 219         }
 220
 221         /**
 222          * An optional [`short_channel_id`] alias for this channel, randomly generated by our
 223          * counterparty and usable in place of [`short_channel_id`] in invoice route hints. Our
 224          * counterparty will recognize the alias provided here in place of the [`short_channel_id`]
 225          * when they see a payment to be routed to us.
 226          *
 227          * Our counterparty may choose to rotate this value at any time, though will always recognize
 228          * previous values for inbound payment forwarding.
 229          *
 230          * [`short_channel_id`]: Self::short_channel_id
 231          */
 232         public Option_u64Z get_inbound_scid_alias() {
 233                 long ret = bindings.ChannelDetails_get_inbound_scid_alias(this.ptr);
 234                 Reference.reachabilityFence(this);
 235                 if (ret >= 0 && ret <= 4096) { return null; }
 236                 org.ldk.structs.Option_u64Z ret_hu_conv = org.ldk.structs.Option_u64Z.constr_from_ptr(ret);
 237                 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(this); };
 238                 return ret_hu_conv;
 239         }
 240
 241         /**
 242          * An optional [`short_channel_id`] alias for this channel, randomly generated by our
 243          * counterparty and usable in place of [`short_channel_id`] in invoice route hints. Our
 244          * counterparty will recognize the alias provided here in place of the [`short_channel_id`]
 245          * when they see a payment to be routed to us.
 246          *
 247          * Our counterparty may choose to rotate this value at any time, though will always recognize
 248          * previous values for inbound payment forwarding.
 249          *
 250          * [`short_channel_id`]: Self::short_channel_id
 251          */
 252         public void set_inbound_scid_alias(org.ldk.structs.Option_u64Z val) {
 253                 bindings.ChannelDetails_set_inbound_scid_alias(this.ptr, val.ptr);
 254                 Reference.reachabilityFence(this);
 255                 Reference.reachabilityFence(val);
 256                 if (this != null) { this.ptrs_to.add(val); };
 257         }
 258
 259         /**
 260          * The value, in satoshis, of this channel as appears in the funding output
 261          */
 262         public long get_channel_value_satoshis() {
 263                 long ret = bindings.ChannelDetails_get_channel_value_satoshis(this.ptr);
 264                 Reference.reachabilityFence(this);
 265                 return ret;
 266         }
 267
 268         /**
 269          * The value, in satoshis, of this channel as appears in the funding output
 270          */
 271         public void set_channel_value_satoshis(long val) {
 272                 bindings.ChannelDetails_set_channel_value_satoshis(this.ptr, val);
 273                 Reference.reachabilityFence(this);
 274                 Reference.reachabilityFence(val);
 275         }
 276
 277         /**
 278          * The value, in satoshis, that must always be held in the channel for us. This value ensures
 279          * that if we broadcast a revoked state, our counterparty can punish us by claiming at least
 280          * this value on chain.
 281          *
 282          * This value is not included in [`outbound_capacity_msat`] as it can never be spent.
 283          *
 284          * This value will be `None` for outbound channels until the counterparty accepts the channel.
 285          *
 286          * [`outbound_capacity_msat`]: ChannelDetails::outbound_capacity_msat
 287          */
 288         public Option_u64Z get_unspendable_punishment_reserve() {
 289                 long ret = bindings.ChannelDetails_get_unspendable_punishment_reserve(this.ptr);
 290                 Reference.reachabilityFence(this);
 291                 if (ret >= 0 && ret <= 4096) { return null; }
 292                 org.ldk.structs.Option_u64Z ret_hu_conv = org.ldk.structs.Option_u64Z.constr_from_ptr(ret);
 293                 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(this); };
 294                 return ret_hu_conv;
 295         }
 296
 297         /**
 298          * The value, in satoshis, that must always be held in the channel for us. This value ensures
 299          * that if we broadcast a revoked state, our counterparty can punish us by claiming at least
 300          * this value on chain.
 301          *
 302          * This value is not included in [`outbound_capacity_msat`] as it can never be spent.
 303          *
 304          * This value will be `None` for outbound channels until the counterparty accepts the channel.
 305          *
 306          * [`outbound_capacity_msat`]: ChannelDetails::outbound_capacity_msat
 307          */
 308         public void set_unspendable_punishment_reserve(org.ldk.structs.Option_u64Z val) {
 309                 bindings.ChannelDetails_set_unspendable_punishment_reserve(this.ptr, val.ptr);
 310                 Reference.reachabilityFence(this);
 311                 Reference.reachabilityFence(val);
 312                 if (this != null) { this.ptrs_to.add(val); };
 313         }
 314
 315         /**
 316          * The `user_channel_id` passed in to create_channel, or a random value if the channel was
 317          * inbound. This may be zero for inbound channels serialized with LDK versions prior to
 318          * 0.0.113.
 319          */
 320         public UInt128 get_user_channel_id() {
 321                 byte[] ret = bindings.ChannelDetails_get_user_channel_id(this.ptr);
 322                 Reference.reachabilityFence(this);
 323                 org.ldk.util.UInt128 ret_conv = new org.ldk.util.UInt128(ret);
 324                 return ret_conv;
 325         }
 326
 327         /**
 328          * The `user_channel_id` passed in to create_channel, or a random value if the channel was
 329          * inbound. This may be zero for inbound channels serialized with LDK versions prior to
 330          * 0.0.113.
 331          */
 332         public void set_user_channel_id(org.ldk.util.UInt128 val) {
 333                 bindings.ChannelDetails_set_user_channel_id(this.ptr, val.getLEBytes());
 334                 Reference.reachabilityFence(this);
 335                 Reference.reachabilityFence(val);
 336         }
 337
 338         /**
 339          * Our total balance.  This is the amount we would get if we close the channel.
 340          * This value is not exact. Due to various in-flight changes and feerate changes, exactly this
 341          * amount is not likely to be recoverable on close.
 342          *
 343          * This does not include any pending HTLCs which are not yet fully resolved (and, thus, whose
 344          * balance is not available for inclusion in new outbound HTLCs). This further does not include
 345          * any pending outgoing HTLCs which are awaiting some other resolution to be sent.
 346          * This does not consider any on-chain fees.
 347          *
 348          * See also [`ChannelDetails::outbound_capacity_msat`]
 349          */
 350         public long get_balance_msat() {
 351                 long ret = bindings.ChannelDetails_get_balance_msat(this.ptr);
 352                 Reference.reachabilityFence(this);
 353                 return ret;
 354         }
 355
 356         /**
 357          * Our total balance.  This is the amount we would get if we close the channel.
 358          * This value is not exact. Due to various in-flight changes and feerate changes, exactly this
 359          * amount is not likely to be recoverable on close.
 360          *
 361          * This does not include any pending HTLCs which are not yet fully resolved (and, thus, whose
 362          * balance is not available for inclusion in new outbound HTLCs). This further does not include
 363          * any pending outgoing HTLCs which are awaiting some other resolution to be sent.
 364          * This does not consider any on-chain fees.
 365          *
 366          * See also [`ChannelDetails::outbound_capacity_msat`]
 367          */
 368         public void set_balance_msat(long val) {
 369                 bindings.ChannelDetails_set_balance_msat(this.ptr, val);
 370                 Reference.reachabilityFence(this);
 371                 Reference.reachabilityFence(val);
 372         }
 373
 374         /**
 375          * The available outbound capacity for sending HTLCs to the remote peer. This does not include
 376          * any pending HTLCs which are not yet fully resolved (and, thus, whose balance is not
 377          * available for inclusion in new outbound HTLCs). This further does not include any pending
 378          * outgoing HTLCs which are awaiting some other resolution to be sent.
 379          *
 380          * See also [`ChannelDetails::balance_msat`]
 381          *
 382          * This value is not exact. Due to various in-flight changes, feerate changes, and our
 383          * conflict-avoidance policy, exactly this amount is not likely to be spendable. However, we
 384          * should be able to spend nearly this amount.
 385          */
 386         public long get_outbound_capacity_msat() {
 387                 long ret = bindings.ChannelDetails_get_outbound_capacity_msat(this.ptr);
 388                 Reference.reachabilityFence(this);
 389                 return ret;
 390         }
 391
 392         /**
 393          * The available outbound capacity for sending HTLCs to the remote peer. This does not include
 394          * any pending HTLCs which are not yet fully resolved (and, thus, whose balance is not
 395          * available for inclusion in new outbound HTLCs). This further does not include any pending
 396          * outgoing HTLCs which are awaiting some other resolution to be sent.
 397          *
 398          * See also [`ChannelDetails::balance_msat`]
 399          *
 400          * This value is not exact. Due to various in-flight changes, feerate changes, and our
 401          * conflict-avoidance policy, exactly this amount is not likely to be spendable. However, we
 402          * should be able to spend nearly this amount.
 403          */
 404         public void set_outbound_capacity_msat(long val) {
 405                 bindings.ChannelDetails_set_outbound_capacity_msat(this.ptr, val);
 406                 Reference.reachabilityFence(this);
 407                 Reference.reachabilityFence(val);
 408         }
 409
 410         /**
 411          * The available outbound capacity for sending a single HTLC to the remote peer. This is
 412          * similar to [`ChannelDetails::outbound_capacity_msat`] but it may be further restricted by
 413          * the current state and per-HTLC limit(s). This is intended for use when routing, allowing us
 414          * to use a limit as close as possible to the HTLC limit we can currently send.
 415          *
 416          * See also [`ChannelDetails::balance_msat`] and [`ChannelDetails::outbound_capacity_msat`].
 417          */
 418         public long get_next_outbound_htlc_limit_msat() {
 419                 long ret = bindings.ChannelDetails_get_next_outbound_htlc_limit_msat(this.ptr);
 420                 Reference.reachabilityFence(this);
 421                 return ret;
 422         }
 423
 424         /**
 425          * The available outbound capacity for sending a single HTLC to the remote peer. This is
 426          * similar to [`ChannelDetails::outbound_capacity_msat`] but it may be further restricted by
 427          * the current state and per-HTLC limit(s). This is intended for use when routing, allowing us
 428          * to use a limit as close as possible to the HTLC limit we can currently send.
 429          *
 430          * See also [`ChannelDetails::balance_msat`] and [`ChannelDetails::outbound_capacity_msat`].
 431          */
 432         public void set_next_outbound_htlc_limit_msat(long val) {
 433                 bindings.ChannelDetails_set_next_outbound_htlc_limit_msat(this.ptr, val);
 434                 Reference.reachabilityFence(this);
 435                 Reference.reachabilityFence(val);
 436         }
 437
 438         /**
 439          * The available inbound capacity for the remote peer to send HTLCs to us. This does not
 440          * include any pending HTLCs which are not yet fully resolved (and, thus, whose balance is not
 441          * available for inclusion in new inbound HTLCs).
 442          * Note that there are some corner cases not fully handled here, so the actual available
 443          * inbound capacity may be slightly higher than this.
 444          *
 445          * This value is not exact. Due to various in-flight changes, feerate changes, and our
 446          * counterparty's conflict-avoidance policy, exactly this amount is not likely to be spendable.
 447          * However, our counterparty should be able to spend nearly this amount.
 448          */
 449         public long get_inbound_capacity_msat() {
 450                 long ret = bindings.ChannelDetails_get_inbound_capacity_msat(this.ptr);
 451                 Reference.reachabilityFence(this);
 452                 return ret;
 453         }
 454
 455         /**
 456          * The available inbound capacity for the remote peer to send HTLCs to us. This does not
 457          * include any pending HTLCs which are not yet fully resolved (and, thus, whose balance is not
 458          * available for inclusion in new inbound HTLCs).
 459          * Note that there are some corner cases not fully handled here, so the actual available
 460          * inbound capacity may be slightly higher than this.
 461          *
 462          * This value is not exact. Due to various in-flight changes, feerate changes, and our
 463          * counterparty's conflict-avoidance policy, exactly this amount is not likely to be spendable.
 464          * However, our counterparty should be able to spend nearly this amount.
 465          */
 466         public void set_inbound_capacity_msat(long val) {
 467                 bindings.ChannelDetails_set_inbound_capacity_msat(this.ptr, val);
 468                 Reference.reachabilityFence(this);
 469                 Reference.reachabilityFence(val);
 470         }
 471
 472         /**
 473          * The number of required confirmations on the funding transaction before the funding will be
 474          * considered \"locked\". This number is selected by the channel fundee (i.e. us if
 475          * [`is_outbound`] is *not* set), and can be selected for inbound channels with
 476          * [`ChannelHandshakeConfig::minimum_depth`] or limited for outbound channels with
 477          * [`ChannelHandshakeLimits::max_minimum_depth`].
 478          *
 479          * This value will be `None` for outbound channels until the counterparty accepts the channel.
 480          *
 481          * [`is_outbound`]: ChannelDetails::is_outbound
 482          * [`ChannelHandshakeConfig::minimum_depth`]: crate::util::config::ChannelHandshakeConfig::minimum_depth
 483          * [`ChannelHandshakeLimits::max_minimum_depth`]: crate::util::config::ChannelHandshakeLimits::max_minimum_depth
 484          */
 485         public Option_u32Z get_confirmations_required() {
 486                 long ret = bindings.ChannelDetails_get_confirmations_required(this.ptr);
 487                 Reference.reachabilityFence(this);
 488                 if (ret >= 0 && ret <= 4096) { return null; }
 489                 org.ldk.structs.Option_u32Z ret_hu_conv = org.ldk.structs.Option_u32Z.constr_from_ptr(ret);
 490                 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(this); };
 491                 return ret_hu_conv;
 492         }
 493
 494         /**
 495          * The number of required confirmations on the funding transaction before the funding will be
 496          * considered \"locked\". This number is selected by the channel fundee (i.e. us if
 497          * [`is_outbound`] is *not* set), and can be selected for inbound channels with
 498          * [`ChannelHandshakeConfig::minimum_depth`] or limited for outbound channels with
 499          * [`ChannelHandshakeLimits::max_minimum_depth`].
 500          *
 501          * This value will be `None` for outbound channels until the counterparty accepts the channel.
 502          *
 503          * [`is_outbound`]: ChannelDetails::is_outbound
 504          * [`ChannelHandshakeConfig::minimum_depth`]: crate::util::config::ChannelHandshakeConfig::minimum_depth
 505          * [`ChannelHandshakeLimits::max_minimum_depth`]: crate::util::config::ChannelHandshakeLimits::max_minimum_depth
 506          */
 507         public void set_confirmations_required(org.ldk.structs.Option_u32Z val) {
 508                 bindings.ChannelDetails_set_confirmations_required(this.ptr, val.ptr);
 509                 Reference.reachabilityFence(this);
 510                 Reference.reachabilityFence(val);
 511                 if (this != null) { this.ptrs_to.add(val); };
 512         }
 513
 514         /**
 515          * The current number of confirmations on the funding transaction.
 516          *
 517          * This value will be `None` for objects serialized with LDK versions prior to 0.0.113.
 518          */
 519         public Option_u32Z get_confirmations() {
 520                 long ret = bindings.ChannelDetails_get_confirmations(this.ptr);
 521                 Reference.reachabilityFence(this);
 522                 if (ret >= 0 && ret <= 4096) { return null; }
 523                 org.ldk.structs.Option_u32Z ret_hu_conv = org.ldk.structs.Option_u32Z.constr_from_ptr(ret);
 524                 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(this); };
 525                 return ret_hu_conv;
 526         }
 527
 528         /**
 529          * The current number of confirmations on the funding transaction.
 530          *
 531          * This value will be `None` for objects serialized with LDK versions prior to 0.0.113.
 532          */
 533         public void set_confirmations(org.ldk.structs.Option_u32Z val) {
 534                 bindings.ChannelDetails_set_confirmations(this.ptr, val.ptr);
 535                 Reference.reachabilityFence(this);
 536                 Reference.reachabilityFence(val);
 537                 if (this != null) { this.ptrs_to.add(val); };
 538         }
 539
 540         /**
 541          * The number of blocks (after our commitment transaction confirms) that we will need to wait
 542          * until we can claim our funds after we force-close the channel. During this time our
 543          * counterparty is allowed to punish us if we broadcasted a stale state. If our counterparty
 544          * force-closes the channel and broadcasts a commitment transaction we do not have to wait any
 545          * time to claim our non-HTLC-encumbered funds.
 546          *
 547          * This value will be `None` for outbound channels until the counterparty accepts the channel.
 548          */
 549         public Option_u16Z get_force_close_spend_delay() {
 550                 long ret = bindings.ChannelDetails_get_force_close_spend_delay(this.ptr);
 551                 Reference.reachabilityFence(this);
 552                 if (ret >= 0 && ret <= 4096) { return null; }
 553                 org.ldk.structs.Option_u16Z ret_hu_conv = org.ldk.structs.Option_u16Z.constr_from_ptr(ret);
 554                 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(this); };
 555                 return ret_hu_conv;
 556         }
 557
 558         /**
 559          * The number of blocks (after our commitment transaction confirms) that we will need to wait
 560          * until we can claim our funds after we force-close the channel. During this time our
 561          * counterparty is allowed to punish us if we broadcasted a stale state. If our counterparty
 562          * force-closes the channel and broadcasts a commitment transaction we do not have to wait any
 563          * time to claim our non-HTLC-encumbered funds.
 564          *
 565          * This value will be `None` for outbound channels until the counterparty accepts the channel.
 566          */
 567         public void set_force_close_spend_delay(org.ldk.structs.Option_u16Z val) {
 568                 bindings.ChannelDetails_set_force_close_spend_delay(this.ptr, val.ptr);
 569                 Reference.reachabilityFence(this);
 570                 Reference.reachabilityFence(val);
 571                 if (this != null) { this.ptrs_to.add(val); };
 572         }
 573
 574         /**
 575          * True if the channel was initiated (and thus funded) by us.
 576          */
 577         public boolean get_is_outbound() {
 578                 boolean ret = bindings.ChannelDetails_get_is_outbound(this.ptr);
 579                 Reference.reachabilityFence(this);
 580                 return ret;
 581         }
 582
 583         /**
 584          * True if the channel was initiated (and thus funded) by us.
 585          */
 586         public void set_is_outbound(boolean val) {
 587                 bindings.ChannelDetails_set_is_outbound(this.ptr, val);
 588                 Reference.reachabilityFence(this);
 589                 Reference.reachabilityFence(val);
 590         }
 591
 592         /**
 593          * True if the channel is confirmed, channel_ready messages have been exchanged, and the
 594          * channel is not currently being shut down. `channel_ready` message exchange implies the
 595          * required confirmation count has been reached (and we were connected to the peer at some
 596          * point after the funding transaction received enough confirmations). The required
 597          * confirmation count is provided in [`confirmations_required`].
 598          *
 599          * [`confirmations_required`]: ChannelDetails::confirmations_required
 600          */
 601         public boolean get_is_channel_ready() {
 602                 boolean ret = bindings.ChannelDetails_get_is_channel_ready(this.ptr);
 603                 Reference.reachabilityFence(this);
 604                 return ret;
 605         }
 606
 607         /**
 608          * True if the channel is confirmed, channel_ready messages have been exchanged, and the
 609          * channel is not currently being shut down. `channel_ready` message exchange implies the
 610          * required confirmation count has been reached (and we were connected to the peer at some
 611          * point after the funding transaction received enough confirmations). The required
 612          * confirmation count is provided in [`confirmations_required`].
 613          *
 614          * [`confirmations_required`]: ChannelDetails::confirmations_required
 615          */
 616         public void set_is_channel_ready(boolean val) {
 617                 bindings.ChannelDetails_set_is_channel_ready(this.ptr, val);
 618                 Reference.reachabilityFence(this);
 619                 Reference.reachabilityFence(val);
 620         }
 621
 622         /**
 623          * True if the channel is (a) confirmed and channel_ready messages have been exchanged, (b)
 624          * the peer is connected, and (c) the channel is not currently negotiating a shutdown.
 625          *
 626          * This is a strict superset of `is_channel_ready`.
 627          */
 628         public boolean get_is_usable() {
 629                 boolean ret = bindings.ChannelDetails_get_is_usable(this.ptr);
 630                 Reference.reachabilityFence(this);
 631                 return ret;
 632         }
 633
 634         /**
 635          * True if the channel is (a) confirmed and channel_ready messages have been exchanged, (b)
 636          * the peer is connected, and (c) the channel is not currently negotiating a shutdown.
 637          *
 638          * This is a strict superset of `is_channel_ready`.
 639          */
 640         public void set_is_usable(boolean val) {
 641                 bindings.ChannelDetails_set_is_usable(this.ptr, val);
 642                 Reference.reachabilityFence(this);
 643                 Reference.reachabilityFence(val);
 644         }
 645
 646         /**
 647          * True if this channel is (or will be) publicly-announced.
 648          */
 649         public boolean get_is_public() {
 650                 boolean ret = bindings.ChannelDetails_get_is_public(this.ptr);
 651                 Reference.reachabilityFence(this);
 652                 return ret;
 653         }
 654
 655         /**
 656          * True if this channel is (or will be) publicly-announced.
 657          */
 658         public void set_is_public(boolean val) {
 659                 bindings.ChannelDetails_set_is_public(this.ptr, val);
 660                 Reference.reachabilityFence(this);
 661                 Reference.reachabilityFence(val);
 662         }
 663
 664         /**
 665          * The smallest value HTLC (in msat) we will accept, for this channel. This field
 666          * is only `None` for `ChannelDetails` objects serialized prior to LDK 0.0.107
 667          */
 668         public Option_u64Z get_inbound_htlc_minimum_msat() {
 669                 long ret = bindings.ChannelDetails_get_inbound_htlc_minimum_msat(this.ptr);
 670                 Reference.reachabilityFence(this);
 671                 if (ret >= 0 && ret <= 4096) { return null; }
 672                 org.ldk.structs.Option_u64Z ret_hu_conv = org.ldk.structs.Option_u64Z.constr_from_ptr(ret);
 673                 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(this); };
 674                 return ret_hu_conv;
 675         }
 676
 677         /**
 678          * The smallest value HTLC (in msat) we will accept, for this channel. This field
 679          * is only `None` for `ChannelDetails` objects serialized prior to LDK 0.0.107
 680          */
 681         public void set_inbound_htlc_minimum_msat(org.ldk.structs.Option_u64Z val) {
 682                 bindings.ChannelDetails_set_inbound_htlc_minimum_msat(this.ptr, val.ptr);
 683                 Reference.reachabilityFence(this);
 684                 Reference.reachabilityFence(val);
 685                 if (this != null) { this.ptrs_to.add(val); };
 686         }
 687
 688         /**
 689          * The largest value HTLC (in msat) we currently will accept, for this channel.
 690          */
 691         public Option_u64Z get_inbound_htlc_maximum_msat() {
 692                 long ret = bindings.ChannelDetails_get_inbound_htlc_maximum_msat(this.ptr);
 693                 Reference.reachabilityFence(this);
 694                 if (ret >= 0 && ret <= 4096) { return null; }
 695                 org.ldk.structs.Option_u64Z ret_hu_conv = org.ldk.structs.Option_u64Z.constr_from_ptr(ret);
 696                 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(this); };
 697                 return ret_hu_conv;
 698         }
 699
 700         /**
 701          * The largest value HTLC (in msat) we currently will accept, for this channel.
 702          */
 703         public void set_inbound_htlc_maximum_msat(org.ldk.structs.Option_u64Z val) {
 704                 bindings.ChannelDetails_set_inbound_htlc_maximum_msat(this.ptr, val.ptr);
 705                 Reference.reachabilityFence(this);
 706                 Reference.reachabilityFence(val);
 707                 if (this != null) { this.ptrs_to.add(val); };
 708         }
 709
 710         /**
 711          * Set of configurable parameters that affect channel operation.
 712          *
 713          * This field is only `None` for `ChannelDetails` objects serialized prior to LDK 0.0.109.
 714          *
 715          * Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
 716          */
 717         @Nullable
 718         public ChannelConfig get_config() {
 719                 long ret = bindings.ChannelDetails_get_config(this.ptr);
 720                 Reference.reachabilityFence(this);
 721                 if (ret >= 0 && ret <= 4096) { return null; }
 722                 org.ldk.structs.ChannelConfig ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new org.ldk.structs.ChannelConfig(null, ret); }
 723                 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(this); };
 724                 return ret_hu_conv;
 725         }
 726
 727         /**
 728          * Set of configurable parameters that affect channel operation.
 729          *
 730          * This field is only `None` for `ChannelDetails` objects serialized prior to LDK 0.0.109.
 731          *
 732          * Note that val (or a relevant inner pointer) may be NULL or all-0s to represent None
 733          */
 734         public void set_config(@Nullable org.ldk.structs.ChannelConfig val) {
 735                 bindings.ChannelDetails_set_config(this.ptr, val == null ? 0 : val.ptr);
 736                 Reference.reachabilityFence(this);
 737                 Reference.reachabilityFence(val);
 738                 if (this != null) { this.ptrs_to.add(val); };
 739         }
 740
 741         /**
 742          * Constructs a new ChannelDetails given each field
 743          */
 744         public static ChannelDetails of(byte[] channel_id_arg, org.ldk.structs.ChannelCounterparty counterparty_arg, org.ldk.structs.OutPoint funding_txo_arg, org.ldk.structs.ChannelTypeFeatures channel_type_arg, org.ldk.structs.Option_u64Z short_channel_id_arg, org.ldk.structs.Option_u64Z outbound_scid_alias_arg, org.ldk.structs.Option_u64Z inbound_scid_alias_arg, long channel_value_satoshis_arg, org.ldk.structs.Option_u64Z unspendable_punishment_reserve_arg, org.ldk.util.UInt128 user_channel_id_arg, long balance_msat_arg, long outbound_capacity_msat_arg, long next_outbound_htlc_limit_msat_arg, long inbound_capacity_msat_arg, org.ldk.structs.Option_u32Z confirmations_required_arg, org.ldk.structs.Option_u32Z confirmations_arg, org.ldk.structs.Option_u16Z force_close_spend_delay_arg, boolean is_outbound_arg, boolean is_channel_ready_arg, boolean is_usable_arg, boolean is_public_arg, org.ldk.structs.Option_u64Z inbound_htlc_minimum_msat_arg, org.ldk.structs.Option_u64Z inbound_htlc_maximum_msat_arg, org.ldk.structs.ChannelConfig config_arg) {
 745                 long ret = bindings.ChannelDetails_new(InternalUtils.check_arr_len(channel_id_arg, 32), counterparty_arg == null ? 0 : counterparty_arg.ptr, funding_txo_arg == null ? 0 : funding_txo_arg.ptr, channel_type_arg == null ? 0 : channel_type_arg.ptr, short_channel_id_arg.ptr, outbound_scid_alias_arg.ptr, inbound_scid_alias_arg.ptr, channel_value_satoshis_arg, unspendable_punishment_reserve_arg.ptr, user_channel_id_arg.getLEBytes(), balance_msat_arg, outbound_capacity_msat_arg, next_outbound_htlc_limit_msat_arg, inbound_capacity_msat_arg, confirmations_required_arg.ptr, confirmations_arg.ptr, force_close_spend_delay_arg.ptr, is_outbound_arg, is_channel_ready_arg, is_usable_arg, is_public_arg, inbound_htlc_minimum_msat_arg.ptr, inbound_htlc_maximum_msat_arg.ptr, config_arg == null ? 0 : config_arg.ptr);
 746                 Reference.reachabilityFence(channel_id_arg);
 747                 Reference.reachabilityFence(counterparty_arg);
 748                 Reference.reachabilityFence(funding_txo_arg);
 749                 Reference.reachabilityFence(channel_type_arg);
 750                 Reference.reachabilityFence(short_channel_id_arg);
 751                 Reference.reachabilityFence(outbound_scid_alias_arg);
 752                 Reference.reachabilityFence(inbound_scid_alias_arg);
 753                 Reference.reachabilityFence(channel_value_satoshis_arg);
 754                 Reference.reachabilityFence(unspendable_punishment_reserve_arg);
 755                 Reference.reachabilityFence(user_channel_id_arg);
 756                 Reference.reachabilityFence(balance_msat_arg);
 757                 Reference.reachabilityFence(outbound_capacity_msat_arg);
 758                 Reference.reachabilityFence(next_outbound_htlc_limit_msat_arg);
 759                 Reference.reachabilityFence(inbound_capacity_msat_arg);
 760                 Reference.reachabilityFence(confirmations_required_arg);
 761                 Reference.reachabilityFence(confirmations_arg);
 762                 Reference.reachabilityFence(force_close_spend_delay_arg);
 763                 Reference.reachabilityFence(is_outbound_arg);
 764                 Reference.reachabilityFence(is_channel_ready_arg);
 765                 Reference.reachabilityFence(is_usable_arg);
 766                 Reference.reachabilityFence(is_public_arg);
 767                 Reference.reachabilityFence(inbound_htlc_minimum_msat_arg);
 768                 Reference.reachabilityFence(inbound_htlc_maximum_msat_arg);
 769                 Reference.reachabilityFence(config_arg);
 770                 if (ret >= 0 && ret <= 4096) { return null; }
 771                 org.ldk.structs.ChannelDetails ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new org.ldk.structs.ChannelDetails(null, ret); }
 772                 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(ret_hu_conv); };
 773                 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(counterparty_arg); };
 774                 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(funding_txo_arg); };
 775                 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(channel_type_arg); };
 776                 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(short_channel_id_arg); };
 777                 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(outbound_scid_alias_arg); };
 778                 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(inbound_scid_alias_arg); };
 779                 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(unspendable_punishment_reserve_arg); };
 780                 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(confirmations_required_arg); };
 781                 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(confirmations_arg); };
 782                 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(force_close_spend_delay_arg); };
 783                 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(inbound_htlc_minimum_msat_arg); };
 784                 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(inbound_htlc_maximum_msat_arg); };
 785                 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(config_arg); };
 786                 return ret_hu_conv;
 787         }
 788
 789         long clone_ptr() {
 790                 long ret = bindings.ChannelDetails_clone_ptr(this.ptr);
 791                 Reference.reachabilityFence(this);
 792                 return ret;
 793         }
 794
 795         /**
 796          * Creates a copy of the ChannelDetails
 797          */
 798         public ChannelDetails clone() {
 799                 long ret = bindings.ChannelDetails_clone(this.ptr);
 800                 Reference.reachabilityFence(this);
 801                 if (ret >= 0 && ret <= 4096) { return null; }
 802                 org.ldk.structs.ChannelDetails ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new org.ldk.structs.ChannelDetails(null, ret); }
 803                 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(this); };
 804                 return ret_hu_conv;
 805         }
 806
 807         /**
 808          * Gets the current SCID which should be used to identify this channel for inbound payments.
 809          * This should be used for providing invoice hints or in any other context where our
 810          * counterparty will forward a payment to us.
 811          *
 812          * This is either the [`ChannelDetails::inbound_scid_alias`], if set, or the
 813          * [`ChannelDetails::short_channel_id`]. See those for more information.
 814          */
 815         public Option_u64Z get_inbound_payment_scid() {
 816                 long ret = bindings.ChannelDetails_get_inbound_payment_scid(this.ptr);
 817                 Reference.reachabilityFence(this);
 818                 if (ret >= 0 && ret <= 4096) { return null; }
 819                 org.ldk.structs.Option_u64Z ret_hu_conv = org.ldk.structs.Option_u64Z.constr_from_ptr(ret);
 820                 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(this); };
 821                 return ret_hu_conv;
 822         }
 823
 824         /**
 825          * Gets the current SCID which should be used to identify this channel for outbound payments.
 826          * This should be used in [`Route`]s to describe the first hop or in other contexts where
 827          * we're sending or forwarding a payment outbound over this channel.
 828          *
 829          * This is either the [`ChannelDetails::short_channel_id`], if set, or the
 830          * [`ChannelDetails::outbound_scid_alias`]. See those for more information.
 831          */
 832         public Option_u64Z get_outbound_payment_scid() {
 833                 long ret = bindings.ChannelDetails_get_outbound_payment_scid(this.ptr);
 834                 Reference.reachabilityFence(this);
 835                 if (ret >= 0 && ret <= 4096) { return null; }
 836                 org.ldk.structs.Option_u64Z ret_hu_conv = org.ldk.structs.Option_u64Z.constr_from_ptr(ret);
 837                 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(this); };
 838                 return ret_hu_conv;
 839         }
 840
 841         /**
 842          * Serialize the ChannelDetails object into a byte array which can be read by ChannelDetails_read
 843          */
 844         public byte[] write() {
 845                 byte[] ret = bindings.ChannelDetails_write(this.ptr);
 846                 Reference.reachabilityFence(this);
 847                 return ret;
 848         }
 849
 850         /**
 851          * Read a ChannelDetails from a byte array, created by ChannelDetails_write
 852          */
 853         public static Result_ChannelDetailsDecodeErrorZ read(byte[] ser) {
 854                 long ret = bindings.ChannelDetails_read(ser);
 855                 Reference.reachabilityFence(ser);
 856                 if (ret >= 0 && ret <= 4096) { return null; }
 857                 Result_ChannelDetailsDecodeErrorZ ret_hu_conv = Result_ChannelDetailsDecodeErrorZ.constr_from_ptr(ret);
 858                 return ret_hu_conv;
 859         }
 860
 861 }