]> git.bitcoin.ninja Git - rust-lightning/blob - lightning/src/util/config.rs
Merge pull request #1951 from wpaulino/remove-get-node-secret
[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::chain::keysinterface::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         #[cfg(anchors)]
153         /// If set, we attempt to negotiate the `anchors_zero_fee_htlc_tx`option for outbound channels.
154         ///
155         /// If this option is set, channels may be created that will not be readable by LDK versions
156         /// prior to 0.0.114, causing [`ChannelManager`]'s read method to return a
157         /// [`DecodeError::InvalidValue`].
158         ///
159         /// Note that setting this to true does *not* prevent us from opening channels with
160         /// counterparties that do not support the `anchors_zero_fee_htlc_tx` option; we will simply
161         /// fall back to a `static_remote_key` channel.
162         ///
163         /// LDK will not support the legacy `option_anchors` commitment version due to a discovered
164         /// vulnerability after its deployment. For more context, see the [`SIGHASH_SINGLE + update_fee
165         /// Considered Harmful`] mailing list post.
166         ///
167         /// Default value: false. This value is likely to change to true in the future.
168         ///
169         /// [`ChannelManager`]: crate::ln::channelmanager::ChannelManager
170         /// [`DecodeError::InvalidValue`]: crate::ln::msgs::DecodeError::InvalidValue
171         /// [`SIGHASH_SINGLE + update_fee Considered Harmful`]: https://lists.linuxfoundation.org/pipermail/lightning-dev/2020-September/002796.html
172         pub negotiate_anchors_zero_fee_htlc_tx: bool,
173 }
174
175 impl Default for ChannelHandshakeConfig {
176         fn default() -> ChannelHandshakeConfig {
177                 ChannelHandshakeConfig {
178                         minimum_depth: 6,
179                         our_to_self_delay: BREAKDOWN_TIMEOUT,
180                         our_htlc_minimum_msat: 1,
181                         max_inbound_htlc_value_in_flight_percent_of_channel: 10,
182                         negotiate_scid_privacy: false,
183                         announced_channel: false,
184                         commit_upfront_shutdown_pubkey: true,
185                         their_channel_reserve_proportional_millionths: 10_000,
186                         #[cfg(anchors)]
187                         negotiate_anchors_zero_fee_htlc_tx: false,
188                 }
189         }
190 }
191
192 /// Optional channel limits which are applied during channel creation.
193 ///
194 /// These limits are only applied to our counterparty's limits, not our own.
195 ///
196 /// Use 0/`<type>::max_value()` as appropriate to skip checking.
197 ///
198 /// Provides sane defaults for most configurations.
199 ///
200 /// Most additional limits are disabled except those with which specify a default in individual
201 /// field documentation. Note that this may result in barely-usable channels, but since they
202 /// are applied mostly only to incoming channels that's not much of a problem.
203 #[derive(Copy, Clone, Debug)]
204 pub struct ChannelHandshakeLimits {
205         /// Minimum allowed satoshis when a channel is funded. This is supplied by the sender and so
206         /// only applies to inbound channels.
207         ///
208         /// Default value: 0.
209         pub min_funding_satoshis: u64,
210         /// Maximum allowed satoshis when a channel is funded. This is supplied by the sender and so
211         /// only applies to inbound channels.
212         ///
213         /// Default value: 2^24 - 1.
214         pub max_funding_satoshis: u64,
215         /// The remote node sets a limit on the minimum size of HTLCs we can send to them. This allows
216         /// you to limit the maximum minimum-size they can require.
217         ///
218         /// Default value: u64::max_value.
219         pub max_htlc_minimum_msat: u64,
220         /// The remote node sets a limit on the maximum value of pending HTLCs to them at any given
221         /// time to limit their funds exposure to HTLCs. This allows you to set a minimum such value.
222         ///
223         /// Default value: 0.
224         pub min_max_htlc_value_in_flight_msat: u64,
225         /// The remote node will require we keep a certain amount in direct payment to ourselves at all
226         /// time, ensuring that we are able to be punished if we broadcast an old state. This allows to
227         /// you limit the amount which we will have to keep to ourselves (and cannot use for HTLCs).
228         ///
229         /// Default value: u64::max_value.
230         pub max_channel_reserve_satoshis: u64,
231         /// The remote node sets a limit on the maximum number of pending HTLCs to them at any given
232         /// time. This allows you to set a minimum such value.
233         ///
234         /// Default value: 0.
235         pub min_max_accepted_htlcs: u16,
236         /// Before a channel is usable the funding transaction will need to be confirmed by at least a
237         /// certain number of blocks, specified by the node which is not the funder (as the funder can
238         /// assume they aren't going to double-spend themselves).
239         /// This config allows you to set a limit on the maximum amount of time to wait.
240         ///
241         /// Default value: 144, or roughly one day and only applies to outbound channels.
242         pub max_minimum_depth: u32,
243         /// Whether we implicitly trust funding transactions generated by us for our own outbound
244         /// channels to not be double-spent.
245         ///
246         /// If this is set, we assume that our own funding transactions are *never* double-spent, and
247         /// thus we can trust them without any confirmations. This is generally a reasonable
248         /// assumption, given we're the only ones who could ever double-spend it (assuming we have sole
249         /// control of the signing keys).
250         ///
251         /// You may wish to un-set this if you allow the user to (or do in an automated fashion)
252         /// double-spend the funding transaction to RBF with an alternative channel open.
253         ///
254         /// This only applies if our counterparty set their confirmations-required value to 0, and we
255         /// always trust our own funding transaction at 1 confirmation irrespective of this value.
256         /// Thus, this effectively acts as a `min_minimum_depth`, with the only possible values being
257         /// `true` (0) and `false` (1).
258         ///
259         /// Default value: true
260         pub trust_own_funding_0conf: bool,
261         /// Set to force an incoming channel to match our announced channel preference in
262         /// [`ChannelHandshakeConfig::announced_channel`].
263         ///
264         /// For a node which is not online reliably, this should be set to true and
265         /// [`ChannelHandshakeConfig::announced_channel`] set to false, ensuring that no announced (aka public)
266         /// channels will ever be opened.
267         ///
268         /// Default value: true.
269         pub force_announced_channel_preference: bool,
270         /// Set to the amount of time we're willing to wait to claim money back to us.
271         ///
272         /// Not checking this value would be a security issue, as our peer would be able to set it to
273         /// max relative lock-time (a year) and we would "lose" money as it would be locked for a long time.
274         ///
275         /// Default value: 2016, which we also enforce as a maximum value so you can tweak config to
276         /// reduce the loss of having useless locked funds (if your peer accepts)
277         pub their_to_self_delay: u16
278 }
279
280 impl Default for ChannelHandshakeLimits {
281         fn default() -> Self {
282                 ChannelHandshakeLimits {
283                         min_funding_satoshis: 0,
284                         max_funding_satoshis: MAX_FUNDING_SATOSHIS_NO_WUMBO,
285                         max_htlc_minimum_msat: <u64>::max_value(),
286                         min_max_htlc_value_in_flight_msat: 0,
287                         max_channel_reserve_satoshis: <u64>::max_value(),
288                         min_max_accepted_htlcs: 0,
289                         trust_own_funding_0conf: true,
290                         max_minimum_depth: 144,
291                         force_announced_channel_preference: true,
292                         their_to_self_delay: MAX_LOCAL_BREAKDOWN_TIMEOUT,
293                 }
294         }
295 }
296
297 /// Options which apply on a per-channel basis and may change at runtime or based on negotiation
298 /// with our counterparty.
299 #[derive(Copy, Clone, Debug, PartialEq, Eq)]
300 pub struct ChannelConfig {
301         /// Amount (in millionths of a satoshi) charged per satoshi for payments forwarded outbound
302         /// over the channel.
303         /// This may be allowed to change at runtime in a later update, however doing so must result in
304         /// update messages sent to notify all nodes of our updated relay fee.
305         ///
306         /// Default value: 0.
307         pub forwarding_fee_proportional_millionths: u32,
308         /// Amount (in milli-satoshi) charged for payments forwarded outbound over the channel, in
309         /// excess of [`forwarding_fee_proportional_millionths`].
310         /// This may be allowed to change at runtime in a later update, however doing so must result in
311         /// update messages sent to notify all nodes of our updated relay fee.
312         ///
313         /// The default value of a single satoshi roughly matches the market rate on many routing nodes
314         /// as of July 2021. Adjusting it upwards or downwards may change whether nodes route through
315         /// this node.
316         ///
317         /// Default value: 1000.
318         ///
319         /// [`forwarding_fee_proportional_millionths`]: ChannelConfig::forwarding_fee_proportional_millionths
320         pub forwarding_fee_base_msat: u32,
321         /// The difference in the CLTV value between incoming HTLCs and an outbound HTLC forwarded over
322         /// the channel this config applies to.
323         ///
324         /// This is analogous to [`ChannelHandshakeConfig::our_to_self_delay`] but applies to in-flight
325         /// HTLC balance when a channel appears on-chain whereas
326         /// [`ChannelHandshakeConfig::our_to_self_delay`] applies to the remaining
327         /// (non-HTLC-encumbered) balance.
328         ///
329         /// Thus, for HTLC-encumbered balances to be enforced on-chain when a channel is force-closed,
330         /// we (or one of our watchtowers) MUST be online to check for broadcast of the current
331         /// commitment transaction at least once per this many blocks (minus some margin to allow us
332         /// enough time to broadcast and confirm a transaction, possibly with time in between to RBF
333         /// the spending transaction).
334         ///
335         /// Default value: 72 (12 hours at an average of 6 blocks/hour).
336         /// Minimum value: [`MIN_CLTV_EXPIRY_DELTA`], any values less than this will be treated as
337         ///                [`MIN_CLTV_EXPIRY_DELTA`] instead.
338         ///
339         /// [`MIN_CLTV_EXPIRY_DELTA`]: crate::ln::channelmanager::MIN_CLTV_EXPIRY_DELTA
340         pub cltv_expiry_delta: u16,
341         /// Limit our total exposure to in-flight HTLCs which are burned to fees as they are too
342         /// small to claim on-chain.
343         ///
344         /// When an HTLC present in one of our channels is below a "dust" threshold, the HTLC will
345         /// not be claimable on-chain, instead being turned into additional miner fees if either
346         /// party force-closes the channel. Because the threshold is per-HTLC, our total exposure
347         /// to such payments may be sustantial if there are many dust HTLCs present when the
348         /// channel is force-closed.
349         ///
350         /// The dust threshold for each HTLC is based on the `dust_limit_satoshis` for each party in a
351         /// channel negotiated throughout the channel open process, along with the fees required to have
352         /// a broadcastable HTLC spending transaction. When a channel supports anchor outputs
353         /// (specifically the zero fee HTLC transaction variant), this threshold no longer takes into
354         /// account the HTLC transaction fee as it is zero.
355         ///
356         /// This limit is applied for sent, forwarded, and received HTLCs and limits the total
357         /// exposure across all three types per-channel. Setting this too low may prevent the
358         /// sending or receipt of low-value HTLCs on high-traffic nodes, and this limit is very
359         /// important to prevent stealing of dust HTLCs by miners.
360         ///
361         /// Default value: 5_000_000 msat.
362         pub max_dust_htlc_exposure_msat: u64,
363         /// The additional fee we're willing to pay to avoid waiting for the counterparty's
364         /// `to_self_delay` to reclaim funds.
365         ///
366         /// When we close a channel cooperatively with our counterparty, we negotiate a fee for the
367         /// closing transaction which both sides find acceptable, ultimately paid by the channel
368         /// funder/initiator.
369         ///
370         /// When we are the funder, because we have to pay the channel closing fee, we bound the
371         /// acceptable fee by our [`Background`] and [`Normal`] fees, with the upper bound increased by
372         /// this value. Because the on-chain fee we'd pay to force-close the channel is kept near our
373         /// [`Normal`] feerate during normal operation, this value represents the additional fee we're
374         /// willing to pay in order to avoid waiting for our counterparty's to_self_delay to reclaim our
375         /// funds.
376         ///
377         /// When we are not the funder, we require the closing transaction fee pay at least our
378         /// [`Background`] fee estimate, but allow our counterparty to pay as much fee as they like.
379         /// Thus, this value is ignored when we are not the funder.
380         ///
381         /// Default value: 1000 satoshis.
382         ///
383         /// [`Normal`]: crate::chain::chaininterface::ConfirmationTarget::Normal
384         /// [`Background`]: crate::chain::chaininterface::ConfirmationTarget::Background
385         pub force_close_avoidance_max_fee_satoshis: u64,
386 }
387
388 impl Default for ChannelConfig {
389         /// Provides sane defaults for most configurations (but with zero relay fees!).
390         fn default() -> Self {
391                 ChannelConfig {
392                         forwarding_fee_proportional_millionths: 0,
393                         forwarding_fee_base_msat: 1000,
394                         cltv_expiry_delta: 6 * 12, // 6 blocks/hour * 12 hours
395                         max_dust_htlc_exposure_msat: 5_000_000,
396                         force_close_avoidance_max_fee_satoshis: 1000,
397                 }
398         }
399 }
400
401 impl_writeable_tlv_based!(ChannelConfig, {
402         (0, forwarding_fee_proportional_millionths, required),
403         (2, forwarding_fee_base_msat, required),
404         (4, cltv_expiry_delta, required),
405         (6, max_dust_htlc_exposure_msat, required),
406         // ChannelConfig serialized this field with a required type of 8 prior to the introduction of
407         // LegacyChannelConfig. To make sure that serialization is not compatible with this one, we use
408         // the next required type of 10, which if seen by the old serialization will always fail.
409         (10, force_close_avoidance_max_fee_satoshis, required),
410 });
411
412 /// Legacy version of [`ChannelConfig`] that stored the static
413 /// [`ChannelHandshakeConfig::announced_channel`] and
414 /// [`ChannelHandshakeConfig::commit_upfront_shutdown_pubkey`] fields.
415 #[derive(Copy, Clone, Debug)]
416 pub(crate) struct LegacyChannelConfig {
417         pub(crate) options: ChannelConfig,
418         /// Deprecated but may still be read from. See [`ChannelHandshakeConfig::announced_channel`] to
419         /// set this when opening/accepting a channel.
420         pub(crate) announced_channel: bool,
421         /// Deprecated but may still be read from. See
422         /// [`ChannelHandshakeConfig::commit_upfront_shutdown_pubkey`] to set this when
423         /// opening/accepting a channel.
424         pub(crate) commit_upfront_shutdown_pubkey: bool,
425 }
426
427 impl Default for LegacyChannelConfig {
428         fn default() -> Self {
429                 Self {
430                         options: ChannelConfig::default(),
431                         announced_channel: false,
432                         commit_upfront_shutdown_pubkey: true,
433                 }
434         }
435 }
436
437 impl crate::util::ser::Writeable for LegacyChannelConfig {
438         fn write<W: crate::util::ser::Writer>(&self, writer: &mut W) -> Result<(), crate::io::Error> {
439                 write_tlv_fields!(writer, {
440                         (0, self.options.forwarding_fee_proportional_millionths, required),
441                         (1, self.options.max_dust_htlc_exposure_msat, (default_value, 5_000_000)),
442                         (2, self.options.cltv_expiry_delta, required),
443                         (3, self.options.force_close_avoidance_max_fee_satoshis, (default_value, 1000)),
444                         (4, self.announced_channel, required),
445                         (6, self.commit_upfront_shutdown_pubkey, required),
446                         (8, self.options.forwarding_fee_base_msat, required),
447                 });
448                 Ok(())
449         }
450 }
451
452 impl crate::util::ser::Readable for LegacyChannelConfig {
453         fn read<R: crate::io::Read>(reader: &mut R) -> Result<Self, crate::ln::msgs::DecodeError> {
454                 let mut forwarding_fee_proportional_millionths = 0;
455                 let mut max_dust_htlc_exposure_msat = 5_000_000;
456                 let mut cltv_expiry_delta = 0;
457                 let mut force_close_avoidance_max_fee_satoshis = 1000;
458                 let mut announced_channel = false;
459                 let mut commit_upfront_shutdown_pubkey = false;
460                 let mut forwarding_fee_base_msat = 0;
461                 read_tlv_fields!(reader, {
462                         (0, forwarding_fee_proportional_millionths, required),
463                         (1, max_dust_htlc_exposure_msat, (default_value, 5_000_000u64)),
464                         (2, cltv_expiry_delta, required),
465                         (3, force_close_avoidance_max_fee_satoshis, (default_value, 1000u64)),
466                         (4, announced_channel, required),
467                         (6, commit_upfront_shutdown_pubkey, required),
468                         (8, forwarding_fee_base_msat, required),
469                 });
470                 Ok(Self {
471                         options: ChannelConfig {
472                                 forwarding_fee_proportional_millionths,
473                                 max_dust_htlc_exposure_msat,
474                                 cltv_expiry_delta,
475                                 force_close_avoidance_max_fee_satoshis,
476                                 forwarding_fee_base_msat,
477                         },
478                         announced_channel,
479                         commit_upfront_shutdown_pubkey,
480                 })
481         }
482 }
483
484 /// Top-level config which holds ChannelHandshakeLimits and ChannelConfig.
485 ///
486 /// Default::default() provides sane defaults for most configurations
487 /// (but currently with 0 relay fees!)
488 #[derive(Copy, Clone, Debug)]
489 pub struct UserConfig {
490         /// Channel handshake config that we propose to our counterparty.
491         pub channel_handshake_config: ChannelHandshakeConfig,
492         /// Limits applied to our counterparty's proposed channel handshake config settings.
493         pub channel_handshake_limits: ChannelHandshakeLimits,
494         /// Channel config which affects behavior during channel lifetime.
495         pub channel_config: ChannelConfig,
496         /// If this is set to false, we will reject any HTLCs which were to be forwarded over private
497         /// channels. This prevents us from taking on HTLC-forwarding risk when we intend to run as a
498         /// node which is not online reliably.
499         ///
500         /// For nodes which are not online reliably, you should set all channels to *not* be announced
501         /// (using [`ChannelHandshakeConfig::announced_channel`] and
502         /// [`ChannelHandshakeLimits::force_announced_channel_preference`]) and set this to false to
503         /// ensure you are not exposed to any forwarding risk.
504         ///
505         /// Note that because you cannot change a channel's announced state after creation, there is no
506         /// way to disable forwarding on public channels retroactively. Thus, in order to change a node
507         /// from a publicly-announced forwarding node to a private non-forwarding node you must close
508         /// all your channels and open new ones. For privacy, you should also change your node_id
509         /// (swapping all private and public key material for new ones) at that time.
510         ///
511         /// Default value: false.
512         pub accept_forwards_to_priv_channels: bool,
513         /// If this is set to false, we do not accept inbound requests to open a new channel.
514         /// Default value: true.
515         pub accept_inbound_channels: bool,
516         /// If this is set to true, the user needs to manually accept inbound requests to open a new
517         /// channel.
518         ///
519         /// When set to true, [`Event::OpenChannelRequest`] will be triggered once a request to open a
520         /// new inbound channel is received through a [`msgs::OpenChannel`] message. In that case, a
521         /// [`msgs::AcceptChannel`] message will not be sent back to the counterparty node unless the
522         /// user explicitly chooses to accept the request.
523         ///
524         /// Default value: false.
525         ///
526         /// [`Event::OpenChannelRequest`]: crate::util::events::Event::OpenChannelRequest
527         /// [`msgs::OpenChannel`]: crate::ln::msgs::OpenChannel
528         /// [`msgs::AcceptChannel`]: crate::ln::msgs::AcceptChannel
529         pub manually_accept_inbound_channels: bool,
530         ///  If this is set to true, LDK will intercept HTLCs that are attempting to be forwarded over
531         ///  fake short channel ids generated via [`ChannelManager::get_intercept_scid`]. Upon HTLC
532         ///  intercept, LDK will generate an [`Event::HTLCIntercepted`] which MUST be handled by the user.
533         ///
534         ///  Setting this to true may break backwards compatibility with LDK versions < 0.0.113.
535         ///
536         ///  Default value: false.
537         ///
538         /// [`ChannelManager::get_intercept_scid`]: crate::ln::channelmanager::ChannelManager::get_intercept_scid
539         /// [`Event::HTLCIntercepted`]: crate::util::events::Event::HTLCIntercepted
540         pub accept_intercept_htlcs: bool,
541 }
542
543 impl Default for UserConfig {
544         fn default() -> Self {
545                 UserConfig {
546                         channel_handshake_config: ChannelHandshakeConfig::default(),
547                         channel_handshake_limits: ChannelHandshakeLimits::default(),
548                         channel_config: ChannelConfig::default(),
549                         accept_forwards_to_priv_channels: false,
550                         accept_inbound_channels: true,
551                         manually_accept_inbound_channels: false,
552                         accept_intercept_htlcs: false,
553                 }
554         }
555 }