Track HTLCSource in ChannelMonitor

Insert it in current_local_signed_tx, prev_local_signed_tx,
remote_claimable_outpoints. For so get it provided by
Channel calls to provide_latest_{local,remote}_tx

Author: Antoine Riard

src/ln/channel.rs

@@ -751,7 +751,7 @@ impl Channel {
 	/// generated by the peer which proposed adding the HTLCs, and thus we need to understand both
 	/// which peer generated this transaction and "to whom" this transaction flows.
 	#[inline]
-	fn build_commitment_transaction(&self, commitment_number: u64, keys: &TxCreationKeys, local: bool, generated_by_local: bool, feerate_per_kw: u64) -> (Transaction, Vec<HTLCOutputInCommitment>) {
+	fn build_commitment_transaction(&self, commitment_number: u64, keys: &TxCreationKeys, local: bool, generated_by_local: bool, feerate_per_kw: u64) -> (Transaction, Vec<(HTLCOutputInCommitment, Option<HTLCSource>)>) {
 		let obscured_commitment_transaction_number = self.get_commitment_transaction_number_obscure_factor() ^ (INITIAL_COMMITMENT_NUMBER - commitment_number);
 
 		let txins = {
@@ -765,30 +765,30 @@ impl Channel {
 			ins
 		};
 
-		let mut txouts: Vec<(TxOut, Option<HTLCOutputInCommitment>)> = Vec::with_capacity(self.pending_inbound_htlcs.len() + self.pending_outbound_htlcs.len() + 2);
+		let mut txouts: Vec<(TxOut, Option<(HTLCOutputInCommitment, Option<HTLCSource>)>)> = Vec::with_capacity(self.pending_inbound_htlcs.len() + self.pending_outbound_htlcs.len() + 2);
 
 		let dust_limit_satoshis = if local { self.our_dust_limit_satoshis } else { self.their_dust_limit_satoshis };
 		let mut remote_htlc_total_msat = 0;
 		let mut local_htlc_total_msat = 0;
 		let mut value_to_self_msat_offset = 0;
 
 		macro_rules! add_htlc_output {
-			($htlc: expr, $outbound: expr) => {
+			($htlc: expr, $outbound: expr, $source: expr) => {
 				if $outbound == local { // "offered HTLC output"
 					if $htlc.amount_msat / 1000 >= dust_limit_satoshis + (feerate_per_kw * HTLC_TIMEOUT_TX_WEIGHT / 1000) {
 						let htlc_in_tx = get_htlc_in_commitment!($htlc, true);
 						txouts.push((TxOut {
 							script_pubkey: chan_utils::get_htlc_redeemscript(&htlc_in_tx, &keys).to_v0_p2wsh(),
 							value: $htlc.amount_msat / 1000
-						}, Some(htlc_in_tx)));
+						}, Some((htlc_in_tx, $source))));
 					}
 				} else {
 					if $htlc.amount_msat / 1000 >= dust_limit_satoshis + (feerate_per_kw * HTLC_SUCCESS_TX_WEIGHT / 1000) {
 						let htlc_in_tx = get_htlc_in_commitment!($htlc, false);
 						txouts.push((TxOut { // "received HTLC output"
 							script_pubkey: chan_utils::get_htlc_redeemscript(&htlc_in_tx, &keys).to_v0_p2wsh(),
 							value: $htlc.amount_msat / 1000
-						}, Some(htlc_in_tx)));
+						}, Some((htlc_in_tx, $source))));
 					}
 				}
 			}
