From 3369b2962d7737da209d8a974b3d9bbf55f9bc50 Mon Sep 17 00:00:00 2001 From: Duncan Dean Date: Tue, 10 May 2022 19:01:15 +0200 Subject: [PATCH] Add expiry to non-phantom invoice utils --- lightning-invoice/src/payment.rs | 6 ++--- lightning-invoice/src/utils.rs | 39 +++++++++++++++++++++----------- 2 files changed, 29 insertions(+), 16 deletions(-) diff --git a/lightning-invoice/src/payment.rs b/lightning-invoice/src/payment.rs index 1c8285429..6b79a0123 100644 --- a/lightning-invoice/src/payment.rs +++ b/lightning-invoice/src/payment.rs @@ -1558,7 +1558,7 @@ mod tests { assert!(invoice_payer.pay_invoice(&create_invoice_from_channelmanager_and_duration_since_epoch( &nodes[1].node, nodes[1].keys_manager, Currency::Bitcoin, Some(100_010_000), "Invoice".to_string(), - duration_since_epoch()).unwrap()) + duration_since_epoch(), 3600).unwrap()) .is_ok()); let htlc_msgs = nodes[0].node.get_and_clear_pending_msg_events(); assert_eq!(htlc_msgs.len(), 2); @@ -1604,7 +1604,7 @@ mod tests { assert!(invoice_payer.pay_invoice(&create_invoice_from_channelmanager_and_duration_since_epoch( &nodes[1].node, nodes[1].keys_manager, Currency::Bitcoin, Some(100_010_000), "Invoice".to_string(), - duration_since_epoch()).unwrap()) + duration_since_epoch(), 3600).unwrap()) .is_ok()); let htlc_msgs = nodes[0].node.get_and_clear_pending_msg_events(); assert_eq!(htlc_msgs.len(), 2); @@ -1686,7 +1686,7 @@ mod tests { assert!(invoice_payer.pay_invoice(&create_invoice_from_channelmanager_and_duration_since_epoch( &nodes[1].node, nodes[1].keys_manager, Currency::Bitcoin, Some(100_010_000), "Invoice".to_string(), - duration_since_epoch()).unwrap()) + duration_since_epoch(), 3600).unwrap()) .is_ok()); let htlc_updates = SendEvent::from_node(&nodes[0]); check_added_monitors!(nodes[0], 1); diff --git a/lightning-invoice/src/utils.rs b/lightning-invoice/src/utils.rs index d287ea672..a020e516d 100644 --- a/lightning-invoice/src/utils.rs +++ b/lightning-invoice/src/utils.rs @@ -1,6 +1,6 @@ //! Convenient utilities to create an invoice. -use {CreationError, Currency, DEFAULT_EXPIRY_TIME, Invoice, InvoiceBuilder, SignOrCreationError}; +use {CreationError, Currency, Invoice, InvoiceBuilder, SignOrCreationError}; use payment::{Payer, Router}; use crate::{prelude::*, Description, InvoiceDescription, Sha256}; @@ -20,7 +20,6 @@ use lightning::routing::network_graph::{NetworkGraph, RoutingFees}; use lightning::routing::router::{Route, RouteHint, RouteHintHop, RouteParameters, find_route}; use lightning::util::logger::Logger; use secp256k1::PublicKey; -use core::convert::TryInto; use core::ops::Deref; use core::time::Duration; use sync::Mutex; @@ -213,9 +212,12 @@ fn _create_phantom_invoice( /// method stores the invoice's payment secret and preimage in `ChannelManager`, so (a) the user /// doesn't have to store preimage/payment secret information and (b) `ChannelManager` can verify /// that the payment secret is valid when the invoice is paid. +/// +/// `invoice_expiry_delta_secs` describes the number of seconds that the invoice is valid for +/// in excess of the current time. pub fn create_invoice_from_channelmanager( channelmanager: &ChannelManager, keys_manager: K, network: Currency, - amt_msat: Option, description: String + amt_msat: Option, description: String, invoice_expiry_delta_secs: u32 ) -> Result> where M::Target: chain::Watch, @@ -228,7 +230,8 @@ where let duration = SystemTime::now().duration_since(SystemTime::UNIX_EPOCH) .expect("for the foreseeable future this shouldn't happen"); create_invoice_from_channelmanager_and_duration_since_epoch( - channelmanager, keys_manager, network, amt_msat, description, duration + channelmanager, keys_manager, network, amt_msat, + description, duration, invoice_expiry_delta_secs ) } @@ -239,9 +242,12 @@ where /// doesn't have to store preimage/payment secret information and (b) `ChannelManager` can verify /// that the payment secret is valid when the invoice is paid. /// Use this variant if you want to pass the `description_hash` to the invoice. +/// +/// `invoice_expiry_delta_secs` describes the number of seconds that the invoice is valid for +/// in excess of the current time. pub fn create_invoice_from_channelmanager_with_description_hash( channelmanager: &ChannelManager, keys_manager: K, network: Currency, - amt_msat: Option, description_hash: Sha256, + amt_msat: Option, description_hash: Sha256, invoice_expiry_delta_secs: u32 ) -> Result> where M::Target: chain::Watch, @@ -257,7 +263,8 @@ where .expect("for the foreseeable future this shouldn't happen"); create_invoice_from_channelmanager_with_description_hash_and_duration_since_epoch( - channelmanager, keys_manager, network, amt_msat, description_hash, duration, + channelmanager, keys_manager, network, amt_msat, + description_hash, duration, invoice_expiry_delta_secs ) } @@ -267,6 +274,7 @@ where pub fn create_invoice_from_channelmanager_with_description_hash_and_duration_since_epoch( channelmanager: &ChannelManager, keys_manager: K, network: Currency, amt_msat: Option, description_hash: Sha256, duration_since_epoch: Duration, + invoice_expiry_delta_secs: u32 ) -> Result> where M::Target: chain::Watch, @@ -278,7 +286,7 @@ where _create_invoice_from_channelmanager_and_duration_since_epoch( channelmanager, keys_manager, network, amt_msat, InvoiceDescription::Hash(&description_hash), - duration_since_epoch, + duration_since_epoch, invoice_expiry_delta_secs ) } @@ -288,6 +296,7 @@ where pub fn create_invoice_from_channelmanager_and_duration_since_epoch( channelmanager: &ChannelManager, keys_manager: K, network: Currency, amt_msat: Option, description: String, duration_since_epoch: Duration, + invoice_expiry_delta_secs: u32 ) -> Result> where M::Target: chain::Watch, @@ -301,13 +310,14 @@ where InvoiceDescription::Direct( &Description::new(description).map_err(SignOrCreationError::CreationError)?, ), - duration_since_epoch, + duration_since_epoch, invoice_expiry_delta_secs ) } fn _create_invoice_from_channelmanager_and_duration_since_epoch( channelmanager: &ChannelManager, keys_manager: K, network: Currency, amt_msat: Option, description: InvoiceDescription, duration_since_epoch: Duration, + invoice_expiry_delta_secs: u32 ) -> Result> where M::Target: chain::Watch, @@ -321,7 +331,7 @@ where // `create_inbound_payment` only returns an error if the amount is greater than the total bitcoin // supply. let (payment_hash, payment_secret) = channelmanager - .create_inbound_payment(amt_msat, DEFAULT_EXPIRY_TIME.try_into().unwrap()) + .create_inbound_payment(amt_msat, invoice_expiry_delta_secs) .map_err(|()| SignOrCreationError::CreationError(CreationError::InvalidAmount))?; let our_node_pubkey = channelmanager.get_our_node_id(); @@ -338,7 +348,8 @@ where .payment_hash(Hash::from_slice(&payment_hash.0).unwrap()) .payment_secret(payment_secret) .basic_mpp() - .min_final_cltv_expiry(MIN_FINAL_CLTV_EXPIRY.into()); + .min_final_cltv_expiry(MIN_FINAL_CLTV_EXPIRY.into()) + .expiry_time(Duration::from_secs(invoice_expiry_delta_secs.into())); if let Some(amt) = amt_msat { invoice = invoice.amount_milli_satoshis(amt); } @@ -527,12 +538,14 @@ mod test { let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]); let nodes = create_network(2, &node_cfgs, &node_chanmgrs); create_unannounced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known()); + let non_default_invoice_expiry_secs = 4200; let invoice = create_invoice_from_channelmanager_and_duration_since_epoch( &nodes[1].node, nodes[1].keys_manager, Currency::BitcoinTestnet, Some(10_000), "test".to_string(), - Duration::from_secs(1234567)).unwrap(); + Duration::from_secs(1234567), non_default_invoice_expiry_secs).unwrap(); assert_eq!(invoice.amount_pico_btc(), Some(100_000)); assert_eq!(invoice.min_final_cltv_expiry(), MIN_FINAL_CLTV_EXPIRY as u64); assert_eq!(invoice.description(), InvoiceDescription::Direct(&Description("test".to_string()))); + assert_eq!(invoice.expiry_time(), Duration::from_secs(non_default_invoice_expiry_secs.into())); // Invoice SCIDs should always use inbound SCID aliases over the real channel ID, if one is // available. @@ -593,7 +606,7 @@ mod test { let description_hash = crate::Sha256(Hash::hash("Testing description_hash".as_bytes())); let invoice = ::utils::create_invoice_from_channelmanager_with_description_hash_and_duration_since_epoch( &nodes[1].node, nodes[1].keys_manager, Currency::BitcoinTestnet, Some(10_000), - description_hash, Duration::from_secs(1234567), + description_hash, Duration::from_secs(1234567), 3600 ).unwrap(); assert_eq!(invoice.amount_pico_btc(), Some(100_000)); assert_eq!(invoice.min_final_cltv_expiry(), MIN_FINAL_CLTV_EXPIRY as u64); @@ -753,7 +766,7 @@ mod test { ) { let invoice = create_invoice_from_channelmanager_and_duration_since_epoch( &invoice_node.node, invoice_node.keys_manager, Currency::BitcoinTestnet, invoice_amt, "test".to_string(), - Duration::from_secs(1234567)).unwrap(); + Duration::from_secs(1234567), 3600).unwrap(); let hints = invoice.private_routes(); for hint in hints { -- 2.39.5