From: José A.P <jose@clovrlabs.com>
Date: Tue, 9 Jan 2024 10:26:14 +0000 (+0100)
Subject: Improved error logging in ChannelManager::do_accept_inbound_channel
X-Git-Tag: v0.0.120~15^2
X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=commitdiff_plain;h=dbe69ba3f02860178c6658122ab6fc4849405470;p=rust-lightning

Improved error logging in ChannelManager::do_accept_inbound_channel

This refactor ensures that all API errors in do_accept_inbound_channel
are logged before they are returned.
---

diff --git a/lightning/src/ln/channelmanager.rs b/lightning/src/ln/channelmanager.rs
index 75cd72b8f..86160c042 100644
--- a/lightning/src/ln/channelmanager.rs
+++ b/lightning/src/ln/channelmanager.rs
@@ -6002,13 +6002,20 @@ where
 	}
 
 	fn do_accept_inbound_channel(&self, temporary_channel_id: &ChannelId, counterparty_node_id: &PublicKey, accept_0conf: bool, user_channel_id: u128) -> Result<(), APIError> {
+
+		let logger = WithContext::from(&self.logger, Some(*counterparty_node_id), Some(*temporary_channel_id));
 		let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
 
 		let peers_without_funded_channels =
 			self.peers_without_funded_channels(|peer| { peer.total_channel_count() > 0 });
 		let per_peer_state = self.per_peer_state.read().unwrap();
 		let peer_state_mutex = per_peer_state.get(counterparty_node_id)
-			.ok_or_else(|| APIError::ChannelUnavailable { err: format!("Can't find a peer matching the passed counterparty node_id {}", 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);
+
+			APIError::ChannelUnavailable { err: err_str } 
+		})?;
 		let mut peer_state_lock = peer_state_mutex.lock().unwrap();
 		let peer_state = &mut *peer_state_lock;
 		let is_only_peer_channel = peer_state.total_channel_count() == 1;
@@ -6023,9 +6030,19 @@ where
 				InboundV1Channel::new(&self.fee_estimator, &self.entropy_source, &self.signer_provider,
 					counterparty_node_id.clone(), &self.channel_type_features(), &peer_state.latest_features,
 					&unaccepted_channel.open_channel_msg, user_channel_id, &self.default_configuration, best_block_height,
-					&self.logger, accept_0conf).map_err(|e| APIError::ChannelUnavailable { err: e.to_string() })
+					&self.logger, accept_0conf).map_err(|e| {
+						let err_str = e.to_string();
+						log_error!(logger, "{}", err_str);
+
+						APIError::ChannelUnavailable { err: err_str }
+					})
+				}
+			_ => { 
+				let err_str = "No such channel awaiting to be accepted.".to_owned();
+				log_error!(logger, "{}", err_str);
+
+				Err(APIError::APIMisuseError { err: err_str })
 			}
-			_ => Err(APIError::APIMisuseError { err: "No such channel awaiting to be accepted.".to_owned() })
 		}?;
 
 		if accept_0conf {
@@ -6039,7 +6056,10 @@ where
 				}
 			};
 			peer_state.pending_msg_events.push(send_msg_err_event);
-			return Err(APIError::APIMisuseError { err: "Please use accept_inbound_channel_from_trusted_peer_0conf to accept channels with zero confirmations.".to_owned() });
+			let err_str = "Please use accept_inbound_channel_from_trusted_peer_0conf to accept channels with zero confirmations.".to_owned();
+			log_error!(logger, "{}", err_str);
+
+			return Err(APIError::APIMisuseError { err: err_str });
 		} else {
 			// If this peer already has some channels, a new channel won't increase our number of peers
 			// with unfunded channels, so as long as we aren't over the maximum number of unfunded
@@ -6052,7 +6072,10 @@ where
 					}
 				};
 				peer_state.pending_msg_events.push(send_msg_err_event);
-				return Err(APIError::APIMisuseError { err: "Too many peers with unfunded channels, refusing to accept new ones".to_owned() });
+				let err_str = "Too many peers with unfunded channels, refusing to accept new ones".to_owned();
+				log_error!(logger, "{}", err_str);
+
+				return Err(APIError::APIMisuseError { err: err_str });
 			}
 		}