Deduplicate node id and payment hash logging

Now that the default Display implementation of Record also outputs
structured log fields, that data can be removed from the log messages.
This declutters the log output and also helps with verticality in the
code.

Note that deduplication is only carried out for log statements that are
always called in a log context. For some statements this isn't the case
because not every caller sets up the context. Those are left unchanged.

Author: joostjager

lightning/src/ln/channelmanager.rs

@@ -5243,7 +5243,7 @@ where
 		.map_err(|e| {
 			let first_hop_key = Some(path.hops.first().unwrap().pubkey);
 			let logger = WithContext::from(&self.logger, first_hop_key, None, Some(*payment_hash));
-			log_error!(logger, "Failed to build an onion for path for payment hash {payment_hash}");
+			log_error!(logger, "Failed to build an onion for path");
 			e
 		})?;
 
@@ -5272,7 +5272,7 @@ where
 			);
 			log_trace!(
 				logger,
-				"Attempting to send payment with payment hash {payment_hash} along path with next hop {first_chan_scid}"
+				"Attempting to send payment along path with next hop {first_chan_scid}"
 			);
 
 			let per_peer_state = self.per_peer_state.read().unwrap();
@@ -6746,7 +6746,10 @@ where
 						Some(*next_hop_channel_id),
 						None,
 					);
