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