Struct breez_sdk_core::lightning::util::config::ChannelConfig
pub struct ChannelConfig {
pub forwarding_fee_proportional_millionths: u32,
pub forwarding_fee_base_msat: u32,
pub cltv_expiry_delta: u16,
pub max_dust_htlc_exposure: MaxDustHTLCExposure,
pub force_close_avoidance_max_fee_satoshis: u64,
pub accept_underpaying_htlcs: bool,
}
Expand description
Options which apply on a per-channel basis and may change at runtime or based on negotiation with our counterparty.
Fields§
§forwarding_fee_proportional_millionths: u32
Amount (in millionths of a satoshi) charged per satoshi for payments forwarded outbound over the channel. This may be allowed to change at runtime in a later update, however doing so must result in update messages sent to notify all nodes of our updated relay fee.
Default value: 0.
forwarding_fee_base_msat: u32
Amount (in milli-satoshi) charged for payments forwarded outbound over the channel, in
excess of forwarding_fee_proportional_millionths
.
This may be allowed to change at runtime in a later update, however doing so must result in
update messages sent to notify all nodes of our updated relay fee.
The default value of a single satoshi roughly matches the market rate on many routing nodes as of July 2021. Adjusting it upwards or downwards may change whether nodes route through this node.
Default value: 1000.
cltv_expiry_delta: u16
The difference in the CLTV value between incoming HTLCs and an outbound HTLC forwarded over the channel this config applies to.
This is analogous to ChannelHandshakeConfig::our_to_self_delay
but applies to in-flight
HTLC balance when a channel appears on-chain whereas
ChannelHandshakeConfig::our_to_self_delay
applies to the remaining
(non-HTLC-encumbered) balance.
Thus, for HTLC-encumbered balances to be enforced on-chain when a channel is force-closed, we (or one of our watchtowers) MUST be online to check for broadcast of the current commitment transaction at least once per this many blocks (minus some margin to allow us enough time to broadcast and confirm a transaction, possibly with time in between to RBF the spending transaction).
Default value: 72 (12 hours at an average of 6 blocks/hour).
Minimum value: MIN_CLTV_EXPIRY_DELTA
, any values less than this will be treated as
MIN_CLTV_EXPIRY_DELTA
instead.
max_dust_htlc_exposure: MaxDustHTLCExposure
Limit our total exposure to in-flight HTLCs which are burned to fees as they are too small to claim on-chain.
When an HTLC present in one of our channels is below a “dust” threshold, the HTLC will not be claimable on-chain, instead being turned into additional miner fees if either party force-closes the channel. Because the threshold is per-HTLC, our total exposure to such payments may be sustantial if there are many dust HTLCs present when the channel is force-closed.
The dust threshold for each HTLC is based on the dust_limit_satoshis
for each party in a
channel negotiated throughout the channel open process, along with the fees required to have
a broadcastable HTLC spending transaction. When a channel supports anchor outputs
(specifically the zero fee HTLC transaction variant), this threshold no longer takes into
account the HTLC transaction fee as it is zero. Because of this, you may want to set this
value to a fixed limit for channels using anchor outputs, while the fee rate multiplier
variant is primarily intended for use with pre-anchor channels.
The selected limit is applied for sent, forwarded, and received HTLCs and limits the total exposure across all three types per-channel.
Default value: MaxDustHTLCExposure::FeeRateMultiplier
with a multiplier of 5000.
force_close_avoidance_max_fee_satoshis: u64
The additional fee we’re willing to pay to avoid waiting for the counterparty’s
to_self_delay
to reclaim funds.
When we close a channel cooperatively with our counterparty, we negotiate a fee for the closing transaction which both sides find acceptable, ultimately paid by the channel funder/initiator.
When we are the funder, because we have to pay the channel closing fee, we bound the
acceptable fee by our ChannelCloseMinimum
and NonAnchorChannelFee
fees, with the upper bound increased by
this value. Because the on-chain fee we’d pay to force-close the channel is kept near our
NonAnchorChannelFee
feerate during normal operation, this value represents the additional fee we’re
willing to pay in order to avoid waiting for our counterparty’s to_self_delay to reclaim our
funds.
When we are not the funder, we require the closing transaction fee pay at least our
ChannelCloseMinimum
fee estimate, but allow our counterparty to pay as much fee as they like.
Thus, this value is ignored when we are not the funder.
Default value: 1000 satoshis.
accept_underpaying_htlcs: bool
If set, allows this channel’s counterparty to skim an additional fee off this node’s inbound HTLCs. Useful for liquidity providers to offload on-chain channel costs to end users.
Usage:
- The payee will set this option and set its invoice route hints to use intercept scids generated by this channel’s counterparty.
- The counterparty will get an
HTLCIntercepted
event upon payment forward, and callforward_intercepted_htlc
with less than the amount provided inHTLCIntercepted::expected_outbound_amount_msat
. The difference between the expected and actual forward amounts is their fee.
§Note
It’s important for payee wallet software to verify that PaymentClaimable::amount_msat
is
as-expected if this feature is activated, otherwise they may lose money!
PaymentClaimable::counterparty_skimmed_fee_msat
provides the fee taken by the
counterparty.
§Note
Switching this config flag on may break compatibility with versions of LDK prior to 0.0.116. Unsetting this flag between restarts may lead to payment receive failures.
Default value: false.
Implementations§
§impl ChannelConfig
impl ChannelConfig
pub fn apply(&mut self, update: &ChannelConfigUpdate)
pub fn apply(&mut self, update: &ChannelConfigUpdate)
Applies the given ChannelConfigUpdate
as a partial update to the ChannelConfig
.
Trait Implementations§
§impl Clone for ChannelConfig
impl Clone for ChannelConfig
§fn clone(&self) -> ChannelConfig
fn clone(&self) -> ChannelConfig
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read more§impl Debug for ChannelConfig
impl Debug for ChannelConfig
§impl Default for ChannelConfig
impl Default for ChannelConfig
§fn default() -> ChannelConfig
fn default() -> ChannelConfig
Provides sane defaults for most configurations (but with zero relay fees!).
§impl From<ChannelConfig> for ChannelConfigUpdate
impl From<ChannelConfig> for ChannelConfigUpdate
§fn from(config: ChannelConfig) -> ChannelConfigUpdate
fn from(config: ChannelConfig) -> ChannelConfigUpdate
§impl PartialEq for ChannelConfig
impl PartialEq for ChannelConfig
§impl Readable for ChannelConfig
impl Readable for ChannelConfig
§fn read<R>(reader: &mut R) -> Result<ChannelConfig, DecodeError>where
R: Read,
fn read<R>(reader: &mut R) -> Result<ChannelConfig, DecodeError>where
R: Read,
Self
in from the given Read
.§impl Writeable for ChannelConfig
impl Writeable for ChannelConfig
impl Copy for ChannelConfig
impl Eq for ChannelConfig
impl StructuralPartialEq for ChannelConfig
Auto Trait Implementations§
impl Freeze for ChannelConfig
impl RefUnwindSafe for ChannelConfig
impl Send for ChannelConfig
impl Sync for ChannelConfig
impl Unpin for ChannelConfig
impl UnwindSafe for ChannelConfig
Blanket Implementations§
§impl<T> AnySync for T
impl<T> AnySync for T
§impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
§impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
T: 'a,
impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
T: 'a,
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
source§unsafe fn clone_to_uninit(&self, dst: *mut T)
unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)§impl<T> Downcast for Twhere
T: AsAny + ?Sized,
impl<T> Downcast for Twhere
T: AsAny + ?Sized,
§fn downcast_ref<T>(&self) -> Option<&T>where
T: AsAny,
fn downcast_ref<T>(&self) -> Option<&T>where
T: AsAny,
Any
.§fn downcast_mut<T>(&mut self) -> Option<&mut T>where
T: AsAny,
fn downcast_mut<T>(&mut self) -> Option<&mut T>where
T: AsAny,
Any
.source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
source§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
key
and return true
if they are equal.§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
key
and return true
if they are equal.§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
source§impl<T> IntoRequest<T> for T
impl<T> IntoRequest<T> for T
source§fn into_request(self) -> Request<T>
fn into_request(self) -> Request<T>
T
in a tonic::Request