ln: add accountable signal to HTLCUpdateAwaitingACK::AddHTLC

Author: carlaKC

lightning/src/ln/channel.rs

@@ -62,7 +62,7 @@ use crate::ln::interactivetxs::{
 	InteractiveTxSigningSession, NegotiationError, SharedOwnedInput, SharedOwnedOutput,
 	TX_COMMON_FIELDS_WEIGHT,
 };
-use crate::ln::msgs;
+use crate::ln::msgs::{self, accountable_from_bool};
 use crate::ln::msgs::{ClosingSigned, ClosingSignedFeeRange, DecodeError, OnionErrorPacket};
 use crate::ln::onion_utils::{
 	AttributionData, HTLCFailReason, LocalHTLCFailureReason, HOLD_TIME_UNIT_MILLIS,
@@ -451,6 +451,7 @@ enum HTLCUpdateAwaitingACK {
 		skimmed_fee_msat: Option<u64>,
 		blinding_point: Option<PublicKey>,
 		hold_htlc: Option<()>,
+		accountable: Option<bool>,
 	},
 	ClaimHTLC {
 		payment_preimage: PaymentPreimage,
@@ -8333,7 +8334,7 @@ where
 						skimmed_fee_msat,
 						blinding_point,
 						hold_htlc,
-						..
+						accountable,
 					} => {
 						match self.send_htlc(
 							amount_msat,
@@ -8345,6 +8346,7 @@ where
 							skimmed_fee_msat,
 							blinding_point,
 							hold_htlc.is_some(),
+							accountable.unwrap_or(false),
 							fee_estimator,
 							logger,
 						) {
@@ -12457,7 +12459,8 @@ where
 	pub fn queue_add_htlc<F: Deref, L: Deref>(
 		&mut self, amount_msat: u64, payment_hash: PaymentHash, cltv_expiry: u32,
 		source: HTLCSource, onion_routing_packet: msgs::OnionPacket, skimmed_fee_msat: Option<u64>,
-		blinding_point: Option<PublicKey>, fee_estimator: &LowerBoundedFeeEstimator<F>, logger: &L,
+		blinding_point: Option<PublicKey>, accountable: bool,
+		fee_estimator: &LowerBoundedFeeEstimator<F>, logger: &L,
 	) -> Result<(), (LocalHTLCFailureReason, String)>
 	where
 		F::Target: FeeEstimator,
@@ -12474,6 +12477,7 @@ where
 			blinding_point,
 			// This method is only called for forwarded HTLCs, which are never held at the next hop
 			false,
+			accountable,
 			fee_estimator,
 			logger,
 		)
@@ -12505,7 +12509,7 @@ where
 		&mut self, amount_msat: u64, payment_hash: PaymentHash, cltv_expiry: u32,
 		source: HTLCSource, onion_routing_packet: msgs::OnionPacket, mut force_holding_cell: bool,
 		skimmed_fee_msat: Option<u64>, blinding_point: Option<PublicKey>, hold_htlc: bool,
-		fee_estimator: &LowerBoundedFeeEstimator<F>, logger: &L,
+		accountable: bool, fee_estimator: &LowerBoundedFeeEstimator<F>, logger: &L,
 	) -> Result<bool, (LocalHTLCFailureReason, String)>
 	where
 		F::Target: FeeEstimator,
@@ -12587,6 +12591,7 @@ where
 				skimmed_fee_msat,
 				blinding_point,
 				hold_htlc: hold_htlc.then(|| ()),
+				accountable: Some(accountable),
 			});
 			return Ok(false);
 		}
@@ -12835,7 +12840,8 @@ where
 	pub fn send_htlc_and_commit<F: Deref, L: Deref>(
 		&mut self, amount_msat: u64, payment_hash: PaymentHash, cltv_expiry: u32,
 		source: HTLCSource, onion_routing_packet: msgs::OnionPacket, skimmed_fee_msat: Option<u64>,
-		hold_htlc: bool, fee_estimator: &LowerBoundedFeeEstimator<F>, logger: &L,
+		hold_htlc: bool, accountable: bool, fee_estimator: &LowerBoundedFeeEstimator<F>,
+		logger: &L,
 	) -> Result<Option<ChannelMonitorUpdate>, ChannelError>
 	where
 		F::Target: FeeEstimator,
@@ -12851,6 +12857,7 @@ where
 			skimmed_fee_msat,
 			None,
 			hold_htlc,
+			accountable,
 			fee_estimator,
 			logger,
 		);
@@ -14515,6 +14522,8 @@ where
 			Vec::with_capacity(holding_cell_htlc_update_count);
 		let mut holding_cell_held_htlc_flags: Vec<Option<()>> =
 			Vec::with_capacity(holding_cell_htlc_update_count);