-					log_error!(logger, "Channel not found for the passed counterparty node_id {next_node_id} when attempting to forward intercepted HTLC");
+					log_error!(
+						logger,
+						"Channel not found when attempting to forward intercepted HTLC"
+					);
 					return Err(APIError::ChannelUnavailable {
 						err: format!(
 						"Channel with id {next_hop_channel_id} not found for the passed counterparty node_id {next_node_id}"
@@ -7485,8 +7488,13 @@ where
 						} else {
 							"alternate"
 						};
-					log_trace!(logger, "Forwarding HTLC from SCID {} with payment_hash {} and next hop SCID {} over {} with corresponding peer {}",
-						prev_outbound_scid_alias, &payment_hash, short_chan_id, channel_description, &counterparty_node_id);
+					log_trace!(
+						logger,
+						"Forwarding HTLC from SCID {} with next hop SCID {} over {}",
+						prev_outbound_scid_alias,
+						short_chan_id,
+						channel_description
+					);
 					if let Err((reason, msg)) = optimal_channel.queue_add_htlc(
 						*outgoing_amt_msat,
 						*payment_hash,
@@ -7498,13 +7506,7 @@ where
 						&self.fee_estimator,
 						&&logger,
 					) {
-						log_trace!(
-							logger,
-							"Failed to forward HTLC with payment_hash {} to peer {}: {}",
-							&payment_hash,
-							&counterparty_node_id,
-							msg
-						);
+						log_trace!(logger, "Failed to forward HTLC: {}", msg);
 
 						if let Some(chan) = peer_state
 							.channel_by_id
@@ -8188,8 +8190,7 @@ where
 								if peer_state.is_connected {
 									if funded_chan.should_disconnect_peer_awaiting_response() {
 										let logger = WithChannelContext::from(&self.logger, &funded_chan.context, None);
-										log_debug!(logger, "Disconnecting peer {} due to not making any progress",
-												counterparty_node_id);
+										log_debug!(logger, "Disconnecting peer due to not making any progress");
 										pending_msg_events.push(MessageSendEvent::HandleError {
 											node_id: counterparty_node_id,
 											action: msgs::ErrorAction::DisconnectPeerWithWarning {
@@ -8560,9 +8561,8 @@ where
 			}) => {
 				log_trace!(
 					WithContext::from(&self.logger, None, Some(*channel_id), Some(*payment_hash)),
-					"Failing {}HTLC with payment_hash {} backwards from us: {:?}",
+					"Failing {}HTLC backwards from us: {:?}",
 					if blinded_failure.is_some() { "blinded " } else { "" },
-					&payment_hash,
 					onion_error
 				);
 				// In case of trampoline + phantom we prioritize the trampoline failure over the phantom failure.
@@ -9848,9 +9848,9 @@ This indicates a bug inside LDK. Please report this error at https://github.com/
 		let per_peer_state = self.per_peer_state.read().unwrap();
 		let peer_state_mutex = per_peer_state.get(counterparty_node_id)
 		.ok_or_else(|| {
-			let err_str = format!("Can't find a peer matching the passed counterparty node_id {counterparty_node_id}");
-			log_error!(logger, "{}", err_str);
+			log_error!(logger, "Can't find peer matching the passed counterparty node_id");
 
+			let err_str = format!("Can't find a peer matching the passed counterparty node_id {counterparty_node_id}");
 			APIError::ChannelUnavailable { err: err_str }
 		})?;
 		let mut peer_state_lock = peer_state_mutex.lock().unwrap();
@@ -12013,11 +12013,7 @@ This indicates a bug inside LDK. Please report this error at https://github.com/
 								None,
 							);
 						} else {
-							log_trace!(
-								logger,
-								"Failing HTLC with hash {} from our monitor",
-								&htlc_update.payment_hash
-							);
+							log_trace!(logger, "Failing HTLC from our monitor");
 							let failure_reason = LocalHTLCFailureReason::OnChainTimeout;
 							let receiver = HTLCHandlingFailureType::Forward {
 								node_id: Some(counterparty_node_id),
@@ -13684,8 +13680,7 @@ where
 			let remove_peer = {
 				log_debug!(
 					WithContext::from(&self.logger, Some(counterparty_node_id), None, None),
-					"Marking channels with {} disconnected and generating channel_updates.",
-					log_pubkey!(counterparty_node_id)
+					"Marking channels disconnected and generating channel_updates.",
 				);
 				if let Some(peer_state_mutex) = per_peer_state.get(&counterparty_node_id) {
 					let mut peer_state_lock = peer_state_mutex.lock().unwrap();
@@ -13870,7 +13865,7 @@ where
 				}
 			}
 
-			log_debug!(logger, "Generating channel_reestablish events for {}", log_pubkey!(counterparty_node_id));
+			log_debug!(logger, "Generating channel_reestablish events");
 
 			let per_peer_state = self.per_peer_state.read().unwrap();
 			if let Some(peer_state_mutex) = per_peer_state.get(&counterparty_node_id) {
@@ -16868,8 +16863,7 @@ where
 								Some(*payment_hash),
 							);
 							log_info!(logger,
-								"Failing HTLC with hash {} as it is missing in the ChannelMonitor but was present in the (stale) ChannelManager",
-								&payment_hash);
+								"Failing HTLC as it is missing in the ChannelMonitor but was present in the (stale) ChannelManager");
 							failed_htlcs.push((
 								channel_htlc_source.clone(),
 								*payment_hash,
@@ -17523,18 +17517,20 @@ where
 								// still have an entry for this HTLC in `forward_htlcs` or
 								// `pending_intercepted_htlcs`, we were apparently not persisted after
 								// the monitor was when forwarding the payment.
-								decode_update_add_htlcs.retain(|src_outb_alias, update_add_htlcs| {
-									update_add_htlcs.retain(|update_add_htlc| {
-										let matches = *src_outb_alias == prev_hop_data.prev_outbound_scid_alias &&
-											update_add_htlc.htlc_id == prev_hop_data.htlc_id;
-										if matches {
-											log_info!(logger, "Removing pending to-decode HTLC with hash {} as it was forwarded to the closed channel",
-												&htlc.payment_hash);
-										}
-										!matches
-									});
-									!update_add_htlcs.is_empty()
-								});
+								decode_update_add_htlcs.retain(
+									|src_outb_alias, update_add_htlcs| {
+										update_add_htlcs.retain(|update_add_htlc| {
+											let matches = *src_outb_alias
+												== prev_hop_data.prev_outbound_scid_alias
+												&& update_add_htlc.htlc_id == prev_hop_data.htlc_id;
+											if matches {
+												log_info!(logger, "Removing pending to-decode HTLC as it was forwarded to the closed channel");
+											}
+											!matches
+										});
+										!update_add_htlcs.is_empty()
+									},
+								);
 								forward_htlcs.retain(|_, forwards| {
 									forwards.retain(|forward| {
 										if let HTLCForwardInfo::AddHTLC(htlc_info) = forward {