_ Git - rust-lightning/blob - lightning/src/chain/chaininterface.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 //! Traits and utility impls which allow other parts of rust-lightning to interact with the
  11 //! blockchain.
  12 //!
  13 //! Includes traits for monitoring and receiving notifications of new blocks and block
  14 //! disconnections, transaction broadcasting, and feerate information requests.
  15
  16 use core::{cmp, ops::Deref};
  17 use core::convert::TryInto;
  18
  19 use bitcoin::blockdata::transaction::Transaction;
  20
  21 // TODO: Define typed abstraction over feerates to handle their conversions.
  22 pub(crate) fn compute_feerate_sat_per_1000_weight(fee_sat: u64, weight: u64) -> u32 {
  23         (fee_sat * 1000 / weight).try_into().unwrap_or(u32::max_value())
  24 }
  25 pub(crate) const fn fee_for_weight(feerate_sat_per_1000_weight: u32, weight: u64) -> u64 {
  26         ((feerate_sat_per_1000_weight as u64 * weight) + 1000 - 1) / 1000
  27 }
  28
  29 /// An interface to send a transaction to the Bitcoin network.
  30 pub trait BroadcasterInterface {
  31         /// Sends a list of transactions out to (hopefully) be mined.
  32         /// This only needs to handle the actual broadcasting of transactions, LDK will automatically
  33         /// rebroadcast transactions that haven't made it into a block.
  34         ///
  35         /// In some cases LDK may attempt to broadcast a transaction which double-spends another
  36         /// and this isn't a bug and can be safely ignored.
  37         ///
  38         /// If more than one transaction is given, these transactions should be considered to be a
  39         /// package and broadcast together. Some of the transactions may or may not depend on each other,
  40         /// be sure to manage both cases correctly.
  41         ///
  42         /// Bitcoin transaction packages are defined in BIP 331 and here:
  43         /// https://github.com/bitcoin/bitcoin/blob/master/doc/policy/packages.md
  44         fn broadcast_transactions(&self, txs: &[&Transaction]);
  45 }
  46
  47 /// An enum that represents the priority at which we want a transaction to confirm used for feerate
  48 /// estimation.
  49 #[derive(Clone, Copy, Debug, Hash, PartialEq, Eq)]
  50 pub enum ConfirmationTarget {
  51         /// We have some funds available on chain which we need to spend prior to some expiry time at
  52         /// which point our counterparty may be able to steal them. Generally we have in the high tens
  53         /// to low hundreds of blocks to get our transaction on-chain, but we shouldn't risk too low a
  54         /// fee - this should be a relatively high priority feerate.
  55         OnChainSweep,
  56         /// The highest feerate we will allow our channel counterparty to have in a non-anchor channel.
  57         ///
  58         /// This is the feerate on the transaction which we (or our counterparty) will broadcast in
  59         /// order to close the channel unilaterally. Because our counterparty must ensure they can
  60         /// always broadcast the latest state, this value being too low will cause immediate
  61         /// force-closures.
  62         ///
  63         /// Allowing this value to be too high can allow our counterparty to burn our HTLC outputs to
  64         /// dust, which can result in HTLCs failing or force-closures (when the dust HTLCs exceed
  65         /// [`ChannelConfig::max_dust_htlc_exposure`]).
  66         ///
  67         /// Because most nodes use a feerate estimate which is based on a relatively high priority
  68         /// transaction entering the current mempool, setting this to a small multiple of your current
  69         /// high priority feerate estimate should suffice.
  70         ///
  71         /// [`ChannelConfig::max_dust_htlc_exposure`]: crate::util::config::ChannelConfig::max_dust_htlc_exposure
  72         MaxAllowedNonAnchorChannelRemoteFee,
  73         /// This is the lowest feerate we will allow our channel counterparty to have in an anchor
  74         /// channel in order to close the channel if a channel party goes away.
  75         ///
  76         /// This needs to be sufficient to get into the mempool when the channel needs to
  77         /// be force-closed. Setting too high may result in force-closures if our counterparty attempts
  78         /// to use a lower feerate. Because this is for anchor channels, we can always bump the feerate
  79         /// later; the feerate here only needs to be sufficient to enter the mempool.
  80         ///
  81         /// A good estimate is the expected mempool minimum at the time of force-closure. Obviously this
  82         /// is not an estimate which is very easy to calculate because we do not know the future. Using
  83         /// a simple long-term fee estimate or tracking of the mempool minimum is a good approach to
  84         /// ensure you can always close the channel. A future change to Bitcoin's P2P network
  85         /// (package relay) may obviate the need for this entirely.
  86         MinAllowedAnchorChannelRemoteFee,
  87         /// The lowest feerate we will allow our channel counterparty to have in a non-anchor channel.
  88         /// This needs to be sufficient to get confirmed when the channel needs to be force-closed.
  89         /// Setting too low may result in force-closures.
  90         ///
  91         /// This is the feerate on the transaction which we (or our counterparty) will broadcast in
  92         /// order to close the channel if a channel party goes away. Because our counterparty must
  93         /// ensure they can always broadcast the latest state, this value being too high will cause
  94         /// immediate force-closures.
  95         ///
  96         /// This feerate represents the fee we pick now, which must be sufficient to enter a block at an
  97         /// arbitrary time in the future. Obviously this is not an estimate which is very easy to
  98         /// calculate. This can leave channels subject to being unable to close if feerates rise, and in
  99         /// general you should prefer anchor channels to ensure you can increase the feerate when the
 100         /// transactions need broadcasting.
 101         ///
 102         /// Do note some fee estimators round up to the next full sat/vbyte (ie 250 sats per kw),
 103         /// causing occasional issues with feerate disagreements between an initiator that wants a
 104         /// feerate of 1.1 sat/vbyte and a receiver that wants 1.1 rounded up to 2. If your fee
 105         /// estimator rounds subtracting 250 to your desired feerate here can help avoid this issue.
 106         ///
 107         /// [`ChannelConfig::max_dust_htlc_exposure`]: crate::util::config::ChannelConfig::max_dust_htlc_exposure
 108         MinAllowedNonAnchorChannelRemoteFee,
 109         /// This is the feerate on the transaction which we (or our counterparty) will broadcast in
 110         /// order to close the channel if a channel party goes away.
 111         ///
 112         /// This needs to be sufficient to get into the mempool when the channel needs to
 113         /// be force-closed. Setting too low may result in force-closures. Because this is for anchor
 114         /// channels, it can be a low value as we can always bump the feerate later.
 115         ///
 116         /// A good estimate is the expected mempool minimum at the time of force-closure. Obviously this
 117         /// is not an estimate which is very easy to calculate because we do not know the future. Using
 118         /// a simple long-term fee estimate or tracking of the mempool minimum is a good approach to
 119         /// ensure you can always close the channel. A future change to Bitcoin's P2P network
 120         /// (package relay) may obviate the need for this entirely.
 121         AnchorChannelFee,
 122         /// Lightning is built around the ability to broadcast a transaction in the future to close our
 123         /// channel and claim all pending funds. In order to do so, non-anchor channels are built with
 124         /// transactions which we need to be able to broadcast at some point in the future.
 125         ///
 126         /// This feerate represents the fee we pick now, which must be sufficient to enter a block at an
 127         /// arbitrary time in the future. Obviously this is not an estimate which is very easy to
 128         /// calculate, so most lightning nodes use some relatively high-priority feerate using the
 129         /// current mempool. This leaves channels subject to being unable to close if feerates rise, and
 130         /// in general you should prefer anchor channels to ensure you can increase the feerate when the
 131         /// transactions need broadcasting.
 132         ///
 133         /// Since this should represent the feerate of a channel close that does not need fee
 134         /// bumping, this is also used as an upper bound for our attempted feerate when doing cooperative
 135         /// closure of any channel.
 136         NonAnchorChannelFee,
 137         /// When cooperatively closing a channel, this is the minimum feerate we will accept.
 138         /// Recommended at least within a day or so worth of blocks.
 139         ///
 140         /// This will also be used when initiating a cooperative close of a channel. When closing a
 141         /// channel you can override this fee by using
 142         /// [`ChannelManager::close_channel_with_feerate_and_script`].
 143         ///
 144         /// [`ChannelManager::close_channel_with_feerate_and_script`]: crate::ln::channelmanager::ChannelManager::close_channel_with_feerate_and_script
 145         ChannelCloseMinimum,
 146 }
 147
 148 /// A trait which should be implemented to provide feerate information on a number of time
 149 /// horizons.
 150 ///
 151 /// If access to a local mempool is not feasible, feerate estimates should be fetched from a set of
 152 /// third-parties hosting them. Note that this enables them to affect the propagation of your
 153 /// pre-signed transactions at any time and therefore endangers the safety of channels funds. It
 154 /// should be considered carefully as a deployment.
 155 ///
 156 /// Note that all of the functions implemented here *must* be reentrant-safe (obviously - they're
 157 /// called from inside the library in response to chain events, P2P events, or timer events).
 158 pub trait FeeEstimator {
 159         /// Gets estimated satoshis of fee required per 1000 Weight-Units.
 160         ///
 161         /// LDK will wrap this method and ensure that the value returned is no smaller than 253
 162         /// (ie 1 satoshi-per-byte rounded up to ensure later round-downs don't put us below 1 satoshi-per-byte).
 163         ///
 164         /// The following unit conversions can be used to convert to sats/KW:
 165         ///  * satoshis-per-byte * 250
 166         ///  * satoshis-per-kbyte / 4
 167         fn get_est_sat_per_1000_weight(&self, confirmation_target: ConfirmationTarget) -> u32;
 168 }
 169
 170 /// Minimum relay fee as required by bitcoin network mempool policy.
 171 pub const MIN_RELAY_FEE_SAT_PER_1000_WEIGHT: u64 = 4000;
 172 /// Minimum feerate that takes a sane approach to bitcoind weight-to-vbytes rounding.
 173 /// See the following Core Lightning commit for an explanation:
 174 /// <https://github.com/ElementsProject/lightning/commit/2e687b9b352c9092b5e8bd4a688916ac50b44af0>
 175 pub const FEERATE_FLOOR_SATS_PER_KW: u32 = 253;
 176
 177 /// Wraps a `Deref` to a `FeeEstimator` so that any fee estimations provided by it
 178 /// are bounded below by `FEERATE_FLOOR_SATS_PER_KW` (253 sats/KW).
 179 ///
 180 /// Note that this does *not* implement [`FeeEstimator`] to make it harder to accidentally mix the
 181 /// two.
 182 pub(crate) struct LowerBoundedFeeEstimator<F: Deref>(pub F) where F::Target: FeeEstimator;
 183
 184 impl<F: Deref> LowerBoundedFeeEstimator<F> where F::Target: FeeEstimator {
 185         /// Creates a new `LowerBoundedFeeEstimator` which wraps the provided fee_estimator
 186         pub fn new(fee_estimator: F) -> Self {
 187                 LowerBoundedFeeEstimator(fee_estimator)
 188         }
 189
 190         pub fn bounded_sat_per_1000_weight(&self, confirmation_target: ConfirmationTarget) -> u32 {
 191                 cmp::max(
 192                         self.0.get_est_sat_per_1000_weight(confirmation_target),
 193                         FEERATE_FLOOR_SATS_PER_KW,
 194                 )
 195         }
 196 }
 197
 198 #[cfg(test)]
 199 mod tests {
 200         use super::{FEERATE_FLOOR_SATS_PER_KW, LowerBoundedFeeEstimator, ConfirmationTarget, FeeEstimator};
 201
 202         struct TestFeeEstimator {
 203                 sat_per_kw: u32,
 204         }
 205
 206         impl FeeEstimator for TestFeeEstimator {
 207                 fn get_est_sat_per_1000_weight(&self, _: ConfirmationTarget) -> u32 {
 208                         self.sat_per_kw
 209                 }
 210         }
 211
 212         #[test]
 213         fn test_fee_estimator_less_than_floor() {
 214                 let sat_per_kw = FEERATE_FLOOR_SATS_PER_KW - 1;
 215                 let test_fee_estimator = &TestFeeEstimator { sat_per_kw };
 216                 let fee_estimator = LowerBoundedFeeEstimator::new(test_fee_estimator);
 217
 218                 assert_eq!(fee_estimator.bounded_sat_per_1000_weight(ConfirmationTarget::AnchorChannelFee), FEERATE_FLOOR_SATS_PER_KW);
 219         }
 220
 221         #[test]
 222         fn test_fee_estimator_greater_than_floor() {
 223                 let sat_per_kw = FEERATE_FLOOR_SATS_PER_KW + 1;
 224                 let test_fee_estimator = &TestFeeEstimator { sat_per_kw };
 225                 let fee_estimator = LowerBoundedFeeEstimator::new(test_fee_estimator);
 226
 227                 assert_eq!(fee_estimator.bounded_sat_per_1000_weight(ConfirmationTarget::AnchorChannelFee), sat_per_kw);
 228         }
 229 }