Pass context into held_htlc_available message handling.

Useful for using the payment_id within to look up the outbound payment.

Author: valentinewallace

fuzz/src/onion_message.rs

@@ -6,7 +6,7 @@ use bitcoin::secp256k1::ecdsa::RecoverableSignature;
 use bitcoin::secp256k1::schnorr;
 use bitcoin::secp256k1::{self, PublicKey, Scalar, Secp256k1, SecretKey};
 
-use lightning::blinded_path::message::{MessageContext, OffersContext};
+use lightning::blinded_path::message::{AsyncPaymentsContext, MessageContext, OffersContext};
 use lightning::blinded_path::{BlindedPath, EmptyNodeIdLookUp};
 use lightning::ln::features::InitFeatures;
 use lightning::ln::msgs::{self, DecodeError, OnionMessageHandler};
@@ -125,7 +125,7 @@ impl AsyncPaymentsMessageHandler for TestAsyncPaymentsMessageHandler {
 		responder
 			.respond(ReleaseHeldHtlc { payment_release_secret: message.payment_release_secret })
 	}
-	fn release_held_htlc(&self, _message: ReleaseHeldHtlc) {}
+	fn release_held_htlc(&self, _message: ReleaseHeldHtlc, _context: AsyncPaymentsContext) {}
 }
 
 #[derive(Debug)]

lightning/src/ln/channelmanager.rs

@@ -31,7 +31,7 @@ use bitcoin::secp256k1::{SecretKey,PublicKey};
 use bitcoin::secp256k1::Secp256k1;
 use bitcoin::{secp256k1, Sequence};
 
-use crate::blinded_path::message::{MessageContext, OffersContext};
+use crate::blinded_path::message::{AsyncPaymentsContext, MessageContext, OffersContext};
 use crate::blinded_path::{BlindedPath, NodeIdLookUp};
 use crate::blinded_path::message::ForwardNode;
 use crate::blinded_path::payment::{Bolt12OfferContext, Bolt12RefundContext, PaymentConstraints, PaymentContext, ReceiveTlvs};
@@ -10686,7 +10686,7 @@ where
 		ResponseInstruction::NoResponse
 	}
 
-	fn release_held_htlc(&self, _message: ReleaseHeldHtlc) {}
+	fn release_held_htlc(&self, _message: ReleaseHeldHtlc, _context: AsyncPaymentsContext) {}
 
 	fn release_pending_messages(&self) -> Vec<PendingOnionMessage<AsyncPaymentsMessage>> {
 		Vec::new()

lightning/src/ln/peer_handler.rs

@@ -18,7 +18,7 @@
 use bitcoin::blockdata::constants::ChainHash;
 use bitcoin::secp256k1::{self, Secp256k1, SecretKey, PublicKey};
 
-use crate::blinded_path::message::OffersContext;
+use crate::blinded_path::message::{AsyncPaymentsContext, OffersContext};
 use crate::sign::{NodeSigner, Recipient};
 use crate::events::{MessageSendEvent, MessageSendEventsProvider};
 use crate::ln::types::ChannelId;
@@ -152,11 +152,11 @@ impl OffersMessageHandler for IgnoringMessageHandler {
 }
 impl AsyncPaymentsMessageHandler for IgnoringMessageHandler {
 	fn held_htlc_available(
-		&self, _message: HeldHtlcAvailable, _responder: Option<Responder>,
+		&self, _message: HeldHtlcAvailable, _responder: Option<Responder>
 	) -> ResponseInstruction<ReleaseHeldHtlc> {
 		ResponseInstruction::NoResponse
 	}
-	fn release_held_htlc(&self, _message: ReleaseHeldHtlc) {}
+	fn release_held_htlc(&self, _message: ReleaseHeldHtlc, _context: AsyncPaymentsContext) {}
 }
 impl CustomOnionMessageHandler for IgnoringMessageHandler {
 	type CustomMessage = Infallible;

lightning/src/onion_message/async_payments.rs

@@ -9,6 +9,7 @@
 
 //! Message handling for async payments.
 
+use crate::blinded_path::message::AsyncPaymentsContext;
 use crate::io;
 use crate::ln::msgs::DecodeError;
 #[cfg(not(c_bindings))]
@@ -34,7 +35,7 @@ pub trait AsyncPaymentsMessageHandler {
 
 	/// Handle a [`ReleaseHeldHtlc`] message. If authentication of the message succeeds, an HTLC
 	/// should be released to the corresponding payee.
-	fn release_held_htlc(&self, message: ReleaseHeldHtlc);
+	fn release_held_htlc(&self, message: ReleaseHeldHtlc, context: AsyncPaymentsContext);
 
 	/// Release any [`AsyncPaymentsMessage`]s that need to be sent.
 	///

lightning/src/onion_message/functional_tests.rs

@@ -10,7 +10,7 @@
 //! Onion message testing and test utilities live here.
 
 use crate::blinded_path::{BlindedPath, EmptyNodeIdLookUp};
-use crate::blinded_path::message::{ForwardNode, MessageContext, OffersContext};
+use crate::blinded_path::message::{AsyncPaymentsContext, ForwardNode, MessageContext, OffersContext};
 use crate::events::{Event, EventsProvider};
 use crate::ln::features::{ChannelFeatures, InitFeatures};
 use crate::ln::msgs::{self, DecodeError, OnionMessageHandler};
@@ -89,7 +89,7 @@ impl AsyncPaymentsMessageHandler for TestAsyncPaymentsMessageHandler {
 	) -> ResponseInstruction<ReleaseHeldHtlc> {
 		ResponseInstruction::NoResponse
 	}
-	fn release_held_htlc(&self, _message: ReleaseHeldHtlc) {}
+	fn release_held_htlc(&self, _message: ReleaseHeldHtlc, _context: AsyncPaymentsContext) {}
 }
 
 #[derive(Clone, Debug, PartialEq)]

lightning/src/onion_message/messenger.rs

@@ -1473,14 +1473,22 @@ where
 					},
 					#[cfg(async_payments)]
 					ParsedOnionMessageContents::AsyncPayments(AsyncPaymentsMessage::HeldHtlcAvailable(msg)) => {
+						debug_assert!(context.is_none());
 						let response_instructions = self.async_payments_handler.held_htlc_available(
 							msg, responder
 						);
 						let _ = self.handle_onion_message_response(response_instructions);
 					},
 					#[cfg(async_payments)]
 					ParsedOnionMessageContents::AsyncPayments(AsyncPaymentsMessage::ReleaseHeldHtlc(msg)) => {
-						self.async_payments_handler.release_held_htlc(msg);
+						let context = match context {
+							Some(MessageContext::AsyncPayments(context)) => context,
+							_ => {
+								debug_assert!(false, "Shouldn't have triggered this case.");
+								return
+							},
+						};
+						self.async_payments_handler.release_held_htlc(msg, context);
 					},
 					ParsedOnionMessageContents::Custom(msg) => {
 						let context = match context {