]> git.bitcoin.ninja Git - rust-lightning/blob - lightning/src/util/config.rs
Merge pull request #2367 from wpaulino/remove-anchors-flag
[rust-lightning] / lightning / src / util / config.rs
1 // This file is Copyright its original authors, visible in version control
2 // history.
3 //
4 // This file is licensed under the Apache License, Version 2.0 <LICENSE-APACHE
5 // or http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
6 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your option.
7 // You may not use this file except in accordance with one or both of these
8 // licenses.
9
10 //! Various user-configurable channel limits and settings which ChannelManager
11 //! applies for you.
12
13 use crate::ln::channel::MAX_FUNDING_SATOSHIS_NO_WUMBO;
14 use crate::ln::channelmanager::{BREAKDOWN_TIMEOUT, MAX_LOCAL_BREAKDOWN_TIMEOUT};
15
16 /// Configuration we set when applicable.
17 ///
18 /// Default::default() provides sane defaults.
19 #[derive(Copy, Clone, Debug)]
20 pub struct ChannelHandshakeConfig {
21         /// Confirmations we will wait for before considering the channel locked in.
22         /// Applied only for inbound channels (see ChannelHandshakeLimits::max_minimum_depth for the
23         /// equivalent limit applied to outbound channels).
24         ///
25         /// A lower-bound of 1 is applied, requiring all channels to have a confirmed commitment
26         /// transaction before operation. If you wish to accept channels with zero confirmations, see
27         /// [`UserConfig::manually_accept_inbound_channels`] and
28         /// [`ChannelManager::accept_inbound_channel_from_trusted_peer_0conf`].
29         ///
30         /// Default value: 6.
31         ///
32         /// [`ChannelManager::accept_inbound_channel`]: crate::ln::channelmanager::ChannelManager::accept_inbound_channel
33         /// [`ChannelManager::accept_inbound_channel_from_trusted_peer_0conf`]: crate::ln::channelmanager::ChannelManager::accept_inbound_channel_from_trusted_peer_0conf
34         pub minimum_depth: u32,
35         /// Set to the number of blocks we require our counterparty to wait to claim their money (ie
36         /// the number of blocks we have to punish our counterparty if they broadcast a revoked
37         /// transaction).
38         ///
39         /// This is one of the main parameters of our security model. We (or one of our watchtowers) MUST
40         /// be online to check for revoked transactions on-chain at least once every our_to_self_delay
41         /// blocks (minus some margin to allow us enough time to broadcast and confirm a transaction,
42         /// possibly with time in between to RBF the spending transaction).
43         ///
44         /// Meanwhile, asking for a too high delay, we bother peer to freeze funds for nothing in
45         /// case of an honest unilateral channel close, which implicitly decrease the economic value of
46         /// our channel.
47         ///
48         /// Default value: [`BREAKDOWN_TIMEOUT`], we enforce it as a minimum at channel opening so you
49         /// can tweak config to ask for more security, not less.
50         pub our_to_self_delay: u16,
51         /// Set to the smallest value HTLC we will accept to process.
52         ///
53         /// This value is sent to our counterparty on channel-open and we close the channel any time
54         /// our counterparty misbehaves by sending us an HTLC with a value smaller than this.
55         ///
56         /// Default value: 1. If the value is less than 1, it is ignored and set to 1, as is required
57         /// by the protocol.
58         pub our_htlc_minimum_msat: u64,
59         /// Sets the percentage of the channel value we will cap the total value of outstanding inbound
60         /// HTLCs to.
61         ///
62         /// This can be set to a value between 1-100, where the value corresponds to the percent of the
63         /// channel value in whole percentages.
64         ///
65         /// Note that:
66         /// * If configured to another value than the default value 10, any new channels created with
67         /// the non default value will cause versions of LDK prior to 0.0.104 to refuse to read the
68         /// `ChannelManager`.
69         ///
70         /// * This caps the total value for inbound HTLCs in-flight only, and there's currently
71         /// no way to configure the cap for the total value of outbound HTLCs in-flight.
72         ///
73         /// * The requirements for your node being online to ensure the safety of HTLC-encumbered funds
74         /// are different from the non-HTLC-encumbered funds. This makes this an important knob to
75         /// restrict exposure to loss due to being offline for too long.
76         /// See [`ChannelHandshakeConfig::our_to_self_delay`] and [`ChannelConfig::cltv_expiry_delta`]
77         /// for more information.
78         ///
79         /// Default value: 10.
80         /// Minimum value: 1, any values less than 1 will be treated as 1 instead.
81         /// Maximum value: 100, any values larger than 100 will be treated as 100 instead.
82         pub max_inbound_htlc_value_in_flight_percent_of_channel: u8,
83         /// If set, we attempt to negotiate the `scid_privacy` (referred to as `scid_alias` in the
84         /// BOLTs) option for outbound private channels. This provides better privacy by not including
85         /// our real on-chain channel UTXO in each invoice and requiring that our counterparty only
86         /// relay HTLCs to us using the channel's SCID alias.
87         ///
88         /// If this option is set, channels may be created that will not be readable by LDK versions
89         /// prior to 0.0.106, causing [`ChannelManager`]'s read method to return a
90         /// [`DecodeError::InvalidValue`].
91         ///
92         /// Note that setting this to true does *not* prevent us from opening channels with
93         /// counterparties that do not support the `scid_alias` option; we will simply fall back to a
94         /// private channel without that option.
95         ///
96         /// Ignored if the channel is negotiated to be announced, see
97         /// [`ChannelHandshakeConfig::announced_channel`] and
98         /// [`ChannelHandshakeLimits::force_announced_channel_preference`] for more.
99         ///
100         /// Default value: false. This value is likely to change to true in the future.
101         ///
102         /// [`ChannelManager`]: crate::ln::channelmanager::ChannelManager
103         /// [`DecodeError::InvalidValue`]: crate::ln::msgs::DecodeError::InvalidValue
104         pub negotiate_scid_privacy: bool,
105         /// Set to announce the channel publicly and notify all nodes that they can route via this
106         /// channel.
107         ///
108         /// This should only be set to true for nodes which expect to be online reliably.
109         ///
110         /// As the node which funds a channel picks this value this will only apply for new outbound
111         /// channels unless [`ChannelHandshakeLimits::force_announced_channel_preference`] is set.
112         ///
113         /// Default value: false.
114         pub announced_channel: bool,
115         /// When set, we commit to an upfront shutdown_pubkey at channel open. If our counterparty
116         /// supports it, they will then enforce the mutual-close output to us matches what we provided
117         /// at intialization, preventing us from closing to an alternate pubkey.
118         ///
119         /// This is set to true by default to provide a slight increase in security, though ultimately
120         /// any attacker who is able to take control of a channel can just as easily send the funds via
121         /// lightning payments, so we never require that our counterparties support this option.
122         ///
123         /// The upfront key committed is provided from [`SignerProvider::get_shutdown_scriptpubkey`].
124         ///
125         /// Default value: true.
126         ///
127         /// [`SignerProvider::get_shutdown_scriptpubkey`]: crate::sign::SignerProvider::get_shutdown_scriptpubkey
128         pub commit_upfront_shutdown_pubkey: bool,
129         /// The Proportion of the channel value to configure as counterparty's channel reserve,
130         /// i.e., `their_channel_reserve_satoshis` for both outbound and inbound channels.
131         ///
132         /// `their_channel_reserve_satoshis` is the minimum balance that the other node has to maintain
133         /// on their side, at all times.
134         /// This ensures that if our counterparty broadcasts a revoked state, we can punish them by
135         /// claiming at least this value on chain.
136         ///
137         /// Channel reserve values greater than 30% could be considered highly unreasonable, since that
138         /// amount can never be used for payments.
139         /// Also, if our selected channel reserve for counterparty and counterparty's selected
140         /// channel reserve for us sum up to equal or greater than channel value, channel negotiations
141         /// will fail.
142         ///
143         /// Note: Versions of LDK earlier than v0.0.104 will fail to read channels with any channel reserve
144         /// other than the default value.
145         ///
146         /// Default value: 1% of channel value, i.e., configured as 10,000 millionths.
147         /// Minimum value: If the calculated proportional value is less than 1000 sats, it will be treated
148         ///                as 1000 sats instead, which is a safe implementation-specific lower bound.
149         /// Maximum value: 1,000,000, any values larger than 1 Million will be treated as 1 Million (or 100%)
150         ///                instead, although channel negotiations will fail in that case.
151         pub their_channel_reserve_proportional_millionths: u32,
152         /// If set, we attempt to negotiate the `anchors_zero_fee_htlc_tx`option for all future
153         /// channels. This feature requires having a reserve of onchain funds readily available to bump
154         /// transactions in the event of a channel force close to avoid the possibility of losing funds.
155         ///
156         /// If this option is set, channels may be created that will not be readable by LDK versions
157         /// prior to 0.0.116, causing [`ChannelManager`]'s read method to return a
158         /// [`DecodeError::InvalidValue`].
159         ///
160         /// Note that setting this to true does *not* prevent us from opening channels with
161         /// counterparties that do not support the `anchors_zero_fee_htlc_tx` option; we will simply
162         /// fall back to a `static_remote_key` channel.
163         ///
164         /// LDK will not support the legacy `option_anchors` commitment version due to a discovered
165         /// vulnerability after its deployment. For more context, see the [`SIGHASH_SINGLE + update_fee
166         /// Considered Harmful`] mailing list post.
167         ///
168         /// Default value: false. This value is likely to change to true in the future.
169         ///
170         /// [`ChannelManager`]: crate::ln::channelmanager::ChannelManager
171         /// [`DecodeError::InvalidValue`]: crate::ln::msgs::DecodeError::InvalidValue
172         /// [`SIGHASH_SINGLE + update_fee Considered Harmful`]: https://lists.linuxfoundation.org/pipermail/lightning-dev/2020-September/002796.html
173         pub negotiate_anchors_zero_fee_htlc_tx: bool,
174
175         /// The maximum number of HTLCs in-flight from our counterparty towards us at the same time.
176         ///
177         /// Increasing the value can help improve liquidity and stability in
178         /// routing at the cost of higher long term disk / DB usage.
179         ///
180         /// Note: Versions of LDK earlier than v0.0.115 will fail to read channels with a configuration
181         /// other than the default value.
182         ///
183         /// Default value: 50
184         /// Maximum value: 483, any values larger will be treated as 483.
185         ///                     This is the BOLT #2 spec limit on `max_accepted_htlcs`.
186         pub our_max_accepted_htlcs: u16,
187 }
188
189 impl Default for ChannelHandshakeConfig {
190         fn default() -> ChannelHandshakeConfig {
191                 ChannelHandshakeConfig {
192                         minimum_depth: 6,
193                         our_to_self_delay: BREAKDOWN_TIMEOUT,
194                         our_htlc_minimum_msat: 1,
195                         max_inbound_htlc_value_in_flight_percent_of_channel: 10,
196                         negotiate_scid_privacy: false,
197                         announced_channel: false,
198                         commit_upfront_shutdown_pubkey: true,
199                         their_channel_reserve_proportional_millionths: 10_000,
200                         negotiate_anchors_zero_fee_htlc_tx: false,
201                         our_max_accepted_htlcs: 50,
202                 }
203         }
204 }
205
206 /// Optional channel limits which are applied during channel creation.
207 ///
208 /// These limits are only applied to our counterparty's limits, not our own.
209 ///
210 /// Use 0/`<type>::max_value()` as appropriate to skip checking.
211 ///
212 /// Provides sane defaults for most configurations.
213 ///
214 /// Most additional limits are disabled except those with which specify a default in individual
215 /// field documentation. Note that this may result in barely-usable channels, but since they
216 /// are applied mostly only to incoming channels that's not much of a problem.
217 #[derive(Copy, Clone, Debug)]
218 pub struct ChannelHandshakeLimits {
219         /// Minimum allowed satoshis when a channel is funded. This is supplied by the sender and so
220         /// only applies to inbound channels.
221         ///
222         /// Default value: 0.
223         pub min_funding_satoshis: u64,
224         /// Maximum allowed satoshis when a channel is funded. This is supplied by the sender and so
225         /// only applies to inbound channels.
226         ///
227         /// Default value: 2^24 - 1.
228         pub max_funding_satoshis: u64,
229         /// The remote node sets a limit on the minimum size of HTLCs we can send to them. This allows
230         /// you to limit the maximum minimum-size they can require.
231         ///
232         /// Default value: u64::max_value.
233         pub max_htlc_minimum_msat: u64,
234         /// The remote node sets a limit on the maximum value of pending HTLCs to them at any given
235         /// time to limit their funds exposure to HTLCs. This allows you to set a minimum such value.
236         ///
237         /// Default value: 0.
238         pub min_max_htlc_value_in_flight_msat: u64,
239         /// The remote node will require we keep a certain amount in direct payment to ourselves at all
240         /// time, ensuring that we are able to be punished if we broadcast an old state. This allows to
241         /// you limit the amount which we will have to keep to ourselves (and cannot use for HTLCs).
242         ///
243         /// Default value: u64::max_value.
244         pub max_channel_reserve_satoshis: u64,
245         /// The remote node sets a limit on the maximum number of pending HTLCs to them at any given
246         /// time. This allows you to set a minimum such value.
247         ///
248         /// Default value: 0.
249         pub min_max_accepted_htlcs: u16,
250         /// Before a channel is usable the funding transaction will need to be confirmed by at least a
251         /// certain number of blocks, specified by the node which is not the funder (as the funder can
252         /// assume they aren't going to double-spend themselves).
253         /// This config allows you to set a limit on the maximum amount of time to wait.
254         ///
255         /// Default value: 144, or roughly one day and only applies to outbound channels.
256         pub max_minimum_depth: u32,
257         /// Whether we implicitly trust funding transactions generated by us for our own outbound
258         /// channels to not be double-spent.
259         ///
260         /// If this is set, we assume that our own funding transactions are *never* double-spent, and
261         /// thus we can trust them without any confirmations. This is generally a reasonable
262         /// assumption, given we're the only ones who could ever double-spend it (assuming we have sole
263         /// control of the signing keys).
264         ///
265         /// You may wish to un-set this if you allow the user to (or do in an automated fashion)
266         /// double-spend the funding transaction to RBF with an alternative channel open.
267         ///
268         /// This only applies if our counterparty set their confirmations-required value to 0, and we
269         /// always trust our own funding transaction at 1 confirmation irrespective of this value.
270         /// Thus, this effectively acts as a `min_minimum_depth`, with the only possible values being
271         /// `true` (0) and `false` (1).
272         ///
273         /// Default value: true
274         pub trust_own_funding_0conf: bool,
275         /// Set to force an incoming channel to match our announced channel preference in
276         /// [`ChannelHandshakeConfig::announced_channel`].
277         ///
278         /// For a node which is not online reliably, this should be set to true and
279         /// [`ChannelHandshakeConfig::announced_channel`] set to false, ensuring that no announced (aka public)
280         /// channels will ever be opened.
281         ///
282         /// Default value: true.
283         pub force_announced_channel_preference: bool,
284         /// Set to the amount of time we're willing to wait to claim money back to us.
285         ///
286         /// Not checking this value would be a security issue, as our peer would be able to set it to
287         /// max relative lock-time (a year) and we would "lose" money as it would be locked for a long time.
288         ///
289         /// Default value: 2016, which we also enforce as a maximum value so you can tweak config to
290         /// reduce the loss of having useless locked funds (if your peer accepts)
291         pub their_to_self_delay: u16
292 }
293
294 impl Default for ChannelHandshakeLimits {
295         fn default() -> Self {
296                 ChannelHandshakeLimits {
297                         min_funding_satoshis: 0,
298                         max_funding_satoshis: MAX_FUNDING_SATOSHIS_NO_WUMBO,
299                         max_htlc_minimum_msat: <u64>::max_value(),
300                         min_max_htlc_value_in_flight_msat: 0,
301                         max_channel_reserve_satoshis: <u64>::max_value(),
302                         min_max_accepted_htlcs: 0,
303                         trust_own_funding_0conf: true,
304                         max_minimum_depth: 144,
305                         force_announced_channel_preference: true,
306                         their_to_self_delay: MAX_LOCAL_BREAKDOWN_TIMEOUT,
307                 }
308         }
309 }
310
311 /// Options which apply on a per-channel basis and may change at runtime or based on negotiation
312 /// with our counterparty.
313 #[derive(Copy, Clone, Debug, PartialEq, Eq)]
314 pub struct ChannelConfig {
315         /// Amount (in millionths of a satoshi) charged per satoshi for payments forwarded outbound
316         /// over the channel.
317         /// This may be allowed to change at runtime in a later update, however doing so must result in
318         /// update messages sent to notify all nodes of our updated relay fee.
319         ///
320         /// Default value: 0.
321         pub forwarding_fee_proportional_millionths: u32,
322         /// Amount (in milli-satoshi) charged for payments forwarded outbound over the channel, in
323         /// excess of [`forwarding_fee_proportional_millionths`].
324         /// This may be allowed to change at runtime in a later update, however doing so must result in
325         /// update messages sent to notify all nodes of our updated relay fee.
326         ///
327         /// The default value of a single satoshi roughly matches the market rate on many routing nodes
328         /// as of July 2021. Adjusting it upwards or downwards may change whether nodes route through
329         /// this node.
330         ///
331         /// Default value: 1000.
332         ///
333         /// [`forwarding_fee_proportional_millionths`]: ChannelConfig::forwarding_fee_proportional_millionths
334         pub forwarding_fee_base_msat: u32,
335         /// The difference in the CLTV value between incoming HTLCs and an outbound HTLC forwarded over
336         /// the channel this config applies to.
337         ///
338         /// This is analogous to [`ChannelHandshakeConfig::our_to_self_delay`] but applies to in-flight
339         /// HTLC balance when a channel appears on-chain whereas
340         /// [`ChannelHandshakeConfig::our_to_self_delay`] applies to the remaining
341         /// (non-HTLC-encumbered) balance.
342         ///
343         /// Thus, for HTLC-encumbered balances to be enforced on-chain when a channel is force-closed,
344         /// we (or one of our watchtowers) MUST be online to check for broadcast of the current
345         /// commitment transaction at least once per this many blocks (minus some margin to allow us
346         /// enough time to broadcast and confirm a transaction, possibly with time in between to RBF
347         /// the spending transaction).
348         ///
349         /// Default value: 72 (12 hours at an average of 6 blocks/hour).
350         /// Minimum value: [`MIN_CLTV_EXPIRY_DELTA`], any values less than this will be treated as
351         ///                [`MIN_CLTV_EXPIRY_DELTA`] instead.
352         ///
353         /// [`MIN_CLTV_EXPIRY_DELTA`]: crate::ln::channelmanager::MIN_CLTV_EXPIRY_DELTA
354         pub cltv_expiry_delta: u16,
355         /// Limit our total exposure to in-flight HTLCs which are burned to fees as they are too
356         /// small to claim on-chain.
357         ///
358         /// When an HTLC present in one of our channels is below a "dust" threshold, the HTLC will
359         /// not be claimable on-chain, instead being turned into additional miner fees if either
360         /// party force-closes the channel. Because the threshold is per-HTLC, our total exposure
361         /// to such payments may be sustantial if there are many dust HTLCs present when the
362         /// channel is force-closed.
363         ///
364         /// The dust threshold for each HTLC is based on the `dust_limit_satoshis` for each party in a
365         /// channel negotiated throughout the channel open process, along with the fees required to have
366         /// a broadcastable HTLC spending transaction. When a channel supports anchor outputs
367         /// (specifically the zero fee HTLC transaction variant), this threshold no longer takes into
368         /// account the HTLC transaction fee as it is zero.
369         ///
370         /// This limit is applied for sent, forwarded, and received HTLCs and limits the total
371         /// exposure across all three types per-channel. Setting this too low may prevent the
372         /// sending or receipt of low-value HTLCs on high-traffic nodes, and this limit is very
373         /// important to prevent stealing of dust HTLCs by miners.
374         ///
375         /// Default value: 5_000_000 msat.
376         pub max_dust_htlc_exposure_msat: u64,
377         /// The additional fee we're willing to pay to avoid waiting for the counterparty's
378         /// `to_self_delay` to reclaim funds.
379         ///
380         /// When we close a channel cooperatively with our counterparty, we negotiate a fee for the
381         /// closing transaction which both sides find acceptable, ultimately paid by the channel
382         /// funder/initiator.
383         ///
384         /// When we are the funder, because we have to pay the channel closing fee, we bound the
385         /// acceptable fee by our [`Background`] and [`Normal`] fees, with the upper bound increased by
386         /// this value. Because the on-chain fee we'd pay to force-close the channel is kept near our
387         /// [`Normal`] feerate during normal operation, this value represents the additional fee we're
388         /// willing to pay in order to avoid waiting for our counterparty's to_self_delay to reclaim our
389         /// funds.
390         ///
391         /// When we are not the funder, we require the closing transaction fee pay at least our
392         /// [`Background`] fee estimate, but allow our counterparty to pay as much fee as they like.
393         /// Thus, this value is ignored when we are not the funder.
394         ///
395         /// Default value: 1000 satoshis.
396         ///
397         /// [`Normal`]: crate::chain::chaininterface::ConfirmationTarget::Normal
398         /// [`Background`]: crate::chain::chaininterface::ConfirmationTarget::Background
399         pub force_close_avoidance_max_fee_satoshis: u64,
400         /// If set, allows this channel's counterparty to skim an additional fee off this node's inbound
401         /// HTLCs. Useful for liquidity providers to offload on-chain channel costs to end users.
402         ///
403         /// Usage:
404         /// - The payee will set this option and set its invoice route hints to use [intercept scids]
405         ///   generated by this channel's counterparty.
406         /// - The counterparty will get an [`HTLCIntercepted`] event upon payment forward, and call
407         ///   [`forward_intercepted_htlc`] with less than the amount provided in
408         ///   [`HTLCIntercepted::expected_outbound_amount_msat`]. The difference between the expected and
409         ///   actual forward amounts is their fee.
410         // TODO: link to LSP JIT channel invoice generation spec when it's merged
411         ///
412         /// # Note
413         /// It's important for payee wallet software to verify that [`PaymentClaimable::amount_msat`] is
414         /// as-expected if this feature is activated, otherwise they may lose money!
415         /// [`PaymentClaimable::counterparty_skimmed_fee_msat`] provides the fee taken by the
416         /// counterparty.
417         ///
418         /// # Note
419         /// Switching this config flag on may break compatibility with versions of LDK prior to 0.0.116.
420         /// Unsetting this flag between restarts may lead to payment receive failures.
421         ///
422         /// Default value: false.
423         ///
424         /// [intercept scids]: crate::ln::channelmanager::ChannelManager::get_intercept_scid
425         /// [`forward_intercepted_htlc`]: crate::ln::channelmanager::ChannelManager::forward_intercepted_htlc
426         /// [`HTLCIntercepted`]: crate::events::Event::HTLCIntercepted
427         /// [`HTLCIntercepted::expected_outbound_amount_msat`]: crate::events::Event::HTLCIntercepted::expected_outbound_amount_msat
428         /// [`PaymentClaimable::amount_msat`]: crate::events::Event::PaymentClaimable::amount_msat
429         /// [`PaymentClaimable::counterparty_skimmed_fee_msat`]: crate::events::Event::PaymentClaimable::counterparty_skimmed_fee_msat
430         //  TODO: link to bLIP when it's merged
431         pub accept_underpaying_htlcs: bool,
432 }
433
434 impl ChannelConfig {
435         /// Applies the given [`ChannelConfigUpdate`] as a partial update to the [`ChannelConfig`].
436         pub fn apply(&mut self, update: &ChannelConfigUpdate) {
437                 if let Some(forwarding_fee_proportional_millionths) = update.forwarding_fee_proportional_millionths {
438                         self.forwarding_fee_proportional_millionths = forwarding_fee_proportional_millionths;
439                 }
440                 if let Some(forwarding_fee_base_msat) = update.forwarding_fee_base_msat {
441                         self.forwarding_fee_base_msat = forwarding_fee_base_msat;
442                 }
443                 if let Some(cltv_expiry_delta) = update.cltv_expiry_delta {
444                         self.cltv_expiry_delta = cltv_expiry_delta;
445                 }
446                 if let Some(max_dust_htlc_exposure_msat) = update.max_dust_htlc_exposure_msat {
447                         self.max_dust_htlc_exposure_msat = max_dust_htlc_exposure_msat;
448                 }
449                 if let Some(force_close_avoidance_max_fee_satoshis) = update.force_close_avoidance_max_fee_satoshis {
450                         self.force_close_avoidance_max_fee_satoshis = force_close_avoidance_max_fee_satoshis;
451                 }
452         }
453 }
454
455 impl Default for ChannelConfig {
456         /// Provides sane defaults for most configurations (but with zero relay fees!).
457         fn default() -> Self {
458                 ChannelConfig {
459                         forwarding_fee_proportional_millionths: 0,
460                         forwarding_fee_base_msat: 1000,
461                         cltv_expiry_delta: 6 * 12, // 6 blocks/hour * 12 hours
462                         max_dust_htlc_exposure_msat: 5_000_000,
463                         force_close_avoidance_max_fee_satoshis: 1000,
464                         accept_underpaying_htlcs: false,
465                 }
466         }
467 }
468
469 impl_writeable_tlv_based!(ChannelConfig, {
470         (0, forwarding_fee_proportional_millionths, required),
471         (1, accept_underpaying_htlcs, (default_value, false)),
472         (2, forwarding_fee_base_msat, required),
473         (4, cltv_expiry_delta, required),
474         (6, max_dust_htlc_exposure_msat, required),
475         // ChannelConfig serialized this field with a required type of 8 prior to the introduction of
476         // LegacyChannelConfig. To make sure that serialization is not compatible with this one, we use
477         // the next required type of 10, which if seen by the old serialization will always fail.
478         (10, force_close_avoidance_max_fee_satoshis, required),
479 });
480
481 /// A parallel struct to [`ChannelConfig`] to define partial updates.
482 #[allow(missing_docs)]
483 pub struct ChannelConfigUpdate {
484         pub forwarding_fee_proportional_millionths: Option<u32>,
485         pub forwarding_fee_base_msat: Option<u32>,
486         pub cltv_expiry_delta: Option<u16>,
487         pub max_dust_htlc_exposure_msat: Option<u64>,
488         pub force_close_avoidance_max_fee_satoshis: Option<u64>,
489 }
490
491 impl Default for ChannelConfigUpdate {
492         fn default() -> ChannelConfigUpdate {
493                 ChannelConfigUpdate {
494                         forwarding_fee_proportional_millionths: None,
495                         forwarding_fee_base_msat: None,
496                         cltv_expiry_delta: None,
497                         max_dust_htlc_exposure_msat: None,
498                         force_close_avoidance_max_fee_satoshis: None,
499                 }
500         }
501 }
502
503 impl From<ChannelConfig> for ChannelConfigUpdate {
504         fn from(config: ChannelConfig) -> ChannelConfigUpdate {
505                 ChannelConfigUpdate {
506                         forwarding_fee_proportional_millionths: Some(config.forwarding_fee_proportional_millionths),
507                         forwarding_fee_base_msat: Some(config.forwarding_fee_base_msat),
508                         cltv_expiry_delta: Some(config.cltv_expiry_delta),
509                         max_dust_htlc_exposure_msat: Some(config.max_dust_htlc_exposure_msat),
510                         force_close_avoidance_max_fee_satoshis: Some(config.force_close_avoidance_max_fee_satoshis),
511                 }
512         }
513 }
514
515 /// Legacy version of [`ChannelConfig`] that stored the static
516 /// [`ChannelHandshakeConfig::announced_channel`] and
517 /// [`ChannelHandshakeConfig::commit_upfront_shutdown_pubkey`] fields.
518 #[derive(Copy, Clone, Debug)]
519 pub(crate) struct LegacyChannelConfig {
520         pub(crate) options: ChannelConfig,
521         /// Deprecated but may still be read from. See [`ChannelHandshakeConfig::announced_channel`] to
522         /// set this when opening/accepting a channel.
523         pub(crate) announced_channel: bool,
524         /// Deprecated but may still be read from. See
525         /// [`ChannelHandshakeConfig::commit_upfront_shutdown_pubkey`] to set this when
526         /// opening/accepting a channel.
527         pub(crate) commit_upfront_shutdown_pubkey: bool,
528 }
529
530 impl Default for LegacyChannelConfig {
531         fn default() -> Self {
532                 Self {
533                         options: ChannelConfig::default(),
534                         announced_channel: false,
535                         commit_upfront_shutdown_pubkey: true,
536                 }
537         }
538 }
539
540 impl crate::util::ser::Writeable for LegacyChannelConfig {
541         fn write<W: crate::util::ser::Writer>(&self, writer: &mut W) -> Result<(), crate::io::Error> {
542                 write_tlv_fields!(writer, {
543                         (0, self.options.forwarding_fee_proportional_millionths, required),
544                         (1, self.options.max_dust_htlc_exposure_msat, (default_value, 5_000_000)),
545                         (2, self.options.cltv_expiry_delta, required),
546                         (3, self.options.force_close_avoidance_max_fee_satoshis, (default_value, 1000)),
547                         (4, self.announced_channel, required),
548                         (6, self.commit_upfront_shutdown_pubkey, required),
549                         (8, self.options.forwarding_fee_base_msat, required),
550                 });
551                 Ok(())
552         }
553 }
554
555 impl crate::util::ser::Readable for LegacyChannelConfig {
556         fn read<R: crate::io::Read>(reader: &mut R) -> Result<Self, crate::ln::msgs::DecodeError> {
557                 let mut forwarding_fee_proportional_millionths = 0;
558                 let mut max_dust_htlc_exposure_msat = 5_000_000;
559                 let mut cltv_expiry_delta = 0;
560                 let mut force_close_avoidance_max_fee_satoshis = 1000;
561                 let mut announced_channel = false;
562                 let mut commit_upfront_shutdown_pubkey = false;
563                 let mut forwarding_fee_base_msat = 0;
564                 read_tlv_fields!(reader, {
565                         (0, forwarding_fee_proportional_millionths, required),
566                         (1, max_dust_htlc_exposure_msat, (default_value, 5_000_000u64)),
567                         (2, cltv_expiry_delta, required),
568                         (3, force_close_avoidance_max_fee_satoshis, (default_value, 1000u64)),
569                         (4, announced_channel, required),
570                         (6, commit_upfront_shutdown_pubkey, required),
571                         (8, forwarding_fee_base_msat, required),
572                 });
573                 Ok(Self {
574                         options: ChannelConfig {
575                                 forwarding_fee_proportional_millionths,
576                                 max_dust_htlc_exposure_msat,
577                                 cltv_expiry_delta,
578                                 force_close_avoidance_max_fee_satoshis,
579                                 forwarding_fee_base_msat,
580                                 accept_underpaying_htlcs: false,
581                         },
582                         announced_channel,
583                         commit_upfront_shutdown_pubkey,
584                 })
585         }
586 }
587
588 /// Top-level config which holds ChannelHandshakeLimits and ChannelConfig.
589 ///
590 /// Default::default() provides sane defaults for most configurations
591 /// (but currently with 0 relay fees!)
592 #[derive(Copy, Clone, Debug)]
593 pub struct UserConfig {
594         /// Channel handshake config that we propose to our counterparty.
595         pub channel_handshake_config: ChannelHandshakeConfig,
596         /// Limits applied to our counterparty's proposed channel handshake config settings.
597         pub channel_handshake_limits: ChannelHandshakeLimits,
598         /// Channel config which affects behavior during channel lifetime.
599         pub channel_config: ChannelConfig,
600         /// If this is set to false, we will reject any HTLCs which were to be forwarded over private
601         /// channels. This prevents us from taking on HTLC-forwarding risk when we intend to run as a
602         /// node which is not online reliably.
603         ///
604         /// For nodes which are not online reliably, you should set all channels to *not* be announced
605         /// (using [`ChannelHandshakeConfig::announced_channel`] and
606         /// [`ChannelHandshakeLimits::force_announced_channel_preference`]) and set this to false to
607         /// ensure you are not exposed to any forwarding risk.
608         ///
609         /// Note that because you cannot change a channel's announced state after creation, there is no
610         /// way to disable forwarding on public channels retroactively. Thus, in order to change a node
611         /// from a publicly-announced forwarding node to a private non-forwarding node you must close
612         /// all your channels and open new ones. For privacy, you should also change your node_id
613         /// (swapping all private and public key material for new ones) at that time.
614         ///
615         /// Default value: false.
616         pub accept_forwards_to_priv_channels: bool,
617         /// If this is set to false, we do not accept inbound requests to open a new channel.
618         /// Default value: true.
619         pub accept_inbound_channels: bool,
620         /// If this is set to true, the user needs to manually accept inbound requests to open a new
621         /// channel.
622         ///
623         /// When set to true, [`Event::OpenChannelRequest`] will be triggered once a request to open a
624         /// new inbound channel is received through a [`msgs::OpenChannel`] message. In that case, a
625         /// [`msgs::AcceptChannel`] message will not be sent back to the counterparty node unless the
626         /// user explicitly chooses to accept the request.
627         ///
628         /// Default value: false.
629         ///
630         /// [`Event::OpenChannelRequest`]: crate::events::Event::OpenChannelRequest
631         /// [`msgs::OpenChannel`]: crate::ln::msgs::OpenChannel
632         /// [`msgs::AcceptChannel`]: crate::ln::msgs::AcceptChannel
633         pub manually_accept_inbound_channels: bool,
634         ///  If this is set to true, LDK will intercept HTLCs that are attempting to be forwarded over
635         ///  fake short channel ids generated via [`ChannelManager::get_intercept_scid`]. Upon HTLC
636         ///  intercept, LDK will generate an [`Event::HTLCIntercepted`] which MUST be handled by the user.
637         ///
638         ///  Setting this to true may break backwards compatibility with LDK versions < 0.0.113.
639         ///
640         ///  Default value: false.
641         ///
642         /// [`ChannelManager::get_intercept_scid`]: crate::ln::channelmanager::ChannelManager::get_intercept_scid
643         /// [`Event::HTLCIntercepted`]: crate::events::Event::HTLCIntercepted
644         pub accept_intercept_htlcs: bool,
645         /// If this is set to false, when receiving a keysend payment we'll fail it if it has multiple
646         /// parts. If this is set to true, we'll accept the payment.
647         ///
648         /// Setting this to true will break backwards compatibility upon downgrading to an LDK
649         /// version < 0.0.116 while receiving an MPP keysend. If we have already received an MPP
650         /// keysend, downgrading will cause us to fail to deserialize [`ChannelManager`].
651         ///
652         /// Default value: false.
653         ///
654         /// [`ChannelManager`]: crate::ln::channelmanager::ChannelManager
655         pub accept_mpp_keysend: bool,
656 }
657
658 impl Default for UserConfig {
659         fn default() -> Self {
660                 UserConfig {
661                         channel_handshake_config: ChannelHandshakeConfig::default(),
662                         channel_handshake_limits: ChannelHandshakeLimits::default(),
663                         channel_config: ChannelConfig::default(),
664                         accept_forwards_to_priv_channels: false,
665                         accept_inbound_channels: true,
666                         manually_accept_inbound_channels: false,
667                         accept_intercept_htlcs: false,
668                         accept_mpp_keysend: false,
669                 }
670         }
671 }