f - logging for phantom invoice creation

Author: jkczyz

lightning-invoice/src/utils.rs

@@ -135,6 +135,7 @@ where
 			CreationError::MissingRouteHints,
 		));
 	}
+
 	let invoice = match description {
 		InvoiceDescription::Direct(description) => {
 			InvoiceBuilder::new(network).description(description.0.clone())
@@ -171,6 +172,9 @@ where
 		.map_err(|_| SignOrCreationError::CreationError(CreationError::InvalidAmount))?
 	};
 
+	log_debug!(logger, "Creating phantom invoice from {} participating nodes with payment hash {}",
+		phantom_route_hints.len(), log_bytes!(payment_hash.0));
+
 	let mut invoice = invoice
 		.current_timestamp()
 		.payment_hash(Hash::from_slice(&payment_hash.0).unwrap())
@@ -182,6 +186,8 @@ where
 	}
 
 	for PhantomRouteHints { channels, phantom_scid, real_node_pubkey } in phantom_route_hints {
+		log_debug!(logger, "Generating phantom route hints for node {}",
+			log_pubkey!(real_node_pubkey));
 		let mut route_hints = filter_channels(channels, amt_msat, &logger);
 
 		// If we have any public channel, the route hints from `filter_channels` will be empty.
@@ -418,7 +424,7 @@ fn filter_channels<L: Deref>(
 		if channel.is_public {
 			// If any public channel exists, return no hints and let the sender
 			// look at the public channels instead.
-			log_debug!(logger, "Not including invoice route hints on account of public channel {}",
+			log_debug!(logger, "Not including channels in invoice route hints on account of public channel {}",
 				log_bytes!(channel.channel_id));
 			return vec![]
 		}

lightning/src/util/logger.rs

@@ -14,6 +14,8 @@
 //! The second one, client-side by implementing check against Record Level field.
 //! Each module may have its own Logger or share one.
 
+use bitcoin::secp256k1::PublicKey;
+
 use core::cmp;
 use core::fmt;
 
@@ -138,6 +140,19 @@ pub trait Logger {
 	fn log(&self, record: &Record);
 }
 
+/// Wrapper for logging a [`PublicKey`] in hex format.
+/// (C-not exported) as fmt can't be used in C
+#[doc(hidden)]
+pub struct DebugPubKey<'a>(pub &'a PublicKey);
+impl<'a> core::fmt::Display for DebugPubKey<'a> {
+	fn fmt(&self, f: &mut core::fmt::Formatter) -> Result<(), core::fmt::Error> {
+		for i in self.0.serialize().iter() {
+			write!(f, "{:02x}", i)?;
+		}
+		Ok(())
+	}
+}
+
 /// Wrapper for logging byte slices in hex format.
 /// (C-not exported) as fmt can't be used in C
 #[doc(hidden)]

lightning/src/util/macro_logger.rs

@@ -12,24 +12,16 @@ use chain::keysinterface::SpendableOutputDescriptor;
 
 use bitcoin::hash_types::Txid;
 use bitcoin::blockdata::transaction::Transaction;
-use bitcoin::secp256k1::PublicKey;
 
 use routing::router::Route;
 use ln::chan_utils::HTLCClaim;
 use util::logger::DebugBytes;
 
-pub(crate) struct DebugPubKey<'a>(pub &'a PublicKey);
-impl<'a> core::fmt::Display for DebugPubKey<'a> {
-	fn fmt(&self, f: &mut core::fmt::Formatter) -> Result<(), core::fmt::Error> {
-		for i in self.0.serialize().iter() {
-			write!(f, "{:02x}", i)?;
-		}
-		Ok(())
-	}
-}
+/// Logs a pubkey in hex format.
+#[macro_export]
 macro_rules! log_pubkey {
 	($obj: expr) => {
-		::util::macro_logger::DebugPubKey(&$obj)
+		$crate::util::logger::DebugPubKey(&$obj)
 	}
 }