]> git.bitcoin.ninja Git - rust-lightning/blob - lightning/src/util/config.rs
Merge pull request #641 from jkczyz/2020-06-deterministic-test-logging
[rust-lightning] / lightning / src / util / config.rs
1 //! Various user-configurable channel limits and settings which ChannelManager
2 //! applies for you.
3
4 use ln::channelmanager::{BREAKDOWN_TIMEOUT, MAX_LOCAL_BREAKDOWN_TIMEOUT};
5
6 /// Top-level config which holds ChannelHandshakeLimits and ChannelConfig.
7 ///
8 /// Default::default() provides sane defaults for most configurations
9 /// (but currently with 0 relay fees!)
10 #[derive(Clone, Debug)]
11 pub struct UserConfig {
12         /// Channel config that we propose to our counterparty.
13         pub own_channel_config: ChannelHandshakeConfig,
14         /// Limits applied to our counterparty's proposed channel config settings.
15         pub peer_channel_config_limits: ChannelHandshakeLimits,
16         /// Channel config which affects behavior during channel lifetime.
17         pub channel_options: ChannelConfig,
18 }
19
20 impl Default for UserConfig {
21         fn default() -> Self {
22                 UserConfig {
23                         own_channel_config: ChannelHandshakeConfig::default(),
24                         peer_channel_config_limits: ChannelHandshakeLimits::default(),
25                         channel_options: ChannelConfig::default(),
26                 }
27         }
28 }
29
30 /// Configuration we set when applicable.
31 ///
32 /// Default::default() provides sane defaults.
33 #[derive(Clone, Debug)]
34 pub struct ChannelHandshakeConfig {
35         /// Confirmations we will wait for before considering the channel locked in.
36         /// Applied only for inbound channels (see ChannelHandshakeLimits::max_minimum_depth for the
37         /// equivalent limit applied to outbound channels).
38         ///
39         /// Default value: 6.
40         pub minimum_depth: u32,
41         /// Set to the amount of time we require our counterparty to wait to claim their money.
42         ///
43         /// It's one of the main parameter of our security model. We (or one of our watchtowers) MUST
44         /// be online to check for peer having broadcast a revoked transaction to steal our funds
45         /// at least once every our_to_self_delay blocks.
46         ///
47         /// Meanwhile, asking for a too high delay, we bother peer to freeze funds for nothing in
48         /// case of an honest unilateral channel close, which implicitly decrease the economic value of
49         /// our channel.
50         ///
51         /// Default value: BREAKDOWN_TIMEOUT (currently 144), we enforce it as a minimum at channel
52         /// opening so you can tweak config to ask for more security, not less.
53         pub our_to_self_delay: u16,
54         /// Set to the smallest value HTLC we will accept to process.
55         ///
56         /// This value is sent to our counterparty on channel-open and we close the channel any time
57         /// our counterparty misbehaves by sending us an HTLC with a value smaller than this.
58         ///
59         /// Default value: 1. If the value is less than 1, it is ignored and set to 1, as is required
60         /// by the protocol.
61         pub our_htlc_minimum_msat: u64,
62 }
63
64 impl Default for ChannelHandshakeConfig {
65         fn default() -> ChannelHandshakeConfig {
66                 ChannelHandshakeConfig {
67                         minimum_depth: 6,
68                         our_to_self_delay: BREAKDOWN_TIMEOUT,
69                         our_htlc_minimum_msat: 1,
70                 }
71         }
72 }
73
74 /// Optional channel limits which are applied during channel creation.
75 ///
76 /// These limits are only applied to our counterparty's limits, not our own.
77 ///
78 /// Use 0/<type>::max_value() as appropriate to skip checking.
79 ///
80 /// Provides sane defaults for most configurations.
81 ///
82 /// Most additional limits are disabled except those with which specify a default in individual
83 /// field documentation. Note that this may result in barely-usable channels, but since they
84 /// are applied mostly only to incoming channels that's not much of a problem.
85 #[derive(Copy, Clone, Debug)]
86 pub struct ChannelHandshakeLimits {
87         /// Minimum allowed satoshis when a channel is funded, this is supplied by the sender and so
88         /// only applies to inbound channels.
89         ///
90         /// Default value: 0.
91         pub min_funding_satoshis: u64,
92         /// The remote node sets a limit on the minimum size of HTLCs we can send to them. This allows
93         /// you to limit the maximum minimum-size they can require.
94         ///
95         /// Default value: u64::max_value.
96         pub max_htlc_minimum_msat: u64,
97         /// The remote node sets a limit on the maximum value of pending HTLCs to them at any given
98         /// time to limit their funds exposure to HTLCs. This allows you to set a minimum such value.
99         ///
100         /// Default value: 0.
101         pub min_max_htlc_value_in_flight_msat: u64,
102         /// The remote node will require we keep a certain amount in direct payment to ourselves at all
103         /// time, ensuring that we are able to be punished if we broadcast an old state. This allows to
104         /// you limit the amount which we will have to keep to ourselves (and cannot use for HTLCs).
105         ///
106         /// Default value: u64::max_value.
107         pub max_channel_reserve_satoshis: u64,
108         /// The remote node sets a limit on the maximum number of pending HTLCs to them at any given
109         /// time. This allows you to set a minimum such value.
110         ///
111         /// Default value: 0.
112         pub min_max_accepted_htlcs: u16,
113         /// Outputs below a certain value will not be added to on-chain transactions. The dust value is
114         /// required to always be higher than this value so this only applies to HTLC outputs (and
115         /// potentially to-self outputs before any payments have been made).
116         /// Thus, HTLCs below this amount plus HTLC transaction fees are not enforceable on-chain.
117         /// This setting allows you to set a minimum dust limit for their commitment transactions,
118         /// reflecting the reality that tiny outputs are not considered standard transactions and will
119         /// not propagate through the Bitcoin network.
120         ///
121         /// Default value: 546, the current dust limit on the Bitcoin network.
122         pub min_dust_limit_satoshis: u64,
123         /// Maximum allowed threshold above which outputs will not be generated in their commitment
124         /// transactions.
125         /// HTLCs below this amount plus HTLC transaction fees are not enforceable on-chain.
126         ///
127         /// Default value: u64::max_value.
128         pub max_dust_limit_satoshis: u64,
129         /// Before a channel is usable the funding transaction will need to be confirmed by at least a
130         /// certain number of blocks, specified by the node which is not the funder (as the funder can
131         /// assume they aren't going to double-spend themselves).
132         /// This config allows you to set a limit on the maximum amount of time to wait.
133         ///
134         /// Default value: 144, or roughly one day and only applies to outbound channels.
135         pub max_minimum_depth: u32,
136         /// Set to force the incoming channel to match our announced channel preference in
137         /// ChannelConfig.
138         ///
139         /// Default value: true, to make the default that no announced channels are possible (which is
140         /// appropriate for any nodes which are not online very reliably).
141         pub force_announced_channel_preference: bool,
142         /// Set to the amount of time we're willing to wait to claim money back to us.
143         ///
144         /// Not checking this value would be a security issue, as our peer would be able to set it to
145         /// max relative lock-time (a year) and we would "lose" money as it would be locked for a long time.
146         ///
147         /// Default value: MAX_LOCAL_BREAKDOWN_TIMEOUT (1008), which we also enforce as a maximum value
148         /// so you can tweak config to reduce the loss of having useless locked funds (if your peer accepts)
149         pub their_to_self_delay: u16
150 }
151
152 impl Default for ChannelHandshakeLimits {
153         fn default() -> Self {
154                 ChannelHandshakeLimits {
155                         min_funding_satoshis: 0,
156                         max_htlc_minimum_msat: <u64>::max_value(),
157                         min_max_htlc_value_in_flight_msat: 0,
158                         max_channel_reserve_satoshis: <u64>::max_value(),
159                         min_max_accepted_htlcs: 0,
160                         min_dust_limit_satoshis: 546,
161                         max_dust_limit_satoshis: <u64>::max_value(),
162                         max_minimum_depth: 144,
163                         force_announced_channel_preference: true,
164                         their_to_self_delay: MAX_LOCAL_BREAKDOWN_TIMEOUT,
165                 }
166         }
167 }
168
169 /// Options which apply on a per-channel basis and may change at runtime or based on negotiation
170 /// with our counterparty.
171 #[derive(Copy, Clone, Debug)]
172 pub struct ChannelConfig {
173         /// Amount (in millionths of a satoshi) the channel will charge per transferred satoshi.
174         /// This may be allowed to change at runtime in a later update, however doing so must result in
175         /// update messages sent to notify all nodes of our updated relay fee.
176         ///
177         /// Default value: 0.
178         pub fee_proportional_millionths: u32,
179         /// Set to announce the channel publicly and notify all nodes that they can route via this
180         /// channel.
181         ///
182         /// This should only be set to true for nodes which expect to be online reliably.
183         ///
184         /// As the node which funds a channel picks this value this will only apply for new outbound
185         /// channels unless ChannelHandshakeLimits::force_announced_channel_preferences is set.
186         ///
187         /// This cannot be changed after the initial channel handshake.
188         ///
189         /// Default value: false.
190         pub announced_channel: bool,
191         /// When set, we commit to an upfront shutdown_pubkey at channel open. If our counterparty
192         /// supports it, they will then enforce the mutual-close output to us matches what we provided
193         /// at intialization, preventing us from closing to an alternate pubkey.
194         ///
195         /// This is set to true by default to provide a slight increase in security, though ultimately
196         /// any attacker who is able to take control of a channel can just as easily send the funds via
197         /// lightning payments, so we never require that our counterparties support this option.
198         ///
199         /// This cannot be changed after a channel has been initialized.
200         ///
201         /// Default value: true.
202         pub commit_upfront_shutdown_pubkey: bool
203 }
204
205 impl Default for ChannelConfig {
206         /// Provides sane defaults for most configurations (but with zero relay fees!).
207         fn default() -> Self {
208                 ChannelConfig {
209                         fee_proportional_millionths: 0,
210                         announced_channel: false,
211                         commit_upfront_shutdown_pubkey: true,
212                 }
213         }
214 }
215
216 //Add write and readable traits to channelconfig
217 impl_writeable!(ChannelConfig, 8+1+1, {
218         fee_proportional_millionths,
219         announced_channel,
220         commit_upfront_shutdown_pubkey
221 });