import org.ldk.impl.bindings;
import org.ldk.enums.*;
+import org.ldk.util.*;
+import java.util.Arrays;
+
+/**
+ * Details of a channel, as returned by ChannelManager::list_channels and ChannelManager::list_usable_channels
+ */
+@SuppressWarnings("unchecked") // We correctly assign various generic arrays
public class ChannelDetails extends CommonBase {
ChannelDetails(Object _dummy, long ptr) { super(ptr); }
@Override @SuppressWarnings("deprecation")
protected void finalize() throws Throwable {
- bindings.ChannelDetails_free(ptr); super.finalize();
+ super.finalize();
+ if (ptr != 0) { bindings.ChannelDetails_free(ptr); }
+ }
+
+ /**
+ * The channel's ID (prior to funding transaction generation, this is a random 32 bytes,
+ * thereafter this is the txid of the funding transaction xor the funding transaction output).
+ * Note that this means this value is *not* persistent - it can change once during the
+ * lifetime of the channel.
+ */
+ public byte[] get_channel_id() {
+ byte[] ret = bindings.ChannelDetails_get_channel_id(this.ptr);
+ return ret;
+ }
+
+ /**
+ * The channel's ID (prior to funding transaction generation, this is a random 32 bytes,
+ * thereafter this is the txid of the funding transaction xor the funding transaction output).
+ * Note that this means this value is *not* persistent - it can change once during the
+ * lifetime of the channel.
+ */
+ public void set_channel_id(byte[] val) {
+ bindings.ChannelDetails_set_channel_id(this.ptr, val);
+ }
+
+ /**
+ * Parameters which apply to our counterparty. See individual fields for more information.
+ */
+ public ChannelCounterparty get_counterparty() {
+ long ret = bindings.ChannelDetails_get_counterparty(this.ptr);
+ ChannelCounterparty ret_hu_conv = new ChannelCounterparty(null, ret);
+ ret_hu_conv.ptrs_to.add(this);
+ return ret_hu_conv;
+ }
+
+ /**
+ * Parameters which apply to our counterparty. See individual fields for more information.
+ */
+ public void set_counterparty(ChannelCounterparty val) {
+ bindings.ChannelDetails_set_counterparty(this.ptr, val == null ? 0 : val.ptr & ~1);
+ this.ptrs_to.add(val);
+ }
+
+ /**
+ * The Channel's funding transaction output, if we've negotiated the funding transaction with
+ * our counterparty already.
+ *
+ * Note that, if this has been set, `channel_id` will be equivalent to
+ * `funding_txo.unwrap().to_channel_id()`.
+ */
+ public OutPoint get_funding_txo() {
+ long ret = bindings.ChannelDetails_get_funding_txo(this.ptr);
+ OutPoint ret_hu_conv = new OutPoint(null, ret);
+ ret_hu_conv.ptrs_to.add(this);
+ return ret_hu_conv;
+ }
+
+ /**
+ * The Channel's funding transaction output, if we've negotiated the funding transaction with
+ * our counterparty already.
+ *
+ * Note that, if this has been set, `channel_id` will be equivalent to
+ * `funding_txo.unwrap().to_channel_id()`.
+ */
+ public void set_funding_txo(OutPoint val) {
+ bindings.ChannelDetails_set_funding_txo(this.ptr, val == null ? 0 : val.ptr & ~1);
+ this.ptrs_to.add(val);
+ }
+
+ /**
+ * The position of the funding transaction in the chain. None if the funding transaction has
+ * not yet been confirmed and the channel fully opened.
+ */
+ public Option_u64Z get_short_channel_id() {
+ long ret = bindings.ChannelDetails_get_short_channel_id(this.ptr);
+ Option_u64Z ret_hu_conv = Option_u64Z.constr_from_ptr(ret);
+ ret_hu_conv.ptrs_to.add(this);
+ return ret_hu_conv;
}
- public ChannelDetails(ChannelDetails orig) {
- super(bindings.ChannelDetails_clone(orig == null ? 0 : orig.ptr & ~1));
- this.ptrs_to.add(orig);
+ /**
+ * The position of the funding transaction in the chain. None if the funding transaction has
+ * not yet been confirmed and the channel fully opened.
+ */
+ public void set_short_channel_id(Option_u64Z val) {
+ bindings.ChannelDetails_set_short_channel_id(this.ptr, val.ptr);
}
- public byte[] get_channel_id(ChannelDetails this_ptr) {
- byte[] ret = bindings.ChannelDetails_get_channel_id(this_ptr == null ? 0 : this_ptr.ptr & ~1);
- this.ptrs_to.add(this_ptr);
+ /**
+ * The value, in satoshis, of this channel as appears in the funding output
+ */
+ public long get_channel_value_satoshis() {
+ long ret = bindings.ChannelDetails_get_channel_value_satoshis(this.ptr);
return ret;
}
- public void set_channel_id(ChannelDetails this_ptr, byte[] val) {
- bindings.ChannelDetails_set_channel_id(this_ptr == null ? 0 : this_ptr.ptr & ~1, val);
- this.ptrs_to.add(this_ptr);
+ /**
+ * The value, in satoshis, of this channel as appears in the funding output
+ */
+ public void set_channel_value_satoshis(long val) {
+ bindings.ChannelDetails_set_channel_value_satoshis(this.ptr, val);
}
- public byte[] get_remote_network_id(ChannelDetails this_ptr) {
- byte[] ret = bindings.ChannelDetails_get_remote_network_id(this_ptr == null ? 0 : this_ptr.ptr & ~1);
- this.ptrs_to.add(this_ptr);
+ /**
+ * The value, in satoshis, that must always be held in the channel for us. This value ensures
+ * that if we broadcast a revoked state, our counterparty can punish us by claiming at least
+ * this value on chain.
+ *
+ * This value is not included in [`outbound_capacity_msat`] as it can never be spent.
+ *
+ * This value will be `None` for outbound channels until the counterparty accepts the channel.
+ *
+ * [`outbound_capacity_msat`]: ChannelDetails::outbound_capacity_msat
+ */
+ public Option_u64Z get_unspendable_punishment_reserve() {
+ long ret = bindings.ChannelDetails_get_unspendable_punishment_reserve(this.ptr);
+ Option_u64Z ret_hu_conv = Option_u64Z.constr_from_ptr(ret);
+ ret_hu_conv.ptrs_to.add(this);
+ return ret_hu_conv;
+ }
+
+ /**
+ * The value, in satoshis, that must always be held in the channel for us. This value ensures
+ * that if we broadcast a revoked state, our counterparty can punish us by claiming at least
+ * this value on chain.
+ *
+ * This value is not included in [`outbound_capacity_msat`] as it can never be spent.
+ *
+ * This value will be `None` for outbound channels until the counterparty accepts the channel.
+ *
+ * [`outbound_capacity_msat`]: ChannelDetails::outbound_capacity_msat
+ */
+ public void set_unspendable_punishment_reserve(Option_u64Z val) {
+ bindings.ChannelDetails_set_unspendable_punishment_reserve(this.ptr, val.ptr);
+ }
+
+ /**
+ * The user_id passed in to create_channel, or 0 if the channel was inbound.
+ */
+ public long get_user_id() {
+ long ret = bindings.ChannelDetails_get_user_id(this.ptr);
return ret;
}
- public void set_remote_network_id(ChannelDetails this_ptr, byte[] val) {
- bindings.ChannelDetails_set_remote_network_id(this_ptr == null ? 0 : this_ptr.ptr & ~1, val);
- this.ptrs_to.add(this_ptr);
+ /**
+ * The user_id passed in to create_channel, or 0 if the channel was inbound.
+ */
+ public void set_user_id(long val) {
+ bindings.ChannelDetails_set_user_id(this.ptr, val);
}
- public InitFeatures get_counterparty_features(ChannelDetails this_ptr) {
- InitFeatures ret = new InitFeatures(null, bindings.ChannelDetails_get_counterparty_features(this_ptr == null ? 0 : this_ptr.ptr & ~1));
- this.ptrs_to.add(this_ptr);
+ /**
+ * The available outbound capacity for sending HTLCs to the remote peer. This does not include
+ * any pending HTLCs which are not yet fully resolved (and, thus, who's balance is not
+ * available for inclusion in new outbound HTLCs). This further does not include any pending
+ * outgoing HTLCs which are awaiting some other resolution to be sent.
+ *
+ * This value is not exact. Due to various in-flight changes, feerate changes, and our
+ * conflict-avoidance policy, exactly this amount is not likely to be spendable. However, we
+ * should be able to spend nearly this amount.
+ */
+ public long get_outbound_capacity_msat() {
+ long ret = bindings.ChannelDetails_get_outbound_capacity_msat(this.ptr);
return ret;
}
- public void set_counterparty_features(ChannelDetails this_ptr, InitFeatures val) {
- bindings.ChannelDetails_set_counterparty_features(this_ptr == null ? 0 : this_ptr.ptr & ~1, val == null ? 0 : val.ptr & ~1);
- this.ptrs_to.add(this_ptr);
- this.ptrs_to.add(val);
+ /**
+ * The available outbound capacity for sending HTLCs to the remote peer. This does not include
+ * any pending HTLCs which are not yet fully resolved (and, thus, who's balance is not
+ * available for inclusion in new outbound HTLCs). This further does not include any pending
+ * outgoing HTLCs which are awaiting some other resolution to be sent.
+ *
+ * This value is not exact. Due to various in-flight changes, feerate changes, and our
+ * conflict-avoidance policy, exactly this amount is not likely to be spendable. However, we
+ * should be able to spend nearly this amount.
+ */
+ public void set_outbound_capacity_msat(long val) {
+ bindings.ChannelDetails_set_outbound_capacity_msat(this.ptr, val);
}
- public long get_channel_value_satoshis(ChannelDetails this_ptr) {
- long ret = bindings.ChannelDetails_get_channel_value_satoshis(this_ptr == null ? 0 : this_ptr.ptr & ~1);
- this.ptrs_to.add(this_ptr);
+ /**
+ * The available inbound capacity for the remote peer to send HTLCs to us. This does not
+ * include any pending HTLCs which are not yet fully resolved (and, thus, who's balance is not
+ * available for inclusion in new inbound HTLCs).
+ * Note that there are some corner cases not fully handled here, so the actual available
+ * inbound capacity may be slightly higher than this.
+ *
+ * This value is not exact. Due to various in-flight changes, feerate changes, and our
+ * counterparty's conflict-avoidance policy, exactly this amount is not likely to be spendable.
+ * However, our counterparty should be able to spend nearly this amount.
+ */
+ public long get_inbound_capacity_msat() {
+ long ret = bindings.ChannelDetails_get_inbound_capacity_msat(this.ptr);
return ret;
}
- public void set_channel_value_satoshis(ChannelDetails this_ptr, long val) {
- bindings.ChannelDetails_set_channel_value_satoshis(this_ptr == null ? 0 : this_ptr.ptr & ~1, val);
- this.ptrs_to.add(this_ptr);
+ /**
+ * The available inbound capacity for the remote peer to send HTLCs to us. This does not
+ * include any pending HTLCs which are not yet fully resolved (and, thus, who's balance is not
+ * available for inclusion in new inbound HTLCs).
+ * Note that there are some corner cases not fully handled here, so the actual available
+ * inbound capacity may be slightly higher than this.
+ *
+ * This value is not exact. Due to various in-flight changes, feerate changes, and our
+ * counterparty's conflict-avoidance policy, exactly this amount is not likely to be spendable.
+ * However, our counterparty should be able to spend nearly this amount.
+ */
+ public void set_inbound_capacity_msat(long val) {
+ bindings.ChannelDetails_set_inbound_capacity_msat(this.ptr, val);
+ }
+
+ /**
+ * The number of required confirmations on the funding transaction before the funding will be
+ * considered \"locked\". This number is selected by the channel fundee (i.e. us if
+ * [`is_outbound`] is *not* set), and can be selected for inbound channels with
+ * [`ChannelHandshakeConfig::minimum_depth`] or limited for outbound channels with
+ * [`ChannelHandshakeLimits::max_minimum_depth`].
+ *
+ * This value will be `None` for outbound channels until the counterparty accepts the channel.
+ *
+ * [`is_outbound`]: ChannelDetails::is_outbound
+ * [`ChannelHandshakeConfig::minimum_depth`]: crate::util::config::ChannelHandshakeConfig::minimum_depth
+ * [`ChannelHandshakeLimits::max_minimum_depth`]: crate::util::config::ChannelHandshakeLimits::max_minimum_depth
+ */
+ public Option_u32Z get_confirmations_required() {
+ long ret = bindings.ChannelDetails_get_confirmations_required(this.ptr);
+ Option_u32Z ret_hu_conv = Option_u32Z.constr_from_ptr(ret);
+ ret_hu_conv.ptrs_to.add(this);
+ return ret_hu_conv;
+ }
+
+ /**
+ * The number of required confirmations on the funding transaction before the funding will be
+ * considered \"locked\". This number is selected by the channel fundee (i.e. us if
+ * [`is_outbound`] is *not* set), and can be selected for inbound channels with
+ * [`ChannelHandshakeConfig::minimum_depth`] or limited for outbound channels with
+ * [`ChannelHandshakeLimits::max_minimum_depth`].
+ *
+ * This value will be `None` for outbound channels until the counterparty accepts the channel.
+ *
+ * [`is_outbound`]: ChannelDetails::is_outbound
+ * [`ChannelHandshakeConfig::minimum_depth`]: crate::util::config::ChannelHandshakeConfig::minimum_depth
+ * [`ChannelHandshakeLimits::max_minimum_depth`]: crate::util::config::ChannelHandshakeLimits::max_minimum_depth
+ */
+ public void set_confirmations_required(Option_u32Z val) {
+ bindings.ChannelDetails_set_confirmations_required(this.ptr, val.ptr);
}
- public long get_user_id(ChannelDetails this_ptr) {
- long ret = bindings.ChannelDetails_get_user_id(this_ptr == null ? 0 : this_ptr.ptr & ~1);
- this.ptrs_to.add(this_ptr);
+ /**
+ * The number of blocks (after our commitment transaction confirms) that we will need to wait
+ * until we can claim our funds after we force-close the channel. During this time our
+ * counterparty is allowed to punish us if we broadcasted a stale state. If our counterparty
+ * force-closes the channel and broadcasts a commitment transaction we do not have to wait any
+ * time to claim our non-HTLC-encumbered funds.
+ *
+ * This value will be `None` for outbound channels until the counterparty accepts the channel.
+ */
+ public Option_u16Z get_force_close_spend_delay() {
+ long ret = bindings.ChannelDetails_get_force_close_spend_delay(this.ptr);
+ Option_u16Z ret_hu_conv = Option_u16Z.constr_from_ptr(ret);
+ ret_hu_conv.ptrs_to.add(this);
+ return ret_hu_conv;
+ }
+
+ /**
+ * The number of blocks (after our commitment transaction confirms) that we will need to wait
+ * until we can claim our funds after we force-close the channel. During this time our
+ * counterparty is allowed to punish us if we broadcasted a stale state. If our counterparty
+ * force-closes the channel and broadcasts a commitment transaction we do not have to wait any
+ * time to claim our non-HTLC-encumbered funds.
+ *
+ * This value will be `None` for outbound channels until the counterparty accepts the channel.
+ */
+ public void set_force_close_spend_delay(Option_u16Z val) {
+ bindings.ChannelDetails_set_force_close_spend_delay(this.ptr, val.ptr);
+ }
+
+ /**
+ * True if the channel was initiated (and thus funded) by us.
+ */
+ public boolean get_is_outbound() {
+ boolean ret = bindings.ChannelDetails_get_is_outbound(this.ptr);
return ret;
}
- public void set_user_id(ChannelDetails this_ptr, long val) {
- bindings.ChannelDetails_set_user_id(this_ptr == null ? 0 : this_ptr.ptr & ~1, val);
- this.ptrs_to.add(this_ptr);
+ /**
+ * True if the channel was initiated (and thus funded) by us.
+ */
+ public void set_is_outbound(boolean val) {
+ bindings.ChannelDetails_set_is_outbound(this.ptr, val);
}
- public long get_outbound_capacity_msat(ChannelDetails this_ptr) {
- long ret = bindings.ChannelDetails_get_outbound_capacity_msat(this_ptr == null ? 0 : this_ptr.ptr & ~1);
- this.ptrs_to.add(this_ptr);
+ /**
+ * True if the channel is confirmed, funding_locked messages have been exchanged, and the
+ * channel is not currently being shut down. `funding_locked` message exchange implies the
+ * required confirmation count has been reached (and we were connected to the peer at some
+ * point after the funding transaction received enough confirmations). The required
+ * confirmation count is provided in [`confirmations_required`].
+ *
+ * [`confirmations_required`]: ChannelDetails::confirmations_required
+ */
+ public boolean get_is_funding_locked() {
+ boolean ret = bindings.ChannelDetails_get_is_funding_locked(this.ptr);
return ret;
}
- public void set_outbound_capacity_msat(ChannelDetails this_ptr, long val) {
- bindings.ChannelDetails_set_outbound_capacity_msat(this_ptr == null ? 0 : this_ptr.ptr & ~1, val);
- this.ptrs_to.add(this_ptr);
+ /**
+ * True if the channel is confirmed, funding_locked messages have been exchanged, and the
+ * channel is not currently being shut down. `funding_locked` message exchange implies the
+ * required confirmation count has been reached (and we were connected to the peer at some
+ * point after the funding transaction received enough confirmations). The required
+ * confirmation count is provided in [`confirmations_required`].
+ *
+ * [`confirmations_required`]: ChannelDetails::confirmations_required
+ */
+ public void set_is_funding_locked(boolean val) {
+ bindings.ChannelDetails_set_is_funding_locked(this.ptr, val);
}
- public long get_inbound_capacity_msat(ChannelDetails this_ptr) {
- long ret = bindings.ChannelDetails_get_inbound_capacity_msat(this_ptr == null ? 0 : this_ptr.ptr & ~1);
- this.ptrs_to.add(this_ptr);
+ /**
+ * True if the channel is (a) confirmed and funding_locked messages have been exchanged, (b)
+ * the peer is connected, and (c) the channel is not currently negotiating a shutdown.
+ *
+ * This is a strict superset of `is_funding_locked`.
+ */
+ public boolean get_is_usable() {
+ boolean ret = bindings.ChannelDetails_get_is_usable(this.ptr);
return ret;
}
- public void set_inbound_capacity_msat(ChannelDetails this_ptr, long val) {
- bindings.ChannelDetails_set_inbound_capacity_msat(this_ptr == null ? 0 : this_ptr.ptr & ~1, val);
- this.ptrs_to.add(this_ptr);
+ /**
+ * True if the channel is (a) confirmed and funding_locked messages have been exchanged, (b)
+ * the peer is connected, and (c) the channel is not currently negotiating a shutdown.
+ *
+ * This is a strict superset of `is_funding_locked`.
+ */
+ public void set_is_usable(boolean val) {
+ bindings.ChannelDetails_set_is_usable(this.ptr, val);
}
- public boolean get_is_live(ChannelDetails this_ptr) {
- boolean ret = bindings.ChannelDetails_get_is_live(this_ptr == null ? 0 : this_ptr.ptr & ~1);
- this.ptrs_to.add(this_ptr);
+ /**
+ * True if this channel is (or will be) publicly-announced.
+ */
+ public boolean get_is_public() {
+ boolean ret = bindings.ChannelDetails_get_is_public(this.ptr);
return ret;
}
- public void set_is_live(ChannelDetails this_ptr, boolean val) {
- bindings.ChannelDetails_set_is_live(this_ptr == null ? 0 : this_ptr.ptr & ~1, val);
- this.ptrs_to.add(this_ptr);
+ /**
+ * True if this channel is (or will be) publicly-announced.
+ */
+ public void set_is_public(boolean val) {
+ bindings.ChannelDetails_set_is_public(this.ptr, val);
+ }
+
+ /**
+ * Constructs a new ChannelDetails given each field
+ */
+ public static ChannelDetails of(byte[] channel_id_arg, ChannelCounterparty counterparty_arg, OutPoint funding_txo_arg, Option_u64Z short_channel_id_arg, long channel_value_satoshis_arg, Option_u64Z unspendable_punishment_reserve_arg, long user_id_arg, long outbound_capacity_msat_arg, long inbound_capacity_msat_arg, Option_u32Z confirmations_required_arg, Option_u16Z force_close_spend_delay_arg, boolean is_outbound_arg, boolean is_funding_locked_arg, boolean is_usable_arg, boolean is_public_arg) {
+ long ret = bindings.ChannelDetails_new(channel_id_arg, counterparty_arg == null ? 0 : counterparty_arg.ptr & ~1, funding_txo_arg == null ? 0 : funding_txo_arg.ptr & ~1, short_channel_id_arg.ptr, channel_value_satoshis_arg, unspendable_punishment_reserve_arg.ptr, user_id_arg, outbound_capacity_msat_arg, inbound_capacity_msat_arg, confirmations_required_arg.ptr, force_close_spend_delay_arg.ptr, is_outbound_arg, is_funding_locked_arg, is_usable_arg, is_public_arg);
+ ChannelDetails ret_hu_conv = new ChannelDetails(null, ret);
+ ret_hu_conv.ptrs_to.add(ret_hu_conv);
+ ret_hu_conv.ptrs_to.add(counterparty_arg);
+ ret_hu_conv.ptrs_to.add(funding_txo_arg);
+ return ret_hu_conv;
+ }
+
+ /**
+ * Creates a copy of the ChannelDetails
+ */
+ public ChannelDetails clone() {
+ long ret = bindings.ChannelDetails_clone(this.ptr);
+ ChannelDetails ret_hu_conv = new ChannelDetails(null, ret);
+ ret_hu_conv.ptrs_to.add(this);
+ return ret_hu_conv;
}
}
projects / ldk-java / blobdiff