_ 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
  18 use bitcoin::blockdata::transaction::Transaction;
  19
  20 /// An interface to send a transaction to the Bitcoin network.
  21 pub trait BroadcasterInterface {
  22         /// Sends a list of transactions out to (hopefully) be mined.
  23         /// This only needs to handle the actual broadcasting of transactions, LDK will automatically
  24         /// rebroadcast transactions that haven't made it into a block.
  25         ///
  26         /// In some cases LDK may attempt to broadcast a transaction which double-spends another
  27         /// and this isn't a bug and can be safely ignored.
  28         ///
  29         /// If more than one transaction is given, these transactions should be considered to be a
  30         /// package and broadcast together. Some of the transactions may or may not depend on each other,
  31         /// be sure to manage both cases correctly.
  32         ///
  33         /// Bitcoin transaction packages are defined in BIP 331 and here:
  34         /// https://github.com/bitcoin/bitcoin/blob/master/doc/policy/packages.md
  35         fn broadcast_transactions(&self, txs: &[&Transaction]);
  36 }
  37
  38 /// An enum that represents the priority at which we want a transaction to confirm used for feerate
  39 /// estimation.
  40 #[derive(Clone, Copy, Debug, Hash, PartialEq, Eq)]
  41 pub enum ConfirmationTarget {
  42         /// We'd like a transaction to confirm in the future, but don't want to commit most of the fees
  43         /// required to do so yet. The remaining fees will come via a Child-Pays-For-Parent (CPFP) fee
  44         /// bump of the transaction.
  45         ///
  46         /// The feerate returned should be the absolute minimum feerate required to enter most node
  47         /// mempools across the network. Note that if you are not able to obtain this feerate estimate,
  48         /// you should likely use the furthest-out estimate allowed by your fee estimator.
  49         MempoolMinimum,
  50         /// We are happy with a transaction confirming slowly, at least within a day or so worth of
  51         /// blocks.
  52         Background,
  53         /// We'd like a transaction to confirm without major delayed, i.e., within the next 12-24 blocks.
  54         Normal,
  55         /// We'd like a transaction to confirm in the next few blocks.
  56         HighPriority,
  57 }
  58
  59 /// A trait which should be implemented to provide feerate information on a number of time
  60 /// horizons.
  61 ///
  62 /// Note that all of the functions implemented here *must* be reentrant-safe (obviously - they're
  63 /// called from inside the library in response to chain events, P2P events, or timer events).
  64 pub trait FeeEstimator {
  65         /// Gets estimated satoshis of fee required per 1000 Weight-Units.
  66         ///
  67         /// LDK will wrap this method and ensure that the value returned is no smaller than 253
  68         /// (ie 1 satoshi-per-byte rounded up to ensure later round-downs don't put us below 1 satoshi-per-byte).
  69         ///
  70         /// The following unit conversions can be used to convert to sats/KW:
  71         ///  * satoshis-per-byte * 250
  72         ///  * satoshis-per-kbyte / 4
  73         fn get_est_sat_per_1000_weight(&self, confirmation_target: ConfirmationTarget) -> u32;
  74 }
  75
  76 /// Minimum relay fee as required by bitcoin network mempool policy.
  77 pub const MIN_RELAY_FEE_SAT_PER_1000_WEIGHT: u64 = 4000;
  78 /// Minimum feerate that takes a sane approach to bitcoind weight-to-vbytes rounding.
  79 /// See the following Core Lightning commit for an explanation:
  80 /// <https://github.com/ElementsProject/lightning/commit/2e687b9b352c9092b5e8bd4a688916ac50b44af0>
  81 pub const FEERATE_FLOOR_SATS_PER_KW: u32 = 253;
  82
  83 /// Wraps a `Deref` to a `FeeEstimator` so that any fee estimations provided by it
  84 /// are bounded below by `FEERATE_FLOOR_SATS_PER_KW` (253 sats/KW).
  85 ///
  86 /// Note that this does *not* implement [`FeeEstimator`] to make it harder to accidentally mix the
  87 /// two.
  88 pub(crate) struct LowerBoundedFeeEstimator<F: Deref>(pub F) where F::Target: FeeEstimator;
  89
  90 impl<F: Deref> LowerBoundedFeeEstimator<F> where F::Target: FeeEstimator {
  91         /// Creates a new `LowerBoundedFeeEstimator` which wraps the provided fee_estimator
  92         pub fn new(fee_estimator: F) -> Self {
  93                 LowerBoundedFeeEstimator(fee_estimator)
  94         }
  95
  96         pub fn bounded_sat_per_1000_weight(&self, confirmation_target: ConfirmationTarget) -> u32 {
  97                 cmp::max(
  98                         self.0.get_est_sat_per_1000_weight(confirmation_target),
  99                         FEERATE_FLOOR_SATS_PER_KW,
 100                 )
 101         }
 102 }
 103
 104 #[cfg(test)]
 105 mod tests {
 106         use super::{FEERATE_FLOOR_SATS_PER_KW, LowerBoundedFeeEstimator, ConfirmationTarget, FeeEstimator};
 107
 108         struct TestFeeEstimator {
 109                 sat_per_kw: u32,
 110         }
 111
 112         impl FeeEstimator for TestFeeEstimator {
 113                 fn get_est_sat_per_1000_weight(&self, _: ConfirmationTarget) -> u32 {
 114                         self.sat_per_kw
 115                 }
 116         }
 117
 118         #[test]
 119         fn test_fee_estimator_less_than_floor() {
 120                 let sat_per_kw = FEERATE_FLOOR_SATS_PER_KW - 1;
 121                 let test_fee_estimator = &TestFeeEstimator { sat_per_kw };
 122                 let fee_estimator = LowerBoundedFeeEstimator::new(test_fee_estimator);
 123
 124                 assert_eq!(fee_estimator.bounded_sat_per_1000_weight(ConfirmationTarget::Background), FEERATE_FLOOR_SATS_PER_KW);
 125         }
 126
 127         #[test]
 128         fn test_fee_estimator_greater_than_floor() {
 129                 let sat_per_kw = FEERATE_FLOOR_SATS_PER_KW + 1;
 130                 let test_fee_estimator = &TestFeeEstimator { sat_per_kw };
 131                 let fee_estimator = LowerBoundedFeeEstimator::new(test_fee_estimator);
 132
 133                 assert_eq!(fee_estimator.bounded_sat_per_1000_weight(ConfirmationTarget::Background), sat_per_kw);
 134         }
 135 }