From 9df0250dbbad7449e3ec8f90532ce9197eb31997 Mon Sep 17 00:00:00 2001
From: Antoine Riard <ariard@student.42.fr>
Date: Fri, 22 Nov 2019 17:44:30 -0500
Subject: [PATCH] Add log for every tx broadcast

Added macro log_tx in macro_logger.rs
---
 lightning/src/ln/channelmanager.rs |  2 ++
 lightning/src/ln/channelmonitor.rs |  4 ++++
 lightning/src/util/macro_logger.rs | 24 ++++++++++++++++++++++++
 3 files changed, 30 insertions(+)

diff --git a/lightning/src/ln/channelmanager.rs b/lightning/src/ln/channelmanager.rs
index c863f46b6..0522ce0a7 100644
--- a/lightning/src/ln/channelmanager.rs
+++ b/lightning/src/ln/channelmanager.rs
@@ -768,6 +768,7 @@ impl ChannelManager {
 			self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), htlc_source.0, &htlc_source.1, HTLCFailReason::Reason { failure_code: 0x4000 | 8, data: Vec::new() });
 		}
 		for tx in local_txn {
+			log_trace!(self, "Broadcast onchain {}", log_tx!(tx));
 			self.tx_broadcaster.broadcast_transaction(&tx);
 		}
 	}
@@ -2064,6 +2065,7 @@ impl ChannelManager {
 			}
 		};
 		if let Some(broadcast_tx) = tx {
+			log_trace!(self, "Broadcast onchain {}", log_tx!(broadcast_tx));
 			self.tx_broadcaster.broadcast_transaction(&broadcast_tx);
 		}
 		if let Some(chan) = chan_option {
diff --git a/lightning/src/ln/channelmonitor.rs b/lightning/src/ln/channelmonitor.rs
index a31c5bc50..d3121c131 100644
--- a/lightning/src/ln/channelmonitor.rs
+++ b/lightning/src/ln/channelmonitor.rs
@@ -2170,6 +2170,7 @@ impl ChannelMonitor {
 					}
 				}
 				for tx in txn.iter() {
+					log_trace!(self, "Broadcast onchain {}", log_tx!(tx));
 					broadcaster.broadcast_transaction(tx);
 				}
 			}
@@ -2205,6 +2206,7 @@ impl ChannelMonitor {
 		let mut pending_claims = Vec::new();
 		if let Some(ref cur_local_tx) = self.current_local_signed_commitment_tx {
 			if self.would_broadcast_at_height(height) {
+				log_trace!(self, "Broadcast onchain {}", log_tx!(cur_local_tx.tx));
 				broadcaster.broadcast_transaction(&cur_local_tx.tx);
 				match self.key_storage {
 					Storage::Local { ref delayed_payment_base_key, ref latest_per_commitment_point, .. } => {
@@ -2215,6 +2217,7 @@ impl ChannelMonitor {
 							watch_outputs.push((cur_local_tx.txid.clone(), new_outputs));
 						}
 						for tx in txs {
+							log_trace!(self, "Broadcast onchain {}", log_tx!(tx));
 							broadcaster.broadcast_transaction(&tx);
 						}
 					},
@@ -2226,6 +2229,7 @@ impl ChannelMonitor {
 							watch_outputs.push((cur_local_tx.txid.clone(), new_outputs));
 						}
 						for tx in txs {
+							log_trace!(self, "Broadcast onchain {}", log_tx!(tx));
 							broadcaster.broadcast_transaction(&tx);
 						}
 					}
diff --git a/lightning/src/util/macro_logger.rs b/lightning/src/util/macro_logger.rs
index 1f6854277..ef7fbd9bb 100644
--- a/lightning/src/util/macro_logger.rs
+++ b/lightning/src/util/macro_logger.rs
@@ -1,6 +1,7 @@
 use chain::transaction::OutPoint;
 
 use bitcoin_hashes::sha256d::Hash as Sha256dHash;
+use bitcoin::blockdata::transaction::Transaction;
 use secp256k1::key::PublicKey;
 
 use ln::router::Route;
@@ -89,6 +90,29 @@ macro_rules! log_route {
 	}
 }
 
+pub(crate) struct DebugTx<'a>(pub &'a Transaction);
+impl<'a> std::fmt::Display for DebugTx<'a> {
+	fn fmt(&self, f: &mut std::fmt::Formatter) -> Result<(), std::fmt::Error> {
+		if self.0.input.len() == 1 && self.0.input[0].witness.last().unwrap().len() == 71 && (self.0.input[0].sequence >> 8*3) as u8 == 0x80 { write!(f, "commitment tx")?; }
+		else if self.0.input.len() == 1 && self.0.input[0].witness.last().unwrap().len() == 71 { write!(f, "closing tx")?; }
+		else if self.0.input.len() == 1 && self.0.input[0].witness.last().unwrap().len() == 133 && self.0.input[0].witness.len() == 5 { write!(f, "HTLC-timeout tx")?; }
+		else if self.0.input.len() == 1 && (self.0.input[0].witness.last().unwrap().len() == 138 || self.0.input[0].witness.last().unwrap().len() == 139) && self.0.input[0].witness.len() == 5 { write!(f, "HTLC-success tx")?; }
+		else {
+			for inp in &self.0.input {
+				if inp.witness.last().unwrap().len() == 133 { write!(f, "preimage tx")?; break }
+				else if inp.witness.last().unwrap().len() == 138 { write!(f, "timeout tx")?; break }
+			}
+		}
+		Ok(())
+	}
+}
+
+macro_rules! log_tx {
+	($obj: expr) => {
+		::util::macro_logger::DebugTx(&$obj)
+	}
+}
+
 macro_rules! log_internal {
 	($self: ident, $lvl:expr, $($arg:tt)+) => (
 		&$self.logger.log(&::util::logger::Record::new($lvl, format_args!($($arg)+), module_path!(), file!(), line!()));
-- 
2.39.5