f Matt comments

Author: valentinewallace

lightning/src/ln/channel.rs

@@ -2195,17 +2195,16 @@ impl<ChanSigner: ChannelKeys> Channel<ChanSigner> {
 						},
 					}
 					if err.is_some() {
-						self.holding_cell_htlc_updates.push(htlc_update);
 						if let Some(ChannelError::Ignore(_)) = err {
 							// If we failed to add the HTLC, but got an Ignore error, we should
 							// still send the new commitment_signed, so reset the err to None.
 							err = None;
+						} else {
+							self.holding_cell_htlc_updates.push(htlc_update);
 						}
 					}
 				}
 			}
-			//TODO: Need to examine the type of err - if it's a fee issue or similar we may want to
-			//fail it back the route, if it's a temporary issue we can ignore it...
 			match err {
 				None => {
 					if update_add_htlcs.is_empty() && update_fulfill_htlcs.is_empty() && update_fail_htlcs.is_empty() && self.holding_cell_update_fee.is_none() {

lightning/src/ln/functional_tests.rs

@@ -6439,7 +6439,7 @@ fn test_fail_holding_cell_htlc_upon_free() {
 	// HTLC, but now that the fee has been raised the payment will now fail, causing
 	// us to surface its failure to the user.
 	chan_stat = get_channel_value_stat!(nodes[0], chan.2);
-	assert_eq!(chan_stat.holding_cell_outbound_amount_msat, max_can_send);
+	assert_eq!(chan_stat.holding_cell_outbound_amount_msat, 0);
 	nodes[0].logger.assert_log("lightning::ln::channel".to_string(), "Freeing holding cell with 1 HTLC updates".to_string(), 1);
 	let failure_log = format!("Failed to send HTLC with payment_hash {} due to Cannot send value that would put us under local channel reserve value", log_bytes!(our_payment_hash.0));
 	nodes[0].logger.assert_log("lightning::ln::channel".to_string(), failure_log.to_string(), 1);
@@ -6458,6 +6458,124 @@ fn test_fail_holding_cell_htlc_upon_free() {
 	}
 }
 
+#[test]
+fn test_free_and_fail_holding_cell_htlcs() {
+	let chanmon_cfgs = create_chanmon_cfgs(2);
+	let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
+	let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
+	let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
+	let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
+	let logger = test_utils::TestLogger::new();
+
+	// First nodes[0] generates an update_fee, setting the channel's
+	// pending_update_fee.
+	nodes[0].node.update_fee(chan.2, get_feerate!(nodes[0], chan.2) + 200).unwrap();
+	check_added_monitors!(nodes[0], 1);
+
+	let events = nodes[0].node.get_and_clear_pending_msg_events();
+	assert_eq!(events.len(), 1);
+	let (update_msg, commitment_signed) = match events[0] {
+		MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
+			(update_fee.as_ref(), commitment_signed)
+		},
+		_ => panic!("Unexpected event"),
+	};
+
+	nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
+
+	let mut chan_stat = get_channel_value_stat!(nodes[0], chan.2);
+	let channel_reserve = chan_stat.channel_reserve_msat;
+	let feerate = get_feerate!(nodes[0], chan.2);
+
+	// 2* and +1 HTLCs on the commit tx fee calculation for the fee spike reserve.
+	let (payment_preimage_1, payment_hash_1) = get_payment_preimage_hash!(nodes[0]);
+	let amt_1 = 20000;
+	let (_, payment_hash_2) = get_payment_preimage_hash!(nodes[0]);
+	let amt_2 = 5000000 - channel_reserve - 2*commit_tx_fee_msat(feerate, 2 + 1) - amt_1;
+	let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
+	let route_1 = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), None, &[], amt_1, TEST_FINAL_CLTV, &logger).unwrap();
+	let route_2 = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), None, &[], amt_2, TEST_FINAL_CLTV, &logger).unwrap();
+
+	// Send 2 payments which pass reserve checks but get stuck in the holding cell.
+	nodes[0].node.send_payment(&route_1, payment_hash_1, &None).unwrap();
+	chan_stat = get_channel_value_stat!(nodes[0], chan.2);
+	assert_eq!(chan_stat.holding_cell_outbound_amount_msat, amt_1);
+	nodes[0].node.send_payment(&route_2, payment_hash_2, &None).unwrap();
+	chan_stat = get_channel_value_stat!(nodes[0], chan.2);
+	assert_eq!(chan_stat.holding_cell_outbound_amount_msat, amt_1 + amt_2);
+
+	// Flush the pending fee update.
+	nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
+	let (revoke_and_ack, commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
+	check_added_monitors!(nodes[1], 1);
+	nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_and_ack);
+	nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
+	check_added_monitors!(nodes[0], 2);
+
+	// Upon receipt of the RAA, there will be an attempt to resend the holding cell HTLCs,
+	// but now that the fee has been raised the second payment will now fail, causing us
+	// to surface its failure to the user. The first payment should succeed.
+	chan_stat = get_channel_value_stat!(nodes[0], chan.2);
+	assert_eq!(chan_stat.holding_cell_outbound_amount_msat, 0);
+	nodes[0].logger.assert_log("lightning::ln::channel".to_string(), "Freeing holding cell with 2 HTLC updates".to_string(), 1);
+	let failure_log = format!("Failed to send HTLC with payment_hash {} due to Cannot send value that would put us under local channel reserve value", log_bytes!(payment_hash_2.0));
+	nodes[0].logger.assert_log("lightning::ln::channel".to_string(), failure_log.to_string(), 1);
+
+	// Check that the second payment failed to be sent out.
+	let events = nodes[0].node.get_and_clear_pending_events();
+	assert_eq!(events.len(), 1);
+	match &events[0] {
+		&Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, ref error_code, ref error_data } => {
+			assert_eq!(payment_hash_2.clone(), *payment_hash);
+			assert_eq!(*rejected_by_dest, false);
+			assert_eq!(*error_code, None);
+			assert_eq!(*error_data, None);
+		},
+		_ => panic!("Unexpected event"),
+	}
+
+	// Complete the first payment and the RAA from the fee update.
+	let (payment_event, send_raa_event) = {
+		let mut msgs = nodes[0].node.get_and_clear_pending_msg_events();
+		assert_eq!(msgs.len(), 2);
+		(SendEvent::from_event(msgs.remove(0)), msgs.remove(0))
+	};
+	let raa = match send_raa_event {
+		MessageSendEvent::SendRevokeAndACK { msg, .. } => msg,
+		_ => panic!("Unexpected event"),
+	};
+	nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &raa);
+	check_added_monitors!(nodes[1], 1);
+	nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
+	commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
+	let events = nodes[1].node.get_and_clear_pending_events();
+	assert_eq!(events.len(), 1);
+	match events[0] {
+		Event::PendingHTLCsForwardable { .. } => {},
+		_ => panic!("Unexpected event"),
+	}
+	nodes[1].node.process_pending_htlc_forwards();
+	let events = nodes[1].node.get_and_clear_pending_events();
+	assert_eq!(events.len(), 1);
+	match events[0] {
+		Event::PaymentReceived { .. } => {},
+		_ => panic!("Unexpected event"),
+	}
+	nodes[1].node.claim_funds(payment_preimage_1, &None, amt_1);
+	check_added_monitors!(nodes[1], 1);
+	let update_msgs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
+	nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_msgs.update_fulfill_htlcs[0]);
+	commitment_signed_dance!(nodes[0], nodes[1], update_msgs.commitment_signed, false, true);
+	let events = nodes[0].node.get_and_clear_pending_events();
+	assert_eq!(events.len(), 1);
+	match events[0] {
+		Event::PaymentSent { ref payment_preimage } => {
+			assert_eq!(*payment_preimage, payment_preimage_1);
+		}
+		_ => panic!("Unexpected event"),
+	}
+}
+
 // Test that if we fail to forward an HTLC that is being freed from the holding cell that the
 // HTLC is failed backwards. We trigger this failure to forward the freed HTLC by increasing
 // our fee while the HTLC is in the holding cell such that the HTLC is no longer affordable