@@ -804,7 +804,7 @@ impl Channel {
 			};
 
 			if include {
-				add_htlc_output!(htlc, false);
+				add_htlc_output!(htlc, false, None);
 				remote_htlc_total_msat += htlc.amount_msat;
 			} else {
 				match &htlc.state {
@@ -830,7 +830,7 @@ impl Channel {
 			};
 
 			if include {
-				add_htlc_output!(htlc, true);
+				add_htlc_output!(htlc, true, Some(htlc.source.clone()));
 				local_htlc_total_msat += htlc.amount_msat;
 			} else {
 				match htlc.state {
@@ -901,12 +901,12 @@ impl Channel {
 		transaction_utils::sort_outputs(&mut txouts);
 
 		let mut outputs: Vec<TxOut> = Vec::with_capacity(txouts.len());
-		let mut htlcs_used: Vec<HTLCOutputInCommitment> = Vec::with_capacity(txouts.len());
+		let mut htlcs_used: Vec<(HTLCOutputInCommitment, Option<HTLCSource>)> = Vec::with_capacity(txouts.len());
 		for (idx, out) in txouts.drain(..).enumerate() {
 			outputs.push(out.0);
-			if let Some(out_htlc) = out.1 {
-				htlcs_used.push(out_htlc);
-				htlcs_used.last_mut().unwrap().transaction_output_index = idx as u32;
+			if let Some(mut out_htlc) = out.1 {
+				out_htlc.0.transaction_output_index = idx as u32;
+				htlcs_used.push((out_htlc.0, out_htlc.1));
 			}
 		}
 
@@ -1692,7 +1692,7 @@ impl Channel {
 		new_local_commitment_txn.push(local_commitment_tx.0.clone());
 
 		let mut htlcs_and_sigs = Vec::with_capacity(local_commitment_tx.1.len());
-		for (idx, ref htlc) in local_commitment_tx.1.iter().enumerate() {
+		for (idx, &(ref htlc, ref htlc_source)) in local_commitment_tx.1.iter().enumerate() {
 			let mut htlc_tx = self.build_htlc_transaction(&local_commitment_txid, htlc, true, &local_keys, feerate_per_kw);
 			let htlc_redeemscript = chan_utils::get_htlc_redeemscript(&htlc, &local_keys);
 			let htlc_sighash = Message::from_slice(&bip143::SighashComponents::new(&htlc_tx).sighash_all(&htlc_tx.input[0], &htlc_redeemscript, htlc.amount_msat / 1000)[..]).unwrap();
@@ -1704,7 +1704,7 @@ impl Channel {
 			} else {
 				self.create_htlc_tx_signature(&htlc_tx, htlc, &local_keys)?.1
 			};
-			htlcs_and_sigs.push(((*htlc).clone(), msg.htlc_signatures[idx], htlc_sig));
+			htlcs_and_sigs.push(((*htlc).clone(), msg.htlc_signatures[idx], htlc_sig, (*htlc_source).clone()));
 		}
 
 		let next_per_commitment_point = PublicKey::from_secret_key(&self.secp_ctx, &self.build_local_commitment_secret(self.cur_local_commitment_transaction_number - 1));
@@ -3221,7 +3221,7 @@ impl Channel {
 
 	/// Only fails in case of bad keys. Used for channel_reestablish commitment_signed generation
 	/// when we shouldn't change HTLC/channel state.
-	fn send_commitment_no_state_update(&self) -> Result<(msgs::CommitmentSigned, (Transaction, Vec<HTLCOutputInCommitment>)), ChannelError> {
+	fn send_commitment_no_state_update(&self) -> Result<(msgs::CommitmentSigned, (Transaction, Vec<(HTLCOutputInCommitment, Option<HTLCSource>)>)), ChannelError> {
 		let funding_script = self.get_funding_redeemscript();
 
 		let mut feerate_per_kw = self.feerate_per_kw;
@@ -3239,7 +3239,7 @@ impl Channel {
 
 		let mut htlc_sigs = Vec::new();
 
-		for ref htlc in remote_commitment_tx.1.iter() {
+		for &(ref htlc, _) in remote_commitment_tx.1.iter() {
 			let htlc_tx = self.build_htlc_transaction(&remote_commitment_txid, htlc, false, &remote_keys, feerate_per_kw);
 			let htlc_redeemscript = chan_utils::get_htlc_redeemscript(&htlc, &remote_keys);
 			let htlc_sighash = Message::from_slice(&bip143::SighashComponents::new(&htlc_tx).sighash_all(&htlc_tx.input[0], &htlc_redeemscript, htlc.amount_msat / 1000)[..]).unwrap();
@@ -3960,7 +3960,7 @@ mod tests {
 		let htlc_basepoint = PublicKey::from_secret_key(&secp_ctx, &chan.local_keys.htlc_base_key);
 		let keys = TxCreationKeys::new(&secp_ctx, &per_commitment_point, &delayed_payment_base, &htlc_basepoint, &chan.their_revocation_basepoint.unwrap(), &chan.their_payment_basepoint.unwrap(), &chan.their_htlc_basepoint.unwrap()).unwrap();
 
-		let mut unsigned_tx: (Transaction, Vec<HTLCOutputInCommitment>);
+		let mut unsigned_tx: (Transaction, Vec<(HTLCOutputInCommitment, Option<HTLCSource>)>);
 
 		macro_rules! test_commitment {
 			( $their_sig_hex: expr, $our_sig_hex: expr, $tx_hex: expr) => {
@@ -3980,7 +3980,7 @@ mod tests {
 			( $htlc_idx: expr, $their_sig_hex: expr, $our_sig_hex: expr, $tx_hex: expr ) => {
 				let remote_signature = Signature::from_der(&secp_ctx, &hex::decode($their_sig_hex).unwrap()[..]).unwrap();
 
-				let ref htlc = unsigned_tx.1[$htlc_idx];
+				let (ref htlc, _) = unsigned_tx.1[$htlc_idx];
 				let mut htlc_tx = chan.build_htlc_transaction(&unsigned_tx.0.txid(), &htlc, true, &keys, chan.feerate_per_kw);
 				let htlc_redeemscript = chan_utils::get_htlc_redeemscript(&htlc, &keys);
 				let htlc_sighash = Message::from_slice(&bip143::SighashComponents::new(&htlc_tx).sighash_all(&htlc_tx.input[0], &htlc_redeemscript, htlc.amount_msat / 1000)[..]).unwrap();

src/ln/channelmanager.rs

@@ -90,15 +90,15 @@ mod channel_held_info {
 	}
 
 	/// Tracks the inbound corresponding to an outbound HTLC
-	#[derive(Clone)]
+	#[derive(Clone, PartialEq)]
 	pub struct HTLCPreviousHopData {
-		pub(super) short_channel_id: u64,
-		pub(super) htlc_id: u64,
-		pub(super) incoming_packet_shared_secret: [u8; 32],
+		pub(crate) short_channel_id: u64,
+		pub(crate) htlc_id: u64,
+		pub(crate) incoming_packet_shared_secret: [u8; 32],
 	}
 
 	/// Tracks the inbound corresponding to an outbound HTLC
-	#[derive(Clone)]
+	#[derive(Clone, PartialEq)]
 	pub enum HTLCSource {
 		PreviousHopData(HTLCPreviousHopData),
 		OutboundRoute {
@@ -131,7 +131,7 @@ mod channel_held_info {
 		}
 	}
 }
-pub(super) use self::channel_held_info::*;
+pub(crate) use self::channel_held_info::*;
 
 type ShutdownResult = (Vec<Transaction>, Vec<(HTLCSource, [u8; 32])>);