]> git.bitcoin.ninja Git - rust-lightning/commitdiff
Updates Fee estimator docs to include a max return value for get_est_sat_per_1000_weight
authorConor Okus <cokus@cokus-macbookpro.local>
Wed, 8 Dec 2021 17:15:57 +0000 (17:15 +0000)
committerConor Okus <cokus@cokus-macbookpro.local>
Tue, 14 Dec 2021 12:36:34 +0000 (12:36 +0000)
Updates docs to include a max return value for get_est_sat_per_1000_weight

Adds max to both conversions

Additional detail

lightning/src/chain/chaininterface.rs

index 8ccfb945543ada51199c6db6874c1507cb96cb36..cca51e3185130c4c99f76d4517805fd5129fb029 100644 (file)
@@ -41,12 +41,12 @@ pub enum ConfirmationTarget {
 pub trait FeeEstimator {
        /// Gets estimated satoshis of fee required per 1000 Weight-Units.
        ///
-       /// Must be no smaller than 253 (ie 1 satoshi-per-byte rounded up to ensure later round-downs
-       /// don't put us below 1 satoshi-per-byte).
+       /// Must return a value no smaller than 253 (ie 1 satoshi-per-byte rounded up to ensure later  
+       /// round-downs don't put us below 1 satoshi-per-byte).
        ///
-       /// This translates to:
-       ///  * satoshis-per-byte * 250
-       ///  * ceil(satoshis-per-kbyte / 4)
+       /// This method can be implemented with the following unit conversions: 
+       ///  * max(satoshis-per-byte * 250, 253)
+       ///  * max(satoshis-per-kbyte / 4, 253)
        fn get_est_sat_per_1000_weight(&self, confirmation_target: ConfirmationTarget) -> u32;
 }