Package org.ldk.structs
Class ChannelDetails
- java.lang.Object
-
- org.ldk.structs.ChannelDetails
-
public class ChannelDetails extends Object
Details of a channel, as returned by [`ChannelManager::list_channels`] and [`ChannelManager::list_usable_channels`]
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description ChannelDetails
clone()
Creates a copy of the ChannelDetailsprotected void
finalize()
long
get_balance_msat()
Our total balance.byte[]
get_channel_id()
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).ChannelTypeFeatures
get_channel_type()
The features which this channel operates with.long
get_channel_value_satoshis()
The value, in satoshis, of this channel as appears in the funding outputChannelConfig
get_config()
Set of configurable parameters that affect channel operation.Option_u32Z
get_confirmations()
The current number of confirmations on the funding transaction.Option_u32Z
get_confirmations_required()
The number of required confirmations on the funding transaction before the funding will be considered \"locked\".ChannelCounterparty
get_counterparty()
Parameters which apply to our counterparty.Option_u32Z
get_feerate_sat_per_1000_weight()
The currently negotiated fee rate denominated in satoshi per 1000 weight units, which is applied to commitment and HTLC transactions.Option_u16Z
get_force_close_spend_delay()
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.OutPoint
get_funding_txo()
The Channel's funding transaction output, if we've negotiated the funding transaction with our counterparty already.long
get_inbound_capacity_msat()
The available inbound capacity for the remote peer to send HTLCs to us.Option_u64Z
get_inbound_htlc_maximum_msat()
The largest value HTLC (in msat) we currently will accept, for this channel.Option_u64Z
get_inbound_htlc_minimum_msat()
The smallest value HTLC (in msat) we will accept, for this channel.Option_u64Z
get_inbound_payment_scid()
Gets the current SCID which should be used to identify this channel for inbound payments.Option_u64Z
get_inbound_scid_alias()
An optional [`short_channel_id`] alias for this channel, randomly generated by our counterparty and usable in place of [`short_channel_id`] in invoice route hints.boolean
get_is_channel_ready()
True if the channel is confirmed, channel_ready messages have been exchanged, and the channel is not currently being shut down.boolean
get_is_outbound()
True if the channel was initiated (and thus funded) by us.boolean
get_is_public()
True if this channel is (or will be) publicly-announced.boolean
get_is_usable()
True if the channel is (a) confirmed and channel_ready messages have been exchanged, (b) the peer is connected, and (c) the channel is not currently negotiating a shutdown.long
get_next_outbound_htlc_limit_msat()
The available outbound capacity for sending a single HTLC to the remote peer.long
get_outbound_capacity_msat()
The available outbound capacity for sending HTLCs to the remote peer.Option_u64Z
get_outbound_payment_scid()
Gets the current SCID which should be used to identify this channel for outbound payments.Option_u64Z
get_outbound_scid_alias()
An optional [`short_channel_id`] alias for this channel, randomly generated by us and usable in place of [`short_channel_id`] to reference the channel in outbound routes when the channel has not yet been confirmed (as long as [`confirmations_required`] is `Some(0)`).Option_u64Z
get_short_channel_id()
The position of the funding transaction in the chain.Option_u64Z
get_unspendable_punishment_reserve()
The value, in satoshis, that must always be held in the channel for us.UInt128
get_user_channel_id()
The `user_channel_id` passed in to create_channel, or a random value if the channel was inbound.static ChannelDetails
of(byte[] channel_id_arg, ChannelCounterparty counterparty_arg, OutPoint funding_txo_arg, ChannelTypeFeatures channel_type_arg, Option_u64Z short_channel_id_arg, Option_u64Z outbound_scid_alias_arg, Option_u64Z inbound_scid_alias_arg, long channel_value_satoshis_arg, Option_u64Z unspendable_punishment_reserve_arg, UInt128 user_channel_id_arg, Option_u32Z feerate_sat_per_1000_weight_arg, long balance_msat_arg, long outbound_capacity_msat_arg, long next_outbound_htlc_limit_msat_arg, long inbound_capacity_msat_arg, Option_u32Z confirmations_required_arg, Option_u32Z confirmations_arg, Option_u16Z force_close_spend_delay_arg, boolean is_outbound_arg, boolean is_channel_ready_arg, boolean is_usable_arg, boolean is_public_arg, Option_u64Z inbound_htlc_minimum_msat_arg, Option_u64Z inbound_htlc_maximum_msat_arg, ChannelConfig config_arg)
Constructs a new ChannelDetails given each fieldstatic Result_ChannelDetailsDecodeErrorZ
read(byte[] ser)
Read a ChannelDetails from a byte array, created by ChannelDetails_writevoid
set_balance_msat(long val)
Our total balance.void
set_channel_id(byte[] val)
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).void
set_channel_type(ChannelTypeFeatures val)
The features which this channel operates with.void
set_channel_value_satoshis(long val)
The value, in satoshis, of this channel as appears in the funding outputvoid
set_config(ChannelConfig val)
Set of configurable parameters that affect channel operation.void
set_confirmations(Option_u32Z val)
The current number of confirmations on the funding transaction.void
set_confirmations_required(Option_u32Z val)
The number of required confirmations on the funding transaction before the funding will be considered \"locked\".void
set_counterparty(ChannelCounterparty val)
Parameters which apply to our counterparty.void
set_feerate_sat_per_1000_weight(Option_u32Z val)
The currently negotiated fee rate denominated in satoshi per 1000 weight units, which is applied to commitment and HTLC transactions.void
set_force_close_spend_delay(Option_u16Z val)
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.void
set_funding_txo(OutPoint val)
The Channel's funding transaction output, if we've negotiated the funding transaction with our counterparty already.void
set_inbound_capacity_msat(long val)
The available inbound capacity for the remote peer to send HTLCs to us.void
set_inbound_htlc_maximum_msat(Option_u64Z val)
The largest value HTLC (in msat) we currently will accept, for this channel.void
set_inbound_htlc_minimum_msat(Option_u64Z val)
The smallest value HTLC (in msat) we will accept, for this channel.void
set_inbound_scid_alias(Option_u64Z val)
An optional [`short_channel_id`] alias for this channel, randomly generated by our counterparty and usable in place of [`short_channel_id`] in invoice route hints.void
set_is_channel_ready(boolean val)
True if the channel is confirmed, channel_ready messages have been exchanged, and the channel is not currently being shut down.void
set_is_outbound(boolean val)
True if the channel was initiated (and thus funded) by us.void
set_is_public(boolean val)
True if this channel is (or will be) publicly-announced.void
set_is_usable(boolean val)
True if the channel is (a) confirmed and channel_ready messages have been exchanged, (b) the peer is connected, and (c) the channel is not currently negotiating a shutdown.void
set_next_outbound_htlc_limit_msat(long val)
The available outbound capacity for sending a single HTLC to the remote peer.void
set_outbound_capacity_msat(long val)
The available outbound capacity for sending HTLCs to the remote peer.void
set_outbound_scid_alias(Option_u64Z val)
An optional [`short_channel_id`] alias for this channel, randomly generated by us and usable in place of [`short_channel_id`] to reference the channel in outbound routes when the channel has not yet been confirmed (as long as [`confirmations_required`] is `Some(0)`).void
set_short_channel_id(Option_u64Z val)
The position of the funding transaction in the chain.void
set_unspendable_punishment_reserve(Option_u64Z val)
The value, in satoshis, that must always be held in the channel for us.void
set_user_channel_id(UInt128 val)
The `user_channel_id` passed in to create_channel, or a random value if the channel was inbound.byte[]
write()
Serialize the ChannelDetails object into a byte array which can be read by ChannelDetails_read
-
-
-
Method Detail
-
finalize
protected void finalize() throws Throwable
-
get_channel_id
public byte[] get_channel_id()
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.
-
set_channel_id
public void set_channel_id(byte[] val)
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.
-
get_counterparty
public ChannelCounterparty get_counterparty()
Parameters which apply to our counterparty. See individual fields for more information.
-
set_counterparty
public void set_counterparty(ChannelCounterparty val)
Parameters which apply to our counterparty. See individual fields for more information.
-
get_funding_txo
@Nullable public OutPoint get_funding_txo()
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()`. Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
-
set_funding_txo
public void set_funding_txo(@Nullable OutPoint 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()`. Note that val (or a relevant inner pointer) may be NULL or all-0s to represent None
-
get_channel_type
@Nullable public ChannelTypeFeatures get_channel_type()
The features which this channel operates with. See individual features for more info. `None` until negotiation completes and the channel type is finalized. Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
-
set_channel_type
public void set_channel_type(@Nullable ChannelTypeFeatures val)
The features which this channel operates with. See individual features for more info. `None` until negotiation completes and the channel type is finalized. Note that val (or a relevant inner pointer) may be NULL or all-0s to represent None
-
get_short_channel_id
public Option_u64Z get_short_channel_id()
The position of the funding transaction in the chain. None if the funding transaction has not yet been confirmed and the channel fully opened. Note that if [`inbound_scid_alias`] is set, it must be used for invoices and inbound payments instead of this. See [`get_inbound_payment_scid`]. For channels with [`confirmations_required`] set to `Some(0)`, [`outbound_scid_alias`] may be used in place of this in outbound routes. See [`get_outbound_payment_scid`]. [`inbound_scid_alias`]: Self::inbound_scid_alias [`outbound_scid_alias`]: Self::outbound_scid_alias [`get_inbound_payment_scid`]: Self::get_inbound_payment_scid [`get_outbound_payment_scid`]: Self::get_outbound_payment_scid [`confirmations_required`]: Self::confirmations_required
-
set_short_channel_id
public void set_short_channel_id(Option_u64Z 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. Note that if [`inbound_scid_alias`] is set, it must be used for invoices and inbound payments instead of this. See [`get_inbound_payment_scid`]. For channels with [`confirmations_required`] set to `Some(0)`, [`outbound_scid_alias`] may be used in place of this in outbound routes. See [`get_outbound_payment_scid`]. [`inbound_scid_alias`]: Self::inbound_scid_alias [`outbound_scid_alias`]: Self::outbound_scid_alias [`get_inbound_payment_scid`]: Self::get_inbound_payment_scid [`get_outbound_payment_scid`]: Self::get_outbound_payment_scid [`confirmations_required`]: Self::confirmations_required
-
get_outbound_scid_alias
public Option_u64Z get_outbound_scid_alias()
An optional [`short_channel_id`] alias for this channel, randomly generated by us and usable in place of [`short_channel_id`] to reference the channel in outbound routes when the channel has not yet been confirmed (as long as [`confirmations_required`] is `Some(0)`). This will be `None` as long as the channel is not available for routing outbound payments. [`short_channel_id`]: Self::short_channel_id [`confirmations_required`]: Self::confirmations_required
-
set_outbound_scid_alias
public void set_outbound_scid_alias(Option_u64Z val)
An optional [`short_channel_id`] alias for this channel, randomly generated by us and usable in place of [`short_channel_id`] to reference the channel in outbound routes when the channel has not yet been confirmed (as long as [`confirmations_required`] is `Some(0)`). This will be `None` as long as the channel is not available for routing outbound payments. [`short_channel_id`]: Self::short_channel_id [`confirmations_required`]: Self::confirmations_required
-
get_inbound_scid_alias
public Option_u64Z get_inbound_scid_alias()
An optional [`short_channel_id`] alias for this channel, randomly generated by our counterparty and usable in place of [`short_channel_id`] in invoice route hints. Our counterparty will recognize the alias provided here in place of the [`short_channel_id`] when they see a payment to be routed to us. Our counterparty may choose to rotate this value at any time, though will always recognize previous values for inbound payment forwarding. [`short_channel_id`]: Self::short_channel_id
-
set_inbound_scid_alias
public void set_inbound_scid_alias(Option_u64Z val)
An optional [`short_channel_id`] alias for this channel, randomly generated by our counterparty and usable in place of [`short_channel_id`] in invoice route hints. Our counterparty will recognize the alias provided here in place of the [`short_channel_id`] when they see a payment to be routed to us. Our counterparty may choose to rotate this value at any time, though will always recognize previous values for inbound payment forwarding. [`short_channel_id`]: Self::short_channel_id
-
get_channel_value_satoshis
public long get_channel_value_satoshis()
The value, in satoshis, of this channel as appears in the funding output
-
set_channel_value_satoshis
public void set_channel_value_satoshis(long val)
The value, in satoshis, of this channel as appears in the funding output
-
get_unspendable_punishment_reserve
public Option_u64Z get_unspendable_punishment_reserve()
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
-
set_unspendable_punishment_reserve
public void set_unspendable_punishment_reserve(Option_u64Z val)
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
-
get_user_channel_id
public UInt128 get_user_channel_id()
The `user_channel_id` passed in to create_channel, or a random value if the channel was inbound. This may be zero for inbound channels serialized with LDK versions prior to 0.0.113.
-
set_user_channel_id
public void set_user_channel_id(UInt128 val)
The `user_channel_id` passed in to create_channel, or a random value if the channel was inbound. This may be zero for inbound channels serialized with LDK versions prior to 0.0.113.
-
get_feerate_sat_per_1000_weight
public Option_u32Z get_feerate_sat_per_1000_weight()
The currently negotiated fee rate denominated in satoshi per 1000 weight units, which is applied to commitment and HTLC transactions. This value will be `None` for objects serialized with LDK versions prior to 0.0.115.
-
set_feerate_sat_per_1000_weight
public void set_feerate_sat_per_1000_weight(Option_u32Z val)
The currently negotiated fee rate denominated in satoshi per 1000 weight units, which is applied to commitment and HTLC transactions. This value will be `None` for objects serialized with LDK versions prior to 0.0.115.
-
get_balance_msat
public long get_balance_msat()
Our total balance. This is the amount we would get if we close the channel. This value is not exact. Due to various in-flight changes and feerate changes, exactly this amount is not likely to be recoverable on close. This does not include any pending HTLCs which are not yet fully resolved (and, thus, whose 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 does not consider any on-chain fees. See also [`ChannelDetails::outbound_capacity_msat`]
-
set_balance_msat
public void set_balance_msat(long val)
Our total balance. This is the amount we would get if we close the channel. This value is not exact. Due to various in-flight changes and feerate changes, exactly this amount is not likely to be recoverable on close. This does not include any pending HTLCs which are not yet fully resolved (and, thus, whose 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 does not consider any on-chain fees. See also [`ChannelDetails::outbound_capacity_msat`]
-
get_outbound_capacity_msat
public long get_outbound_capacity_msat()
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, whose 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. See also [`ChannelDetails::balance_msat`] 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.
-
set_outbound_capacity_msat
public void set_outbound_capacity_msat(long 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, whose 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. See also [`ChannelDetails::balance_msat`] 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.
-
get_next_outbound_htlc_limit_msat
public long get_next_outbound_htlc_limit_msat()
The available outbound capacity for sending a single HTLC to the remote peer. This is similar to [`ChannelDetails::outbound_capacity_msat`] but it may be further restricted by the current state and per-HTLC limit(s). This is intended for use when routing, allowing us to use a limit as close as possible to the HTLC limit we can currently send. See also [`ChannelDetails::balance_msat`] and [`ChannelDetails::outbound_capacity_msat`].
-
set_next_outbound_htlc_limit_msat
public void set_next_outbound_htlc_limit_msat(long val)
The available outbound capacity for sending a single HTLC to the remote peer. This is similar to [`ChannelDetails::outbound_capacity_msat`] but it may be further restricted by the current state and per-HTLC limit(s). This is intended for use when routing, allowing us to use a limit as close as possible to the HTLC limit we can currently send. See also [`ChannelDetails::balance_msat`] and [`ChannelDetails::outbound_capacity_msat`].
-
get_inbound_capacity_msat
public long get_inbound_capacity_msat()
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, whose 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.
-
set_inbound_capacity_msat
public void set_inbound_capacity_msat(long val)
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, whose 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.
-
get_confirmations_required
public Option_u32Z get_confirmations_required()
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
-
set_confirmations_required
public void set_confirmations_required(Option_u32Z 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
-
get_confirmations
public Option_u32Z get_confirmations()
The current number of confirmations on the funding transaction. This value will be `None` for objects serialized with LDK versions prior to 0.0.113.
-
set_confirmations
public void set_confirmations(Option_u32Z val)
The current number of confirmations on the funding transaction. This value will be `None` for objects serialized with LDK versions prior to 0.0.113.
-
get_force_close_spend_delay
public Option_u16Z get_force_close_spend_delay()
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.
-
set_force_close_spend_delay
public void set_force_close_spend_delay(Option_u16Z val)
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.
-
get_is_outbound
public boolean get_is_outbound()
True if the channel was initiated (and thus funded) by us.
-
set_is_outbound
public void set_is_outbound(boolean val)
True if the channel was initiated (and thus funded) by us.
-
get_is_channel_ready
public boolean get_is_channel_ready()
True if the channel is confirmed, channel_ready messages have been exchanged, and the channel is not currently being shut down. `channel_ready` 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
-
set_is_channel_ready
public void set_is_channel_ready(boolean val)
True if the channel is confirmed, channel_ready messages have been exchanged, and the channel is not currently being shut down. `channel_ready` 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
-
get_is_usable
public boolean get_is_usable()
True if the channel is (a) confirmed and channel_ready 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_channel_ready`.
-
set_is_usable
public void set_is_usable(boolean val)
True if the channel is (a) confirmed and channel_ready 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_channel_ready`.
-
get_is_public
public boolean get_is_public()
True if this channel is (or will be) publicly-announced.
-
set_is_public
public void set_is_public(boolean val)
True if this channel is (or will be) publicly-announced.
-
get_inbound_htlc_minimum_msat
public Option_u64Z get_inbound_htlc_minimum_msat()
The smallest value HTLC (in msat) we will accept, for this channel. This field is only `None` for `ChannelDetails` objects serialized prior to LDK 0.0.107
-
set_inbound_htlc_minimum_msat
public void set_inbound_htlc_minimum_msat(Option_u64Z val)
The smallest value HTLC (in msat) we will accept, for this channel. This field is only `None` for `ChannelDetails` objects serialized prior to LDK 0.0.107
-
get_inbound_htlc_maximum_msat
public Option_u64Z get_inbound_htlc_maximum_msat()
The largest value HTLC (in msat) we currently will accept, for this channel.
-
set_inbound_htlc_maximum_msat
public void set_inbound_htlc_maximum_msat(Option_u64Z val)
The largest value HTLC (in msat) we currently will accept, for this channel.
-
get_config
@Nullable public ChannelConfig get_config()
Set of configurable parameters that affect channel operation. This field is only `None` for `ChannelDetails` objects serialized prior to LDK 0.0.109. Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
-
set_config
public void set_config(@Nullable ChannelConfig val)
Set of configurable parameters that affect channel operation. This field is only `None` for `ChannelDetails` objects serialized prior to LDK 0.0.109. Note that val (or a relevant inner pointer) may be NULL or all-0s to represent None
-
of
public static ChannelDetails of(byte[] channel_id_arg, ChannelCounterparty counterparty_arg, OutPoint funding_txo_arg, ChannelTypeFeatures channel_type_arg, Option_u64Z short_channel_id_arg, Option_u64Z outbound_scid_alias_arg, Option_u64Z inbound_scid_alias_arg, long channel_value_satoshis_arg, Option_u64Z unspendable_punishment_reserve_arg, UInt128 user_channel_id_arg, Option_u32Z feerate_sat_per_1000_weight_arg, long balance_msat_arg, long outbound_capacity_msat_arg, long next_outbound_htlc_limit_msat_arg, long inbound_capacity_msat_arg, Option_u32Z confirmations_required_arg, Option_u32Z confirmations_arg, Option_u16Z force_close_spend_delay_arg, boolean is_outbound_arg, boolean is_channel_ready_arg, boolean is_usable_arg, boolean is_public_arg, Option_u64Z inbound_htlc_minimum_msat_arg, Option_u64Z inbound_htlc_maximum_msat_arg, ChannelConfig config_arg)
Constructs a new ChannelDetails given each field
-
clone
public ChannelDetails clone()
Creates a copy of the ChannelDetails
-
get_inbound_payment_scid
public Option_u64Z get_inbound_payment_scid()
Gets the current SCID which should be used to identify this channel for inbound payments. This should be used for providing invoice hints or in any other context where our counterparty will forward a payment to us. This is either the [`ChannelDetails::inbound_scid_alias`], if set, or the [`ChannelDetails::short_channel_id`]. See those for more information.
-
get_outbound_payment_scid
public Option_u64Z get_outbound_payment_scid()
Gets the current SCID which should be used to identify this channel for outbound payments. This should be used in [`Route`]s to describe the first hop or in other contexts where we're sending or forwarding a payment outbound over this channel. This is either the [`ChannelDetails::short_channel_id`], if set, or the [`ChannelDetails::outbound_scid_alias`]. See those for more information.
-
write
public byte[] write()
Serialize the ChannelDetails object into a byte array which can be read by ChannelDetails_read
-
read
public static Result_ChannelDetailsDecodeErrorZ read(byte[] ser)
Read a ChannelDetails from a byte array, created by ChannelDetails_write
-
-