git.bitcoin.ninja 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'd like a transaction to confirm in the future, but don't want to commit most of the fees
  52         /// required to do so yet. The remaining fees will come via a Child-Pays-For-Parent (CPFP) fee
  53         /// bump of the transaction.
  54         ///
  55         /// The feerate returned should be the absolute minimum feerate required to enter most node
  56         /// mempools across the network. Note that if you are not able to obtain this feerate estimate,
  57         /// you should likely use the furthest-out estimate allowed by your fee estimator.
  58         MempoolMinimum,
  59         /// We are happy with a transaction confirming slowly, at least within a day or so worth of
  60         /// blocks.
  61         Background,
  62         /// We'd like a transaction to confirm without major delayed, i.e., within the next 12-24 blocks.
  63         Normal,
  64         /// We'd like a transaction to confirm in the next few blocks.
  65         HighPriority,
  66 }
  67
  68 /// A trait which should be implemented to provide feerate information on a number of time
  69 /// horizons.
  70 ///
  71 /// If access to a local mempool is not feasible, feerate estimates should be fetched from a set of
  72 /// third-parties hosting them. Note that this enables them to affect the propagation of your
  73 /// pre-signed transactions at any time and therefore endangers the safety of channels funds. It
  74 /// should be considered carefully as a deployment.
  75 ///
  76 /// Note that all of the functions implemented here *must* be reentrant-safe (obviously - they're
  77 /// called from inside the library in response to chain events, P2P events, or timer events).
  78 pub trait FeeEstimator {
  79         /// Gets estimated satoshis of fee required per 1000 Weight-Units.
  80         ///
  81         /// LDK will wrap this method and ensure that the value returned is no smaller than 253
  82         /// (ie 1 satoshi-per-byte rounded up to ensure later round-downs don't put us below 1 satoshi-per-byte).
  83         ///
  84         /// The following unit conversions can be used to convert to sats/KW:
  85         ///  * satoshis-per-byte * 250
  86         ///  * satoshis-per-kbyte / 4
  87         fn get_est_sat_per_1000_weight(&self, confirmation_target: ConfirmationTarget) -> u32;
  88 }
  89
  90 /// Minimum relay fee as required by bitcoin network mempool policy.
  91 pub const MIN_RELAY_FEE_SAT_PER_1000_WEIGHT: u64 = 4000;
  92 /// Minimum feerate that takes a sane approach to bitcoind weight-to-vbytes rounding.
  93 /// See the following Core Lightning commit for an explanation:
  94 /// <https://github.com/ElementsProject/lightning/commit/2e687b9b352c9092b5e8bd4a688916ac50b44af0>
  95 pub const FEERATE_FLOOR_SATS_PER_KW: u32 = 253;
  96
  97 /// Wraps a `Deref` to a `FeeEstimator` so that any fee estimations provided by it
  98 /// are bounded below by `FEERATE_FLOOR_SATS_PER_KW` (253 sats/KW).
  99 ///
 100 /// Note that this does *not* implement [`FeeEstimator`] to make it harder to accidentally mix the
 101 /// two.
 102 pub(crate) struct LowerBoundedFeeEstimator<F: Deref>(pub F) where F::Target: FeeEstimator;
 103
 104 impl<F: Deref> LowerBoundedFeeEstimator<F> where F::Target: FeeEstimator {
 105         /// Creates a new `LowerBoundedFeeEstimator` which wraps the provided fee_estimator
 106         pub fn new(fee_estimator: F) -> Self {
 107                 LowerBoundedFeeEstimator(fee_estimator)
 108         }
 109
 110         pub fn bounded_sat_per_1000_weight(&self, confirmation_target: ConfirmationTarget) -> u32 {
 111                 cmp::max(
 112                         self.0.get_est_sat_per_1000_weight(confirmation_target),
 113                         FEERATE_FLOOR_SATS_PER_KW,
 114                 )
 115         }
 116 }
 117
 118 #[cfg(test)]
 119 mod tests {
 120         use super::{FEERATE_FLOOR_SATS_PER_KW, LowerBoundedFeeEstimator, ConfirmationTarget, FeeEstimator};
 121
 122         struct TestFeeEstimator {
 123                 sat_per_kw: u32,
 124         }
 125
 126         impl FeeEstimator for TestFeeEstimator {
 127                 fn get_est_sat_per_1000_weight(&self, _: ConfirmationTarget) -> u32 {
 128                         self.sat_per_kw
 129                 }
 130         }
 131
 132         #[test]
 133         fn test_fee_estimator_less_than_floor() {
 134                 let sat_per_kw = FEERATE_FLOOR_SATS_PER_KW - 1;
 135                 let test_fee_estimator = &TestFeeEstimator { sat_per_kw };
 136                 let fee_estimator = LowerBoundedFeeEstimator::new(test_fee_estimator);
 137
 138                 assert_eq!(fee_estimator.bounded_sat_per_1000_weight(ConfirmationTarget::Background), FEERATE_FLOOR_SATS_PER_KW);
 139         }
 140
 141         #[test]
 142         fn test_fee_estimator_greater_than_floor() {
 143                 let sat_per_kw = FEERATE_FLOOR_SATS_PER_KW + 1;
 144                 let test_fee_estimator = &TestFeeEstimator { sat_per_kw };
 145                 let fee_estimator = LowerBoundedFeeEstimator::new(test_fee_estimator);
 146
 147                 assert_eq!(fee_estimator.bounded_sat_per_1000_weight(ConfirmationTarget::Background), sat_per_kw);
 148         }
 149 }