Clarify invoice comment noting the relevant final-cltv-expiry vals 2021-06-rustc-bugz
authorMatt Corallo <git@bluematt.me>
Thu, 17 Jun 2021 20:15:39 +0000 (20:15 +0000)
committerMatt Corallo <git@bluematt.me>
Thu, 17 Jun 2021 20:17:24 +0000 (20:17 +0000)
lightning-invoice/src/lib.rs

index f3a1f40bb0ae0d28616f64156adaf7d969aebf94..2ce58f296f9b26b06ec4c92d8b634a57f680d5b3 100644 (file)
@@ -64,7 +64,11 @@ pub const DEFAULT_EXPIRY_TIME: u64 = 3600;
 
 /// Default minimum final CLTV expiry as defined by [BOLT 11].
 ///
+/// Note that this is *not* the same value as rust-lightning's minimum CLTV expiry, which is
+/// provided in [`MIN_FINAL_CLTV_EXPIRY`].
+///
 /// [BOLT 11]: https://github.com/lightningnetwork/lightning-rfc/blob/master/11-payment-encoding.md
+/// [`MIN_FINAL_CLTV_EXPIRY`]: lightning::ln::channelmanager::MIN_FINAL_CLTV_EXPIRY
 pub const DEFAULT_MIN_FINAL_CLTV_EXPIRY: u64 = 18;
 
 /// This function is used as a static assert for the size of `SystemTime`. If the crate fails to