Refactor BroadcasterInterface to include BroadcastType

Add a `BroadcastType` enum to provide context about the type of
transaction being broadcast. This information can be useful for
logging, filtering, or prioritization purposes.

The `BroadcastType` variants are:
- `Funding`: A funding transaction establishing a new channel
- `CooperativeClose`: A cooperative close transaction
- `UnilateralClose`: A force-close transaction
- `AnchorBump`: An anchor transaction for CPFP fee-bumping
- `Claim`: A transaction claiming outputs from commitment tx
- `Sweep`: A transaction sweeping spendable outputs to wallet

Co-Authored-By: HAL 9000
Signed-off-by: Elias Rohrer <dev@tnull.de>

Author: tnull

fuzz/src/chanmon_consistency.rs

@@ -36,7 +36,9 @@ use bitcoin::WPubkeyHash;
 use lightning::blinded_path::message::{BlindedMessagePath, MessageContext, MessageForwardNode};
 use lightning::blinded_path::payment::{BlindedPaymentPath, ReceiveTlvs};
 use lightning::chain;
-use lightning::chain::chaininterface::{BroadcasterInterface, ConfirmationTarget, FeeEstimator};
+use lightning::chain::chaininterface::{
+	BroadcastType, BroadcasterInterface, ConfirmationTarget, FeeEstimator,
+};
 use lightning::chain::channelmonitor::{ChannelMonitor, MonitorEvent};
 use lightning::chain::transaction::OutPoint;
 use lightning::chain::{
@@ -159,8 +161,8 @@ pub struct TestBroadcaster {
 	txn_broadcasted: RefCell<Vec<Transaction>>,
 }
 impl BroadcasterInterface for TestBroadcaster {
-	fn broadcast_transactions(&self, txs: &[&Transaction]) {
-		for tx in txs {
+	fn broadcast_transactions(&self, txs: &[(&Transaction, BroadcastType)]) {
+		for (tx, _broadcast_type) in txs {
 			self.txn_broadcasted.borrow_mut().push((*tx).clone());
 		}
 	}

fuzz/src/full_stack.rs

@@ -33,7 +33,9 @@ use bitcoin::WPubkeyHash;
 use lightning::blinded_path::message::{BlindedMessagePath, MessageContext, MessageForwardNode};
 use lightning::blinded_path::payment::{BlindedPaymentPath, ReceiveTlvs};
 use lightning::chain;
-use lightning::chain::chaininterface::{BroadcasterInterface, ConfirmationTarget, FeeEstimator};
+use lightning::chain::chaininterface::{
+	BroadcastType, BroadcasterInterface, ConfirmationTarget, FeeEstimator,
+};
 use lightning::chain::chainmonitor;
 use lightning::chain::transaction::OutPoint;
 use lightning::chain::{BestBlock, ChannelMonitorUpdateStatus, Confirm, Listen};
@@ -184,8 +186,8 @@ struct TestBroadcaster {
 	txn_broadcasted: Mutex<Vec<Transaction>>,
 }
 impl BroadcasterInterface for TestBroadcaster {
-	fn broadcast_transactions(&self, txs: &[&Transaction]) {
-		let owned_txs: Vec<Transaction> = txs.iter().map(|tx| (*tx).clone()).collect();
+	fn broadcast_transactions(&self, txs: &[(&Transaction, BroadcastType)]) {
+		let owned_txs: Vec<Transaction> = txs.iter().map(|(tx, _)| (*tx).clone()).collect();
 		self.txn_broadcasted.lock().unwrap().extend(owned_txs);
 	}
 }

lightning-liquidity/src/lsps2/service.rs

@@ -40,7 +40,7 @@ use crate::prelude::{new_hash_map, HashMap};
 use crate::sync::{Arc, Mutex, MutexGuard, RwLock};
 use crate::utils::async_poll::dummy_waker;
 
-use lightning::chain::chaininterface::BroadcasterInterface;
+use lightning::chain::chaininterface::{BroadcastType, BroadcasterInterface};
 use lightning::events::HTLCHandlingFailureType;
 use lightning::ln::channelmanager::{AChannelManager, FailureCode, InterceptId};
 use lightning::ln::msgs::{ErrorAction, LightningError};
@@ -2039,7 +2039,7 @@ where
 		}
 
 		if let Some(funding_tx) = jit_channel.get_funding_tx() {
-			self.tx_broadcaster.broadcast_transactions(&[funding_tx]);
+			self.tx_broadcaster.broadcast_transactions(&[(funding_tx, BroadcastType::Funding)]);
 		}
 	}
 }

lightning/src/chain/chaininterface.rs

@@ -19,6 +19,28 @@ use crate::prelude::*;
 
 use bitcoin::transaction::Transaction;
 
+/// Represents the class of transaction being broadcast.
+///
+/// This is used to provide context about the type of transaction being broadcast, which may be
+/// useful for logging, filtering, or prioritization purposes.
+#[derive(Clone, Copy, Debug, Hash, PartialEq, Eq)]
+pub enum BroadcastType {
+	/// A funding transaction establishing a new channel.
+	Funding,
+	/// A cooperative close transaction mutually agreed upon by both parties.
+	CooperativeClose,
+	/// A commitment transaction being broadcast to force-close the channel.
+	Commitment,
+	/// An anchor transaction used for CPFP fee-bumping a commitment transaction.
+	Anchor,
+	/// A transaction claiming outputs from a commitment transaction (HTLC claims, penalty/justice).
+	Claim,
+	/// An HTLC resolution transaction (HTLC-timeout or HTLC-success) for anchor channels.
+	HtlcResolution,
+	/// A transaction sweeping spendable outputs to the user's wallet.
+	Sweep,
+}
+
 // TODO: Define typed abstraction over feerates to handle their conversions.
 pub(crate) fn compute_feerate_sat_per_1000_weight(fee_sat: u64, weight: u64) -> u32 {
 	(fee_sat * 1000 / weight).try_into().unwrap_or(u32::max_value())
@@ -45,7 +67,10 @@ pub trait BroadcasterInterface {
 	///
 	/// Bitcoin transaction packages are defined in BIP 331 and here:
 	/// <https://github.com/bitcoin/bitcoin/blob/master/doc/policy/packages.md>
-	fn broadcast_transactions(&self, txs: &[&Transaction]);
+	///
+	/// Each transaction is paired with a [`BroadcastType`] indicating the class of transaction
+	/// being broadcast, which may be useful for logging, filtering, or prioritization.
+	fn broadcast_transactions(&self, txs: &[(&Transaction, BroadcastType)]);
 }
 
 /// An enum that represents the priority at which we want a transaction to confirm used for feerate

lightning/src/chain/onchaintx.rs

@@ -23,7 +23,9 @@ use bitcoin::transaction::OutPoint as BitcoinOutPoint;
 use bitcoin::transaction::Transaction;
 
 use crate::chain::chaininterface::ConfirmationTarget;
-use crate::chain::chaininterface::{BroadcasterInterface, FeeEstimator, LowerBoundedFeeEstimator};
+use crate::chain::chaininterface::{
+	BroadcastType, BroadcasterInterface, FeeEstimator, LowerBoundedFeeEstimator,
+};
 use crate::chain::channelmonitor::ANTI_REORG_DELAY;
 use crate::chain::package::{PackageSolvingData, PackageTemplate};
 use crate::chain::transaction::MaybeSignedTransaction;
@@ -516,7 +518,7 @@ impl<ChannelSigner: EcdsaChannelSigner> OnchainTxHandler<ChannelSigner> {
 							if tx.is_fully_signed() {
 								let log_start = if feerate_was_bumped { "Broadcasting RBF-bumped" } else { "Rebroadcasting" };
 								log_info!(logger, "{} onchain {}", log_start, log_tx!(tx.0));
-								broadcaster.broadcast_transactions(&[&tx.0]);
+								broadcaster.broadcast_transactions(&[(&tx.0, BroadcastType::Claim)]);
 							} else {
 								log_info!(logger, "Waiting for signature of unsigned onchain transaction {}", tx.0.compute_txid());
 							}
@@ -863,7 +865,7 @@ impl<ChannelSigner: EcdsaChannelSigner> OnchainTxHandler<ChannelSigner> {
 					OnchainClaim::Tx(tx) => {
 						if tx.is_fully_signed() {
 							log_info!(logger, "Broadcasting onchain {}", log_tx!(tx.0));
-							broadcaster.broadcast_transactions(&[&tx.0]);
+							broadcaster.broadcast_transactions(&[(&tx.0, BroadcastType::Claim)]);
 						} else {
 							log_info!(logger, "Waiting for signature of unsigned onchain transaction {}", tx.0.compute_txid());
 						}
@@ -1084,7 +1086,7 @@ impl<ChannelSigner: EcdsaChannelSigner> OnchainTxHandler<ChannelSigner> {
 					OnchainClaim::Tx(bump_tx) => {
 						if bump_tx.is_fully_signed() {
 							log_info!(logger, "Broadcasting RBF-bumped onchain {}", log_tx!(bump_tx.0));
-							broadcaster.broadcast_transactions(&[&bump_tx.0]);
+							broadcaster.broadcast_transactions(&[(&bump_tx.0, BroadcastType::Claim)]);
 						} else {
 							log_info!(logger, "Waiting for signature of RBF-bumped unsigned onchain transaction {}",
 								bump_tx.0.compute_txid());
@@ -1187,7 +1189,7 @@ impl<ChannelSigner: EcdsaChannelSigner> OnchainTxHandler<ChannelSigner> {
 					OnchainClaim::Tx(bump_tx) => {
 						if bump_tx.is_fully_signed() {
 							log_info!(logger, "Broadcasting onchain {}", log_tx!(bump_tx.0));
-							broadcaster.broadcast_transactions(&[&bump_tx.0]);
+							broadcaster.broadcast_transactions(&[(&bump_tx.0, BroadcastType::Claim)]);
 						} else {
 							log_info!(logger, "Waiting for signature of unsigned onchain transaction {}", bump_tx.0.compute_txid());
 						}

lightning/src/events/bump_transaction/mod.rs

@@ -18,7 +18,7 @@ use core::future::Future;
 use core::ops::Deref;
 
 use crate::chain::chaininterface::{
-	compute_feerate_sat_per_1000_weight, fee_for_weight, BroadcasterInterface,
+	compute_feerate_sat_per_1000_weight, fee_for_weight, BroadcastType, BroadcasterInterface,
 };
 use crate::chain::ClaimId;
 use crate::io_extras::sink;
@@ -788,7 +788,7 @@ where
 			log_debug!(self.logger, "Pre-signed commitment {} already has feerate {} sat/kW above required {} sat/kW, broadcasting.",
 				commitment_tx.compute_txid(), commitment_tx_feerate_sat_per_1000_weight,
 				package_target_feerate_sat_per_1000_weight);
-			self.broadcaster.broadcast_transactions(&[&commitment_tx]);
+			self.broadcaster.broadcast_transactions(&[(&commitment_tx, BroadcastType::Commitment)]);
 			return Ok(());
 		}
 
@@ -955,7 +955,10 @@ where
 				anchor_txid,
 				commitment_tx.compute_txid()
 			);
-			self.broadcaster.broadcast_transactions(&[&commitment_tx, &anchor_tx]);
+			self.broadcaster.broadcast_transactions(&[
+				(&commitment_tx, BroadcastType::Commitment),
+				(&anchor_tx, BroadcastType::Anchor),
+			]);
 			return Ok(());
 		}
 	}
@@ -1188,7 +1191,7 @@ where
 			}
 
 			log_info!(self.logger, "Broadcasting {}", log_tx!(htlc_tx));
-			self.broadcaster.broadcast_transactions(&[&htlc_tx]);
+			self.broadcaster.broadcast_transactions(&[(&htlc_tx, BroadcastType::HtlcResolution)]);
 		}
 
 		Ok(())

lightning/src/ln/channelmanager.rs

@@ -39,7 +39,7 @@ use crate::blinded_path::payment::{AsyncBolt12OfferContext, Bolt12OfferContext,
 use crate::blinded_path::NodeIdLookUp;
 use crate::chain;
 use crate::chain::chaininterface::{
-	BroadcasterInterface, ConfirmationTarget, FeeEstimator, LowerBoundedFeeEstimator,
+	BroadcastType, BroadcasterInterface, ConfirmationTarget, FeeEstimator, LowerBoundedFeeEstimator,
 };
 use crate::chain::channelmonitor::{
 	Balance, ChannelMonitor, ChannelMonitorUpdate, ChannelMonitorUpdateStep, MonitorEvent,
@@ -6548,7 +6548,7 @@ where
 			"Broadcasting signed interactive funding transaction {}",
 			funding_tx.compute_txid()
 		);
-		self.tx_broadcaster.broadcast_transactions(&[funding_tx]);
+		self.tx_broadcaster.broadcast_transactions(&[(funding_tx, BroadcastType::Funding)]);
 		{
 			let mut pending_events = self.pending_events.lock().unwrap();
 			emit_channel_pending_event!(pending_events, channel);
@@ -9481,7 +9481,7 @@ This indicates a bug inside LDK. Please report this error at https://github.com/
 				}
 				if let Some(tx) = batch_funding_tx {
 					log_info!(self.logger, "Broadcasting batch funding tx {}", tx.compute_txid());
-					self.tx_broadcaster.broadcast_transactions(&[&tx]);
+					self.tx_broadcaster.broadcast_transactions(&[(&tx, BroadcastType::Funding)]);
 				}
 			}
 		}
@@ -10147,7 +10147,7 @@ This indicates a bug inside LDK. Please report this error at https://github.com/
 				};
 			} else {
 				log_info!(logger, "Broadcasting funding transaction with txid {}", tx.compute_txid());
-				self.tx_broadcaster.broadcast_transactions(&[&tx]);
+				self.tx_broadcaster.broadcast_transactions(&[(&tx, BroadcastType::Funding)]);
 			}
 		}
 
@@ -11608,7 +11608,8 @@ This indicates a bug inside LDK. Please report this error at https://github.com/
 		mem::drop(per_peer_state);
 		if let Some((broadcast_tx, err)) = tx_err {
 			log_info!(logger, "Broadcasting {}", log_tx!(broadcast_tx));
-			self.tx_broadcaster.broadcast_transactions(&[&broadcast_tx]);
+			self.tx_broadcaster
+				.broadcast_transactions(&[(&broadcast_tx, BroadcastType::CooperativeClose)]);
 			let _ = self.handle_error(err, *counterparty_node_id);
 		}
 		Ok(())
@@ -12935,7 +12936,10 @@ This indicates a bug inside LDK. Please report this error at https://github.com/
 					}
 					if let Some(broadcast_tx) = msgs.signed_closing_tx {
 						log_info!(logger, "Broadcasting closing tx {}", log_tx!(broadcast_tx));
-						self.tx_broadcaster.broadcast_transactions(&[&broadcast_tx]);
+						self.tx_broadcaster.broadcast_transactions(&[(
+							&broadcast_tx,
+							BroadcastType::CooperativeClose,
+						)]);
 					}
 				} else {
 					// We don't know how to handle a channel_ready or signed_closing_tx for a
@@ -13062,7 +13066,10 @@ This indicates a bug inside LDK. Please report this error at https://github.com/
 										handle_errors.push((*cp_id, Err(err)));
 
 										log_info!(logger, "Broadcasting {}", log_tx!(tx));
-										self.tx_broadcaster.broadcast_transactions(&[&tx]);
+										self.tx_broadcaster.broadcast_transactions(&[(
+											&tx,
+											BroadcastType::CooperativeClose,
+										)]);
 										false
 									} else {
 										true

lightning/src/util/sweep.rs

@@ -8,7 +8,9 @@
 //! [`SpendableOutputDescriptor`]s, i.e., persists them in a given [`KVStoreSync`] and regularly retries
 //! sweeping them.
 
-use crate::chain::chaininterface::{BroadcasterInterface, ConfirmationTarget, FeeEstimator};
+use crate::chain::chaininterface::{
+	BroadcastType, BroadcasterInterface, ConfirmationTarget, FeeEstimator,
+};
 use crate::chain::channelmonitor::{ANTI_REORG_DELAY, ARCHIVAL_DELAY_BLOCKS};
 use crate::chain::{self, BestBlock, Confirm, Filter, Listen, WatchedOutput};
 use crate::io;
@@ -582,7 +584,7 @@ where
 
 		// Persistence completely successfully. If we have a spending transaction, we broadcast it.
 		if let Some(spending_tx) = spending_tx {
-			self.broadcaster.broadcast_transactions(&[&spending_tx]);
+			self.broadcaster.broadcast_transactions(&[(&spending_tx, BroadcastType::Sweep)]);
 		}
 
 		Ok(())

lightning/src/util/test_utils.rs

@@ -12,9 +12,9 @@ use crate::blinded_path::message::{BlindedMessagePath, MessageForwardNode};
 use crate::blinded_path::payment::{BlindedPaymentPath, ReceiveTlvs};
 use crate::chain;
 use crate::chain::chaininterface;
-use crate::chain::chaininterface::ConfirmationTarget;
 #[cfg(any(test, feature = "_externalize_tests"))]
 use crate::chain::chaininterface::FEERATE_FLOOR_SATS_PER_KW;
+use crate::chain::chaininterface::{BroadcastType, ConfirmationTarget};
 use crate::chain::chainmonitor::{ChainMonitor, Persist};
 use crate::chain::channelmonitor::{
 	ChannelMonitor, ChannelMonitorUpdate, ChannelMonitorUpdateStep, MonitorEvent,
@@ -1154,7 +1154,7 @@ impl TestBroadcaster {
 }
 
 impl chaininterface::BroadcasterInterface for TestBroadcaster {
-	fn broadcast_transactions(&self, txs: &[&Transaction]) {
+	fn broadcast_transactions(&self, txs: &[(&Transaction, BroadcastType)]) {
 		// Assert that any batch of transactions of length greater than 1 is sorted
 		// topologically, and is a `child-with-parents` package as defined in
 		// <https://github.com/bitcoin/bitcoin/blob/master/doc/policy/packages.md>.
@@ -1165,21 +1165,23 @@ impl chaininterface::BroadcasterInterface for TestBroadcaster {
 		// Right now LDK only ever broadcasts packages of length 2.
 		assert!(txs.len() <= 2);
 		if txs.len() == 2 {
-			let parent_txid = txs[0].compute_txid();
+			let parent_txid = txs[0].0.compute_txid();
 			assert!(txs[1]
+				.0
 				.input
 				.iter()
 				.map(|input| input.previous_output.txid)
 				.any(|txid| txid == parent_txid));
-			let child_txid = txs[1].compute_txid();
+			let child_txid = txs[1].0.compute_txid();
 			assert!(txs[0]
+				.0
 				.input
 				.iter()
 				.map(|input| input.previous_output.txid)
 				.all(|txid| txid != child_txid));
 		}
 
-		for tx in txs {
+		for (tx, _broadcast_type) in txs {
 			let lock_time = tx.lock_time.to_consensus_u32();
 			assert!(lock_time < 1_500_000_000);
 			if tx.lock_time.is_block_height()
@@ -1195,7 +1197,7 @@ impl chaininterface::BroadcasterInterface for TestBroadcaster {
 				}
 			}
 		}
-		let owned_txs: Vec<Transaction> = txs.iter().map(|tx| (*tx).clone()).collect();
+		let owned_txs: Vec<Transaction> = txs.iter().map(|(tx, _)| (*tx).clone()).collect();
 		self.txn_broadcasted.lock().unwrap().extend(owned_txs);
 	}
 }