Add PaymentHash to Record

    Adding the `payment_hash` to `Record` so we are able to track it
    in logs.

Author: jbesraa

lightning/src/chain/chainmonitor.rs

@@ -760,7 +760,7 @@ where C::Target: chain::Filter,
 		let monitors = self.monitors.read().unwrap();
 		match monitors.get(&funding_txo) {
 			None => {
-				let logger = WithContext::from(&self.logger, update.counterparty_node_id, Some(channel_id));
+				let logger = WithContext::from(&self.logger, update.counterparty_node_id, Some(channel_id), None);
 				log_error!(logger, "Failed to update channel monitor: no such monitor registered");
 
 				// We should never ever trigger this from within ChannelManager. Technically a

lightning/src/ln/channel.rs

@@ -923,25 +923,28 @@ pub(super) struct WithChannelContext<'a, L: Deref> where L::Target: Logger {
 	pub logger: &'a L,
 	pub peer_id: Option<PublicKey>,
 	pub channel_id: Option<ChannelId>,
+	pub payment_hash: Option<PaymentHash>,
 }
 
 impl<'a, L: Deref> Logger for WithChannelContext<'a, L> where L::Target: Logger {
 	fn log(&self, mut record: Record) {
 		record.peer_id = self.peer_id;
 		record.channel_id = self.channel_id;
+		record.payment_hash = self.payment_hash;
 		self.logger.log(record)
 	}
 }
 
 impl<'a, 'b, L: Deref> WithChannelContext<'a, L>
 where L::Target: Logger {
-	pub(super) fn from<S: Deref>(logger: &'a L, context: &'b ChannelContext<S>) -> Self
+	pub(super) fn from<S: Deref>(logger: &'a L, context: &'b ChannelContext<S>, payment_hash: Option<PaymentHash>) -> Self
 	where S::Target: SignerProvider
 	{
 		WithChannelContext {
 			logger,
 			peer_id: Some(context.counterparty_node_id),
 			channel_id: Some(context.channel_id),
+			payment_hash
 		}
 	}
 }
@@ -1571,7 +1574,7 @@ impl<SP: Deref> ChannelContext<SP> where SP::Target: SignerProvider  {
 			L::Target: Logger,
 			SP::Target: SignerProvider,
 	{
-		let logger = WithContext::from(logger, Some(counterparty_node_id), Some(open_channel_fields.temporary_channel_id));
+		let logger = WithContext::from(logger, Some(counterparty_node_id), Some(open_channel_fields.temporary_channel_id), None);
 		let announced_channel = if (open_channel_fields.channel_flags & 1) == 1 { true } else { false };
 
 		let channel_value_satoshis = our_funding_satoshis.saturating_add(open_channel_fields.funding_satoshis);
@@ -7859,7 +7862,7 @@ impl<SP: Deref> InboundV1Channel<SP> where SP::Target: SignerProvider {
 			  F::Target: FeeEstimator,
 			  L::Target: Logger,
 	{
-		let logger = WithContext::from(logger, Some(counterparty_node_id), Some(msg.common_fields.temporary_channel_id));
+		let logger = WithContext::from(logger, Some(counterparty_node_id), Some(msg.common_fields.temporary_channel_id), None);
 
 		// First check the channel type is known, failing before we do anything else if we don't
 		// support this channel type.

lightning/src/ln/channelmanager.rs

@@ -877,13 +877,12 @@ where
 		&self, contents: T, destination: Destination, reply_path: Option<BlindedPath>,
 		log_suffix: fmt::Arguments
 	) -> Result<SendSuccess, SendError> {
-		let mut logger = WithContext::from(&self.logger, None, None);
-		let result = self.find_path(destination)
-			.and_then(|path| {
-				let first_hop = path.intermediate_nodes.get(0).map(|p| *p);
-				logger = WithContext::from(&self.logger, first_hop, None);
-				self.enqueue_onion_message(path, contents, reply_path, log_suffix)
-			});
+		let mut logger = WithContext::from(&self.logger, None, None, None);
+		let result = self.find_path(destination).and_then(|path| {
+			let first_hop = path.intermediate_nodes.get(0).map(|p| *p);
+			logger = WithContext::from(&self.logger, first_hop, None, None);
+			self.enqueue_onion_message(path, contents, reply_path, log_suffix)
+		});
 
 		match result.as_ref() {
 			Err(SendError::GetNodeIdFailed) => {
@@ -1063,7 +1062,7 @@ where
 	CMH::Target: CustomOnionMessageHandler,
 {
 	fn handle_onion_message(&self, peer_node_id: &PublicKey, msg: &OnionMessage) {
-		let logger = WithContext::from(&self.logger, Some(*peer_node_id), None);
+		let logger = WithContext::from(&self.logger, Some(*peer_node_id), None, None);
 		match self.peel_onion_message(msg) {
 			Ok(PeeledOnion::Receive(message, path_id, reply_path)) => {
 				log_trace!(

lightning/src/ln/peer_handler.rs

@@ -21,6 +21,7 @@ use core::fmt;
 use core::ops::Deref;
 
 use crate::ln::types::ChannelId;
+use crate::ln::PaymentHash;
 #[cfg(c_bindings)]
 use crate::prelude::*; // Needed for String
 
@@ -120,6 +121,11 @@ pub struct Record<$($args)?> {
 	pub file: &'static str,
 	/// The line containing the message.
 	pub line: u32,
+	/// The payment hash.
+	///
+	/// Note that this is only filled in for logs pertaining to a specific payment, and will be
+	/// `None` for logs which are not directly related to a payment.
+	pub payment_hash: Option<PaymentHash>,
 }
 
 impl<$($args)?> Record<$($args)?> {
@@ -129,7 +135,8 @@ impl<$($args)?> Record<$($args)?> {
 	#[inline]
 	pub fn new<$($nonstruct_args)?>(
 		level: Level, peer_id: Option<PublicKey>, channel_id: Option<ChannelId>,
-		args: fmt::Arguments<'a>, module_path: &'static str, file: &'static str, line: u32
+		args: fmt::Arguments<'a>, module_path: &'static str, file: &'static str, line: u32,
+		payment_hash: Option<PaymentHash>
 	) -> Record<$($args)?> {
 		Record {
 			level,
@@ -142,6 +149,7 @@ impl<$($args)?> Record<$($args)?> {
 			module_path,
 			file,
 			line,
+			payment_hash,
 		}
 	}
 }
@@ -168,6 +176,8 @@ pub struct WithContext<'a, L: Deref> where L::Target: Logger {
 	peer_id: Option<PublicKey>,
 	/// The channel id of the channel pertaining to the logged record.
 	channel_id: Option<ChannelId>,
+	/// The payment hash of the payment pertaining to the logged record.
+	payment_hash: Option<PaymentHash>
 }
 
 impl<'a, L: Deref> Logger for WithContext<'a, L> where L::Target: Logger {
@@ -178,17 +188,21 @@ impl<'a, L: Deref> Logger for WithContext<'a, L> where L::Target: Logger {
 		if self.channel_id.is_some() {
 			record.channel_id = self.channel_id;
 		}
+		if self.payment_hash.is_some() {
+			record.payment_hash = self.payment_hash;
+		}
 		self.logger.log(record)
 	}
 }
 
 impl<'a, L: Deref> WithContext<'a, L> where L::Target: Logger {
 	/// Wraps the given logger, providing additional context to any logged records.
-	pub fn from(logger: &'a L, peer_id: Option<PublicKey>, channel_id: Option<ChannelId>) -> Self {
+	pub fn from(logger: &'a L, peer_id: Option<PublicKey>, channel_id: Option<ChannelId>, payment_hash: Option<PaymentHash>) -> Self {
 		WithContext {
 			logger,
 			peer_id,
 			channel_id,
+			payment_hash,
 		}
 	}
 }
@@ -245,6 +259,7 @@ impl<T: fmt::Display, I: core::iter::Iterator<Item = T> + Clone> fmt::Display fo
 mod tests {
 	use bitcoin::secp256k1::{PublicKey, SecretKey, Secp256k1};
 	use crate::ln::types::ChannelId;
+	use crate::ln::PaymentHash;
 	use crate::util::logger::{Logger, Level, WithContext};
 	use crate::util::test_utils::TestLogger;
 	use crate::sync::Arc;
@@ -291,7 +306,8 @@ mod tests {
 		let logger = &TestLogger::new();
 		let secp_ctx = Secp256k1::new();
 		let pk = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
-		let context_logger = WithContext::from(&logger, Some(pk), Some(ChannelId([0; 32])));
+		let payment_hash = PaymentHash([0; 32]);
+		let context_logger = WithContext::from(&logger, Some(pk), Some(ChannelId([0; 32])), Some(payment_hash));
 		log_error!(context_logger, "This is an error");
 		log_warn!(context_logger, "This is an error");
 		log_debug!(context_logger, "This is an error");
@@ -308,8 +324,9 @@ mod tests {
 		let logger = &TestLogger::new();
 		let secp_ctx = Secp256k1::new();
 		let pk = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
-		let context_logger = &WithContext::from(&logger, None, Some(ChannelId([0; 32])));
-		let full_context_logger = WithContext::from(&context_logger, Some(pk), None);
+		let payment_hash = PaymentHash([0; 32]);
+		let context_logger = &WithContext::from(&logger, None, Some(ChannelId([0; 32])), Some(payment_hash));
+		let full_context_logger = WithContext::from(&context_logger, Some(pk), None, None);
 		log_error!(full_context_logger, "This is an error");
 		log_warn!(full_context_logger, "This is an error");
 		log_debug!(full_context_logger, "This is an error");

lightning/src/onion_message/messenger.rs

@@ -148,7 +148,7 @@ macro_rules! log_spendable {
 #[macro_export]
 macro_rules! log_internal {
 	($logger: expr, $lvl:expr, $($arg:tt)+) => (
-		$logger.log($crate::util::logger::Record::new($lvl, None, None, format_args!($($arg)+), module_path!(), file!(), line!()))
+		$logger.log($crate::util::logger::Record::new($lvl, None, None, format_args!($($arg)+), module_path!(), file!(), line!(), None))
 	);
 }