1 // This file is Copyright its original authors, visible in version control
4 // This file is licensed under the Apache License, Version 2.0 <LICENSE-APACHE
5 // or http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
6 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your option.
7 // You may not use this file except in accordance with one or both of these
10 //! Tests that test standing up a network of ChannelManagers, creating channels, sending
11 //! payments/messages between them, and often checking the resulting ChannelMonitors are able to
12 //! claim outputs on-chain.
15 use crate::chain::{ChannelMonitorUpdateStatus, Confirm, Listen, Watch};
16 use crate::chain::chaininterface::LowerBoundedFeeEstimator;
17 use crate::chain::channelmonitor;
18 use crate::chain::channelmonitor::{CLOSED_CHANNEL_UPDATE_ID, CLTV_CLAIM_BUFFER, LATENCY_GRACE_PERIOD_BLOCKS, ANTI_REORG_DELAY};
19 use crate::chain::transaction::OutPoint;
20 use crate::sign::{ecdsa::EcdsaChannelSigner, EntropySource, SignerProvider};
21 use crate::events::{Event, MessageSendEvent, MessageSendEventsProvider, PathFailure, PaymentPurpose, ClosureReason, HTLCDestination, PaymentFailureReason};
22 use crate::ln::{ChannelId, PaymentPreimage, PaymentSecret, PaymentHash};
23 use crate::ln::channel::{commitment_tx_base_weight, COMMITMENT_TX_WEIGHT_PER_HTLC, CONCURRENT_INBOUND_HTLC_FEE_BUFFER, FEE_SPIKE_BUFFER_FEE_INCREASE_MULTIPLE, MIN_AFFORDABLE_HTLC_COUNT, get_holder_selected_channel_reserve_satoshis, OutboundV1Channel, InboundV1Channel, COINBASE_MATURITY, ChannelPhase};
24 use crate::ln::channelmanager::{self, PaymentId, RAACommitmentOrder, PaymentSendFailure, RecipientOnionFields, BREAKDOWN_TIMEOUT, ENABLE_GOSSIP_TICKS, DISABLE_GOSSIP_TICKS, MIN_CLTV_EXPIRY_DELTA};
25 use crate::ln::channel::{DISCONNECT_PEER_AWAITING_RESPONSE_TICKS, ChannelError};
26 use crate::ln::{chan_utils, onion_utils};
27 use crate::ln::chan_utils::{OFFERED_HTLC_SCRIPT_WEIGHT, htlc_success_tx_weight, htlc_timeout_tx_weight, HTLCOutputInCommitment};
28 use crate::routing::gossip::{NetworkGraph, NetworkUpdate};
29 use crate::routing::router::{Path, PaymentParameters, Route, RouteHop, get_route, RouteParameters};
30 use crate::ln::features::{ChannelFeatures, ChannelTypeFeatures, NodeFeatures};
32 use crate::ln::msgs::{ChannelMessageHandler, RoutingMessageHandler, ErrorAction};
33 use crate::util::test_channel_signer::TestChannelSigner;
34 use crate::util::test_utils::{self, WatchtowerPersister};
35 use crate::util::errors::APIError;
36 use crate::util::ser::{Writeable, ReadableArgs};
37 use crate::util::string::UntrustedString;
38 use crate::util::config::{UserConfig, MaxDustHTLCExposure};
40 use bitcoin::hash_types::BlockHash;
41 use bitcoin::blockdata::locktime::absolute::LockTime;
42 use bitcoin::blockdata::script::{Builder, ScriptBuf};
43 use bitcoin::blockdata::opcodes;
44 use bitcoin::blockdata::constants::ChainHash;
45 use bitcoin::network::constants::Network;
46 use bitcoin::{Sequence, Transaction, TxIn, TxOut, Witness};
47 use bitcoin::OutPoint as BitcoinOutPoint;
49 use bitcoin::secp256k1::Secp256k1;
50 use bitcoin::secp256k1::{PublicKey,SecretKey};
55 use crate::prelude::*;
56 use alloc::collections::BTreeSet;
57 use core::default::Default;
58 use core::iter::repeat;
59 use bitcoin::hashes::Hash;
60 use crate::sync::{Arc, Mutex, RwLock};
62 use crate::ln::functional_test_utils::*;
63 use crate::ln::chan_utils::CommitmentTransaction;
65 use super::channel::UNFUNDED_CHANNEL_AGE_LIMIT_TICKS;
68 fn test_insane_channel_opens() {
69 // Stand up a network of 2 nodes
70 use crate::ln::channel::TOTAL_BITCOIN_SUPPLY_SATOSHIS;
71 let mut cfg = UserConfig::default();
72 cfg.channel_handshake_limits.max_funding_satoshis = TOTAL_BITCOIN_SUPPLY_SATOSHIS + 1;
73 let chanmon_cfgs = create_chanmon_cfgs(2);
74 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
75 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, Some(cfg)]);
76 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
78 // Instantiate channel parameters where we push the maximum msats given our
80 let channel_value_sat = 31337; // same as funding satoshis
81 let channel_reserve_satoshis = get_holder_selected_channel_reserve_satoshis(channel_value_sat, &cfg);
82 let push_msat = (channel_value_sat - channel_reserve_satoshis) * 1000;
84 // Have node0 initiate a channel to node1 with aforementioned parameters
85 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_sat, push_msat, 42, None, None).unwrap();
87 // Extract the channel open message from node0 to node1
88 let open_channel_message = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
90 // Test helper that asserts we get the correct error string given a mutator
91 // that supposedly makes the channel open message insane
92 let insane_open_helper = |expected_error_str: &str, message_mutator: fn(msgs::OpenChannel) -> msgs::OpenChannel| {
93 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &message_mutator(open_channel_message.clone()));
94 let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
95 assert_eq!(msg_events.len(), 1);
96 let expected_regex = regex::Regex::new(expected_error_str).unwrap();
97 if let MessageSendEvent::HandleError { ref action, .. } = msg_events[0] {
99 &ErrorAction::SendErrorMessage { .. } => {
100 nodes[1].logger.assert_log_regex("lightning::ln::channelmanager", expected_regex, 1);
102 _ => panic!("unexpected event!"),
104 } else { assert!(false); }
107 use crate::ln::channelmanager::MAX_LOCAL_BREAKDOWN_TIMEOUT;
109 // Test all mutations that would make the channel open message insane
110 insane_open_helper(format!("Per our config, funding must be at most {}. It was {}", TOTAL_BITCOIN_SUPPLY_SATOSHIS + 1, TOTAL_BITCOIN_SUPPLY_SATOSHIS + 2).as_str(), |mut msg| { msg.funding_satoshis = TOTAL_BITCOIN_SUPPLY_SATOSHIS + 2; msg });
111 insane_open_helper(format!("Funding must be smaller than the total bitcoin supply. It was {}", TOTAL_BITCOIN_SUPPLY_SATOSHIS).as_str(), |mut msg| { msg.funding_satoshis = TOTAL_BITCOIN_SUPPLY_SATOSHIS; msg });
113 insane_open_helper("Bogus channel_reserve_satoshis", |mut msg| { msg.channel_reserve_satoshis = msg.funding_satoshis + 1; msg });
115 insane_open_helper(r"push_msat \d+ was larger than channel amount minus reserve \(\d+\)", |mut msg| { msg.push_msat = (msg.funding_satoshis - msg.channel_reserve_satoshis) * 1000 + 1; msg });
117 insane_open_helper("Peer never wants payout outputs?", |mut msg| { msg.dust_limit_satoshis = msg.funding_satoshis + 1 ; msg });
119 insane_open_helper(r"Minimum htlc value \(\d+\) was larger than full channel value \(\d+\)", |mut msg| { msg.htlc_minimum_msat = (msg.funding_satoshis - msg.channel_reserve_satoshis) * 1000; msg });
121 insane_open_helper("They wanted our payments to be delayed by a needlessly long period", |mut msg| { msg.to_self_delay = MAX_LOCAL_BREAKDOWN_TIMEOUT + 1; msg });
123 insane_open_helper("0 max_accepted_htlcs makes for a useless channel", |mut msg| { msg.max_accepted_htlcs = 0; msg });
125 insane_open_helper("max_accepted_htlcs was 484. It must not be larger than 483", |mut msg| { msg.max_accepted_htlcs = 484; msg });
129 fn test_funding_exceeds_no_wumbo_limit() {
130 // Test that if a peer does not support wumbo channels, we'll refuse to open a wumbo channel to
132 use crate::ln::channel::MAX_FUNDING_SATOSHIS_NO_WUMBO;
133 let chanmon_cfgs = create_chanmon_cfgs(2);
134 let mut node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
135 *node_cfgs[1].override_init_features.borrow_mut() = Some(channelmanager::provided_init_features(&test_default_channel_config()).clear_wumbo());
136 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
137 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
139 match nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), MAX_FUNDING_SATOSHIS_NO_WUMBO + 1, 0, 42, None, None) {
140 Err(APIError::APIMisuseError { err }) => {
141 assert_eq!(format!("funding_value must not exceed {}, it was {}", MAX_FUNDING_SATOSHIS_NO_WUMBO, MAX_FUNDING_SATOSHIS_NO_WUMBO + 1), err);
147 fn do_test_counterparty_no_reserve(send_from_initiator: bool) {
148 // A peer providing a channel_reserve_satoshis of 0 (or less than our dust limit) is insecure,
149 // but only for them. Because some LSPs do it with some level of trust of the clients (for a
150 // substantial UX improvement), we explicitly allow it. Because it's unlikely to happen often
151 // in normal testing, we test it explicitly here.
152 let chanmon_cfgs = create_chanmon_cfgs(2);
153 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
154 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
155 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
156 let default_config = UserConfig::default();
158 // Have node0 initiate a channel to node1 with aforementioned parameters
159 let mut push_amt = 100_000_000;
160 let feerate_per_kw = 253;
161 let channel_type_features = ChannelTypeFeatures::only_static_remote_key();
162 push_amt -= feerate_per_kw as u64 * (commitment_tx_base_weight(&channel_type_features) + 4 * COMMITMENT_TX_WEIGHT_PER_HTLC) / 1000 * 1000;
163 push_amt -= get_holder_selected_channel_reserve_satoshis(100_000, &default_config) * 1000;
165 let temp_channel_id = nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100_000, if send_from_initiator { 0 } else { push_amt }, 42, None, None).unwrap();
166 let mut open_channel_message = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
167 if !send_from_initiator {
168 open_channel_message.channel_reserve_satoshis = 0;
169 open_channel_message.max_htlc_value_in_flight_msat = 100_000_000;
171 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel_message);
173 // Extract the channel accept message from node1 to node0
174 let mut accept_channel_message = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
175 if send_from_initiator {
176 accept_channel_message.channel_reserve_satoshis = 0;
177 accept_channel_message.max_htlc_value_in_flight_msat = 100_000_000;
179 nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), &accept_channel_message);
181 let sender_node = if send_from_initiator { &nodes[1] } else { &nodes[0] };
182 let counterparty_node = if send_from_initiator { &nodes[0] } else { &nodes[1] };
183 let mut sender_node_per_peer_lock;
184 let mut sender_node_peer_state_lock;
186 let channel_phase = get_channel_ref!(sender_node, counterparty_node, sender_node_per_peer_lock, sender_node_peer_state_lock, temp_channel_id);
187 match channel_phase {
188 ChannelPhase::UnfundedInboundV1(_) | ChannelPhase::UnfundedOutboundV1(_) => {
189 let chan_context = channel_phase.context_mut();
190 chan_context.holder_selected_channel_reserve_satoshis = 0;
191 chan_context.holder_max_htlc_value_in_flight_msat = 100_000_000;
193 ChannelPhase::Funded(_) => assert!(false),
197 let funding_tx = sign_funding_transaction(&nodes[0], &nodes[1], 100_000, temp_channel_id);
198 let funding_msgs = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &funding_tx);
199 create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_msgs.0);
201 // nodes[0] should now be able to send the full balance to nodes[1], violating nodes[1]'s
202 // security model if it ever tries to send funds back to nodes[0] (but that's not our problem).
203 if send_from_initiator {
204 send_payment(&nodes[0], &[&nodes[1]], 100_000_000
205 // Note that for outbound channels we have to consider the commitment tx fee and the
206 // "fee spike buffer", which is currently a multiple of the total commitment tx fee as
207 // well as an additional HTLC.
208 - FEE_SPIKE_BUFFER_FEE_INCREASE_MULTIPLE * commit_tx_fee_msat(feerate_per_kw, 2, &channel_type_features));
210 send_payment(&nodes[1], &[&nodes[0]], push_amt);
215 fn test_counterparty_no_reserve() {
216 do_test_counterparty_no_reserve(true);
217 do_test_counterparty_no_reserve(false);
221 fn test_async_inbound_update_fee() {
222 let chanmon_cfgs = create_chanmon_cfgs(2);
223 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
224 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
225 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
226 create_announced_chan_between_nodes(&nodes, 0, 1);
229 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
233 // send (1) commitment_signed -.
234 // <- update_add_htlc/commitment_signed
235 // send (2) RAA (awaiting remote revoke) -.
236 // (1) commitment_signed is delivered ->
237 // .- send (3) RAA (awaiting remote revoke)
238 // (2) RAA is delivered ->
239 // .- send (4) commitment_signed
240 // <- (3) RAA is delivered
241 // send (5) commitment_signed -.
242 // <- (4) commitment_signed is delivered
244 // (5) commitment_signed is delivered ->
246 // (6) RAA is delivered ->
248 // First nodes[0] generates an update_fee
250 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
253 nodes[0].node.timer_tick_occurred();
254 check_added_monitors!(nodes[0], 1);
256 let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
257 assert_eq!(events_0.len(), 1);
258 let (update_msg, commitment_signed) = match events_0[0] { // (1)
259 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
260 (update_fee.as_ref(), commitment_signed)
262 _ => panic!("Unexpected event"),
265 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
267 // ...but before it's delivered, nodes[1] starts to send a payment back to nodes[0]...
268 let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[1], nodes[0], 40000);
269 nodes[1].node.send_payment_with_route(&route, our_payment_hash,
270 RecipientOnionFields::secret_only(our_payment_secret), PaymentId(our_payment_hash.0)).unwrap();
271 check_added_monitors!(nodes[1], 1);
273 let payment_event = {
274 let mut events_1 = nodes[1].node.get_and_clear_pending_msg_events();
275 assert_eq!(events_1.len(), 1);
276 SendEvent::from_event(events_1.remove(0))
278 assert_eq!(payment_event.node_id, nodes[0].node.get_our_node_id());
279 assert_eq!(payment_event.msgs.len(), 1);
281 // ...now when the messages get delivered everyone should be happy
282 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
283 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg); // (2)
284 let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
285 // nodes[0] is awaiting nodes[1] revoke_and_ack so get_event_msg's assert(len == 1) passes
286 check_added_monitors!(nodes[0], 1);
288 // deliver(1), generate (3):
289 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
290 let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
291 // nodes[1] is awaiting nodes[0] revoke_and_ack so get_event_msg's assert(len == 1) passes
292 check_added_monitors!(nodes[1], 1);
294 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack); // deliver (2)
295 let bs_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
296 assert!(bs_update.update_add_htlcs.is_empty()); // (4)
297 assert!(bs_update.update_fulfill_htlcs.is_empty()); // (4)
298 assert!(bs_update.update_fail_htlcs.is_empty()); // (4)
299 assert!(bs_update.update_fail_malformed_htlcs.is_empty()); // (4)
300 assert!(bs_update.update_fee.is_none()); // (4)
301 check_added_monitors!(nodes[1], 1);
303 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack); // deliver (3)
304 let as_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
305 assert!(as_update.update_add_htlcs.is_empty()); // (5)
306 assert!(as_update.update_fulfill_htlcs.is_empty()); // (5)
307 assert!(as_update.update_fail_htlcs.is_empty()); // (5)
308 assert!(as_update.update_fail_malformed_htlcs.is_empty()); // (5)
309 assert!(as_update.update_fee.is_none()); // (5)
310 check_added_monitors!(nodes[0], 1);
312 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_update.commitment_signed); // deliver (4)
313 let as_second_revoke = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
314 // only (6) so get_event_msg's assert(len == 1) passes
315 check_added_monitors!(nodes[0], 1);
317 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_update.commitment_signed); // deliver (5)
318 let bs_second_revoke = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
319 check_added_monitors!(nodes[1], 1);
321 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke);
322 check_added_monitors!(nodes[0], 1);
324 let events_2 = nodes[0].node.get_and_clear_pending_events();
325 assert_eq!(events_2.len(), 1);
327 Event::PendingHTLCsForwardable {..} => {}, // If we actually processed we'd receive the payment
328 _ => panic!("Unexpected event"),
331 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_revoke); // deliver (6)
332 check_added_monitors!(nodes[1], 1);
336 fn test_update_fee_unordered_raa() {
337 // Just the intro to the previous test followed by an out-of-order RAA (which caused a
338 // crash in an earlier version of the update_fee patch)
339 let chanmon_cfgs = create_chanmon_cfgs(2);
340 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
341 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
342 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
343 create_announced_chan_between_nodes(&nodes, 0, 1);
346 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
348 // First nodes[0] generates an update_fee
350 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
353 nodes[0].node.timer_tick_occurred();
354 check_added_monitors!(nodes[0], 1);
356 let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
357 assert_eq!(events_0.len(), 1);
358 let update_msg = match events_0[0] { // (1)
359 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, .. }, .. } => {
362 _ => panic!("Unexpected event"),
365 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
367 // ...but before it's delivered, nodes[1] starts to send a payment back to nodes[0]...
368 let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[1], nodes[0], 40000);
369 nodes[1].node.send_payment_with_route(&route, our_payment_hash,
370 RecipientOnionFields::secret_only(our_payment_secret), PaymentId(our_payment_hash.0)).unwrap();
371 check_added_monitors!(nodes[1], 1);
373 let payment_event = {
374 let mut events_1 = nodes[1].node.get_and_clear_pending_msg_events();
375 assert_eq!(events_1.len(), 1);
376 SendEvent::from_event(events_1.remove(0))
378 assert_eq!(payment_event.node_id, nodes[0].node.get_our_node_id());
379 assert_eq!(payment_event.msgs.len(), 1);
381 // ...now when the messages get delivered everyone should be happy
382 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
383 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg); // (2)
384 let as_revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
385 // nodes[0] is awaiting nodes[1] revoke_and_ack so get_event_msg's assert(len == 1) passes
386 check_added_monitors!(nodes[0], 1);
388 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_msg); // deliver (2)
389 check_added_monitors!(nodes[1], 1);
391 // We can't continue, sadly, because our (1) now has a bogus signature
395 fn test_multi_flight_update_fee() {
396 let chanmon_cfgs = create_chanmon_cfgs(2);
397 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
398 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
399 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
400 create_announced_chan_between_nodes(&nodes, 0, 1);
403 // update_fee/commitment_signed ->
404 // .- send (1) RAA and (2) commitment_signed
405 // update_fee (never committed) ->
407 // We have to manually generate the above update_fee, it is allowed by the protocol but we
408 // don't track which updates correspond to which revoke_and_ack responses so we're in
409 // AwaitingRAA mode and will not generate the update_fee yet.
410 // <- (1) RAA delivered
411 // (3) is generated and send (4) CS -.
412 // Note that A cannot generate (4) prior to (1) being delivered as it otherwise doesn't
413 // know the per_commitment_point to use for it.
414 // <- (2) commitment_signed delivered
416 // B should send no response here
417 // (4) commitment_signed delivered ->
418 // <- RAA/commitment_signed delivered
421 // First nodes[0] generates an update_fee
424 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
425 initial_feerate = *feerate_lock;
426 *feerate_lock = initial_feerate + 20;
428 nodes[0].node.timer_tick_occurred();
429 check_added_monitors!(nodes[0], 1);
431 let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
432 assert_eq!(events_0.len(), 1);
433 let (update_msg_1, commitment_signed_1) = match events_0[0] { // (1)
434 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
435 (update_fee.as_ref().unwrap(), commitment_signed)
437 _ => panic!("Unexpected event"),
440 // Deliver first update_fee/commitment_signed pair, generating (1) and (2):
441 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg_1);
442 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed_1);
443 let (bs_revoke_msg, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
444 check_added_monitors!(nodes[1], 1);
446 // nodes[0] is awaiting a revoke from nodes[1] before it will create a new commitment
449 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
450 *feerate_lock = initial_feerate + 40;
452 nodes[0].node.timer_tick_occurred();
453 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
454 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
456 // Create the (3) update_fee message that nodes[0] will generate before it does...
457 let mut update_msg_2 = msgs::UpdateFee {
458 channel_id: update_msg_1.channel_id.clone(),
459 feerate_per_kw: (initial_feerate + 30) as u32,
462 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg_2);
464 update_msg_2.feerate_per_kw = (initial_feerate + 40) as u32;
466 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg_2);
468 // Deliver (1), generating (3) and (4)
469 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_msg);
470 let as_second_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
471 check_added_monitors!(nodes[0], 1);
472 assert!(as_second_update.update_add_htlcs.is_empty());
473 assert!(as_second_update.update_fulfill_htlcs.is_empty());
474 assert!(as_second_update.update_fail_htlcs.is_empty());
475 assert!(as_second_update.update_fail_malformed_htlcs.is_empty());
476 // Check that the update_fee newly generated matches what we delivered:
477 assert_eq!(as_second_update.update_fee.as_ref().unwrap().channel_id, update_msg_2.channel_id);
478 assert_eq!(as_second_update.update_fee.as_ref().unwrap().feerate_per_kw, update_msg_2.feerate_per_kw);
480 // Deliver (2) commitment_signed
481 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_commitment_signed);
482 let as_revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
483 check_added_monitors!(nodes[0], 1);
484 // No commitment_signed so get_event_msg's assert(len == 1) passes
486 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_msg);
487 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
488 check_added_monitors!(nodes[1], 1);
491 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_second_update.commitment_signed);
492 let (bs_second_revoke, bs_second_commitment) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
493 check_added_monitors!(nodes[1], 1);
495 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke);
496 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
497 check_added_monitors!(nodes[0], 1);
499 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_commitment);
500 let as_second_revoke = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
501 // No commitment_signed so get_event_msg's assert(len == 1) passes
502 check_added_monitors!(nodes[0], 1);
504 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_revoke);
505 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
506 check_added_monitors!(nodes[1], 1);
509 fn do_test_sanity_on_in_flight_opens(steps: u8) {
510 // Previously, we had issues deserializing channels when we hadn't connected the first block
511 // after creation. To catch that and similar issues, we lean on the Node::drop impl to test
512 // serialization round-trips and simply do steps towards opening a channel and then drop the
515 let chanmon_cfgs = create_chanmon_cfgs(2);
516 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
517 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
518 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
520 if steps & 0b1000_0000 != 0{
521 let block = create_dummy_block(nodes[0].best_block_hash(), 42, Vec::new());
522 connect_block(&nodes[0], &block);
523 connect_block(&nodes[1], &block);
526 if steps & 0x0f == 0 { return; }
527 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None, None).unwrap();
528 let open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
530 if steps & 0x0f == 1 { return; }
531 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel);
532 let accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
534 if steps & 0x0f == 2 { return; }
535 nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), &accept_channel);
537 let (temporary_channel_id, tx, funding_output) = create_funding_transaction(&nodes[0], &nodes[1].node.get_our_node_id(), 100000, 42);
539 if steps & 0x0f == 3 { return; }
540 nodes[0].node.funding_transaction_generated(&temporary_channel_id, &nodes[1].node.get_our_node_id(), tx.clone()).unwrap();
541 check_added_monitors!(nodes[0], 0);
542 let funding_created = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
544 if steps & 0x0f == 4 { return; }
545 nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created);
547 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
548 assert_eq!(added_monitors.len(), 1);
549 assert_eq!(added_monitors[0].0, funding_output);
550 added_monitors.clear();
552 expect_channel_pending_event(&nodes[1], &nodes[0].node.get_our_node_id());
554 let funding_signed = get_event_msg!(nodes[1], MessageSendEvent::SendFundingSigned, nodes[0].node.get_our_node_id());
556 if steps & 0x0f == 5 { return; }
557 nodes[0].node.handle_funding_signed(&nodes[1].node.get_our_node_id(), &funding_signed);
559 let mut added_monitors = nodes[0].chain_monitor.added_monitors.lock().unwrap();
560 assert_eq!(added_monitors.len(), 1);
561 assert_eq!(added_monitors[0].0, funding_output);
562 added_monitors.clear();
565 expect_channel_pending_event(&nodes[0], &nodes[1].node.get_our_node_id());
566 let events_4 = nodes[0].node.get_and_clear_pending_events();
567 assert_eq!(events_4.len(), 0);
569 if steps & 0x0f == 6 { return; }
570 create_chan_between_nodes_with_value_confirm_first(&nodes[0], &nodes[1], &tx, 2);
572 if steps & 0x0f == 7 { return; }
573 confirm_transaction_at(&nodes[0], &tx, 2);
574 connect_blocks(&nodes[0], CHAN_CONFIRM_DEPTH);
575 create_chan_between_nodes_with_value_confirm_second(&nodes[1], &nodes[0]);
576 expect_channel_ready_event(&nodes[0], &nodes[1].node.get_our_node_id());
580 fn test_sanity_on_in_flight_opens() {
581 do_test_sanity_on_in_flight_opens(0);
582 do_test_sanity_on_in_flight_opens(0 | 0b1000_0000);
583 do_test_sanity_on_in_flight_opens(1);
584 do_test_sanity_on_in_flight_opens(1 | 0b1000_0000);
585 do_test_sanity_on_in_flight_opens(2);
586 do_test_sanity_on_in_flight_opens(2 | 0b1000_0000);
587 do_test_sanity_on_in_flight_opens(3);
588 do_test_sanity_on_in_flight_opens(3 | 0b1000_0000);
589 do_test_sanity_on_in_flight_opens(4);
590 do_test_sanity_on_in_flight_opens(4 | 0b1000_0000);
591 do_test_sanity_on_in_flight_opens(5);
592 do_test_sanity_on_in_flight_opens(5 | 0b1000_0000);
593 do_test_sanity_on_in_flight_opens(6);
594 do_test_sanity_on_in_flight_opens(6 | 0b1000_0000);
595 do_test_sanity_on_in_flight_opens(7);
596 do_test_sanity_on_in_flight_opens(7 | 0b1000_0000);
597 do_test_sanity_on_in_flight_opens(8);
598 do_test_sanity_on_in_flight_opens(8 | 0b1000_0000);
602 fn test_update_fee_vanilla() {
603 let chanmon_cfgs = create_chanmon_cfgs(2);
604 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
605 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
606 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
607 create_announced_chan_between_nodes(&nodes, 0, 1);
610 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
613 nodes[0].node.timer_tick_occurred();
614 check_added_monitors!(nodes[0], 1);
616 let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
617 assert_eq!(events_0.len(), 1);
618 let (update_msg, commitment_signed) = match events_0[0] {
619 MessageSendEvent::UpdateHTLCs { node_id:_, updates: msgs::CommitmentUpdate { update_add_htlcs:_, update_fulfill_htlcs:_, update_fail_htlcs:_, update_fail_malformed_htlcs:_, ref update_fee, ref commitment_signed } } => {
620 (update_fee.as_ref(), commitment_signed)
622 _ => panic!("Unexpected event"),
624 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
626 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
627 let (revoke_msg, commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
628 check_added_monitors!(nodes[1], 1);
630 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
631 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
632 check_added_monitors!(nodes[0], 1);
634 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
635 let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
636 // No commitment_signed so get_event_msg's assert(len == 1) passes
637 check_added_monitors!(nodes[0], 1);
639 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg);
640 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
641 check_added_monitors!(nodes[1], 1);
645 fn test_update_fee_that_funder_cannot_afford() {
646 let chanmon_cfgs = create_chanmon_cfgs(2);
647 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
648 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
649 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
650 let channel_value = 5000;
652 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, channel_value, push_sats * 1000);
653 let channel_id = chan.2;
654 let secp_ctx = Secp256k1::new();
655 let default_config = UserConfig::default();
656 let bs_channel_reserve_sats = get_holder_selected_channel_reserve_satoshis(channel_value, &default_config);
658 let channel_type_features = ChannelTypeFeatures::only_static_remote_key();
660 // Calculate the maximum feerate that A can afford. Note that we don't send an update_fee
661 // CONCURRENT_INBOUND_HTLC_FEE_BUFFER HTLCs before actually running out of local balance, so we
662 // calculate two different feerates here - the expected local limit as well as the expected
664 let feerate = ((channel_value - bs_channel_reserve_sats - push_sats) * 1000 / (commitment_tx_base_weight(&channel_type_features) + CONCURRENT_INBOUND_HTLC_FEE_BUFFER as u64 * COMMITMENT_TX_WEIGHT_PER_HTLC)) as u32;
665 let non_buffer_feerate = ((channel_value - bs_channel_reserve_sats - push_sats) * 1000 / commitment_tx_base_weight(&channel_type_features)) as u32;
667 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
668 *feerate_lock = feerate;
670 nodes[0].node.timer_tick_occurred();
671 check_added_monitors!(nodes[0], 1);
672 let update_msg = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
674 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg.update_fee.unwrap());
676 commitment_signed_dance!(nodes[1], nodes[0], update_msg.commitment_signed, false);
678 // Confirm that the new fee based on the last local commitment txn is what we expected based on the feerate set above.
680 let commitment_tx = get_local_commitment_txn!(nodes[1], channel_id)[0].clone();
682 //We made sure neither party's funds are below the dust limit and there are no HTLCs here
683 assert_eq!(commitment_tx.output.len(), 2);
684 let total_fee: u64 = commit_tx_fee_msat(feerate, 0, &channel_type_features) / 1000;
685 let mut actual_fee = commitment_tx.output.iter().fold(0, |acc, output| acc + output.value);
686 actual_fee = channel_value - actual_fee;
687 assert_eq!(total_fee, actual_fee);
691 // Increment the feerate by a small constant, accounting for rounding errors
692 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
695 nodes[0].node.timer_tick_occurred();
696 nodes[0].logger.assert_log("lightning::ln::channel", format!("Cannot afford to send new feerate at {}", feerate + 4), 1);
697 check_added_monitors!(nodes[0], 0);
699 const INITIAL_COMMITMENT_NUMBER: u64 = 281474976710654;
701 // Get the TestChannelSigner for each channel, which will be used to (1) get the keys
702 // needed to sign the new commitment tx and (2) sign the new commitment tx.
703 let (local_revocation_basepoint, local_htlc_basepoint, local_funding) = {
704 let per_peer_state = nodes[0].node.per_peer_state.read().unwrap();
705 let chan_lock = per_peer_state.get(&nodes[1].node.get_our_node_id()).unwrap().lock().unwrap();
706 let local_chan = chan_lock.channel_by_id.get(&chan.2).map(
707 |phase| if let ChannelPhase::Funded(chan) = phase { Some(chan) } else { None }
708 ).flatten().unwrap();
709 let chan_signer = local_chan.get_signer();
710 let pubkeys = chan_signer.as_ref().pubkeys();
711 (pubkeys.revocation_basepoint, pubkeys.htlc_basepoint,
712 pubkeys.funding_pubkey)
714 let (remote_delayed_payment_basepoint, remote_htlc_basepoint,remote_point, remote_funding) = {
715 let per_peer_state = nodes[1].node.per_peer_state.read().unwrap();
716 let chan_lock = per_peer_state.get(&nodes[0].node.get_our_node_id()).unwrap().lock().unwrap();
717 let remote_chan = chan_lock.channel_by_id.get(&chan.2).map(
718 |phase| if let ChannelPhase::Funded(chan) = phase { Some(chan) } else { None }
719 ).flatten().unwrap();
720 let chan_signer = remote_chan.get_signer();
721 let pubkeys = chan_signer.as_ref().pubkeys();
722 (pubkeys.delayed_payment_basepoint, pubkeys.htlc_basepoint,
723 chan_signer.as_ref().get_per_commitment_point(INITIAL_COMMITMENT_NUMBER - 1, &secp_ctx),
724 pubkeys.funding_pubkey)
727 // Assemble the set of keys we can use for signatures for our commitment_signed message.
728 let commit_tx_keys = chan_utils::TxCreationKeys::derive_new(&secp_ctx, &remote_point, &remote_delayed_payment_basepoint,
729 &remote_htlc_basepoint, &local_revocation_basepoint, &local_htlc_basepoint);
732 let per_peer_state = nodes[0].node.per_peer_state.read().unwrap();
733 let local_chan_lock = per_peer_state.get(&nodes[1].node.get_our_node_id()).unwrap().lock().unwrap();
734 let local_chan = local_chan_lock.channel_by_id.get(&chan.2).map(
735 |phase| if let ChannelPhase::Funded(chan) = phase { Some(chan) } else { None }
736 ).flatten().unwrap();
737 let local_chan_signer = local_chan.get_signer();
738 let mut htlcs: Vec<(HTLCOutputInCommitment, ())> = vec![];
739 let commitment_tx = CommitmentTransaction::new_with_auxiliary_htlc_data(
740 INITIAL_COMMITMENT_NUMBER - 1,
742 channel_value - push_sats - commit_tx_fee_msat(non_buffer_feerate + 4, 0, &channel_type_features) / 1000,
743 local_funding, remote_funding,
744 commit_tx_keys.clone(),
745 non_buffer_feerate + 4,
747 &local_chan.context.channel_transaction_parameters.as_counterparty_broadcastable()
749 local_chan_signer.as_ecdsa().unwrap().sign_counterparty_commitment(&commitment_tx, Vec::new(), Vec::new(), &secp_ctx).unwrap()
752 let commit_signed_msg = msgs::CommitmentSigned {
755 htlc_signatures: res.1,
757 partial_signature_with_nonce: None,
760 let update_fee = msgs::UpdateFee {
762 feerate_per_kw: non_buffer_feerate + 4,
765 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_fee);
767 //While producing the commitment_signed response after handling a received update_fee request the
768 //check to see if the funder, who sent the update_fee request, can afford the new fee (funder_balance >= fee+channel_reserve)
769 //Should produce and error.
770 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commit_signed_msg);
771 nodes[1].logger.assert_log("lightning::ln::channelmanager", "Funding remote cannot afford proposed new fee".to_string(), 1);
772 check_added_monitors!(nodes[1], 1);
773 check_closed_broadcast!(nodes[1], true);
774 check_closed_event!(nodes[1], 1, ClosureReason::ProcessingError { err: String::from("Funding remote cannot afford proposed new fee") },
775 [nodes[0].node.get_our_node_id()], channel_value);
779 fn test_update_fee_with_fundee_update_add_htlc() {
780 let chanmon_cfgs = create_chanmon_cfgs(2);
781 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
782 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
783 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
784 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
787 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
790 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
793 nodes[0].node.timer_tick_occurred();
794 check_added_monitors!(nodes[0], 1);
796 let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
797 assert_eq!(events_0.len(), 1);
798 let (update_msg, commitment_signed) = match events_0[0] {
799 MessageSendEvent::UpdateHTLCs { node_id:_, updates: msgs::CommitmentUpdate { update_add_htlcs:_, update_fulfill_htlcs:_, update_fail_htlcs:_, update_fail_malformed_htlcs:_, ref update_fee, ref commitment_signed } } => {
800 (update_fee.as_ref(), commitment_signed)
802 _ => panic!("Unexpected event"),
804 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
805 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
806 let (revoke_msg, commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
807 check_added_monitors!(nodes[1], 1);
809 let (route, our_payment_hash, our_payment_preimage, our_payment_secret) = get_route_and_payment_hash!(nodes[1], nodes[0], 800000);
811 // nothing happens since node[1] is in AwaitingRemoteRevoke
812 nodes[1].node.send_payment_with_route(&route, our_payment_hash,
813 RecipientOnionFields::secret_only(our_payment_secret), PaymentId(our_payment_hash.0)).unwrap();
815 let mut added_monitors = nodes[0].chain_monitor.added_monitors.lock().unwrap();
816 assert_eq!(added_monitors.len(), 0);
817 added_monitors.clear();
819 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
820 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
821 // node[1] has nothing to do
823 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
824 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
825 check_added_monitors!(nodes[0], 1);
827 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
828 let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
829 // No commitment_signed so get_event_msg's assert(len == 1) passes
830 check_added_monitors!(nodes[0], 1);
831 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg);
832 check_added_monitors!(nodes[1], 1);
833 // AwaitingRemoteRevoke ends here
835 let commitment_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
836 assert_eq!(commitment_update.update_add_htlcs.len(), 1);
837 assert_eq!(commitment_update.update_fulfill_htlcs.len(), 0);
838 assert_eq!(commitment_update.update_fail_htlcs.len(), 0);
839 assert_eq!(commitment_update.update_fail_malformed_htlcs.len(), 0);
840 assert_eq!(commitment_update.update_fee.is_none(), true);
842 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &commitment_update.update_add_htlcs[0]);
843 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_update.commitment_signed);
844 check_added_monitors!(nodes[0], 1);
845 let (revoke, commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
847 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke);
848 check_added_monitors!(nodes[1], 1);
849 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
851 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commitment_signed);
852 check_added_monitors!(nodes[1], 1);
853 let revoke = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
854 // No commitment_signed so get_event_msg's assert(len == 1) passes
856 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke);
857 check_added_monitors!(nodes[0], 1);
858 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
860 expect_pending_htlcs_forwardable!(nodes[0]);
862 let events = nodes[0].node.get_and_clear_pending_events();
863 assert_eq!(events.len(), 1);
865 Event::PaymentClaimable { .. } => { },
866 _ => panic!("Unexpected event"),
869 claim_payment(&nodes[1], &vec!(&nodes[0])[..], our_payment_preimage);
871 send_payment(&nodes[1], &vec!(&nodes[0])[..], 800000);
872 send_payment(&nodes[0], &vec!(&nodes[1])[..], 800000);
873 close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true);
874 check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
875 check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
879 fn test_update_fee() {
880 let chanmon_cfgs = create_chanmon_cfgs(2);
881 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
882 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
883 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
884 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
885 let channel_id = chan.2;
888 // (1) update_fee/commitment_signed ->
889 // <- (2) revoke_and_ack
890 // .- send (3) commitment_signed
891 // (4) update_fee/commitment_signed ->
892 // .- send (5) revoke_and_ack (no CS as we're awaiting a revoke)
893 // <- (3) commitment_signed delivered
894 // send (6) revoke_and_ack -.
895 // <- (5) deliver revoke_and_ack
896 // (6) deliver revoke_and_ack ->
897 // .- send (7) commitment_signed in response to (4)
898 // <- (7) deliver commitment_signed
901 // Create and deliver (1)...
904 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
905 feerate = *feerate_lock;
906 *feerate_lock = feerate + 20;
908 nodes[0].node.timer_tick_occurred();
909 check_added_monitors!(nodes[0], 1);
911 let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
912 assert_eq!(events_0.len(), 1);
913 let (update_msg, commitment_signed) = match events_0[0] {
914 MessageSendEvent::UpdateHTLCs { node_id:_, updates: msgs::CommitmentUpdate { update_add_htlcs:_, update_fulfill_htlcs:_, update_fail_htlcs:_, update_fail_malformed_htlcs:_, ref update_fee, ref commitment_signed } } => {
915 (update_fee.as_ref(), commitment_signed)
917 _ => panic!("Unexpected event"),
919 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
921 // Generate (2) and (3):
922 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
923 let (revoke_msg, commitment_signed_0) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
924 check_added_monitors!(nodes[1], 1);
927 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
928 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
929 check_added_monitors!(nodes[0], 1);
931 // Create and deliver (4)...
933 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
934 *feerate_lock = feerate + 30;
936 nodes[0].node.timer_tick_occurred();
937 check_added_monitors!(nodes[0], 1);
938 let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
939 assert_eq!(events_0.len(), 1);
940 let (update_msg, commitment_signed) = match events_0[0] {
941 MessageSendEvent::UpdateHTLCs { node_id:_, updates: msgs::CommitmentUpdate { update_add_htlcs:_, update_fulfill_htlcs:_, update_fail_htlcs:_, update_fail_malformed_htlcs:_, ref update_fee, ref commitment_signed } } => {
942 (update_fee.as_ref(), commitment_signed)
944 _ => panic!("Unexpected event"),
947 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
948 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
949 check_added_monitors!(nodes[1], 1);
951 let revoke_msg = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
952 // No commitment_signed so get_event_msg's assert(len == 1) passes
954 // Handle (3), creating (6):
955 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed_0);
956 check_added_monitors!(nodes[0], 1);
957 let revoke_msg_0 = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
958 // No commitment_signed so get_event_msg's assert(len == 1) passes
961 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
962 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
963 check_added_monitors!(nodes[0], 1);
965 // Deliver (6), creating (7):
966 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg_0);
967 let commitment_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
968 assert!(commitment_update.update_add_htlcs.is_empty());
969 assert!(commitment_update.update_fulfill_htlcs.is_empty());
970 assert!(commitment_update.update_fail_htlcs.is_empty());
971 assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
972 assert!(commitment_update.update_fee.is_none());
973 check_added_monitors!(nodes[1], 1);
976 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_update.commitment_signed);
977 check_added_monitors!(nodes[0], 1);
978 let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
979 // No commitment_signed so get_event_msg's assert(len == 1) passes
981 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg);
982 check_added_monitors!(nodes[1], 1);
983 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
985 assert_eq!(get_feerate!(nodes[0], nodes[1], channel_id), feerate + 30);
986 assert_eq!(get_feerate!(nodes[1], nodes[0], channel_id), feerate + 30);
987 close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true);
988 check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
989 check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
993 fn fake_network_test() {
994 // Simple test which builds a network of ChannelManagers, connects them to each other, and
995 // tests that payments get routed and transactions broadcast in semi-reasonable ways.
996 let chanmon_cfgs = create_chanmon_cfgs(4);
997 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
998 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
999 let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
1001 // Create some initial channels
1002 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
1003 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
1004 let chan_3 = create_announced_chan_between_nodes(&nodes, 2, 3);
1006 // Rebalance the network a bit by relaying one payment through all the channels...
1007 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000);
1008 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000);
1009 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000);
1010 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000);
1012 // Send some more payments
1013 send_payment(&nodes[1], &vec!(&nodes[2], &nodes[3])[..], 1000000);
1014 send_payment(&nodes[3], &vec!(&nodes[2], &nodes[1], &nodes[0])[..], 1000000);
1015 send_payment(&nodes[3], &vec!(&nodes[2], &nodes[1])[..], 1000000);
1017 // Test failure packets
1018 let payment_hash_1 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 1000000).1;
1019 fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], payment_hash_1);
1021 // Add a new channel that skips 3
1022 let chan_4 = create_announced_chan_between_nodes(&nodes, 1, 3);
1024 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 1000000);
1025 send_payment(&nodes[2], &vec!(&nodes[3])[..], 1000000);
1026 send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
1027 send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
1028 send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
1029 send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
1030 send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
1032 // Do some rebalance loop payments, simultaneously
1033 let mut hops = Vec::with_capacity(3);
1034 hops.push(RouteHop {
1035 pubkey: nodes[2].node.get_our_node_id(),
1036 node_features: NodeFeatures::empty(),
1037 short_channel_id: chan_2.0.contents.short_channel_id,
1038 channel_features: ChannelFeatures::empty(),
1040 cltv_expiry_delta: chan_3.0.contents.cltv_expiry_delta as u32,
1041 maybe_announced_channel: true,
1043 hops.push(RouteHop {
1044 pubkey: nodes[3].node.get_our_node_id(),
1045 node_features: NodeFeatures::empty(),
1046 short_channel_id: chan_3.0.contents.short_channel_id,
1047 channel_features: ChannelFeatures::empty(),
1049 cltv_expiry_delta: chan_4.1.contents.cltv_expiry_delta as u32,
1050 maybe_announced_channel: true,
1052 hops.push(RouteHop {
1053 pubkey: nodes[1].node.get_our_node_id(),
1054 node_features: nodes[1].node.node_features(),
1055 short_channel_id: chan_4.0.contents.short_channel_id,
1056 channel_features: nodes[1].node.channel_features(),
1058 cltv_expiry_delta: TEST_FINAL_CLTV,
1059 maybe_announced_channel: true,
1061 hops[1].fee_msat = chan_4.1.contents.fee_base_msat as u64 + chan_4.1.contents.fee_proportional_millionths as u64 * hops[2].fee_msat as u64 / 1000000;
1062 hops[0].fee_msat = chan_3.0.contents.fee_base_msat as u64 + chan_3.0.contents.fee_proportional_millionths as u64 * hops[1].fee_msat as u64 / 1000000;
1063 let payment_preimage_1 = send_along_route(&nodes[1],
1064 Route { paths: vec![Path { hops, blinded_tail: None }], route_params: None },
1065 &vec!(&nodes[2], &nodes[3], &nodes[1])[..], 1000000).0;
1067 let mut hops = Vec::with_capacity(3);
1068 hops.push(RouteHop {
1069 pubkey: nodes[3].node.get_our_node_id(),
1070 node_features: NodeFeatures::empty(),
1071 short_channel_id: chan_4.0.contents.short_channel_id,
1072 channel_features: ChannelFeatures::empty(),
1074 cltv_expiry_delta: chan_3.1.contents.cltv_expiry_delta as u32,
1075 maybe_announced_channel: true,
1077 hops.push(RouteHop {
1078 pubkey: nodes[2].node.get_our_node_id(),
1079 node_features: NodeFeatures::empty(),
1080 short_channel_id: chan_3.0.contents.short_channel_id,
1081 channel_features: ChannelFeatures::empty(),
1083 cltv_expiry_delta: chan_2.1.contents.cltv_expiry_delta as u32,
1084 maybe_announced_channel: true,
1086 hops.push(RouteHop {
1087 pubkey: nodes[1].node.get_our_node_id(),
1088 node_features: nodes[1].node.node_features(),
1089 short_channel_id: chan_2.0.contents.short_channel_id,
1090 channel_features: nodes[1].node.channel_features(),
1092 cltv_expiry_delta: TEST_FINAL_CLTV,
1093 maybe_announced_channel: true,
1095 hops[1].fee_msat = chan_2.1.contents.fee_base_msat as u64 + chan_2.1.contents.fee_proportional_millionths as u64 * hops[2].fee_msat as u64 / 1000000;
1096 hops[0].fee_msat = chan_3.1.contents.fee_base_msat as u64 + chan_3.1.contents.fee_proportional_millionths as u64 * hops[1].fee_msat as u64 / 1000000;
1097 let payment_hash_2 = send_along_route(&nodes[1],
1098 Route { paths: vec![Path { hops, blinded_tail: None }], route_params: None },
1099 &vec!(&nodes[3], &nodes[2], &nodes[1])[..], 1000000).1;
1101 // Claim the rebalances...
1102 fail_payment(&nodes[1], &vec!(&nodes[3], &nodes[2], &nodes[1])[..], payment_hash_2);
1103 claim_payment(&nodes[1], &vec!(&nodes[2], &nodes[3], &nodes[1])[..], payment_preimage_1);
1105 // Close down the channels...
1106 close_channel(&nodes[0], &nodes[1], &chan_1.2, chan_1.3, true);
1107 check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
1108 check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
1109 close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, false);
1110 check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure, [nodes[2].node.get_our_node_id()], 100000);
1111 check_closed_event!(nodes[2], 1, ClosureReason::CooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
1112 close_channel(&nodes[2], &nodes[3], &chan_3.2, chan_3.3, true);
1113 check_closed_event!(nodes[2], 1, ClosureReason::CooperativeClosure, [nodes[3].node.get_our_node_id()], 100000);
1114 check_closed_event!(nodes[3], 1, ClosureReason::CooperativeClosure, [nodes[2].node.get_our_node_id()], 100000);
1115 close_channel(&nodes[1], &nodes[3], &chan_4.2, chan_4.3, false);
1116 check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure, [nodes[3].node.get_our_node_id()], 100000);
1117 check_closed_event!(nodes[3], 1, ClosureReason::CooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
1121 fn holding_cell_htlc_counting() {
1122 // Tests that HTLCs in the holding cell count towards the pending HTLC limits on outbound HTLCs
1123 // to ensure we don't end up with HTLCs sitting around in our holding cell for several
1124 // commitment dance rounds.
1125 let chanmon_cfgs = create_chanmon_cfgs(3);
1126 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1127 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1128 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1129 create_announced_chan_between_nodes(&nodes, 0, 1);
1130 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
1132 // Fetch a route in advance as we will be unable to once we're unable to send.
1133 let (route, payment_hash_1, _, payment_secret_1) = get_route_and_payment_hash!(nodes[1], nodes[2], 100000);
1135 let mut payments = Vec::new();
1137 let (route, payment_hash, payment_preimage, payment_secret) = get_route_and_payment_hash!(nodes[1], nodes[2], 100000);
1138 nodes[1].node.send_payment_with_route(&route, payment_hash,
1139 RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_hash.0)).unwrap();
1140 payments.push((payment_preimage, payment_hash));
1142 check_added_monitors!(nodes[1], 1);
1144 let mut events = nodes[1].node.get_and_clear_pending_msg_events();
1145 assert_eq!(events.len(), 1);
1146 let initial_payment_event = SendEvent::from_event(events.pop().unwrap());
1147 assert_eq!(initial_payment_event.node_id, nodes[2].node.get_our_node_id());
1149 // There is now one HTLC in an outbound commitment transaction and (OUR_MAX_HTLCS - 1) HTLCs in
1150 // the holding cell waiting on B's RAA to send. At this point we should not be able to add
1153 unwrap_send_err!(nodes[1].node.send_payment_with_route(&route, payment_hash_1,
1154 RecipientOnionFields::secret_only(payment_secret_1), PaymentId(payment_hash_1.0)
1155 ), true, APIError::ChannelUnavailable { .. }, {});
1156 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1159 // This should also be true if we try to forward a payment.
1160 let (route, payment_hash_2, _, payment_secret_2) = get_route_and_payment_hash!(nodes[0], nodes[2], 100000);
1162 nodes[0].node.send_payment_with_route(&route, payment_hash_2,
1163 RecipientOnionFields::secret_only(payment_secret_2), PaymentId(payment_hash_2.0)).unwrap();
1164 check_added_monitors!(nodes[0], 1);
1167 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1168 assert_eq!(events.len(), 1);
1169 let payment_event = SendEvent::from_event(events.pop().unwrap());
1170 assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
1172 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1173 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
1174 // We have to forward pending HTLCs twice - once tries to forward the payment forward (and
1175 // fails), the second will process the resulting failure and fail the HTLC backward.
1176 expect_pending_htlcs_forwardable!(nodes[1]);
1177 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], vec![HTLCDestination::NextHopChannel { node_id: Some(nodes[2].node.get_our_node_id()), channel_id: chan_2.2 }]);
1178 check_added_monitors!(nodes[1], 1);
1180 let bs_fail_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1181 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &bs_fail_updates.update_fail_htlcs[0]);
1182 commitment_signed_dance!(nodes[0], nodes[1], bs_fail_updates.commitment_signed, false, true);
1184 expect_payment_failed_with_update!(nodes[0], payment_hash_2, false, chan_2.0.contents.short_channel_id, false);
1186 // Now forward all the pending HTLCs and claim them back
1187 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &initial_payment_event.msgs[0]);
1188 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &initial_payment_event.commitment_msg);
1189 check_added_monitors!(nodes[2], 1);
1191 let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1192 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_revoke_and_ack);
1193 check_added_monitors!(nodes[1], 1);
1194 let as_updates = get_htlc_update_msgs!(nodes[1], nodes[2].node.get_our_node_id());
1196 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &bs_commitment_signed);
1197 check_added_monitors!(nodes[1], 1);
1198 let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
1200 for ref update in as_updates.update_add_htlcs.iter() {
1201 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), update);
1203 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &as_updates.commitment_signed);
1204 check_added_monitors!(nodes[2], 1);
1205 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
1206 check_added_monitors!(nodes[2], 1);
1207 let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1209 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_revoke_and_ack);
1210 check_added_monitors!(nodes[1], 1);
1211 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &bs_commitment_signed);
1212 check_added_monitors!(nodes[1], 1);
1213 let as_final_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
1215 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_final_raa);
1216 check_added_monitors!(nodes[2], 1);
1218 expect_pending_htlcs_forwardable!(nodes[2]);
1220 let events = nodes[2].node.get_and_clear_pending_events();
1221 assert_eq!(events.len(), payments.len());
1222 for (event, &(_, ref hash)) in events.iter().zip(payments.iter()) {
1224 &Event::PaymentClaimable { ref payment_hash, .. } => {
1225 assert_eq!(*payment_hash, *hash);
1227 _ => panic!("Unexpected event"),
1231 for (preimage, _) in payments.drain(..) {
1232 claim_payment(&nodes[1], &[&nodes[2]], preimage);
1235 send_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1000000);
1239 fn duplicate_htlc_test() {
1240 // Test that we accept duplicate payment_hash HTLCs across the network and that
1241 // claiming/failing them are all separate and don't affect each other
1242 let chanmon_cfgs = create_chanmon_cfgs(6);
1243 let node_cfgs = create_node_cfgs(6, &chanmon_cfgs);
1244 let node_chanmgrs = create_node_chanmgrs(6, &node_cfgs, &[None, None, None, None, None, None]);
1245 let mut nodes = create_network(6, &node_cfgs, &node_chanmgrs);
1247 // Create some initial channels to route via 3 to 4/5 from 0/1/2
1248 create_announced_chan_between_nodes(&nodes, 0, 3);
1249 create_announced_chan_between_nodes(&nodes, 1, 3);
1250 create_announced_chan_between_nodes(&nodes, 2, 3);
1251 create_announced_chan_between_nodes(&nodes, 3, 4);
1252 create_announced_chan_between_nodes(&nodes, 3, 5);
1254 let (payment_preimage, payment_hash, ..) = route_payment(&nodes[0], &vec!(&nodes[3], &nodes[4])[..], 1000000);
1256 *nodes[0].network_payment_count.borrow_mut() -= 1;
1257 assert_eq!(route_payment(&nodes[1], &vec!(&nodes[3])[..], 1000000).0, payment_preimage);
1259 *nodes[0].network_payment_count.borrow_mut() -= 1;
1260 assert_eq!(route_payment(&nodes[2], &vec!(&nodes[3], &nodes[5])[..], 1000000).0, payment_preimage);
1262 claim_payment(&nodes[0], &vec!(&nodes[3], &nodes[4])[..], payment_preimage);
1263 fail_payment(&nodes[2], &vec!(&nodes[3], &nodes[5])[..], payment_hash);
1264 claim_payment(&nodes[1], &vec!(&nodes[3])[..], payment_preimage);
1268 fn test_duplicate_htlc_different_direction_onchain() {
1269 // Test that ChannelMonitor doesn't generate 2 preimage txn
1270 // when we have 2 HTLCs with same preimage that go across a node
1271 // in opposite directions, even with the same payment secret.
1272 let chanmon_cfgs = create_chanmon_cfgs(2);
1273 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1274 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1275 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1277 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
1280 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
1282 let (payment_preimage, payment_hash, ..) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 900_000);
1284 let (route, _, _, _) = get_route_and_payment_hash!(nodes[1], nodes[0], 800_000);
1285 let node_a_payment_secret = nodes[0].node.create_inbound_payment_for_hash(payment_hash, None, 7200, None).unwrap();
1286 send_along_route_with_secret(&nodes[1], route, &[&[&nodes[0]]], 800_000, payment_hash, node_a_payment_secret);
1288 // Provide preimage to node 0 by claiming payment
1289 nodes[0].node.claim_funds(payment_preimage);
1290 expect_payment_claimed!(nodes[0], payment_hash, 800_000);
1291 check_added_monitors!(nodes[0], 1);
1293 // Broadcast node 1 commitment txn
1294 let remote_txn = get_local_commitment_txn!(nodes[1], chan_1.2);
1296 assert_eq!(remote_txn[0].output.len(), 4); // 1 local, 1 remote, 1 htlc inbound, 1 htlc outbound
1297 let mut has_both_htlcs = 0; // check htlcs match ones committed
1298 for outp in remote_txn[0].output.iter() {
1299 if outp.value == 800_000 / 1000 {
1300 has_both_htlcs += 1;
1301 } else if outp.value == 900_000 / 1000 {
1302 has_both_htlcs += 1;
1305 assert_eq!(has_both_htlcs, 2);
1307 mine_transaction(&nodes[0], &remote_txn[0]);
1308 check_added_monitors!(nodes[0], 1);
1309 check_closed_event!(nodes[0], 1, ClosureReason::CommitmentTxConfirmed, [nodes[1].node.get_our_node_id()], 100000);
1310 connect_blocks(&nodes[0], TEST_FINAL_CLTV); // Confirm blocks until the HTLC expires
1312 let claim_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
1313 assert_eq!(claim_txn.len(), 3);
1315 check_spends!(claim_txn[0], remote_txn[0]); // Immediate HTLC claim with preimage
1316 check_spends!(claim_txn[1], remote_txn[0]);
1317 check_spends!(claim_txn[2], remote_txn[0]);
1318 let preimage_tx = &claim_txn[0];
1319 let (preimage_bump_tx, timeout_tx) = if claim_txn[1].input[0].previous_output == preimage_tx.input[0].previous_output {
1320 (&claim_txn[1], &claim_txn[2])
1322 (&claim_txn[2], &claim_txn[1])
1325 assert_eq!(preimage_tx.input.len(), 1);
1326 assert_eq!(preimage_bump_tx.input.len(), 1);
1328 assert_eq!(preimage_tx.input.len(), 1);
1329 assert_eq!(preimage_tx.input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC 1 <--> 0, preimage tx
1330 assert_eq!(remote_txn[0].output[preimage_tx.input[0].previous_output.vout as usize].value, 800);
1332 assert_eq!(timeout_tx.input.len(), 1);
1333 assert_eq!(timeout_tx.input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // HTLC 0 <--> 1, timeout tx
1334 check_spends!(timeout_tx, remote_txn[0]);
1335 assert_eq!(remote_txn[0].output[timeout_tx.input[0].previous_output.vout as usize].value, 900);
1337 let events = nodes[0].node.get_and_clear_pending_msg_events();
1338 assert_eq!(events.len(), 3);
1341 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
1342 MessageSendEvent::HandleError { node_id, action: msgs::ErrorAction::DisconnectPeer { ref msg } } => {
1343 assert_eq!(node_id, nodes[1].node.get_our_node_id());
1344 assert_eq!(msg.as_ref().unwrap().data, "Channel closed because commitment or closing transaction was confirmed on chain.");
1346 MessageSendEvent::UpdateHTLCs { ref node_id, updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fulfill_htlcs, ref update_fail_htlcs, ref update_fail_malformed_htlcs, .. } } => {
1347 assert!(update_add_htlcs.is_empty());
1348 assert!(update_fail_htlcs.is_empty());
1349 assert_eq!(update_fulfill_htlcs.len(), 1);
1350 assert!(update_fail_malformed_htlcs.is_empty());
1351 assert_eq!(nodes[1].node.get_our_node_id(), *node_id);
1353 _ => panic!("Unexpected event"),
1359 fn test_basic_channel_reserve() {
1360 let chanmon_cfgs = create_chanmon_cfgs(2);
1361 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1362 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1363 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1364 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000);
1366 let chan_stat = get_channel_value_stat!(nodes[0], nodes[1], chan.2);
1367 let channel_reserve = chan_stat.channel_reserve_msat;
1369 // The 2* and +1 are for the fee spike reserve.
1370 let commit_tx_fee = 2 * commit_tx_fee_msat(get_feerate!(nodes[0], nodes[1], chan.2), 1 + 1, &get_channel_type_features!(nodes[0], nodes[1], chan.2));
1371 let max_can_send = 5000000 - channel_reserve - commit_tx_fee;
1372 let (mut route, our_payment_hash, _, our_payment_secret) =
1373 get_route_and_payment_hash!(nodes[0], nodes[1], max_can_send);
1374 route.paths[0].hops.last_mut().unwrap().fee_msat += 1;
1375 let err = nodes[0].node.send_payment_with_route(&route, our_payment_hash,
1376 RecipientOnionFields::secret_only(our_payment_secret), PaymentId(our_payment_hash.0)).err().unwrap();
1378 PaymentSendFailure::AllFailedResendSafe(ref fails) => {
1379 if let &APIError::ChannelUnavailable { .. } = &fails[0] {}
1380 else { panic!("Unexpected error variant"); }
1382 _ => panic!("Unexpected error variant"),
1384 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1386 send_payment(&nodes[0], &vec![&nodes[1]], max_can_send);
1390 fn test_fee_spike_violation_fails_htlc() {
1391 let chanmon_cfgs = create_chanmon_cfgs(2);
1392 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1393 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1394 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1395 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000);
1397 let (mut route, payment_hash, _, payment_secret) =
1398 get_route_and_payment_hash!(nodes[0], nodes[1], 3460000);
1399 route.paths[0].hops[0].fee_msat += 1;
1400 // Need to manually create the update_add_htlc message to go around the channel reserve check in send_htlc()
1401 let secp_ctx = Secp256k1::new();
1402 let session_priv = SecretKey::from_slice(&[42; 32]).expect("RNG is bad!");
1404 let cur_height = nodes[1].node.best_block.read().unwrap().height() + 1;
1406 let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route.paths[0], &session_priv).unwrap();
1407 let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0],
1408 3460001, RecipientOnionFields::secret_only(payment_secret), cur_height, &None).unwrap();
1409 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash).unwrap();
1410 let msg = msgs::UpdateAddHTLC {
1413 amount_msat: htlc_msat,
1414 payment_hash: payment_hash,
1415 cltv_expiry: htlc_cltv,
1416 onion_routing_packet: onion_packet,
1417 skimmed_fee_msat: None,
1418 blinding_point: None,
1421 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
1423 // Now manually create the commitment_signed message corresponding to the update_add
1424 // nodes[0] just sent. In the code for construction of this message, "local" refers
1425 // to the sender of the message, and "remote" refers to the receiver.
1427 let feerate_per_kw = get_feerate!(nodes[0], nodes[1], chan.2);
1429 const INITIAL_COMMITMENT_NUMBER: u64 = (1 << 48) - 1;
1431 // Get the TestChannelSigner for each channel, which will be used to (1) get the keys
1432 // needed to sign the new commitment tx and (2) sign the new commitment tx.
1433 let (local_revocation_basepoint, local_htlc_basepoint, local_secret, next_local_point, local_funding) = {
1434 let per_peer_state = nodes[0].node.per_peer_state.read().unwrap();
1435 let chan_lock = per_peer_state.get(&nodes[1].node.get_our_node_id()).unwrap().lock().unwrap();
1436 let local_chan = chan_lock.channel_by_id.get(&chan.2).map(
1437 |phase| if let ChannelPhase::Funded(chan) = phase { Some(chan) } else { None }
1438 ).flatten().unwrap();
1439 let chan_signer = local_chan.get_signer();
1440 // Make the signer believe we validated another commitment, so we can release the secret
1441 chan_signer.as_ecdsa().unwrap().get_enforcement_state().last_holder_commitment -= 1;
1443 let pubkeys = chan_signer.as_ref().pubkeys();
1444 (pubkeys.revocation_basepoint, pubkeys.htlc_basepoint,
1445 chan_signer.as_ref().release_commitment_secret(INITIAL_COMMITMENT_NUMBER),
1446 chan_signer.as_ref().get_per_commitment_point(INITIAL_COMMITMENT_NUMBER - 2, &secp_ctx),
1447 chan_signer.as_ref().pubkeys().funding_pubkey)
1449 let (remote_delayed_payment_basepoint, remote_htlc_basepoint, remote_point, remote_funding) = {
1450 let per_peer_state = nodes[1].node.per_peer_state.read().unwrap();
1451 let chan_lock = per_peer_state.get(&nodes[0].node.get_our_node_id()).unwrap().lock().unwrap();
1452 let remote_chan = chan_lock.channel_by_id.get(&chan.2).map(
1453 |phase| if let ChannelPhase::Funded(chan) = phase { Some(chan) } else { None }
1454 ).flatten().unwrap();
1455 let chan_signer = remote_chan.get_signer();
1456 let pubkeys = chan_signer.as_ref().pubkeys();
1457 (pubkeys.delayed_payment_basepoint, pubkeys.htlc_basepoint,
1458 chan_signer.as_ref().get_per_commitment_point(INITIAL_COMMITMENT_NUMBER - 1, &secp_ctx),
1459 chan_signer.as_ref().pubkeys().funding_pubkey)
1462 // Assemble the set of keys we can use for signatures for our commitment_signed message.
1463 let commit_tx_keys = chan_utils::TxCreationKeys::derive_new(&secp_ctx, &remote_point, &remote_delayed_payment_basepoint,
1464 &remote_htlc_basepoint, &local_revocation_basepoint, &local_htlc_basepoint);
1466 // Build the remote commitment transaction so we can sign it, and then later use the
1467 // signature for the commitment_signed message.
1468 let local_chan_balance = 1313;
1470 let accepted_htlc_info = chan_utils::HTLCOutputInCommitment {
1472 amount_msat: 3460001,
1473 cltv_expiry: htlc_cltv,
1475 transaction_output_index: Some(1),
1478 let commitment_number = INITIAL_COMMITMENT_NUMBER - 1;
1481 let per_peer_state = nodes[0].node.per_peer_state.read().unwrap();
1482 let local_chan_lock = per_peer_state.get(&nodes[1].node.get_our_node_id()).unwrap().lock().unwrap();
1483 let local_chan = local_chan_lock.channel_by_id.get(&chan.2).map(
1484 |phase| if let ChannelPhase::Funded(chan) = phase { Some(chan) } else { None }
1485 ).flatten().unwrap();
1486 let local_chan_signer = local_chan.get_signer();
1487 let commitment_tx = CommitmentTransaction::new_with_auxiliary_htlc_data(
1491 local_funding, remote_funding,
1492 commit_tx_keys.clone(),
1494 &mut vec![(accepted_htlc_info, ())],
1495 &local_chan.context.channel_transaction_parameters.as_counterparty_broadcastable()
1497 local_chan_signer.as_ecdsa().unwrap().sign_counterparty_commitment(&commitment_tx, Vec::new(), Vec::new(), &secp_ctx).unwrap()
1500 let commit_signed_msg = msgs::CommitmentSigned {
1503 htlc_signatures: res.1,
1505 partial_signature_with_nonce: None,
1508 // Send the commitment_signed message to the nodes[1].
1509 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commit_signed_msg);
1510 let _ = nodes[1].node.get_and_clear_pending_msg_events();
1512 // Send the RAA to nodes[1].
1513 let raa_msg = msgs::RevokeAndACK {
1515 per_commitment_secret: local_secret,
1516 next_per_commitment_point: next_local_point,
1518 next_local_nonce: None,
1520 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &raa_msg);
1522 let events = nodes[1].node.get_and_clear_pending_msg_events();
1523 assert_eq!(events.len(), 1);
1524 // Make sure the HTLC failed in the way we expect.
1526 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fail_htlcs, .. }, .. } => {
1527 assert_eq!(update_fail_htlcs.len(), 1);
1528 update_fail_htlcs[0].clone()
1530 _ => panic!("Unexpected event"),
1532 nodes[1].logger.assert_log("lightning::ln::channel",
1533 format!("Attempting to fail HTLC due to fee spike buffer violation in channel {}. Rebalancing is required.", raa_msg.channel_id), 1);
1535 check_added_monitors!(nodes[1], 2);
1539 fn test_chan_reserve_violation_outbound_htlc_inbound_chan() {
1540 let mut chanmon_cfgs = create_chanmon_cfgs(2);
1541 // Set the fee rate for the channel very high, to the point where the fundee
1542 // sending any above-dust amount would result in a channel reserve violation.
1543 // In this test we check that we would be prevented from sending an HTLC in
1545 let feerate_per_kw = *chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
1546 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1547 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1548 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1549 let default_config = UserConfig::default();
1550 let channel_type_features = ChannelTypeFeatures::only_static_remote_key();
1552 let mut push_amt = 100_000_000;
1553 push_amt -= commit_tx_fee_msat(feerate_per_kw, MIN_AFFORDABLE_HTLC_COUNT as u64, &channel_type_features);
1555 push_amt -= get_holder_selected_channel_reserve_satoshis(100_000, &default_config) * 1000;
1557 let _ = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100_000, push_amt);
1559 // Fetch a route in advance as we will be unable to once we're unable to send.
1560 let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[1], nodes[0], 1_000_000);
1561 // Sending exactly enough to hit the reserve amount should be accepted
1562 for _ in 0..MIN_AFFORDABLE_HTLC_COUNT {
1563 route_payment(&nodes[1], &[&nodes[0]], 1_000_000);
1566 // However one more HTLC should be significantly over the reserve amount and fail.
1567 unwrap_send_err!(nodes[1].node.send_payment_with_route(&route, our_payment_hash,
1568 RecipientOnionFields::secret_only(our_payment_secret), PaymentId(our_payment_hash.0)
1569 ), true, APIError::ChannelUnavailable { .. }, {});
1570 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1574 fn test_chan_reserve_violation_inbound_htlc_outbound_channel() {
1575 let mut chanmon_cfgs = create_chanmon_cfgs(2);
1576 let feerate_per_kw = *chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
1577 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1578 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1579 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1580 let default_config = UserConfig::default();
1581 let channel_type_features = ChannelTypeFeatures::only_static_remote_key();
1583 // Set nodes[0]'s balance such that they will consider any above-dust received HTLC to be a
1584 // channel reserve violation (so their balance is channel reserve (1000 sats) + commitment
1585 // transaction fee with 0 HTLCs (183 sats)).
1586 let mut push_amt = 100_000_000;
1587 push_amt -= commit_tx_fee_msat(feerate_per_kw, MIN_AFFORDABLE_HTLC_COUNT as u64, &channel_type_features);
1588 push_amt -= get_holder_selected_channel_reserve_satoshis(100_000, &default_config) * 1000;
1589 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100_000, push_amt);
1591 // Send four HTLCs to cover the initial push_msat buffer we're required to include
1592 for _ in 0..MIN_AFFORDABLE_HTLC_COUNT {
1593 route_payment(&nodes[1], &[&nodes[0]], 1_000_000);
1596 let (mut route, payment_hash, _, payment_secret) =
1597 get_route_and_payment_hash!(nodes[1], nodes[0], 1000);
1598 route.paths[0].hops[0].fee_msat = 700_000;
1599 // Need to manually create the update_add_htlc message to go around the channel reserve check in send_htlc()
1600 let secp_ctx = Secp256k1::new();
1601 let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
1602 let cur_height = nodes[1].node.best_block.read().unwrap().height() + 1;
1603 let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route.paths[0], &session_priv).unwrap();
1604 let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0],
1605 700_000, RecipientOnionFields::secret_only(payment_secret), cur_height, &None).unwrap();
1606 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash).unwrap();
1607 let msg = msgs::UpdateAddHTLC {
1609 htlc_id: MIN_AFFORDABLE_HTLC_COUNT as u64,
1610 amount_msat: htlc_msat,
1611 payment_hash: payment_hash,
1612 cltv_expiry: htlc_cltv,
1613 onion_routing_packet: onion_packet,
1614 skimmed_fee_msat: None,
1615 blinding_point: None,
1618 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &msg);
1619 // Check that the payment failed and the channel is closed in response to the malicious UpdateAdd.
1620 nodes[0].logger.assert_log("lightning::ln::channelmanager", "Cannot accept HTLC that would put our balance under counterparty-announced channel reserve value".to_string(), 1);
1621 assert_eq!(nodes[0].node.list_channels().len(), 0);
1622 let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
1623 assert_eq!(err_msg.data, "Cannot accept HTLC that would put our balance under counterparty-announced channel reserve value");
1624 check_added_monitors!(nodes[0], 1);
1625 check_closed_event!(nodes[0], 1, ClosureReason::ProcessingError { err: "Cannot accept HTLC that would put our balance under counterparty-announced channel reserve value".to_string() },
1626 [nodes[1].node.get_our_node_id()], 100000);
1630 fn test_chan_reserve_dust_inbound_htlcs_outbound_chan() {
1631 // Test that if we receive many dust HTLCs over an outbound channel, they don't count when
1632 // calculating our commitment transaction fee (this was previously broken).
1633 let mut chanmon_cfgs = create_chanmon_cfgs(2);
1634 let feerate_per_kw = *chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
1636 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1637 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None, None]);
1638 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1639 let default_config = UserConfig::default();
1640 let channel_type_features = ChannelTypeFeatures::only_static_remote_key();
1642 // Set nodes[0]'s balance such that they will consider any above-dust received HTLC to be a
1643 // channel reserve violation (so their balance is channel reserve (1000 sats) + commitment
1644 // transaction fee with 0 HTLCs (183 sats)).
1645 let mut push_amt = 100_000_000;
1646 push_amt -= commit_tx_fee_msat(feerate_per_kw, MIN_AFFORDABLE_HTLC_COUNT as u64, &channel_type_features);
1647 push_amt -= get_holder_selected_channel_reserve_satoshis(100_000, &default_config) * 1000;
1648 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, push_amt);
1650 let dust_amt = crate::ln::channel::MIN_CHAN_DUST_LIMIT_SATOSHIS * 1000
1651 + feerate_per_kw as u64 * htlc_success_tx_weight(&channel_type_features) / 1000 * 1000 - 1;
1652 // In the previous code, routing this dust payment would cause nodes[0] to perceive a channel
1653 // reserve violation even though it's a dust HTLC and therefore shouldn't count towards the
1654 // commitment transaction fee.
1655 route_payment(&nodes[1], &[&nodes[0]], dust_amt);
1657 // Send four HTLCs to cover the initial push_msat buffer we're required to include
1658 for _ in 0..MIN_AFFORDABLE_HTLC_COUNT {
1659 route_payment(&nodes[1], &[&nodes[0]], 1_000_000);
1662 // One more than the dust amt should fail, however.
1663 let (mut route, our_payment_hash, _, our_payment_secret) =
1664 get_route_and_payment_hash!(nodes[1], nodes[0], dust_amt);
1665 route.paths[0].hops[0].fee_msat += 1;
1666 unwrap_send_err!(nodes[1].node.send_payment_with_route(&route, our_payment_hash,
1667 RecipientOnionFields::secret_only(our_payment_secret), PaymentId(our_payment_hash.0)
1668 ), true, APIError::ChannelUnavailable { .. }, {});
1672 fn test_chan_init_feerate_unaffordability() {
1673 // Test that we will reject channel opens which do not leave enough to pay for any HTLCs due to
1674 // channel reserve and feerate requirements.
1675 let mut chanmon_cfgs = create_chanmon_cfgs(2);
1676 let feerate_per_kw = *chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
1677 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1678 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1679 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1680 let default_config = UserConfig::default();
1681 let channel_type_features = ChannelTypeFeatures::only_static_remote_key();
1683 // Set the push_msat amount such that nodes[0] will not be able to afford to add even a single
1685 let mut push_amt = 100_000_000;
1686 push_amt -= commit_tx_fee_msat(feerate_per_kw, MIN_AFFORDABLE_HTLC_COUNT as u64, &channel_type_features);
1687 assert_eq!(nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100_000, push_amt + 1, 42, None, None).unwrap_err(),
1688 APIError::APIMisuseError { err: "Funding amount (356) can't even pay fee for initial commitment transaction fee of 357.".to_string() });
1690 // During open, we don't have a "counterparty channel reserve" to check against, so that
1691 // requirement only comes into play on the open_channel handling side.
1692 push_amt -= get_holder_selected_channel_reserve_satoshis(100_000, &default_config) * 1000;
1693 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100_000, push_amt, 42, None, None).unwrap();
1694 let mut open_channel_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
1695 open_channel_msg.push_msat += 1;
1696 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel_msg);
1698 let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
1699 assert_eq!(msg_events.len(), 1);
1700 match msg_events[0] {
1701 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id: _ } => {
1702 assert_eq!(msg.data, "Insufficient funding amount for initial reserve");
1704 _ => panic!("Unexpected event"),
1709 fn test_chan_reserve_dust_inbound_htlcs_inbound_chan() {
1710 // Test that if we receive many dust HTLCs over an inbound channel, they don't count when
1711 // calculating our counterparty's commitment transaction fee (this was previously broken).
1712 let chanmon_cfgs = create_chanmon_cfgs(2);
1713 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1714 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None, None]);
1715 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1716 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 98000000);
1718 let payment_amt = 46000; // Dust amount
1719 // In the previous code, these first four payments would succeed.
1720 route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1721 route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1722 route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1723 route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1725 // Then these next 5 would be interpreted by nodes[1] as violating the fee spike buffer.
1726 route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1727 route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1728 route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1729 route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1730 route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1732 // And this last payment previously resulted in nodes[1] closing on its inbound-channel
1733 // counterparty, because it counted all the previous dust HTLCs against nodes[0]'s commitment
1734 // transaction fee and therefore perceived this next payment as a channel reserve violation.
1735 route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1739 fn test_chan_reserve_violation_inbound_htlc_inbound_chan() {
1740 let chanmon_cfgs = create_chanmon_cfgs(3);
1741 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1742 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1743 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1744 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000);
1745 let _ = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 100000, 95000000);
1748 let total_routing_fee_msat = (nodes.len() - 2) as u64 * feemsat;
1749 let chan_stat = get_channel_value_stat!(nodes[0], nodes[1], chan.2);
1750 let feerate = get_feerate!(nodes[0], nodes[1], chan.2);
1751 let channel_type_features = get_channel_type_features!(nodes[0], nodes[1], chan.2);
1753 // Add a 2* and +1 for the fee spike reserve.
1754 let commit_tx_fee_2_htlc = 2*commit_tx_fee_msat(feerate, 2 + 1, &channel_type_features);
1755 let recv_value_1 = (chan_stat.value_to_self_msat - chan_stat.channel_reserve_msat - total_routing_fee_msat - commit_tx_fee_2_htlc)/2;
1756 let amt_msat_1 = recv_value_1 + total_routing_fee_msat;
1758 // Add a pending HTLC.
1759 let (route_1, our_payment_hash_1, _, our_payment_secret_1) = get_route_and_payment_hash!(nodes[0], nodes[2], amt_msat_1);
1760 let payment_event_1 = {
1761 nodes[0].node.send_payment_with_route(&route_1, our_payment_hash_1,
1762 RecipientOnionFields::secret_only(our_payment_secret_1), PaymentId(our_payment_hash_1.0)).unwrap();
1763 check_added_monitors!(nodes[0], 1);
1765 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1766 assert_eq!(events.len(), 1);
1767 SendEvent::from_event(events.remove(0))
1769 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event_1.msgs[0]);
1771 // Attempt to trigger a channel reserve violation --> payment failure.
1772 let commit_tx_fee_2_htlcs = commit_tx_fee_msat(feerate, 2, &channel_type_features);
1773 let recv_value_2 = chan_stat.value_to_self_msat - amt_msat_1 - chan_stat.channel_reserve_msat - total_routing_fee_msat - commit_tx_fee_2_htlcs + 1;
1774 let amt_msat_2 = recv_value_2 + total_routing_fee_msat;
1775 let mut route_2 = route_1.clone();
1776 route_2.paths[0].hops.last_mut().unwrap().fee_msat = amt_msat_2;
1778 // Need to manually create the update_add_htlc message to go around the channel reserve check in send_htlc()
1779 let secp_ctx = Secp256k1::new();
1780 let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
1781 let cur_height = nodes[0].node.best_block.read().unwrap().height() + 1;
1782 let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route_2.paths[0], &session_priv).unwrap();
1783 let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(
1784 &route_2.paths[0], recv_value_2, RecipientOnionFields::spontaneous_empty(), cur_height, &None).unwrap();
1785 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &our_payment_hash_1).unwrap();
1786 let msg = msgs::UpdateAddHTLC {
1789 amount_msat: htlc_msat + 1,
1790 payment_hash: our_payment_hash_1,
1791 cltv_expiry: htlc_cltv,
1792 onion_routing_packet: onion_packet,
1793 skimmed_fee_msat: None,
1794 blinding_point: None,
1797 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
1798 // Check that the payment failed and the channel is closed in response to the malicious UpdateAdd.
1799 nodes[1].logger.assert_log("lightning::ln::channelmanager", "Remote HTLC add would put them under remote reserve value".to_string(), 1);
1800 assert_eq!(nodes[1].node.list_channels().len(), 1);
1801 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
1802 assert_eq!(err_msg.data, "Remote HTLC add would put them under remote reserve value");
1803 check_added_monitors!(nodes[1], 1);
1804 check_closed_event!(nodes[1], 1, ClosureReason::ProcessingError { err: "Remote HTLC add would put them under remote reserve value".to_string() },
1805 [nodes[0].node.get_our_node_id()], 100000);
1809 fn test_inbound_outbound_capacity_is_not_zero() {
1810 let chanmon_cfgs = create_chanmon_cfgs(2);
1811 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1812 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1813 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1814 let _ = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000);
1815 let channels0 = node_chanmgrs[0].list_channels();
1816 let channels1 = node_chanmgrs[1].list_channels();
1817 let default_config = UserConfig::default();
1818 assert_eq!(channels0.len(), 1);
1819 assert_eq!(channels1.len(), 1);
1821 let reserve = get_holder_selected_channel_reserve_satoshis(100_000, &default_config);
1822 assert_eq!(channels0[0].inbound_capacity_msat, 95000000 - reserve*1000);
1823 assert_eq!(channels1[0].outbound_capacity_msat, 95000000 - reserve*1000);
1825 assert_eq!(channels0[0].outbound_capacity_msat, 100000 * 1000 - 95000000 - reserve*1000);
1826 assert_eq!(channels1[0].inbound_capacity_msat, 100000 * 1000 - 95000000 - reserve*1000);
1829 fn commit_tx_fee_msat(feerate: u32, num_htlcs: u64, channel_type_features: &ChannelTypeFeatures) -> u64 {
1830 (commitment_tx_base_weight(channel_type_features) + num_htlcs * COMMITMENT_TX_WEIGHT_PER_HTLC) * feerate as u64 / 1000 * 1000
1834 fn test_channel_reserve_holding_cell_htlcs() {
1835 let chanmon_cfgs = create_chanmon_cfgs(3);
1836 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1837 // When this test was written, the default base fee floated based on the HTLC count.
1838 // It is now fixed, so we simply set the fee to the expected value here.
1839 let mut config = test_default_channel_config();
1840 config.channel_config.forwarding_fee_base_msat = 239;
1841 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[Some(config.clone()), Some(config.clone()), Some(config.clone())]);
1842 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1843 let chan_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 190000, 1001);
1844 let chan_2 = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 190000, 1001);
1846 let mut stat01 = get_channel_value_stat!(nodes[0], nodes[1], chan_1.2);
1847 let mut stat11 = get_channel_value_stat!(nodes[1], nodes[0], chan_1.2);
1849 let mut stat12 = get_channel_value_stat!(nodes[1], nodes[2], chan_2.2);
1850 let mut stat22 = get_channel_value_stat!(nodes[2], nodes[1], chan_2.2);
1852 macro_rules! expect_forward {
1854 let mut events = $node.node.get_and_clear_pending_msg_events();
1855 assert_eq!(events.len(), 1);
1856 check_added_monitors!($node, 1);
1857 let payment_event = SendEvent::from_event(events.remove(0));
1862 let feemsat = 239; // set above
1863 let total_fee_msat = (nodes.len() - 2) as u64 * feemsat;
1864 let feerate = get_feerate!(nodes[0], nodes[1], chan_1.2);
1865 let channel_type_features = get_channel_type_features!(nodes[0], nodes[1], chan_1.2);
1867 let recv_value_0 = stat01.counterparty_max_htlc_value_in_flight_msat - total_fee_msat;
1869 // attempt to send amt_msat > their_max_htlc_value_in_flight_msat
1871 let payment_params = PaymentParameters::from_node_id(nodes[2].node.get_our_node_id(), TEST_FINAL_CLTV)
1872 .with_bolt11_features(nodes[2].node.bolt11_invoice_features()).unwrap().with_max_channel_saturation_power_of_half(0);
1873 let (mut route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], payment_params, recv_value_0);
1874 route.paths[0].hops.last_mut().unwrap().fee_msat += 1;
1875 assert!(route.paths[0].hops.iter().rev().skip(1).all(|h| h.fee_msat == feemsat));
1877 unwrap_send_err!(nodes[0].node.send_payment_with_route(&route, our_payment_hash,
1878 RecipientOnionFields::secret_only(our_payment_secret), PaymentId(our_payment_hash.0)
1879 ), true, APIError::ChannelUnavailable { .. }, {});
1880 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1883 // channel reserve is bigger than their_max_htlc_value_in_flight_msat so loop to deplete
1884 // nodes[0]'s wealth
1886 let amt_msat = recv_value_0 + total_fee_msat;
1887 // 3 for the 3 HTLCs that will be sent, 2* and +1 for the fee spike reserve.
1888 // Also, ensure that each payment has enough to be over the dust limit to
1889 // ensure it'll be included in each commit tx fee calculation.
1890 let commit_tx_fee_all_htlcs = 2*commit_tx_fee_msat(feerate, 3 + 1, &channel_type_features);
1891 let ensure_htlc_amounts_above_dust_buffer = 3 * (stat01.counterparty_dust_limit_msat + 1000);
1892 if stat01.value_to_self_msat < stat01.channel_reserve_msat + commit_tx_fee_all_htlcs + ensure_htlc_amounts_above_dust_buffer + amt_msat {
1896 let payment_params = PaymentParameters::from_node_id(nodes[2].node.get_our_node_id(), TEST_FINAL_CLTV)
1897 .with_bolt11_features(nodes[2].node.bolt11_invoice_features()).unwrap().with_max_channel_saturation_power_of_half(0);
1898 let route = get_route!(nodes[0], payment_params, recv_value_0).unwrap();
1899 let (payment_preimage, ..) = send_along_route(&nodes[0], route, &[&nodes[1], &nodes[2]], recv_value_0);
1900 claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage);
1902 let (stat01_, stat11_, stat12_, stat22_) = (
1903 get_channel_value_stat!(nodes[0], nodes[1], chan_1.2),
1904 get_channel_value_stat!(nodes[1], nodes[0], chan_1.2),
1905 get_channel_value_stat!(nodes[1], nodes[2], chan_2.2),
1906 get_channel_value_stat!(nodes[2], nodes[1], chan_2.2),
1909 assert_eq!(stat01_.value_to_self_msat, stat01.value_to_self_msat - amt_msat);
1910 assert_eq!(stat11_.value_to_self_msat, stat11.value_to_self_msat + amt_msat);
1911 assert_eq!(stat12_.value_to_self_msat, stat12.value_to_self_msat - (amt_msat - feemsat));
1912 assert_eq!(stat22_.value_to_self_msat, stat22.value_to_self_msat + (amt_msat - feemsat));
1913 stat01 = stat01_; stat11 = stat11_; stat12 = stat12_; stat22 = stat22_;
1916 // adding pending output.
1917 // 2* and +1 HTLCs on the commit tx fee for the fee spike reserve.
1918 // The reason we're dividing by two here is as follows: the dividend is the total outbound liquidity
1919 // after fees, the channel reserve, and the fee spike buffer are removed. We eventually want to
1920 // divide this quantity into 3 portions, that will each be sent in an HTLC. This allows us
1921 // to test channel channel reserve policy at the edges of what amount is sendable, i.e.
1922 // cases where 1 msat over X amount will cause a payment failure, but anything less than
1923 // that can be sent successfully. So, dividing by two is a somewhat arbitrary way of getting
1924 // the amount of the first of these aforementioned 3 payments. The reason we split into 3 payments
1925 // is to test the behavior of the holding cell with respect to channel reserve and commit tx fee
1927 let commit_tx_fee_2_htlcs = 2*commit_tx_fee_msat(feerate, 2 + 1, &channel_type_features);
1928 let recv_value_1 = (stat01.value_to_self_msat - stat01.channel_reserve_msat - total_fee_msat - commit_tx_fee_2_htlcs)/2;
1929 let amt_msat_1 = recv_value_1 + total_fee_msat;
1931 let (route_1, our_payment_hash_1, our_payment_preimage_1, our_payment_secret_1) = get_route_and_payment_hash!(nodes[0], nodes[2], recv_value_1);
1932 let payment_event_1 = {
1933 nodes[0].node.send_payment_with_route(&route_1, our_payment_hash_1,
1934 RecipientOnionFields::secret_only(our_payment_secret_1), PaymentId(our_payment_hash_1.0)).unwrap();
1935 check_added_monitors!(nodes[0], 1);
1937 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1938 assert_eq!(events.len(), 1);
1939 SendEvent::from_event(events.remove(0))
1941 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event_1.msgs[0]);
1943 // channel reserve test with htlc pending output > 0
1944 let recv_value_2 = stat01.value_to_self_msat - amt_msat_1 - stat01.channel_reserve_msat - total_fee_msat - commit_tx_fee_2_htlcs;
1946 let mut route = route_1.clone();
1947 route.paths[0].hops.last_mut().unwrap().fee_msat = recv_value_2 + 1;
1948 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[2]);
1949 unwrap_send_err!(nodes[0].node.send_payment_with_route(&route, our_payment_hash,
1950 RecipientOnionFields::secret_only(our_payment_secret), PaymentId(our_payment_hash.0)
1951 ), true, APIError::ChannelUnavailable { .. }, {});
1952 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1955 // split the rest to test holding cell
1956 let commit_tx_fee_3_htlcs = 2*commit_tx_fee_msat(feerate, 3 + 1, &channel_type_features);
1957 let additional_htlc_cost_msat = commit_tx_fee_3_htlcs - commit_tx_fee_2_htlcs;
1958 let recv_value_21 = recv_value_2/2 - additional_htlc_cost_msat/2;
1959 let recv_value_22 = recv_value_2 - recv_value_21 - total_fee_msat - additional_htlc_cost_msat;
1961 let stat = get_channel_value_stat!(nodes[0], nodes[1], chan_1.2);
1962 assert_eq!(stat.value_to_self_msat - (stat.pending_outbound_htlcs_amount_msat + recv_value_21 + recv_value_22 + total_fee_msat + total_fee_msat + commit_tx_fee_3_htlcs), stat.channel_reserve_msat);
1965 // now see if they go through on both sides
1966 let (route_21, our_payment_hash_21, our_payment_preimage_21, our_payment_secret_21) = get_route_and_payment_hash!(nodes[0], nodes[2], recv_value_21);
1967 // but this will stuck in the holding cell
1968 nodes[0].node.send_payment_with_route(&route_21, our_payment_hash_21,
1969 RecipientOnionFields::secret_only(our_payment_secret_21), PaymentId(our_payment_hash_21.0)).unwrap();
1970 check_added_monitors!(nodes[0], 0);
1971 let events = nodes[0].node.get_and_clear_pending_events();
1972 assert_eq!(events.len(), 0);
1974 // test with outbound holding cell amount > 0
1976 let (mut route, our_payment_hash, _, our_payment_secret) =
1977 get_route_and_payment_hash!(nodes[0], nodes[2], recv_value_22);
1978 route.paths[0].hops.last_mut().unwrap().fee_msat += 1;
1979 unwrap_send_err!(nodes[0].node.send_payment_with_route(&route, our_payment_hash,
1980 RecipientOnionFields::secret_only(our_payment_secret), PaymentId(our_payment_hash.0)
1981 ), true, APIError::ChannelUnavailable { .. }, {});
1982 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1985 let (route_22, our_payment_hash_22, our_payment_preimage_22, our_payment_secret_22) = get_route_and_payment_hash!(nodes[0], nodes[2], recv_value_22);
1986 // this will also stuck in the holding cell
1987 nodes[0].node.send_payment_with_route(&route_22, our_payment_hash_22,
1988 RecipientOnionFields::secret_only(our_payment_secret_22), PaymentId(our_payment_hash_22.0)).unwrap();
1989 check_added_monitors!(nodes[0], 0);
1990 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
1991 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1993 // flush the pending htlc
1994 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event_1.commitment_msg);
1995 let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1996 check_added_monitors!(nodes[1], 1);
1998 // the pending htlc should be promoted to committed
1999 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_revoke_and_ack);
2000 check_added_monitors!(nodes[0], 1);
2001 let commitment_update_2 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2003 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &as_commitment_signed);
2004 let bs_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2005 // No commitment_signed so get_event_msg's assert(len == 1) passes
2006 check_added_monitors!(nodes[0], 1);
2008 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &bs_revoke_and_ack);
2009 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2010 check_added_monitors!(nodes[1], 1);
2012 expect_pending_htlcs_forwardable!(nodes[1]);
2014 let ref payment_event_11 = expect_forward!(nodes[1]);
2015 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_11.msgs[0]);
2016 commitment_signed_dance!(nodes[2], nodes[1], payment_event_11.commitment_msg, false);
2018 expect_pending_htlcs_forwardable!(nodes[2]);
2019 expect_payment_claimable!(nodes[2], our_payment_hash_1, our_payment_secret_1, recv_value_1);
2021 // flush the htlcs in the holding cell
2022 assert_eq!(commitment_update_2.update_add_htlcs.len(), 2);
2023 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &commitment_update_2.update_add_htlcs[0]);
2024 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &commitment_update_2.update_add_htlcs[1]);
2025 commitment_signed_dance!(nodes[1], nodes[0], &commitment_update_2.commitment_signed, false);
2026 expect_pending_htlcs_forwardable!(nodes[1]);
2028 let ref payment_event_3 = expect_forward!(nodes[1]);
2029 assert_eq!(payment_event_3.msgs.len(), 2);
2030 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_3.msgs[0]);
2031 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_3.msgs[1]);
2033 commitment_signed_dance!(nodes[2], nodes[1], &payment_event_3.commitment_msg, false);
2034 expect_pending_htlcs_forwardable!(nodes[2]);
2036 let events = nodes[2].node.get_and_clear_pending_events();
2037 assert_eq!(events.len(), 2);
2039 Event::PaymentClaimable { ref payment_hash, ref purpose, amount_msat, receiver_node_id, via_channel_id, .. } => {
2040 assert_eq!(our_payment_hash_21, *payment_hash);
2041 assert_eq!(recv_value_21, amount_msat);
2042 assert_eq!(nodes[2].node.get_our_node_id(), receiver_node_id.unwrap());
2043 assert_eq!(via_channel_id, Some(chan_2.2));
2045 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
2046 assert!(payment_preimage.is_none());
2047 assert_eq!(our_payment_secret_21, *payment_secret);
2049 _ => panic!("expected PaymentPurpose::InvoicePayment")
2052 _ => panic!("Unexpected event"),
2055 Event::PaymentClaimable { ref payment_hash, ref purpose, amount_msat, receiver_node_id, via_channel_id, .. } => {
2056 assert_eq!(our_payment_hash_22, *payment_hash);
2057 assert_eq!(recv_value_22, amount_msat);
2058 assert_eq!(nodes[2].node.get_our_node_id(), receiver_node_id.unwrap());
2059 assert_eq!(via_channel_id, Some(chan_2.2));
2061 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
2062 assert!(payment_preimage.is_none());
2063 assert_eq!(our_payment_secret_22, *payment_secret);
2065 _ => panic!("expected PaymentPurpose::InvoicePayment")
2068 _ => panic!("Unexpected event"),
2071 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_1);
2072 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_21);
2073 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_22);
2075 let commit_tx_fee_0_htlcs = 2*commit_tx_fee_msat(feerate, 1, &channel_type_features);
2076 let recv_value_3 = commit_tx_fee_2_htlcs - commit_tx_fee_0_htlcs - total_fee_msat;
2077 send_payment(&nodes[0], &vec![&nodes[1], &nodes[2]][..], recv_value_3);
2079 let commit_tx_fee_1_htlc = 2*commit_tx_fee_msat(feerate, 1 + 1, &channel_type_features);
2080 let expected_value_to_self = stat01.value_to_self_msat - (recv_value_1 + total_fee_msat) - (recv_value_21 + total_fee_msat) - (recv_value_22 + total_fee_msat) - (recv_value_3 + total_fee_msat);
2081 let stat0 = get_channel_value_stat!(nodes[0], nodes[1], chan_1.2);
2082 assert_eq!(stat0.value_to_self_msat, expected_value_to_self);
2083 assert_eq!(stat0.value_to_self_msat, stat0.channel_reserve_msat + commit_tx_fee_1_htlc);
2085 let stat2 = get_channel_value_stat!(nodes[2], nodes[1], chan_2.2);
2086 assert_eq!(stat2.value_to_self_msat, stat22.value_to_self_msat + recv_value_1 + recv_value_21 + recv_value_22 + recv_value_3);
2090 fn channel_reserve_in_flight_removes() {
2091 // In cases where one side claims an HTLC, it thinks it has additional available funds that it
2092 // can send to its counterparty, but due to update ordering, the other side may not yet have
2093 // considered those HTLCs fully removed.
2094 // This tests that we don't count HTLCs which will not be included in the next remote
2095 // commitment transaction towards the reserve value (as it implies no commitment transaction
2096 // will be generated which violates the remote reserve value).
2097 // This was broken previously, and discovered by the chanmon_fail_consistency fuzz test.
2099 // * route two HTLCs from A to B (note that, at a high level, this test is checking that, when
2100 // you consider the values of both of these HTLCs, B may not send an HTLC back to A, but if
2101 // you only consider the value of the first HTLC, it may not),
2102 // * start routing a third HTLC from A to B,
2103 // * claim the first two HTLCs (though B will generate an update_fulfill for one, and put
2104 // the other claim in its holding cell, as it immediately goes into AwaitingRAA),
2105 // * deliver the first fulfill from B
2106 // * deliver the update_add and an RAA from A, resulting in B freeing the second holding cell
2108 // * deliver A's response CS and RAA.
2109 // This results in A having the second HTLC in AwaitingRemovedRemoteRevoke, but B having
2110 // removed it fully. B now has the push_msat plus the first two HTLCs in value.
2111 // * Now B happily sends another HTLC, potentially violating its reserve value from A's point
2112 // of view (if A counts the AwaitingRemovedRemoteRevoke HTLC).
2113 let chanmon_cfgs = create_chanmon_cfgs(2);
2114 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2115 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2116 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2117 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
2119 let b_chan_values = get_channel_value_stat!(nodes[1], nodes[0], chan_1.2);
2120 // Route the first two HTLCs.
2121 let payment_value_1 = b_chan_values.channel_reserve_msat - b_chan_values.value_to_self_msat - 10000;
2122 let (payment_preimage_1, payment_hash_1, ..) = route_payment(&nodes[0], &[&nodes[1]], payment_value_1);
2123 let (payment_preimage_2, payment_hash_2, ..) = route_payment(&nodes[0], &[&nodes[1]], 20_000);
2125 // Start routing the third HTLC (this is just used to get everyone in the right state).
2126 let (route, payment_hash_3, payment_preimage_3, payment_secret_3) = get_route_and_payment_hash!(nodes[0], nodes[1], 100000);
2128 nodes[0].node.send_payment_with_route(&route, payment_hash_3,
2129 RecipientOnionFields::secret_only(payment_secret_3), PaymentId(payment_hash_3.0)).unwrap();
2130 check_added_monitors!(nodes[0], 1);
2131 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
2132 assert_eq!(events.len(), 1);
2133 SendEvent::from_event(events.remove(0))
2136 // Now claim both of the first two HTLCs on B's end, putting B in AwaitingRAA and generating an
2137 // initial fulfill/CS.
2138 nodes[1].node.claim_funds(payment_preimage_1);
2139 expect_payment_claimed!(nodes[1], payment_hash_1, payment_value_1);
2140 check_added_monitors!(nodes[1], 1);
2141 let bs_removes = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2143 // This claim goes in B's holding cell, allowing us to have a pending B->A RAA which does not
2144 // remove the second HTLC when we send the HTLC back from B to A.
2145 nodes[1].node.claim_funds(payment_preimage_2);
2146 expect_payment_claimed!(nodes[1], payment_hash_2, 20_000);
2147 check_added_monitors!(nodes[1], 1);
2148 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2150 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_removes.update_fulfill_htlcs[0]);
2151 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_removes.commitment_signed);
2152 check_added_monitors!(nodes[0], 1);
2153 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2154 expect_payment_sent(&nodes[0], payment_preimage_1, None, false, false);
2156 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_1.msgs[0]);
2157 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &send_1.commitment_msg);
2158 check_added_monitors!(nodes[1], 1);
2159 // B is already AwaitingRAA, so cant generate a CS here
2160 let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2162 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
2163 check_added_monitors!(nodes[1], 1);
2164 let bs_cs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2166 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2167 check_added_monitors!(nodes[0], 1);
2168 let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2170 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
2171 check_added_monitors!(nodes[1], 1);
2172 let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2174 // The second HTLCis removed, but as A is in AwaitingRAA it can't generate a CS here, so the
2175 // RAA that B generated above doesn't fully resolve the second HTLC from A's point of view.
2176 // However, the RAA A generates here *does* fully resolve the HTLC from B's point of view (as A
2177 // can no longer broadcast a commitment transaction with it and B has the preimage so can go
2178 // on-chain as necessary).
2179 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_cs.update_fulfill_htlcs[0]);
2180 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_cs.commitment_signed);
2181 check_added_monitors!(nodes[0], 1);
2182 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2183 expect_payment_sent(&nodes[0], payment_preimage_2, None, false, false);
2185 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
2186 check_added_monitors!(nodes[1], 1);
2187 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2189 expect_pending_htlcs_forwardable!(nodes[1]);
2190 expect_payment_claimable!(nodes[1], payment_hash_3, payment_secret_3, 100000);
2192 // Note that as this RAA was generated before the delivery of the update_fulfill it shouldn't
2193 // resolve the second HTLC from A's point of view.
2194 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2195 check_added_monitors!(nodes[0], 1);
2196 expect_payment_path_successful!(nodes[0]);
2197 let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2199 // Now that B doesn't have the second RAA anymore, but A still does, send a payment from B back
2200 // to A to ensure that A doesn't count the almost-removed HTLC in update_add processing.
2201 let (route, payment_hash_4, payment_preimage_4, payment_secret_4) = get_route_and_payment_hash!(nodes[1], nodes[0], 10000);
2203 nodes[1].node.send_payment_with_route(&route, payment_hash_4,
2204 RecipientOnionFields::secret_only(payment_secret_4), PaymentId(payment_hash_4.0)).unwrap();
2205 check_added_monitors!(nodes[1], 1);
2206 let mut events = nodes[1].node.get_and_clear_pending_msg_events();
2207 assert_eq!(events.len(), 1);
2208 SendEvent::from_event(events.remove(0))
2211 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &send_2.msgs[0]);
2212 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &send_2.commitment_msg);
2213 check_added_monitors!(nodes[0], 1);
2214 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2216 // Now just resolve all the outstanding messages/HTLCs for completeness...
2218 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
2219 check_added_monitors!(nodes[1], 1);
2220 let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2222 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
2223 check_added_monitors!(nodes[1], 1);
2225 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2226 check_added_monitors!(nodes[0], 1);
2227 expect_payment_path_successful!(nodes[0]);
2228 let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2230 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
2231 check_added_monitors!(nodes[1], 1);
2232 let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2234 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2235 check_added_monitors!(nodes[0], 1);
2237 expect_pending_htlcs_forwardable!(nodes[0]);
2238 expect_payment_claimable!(nodes[0], payment_hash_4, payment_secret_4, 10000);
2240 claim_payment(&nodes[1], &[&nodes[0]], payment_preimage_4);
2241 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_3);
2245 fn channel_monitor_network_test() {
2246 // Simple test which builds a network of ChannelManagers, connects them to each other, and
2247 // tests that ChannelMonitor is able to recover from various states.
2248 let chanmon_cfgs = create_chanmon_cfgs(5);
2249 let node_cfgs = create_node_cfgs(5, &chanmon_cfgs);
2250 let node_chanmgrs = create_node_chanmgrs(5, &node_cfgs, &[None, None, None, None, None]);
2251 let nodes = create_network(5, &node_cfgs, &node_chanmgrs);
2253 // Create some initial channels
2254 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
2255 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
2256 let chan_3 = create_announced_chan_between_nodes(&nodes, 2, 3);
2257 let chan_4 = create_announced_chan_between_nodes(&nodes, 3, 4);
2259 // Make sure all nodes are at the same starting height
2260 connect_blocks(&nodes[0], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[0].best_block_info().1);
2261 connect_blocks(&nodes[1], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[1].best_block_info().1);
2262 connect_blocks(&nodes[2], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[2].best_block_info().1);
2263 connect_blocks(&nodes[3], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[3].best_block_info().1);
2264 connect_blocks(&nodes[4], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[4].best_block_info().1);
2266 // Rebalance the network a bit by relaying one payment through all the channels...
2267 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
2268 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
2269 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
2270 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
2272 // Simple case with no pending HTLCs:
2273 nodes[1].node.force_close_broadcasting_latest_txn(&chan_1.2, &nodes[0].node.get_our_node_id()).unwrap();
2274 check_added_monitors!(nodes[1], 1);
2275 check_closed_broadcast!(nodes[1], true);
2276 check_closed_event!(nodes[1], 1, ClosureReason::HolderForceClosed, [nodes[0].node.get_our_node_id()], 100000);
2278 let mut node_txn = test_txn_broadcast(&nodes[1], &chan_1, None, HTLCType::NONE);
2279 assert_eq!(node_txn.len(), 1);
2280 mine_transaction(&nodes[1], &node_txn[0]);
2281 if nodes[1].connect_style.borrow().updates_best_block_first() {
2282 let _ = nodes[1].tx_broadcaster.txn_broadcast();
2285 mine_transaction(&nodes[0], &node_txn[0]);
2286 check_added_monitors!(nodes[0], 1);
2287 test_txn_broadcast(&nodes[0], &chan_1, Some(node_txn[0].clone()), HTLCType::NONE);
2289 check_closed_broadcast!(nodes[0], true);
2290 assert_eq!(nodes[0].node.list_channels().len(), 0);
2291 assert_eq!(nodes[1].node.list_channels().len(), 1);
2292 check_closed_event!(nodes[0], 1, ClosureReason::CommitmentTxConfirmed, [nodes[1].node.get_our_node_id()], 100000);
2294 // One pending HTLC is discarded by the force-close:
2295 let (payment_preimage_1, payment_hash_1, ..) = route_payment(&nodes[1], &[&nodes[2], &nodes[3]], 3_000_000);
2297 // Simple case of one pending HTLC to HTLC-Timeout (note that the HTLC-Timeout is not
2298 // broadcasted until we reach the timelock time).
2299 nodes[1].node.force_close_broadcasting_latest_txn(&chan_2.2, &nodes[2].node.get_our_node_id()).unwrap();
2300 check_closed_broadcast!(nodes[1], true);
2301 check_added_monitors!(nodes[1], 1);
2303 let mut node_txn = test_txn_broadcast(&nodes[1], &chan_2, None, HTLCType::NONE);
2304 connect_blocks(&nodes[1], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + MIN_CLTV_EXPIRY_DELTA as u32 + 1);
2305 test_txn_broadcast(&nodes[1], &chan_2, None, HTLCType::TIMEOUT);
2306 mine_transaction(&nodes[2], &node_txn[0]);
2307 check_added_monitors!(nodes[2], 1);
2308 test_txn_broadcast(&nodes[2], &chan_2, Some(node_txn[0].clone()), HTLCType::NONE);
2310 check_closed_broadcast!(nodes[2], true);
2311 assert_eq!(nodes[1].node.list_channels().len(), 0);
2312 assert_eq!(nodes[2].node.list_channels().len(), 1);
2313 check_closed_event!(nodes[1], 1, ClosureReason::HolderForceClosed, [nodes[2].node.get_our_node_id()], 100000);
2314 check_closed_event!(nodes[2], 1, ClosureReason::CommitmentTxConfirmed, [nodes[1].node.get_our_node_id()], 100000);
2316 macro_rules! claim_funds {
2317 ($node: expr, $prev_node: expr, $preimage: expr, $payment_hash: expr) => {
2319 $node.node.claim_funds($preimage);
2320 expect_payment_claimed!($node, $payment_hash, 3_000_000);
2321 check_added_monitors!($node, 1);
2323 let events = $node.node.get_and_clear_pending_msg_events();
2324 assert_eq!(events.len(), 1);
2326 MessageSendEvent::UpdateHTLCs { ref node_id, updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fail_htlcs, .. } } => {
2327 assert!(update_add_htlcs.is_empty());
2328 assert!(update_fail_htlcs.is_empty());
2329 assert_eq!(*node_id, $prev_node.node.get_our_node_id());
2331 _ => panic!("Unexpected event"),
2337 // nodes[3] gets the preimage, but nodes[2] already disconnected, resulting in a nodes[2]
2338 // HTLC-Timeout and a nodes[3] claim against it (+ its own announces)
2339 nodes[2].node.force_close_broadcasting_latest_txn(&chan_3.2, &nodes[3].node.get_our_node_id()).unwrap();
2340 check_added_monitors!(nodes[2], 1);
2341 check_closed_broadcast!(nodes[2], true);
2342 let node2_commitment_txid;
2344 let node_txn = test_txn_broadcast(&nodes[2], &chan_3, None, HTLCType::NONE);
2345 connect_blocks(&nodes[2], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + MIN_CLTV_EXPIRY_DELTA as u32 + 1);
2346 test_txn_broadcast(&nodes[2], &chan_3, None, HTLCType::TIMEOUT);
2347 node2_commitment_txid = node_txn[0].txid();
2349 // Claim the payment on nodes[3], giving it knowledge of the preimage
2350 claim_funds!(nodes[3], nodes[2], payment_preimage_1, payment_hash_1);
2351 mine_transaction(&nodes[3], &node_txn[0]);
2352 check_added_monitors!(nodes[3], 1);
2353 check_preimage_claim(&nodes[3], &node_txn);
2355 check_closed_broadcast!(nodes[3], true);
2356 assert_eq!(nodes[2].node.list_channels().len(), 0);
2357 assert_eq!(nodes[3].node.list_channels().len(), 1);
2358 check_closed_event!(nodes[2], 1, ClosureReason::HolderForceClosed, [nodes[3].node.get_our_node_id()], 100000);
2359 check_closed_event!(nodes[3], 1, ClosureReason::CommitmentTxConfirmed, [nodes[2].node.get_our_node_id()], 100000);
2361 // Drop the ChannelMonitor for the previous channel to avoid it broadcasting transactions and
2362 // confusing us in the following tests.
2363 let chan_3_mon = nodes[3].chain_monitor.chain_monitor.remove_monitor(&OutPoint { txid: chan_3.3.txid(), index: 0 });
2365 // One pending HTLC to time out:
2366 let (payment_preimage_2, payment_hash_2, ..) = route_payment(&nodes[3], &[&nodes[4]], 3_000_000);
2367 // CLTV expires at TEST_FINAL_CLTV + 1 (current height) + 1 (added in send_payment for
2370 let (close_chan_update_1, close_chan_update_2) = {
2371 connect_blocks(&nodes[3], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + 1);
2372 let events = nodes[3].node.get_and_clear_pending_msg_events();
2373 assert_eq!(events.len(), 2);
2374 let close_chan_update_1 = match events[0] {
2375 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
2378 _ => panic!("Unexpected event"),
2381 MessageSendEvent::HandleError { action: ErrorAction::DisconnectPeer { .. }, node_id } => {
2382 assert_eq!(node_id, nodes[4].node.get_our_node_id());
2384 _ => panic!("Unexpected event"),
2386 check_added_monitors!(nodes[3], 1);
2388 // Clear bumped claiming txn spending node 2 commitment tx. Bumped txn are generated after reaching some height timer.
2390 let mut node_txn = nodes[3].tx_broadcaster.txn_broadcasted.lock().unwrap();
2391 node_txn.retain(|tx| {
2392 if tx.input[0].previous_output.txid == node2_commitment_txid {
2398 let node_txn = test_txn_broadcast(&nodes[3], &chan_4, None, HTLCType::TIMEOUT);
2400 // Claim the payment on nodes[4], giving it knowledge of the preimage
2401 claim_funds!(nodes[4], nodes[3], payment_preimage_2, payment_hash_2);
2403 connect_blocks(&nodes[4], TEST_FINAL_CLTV - CLTV_CLAIM_BUFFER + 2);
2404 let events = nodes[4].node.get_and_clear_pending_msg_events();
2405 assert_eq!(events.len(), 2);
2406 let close_chan_update_2 = match events[0] {
2407 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
2410 _ => panic!("Unexpected event"),
2413 MessageSendEvent::HandleError { action: ErrorAction::DisconnectPeer { .. }, node_id } => {
2414 assert_eq!(node_id, nodes[3].node.get_our_node_id());
2416 _ => panic!("Unexpected event"),
2418 check_added_monitors!(nodes[4], 1);
2419 test_txn_broadcast(&nodes[4], &chan_4, None, HTLCType::SUCCESS);
2420 check_closed_event!(nodes[4], 1, ClosureReason::HolderForceClosed, [nodes[3].node.get_our_node_id()], 100000);
2422 mine_transaction(&nodes[4], &node_txn[0]);
2423 check_preimage_claim(&nodes[4], &node_txn);
2424 (close_chan_update_1, close_chan_update_2)
2426 nodes[3].gossip_sync.handle_channel_update(&close_chan_update_2).unwrap();
2427 nodes[4].gossip_sync.handle_channel_update(&close_chan_update_1).unwrap();
2428 assert_eq!(nodes[3].node.list_channels().len(), 0);
2429 assert_eq!(nodes[4].node.list_channels().len(), 0);
2431 assert_eq!(nodes[3].chain_monitor.chain_monitor.watch_channel(OutPoint { txid: chan_3.3.txid(), index: 0 }, chan_3_mon),
2432 Ok(ChannelMonitorUpdateStatus::Completed));
2433 check_closed_event!(nodes[3], 1, ClosureReason::HolderForceClosed, [nodes[4].node.get_our_node_id()], 100000);
2437 fn test_justice_tx_htlc_timeout() {
2438 // Test justice txn built on revoked HTLC-Timeout tx, against both sides
2439 let mut alice_config = UserConfig::default();
2440 alice_config.channel_handshake_config.announced_channel = true;
2441 alice_config.channel_handshake_limits.force_announced_channel_preference = false;
2442 alice_config.channel_handshake_config.our_to_self_delay = 6 * 24 * 5;
2443 let mut bob_config = UserConfig::default();
2444 bob_config.channel_handshake_config.announced_channel = true;
2445 bob_config.channel_handshake_limits.force_announced_channel_preference = false;
2446 bob_config.channel_handshake_config.our_to_self_delay = 6 * 24 * 3;
2447 let user_cfgs = [Some(alice_config), Some(bob_config)];
2448 let mut chanmon_cfgs = create_chanmon_cfgs(2);
2449 chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
2450 chanmon_cfgs[1].keys_manager.disable_revocation_policy_check = true;
2451 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2452 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &user_cfgs);
2453 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2454 // Create some new channels:
2455 let chan_5 = create_announced_chan_between_nodes(&nodes, 0, 1);
2457 // A pending HTLC which will be revoked:
2458 let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2459 // Get the will-be-revoked local txn from nodes[0]
2460 let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_5.2);
2461 assert_eq!(revoked_local_txn.len(), 2); // First commitment tx, then HTLC tx
2462 assert_eq!(revoked_local_txn[0].input.len(), 1);
2463 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_5.3.txid());
2464 assert_eq!(revoked_local_txn[0].output.len(), 2); // Only HTLC and output back to 0 are present
2465 assert_eq!(revoked_local_txn[1].input.len(), 1);
2466 assert_eq!(revoked_local_txn[1].input[0].previous_output.txid, revoked_local_txn[0].txid());
2467 assert_eq!(revoked_local_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC-Timeout
2468 // Revoke the old state
2469 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_3);
2472 mine_transaction(&nodes[1], &revoked_local_txn[0]);
2474 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2475 assert_eq!(node_txn.len(), 1); // ChannelMonitor: penalty tx
2476 assert_eq!(node_txn[0].input.len(), 2); // We should claim the revoked output and the HTLC output
2477 check_spends!(node_txn[0], revoked_local_txn[0]);
2478 node_txn.swap_remove(0);
2480 check_added_monitors!(nodes[1], 1);
2481 check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed, [nodes[0].node.get_our_node_id()], 100000);
2482 test_txn_broadcast(&nodes[1], &chan_5, Some(revoked_local_txn[0].clone()), HTLCType::NONE);
2484 mine_transaction(&nodes[0], &revoked_local_txn[0]);
2485 connect_blocks(&nodes[0], TEST_FINAL_CLTV); // Confirm blocks until the HTLC expires
2486 // Verify broadcast of revoked HTLC-timeout
2487 let node_txn = test_txn_broadcast(&nodes[0], &chan_5, Some(revoked_local_txn[0].clone()), HTLCType::TIMEOUT);
2488 check_added_monitors!(nodes[0], 1);
2489 check_closed_event!(nodes[0], 1, ClosureReason::CommitmentTxConfirmed, [nodes[1].node.get_our_node_id()], 100000);
2490 // Broadcast revoked HTLC-timeout on node 1
2491 mine_transaction(&nodes[1], &node_txn[1]);
2492 test_revoked_htlc_claim_txn_broadcast(&nodes[1], node_txn[1].clone(), revoked_local_txn[0].clone());
2494 get_announce_close_broadcast_events(&nodes, 0, 1);
2495 assert_eq!(nodes[0].node.list_channels().len(), 0);
2496 assert_eq!(nodes[1].node.list_channels().len(), 0);
2500 fn test_justice_tx_htlc_success() {
2501 // Test justice txn built on revoked HTLC-Success tx, against both sides
2502 let mut alice_config = UserConfig::default();
2503 alice_config.channel_handshake_config.announced_channel = true;
2504 alice_config.channel_handshake_limits.force_announced_channel_preference = false;
2505 alice_config.channel_handshake_config.our_to_self_delay = 6 * 24 * 5;
2506 let mut bob_config = UserConfig::default();
2507 bob_config.channel_handshake_config.announced_channel = true;
2508 bob_config.channel_handshake_limits.force_announced_channel_preference = false;
2509 bob_config.channel_handshake_config.our_to_self_delay = 6 * 24 * 3;
2510 let user_cfgs = [Some(alice_config), Some(bob_config)];
2511 let mut chanmon_cfgs = create_chanmon_cfgs(2);
2512 chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
2513 chanmon_cfgs[1].keys_manager.disable_revocation_policy_check = true;
2514 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2515 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &user_cfgs);
2516 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2517 // Create some new channels:
2518 let chan_6 = create_announced_chan_between_nodes(&nodes, 0, 1);
2520 // A pending HTLC which will be revoked:
2521 let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2522 // Get the will-be-revoked local txn from B
2523 let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan_6.2);
2524 assert_eq!(revoked_local_txn.len(), 1); // Only commitment tx
2525 assert_eq!(revoked_local_txn[0].input.len(), 1);
2526 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_6.3.txid());
2527 assert_eq!(revoked_local_txn[0].output.len(), 2); // Only HTLC and output back to A are present
2528 // Revoke the old state
2529 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_4);
2531 mine_transaction(&nodes[0], &revoked_local_txn[0]);
2533 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
2534 assert_eq!(node_txn.len(), 1); // ChannelMonitor: penalty tx
2535 assert_eq!(node_txn[0].input.len(), 1); // We claim the received HTLC output
2537 check_spends!(node_txn[0], revoked_local_txn[0]);
2538 node_txn.swap_remove(0);
2540 check_added_monitors!(nodes[0], 1);
2541 test_txn_broadcast(&nodes[0], &chan_6, Some(revoked_local_txn[0].clone()), HTLCType::NONE);
2543 mine_transaction(&nodes[1], &revoked_local_txn[0]);
2544 check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed, [nodes[0].node.get_our_node_id()], 100000);
2545 let node_txn = test_txn_broadcast(&nodes[1], &chan_6, Some(revoked_local_txn[0].clone()), HTLCType::SUCCESS);
2546 check_added_monitors!(nodes[1], 1);
2547 mine_transaction(&nodes[0], &node_txn[1]);
2548 check_closed_event!(nodes[0], 1, ClosureReason::CommitmentTxConfirmed, [nodes[1].node.get_our_node_id()], 100000);
2549 test_revoked_htlc_claim_txn_broadcast(&nodes[0], node_txn[1].clone(), revoked_local_txn[0].clone());
2551 get_announce_close_broadcast_events(&nodes, 0, 1);
2552 assert_eq!(nodes[0].node.list_channels().len(), 0);
2553 assert_eq!(nodes[1].node.list_channels().len(), 0);
2557 fn revoked_output_claim() {
2558 // Simple test to ensure a node will claim a revoked output when a stale remote commitment
2559 // transaction is broadcast by its counterparty
2560 let chanmon_cfgs = create_chanmon_cfgs(2);
2561 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2562 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2563 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2564 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
2565 // node[0] is gonna to revoke an old state thus node[1] should be able to claim the revoked output
2566 let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2567 assert_eq!(revoked_local_txn.len(), 1);
2568 // Only output is the full channel value back to nodes[0]:
2569 assert_eq!(revoked_local_txn[0].output.len(), 1);
2570 // Send a payment through, updating everyone's latest commitment txn
2571 send_payment(&nodes[0], &vec!(&nodes[1])[..], 5000000);
2573 // Inform nodes[1] that nodes[0] broadcast a stale tx
2574 mine_transaction(&nodes[1], &revoked_local_txn[0]);
2575 check_added_monitors!(nodes[1], 1);
2576 check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed, [nodes[0].node.get_our_node_id()], 100000);
2577 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
2578 assert_eq!(node_txn.len(), 1); // ChannelMonitor: justice tx against revoked to_local output
2580 check_spends!(node_txn[0], revoked_local_txn[0]);
2582 // Inform nodes[0] that a watchtower cheated on its behalf, so it will force-close the chan
2583 mine_transaction(&nodes[0], &revoked_local_txn[0]);
2584 get_announce_close_broadcast_events(&nodes, 0, 1);
2585 check_added_monitors!(nodes[0], 1);
2586 check_closed_event!(nodes[0], 1, ClosureReason::CommitmentTxConfirmed, [nodes[1].node.get_our_node_id()], 100000);
2590 fn test_forming_justice_tx_from_monitor_updates() {
2591 do_test_forming_justice_tx_from_monitor_updates(true);
2592 do_test_forming_justice_tx_from_monitor_updates(false);
2595 fn do_test_forming_justice_tx_from_monitor_updates(broadcast_initial_commitment: bool) {
2596 // Simple test to make sure that the justice tx formed in WatchtowerPersister
2597 // is properly formed and can be broadcasted/confirmed successfully in the event
2598 // that a revoked commitment transaction is broadcasted
2599 // (Similar to `revoked_output_claim` test but we get the justice tx + broadcast manually)
2600 let chanmon_cfgs = create_chanmon_cfgs(2);
2601 let destination_script0 = chanmon_cfgs[0].keys_manager.get_destination_script([0; 32]).unwrap();
2602 let destination_script1 = chanmon_cfgs[1].keys_manager.get_destination_script([0; 32]).unwrap();
2603 let persisters = vec![WatchtowerPersister::new(destination_script0),
2604 WatchtowerPersister::new(destination_script1)];
2605 let node_cfgs = create_node_cfgs_with_persisters(2, &chanmon_cfgs, persisters.iter().collect());
2606 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2607 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2608 let (_, _, channel_id, funding_tx) = create_announced_chan_between_nodes(&nodes, 0, 1);
2609 let funding_txo = OutPoint { txid: funding_tx.txid(), index: 0 };
2611 if !broadcast_initial_commitment {
2612 // Send a payment to move the channel forward
2613 send_payment(&nodes[0], &vec!(&nodes[1])[..], 5_000_000);
2616 // node[0] is gonna to revoke an old state thus node[1] should be able to claim the revoked output.
2617 // We'll keep this commitment transaction to broadcast once it's revoked.
2618 let revoked_local_txn = get_local_commitment_txn!(nodes[0], channel_id);
2619 assert_eq!(revoked_local_txn.len(), 1);
2620 let revoked_commitment_tx = &revoked_local_txn[0];
2622 // Send another payment, now revoking the previous commitment tx
2623 send_payment(&nodes[0], &vec!(&nodes[1])[..], 5_000_000);
2625 let justice_tx = persisters[1].justice_tx(funding_txo, &revoked_commitment_tx.txid()).unwrap();
2626 check_spends!(justice_tx, revoked_commitment_tx);
2628 mine_transactions(&nodes[1], &[revoked_commitment_tx, &justice_tx]);
2629 mine_transactions(&nodes[0], &[revoked_commitment_tx, &justice_tx]);
2631 check_added_monitors!(nodes[1], 1);
2632 check_closed_event(&nodes[1], 1, ClosureReason::CommitmentTxConfirmed, false,
2633 &[nodes[0].node.get_our_node_id()], 100_000);
2634 get_announce_close_broadcast_events(&nodes, 1, 0);
2636 check_added_monitors!(nodes[0], 1);
2637 check_closed_event(&nodes[0], 1, ClosureReason::CommitmentTxConfirmed, false,
2638 &[nodes[1].node.get_our_node_id()], 100_000);
2640 // Check that the justice tx has sent the revoked output value to nodes[1]
2641 let monitor = get_monitor!(nodes[1], channel_id);
2642 let total_claimable_balance = monitor.get_claimable_balances().iter().fold(0, |sum, balance| {
2644 channelmonitor::Balance::ClaimableAwaitingConfirmations { amount_satoshis, .. } => sum + amount_satoshis,
2645 _ => panic!("Unexpected balance type"),
2648 // On the first commitment, node[1]'s balance was below dust so it didn't have an output
2649 let node1_channel_balance = if broadcast_initial_commitment { 0 } else { revoked_commitment_tx.output[0].value };
2650 let expected_claimable_balance = node1_channel_balance + justice_tx.output[0].value;
2651 assert_eq!(total_claimable_balance, expected_claimable_balance);
2656 fn claim_htlc_outputs_shared_tx() {
2657 // Node revoked old state, htlcs haven't time out yet, claim them in shared justice tx
2658 let mut chanmon_cfgs = create_chanmon_cfgs(2);
2659 chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
2660 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2661 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2662 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2664 // Create some new channel:
2665 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
2667 // Rebalance the network to generate htlc in the two directions
2668 send_payment(&nodes[0], &[&nodes[1]], 8_000_000);
2669 // node[0] is gonna to revoke an old state thus node[1] should be able to claim both offered/received HTLC outputs on top of commitment tx
2670 let payment_preimage_1 = route_payment(&nodes[0], &[&nodes[1]], 3_000_000).0;
2671 let (_payment_preimage_2, payment_hash_2, ..) = route_payment(&nodes[1], &[&nodes[0]], 3_000_000);
2673 // Get the will-be-revoked local txn from node[0]
2674 let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2675 assert_eq!(revoked_local_txn.len(), 2); // commitment tx + 1 HTLC-Timeout tx
2676 assert_eq!(revoked_local_txn[0].input.len(), 1);
2677 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
2678 assert_eq!(revoked_local_txn[1].input.len(), 1);
2679 assert_eq!(revoked_local_txn[1].input[0].previous_output.txid, revoked_local_txn[0].txid());
2680 assert_eq!(revoked_local_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC-Timeout
2681 check_spends!(revoked_local_txn[1], revoked_local_txn[0]);
2683 //Revoke the old state
2684 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_1);
2687 mine_transaction(&nodes[0], &revoked_local_txn[0]);
2688 check_added_monitors!(nodes[0], 1);
2689 check_closed_event!(nodes[0], 1, ClosureReason::CommitmentTxConfirmed, [nodes[1].node.get_our_node_id()], 100000);
2690 mine_transaction(&nodes[1], &revoked_local_txn[0]);
2691 check_added_monitors!(nodes[1], 1);
2692 check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed, [nodes[0].node.get_our_node_id()], 100000);
2693 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
2694 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
2696 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
2697 assert_eq!(node_txn.len(), 1); // ChannelMonitor: penalty tx
2699 assert_eq!(node_txn[0].input.len(), 3); // Claim the revoked output + both revoked HTLC outputs
2700 check_spends!(node_txn[0], revoked_local_txn[0]);
2702 let mut witness_lens = BTreeSet::new();
2703 witness_lens.insert(node_txn[0].input[0].witness.last().unwrap().len());
2704 witness_lens.insert(node_txn[0].input[1].witness.last().unwrap().len());
2705 witness_lens.insert(node_txn[0].input[2].witness.last().unwrap().len());
2706 assert_eq!(witness_lens.len(), 3);
2707 assert_eq!(*witness_lens.iter().skip(0).next().unwrap(), 77); // revoked to_local
2708 assert_eq!(*witness_lens.iter().skip(1).next().unwrap(), OFFERED_HTLC_SCRIPT_WEIGHT); // revoked offered HTLC
2709 assert_eq!(*witness_lens.iter().skip(2).next().unwrap(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // revoked received HTLC
2711 // Finally, mine the penalty transaction and check that we get an HTLC failure after
2712 // ANTI_REORG_DELAY confirmations.
2713 mine_transaction(&nodes[1], &node_txn[0]);
2714 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
2715 expect_payment_failed!(nodes[1], payment_hash_2, false);
2717 get_announce_close_broadcast_events(&nodes, 0, 1);
2718 assert_eq!(nodes[0].node.list_channels().len(), 0);
2719 assert_eq!(nodes[1].node.list_channels().len(), 0);
2723 fn claim_htlc_outputs_single_tx() {
2724 // Node revoked old state, htlcs have timed out, claim each of them in separated justice tx
2725 let mut chanmon_cfgs = create_chanmon_cfgs(2);
2726 chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
2727 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2728 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2729 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2731 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
2733 // Rebalance the network to generate htlc in the two directions
2734 send_payment(&nodes[0], &[&nodes[1]], 8_000_000);
2735 // node[0] is gonna to revoke an old state thus node[1] should be able to claim both offered/received HTLC outputs on top of commitment tx, but this
2736 // time as two different claim transactions as we're gonna to timeout htlc with given a high current height
2737 let payment_preimage_1 = route_payment(&nodes[0], &[&nodes[1]], 3_000_000).0;
2738 let (_payment_preimage_2, payment_hash_2, ..) = route_payment(&nodes[1], &[&nodes[0]], 3_000_000);
2740 // Get the will-be-revoked local txn from node[0]
2741 let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2743 //Revoke the old state
2744 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_1);
2747 confirm_transaction_at(&nodes[0], &revoked_local_txn[0], 100);
2748 check_added_monitors!(nodes[0], 1);
2749 confirm_transaction_at(&nodes[1], &revoked_local_txn[0], 100);
2750 check_added_monitors!(nodes[1], 1);
2751 check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed, [nodes[0].node.get_our_node_id()], 100000);
2752 let mut events = nodes[0].node.get_and_clear_pending_events();
2753 expect_pending_htlcs_forwardable_from_events!(nodes[0], events[0..1], true);
2754 match events.last().unwrap() {
2755 Event::ChannelClosed { reason: ClosureReason::CommitmentTxConfirmed, .. } => {}
2756 _ => panic!("Unexpected event"),
2759 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
2760 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
2762 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcast();
2764 // Check the pair local commitment and HTLC-timeout broadcast due to HTLC expiration
2765 assert_eq!(node_txn[0].input.len(), 1);
2766 check_spends!(node_txn[0], chan_1.3);
2767 assert_eq!(node_txn[1].input.len(), 1);
2768 let witness_script = node_txn[1].input[0].witness.last().unwrap();
2769 assert_eq!(witness_script.len(), OFFERED_HTLC_SCRIPT_WEIGHT); //Spending an offered htlc output
2770 check_spends!(node_txn[1], node_txn[0]);
2772 // Filter out any non justice transactions.
2773 node_txn.retain(|tx| tx.input[0].previous_output.txid == revoked_local_txn[0].txid());
2774 assert!(node_txn.len() > 3);
2776 assert_eq!(node_txn[0].input.len(), 1);
2777 assert_eq!(node_txn[1].input.len(), 1);
2778 assert_eq!(node_txn[2].input.len(), 1);
2780 check_spends!(node_txn[0], revoked_local_txn[0]);
2781 check_spends!(node_txn[1], revoked_local_txn[0]);
2782 check_spends!(node_txn[2], revoked_local_txn[0]);
2784 let mut witness_lens = BTreeSet::new();
2785 witness_lens.insert(node_txn[0].input[0].witness.last().unwrap().len());
2786 witness_lens.insert(node_txn[1].input[0].witness.last().unwrap().len());
2787 witness_lens.insert(node_txn[2].input[0].witness.last().unwrap().len());
2788 assert_eq!(witness_lens.len(), 3);
2789 assert_eq!(*witness_lens.iter().skip(0).next().unwrap(), 77); // revoked to_local
2790 assert_eq!(*witness_lens.iter().skip(1).next().unwrap(), OFFERED_HTLC_SCRIPT_WEIGHT); // revoked offered HTLC
2791 assert_eq!(*witness_lens.iter().skip(2).next().unwrap(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // revoked received HTLC
2793 // Finally, mine the penalty transactions and check that we get an HTLC failure after
2794 // ANTI_REORG_DELAY confirmations.
2795 mine_transaction(&nodes[1], &node_txn[0]);
2796 mine_transaction(&nodes[1], &node_txn[1]);
2797 mine_transaction(&nodes[1], &node_txn[2]);
2798 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
2799 expect_payment_failed!(nodes[1], payment_hash_2, false);
2801 get_announce_close_broadcast_events(&nodes, 0, 1);
2802 assert_eq!(nodes[0].node.list_channels().len(), 0);
2803 assert_eq!(nodes[1].node.list_channels().len(), 0);
2807 fn test_htlc_on_chain_success() {
2808 // Test that in case of a unilateral close onchain, we detect the state of output and pass
2809 // the preimage backward accordingly. So here we test that ChannelManager is
2810 // broadcasting the right event to other nodes in payment path.
2811 // We test with two HTLCs simultaneously as that was not handled correctly in the past.
2812 // A --------------------> B ----------------------> C (preimage)
2813 // First, C should claim the HTLC outputs via HTLC-Success when its own latest local
2814 // commitment transaction was broadcast.
2815 // Then, B should learn the preimage from said transactions, attempting to claim backwards
2817 // B should be able to claim via preimage if A then broadcasts its local tx.
2818 // Finally, when A sees B's latest local commitment transaction it should be able to claim
2819 // the HTLC outputs via the preimage it learned (which, once confirmed should generate a
2820 // PaymentSent event).
2822 let chanmon_cfgs = create_chanmon_cfgs(3);
2823 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2824 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2825 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2827 // Create some initial channels
2828 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
2829 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
2831 // Ensure all nodes are at the same height
2832 let node_max_height = nodes.iter().map(|node| node.blocks.lock().unwrap().len()).max().unwrap() as u32;
2833 connect_blocks(&nodes[0], node_max_height - nodes[0].best_block_info().1);
2834 connect_blocks(&nodes[1], node_max_height - nodes[1].best_block_info().1);
2835 connect_blocks(&nodes[2], node_max_height - nodes[2].best_block_info().1);
2837 // Rebalance the network a bit by relaying one payment through all the channels...
2838 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
2839 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
2841 let (our_payment_preimage, payment_hash_1, ..) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3_000_000);
2842 let (our_payment_preimage_2, payment_hash_2, ..) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3_000_000);
2844 // Broadcast legit commitment tx from C on B's chain
2845 // Broadcast HTLC Success transaction by C on received output from C's commitment tx on B's chain
2846 let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
2847 assert_eq!(commitment_tx.len(), 1);
2848 check_spends!(commitment_tx[0], chan_2.3);
2849 nodes[2].node.claim_funds(our_payment_preimage);
2850 expect_payment_claimed!(nodes[2], payment_hash_1, 3_000_000);
2851 nodes[2].node.claim_funds(our_payment_preimage_2);
2852 expect_payment_claimed!(nodes[2], payment_hash_2, 3_000_000);
2853 check_added_monitors!(nodes[2], 2);
2854 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2855 assert!(updates.update_add_htlcs.is_empty());
2856 assert!(updates.update_fail_htlcs.is_empty());
2857 assert!(updates.update_fail_malformed_htlcs.is_empty());
2858 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
2860 mine_transaction(&nodes[2], &commitment_tx[0]);
2861 check_closed_broadcast!(nodes[2], true);
2862 check_added_monitors!(nodes[2], 1);
2863 check_closed_event!(nodes[2], 1, ClosureReason::CommitmentTxConfirmed, [nodes[1].node.get_our_node_id()], 100000);
2864 let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelMonitor: 2 (2 * HTLC-Success tx)
2865 assert_eq!(node_txn.len(), 2);
2866 check_spends!(node_txn[0], commitment_tx[0]);
2867 check_spends!(node_txn[1], commitment_tx[0]);
2868 assert_eq!(node_txn[0].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2869 assert_eq!(node_txn[1].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2870 assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2871 assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2872 assert_eq!(node_txn[0].lock_time, LockTime::ZERO);
2873 assert_eq!(node_txn[1].lock_time, LockTime::ZERO);
2875 // Verify that B's ChannelManager is able to extract preimage from HTLC Success tx and pass it backward
2876 connect_block(&nodes[1], &create_dummy_block(nodes[1].best_block_hash(), 42, vec![commitment_tx[0].clone(), node_txn[0].clone(), node_txn[1].clone()]));
2877 connect_blocks(&nodes[1], TEST_FINAL_CLTV); // Confirm blocks until the HTLC expires
2879 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
2880 assert_eq!(added_monitors.len(), 1);
2881 assert_eq!(added_monitors[0].0.txid, chan_2.3.txid());
2882 added_monitors.clear();
2884 let forwarded_events = nodes[1].node.get_and_clear_pending_events();
2885 assert_eq!(forwarded_events.len(), 3);
2886 match forwarded_events[0] {
2887 Event::ChannelClosed { reason: ClosureReason::CommitmentTxConfirmed, .. } => {}
2888 _ => panic!("Unexpected event"),
2890 let chan_id = Some(chan_1.2);
2891 match forwarded_events[1] {
2892 Event::PaymentForwarded { fee_earned_msat, prev_channel_id, claim_from_onchain_tx, next_channel_id, outbound_amount_forwarded_msat } => {
2893 assert_eq!(fee_earned_msat, Some(1000));
2894 assert_eq!(prev_channel_id, chan_id);
2895 assert_eq!(claim_from_onchain_tx, true);
2896 assert_eq!(next_channel_id, Some(chan_2.2));
2897 assert_eq!(outbound_amount_forwarded_msat, Some(3000000));
2901 match forwarded_events[2] {
2902 Event::PaymentForwarded { fee_earned_msat, prev_channel_id, claim_from_onchain_tx, next_channel_id, outbound_amount_forwarded_msat } => {
2903 assert_eq!(fee_earned_msat, Some(1000));
2904 assert_eq!(prev_channel_id, chan_id);
2905 assert_eq!(claim_from_onchain_tx, true);
2906 assert_eq!(next_channel_id, Some(chan_2.2));
2907 assert_eq!(outbound_amount_forwarded_msat, Some(3000000));
2911 let mut events = nodes[1].node.get_and_clear_pending_msg_events();
2913 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
2914 assert_eq!(added_monitors.len(), 2);
2915 assert_eq!(added_monitors[0].0.txid, chan_1.3.txid());
2916 assert_eq!(added_monitors[1].0.txid, chan_1.3.txid());
2917 added_monitors.clear();
2919 assert_eq!(events.len(), 3);
2921 let nodes_2_event = remove_first_msg_event_to_node(&nodes[2].node.get_our_node_id(), &mut events);
2922 let nodes_0_event = remove_first_msg_event_to_node(&nodes[0].node.get_our_node_id(), &mut events);
2924 match nodes_2_event {
2925 MessageSendEvent::HandleError { action: ErrorAction::DisconnectPeer { .. }, node_id: _ } => {},
2926 _ => panic!("Unexpected event"),
2929 match nodes_0_event {
2930 MessageSendEvent::UpdateHTLCs { ref node_id, updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fail_htlcs, ref update_fulfill_htlcs, ref update_fail_malformed_htlcs, .. } } => {
2931 assert!(update_add_htlcs.is_empty());
2932 assert!(update_fail_htlcs.is_empty());
2933 assert_eq!(update_fulfill_htlcs.len(), 1);
2934 assert!(update_fail_malformed_htlcs.is_empty());
2935 assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
2937 _ => panic!("Unexpected event"),
2940 // Ensure that the last remaining message event is the BroadcastChannelUpdate msg for chan_2
2942 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
2943 _ => panic!("Unexpected event"),
2946 macro_rules! check_tx_local_broadcast {
2947 ($node: expr, $htlc_offered: expr, $commitment_tx: expr) => { {
2948 let mut node_txn = $node.tx_broadcaster.txn_broadcasted.lock().unwrap();
2949 assert_eq!(node_txn.len(), 2);
2950 // Node[1]: 2 * HTLC-timeout tx
2951 // Node[0]: 2 * HTLC-timeout tx
2952 check_spends!(node_txn[0], $commitment_tx);
2953 check_spends!(node_txn[1], $commitment_tx);
2954 assert_ne!(node_txn[0].lock_time, LockTime::ZERO);
2955 assert_ne!(node_txn[1].lock_time, LockTime::ZERO);
2957 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2958 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2959 assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2960 assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2962 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2963 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2964 assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2965 assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2970 // nodes[1] now broadcasts its own timeout-claim of the output that nodes[2] just claimed via success.
2971 check_tx_local_broadcast!(nodes[1], false, commitment_tx[0]);
2973 // Broadcast legit commitment tx from A on B's chain
2974 // Broadcast preimage tx by B on offered output from A commitment tx on A's chain
2975 let node_a_commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
2976 check_spends!(node_a_commitment_tx[0], chan_1.3);
2977 mine_transaction(&nodes[1], &node_a_commitment_tx[0]);
2978 check_closed_broadcast!(nodes[1], true);
2979 check_added_monitors!(nodes[1], 1);
2980 check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed, [nodes[0].node.get_our_node_id()], 100000);
2981 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
2982 assert!(node_txn.len() == 1 || node_txn.len() == 3); // HTLC-Success, 2* RBF bumps of above HTLC txn
2983 let commitment_spend =
2984 if node_txn.len() == 1 {
2987 // Certain `ConnectStyle`s will cause RBF bumps of the previous HTLC transaction to be broadcast.
2988 // FullBlockViaListen
2989 if node_txn[0].input[0].previous_output.txid == node_a_commitment_tx[0].txid() {
2990 check_spends!(node_txn[1], commitment_tx[0]);
2991 check_spends!(node_txn[2], commitment_tx[0]);
2992 assert_ne!(node_txn[1].input[0].previous_output.vout, node_txn[2].input[0].previous_output.vout);
2995 check_spends!(node_txn[0], commitment_tx[0]);
2996 check_spends!(node_txn[1], commitment_tx[0]);
2997 assert_ne!(node_txn[0].input[0].previous_output.vout, node_txn[1].input[0].previous_output.vout);
3002 check_spends!(commitment_spend, node_a_commitment_tx[0]);
3003 assert_eq!(commitment_spend.input.len(), 2);
3004 assert_eq!(commitment_spend.input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
3005 assert_eq!(commitment_spend.input[1].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
3006 assert_eq!(commitment_spend.lock_time.to_consensus_u32(), nodes[1].best_block_info().1);
3007 assert!(commitment_spend.output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
3008 // We don't bother to check that B can claim the HTLC output on its commitment tx here as
3009 // we already checked the same situation with A.
3011 // Verify that A's ChannelManager is able to extract preimage from preimage tx and generate PaymentSent
3012 connect_block(&nodes[0], &create_dummy_block(nodes[0].best_block_hash(), 42, vec![node_a_commitment_tx[0].clone(), commitment_spend.clone()]));
3013 connect_blocks(&nodes[0], TEST_FINAL_CLTV + MIN_CLTV_EXPIRY_DELTA as u32); // Confirm blocks until the HTLC expires
3014 check_closed_broadcast!(nodes[0], true);
3015 check_added_monitors!(nodes[0], 1);
3016 let events = nodes[0].node.get_and_clear_pending_events();
3017 assert_eq!(events.len(), 5);
3018 let mut first_claimed = false;
3019 for event in events {
3021 Event::PaymentSent { payment_preimage, payment_hash, .. } => {
3022 if payment_preimage == our_payment_preimage && payment_hash == payment_hash_1 {
3023 assert!(!first_claimed);
3024 first_claimed = true;
3026 assert_eq!(payment_preimage, our_payment_preimage_2);
3027 assert_eq!(payment_hash, payment_hash_2);
3030 Event::PaymentPathSuccessful { .. } => {},
3031 Event::ChannelClosed { reason: ClosureReason::CommitmentTxConfirmed, .. } => {},
3032 _ => panic!("Unexpected event"),
3035 check_tx_local_broadcast!(nodes[0], true, node_a_commitment_tx[0]);
3038 fn do_test_htlc_on_chain_timeout(connect_style: ConnectStyle) {
3039 // Test that in case of a unilateral close onchain, we detect the state of output and
3040 // timeout the HTLC backward accordingly. So here we test that ChannelManager is
3041 // broadcasting the right event to other nodes in payment path.
3042 // A ------------------> B ----------------------> C (timeout)
3043 // B's commitment tx C's commitment tx
3045 // B's HTLC timeout tx B's timeout tx
3047 let chanmon_cfgs = create_chanmon_cfgs(3);
3048 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3049 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3050 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3051 *nodes[0].connect_style.borrow_mut() = connect_style;
3052 *nodes[1].connect_style.borrow_mut() = connect_style;
3053 *nodes[2].connect_style.borrow_mut() = connect_style;
3055 // Create some intial channels
3056 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
3057 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
3059 // Rebalance the network a bit by relaying one payment thorugh all the channels...
3060 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
3061 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
3063 let (_payment_preimage, payment_hash, ..) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
3065 // Broadcast legit commitment tx from C on B's chain
3066 let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
3067 check_spends!(commitment_tx[0], chan_2.3);
3068 nodes[2].node.fail_htlc_backwards(&payment_hash);
3069 check_added_monitors!(nodes[2], 0);
3070 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[2], vec![HTLCDestination::FailedPayment { payment_hash: payment_hash.clone() }]);
3071 check_added_monitors!(nodes[2], 1);
3073 let events = nodes[2].node.get_and_clear_pending_msg_events();
3074 assert_eq!(events.len(), 1);
3076 MessageSendEvent::UpdateHTLCs { ref node_id, updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fulfill_htlcs, ref update_fail_htlcs, ref update_fail_malformed_htlcs, .. } } => {
3077 assert!(update_add_htlcs.is_empty());
3078 assert!(!update_fail_htlcs.is_empty());
3079 assert!(update_fulfill_htlcs.is_empty());
3080 assert!(update_fail_malformed_htlcs.is_empty());
3081 assert_eq!(nodes[1].node.get_our_node_id(), *node_id);
3083 _ => panic!("Unexpected event"),
3085 mine_transaction(&nodes[2], &commitment_tx[0]);
3086 check_closed_broadcast!(nodes[2], true);
3087 check_added_monitors!(nodes[2], 1);
3088 check_closed_event!(nodes[2], 1, ClosureReason::CommitmentTxConfirmed, [nodes[1].node.get_our_node_id()], 100000);
3089 let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
3090 assert_eq!(node_txn.len(), 0);
3092 // Broadcast timeout transaction by B on received output from C's commitment tx on B's chain
3093 // Verify that B's ChannelManager is able to detect that HTLC is timeout by its own tx and react backward in consequence
3094 mine_transaction(&nodes[1], &commitment_tx[0]);
3095 check_closed_event!(&nodes[1], 1, ClosureReason::CommitmentTxConfirmed, false
3096 , [nodes[2].node.get_our_node_id()], 100000);
3097 connect_blocks(&nodes[1], 200 - nodes[2].best_block_info().1);
3099 let mut txn = nodes[1].tx_broadcaster.txn_broadcast();
3100 if nodes[1].connect_style.borrow().skips_blocks() {
3101 assert_eq!(txn.len(), 1);
3103 assert_eq!(txn.len(), 3); // Two extra fee bumps for timeout transaction
3105 txn.iter().for_each(|tx| check_spends!(tx, commitment_tx[0]));
3106 assert_eq!(txn[0].clone().input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
3110 mine_transaction(&nodes[1], &timeout_tx);
3111 check_added_monitors!(nodes[1], 1);
3112 check_closed_broadcast!(nodes[1], true);
3114 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
3116 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], vec![HTLCDestination::NextHopChannel { node_id: Some(nodes[2].node.get_our_node_id()), channel_id: chan_2.2 }]);
3117 check_added_monitors!(nodes[1], 1);
3118 let events = nodes[1].node.get_and_clear_pending_msg_events();
3119 assert_eq!(events.len(), 1);
3121 MessageSendEvent::UpdateHTLCs { ref node_id, updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fail_htlcs, ref update_fulfill_htlcs, ref update_fail_malformed_htlcs, .. } } => {
3122 assert!(update_add_htlcs.is_empty());
3123 assert!(!update_fail_htlcs.is_empty());
3124 assert!(update_fulfill_htlcs.is_empty());
3125 assert!(update_fail_malformed_htlcs.is_empty());
3126 assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
3128 _ => panic!("Unexpected event"),
3131 // Broadcast legit commitment tx from B on A's chain
3132 let commitment_tx = get_local_commitment_txn!(nodes[1], chan_1.2);
3133 check_spends!(commitment_tx[0], chan_1.3);
3135 mine_transaction(&nodes[0], &commitment_tx[0]);
3136 connect_blocks(&nodes[0], TEST_FINAL_CLTV + MIN_CLTV_EXPIRY_DELTA as u32); // Confirm blocks until the HTLC expires
3138 check_closed_broadcast!(nodes[0], true);
3139 check_added_monitors!(nodes[0], 1);
3140 check_closed_event!(nodes[0], 1, ClosureReason::CommitmentTxConfirmed, [nodes[1].node.get_our_node_id()], 100000);
3141 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // 1 timeout tx
3142 assert_eq!(node_txn.len(), 1);
3143 check_spends!(node_txn[0], commitment_tx[0]);
3144 assert_eq!(node_txn[0].clone().input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
3148 fn test_htlc_on_chain_timeout() {
3149 do_test_htlc_on_chain_timeout(ConnectStyle::BestBlockFirstSkippingBlocks);
3150 do_test_htlc_on_chain_timeout(ConnectStyle::TransactionsFirstSkippingBlocks);
3151 do_test_htlc_on_chain_timeout(ConnectStyle::FullBlockViaListen);
3155 fn test_simple_commitment_revoked_fail_backward() {
3156 // Test that in case of a revoked commitment tx, we detect the resolution of output by justice tx
3157 // and fail backward accordingly.
3159 let chanmon_cfgs = create_chanmon_cfgs(3);
3160 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3161 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3162 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3164 // Create some initial channels
3165 create_announced_chan_between_nodes(&nodes, 0, 1);
3166 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
3168 let (payment_preimage, _payment_hash, ..) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3000000);
3169 // Get the will-be-revoked local txn from nodes[2]
3170 let revoked_local_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
3171 // Revoke the old state
3172 claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage);
3174 let (_, payment_hash, ..) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3000000);
3176 mine_transaction(&nodes[1], &revoked_local_txn[0]);
3177 check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed, [nodes[2].node.get_our_node_id()], 100000);
3178 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
3179 check_added_monitors!(nodes[1], 1);
3180 check_closed_broadcast!(nodes[1], true);
3182 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], vec![HTLCDestination::NextHopChannel { node_id: Some(nodes[2].node.get_our_node_id()), channel_id: chan_2.2 }]);
3183 check_added_monitors!(nodes[1], 1);
3184 let events = nodes[1].node.get_and_clear_pending_msg_events();
3185 assert_eq!(events.len(), 1);
3187 MessageSendEvent::UpdateHTLCs { ref node_id, updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fail_htlcs, ref update_fulfill_htlcs, ref update_fail_malformed_htlcs, ref commitment_signed, .. } } => {
3188 assert!(update_add_htlcs.is_empty());
3189 assert_eq!(update_fail_htlcs.len(), 1);
3190 assert!(update_fulfill_htlcs.is_empty());
3191 assert!(update_fail_malformed_htlcs.is_empty());
3192 assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
3194 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
3195 commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
3196 expect_payment_failed_with_update!(nodes[0], payment_hash, false, chan_2.0.contents.short_channel_id, true);
3198 _ => panic!("Unexpected event"),
3202 fn do_test_commitment_revoked_fail_backward_exhaustive(deliver_bs_raa: bool, use_dust: bool, no_to_remote: bool) {
3203 // Test that if our counterparty broadcasts a revoked commitment transaction we fail all
3204 // pending HTLCs on that channel backwards even if the HTLCs aren't present in our latest
3205 // commitment transaction anymore.
3206 // To do this, we have the peer which will broadcast a revoked commitment transaction send
3207 // a number of update_fail/commitment_signed updates without ever sending the RAA in
3208 // response to our commitment_signed. This is somewhat misbehavior-y, though not
3209 // technically disallowed and we should probably handle it reasonably.
3210 // Note that this is pretty exhaustive as an outbound HTLC which we haven't yet
3211 // failed/fulfilled backwards must be in at least one of the latest two remote commitment
3213 // * Once we move it out of our holding cell/add it, we will immediately include it in a
3214 // commitment_signed (implying it will be in the latest remote commitment transaction).
3215 // * Once they remove it, we will send a (the first) commitment_signed without the HTLC,
3216 // and once they revoke the previous commitment transaction (allowing us to send a new
3217 // commitment_signed) we will be free to fail/fulfill the HTLC backwards.
3218 let chanmon_cfgs = create_chanmon_cfgs(3);
3219 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3220 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3221 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3223 // Create some initial channels
3224 create_announced_chan_between_nodes(&nodes, 0, 1);
3225 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
3227 let (payment_preimage, _payment_hash, ..) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], if no_to_remote { 10_000 } else { 3_000_000 });
3228 // Get the will-be-revoked local txn from nodes[2]
3229 let revoked_local_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
3230 assert_eq!(revoked_local_txn[0].output.len(), if no_to_remote { 1 } else { 2 });
3231 // Revoke the old state
3232 claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage);
3234 let value = if use_dust {
3235 // The dust limit applied to HTLC outputs considers the fee of the HTLC transaction as
3236 // well, so HTLCs at exactly the dust limit will not be included in commitment txn.
3237 nodes[2].node.per_peer_state.read().unwrap().get(&nodes[1].node.get_our_node_id())
3238 .unwrap().lock().unwrap().channel_by_id.get(&chan_2.2).unwrap().context().holder_dust_limit_satoshis * 1000
3241 let (_, first_payment_hash, ..) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
3242 let (_, second_payment_hash, ..) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
3243 let (_, third_payment_hash, ..) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
3245 nodes[2].node.fail_htlc_backwards(&first_payment_hash);
3246 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[2], vec![HTLCDestination::FailedPayment { payment_hash: first_payment_hash }]);
3247 check_added_monitors!(nodes[2], 1);
3248 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3249 assert!(updates.update_add_htlcs.is_empty());
3250 assert!(updates.update_fulfill_htlcs.is_empty());
3251 assert!(updates.update_fail_malformed_htlcs.is_empty());
3252 assert_eq!(updates.update_fail_htlcs.len(), 1);
3253 assert!(updates.update_fee.is_none());
3254 nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
3255 let bs_raa = commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false, true, false, true);
3256 // Drop the last RAA from 3 -> 2
3258 nodes[2].node.fail_htlc_backwards(&second_payment_hash);
3259 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[2], vec![HTLCDestination::FailedPayment { payment_hash: second_payment_hash }]);
3260 check_added_monitors!(nodes[2], 1);
3261 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3262 assert!(updates.update_add_htlcs.is_empty());
3263 assert!(updates.update_fulfill_htlcs.is_empty());
3264 assert!(updates.update_fail_malformed_htlcs.is_empty());
3265 assert_eq!(updates.update_fail_htlcs.len(), 1);
3266 assert!(updates.update_fee.is_none());
3267 nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
3268 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &updates.commitment_signed);
3269 check_added_monitors!(nodes[1], 1);
3270 // Note that nodes[1] is in AwaitingRAA, so won't send a CS
3271 let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
3272 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
3273 check_added_monitors!(nodes[2], 1);
3275 nodes[2].node.fail_htlc_backwards(&third_payment_hash);
3276 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[2], vec![HTLCDestination::FailedPayment { payment_hash: third_payment_hash }]);
3277 check_added_monitors!(nodes[2], 1);
3278 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3279 assert!(updates.update_add_htlcs.is_empty());
3280 assert!(updates.update_fulfill_htlcs.is_empty());
3281 assert!(updates.update_fail_malformed_htlcs.is_empty());
3282 assert_eq!(updates.update_fail_htlcs.len(), 1);
3283 assert!(updates.update_fee.is_none());
3284 nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
3285 // At this point first_payment_hash has dropped out of the latest two commitment
3286 // transactions that nodes[1] is tracking...
3287 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &updates.commitment_signed);
3288 check_added_monitors!(nodes[1], 1);
3289 // Note that nodes[1] is (still) in AwaitingRAA, so won't send a CS
3290 let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
3291 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
3292 check_added_monitors!(nodes[2], 1);
3294 // Add a fourth HTLC, this one will get sequestered away in nodes[1]'s holding cell waiting
3295 // on nodes[2]'s RAA.
3296 let (route, fourth_payment_hash, _, fourth_payment_secret) = get_route_and_payment_hash!(nodes[1], nodes[2], 1000000);
3297 nodes[1].node.send_payment_with_route(&route, fourth_payment_hash,
3298 RecipientOnionFields::secret_only(fourth_payment_secret), PaymentId(fourth_payment_hash.0)).unwrap();
3299 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3300 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
3301 check_added_monitors!(nodes[1], 0);
3304 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_raa);
3305 // One monitor for the new revocation preimage, no second on as we won't generate a new
3306 // commitment transaction for nodes[0] until process_pending_htlc_forwards().
3307 check_added_monitors!(nodes[1], 1);
3308 let events = nodes[1].node.get_and_clear_pending_events();
3309 assert_eq!(events.len(), 2);
3311 Event::PendingHTLCsForwardable { .. } => { },
3312 _ => panic!("Unexpected event"),
3315 Event::HTLCHandlingFailed { .. } => { },
3316 _ => panic!("Unexpected event"),
3318 // Deliberately don't process the pending fail-back so they all fail back at once after
3319 // block connection just like the !deliver_bs_raa case
3322 let mut failed_htlcs = HashSet::new();
3323 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
3325 mine_transaction(&nodes[1], &revoked_local_txn[0]);
3326 check_added_monitors!(nodes[1], 1);
3327 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
3329 let events = nodes[1].node.get_and_clear_pending_events();
3330 assert_eq!(events.len(), if deliver_bs_raa { 3 + nodes.len() - 1 } else { 4 + nodes.len() });
3332 Event::ChannelClosed { reason: ClosureReason::CommitmentTxConfirmed, .. } => { },
3333 _ => panic!("Unexepected event"),
3336 Event::PaymentPathFailed { ref payment_hash, .. } => {
3337 assert_eq!(*payment_hash, fourth_payment_hash);
3339 _ => panic!("Unexpected event"),
3342 Event::PaymentFailed { ref payment_hash, .. } => {
3343 assert_eq!(*payment_hash, fourth_payment_hash);
3345 _ => panic!("Unexpected event"),
3348 nodes[1].node.process_pending_htlc_forwards();
3349 check_added_monitors!(nodes[1], 1);
3351 let mut events = nodes[1].node.get_and_clear_pending_msg_events();
3352 assert_eq!(events.len(), if deliver_bs_raa { 4 } else { 3 });
3355 let nodes_2_event = remove_first_msg_event_to_node(&nodes[2].node.get_our_node_id(), &mut events);
3356 match nodes_2_event {
3357 MessageSendEvent::UpdateHTLCs { ref node_id, updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fail_htlcs, ref update_fulfill_htlcs, ref update_fail_malformed_htlcs, .. } } => {
3358 assert_eq!(nodes[2].node.get_our_node_id(), *node_id);
3359 assert_eq!(update_add_htlcs.len(), 1);
3360 assert!(update_fulfill_htlcs.is_empty());
3361 assert!(update_fail_htlcs.is_empty());
3362 assert!(update_fail_malformed_htlcs.is_empty());
3364 _ => panic!("Unexpected event"),
3368 let nodes_2_event = remove_first_msg_event_to_node(&nodes[2].node.get_our_node_id(), &mut events);
3369 match nodes_2_event {
3370 MessageSendEvent::HandleError { action: ErrorAction::DisconnectPeer { msg: Some(msgs::ErrorMessage { channel_id, ref data }) }, node_id: _ } => {
3371 assert_eq!(channel_id, chan_2.2);
3372 assert_eq!(data.as_str(), "Channel closed because commitment or closing transaction was confirmed on chain.");
3374 _ => panic!("Unexpected event"),
3377 let nodes_0_event = remove_first_msg_event_to_node(&nodes[0].node.get_our_node_id(), &mut events);
3378 match nodes_0_event {
3379 MessageSendEvent::UpdateHTLCs { ref node_id, updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fail_htlcs, ref update_fulfill_htlcs, ref update_fail_malformed_htlcs, ref commitment_signed, .. } } => {
3380 assert!(update_add_htlcs.is_empty());
3381 assert_eq!(update_fail_htlcs.len(), 3);
3382 assert!(update_fulfill_htlcs.is_empty());
3383 assert!(update_fail_malformed_htlcs.is_empty());
3384 assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
3386 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
3387 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[1]);
3388 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[2]);
3390 commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
3392 let events = nodes[0].node.get_and_clear_pending_events();
3393 assert_eq!(events.len(), 6);
3395 Event::PaymentPathFailed { ref payment_hash, ref failure, .. } => {
3396 assert!(failed_htlcs.insert(payment_hash.0));
3397 // If we delivered B's RAA we got an unknown preimage error, not something
3398 // that we should update our routing table for.
3399 if !deliver_bs_raa {
3400 if let PathFailure::OnPath { network_update: Some(_) } = failure { } else { panic!("Unexpected path failure") }
3403 _ => panic!("Unexpected event"),
3406 Event::PaymentFailed { ref payment_hash, .. } => {
3407 assert_eq!(*payment_hash, first_payment_hash);
3409 _ => panic!("Unexpected event"),
3412 Event::PaymentPathFailed { ref payment_hash, failure: PathFailure::OnPath { network_update: Some(_) }, .. } => {
3413 assert!(failed_htlcs.insert(payment_hash.0));
3415 _ => panic!("Unexpected event"),
3418 Event::PaymentFailed { ref payment_hash, .. } => {
3419 assert_eq!(*payment_hash, second_payment_hash);
3421 _ => panic!("Unexpected event"),
3424 Event::PaymentPathFailed { ref payment_hash, failure: PathFailure::OnPath { network_update: Some(_) }, .. } => {
3425 assert!(failed_htlcs.insert(payment_hash.0));
3427 _ => panic!("Unexpected event"),
3430 Event::PaymentFailed { ref payment_hash, .. } => {
3431 assert_eq!(*payment_hash, third_payment_hash);
3433 _ => panic!("Unexpected event"),
3436 _ => panic!("Unexpected event"),
3439 // Ensure that the last remaining message event is the BroadcastChannelUpdate msg for chan_2
3441 MessageSendEvent::BroadcastChannelUpdate { msg: msgs::ChannelUpdate { .. } } => {},
3442 _ => panic!("Unexpected event"),
3445 assert!(failed_htlcs.contains(&first_payment_hash.0));
3446 assert!(failed_htlcs.contains(&second_payment_hash.0));
3447 assert!(failed_htlcs.contains(&third_payment_hash.0));
3451 fn test_commitment_revoked_fail_backward_exhaustive_a() {
3452 do_test_commitment_revoked_fail_backward_exhaustive(false, true, false);
3453 do_test_commitment_revoked_fail_backward_exhaustive(true, true, false);
3454 do_test_commitment_revoked_fail_backward_exhaustive(false, false, false);
3455 do_test_commitment_revoked_fail_backward_exhaustive(true, false, false);
3459 fn test_commitment_revoked_fail_backward_exhaustive_b() {
3460 do_test_commitment_revoked_fail_backward_exhaustive(false, true, true);
3461 do_test_commitment_revoked_fail_backward_exhaustive(true, true, true);
3462 do_test_commitment_revoked_fail_backward_exhaustive(false, false, true);
3463 do_test_commitment_revoked_fail_backward_exhaustive(true, false, true);
3467 fn fail_backward_pending_htlc_upon_channel_failure() {
3468 let chanmon_cfgs = create_chanmon_cfgs(2);
3469 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3470 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3471 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3472 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1_000_000, 500_000_000);
3474 // Alice -> Bob: Route a payment but without Bob sending revoke_and_ack.
3476 let (route, payment_hash, _, payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], 50_000);
3477 nodes[0].node.send_payment_with_route(&route, payment_hash, RecipientOnionFields::secret_only(payment_secret),
3478 PaymentId(payment_hash.0)).unwrap();
3479 check_added_monitors!(nodes[0], 1);
3481 let payment_event = {
3482 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3483 assert_eq!(events.len(), 1);
3484 SendEvent::from_event(events.remove(0))
3486 assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
3487 assert_eq!(payment_event.msgs.len(), 1);
3490 // Alice -> Bob: Route another payment but now Alice waits for Bob's earlier revoke_and_ack.
3491 let (route, failed_payment_hash, _, failed_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], 50_000);
3493 nodes[0].node.send_payment_with_route(&route, failed_payment_hash,
3494 RecipientOnionFields::secret_only(failed_payment_secret), PaymentId(failed_payment_hash.0)).unwrap();
3495 check_added_monitors!(nodes[0], 0);
3497 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3500 // Alice <- Bob: Send a malformed update_add_htlc so Alice fails the channel.
3502 let (route, payment_hash, _, payment_secret) = get_route_and_payment_hash!(nodes[1], nodes[0], 50_000);
3504 let secp_ctx = Secp256k1::new();
3505 let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
3506 let current_height = nodes[1].node.best_block.read().unwrap().height() + 1;
3507 let (onion_payloads, _amount_msat, cltv_expiry) = onion_utils::build_onion_payloads(
3508 &route.paths[0], 50_000, RecipientOnionFields::secret_only(payment_secret), current_height, &None).unwrap();
3509 let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route.paths[0], &session_priv).unwrap();
3510 let onion_routing_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash).unwrap();
3512 // Send a 0-msat update_add_htlc to fail the channel.
3513 let update_add_htlc = msgs::UpdateAddHTLC {
3519 onion_routing_packet,
3520 skimmed_fee_msat: None,
3521 blinding_point: None,
3523 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &update_add_htlc);
3525 let events = nodes[0].node.get_and_clear_pending_events();
3526 assert_eq!(events.len(), 3);
3527 // Check that Alice fails backward the pending HTLC from the second payment.
3529 Event::PaymentPathFailed { payment_hash, .. } => {
3530 assert_eq!(payment_hash, failed_payment_hash);
3532 _ => panic!("Unexpected event"),
3535 Event::PaymentFailed { payment_hash, .. } => {
3536 assert_eq!(payment_hash, failed_payment_hash);
3538 _ => panic!("Unexpected event"),
3541 Event::ChannelClosed { reason: ClosureReason::ProcessingError { ref err }, .. } => {
3542 assert_eq!(err, "Remote side tried to send a 0-msat HTLC");
3544 _ => panic!("Unexpected event {:?}", events[1]),
3546 check_closed_broadcast!(nodes[0], true);
3547 check_added_monitors!(nodes[0], 1);
3551 fn test_htlc_ignore_latest_remote_commitment() {
3552 // Test that HTLC transactions spending the latest remote commitment transaction are simply
3553 // ignored if we cannot claim them. This originally tickled an invalid unwrap().
3554 let chanmon_cfgs = create_chanmon_cfgs(2);
3555 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3556 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3557 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3558 if *nodes[1].connect_style.borrow() == ConnectStyle::FullBlockViaListen {
3559 // We rely on the ability to connect a block redundantly, which isn't allowed via
3560 // `chain::Listen`, so we never run the test if we randomly get assigned that
3564 let funding_tx = create_announced_chan_between_nodes(&nodes, 0, 1).3;
3566 route_payment(&nodes[0], &[&nodes[1]], 10000000);
3567 nodes[0].node.force_close_broadcasting_latest_txn(&nodes[0].node.list_channels()[0].channel_id, &nodes[1].node.get_our_node_id()).unwrap();
3568 connect_blocks(&nodes[0], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + 1);
3569 check_closed_broadcast!(nodes[0], true);
3570 check_added_monitors!(nodes[0], 1);
3571 check_closed_event!(nodes[0], 1, ClosureReason::HolderForceClosed, [nodes[1].node.get_our_node_id()], 100000);
3573 let node_txn = nodes[0].tx_broadcaster.unique_txn_broadcast();
3574 assert_eq!(node_txn.len(), 2);
3575 check_spends!(node_txn[0], funding_tx);
3576 check_spends!(node_txn[1], node_txn[0]);
3578 let block = create_dummy_block(nodes[1].best_block_hash(), 42, vec![node_txn[0].clone()]);
3579 connect_block(&nodes[1], &block);
3580 check_closed_broadcast!(nodes[1], true);
3581 check_added_monitors!(nodes[1], 1);
3582 check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed, [nodes[0].node.get_our_node_id()], 100000);
3584 // Duplicate the connect_block call since this may happen due to other listeners
3585 // registering new transactions
3586 connect_block(&nodes[1], &block);
3590 fn test_force_close_fail_back() {
3591 // Check which HTLCs are failed-backwards on channel force-closure
3592 let chanmon_cfgs = create_chanmon_cfgs(3);
3593 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3594 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3595 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3596 create_announced_chan_between_nodes(&nodes, 0, 1);
3597 create_announced_chan_between_nodes(&nodes, 1, 2);
3599 let (route, our_payment_hash, our_payment_preimage, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], 1000000);
3601 let mut payment_event = {
3602 nodes[0].node.send_payment_with_route(&route, our_payment_hash,
3603 RecipientOnionFields::secret_only(our_payment_secret), PaymentId(our_payment_hash.0)).unwrap();
3604 check_added_monitors!(nodes[0], 1);
3606 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3607 assert_eq!(events.len(), 1);
3608 SendEvent::from_event(events.remove(0))
3611 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
3612 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
3614 expect_pending_htlcs_forwardable!(nodes[1]);
3616 let mut events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3617 assert_eq!(events_2.len(), 1);
3618 payment_event = SendEvent::from_event(events_2.remove(0));
3619 assert_eq!(payment_event.msgs.len(), 1);
3621 check_added_monitors!(nodes[1], 1);
3622 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
3623 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg);
3624 check_added_monitors!(nodes[2], 1);
3625 let (_, _) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3627 // nodes[2] now has the latest commitment transaction, but hasn't revoked its previous
3628 // state or updated nodes[1]' state. Now force-close and broadcast that commitment/HTLC
3629 // transaction and ensure nodes[1] doesn't fail-backwards (this was originally a bug!).
3631 nodes[2].node.force_close_broadcasting_latest_txn(&payment_event.commitment_msg.channel_id, &nodes[1].node.get_our_node_id()).unwrap();
3632 check_closed_broadcast!(nodes[2], true);
3633 check_added_monitors!(nodes[2], 1);
3634 check_closed_event!(nodes[2], 1, ClosureReason::HolderForceClosed, [nodes[1].node.get_our_node_id()], 100000);
3635 let commitment_tx = {
3636 let mut node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap();
3637 // Note that we don't bother broadcasting the HTLC-Success transaction here as we don't
3638 // have a use for it unless nodes[2] learns the preimage somehow, the funds will go
3639 // back to nodes[1] upon timeout otherwise.
3640 assert_eq!(node_txn.len(), 1);
3644 mine_transaction(&nodes[1], &commitment_tx);
3646 // Note no UpdateHTLCs event here from nodes[1] to nodes[0]!
3647 check_closed_broadcast!(nodes[1], true);
3648 check_added_monitors!(nodes[1], 1);
3649 check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed, [nodes[2].node.get_our_node_id()], 100000);
3651 // Now check that if we add the preimage to ChannelMonitor it broadcasts our HTLC-Success..
3653 get_monitor!(nodes[2], payment_event.commitment_msg.channel_id)
3654 .provide_payment_preimage(&our_payment_hash, &our_payment_preimage, &node_cfgs[2].tx_broadcaster, &LowerBoundedFeeEstimator::new(node_cfgs[2].fee_estimator), &node_cfgs[2].logger);
3656 mine_transaction(&nodes[2], &commitment_tx);
3657 let mut node_txn = nodes[2].tx_broadcaster.txn_broadcast();
3658 assert_eq!(node_txn.len(), if nodes[2].connect_style.borrow().updates_best_block_first() { 2 } else { 1 });
3659 let htlc_tx = node_txn.pop().unwrap();
3660 assert_eq!(htlc_tx.input.len(), 1);
3661 assert_eq!(htlc_tx.input[0].previous_output.txid, commitment_tx.txid());
3662 assert_eq!(htlc_tx.lock_time, LockTime::ZERO); // Must be an HTLC-Success
3663 assert_eq!(htlc_tx.input[0].witness.len(), 5); // Must be an HTLC-Success
3665 check_spends!(htlc_tx, commitment_tx);
3669 fn test_dup_events_on_peer_disconnect() {
3670 // Test that if we receive a duplicative update_fulfill_htlc message after a reconnect we do
3671 // not generate a corresponding duplicative PaymentSent event. This did not use to be the case
3672 // as we used to generate the event immediately upon receipt of the payment preimage in the
3673 // update_fulfill_htlc message.
3675 let chanmon_cfgs = create_chanmon_cfgs(2);
3676 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3677 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3678 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3679 create_announced_chan_between_nodes(&nodes, 0, 1);
3681 let (payment_preimage, payment_hash, ..) = route_payment(&nodes[0], &[&nodes[1]], 1_000_000);
3683 nodes[1].node.claim_funds(payment_preimage);
3684 expect_payment_claimed!(nodes[1], payment_hash, 1_000_000);
3685 check_added_monitors!(nodes[1], 1);
3686 let claim_msgs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3687 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &claim_msgs.update_fulfill_htlcs[0]);
3688 expect_payment_sent(&nodes[0], payment_preimage, None, false, false);
3690 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id());
3691 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
3693 let mut reconnect_args = ReconnectArgs::new(&nodes[0], &nodes[1]);
3694 reconnect_args.pending_htlc_claims.0 = 1;
3695 reconnect_nodes(reconnect_args);
3696 expect_payment_path_successful!(nodes[0]);
3700 fn test_peer_disconnected_before_funding_broadcasted() {
3701 // Test that channels are closed with `ClosureReason::DisconnectedPeer` if the peer disconnects
3702 // before the funding transaction has been broadcasted.
3703 let chanmon_cfgs = create_chanmon_cfgs(2);
3704 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3705 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3706 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3708 // Open a channel between `nodes[0]` and `nodes[1]`, for which the funding transaction is never
3709 // broadcasted, even though it's created by `nodes[0]`.
3710 let expected_temporary_channel_id = nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 1_000_000, 500_000_000, 42, None, None).unwrap();
3711 let open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
3712 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel);
3713 let accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
3714 nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), &accept_channel);
3716 let (temporary_channel_id, tx, _funding_output) = create_funding_transaction(&nodes[0], &nodes[1].node.get_our_node_id(), 1_000_000, 42);
3717 assert_eq!(temporary_channel_id, expected_temporary_channel_id);
3719 assert!(nodes[0].node.funding_transaction_generated(&temporary_channel_id, &nodes[1].node.get_our_node_id(), tx.clone()).is_ok());
3721 let funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
3722 assert_eq!(funding_created_msg.temporary_channel_id, expected_temporary_channel_id);
3724 // Even though the funding transaction is created by `nodes[0]`, the `FundingCreated` msg is
3725 // never sent to `nodes[1]`, and therefore the tx is never signed by either party nor
3728 assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 0);
3731 // Ensure that the channel is closed with `ClosureReason::DisconnectedPeer` when the peers are
3732 // disconnected before the funding transaction was broadcasted.
3733 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id());
3734 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
3736 check_closed_event!(&nodes[0], 2, ClosureReason::DisconnectedPeer, true
3737 , [nodes[1].node.get_our_node_id()], 1000000);
3738 check_closed_event!(&nodes[1], 1, ClosureReason::DisconnectedPeer, false
3739 , [nodes[0].node.get_our_node_id()], 1000000);
3743 fn test_simple_peer_disconnect() {
3744 // Test that we can reconnect when there are no lost messages
3745 let chanmon_cfgs = create_chanmon_cfgs(3);
3746 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3747 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3748 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3749 create_announced_chan_between_nodes(&nodes, 0, 1);
3750 create_announced_chan_between_nodes(&nodes, 1, 2);
3752 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id());
3753 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
3754 let mut reconnect_args = ReconnectArgs::new(&nodes[0], &nodes[1]);
3755 reconnect_args.send_channel_ready = (true, true);
3756 reconnect_nodes(reconnect_args);
3758 let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3759 let payment_hash_2 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3760 fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_hash_2);
3761 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_preimage_1);
3763 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id());
3764 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
3765 reconnect_nodes(ReconnectArgs::new(&nodes[0], &nodes[1]));
3767 let (payment_preimage_3, payment_hash_3, ..) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000);
3768 let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3769 let payment_hash_5 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3770 let payment_hash_6 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3772 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id());
3773 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
3775 claim_payment_along_route(&nodes[0], &[&[&nodes[1], &nodes[2]]], true, payment_preimage_3);
3776 fail_payment_along_route(&nodes[0], &[&[&nodes[1], &nodes[2]]], true, payment_hash_5);
3778 let mut reconnect_args = ReconnectArgs::new(&nodes[0], &nodes[1]);
3779 reconnect_args.pending_cell_htlc_fails.0 = 1;
3780 reconnect_args.pending_cell_htlc_claims.0 = 1;
3781 reconnect_nodes(reconnect_args);
3783 let events = nodes[0].node.get_and_clear_pending_events();
3784 assert_eq!(events.len(), 4);
3786 Event::PaymentSent { payment_preimage, payment_hash, .. } => {
3787 assert_eq!(payment_preimage, payment_preimage_3);
3788 assert_eq!(payment_hash, payment_hash_3);
3790 _ => panic!("Unexpected event"),
3793 Event::PaymentPathSuccessful { .. } => {},
3794 _ => panic!("Unexpected event"),
3797 Event::PaymentPathFailed { payment_hash, payment_failed_permanently, .. } => {
3798 assert_eq!(payment_hash, payment_hash_5);
3799 assert!(payment_failed_permanently);
3801 _ => panic!("Unexpected event"),
3804 Event::PaymentFailed { payment_hash, .. } => {
3805 assert_eq!(payment_hash, payment_hash_5);
3807 _ => panic!("Unexpected event"),
3810 check_added_monitors(&nodes[0], 1);
3812 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_preimage_4);
3813 fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_hash_6);
3816 fn do_test_drop_messages_peer_disconnect(messages_delivered: u8, simulate_broken_lnd: bool) {
3817 // Test that we can reconnect when in-flight HTLC updates get dropped
3818 let chanmon_cfgs = create_chanmon_cfgs(2);
3819 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3820 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3821 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3823 let mut as_channel_ready = None;
3824 let channel_id = if messages_delivered == 0 {
3825 let (channel_ready, chan_id, _) = create_chan_between_nodes_with_value_a(&nodes[0], &nodes[1], 100000, 10001);
3826 as_channel_ready = Some(channel_ready);
3827 // nodes[1] doesn't receive the channel_ready message (it'll be re-sent on reconnect)
3828 // Note that we store it so that if we're running with `simulate_broken_lnd` we can deliver
3829 // it before the channel_reestablish message.
3832 create_announced_chan_between_nodes(&nodes, 0, 1).2
3835 let (route, payment_hash_1, payment_preimage_1, payment_secret_1) = get_route_and_payment_hash!(nodes[0], nodes[1], 1_000_000);
3837 let payment_event = {
3838 nodes[0].node.send_payment_with_route(&route, payment_hash_1,
3839 RecipientOnionFields::secret_only(payment_secret_1), PaymentId(payment_hash_1.0)).unwrap();
3840 check_added_monitors!(nodes[0], 1);
3842 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3843 assert_eq!(events.len(), 1);
3844 SendEvent::from_event(events.remove(0))
3846 assert_eq!(nodes[1].node.get_our_node_id(), payment_event.node_id);
3848 if messages_delivered < 2 {
3849 // Drop the payment_event messages, and let them get re-generated in reconnect_nodes!
3851 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
3852 if messages_delivered >= 3 {
3853 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
3854 check_added_monitors!(nodes[1], 1);
3855 let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3857 if messages_delivered >= 4 {
3858 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3859 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3860 check_added_monitors!(nodes[0], 1);
3862 if messages_delivered >= 5 {
3863 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_commitment_signed);
3864 let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3865 // No commitment_signed so get_event_msg's assert(len == 1) passes
3866 check_added_monitors!(nodes[0], 1);
3868 if messages_delivered >= 6 {
3869 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3870 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3871 check_added_monitors!(nodes[1], 1);
3878 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id());
3879 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
3880 if messages_delivered < 3 {
3881 if simulate_broken_lnd {
3882 // lnd has a long-standing bug where they send a channel_ready prior to a
3883 // channel_reestablish if you reconnect prior to channel_ready time.
3885 // Here we simulate that behavior, delivering a channel_ready immediately on
3886 // reconnect. Note that we don't bother skipping the now-duplicate channel_ready sent
3887 // in `reconnect_nodes` but we currently don't fail based on that.
3889 // See-also <https://github.com/lightningnetwork/lnd/issues/4006>
3890 nodes[1].node.handle_channel_ready(&nodes[0].node.get_our_node_id(), &as_channel_ready.as_ref().unwrap().0);
3892 // Even if the channel_ready messages get exchanged, as long as nothing further was
3893 // received on either side, both sides will need to resend them.
3894 let mut reconnect_args = ReconnectArgs::new(&nodes[0], &nodes[1]);
3895 reconnect_args.send_channel_ready = (true, true);
3896 reconnect_args.pending_htlc_adds.1 = 1;
3897 reconnect_nodes(reconnect_args);
3898 } else if messages_delivered == 3 {
3899 // nodes[0] still wants its RAA + commitment_signed
3900 let mut reconnect_args = ReconnectArgs::new(&nodes[0], &nodes[1]);
3901 reconnect_args.pending_responding_commitment_signed.0 = true;
3902 reconnect_args.pending_raa.0 = true;
3903 reconnect_nodes(reconnect_args);
3904 } else if messages_delivered == 4 {
3905 // nodes[0] still wants its commitment_signed
3906 let mut reconnect_args = ReconnectArgs::new(&nodes[0], &nodes[1]);
3907 reconnect_args.pending_responding_commitment_signed.0 = true;
3908 reconnect_nodes(reconnect_args);
3909 } else if messages_delivered == 5 {
3910 // nodes[1] still wants its final RAA
3911 let mut reconnect_args = ReconnectArgs::new(&nodes[0], &nodes[1]);
3912 reconnect_args.pending_raa.1 = true;
3913 reconnect_nodes(reconnect_args);
3914 } else if messages_delivered == 6 {
3915 // Everything was delivered...
3916 reconnect_nodes(ReconnectArgs::new(&nodes[0], &nodes[1]));
3919 let events_1 = nodes[1].node.get_and_clear_pending_events();
3920 if messages_delivered == 0 {
3921 assert_eq!(events_1.len(), 2);
3923 Event::ChannelReady { .. } => { },
3924 _ => panic!("Unexpected event"),
3927 Event::PendingHTLCsForwardable { .. } => { },
3928 _ => panic!("Unexpected event"),
3931 assert_eq!(events_1.len(), 1);
3933 Event::PendingHTLCsForwardable { .. } => { },
3934 _ => panic!("Unexpected event"),
3938 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id());
3939 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
3940 reconnect_nodes(ReconnectArgs::new(&nodes[0], &nodes[1]));
3942 nodes[1].node.process_pending_htlc_forwards();
3944 let events_2 = nodes[1].node.get_and_clear_pending_events();
3945 assert_eq!(events_2.len(), 1);
3947 Event::PaymentClaimable { ref payment_hash, ref purpose, amount_msat, receiver_node_id, via_channel_id, .. } => {
3948 assert_eq!(payment_hash_1, *payment_hash);
3949 assert_eq!(amount_msat, 1_000_000);
3950 assert_eq!(receiver_node_id.unwrap(), nodes[1].node.get_our_node_id());
3951 assert_eq!(via_channel_id, Some(channel_id));
3953 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
3954 assert!(payment_preimage.is_none());
3955 assert_eq!(payment_secret_1, *payment_secret);
3957 _ => panic!("expected PaymentPurpose::InvoicePayment")
3960 _ => panic!("Unexpected event"),
3963 nodes[1].node.claim_funds(payment_preimage_1);
3964 check_added_monitors!(nodes[1], 1);
3965 expect_payment_claimed!(nodes[1], payment_hash_1, 1_000_000);
3967 let events_3 = nodes[1].node.get_and_clear_pending_msg_events();
3968 assert_eq!(events_3.len(), 1);
3969 let (update_fulfill_htlc, commitment_signed) = match events_3[0] {
3970 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
3971 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3972 assert!(updates.update_add_htlcs.is_empty());
3973 assert!(updates.update_fail_htlcs.is_empty());
3974 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
3975 assert!(updates.update_fail_malformed_htlcs.is_empty());
3976 assert!(updates.update_fee.is_none());
3977 (updates.update_fulfill_htlcs[0].clone(), updates.commitment_signed.clone())
3979 _ => panic!("Unexpected event"),
3982 if messages_delivered >= 1 {
3983 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlc);
3985 let events_4 = nodes[0].node.get_and_clear_pending_events();
3986 assert_eq!(events_4.len(), 1);
3988 Event::PaymentSent { ref payment_preimage, ref payment_hash, .. } => {
3989 assert_eq!(payment_preimage_1, *payment_preimage);
3990 assert_eq!(payment_hash_1, *payment_hash);
3992 _ => panic!("Unexpected event"),
3995 if messages_delivered >= 2 {
3996 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
3997 check_added_monitors!(nodes[0], 1);
3998 let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
4000 if messages_delivered >= 3 {
4001 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
4002 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4003 check_added_monitors!(nodes[1], 1);
4005 if messages_delivered >= 4 {
4006 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed);
4007 let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
4008 // No commitment_signed so get_event_msg's assert(len == 1) passes
4009 check_added_monitors!(nodes[1], 1);
4011 if messages_delivered >= 5 {
4012 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
4013 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4014 check_added_monitors!(nodes[0], 1);
4021 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id());
4022 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
4023 if messages_delivered < 2 {
4024 let mut reconnect_args = ReconnectArgs::new(&nodes[0], &nodes[1]);
4025 reconnect_args.pending_htlc_claims.0 = 1;
4026 reconnect_nodes(reconnect_args);
4027 if messages_delivered < 1 {
4028 expect_payment_sent!(nodes[0], payment_preimage_1);
4030 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4032 } else if messages_delivered == 2 {
4033 // nodes[0] still wants its RAA + commitment_signed
4034 let mut reconnect_args = ReconnectArgs::new(&nodes[0], &nodes[1]);
4035 reconnect_args.pending_responding_commitment_signed.1 = true;
4036 reconnect_args.pending_raa.1 = true;
4037 reconnect_nodes(reconnect_args);
4038 } else if messages_delivered == 3 {
4039 // nodes[0] still wants its commitment_signed
4040 let mut reconnect_args = ReconnectArgs::new(&nodes[0], &nodes[1]);
4041 reconnect_args.pending_responding_commitment_signed.1 = true;
4042 reconnect_nodes(reconnect_args);
4043 } else if messages_delivered == 4 {
4044 // nodes[1] still wants its final RAA
4045 let mut reconnect_args = ReconnectArgs::new(&nodes[0], &nodes[1]);
4046 reconnect_args.pending_raa.0 = true;
4047 reconnect_nodes(reconnect_args);
4048 } else if messages_delivered == 5 {
4049 // Everything was delivered...
4050 reconnect_nodes(ReconnectArgs::new(&nodes[0], &nodes[1]));
4053 if messages_delivered == 1 || messages_delivered == 2 {
4054 expect_payment_path_successful!(nodes[0]);
4056 if messages_delivered <= 5 {
4057 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id());
4058 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
4060 reconnect_nodes(ReconnectArgs::new(&nodes[0], &nodes[1]));
4062 if messages_delivered > 2 {
4063 expect_payment_path_successful!(nodes[0]);
4066 // Channel should still work fine...
4067 let (route, _, _, _) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
4068 let payment_preimage_2 = send_along_route(&nodes[0], route, &[&nodes[1]], 1000000).0;
4069 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
4073 fn test_drop_messages_peer_disconnect_a() {
4074 do_test_drop_messages_peer_disconnect(0, true);
4075 do_test_drop_messages_peer_disconnect(0, false);
4076 do_test_drop_messages_peer_disconnect(1, false);
4077 do_test_drop_messages_peer_disconnect(2, false);
4081 fn test_drop_messages_peer_disconnect_b() {
4082 do_test_drop_messages_peer_disconnect(3, false);
4083 do_test_drop_messages_peer_disconnect(4, false);
4084 do_test_drop_messages_peer_disconnect(5, false);
4085 do_test_drop_messages_peer_disconnect(6, false);
4089 fn test_channel_ready_without_best_block_updated() {
4090 // Previously, if we were offline when a funding transaction was locked in, and then we came
4091 // back online, calling best_block_updated once followed by transactions_confirmed, we'd not
4092 // generate a channel_ready until a later best_block_updated. This tests that we generate the
4093 // channel_ready immediately instead.
4094 let chanmon_cfgs = create_chanmon_cfgs(2);
4095 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4096 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4097 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4098 *nodes[0].connect_style.borrow_mut() = ConnectStyle::BestBlockFirstSkippingBlocks;
4100 let funding_tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 1_000_000, 0);
4102 let conf_height = nodes[0].best_block_info().1 + 1;
4103 connect_blocks(&nodes[0], CHAN_CONFIRM_DEPTH);
4104 let block_txn = [funding_tx];
4105 let conf_txn: Vec<_> = block_txn.iter().enumerate().collect();
4106 let conf_block_header = nodes[0].get_block_header(conf_height);
4107 nodes[0].node.transactions_confirmed(&conf_block_header, &conf_txn[..], conf_height);
4109 // Ensure nodes[0] generates a channel_ready after the transactions_confirmed
4110 let as_channel_ready = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReady, nodes[1].node.get_our_node_id());
4111 nodes[1].node.handle_channel_ready(&nodes[0].node.get_our_node_id(), &as_channel_ready);
4115 fn test_channel_monitor_skipping_block_when_channel_manager_is_leading() {
4116 let chanmon_cfgs = create_chanmon_cfgs(2);
4117 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4118 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4119 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4121 // Let channel_manager get ahead of chain_monitor by 1 block.
4122 // This is to emulate race-condition where newly added channel_monitor skips processing 1 block,
4123 // in case where client calls block_connect on channel_manager first and then on chain_monitor.
4124 let height_1 = nodes[0].best_block_info().1 + 1;
4125 let mut block_1 = create_dummy_block(nodes[0].best_block_hash(), height_1, Vec::new());
4127 nodes[0].blocks.lock().unwrap().push((block_1.clone(), height_1));
4128 nodes[0].node.block_connected(&block_1, height_1);
4130 // Create channel, and it gets added to chain_monitor in funding_created.
4131 let funding_tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 1_000_000, 0);
4133 // Now, newly added channel_monitor in chain_monitor hasn't processed block_1,
4134 // but it's best_block is block_1, since that was populated by channel_manager, and channel_manager
4135 // was running ahead of chain_monitor at the time of funding_created.
4136 // Later on, subsequent blocks are connected to both channel_manager and chain_monitor.
4137 // Hence, this channel's channel_monitor skipped block_1, directly tries to process subsequent blocks.
4138 confirm_transaction_at(&nodes[0], &funding_tx, nodes[0].best_block_info().1 + 1);
4139 connect_blocks(&nodes[0], CHAN_CONFIRM_DEPTH);
4141 // Ensure nodes[0] generates a channel_ready after the transactions_confirmed
4142 let as_channel_ready = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReady, nodes[1].node.get_our_node_id());
4143 nodes[1].node.handle_channel_ready(&nodes[0].node.get_our_node_id(), &as_channel_ready);
4147 fn test_channel_monitor_skipping_block_when_channel_manager_is_lagging() {
4148 let chanmon_cfgs = create_chanmon_cfgs(2);
4149 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4150 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4151 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4153 // Let chain_monitor get ahead of channel_manager by 1 block.
4154 // This is to emulate race-condition where newly added channel_monitor skips processing 1 block,
4155 // in case where client calls block_connect on chain_monitor first and then on channel_manager.
4156 let height_1 = nodes[0].best_block_info().1 + 1;
4157 let mut block_1 = create_dummy_block(nodes[0].best_block_hash(), height_1, Vec::new());
4159 nodes[0].blocks.lock().unwrap().push((block_1.clone(), height_1));
4160 nodes[0].chain_monitor.chain_monitor.block_connected(&block_1, height_1);
4162 // Create channel, and it gets added to chain_monitor in funding_created.
4163 let funding_tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 1_000_000, 0);
4165 // channel_manager can't really skip block_1, it should get it eventually.
4166 nodes[0].node.block_connected(&block_1, height_1);
4168 // Now, newly added channel_monitor in chain_monitor hasn't processed block_1, it's best_block is
4169 // the block before block_1, since that was populated by channel_manager, and channel_manager was
4170 // running behind at the time of funding_created.
4171 // Later on, subsequent blocks are connected to both channel_manager and chain_monitor.
4172 // Hence, this channel's channel_monitor skipped block_1, directly tries to process subsequent blocks.
4173 confirm_transaction_at(&nodes[0], &funding_tx, nodes[0].best_block_info().1 + 1);
4174 connect_blocks(&nodes[0], CHAN_CONFIRM_DEPTH);
4176 // Ensure nodes[0] generates a channel_ready after the transactions_confirmed
4177 let as_channel_ready = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReady, nodes[1].node.get_our_node_id());
4178 nodes[1].node.handle_channel_ready(&nodes[0].node.get_our_node_id(), &as_channel_ready);
4182 fn test_drop_messages_peer_disconnect_dual_htlc() {
4183 // Test that we can handle reconnecting when both sides of a channel have pending
4184 // commitment_updates when we disconnect.
4185 let chanmon_cfgs = create_chanmon_cfgs(2);
4186 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4187 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4188 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4189 create_announced_chan_between_nodes(&nodes, 0, 1);
4191 let (payment_preimage_1, payment_hash_1, ..) = route_payment(&nodes[0], &[&nodes[1]], 1_000_000);
4193 // Now try to send a second payment which will fail to send
4194 let (route, payment_hash_2, payment_preimage_2, payment_secret_2) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
4195 nodes[0].node.send_payment_with_route(&route, payment_hash_2,
4196 RecipientOnionFields::secret_only(payment_secret_2), PaymentId(payment_hash_2.0)).unwrap();
4197 check_added_monitors!(nodes[0], 1);
4199 let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
4200 assert_eq!(events_1.len(), 1);
4202 MessageSendEvent::UpdateHTLCs { .. } => {},
4203 _ => panic!("Unexpected event"),
4206 nodes[1].node.claim_funds(payment_preimage_1);
4207 expect_payment_claimed!(nodes[1], payment_hash_1, 1_000_000);
4208 check_added_monitors!(nodes[1], 1);
4210 let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
4211 assert_eq!(events_2.len(), 1);
4213 MessageSendEvent::UpdateHTLCs { ref node_id, updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fulfill_htlcs, ref update_fail_htlcs, ref update_fail_malformed_htlcs, ref update_fee, ref commitment_signed } } => {
4214 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
4215 assert!(update_add_htlcs.is_empty());
4216 assert_eq!(update_fulfill_htlcs.len(), 1);
4217 assert!(update_fail_htlcs.is_empty());
4218 assert!(update_fail_malformed_htlcs.is_empty());
4219 assert!(update_fee.is_none());
4221 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlcs[0]);
4222 let events_3 = nodes[0].node.get_and_clear_pending_events();
4223 assert_eq!(events_3.len(), 1);
4225 Event::PaymentSent { ref payment_preimage, ref payment_hash, .. } => {
4226 assert_eq!(*payment_preimage, payment_preimage_1);
4227 assert_eq!(*payment_hash, payment_hash_1);
4229 _ => panic!("Unexpected event"),
4232 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), commitment_signed);
4233 let _ = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
4234 // No commitment_signed so get_event_msg's assert(len == 1) passes
4235 check_added_monitors!(nodes[0], 1);
4237 _ => panic!("Unexpected event"),
4240 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id());
4241 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
4243 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init {
4244 features: nodes[1].node.init_features(), networks: None, remote_network_address: None
4246 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
4247 assert_eq!(reestablish_1.len(), 1);
4248 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init {
4249 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
4251 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
4252 assert_eq!(reestablish_2.len(), 1);
4254 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
4255 let as_resp = handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
4256 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
4257 let bs_resp = handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
4259 assert!(as_resp.0.is_none());
4260 assert!(bs_resp.0.is_none());
4262 assert!(bs_resp.1.is_none());
4263 assert!(bs_resp.2.is_none());
4265 assert!(as_resp.3 == RAACommitmentOrder::CommitmentFirst);
4267 assert_eq!(as_resp.2.as_ref().unwrap().update_add_htlcs.len(), 1);
4268 assert!(as_resp.2.as_ref().unwrap().update_fulfill_htlcs.is_empty());
4269 assert!(as_resp.2.as_ref().unwrap().update_fail_htlcs.is_empty());
4270 assert!(as_resp.2.as_ref().unwrap().update_fail_malformed_htlcs.is_empty());
4271 assert!(as_resp.2.as_ref().unwrap().update_fee.is_none());
4272 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &as_resp.2.as_ref().unwrap().update_add_htlcs[0]);
4273 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_resp.2.as_ref().unwrap().commitment_signed);
4274 let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
4275 // No commitment_signed so get_event_msg's assert(len == 1) passes
4276 check_added_monitors!(nodes[1], 1);
4278 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), as_resp.1.as_ref().unwrap());
4279 let bs_second_commitment_signed = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4280 assert!(bs_second_commitment_signed.update_add_htlcs.is_empty());
4281 assert!(bs_second_commitment_signed.update_fulfill_htlcs.is_empty());
4282 assert!(bs_second_commitment_signed.update_fail_htlcs.is_empty());
4283 assert!(bs_second_commitment_signed.update_fail_malformed_htlcs.is_empty());
4284 assert!(bs_second_commitment_signed.update_fee.is_none());
4285 check_added_monitors!(nodes[1], 1);
4287 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
4288 let as_commitment_signed = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
4289 assert!(as_commitment_signed.update_add_htlcs.is_empty());
4290 assert!(as_commitment_signed.update_fulfill_htlcs.is_empty());
4291 assert!(as_commitment_signed.update_fail_htlcs.is_empty());
4292 assert!(as_commitment_signed.update_fail_malformed_htlcs.is_empty());
4293 assert!(as_commitment_signed.update_fee.is_none());
4294 check_added_monitors!(nodes[0], 1);
4296 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_commitment_signed.commitment_signed);
4297 let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
4298 // No commitment_signed so get_event_msg's assert(len == 1) passes
4299 check_added_monitors!(nodes[0], 1);
4301 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed.commitment_signed);
4302 let bs_second_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
4303 // No commitment_signed so get_event_msg's assert(len == 1) passes
4304 check_added_monitors!(nodes[1], 1);
4306 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
4307 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4308 check_added_monitors!(nodes[1], 1);
4310 expect_pending_htlcs_forwardable!(nodes[1]);
4312 let events_5 = nodes[1].node.get_and_clear_pending_events();
4313 assert_eq!(events_5.len(), 1);
4315 Event::PaymentClaimable { ref payment_hash, ref purpose, .. } => {
4316 assert_eq!(payment_hash_2, *payment_hash);
4318 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
4319 assert!(payment_preimage.is_none());
4320 assert_eq!(payment_secret_2, *payment_secret);
4322 _ => panic!("expected PaymentPurpose::InvoicePayment")
4325 _ => panic!("Unexpected event"),
4328 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke_and_ack);
4329 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4330 check_added_monitors!(nodes[0], 1);
4332 expect_payment_path_successful!(nodes[0]);
4333 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
4336 fn do_test_htlc_timeout(send_partial_mpp: bool) {
4337 // If the user fails to claim/fail an HTLC within the HTLC CLTV timeout we fail it for them
4338 // to avoid our counterparty failing the channel.
4339 let chanmon_cfgs = create_chanmon_cfgs(2);
4340 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4341 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4342 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4344 create_announced_chan_between_nodes(&nodes, 0, 1);
4346 let our_payment_hash = if send_partial_mpp {
4347 let (route, our_payment_hash, _, payment_secret) = get_route_and_payment_hash!(&nodes[0], nodes[1], 100000);
4348 // Use the utility function send_payment_along_path to send the payment with MPP data which
4349 // indicates there are more HTLCs coming.
4350 let cur_height = CHAN_CONFIRM_DEPTH + 1; // route_payment calls send_payment, which adds 1 to the current height. So we do the same here to match.
4351 let payment_id = PaymentId([42; 32]);
4352 let session_privs = nodes[0].node.test_add_new_pending_payment(our_payment_hash,
4353 RecipientOnionFields::secret_only(payment_secret), payment_id, &route).unwrap();
4354 nodes[0].node.test_send_payment_along_path(&route.paths[0], &our_payment_hash,
4355 RecipientOnionFields::secret_only(payment_secret), 200_000, cur_height, payment_id,
4356 &None, session_privs[0]).unwrap();
4357 check_added_monitors!(nodes[0], 1);
4358 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
4359 assert_eq!(events.len(), 1);
4360 // Now do the relevant commitment_signed/RAA dances along the path, noting that the final
4361 // hop should *not* yet generate any PaymentClaimable event(s).
4362 pass_along_path(&nodes[0], &[&nodes[1]], 100000, our_payment_hash, Some(payment_secret), events.drain(..).next().unwrap(), false, None);
4365 route_payment(&nodes[0], &[&nodes[1]], 100000).1
4368 let mut block = create_dummy_block(nodes[0].best_block_hash(), 42, Vec::new());
4369 connect_block(&nodes[0], &block);
4370 connect_block(&nodes[1], &block);
4371 let block_count = TEST_FINAL_CLTV + CHAN_CONFIRM_DEPTH + 2 - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS;
4372 for _ in CHAN_CONFIRM_DEPTH + 2..block_count {
4373 block.header.prev_blockhash = block.block_hash();
4374 connect_block(&nodes[0], &block);
4375 connect_block(&nodes[1], &block);
4378 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash: our_payment_hash }]);
4380 check_added_monitors!(nodes[1], 1);
4381 let htlc_timeout_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4382 assert!(htlc_timeout_updates.update_add_htlcs.is_empty());
4383 assert_eq!(htlc_timeout_updates.update_fail_htlcs.len(), 1);
4384 assert!(htlc_timeout_updates.update_fail_malformed_htlcs.is_empty());
4385 assert!(htlc_timeout_updates.update_fee.is_none());
4387 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_timeout_updates.update_fail_htlcs[0]);
4388 commitment_signed_dance!(nodes[0], nodes[1], htlc_timeout_updates.commitment_signed, false);
4389 // 100_000 msat as u64, followed by the height at which we failed back above
4390 let mut expected_failure_data = (100_000 as u64).to_be_bytes().to_vec();
4391 expected_failure_data.extend_from_slice(&(block_count - 1).to_be_bytes());
4392 expect_payment_failed!(nodes[0], our_payment_hash, true, 0x4000 | 15, &expected_failure_data[..]);
4396 fn test_htlc_timeout() {
4397 do_test_htlc_timeout(true);
4398 do_test_htlc_timeout(false);
4401 fn do_test_holding_cell_htlc_add_timeouts(forwarded_htlc: bool) {
4402 // Tests that HTLCs in the holding cell are timed out after the requisite number of blocks.
4403 let chanmon_cfgs = create_chanmon_cfgs(3);
4404 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
4405 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
4406 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
4407 create_announced_chan_between_nodes(&nodes, 0, 1);
4408 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
4410 // Make sure all nodes are at the same starting height
4411 connect_blocks(&nodes[0], 2*CHAN_CONFIRM_DEPTH + 1 - nodes[0].best_block_info().1);
4412 connect_blocks(&nodes[1], 2*CHAN_CONFIRM_DEPTH + 1 - nodes[1].best_block_info().1);
4413 connect_blocks(&nodes[2], 2*CHAN_CONFIRM_DEPTH + 1 - nodes[2].best_block_info().1);
4415 // Route a first payment to get the 1 -> 2 channel in awaiting_raa...
4416 let (route, first_payment_hash, _, first_payment_secret) = get_route_and_payment_hash!(nodes[1], nodes[2], 100000);
4417 nodes[1].node.send_payment_with_route(&route, first_payment_hash,
4418 RecipientOnionFields::secret_only(first_payment_secret), PaymentId(first_payment_hash.0)).unwrap();
4419 assert_eq!(nodes[1].node.get_and_clear_pending_msg_events().len(), 1);
4420 check_added_monitors!(nodes[1], 1);
4422 // Now attempt to route a second payment, which should be placed in the holding cell
4423 let sending_node = if forwarded_htlc { &nodes[0] } else { &nodes[1] };
4424 let (route, second_payment_hash, _, second_payment_secret) = get_route_and_payment_hash!(sending_node, nodes[2], 100000);
4425 sending_node.node.send_payment_with_route(&route, second_payment_hash,
4426 RecipientOnionFields::secret_only(second_payment_secret), PaymentId(second_payment_hash.0)).unwrap();
4428 check_added_monitors!(nodes[0], 1);
4429 let payment_event = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
4430 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
4431 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
4432 expect_pending_htlcs_forwardable!(nodes[1]);
4434 check_added_monitors!(nodes[1], 0);
4436 connect_blocks(&nodes[1], TEST_FINAL_CLTV - LATENCY_GRACE_PERIOD_BLOCKS);
4437 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4438 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
4439 connect_blocks(&nodes[1], 1);
4442 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], vec![HTLCDestination::NextHopChannel { node_id: Some(nodes[2].node.get_our_node_id()), channel_id: chan_2.2 }]);
4443 check_added_monitors!(nodes[1], 1);
4444 let fail_commit = nodes[1].node.get_and_clear_pending_msg_events();
4445 assert_eq!(fail_commit.len(), 1);
4446 match fail_commit[0] {
4447 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fail_htlcs, ref commitment_signed, .. }, .. } => {
4448 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
4449 commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, true, true);
4451 _ => unreachable!(),
4453 expect_payment_failed_with_update!(nodes[0], second_payment_hash, false, chan_2.0.contents.short_channel_id, false);
4455 expect_payment_failed!(nodes[1], second_payment_hash, false);
4460 fn test_holding_cell_htlc_add_timeouts() {
4461 do_test_holding_cell_htlc_add_timeouts(false);
4462 do_test_holding_cell_htlc_add_timeouts(true);
4465 macro_rules! check_spendable_outputs {
4466 ($node: expr, $keysinterface: expr) => {
4468 let mut events = $node.chain_monitor.chain_monitor.get_and_clear_pending_events();
4469 let mut txn = Vec::new();
4470 let mut all_outputs = Vec::new();
4471 let secp_ctx = Secp256k1::new();
4472 for event in events.drain(..) {
4474 Event::SpendableOutputs { mut outputs, channel_id: _ } => {
4475 for outp in outputs.drain(..) {
4476 txn.push($keysinterface.backing.spend_spendable_outputs(&[&outp], Vec::new(), Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(), 253, None, &secp_ctx).unwrap());
4477 all_outputs.push(outp);
4480 _ => panic!("Unexpected event"),
4483 if all_outputs.len() > 1 {
4484 if let Ok(tx) = $keysinterface.backing.spend_spendable_outputs(&all_outputs.iter().map(|a| a).collect::<Vec<_>>(), Vec::new(), Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(), 253, None, &secp_ctx) {
4494 fn test_claim_sizeable_push_msat() {
4495 // Incidentally test SpendableOutput event generation due to detection of to_local output on commitment tx
4496 let chanmon_cfgs = create_chanmon_cfgs(2);
4497 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4498 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4499 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4501 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100_000, 98_000_000);
4502 nodes[1].node.force_close_broadcasting_latest_txn(&chan.2, &nodes[0].node.get_our_node_id()).unwrap();
4503 check_closed_broadcast!(nodes[1], true);
4504 check_added_monitors!(nodes[1], 1);
4505 check_closed_event!(nodes[1], 1, ClosureReason::HolderForceClosed, [nodes[0].node.get_our_node_id()], 100000);
4506 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
4507 assert_eq!(node_txn.len(), 1);
4508 check_spends!(node_txn[0], chan.3);
4509 assert_eq!(node_txn[0].output.len(), 2); // We can't force trimming of to_remote output as channel_reserve_satoshis block us to do so at channel opening
4511 mine_transaction(&nodes[1], &node_txn[0]);
4512 connect_blocks(&nodes[1], BREAKDOWN_TIMEOUT as u32 - 1);
4514 let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
4515 assert_eq!(spend_txn.len(), 1);
4516 assert_eq!(spend_txn[0].input.len(), 1);
4517 check_spends!(spend_txn[0], node_txn[0]);
4518 assert_eq!(spend_txn[0].input[0].sequence.0, BREAKDOWN_TIMEOUT as u32);
4522 fn test_claim_on_remote_sizeable_push_msat() {
4523 // Same test as previous, just test on remote commitment tx, as per_commitment_point registration changes following you're funder/fundee and
4524 // to_remote output is encumbered by a P2WPKH
4525 let chanmon_cfgs = create_chanmon_cfgs(2);
4526 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4527 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4528 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4530 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100_000, 98_000_000);
4531 nodes[0].node.force_close_broadcasting_latest_txn(&chan.2, &nodes[1].node.get_our_node_id()).unwrap();
4532 check_closed_broadcast!(nodes[0], true);
4533 check_added_monitors!(nodes[0], 1);
4534 check_closed_event!(nodes[0], 1, ClosureReason::HolderForceClosed, [nodes[1].node.get_our_node_id()], 100000);
4536 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
4537 assert_eq!(node_txn.len(), 1);
4538 check_spends!(node_txn[0], chan.3);
4539 assert_eq!(node_txn[0].output.len(), 2); // We can't force trimming of to_remote output as channel_reserve_satoshis block us to do so at channel opening
4541 mine_transaction(&nodes[1], &node_txn[0]);
4542 check_closed_broadcast!(nodes[1], true);
4543 check_added_monitors!(nodes[1], 1);
4544 check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed, [nodes[0].node.get_our_node_id()], 100000);
4545 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4547 let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
4548 assert_eq!(spend_txn.len(), 1);
4549 check_spends!(spend_txn[0], node_txn[0]);
4553 fn test_claim_on_remote_revoked_sizeable_push_msat() {
4554 // Same test as previous, just test on remote revoked commitment tx, as per_commitment_point registration changes following you're funder/fundee and
4555 // to_remote output is encumbered by a P2WPKH
4557 let chanmon_cfgs = create_chanmon_cfgs(2);
4558 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4559 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4560 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4562 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 59000000);
4563 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4564 let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan.2);
4565 assert_eq!(revoked_local_txn[0].input.len(), 1);
4566 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
4568 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
4569 mine_transaction(&nodes[1], &revoked_local_txn[0]);
4570 check_closed_broadcast!(nodes[1], true);
4571 check_added_monitors!(nodes[1], 1);
4572 check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed, [nodes[0].node.get_our_node_id()], 100000);
4574 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
4575 mine_transaction(&nodes[1], &node_txn[0]);
4576 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4578 let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
4579 assert_eq!(spend_txn.len(), 3);
4580 check_spends!(spend_txn[0], revoked_local_txn[0]); // to_remote output on revoked remote commitment_tx
4581 check_spends!(spend_txn[1], node_txn[0]);
4582 check_spends!(spend_txn[2], revoked_local_txn[0], node_txn[0]); // Both outputs
4586 fn test_static_spendable_outputs_preimage_tx() {
4587 let chanmon_cfgs = create_chanmon_cfgs(2);
4588 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4589 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4590 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4592 // Create some initial channels
4593 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
4595 let (payment_preimage, payment_hash, ..) = route_payment(&nodes[0], &[&nodes[1]], 3_000_000);
4597 let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
4598 assert_eq!(commitment_tx[0].input.len(), 1);
4599 assert_eq!(commitment_tx[0].input[0].previous_output.txid, chan_1.3.txid());
4601 // Settle A's commitment tx on B's chain
4602 nodes[1].node.claim_funds(payment_preimage);
4603 expect_payment_claimed!(nodes[1], payment_hash, 3_000_000);
4604 check_added_monitors!(nodes[1], 1);
4605 mine_transaction(&nodes[1], &commitment_tx[0]);
4606 check_added_monitors!(nodes[1], 1);
4607 let events = nodes[1].node.get_and_clear_pending_msg_events();
4609 MessageSendEvent::UpdateHTLCs { .. } => {},
4610 _ => panic!("Unexpected event"),
4613 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
4614 _ => panic!("Unexepected event"),
4617 // Check B's monitor was able to send back output descriptor event for preimage tx on A's commitment tx
4618 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelMonitor: preimage tx
4619 assert_eq!(node_txn.len(), 1);
4620 check_spends!(node_txn[0], commitment_tx[0]);
4621 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
4623 mine_transaction(&nodes[1], &node_txn[0]);
4624 check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed, [nodes[0].node.get_our_node_id()], 100000);
4625 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4627 let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
4628 assert_eq!(spend_txn.len(), 1);
4629 check_spends!(spend_txn[0], node_txn[0]);
4633 fn test_static_spendable_outputs_timeout_tx() {
4634 let chanmon_cfgs = create_chanmon_cfgs(2);
4635 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4636 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4637 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4639 // Create some initial channels
4640 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
4642 // Rebalance the network a bit by relaying one payment through all the channels ...
4643 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
4645 let (_, our_payment_hash, ..) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3_000_000);
4647 let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
4648 assert_eq!(commitment_tx[0].input.len(), 1);
4649 assert_eq!(commitment_tx[0].input[0].previous_output.txid, chan_1.3.txid());
4651 // Settle A's commitment tx on B' chain
4652 mine_transaction(&nodes[1], &commitment_tx[0]);
4653 check_added_monitors!(nodes[1], 1);
4654 let events = nodes[1].node.get_and_clear_pending_msg_events();
4656 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
4657 _ => panic!("Unexpected event"),
4659 connect_blocks(&nodes[1], TEST_FINAL_CLTV); // Confirm blocks until the HTLC expires
4661 // Check B's monitor was able to send back output descriptor event for timeout tx on A's commitment tx
4662 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
4663 assert_eq!(node_txn.len(), 1); // ChannelMonitor: timeout tx
4664 check_spends!(node_txn[0], commitment_tx[0].clone());
4665 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4667 mine_transaction(&nodes[1], &node_txn[0]);
4668 check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed, [nodes[0].node.get_our_node_id()], 100000);
4669 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4670 expect_payment_failed!(nodes[1], our_payment_hash, false);
4672 let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
4673 assert_eq!(spend_txn.len(), 3); // SpendableOutput: remote_commitment_tx.to_remote, timeout_tx.output
4674 check_spends!(spend_txn[0], commitment_tx[0]);
4675 check_spends!(spend_txn[1], node_txn[0]);
4676 check_spends!(spend_txn[2], node_txn[0], commitment_tx[0]); // All outputs
4680 fn test_static_spendable_outputs_justice_tx_revoked_commitment_tx() {
4681 let chanmon_cfgs = create_chanmon_cfgs(2);
4682 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4683 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4684 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4686 // Create some initial channels
4687 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
4689 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4690 let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
4691 assert_eq!(revoked_local_txn[0].input.len(), 1);
4692 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
4694 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
4696 mine_transaction(&nodes[1], &revoked_local_txn[0]);
4697 check_closed_broadcast!(nodes[1], true);
4698 check_added_monitors!(nodes[1], 1);
4699 check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed, [nodes[0].node.get_our_node_id()], 100000);
4701 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
4702 assert_eq!(node_txn.len(), 1);
4703 assert_eq!(node_txn[0].input.len(), 2);
4704 check_spends!(node_txn[0], revoked_local_txn[0]);
4706 mine_transaction(&nodes[1], &node_txn[0]);
4707 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4709 let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
4710 assert_eq!(spend_txn.len(), 1);
4711 check_spends!(spend_txn[0], node_txn[0]);
4715 fn test_static_spendable_outputs_justice_tx_revoked_htlc_timeout_tx() {
4716 let mut chanmon_cfgs = create_chanmon_cfgs(2);
4717 chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
4718 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4719 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4720 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4722 // Create some initial channels
4723 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
4725 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4726 let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
4727 assert_eq!(revoked_local_txn[0].input.len(), 1);
4728 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
4730 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
4732 // A will generate HTLC-Timeout from revoked commitment tx
4733 mine_transaction(&nodes[0], &revoked_local_txn[0]);
4734 check_closed_broadcast!(nodes[0], true);
4735 check_added_monitors!(nodes[0], 1);
4736 check_closed_event!(nodes[0], 1, ClosureReason::CommitmentTxConfirmed, [nodes[1].node.get_our_node_id()], 100000);
4737 connect_blocks(&nodes[0], TEST_FINAL_CLTV); // Confirm blocks until the HTLC expires
4739 let revoked_htlc_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
4740 assert_eq!(revoked_htlc_txn.len(), 1);
4741 assert_eq!(revoked_htlc_txn[0].input.len(), 1);
4742 assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
4743 check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
4744 assert_ne!(revoked_htlc_txn[0].lock_time, LockTime::ZERO); // HTLC-Timeout
4746 // B will generate justice tx from A's revoked commitment/HTLC tx
4747 connect_block(&nodes[1], &create_dummy_block(nodes[1].best_block_hash(), 42, vec![revoked_local_txn[0].clone(), revoked_htlc_txn[0].clone()]));
4748 check_closed_broadcast!(nodes[1], true);
4749 check_added_monitors!(nodes[1], 1);
4750 check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed, [nodes[0].node.get_our_node_id()], 100000);
4752 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
4753 assert_eq!(node_txn.len(), 2); // ChannelMonitor: bogus justice tx, justice tx on revoked outputs
4754 // The first transaction generated is bogus - it spends both outputs of revoked_local_txn[0]
4755 // including the one already spent by revoked_htlc_txn[1]. That's OK, we'll spend with valid
4756 // transactions next...
4757 assert_eq!(node_txn[0].input.len(), 3);
4758 check_spends!(node_txn[0], revoked_local_txn[0], revoked_htlc_txn[0]);
4760 assert_eq!(node_txn[1].input.len(), 2);
4761 check_spends!(node_txn[1], revoked_local_txn[0], revoked_htlc_txn[0]);
4762 if node_txn[1].input[1].previous_output.txid == revoked_htlc_txn[0].txid() {
4763 assert_ne!(node_txn[1].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
4765 assert_eq!(node_txn[1].input[0].previous_output.txid, revoked_htlc_txn[0].txid());
4766 assert_ne!(node_txn[1].input[1].previous_output, revoked_htlc_txn[0].input[0].previous_output);
4769 mine_transaction(&nodes[1], &node_txn[1]);
4770 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4772 // Check B's ChannelMonitor was able to generate the right spendable output descriptor
4773 let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
4774 assert_eq!(spend_txn.len(), 1);
4775 assert_eq!(spend_txn[0].input.len(), 1);
4776 check_spends!(spend_txn[0], node_txn[1]);
4780 fn test_static_spendable_outputs_justice_tx_revoked_htlc_success_tx() {
4781 let mut chanmon_cfgs = create_chanmon_cfgs(2);
4782 chanmon_cfgs[1].keys_manager.disable_revocation_policy_check = true;
4783 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4784 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4785 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4787 // Create some initial channels
4788 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
4790 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4791 let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan_1.2);
4792 assert_eq!(revoked_local_txn[0].input.len(), 1);
4793 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
4795 // The to-be-revoked commitment tx should have one HTLC and one to_remote output
4796 assert_eq!(revoked_local_txn[0].output.len(), 2);
4798 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
4800 // B will generate HTLC-Success from revoked commitment tx
4801 mine_transaction(&nodes[1], &revoked_local_txn[0]);
4802 check_closed_broadcast!(nodes[1], true);
4803 check_added_monitors!(nodes[1], 1);
4804 check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed, [nodes[0].node.get_our_node_id()], 100000);
4805 let revoked_htlc_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
4807 assert_eq!(revoked_htlc_txn.len(), 1);
4808 assert_eq!(revoked_htlc_txn[0].input.len(), 1);
4809 assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4810 check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
4812 // Check that the unspent (of two) outputs on revoked_local_txn[0] is a P2WPKH:
4813 let unspent_local_txn_output = revoked_htlc_txn[0].input[0].previous_output.vout as usize ^ 1;
4814 assert_eq!(revoked_local_txn[0].output[unspent_local_txn_output].script_pubkey.len(), 2 + 20); // P2WPKH
4816 // A will generate justice tx from B's revoked commitment/HTLC tx
4817 connect_block(&nodes[0], &create_dummy_block(nodes[0].best_block_hash(), 42, vec![revoked_local_txn[0].clone(), revoked_htlc_txn[0].clone()]));
4818 check_closed_broadcast!(nodes[0], true);
4819 check_added_monitors!(nodes[0], 1);
4820 check_closed_event!(nodes[0], 1, ClosureReason::CommitmentTxConfirmed, [nodes[1].node.get_our_node_id()], 100000);
4822 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
4823 assert_eq!(node_txn.len(), 2); // ChannelMonitor: justice tx on revoked commitment, justice tx on revoked HTLC-success
4825 // The first transaction generated is bogus - it spends both outputs of revoked_local_txn[0]
4826 // including the one already spent by revoked_htlc_txn[0]. That's OK, we'll spend with valid
4827 // transactions next...
4828 assert_eq!(node_txn[0].input.len(), 2);
4829 check_spends!(node_txn[0], revoked_local_txn[0], revoked_htlc_txn[0]);
4830 if node_txn[0].input[1].previous_output.txid == revoked_htlc_txn[0].txid() {
4831 assert_eq!(node_txn[0].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
4833 assert_eq!(node_txn[0].input[0].previous_output.txid, revoked_htlc_txn[0].txid());
4834 assert_eq!(node_txn[0].input[1].previous_output, revoked_htlc_txn[0].input[0].previous_output);
4837 assert_eq!(node_txn[1].input.len(), 1);
4838 check_spends!(node_txn[1], revoked_htlc_txn[0]);
4840 mine_transaction(&nodes[0], &node_txn[1]);
4841 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
4843 // Note that nodes[0]'s tx_broadcaster is still locked, so if we get here the channelmonitor
4844 // didn't try to generate any new transactions.
4846 // Check A's ChannelMonitor was able to generate the right spendable output descriptor
4847 let spend_txn = check_spendable_outputs!(nodes[0], node_cfgs[0].keys_manager);
4848 assert_eq!(spend_txn.len(), 3);
4849 assert_eq!(spend_txn[0].input.len(), 1);
4850 check_spends!(spend_txn[0], revoked_local_txn[0]); // spending to_remote output from revoked local tx
4851 assert_ne!(spend_txn[0].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
4852 check_spends!(spend_txn[1], node_txn[1]); // spending justice tx output on the htlc success tx
4853 check_spends!(spend_txn[2], revoked_local_txn[0], node_txn[1]); // Both outputs
4857 fn test_onchain_to_onchain_claim() {
4858 // Test that in case of channel closure, we detect the state of output and claim HTLC
4859 // on downstream peer's remote commitment tx.
4860 // First, have C claim an HTLC against its own latest commitment transaction.
4861 // Then, broadcast these to B, which should update the monitor downstream on the A<->B
4863 // Finally, check that B will claim the HTLC output if A's latest commitment transaction
4866 let chanmon_cfgs = create_chanmon_cfgs(3);
4867 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
4868 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
4869 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
4871 // Create some initial channels
4872 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
4873 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
4875 // Ensure all nodes are at the same height
4876 let node_max_height = nodes.iter().map(|node| node.blocks.lock().unwrap().len()).max().unwrap() as u32;
4877 connect_blocks(&nodes[0], node_max_height - nodes[0].best_block_info().1);
4878 connect_blocks(&nodes[1], node_max_height - nodes[1].best_block_info().1);
4879 connect_blocks(&nodes[2], node_max_height - nodes[2].best_block_info().1);
4881 // Rebalance the network a bit by relaying one payment through all the channels ...
4882 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
4883 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
4885 let (payment_preimage, payment_hash, ..) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3_000_000);
4886 let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
4887 check_spends!(commitment_tx[0], chan_2.3);
4888 nodes[2].node.claim_funds(payment_preimage);
4889 expect_payment_claimed!(nodes[2], payment_hash, 3_000_000);
4890 check_added_monitors!(nodes[2], 1);
4891 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
4892 assert!(updates.update_add_htlcs.is_empty());
4893 assert!(updates.update_fail_htlcs.is_empty());
4894 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
4895 assert!(updates.update_fail_malformed_htlcs.is_empty());
4897 mine_transaction(&nodes[2], &commitment_tx[0]);
4898 check_closed_broadcast!(nodes[2], true);
4899 check_added_monitors!(nodes[2], 1);
4900 check_closed_event!(nodes[2], 1, ClosureReason::CommitmentTxConfirmed, [nodes[1].node.get_our_node_id()], 100000);
4902 let c_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelMonitor: 1 (HTLC-Success tx)
4903 assert_eq!(c_txn.len(), 1);
4904 check_spends!(c_txn[0], commitment_tx[0]);
4905 assert_eq!(c_txn[0].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4906 assert!(c_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
4907 assert_eq!(c_txn[0].lock_time, LockTime::ZERO); // Success tx
4909 // So we broadcast C's commitment tx and HTLC-Success on B's chain, we should successfully be able to extract preimage and update downstream monitor
4910 connect_block(&nodes[1], &create_dummy_block(nodes[1].best_block_hash(), 42, vec![commitment_tx[0].clone(), c_txn[0].clone()]));
4911 check_added_monitors!(nodes[1], 1);
4912 let events = nodes[1].node.get_and_clear_pending_events();
4913 assert_eq!(events.len(), 2);
4915 Event::ChannelClosed { reason: ClosureReason::CommitmentTxConfirmed, .. } => {}
4916 _ => panic!("Unexpected event"),
4919 Event::PaymentForwarded { fee_earned_msat, prev_channel_id, claim_from_onchain_tx, next_channel_id, outbound_amount_forwarded_msat } => {
4920 assert_eq!(fee_earned_msat, Some(1000));
4921 assert_eq!(prev_channel_id, Some(chan_1.2));
4922 assert_eq!(claim_from_onchain_tx, true);
4923 assert_eq!(next_channel_id, Some(chan_2.2));
4924 assert_eq!(outbound_amount_forwarded_msat, Some(3000000));
4926 _ => panic!("Unexpected event"),
4928 check_added_monitors!(nodes[1], 1);
4929 let mut msg_events = nodes[1].node.get_and_clear_pending_msg_events();
4930 assert_eq!(msg_events.len(), 3);
4931 let nodes_2_event = remove_first_msg_event_to_node(&nodes[2].node.get_our_node_id(), &mut msg_events);
4932 let nodes_0_event = remove_first_msg_event_to_node(&nodes[0].node.get_our_node_id(), &mut msg_events);
4934 match nodes_2_event {
4935 MessageSendEvent::HandleError { action: ErrorAction::DisconnectPeer { .. }, node_id: _ } => {},
4936 _ => panic!("Unexpected event"),
4939 match nodes_0_event {
4940 MessageSendEvent::UpdateHTLCs { ref node_id, updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fulfill_htlcs, ref update_fail_htlcs, ref update_fail_malformed_htlcs, .. } } => {
4941 assert!(update_add_htlcs.is_empty());
4942 assert!(update_fail_htlcs.is_empty());
4943 assert_eq!(update_fulfill_htlcs.len(), 1);
4944 assert!(update_fail_malformed_htlcs.is_empty());
4945 assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
4947 _ => panic!("Unexpected event"),
4950 // Ensure that the last remaining message event is the BroadcastChannelUpdate msg for chan_2
4951 match msg_events[0] {
4952 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
4953 _ => panic!("Unexpected event"),
4956 // Broadcast A's commitment tx on B's chain to see if we are able to claim inbound HTLC with our HTLC-Success tx
4957 let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
4958 mine_transaction(&nodes[1], &commitment_tx[0]);
4959 check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed, [nodes[0].node.get_our_node_id()], 100000);
4960 let b_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
4961 // ChannelMonitor: HTLC-Success tx
4962 assert_eq!(b_txn.len(), 1);
4963 check_spends!(b_txn[0], commitment_tx[0]);
4964 assert_eq!(b_txn[0].input[0].witness.clone().last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
4965 assert!(b_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
4966 assert_eq!(b_txn[0].lock_time.to_consensus_u32(), nodes[1].best_block_info().1); // Success tx
4968 check_closed_broadcast!(nodes[1], true);
4969 check_added_monitors!(nodes[1], 1);
4973 fn test_duplicate_payment_hash_one_failure_one_success() {
4974 // Topology : A --> B --> C --> D
4975 // We route 2 payments with same hash between B and C, one will be timeout, the other successfully claim
4976 // Note that because C will refuse to generate two payment secrets for the same payment hash,
4977 // we forward one of the payments onwards to D.
4978 let chanmon_cfgs = create_chanmon_cfgs(4);
4979 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
4980 // When this test was written, the default base fee floated based on the HTLC count.
4981 // It is now fixed, so we simply set the fee to the expected value here.
4982 let mut config = test_default_channel_config();
4983 config.channel_config.forwarding_fee_base_msat = 196;
4984 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs,
4985 &[Some(config.clone()), Some(config.clone()), Some(config.clone()), Some(config.clone())]);
4986 let mut nodes = create_network(4, &node_cfgs, &node_chanmgrs);
4988 create_announced_chan_between_nodes(&nodes, 0, 1);
4989 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
4990 create_announced_chan_between_nodes(&nodes, 2, 3);
4992 let node_max_height = nodes.iter().map(|node| node.blocks.lock().unwrap().len()).max().unwrap() as u32;
4993 connect_blocks(&nodes[0], node_max_height - nodes[0].best_block_info().1);
4994 connect_blocks(&nodes[1], node_max_height - nodes[1].best_block_info().1);
4995 connect_blocks(&nodes[2], node_max_height - nodes[2].best_block_info().1);
4996 connect_blocks(&nodes[3], node_max_height - nodes[3].best_block_info().1);
4998 let (our_payment_preimage, duplicate_payment_hash, ..) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 900_000);
5000 let payment_secret = nodes[3].node.create_inbound_payment_for_hash(duplicate_payment_hash, None, 7200, None).unwrap();
5001 // We reduce the final CLTV here by a somewhat arbitrary constant to keep it under the one-byte
5002 // script push size limit so that the below script length checks match
5003 // ACCEPTED_HTLC_SCRIPT_WEIGHT.
5004 let payment_params = PaymentParameters::from_node_id(nodes[3].node.get_our_node_id(), TEST_FINAL_CLTV - 40)
5005 .with_bolt11_features(nodes[3].node.bolt11_invoice_features()).unwrap();
5006 let (route, _, _, _) = get_route_and_payment_hash!(nodes[0], nodes[3], payment_params, 800_000);
5007 send_along_route_with_secret(&nodes[0], route, &[&[&nodes[1], &nodes[2], &nodes[3]]], 800_000, duplicate_payment_hash, payment_secret);
5009 let commitment_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
5010 assert_eq!(commitment_txn[0].input.len(), 1);
5011 check_spends!(commitment_txn[0], chan_2.3);
5013 mine_transaction(&nodes[1], &commitment_txn[0]);
5014 check_closed_broadcast!(nodes[1], true);
5015 check_added_monitors!(nodes[1], 1);
5016 check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed, [nodes[2].node.get_our_node_id()], 100000);
5017 connect_blocks(&nodes[1], TEST_FINAL_CLTV - 40 + MIN_CLTV_EXPIRY_DELTA as u32); // Confirm blocks until the HTLC expires
5019 let htlc_timeout_tx;
5020 { // Extract one of the two HTLC-Timeout transaction
5021 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5022 // ChannelMonitor: timeout tx * 2-or-3
5023 assert!(node_txn.len() == 2 || node_txn.len() == 3);
5025 check_spends!(node_txn[0], commitment_txn[0]);
5026 assert_eq!(node_txn[0].input.len(), 1);
5027 assert_eq!(node_txn[0].output.len(), 1);
5029 if node_txn.len() > 2 {
5030 check_spends!(node_txn[1], commitment_txn[0]);
5031 assert_eq!(node_txn[1].input.len(), 1);
5032 assert_eq!(node_txn[1].output.len(), 1);
5033 assert_eq!(node_txn[0].input[0].previous_output, node_txn[1].input[0].previous_output);
5035 check_spends!(node_txn[2], commitment_txn[0]);
5036 assert_eq!(node_txn[2].input.len(), 1);
5037 assert_eq!(node_txn[2].output.len(), 1);
5038 assert_ne!(node_txn[0].input[0].previous_output, node_txn[2].input[0].previous_output);
5040 check_spends!(node_txn[1], commitment_txn[0]);
5041 assert_eq!(node_txn[1].input.len(), 1);
5042 assert_eq!(node_txn[1].output.len(), 1);
5043 assert_ne!(node_txn[0].input[0].previous_output, node_txn[1].input[0].previous_output);
5046 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5047 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5048 // Assign htlc_timeout_tx to the forwarded HTLC (with value ~800 sats). The received HTLC
5049 // (with value 900 sats) will be claimed in the below `claim_funds` call.
5050 if node_txn.len() > 2 {
5051 assert_eq!(node_txn[2].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5052 htlc_timeout_tx = if node_txn[2].output[0].value < 900 { node_txn[2].clone() } else { node_txn[0].clone() };
5054 htlc_timeout_tx = if node_txn[0].output[0].value < 900 { node_txn[1].clone() } else { node_txn[0].clone() };
5058 nodes[2].node.claim_funds(our_payment_preimage);
5059 expect_payment_claimed!(nodes[2], duplicate_payment_hash, 900_000);
5061 mine_transaction(&nodes[2], &commitment_txn[0]);
5062 check_added_monitors!(nodes[2], 2);
5063 check_closed_event!(nodes[2], 1, ClosureReason::CommitmentTxConfirmed, [nodes[1].node.get_our_node_id()], 100000);
5064 let events = nodes[2].node.get_and_clear_pending_msg_events();
5066 MessageSendEvent::UpdateHTLCs { .. } => {},
5067 _ => panic!("Unexpected event"),
5070 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5071 _ => panic!("Unexepected event"),
5073 let htlc_success_txn: Vec<_> = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
5074 assert_eq!(htlc_success_txn.len(), 2); // ChannelMonitor: HTLC-Success txn (*2 due to 2-HTLC outputs)
5075 check_spends!(htlc_success_txn[0], commitment_txn[0]);
5076 check_spends!(htlc_success_txn[1], commitment_txn[0]);
5077 assert_eq!(htlc_success_txn[0].input.len(), 1);
5078 assert_eq!(htlc_success_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5079 assert_eq!(htlc_success_txn[1].input.len(), 1);
5080 assert_eq!(htlc_success_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5081 assert_ne!(htlc_success_txn[0].input[0].previous_output, htlc_success_txn[1].input[0].previous_output);
5082 assert_ne!(htlc_success_txn[1].input[0].previous_output, htlc_timeout_tx.input[0].previous_output);
5084 mine_transaction(&nodes[1], &htlc_timeout_tx);
5085 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
5086 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], vec![HTLCDestination::NextHopChannel { node_id: Some(nodes[2].node.get_our_node_id()), channel_id: chan_2.2 }]);
5087 let htlc_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5088 assert!(htlc_updates.update_add_htlcs.is_empty());
5089 assert_eq!(htlc_updates.update_fail_htlcs.len(), 1);
5090 let first_htlc_id = htlc_updates.update_fail_htlcs[0].htlc_id;
5091 assert!(htlc_updates.update_fulfill_htlcs.is_empty());
5092 assert!(htlc_updates.update_fail_malformed_htlcs.is_empty());
5093 check_added_monitors!(nodes[1], 1);
5095 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_updates.update_fail_htlcs[0]);
5096 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
5098 commitment_signed_dance!(nodes[0], nodes[1], &htlc_updates.commitment_signed, false, true);
5100 expect_payment_failed_with_update!(nodes[0], duplicate_payment_hash, false, chan_2.0.contents.short_channel_id, true);
5102 // Solve 2nd HTLC by broadcasting on B's chain HTLC-Success Tx from C
5103 mine_transaction(&nodes[1], &htlc_success_txn[1]);
5104 expect_payment_forwarded!(nodes[1], nodes[0], nodes[2], Some(196), true, true);
5105 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5106 assert!(updates.update_add_htlcs.is_empty());
5107 assert!(updates.update_fail_htlcs.is_empty());
5108 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
5109 assert_ne!(updates.update_fulfill_htlcs[0].htlc_id, first_htlc_id);
5110 assert!(updates.update_fail_malformed_htlcs.is_empty());
5111 check_added_monitors!(nodes[1], 1);
5113 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
5114 commitment_signed_dance!(nodes[0], nodes[1], &updates.commitment_signed, false);
5115 expect_payment_sent(&nodes[0], our_payment_preimage, None, true, true);
5119 fn test_dynamic_spendable_outputs_local_htlc_success_tx() {
5120 let chanmon_cfgs = create_chanmon_cfgs(2);
5121 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5122 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5123 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5125 // Create some initial channels
5126 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
5128 let (payment_preimage, payment_hash, ..) = route_payment(&nodes[0], &[&nodes[1]], 9_000_000);
5129 let local_txn = get_local_commitment_txn!(nodes[1], chan_1.2);
5130 assert_eq!(local_txn.len(), 1);
5131 assert_eq!(local_txn[0].input.len(), 1);
5132 check_spends!(local_txn[0], chan_1.3);
5134 // Give B knowledge of preimage to be able to generate a local HTLC-Success Tx
5135 nodes[1].node.claim_funds(payment_preimage);
5136 expect_payment_claimed!(nodes[1], payment_hash, 9_000_000);
5137 check_added_monitors!(nodes[1], 1);
5139 mine_transaction(&nodes[1], &local_txn[0]);
5140 check_added_monitors!(nodes[1], 1);
5141 check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed, [nodes[0].node.get_our_node_id()], 100000);
5142 let events = nodes[1].node.get_and_clear_pending_msg_events();
5144 MessageSendEvent::UpdateHTLCs { .. } => {},
5145 _ => panic!("Unexpected event"),
5148 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5149 _ => panic!("Unexepected event"),
5152 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5153 assert_eq!(node_txn.len(), 1);
5154 assert_eq!(node_txn[0].input.len(), 1);
5155 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5156 check_spends!(node_txn[0], local_txn[0]);
5160 mine_transaction(&nodes[1], &node_tx);
5161 connect_blocks(&nodes[1], BREAKDOWN_TIMEOUT as u32 - 1);
5163 // Verify that B is able to spend its own HTLC-Success tx thanks to spendable output event given back by its ChannelMonitor
5164 let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
5165 assert_eq!(spend_txn.len(), 1);
5166 assert_eq!(spend_txn[0].input.len(), 1);
5167 check_spends!(spend_txn[0], node_tx);
5168 assert_eq!(spend_txn[0].input[0].sequence.0, BREAKDOWN_TIMEOUT as u32);
5171 fn do_test_fail_backwards_unrevoked_remote_announce(deliver_last_raa: bool, announce_latest: bool) {
5172 // Test that we fail backwards the full set of HTLCs we need to when remote broadcasts an
5173 // unrevoked commitment transaction.
5174 // This includes HTLCs which were below the dust threshold as well as HTLCs which were awaiting
5175 // a remote RAA before they could be failed backwards (and combinations thereof).
5176 // We also test duplicate-hash HTLCs by adding two nodes on each side of the target nodes which
5177 // use the same payment hashes.
5178 // Thus, we use a six-node network:
5183 // And test where C fails back to A/B when D announces its latest commitment transaction
5184 let chanmon_cfgs = create_chanmon_cfgs(6);
5185 let node_cfgs = create_node_cfgs(6, &chanmon_cfgs);
5186 // When this test was written, the default base fee floated based on the HTLC count.
5187 // It is now fixed, so we simply set the fee to the expected value here.
5188 let mut config = test_default_channel_config();
5189 config.channel_config.forwarding_fee_base_msat = 196;
5190 let node_chanmgrs = create_node_chanmgrs(6, &node_cfgs,
5191 &[Some(config.clone()), Some(config.clone()), Some(config.clone()), Some(config.clone()), Some(config.clone()), Some(config.clone())]);
5192 let nodes = create_network(6, &node_cfgs, &node_chanmgrs);
5194 let _chan_0_2 = create_announced_chan_between_nodes(&nodes, 0, 2);
5195 let _chan_1_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
5196 let chan_2_3 = create_announced_chan_between_nodes(&nodes, 2, 3);
5197 let chan_3_4 = create_announced_chan_between_nodes(&nodes, 3, 4);
5198 let chan_3_5 = create_announced_chan_between_nodes(&nodes, 3, 5);
5200 // Rebalance and check output sanity...
5201 send_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 500000);
5202 send_payment(&nodes[1], &[&nodes[2], &nodes[3], &nodes[5]], 500000);
5203 assert_eq!(get_local_commitment_txn!(nodes[3], chan_2_3.2)[0].output.len(), 2);
5205 let ds_dust_limit = nodes[3].node.per_peer_state.read().unwrap().get(&nodes[2].node.get_our_node_id())
5206 .unwrap().lock().unwrap().channel_by_id.get(&chan_2_3.2).unwrap().context().holder_dust_limit_satoshis;
5208 let (_, payment_hash_1, ..) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], ds_dust_limit*1000); // not added < dust limit + HTLC tx fee
5210 let (_, payment_hash_2, ..) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], ds_dust_limit*1000); // not added < dust limit + HTLC tx fee
5211 let (route, _, _, _) = get_route_and_payment_hash!(nodes[1], nodes[5], ds_dust_limit*1000);
5213 send_along_route_with_secret(&nodes[1], route.clone(), &[&[&nodes[2], &nodes[3], &nodes[5]]], ds_dust_limit*1000, payment_hash_1, nodes[5].node.create_inbound_payment_for_hash(payment_hash_1, None, 7200, None).unwrap()); // not added < dust limit + HTLC tx fee
5215 send_along_route_with_secret(&nodes[1], route, &[&[&nodes[2], &nodes[3], &nodes[5]]], ds_dust_limit*1000, payment_hash_2, nodes[5].node.create_inbound_payment_for_hash(payment_hash_2, None, 7200, None).unwrap()); // not added < dust limit + HTLC tx fee
5217 let (_, payment_hash_3, ..) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
5219 let (_, payment_hash_4, ..) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
5220 let (route, _, _, _) = get_route_and_payment_hash!(nodes[1], nodes[5], 1000000);
5222 send_along_route_with_secret(&nodes[1], route.clone(), &[&[&nodes[2], &nodes[3], &nodes[5]]], 1000000, payment_hash_3, nodes[5].node.create_inbound_payment_for_hash(payment_hash_3, None, 7200, None).unwrap());
5224 send_along_route_with_secret(&nodes[1], route, &[&[&nodes[2], &nodes[3], &nodes[5]]], 1000000, payment_hash_4, nodes[5].node.create_inbound_payment_for_hash(payment_hash_4, None, 7200, None).unwrap());
5227 let (_, payment_hash_5, ..) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
5229 let (route, _, _, _) = get_route_and_payment_hash!(nodes[1], nodes[5], ds_dust_limit*1000);
5230 send_along_route_with_secret(&nodes[1], route, &[&[&nodes[2], &nodes[3], &nodes[5]]], ds_dust_limit*1000, payment_hash_5, nodes[5].node.create_inbound_payment_for_hash(payment_hash_5, None, 7200, None).unwrap()); // not added < dust limit + HTLC tx fee
5233 let (_, payment_hash_6, ..) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], ds_dust_limit*1000); // not added < dust limit + HTLC tx fee
5235 let (route, _, _, _) = get_route_and_payment_hash!(nodes[1], nodes[5], 1000000);
5236 send_along_route_with_secret(&nodes[1], route, &[&[&nodes[2], &nodes[3], &nodes[5]]], 1000000, payment_hash_6, nodes[5].node.create_inbound_payment_for_hash(payment_hash_6, None, 7200, None).unwrap());
5238 // Double-check that six of the new HTLC were added
5239 // We now have six HTLCs pending over the dust limit and six HTLCs under the dust limit (ie,
5240 // with to_local and to_remote outputs, 8 outputs and 6 HTLCs not included).
5241 assert_eq!(get_local_commitment_txn!(nodes[3], chan_2_3.2).len(), 1);
5242 assert_eq!(get_local_commitment_txn!(nodes[3], chan_2_3.2)[0].output.len(), 8);
5244 // Now fail back three of the over-dust-limit and three of the under-dust-limit payments in one go.
5245 // Fail 0th below-dust, 4th above-dust, 8th above-dust, 10th below-dust HTLCs
5246 nodes[4].node.fail_htlc_backwards(&payment_hash_1);
5247 nodes[4].node.fail_htlc_backwards(&payment_hash_3);
5248 nodes[4].node.fail_htlc_backwards(&payment_hash_5);
5249 nodes[4].node.fail_htlc_backwards(&payment_hash_6);
5250 check_added_monitors!(nodes[4], 0);
5252 let failed_destinations = vec![
5253 HTLCDestination::FailedPayment { payment_hash: payment_hash_1 },
5254 HTLCDestination::FailedPayment { payment_hash: payment_hash_3 },
5255 HTLCDestination::FailedPayment { payment_hash: payment_hash_5 },
5256 HTLCDestination::FailedPayment { payment_hash: payment_hash_6 },
5258 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[4], failed_destinations);
5259 check_added_monitors!(nodes[4], 1);
5261 let four_removes = get_htlc_update_msgs!(nodes[4], nodes[3].node.get_our_node_id());
5262 nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[0]);
5263 nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[1]);
5264 nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[2]);
5265 nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[3]);
5266 commitment_signed_dance!(nodes[3], nodes[4], four_removes.commitment_signed, false);
5268 // Fail 3rd below-dust and 7th above-dust HTLCs
5269 nodes[5].node.fail_htlc_backwards(&payment_hash_2);
5270 nodes[5].node.fail_htlc_backwards(&payment_hash_4);
5271 check_added_monitors!(nodes[5], 0);
5273 let failed_destinations_2 = vec![
5274 HTLCDestination::FailedPayment { payment_hash: payment_hash_2 },
5275 HTLCDestination::FailedPayment { payment_hash: payment_hash_4 },
5277 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[5], failed_destinations_2);
5278 check_added_monitors!(nodes[5], 1);
5280 let two_removes = get_htlc_update_msgs!(nodes[5], nodes[3].node.get_our_node_id());
5281 nodes[3].node.handle_update_fail_htlc(&nodes[5].node.get_our_node_id(), &two_removes.update_fail_htlcs[0]);
5282 nodes[3].node.handle_update_fail_htlc(&nodes[5].node.get_our_node_id(), &two_removes.update_fail_htlcs[1]);
5283 commitment_signed_dance!(nodes[3], nodes[5], two_removes.commitment_signed, false);
5285 let ds_prev_commitment_tx = get_local_commitment_txn!(nodes[3], chan_2_3.2);
5287 // After 4 and 2 removes respectively above in nodes[4] and nodes[5], nodes[3] should receive 6 PaymentForwardedFailed events
5288 let failed_destinations_3 = vec![
5289 HTLCDestination::NextHopChannel { node_id: Some(nodes[4].node.get_our_node_id()), channel_id: chan_3_4.2 },
5290 HTLCDestination::NextHopChannel { node_id: Some(nodes[4].node.get_our_node_id()), channel_id: chan_3_4.2 },
5291 HTLCDestination::NextHopChannel { node_id: Some(nodes[4].node.get_our_node_id()), channel_id: chan_3_4.2 },
5292 HTLCDestination::NextHopChannel { node_id: Some(nodes[4].node.get_our_node_id()), channel_id: chan_3_4.2 },
5293 HTLCDestination::NextHopChannel { node_id: Some(nodes[5].node.get_our_node_id()), channel_id: chan_3_5.2 },
5294 HTLCDestination::NextHopChannel { node_id: Some(nodes[5].node.get_our_node_id()), channel_id: chan_3_5.2 },
5296 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[3], failed_destinations_3);
5297 check_added_monitors!(nodes[3], 1);
5298 let six_removes = get_htlc_update_msgs!(nodes[3], nodes[2].node.get_our_node_id());
5299 nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[0]);
5300 nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[1]);
5301 nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[2]);
5302 nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[3]);
5303 nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[4]);
5304 nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[5]);
5305 if deliver_last_raa {
5306 commitment_signed_dance!(nodes[2], nodes[3], six_removes.commitment_signed, false);
5308 let _cs_last_raa = commitment_signed_dance!(nodes[2], nodes[3], six_removes.commitment_signed, false, true, false, true);
5311 // D's latest commitment transaction now contains 1st + 2nd + 9th HTLCs (implicitly, they're
5312 // below the dust limit) and the 5th + 6th + 11th HTLCs. It has failed back the 0th, 3rd, 4th,
5313 // 7th, 8th, and 10th, but as we haven't yet delivered the final RAA to C, the fails haven't
5314 // propagated back to A/B yet (and D has two unrevoked commitment transactions).
5316 // We now broadcast the latest commitment transaction, which *should* result in failures for
5317 // the 0th, 1st, 2nd, 3rd, 4th, 7th, 8th, 9th, and 10th HTLCs, ie all the below-dust HTLCs and
5318 // the non-broadcast above-dust HTLCs.
5320 // Alternatively, we may broadcast the previous commitment transaction, which should only
5321 // result in failures for the below-dust HTLCs, ie the 0th, 1st, 2nd, 3rd, 9th, and 10th HTLCs.
5322 let ds_last_commitment_tx = get_local_commitment_txn!(nodes[3], chan_2_3.2);
5324 if announce_latest {
5325 mine_transaction(&nodes[2], &ds_last_commitment_tx[0]);
5327 mine_transaction(&nodes[2], &ds_prev_commitment_tx[0]);
5329 let events = nodes[2].node.get_and_clear_pending_events();
5330 let close_event = if deliver_last_raa {
5331 assert_eq!(events.len(), 2 + 6);
5332 events.last().clone().unwrap()
5334 assert_eq!(events.len(), 1);
5335 events.last().clone().unwrap()
5338 Event::ChannelClosed { reason: ClosureReason::CommitmentTxConfirmed, .. } => {}
5339 _ => panic!("Unexpected event"),
5342 connect_blocks(&nodes[2], ANTI_REORG_DELAY - 1);
5343 check_closed_broadcast!(nodes[2], true);
5344 if deliver_last_raa {
5345 expect_pending_htlcs_forwardable_from_events!(nodes[2], events[0..1], true);
5347 let expected_destinations: Vec<HTLCDestination> = repeat(HTLCDestination::NextHopChannel { node_id: Some(nodes[3].node.get_our_node_id()), channel_id: chan_2_3.2 }).take(3).collect();
5348 expect_htlc_handling_failed_destinations!(nodes[2].node.get_and_clear_pending_events(), expected_destinations);
5350 let expected_destinations: Vec<HTLCDestination> = if announce_latest {
5351 repeat(HTLCDestination::NextHopChannel { node_id: Some(nodes[3].node.get_our_node_id()), channel_id: chan_2_3.2 }).take(9).collect()
5353 repeat(HTLCDestination::NextHopChannel { node_id: Some(nodes[3].node.get_our_node_id()), channel_id: chan_2_3.2 }).take(6).collect()
5356 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[2], expected_destinations);
5358 check_added_monitors!(nodes[2], 3);
5360 let cs_msgs = nodes[2].node.get_and_clear_pending_msg_events();
5361 assert_eq!(cs_msgs.len(), 2);
5362 let mut a_done = false;
5363 for msg in cs_msgs {
5365 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
5366 // Both under-dust HTLCs and the one above-dust HTLC that we had already failed
5367 // should be failed-backwards here.
5368 let target = if *node_id == nodes[0].node.get_our_node_id() {
5369 // If announce_latest, expect 0th, 1st, 4th, 8th, 10th HTLCs, else only 0th, 1st, 10th below-dust HTLCs
5370 for htlc in &updates.update_fail_htlcs {
5371 assert!(htlc.htlc_id == 1 || htlc.htlc_id == 2 || htlc.htlc_id == 6 || if announce_latest { htlc.htlc_id == 3 || htlc.htlc_id == 5 } else { false });
5373 assert_eq!(updates.update_fail_htlcs.len(), if announce_latest { 5 } else { 3 });
5378 // If announce_latest, expect 2nd, 3rd, 7th, 9th HTLCs, else only 2nd, 3rd, 9th below-dust HTLCs
5379 for htlc in &updates.update_fail_htlcs {
5380 assert!(htlc.htlc_id == 1 || htlc.htlc_id == 2 || htlc.htlc_id == 5 || if announce_latest { htlc.htlc_id == 4 } else { false });
5382 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
5383 assert_eq!(updates.update_fail_htlcs.len(), if announce_latest { 4 } else { 3 });
5386 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
5387 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[1]);
5388 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[2]);
5389 if announce_latest {
5390 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[3]);
5391 if *node_id == nodes[0].node.get_our_node_id() {
5392 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[4]);
5395 commitment_signed_dance!(target, nodes[2], updates.commitment_signed, false, true);
5397 _ => panic!("Unexpected event"),
5401 let as_events = nodes[0].node.get_and_clear_pending_events();
5402 assert_eq!(as_events.len(), if announce_latest { 10 } else { 6 });
5403 let mut as_failds = HashSet::new();
5404 let mut as_updates = 0;
5405 for event in as_events.iter() {
5406 if let &Event::PaymentPathFailed { ref payment_hash, ref payment_failed_permanently, ref failure, .. } = event {
5407 assert!(as_failds.insert(*payment_hash));
5408 if *payment_hash != payment_hash_2 {
5409 assert_eq!(*payment_failed_permanently, deliver_last_raa);
5411 assert!(!payment_failed_permanently);
5413 if let PathFailure::OnPath { network_update: Some(_) } = failure {
5416 } else if let &Event::PaymentFailed { .. } = event {
5417 } else { panic!("Unexpected event"); }
5419 assert!(as_failds.contains(&payment_hash_1));
5420 assert!(as_failds.contains(&payment_hash_2));
5421 if announce_latest {
5422 assert!(as_failds.contains(&payment_hash_3));
5423 assert!(as_failds.contains(&payment_hash_5));
5425 assert!(as_failds.contains(&payment_hash_6));
5427 let bs_events = nodes[1].node.get_and_clear_pending_events();
5428 assert_eq!(bs_events.len(), if announce_latest { 8 } else { 6 });
5429 let mut bs_failds = HashSet::new();
5430 let mut bs_updates = 0;
5431 for event in bs_events.iter() {
5432 if let &Event::PaymentPathFailed { ref payment_hash, ref payment_failed_permanently, ref failure, .. } = event {
5433 assert!(bs_failds.insert(*payment_hash));
5434 if *payment_hash != payment_hash_1 && *payment_hash != payment_hash_5 {
5435 assert_eq!(*payment_failed_permanently, deliver_last_raa);
5437 assert!(!payment_failed_permanently);
5439 if let PathFailure::OnPath { network_update: Some(_) } = failure {
5442 } else if let &Event::PaymentFailed { .. } = event {
5443 } else { panic!("Unexpected event"); }
5445 assert!(bs_failds.contains(&payment_hash_1));
5446 assert!(bs_failds.contains(&payment_hash_2));
5447 if announce_latest {
5448 assert!(bs_failds.contains(&payment_hash_4));
5450 assert!(bs_failds.contains(&payment_hash_5));
5452 // For each HTLC which was not failed-back by normal process (ie deliver_last_raa), we should
5453 // get a NetworkUpdate. A should have gotten 4 HTLCs which were failed-back due to
5454 // unknown-preimage-etc, B should have gotten 2. Thus, in the
5455 // announce_latest && deliver_last_raa case, we should have 5-4=1 and 4-2=2 NetworkUpdates.
5456 assert_eq!(as_updates, if deliver_last_raa { 1 } else if !announce_latest { 3 } else { 5 });
5457 assert_eq!(bs_updates, if deliver_last_raa { 2 } else if !announce_latest { 3 } else { 4 });
5461 fn test_fail_backwards_latest_remote_announce_a() {
5462 do_test_fail_backwards_unrevoked_remote_announce(false, true);
5466 fn test_fail_backwards_latest_remote_announce_b() {
5467 do_test_fail_backwards_unrevoked_remote_announce(true, true);
5471 fn test_fail_backwards_previous_remote_announce() {
5472 do_test_fail_backwards_unrevoked_remote_announce(false, false);
5473 // Note that true, true doesn't make sense as it implies we announce a revoked state, which is
5474 // tested for in test_commitment_revoked_fail_backward_exhaustive()
5478 fn test_dynamic_spendable_outputs_local_htlc_timeout_tx() {
5479 let chanmon_cfgs = create_chanmon_cfgs(2);
5480 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5481 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5482 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5484 // Create some initial channels
5485 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
5487 let (_, our_payment_hash, ..) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000);
5488 let local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
5489 assert_eq!(local_txn[0].input.len(), 1);
5490 check_spends!(local_txn[0], chan_1.3);
5492 // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
5493 mine_transaction(&nodes[0], &local_txn[0]);
5494 check_closed_broadcast!(nodes[0], true);
5495 check_added_monitors!(nodes[0], 1);
5496 check_closed_event!(nodes[0], 1, ClosureReason::CommitmentTxConfirmed, [nodes[1].node.get_our_node_id()], 100000);
5497 connect_blocks(&nodes[0], TEST_FINAL_CLTV); // Confirm blocks until the HTLC expires
5499 let htlc_timeout = {
5500 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5501 assert_eq!(node_txn.len(), 1);
5502 assert_eq!(node_txn[0].input.len(), 1);
5503 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5504 check_spends!(node_txn[0], local_txn[0]);
5508 mine_transaction(&nodes[0], &htlc_timeout);
5509 connect_blocks(&nodes[0], BREAKDOWN_TIMEOUT as u32 - 1);
5510 expect_payment_failed!(nodes[0], our_payment_hash, false);
5512 // Verify that A is able to spend its own HTLC-Timeout tx thanks to spendable output event given back by its ChannelMonitor
5513 let spend_txn = check_spendable_outputs!(nodes[0], node_cfgs[0].keys_manager);
5514 assert_eq!(spend_txn.len(), 3);
5515 check_spends!(spend_txn[0], local_txn[0]);
5516 assert_eq!(spend_txn[1].input.len(), 1);
5517 check_spends!(spend_txn[1], htlc_timeout);
5518 assert_eq!(spend_txn[1].input[0].sequence.0, BREAKDOWN_TIMEOUT as u32);
5519 assert_eq!(spend_txn[2].input.len(), 2);
5520 check_spends!(spend_txn[2], local_txn[0], htlc_timeout);
5521 assert!(spend_txn[2].input[0].sequence.0 == BREAKDOWN_TIMEOUT as u32 ||
5522 spend_txn[2].input[1].sequence.0 == BREAKDOWN_TIMEOUT as u32);
5526 fn test_key_derivation_params() {
5527 // This test is a copy of test_dynamic_spendable_outputs_local_htlc_timeout_tx, with a key
5528 // manager rotation to test that `channel_keys_id` returned in
5529 // [`SpendableOutputDescriptor::DelayedPaymentOutput`] let us re-derive the channel key set to
5530 // then derive a `delayed_payment_key`.
5532 let chanmon_cfgs = create_chanmon_cfgs(3);
5534 // We manually create the node configuration to backup the seed.
5535 let seed = [42; 32];
5536 let keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
5537 let chain_monitor = test_utils::TestChainMonitor::new(Some(&chanmon_cfgs[0].chain_source), &chanmon_cfgs[0].tx_broadcaster, &chanmon_cfgs[0].logger, &chanmon_cfgs[0].fee_estimator, &chanmon_cfgs[0].persister, &keys_manager);
5538 let network_graph = Arc::new(NetworkGraph::new(Network::Testnet, &chanmon_cfgs[0].logger));
5539 let scorer = RwLock::new(test_utils::TestScorer::new());
5540 let router = test_utils::TestRouter::new(network_graph.clone(), &scorer);
5541 let node = NodeCfg { chain_source: &chanmon_cfgs[0].chain_source, logger: &chanmon_cfgs[0].logger, tx_broadcaster: &chanmon_cfgs[0].tx_broadcaster, fee_estimator: &chanmon_cfgs[0].fee_estimator, router, chain_monitor, keys_manager: &keys_manager, network_graph, node_seed: seed, override_init_features: alloc::rc::Rc::new(core::cell::RefCell::new(None)) };
5542 let mut node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5543 node_cfgs.remove(0);
5544 node_cfgs.insert(0, node);
5546 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5547 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5549 // Create some initial channels
5550 // Create a dummy channel to advance index by one and thus test re-derivation correctness
5552 let chan_0 = create_announced_chan_between_nodes(&nodes, 0, 2);
5553 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
5554 assert_ne!(chan_0.3.output[0].script_pubkey, chan_1.3.output[0].script_pubkey);
5556 // Ensure all nodes are at the same height
5557 let node_max_height = nodes.iter().map(|node| node.blocks.lock().unwrap().len()).max().unwrap() as u32;
5558 connect_blocks(&nodes[0], node_max_height - nodes[0].best_block_info().1);
5559 connect_blocks(&nodes[1], node_max_height - nodes[1].best_block_info().1);
5560 connect_blocks(&nodes[2], node_max_height - nodes[2].best_block_info().1);
5562 let (_, our_payment_hash, ..) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000);
5563 let local_txn_0 = get_local_commitment_txn!(nodes[0], chan_0.2);
5564 let local_txn_1 = get_local_commitment_txn!(nodes[0], chan_1.2);
5565 assert_eq!(local_txn_1[0].input.len(), 1);
5566 check_spends!(local_txn_1[0], chan_1.3);
5568 // We check funding pubkey are unique
5569 let (from_0_funding_key_0, from_0_funding_key_1) = (PublicKey::from_slice(&local_txn_0[0].input[0].witness.to_vec()[3][2..35]), PublicKey::from_slice(&local_txn_0[0].input[0].witness.to_vec()[3][36..69]));
5570 let (from_1_funding_key_0, from_1_funding_key_1) = (PublicKey::from_slice(&local_txn_1[0].input[0].witness.to_vec()[3][2..35]), PublicKey::from_slice(&local_txn_1[0].input[0].witness.to_vec()[3][36..69]));
5571 if from_0_funding_key_0 == from_1_funding_key_0
5572 || from_0_funding_key_0 == from_1_funding_key_1
5573 || from_0_funding_key_1 == from_1_funding_key_0
5574 || from_0_funding_key_1 == from_1_funding_key_1 {
5575 panic!("Funding pubkeys aren't unique");
5578 // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
5579 mine_transaction(&nodes[0], &local_txn_1[0]);
5580 connect_blocks(&nodes[0], TEST_FINAL_CLTV); // Confirm blocks until the HTLC expires
5581 check_closed_broadcast!(nodes[0], true);
5582 check_added_monitors!(nodes[0], 1);
5583 check_closed_event!(nodes[0], 1, ClosureReason::CommitmentTxConfirmed, [nodes[1].node.get_our_node_id()], 100000);
5585 let htlc_timeout = {
5586 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5587 assert_eq!(node_txn.len(), 1);
5588 assert_eq!(node_txn[0].input.len(), 1);
5589 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5590 check_spends!(node_txn[0], local_txn_1[0]);
5594 mine_transaction(&nodes[0], &htlc_timeout);
5595 connect_blocks(&nodes[0], BREAKDOWN_TIMEOUT as u32 - 1);
5596 expect_payment_failed!(nodes[0], our_payment_hash, false);
5598 // Verify that A is able to spend its own HTLC-Timeout tx thanks to spendable output event given back by its ChannelMonitor
5599 let new_keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
5600 let spend_txn = check_spendable_outputs!(nodes[0], new_keys_manager);
5601 assert_eq!(spend_txn.len(), 3);
5602 check_spends!(spend_txn[0], local_txn_1[0]);
5603 assert_eq!(spend_txn[1].input.len(), 1);
5604 check_spends!(spend_txn[1], htlc_timeout);
5605 assert_eq!(spend_txn[1].input[0].sequence.0, BREAKDOWN_TIMEOUT as u32);
5606 assert_eq!(spend_txn[2].input.len(), 2);
5607 check_spends!(spend_txn[2], local_txn_1[0], htlc_timeout);
5608 assert!(spend_txn[2].input[0].sequence.0 == BREAKDOWN_TIMEOUT as u32 ||
5609 spend_txn[2].input[1].sequence.0 == BREAKDOWN_TIMEOUT as u32);
5613 fn test_static_output_closing_tx() {
5614 let chanmon_cfgs = create_chanmon_cfgs(2);
5615 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5616 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5617 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5619 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
5621 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
5622 let closing_tx = close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true).2;
5624 mine_transaction(&nodes[0], &closing_tx);
5625 check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
5626 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
5628 let spend_txn = check_spendable_outputs!(nodes[0], node_cfgs[0].keys_manager);
5629 assert_eq!(spend_txn.len(), 1);
5630 check_spends!(spend_txn[0], closing_tx);
5632 mine_transaction(&nodes[1], &closing_tx);
5633 check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
5634 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
5636 let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
5637 assert_eq!(spend_txn.len(), 1);
5638 check_spends!(spend_txn[0], closing_tx);
5641 fn do_htlc_claim_local_commitment_only(use_dust: bool) {
5642 let chanmon_cfgs = create_chanmon_cfgs(2);
5643 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5644 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5645 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5646 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
5648 let (payment_preimage, payment_hash, ..) = route_payment(&nodes[0], &[&nodes[1]], if use_dust { 50000 } else { 3_000_000 });
5650 // Claim the payment, but don't deliver A's commitment_signed, resulting in the HTLC only being
5651 // present in B's local commitment transaction, but none of A's commitment transactions.
5652 nodes[1].node.claim_funds(payment_preimage);
5653 check_added_monitors!(nodes[1], 1);
5654 expect_payment_claimed!(nodes[1], payment_hash, if use_dust { 50000 } else { 3_000_000 });
5656 let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5657 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fulfill_htlcs[0]);
5658 expect_payment_sent(&nodes[0], payment_preimage, None, false, false);
5660 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_updates.commitment_signed);
5661 check_added_monitors!(nodes[0], 1);
5662 let as_updates = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5663 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_updates.0);
5664 check_added_monitors!(nodes[1], 1);
5666 let starting_block = nodes[1].best_block_info();
5667 let mut block = create_dummy_block(starting_block.0, 42, Vec::new());
5668 for _ in starting_block.1 + 1..TEST_FINAL_CLTV - CLTV_CLAIM_BUFFER + starting_block.1 + 2 {
5669 connect_block(&nodes[1], &block);
5670 block.header.prev_blockhash = block.block_hash();
5672 test_txn_broadcast(&nodes[1], &chan, None, if use_dust { HTLCType::NONE } else { HTLCType::SUCCESS });
5673 check_closed_broadcast!(nodes[1], true);
5674 check_added_monitors!(nodes[1], 1);
5675 check_closed_event!(nodes[1], 1, ClosureReason::HolderForceClosed, [nodes[0].node.get_our_node_id()], 100000);
5678 fn do_htlc_claim_current_remote_commitment_only(use_dust: bool) {
5679 let chanmon_cfgs = create_chanmon_cfgs(2);
5680 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5681 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5682 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5683 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
5685 let (route, payment_hash, _, payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], if use_dust { 50000 } else { 3000000 });
5686 nodes[0].node.send_payment_with_route(&route, payment_hash,
5687 RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_hash.0)).unwrap();
5688 check_added_monitors!(nodes[0], 1);
5690 let _as_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5692 // As far as A is concerned, the HTLC is now present only in the latest remote commitment
5693 // transaction, however it is not in A's latest local commitment, so we can just broadcast that
5694 // to "time out" the HTLC.
5696 let starting_block = nodes[1].best_block_info();
5697 let mut block = create_dummy_block(starting_block.0, 42, Vec::new());
5699 for _ in starting_block.1 + 1..TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + starting_block.1 + 2 {
5700 connect_block(&nodes[0], &block);
5701 block.header.prev_blockhash = block.block_hash();
5703 test_txn_broadcast(&nodes[0], &chan, None, HTLCType::NONE);
5704 check_closed_broadcast!(nodes[0], true);
5705 check_added_monitors!(nodes[0], 1);
5706 check_closed_event!(nodes[0], 1, ClosureReason::HolderForceClosed, [nodes[1].node.get_our_node_id()], 100000);
5709 fn do_htlc_claim_previous_remote_commitment_only(use_dust: bool, check_revoke_no_close: bool) {
5710 let chanmon_cfgs = create_chanmon_cfgs(3);
5711 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5712 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5713 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5714 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
5716 // Fail the payment, but don't deliver A's final RAA, resulting in the HTLC only being present
5717 // in B's previous (unrevoked) commitment transaction, but none of A's commitment transactions.
5718 // Also optionally test that we *don't* fail the channel in case the commitment transaction was
5719 // actually revoked.
5720 let htlc_value = if use_dust { 50000 } else { 3000000 };
5721 let (_, our_payment_hash, ..) = route_payment(&nodes[0], &[&nodes[1]], htlc_value);
5722 nodes[1].node.fail_htlc_backwards(&our_payment_hash);
5723 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash: our_payment_hash }]);
5724 check_added_monitors!(nodes[1], 1);
5726 let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5727 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fail_htlcs[0]);
5728 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_updates.commitment_signed);
5729 check_added_monitors!(nodes[0], 1);
5730 let as_updates = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5731 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_updates.0);
5732 check_added_monitors!(nodes[1], 1);
5733 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_updates.1);
5734 check_added_monitors!(nodes[1], 1);
5735 let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
5737 if check_revoke_no_close {
5738 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
5739 check_added_monitors!(nodes[0], 1);
5742 let starting_block = nodes[1].best_block_info();
5743 let mut block = create_dummy_block(starting_block.0, 42, Vec::new());
5744 for _ in starting_block.1 + 1..TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + CHAN_CONFIRM_DEPTH + 2 {
5745 connect_block(&nodes[0], &block);
5746 block.header.prev_blockhash = block.block_hash();
5748 if !check_revoke_no_close {
5749 test_txn_broadcast(&nodes[0], &chan, None, HTLCType::NONE);
5750 check_closed_broadcast!(nodes[0], true);
5751 check_added_monitors!(nodes[0], 1);
5752 check_closed_event!(nodes[0], 1, ClosureReason::HolderForceClosed, [nodes[1].node.get_our_node_id()], 100000);
5754 expect_payment_failed!(nodes[0], our_payment_hash, true);
5758 // Test that we close channels on-chain when broadcastable HTLCs reach their timeout window.
5759 // There are only a few cases to test here:
5760 // * its not really normative behavior, but we test that below-dust HTLCs "included" in
5761 // broadcastable commitment transactions result in channel closure,
5762 // * its included in an unrevoked-but-previous remote commitment transaction,
5763 // * its included in the latest remote or local commitment transactions.
5764 // We test each of the three possible commitment transactions individually and use both dust and
5766 // Note that we don't bother testing both outbound and inbound HTLC failures for each case, and we
5767 // assume they are handled the same across all six cases, as both outbound and inbound failures are
5768 // tested for at least one of the cases in other tests.
5770 fn htlc_claim_single_commitment_only_a() {
5771 do_htlc_claim_local_commitment_only(true);
5772 do_htlc_claim_local_commitment_only(false);
5774 do_htlc_claim_current_remote_commitment_only(true);
5775 do_htlc_claim_current_remote_commitment_only(false);
5779 fn htlc_claim_single_commitment_only_b() {
5780 do_htlc_claim_previous_remote_commitment_only(true, false);
5781 do_htlc_claim_previous_remote_commitment_only(false, false);
5782 do_htlc_claim_previous_remote_commitment_only(true, true);
5783 do_htlc_claim_previous_remote_commitment_only(false, true);
5788 fn bolt2_open_channel_sending_node_checks_part1() { //This test needs to be on its own as we are catching a panic
5789 let chanmon_cfgs = create_chanmon_cfgs(2);
5790 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5791 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5792 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5793 // Force duplicate randomness for every get-random call
5794 for node in nodes.iter() {
5795 *node.keys_manager.override_random_bytes.lock().unwrap() = Some([0; 32]);
5798 // BOLT #2 spec: Sending node must ensure temporary_channel_id is unique from any other channel ID with the same peer.
5799 let channel_value_satoshis=10000;
5800 let push_msat=10001;
5801 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None, None).unwrap();
5802 let node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
5803 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &node0_to_1_send_open_channel);
5804 get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
5806 // Create a second channel with the same random values. This used to panic due to a colliding
5807 // channel_id, but now panics due to a colliding outbound SCID alias.
5808 assert!(nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None, None).is_err());
5812 fn bolt2_open_channel_sending_node_checks_part2() {
5813 let chanmon_cfgs = create_chanmon_cfgs(2);
5814 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5815 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5816 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5818 // BOLT #2 spec: Sending node must set funding_satoshis to less than 2^24 satoshis
5819 let channel_value_satoshis=2^24;
5820 let push_msat=10001;
5821 assert!(nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None, None).is_err());
5823 // BOLT #2 spec: Sending node must set push_msat to equal or less than 1000 * funding_satoshis
5824 let channel_value_satoshis=10000;
5825 // Test when push_msat is equal to 1000 * funding_satoshis.
5826 let push_msat=1000*channel_value_satoshis+1;
5827 assert!(nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None, None).is_err());
5829 // BOLT #2 spec: Sending node must set set channel_reserve_satoshis greater than or equal to dust_limit_satoshis
5830 let channel_value_satoshis=10000;
5831 let push_msat=10001;
5832 assert!(nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None, None).is_ok()); //Create a valid channel
5833 let node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
5834 assert!(node0_to_1_send_open_channel.channel_reserve_satoshis>=node0_to_1_send_open_channel.dust_limit_satoshis);
5836 // BOLT #2 spec: Sending node must set undefined bits in channel_flags to 0
5837 // Only the least-significant bit of channel_flags is currently defined resulting in channel_flags only having one of two possible states 0 or 1
5838 assert!(node0_to_1_send_open_channel.channel_flags<=1);
5840 // BOLT #2 spec: Sending node should set to_self_delay sufficient to ensure the sender can irreversibly spend a commitment transaction output, in case of misbehaviour by the receiver.
5841 assert!(BREAKDOWN_TIMEOUT>0);
5842 assert!(node0_to_1_send_open_channel.to_self_delay==BREAKDOWN_TIMEOUT);
5844 // BOLT #2 spec: Sending node must ensure the chain_hash value identifies the chain it wishes to open the channel within.
5845 let chain_hash = ChainHash::using_genesis_block(Network::Testnet);
5846 assert_eq!(node0_to_1_send_open_channel.chain_hash, chain_hash);
5848 // BOLT #2 spec: Sending node must set funding_pubkey, revocation_basepoint, htlc_basepoint, payment_basepoint, and delayed_payment_basepoint to valid DER-encoded, compressed, secp256k1 pubkeys.
5849 assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.funding_pubkey.serialize()).is_ok());
5850 assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.revocation_basepoint.serialize()).is_ok());
5851 assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.htlc_basepoint.serialize()).is_ok());
5852 assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.payment_point.serialize()).is_ok());
5853 assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.delayed_payment_basepoint.serialize()).is_ok());
5857 fn bolt2_open_channel_sane_dust_limit() {
5858 let chanmon_cfgs = create_chanmon_cfgs(2);
5859 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5860 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5861 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5863 let channel_value_satoshis=1000000;
5864 let push_msat=10001;
5865 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None, None).unwrap();
5866 let mut node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
5867 node0_to_1_send_open_channel.dust_limit_satoshis = 547;
5868 node0_to_1_send_open_channel.channel_reserve_satoshis = 100001;
5870 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &node0_to_1_send_open_channel);
5871 let events = nodes[1].node.get_and_clear_pending_msg_events();
5872 let err_msg = match events[0] {
5873 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id: _ } => {
5876 _ => panic!("Unexpected event"),
5878 assert_eq!(err_msg.data, "dust_limit_satoshis (547) is greater than the implementation limit (546)");
5881 // Test that if we fail to send an HTLC that is being freed from the holding cell, and the HTLC
5882 // originated from our node, its failure is surfaced to the user. We trigger this failure to
5883 // free the HTLC by increasing our fee while the HTLC is in the holding cell such that the HTLC
5884 // is no longer affordable once it's freed.
5886 fn test_fail_holding_cell_htlc_upon_free() {
5887 let chanmon_cfgs = create_chanmon_cfgs(2);
5888 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5889 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5890 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5891 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000);
5893 // First nodes[0] generates an update_fee, setting the channel's
5894 // pending_update_fee.
5896 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
5897 *feerate_lock += 20;
5899 nodes[0].node.timer_tick_occurred();
5900 check_added_monitors!(nodes[0], 1);
5902 let events = nodes[0].node.get_and_clear_pending_msg_events();
5903 assert_eq!(events.len(), 1);
5904 let (update_msg, commitment_signed) = match events[0] {
5905 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
5906 (update_fee.as_ref(), commitment_signed)
5908 _ => panic!("Unexpected event"),
5911 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
5913 let mut chan_stat = get_channel_value_stat!(nodes[0], nodes[1], chan.2);
5914 let channel_reserve = chan_stat.channel_reserve_msat;
5915 let feerate = get_feerate!(nodes[0], nodes[1], chan.2);
5916 let channel_type_features = get_channel_type_features!(nodes[0], nodes[1], chan.2);
5918 // 2* and +1 HTLCs on the commit tx fee calculation for the fee spike reserve.
5919 let max_can_send = 5000000 - channel_reserve - 2*commit_tx_fee_msat(feerate, 1 + 1, &channel_type_features);
5920 let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], max_can_send);
5922 // Send a payment which passes reserve checks but gets stuck in the holding cell.
5923 nodes[0].node.send_payment_with_route(&route, our_payment_hash,
5924 RecipientOnionFields::secret_only(our_payment_secret), PaymentId(our_payment_hash.0)).unwrap();
5925 chan_stat = get_channel_value_stat!(nodes[0], nodes[1], chan.2);
5926 assert_eq!(chan_stat.holding_cell_outbound_amount_msat, max_can_send);
5928 // Flush the pending fee update.
5929 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
5930 let (as_revoke_and_ack, _) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5931 check_added_monitors!(nodes[1], 1);
5932 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_revoke_and_ack);
5933 check_added_monitors!(nodes[0], 1);
5935 // Upon receipt of the RAA, there will be an attempt to resend the holding cell
5936 // HTLC, but now that the fee has been raised the payment will now fail, causing
5937 // us to surface its failure to the user.
5938 chan_stat = get_channel_value_stat!(nodes[0], nodes[1], chan.2);
5939 assert_eq!(chan_stat.holding_cell_outbound_amount_msat, 0);
5940 nodes[0].logger.assert_log("lightning::ln::channel", format!("Freeing holding cell with 1 HTLC updates in channel {}", chan.2), 1);
5942 // Check that the payment failed to be sent out.
5943 let events = nodes[0].node.get_and_clear_pending_events();
5944 assert_eq!(events.len(), 2);
5946 &Event::PaymentPathFailed { ref payment_id, ref payment_hash, ref payment_failed_permanently, failure: PathFailure::OnPath { network_update: None }, ref short_channel_id, .. } => {
5947 assert_eq!(PaymentId(our_payment_hash.0), *payment_id.as_ref().unwrap());
5948 assert_eq!(our_payment_hash.clone(), *payment_hash);
5949 assert_eq!(*payment_failed_permanently, false);
5950 assert_eq!(*short_channel_id, Some(route.paths[0].hops[0].short_channel_id));
5952 _ => panic!("Unexpected event"),
5955 &Event::PaymentFailed { ref payment_hash, .. } => {
5956 assert_eq!(our_payment_hash.clone(), *payment_hash);
5958 _ => panic!("Unexpected event"),
5962 // Test that if multiple HTLCs are released from the holding cell and one is
5963 // valid but the other is no longer valid upon release, the valid HTLC can be
5964 // successfully completed while the other one fails as expected.
5966 fn test_free_and_fail_holding_cell_htlcs() {
5967 let chanmon_cfgs = create_chanmon_cfgs(2);
5968 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5969 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5970 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5971 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000);
5973 // First nodes[0] generates an update_fee, setting the channel's
5974 // pending_update_fee.
5976 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
5977 *feerate_lock += 200;
5979 nodes[0].node.timer_tick_occurred();
5980 check_added_monitors!(nodes[0], 1);
5982 let events = nodes[0].node.get_and_clear_pending_msg_events();
5983 assert_eq!(events.len(), 1);
5984 let (update_msg, commitment_signed) = match events[0] {
5985 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
5986 (update_fee.as_ref(), commitment_signed)
5988 _ => panic!("Unexpected event"),
5991 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
5993 let mut chan_stat = get_channel_value_stat!(nodes[0], nodes[1], chan.2);
5994 let channel_reserve = chan_stat.channel_reserve_msat;
5995 let feerate = get_feerate!(nodes[0], nodes[1], chan.2);
5996 let channel_type_features = get_channel_type_features!(nodes[0], nodes[1], chan.2);
5998 // 2* and +1 HTLCs on the commit tx fee calculation for the fee spike reserve.
6000 let amt_2 = 5000000 - channel_reserve - 2*commit_tx_fee_msat(feerate, 2 + 1, &channel_type_features) - amt_1;
6001 let (route_1, payment_hash_1, payment_preimage_1, payment_secret_1) = get_route_and_payment_hash!(nodes[0], nodes[1], amt_1);
6002 let (route_2, payment_hash_2, _, payment_secret_2) = get_route_and_payment_hash!(nodes[0], nodes[1], amt_2);
6004 // Send 2 payments which pass reserve checks but get stuck in the holding cell.
6005 nodes[0].node.send_payment_with_route(&route_1, payment_hash_1,
6006 RecipientOnionFields::secret_only(payment_secret_1), PaymentId(payment_hash_1.0)).unwrap();
6007 chan_stat = get_channel_value_stat!(nodes[0], nodes[1], chan.2);
6008 assert_eq!(chan_stat.holding_cell_outbound_amount_msat, amt_1);
6009 let payment_id_2 = PaymentId(nodes[0].keys_manager.get_secure_random_bytes());
6010 nodes[0].node.send_payment_with_route(&route_2, payment_hash_2,
6011 RecipientOnionFields::secret_only(payment_secret_2), payment_id_2).unwrap();
6012 chan_stat = get_channel_value_stat!(nodes[0], nodes[1], chan.2);
6013 assert_eq!(chan_stat.holding_cell_outbound_amount_msat, amt_1 + amt_2);
6015 // Flush the pending fee update.
6016 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
6017 let (revoke_and_ack, commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6018 check_added_monitors!(nodes[1], 1);
6019 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_and_ack);
6020 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
6021 check_added_monitors!(nodes[0], 2);
6023 // Upon receipt of the RAA, there will be an attempt to resend the holding cell HTLCs,
6024 // but now that the fee has been raised the second payment will now fail, causing us
6025 // to surface its failure to the user. The first payment should succeed.
6026 chan_stat = get_channel_value_stat!(nodes[0], nodes[1], chan.2);
6027 assert_eq!(chan_stat.holding_cell_outbound_amount_msat, 0);
6028 nodes[0].logger.assert_log("lightning::ln::channel", format!("Freeing holding cell with 2 HTLC updates in channel {}", chan.2), 1);
6030 // Check that the second payment failed to be sent out.
6031 let events = nodes[0].node.get_and_clear_pending_events();
6032 assert_eq!(events.len(), 2);
6034 &Event::PaymentPathFailed { ref payment_id, ref payment_hash, ref payment_failed_permanently, failure: PathFailure::OnPath { network_update: None }, ref short_channel_id, .. } => {
6035 assert_eq!(payment_id_2, *payment_id.as_ref().unwrap());
6036 assert_eq!(payment_hash_2.clone(), *payment_hash);
6037 assert_eq!(*payment_failed_permanently, false);
6038 assert_eq!(*short_channel_id, Some(route_2.paths[0].hops[0].short_channel_id));
6040 _ => panic!("Unexpected event"),
6043 &Event::PaymentFailed { ref payment_hash, .. } => {
6044 assert_eq!(payment_hash_2.clone(), *payment_hash);
6046 _ => panic!("Unexpected event"),
6049 // Complete the first payment and the RAA from the fee update.
6050 let (payment_event, send_raa_event) = {
6051 let mut msgs = nodes[0].node.get_and_clear_pending_msg_events();
6052 assert_eq!(msgs.len(), 2);
6053 (SendEvent::from_event(msgs.remove(0)), msgs.remove(0))
6055 let raa = match send_raa_event {
6056 MessageSendEvent::SendRevokeAndACK { msg, .. } => msg,
6057 _ => panic!("Unexpected event"),
6059 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &raa);
6060 check_added_monitors!(nodes[1], 1);
6061 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6062 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6063 let events = nodes[1].node.get_and_clear_pending_events();
6064 assert_eq!(events.len(), 1);
6066 Event::PendingHTLCsForwardable { .. } => {},
6067 _ => panic!("Unexpected event"),
6069 nodes[1].node.process_pending_htlc_forwards();
6070 let events = nodes[1].node.get_and_clear_pending_events();
6071 assert_eq!(events.len(), 1);
6073 Event::PaymentClaimable { .. } => {},
6074 _ => panic!("Unexpected event"),
6076 nodes[1].node.claim_funds(payment_preimage_1);
6077 check_added_monitors!(nodes[1], 1);
6078 expect_payment_claimed!(nodes[1], payment_hash_1, amt_1);
6080 let update_msgs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6081 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_msgs.update_fulfill_htlcs[0]);
6082 commitment_signed_dance!(nodes[0], nodes[1], update_msgs.commitment_signed, false, true);
6083 expect_payment_sent!(nodes[0], payment_preimage_1);
6086 // Test that if we fail to forward an HTLC that is being freed from the holding cell that the
6087 // HTLC is failed backwards. We trigger this failure to forward the freed HTLC by increasing
6088 // our fee while the HTLC is in the holding cell such that the HTLC is no longer affordable
6091 fn test_fail_holding_cell_htlc_upon_free_multihop() {
6092 let chanmon_cfgs = create_chanmon_cfgs(3);
6093 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
6094 // Avoid having to include routing fees in calculations
6095 let mut config = test_default_channel_config();
6096 config.channel_config.forwarding_fee_base_msat = 0;
6097 config.channel_config.forwarding_fee_proportional_millionths = 0;
6098 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[Some(config.clone()), Some(config.clone()), Some(config.clone())]);
6099 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
6100 let chan_0_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000);
6101 let chan_1_2 = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 100000, 95000000);
6103 // First nodes[1] generates an update_fee, setting the channel's
6104 // pending_update_fee.
6106 let mut feerate_lock = chanmon_cfgs[1].fee_estimator.sat_per_kw.lock().unwrap();
6107 *feerate_lock += 20;
6109 nodes[1].node.timer_tick_occurred();
6110 check_added_monitors!(nodes[1], 1);
6112 let events = nodes[1].node.get_and_clear_pending_msg_events();
6113 assert_eq!(events.len(), 1);
6114 let (update_msg, commitment_signed) = match events[0] {
6115 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
6116 (update_fee.as_ref(), commitment_signed)
6118 _ => panic!("Unexpected event"),
6121 nodes[2].node.handle_update_fee(&nodes[1].node.get_our_node_id(), update_msg.unwrap());
6123 let mut chan_stat = get_channel_value_stat!(nodes[0], nodes[1], chan_0_1.2);
6124 let channel_reserve = chan_stat.channel_reserve_msat;
6125 let feerate = get_feerate!(nodes[0], nodes[1], chan_0_1.2);
6126 let channel_type_features = get_channel_type_features!(nodes[0], nodes[1], chan_0_1.2);
6128 // Send a payment which passes reserve checks but gets stuck in the holding cell.
6129 let max_can_send = 5000000 - channel_reserve - 2*commit_tx_fee_msat(feerate, 1 + 1, &channel_type_features);
6130 let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], max_can_send);
6131 let payment_event = {
6132 nodes[0].node.send_payment_with_route(&route, our_payment_hash,
6133 RecipientOnionFields::secret_only(our_payment_secret), PaymentId(our_payment_hash.0)).unwrap();
6134 check_added_monitors!(nodes[0], 1);
6136 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
6137 assert_eq!(events.len(), 1);
6139 SendEvent::from_event(events.remove(0))
6141 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6142 check_added_monitors!(nodes[1], 0);
6143 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6144 expect_pending_htlcs_forwardable!(nodes[1]);
6146 chan_stat = get_channel_value_stat!(nodes[1], nodes[2], chan_1_2.2);
6147 assert_eq!(chan_stat.holding_cell_outbound_amount_msat, max_can_send);
6149 // Flush the pending fee update.
6150 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), commitment_signed);
6151 let (raa, commitment_signed) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
6152 check_added_monitors!(nodes[2], 1);
6153 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &raa);
6154 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &commitment_signed);
6155 check_added_monitors!(nodes[1], 2);
6157 // A final RAA message is generated to finalize the fee update.
6158 let events = nodes[1].node.get_and_clear_pending_msg_events();
6159 assert_eq!(events.len(), 1);
6161 let raa_msg = match &events[0] {
6162 &MessageSendEvent::SendRevokeAndACK { ref msg, .. } => {
6165 _ => panic!("Unexpected event"),
6168 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &raa_msg);
6169 check_added_monitors!(nodes[2], 1);
6170 assert!(nodes[2].node.get_and_clear_pending_msg_events().is_empty());
6172 // nodes[1]'s ChannelManager will now signal that we have HTLC forwards to process.
6173 let process_htlc_forwards_event = nodes[1].node.get_and_clear_pending_events();
6174 assert_eq!(process_htlc_forwards_event.len(), 2);
6175 match &process_htlc_forwards_event[0] {
6176 &Event::PendingHTLCsForwardable { .. } => {},
6177 _ => panic!("Unexpected event"),
6180 // In response, we call ChannelManager's process_pending_htlc_forwards
6181 nodes[1].node.process_pending_htlc_forwards();
6182 check_added_monitors!(nodes[1], 1);
6184 // This causes the HTLC to be failed backwards.
6185 let fail_event = nodes[1].node.get_and_clear_pending_msg_events();
6186 assert_eq!(fail_event.len(), 1);
6187 let (fail_msg, commitment_signed) = match &fail_event[0] {
6188 &MessageSendEvent::UpdateHTLCs { ref updates, .. } => {
6189 assert_eq!(updates.update_add_htlcs.len(), 0);
6190 assert_eq!(updates.update_fulfill_htlcs.len(), 0);
6191 assert_eq!(updates.update_fail_malformed_htlcs.len(), 0);
6192 assert_eq!(updates.update_fail_htlcs.len(), 1);
6193 (updates.update_fail_htlcs[0].clone(), updates.commitment_signed.clone())
6195 _ => panic!("Unexpected event"),
6198 // Pass the failure messages back to nodes[0].
6199 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
6200 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
6202 // Complete the HTLC failure+removal process.
6203 let (raa, commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6204 check_added_monitors!(nodes[0], 1);
6205 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &raa);
6206 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commitment_signed);
6207 check_added_monitors!(nodes[1], 2);
6208 let final_raa_event = nodes[1].node.get_and_clear_pending_msg_events();
6209 assert_eq!(final_raa_event.len(), 1);
6210 let raa = match &final_raa_event[0] {
6211 &MessageSendEvent::SendRevokeAndACK { ref msg, .. } => msg.clone(),
6212 _ => panic!("Unexpected event"),
6214 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &raa);
6215 expect_payment_failed_with_update!(nodes[0], our_payment_hash, false, chan_1_2.0.contents.short_channel_id, false);
6216 check_added_monitors!(nodes[0], 1);
6220 fn test_payment_route_reaching_same_channel_twice() {
6221 //A route should not go through the same channel twice
6222 //It is enforced when constructing a route.
6223 let chanmon_cfgs = create_chanmon_cfgs(2);
6224 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6225 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6226 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6227 let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 0);
6229 let payment_params = PaymentParameters::from_node_id(nodes[1].node.get_our_node_id(), 0)
6230 .with_bolt11_features(nodes[1].node.bolt11_invoice_features()).unwrap();
6231 let (mut route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], payment_params, 100000000);
6233 // Extend the path by itself, essentially simulating route going through same channel twice
6234 let cloned_hops = route.paths[0].hops.clone();
6235 route.paths[0].hops.extend_from_slice(&cloned_hops);
6237 unwrap_send_err!(nodes[0].node.send_payment_with_route(&route, our_payment_hash,
6238 RecipientOnionFields::secret_only(our_payment_secret), PaymentId(our_payment_hash.0)
6239 ), false, APIError::InvalidRoute { ref err },
6240 assert_eq!(err, &"Path went through the same channel twice"));
6243 // BOLT 2 Requirements for the Sender when constructing and sending an update_add_htlc message.
6244 // BOLT 2 Requirement: MUST NOT offer amount_msat it cannot pay for in the remote commitment transaction at the current feerate_per_kw (see "Updating Fees") while maintaining its channel reserve.
6245 //TODO: I don't believe this is explicitly enforced when sending an HTLC but as the Fee aspect of the BOLT specs is in flux leaving this as a TODO.
6248 fn test_update_add_htlc_bolt2_sender_value_below_minimum_msat() {
6249 //BOLT2 Requirement: MUST NOT offer amount_msat below the receiving node's htlc_minimum_msat (same validation check catches both of these)
6250 let chanmon_cfgs = create_chanmon_cfgs(2);
6251 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6252 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6253 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6254 let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000);
6256 let (mut route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], 100000);
6257 route.paths[0].hops[0].fee_msat = 100;
6259 unwrap_send_err!(nodes[0].node.send_payment_with_route(&route, our_payment_hash,
6260 RecipientOnionFields::secret_only(our_payment_secret), PaymentId(our_payment_hash.0)
6261 ), true, APIError::ChannelUnavailable { .. }, {});
6262 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6266 fn test_update_add_htlc_bolt2_sender_zero_value_msat() {
6267 //BOLT2 Requirement: MUST offer amount_msat greater than 0.
6268 let chanmon_cfgs = create_chanmon_cfgs(2);
6269 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6270 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6271 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6272 let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000);
6274 let (mut route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], 100000);
6275 route.paths[0].hops[0].fee_msat = 0;
6276 unwrap_send_err!(nodes[0].node.send_payment_with_route(&route, our_payment_hash,
6277 RecipientOnionFields::secret_only(our_payment_secret), PaymentId(our_payment_hash.0)),
6278 true, APIError::ChannelUnavailable { ref err },
6279 assert_eq!(err, "Cannot send 0-msat HTLC"));
6281 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6282 nodes[0].logger.assert_log_contains("lightning::ln::channelmanager", "Cannot send 0-msat HTLC", 1);
6286 fn test_update_add_htlc_bolt2_receiver_zero_value_msat() {
6287 //BOLT2 Requirement: MUST offer amount_msat greater than 0.
6288 let chanmon_cfgs = create_chanmon_cfgs(2);
6289 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6290 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6291 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6292 let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000);
6294 let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], 100000);
6295 nodes[0].node.send_payment_with_route(&route, our_payment_hash,
6296 RecipientOnionFields::secret_only(our_payment_secret), PaymentId(our_payment_hash.0)).unwrap();
6297 check_added_monitors!(nodes[0], 1);
6298 let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6299 updates.update_add_htlcs[0].amount_msat = 0;
6301 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6302 nodes[1].logger.assert_log("lightning::ln::channelmanager", "Remote side tried to send a 0-msat HTLC".to_string(), 1);
6303 check_closed_broadcast!(nodes[1], true).unwrap();
6304 check_added_monitors!(nodes[1], 1);
6305 check_closed_event!(nodes[1], 1, ClosureReason::ProcessingError { err: "Remote side tried to send a 0-msat HTLC".to_string() },
6306 [nodes[0].node.get_our_node_id()], 100000);
6310 fn test_update_add_htlc_bolt2_sender_cltv_expiry_too_high() {
6311 //BOLT 2 Requirement: MUST set cltv_expiry less than 500000000.
6312 //It is enforced when constructing a route.
6313 let chanmon_cfgs = create_chanmon_cfgs(2);
6314 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6315 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6316 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6317 let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 0);
6319 let payment_params = PaymentParameters::from_node_id(nodes[1].node.get_our_node_id(), 0)
6320 .with_bolt11_features(nodes[1].node.bolt11_invoice_features()).unwrap();
6321 let (mut route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], payment_params, 100000000);
6322 route.paths[0].hops.last_mut().unwrap().cltv_expiry_delta = 500000001;
6323 unwrap_send_err!(nodes[0].node.send_payment_with_route(&route, our_payment_hash,
6324 RecipientOnionFields::secret_only(our_payment_secret), PaymentId(our_payment_hash.0)
6325 ), true, APIError::InvalidRoute { ref err },
6326 assert_eq!(err, &"Channel CLTV overflowed?"));
6330 fn test_update_add_htlc_bolt2_sender_exceed_max_htlc_num_and_htlc_id_increment() {
6331 //BOLT 2 Requirement: if result would be offering more than the remote's max_accepted_htlcs HTLCs, in the remote commitment transaction: MUST NOT add an HTLC.
6332 //BOLT 2 Requirement: for the first HTLC it offers MUST set id to 0.
6333 //BOLT 2 Requirement: MUST increase the value of id by 1 for each successive offer.
6334 let chanmon_cfgs = create_chanmon_cfgs(2);
6335 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6336 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6337 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6338 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 0);
6339 let max_accepted_htlcs = nodes[1].node.per_peer_state.read().unwrap().get(&nodes[0].node.get_our_node_id())
6340 .unwrap().lock().unwrap().channel_by_id.get(&chan.2).unwrap().context().counterparty_max_accepted_htlcs as u64;
6342 // Fetch a route in advance as we will be unable to once we're unable to send.
6343 let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], 100000);
6344 for i in 0..max_accepted_htlcs {
6345 let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], 100000);
6346 let payment_event = {
6347 nodes[0].node.send_payment_with_route(&route, our_payment_hash,
6348 RecipientOnionFields::secret_only(our_payment_secret), PaymentId(our_payment_hash.0)).unwrap();
6349 check_added_monitors!(nodes[0], 1);
6351 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
6352 assert_eq!(events.len(), 1);
6353 if let MessageSendEvent::UpdateHTLCs { node_id: _, updates: msgs::CommitmentUpdate{ update_add_htlcs: ref htlcs, .. }, } = events[0] {
6354 assert_eq!(htlcs[0].htlc_id, i);
6358 SendEvent::from_event(events.remove(0))
6360 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6361 check_added_monitors!(nodes[1], 0);
6362 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6364 expect_pending_htlcs_forwardable!(nodes[1]);
6365 expect_payment_claimable!(nodes[1], our_payment_hash, our_payment_secret, 100000);
6367 unwrap_send_err!(nodes[0].node.send_payment_with_route(&route, our_payment_hash,
6368 RecipientOnionFields::secret_only(our_payment_secret), PaymentId(our_payment_hash.0)
6369 ), true, APIError::ChannelUnavailable { .. }, {});
6371 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6375 fn test_update_add_htlc_bolt2_sender_exceed_max_htlc_value_in_flight() {
6376 //BOLT 2 Requirement: if the sum of total offered HTLCs would exceed the remote's max_htlc_value_in_flight_msat: MUST NOT add an HTLC.
6377 let chanmon_cfgs = create_chanmon_cfgs(2);
6378 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6379 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6380 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6381 let channel_value = 100000;
6382 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, channel_value, 0);
6383 let max_in_flight = get_channel_value_stat!(nodes[0], nodes[1], chan.2).counterparty_max_htlc_value_in_flight_msat;
6385 send_payment(&nodes[0], &vec!(&nodes[1])[..], max_in_flight);
6387 let (mut route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], max_in_flight);
6388 // Manually create a route over our max in flight (which our router normally automatically
6390 route.paths[0].hops[0].fee_msat = max_in_flight + 1;
6391 unwrap_send_err!(nodes[0].node.send_payment_with_route(&route, our_payment_hash,
6392 RecipientOnionFields::secret_only(our_payment_secret), PaymentId(our_payment_hash.0)
6393 ), true, APIError::ChannelUnavailable { .. }, {});
6394 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6396 send_payment(&nodes[0], &[&nodes[1]], max_in_flight);
6399 // BOLT 2 Requirements for the Receiver when handling an update_add_htlc message.
6401 fn test_update_add_htlc_bolt2_receiver_check_amount_received_more_than_min() {
6402 //BOLT2 Requirement: receiving an amount_msat equal to 0, OR less than its own htlc_minimum_msat -> SHOULD fail the channel.
6403 let chanmon_cfgs = create_chanmon_cfgs(2);
6404 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6405 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6406 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6407 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000);
6408 let htlc_minimum_msat: u64;
6410 let per_peer_state = nodes[0].node.per_peer_state.read().unwrap();
6411 let chan_lock = per_peer_state.get(&nodes[1].node.get_our_node_id()).unwrap().lock().unwrap();
6412 let channel = chan_lock.channel_by_id.get(&chan.2).unwrap();
6413 htlc_minimum_msat = channel.context().get_holder_htlc_minimum_msat();
6416 let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], htlc_minimum_msat);
6417 nodes[0].node.send_payment_with_route(&route, our_payment_hash,
6418 RecipientOnionFields::secret_only(our_payment_secret), PaymentId(our_payment_hash.0)).unwrap();
6419 check_added_monitors!(nodes[0], 1);
6420 let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6421 updates.update_add_htlcs[0].amount_msat = htlc_minimum_msat-1;
6422 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6423 assert!(nodes[1].node.list_channels().is_empty());
6424 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6425 assert!(regex::Regex::new(r"Remote side tried to send less than our minimum HTLC value\. Lower limit: \(\d+\)\. Actual: \(\d+\)").unwrap().is_match(err_msg.data.as_str()));
6426 check_added_monitors!(nodes[1], 1);
6427 check_closed_event!(nodes[1], 1, ClosureReason::ProcessingError { err: err_msg.data }, [nodes[0].node.get_our_node_id()], 100000);
6431 fn test_update_add_htlc_bolt2_receiver_sender_can_afford_amount_sent() {
6432 //BOLT2 Requirement: receiving an amount_msat that the sending node cannot afford at the current feerate_per_kw (while maintaining its channel reserve): SHOULD fail the channel
6433 let chanmon_cfgs = create_chanmon_cfgs(2);
6434 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6435 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6436 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6437 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000);
6439 let chan_stat = get_channel_value_stat!(nodes[0], nodes[1], chan.2);
6440 let channel_reserve = chan_stat.channel_reserve_msat;
6441 let feerate = get_feerate!(nodes[0], nodes[1], chan.2);
6442 let channel_type_features = get_channel_type_features!(nodes[0], nodes[1], chan.2);
6443 // The 2* and +1 are for the fee spike reserve.
6444 let commit_tx_fee_outbound = 2 * commit_tx_fee_msat(feerate, 1 + 1, &channel_type_features);
6446 let max_can_send = 5000000 - channel_reserve - commit_tx_fee_outbound;
6447 let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], max_can_send);
6448 nodes[0].node.send_payment_with_route(&route, our_payment_hash,
6449 RecipientOnionFields::secret_only(our_payment_secret), PaymentId(our_payment_hash.0)).unwrap();
6450 check_added_monitors!(nodes[0], 1);
6451 let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6453 // Even though channel-initiator senders are required to respect the fee_spike_reserve,
6454 // at this time channel-initiatee receivers are not required to enforce that senders
6455 // respect the fee_spike_reserve.
6456 updates.update_add_htlcs[0].amount_msat = max_can_send + commit_tx_fee_outbound + 1;
6457 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6459 assert!(nodes[1].node.list_channels().is_empty());
6460 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6461 assert_eq!(err_msg.data, "Remote HTLC add would put them under remote reserve value");
6462 check_added_monitors!(nodes[1], 1);
6463 check_closed_event!(nodes[1], 1, ClosureReason::ProcessingError { err: err_msg.data }, [nodes[0].node.get_our_node_id()], 100000);
6467 fn test_update_add_htlc_bolt2_receiver_check_max_htlc_limit() {
6468 //BOLT 2 Requirement: if a sending node adds more than its max_accepted_htlcs HTLCs to its local commitment transaction: SHOULD fail the channel
6469 //BOLT 2 Requirement: MUST allow multiple HTLCs with the same payment_hash.
6470 let chanmon_cfgs = create_chanmon_cfgs(2);
6471 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6472 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6473 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6474 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000);
6476 let send_amt = 3999999;
6477 let (mut route, our_payment_hash, _, our_payment_secret) =
6478 get_route_and_payment_hash!(nodes[0], nodes[1], 1000);
6479 route.paths[0].hops[0].fee_msat = send_amt;
6480 let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
6481 let cur_height = nodes[0].node.best_block.read().unwrap().height() + 1;
6482 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::signing_only(), &route.paths[0], &session_priv).unwrap();
6483 let (onion_payloads, _htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(
6484 &route.paths[0], send_amt, RecipientOnionFields::secret_only(our_payment_secret), cur_height, &None).unwrap();
6485 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &our_payment_hash).unwrap();
6487 let mut msg = msgs::UpdateAddHTLC {
6491 payment_hash: our_payment_hash,
6492 cltv_expiry: htlc_cltv,
6493 onion_routing_packet: onion_packet.clone(),
6494 skimmed_fee_msat: None,
6495 blinding_point: None,
6499 msg.htlc_id = i as u64;
6500 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
6502 msg.htlc_id = (50) as u64;
6503 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
6505 assert!(nodes[1].node.list_channels().is_empty());
6506 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6507 assert!(regex::Regex::new(r"Remote tried to push more than our max accepted HTLCs \(\d+\)").unwrap().is_match(err_msg.data.as_str()));
6508 check_added_monitors!(nodes[1], 1);
6509 check_closed_event!(nodes[1], 1, ClosureReason::ProcessingError { err: err_msg.data }, [nodes[0].node.get_our_node_id()], 100000);
6513 fn test_update_add_htlc_bolt2_receiver_check_max_in_flight_msat() {
6514 //OR adds more than its max_htlc_value_in_flight_msat worth of offered HTLCs to its local commitment transaction: SHOULD fail the channel
6515 let chanmon_cfgs = create_chanmon_cfgs(2);
6516 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6517 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6518 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6519 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000);
6521 let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
6522 nodes[0].node.send_payment_with_route(&route, our_payment_hash,
6523 RecipientOnionFields::secret_only(our_payment_secret), PaymentId(our_payment_hash.0)).unwrap();
6524 check_added_monitors!(nodes[0], 1);
6525 let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6526 updates.update_add_htlcs[0].amount_msat = get_channel_value_stat!(nodes[1], nodes[0], chan.2).counterparty_max_htlc_value_in_flight_msat + 1;
6527 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6529 assert!(nodes[1].node.list_channels().is_empty());
6530 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6531 assert!(regex::Regex::new("Remote HTLC add would put them over our max HTLC value").unwrap().is_match(err_msg.data.as_str()));
6532 check_added_monitors!(nodes[1], 1);
6533 check_closed_event!(nodes[1], 1, ClosureReason::ProcessingError { err: err_msg.data }, [nodes[0].node.get_our_node_id()], 1000000);
6537 fn test_update_add_htlc_bolt2_receiver_check_cltv_expiry() {
6538 //BOLT2 Requirement: if sending node sets cltv_expiry to greater or equal to 500000000: SHOULD fail the channel.
6539 let chanmon_cfgs = create_chanmon_cfgs(2);
6540 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6541 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6542 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6544 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000);
6545 let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
6546 nodes[0].node.send_payment_with_route(&route, our_payment_hash,
6547 RecipientOnionFields::secret_only(our_payment_secret), PaymentId(our_payment_hash.0)).unwrap();
6548 check_added_monitors!(nodes[0], 1);
6549 let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6550 updates.update_add_htlcs[0].cltv_expiry = 500000000;
6551 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6553 assert!(nodes[1].node.list_channels().is_empty());
6554 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6555 assert_eq!(err_msg.data,"Remote provided CLTV expiry in seconds instead of block height");
6556 check_added_monitors!(nodes[1], 1);
6557 check_closed_event!(nodes[1], 1, ClosureReason::ProcessingError { err: err_msg.data }, [nodes[0].node.get_our_node_id()], 100000);
6561 fn test_update_add_htlc_bolt2_receiver_check_repeated_id_ignore() {
6562 //BOLT 2 requirement: if the sender did not previously acknowledge the commitment of that HTLC: MUST ignore a repeated id value after a reconnection.
6563 // We test this by first testing that that repeated HTLCs pass commitment signature checks
6564 // after disconnect and that non-sequential htlc_ids result in a channel failure.
6565 let chanmon_cfgs = create_chanmon_cfgs(2);
6566 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6567 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6568 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6570 create_announced_chan_between_nodes(&nodes, 0, 1);
6571 let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
6572 nodes[0].node.send_payment_with_route(&route, our_payment_hash,
6573 RecipientOnionFields::secret_only(our_payment_secret), PaymentId(our_payment_hash.0)).unwrap();
6574 check_added_monitors!(nodes[0], 1);
6575 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6576 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6578 //Disconnect and Reconnect
6579 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id());
6580 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
6581 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init {
6582 features: nodes[1].node.init_features(), networks: None, remote_network_address: None
6584 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
6585 assert_eq!(reestablish_1.len(), 1);
6586 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init {
6587 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
6589 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
6590 assert_eq!(reestablish_2.len(), 1);
6591 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
6592 handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
6593 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
6594 handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
6597 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6598 assert_eq!(updates.commitment_signed.htlc_signatures.len(), 1);
6599 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &updates.commitment_signed);
6600 check_added_monitors!(nodes[1], 1);
6601 let _bs_responses = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6603 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6605 assert!(nodes[1].node.list_channels().is_empty());
6606 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6607 assert!(regex::Regex::new(r"Remote skipped HTLC ID \(skipped ID: \d+\)").unwrap().is_match(err_msg.data.as_str()));
6608 check_added_monitors!(nodes[1], 1);
6609 check_closed_event!(nodes[1], 1, ClosureReason::ProcessingError { err: err_msg.data }, [nodes[0].node.get_our_node_id()], 100000);
6613 fn test_update_fulfill_htlc_bolt2_update_fulfill_htlc_before_commitment() {
6614 //BOLT 2 Requirement: until the corresponding HTLC is irrevocably committed in both sides' commitment transactions: MUST NOT send an update_fulfill_htlc, update_fail_htlc, or update_fail_malformed_htlc.
6616 let chanmon_cfgs = create_chanmon_cfgs(2);
6617 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6618 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6619 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6620 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
6621 let (route, our_payment_hash, our_payment_preimage, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
6622 nodes[0].node.send_payment_with_route(&route, our_payment_hash,
6623 RecipientOnionFields::secret_only(our_payment_secret), PaymentId(our_payment_hash.0)).unwrap();
6625 check_added_monitors!(nodes[0], 1);
6626 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6627 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6629 let update_msg = msgs::UpdateFulfillHTLC{
6632 payment_preimage: our_payment_preimage,
6635 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6637 assert!(nodes[0].node.list_channels().is_empty());
6638 let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6639 assert!(regex::Regex::new(r"Remote tried to fulfill/fail HTLC \(\d+\) before it had been committed").unwrap().is_match(err_msg.data.as_str()));
6640 check_added_monitors!(nodes[0], 1);
6641 check_closed_event!(nodes[0], 1, ClosureReason::ProcessingError { err: err_msg.data }, [nodes[1].node.get_our_node_id()], 100000);
6645 fn test_update_fulfill_htlc_bolt2_update_fail_htlc_before_commitment() {
6646 //BOLT 2 Requirement: until the corresponding HTLC is irrevocably committed in both sides' commitment transactions: MUST NOT send an update_fulfill_htlc, update_fail_htlc, or update_fail_malformed_htlc.
6648 let chanmon_cfgs = create_chanmon_cfgs(2);
6649 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6650 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6651 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6652 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
6654 let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
6655 nodes[0].node.send_payment_with_route(&route, our_payment_hash,
6656 RecipientOnionFields::secret_only(our_payment_secret), PaymentId(our_payment_hash.0)).unwrap();
6657 check_added_monitors!(nodes[0], 1);
6658 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6659 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6661 let update_msg = msgs::UpdateFailHTLC{
6664 reason: msgs::OnionErrorPacket { data: Vec::new()},
6667 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6669 assert!(nodes[0].node.list_channels().is_empty());
6670 let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6671 assert!(regex::Regex::new(r"Remote tried to fulfill/fail HTLC \(\d+\) before it had been committed").unwrap().is_match(err_msg.data.as_str()));
6672 check_added_monitors!(nodes[0], 1);
6673 check_closed_event!(nodes[0], 1, ClosureReason::ProcessingError { err: err_msg.data }, [nodes[1].node.get_our_node_id()], 100000);
6677 fn test_update_fulfill_htlc_bolt2_update_fail_malformed_htlc_before_commitment() {
6678 //BOLT 2 Requirement: until the corresponding HTLC is irrevocably committed in both sides' commitment transactions: MUST NOT send an update_fulfill_htlc, update_fail_htlc, or update_fail_malformed_htlc.
6680 let chanmon_cfgs = create_chanmon_cfgs(2);
6681 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6682 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6683 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6684 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
6686 let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
6687 nodes[0].node.send_payment_with_route(&route, our_payment_hash,
6688 RecipientOnionFields::secret_only(our_payment_secret), PaymentId(our_payment_hash.0)).unwrap();
6689 check_added_monitors!(nodes[0], 1);
6690 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6691 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6692 let update_msg = msgs::UpdateFailMalformedHTLC{
6695 sha256_of_onion: [1; 32],
6696 failure_code: 0x8000,
6699 nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6701 assert!(nodes[0].node.list_channels().is_empty());
6702 let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6703 assert!(regex::Regex::new(r"Remote tried to fulfill/fail HTLC \(\d+\) before it had been committed").unwrap().is_match(err_msg.data.as_str()));
6704 check_added_monitors!(nodes[0], 1);
6705 check_closed_event!(nodes[0], 1, ClosureReason::ProcessingError { err: err_msg.data }, [nodes[1].node.get_our_node_id()], 100000);
6709 fn test_update_fulfill_htlc_bolt2_incorrect_htlc_id() {
6710 //BOLT 2 Requirement: A receiving node: if the id does not correspond to an HTLC in its current commitment transaction MUST fail the channel.
6712 let chanmon_cfgs = create_chanmon_cfgs(2);
6713 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6714 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6715 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6716 create_announced_chan_between_nodes(&nodes, 0, 1);
6718 let (our_payment_preimage, our_payment_hash, ..) = route_payment(&nodes[0], &[&nodes[1]], 100_000);
6720 nodes[1].node.claim_funds(our_payment_preimage);
6721 check_added_monitors!(nodes[1], 1);
6722 expect_payment_claimed!(nodes[1], our_payment_hash, 100_000);
6724 let events = nodes[1].node.get_and_clear_pending_msg_events();
6725 assert_eq!(events.len(), 1);
6726 let mut update_fulfill_msg: msgs::UpdateFulfillHTLC = {
6728 MessageSendEvent::UpdateHTLCs { node_id: _ , updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fulfill_htlcs, ref update_fail_htlcs, ref update_fail_malformed_htlcs, ref update_fee, .. } } => {
6729 assert!(update_add_htlcs.is_empty());
6730 assert_eq!(update_fulfill_htlcs.len(), 1);
6731 assert!(update_fail_htlcs.is_empty());
6732 assert!(update_fail_malformed_htlcs.is_empty());
6733 assert!(update_fee.is_none());
6734 update_fulfill_htlcs[0].clone()
6736 _ => panic!("Unexpected event"),
6740 update_fulfill_msg.htlc_id = 1;
6742 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_msg);
6744 assert!(nodes[0].node.list_channels().is_empty());
6745 let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6746 assert_eq!(err_msg.data, "Remote tried to fulfill/fail an HTLC we couldn't find");
6747 check_added_monitors!(nodes[0], 1);
6748 check_closed_event!(nodes[0], 1, ClosureReason::ProcessingError { err: err_msg.data }, [nodes[1].node.get_our_node_id()], 100000);
6752 fn test_update_fulfill_htlc_bolt2_wrong_preimage() {
6753 //BOLT 2 Requirement: A receiving node: if the payment_preimage value in update_fulfill_htlc doesn't SHA256 hash to the corresponding HTLC payment_hash MUST fail the channel.
6755 let chanmon_cfgs = create_chanmon_cfgs(2);
6756 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6757 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6758 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6759 create_announced_chan_between_nodes(&nodes, 0, 1);
6761 let (our_payment_preimage, our_payment_hash, ..) = route_payment(&nodes[0], &[&nodes[1]], 100_000);
6763 nodes[1].node.claim_funds(our_payment_preimage);
6764 check_added_monitors!(nodes[1], 1);
6765 expect_payment_claimed!(nodes[1], our_payment_hash, 100_000);
6767 let events = nodes[1].node.get_and_clear_pending_msg_events();
6768 assert_eq!(events.len(), 1);
6769 let mut update_fulfill_msg: msgs::UpdateFulfillHTLC = {
6771 MessageSendEvent::UpdateHTLCs { node_id: _ , updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fulfill_htlcs, ref update_fail_htlcs, ref update_fail_malformed_htlcs, ref update_fee, .. } } => {
6772 assert!(update_add_htlcs.is_empty());
6773 assert_eq!(update_fulfill_htlcs.len(), 1);
6774 assert!(update_fail_htlcs.is_empty());
6775 assert!(update_fail_malformed_htlcs.is_empty());
6776 assert!(update_fee.is_none());
6777 update_fulfill_htlcs[0].clone()
6779 _ => panic!("Unexpected event"),
6783 update_fulfill_msg.payment_preimage = PaymentPreimage([1; 32]);
6785 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_msg);
6787 assert!(nodes[0].node.list_channels().is_empty());
6788 let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6789 assert!(regex::Regex::new(r"Remote tried to fulfill HTLC \(\d+\) with an incorrect preimage").unwrap().is_match(err_msg.data.as_str()));
6790 check_added_monitors!(nodes[0], 1);
6791 check_closed_event!(nodes[0], 1, ClosureReason::ProcessingError { err: err_msg.data }, [nodes[1].node.get_our_node_id()], 100000);
6795 fn test_update_fulfill_htlc_bolt2_missing_badonion_bit_for_malformed_htlc_message() {
6796 //BOLT 2 Requirement: A receiving node: if the BADONION bit in failure_code is not set for update_fail_malformed_htlc MUST fail the channel.
6798 let chanmon_cfgs = create_chanmon_cfgs(2);
6799 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6800 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6801 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6802 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000);
6804 let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
6805 nodes[0].node.send_payment_with_route(&route, our_payment_hash,
6806 RecipientOnionFields::secret_only(our_payment_secret), PaymentId(our_payment_hash.0)).unwrap();
6807 check_added_monitors!(nodes[0], 1);
6809 let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6810 updates.update_add_htlcs[0].onion_routing_packet.version = 1; //Produce a malformed HTLC message
6812 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6813 check_added_monitors!(nodes[1], 0);
6814 commitment_signed_dance!(nodes[1], nodes[0], updates.commitment_signed, false, true);
6816 let events = nodes[1].node.get_and_clear_pending_msg_events();
6818 let mut update_msg: msgs::UpdateFailMalformedHTLC = {
6820 MessageSendEvent::UpdateHTLCs { node_id: _ , updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fulfill_htlcs, ref update_fail_htlcs, ref update_fail_malformed_htlcs, ref update_fee, .. } } => {
6821 assert!(update_add_htlcs.is_empty());
6822 assert!(update_fulfill_htlcs.is_empty());
6823 assert!(update_fail_htlcs.is_empty());
6824 assert_eq!(update_fail_malformed_htlcs.len(), 1);
6825 assert!(update_fee.is_none());
6826 update_fail_malformed_htlcs[0].clone()
6828 _ => panic!("Unexpected event"),
6831 update_msg.failure_code &= !0x8000;
6832 nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6834 assert!(nodes[0].node.list_channels().is_empty());
6835 let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6836 assert_eq!(err_msg.data, "Got update_fail_malformed_htlc with BADONION not set");
6837 check_added_monitors!(nodes[0], 1);
6838 check_closed_event!(nodes[0], 1, ClosureReason::ProcessingError { err: err_msg.data }, [nodes[1].node.get_our_node_id()], 1000000);
6842 fn test_update_fulfill_htlc_bolt2_after_malformed_htlc_message_must_forward_update_fail_htlc() {
6843 //BOLT 2 Requirement: a receiving node which has an outgoing HTLC canceled by update_fail_malformed_htlc:
6844 // * MUST return an error in the update_fail_htlc sent to the link which originally sent the HTLC, using the failure_code given and setting the data to sha256_of_onion.
6846 let chanmon_cfgs = create_chanmon_cfgs(3);
6847 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
6848 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
6849 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
6850 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000);
6851 let chan_2 = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 1000000, 1000000);
6853 let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], 100000);
6856 let mut payment_event = {
6857 nodes[0].node.send_payment_with_route(&route, our_payment_hash,
6858 RecipientOnionFields::secret_only(our_payment_secret), PaymentId(our_payment_hash.0)).unwrap();
6859 check_added_monitors!(nodes[0], 1);
6860 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
6861 assert_eq!(events.len(), 1);
6862 SendEvent::from_event(events.remove(0))
6864 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6865 check_added_monitors!(nodes[1], 0);
6866 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6867 expect_pending_htlcs_forwardable!(nodes[1]);
6868 let mut events_2 = nodes[1].node.get_and_clear_pending_msg_events();
6869 assert_eq!(events_2.len(), 1);
6870 check_added_monitors!(nodes[1], 1);
6871 payment_event = SendEvent::from_event(events_2.remove(0));
6872 assert_eq!(payment_event.msgs.len(), 1);
6875 payment_event.msgs[0].onion_routing_packet.version = 1; //Produce a malformed HTLC message
6876 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
6877 check_added_monitors!(nodes[2], 0);
6878 commitment_signed_dance!(nodes[2], nodes[1], payment_event.commitment_msg, false, true);
6880 let events_3 = nodes[2].node.get_and_clear_pending_msg_events();
6881 assert_eq!(events_3.len(), 1);
6882 let update_msg : (msgs::UpdateFailMalformedHTLC, msgs::CommitmentSigned) = {
6884 MessageSendEvent::UpdateHTLCs { node_id: _ , updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fulfill_htlcs, ref update_fail_htlcs, ref update_fail_malformed_htlcs, ref update_fee, ref commitment_signed } } => {
6885 assert!(update_add_htlcs.is_empty());
6886 assert!(update_fulfill_htlcs.is_empty());
6887 assert!(update_fail_htlcs.is_empty());
6888 assert_eq!(update_fail_malformed_htlcs.len(), 1);
6889 assert!(update_fee.is_none());
6890 (update_fail_malformed_htlcs[0].clone(), commitment_signed.clone())
6892 _ => panic!("Unexpected event"),
6896 nodes[1].node.handle_update_fail_malformed_htlc(&nodes[2].node.get_our_node_id(), &update_msg.0);
6898 check_added_monitors!(nodes[1], 0);
6899 commitment_signed_dance!(nodes[1], nodes[2], update_msg.1, false, true);
6900 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], vec![HTLCDestination::NextHopChannel { node_id: Some(nodes[2].node.get_our_node_id()), channel_id: chan_2.2 }]);
6901 let events_4 = nodes[1].node.get_and_clear_pending_msg_events();
6902 assert_eq!(events_4.len(), 1);
6904 //Confirm that handlinge the update_malformed_htlc message produces an update_fail_htlc message to be forwarded back along the route
6906 MessageSendEvent::UpdateHTLCs { node_id: _ , updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fulfill_htlcs, ref update_fail_htlcs, ref update_fail_malformed_htlcs, ref update_fee, .. } } => {
6907 assert!(update_add_htlcs.is_empty());
6908 assert!(update_fulfill_htlcs.is_empty());
6909 assert_eq!(update_fail_htlcs.len(), 1);
6910 assert!(update_fail_malformed_htlcs.is_empty());
6911 assert!(update_fee.is_none());
6913 _ => panic!("Unexpected event"),
6916 check_added_monitors!(nodes[1], 1);
6920 fn test_channel_failed_after_message_with_badonion_node_perm_bits_set() {
6921 let chanmon_cfgs = create_chanmon_cfgs(3);
6922 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
6923 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
6924 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
6925 create_announced_chan_between_nodes(&nodes, 0, 1);
6926 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
6928 let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], 100_000);
6931 let mut payment_event = {
6932 nodes[0].node.send_payment_with_route(&route, our_payment_hash,
6933 RecipientOnionFields::secret_only(our_payment_secret), PaymentId(our_payment_hash.0)).unwrap();
6934 check_added_monitors!(nodes[0], 1);
6935 SendEvent::from_node(&nodes[0])
6938 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6939 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6940 expect_pending_htlcs_forwardable!(nodes[1]);
6941 check_added_monitors!(nodes[1], 1);
6942 payment_event = SendEvent::from_node(&nodes[1]);
6943 assert_eq!(payment_event.msgs.len(), 1);
6946 payment_event.msgs[0].onion_routing_packet.version = 1; // Trigger an invalid_onion_version error
6947 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
6948 check_added_monitors!(nodes[2], 0);
6949 commitment_signed_dance!(nodes[2], nodes[1], payment_event.commitment_msg, false, true);
6951 let events_3 = nodes[2].node.get_and_clear_pending_msg_events();
6952 assert_eq!(events_3.len(), 1);
6954 MessageSendEvent::UpdateHTLCs { ref updates, .. } => {
6955 let mut update_msg = updates.update_fail_malformed_htlcs[0].clone();
6956 // Set the NODE bit (BADONION and PERM already set in invalid_onion_version error)
6957 update_msg.failure_code |= 0x2000;
6959 nodes[1].node.handle_update_fail_malformed_htlc(&nodes[2].node.get_our_node_id(), &update_msg);
6960 commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false, true);
6962 _ => panic!("Unexpected event"),
6965 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1],
6966 vec![HTLCDestination::NextHopChannel {
6967 node_id: Some(nodes[2].node.get_our_node_id()), channel_id: chan_2.2 }]);
6968 let events_4 = nodes[1].node.get_and_clear_pending_msg_events();
6969 assert_eq!(events_4.len(), 1);
6970 check_added_monitors!(nodes[1], 1);
6973 MessageSendEvent::UpdateHTLCs { ref updates, .. } => {
6974 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
6975 commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, false, true);
6977 _ => panic!("Unexpected event"),
6980 let events_5 = nodes[0].node.get_and_clear_pending_events();
6981 assert_eq!(events_5.len(), 2);
6983 // Expect a PaymentPathFailed event with a ChannelFailure network update for the channel between
6984 // the node originating the error to its next hop.
6986 Event::PaymentPathFailed { error_code, failure: PathFailure::OnPath { network_update: Some(NetworkUpdate::ChannelFailure { short_channel_id, is_permanent }) }, ..
6988 assert_eq!(short_channel_id, chan_2.0.contents.short_channel_id);
6989 assert!(is_permanent);
6990 assert_eq!(error_code, Some(0x8000|0x4000|0x2000|4));
6992 _ => panic!("Unexpected event"),
6995 Event::PaymentFailed { payment_hash, .. } => {
6996 assert_eq!(payment_hash, our_payment_hash);
6998 _ => panic!("Unexpected event"),
7001 // TODO: Test actual removal of channel from NetworkGraph when it's implemented.
7004 fn do_test_failure_delay_dust_htlc_local_commitment(announce_latest: bool) {
7005 // Dust-HTLC failure updates must be delayed until failure-trigger tx (in this case local commitment) reach ANTI_REORG_DELAY
7006 // We can have at most two valid local commitment tx, so both cases must be covered, and both txs must be checked to get them all as
7007 // HTLC could have been removed from lastest local commitment tx but still valid until we get remote RAA
7009 let mut chanmon_cfgs = create_chanmon_cfgs(2);
7010 chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
7011 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7012 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7013 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7014 let chan =create_announced_chan_between_nodes(&nodes, 0, 1);
7016 let bs_dust_limit = nodes[1].node.per_peer_state.read().unwrap().get(&nodes[0].node.get_our_node_id())
7017 .unwrap().lock().unwrap().channel_by_id.get(&chan.2).unwrap().context().holder_dust_limit_satoshis;
7019 // We route 2 dust-HTLCs between A and B
7020 let (_, payment_hash_1, ..) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
7021 let (_, payment_hash_2, ..) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
7022 route_payment(&nodes[0], &[&nodes[1]], 1000000);
7024 // Cache one local commitment tx as previous
7025 let as_prev_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
7027 // Fail one HTLC to prune it in the will-be-latest-local commitment tx
7028 nodes[1].node.fail_htlc_backwards(&payment_hash_2);
7029 check_added_monitors!(nodes[1], 0);
7030 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash: payment_hash_2 }]);
7031 check_added_monitors!(nodes[1], 1);
7033 let remove = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
7034 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &remove.update_fail_htlcs[0]);
7035 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &remove.commitment_signed);
7036 check_added_monitors!(nodes[0], 1);
7038 // Cache one local commitment tx as lastest
7039 let as_last_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
7041 let events = nodes[0].node.get_and_clear_pending_msg_events();
7043 MessageSendEvent::SendRevokeAndACK { node_id, .. } => {
7044 assert_eq!(node_id, nodes[1].node.get_our_node_id());
7046 _ => panic!("Unexpected event"),
7049 MessageSendEvent::UpdateHTLCs { node_id, .. } => {
7050 assert_eq!(node_id, nodes[1].node.get_our_node_id());
7052 _ => panic!("Unexpected event"),
7055 assert_ne!(as_prev_commitment_tx, as_last_commitment_tx);
7056 // Fail the 2 dust-HTLCs, move their failure in maturation buffer (htlc_updated_waiting_threshold_conf)
7057 if announce_latest {
7058 mine_transaction(&nodes[0], &as_last_commitment_tx[0]);
7060 mine_transaction(&nodes[0], &as_prev_commitment_tx[0]);
7063 check_closed_broadcast!(nodes[0], true);
7064 check_added_monitors!(nodes[0], 1);
7065 check_closed_event!(nodes[0], 1, ClosureReason::CommitmentTxConfirmed, [nodes[1].node.get_our_node_id()], 100000);
7067 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7068 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7069 let events = nodes[0].node.get_and_clear_pending_events();
7070 // Only 2 PaymentPathFailed events should show up, over-dust HTLC has to be failed by timeout tx
7071 assert_eq!(events.len(), 4);
7072 let mut first_failed = false;
7073 for event in events {
7075 Event::PaymentPathFailed { payment_hash, .. } => {
7076 if payment_hash == payment_hash_1 {
7077 assert!(!first_failed);
7078 first_failed = true;
7080 assert_eq!(payment_hash, payment_hash_2);
7083 Event::PaymentFailed { .. } => {}
7084 _ => panic!("Unexpected event"),
7090 fn test_failure_delay_dust_htlc_local_commitment() {
7091 do_test_failure_delay_dust_htlc_local_commitment(true);
7092 do_test_failure_delay_dust_htlc_local_commitment(false);
7095 fn do_test_sweep_outbound_htlc_failure_update(revoked: bool, local: bool) {
7096 // Outbound HTLC-failure updates must be cancelled if we get a reorg before we reach ANTI_REORG_DELAY.
7097 // Broadcast of revoked remote commitment tx, trigger failure-update of dust/non-dust HTLCs
7098 // Broadcast of remote commitment tx, trigger failure-update of dust-HTLCs
7099 // Broadcast of timeout tx on remote commitment tx, trigger failure-udate of non-dust HTLCs
7100 // Broadcast of local commitment tx, trigger failure-update of dust-HTLCs
7101 // Broadcast of HTLC-timeout tx on local commitment tx, trigger failure-update of non-dust HTLCs
7103 let chanmon_cfgs = create_chanmon_cfgs(3);
7104 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7105 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
7106 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7107 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
7109 let bs_dust_limit = nodes[1].node.per_peer_state.read().unwrap().get(&nodes[0].node.get_our_node_id())
7110 .unwrap().lock().unwrap().channel_by_id.get(&chan.2).unwrap().context().holder_dust_limit_satoshis;
7112 let (_payment_preimage_1, dust_hash, ..) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
7113 let (_payment_preimage_2, non_dust_hash, ..) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
7115 let as_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
7116 let bs_commitment_tx = get_local_commitment_txn!(nodes[1], chan.2);
7118 // We revoked bs_commitment_tx
7120 let (payment_preimage_3, ..) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
7121 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_3);
7124 let mut timeout_tx = Vec::new();
7126 // We fail dust-HTLC 1 by broadcast of local commitment tx
7127 mine_transaction(&nodes[0], &as_commitment_tx[0]);
7128 check_closed_event!(nodes[0], 1, ClosureReason::CommitmentTxConfirmed, [nodes[1].node.get_our_node_id()], 100000);
7129 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7130 expect_payment_failed!(nodes[0], dust_hash, false);
7132 connect_blocks(&nodes[0], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS - ANTI_REORG_DELAY);
7133 check_closed_broadcast!(nodes[0], true);
7134 check_added_monitors!(nodes[0], 1);
7135 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7136 timeout_tx.push(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0].clone());
7137 assert_eq!(timeout_tx[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
7138 // We fail non-dust-HTLC 2 by broadcast of local HTLC-timeout tx on local commitment tx
7139 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7140 mine_transaction(&nodes[0], &timeout_tx[0]);
7141 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7142 expect_payment_failed!(nodes[0], non_dust_hash, false);
7144 // We fail dust-HTLC 1 by broadcast of remote commitment tx. If revoked, fail also non-dust HTLC
7145 mine_transaction(&nodes[0], &bs_commitment_tx[0]);
7146 check_closed_broadcast!(nodes[0], true);
7147 check_added_monitors!(nodes[0], 1);
7148 check_closed_event!(nodes[0], 1, ClosureReason::CommitmentTxConfirmed, [nodes[1].node.get_our_node_id()], 100000);
7149 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7151 connect_blocks(&nodes[0], TEST_FINAL_CLTV); // Confirm blocks until the HTLC expires
7152 timeout_tx = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().drain(..)
7153 .filter(|tx| tx.input[0].previous_output.txid == bs_commitment_tx[0].txid()).collect();
7154 check_spends!(timeout_tx[0], bs_commitment_tx[0]);
7155 // For both a revoked or non-revoked commitment transaction, after ANTI_REORG_DELAY the
7156 // dust HTLC should have been failed.
7157 expect_payment_failed!(nodes[0], dust_hash, false);
7160 assert_eq!(timeout_tx[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
7162 assert_eq!(timeout_tx[0].lock_time.to_consensus_u32(), 11);
7164 // We fail non-dust-HTLC 2 by broadcast of local timeout/revocation-claim tx
7165 mine_transaction(&nodes[0], &timeout_tx[0]);
7166 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7167 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7168 expect_payment_failed!(nodes[0], non_dust_hash, false);
7173 fn test_sweep_outbound_htlc_failure_update() {
7174 do_test_sweep_outbound_htlc_failure_update(false, true);
7175 do_test_sweep_outbound_htlc_failure_update(false, false);
7176 do_test_sweep_outbound_htlc_failure_update(true, false);
7180 fn test_user_configurable_csv_delay() {
7181 // We test our channel constructors yield errors when we pass them absurd csv delay
7183 let mut low_our_to_self_config = UserConfig::default();
7184 low_our_to_self_config.channel_handshake_config.our_to_self_delay = 6;
7185 let mut high_their_to_self_config = UserConfig::default();
7186 high_their_to_self_config.channel_handshake_limits.their_to_self_delay = 100;
7187 let user_cfgs = [Some(high_their_to_self_config.clone()), None];
7188 let chanmon_cfgs = create_chanmon_cfgs(2);
7189 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7190 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &user_cfgs);
7191 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7193 // We test config.our_to_self > BREAKDOWN_TIMEOUT is enforced in OutboundV1Channel::new()
7194 if let Err(error) = OutboundV1Channel::new(&LowerBoundedFeeEstimator::new(&test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) }),
7195 &nodes[0].keys_manager, &nodes[0].keys_manager, nodes[1].node.get_our_node_id(), &nodes[1].node.init_features(), 1000000, 1000000, 0,
7196 &low_our_to_self_config, 0, 42, None)
7199 APIError::APIMisuseError { err } => { assert!(regex::Regex::new(r"Configured with an unreasonable our_to_self_delay \(\d+\) putting user funds at risks").unwrap().is_match(err.as_str())); },
7200 _ => panic!("Unexpected event"),
7202 } else { assert!(false) }
7204 // We test config.our_to_self > BREAKDOWN_TIMEOUT is enforced in InboundV1Channel::new()
7205 nodes[1].node.create_channel(nodes[0].node.get_our_node_id(), 1000000, 1000000, 42, None, None).unwrap();
7206 let mut open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
7207 open_channel.to_self_delay = 200;
7208 if let Err(error) = InboundV1Channel::new(&LowerBoundedFeeEstimator::new(&test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) }),
7209 &nodes[0].keys_manager, &nodes[0].keys_manager, nodes[1].node.get_our_node_id(), &nodes[0].node.channel_type_features(), &nodes[1].node.init_features(), &open_channel, 0,
7210 &low_our_to_self_config, 0, &nodes[0].logger, /*is_0conf=*/false)
7213 ChannelError::Close(err) => { assert!(regex::Regex::new(r"Configured with an unreasonable our_to_self_delay \(\d+\) putting user funds at risks").unwrap().is_match(err.as_str())); },
7214 _ => panic!("Unexpected event"),
7216 } else { assert!(false); }
7218 // We test msg.to_self_delay <= config.their_to_self_delay is enforced in Chanel::accept_channel()
7219 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 1000000, 1000000, 42, None, None).unwrap();
7220 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id()));
7221 let mut accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
7222 accept_channel.to_self_delay = 200;
7223 nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), &accept_channel);
7225 if let MessageSendEvent::HandleError { ref action, .. } = nodes[0].node.get_and_clear_pending_msg_events()[0] {
7227 &ErrorAction::SendErrorMessage { ref msg } => {
7228 assert!(regex::Regex::new(r"They wanted our payments to be delayed by a needlessly long period\. Upper limit: \d+\. Actual: \d+").unwrap().is_match(msg.data.as_str()));
7229 reason_msg = msg.data.clone();
7233 } else { panic!(); }
7234 check_closed_event!(nodes[0], 1, ClosureReason::ProcessingError { err: reason_msg }, [nodes[1].node.get_our_node_id()], 1000000);
7236 // We test msg.to_self_delay <= config.their_to_self_delay is enforced in InboundV1Channel::new()
7237 nodes[1].node.create_channel(nodes[0].node.get_our_node_id(), 1000000, 1000000, 42, None, None).unwrap();
7238 let mut open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
7239 open_channel.to_self_delay = 200;
7240 if let Err(error) = InboundV1Channel::new(&LowerBoundedFeeEstimator::new(&test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) }),
7241 &nodes[0].keys_manager, &nodes[0].keys_manager, nodes[1].node.get_our_node_id(), &nodes[0].node.channel_type_features(), &nodes[1].node.init_features(), &open_channel, 0,
7242 &high_their_to_self_config, 0, &nodes[0].logger, /*is_0conf=*/false)
7245 ChannelError::Close(err) => { assert!(regex::Regex::new(r"They wanted our payments to be delayed by a needlessly long period\. Upper limit: \d+\. Actual: \d+").unwrap().is_match(err.as_str())); },
7246 _ => panic!("Unexpected event"),
7248 } else { assert!(false); }
7252 fn test_check_htlc_underpaying() {
7253 // Send payment through A -> B but A is maliciously
7254 // sending a probe payment (i.e less than expected value0
7255 // to B, B should refuse payment.
7257 let chanmon_cfgs = create_chanmon_cfgs(2);
7258 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7259 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7260 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7262 // Create some initial channels
7263 create_announced_chan_between_nodes(&nodes, 0, 1);
7265 let scorer = test_utils::TestScorer::new();
7266 let random_seed_bytes = chanmon_cfgs[1].keys_manager.get_secure_random_bytes();
7267 let payment_params = PaymentParameters::from_node_id(nodes[1].node.get_our_node_id(), TEST_FINAL_CLTV)
7268 .with_bolt11_features(nodes[1].node.bolt11_invoice_features()).unwrap();
7269 let route_params = RouteParameters::from_payment_params_and_value(payment_params, 10_000);
7270 let route = get_route(&nodes[0].node.get_our_node_id(), &route_params, &nodes[0].network_graph.read_only(),
7271 None, nodes[0].logger, &scorer, &Default::default(), &random_seed_bytes).unwrap();
7272 let (_, our_payment_hash, _) = get_payment_preimage_hash!(nodes[0]);
7273 let our_payment_secret = nodes[1].node.create_inbound_payment_for_hash(our_payment_hash, Some(100_000), 7200, None).unwrap();
7274 nodes[0].node.send_payment_with_route(&route, our_payment_hash,
7275 RecipientOnionFields::secret_only(our_payment_secret), PaymentId(our_payment_hash.0)).unwrap();
7276 check_added_monitors!(nodes[0], 1);
7278 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
7279 assert_eq!(events.len(), 1);
7280 let mut payment_event = SendEvent::from_event(events.pop().unwrap());
7281 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
7282 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
7284 // Note that we first have to wait a random delay before processing the receipt of the HTLC,
7285 // and then will wait a second random delay before failing the HTLC back:
7286 expect_pending_htlcs_forwardable!(nodes[1]);
7287 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash: our_payment_hash }]);
7289 // Node 3 is expecting payment of 100_000 but received 10_000,
7290 // it should fail htlc like we didn't know the preimage.
7291 nodes[1].node.process_pending_htlc_forwards();
7293 let events = nodes[1].node.get_and_clear_pending_msg_events();
7294 assert_eq!(events.len(), 1);
7295 let (update_fail_htlc, commitment_signed) = match events[0] {
7296 MessageSendEvent::UpdateHTLCs { node_id: _ , updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fulfill_htlcs, ref update_fail_htlcs, ref update_fail_malformed_htlcs, ref update_fee, ref commitment_signed } } => {
7297 assert!(update_add_htlcs.is_empty());
7298 assert!(update_fulfill_htlcs.is_empty());
7299 assert_eq!(update_fail_htlcs.len(), 1);
7300 assert!(update_fail_malformed_htlcs.is_empty());
7301 assert!(update_fee.is_none());
7302 (update_fail_htlcs[0].clone(), commitment_signed)
7304 _ => panic!("Unexpected event"),
7306 check_added_monitors!(nodes[1], 1);
7308 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlc);
7309 commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
7311 // 10_000 msat as u64, followed by a height of CHAN_CONFIRM_DEPTH as u32
7312 let mut expected_failure_data = (10_000 as u64).to_be_bytes().to_vec();
7313 expected_failure_data.extend_from_slice(&CHAN_CONFIRM_DEPTH.to_be_bytes());
7314 expect_payment_failed!(nodes[0], our_payment_hash, true, 0x4000|15, &expected_failure_data[..]);
7318 fn test_announce_disable_channels() {
7319 // Create 2 channels between A and B. Disconnect B. Call timer_tick_occurred and check for generated
7320 // ChannelUpdate. Reconnect B, reestablish and check there is non-generated ChannelUpdate.
7322 let chanmon_cfgs = create_chanmon_cfgs(2);
7323 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7324 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7325 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7327 create_announced_chan_between_nodes(&nodes, 0, 1);
7328 create_announced_chan_between_nodes(&nodes, 1, 0);
7329 create_announced_chan_between_nodes(&nodes, 0, 1);
7332 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id());
7333 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
7335 for _ in 0..DISABLE_GOSSIP_TICKS + 1 {
7336 nodes[0].node.timer_tick_occurred();
7338 let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
7339 assert_eq!(msg_events.len(), 3);
7340 let mut chans_disabled = HashMap::new();
7341 for e in msg_events {
7343 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
7344 assert_eq!(msg.contents.flags & (1<<1), 1<<1); // The "channel disabled" bit should be set
7345 // Check that each channel gets updated exactly once
7346 if chans_disabled.insert(msg.contents.short_channel_id, msg.contents.timestamp).is_some() {
7347 panic!("Generated ChannelUpdate for wrong chan!");
7350 _ => panic!("Unexpected event"),
7354 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init {
7355 features: nodes[1].node.init_features(), networks: None, remote_network_address: None
7357 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
7358 assert_eq!(reestablish_1.len(), 3);
7359 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init {
7360 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
7362 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
7363 assert_eq!(reestablish_2.len(), 3);
7365 // Reestablish chan_1
7366 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
7367 handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
7368 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
7369 handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
7370 // Reestablish chan_2
7371 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[1]);
7372 handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
7373 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[1]);
7374 handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
7375 // Reestablish chan_3
7376 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[2]);
7377 handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
7378 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[2]);
7379 handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
7381 for _ in 0..ENABLE_GOSSIP_TICKS {
7382 nodes[0].node.timer_tick_occurred();
7384 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
7385 nodes[0].node.timer_tick_occurred();
7386 let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
7387 assert_eq!(msg_events.len(), 3);
7388 for e in msg_events {
7390 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
7391 assert_eq!(msg.contents.flags & (1<<1), 0); // The "channel disabled" bit should be off
7392 match chans_disabled.remove(&msg.contents.short_channel_id) {
7393 // Each update should have a higher timestamp than the previous one, replacing
7395 Some(prev_timestamp) => assert!(msg.contents.timestamp > prev_timestamp),
7396 None => panic!("Generated ChannelUpdate for wrong chan!"),
7399 _ => panic!("Unexpected event"),
7402 // Check that each channel gets updated exactly once
7403 assert!(chans_disabled.is_empty());
7407 fn test_bump_penalty_txn_on_revoked_commitment() {
7408 // In case of penalty txn with too low feerates for getting into mempools, RBF-bump them to be sure
7409 // we're able to claim outputs on revoked commitment transaction before timelocks expiration
7411 let chanmon_cfgs = create_chanmon_cfgs(2);
7412 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7413 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7414 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7416 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000);
7418 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
7419 let payment_params = PaymentParameters::from_node_id(nodes[0].node.get_our_node_id(), 30)
7420 .with_bolt11_features(nodes[0].node.bolt11_invoice_features()).unwrap();
7421 let (route,_, _, _) = get_route_and_payment_hash!(nodes[1], nodes[0], payment_params, 3000000);
7422 send_along_route(&nodes[1], route, &vec!(&nodes[0])[..], 3000000);
7424 let revoked_txn = get_local_commitment_txn!(nodes[0], chan.2);
7425 // Revoked commitment txn with 4 outputs : to_local, to_remote, 1 outgoing HTLC, 1 incoming HTLC
7426 assert_eq!(revoked_txn[0].output.len(), 4);
7427 assert_eq!(revoked_txn[0].input.len(), 1);
7428 assert_eq!(revoked_txn[0].input[0].previous_output.txid, chan.3.txid());
7429 let revoked_txid = revoked_txn[0].txid();
7431 let mut penalty_sum = 0;
7432 for outp in revoked_txn[0].output.iter() {
7433 if outp.script_pubkey.is_v0_p2wsh() {
7434 penalty_sum += outp.value;
7438 // Connect blocks to change height_timer range to see if we use right soonest_timelock
7439 let header_114 = connect_blocks(&nodes[1], 14);
7441 // Actually revoke tx by claiming a HTLC
7442 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
7443 connect_block(&nodes[1], &create_dummy_block(header_114, 42, vec![revoked_txn[0].clone()]));
7444 check_added_monitors!(nodes[1], 1);
7446 // One or more justice tx should have been broadcast, check it
7450 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7451 assert_eq!(node_txn.len(), 1); // justice tx (broadcasted from ChannelMonitor)
7452 assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
7453 assert_eq!(node_txn[0].output.len(), 1);
7454 check_spends!(node_txn[0], revoked_txn[0]);
7455 let fee_1 = penalty_sum - node_txn[0].output[0].value;
7456 feerate_1 = fee_1 * 1000 / node_txn[0].weight().to_wu();
7457 penalty_1 = node_txn[0].txid();
7461 // After exhaustion of height timer, a new bumped justice tx should have been broadcast, check it
7462 connect_blocks(&nodes[1], 15);
7463 let mut penalty_2 = penalty_1;
7464 let mut feerate_2 = 0;
7466 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7467 assert_eq!(node_txn.len(), 1);
7468 if node_txn[0].input[0].previous_output.txid == revoked_txid {
7469 assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
7470 assert_eq!(node_txn[0].output.len(), 1);
7471 check_spends!(node_txn[0], revoked_txn[0]);
7472 penalty_2 = node_txn[0].txid();
7473 // Verify new bumped tx is different from last claiming transaction, we don't want spurrious rebroadcast
7474 assert_ne!(penalty_2, penalty_1);
7475 let fee_2 = penalty_sum - node_txn[0].output[0].value;
7476 feerate_2 = fee_2 * 1000 / node_txn[0].weight().to_wu();
7477 // Verify 25% bump heuristic
7478 assert!(feerate_2 * 100 >= feerate_1 * 125);
7482 assert_ne!(feerate_2, 0);
7484 // After exhaustion of height timer for a 2nd time, a new bumped justice tx should have been broadcast, check it
7485 connect_blocks(&nodes[1], 1);
7487 let mut feerate_3 = 0;
7489 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7490 assert_eq!(node_txn.len(), 1);
7491 if node_txn[0].input[0].previous_output.txid == revoked_txid {
7492 assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
7493 assert_eq!(node_txn[0].output.len(), 1);
7494 check_spends!(node_txn[0], revoked_txn[0]);
7495 penalty_3 = node_txn[0].txid();
7496 // Verify new bumped tx is different from last claiming transaction, we don't want spurrious rebroadcast
7497 assert_ne!(penalty_3, penalty_2);
7498 let fee_3 = penalty_sum - node_txn[0].output[0].value;
7499 feerate_3 = fee_3 * 1000 / node_txn[0].weight().to_wu();
7500 // Verify 25% bump heuristic
7501 assert!(feerate_3 * 100 >= feerate_2 * 125);
7505 assert_ne!(feerate_3, 0);
7507 nodes[1].node.get_and_clear_pending_events();
7508 nodes[1].node.get_and_clear_pending_msg_events();
7512 fn test_bump_penalty_txn_on_revoked_htlcs() {
7513 // In case of penalty txn with too low feerates for getting into mempools, RBF-bump them to sure
7514 // we're able to claim outputs on revoked HTLC transactions before timelocks expiration
7516 let mut chanmon_cfgs = create_chanmon_cfgs(2);
7517 chanmon_cfgs[1].keys_manager.disable_revocation_policy_check = true;
7518 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7519 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7520 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7522 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000);
7523 // Lock HTLC in both directions (using a slightly lower CLTV delay to provide timely RBF bumps)
7524 let payment_params = PaymentParameters::from_node_id(nodes[1].node.get_our_node_id(), 50).with_bolt11_features(nodes[1].node.bolt11_invoice_features()).unwrap();
7525 let scorer = test_utils::TestScorer::new();
7526 let random_seed_bytes = chanmon_cfgs[1].keys_manager.get_secure_random_bytes();
7527 let route_params = RouteParameters::from_payment_params_and_value(payment_params, 3_000_000);
7528 let route = get_route(&nodes[0].node.get_our_node_id(), &route_params, &nodes[0].network_graph.read_only(), None,
7529 nodes[0].logger, &scorer, &Default::default(), &random_seed_bytes).unwrap();
7530 let payment_preimage = send_along_route(&nodes[0], route, &[&nodes[1]], 3_000_000).0;
7531 let payment_params = PaymentParameters::from_node_id(nodes[0].node.get_our_node_id(), 50)
7532 .with_bolt11_features(nodes[0].node.bolt11_invoice_features()).unwrap();
7533 let route_params = RouteParameters::from_payment_params_and_value(payment_params, 3_000_000);
7534 let route = get_route(&nodes[1].node.get_our_node_id(), &route_params, &nodes[1].network_graph.read_only(), None,
7535 nodes[0].logger, &scorer, &Default::default(), &random_seed_bytes).unwrap();
7536 send_along_route(&nodes[1], route, &[&nodes[0]], 3_000_000);
7538 let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan.2);
7539 assert_eq!(revoked_local_txn[0].input.len(), 1);
7540 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
7542 // Revoke local commitment tx
7543 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
7545 // B will generate both revoked HTLC-timeout/HTLC-preimage txn from revoked commitment tx
7546 connect_block(&nodes[1], &create_dummy_block(nodes[1].best_block_hash(), 42, vec![revoked_local_txn[0].clone()]));
7547 check_closed_broadcast!(nodes[1], true);
7548 check_added_monitors!(nodes[1], 1);
7549 check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed, [nodes[0].node.get_our_node_id()], 1000000);
7550 connect_blocks(&nodes[1], 50); // Confirm blocks until the HTLC expires (note CLTV was explicitly 50 above)
7552 let revoked_htlc_txn = {
7553 let txn = nodes[1].tx_broadcaster.unique_txn_broadcast();
7554 assert_eq!(txn.len(), 2);
7556 assert_eq!(txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
7557 assert_eq!(txn[0].input.len(), 1);
7558 check_spends!(txn[0], revoked_local_txn[0]);
7560 assert_eq!(txn[1].input.len(), 1);
7561 assert_eq!(txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
7562 assert_eq!(txn[1].output.len(), 1);
7563 check_spends!(txn[1], revoked_local_txn[0]);
7568 // Broadcast set of revoked txn on A
7569 let hash_128 = connect_blocks(&nodes[0], 40);
7570 let block_11 = create_dummy_block(hash_128, 42, vec![revoked_local_txn[0].clone()]);
7571 connect_block(&nodes[0], &block_11);
7572 let block_129 = create_dummy_block(block_11.block_hash(), 42, vec![revoked_htlc_txn[0].clone(), revoked_htlc_txn[1].clone()]);
7573 connect_block(&nodes[0], &block_129);
7574 let events = nodes[0].node.get_and_clear_pending_events();
7575 expect_pending_htlcs_forwardable_from_events!(nodes[0], events[0..1], true);
7576 match events.last().unwrap() {
7577 Event::ChannelClosed { reason: ClosureReason::CommitmentTxConfirmed, .. } => {}
7578 _ => panic!("Unexpected event"),
7584 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7585 assert_eq!(node_txn.len(), 4); // 3 penalty txn on revoked commitment tx + 1 penalty tnx on revoked HTLC txn
7586 // Verify claim tx are spending revoked HTLC txn
7588 // node_txn 0-2 each spend a separate revoked output from revoked_local_txn[0]
7589 // Note that node_txn[0] and node_txn[1] are bogus - they double spend the revoked_htlc_txn
7590 // which are included in the same block (they are broadcasted because we scan the
7591 // transactions linearly and generate claims as we go, they likely should be removed in the
7593 assert_eq!(node_txn[0].input.len(), 1);
7594 check_spends!(node_txn[0], revoked_local_txn[0]);
7595 assert_eq!(node_txn[1].input.len(), 1);
7596 check_spends!(node_txn[1], revoked_local_txn[0]);
7597 assert_eq!(node_txn[2].input.len(), 1);
7598 check_spends!(node_txn[2], revoked_local_txn[0]);
7600 // Each of the three justice transactions claim a separate (single) output of the three
7601 // available, which we check here:
7602 assert_ne!(node_txn[0].input[0].previous_output, node_txn[1].input[0].previous_output);
7603 assert_ne!(node_txn[0].input[0].previous_output, node_txn[2].input[0].previous_output);
7604 assert_ne!(node_txn[1].input[0].previous_output, node_txn[2].input[0].previous_output);
7606 assert_eq!(node_txn[0].input[0].previous_output, revoked_htlc_txn[1].input[0].previous_output);
7607 assert_eq!(node_txn[1].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
7609 // node_txn[3] spends the revoked outputs from the revoked_htlc_txn (which only have one
7610 // output, checked above).
7611 assert_eq!(node_txn[3].input.len(), 2);
7612 assert_eq!(node_txn[3].output.len(), 1);
7613 check_spends!(node_txn[3], revoked_htlc_txn[0], revoked_htlc_txn[1]);
7615 first = node_txn[3].txid();
7616 // Store both feerates for later comparison
7617 let fee_1 = revoked_htlc_txn[0].output[0].value + revoked_htlc_txn[1].output[0].value - node_txn[3].output[0].value;
7618 feerate_1 = fee_1 * 1000 / node_txn[3].weight().to_wu();
7619 penalty_txn = vec![node_txn[2].clone()];
7623 // Connect one more block to see if bumped penalty are issued for HTLC txn
7624 let block_130 = create_dummy_block(block_129.block_hash(), 42, penalty_txn);
7625 connect_block(&nodes[0], &block_130);
7626 let block_131 = create_dummy_block(block_130.block_hash(), 42, Vec::new());
7627 connect_block(&nodes[0], &block_131);
7629 // Few more blocks to confirm penalty txn
7630 connect_blocks(&nodes[0], 4);
7631 assert!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
7632 let header_144 = connect_blocks(&nodes[0], 9);
7634 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7635 assert_eq!(node_txn.len(), 1);
7637 assert_eq!(node_txn[0].input.len(), 2);
7638 check_spends!(node_txn[0], revoked_htlc_txn[0], revoked_htlc_txn[1]);
7639 // Verify bumped tx is different and 25% bump heuristic
7640 assert_ne!(first, node_txn[0].txid());
7641 let fee_2 = revoked_htlc_txn[0].output[0].value + revoked_htlc_txn[1].output[0].value - node_txn[0].output[0].value;
7642 let feerate_2 = fee_2 * 1000 / node_txn[0].weight().to_wu();
7643 assert!(feerate_2 * 100 > feerate_1 * 125);
7644 let txn = vec![node_txn[0].clone()];
7648 // Broadcast claim txn and confirm blocks to avoid further bumps on this outputs
7649 connect_block(&nodes[0], &create_dummy_block(header_144, 42, node_txn));
7650 connect_blocks(&nodes[0], 20);
7652 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7653 // We verify than no new transaction has been broadcast because previously
7654 // we were buggy on this exact behavior by not tracking for monitoring remote HTLC outputs (see #411)
7655 // which means we wouldn't see a spend of them by a justice tx and bumped justice tx
7656 // were generated forever instead of safe cleaning after confirmation and ANTI_REORG_SAFE_DELAY blocks.
7657 // Enforce spending of revoked htlc output by claiming transaction remove request as expected and dry
7658 // up bumped justice generation.
7659 assert_eq!(node_txn.len(), 0);
7662 check_closed_broadcast!(nodes[0], true);
7663 check_added_monitors!(nodes[0], 1);
7667 fn test_bump_penalty_txn_on_remote_commitment() {
7668 // In case of claim txn with too low feerates for getting into mempools, RBF-bump them to be sure
7669 // we're able to claim outputs on remote commitment transaction before timelocks expiration
7672 // Provide preimage for one
7673 // Check aggregation
7675 let chanmon_cfgs = create_chanmon_cfgs(2);
7676 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7677 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7678 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7680 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000);
7681 let (payment_preimage, payment_hash, ..) = route_payment(&nodes[0], &[&nodes[1]], 3_000_000);
7682 route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000).0;
7684 // Remote commitment txn with 4 outputs : to_local, to_remote, 1 outgoing HTLC, 1 incoming HTLC
7685 let remote_txn = get_local_commitment_txn!(nodes[0], chan.2);
7686 assert_eq!(remote_txn[0].output.len(), 4);
7687 assert_eq!(remote_txn[0].input.len(), 1);
7688 assert_eq!(remote_txn[0].input[0].previous_output.txid, chan.3.txid());
7690 // Claim a HTLC without revocation (provide B monitor with preimage)
7691 nodes[1].node.claim_funds(payment_preimage);
7692 expect_payment_claimed!(nodes[1], payment_hash, 3_000_000);
7693 mine_transaction(&nodes[1], &remote_txn[0]);
7694 check_added_monitors!(nodes[1], 2);
7695 connect_blocks(&nodes[1], TEST_FINAL_CLTV); // Confirm blocks until the HTLC expires
7697 // One or more claim tx should have been broadcast, check it
7701 let feerate_timeout;
7702 let feerate_preimage;
7704 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7705 // 3 transactions including:
7706 // preimage and timeout sweeps from remote commitment + preimage sweep bump
7707 assert_eq!(node_txn.len(), 3);
7708 assert_eq!(node_txn[0].input.len(), 1);
7709 assert_eq!(node_txn[1].input.len(), 1);
7710 assert_eq!(node_txn[2].input.len(), 1);
7711 check_spends!(node_txn[0], remote_txn[0]);
7712 check_spends!(node_txn[1], remote_txn[0]);
7713 check_spends!(node_txn[2], remote_txn[0]);
7715 preimage = node_txn[0].txid();
7716 let index = node_txn[0].input[0].previous_output.vout;
7717 let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
7718 feerate_preimage = fee * 1000 / node_txn[0].weight().to_wu();
7720 let (preimage_bump_tx, timeout_tx) = if node_txn[2].input[0].previous_output == node_txn[0].input[0].previous_output {
7721 (node_txn[2].clone(), node_txn[1].clone())
7723 (node_txn[1].clone(), node_txn[2].clone())
7726 preimage_bump = preimage_bump_tx;
7727 check_spends!(preimage_bump, remote_txn[0]);
7728 assert_eq!(node_txn[0].input[0].previous_output, preimage_bump.input[0].previous_output);
7730 timeout = timeout_tx.txid();
7731 let index = timeout_tx.input[0].previous_output.vout;
7732 let fee = remote_txn[0].output[index as usize].value - timeout_tx.output[0].value;
7733 feerate_timeout = fee * 1000 / timeout_tx.weight().to_wu();
7737 assert_ne!(feerate_timeout, 0);
7738 assert_ne!(feerate_preimage, 0);
7740 // After exhaustion of height timer, new bumped claim txn should have been broadcast, check it
7741 connect_blocks(&nodes[1], 1);
7743 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7744 assert_eq!(node_txn.len(), 1);
7745 assert_eq!(node_txn[0].input.len(), 1);
7746 assert_eq!(preimage_bump.input.len(), 1);
7747 check_spends!(node_txn[0], remote_txn[0]);
7748 check_spends!(preimage_bump, remote_txn[0]);
7750 let index = preimage_bump.input[0].previous_output.vout;
7751 let fee = remote_txn[0].output[index as usize].value - preimage_bump.output[0].value;
7752 let new_feerate = fee * 1000 / preimage_bump.weight().to_wu();
7753 assert!(new_feerate * 100 > feerate_timeout * 125);
7754 assert_ne!(timeout, preimage_bump.txid());
7756 let index = node_txn[0].input[0].previous_output.vout;
7757 let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
7758 let new_feerate = fee * 1000 / node_txn[0].weight().to_wu();
7759 assert!(new_feerate * 100 > feerate_preimage * 125);
7760 assert_ne!(preimage, node_txn[0].txid());
7765 nodes[1].node.get_and_clear_pending_events();
7766 nodes[1].node.get_and_clear_pending_msg_events();
7770 fn test_counterparty_raa_skip_no_crash() {
7771 // Previously, if our counterparty sent two RAAs in a row without us having provided a
7772 // commitment transaction, we would have happily carried on and provided them the next
7773 // commitment transaction based on one RAA forward. This would probably eventually have led to
7774 // channel closure, but it would not have resulted in funds loss. Still, our
7775 // TestChannelSigner would have panicked as it doesn't like jumps into the future. Here, we
7776 // check simply that the channel is closed in response to such an RAA, but don't check whether
7777 // we decide to punish our counterparty for revoking their funds (as we don't currently
7779 let chanmon_cfgs = create_chanmon_cfgs(2);
7780 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7781 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7782 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7783 let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1).2;
7785 let per_commitment_secret;
7786 let next_per_commitment_point;
7788 let per_peer_state = nodes[0].node.per_peer_state.read().unwrap();
7789 let mut guard = per_peer_state.get(&nodes[1].node.get_our_node_id()).unwrap().lock().unwrap();
7790 let keys = guard.channel_by_id.get_mut(&channel_id).map(
7791 |phase| if let ChannelPhase::Funded(chan) = phase { Some(chan) } else { None }
7792 ).flatten().unwrap().get_signer();
7794 const INITIAL_COMMITMENT_NUMBER: u64 = (1 << 48) - 1;
7796 // Make signer believe we got a counterparty signature, so that it allows the revocation
7797 keys.as_ecdsa().unwrap().get_enforcement_state().last_holder_commitment -= 1;
7798 per_commitment_secret = keys.as_ref().release_commitment_secret(INITIAL_COMMITMENT_NUMBER);
7800 // Must revoke without gaps
7801 keys.as_ecdsa().unwrap().get_enforcement_state().last_holder_commitment -= 1;
7802 keys.as_ref().release_commitment_secret(INITIAL_COMMITMENT_NUMBER - 1);
7804 keys.as_ecdsa().unwrap().get_enforcement_state().last_holder_commitment -= 1;
7805 next_per_commitment_point = PublicKey::from_secret_key(&Secp256k1::new(),
7806 &SecretKey::from_slice(&keys.as_ref().release_commitment_secret(INITIAL_COMMITMENT_NUMBER - 2)).unwrap());
7809 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(),
7810 &msgs::RevokeAndACK {
7812 per_commitment_secret,
7813 next_per_commitment_point,
7815 next_local_nonce: None,
7817 assert_eq!(check_closed_broadcast!(nodes[1], true).unwrap().data, "Received an unexpected revoke_and_ack");
7818 check_added_monitors!(nodes[1], 1);
7819 check_closed_event!(nodes[1], 1, ClosureReason::ProcessingError { err: "Received an unexpected revoke_and_ack".to_string() }
7820 , [nodes[0].node.get_our_node_id()], 100000);
7824 fn test_bump_txn_sanitize_tracking_maps() {
7825 // Sanitizing pendning_claim_request and claimable_outpoints used to be buggy,
7826 // verify we clean then right after expiration of ANTI_REORG_DELAY.
7828 let chanmon_cfgs = create_chanmon_cfgs(2);
7829 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7830 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7831 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7833 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000);
7834 // Lock HTLC in both directions
7835 let (payment_preimage_1, ..) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000);
7836 let (_, payment_hash_2, ..) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 9_000_000);
7838 let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan.2);
7839 assert_eq!(revoked_local_txn[0].input.len(), 1);
7840 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
7842 // Revoke local commitment tx
7843 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_1);
7845 // Broadcast set of revoked txn on A
7846 connect_blocks(&nodes[0], TEST_FINAL_CLTV + 2 - CHAN_CONFIRM_DEPTH);
7847 expect_pending_htlcs_forwardable_and_htlc_handling_failed_ignore!(nodes[0], vec![HTLCDestination::FailedPayment { payment_hash: payment_hash_2 }]);
7848 assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 0);
7850 mine_transaction(&nodes[0], &revoked_local_txn[0]);
7851 check_closed_broadcast!(nodes[0], true);
7852 check_added_monitors!(nodes[0], 1);
7853 check_closed_event!(nodes[0], 1, ClosureReason::CommitmentTxConfirmed, [nodes[1].node.get_our_node_id()], 1000000);
7855 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7856 assert_eq!(node_txn.len(), 3); //ChannelMonitor: justice txn * 3
7857 check_spends!(node_txn[0], revoked_local_txn[0]);
7858 check_spends!(node_txn[1], revoked_local_txn[0]);
7859 check_spends!(node_txn[2], revoked_local_txn[0]);
7860 let penalty_txn = vec![node_txn[0].clone(), node_txn[1].clone(), node_txn[2].clone()];
7864 connect_block(&nodes[0], &create_dummy_block(nodes[0].best_block_hash(), 42, penalty_txn));
7865 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7867 let monitor = nodes[0].chain_monitor.chain_monitor.get_monitor(OutPoint { txid: chan.3.txid(), index: 0 }).unwrap();
7868 assert!(monitor.inner.lock().unwrap().onchain_tx_handler.pending_claim_requests.is_empty());
7869 assert!(monitor.inner.lock().unwrap().onchain_tx_handler.claimable_outpoints.is_empty());
7874 fn test_channel_conf_timeout() {
7875 // Tests that, for inbound channels, we give up on them if the funding transaction does not
7876 // confirm within 2016 blocks, as recommended by BOLT 2.
7877 let chanmon_cfgs = create_chanmon_cfgs(2);
7878 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7879 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7880 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7882 let _funding_tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 1_000_000, 100_000);
7884 // The outbound node should wait forever for confirmation:
7885 // This matches `channel::FUNDING_CONF_DEADLINE_BLOCKS` and BOLT 2's suggested timeout, thus is
7886 // copied here instead of directly referencing the constant.
7887 connect_blocks(&nodes[0], 2016);
7888 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
7890 // The inbound node should fail the channel after exactly 2016 blocks
7891 connect_blocks(&nodes[1], 2015);
7892 check_added_monitors!(nodes[1], 0);
7893 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
7895 connect_blocks(&nodes[1], 1);
7896 check_added_monitors!(nodes[1], 1);
7897 check_closed_event!(nodes[1], 1, ClosureReason::FundingTimedOut, [nodes[0].node.get_our_node_id()], 1000000);
7898 let close_ev = nodes[1].node.get_and_clear_pending_msg_events();
7899 assert_eq!(close_ev.len(), 1);
7901 MessageSendEvent::HandleError { action: ErrorAction::DisconnectPeer { ref msg }, ref node_id } => {
7902 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
7903 assert_eq!(msg.as_ref().unwrap().data, "Channel closed because funding transaction failed to confirm within 2016 blocks");
7905 _ => panic!("Unexpected event"),
7910 fn test_override_channel_config() {
7911 let chanmon_cfgs = create_chanmon_cfgs(2);
7912 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7913 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7914 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7916 // Node0 initiates a channel to node1 using the override config.
7917 let mut override_config = UserConfig::default();
7918 override_config.channel_handshake_config.our_to_self_delay = 200;
7920 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 16_000_000, 12_000_000, 42, None, Some(override_config)).unwrap();
7922 // Assert the channel created by node0 is using the override config.
7923 let res = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
7924 assert_eq!(res.channel_flags, 0);
7925 assert_eq!(res.to_self_delay, 200);
7929 fn test_override_0msat_htlc_minimum() {
7930 let mut zero_config = UserConfig::default();
7931 zero_config.channel_handshake_config.our_htlc_minimum_msat = 0;
7932 let chanmon_cfgs = create_chanmon_cfgs(2);
7933 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7934 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, Some(zero_config.clone())]);
7935 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7937 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 16_000_000, 12_000_000, 42, None, Some(zero_config)).unwrap();
7938 let res = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
7939 assert_eq!(res.htlc_minimum_msat, 1);
7941 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &res);
7942 let res = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
7943 assert_eq!(res.htlc_minimum_msat, 1);
7947 fn test_channel_update_has_correct_htlc_maximum_msat() {
7948 // Tests that the `ChannelUpdate` message has the correct values for `htlc_maximum_msat` set.
7949 // Bolt 7 specifies that if present `htlc_maximum_msat`:
7950 // 1. MUST be set to less than or equal to the channel capacity. In LDK, this is capped to
7951 // 90% of the `channel_value`.
7952 // 2. MUST be set to less than or equal to the `max_htlc_value_in_flight_msat` received from the peer.
7954 let mut config_30_percent = UserConfig::default();
7955 config_30_percent.channel_handshake_config.announced_channel = true;
7956 config_30_percent.channel_handshake_config.max_inbound_htlc_value_in_flight_percent_of_channel = 30;
7957 let mut config_50_percent = UserConfig::default();
7958 config_50_percent.channel_handshake_config.announced_channel = true;
7959 config_50_percent.channel_handshake_config.max_inbound_htlc_value_in_flight_percent_of_channel = 50;
7960 let mut config_95_percent = UserConfig::default();
7961 config_95_percent.channel_handshake_config.announced_channel = true;
7962 config_95_percent.channel_handshake_config.max_inbound_htlc_value_in_flight_percent_of_channel = 95;
7963 let mut config_100_percent = UserConfig::default();
7964 config_100_percent.channel_handshake_config.announced_channel = true;
7965 config_100_percent.channel_handshake_config.max_inbound_htlc_value_in_flight_percent_of_channel = 100;
7967 let chanmon_cfgs = create_chanmon_cfgs(4);
7968 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
7969 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[Some(config_30_percent), Some(config_50_percent), Some(config_95_percent), Some(config_100_percent)]);
7970 let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
7972 let channel_value_satoshis = 100000;
7973 let channel_value_msat = channel_value_satoshis * 1000;
7974 let channel_value_30_percent_msat = (channel_value_msat as f64 * 0.3) as u64;
7975 let channel_value_50_percent_msat = (channel_value_msat as f64 * 0.5) as u64;
7976 let channel_value_90_percent_msat = (channel_value_msat as f64 * 0.9) as u64;
7978 let (node_0_chan_update, node_1_chan_update, _, _) = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, channel_value_satoshis, 10001);
7979 let (node_2_chan_update, node_3_chan_update, _, _) = create_announced_chan_between_nodes_with_value(&nodes, 2, 3, channel_value_satoshis, 10001);
7981 // Assert that `node[0]`'s `ChannelUpdate` is capped at 50 percent of the `channel_value`, as
7982 // that's the value of `node[1]`'s `holder_max_htlc_value_in_flight_msat`.
7983 assert_eq!(node_0_chan_update.contents.htlc_maximum_msat, channel_value_50_percent_msat);
7984 // Assert that `node[1]`'s `ChannelUpdate` is capped at 30 percent of the `channel_value`, as
7985 // that's the value of `node[0]`'s `holder_max_htlc_value_in_flight_msat`.
7986 assert_eq!(node_1_chan_update.contents.htlc_maximum_msat, channel_value_30_percent_msat);
7988 // Assert that `node[2]`'s `ChannelUpdate` is capped at 90 percent of the `channel_value`, as
7989 // the value of `node[3]`'s `holder_max_htlc_value_in_flight_msat` (100%), exceeds 90% of the
7991 assert_eq!(node_2_chan_update.contents.htlc_maximum_msat, channel_value_90_percent_msat);
7992 // Assert that `node[3]`'s `ChannelUpdate` is capped at 90 percent of the `channel_value`, as
7993 // the value of `node[2]`'s `holder_max_htlc_value_in_flight_msat` (95%), exceeds 90% of the
7995 assert_eq!(node_3_chan_update.contents.htlc_maximum_msat, channel_value_90_percent_msat);
7999 fn test_manually_accept_inbound_channel_request() {
8000 let mut manually_accept_conf = UserConfig::default();
8001 manually_accept_conf.manually_accept_inbound_channels = true;
8002 let chanmon_cfgs = create_chanmon_cfgs(2);
8003 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8004 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, Some(manually_accept_conf.clone())]);
8005 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8007 let temp_channel_id = nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None, Some(manually_accept_conf)).unwrap();
8008 let res = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8010 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &res);
8012 // Assert that `nodes[1]` has no `MessageSendEvent::SendAcceptChannel` in `msg_events` before
8013 // accepting the inbound channel request.
8014 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
8016 let events = nodes[1].node.get_and_clear_pending_events();
8018 Event::OpenChannelRequest { temporary_channel_id, .. } => {
8019 nodes[1].node.accept_inbound_channel(&temporary_channel_id, &nodes[0].node.get_our_node_id(), 23).unwrap();
8021 _ => panic!("Unexpected event"),
8024 let accept_msg_ev = nodes[1].node.get_and_clear_pending_msg_events();
8025 assert_eq!(accept_msg_ev.len(), 1);
8027 match accept_msg_ev[0] {
8028 MessageSendEvent::SendAcceptChannel { ref node_id, .. } => {
8029 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
8031 _ => panic!("Unexpected event"),
8034 nodes[1].node.force_close_broadcasting_latest_txn(&temp_channel_id, &nodes[0].node.get_our_node_id()).unwrap();
8036 let close_msg_ev = nodes[1].node.get_and_clear_pending_msg_events();
8037 assert_eq!(close_msg_ev.len(), 1);
8039 let events = nodes[1].node.get_and_clear_pending_events();
8041 Event::ChannelClosed { user_channel_id, .. } => {
8042 assert_eq!(user_channel_id, 23);
8044 _ => panic!("Unexpected event"),
8049 fn test_manually_reject_inbound_channel_request() {
8050 let mut manually_accept_conf = UserConfig::default();
8051 manually_accept_conf.manually_accept_inbound_channels = true;
8052 let chanmon_cfgs = create_chanmon_cfgs(2);
8053 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8054 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, Some(manually_accept_conf.clone())]);
8055 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8057 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None, Some(manually_accept_conf)).unwrap();
8058 let res = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8060 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &res);
8062 // Assert that `nodes[1]` has no `MessageSendEvent::SendAcceptChannel` in `msg_events` before
8063 // rejecting the inbound channel request.
8064 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
8066 let events = nodes[1].node.get_and_clear_pending_events();
8068 Event::OpenChannelRequest { temporary_channel_id, .. } => {
8069 nodes[1].node.force_close_broadcasting_latest_txn(&temporary_channel_id, &nodes[0].node.get_our_node_id()).unwrap();
8071 _ => panic!("Unexpected event"),
8074 let close_msg_ev = nodes[1].node.get_and_clear_pending_msg_events();
8075 assert_eq!(close_msg_ev.len(), 1);
8077 match close_msg_ev[0] {
8078 MessageSendEvent::HandleError { ref node_id, .. } => {
8079 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
8081 _ => panic!("Unexpected event"),
8084 // There should be no more events to process, as the channel was never opened.
8085 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
8089 fn test_can_not_accept_inbound_channel_twice() {
8090 let mut manually_accept_conf = UserConfig::default();
8091 manually_accept_conf.manually_accept_inbound_channels = true;
8092 let chanmon_cfgs = create_chanmon_cfgs(2);
8093 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8094 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, Some(manually_accept_conf.clone())]);
8095 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8097 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None, Some(manually_accept_conf)).unwrap();
8098 let res = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8100 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &res);
8102 // Assert that `nodes[1]` has no `MessageSendEvent::SendAcceptChannel` in `msg_events` before
8103 // accepting the inbound channel request.
8104 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
8106 let events = nodes[1].node.get_and_clear_pending_events();
8108 Event::OpenChannelRequest { temporary_channel_id, .. } => {
8109 nodes[1].node.accept_inbound_channel(&temporary_channel_id, &nodes[0].node.get_our_node_id(), 0).unwrap();
8110 let api_res = nodes[1].node.accept_inbound_channel(&temporary_channel_id, &nodes[0].node.get_our_node_id(), 0);
8112 Err(APIError::APIMisuseError { err }) => {
8113 assert_eq!(err, "No such channel awaiting to be accepted.");
8115 Ok(_) => panic!("Channel shouldn't be possible to be accepted twice"),
8116 Err(e) => panic!("Unexpected Error {:?}", e),
8119 _ => panic!("Unexpected event"),
8122 // Ensure that the channel wasn't closed after attempting to accept it twice.
8123 let accept_msg_ev = nodes[1].node.get_and_clear_pending_msg_events();
8124 assert_eq!(accept_msg_ev.len(), 1);
8126 match accept_msg_ev[0] {
8127 MessageSendEvent::SendAcceptChannel { ref node_id, .. } => {
8128 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
8130 _ => panic!("Unexpected event"),
8135 fn test_can_not_accept_unknown_inbound_channel() {
8136 let chanmon_cfg = create_chanmon_cfgs(2);
8137 let node_cfg = create_node_cfgs(2, &chanmon_cfg);
8138 let node_chanmgr = create_node_chanmgrs(2, &node_cfg, &[None, None]);
8139 let nodes = create_network(2, &node_cfg, &node_chanmgr);
8141 let unknown_channel_id = ChannelId::new_zero();
8142 let api_res = nodes[0].node.accept_inbound_channel(&unknown_channel_id, &nodes[1].node.get_our_node_id(), 0);
8144 Err(APIError::APIMisuseError { err }) => {
8145 assert_eq!(err, "No such channel awaiting to be accepted.");
8147 Ok(_) => panic!("It shouldn't be possible to accept an unkown channel"),
8148 Err(e) => panic!("Unexpected Error: {:?}", e),
8153 fn test_onion_value_mpp_set_calculation() {
8154 // Test that we use the onion value `amt_to_forward` when
8155 // calculating whether we've reached the `total_msat` of an MPP
8156 // by having a routing node forward more than `amt_to_forward`
8157 // and checking that the receiving node doesn't generate
8158 // a PaymentClaimable event too early
8160 let chanmon_cfgs = create_chanmon_cfgs(node_count);
8161 let node_cfgs = create_node_cfgs(node_count, &chanmon_cfgs);
8162 let node_chanmgrs = create_node_chanmgrs(node_count, &node_cfgs, &vec![None; node_count]);
8163 let mut nodes = create_network(node_count, &node_cfgs, &node_chanmgrs);
8165 let chan_1_id = create_announced_chan_between_nodes(&nodes, 0, 1).0.contents.short_channel_id;
8166 let chan_2_id = create_announced_chan_between_nodes(&nodes, 0, 2).0.contents.short_channel_id;
8167 let chan_3_id = create_announced_chan_between_nodes(&nodes, 1, 3).0.contents.short_channel_id;
8168 let chan_4_id = create_announced_chan_between_nodes(&nodes, 2, 3).0.contents.short_channel_id;
8170 let total_msat = 100_000;
8171 let expected_paths: &[&[&Node]] = &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]];
8172 let (mut route, our_payment_hash, our_payment_preimage, our_payment_secret) = get_route_and_payment_hash!(&nodes[0], nodes[3], total_msat);
8173 let sample_path = route.paths.pop().unwrap();
8175 let mut path_1 = sample_path.clone();
8176 path_1.hops[0].pubkey = nodes[1].node.get_our_node_id();
8177 path_1.hops[0].short_channel_id = chan_1_id;
8178 path_1.hops[1].pubkey = nodes[3].node.get_our_node_id();
8179 path_1.hops[1].short_channel_id = chan_3_id;
8180 path_1.hops[1].fee_msat = 100_000;
8181 route.paths.push(path_1);
8183 let mut path_2 = sample_path.clone();
8184 path_2.hops[0].pubkey = nodes[2].node.get_our_node_id();
8185 path_2.hops[0].short_channel_id = chan_2_id;
8186 path_2.hops[1].pubkey = nodes[3].node.get_our_node_id();
8187 path_2.hops[1].short_channel_id = chan_4_id;
8188 path_2.hops[1].fee_msat = 1_000;
8189 route.paths.push(path_2);
8192 let payment_id = PaymentId(nodes[0].keys_manager.backing.get_secure_random_bytes());
8193 let onion_session_privs = nodes[0].node.test_add_new_pending_payment(our_payment_hash,
8194 RecipientOnionFields::secret_only(our_payment_secret), payment_id, &route).unwrap();
8195 nodes[0].node.test_send_payment_internal(&route, our_payment_hash,
8196 RecipientOnionFields::secret_only(our_payment_secret), None, payment_id, Some(total_msat), onion_session_privs).unwrap();
8197 check_added_monitors!(nodes[0], expected_paths.len());
8199 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
8200 assert_eq!(events.len(), expected_paths.len());
8203 let ev = remove_first_msg_event_to_node(&expected_paths[0][0].node.get_our_node_id(), &mut events);
8204 let mut payment_event = SendEvent::from_event(ev);
8205 let mut prev_node = &nodes[0];
8207 for (idx, &node) in expected_paths[0].iter().enumerate() {
8208 assert_eq!(node.node.get_our_node_id(), payment_event.node_id);
8210 if idx == 0 { // routing node
8211 let session_priv = [3; 32];
8212 let height = nodes[0].best_block_info().1;
8213 let session_priv = SecretKey::from_slice(&session_priv).unwrap();
8214 let mut onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
8215 let (mut onion_payloads, _, _) = onion_utils::build_onion_payloads(&route.paths[0], 100_000,
8216 RecipientOnionFields::secret_only(our_payment_secret), height + 1, &None).unwrap();
8217 // Edit amt_to_forward to simulate the sender having set
8218 // the final amount and the routing node taking less fee
8219 if let msgs::OutboundOnionPayload::Receive { ref mut amt_msat, .. } = onion_payloads[1] {
8222 let new_onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &our_payment_hash).unwrap();
8223 payment_event.msgs[0].onion_routing_packet = new_onion_packet;
8226 node.node.handle_update_add_htlc(&prev_node.node.get_our_node_id(), &payment_event.msgs[0]);
8227 check_added_monitors!(node, 0);
8228 commitment_signed_dance!(node, prev_node, payment_event.commitment_msg, false);
8229 expect_pending_htlcs_forwardable!(node);
8232 let mut events_2 = node.node.get_and_clear_pending_msg_events();
8233 assert_eq!(events_2.len(), 1);
8234 check_added_monitors!(node, 1);
8235 payment_event = SendEvent::from_event(events_2.remove(0));
8236 assert_eq!(payment_event.msgs.len(), 1);
8238 let events_2 = node.node.get_and_clear_pending_events();
8239 assert!(events_2.is_empty());
8246 let ev = remove_first_msg_event_to_node(&expected_paths[1][0].node.get_our_node_id(), &mut events);
8247 pass_along_path(&nodes[0], expected_paths[1], 101_000, our_payment_hash.clone(), Some(our_payment_secret), ev, true, None);
8249 claim_payment_along_route(&nodes[0], expected_paths, false, our_payment_preimage);
8252 fn do_test_overshoot_mpp(msat_amounts: &[u64], total_msat: u64) {
8254 let routing_node_count = msat_amounts.len();
8255 let node_count = routing_node_count + 2;
8257 let chanmon_cfgs = create_chanmon_cfgs(node_count);
8258 let node_cfgs = create_node_cfgs(node_count, &chanmon_cfgs);
8259 let node_chanmgrs = create_node_chanmgrs(node_count, &node_cfgs, &vec![None; node_count]);
8260 let nodes = create_network(node_count, &node_cfgs, &node_chanmgrs);
8265 // Create channels for each amount
8266 let mut expected_paths = Vec::with_capacity(routing_node_count);
8267 let mut src_chan_ids = Vec::with_capacity(routing_node_count);
8268 let mut dst_chan_ids = Vec::with_capacity(routing_node_count);
8269 for i in 0..routing_node_count {
8270 let routing_node = 2 + i;
8271 let src_chan_id = create_announced_chan_between_nodes(&nodes, src_idx, routing_node).0.contents.short_channel_id;
8272 src_chan_ids.push(src_chan_id);
8273 let dst_chan_id = create_announced_chan_between_nodes(&nodes, routing_node, dst_idx).0.contents.short_channel_id;
8274 dst_chan_ids.push(dst_chan_id);
8275 let path = vec![&nodes[routing_node], &nodes[dst_idx]];
8276 expected_paths.push(path);
8278 let expected_paths: Vec<&[&Node]> = expected_paths.iter().map(|route| route.as_slice()).collect();
8280 // Create a route for each amount
8281 let example_amount = 100000;
8282 let (mut route, our_payment_hash, our_payment_preimage, our_payment_secret) = get_route_and_payment_hash!(&nodes[src_idx], nodes[dst_idx], example_amount);
8283 let sample_path = route.paths.pop().unwrap();
8284 for i in 0..routing_node_count {
8285 let routing_node = 2 + i;
8286 let mut path = sample_path.clone();
8287 path.hops[0].pubkey = nodes[routing_node].node.get_our_node_id();
8288 path.hops[0].short_channel_id = src_chan_ids[i];
8289 path.hops[1].pubkey = nodes[dst_idx].node.get_our_node_id();
8290 path.hops[1].short_channel_id = dst_chan_ids[i];
8291 path.hops[1].fee_msat = msat_amounts[i];
8292 route.paths.push(path);
8295 // Send payment with manually set total_msat
8296 let payment_id = PaymentId(nodes[src_idx].keys_manager.backing.get_secure_random_bytes());
8297 let onion_session_privs = nodes[src_idx].node.test_add_new_pending_payment(our_payment_hash,
8298 RecipientOnionFields::secret_only(our_payment_secret), payment_id, &route).unwrap();
8299 nodes[src_idx].node.test_send_payment_internal(&route, our_payment_hash,
8300 RecipientOnionFields::secret_only(our_payment_secret), None, payment_id, Some(total_msat), onion_session_privs).unwrap();
8301 check_added_monitors!(nodes[src_idx], expected_paths.len());
8303 let mut events = nodes[src_idx].node.get_and_clear_pending_msg_events();
8304 assert_eq!(events.len(), expected_paths.len());
8305 let mut amount_received = 0;
8306 for (path_idx, expected_path) in expected_paths.iter().enumerate() {
8307 let ev = remove_first_msg_event_to_node(&expected_path[0].node.get_our_node_id(), &mut events);
8309 let current_path_amount = msat_amounts[path_idx];
8310 amount_received += current_path_amount;
8311 let became_claimable_now = amount_received >= total_msat && amount_received - current_path_amount < total_msat;
8312 pass_along_path(&nodes[src_idx], expected_path, amount_received, our_payment_hash.clone(), Some(our_payment_secret), ev, became_claimable_now, None);
8315 claim_payment_along_route(&nodes[src_idx], &expected_paths, false, our_payment_preimage);
8319 fn test_overshoot_mpp() {
8320 do_test_overshoot_mpp(&[100_000, 101_000], 200_000);
8321 do_test_overshoot_mpp(&[100_000, 10_000, 100_000], 200_000);
8325 fn test_simple_mpp() {
8326 // Simple test of sending a multi-path payment.
8327 let chanmon_cfgs = create_chanmon_cfgs(4);
8328 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
8329 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
8330 let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
8332 let chan_1_id = create_announced_chan_between_nodes(&nodes, 0, 1).0.contents.short_channel_id;
8333 let chan_2_id = create_announced_chan_between_nodes(&nodes, 0, 2).0.contents.short_channel_id;
8334 let chan_3_id = create_announced_chan_between_nodes(&nodes, 1, 3).0.contents.short_channel_id;
8335 let chan_4_id = create_announced_chan_between_nodes(&nodes, 2, 3).0.contents.short_channel_id;
8337 let (mut route, payment_hash, payment_preimage, payment_secret) = get_route_and_payment_hash!(&nodes[0], nodes[3], 100000);
8338 let path = route.paths[0].clone();
8339 route.paths.push(path);
8340 route.paths[0].hops[0].pubkey = nodes[1].node.get_our_node_id();
8341 route.paths[0].hops[0].short_channel_id = chan_1_id;
8342 route.paths[0].hops[1].short_channel_id = chan_3_id;
8343 route.paths[1].hops[0].pubkey = nodes[2].node.get_our_node_id();
8344 route.paths[1].hops[0].short_channel_id = chan_2_id;
8345 route.paths[1].hops[1].short_channel_id = chan_4_id;
8346 send_along_route_with_secret(&nodes[0], route, &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], 200_000, payment_hash, payment_secret);
8347 claim_payment_along_route(&nodes[0], &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], false, payment_preimage);
8351 fn test_preimage_storage() {
8352 // Simple test of payment preimage storage allowing no client-side storage to claim payments
8353 let chanmon_cfgs = create_chanmon_cfgs(2);
8354 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8355 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8356 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8358 create_announced_chan_between_nodes(&nodes, 0, 1).0.contents.short_channel_id;
8361 let (payment_hash, payment_secret) = nodes[1].node.create_inbound_payment(Some(100_000), 7200, None).unwrap();
8362 let (route, _, _, _) = get_route_and_payment_hash!(nodes[0], nodes[1], 100_000);
8363 nodes[0].node.send_payment_with_route(&route, payment_hash,
8364 RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_hash.0)).unwrap();
8365 check_added_monitors!(nodes[0], 1);
8366 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
8367 let mut payment_event = SendEvent::from_event(events.pop().unwrap());
8368 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
8369 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
8371 // Note that after leaving the above scope we have no knowledge of any arguments or return
8372 // values from previous calls.
8373 expect_pending_htlcs_forwardable!(nodes[1]);
8374 let events = nodes[1].node.get_and_clear_pending_events();
8375 assert_eq!(events.len(), 1);
8377 Event::PaymentClaimable { ref purpose, .. } => {
8379 PaymentPurpose::InvoicePayment { payment_preimage, .. } => {
8380 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage.unwrap());
8382 _ => panic!("expected PaymentPurpose::InvoicePayment")
8385 _ => panic!("Unexpected event"),
8390 fn test_bad_secret_hash() {
8391 // Simple test of unregistered payment hash/invalid payment secret handling
8392 let chanmon_cfgs = create_chanmon_cfgs(2);
8393 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8394 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8395 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8397 create_announced_chan_between_nodes(&nodes, 0, 1).0.contents.short_channel_id;
8399 let random_payment_hash = PaymentHash([42; 32]);
8400 let random_payment_secret = PaymentSecret([43; 32]);
8401 let (our_payment_hash, our_payment_secret) = nodes[1].node.create_inbound_payment(Some(100_000), 2, None).unwrap();
8402 let (route, _, _, _) = get_route_and_payment_hash!(nodes[0], nodes[1], 100_000);
8404 // All the below cases should end up being handled exactly identically, so we macro the
8405 // resulting events.
8406 macro_rules! handle_unknown_invalid_payment_data {
8407 ($payment_hash: expr) => {
8408 check_added_monitors!(nodes[0], 1);
8409 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
8410 let payment_event = SendEvent::from_event(events.pop().unwrap());
8411 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
8412 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
8414 // We have to forward pending HTLCs once to process the receipt of the HTLC and then
8415 // again to process the pending backwards-failure of the HTLC
8416 expect_pending_htlcs_forwardable!(nodes[1]);
8417 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], vec![HTLCDestination::FailedPayment{ payment_hash: $payment_hash }]);
8418 check_added_monitors!(nodes[1], 1);
8420 // We should fail the payment back
8421 let mut events = nodes[1].node.get_and_clear_pending_msg_events();
8422 match events.pop().unwrap() {
8423 MessageSendEvent::UpdateHTLCs { node_id: _, updates: msgs::CommitmentUpdate { update_fail_htlcs, commitment_signed, .. } } => {
8424 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
8425 commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false);
8427 _ => panic!("Unexpected event"),
8432 let expected_error_code = 0x4000|15; // incorrect_or_unknown_payment_details
8433 // Error data is the HTLC value (100,000) and current block height
8434 let expected_error_data = [0, 0, 0, 0, 0, 1, 0x86, 0xa0, 0, 0, 0, CHAN_CONFIRM_DEPTH as u8];
8436 // Send a payment with the right payment hash but the wrong payment secret
8437 nodes[0].node.send_payment_with_route(&route, our_payment_hash,
8438 RecipientOnionFields::secret_only(random_payment_secret), PaymentId(our_payment_hash.0)).unwrap();
8439 handle_unknown_invalid_payment_data!(our_payment_hash);
8440 expect_payment_failed!(nodes[0], our_payment_hash, true, expected_error_code, expected_error_data);
8442 // Send a payment with a random payment hash, but the right payment secret
8443 nodes[0].node.send_payment_with_route(&route, random_payment_hash,
8444 RecipientOnionFields::secret_only(our_payment_secret), PaymentId(random_payment_hash.0)).unwrap();
8445 handle_unknown_invalid_payment_data!(random_payment_hash);
8446 expect_payment_failed!(nodes[0], random_payment_hash, true, expected_error_code, expected_error_data);
8448 // Send a payment with a random payment hash and random payment secret
8449 nodes[0].node.send_payment_with_route(&route, random_payment_hash,
8450 RecipientOnionFields::secret_only(random_payment_secret), PaymentId(random_payment_hash.0)).unwrap();
8451 handle_unknown_invalid_payment_data!(random_payment_hash);
8452 expect_payment_failed!(nodes[0], random_payment_hash, true, expected_error_code, expected_error_data);
8456 fn test_update_err_monitor_lockdown() {
8457 // Our monitor will lock update of local commitment transaction if a broadcastion condition
8458 // has been fulfilled (either force-close from Channel or block height requiring a HTLC-
8459 // timeout). Trying to update monitor after lockdown should return a ChannelMonitorUpdateStatus
8462 // This scenario may happen in a watchtower setup, where watchtower process a block height
8463 // triggering a timeout while a slow-block-processing ChannelManager receives a local signed
8464 // commitment at same time.
8466 let chanmon_cfgs = create_chanmon_cfgs(2);
8467 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8468 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8469 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8471 // Create some initial channel
8472 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
8473 let outpoint = OutPoint { txid: chan_1.3.txid(), index: 0 };
8475 // Rebalance the network to generate htlc in the two directions
8476 send_payment(&nodes[0], &vec!(&nodes[1])[..], 10_000_000);
8478 // Route a HTLC from node 0 to node 1 (but don't settle)
8479 let (preimage, payment_hash, ..) = route_payment(&nodes[0], &[&nodes[1]], 9_000_000);
8481 // Copy ChainMonitor to simulate a watchtower and update block height of node 0 until its ChannelMonitor timeout HTLC onchain
8482 let chain_source = test_utils::TestChainSource::new(Network::Testnet);
8483 let logger = test_utils::TestLogger::with_id(format!("node {}", 0));
8484 let persister = test_utils::TestPersister::new();
8487 let monitor = nodes[0].chain_monitor.chain_monitor.get_monitor(outpoint).unwrap();
8488 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<TestChannelSigner>)>::read(
8489 &mut io::Cursor::new(&monitor.encode()), (nodes[0].keys_manager, nodes[0].keys_manager)).unwrap().1;
8490 assert!(new_monitor == *monitor);
8493 let watchtower = test_utils::TestChainMonitor::new(Some(&chain_source), &chanmon_cfgs[0].tx_broadcaster, &logger, &chanmon_cfgs[0].fee_estimator, &persister, &node_cfgs[0].keys_manager);
8494 assert_eq!(watchtower.watch_channel(outpoint, new_monitor), Ok(ChannelMonitorUpdateStatus::Completed));
8497 let block = create_dummy_block(BlockHash::all_zeros(), 42, Vec::new());
8498 // Make the tx_broadcaster aware of enough blocks that it doesn't think we're violating
8499 // transaction lock time requirements here.
8500 chanmon_cfgs[0].tx_broadcaster.blocks.lock().unwrap().resize(200, (block.clone(), 200));
8501 watchtower.chain_monitor.block_connected(&block, 200);
8503 // Try to update ChannelMonitor
8504 nodes[1].node.claim_funds(preimage);
8505 check_added_monitors!(nodes[1], 1);
8506 expect_payment_claimed!(nodes[1], payment_hash, 9_000_000);
8508 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
8509 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
8510 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
8512 let mut node_0_per_peer_lock;
8513 let mut node_0_peer_state_lock;
8514 if let ChannelPhase::Funded(ref mut channel) = get_channel_ref!(nodes[0], nodes[1], node_0_per_peer_lock, node_0_peer_state_lock, chan_1.2) {
8515 if let Ok(Some(update)) = channel.commitment_signed(&updates.commitment_signed, &node_cfgs[0].logger) {
8516 assert_eq!(watchtower.chain_monitor.update_channel(outpoint, &update), ChannelMonitorUpdateStatus::InProgress);
8517 assert_eq!(nodes[0].chain_monitor.update_channel(outpoint, &update), ChannelMonitorUpdateStatus::Completed);
8518 } else { assert!(false); }
8523 // Our local monitor is in-sync and hasn't processed yet timeout
8524 check_added_monitors!(nodes[0], 1);
8525 let events = nodes[0].node.get_and_clear_pending_events();
8526 assert_eq!(events.len(), 1);
8530 fn test_concurrent_monitor_claim() {
8531 // Watchtower A receives block, broadcasts state N, then channel receives new state N+1,
8532 // sending it to both watchtowers, Bob accepts N+1, then receives block and broadcasts
8533 // the latest state N+1, Alice rejects state N+1, but Bob has already broadcast it,
8534 // state N+1 confirms. Alice claims output from state N+1.
8536 let chanmon_cfgs = create_chanmon_cfgs(2);
8537 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8538 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8539 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8541 // Create some initial channel
8542 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
8543 let outpoint = OutPoint { txid: chan_1.3.txid(), index: 0 };
8545 // Rebalance the network to generate htlc in the two directions
8546 send_payment(&nodes[0], &vec!(&nodes[1])[..], 10_000_000);
8548 // Route a HTLC from node 0 to node 1 (but don't settle)
8549 route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000).0;
8551 // Copy ChainMonitor to simulate watchtower Alice and update block height her ChannelMonitor timeout HTLC onchain
8552 let chain_source = test_utils::TestChainSource::new(Network::Testnet);
8553 let logger = test_utils::TestLogger::with_id(format!("node {}", "Alice"));
8554 let persister = test_utils::TestPersister::new();
8555 let alice_broadcaster = test_utils::TestBroadcaster::with_blocks(
8556 Arc::new(Mutex::new(nodes[0].blocks.lock().unwrap().clone())),
8558 let watchtower_alice = {
8560 let monitor = nodes[0].chain_monitor.chain_monitor.get_monitor(outpoint).unwrap();
8561 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<TestChannelSigner>)>::read(
8562 &mut io::Cursor::new(&monitor.encode()), (nodes[0].keys_manager, nodes[0].keys_manager)).unwrap().1;
8563 assert!(new_monitor == *monitor);
8566 let watchtower = test_utils::TestChainMonitor::new(Some(&chain_source), &alice_broadcaster, &logger, &chanmon_cfgs[0].fee_estimator, &persister, &node_cfgs[0].keys_manager);
8567 assert_eq!(watchtower.watch_channel(outpoint, new_monitor), Ok(ChannelMonitorUpdateStatus::Completed));
8570 let block = create_dummy_block(BlockHash::all_zeros(), 42, Vec::new());
8571 // Make Alice aware of enough blocks that it doesn't think we're violating transaction lock time
8572 // requirements here.
8573 const HTLC_TIMEOUT_BROADCAST: u32 = CHAN_CONFIRM_DEPTH + 1 + TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS;
8574 alice_broadcaster.blocks.lock().unwrap().resize((HTLC_TIMEOUT_BROADCAST) as usize, (block.clone(), HTLC_TIMEOUT_BROADCAST));
8575 watchtower_alice.chain_monitor.block_connected(&block, HTLC_TIMEOUT_BROADCAST);
8577 // Watchtower Alice should have broadcast a commitment/HTLC-timeout
8579 let mut txn = alice_broadcaster.txn_broadcast();
8580 assert_eq!(txn.len(), 2);
8581 check_spends!(txn[0], chan_1.3);
8582 check_spends!(txn[1], txn[0]);
8585 // Copy ChainMonitor to simulate watchtower Bob and make it receive a commitment update first.
8586 let chain_source = test_utils::TestChainSource::new(Network::Testnet);
8587 let logger = test_utils::TestLogger::with_id(format!("node {}", "Bob"));
8588 let persister = test_utils::TestPersister::new();
8589 let bob_broadcaster = test_utils::TestBroadcaster::with_blocks(Arc::clone(&alice_broadcaster.blocks));
8590 let watchtower_bob = {
8592 let monitor = nodes[0].chain_monitor.chain_monitor.get_monitor(outpoint).unwrap();
8593 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<TestChannelSigner>)>::read(
8594 &mut io::Cursor::new(&monitor.encode()), (nodes[0].keys_manager, nodes[0].keys_manager)).unwrap().1;
8595 assert!(new_monitor == *monitor);
8598 let watchtower = test_utils::TestChainMonitor::new(Some(&chain_source), &bob_broadcaster, &logger, &chanmon_cfgs[0].fee_estimator, &persister, &node_cfgs[0].keys_manager);
8599 assert_eq!(watchtower.watch_channel(outpoint, new_monitor), Ok(ChannelMonitorUpdateStatus::Completed));
8602 watchtower_bob.chain_monitor.block_connected(&create_dummy_block(BlockHash::all_zeros(), 42, Vec::new()), HTLC_TIMEOUT_BROADCAST - 1);
8604 // Route another payment to generate another update with still previous HTLC pending
8605 let (route, payment_hash, _, payment_secret) = get_route_and_payment_hash!(nodes[1], nodes[0], 3000000);
8606 nodes[1].node.send_payment_with_route(&route, payment_hash,
8607 RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_hash.0)).unwrap();
8608 check_added_monitors!(nodes[1], 1);
8610 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
8611 assert_eq!(updates.update_add_htlcs.len(), 1);
8612 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &updates.update_add_htlcs[0]);
8614 let mut node_0_per_peer_lock;
8615 let mut node_0_peer_state_lock;
8616 if let ChannelPhase::Funded(ref mut channel) = get_channel_ref!(nodes[0], nodes[1], node_0_per_peer_lock, node_0_peer_state_lock, chan_1.2) {
8617 if let Ok(Some(update)) = channel.commitment_signed(&updates.commitment_signed, &node_cfgs[0].logger) {
8618 // Watchtower Alice should already have seen the block and reject the update
8619 assert_eq!(watchtower_alice.chain_monitor.update_channel(outpoint, &update), ChannelMonitorUpdateStatus::InProgress);
8620 assert_eq!(watchtower_bob.chain_monitor.update_channel(outpoint, &update), ChannelMonitorUpdateStatus::Completed);
8621 assert_eq!(nodes[0].chain_monitor.update_channel(outpoint, &update), ChannelMonitorUpdateStatus::Completed);
8622 } else { assert!(false); }
8627 // Our local monitor is in-sync and hasn't processed yet timeout
8628 check_added_monitors!(nodes[0], 1);
8630 //// Provide one more block to watchtower Bob, expect broadcast of commitment and HTLC-Timeout
8631 watchtower_bob.chain_monitor.block_connected(&create_dummy_block(BlockHash::all_zeros(), 42, Vec::new()), HTLC_TIMEOUT_BROADCAST);
8633 // Watchtower Bob should have broadcast a commitment/HTLC-timeout
8636 let mut txn = bob_broadcaster.txn_broadcast();
8637 assert_eq!(txn.len(), 2);
8638 bob_state_y = txn.remove(0);
8641 // We confirm Bob's state Y on Alice, she should broadcast a HTLC-timeout
8642 let height = HTLC_TIMEOUT_BROADCAST + 1;
8643 connect_blocks(&nodes[0], height - nodes[0].best_block_info().1);
8644 check_closed_broadcast(&nodes[0], 1, true);
8645 check_closed_event!(&nodes[0], 1, ClosureReason::HolderForceClosed, false,
8646 [nodes[1].node.get_our_node_id()], 100000);
8647 watchtower_alice.chain_monitor.block_connected(&create_dummy_block(BlockHash::all_zeros(), 42, vec![bob_state_y.clone()]), height);
8648 check_added_monitors(&nodes[0], 1);
8650 let htlc_txn = alice_broadcaster.txn_broadcast();
8651 assert_eq!(htlc_txn.len(), 1);
8652 check_spends!(htlc_txn[0], bob_state_y);
8657 fn test_pre_lockin_no_chan_closed_update() {
8658 // Test that if a peer closes a channel in response to a funding_created message we don't
8659 // generate a channel update (as the channel cannot appear on chain without a funding_signed
8662 // Doing so would imply a channel monitor update before the initial channel monitor
8663 // registration, violating our API guarantees.
8665 // Previously, full_stack_target managed to hit this case by opening then closing a channel,
8666 // then opening a second channel with the same funding output as the first (which is not
8667 // rejected because the first channel does not exist in the ChannelManager) and closing it
8668 // before receiving funding_signed.
8669 let chanmon_cfgs = create_chanmon_cfgs(2);
8670 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8671 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8672 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8674 // Create an initial channel
8675 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None, None).unwrap();
8676 let mut open_chan_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8677 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_chan_msg);
8678 let accept_chan_msg = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
8679 nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), &accept_chan_msg);
8681 // Move the first channel through the funding flow...
8682 let (temporary_channel_id, tx, _) = create_funding_transaction(&nodes[0], &nodes[1].node.get_our_node_id(), 100000, 42);
8684 nodes[0].node.funding_transaction_generated(&temporary_channel_id, &nodes[1].node.get_our_node_id(), tx.clone()).unwrap();
8685 check_added_monitors!(nodes[0], 0);
8687 let funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
8688 let channel_id = crate::chain::transaction::OutPoint { txid: funding_created_msg.funding_txid, index: funding_created_msg.funding_output_index }.to_channel_id();
8689 nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msgs::ErrorMessage { channel_id, data: "Hi".to_owned() });
8690 assert!(nodes[0].chain_monitor.added_monitors.lock().unwrap().is_empty());
8691 check_closed_event!(nodes[0], 2, ClosureReason::CounterpartyForceClosed { peer_msg: UntrustedString("Hi".to_string()) }, true,
8692 [nodes[1].node.get_our_node_id()], 100000);
8696 fn test_htlc_no_detection() {
8697 // This test is a mutation to underscore the detection logic bug we had
8698 // before #653. HTLC value routed is above the remaining balance, thus
8699 // inverting HTLC and `to_remote` output. HTLC will come second and
8700 // it wouldn't be seen by pre-#653 detection as we were enumerate()'ing
8701 // on a watched outputs vector (Vec<TxOut>) thus implicitly relying on
8702 // outputs order detection for correct spending children filtring.
8704 let chanmon_cfgs = create_chanmon_cfgs(2);
8705 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8706 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8707 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8709 // Create some initial channels
8710 let chan_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001);
8712 send_payment(&nodes[0], &vec!(&nodes[1])[..], 1_000_000);
8713 let (_, our_payment_hash, ..) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 2_000_000);
8714 let local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
8715 assert_eq!(local_txn[0].input.len(), 1);
8716 assert_eq!(local_txn[0].output.len(), 3);
8717 check_spends!(local_txn[0], chan_1.3);
8719 // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
8720 let block = create_dummy_block(nodes[0].best_block_hash(), 42, vec![local_txn[0].clone()]);
8721 connect_block(&nodes[0], &block);
8722 // We deliberately connect the local tx twice as this should provoke a failure calling
8723 // this test before #653 fix.
8724 chain::Listen::block_connected(&nodes[0].chain_monitor.chain_monitor, &block, nodes[0].best_block_info().1 + 1);
8725 check_closed_broadcast!(nodes[0], true);
8726 check_added_monitors!(nodes[0], 1);
8727 check_closed_event!(nodes[0], 1, ClosureReason::CommitmentTxConfirmed, [nodes[1].node.get_our_node_id()], 100000);
8728 connect_blocks(&nodes[0], TEST_FINAL_CLTV);
8730 let htlc_timeout = {
8731 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8732 assert_eq!(node_txn.len(), 1);
8733 assert_eq!(node_txn[0].input.len(), 1);
8734 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
8735 check_spends!(node_txn[0], local_txn[0]);
8739 connect_block(&nodes[0], &create_dummy_block(nodes[0].best_block_hash(), 42, vec![htlc_timeout.clone()]));
8740 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
8741 expect_payment_failed!(nodes[0], our_payment_hash, false);
8744 fn do_test_onchain_htlc_settlement_after_close(broadcast_alice: bool, go_onchain_before_fulfill: bool) {
8745 // If we route an HTLC, then learn the HTLC's preimage after the upstream channel has been
8746 // force-closed, we must claim that HTLC on-chain. (Given an HTLC forwarded from Alice --> Bob -->
8747 // Carol, Alice would be the upstream node, and Carol the downstream.)
8749 // Steps of the test:
8750 // 1) Alice sends a HTLC to Carol through Bob.
8751 // 2) Carol doesn't settle the HTLC.
8752 // 3) If broadcast_alice is true, Alice force-closes her channel with Bob. Else Bob force closes.
8753 // Steps 4 and 5 may be reordered depending on go_onchain_before_fulfill.
8754 // 4) Bob sees the Alice's commitment on his chain or vice versa. An offered output is present
8755 // but can't be claimed as Bob doesn't have yet knowledge of the preimage.
8756 // 5) Carol release the preimage to Bob off-chain.
8757 // 6) Bob claims the offered output on the broadcasted commitment.
8758 let chanmon_cfgs = create_chanmon_cfgs(3);
8759 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
8760 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
8761 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
8763 // Create some initial channels
8764 let chan_ab = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001);
8765 create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 100000, 10001);
8767 // Steps (1) and (2):
8768 // Send an HTLC Alice --> Bob --> Carol, but Carol doesn't settle the HTLC back.
8769 let (payment_preimage, payment_hash, ..) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3_000_000);
8771 // Check that Alice's commitment transaction now contains an output for this HTLC.
8772 let alice_txn = get_local_commitment_txn!(nodes[0], chan_ab.2);
8773 check_spends!(alice_txn[0], chan_ab.3);
8774 assert_eq!(alice_txn[0].output.len(), 2);
8775 check_spends!(alice_txn[1], alice_txn[0]); // 2nd transaction is a non-final HTLC-timeout
8776 assert_eq!(alice_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
8777 assert_eq!(alice_txn.len(), 2);
8779 // Steps (3) and (4):
8780 // If `go_onchain_before_fufill`, broadcast the relevant commitment transaction and check that Bob
8781 // responds by (1) broadcasting a channel update and (2) adding a new ChannelMonitor.
8782 let mut force_closing_node = 0; // Alice force-closes
8783 let mut counterparty_node = 1; // Bob if Alice force-closes
8786 if !broadcast_alice {
8787 force_closing_node = 1;
8788 counterparty_node = 0;
8790 nodes[force_closing_node].node.force_close_broadcasting_latest_txn(&chan_ab.2, &nodes[counterparty_node].node.get_our_node_id()).unwrap();
8791 check_closed_broadcast!(nodes[force_closing_node], true);
8792 check_added_monitors!(nodes[force_closing_node], 1);
8793 check_closed_event!(nodes[force_closing_node], 1, ClosureReason::HolderForceClosed, [nodes[counterparty_node].node.get_our_node_id()], 100000);
8794 if go_onchain_before_fulfill {
8795 let txn_to_broadcast = match broadcast_alice {
8796 true => alice_txn.clone(),
8797 false => get_local_commitment_txn!(nodes[1], chan_ab.2)
8799 connect_block(&nodes[1], &create_dummy_block(nodes[1].best_block_hash(), 42, vec![txn_to_broadcast[0].clone()]));
8800 if broadcast_alice {
8801 check_closed_broadcast!(nodes[1], true);
8802 check_added_monitors!(nodes[1], 1);
8803 check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed, [nodes[0].node.get_our_node_id()], 100000);
8808 // Carol then claims the funds and sends an update_fulfill message to Bob, and they go through the
8809 // process of removing the HTLC from their commitment transactions.
8810 nodes[2].node.claim_funds(payment_preimage);
8811 check_added_monitors!(nodes[2], 1);
8812 expect_payment_claimed!(nodes[2], payment_hash, 3_000_000);
8814 let carol_updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
8815 assert!(carol_updates.update_add_htlcs.is_empty());
8816 assert!(carol_updates.update_fail_htlcs.is_empty());
8817 assert!(carol_updates.update_fail_malformed_htlcs.is_empty());
8818 assert!(carol_updates.update_fee.is_none());
8819 assert_eq!(carol_updates.update_fulfill_htlcs.len(), 1);
8821 nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &carol_updates.update_fulfill_htlcs[0]);
8822 let went_onchain = go_onchain_before_fulfill || force_closing_node == 1;
8823 expect_payment_forwarded!(nodes[1], nodes[0], nodes[2], if went_onchain { None } else { Some(1000) }, went_onchain, false);
8824 // If Alice broadcasted but Bob doesn't know yet, here he prepares to tell her about the preimage.
8825 if !go_onchain_before_fulfill && broadcast_alice {
8826 let events = nodes[1].node.get_and_clear_pending_msg_events();
8827 assert_eq!(events.len(), 1);
8829 MessageSendEvent::UpdateHTLCs { ref node_id, .. } => {
8830 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
8832 _ => panic!("Unexpected event"),
8835 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &carol_updates.commitment_signed);
8836 // One monitor update for the preimage to update the Bob<->Alice channel, one monitor update
8837 // Carol<->Bob's updated commitment transaction info.
8838 check_added_monitors!(nodes[1], 2);
8840 let events = nodes[1].node.get_and_clear_pending_msg_events();
8841 assert_eq!(events.len(), 2);
8842 let bob_revocation = match events[0] {
8843 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
8844 assert_eq!(*node_id, nodes[2].node.get_our_node_id());
8847 _ => panic!("Unexpected event"),
8849 let bob_updates = match events[1] {
8850 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
8851 assert_eq!(*node_id, nodes[2].node.get_our_node_id());
8854 _ => panic!("Unexpected event"),
8857 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bob_revocation);
8858 check_added_monitors!(nodes[2], 1);
8859 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bob_updates.commitment_signed);
8860 check_added_monitors!(nodes[2], 1);
8862 let events = nodes[2].node.get_and_clear_pending_msg_events();
8863 assert_eq!(events.len(), 1);
8864 let carol_revocation = match events[0] {
8865 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
8866 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
8869 _ => panic!("Unexpected event"),
8871 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &carol_revocation);
8872 check_added_monitors!(nodes[1], 1);
8874 // If this test requires the force-closed channel to not be on-chain until after the fulfill,
8875 // here's where we put said channel's commitment tx on-chain.
8876 let mut txn_to_broadcast = alice_txn.clone();
8877 if !broadcast_alice { txn_to_broadcast = get_local_commitment_txn!(nodes[1], chan_ab.2); }
8878 if !go_onchain_before_fulfill {
8879 connect_block(&nodes[1], &create_dummy_block(nodes[1].best_block_hash(), 42, vec![txn_to_broadcast[0].clone()]));
8880 // If Bob was the one to force-close, he will have already passed these checks earlier.
8881 if broadcast_alice {
8882 check_closed_broadcast!(nodes[1], true);
8883 check_added_monitors!(nodes[1], 1);
8884 check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed, [nodes[0].node.get_our_node_id()], 100000);
8886 let mut bob_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8887 if broadcast_alice {
8888 assert_eq!(bob_txn.len(), 1);
8889 check_spends!(bob_txn[0], txn_to_broadcast[0]);
8891 if nodes[1].connect_style.borrow().updates_best_block_first() {
8892 assert_eq!(bob_txn.len(), 3);
8893 assert_eq!(bob_txn[0].txid(), bob_txn[1].txid());
8895 assert_eq!(bob_txn.len(), 2);
8897 check_spends!(bob_txn[0], chan_ab.3);
8902 // Finally, check that Bob broadcasted a preimage-claiming transaction for the HTLC output on the
8903 // broadcasted commitment transaction.
8905 let script_weight = match broadcast_alice {
8906 true => OFFERED_HTLC_SCRIPT_WEIGHT,
8907 false => ACCEPTED_HTLC_SCRIPT_WEIGHT
8909 // If Alice force-closed, Bob only broadcasts a HTLC-output-claiming transaction. Otherwise,
8910 // Bob force-closed and broadcasts the commitment transaction along with a
8911 // HTLC-output-claiming transaction.
8912 let mut bob_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
8913 if broadcast_alice {
8914 assert_eq!(bob_txn.len(), 1);
8915 check_spends!(bob_txn[0], txn_to_broadcast[0]);
8916 assert_eq!(bob_txn[0].input[0].witness.last().unwrap().len(), script_weight);
8918 assert_eq!(bob_txn.len(), if nodes[1].connect_style.borrow().updates_best_block_first() { 3 } else { 2 });
8919 let htlc_tx = bob_txn.pop().unwrap();
8920 check_spends!(htlc_tx, txn_to_broadcast[0]);
8921 assert_eq!(htlc_tx.input[0].witness.last().unwrap().len(), script_weight);
8927 fn test_onchain_htlc_settlement_after_close() {
8928 do_test_onchain_htlc_settlement_after_close(true, true);
8929 do_test_onchain_htlc_settlement_after_close(false, true); // Technically redundant, but may as well
8930 do_test_onchain_htlc_settlement_after_close(true, false);
8931 do_test_onchain_htlc_settlement_after_close(false, false);
8935 fn test_duplicate_temporary_channel_id_from_different_peers() {
8936 // Tests that we can accept two different `OpenChannel` requests with the same
8937 // `temporary_channel_id`, as long as they are from different peers.
8938 let chanmon_cfgs = create_chanmon_cfgs(3);
8939 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
8940 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
8941 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
8943 // Create an first channel channel
8944 nodes[1].node.create_channel(nodes[0].node.get_our_node_id(), 100000, 10001, 42, None, None).unwrap();
8945 let mut open_chan_msg_chan_1_0 = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
8947 // Create an second channel
8948 nodes[2].node.create_channel(nodes[0].node.get_our_node_id(), 100000, 10001, 43, None, None).unwrap();
8949 let mut open_chan_msg_chan_2_0 = get_event_msg!(nodes[2], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
8951 // Modify the `OpenChannel` from `nodes[2]` to `nodes[0]` to ensure that it uses the same
8952 // `temporary_channel_id` as the `OpenChannel` from nodes[1] to nodes[0].
8953 open_chan_msg_chan_2_0.temporary_channel_id = open_chan_msg_chan_1_0.temporary_channel_id;
8955 // Assert that `nodes[0]` can accept both `OpenChannel` requests, even though they use the same
8956 // `temporary_channel_id` as they are from different peers.
8957 nodes[0].node.handle_open_channel(&nodes[1].node.get_our_node_id(), &open_chan_msg_chan_1_0);
8959 let events = nodes[0].node.get_and_clear_pending_msg_events();
8960 assert_eq!(events.len(), 1);
8962 MessageSendEvent::SendAcceptChannel { node_id, msg } => {
8963 assert_eq!(node_id, &nodes[1].node.get_our_node_id());
8964 assert_eq!(msg.temporary_channel_id, open_chan_msg_chan_1_0.temporary_channel_id);
8966 _ => panic!("Unexpected event"),
8970 nodes[0].node.handle_open_channel(&nodes[2].node.get_our_node_id(), &open_chan_msg_chan_2_0);
8972 let events = nodes[0].node.get_and_clear_pending_msg_events();
8973 assert_eq!(events.len(), 1);
8975 MessageSendEvent::SendAcceptChannel { node_id, msg } => {
8976 assert_eq!(node_id, &nodes[2].node.get_our_node_id());
8977 assert_eq!(msg.temporary_channel_id, open_chan_msg_chan_1_0.temporary_channel_id);
8979 _ => panic!("Unexpected event"),
8985 fn test_duplicate_chan_id() {
8986 // Test that if a given peer tries to open a channel with the same channel_id as one that is
8987 // already open we reject it and keep the old channel.
8989 // Previously, full_stack_target managed to figure out that if you tried to open two channels
8990 // with the same funding output (ie post-funding channel_id), we'd create a monitor update for
8991 // the existing channel when we detect the duplicate new channel, screwing up our monitor
8992 // updating logic for the existing channel.
8993 let chanmon_cfgs = create_chanmon_cfgs(2);
8994 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8995 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8996 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8998 // Create an initial channel
8999 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None, None).unwrap();
9000 let mut open_chan_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
9001 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_chan_msg);
9002 nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), &get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id()));
9004 // Try to create a second channel with the same temporary_channel_id as the first and check
9005 // that it is rejected.
9006 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_chan_msg);
9008 let events = nodes[1].node.get_and_clear_pending_msg_events();
9009 assert_eq!(events.len(), 1);
9011 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
9012 // Technically, at this point, nodes[1] would be justified in thinking both the
9013 // first (valid) and second (invalid) channels are closed, given they both have
9014 // the same non-temporary channel_id. However, currently we do not, so we just
9015 // move forward with it.
9016 assert_eq!(msg.channel_id, open_chan_msg.temporary_channel_id);
9017 assert_eq!(node_id, nodes[0].node.get_our_node_id());
9019 _ => panic!("Unexpected event"),
9023 // Move the first channel through the funding flow...
9024 let (temporary_channel_id, tx, funding_output) = create_funding_transaction(&nodes[0], &nodes[1].node.get_our_node_id(), 100000, 42);
9026 nodes[0].node.funding_transaction_generated(&temporary_channel_id, &nodes[1].node.get_our_node_id(), tx.clone()).unwrap();
9027 check_added_monitors!(nodes[0], 0);
9029 let mut funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
9030 nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created_msg);
9032 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
9033 assert_eq!(added_monitors.len(), 1);
9034 assert_eq!(added_monitors[0].0, funding_output);
9035 added_monitors.clear();
9037 expect_channel_pending_event(&nodes[1], &nodes[0].node.get_our_node_id());
9039 let funding_signed_msg = get_event_msg!(nodes[1], MessageSendEvent::SendFundingSigned, nodes[0].node.get_our_node_id());
9041 let funding_outpoint = crate::chain::transaction::OutPoint { txid: funding_created_msg.funding_txid, index: funding_created_msg.funding_output_index };
9042 let channel_id = funding_outpoint.to_channel_id();
9044 // Now we have the first channel past funding_created (ie it has a txid-based channel_id, not a
9047 // First try to open a second channel with a temporary channel id equal to the txid-based one.
9048 // Technically this is allowed by the spec, but we don't support it and there's little reason
9049 // to. Still, it shouldn't cause any other issues.
9050 open_chan_msg.temporary_channel_id = channel_id;
9051 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_chan_msg);
9053 let events = nodes[1].node.get_and_clear_pending_msg_events();
9054 assert_eq!(events.len(), 1);
9056 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
9057 // Technically, at this point, nodes[1] would be justified in thinking both
9058 // channels are closed, but currently we do not, so we just move forward with it.
9059 assert_eq!(msg.channel_id, open_chan_msg.temporary_channel_id);
9060 assert_eq!(node_id, nodes[0].node.get_our_node_id());
9062 _ => panic!("Unexpected event"),
9066 // Now try to create a second channel which has a duplicate funding output.
9067 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None, None).unwrap();
9068 let open_chan_2_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
9069 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_chan_2_msg);
9070 nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), &get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id()));
9071 create_funding_transaction(&nodes[0], &nodes[1].node.get_our_node_id(), 100000, 42); // Get and check the FundingGenerationReady event
9073 let funding_created = {
9074 let per_peer_state = nodes[0].node.per_peer_state.read().unwrap();
9075 let mut a_peer_state = per_peer_state.get(&nodes[1].node.get_our_node_id()).unwrap().lock().unwrap();
9076 // Once we call `get_funding_created` the channel has a duplicate channel_id as
9077 // another channel in the ChannelManager - an invalid state. Thus, we'd panic later when we
9078 // try to create another channel. Instead, we drop the channel entirely here (leaving the
9079 // channelmanager in a possibly nonsense state instead).
9080 match a_peer_state.channel_by_id.remove(&open_chan_2_msg.temporary_channel_id).unwrap() {
9081 ChannelPhase::UnfundedOutboundV1(mut chan) => {
9082 let logger = test_utils::TestLogger::new();
9083 chan.get_funding_created(tx.clone(), funding_outpoint, false, &&logger).map_err(|_| ()).unwrap()
9085 _ => panic!("Unexpected ChannelPhase variant"),
9088 check_added_monitors!(nodes[0], 0);
9089 nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created.unwrap());
9090 // At this point we'll look up if the channel_id is present and immediately fail the channel
9091 // without trying to persist the `ChannelMonitor`.
9092 check_added_monitors!(nodes[1], 0);
9094 // ...still, nodes[1] will reject the duplicate channel.
9096 let events = nodes[1].node.get_and_clear_pending_msg_events();
9097 assert_eq!(events.len(), 1);
9099 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
9100 // Technically, at this point, nodes[1] would be justified in thinking both
9101 // channels are closed, but currently we do not, so we just move forward with it.
9102 assert_eq!(msg.channel_id, channel_id);
9103 assert_eq!(node_id, nodes[0].node.get_our_node_id());
9105 _ => panic!("Unexpected event"),
9109 // finally, finish creating the original channel and send a payment over it to make sure
9110 // everything is functional.
9111 nodes[0].node.handle_funding_signed(&nodes[1].node.get_our_node_id(), &funding_signed_msg);
9113 let mut added_monitors = nodes[0].chain_monitor.added_monitors.lock().unwrap();
9114 assert_eq!(added_monitors.len(), 1);
9115 assert_eq!(added_monitors[0].0, funding_output);
9116 added_monitors.clear();
9118 expect_channel_pending_event(&nodes[0], &nodes[1].node.get_our_node_id());
9120 let events_4 = nodes[0].node.get_and_clear_pending_events();
9121 assert_eq!(events_4.len(), 0);
9122 assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
9123 assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0], tx);
9125 let (channel_ready, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
9126 let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &channel_ready);
9127 update_nodes_with_chan_announce(&nodes, 0, 1, &announcement, &as_update, &bs_update);
9129 send_payment(&nodes[0], &[&nodes[1]], 8000000);
9133 fn test_error_chans_closed() {
9134 // Test that we properly handle error messages, closing appropriate channels.
9136 // Prior to #787 we'd allow a peer to make us force-close a channel we had with a different
9137 // peer. The "real" fix for that is to index channels with peers_ids, however in the mean time
9138 // we can test various edge cases around it to ensure we don't regress.
9139 let chanmon_cfgs = create_chanmon_cfgs(3);
9140 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
9141 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
9142 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
9144 // Create some initial channels
9145 let chan_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001);
9146 let chan_2 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001);
9147 let chan_3 = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 100000, 10001);
9149 assert_eq!(nodes[0].node.list_usable_channels().len(), 3);
9150 assert_eq!(nodes[1].node.list_usable_channels().len(), 2);
9151 assert_eq!(nodes[2].node.list_usable_channels().len(), 1);
9153 // Closing a channel from a different peer has no effect
9154 nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msgs::ErrorMessage { channel_id: chan_3.2, data: "ERR".to_owned() });
9155 assert_eq!(nodes[0].node.list_usable_channels().len(), 3);
9157 // Closing one channel doesn't impact others
9158 nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msgs::ErrorMessage { channel_id: chan_2.2, data: "ERR".to_owned() });
9159 check_added_monitors!(nodes[0], 1);
9160 check_closed_broadcast!(nodes[0], false);
9161 check_closed_event!(nodes[0], 1, ClosureReason::CounterpartyForceClosed { peer_msg: UntrustedString("ERR".to_string()) },
9162 [nodes[1].node.get_our_node_id()], 100000);
9163 assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0).len(), 1);
9164 assert_eq!(nodes[0].node.list_usable_channels().len(), 2);
9165 assert!(nodes[0].node.list_usable_channels()[0].channel_id == chan_1.2 || nodes[0].node.list_usable_channels()[1].channel_id == chan_1.2);
9166 assert!(nodes[0].node.list_usable_channels()[0].channel_id == chan_3.2 || nodes[0].node.list_usable_channels()[1].channel_id == chan_3.2);
9168 // A null channel ID should close all channels
9169 let _chan_4 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001);
9170 nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msgs::ErrorMessage { channel_id: ChannelId::new_zero(), data: "ERR".to_owned() });
9171 check_added_monitors!(nodes[0], 2);
9172 check_closed_event!(nodes[0], 2, ClosureReason::CounterpartyForceClosed { peer_msg: UntrustedString("ERR".to_string()) },
9173 [nodes[1].node.get_our_node_id(); 2], 100000);
9174 let events = nodes[0].node.get_and_clear_pending_msg_events();
9175 assert_eq!(events.len(), 2);
9177 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
9178 assert_eq!(msg.contents.flags & 2, 2);
9180 _ => panic!("Unexpected event"),
9183 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
9184 assert_eq!(msg.contents.flags & 2, 2);
9186 _ => panic!("Unexpected event"),
9188 // Note that at this point users of a standard PeerHandler will end up calling
9189 // peer_disconnected.
9190 assert_eq!(nodes[0].node.list_usable_channels().len(), 1);
9191 assert!(nodes[0].node.list_usable_channels()[0].channel_id == chan_3.2);
9193 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id());
9194 assert_eq!(nodes[0].node.list_usable_channels().len(), 1);
9195 assert!(nodes[0].node.list_usable_channels()[0].channel_id == chan_3.2);
9199 fn test_invalid_funding_tx() {
9200 // Test that we properly handle invalid funding transactions sent to us from a peer.
9202 // Previously, all other major lightning implementations had failed to properly sanitize
9203 // funding transactions from their counterparties, leading to a multi-implementation critical
9204 // security vulnerability (though we always sanitized properly, we've previously had
9205 // un-released crashes in the sanitization process).
9207 // Further, if the funding transaction is consensus-valid, confirms, and is later spent, we'd
9208 // previously have crashed in `ChannelMonitor` even though we closed the channel as bogus and
9209 // gave up on it. We test this here by generating such a transaction.
9210 let chanmon_cfgs = create_chanmon_cfgs(2);
9211 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
9212 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
9213 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
9215 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100_000, 10_000, 42, None, None).unwrap();
9216 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id()));
9217 nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), &get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id()));
9219 let (temporary_channel_id, mut tx, _) = create_funding_transaction(&nodes[0], &nodes[1].node.get_our_node_id(), 100_000, 42);
9221 // Create a witness program which can be spent by a 4-empty-stack-elements witness and which is
9222 // 136 bytes long. This matches our "accepted HTLC preimage spend" matching, previously causing
9223 // a panic as we'd try to extract a 32 byte preimage from a witness element without checking
9225 let mut wit_program: Vec<u8> = channelmonitor::deliberately_bogus_accepted_htlc_witness_program();
9226 let wit_program_script: ScriptBuf = wit_program.into();
9227 for output in tx.output.iter_mut() {
9228 // Make the confirmed funding transaction have a bogus script_pubkey
9229 output.script_pubkey = ScriptBuf::new_v0_p2wsh(&wit_program_script.wscript_hash());
9232 nodes[0].node.funding_transaction_generated_unchecked(&temporary_channel_id, &nodes[1].node.get_our_node_id(), tx.clone(), 0).unwrap();
9233 nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id()));
9234 check_added_monitors!(nodes[1], 1);
9235 expect_channel_pending_event(&nodes[1], &nodes[0].node.get_our_node_id());
9237 nodes[0].node.handle_funding_signed(&nodes[1].node.get_our_node_id(), &get_event_msg!(nodes[1], MessageSendEvent::SendFundingSigned, nodes[0].node.get_our_node_id()));
9238 check_added_monitors!(nodes[0], 1);
9239 expect_channel_pending_event(&nodes[0], &nodes[1].node.get_our_node_id());
9241 let events_1 = nodes[0].node.get_and_clear_pending_events();
9242 assert_eq!(events_1.len(), 0);
9244 assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
9245 assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0], tx);
9246 nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
9248 let expected_err = "funding tx had wrong script/value or output index";
9249 confirm_transaction_at(&nodes[1], &tx, 1);
9250 check_closed_event!(nodes[1], 1, ClosureReason::ProcessingError { err: expected_err.to_string() },
9251 [nodes[0].node.get_our_node_id()], 100000);
9252 check_added_monitors!(nodes[1], 1);
9253 let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
9254 assert_eq!(events_2.len(), 1);
9255 if let MessageSendEvent::HandleError { node_id, action } = &events_2[0] {
9256 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
9257 if let msgs::ErrorAction::DisconnectPeer { msg } = action {
9258 assert_eq!(msg.as_ref().unwrap().data, "Channel closed because of an exception: ".to_owned() + expected_err);
9259 } else { panic!(); }
9260 } else { panic!(); }
9261 assert_eq!(nodes[1].node.list_channels().len(), 0);
9263 // Now confirm a spend of the (bogus) funding transaction. As long as the witness is 5 elements
9264 // long the ChannelMonitor will try to read 32 bytes from the second-to-last element, panicing
9265 // as its not 32 bytes long.
9266 let mut spend_tx = Transaction {
9267 version: 2i32, lock_time: LockTime::ZERO,
9268 input: tx.output.iter().enumerate().map(|(idx, _)| TxIn {
9269 previous_output: BitcoinOutPoint {
9273 script_sig: ScriptBuf::new(),
9274 sequence: Sequence::ENABLE_RBF_NO_LOCKTIME,
9275 witness: Witness::from_slice(&channelmonitor::deliberately_bogus_accepted_htlc_witness())
9277 output: vec![TxOut {
9279 script_pubkey: ScriptBuf::new(),
9282 check_spends!(spend_tx, tx);
9283 mine_transaction(&nodes[1], &spend_tx);
9287 fn test_coinbase_funding_tx() {
9288 // Miners are able to fund channels directly from coinbase transactions, however
9289 // by consensus rules, outputs of a coinbase transaction are encumbered by a 100
9290 // block maturity timelock. To ensure that a (non-0conf) channel like this is enforceable
9291 // on-chain, the minimum depth is updated to 100 blocks for coinbase funding transactions.
9293 // Note that 0conf channels with coinbase funding transactions are unaffected and are
9294 // immediately operational after opening.
9295 let chanmon_cfgs = create_chanmon_cfgs(2);
9296 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
9297 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
9298 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
9300 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None, None).unwrap();
9301 let open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
9303 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel);
9304 let accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
9306 nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), &accept_channel);
9308 // Create the coinbase funding transaction.
9309 let (temporary_channel_id, tx, _) = create_coinbase_funding_transaction(&nodes[0], &nodes[1].node.get_our_node_id(), 100000, 42);
9311 nodes[0].node.funding_transaction_generated(&temporary_channel_id, &nodes[1].node.get_our_node_id(), tx.clone()).unwrap();
9312 check_added_monitors!(nodes[0], 0);
9313 let funding_created = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
9315 nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created);
9316 check_added_monitors!(nodes[1], 1);
9317 expect_channel_pending_event(&nodes[1], &nodes[0].node.get_our_node_id());
9319 let funding_signed = get_event_msg!(nodes[1], MessageSendEvent::SendFundingSigned, nodes[0].node.get_our_node_id());
9321 nodes[0].node.handle_funding_signed(&nodes[1].node.get_our_node_id(), &funding_signed);
9322 check_added_monitors!(nodes[0], 1);
9324 expect_channel_pending_event(&nodes[0], &nodes[1].node.get_our_node_id());
9325 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
9327 // Starting at height 0, we "confirm" the coinbase at height 1.
9328 confirm_transaction_at(&nodes[0], &tx, 1);
9329 // We connect 98 more blocks to have 99 confirmations for the coinbase transaction.
9330 connect_blocks(&nodes[0], COINBASE_MATURITY - 2);
9331 // Check that we have no pending message events (we have not queued a `channel_ready` yet).
9332 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
9333 // Now connect one more block which results in 100 confirmations of the coinbase transaction.
9334 connect_blocks(&nodes[0], 1);
9335 // There should now be a `channel_ready` which can be handled.
9336 let _ = &nodes[1].node.handle_channel_ready(&nodes[0].node.get_our_node_id(), &get_event_msg!(&nodes[0], MessageSendEvent::SendChannelReady, nodes[1].node.get_our_node_id()));
9338 confirm_transaction_at(&nodes[1], &tx, 1);
9339 connect_blocks(&nodes[1], COINBASE_MATURITY - 2);
9340 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
9341 connect_blocks(&nodes[1], 1);
9342 expect_channel_ready_event(&nodes[1], &nodes[0].node.get_our_node_id());
9343 create_chan_between_nodes_with_value_confirm_second(&nodes[0], &nodes[1]);
9346 fn do_test_tx_confirmed_skipping_blocks_immediate_broadcast(test_height_before_timelock: bool) {
9347 // In the first version of the chain::Confirm interface, after a refactor was made to not
9348 // broadcast CSV-locked transactions until their CSV lock is up, we wouldn't reliably broadcast
9349 // transactions after a `transactions_confirmed` call. Specifically, if the chain, provided via
9350 // `best_block_updated` is at height N, and a transaction output which we wish to spend at
9351 // height N-1 (due to a CSV to height N-1) is provided at height N, we will not broadcast the
9352 // spending transaction until height N+1 (or greater). This was due to the way
9353 // `ChannelMonitor::transactions_confirmed` worked, only checking if we should broadcast a
9354 // spending transaction at the height the input transaction was confirmed at, not whether we
9355 // should broadcast a spending transaction at the current height.
9356 // A second, similar, issue involved failing HTLCs backwards - because we only provided the
9357 // height at which transactions were confirmed to `OnchainTx::update_claims_view`, it wasn't
9358 // aware that the anti-reorg-delay had, in fact, already expired, waiting to fail-backwards
9359 // until we learned about an additional block.
9361 // As an additional check, if `test_height_before_timelock` is set, we instead test that we
9362 // aren't broadcasting transactions too early (ie not broadcasting them at all).
9363 let chanmon_cfgs = create_chanmon_cfgs(3);
9364 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
9365 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
9366 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
9367 *nodes[0].connect_style.borrow_mut() = ConnectStyle::BestBlockFirstSkippingBlocks;
9369 create_announced_chan_between_nodes(&nodes, 0, 1);
9370 let (chan_announce, _, channel_id, _) = create_announced_chan_between_nodes(&nodes, 1, 2);
9371 let (_, payment_hash, ..) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1_000_000);
9372 nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id());
9373 nodes[2].node.peer_disconnected(&nodes[1].node.get_our_node_id());
9375 nodes[1].node.force_close_broadcasting_latest_txn(&channel_id, &nodes[2].node.get_our_node_id()).unwrap();
9376 check_closed_broadcast!(nodes[1], true);
9377 check_closed_event!(nodes[1], 1, ClosureReason::HolderForceClosed, [nodes[2].node.get_our_node_id()], 100000);
9378 check_added_monitors!(nodes[1], 1);
9379 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
9380 assert_eq!(node_txn.len(), 1);
9382 let conf_height = nodes[1].best_block_info().1;
9383 if !test_height_before_timelock {
9384 connect_blocks(&nodes[1], 24 * 6);
9386 nodes[1].chain_monitor.chain_monitor.transactions_confirmed(
9387 &nodes[1].get_block_header(conf_height), &[(0, &node_txn[0])], conf_height);
9388 if test_height_before_timelock {
9389 // If we confirmed the close transaction, but timelocks have not yet expired, we should not
9390 // generate any events or broadcast any transactions
9391 assert!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
9392 assert!(nodes[1].chain_monitor.chain_monitor.get_and_clear_pending_events().is_empty());
9394 // We should broadcast an HTLC transaction spending our funding transaction first
9395 let spending_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
9396 assert_eq!(spending_txn.len(), 2);
9397 let htlc_tx = if spending_txn[0].txid() == node_txn[0].txid() {
9402 check_spends!(htlc_tx, node_txn[0]);
9403 // We should also generate a SpendableOutputs event with the to_self output (as its
9405 let descriptor_spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
9406 assert_eq!(descriptor_spend_txn.len(), 1);
9408 // If we also discover that the HTLC-Timeout transaction was confirmed some time ago, we
9409 // should immediately fail-backwards the HTLC to the previous hop, without waiting for an
9410 // additional block built on top of the current chain.
9411 nodes[1].chain_monitor.chain_monitor.transactions_confirmed(
9412 &nodes[1].get_block_header(conf_height + 1), &[(0, htlc_tx)], conf_height + 1);
9413 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], vec![HTLCDestination::NextHopChannel { node_id: Some(nodes[2].node.get_our_node_id()), channel_id: channel_id }]);
9414 check_added_monitors!(nodes[1], 1);
9416 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
9417 assert!(updates.update_add_htlcs.is_empty());
9418 assert!(updates.update_fulfill_htlcs.is_empty());
9419 assert_eq!(updates.update_fail_htlcs.len(), 1);
9420 assert!(updates.update_fail_malformed_htlcs.is_empty());
9421 assert!(updates.update_fee.is_none());
9422 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
9423 commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, true, true);
9424 expect_payment_failed_with_update!(nodes[0], payment_hash, false, chan_announce.contents.short_channel_id, true);
9429 fn test_tx_confirmed_skipping_blocks_immediate_broadcast() {
9430 do_test_tx_confirmed_skipping_blocks_immediate_broadcast(false);
9431 do_test_tx_confirmed_skipping_blocks_immediate_broadcast(true);
9434 fn do_test_dup_htlc_second_rejected(test_for_second_fail_panic: bool) {
9435 let chanmon_cfgs = create_chanmon_cfgs(2);
9436 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
9437 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
9438 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
9440 let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001);
9442 let payment_params = PaymentParameters::from_node_id(nodes[1].node.get_our_node_id(), TEST_FINAL_CLTV)
9443 .with_bolt11_features(nodes[1].node.bolt11_invoice_features()).unwrap();
9444 let route = get_route!(nodes[0], payment_params, 10_000).unwrap();
9446 let (our_payment_preimage, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(&nodes[1]);
9449 nodes[0].node.send_payment_with_route(&route, our_payment_hash,
9450 RecipientOnionFields::secret_only(our_payment_secret), PaymentId(our_payment_hash.0)).unwrap();
9451 check_added_monitors!(nodes[0], 1);
9452 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
9453 assert_eq!(events.len(), 1);
9454 let mut payment_event = SendEvent::from_event(events.pop().unwrap());
9455 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
9456 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
9458 expect_pending_htlcs_forwardable!(nodes[1]);
9459 expect_payment_claimable!(nodes[1], our_payment_hash, our_payment_secret, 10_000);
9462 // Note that we use a different PaymentId here to allow us to duplicativly pay
9463 nodes[0].node.send_payment_with_route(&route, our_payment_hash,
9464 RecipientOnionFields::secret_only(our_payment_secret), PaymentId(our_payment_secret.0)).unwrap();
9465 check_added_monitors!(nodes[0], 1);
9466 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
9467 assert_eq!(events.len(), 1);
9468 let mut payment_event = SendEvent::from_event(events.pop().unwrap());
9469 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
9470 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
9471 // At this point, nodes[1] would notice it has too much value for the payment. It will
9472 // assume the second is a privacy attack (no longer particularly relevant
9473 // post-payment_secrets) and fail back the new HTLC. Previously, it'd also have failed back
9474 // the first HTLC delivered above.
9477 expect_pending_htlcs_forwardable_ignore!(nodes[1]);
9478 nodes[1].node.process_pending_htlc_forwards();
9480 if test_for_second_fail_panic {
9481 // Now we go fail back the first HTLC from the user end.
9482 nodes[1].node.fail_htlc_backwards(&our_payment_hash);
9484 let expected_destinations = vec![
9485 HTLCDestination::FailedPayment { payment_hash: our_payment_hash },
9486 HTLCDestination::FailedPayment { payment_hash: our_payment_hash },
9488 expect_pending_htlcs_forwardable_and_htlc_handling_failed_ignore!(nodes[1], expected_destinations);
9489 nodes[1].node.process_pending_htlc_forwards();
9491 check_added_monitors!(nodes[1], 1);
9492 let fail_updates_1 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
9493 assert_eq!(fail_updates_1.update_fail_htlcs.len(), 2);
9495 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_updates_1.update_fail_htlcs[0]);
9496 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_updates_1.update_fail_htlcs[1]);
9497 commitment_signed_dance!(nodes[0], nodes[1], fail_updates_1.commitment_signed, false);
9499 let failure_events = nodes[0].node.get_and_clear_pending_events();
9500 assert_eq!(failure_events.len(), 4);
9501 if let Event::PaymentPathFailed { .. } = failure_events[0] {} else { panic!(); }
9502 if let Event::PaymentFailed { .. } = failure_events[1] {} else { panic!(); }
9503 if let Event::PaymentPathFailed { .. } = failure_events[2] {} else { panic!(); }
9504 if let Event::PaymentFailed { .. } = failure_events[3] {} else { panic!(); }
9506 // Let the second HTLC fail and claim the first
9507 expect_pending_htlcs_forwardable_and_htlc_handling_failed_ignore!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash: our_payment_hash }]);
9508 nodes[1].node.process_pending_htlc_forwards();
9510 check_added_monitors!(nodes[1], 1);
9511 let fail_updates_1 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
9512 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_updates_1.update_fail_htlcs[0]);
9513 commitment_signed_dance!(nodes[0], nodes[1], fail_updates_1.commitment_signed, false);
9515 expect_payment_failed_conditions(&nodes[0], our_payment_hash, true, PaymentFailedConditions::new());
9517 claim_payment(&nodes[0], &[&nodes[1]], our_payment_preimage);
9522 fn test_dup_htlc_second_fail_panic() {
9523 // Previously, if we received two HTLCs back-to-back, where the second overran the expected
9524 // value for the payment, we'd fail back both HTLCs after generating a `PaymentClaimable` event.
9525 // Then, if the user failed the second payment, they'd hit a "tried to fail an already failed
9526 // HTLC" debug panic. This tests for this behavior, checking that only one HTLC is auto-failed.
9527 do_test_dup_htlc_second_rejected(true);
9531 fn test_dup_htlc_second_rejected() {
9532 // Test that if we receive a second HTLC for an MPP payment that overruns the payment amount we
9533 // simply reject the second HTLC but are still able to claim the first HTLC.
9534 do_test_dup_htlc_second_rejected(false);
9538 fn test_inconsistent_mpp_params() {
9539 // Test that if we recieve two HTLCs with different payment parameters we fail back the first
9540 // such HTLC and allow the second to stay.
9541 let chanmon_cfgs = create_chanmon_cfgs(4);
9542 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
9543 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
9544 let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
9546 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100_000, 0);
9547 create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 100_000, 0);
9548 create_announced_chan_between_nodes_with_value(&nodes, 1, 3, 100_000, 0);
9549 let chan_2_3 =create_announced_chan_between_nodes_with_value(&nodes, 2, 3, 100_000, 0);
9551 let payment_params = PaymentParameters::from_node_id(nodes[3].node.get_our_node_id(), TEST_FINAL_CLTV)
9552 .with_bolt11_features(nodes[3].node.bolt11_invoice_features()).unwrap();
9553 let mut route = get_route!(nodes[0], payment_params, 15_000_000).unwrap();
9554 assert_eq!(route.paths.len(), 2);
9555 route.paths.sort_by(|path_a, _| {
9556 // Sort the path so that the path through nodes[1] comes first
9557 if path_a.hops[0].pubkey == nodes[1].node.get_our_node_id() {
9558 core::cmp::Ordering::Less } else { core::cmp::Ordering::Greater }
9561 let (our_payment_preimage, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(&nodes[3]);
9563 let cur_height = nodes[0].best_block_info().1;
9564 let payment_id = PaymentId([42; 32]);
9566 let session_privs = {
9567 // We create a fake route here so that we start with three pending HTLCs, which we'll
9568 // ultimately have, just not right away.
9569 let mut dup_route = route.clone();
9570 dup_route.paths.push(route.paths[1].clone());
9571 nodes[0].node.test_add_new_pending_payment(our_payment_hash,
9572 RecipientOnionFields::secret_only(our_payment_secret), payment_id, &dup_route).unwrap()
9574 nodes[0].node.test_send_payment_along_path(&route.paths[0], &our_payment_hash,
9575 RecipientOnionFields::secret_only(our_payment_secret), 15_000_000, cur_height, payment_id,
9576 &None, session_privs[0]).unwrap();
9577 check_added_monitors!(nodes[0], 1);
9580 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
9581 assert_eq!(events.len(), 1);
9582 pass_along_path(&nodes[0], &[&nodes[1], &nodes[3]], 15_000_000, our_payment_hash, Some(our_payment_secret), events.pop().unwrap(), false, None);
9584 assert!(nodes[3].node.get_and_clear_pending_events().is_empty());
9586 nodes[0].node.test_send_payment_along_path(&route.paths[1], &our_payment_hash,
9587 RecipientOnionFields::secret_only(our_payment_secret), 14_000_000, cur_height, payment_id, &None, session_privs[1]).unwrap();
9588 check_added_monitors!(nodes[0], 1);
9591 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
9592 assert_eq!(events.len(), 1);
9593 let payment_event = SendEvent::from_event(events.pop().unwrap());
9595 nodes[2].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
9596 commitment_signed_dance!(nodes[2], nodes[0], payment_event.commitment_msg, false);
9598 expect_pending_htlcs_forwardable!(nodes[2]);
9599 check_added_monitors!(nodes[2], 1);
9601 let mut events = nodes[2].node.get_and_clear_pending_msg_events();
9602 assert_eq!(events.len(), 1);
9603 let payment_event = SendEvent::from_event(events.pop().unwrap());
9605 nodes[3].node.handle_update_add_htlc(&nodes[2].node.get_our_node_id(), &payment_event.msgs[0]);
9606 check_added_monitors!(nodes[3], 0);
9607 commitment_signed_dance!(nodes[3], nodes[2], payment_event.commitment_msg, true, true);
9609 // At this point, nodes[3] should notice the two HTLCs don't contain the same total payment
9610 // amount. It will assume the second is a privacy attack (no longer particularly relevant
9611 // post-payment_secrets) and fail back the new HTLC.
9613 expect_pending_htlcs_forwardable_ignore!(nodes[3]);
9614 nodes[3].node.process_pending_htlc_forwards();
9615 expect_pending_htlcs_forwardable_and_htlc_handling_failed_ignore!(nodes[3], vec![HTLCDestination::FailedPayment { payment_hash: our_payment_hash }]);
9616 nodes[3].node.process_pending_htlc_forwards();
9618 check_added_monitors!(nodes[3], 1);
9620 let fail_updates_1 = get_htlc_update_msgs!(nodes[3], nodes[2].node.get_our_node_id());
9621 nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &fail_updates_1.update_fail_htlcs[0]);
9622 commitment_signed_dance!(nodes[2], nodes[3], fail_updates_1.commitment_signed, false);
9624 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[2], vec![HTLCDestination::NextHopChannel { node_id: Some(nodes[3].node.get_our_node_id()), channel_id: chan_2_3.2 }]);
9625 check_added_monitors!(nodes[2], 1);
9627 let fail_updates_2 = get_htlc_update_msgs!(nodes[2], nodes[0].node.get_our_node_id());
9628 nodes[0].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &fail_updates_2.update_fail_htlcs[0]);
9629 commitment_signed_dance!(nodes[0], nodes[2], fail_updates_2.commitment_signed, false);
9631 expect_payment_failed_conditions(&nodes[0], our_payment_hash, true, PaymentFailedConditions::new().mpp_parts_remain());
9633 nodes[0].node.test_send_payment_along_path(&route.paths[1], &our_payment_hash,
9634 RecipientOnionFields::secret_only(our_payment_secret), 15_000_000, cur_height, payment_id,
9635 &None, session_privs[2]).unwrap();
9636 check_added_monitors!(nodes[0], 1);
9638 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
9639 assert_eq!(events.len(), 1);
9640 pass_along_path(&nodes[0], &[&nodes[2], &nodes[3]], 15_000_000, our_payment_hash, Some(our_payment_secret), events.pop().unwrap(), true, None);
9642 do_claim_payment_along_route(&nodes[0], &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], false, our_payment_preimage);
9643 expect_payment_sent(&nodes[0], our_payment_preimage, Some(None), true, true);
9647 fn test_double_partial_claim() {
9648 // Test what happens if a node receives a payment, generates a PaymentClaimable event, the HTLCs
9649 // time out, the sender resends only some of the MPP parts, then the user processes the
9650 // PaymentClaimable event, ensuring they don't inadvertently claim only part of the full payment
9652 let chanmon_cfgs = create_chanmon_cfgs(4);
9653 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
9654 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
9655 let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
9657 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100_000, 0);
9658 create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 100_000, 0);
9659 create_announced_chan_between_nodes_with_value(&nodes, 1, 3, 100_000, 0);
9660 create_announced_chan_between_nodes_with_value(&nodes, 2, 3, 100_000, 0);
9662 let (mut route, payment_hash, payment_preimage, payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[3], 15_000_000);
9663 assert_eq!(route.paths.len(), 2);
9664 route.paths.sort_by(|path_a, _| {
9665 // Sort the path so that the path through nodes[1] comes first
9666 if path_a.hops[0].pubkey == nodes[1].node.get_our_node_id() {
9667 core::cmp::Ordering::Less } else { core::cmp::Ordering::Greater }
9670 send_along_route_with_secret(&nodes[0], route.clone(), &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], 15_000_000, payment_hash, payment_secret);
9671 // nodes[3] has now received a PaymentClaimable event...which it will take some (exorbitant)
9672 // amount of time to respond to.
9674 // Connect some blocks to time out the payment
9675 connect_blocks(&nodes[3], TEST_FINAL_CLTV);
9676 connect_blocks(&nodes[0], TEST_FINAL_CLTV); // To get the same height for sending later
9678 let failed_destinations = vec![
9679 HTLCDestination::FailedPayment { payment_hash },
9680 HTLCDestination::FailedPayment { payment_hash },
9682 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[3], failed_destinations);
9684 pass_failed_payment_back(&nodes[0], &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], false, payment_hash, PaymentFailureReason::RecipientRejected);
9686 // nodes[1] now retries one of the two paths...
9687 nodes[0].node.send_payment_with_route(&route, payment_hash,
9688 RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_hash.0)).unwrap();
9689 check_added_monitors!(nodes[0], 2);
9691 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
9692 assert_eq!(events.len(), 2);
9693 let node_1_msgs = remove_first_msg_event_to_node(&nodes[1].node.get_our_node_id(), &mut events);
9694 pass_along_path(&nodes[0], &[&nodes[1], &nodes[3]], 15_000_000, payment_hash, Some(payment_secret), node_1_msgs, false, None);
9696 // At this point nodes[3] has received one half of the payment, and the user goes to handle
9697 // that PaymentClaimable event they got hours ago and never handled...we should refuse to claim.
9698 nodes[3].node.claim_funds(payment_preimage);
9699 check_added_monitors!(nodes[3], 0);
9700 assert!(nodes[3].node.get_and_clear_pending_msg_events().is_empty());
9703 /// The possible events which may trigger a `max_dust_htlc_exposure` breach
9704 #[derive(Clone, Copy, PartialEq)]
9705 enum ExposureEvent {
9706 /// Breach occurs at HTLC forwarding (see `send_htlc`)
9708 /// Breach occurs at HTLC reception (see `update_add_htlc`)
9710 /// Breach occurs at outbound update_fee (see `send_update_fee`)
9711 AtUpdateFeeOutbound,
9714 fn do_test_max_dust_htlc_exposure(dust_outbound_balance: bool, exposure_breach_event: ExposureEvent, on_holder_tx: bool, multiplier_dust_limit: bool) {
9715 // Test that we properly reject dust HTLC violating our `max_dust_htlc_exposure_msat`
9718 // At HTLC forward (`send_payment()`), if the sum of the trimmed-to-dust HTLC inbound and
9719 // trimmed-to-dust HTLC outbound balance and this new payment as included on next
9720 // counterparty commitment are above our `max_dust_htlc_exposure_msat`, we'll reject the
9721 // update. At HTLC reception (`update_add_htlc()`), if the sum of the trimmed-to-dust HTLC
9722 // inbound and trimmed-to-dust HTLC outbound balance and this new received HTLC as included
9723 // on next counterparty commitment are above our `max_dust_htlc_exposure_msat`, we'll fail
9724 // the update. Note, we return a `temporary_channel_failure` (0x1000 | 7), as the channel
9725 // might be available again for HTLC processing once the dust bandwidth has cleared up.
9727 let chanmon_cfgs = create_chanmon_cfgs(2);
9728 let mut config = test_default_channel_config();
9729 config.channel_config.max_dust_htlc_exposure = if multiplier_dust_limit {
9730 // Default test fee estimator rate is 253 sat/kw, so we set the multiplier to 5_000_000 / 253
9731 // to get roughly the same initial value as the default setting when this test was
9732 // originally written.
9733 MaxDustHTLCExposure::FeeRateMultiplier(5_000_000 / 253)
9734 } else { MaxDustHTLCExposure::FixedLimitMsat(5_000_000) }; // initial default setting value
9735 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
9736 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[Some(config), None]);
9737 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
9739 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 1_000_000, 500_000_000, 42, None, None).unwrap();
9740 let mut open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
9741 open_channel.max_htlc_value_in_flight_msat = 50_000_000;
9742 open_channel.max_accepted_htlcs = 60;
9744 open_channel.dust_limit_satoshis = 546;
9746 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel);
9747 let mut accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
9748 nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), &accept_channel);
9750 let channel_type_features = ChannelTypeFeatures::only_static_remote_key();
9752 let (temporary_channel_id, tx, _) = create_funding_transaction(&nodes[0], &nodes[1].node.get_our_node_id(), 1_000_000, 42);
9755 let mut node_0_per_peer_lock;
9756 let mut node_0_peer_state_lock;
9757 match get_channel_ref!(nodes[0], nodes[1], node_0_per_peer_lock, node_0_peer_state_lock, temporary_channel_id) {
9758 ChannelPhase::UnfundedOutboundV1(chan) => {
9759 chan.context.holder_dust_limit_satoshis = 546;
9761 _ => panic!("Unexpected ChannelPhase variant"),
9765 nodes[0].node.funding_transaction_generated(&temporary_channel_id, &nodes[1].node.get_our_node_id(), tx.clone()).unwrap();
9766 nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id()));
9767 check_added_monitors!(nodes[1], 1);
9768 expect_channel_pending_event(&nodes[1], &nodes[0].node.get_our_node_id());
9770 nodes[0].node.handle_funding_signed(&nodes[1].node.get_our_node_id(), &get_event_msg!(nodes[1], MessageSendEvent::SendFundingSigned, nodes[0].node.get_our_node_id()));
9771 check_added_monitors!(nodes[0], 1);
9772 expect_channel_pending_event(&nodes[0], &nodes[1].node.get_our_node_id());
9774 let (channel_ready, channel_id) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
9775 let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &channel_ready);
9776 update_nodes_with_chan_announce(&nodes, 0, 1, &announcement, &as_update, &bs_update);
9778 // Fetch a route in advance as we will be unable to once we're unable to send.
9779 let (mut route, payment_hash, _, payment_secret) =
9780 get_route_and_payment_hash!(nodes[0], nodes[1], 1000);
9782 let (dust_buffer_feerate, max_dust_htlc_exposure_msat) = {
9783 let per_peer_state = nodes[0].node.per_peer_state.read().unwrap();
9784 let chan_lock = per_peer_state.get(&nodes[1].node.get_our_node_id()).unwrap().lock().unwrap();
9785 let chan = chan_lock.channel_by_id.get(&channel_id).unwrap();
9786 (chan.context().get_dust_buffer_feerate(None) as u64,
9787 chan.context().get_max_dust_htlc_exposure_msat(&LowerBoundedFeeEstimator(nodes[0].fee_estimator)))
9789 let dust_outbound_htlc_on_holder_tx_msat: u64 = (dust_buffer_feerate * htlc_timeout_tx_weight(&channel_type_features) / 1000 + open_channel.dust_limit_satoshis - 1) * 1000;
9790 let dust_outbound_htlc_on_holder_tx: u64 = max_dust_htlc_exposure_msat / dust_outbound_htlc_on_holder_tx_msat;
9792 let dust_inbound_htlc_on_holder_tx_msat: u64 = (dust_buffer_feerate * htlc_success_tx_weight(&channel_type_features) / 1000 + open_channel.dust_limit_satoshis - 1) * 1000;
9793 let dust_inbound_htlc_on_holder_tx: u64 = max_dust_htlc_exposure_msat / dust_inbound_htlc_on_holder_tx_msat;
9795 let dust_htlc_on_counterparty_tx: u64 = 4;
9796 let dust_htlc_on_counterparty_tx_msat: u64 = max_dust_htlc_exposure_msat / dust_htlc_on_counterparty_tx;
9799 if dust_outbound_balance {
9800 // Outbound dust threshold: 2223 sats (`dust_buffer_feerate` * HTLC_TIMEOUT_TX_WEIGHT / 1000 + holder's `dust_limit_satoshis`)
9801 // Outbound dust balance: 4372 sats
9802 // Note, we need sent payment to be above outbound dust threshold on counterparty_tx of 2132 sats
9803 for _ in 0..dust_outbound_htlc_on_holder_tx {
9804 let (route, payment_hash, _, payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], dust_outbound_htlc_on_holder_tx_msat);
9805 nodes[0].node.send_payment_with_route(&route, payment_hash,
9806 RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_hash.0)).unwrap();
9809 // Inbound dust threshold: 2324 sats (`dust_buffer_feerate` * HTLC_SUCCESS_TX_WEIGHT / 1000 + holder's `dust_limit_satoshis`)
9810 // Inbound dust balance: 4372 sats
9811 // Note, we need sent payment to be above outbound dust threshold on counterparty_tx of 2031 sats
9812 for _ in 0..dust_inbound_htlc_on_holder_tx {
9813 route_payment(&nodes[1], &[&nodes[0]], dust_inbound_htlc_on_holder_tx_msat);
9817 if dust_outbound_balance {
9818 // Outbound dust threshold: 2132 sats (`dust_buffer_feerate` * HTLC_TIMEOUT_TX_WEIGHT / 1000 + counteparty's `dust_limit_satoshis`)
9819 // Outbound dust balance: 5000 sats
9820 for _ in 0..dust_htlc_on_counterparty_tx - 1 {
9821 let (route, payment_hash, _, payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], dust_htlc_on_counterparty_tx_msat);
9822 nodes[0].node.send_payment_with_route(&route, payment_hash,
9823 RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_hash.0)).unwrap();
9826 // Inbound dust threshold: 2031 sats (`dust_buffer_feerate` * HTLC_TIMEOUT_TX_WEIGHT / 1000 + counteparty's `dust_limit_satoshis`)
9827 // Inbound dust balance: 5000 sats
9828 for _ in 0..dust_htlc_on_counterparty_tx - 1 {
9829 route_payment(&nodes[1], &[&nodes[0]], dust_htlc_on_counterparty_tx_msat);
9834 if exposure_breach_event == ExposureEvent::AtHTLCForward {
9835 route.paths[0].hops.last_mut().unwrap().fee_msat =
9836 if on_holder_tx { dust_outbound_htlc_on_holder_tx_msat } else { dust_htlc_on_counterparty_tx_msat + 1 };
9837 // With default dust exposure: 5000 sats
9839 unwrap_send_err!(nodes[0].node.send_payment_with_route(&route, payment_hash,
9840 RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_hash.0)
9841 ), true, APIError::ChannelUnavailable { .. }, {});
9843 unwrap_send_err!(nodes[0].node.send_payment_with_route(&route, payment_hash,
9844 RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_hash.0)
9845 ), true, APIError::ChannelUnavailable { .. }, {});
9847 } else if exposure_breach_event == ExposureEvent::AtHTLCReception {
9848 let (route, payment_hash, _, payment_secret) = get_route_and_payment_hash!(nodes[1], nodes[0], if on_holder_tx { dust_inbound_htlc_on_holder_tx_msat } else { dust_htlc_on_counterparty_tx_msat + 4 });
9849 nodes[1].node.send_payment_with_route(&route, payment_hash,
9850 RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_hash.0)).unwrap();
9851 check_added_monitors!(nodes[1], 1);
9852 let mut events = nodes[1].node.get_and_clear_pending_msg_events();
9853 assert_eq!(events.len(), 1);
9854 let payment_event = SendEvent::from_event(events.remove(0));
9855 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
9856 // With default dust exposure: 5000 sats
9858 // Outbound dust balance: 6399 sats
9859 let dust_inbound_overflow = dust_inbound_htlc_on_holder_tx_msat * (dust_inbound_htlc_on_holder_tx + 1);
9860 let dust_outbound_overflow = dust_outbound_htlc_on_holder_tx_msat * dust_outbound_htlc_on_holder_tx + dust_inbound_htlc_on_holder_tx_msat;
9861 nodes[0].logger.assert_log("lightning::ln::channel", format!("Cannot accept value that would put our exposure to dust HTLCs at {} over the limit {} on holder commitment tx", if dust_outbound_balance { dust_outbound_overflow } else { dust_inbound_overflow }, max_dust_htlc_exposure_msat), 1);
9863 // Outbound dust balance: 5200 sats
9864 nodes[0].logger.assert_log("lightning::ln::channel",
9865 format!("Cannot accept value that would put our exposure to dust HTLCs at {} over the limit {} on counterparty commitment tx",
9866 dust_htlc_on_counterparty_tx_msat * (dust_htlc_on_counterparty_tx - 1) + dust_htlc_on_counterparty_tx_msat + 4,
9867 max_dust_htlc_exposure_msat), 1);
9869 } else if exposure_breach_event == ExposureEvent::AtUpdateFeeOutbound {
9870 route.paths[0].hops.last_mut().unwrap().fee_msat = 2_500_000;
9871 // For the multiplier dust exposure limit, since it scales with feerate,
9872 // we need to add a lot of HTLCs that will become dust at the new feerate
9873 // to cross the threshold.
9875 let (_, payment_hash, payment_secret) = get_payment_preimage_hash(&nodes[1], Some(1_000), None);
9876 nodes[0].node.send_payment_with_route(&route, payment_hash,
9877 RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_hash.0)).unwrap();
9880 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
9881 *feerate_lock = *feerate_lock * 10;
9883 nodes[0].node.timer_tick_occurred();
9884 check_added_monitors!(nodes[0], 1);
9885 nodes[0].logger.assert_log_contains("lightning::ln::channel", "Cannot afford to send new feerate at 2530 without infringing max dust htlc exposure", 1);
9888 let _ = nodes[0].node.get_and_clear_pending_msg_events();
9889 let mut added_monitors = nodes[0].chain_monitor.added_monitors.lock().unwrap();
9890 added_monitors.clear();
9893 fn do_test_max_dust_htlc_exposure_by_threshold_type(multiplier_dust_limit: bool) {
9894 do_test_max_dust_htlc_exposure(true, ExposureEvent::AtHTLCForward, true, multiplier_dust_limit);
9895 do_test_max_dust_htlc_exposure(false, ExposureEvent::AtHTLCForward, true, multiplier_dust_limit);
9896 do_test_max_dust_htlc_exposure(false, ExposureEvent::AtHTLCReception, true, multiplier_dust_limit);
9897 do_test_max_dust_htlc_exposure(false, ExposureEvent::AtHTLCReception, false, multiplier_dust_limit);
9898 do_test_max_dust_htlc_exposure(true, ExposureEvent::AtHTLCForward, false, multiplier_dust_limit);
9899 do_test_max_dust_htlc_exposure(true, ExposureEvent::AtHTLCReception, false, multiplier_dust_limit);
9900 do_test_max_dust_htlc_exposure(true, ExposureEvent::AtHTLCReception, true, multiplier_dust_limit);
9901 do_test_max_dust_htlc_exposure(false, ExposureEvent::AtHTLCForward, false, multiplier_dust_limit);
9902 do_test_max_dust_htlc_exposure(true, ExposureEvent::AtUpdateFeeOutbound, true, multiplier_dust_limit);
9903 do_test_max_dust_htlc_exposure(true, ExposureEvent::AtUpdateFeeOutbound, false, multiplier_dust_limit);
9904 do_test_max_dust_htlc_exposure(false, ExposureEvent::AtUpdateFeeOutbound, false, multiplier_dust_limit);
9905 do_test_max_dust_htlc_exposure(false, ExposureEvent::AtUpdateFeeOutbound, true, multiplier_dust_limit);
9909 fn test_max_dust_htlc_exposure() {
9910 do_test_max_dust_htlc_exposure_by_threshold_type(false);
9911 do_test_max_dust_htlc_exposure_by_threshold_type(true);
9915 fn test_non_final_funding_tx() {
9916 let chanmon_cfgs = create_chanmon_cfgs(2);
9917 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
9918 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
9919 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
9921 let temp_channel_id = nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100_000, 0, 42, None, None).unwrap();
9922 let open_channel_message = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
9923 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel_message);
9924 let accept_channel_message = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
9925 nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), &accept_channel_message);
9927 let best_height = nodes[0].node.best_block.read().unwrap().height();
9929 let chan_id = *nodes[0].network_chan_count.borrow();
9930 let events = nodes[0].node.get_and_clear_pending_events();
9931 let input = TxIn { previous_output: BitcoinOutPoint::null(), script_sig: bitcoin::ScriptBuf::new(), sequence: Sequence(1), witness: Witness::from_slice(&[&[1]]) };
9932 assert_eq!(events.len(), 1);
9933 let mut tx = match events[0] {
9934 Event::FundingGenerationReady { ref channel_value_satoshis, ref output_script, .. } => {
9935 // Timelock the transaction _beyond_ the best client height + 1.
9936 Transaction { version: chan_id as i32, lock_time: LockTime::from_height(best_height + 2).unwrap(), input: vec![input], output: vec![TxOut {
9937 value: *channel_value_satoshis, script_pubkey: output_script.clone(),
9940 _ => panic!("Unexpected event"),
9942 // Transaction should fail as it's evaluated as non-final for propagation.
9943 match nodes[0].node.funding_transaction_generated(&temp_channel_id, &nodes[1].node.get_our_node_id(), tx.clone()) {
9944 Err(APIError::APIMisuseError { err }) => {
9945 assert_eq!(format!("Funding transaction absolute timelock is non-final"), err);
9949 let events = nodes[0].node.get_and_clear_pending_events();
9950 assert_eq!(events.len(), 1);
9952 Event::ChannelClosed { channel_id, .. } => {
9953 assert_eq!(channel_id, temp_channel_id);
9955 _ => panic!("Unexpected event"),
9960 fn test_non_final_funding_tx_within_headroom() {
9961 let chanmon_cfgs = create_chanmon_cfgs(2);
9962 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
9963 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
9964 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
9966 let temp_channel_id = nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100_000, 0, 42, None, None).unwrap();
9967 let open_channel_message = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
9968 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel_message);
9969 let accept_channel_message = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
9970 nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), &accept_channel_message);
9972 let best_height = nodes[0].node.best_block.read().unwrap().height();
9974 let chan_id = *nodes[0].network_chan_count.borrow();
9975 let events = nodes[0].node.get_and_clear_pending_events();
9976 let input = TxIn { previous_output: BitcoinOutPoint::null(), script_sig: bitcoin::ScriptBuf::new(), sequence: Sequence(1), witness: Witness::from_slice(&[[1]]) };
9977 assert_eq!(events.len(), 1);
9978 let mut tx = match events[0] {
9979 Event::FundingGenerationReady { ref channel_value_satoshis, ref output_script, .. } => {
9980 // Timelock the transaction within a +1 headroom from the best block.
9981 Transaction { version: chan_id as i32, lock_time: LockTime::from_consensus(best_height + 1), input: vec![input], output: vec![TxOut {
9982 value: *channel_value_satoshis, script_pubkey: output_script.clone(),
9985 _ => panic!("Unexpected event"),
9988 // Transaction should be accepted if it's in a +1 headroom from best block.
9989 assert!(nodes[0].node.funding_transaction_generated(&temp_channel_id, &nodes[1].node.get_our_node_id(), tx.clone()).is_ok());
9990 get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
9994 fn accept_busted_but_better_fee() {
9995 // If a peer sends us a fee update that is too low, but higher than our previous channel
9996 // feerate, we should accept it. In the future we may want to consider closing the channel
9997 // later, but for now we only accept the update.
9998 let mut chanmon_cfgs = create_chanmon_cfgs(2);
9999 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
10000 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
10001 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
10003 create_chan_between_nodes(&nodes[0], &nodes[1]);
10005 // Set nodes[1] to expect 5,000 sat/kW.
10007 let mut feerate_lock = chanmon_cfgs[1].fee_estimator.sat_per_kw.lock().unwrap();
10008 *feerate_lock = 5000;
10011 // If nodes[0] increases their feerate, even if its not enough, nodes[1] should accept it.
10013 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
10014 *feerate_lock = 1000;
10016 nodes[0].node.timer_tick_occurred();
10017 check_added_monitors!(nodes[0], 1);
10019 let events = nodes[0].node.get_and_clear_pending_msg_events();
10020 assert_eq!(events.len(), 1);
10022 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
10023 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_fee.as_ref().unwrap());
10024 commitment_signed_dance!(nodes[1], nodes[0], commitment_signed, false);
10026 _ => panic!("Unexpected event"),
10029 // If nodes[0] increases their feerate further, even if its not enough, nodes[1] should accept
10032 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
10033 *feerate_lock = 2000;
10035 nodes[0].node.timer_tick_occurred();
10036 check_added_monitors!(nodes[0], 1);
10038 let events = nodes[0].node.get_and_clear_pending_msg_events();
10039 assert_eq!(events.len(), 1);
10041 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
10042 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_fee.as_ref().unwrap());
10043 commitment_signed_dance!(nodes[1], nodes[0], commitment_signed, false);
10045 _ => panic!("Unexpected event"),
10048 // However, if nodes[0] decreases their feerate, nodes[1] should reject it and close the
10051 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
10052 *feerate_lock = 1000;
10054 nodes[0].node.timer_tick_occurred();
10055 check_added_monitors!(nodes[0], 1);
10057 let events = nodes[0].node.get_and_clear_pending_msg_events();
10058 assert_eq!(events.len(), 1);
10060 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, .. }, .. } => {
10061 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_fee.as_ref().unwrap());
10062 check_closed_event!(nodes[1], 1, ClosureReason::ProcessingError {
10063 err: "Peer's feerate much too low. Actual: 1000. Our expected lower limit: 5000".to_owned() },
10064 [nodes[0].node.get_our_node_id()], 100000);
10065 check_closed_broadcast!(nodes[1], true);
10066 check_added_monitors!(nodes[1], 1);
10068 _ => panic!("Unexpected event"),
10072 fn do_payment_with_custom_min_final_cltv_expiry(valid_delta: bool, use_user_hash: bool) {
10073 let mut chanmon_cfgs = create_chanmon_cfgs(2);
10074 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
10075 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
10076 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
10077 let min_final_cltv_expiry_delta = 120;
10078 let final_cltv_expiry_delta = if valid_delta { min_final_cltv_expiry_delta + 2 } else {
10079 min_final_cltv_expiry_delta - 2 };
10080 let recv_value = 100_000;
10082 create_chan_between_nodes(&nodes[0], &nodes[1]);
10084 let payment_parameters = PaymentParameters::from_node_id(nodes[1].node.get_our_node_id(), final_cltv_expiry_delta as u32);
10085 let (payment_hash, payment_preimage, payment_secret) = if use_user_hash {
10086 let (payment_preimage, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1],
10087 Some(recv_value), Some(min_final_cltv_expiry_delta));
10088 (payment_hash, payment_preimage, payment_secret)
10090 let (payment_hash, payment_secret) = nodes[1].node.create_inbound_payment(Some(recv_value), 7200, Some(min_final_cltv_expiry_delta)).unwrap();
10091 (payment_hash, nodes[1].node.get_payment_preimage(payment_hash, payment_secret).unwrap(), payment_secret)
10093 let route = get_route!(nodes[0], payment_parameters, recv_value).unwrap();
10094 nodes[0].node.send_payment_with_route(&route, payment_hash,
10095 RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_hash.0)).unwrap();
10096 check_added_monitors!(nodes[0], 1);
10097 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
10098 assert_eq!(events.len(), 1);
10099 let mut payment_event = SendEvent::from_event(events.pop().unwrap());
10100 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
10101 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
10102 expect_pending_htlcs_forwardable!(nodes[1]);
10105 expect_payment_claimable!(nodes[1], payment_hash, payment_secret, recv_value, if use_user_hash {
10106 None } else { Some(payment_preimage) }, nodes[1].node.get_our_node_id());
10108 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
10110 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash }]);
10112 check_added_monitors!(nodes[1], 1);
10114 let fail_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
10115 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_updates.update_fail_htlcs[0]);
10116 commitment_signed_dance!(nodes[0], nodes[1], fail_updates.commitment_signed, false, true);
10118 expect_payment_failed!(nodes[0], payment_hash, true);
10123 fn test_payment_with_custom_min_cltv_expiry_delta() {
10124 do_payment_with_custom_min_final_cltv_expiry(false, false);
10125 do_payment_with_custom_min_final_cltv_expiry(false, true);
10126 do_payment_with_custom_min_final_cltv_expiry(true, false);
10127 do_payment_with_custom_min_final_cltv_expiry(true, true);
10131 fn test_disconnects_peer_awaiting_response_ticks() {
10132 // Tests that nodes which are awaiting on a response critical for channel responsiveness
10133 // disconnect their counterparty after `DISCONNECT_PEER_AWAITING_RESPONSE_TICKS`.
10134 let mut chanmon_cfgs = create_chanmon_cfgs(2);
10135 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
10136 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
10137 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
10139 // Asserts a disconnect event is queued to the user.
10140 let check_disconnect_event = |node: &Node, should_disconnect: bool| {
10141 let disconnect_event = node.node.get_and_clear_pending_msg_events().iter().find_map(|event|
10142 if let MessageSendEvent::HandleError { action, .. } = event {
10143 if let msgs::ErrorAction::DisconnectPeerWithWarning { .. } = action {
10152 assert_eq!(disconnect_event.is_some(), should_disconnect);
10155 // Fires timer ticks ensuring we only attempt to disconnect peers after reaching
10156 // `DISCONNECT_PEER_AWAITING_RESPONSE_TICKS`.
10157 let check_disconnect = |node: &Node| {
10158 // No disconnect without any timer ticks.
10159 check_disconnect_event(node, false);
10161 // No disconnect with 1 timer tick less than required.
10162 for _ in 0..DISCONNECT_PEER_AWAITING_RESPONSE_TICKS - 1 {
10163 node.node.timer_tick_occurred();
10164 check_disconnect_event(node, false);
10167 // Disconnect after reaching the required ticks.
10168 node.node.timer_tick_occurred();
10169 check_disconnect_event(node, true);
10171 // Disconnect again on the next tick if the peer hasn't been disconnected yet.
10172 node.node.timer_tick_occurred();
10173 check_disconnect_event(node, true);
10176 create_chan_between_nodes(&nodes[0], &nodes[1]);
10178 // We'll start by performing a fee update with Alice (nodes[0]) on the channel.
10179 *nodes[0].fee_estimator.sat_per_kw.lock().unwrap() *= 2;
10180 nodes[0].node.timer_tick_occurred();
10181 check_added_monitors!(&nodes[0], 1);
10182 let alice_fee_update = get_htlc_update_msgs(&nodes[0], &nodes[1].node.get_our_node_id());
10183 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), alice_fee_update.update_fee.as_ref().unwrap());
10184 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &alice_fee_update.commitment_signed);
10185 check_added_monitors!(&nodes[1], 1);
10187 // This will prompt Bob (nodes[1]) to respond with his `CommitmentSigned` and `RevokeAndACK`.
10188 let (bob_revoke_and_ack, bob_commitment_signed) = get_revoke_commit_msgs!(&nodes[1], nodes[0].node.get_our_node_id());
10189 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bob_revoke_and_ack);
10190 check_added_monitors!(&nodes[0], 1);
10191 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bob_commitment_signed);
10192 check_added_monitors(&nodes[0], 1);
10194 // Alice then needs to send her final `RevokeAndACK` to complete the commitment dance. We
10195 // pretend Bob hasn't received the message and check whether he'll disconnect Alice after
10196 // reaching `DISCONNECT_PEER_AWAITING_RESPONSE_TICKS`.
10197 let alice_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
10198 check_disconnect(&nodes[1]);
10200 // Now, we'll reconnect them to test awaiting a `ChannelReestablish` message.
10202 // Note that since the commitment dance didn't complete above, Alice is expected to resend her
10203 // final `RevokeAndACK` to Bob to complete it.
10204 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id());
10205 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
10206 let bob_init = msgs::Init {
10207 features: nodes[1].node.init_features(), networks: None, remote_network_address: None
10209 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &bob_init, true).unwrap();
10210 let alice_init = msgs::Init {
10211 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
10213 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &alice_init, true).unwrap();
10215 // Upon reconnection, Alice sends her `ChannelReestablish` to Bob. Alice, however, hasn't
10216 // received Bob's yet, so she should disconnect him after reaching
10217 // `DISCONNECT_PEER_AWAITING_RESPONSE_TICKS`.
10218 let alice_channel_reestablish = get_event_msg!(
10219 nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id()
10221 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &alice_channel_reestablish);
10222 check_disconnect(&nodes[0]);
10224 // Bob now sends his `ChannelReestablish` to Alice to resume the channel and consider it "live".
10225 let bob_channel_reestablish = nodes[1].node.get_and_clear_pending_msg_events().iter().find_map(|event|
10226 if let MessageSendEvent::SendChannelReestablish { node_id, msg } = event {
10227 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
10233 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &bob_channel_reestablish);
10235 // Sanity check that Alice won't disconnect Bob since she's no longer waiting for any messages.
10236 for _ in 0..DISCONNECT_PEER_AWAITING_RESPONSE_TICKS {
10237 nodes[0].node.timer_tick_occurred();
10238 check_disconnect_event(&nodes[0], false);
10241 // However, Bob is still waiting on Alice's `RevokeAndACK`, so he should disconnect her after
10242 // reaching `DISCONNECT_PEER_AWAITING_RESPONSE_TICKS`.
10243 check_disconnect(&nodes[1]);
10245 // Finally, have Bob process the last message.
10246 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &alice_revoke_and_ack);
10247 check_added_monitors(&nodes[1], 1);
10249 // At this point, neither node should attempt to disconnect each other, since they aren't
10250 // waiting on any messages.
10251 for node in &nodes {
10252 for _ in 0..DISCONNECT_PEER_AWAITING_RESPONSE_TICKS {
10253 node.node.timer_tick_occurred();
10254 check_disconnect_event(node, false);
10260 fn test_remove_expired_outbound_unfunded_channels() {
10261 let chanmon_cfgs = create_chanmon_cfgs(2);
10262 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
10263 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
10264 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
10266 let temp_channel_id = nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100_000, 0, 42, None, None).unwrap();
10267 let open_channel_message = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
10268 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel_message);
10269 let accept_channel_message = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
10270 nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), &accept_channel_message);
10272 let events = nodes[0].node.get_and_clear_pending_events();
10273 assert_eq!(events.len(), 1);
10275 Event::FundingGenerationReady { .. } => (),
10276 _ => panic!("Unexpected event"),
10279 // Asserts the outbound channel has been removed from a nodes[0]'s peer state map.
10280 let check_outbound_channel_existence = |should_exist: bool| {
10281 let per_peer_state = nodes[0].node.per_peer_state.read().unwrap();
10282 let chan_lock = per_peer_state.get(&nodes[1].node.get_our_node_id()).unwrap().lock().unwrap();
10283 assert_eq!(chan_lock.channel_by_id.contains_key(&temp_channel_id), should_exist);
10286 // Channel should exist without any timer ticks.
10287 check_outbound_channel_existence(true);
10289 // Channel should exist with 1 timer tick less than required.
10290 for _ in 0..UNFUNDED_CHANNEL_AGE_LIMIT_TICKS - 1 {
10291 nodes[0].node.timer_tick_occurred();
10292 check_outbound_channel_existence(true)
10295 // Remove channel after reaching the required ticks.
10296 nodes[0].node.timer_tick_occurred();
10297 check_outbound_channel_existence(false);
10299 let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
10300 assert_eq!(msg_events.len(), 1);
10301 match msg_events[0] {
10302 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id: _ } => {
10303 assert_eq!(msg.data, "Force-closing pending channel due to timeout awaiting establishment handshake");
10305 _ => panic!("Unexpected event"),
10307 check_closed_event(&nodes[0], 1, ClosureReason::HolderForceClosed, false, &[nodes[1].node.get_our_node_id()], 100000);
10311 fn test_remove_expired_inbound_unfunded_channels() {
10312 let chanmon_cfgs = create_chanmon_cfgs(2);
10313 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
10314 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
10315 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
10317 let temp_channel_id = nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100_000, 0, 42, None, None).unwrap();
10318 let open_channel_message = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
10319 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel_message);
10320 let accept_channel_message = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
10321 nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), &accept_channel_message);
10323 let events = nodes[0].node.get_and_clear_pending_events();
10324 assert_eq!(events.len(), 1);
10326 Event::FundingGenerationReady { .. } => (),
10327 _ => panic!("Unexpected event"),
10330 // Asserts the inbound channel has been removed from a nodes[1]'s peer state map.
10331 let check_inbound_channel_existence = |should_exist: bool| {
10332 let per_peer_state = nodes[1].node.per_peer_state.read().unwrap();
10333 let chan_lock = per_peer_state.get(&nodes[0].node.get_our_node_id()).unwrap().lock().unwrap();
10334 assert_eq!(chan_lock.channel_by_id.contains_key(&temp_channel_id), should_exist);
10337 // Channel should exist without any timer ticks.
10338 check_inbound_channel_existence(true);
10340 // Channel should exist with 1 timer tick less than required.
10341 for _ in 0..UNFUNDED_CHANNEL_AGE_LIMIT_TICKS - 1 {
10342 nodes[1].node.timer_tick_occurred();
10343 check_inbound_channel_existence(true)
10346 // Remove channel after reaching the required ticks.
10347 nodes[1].node.timer_tick_occurred();
10348 check_inbound_channel_existence(false);
10350 let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
10351 assert_eq!(msg_events.len(), 1);
10352 match msg_events[0] {
10353 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id: _ } => {
10354 assert_eq!(msg.data, "Force-closing pending channel due to timeout awaiting establishment handshake");
10356 _ => panic!("Unexpected event"),
10358 check_closed_event(&nodes[1], 1, ClosureReason::HolderForceClosed, false, &[nodes[0].node.get_our_node_id()], 100000);
10361 fn do_test_multi_post_event_actions(do_reload: bool) {
10362 // Tests handling multiple post-Event actions at once.
10363 // There is specific code in ChannelManager to handle channels where multiple post-Event
10364 // `ChannelMonitorUpdates` are pending at once. This test exercises that code.
10366 // Specifically, we test calling `get_and_clear_pending_events` while there are two
10367 // PaymentSents from different channels and one channel has two pending `ChannelMonitorUpdate`s
10368 // - one from an RAA and one from an inbound commitment_signed.
10369 let chanmon_cfgs = create_chanmon_cfgs(3);
10370 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
10371 let (persister, chain_monitor);
10372 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
10373 let nodes_0_deserialized;
10374 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
10376 let chan_id = create_announced_chan_between_nodes(&nodes, 0, 1).2;
10377 let chan_id_2 = create_announced_chan_between_nodes(&nodes, 0, 2).2;
10379 send_payment(&nodes[0], &[&nodes[1]], 1_000_000);
10380 send_payment(&nodes[0], &[&nodes[2]], 1_000_000);
10382 let (our_payment_preimage, our_payment_hash, ..) = route_payment(&nodes[0], &[&nodes[1]], 1_000_000);
10383 let (payment_preimage_2, payment_hash_2, ..) = route_payment(&nodes[0], &[&nodes[2]], 1_000_000);
10385 nodes[1].node.claim_funds(our_payment_preimage);
10386 check_added_monitors!(nodes[1], 1);
10387 expect_payment_claimed!(nodes[1], our_payment_hash, 1_000_000);
10389 nodes[2].node.claim_funds(payment_preimage_2);
10390 check_added_monitors!(nodes[2], 1);
10391 expect_payment_claimed!(nodes[2], payment_hash_2, 1_000_000);
10393 for dest in &[1, 2] {
10394 let htlc_fulfill_updates = get_htlc_update_msgs!(nodes[*dest], nodes[0].node.get_our_node_id());
10395 nodes[0].node.handle_update_fulfill_htlc(&nodes[*dest].node.get_our_node_id(), &htlc_fulfill_updates.update_fulfill_htlcs[0]);
10396 commitment_signed_dance!(nodes[0], nodes[*dest], htlc_fulfill_updates.commitment_signed, false);
10397 check_added_monitors(&nodes[0], 0);
10400 let (route, payment_hash_3, _, payment_secret_3) =
10401 get_route_and_payment_hash!(nodes[1], nodes[0], 100_000);
10402 let payment_id = PaymentId(payment_hash_3.0);
10403 nodes[1].node.send_payment_with_route(&route, payment_hash_3,
10404 RecipientOnionFields::secret_only(payment_secret_3), payment_id).unwrap();
10405 check_added_monitors(&nodes[1], 1);
10407 let send_event = SendEvent::from_node(&nodes[1]);
10408 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &send_event.msgs[0]);
10409 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &send_event.commitment_msg);
10410 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
10413 let nodes_0_serialized = nodes[0].node.encode();
10414 let chan_0_monitor_serialized = get_monitor!(nodes[0], chan_id).encode();
10415 let chan_1_monitor_serialized = get_monitor!(nodes[0], chan_id_2).encode();
10416 reload_node!(nodes[0], test_default_channel_config(), &nodes_0_serialized, &[&chan_0_monitor_serialized, &chan_1_monitor_serialized], persister, chain_monitor, nodes_0_deserialized);
10418 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
10419 nodes[2].node.peer_disconnected(&nodes[0].node.get_our_node_id());
10421 reconnect_nodes(ReconnectArgs::new(&nodes[0], &nodes[1]));
10422 reconnect_nodes(ReconnectArgs::new(&nodes[0], &nodes[2]));
10425 let events = nodes[0].node.get_and_clear_pending_events();
10426 assert_eq!(events.len(), 4);
10427 if let Event::PaymentSent { payment_preimage, .. } = events[0] {
10428 assert!(payment_preimage == our_payment_preimage || payment_preimage == payment_preimage_2);
10429 } else { panic!(); }
10430 if let Event::PaymentSent { payment_preimage, .. } = events[1] {
10431 assert!(payment_preimage == our_payment_preimage || payment_preimage == payment_preimage_2);
10432 } else { panic!(); }
10433 if let Event::PaymentPathSuccessful { .. } = events[2] {} else { panic!(); }
10434 if let Event::PaymentPathSuccessful { .. } = events[3] {} else { panic!(); }
10436 // After the events are processed, the ChannelMonitorUpdates will be released and, upon their
10437 // completion, we'll respond to nodes[1] with an RAA + CS.
10438 get_revoke_commit_msgs(&nodes[0], &nodes[1].node.get_our_node_id());
10439 check_added_monitors(&nodes[0], 3);
10443 fn test_multi_post_event_actions() {
10444 do_test_multi_post_event_actions(true);
10445 do_test_multi_post_event_actions(false);
10449 fn test_batch_channel_open() {
10450 let chanmon_cfgs = create_chanmon_cfgs(3);
10451 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
10452 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
10453 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
10455 // Initiate channel opening and create the batch channel funding transaction.
10456 let (tx, funding_created_msgs) = create_batch_channel_funding(&nodes[0], &[
10457 (&nodes[1], 100_000, 0, 42, None),
10458 (&nodes[2], 200_000, 0, 43, None),
10461 // Go through the funding_created and funding_signed flow with node 1.
10462 nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created_msgs[0]);
10463 check_added_monitors(&nodes[1], 1);
10464 expect_channel_pending_event(&nodes[1], &nodes[0].node.get_our_node_id());
10466 let funding_signed_msg = get_event_msg!(nodes[1], MessageSendEvent::SendFundingSigned, nodes[0].node.get_our_node_id());
10467 nodes[0].node.handle_funding_signed(&nodes[1].node.get_our_node_id(), &funding_signed_msg);
10468 check_added_monitors(&nodes[0], 1);
10470 // The transaction should not have been broadcast before all channels are ready.
10471 assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 0);
10473 // Go through the funding_created and funding_signed flow with node 2.
10474 nodes[2].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created_msgs[1]);
10475 check_added_monitors(&nodes[2], 1);
10476 expect_channel_pending_event(&nodes[2], &nodes[0].node.get_our_node_id());
10478 let funding_signed_msg = get_event_msg!(nodes[2], MessageSendEvent::SendFundingSigned, nodes[0].node.get_our_node_id());
10479 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
10480 nodes[0].node.handle_funding_signed(&nodes[2].node.get_our_node_id(), &funding_signed_msg);
10481 check_added_monitors(&nodes[0], 1);
10483 // The transaction should not have been broadcast before persisting all monitors has been
10485 assert_eq!(nodes[0].tx_broadcaster.txn_broadcast().len(), 0);
10486 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
10488 // Complete the persistence of the monitor.
10489 nodes[0].chain_monitor.complete_sole_pending_chan_update(
10490 &OutPoint { txid: tx.txid(), index: 1 }.to_channel_id()
10492 let events = nodes[0].node.get_and_clear_pending_events();
10494 // The transaction should only have been broadcast now.
10495 let broadcasted_txs = nodes[0].tx_broadcaster.txn_broadcast();
10496 assert_eq!(broadcasted_txs.len(), 1);
10497 assert_eq!(broadcasted_txs[0], tx);
10499 assert_eq!(events.len(), 2);
10500 assert!(events.iter().any(|e| matches!(
10502 crate::events::Event::ChannelPending {
10503 ref counterparty_node_id,
10505 } if counterparty_node_id == &nodes[1].node.get_our_node_id(),
10507 assert!(events.iter().any(|e| matches!(
10509 crate::events::Event::ChannelPending {
10510 ref counterparty_node_id,
10512 } if counterparty_node_id == &nodes[2].node.get_our_node_id(),
10517 fn test_disconnect_in_funding_batch() {
10518 let chanmon_cfgs = create_chanmon_cfgs(3);
10519 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
10520 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
10521 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
10523 // Initiate channel opening and create the batch channel funding transaction.
10524 let (tx, funding_created_msgs) = create_batch_channel_funding(&nodes[0], &[
10525 (&nodes[1], 100_000, 0, 42, None),
10526 (&nodes[2], 200_000, 0, 43, None),
10529 // Go through the funding_created and funding_signed flow with node 1.
10530 nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created_msgs[0]);
10531 check_added_monitors(&nodes[1], 1);
10532 expect_channel_pending_event(&nodes[1], &nodes[0].node.get_our_node_id());
10534 let funding_signed_msg = get_event_msg!(nodes[1], MessageSendEvent::SendFundingSigned, nodes[0].node.get_our_node_id());
10535 nodes[0].node.handle_funding_signed(&nodes[1].node.get_our_node_id(), &funding_signed_msg);
10536 check_added_monitors(&nodes[0], 1);
10538 // The transaction should not have been broadcast before all channels are ready.
10539 assert_eq!(nodes[0].tx_broadcaster.txn_broadcast().len(), 0);
10541 // The remaining peer in the batch disconnects.
10542 nodes[0].node.peer_disconnected(&nodes[2].node.get_our_node_id());
10544 // The channels in the batch will close immediately.
10545 let channel_id_1 = OutPoint { txid: tx.txid(), index: 0 }.to_channel_id();
10546 let channel_id_2 = OutPoint { txid: tx.txid(), index: 1 }.to_channel_id();
10547 check_closed_events(&nodes[0], &[
10548 ExpectedCloseEvent {
10549 channel_id: Some(channel_id_1),
10550 discard_funding: true,
10551 ..Default::default()
10553 ExpectedCloseEvent {
10554 channel_id: Some(channel_id_2),
10555 discard_funding: true,
10556 ..Default::default()
10560 // The monitor should become closed.
10561 check_added_monitors(&nodes[0], 1);
10563 let mut monitor_updates = nodes[0].chain_monitor.monitor_updates.lock().unwrap();
10564 let monitor_updates_1 = monitor_updates.get(&channel_id_1).unwrap();
10565 assert_eq!(monitor_updates_1.len(), 1);
10566 assert_eq!(monitor_updates_1[0].update_id, CLOSED_CHANNEL_UPDATE_ID);
10569 // The funding transaction should not have been broadcast, and therefore, we don't need
10570 // to broadcast a force-close transaction for the closed monitor.
10571 assert_eq!(nodes[0].tx_broadcaster.txn_broadcast().len(), 0);
10573 // Ensure the channels don't exist anymore.
10574 assert!(nodes[0].node.list_channels().is_empty());
10578 fn test_batch_funding_close_after_funding_signed() {
10579 let chanmon_cfgs = create_chanmon_cfgs(3);
10580 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
10581 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
10582 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
10584 // Initiate channel opening and create the batch channel funding transaction.
10585 let (tx, funding_created_msgs) = create_batch_channel_funding(&nodes[0], &[
10586 (&nodes[1], 100_000, 0, 42, None),
10587 (&nodes[2], 200_000, 0, 43, None),
10590 // Go through the funding_created and funding_signed flow with node 1.
10591 nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created_msgs[0]);
10592 check_added_monitors(&nodes[1], 1);
10593 expect_channel_pending_event(&nodes[1], &nodes[0].node.get_our_node_id());
10595 let funding_signed_msg = get_event_msg!(nodes[1], MessageSendEvent::SendFundingSigned, nodes[0].node.get_our_node_id());
10596 nodes[0].node.handle_funding_signed(&nodes[1].node.get_our_node_id(), &funding_signed_msg);
10597 check_added_monitors(&nodes[0], 1);
10599 // Go through the funding_created and funding_signed flow with node 2.
10600 nodes[2].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created_msgs[1]);
10601 check_added_monitors(&nodes[2], 1);
10602 expect_channel_pending_event(&nodes[2], &nodes[0].node.get_our_node_id());
10604 let funding_signed_msg = get_event_msg!(nodes[2], MessageSendEvent::SendFundingSigned, nodes[0].node.get_our_node_id());
10605 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
10606 nodes[0].node.handle_funding_signed(&nodes[2].node.get_our_node_id(), &funding_signed_msg);
10607 check_added_monitors(&nodes[0], 1);
10609 // The transaction should not have been broadcast before all channels are ready.
10610 assert_eq!(nodes[0].tx_broadcaster.txn_broadcast().len(), 0);
10612 // Force-close the channel for which we've completed the initial monitor.
10613 let channel_id_1 = OutPoint { txid: tx.txid(), index: 0 }.to_channel_id();
10614 let channel_id_2 = OutPoint { txid: tx.txid(), index: 1 }.to_channel_id();
10615 nodes[0].node.force_close_broadcasting_latest_txn(&channel_id_1, &nodes[1].node.get_our_node_id()).unwrap();
10616 check_added_monitors(&nodes[0], 2);
10618 let mut monitor_updates = nodes[0].chain_monitor.monitor_updates.lock().unwrap();
10619 let monitor_updates_1 = monitor_updates.get(&channel_id_1).unwrap();
10620 assert_eq!(monitor_updates_1.len(), 1);
10621 assert_eq!(monitor_updates_1[0].update_id, CLOSED_CHANNEL_UPDATE_ID);
10622 let monitor_updates_2 = monitor_updates.get(&channel_id_2).unwrap();
10623 assert_eq!(monitor_updates_2.len(), 1);
10624 assert_eq!(monitor_updates_2[0].update_id, CLOSED_CHANNEL_UPDATE_ID);
10626 let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
10627 match msg_events[0] {
10628 MessageSendEvent::HandleError { .. } => (),
10629 _ => panic!("Unexpected message."),
10632 // We broadcast the commitment transaction as part of the force-close.
10634 let broadcasted_txs = nodes[0].tx_broadcaster.txn_broadcast();
10635 assert_eq!(broadcasted_txs.len(), 1);
10636 assert!(broadcasted_txs[0].txid() != tx.txid());
10637 assert_eq!(broadcasted_txs[0].input.len(), 1);
10638 assert_eq!(broadcasted_txs[0].input[0].previous_output.txid, tx.txid());
10641 // All channels in the batch should close immediately.
10642 check_closed_events(&nodes[0], &[
10643 ExpectedCloseEvent {
10644 channel_id: Some(channel_id_1),
10645 discard_funding: true,
10646 ..Default::default()
10648 ExpectedCloseEvent {
10649 channel_id: Some(channel_id_2),
10650 discard_funding: true,
10651 ..Default::default()
10655 // Ensure the channels don't exist anymore.
10656 assert!(nodes[0].node.list_channels().is_empty());
10659 fn do_test_funding_and_commitment_tx_confirm_same_block(confirm_remote_commitment: bool) {
10660 // Tests that a node will forget the channel (when it only requires 1 confirmation) if the
10661 // funding and commitment transaction confirm in the same block.
10662 let chanmon_cfgs = create_chanmon_cfgs(2);
10663 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
10664 let mut min_depth_1_block_cfg = test_default_channel_config();
10665 min_depth_1_block_cfg.channel_handshake_config.minimum_depth = 1;
10666 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[Some(min_depth_1_block_cfg), Some(min_depth_1_block_cfg)]);
10667 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
10669 let funding_tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 1_000_000, 0);
10670 let chan_id = chain::transaction::OutPoint { txid: funding_tx.txid(), index: 0 }.to_channel_id();
10672 assert_eq!(nodes[0].node.list_channels().len(), 1);
10673 assert_eq!(nodes[1].node.list_channels().len(), 1);
10675 let (closing_node, other_node) = if confirm_remote_commitment {
10676 (&nodes[1], &nodes[0])
10678 (&nodes[0], &nodes[1])
10681 closing_node.node.force_close_broadcasting_latest_txn(&chan_id, &other_node.node.get_our_node_id()).unwrap();
10682 let mut msg_events = closing_node.node.get_and_clear_pending_msg_events();
10683 assert_eq!(msg_events.len(), 1);
10684 match msg_events.pop().unwrap() {
10685 MessageSendEvent::HandleError { action: msgs::ErrorAction::DisconnectPeer { .. }, .. } => {},
10686 _ => panic!("Unexpected event"),
10688 check_added_monitors(closing_node, 1);
10689 check_closed_event(closing_node, 1, ClosureReason::HolderForceClosed, false, &[other_node.node.get_our_node_id()], 1_000_000);
10691 let commitment_tx = {
10692 let mut txn = closing_node.tx_broadcaster.txn_broadcast();
10693 assert_eq!(txn.len(), 1);
10694 let commitment_tx = txn.pop().unwrap();
10695 check_spends!(commitment_tx, funding_tx);
10699 mine_transactions(&nodes[0], &[&funding_tx, &commitment_tx]);
10700 mine_transactions(&nodes[1], &[&funding_tx, &commitment_tx]);
10702 check_closed_broadcast(other_node, 1, true);
10703 check_added_monitors(other_node, 1);
10704 check_closed_event(other_node, 1, ClosureReason::CommitmentTxConfirmed, false, &[closing_node.node.get_our_node_id()], 1_000_000);
10706 assert!(nodes[0].node.list_channels().is_empty());
10707 assert!(nodes[1].node.list_channels().is_empty());
10711 fn test_funding_and_commitment_tx_confirm_same_block() {
10712 do_test_funding_and_commitment_tx_confirm_same_block(false);
10713 do_test_funding_and_commitment_tx_confirm_same_block(true);