+		let mut holding_cell_accountable_flags: Vec<Option<bool>> =
+			Vec::with_capacity(holding_cell_htlc_update_count);
 		// Vec of (htlc_id, failure_code, sha256_of_onion)
 		let mut malformed_htlcs: Vec<(u64, u16, [u8; 32])> = Vec::new();
 		(holding_cell_htlc_update_count as u64).write(writer)?;
@@ -14529,6 +14538,7 @@ where
 					blinding_point,
 					skimmed_fee_msat,
 					hold_htlc,
+					accountable,
 				} => {
 					0u8.write(writer)?;
 					amount_msat.write(writer)?;
@@ -14540,6 +14550,7 @@ where
 					holding_cell_skimmed_fees.push(skimmed_fee_msat);
 					holding_cell_blinding_points.push(blinding_point);
 					holding_cell_held_htlc_flags.push(hold_htlc);
+					holding_cell_accountable_flags.push(accountable);
 				},
 				&HTLCUpdateAwaitingACK::ClaimHTLC {
 					ref payment_preimage,
@@ -14794,6 +14805,7 @@ where
 			(65, self.quiescent_action, option), // Added in 0.2
 			(67, pending_outbound_held_htlc_flags, optional_vec), // Added in 0.2
 			(69, holding_cell_held_htlc_flags, optional_vec), // Added in 0.2
+			(71, holding_cell_accountable_flags, optional_vec), // Added in 0.3
 		});
 
 		Ok(())
@@ -14962,6 +14974,7 @@ where
 					skimmed_fee_msat: None,
 					blinding_point: None,
 					hold_htlc: None,
+					accountable: None,
 				},
 				1 => HTLCUpdateAwaitingACK::ClaimHTLC {
 					payment_preimage: Readable::read(reader)?,
@@ -15161,6 +15174,7 @@ where
 
 		let mut pending_outbound_held_htlc_flags_opt: Option<Vec<Option<()>>> = None;
 		let mut holding_cell_held_htlc_flags_opt: Option<Vec<Option<()>>> = None;
+		let mut holding_cell_accountable_opt: Option<Vec<Option<bool>>> = None;
 
 		read_tlv_fields!(reader, {
 			(0, announcement_sigs, option),
@@ -15208,6 +15222,7 @@ where
 			(65, quiescent_action, upgradable_option), // Added in 0.2
 			(67, pending_outbound_held_htlc_flags_opt, optional_vec), // Added in 0.2
 			(69, holding_cell_held_htlc_flags_opt, optional_vec), // Added in 0.2
+			(71, holding_cell_accountable_opt, optional_vec), // Added in 0.3
 		});
 
 		let holder_signer = signer_provider.derive_channel_signer(channel_keys_id);
@@ -15332,6 +15347,19 @@ where
 			}
 		}
 
+		if let Some(accountable_htlcs) = holding_cell_accountable_opt {
+			let mut iter = accountable_htlcs.into_iter();
+			for htlc in holding_cell_htlc_updates.iter_mut() {
+				if let HTLCUpdateAwaitingACK::AddHTLC { ref mut accountable, .. } = htlc {
+					*accountable = iter.next().ok_or(DecodeError::InvalidValue)?;
+				}
+			}
+			// We expect all accountable HTLC signals to be consumed above
+			if iter.next().is_some() {
+				return Err(DecodeError::InvalidValue);
+			}
+		}
+
 		if let Some(attribution_data_list) = removed_htlc_attribution_data {
 			let mut removed_htlcs = pending_inbound_htlcs.iter_mut().filter_map(|status| {
 				if let InboundHTLCState::LocalRemoved(reason) = &mut status.state {
@@ -16385,6 +16413,7 @@ mod tests {
 			skimmed_fee_msat: None,
 			blinding_point: None,
 			hold_htlc: None,
+			accountable: None,
 		};
 		let dummy_holding_cell_claim_htlc = |attribution_data| HTLCUpdateAwaitingACK::ClaimHTLC {
 			payment_preimage: PaymentPreimage([42; 32]),

lightning/src/ln/channelmanager.rs

@@ -5307,6 +5307,7 @@ where
 							onion_packet,
 							None,
 							hold_htlc_at_next_hop,
+							false, // Not accountable by default for sender.
 							&self.fee_estimator,
 							&&logger,
 						);
@@ -7401,6 +7402,7 @@ where
 								outgoing_cltv_value,
 								routing,
 								skimmed_fee_msat,
+								incoming_accountable,
 								..
 							},
 						..
@@ -7496,6 +7498,7 @@ where
 						onion_packet.clone(),
 						*skimmed_fee_msat,
 						next_blinding_point,
+						incoming_accountable.unwrap_or(false),
 						&self.fee_estimator,
 						&&logger,
 					) {