Merge pull request #1137 from joschisan/receive-for-hash-min-final-cltv

Add receive_for_hash_with_min_final_cltv_expiry_delta

Author: tnull

src/payment/bolt11.rs

@@ -102,12 +102,14 @@ impl Bolt11Payment {
 	pub(crate) fn receive_inner(
 		&self, amount_msat: Option<u64>, invoice_description: &LdkBolt11InvoiceDescription,
 		expiry_secs: u32, manual_claim_payment_hash: Option<PaymentHash>,
+		min_final_cltv_expiry_delta: Option<u16>,
 	) -> Result<LdkBolt11Invoice, Error> {
 		let invoice_params = Bolt11InvoiceParameters {
 			amount_msats: amount_msat,
 			description: invoice_description.clone(),
 			invoice_expiry_delta_secs: Some(expiry_secs),
 			payment_hash: manual_claim_payment_hash,
+			min_final_cltv_expiry_delta,
 			..Default::default()
 		};
 
@@ -557,7 +559,8 @@ impl Bolt11Payment {
 		&self, amount_msat: u64, description: &Bolt11InvoiceDescription, expiry_secs: u32,
 	) -> Result<Bolt11Invoice, Error> {
 		let description = maybe_try_convert_enum(description)?;
-		let invoice = self.receive_inner(Some(amount_msat), &description, expiry_secs, None)?;
+		let invoice =
+			self.receive_inner(Some(amount_msat), &description, expiry_secs, None, None)?;
 		Ok(maybe_wrap(invoice))
 	}
 
@@ -586,8 +589,39 @@ impl Bolt11Payment {
 		payment_hash: PaymentHash,
 	) -> Result<Bolt11Invoice, Error> {
 		let description = maybe_try_convert_enum(description)?;
-		let invoice =
-			self.receive_inner(Some(amount_msat), &description, expiry_secs, Some(payment_hash))?;
+		let invoice = self.receive_inner(
+			Some(amount_msat),
+			&description,
+			expiry_secs,
+			Some(payment_hash),
+			None,
+		)?;
+		Ok(maybe_wrap(invoice))
+	}
+
+	/// Same as [`receive_for_hash`], but requires the payment's final HTLC to leave at least
+	/// `min_final_cltv_expiry_delta` blocks until it expires, giving the user that much more time
+	/// to obtain the preimage.
+	///
+	/// The invoice requests three blocks more than the given value, to allow for blocks being
+	/// connected while the payment is in flight, and an HTLC arriving with fewer than
+	/// `min_final_cltv_expiry_delta` blocks left is failed back without a [`PaymentClaimable`]
+	/// event.
+	///
+	/// [`receive_for_hash`]: Self::receive_for_hash
+	/// [`PaymentClaimable`]: crate::Event::PaymentClaimable
+	pub fn receive_for_hash_with_min_final_cltv_expiry_delta(
+		&self, amount_msat: u64, description: &Bolt11InvoiceDescription, expiry_secs: u32,
+		payment_hash: PaymentHash, min_final_cltv_expiry_delta: u16,
+	) -> Result<Bolt11Invoice, Error> {
+		let description = maybe_try_convert_enum(description)?;
+		let invoice = self.receive_inner(
+			Some(amount_msat),
+			&description,
+			expiry_secs,
+			Some(payment_hash),
+			Some(min_final_cltv_expiry_delta),
+		)?;
 		Ok(maybe_wrap(invoice))
 	}
 
@@ -599,7 +633,7 @@ impl Bolt11Payment {
 		&self, description: &Bolt11InvoiceDescription, expiry_secs: u32,
 	) -> Result<Bolt11Invoice, Error> {
 		let description = maybe_try_convert_enum(description)?;
-		let invoice = self.receive_inner(None, &description, expiry_secs, None)?;
+		let invoice = self.receive_inner(None, &description, expiry_secs, None, None)?;
 		Ok(maybe_wrap(invoice))
 	}
 
@@ -627,7 +661,8 @@ impl Bolt11Payment {
 		&self, description: &Bolt11InvoiceDescription, expiry_secs: u32, payment_hash: PaymentHash,
 	) -> Result<Bolt11Invoice, Error> {
 		let description = maybe_try_convert_enum(description)?;
-		let invoice = self.receive_inner(None, &description, expiry_secs, Some(payment_hash))?;
+		let invoice =
+			self.receive_inner(None, &description, expiry_secs, Some(payment_hash), None)?;
 		Ok(maybe_wrap(invoice))
 	}
 

src/payment/unified.rs

@@ -156,6 +156,7 @@ impl UnifiedPayment {
 			&invoice_description,
 			expiry_sec,
 			None,
+			None,
 		) {
 			Ok(invoice) => Some(invoice),
 			Err(e) => {

tests/common/mod.rs

@@ -1587,6 +1587,39 @@ pub(crate) async fn do_channel_full_cycle<E: ElectrumApi>(
 	assert_eq!(manual_payment.amount_msat, Some(invoice_amount_3_msat));
 	assert!(matches!(&manual_payment.kind, PaymentKind::Bolt11 { .. }));
 
+	// Test claiming manually registered payments that require a longer final CLTV expiry.
+	let manual_cltv_amount_msat = 5_532_000;
+	let min_final_cltv_expiry_delta = 81;
+	let manual_cltv_preimage = PaymentPreimage([44u8; 32]);
+	let manual_cltv_payment_hash =
+		PaymentHash(Sha256::hash(&manual_cltv_preimage.0).to_byte_array());
+	let manual_cltv_invoice = node_b
+		.bolt11_payment()
+		.receive_for_hash_with_min_final_cltv_expiry_delta(
+			manual_cltv_amount_msat,
+			&invoice_description.clone().into(),
+			9217,
+			manual_cltv_payment_hash,
+			min_final_cltv_expiry_delta,
+		)
+		.unwrap();
+	assert_eq!(
+		manual_cltv_invoice.min_final_cltv_expiry_delta(),
+		u64::from(min_final_cltv_expiry_delta) + 3
+	);
+	let outbound_manual_cltv_payment_id =
+		node_a.bolt11_payment().send(&manual_cltv_invoice, None).unwrap();
+
+	let (manual_cltv_payment_id, claimable_amount_msat) =
+		expect_payment_claimable_event!(node_b, manual_cltv_payment_hash, manual_cltv_amount_msat);
+	node_b
+		.bolt11_payment()
+		.claim_for_id(manual_cltv_payment_id, claimable_amount_msat, manual_cltv_preimage)
+		.unwrap();
+	let received_payment_id = expect_payment_received_event!(node_b, claimable_amount_msat);
+	assert_eq!(received_payment_id, manual_cltv_payment_id);
+	expect_payment_successful_event!(node_a, outbound_manual_cltv_payment_id, None);
+
 	// Test failing manually registered payments.
 	let invoice_amount_4_msat = 5_532_000;
 	let manual_fail_preimage = PaymentPreimage([43u8; 32]);
@@ -1658,11 +1691,11 @@ pub(crate) async fn do_channel_full_cycle<E: ElectrumApi>(
 	assert!(matches!(&received_keysend_payment.kind, PaymentKind::Spontaneous { .. }));
 	assert_eq!(
 		node_a.list_payments_matching(|p| matches!(p.kind, PaymentKind::Bolt11 { .. })).len(),
-		5
+		6
 	);
 	assert_eq!(
 		node_b.list_payments_matching(|p| matches!(p.kind, PaymentKind::Bolt11 { .. })).len(),
-		5
+		6
 	);
 	assert_eq!(
 		node_a.list_payments_matching(|p| matches!(p.kind, PaymentKind::Spontaneous { .. })).len(),
@@ -1875,6 +1908,7 @@ pub(crate) async fn do_channel_full_cycle<E: ElectrumApi>(
 		+ invoice_amount_1_msat
 		+ overpaid_amount_msat
 		+ invoice_amount_3_msat
+		+ manual_cltv_amount_msat
 		+ determined_amount_msat
 		+ keysend_amount_msat)
 		/ 1000 - splice_out_sat;