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 chain::{Confirm, Listen, Watch};
16 use chain::channelmonitor;
17 use chain::channelmonitor::{ChannelMonitor, CLTV_CLAIM_BUFFER, LATENCY_GRACE_PERIOD_BLOCKS, ANTI_REORG_DELAY};
18 use chain::transaction::OutPoint;
19 use chain::keysinterface::{KeysInterface, BaseSign};
20 use ln::{PaymentPreimage, PaymentSecret, PaymentHash};
21 use ln::channel::{COMMITMENT_TX_BASE_WEIGHT, COMMITMENT_TX_WEIGHT_PER_HTLC};
22 use ln::channelmanager::{ChannelManager, ChannelManagerReadArgs, RAACommitmentOrder, PaymentSendFailure, BREAKDOWN_TIMEOUT, MIN_CLTV_EXPIRY_DELTA};
23 use ln::channel::{Channel, ChannelError};
24 use ln::{chan_utils, onion_utils};
25 use routing::router::{Route, RouteHop, RouteHint, RouteHintHop, get_route};
26 use routing::network_graph::RoutingFees;
27 use ln::features::{ChannelFeatures, InitFeatures, InvoiceFeatures, NodeFeatures};
29 use ln::msgs::{ChannelMessageHandler,RoutingMessageHandler,HTLCFailChannelUpdate, ErrorAction};
30 use util::enforcing_trait_impls::EnforcingSigner;
31 use util::{byte_utils, test_utils};
32 use util::events::{Event, MessageSendEvent, MessageSendEventsProvider};
33 use util::errors::APIError;
34 use util::ser::{Writeable, ReadableArgs};
35 use util::config::UserConfig;
37 use bitcoin::hashes::sha256d::Hash as Sha256dHash;
38 use bitcoin::hash_types::{Txid, BlockHash};
39 use bitcoin::blockdata::block::{Block, BlockHeader};
40 use bitcoin::blockdata::script::Builder;
41 use bitcoin::blockdata::opcodes;
42 use bitcoin::blockdata::constants::genesis_block;
43 use bitcoin::network::constants::Network;
45 use bitcoin::hashes::sha256::Hash as Sha256;
46 use bitcoin::hashes::Hash;
48 use bitcoin::secp256k1::{Secp256k1, Message};
49 use bitcoin::secp256k1::key::{PublicKey,SecretKey};
54 use alloc::collections::BTreeSet;
55 use core::default::Default;
56 use std::sync::{Arc, Mutex};
58 use ln::functional_test_utils::*;
59 use ln::chan_utils::CommitmentTransaction;
60 use ln::msgs::OptionalField::Present;
63 fn test_insane_channel_opens() {
64 // Stand up a network of 2 nodes
65 let chanmon_cfgs = create_chanmon_cfgs(2);
66 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
67 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
68 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
70 // Instantiate channel parameters where we push the maximum msats given our
72 let channel_value_sat = 31337; // same as funding satoshis
73 let channel_reserve_satoshis = Channel::<EnforcingSigner>::get_holder_selected_channel_reserve_satoshis(channel_value_sat);
74 let push_msat = (channel_value_sat - channel_reserve_satoshis) * 1000;
76 // Have node0 initiate a channel to node1 with aforementioned parameters
77 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_sat, push_msat, 42, None).unwrap();
79 // Extract the channel open message from node0 to node1
80 let open_channel_message = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
82 // Test helper that asserts we get the correct error string given a mutator
83 // that supposedly makes the channel open message insane
84 let insane_open_helper = |expected_error_str: &str, message_mutator: fn(msgs::OpenChannel) -> msgs::OpenChannel| {
85 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &message_mutator(open_channel_message.clone()));
86 let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
87 assert_eq!(msg_events.len(), 1);
88 let expected_regex = regex::Regex::new(expected_error_str).unwrap();
89 if let MessageSendEvent::HandleError { ref action, .. } = msg_events[0] {
91 &ErrorAction::SendErrorMessage { .. } => {
92 nodes[1].logger.assert_log_regex("lightning::ln::channelmanager".to_string(), expected_regex, 1);
94 _ => panic!("unexpected event!"),
96 } else { assert!(false); }
99 use ln::channel::MAX_FUNDING_SATOSHIS;
100 use ln::channelmanager::MAX_LOCAL_BREAKDOWN_TIMEOUT;
102 // Test all mutations that would make the channel open message insane
103 insane_open_helper(format!("Funding must be smaller than {}. It was {}", MAX_FUNDING_SATOSHIS, MAX_FUNDING_SATOSHIS).as_str(), |mut msg| { msg.funding_satoshis = MAX_FUNDING_SATOSHIS; msg });
105 insane_open_helper("Bogus channel_reserve_satoshis", |mut msg| { msg.channel_reserve_satoshis = msg.funding_satoshis + 1; msg });
107 insane_open_helper(r"push_msat \d+ was larger than funding value \d+", |mut msg| { msg.push_msat = (msg.funding_satoshis - msg.channel_reserve_satoshis) * 1000 + 1; msg });
109 insane_open_helper("Peer never wants payout outputs?", |mut msg| { msg.dust_limit_satoshis = msg.funding_satoshis + 1 ; msg });
111 insane_open_helper(r"Bogus; channel reserve \(\d+\) is less than dust limit \(\d+\)", |mut msg| { msg.dust_limit_satoshis = msg.channel_reserve_satoshis + 1; msg });
113 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 });
115 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 });
117 insane_open_helper("0 max_accepted_htlcs makes for a useless channel", |mut msg| { msg.max_accepted_htlcs = 0; msg });
119 insane_open_helper("max_accepted_htlcs was 484. It must not be larger than 483", |mut msg| { msg.max_accepted_htlcs = 484; msg });
123 fn test_async_inbound_update_fee() {
124 let chanmon_cfgs = create_chanmon_cfgs(2);
125 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
126 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
127 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
128 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
129 let logger = test_utils::TestLogger::new();
130 let channel_id = chan.2;
133 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
137 // send (1) commitment_signed -.
138 // <- update_add_htlc/commitment_signed
139 // send (2) RAA (awaiting remote revoke) -.
140 // (1) commitment_signed is delivered ->
141 // .- send (3) RAA (awaiting remote revoke)
142 // (2) RAA is delivered ->
143 // .- send (4) commitment_signed
144 // <- (3) RAA is delivered
145 // send (5) commitment_signed -.
146 // <- (4) commitment_signed is delivered
148 // (5) commitment_signed is delivered ->
150 // (6) RAA is delivered ->
152 // First nodes[0] generates an update_fee
153 nodes[0].node.update_fee(channel_id, get_feerate!(nodes[0], channel_id) + 20).unwrap();
154 check_added_monitors!(nodes[0], 1);
156 let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
157 assert_eq!(events_0.len(), 1);
158 let (update_msg, commitment_signed) = match events_0[0] { // (1)
159 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
160 (update_fee.as_ref(), commitment_signed)
162 _ => panic!("Unexpected event"),
165 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
167 // ...but before it's delivered, nodes[1] starts to send a payment back to nodes[0]...
168 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[0]);
169 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
170 nodes[1].node.send_payment(&get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[0].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 40000, TEST_FINAL_CLTV, &logger).unwrap(), our_payment_hash, &Some(our_payment_secret)).unwrap();
171 check_added_monitors!(nodes[1], 1);
173 let payment_event = {
174 let mut events_1 = nodes[1].node.get_and_clear_pending_msg_events();
175 assert_eq!(events_1.len(), 1);
176 SendEvent::from_event(events_1.remove(0))
178 assert_eq!(payment_event.node_id, nodes[0].node.get_our_node_id());
179 assert_eq!(payment_event.msgs.len(), 1);
181 // ...now when the messages get delivered everyone should be happy
182 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
183 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg); // (2)
184 let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
185 // nodes[0] is awaiting nodes[1] revoke_and_ack so get_event_msg's assert(len == 1) passes
186 check_added_monitors!(nodes[0], 1);
188 // deliver(1), generate (3):
189 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
190 let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
191 // nodes[1] is awaiting nodes[0] revoke_and_ack so get_event_msg's assert(len == 1) passes
192 check_added_monitors!(nodes[1], 1);
194 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack); // deliver (2)
195 let bs_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
196 assert!(bs_update.update_add_htlcs.is_empty()); // (4)
197 assert!(bs_update.update_fulfill_htlcs.is_empty()); // (4)
198 assert!(bs_update.update_fail_htlcs.is_empty()); // (4)
199 assert!(bs_update.update_fail_malformed_htlcs.is_empty()); // (4)
200 assert!(bs_update.update_fee.is_none()); // (4)
201 check_added_monitors!(nodes[1], 1);
203 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack); // deliver (3)
204 let as_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
205 assert!(as_update.update_add_htlcs.is_empty()); // (5)
206 assert!(as_update.update_fulfill_htlcs.is_empty()); // (5)
207 assert!(as_update.update_fail_htlcs.is_empty()); // (5)
208 assert!(as_update.update_fail_malformed_htlcs.is_empty()); // (5)
209 assert!(as_update.update_fee.is_none()); // (5)
210 check_added_monitors!(nodes[0], 1);
212 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_update.commitment_signed); // deliver (4)
213 let as_second_revoke = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
214 // only (6) so get_event_msg's assert(len == 1) passes
215 check_added_monitors!(nodes[0], 1);
217 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_update.commitment_signed); // deliver (5)
218 let bs_second_revoke = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
219 check_added_monitors!(nodes[1], 1);
221 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke);
222 check_added_monitors!(nodes[0], 1);
224 let events_2 = nodes[0].node.get_and_clear_pending_events();
225 assert_eq!(events_2.len(), 1);
227 Event::PendingHTLCsForwardable {..} => {}, // If we actually processed we'd receive the payment
228 _ => panic!("Unexpected event"),
231 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_revoke); // deliver (6)
232 check_added_monitors!(nodes[1], 1);
236 fn test_update_fee_unordered_raa() {
237 // Just the intro to the previous test followed by an out-of-order RAA (which caused a
238 // crash in an earlier version of the update_fee patch)
239 let chanmon_cfgs = create_chanmon_cfgs(2);
240 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
241 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
242 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
243 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
244 let channel_id = chan.2;
245 let logger = test_utils::TestLogger::new();
248 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
250 // First nodes[0] generates an update_fee
251 nodes[0].node.update_fee(channel_id, get_feerate!(nodes[0], channel_id) + 20).unwrap();
252 check_added_monitors!(nodes[0], 1);
254 let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
255 assert_eq!(events_0.len(), 1);
256 let update_msg = match events_0[0] { // (1)
257 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, .. }, .. } => {
260 _ => panic!("Unexpected event"),
263 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
265 // ...but before it's delivered, nodes[1] starts to send a payment back to nodes[0]...
266 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[0]);
267 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
268 nodes[1].node.send_payment(&get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[0].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 40000, TEST_FINAL_CLTV, &logger).unwrap(), our_payment_hash, &Some(our_payment_secret)).unwrap();
269 check_added_monitors!(nodes[1], 1);
271 let payment_event = {
272 let mut events_1 = nodes[1].node.get_and_clear_pending_msg_events();
273 assert_eq!(events_1.len(), 1);
274 SendEvent::from_event(events_1.remove(0))
276 assert_eq!(payment_event.node_id, nodes[0].node.get_our_node_id());
277 assert_eq!(payment_event.msgs.len(), 1);
279 // ...now when the messages get delivered everyone should be happy
280 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
281 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg); // (2)
282 let as_revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
283 // nodes[0] is awaiting nodes[1] revoke_and_ack so get_event_msg's assert(len == 1) passes
284 check_added_monitors!(nodes[0], 1);
286 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_msg); // deliver (2)
287 check_added_monitors!(nodes[1], 1);
289 // We can't continue, sadly, because our (1) now has a bogus signature
293 fn test_multi_flight_update_fee() {
294 let chanmon_cfgs = create_chanmon_cfgs(2);
295 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
296 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
297 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
298 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
299 let channel_id = chan.2;
302 // update_fee/commitment_signed ->
303 // .- send (1) RAA and (2) commitment_signed
304 // update_fee (never committed) ->
306 // We have to manually generate the above update_fee, it is allowed by the protocol but we
307 // don't track which updates correspond to which revoke_and_ack responses so we're in
308 // AwaitingRAA mode and will not generate the update_fee yet.
309 // <- (1) RAA delivered
310 // (3) is generated and send (4) CS -.
311 // Note that A cannot generate (4) prior to (1) being delivered as it otherwise doesn't
312 // know the per_commitment_point to use for it.
313 // <- (2) commitment_signed delivered
315 // B should send no response here
316 // (4) commitment_signed delivered ->
317 // <- RAA/commitment_signed delivered
320 // First nodes[0] generates an update_fee
321 let initial_feerate = get_feerate!(nodes[0], channel_id);
322 nodes[0].node.update_fee(channel_id, initial_feerate + 20).unwrap();
323 check_added_monitors!(nodes[0], 1);
325 let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
326 assert_eq!(events_0.len(), 1);
327 let (update_msg_1, commitment_signed_1) = match events_0[0] { // (1)
328 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
329 (update_fee.as_ref().unwrap(), commitment_signed)
331 _ => panic!("Unexpected event"),
334 // Deliver first update_fee/commitment_signed pair, generating (1) and (2):
335 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg_1);
336 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed_1);
337 let (bs_revoke_msg, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
338 check_added_monitors!(nodes[1], 1);
340 // nodes[0] is awaiting a revoke from nodes[1] before it will create a new commitment
342 nodes[0].node.update_fee(channel_id, initial_feerate + 40).unwrap();
343 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
344 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
346 // Create the (3) update_fee message that nodes[0] will generate before it does...
347 let mut update_msg_2 = msgs::UpdateFee {
348 channel_id: update_msg_1.channel_id.clone(),
349 feerate_per_kw: (initial_feerate + 30) as u32,
352 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg_2);
354 update_msg_2.feerate_per_kw = (initial_feerate + 40) as u32;
356 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg_2);
358 // Deliver (1), generating (3) and (4)
359 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_msg);
360 let as_second_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
361 check_added_monitors!(nodes[0], 1);
362 assert!(as_second_update.update_add_htlcs.is_empty());
363 assert!(as_second_update.update_fulfill_htlcs.is_empty());
364 assert!(as_second_update.update_fail_htlcs.is_empty());
365 assert!(as_second_update.update_fail_malformed_htlcs.is_empty());
366 // Check that the update_fee newly generated matches what we delivered:
367 assert_eq!(as_second_update.update_fee.as_ref().unwrap().channel_id, update_msg_2.channel_id);
368 assert_eq!(as_second_update.update_fee.as_ref().unwrap().feerate_per_kw, update_msg_2.feerate_per_kw);
370 // Deliver (2) commitment_signed
371 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_commitment_signed);
372 let as_revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
373 check_added_monitors!(nodes[0], 1);
374 // No commitment_signed so get_event_msg's assert(len == 1) passes
376 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_msg);
377 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
378 check_added_monitors!(nodes[1], 1);
381 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_second_update.commitment_signed);
382 let (bs_second_revoke, bs_second_commitment) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
383 check_added_monitors!(nodes[1], 1);
385 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke);
386 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
387 check_added_monitors!(nodes[0], 1);
389 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_commitment);
390 let as_second_revoke = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
391 // No commitment_signed so get_event_msg's assert(len == 1) passes
392 check_added_monitors!(nodes[0], 1);
394 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_revoke);
395 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
396 check_added_monitors!(nodes[1], 1);
399 fn do_test_1_conf_open(connect_style: ConnectStyle) {
400 // Previously, if the minium_depth config was set to 1, we'd never send a funding_locked. This
401 // tests that we properly send one in that case.
402 let mut alice_config = UserConfig::default();
403 alice_config.own_channel_config.minimum_depth = 1;
404 alice_config.channel_options.announced_channel = true;
405 alice_config.peer_channel_config_limits.force_announced_channel_preference = false;
406 let mut bob_config = UserConfig::default();
407 bob_config.own_channel_config.minimum_depth = 1;
408 bob_config.channel_options.announced_channel = true;
409 bob_config.peer_channel_config_limits.force_announced_channel_preference = false;
410 let chanmon_cfgs = create_chanmon_cfgs(2);
411 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
412 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[Some(alice_config), Some(bob_config)]);
413 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
414 *nodes[0].connect_style.borrow_mut() = connect_style;
416 let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
417 mine_transaction(&nodes[1], &tx);
418 nodes[0].node.handle_funding_locked(&nodes[1].node.get_our_node_id(), &get_event_msg!(nodes[1], MessageSendEvent::SendFundingLocked, nodes[0].node.get_our_node_id()));
420 mine_transaction(&nodes[0], &tx);
421 let (funding_locked, _) = create_chan_between_nodes_with_value_confirm_second(&nodes[1], &nodes[0]);
422 let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
425 assert!(node.net_graph_msg_handler.handle_channel_announcement(&announcement).unwrap());
426 node.net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
427 node.net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
431 fn test_1_conf_open() {
432 do_test_1_conf_open(ConnectStyle::BestBlockFirst);
433 do_test_1_conf_open(ConnectStyle::TransactionsFirst);
434 do_test_1_conf_open(ConnectStyle::FullBlockViaListen);
437 fn do_test_sanity_on_in_flight_opens(steps: u8) {
438 // Previously, we had issues deserializing channels when we hadn't connected the first block
439 // after creation. To catch that and similar issues, we lean on the Node::drop impl to test
440 // serialization round-trips and simply do steps towards opening a channel and then drop the
443 let chanmon_cfgs = create_chanmon_cfgs(2);
444 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
445 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
446 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
448 if steps & 0b1000_0000 != 0{
450 header: BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
453 connect_block(&nodes[0], &block);
454 connect_block(&nodes[1], &block);
457 if steps & 0x0f == 0 { return; }
458 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
459 let open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
461 if steps & 0x0f == 1 { return; }
462 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_channel);
463 let accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
465 if steps & 0x0f == 2 { return; }
466 nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &accept_channel);
468 let (temporary_channel_id, tx, funding_output) = create_funding_transaction(&nodes[0], 100000, 42);
470 if steps & 0x0f == 3 { return; }
471 nodes[0].node.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
472 check_added_monitors!(nodes[0], 0);
473 let funding_created = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
475 if steps & 0x0f == 4 { return; }
476 nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created);
478 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
479 assert_eq!(added_monitors.len(), 1);
480 assert_eq!(added_monitors[0].0, funding_output);
481 added_monitors.clear();
483 let funding_signed = get_event_msg!(nodes[1], MessageSendEvent::SendFundingSigned, nodes[0].node.get_our_node_id());
485 if steps & 0x0f == 5 { return; }
486 nodes[0].node.handle_funding_signed(&nodes[1].node.get_our_node_id(), &funding_signed);
488 let mut added_monitors = nodes[0].chain_monitor.added_monitors.lock().unwrap();
489 assert_eq!(added_monitors.len(), 1);
490 assert_eq!(added_monitors[0].0, funding_output);
491 added_monitors.clear();
494 let events_4 = nodes[0].node.get_and_clear_pending_events();
495 assert_eq!(events_4.len(), 0);
497 if steps & 0x0f == 6 { return; }
498 create_chan_between_nodes_with_value_confirm_first(&nodes[0], &nodes[1], &tx, 2);
500 if steps & 0x0f == 7 { return; }
501 confirm_transaction_at(&nodes[0], &tx, 2);
502 connect_blocks(&nodes[0], CHAN_CONFIRM_DEPTH);
503 create_chan_between_nodes_with_value_confirm_second(&nodes[1], &nodes[0]);
507 fn test_sanity_on_in_flight_opens() {
508 do_test_sanity_on_in_flight_opens(0);
509 do_test_sanity_on_in_flight_opens(0 | 0b1000_0000);
510 do_test_sanity_on_in_flight_opens(1);
511 do_test_sanity_on_in_flight_opens(1 | 0b1000_0000);
512 do_test_sanity_on_in_flight_opens(2);
513 do_test_sanity_on_in_flight_opens(2 | 0b1000_0000);
514 do_test_sanity_on_in_flight_opens(3);
515 do_test_sanity_on_in_flight_opens(3 | 0b1000_0000);
516 do_test_sanity_on_in_flight_opens(4);
517 do_test_sanity_on_in_flight_opens(4 | 0b1000_0000);
518 do_test_sanity_on_in_flight_opens(5);
519 do_test_sanity_on_in_flight_opens(5 | 0b1000_0000);
520 do_test_sanity_on_in_flight_opens(6);
521 do_test_sanity_on_in_flight_opens(6 | 0b1000_0000);
522 do_test_sanity_on_in_flight_opens(7);
523 do_test_sanity_on_in_flight_opens(7 | 0b1000_0000);
524 do_test_sanity_on_in_flight_opens(8);
525 do_test_sanity_on_in_flight_opens(8 | 0b1000_0000);
529 fn test_update_fee_vanilla() {
530 let chanmon_cfgs = create_chanmon_cfgs(2);
531 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
532 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
533 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
534 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
535 let channel_id = chan.2;
537 let feerate = get_feerate!(nodes[0], channel_id);
538 nodes[0].node.update_fee(channel_id, feerate+25).unwrap();
539 check_added_monitors!(nodes[0], 1);
541 let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
542 assert_eq!(events_0.len(), 1);
543 let (update_msg, commitment_signed) = match events_0[0] {
544 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 } } => {
545 (update_fee.as_ref(), commitment_signed)
547 _ => panic!("Unexpected event"),
549 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
551 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
552 let (revoke_msg, commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
553 check_added_monitors!(nodes[1], 1);
555 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
556 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
557 check_added_monitors!(nodes[0], 1);
559 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
560 let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
561 // No commitment_signed so get_event_msg's assert(len == 1) passes
562 check_added_monitors!(nodes[0], 1);
564 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg);
565 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
566 check_added_monitors!(nodes[1], 1);
570 fn test_update_fee_that_funder_cannot_afford() {
571 let chanmon_cfgs = create_chanmon_cfgs(2);
572 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
573 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
574 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
575 let channel_value = 1888;
576 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, channel_value, 700000, InitFeatures::known(), InitFeatures::known());
577 let channel_id = chan.2;
580 nodes[0].node.update_fee(channel_id, feerate).unwrap();
581 check_added_monitors!(nodes[0], 1);
582 let update_msg = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
584 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg.update_fee.unwrap());
586 commitment_signed_dance!(nodes[1], nodes[0], update_msg.commitment_signed, false);
588 //Confirm that the new fee based on the last local commitment txn is what we expected based on the feerate of 260 set above.
589 //This value results in a fee that is exactly what the funder can afford (277 sat + 1000 sat channel reserve)
591 let commitment_tx = get_local_commitment_txn!(nodes[1], channel_id)[0].clone();
593 //We made sure neither party's funds are below the dust limit so -2 non-HTLC txns from number of outputs
594 let num_htlcs = commitment_tx.output.len() - 2;
595 let total_fee: u64 = feerate as u64 * (COMMITMENT_TX_BASE_WEIGHT + (num_htlcs as u64) * COMMITMENT_TX_WEIGHT_PER_HTLC) / 1000;
596 let mut actual_fee = commitment_tx.output.iter().fold(0, |acc, output| acc + output.value);
597 actual_fee = channel_value - actual_fee;
598 assert_eq!(total_fee, actual_fee);
601 //Add 2 to the previous fee rate to the final fee increases by 1 (with no HTLCs the fee is essentially
602 //fee_rate*(724/1000) so the increment of 1*0.724 is rounded back down)
603 nodes[0].node.update_fee(channel_id, feerate+2).unwrap();
604 check_added_monitors!(nodes[0], 1);
606 let update2_msg = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
608 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update2_msg.update_fee.unwrap());
610 //While producing the commitment_signed response after handling a received update_fee request the
611 //check to see if the funder, who sent the update_fee request, can afford the new fee (funder_balance >= fee+channel_reserve)
612 //Should produce and error.
613 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &update2_msg.commitment_signed);
614 nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Funding remote cannot afford proposed new fee".to_string(), 1);
615 check_added_monitors!(nodes[1], 1);
616 check_closed_broadcast!(nodes[1], true);
620 fn test_update_fee_with_fundee_update_add_htlc() {
621 let chanmon_cfgs = create_chanmon_cfgs(2);
622 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
623 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
624 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
625 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
626 let channel_id = chan.2;
627 let logger = test_utils::TestLogger::new();
630 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
632 let feerate = get_feerate!(nodes[0], channel_id);
633 nodes[0].node.update_fee(channel_id, feerate+20).unwrap();
634 check_added_monitors!(nodes[0], 1);
636 let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
637 assert_eq!(events_0.len(), 1);
638 let (update_msg, commitment_signed) = match events_0[0] {
639 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 } } => {
640 (update_fee.as_ref(), commitment_signed)
642 _ => panic!("Unexpected event"),
644 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
645 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
646 let (revoke_msg, commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
647 check_added_monitors!(nodes[1], 1);
649 let (our_payment_preimage, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[0]);
650 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
651 let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[0].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 800000, TEST_FINAL_CLTV, &logger).unwrap();
653 // nothing happens since node[1] is in AwaitingRemoteRevoke
654 nodes[1].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
656 let mut added_monitors = nodes[0].chain_monitor.added_monitors.lock().unwrap();
657 assert_eq!(added_monitors.len(), 0);
658 added_monitors.clear();
660 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
661 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
662 // node[1] has nothing to do
664 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
665 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
666 check_added_monitors!(nodes[0], 1);
668 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
669 let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
670 // No commitment_signed so get_event_msg's assert(len == 1) passes
671 check_added_monitors!(nodes[0], 1);
672 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg);
673 check_added_monitors!(nodes[1], 1);
674 // AwaitingRemoteRevoke ends here
676 let commitment_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
677 assert_eq!(commitment_update.update_add_htlcs.len(), 1);
678 assert_eq!(commitment_update.update_fulfill_htlcs.len(), 0);
679 assert_eq!(commitment_update.update_fail_htlcs.len(), 0);
680 assert_eq!(commitment_update.update_fail_malformed_htlcs.len(), 0);
681 assert_eq!(commitment_update.update_fee.is_none(), true);
683 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &commitment_update.update_add_htlcs[0]);
684 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_update.commitment_signed);
685 check_added_monitors!(nodes[0], 1);
686 let (revoke, commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
688 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke);
689 check_added_monitors!(nodes[1], 1);
690 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
692 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commitment_signed);
693 check_added_monitors!(nodes[1], 1);
694 let revoke = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
695 // No commitment_signed so get_event_msg's assert(len == 1) passes
697 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke);
698 check_added_monitors!(nodes[0], 1);
699 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
701 expect_pending_htlcs_forwardable!(nodes[0]);
703 let events = nodes[0].node.get_and_clear_pending_events();
704 assert_eq!(events.len(), 1);
706 Event::PaymentReceived { .. } => { },
707 _ => panic!("Unexpected event"),
710 claim_payment(&nodes[1], &vec!(&nodes[0])[..], our_payment_preimage);
712 send_payment(&nodes[1], &vec!(&nodes[0])[..], 800000);
713 send_payment(&nodes[0], &vec!(&nodes[1])[..], 800000);
714 close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true);
718 fn test_update_fee() {
719 let chanmon_cfgs = create_chanmon_cfgs(2);
720 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
721 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
722 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
723 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
724 let channel_id = chan.2;
727 // (1) update_fee/commitment_signed ->
728 // <- (2) revoke_and_ack
729 // .- send (3) commitment_signed
730 // (4) update_fee/commitment_signed ->
731 // .- send (5) revoke_and_ack (no CS as we're awaiting a revoke)
732 // <- (3) commitment_signed delivered
733 // send (6) revoke_and_ack -.
734 // <- (5) deliver revoke_and_ack
735 // (6) deliver revoke_and_ack ->
736 // .- send (7) commitment_signed in response to (4)
737 // <- (7) deliver commitment_signed
740 // Create and deliver (1)...
741 let feerate = get_feerate!(nodes[0], channel_id);
742 nodes[0].node.update_fee(channel_id, feerate+20).unwrap();
743 check_added_monitors!(nodes[0], 1);
745 let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
746 assert_eq!(events_0.len(), 1);
747 let (update_msg, commitment_signed) = match events_0[0] {
748 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 } } => {
749 (update_fee.as_ref(), commitment_signed)
751 _ => panic!("Unexpected event"),
753 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
755 // Generate (2) and (3):
756 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
757 let (revoke_msg, commitment_signed_0) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
758 check_added_monitors!(nodes[1], 1);
761 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
762 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
763 check_added_monitors!(nodes[0], 1);
765 // Create and deliver (4)...
766 nodes[0].node.update_fee(channel_id, feerate+30).unwrap();
767 check_added_monitors!(nodes[0], 1);
768 let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
769 assert_eq!(events_0.len(), 1);
770 let (update_msg, commitment_signed) = match events_0[0] {
771 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 } } => {
772 (update_fee.as_ref(), commitment_signed)
774 _ => panic!("Unexpected event"),
777 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
778 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
779 check_added_monitors!(nodes[1], 1);
781 let revoke_msg = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
782 // No commitment_signed so get_event_msg's assert(len == 1) passes
784 // Handle (3), creating (6):
785 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed_0);
786 check_added_monitors!(nodes[0], 1);
787 let revoke_msg_0 = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
788 // No commitment_signed so get_event_msg's assert(len == 1) passes
791 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
792 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
793 check_added_monitors!(nodes[0], 1);
795 // Deliver (6), creating (7):
796 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg_0);
797 let commitment_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
798 assert!(commitment_update.update_add_htlcs.is_empty());
799 assert!(commitment_update.update_fulfill_htlcs.is_empty());
800 assert!(commitment_update.update_fail_htlcs.is_empty());
801 assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
802 assert!(commitment_update.update_fee.is_none());
803 check_added_monitors!(nodes[1], 1);
806 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_update.commitment_signed);
807 check_added_monitors!(nodes[0], 1);
808 let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
809 // No commitment_signed so get_event_msg's assert(len == 1) passes
811 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg);
812 check_added_monitors!(nodes[1], 1);
813 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
815 assert_eq!(get_feerate!(nodes[0], channel_id), feerate + 30);
816 assert_eq!(get_feerate!(nodes[1], channel_id), feerate + 30);
817 close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true);
821 fn pre_funding_lock_shutdown_test() {
822 // Test sending a shutdown prior to funding_locked after funding generation
823 let chanmon_cfgs = create_chanmon_cfgs(2);
824 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
825 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
826 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
827 let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 8000000, 0, InitFeatures::known(), InitFeatures::known());
828 mine_transaction(&nodes[0], &tx);
829 mine_transaction(&nodes[1], &tx);
831 nodes[0].node.close_channel(&OutPoint { txid: tx.txid(), index: 0 }.to_channel_id()).unwrap();
832 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
833 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
834 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
835 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_shutdown);
837 let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
838 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
839 let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
840 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
841 let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
842 assert!(node_0_none.is_none());
844 assert!(nodes[0].node.list_channels().is_empty());
845 assert!(nodes[1].node.list_channels().is_empty());
849 fn updates_shutdown_wait() {
850 // Test sending a shutdown with outstanding updates pending
851 let chanmon_cfgs = create_chanmon_cfgs(3);
852 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
853 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
854 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
855 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
856 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
857 let logger = test_utils::TestLogger::new();
859 let (our_payment_preimage, _, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100000);
861 nodes[0].node.close_channel(&chan_1.2).unwrap();
862 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
863 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
864 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
865 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_shutdown);
867 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
868 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
870 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[0]);
872 let net_graph_msg_handler0 = &nodes[0].net_graph_msg_handler;
873 let net_graph_msg_handler1 = &nodes[1].net_graph_msg_handler;
874 let route_1 = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler0.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
875 let route_2 = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler1.network_graph.read().unwrap(), &nodes[0].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
876 unwrap_send_err!(nodes[0].node.send_payment(&route_1, payment_hash, &Some(payment_secret)), true, APIError::ChannelUnavailable {..}, {});
877 unwrap_send_err!(nodes[1].node.send_payment(&route_2, payment_hash, &Some(payment_secret)), true, APIError::ChannelUnavailable {..}, {});
879 assert!(nodes[2].node.claim_funds(our_payment_preimage));
880 check_added_monitors!(nodes[2], 1);
881 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
882 assert!(updates.update_add_htlcs.is_empty());
883 assert!(updates.update_fail_htlcs.is_empty());
884 assert!(updates.update_fail_malformed_htlcs.is_empty());
885 assert!(updates.update_fee.is_none());
886 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
887 nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
888 check_added_monitors!(nodes[1], 1);
889 let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
890 commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
892 assert!(updates_2.update_add_htlcs.is_empty());
893 assert!(updates_2.update_fail_htlcs.is_empty());
894 assert!(updates_2.update_fail_malformed_htlcs.is_empty());
895 assert!(updates_2.update_fee.is_none());
896 assert_eq!(updates_2.update_fulfill_htlcs.len(), 1);
897 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fulfill_htlcs[0]);
898 commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
900 let events = nodes[0].node.get_and_clear_pending_events();
901 assert_eq!(events.len(), 1);
903 Event::PaymentSent { ref payment_preimage } => {
904 assert_eq!(our_payment_preimage, *payment_preimage);
906 _ => panic!("Unexpected event"),
909 let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
910 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
911 let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
912 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
913 let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
914 assert!(node_0_none.is_none());
916 assert!(nodes[0].node.list_channels().is_empty());
918 assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
919 nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
920 close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
921 assert!(nodes[1].node.list_channels().is_empty());
922 assert!(nodes[2].node.list_channels().is_empty());
926 fn htlc_fail_async_shutdown() {
927 // Test HTLCs fail if shutdown starts even if messages are delivered out-of-order
928 let chanmon_cfgs = create_chanmon_cfgs(3);
929 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
930 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
931 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
932 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
933 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
934 let logger = test_utils::TestLogger::new();
936 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[2]);
937 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
938 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[2].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
939 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
940 check_added_monitors!(nodes[0], 1);
941 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
942 assert_eq!(updates.update_add_htlcs.len(), 1);
943 assert!(updates.update_fulfill_htlcs.is_empty());
944 assert!(updates.update_fail_htlcs.is_empty());
945 assert!(updates.update_fail_malformed_htlcs.is_empty());
946 assert!(updates.update_fee.is_none());
948 nodes[1].node.close_channel(&chan_1.2).unwrap();
949 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
950 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_shutdown);
951 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
953 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
954 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &updates.commitment_signed);
955 check_added_monitors!(nodes[1], 1);
956 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
957 commitment_signed_dance!(nodes[1], nodes[0], (), false, true, false);
959 let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
960 assert!(updates_2.update_add_htlcs.is_empty());
961 assert!(updates_2.update_fulfill_htlcs.is_empty());
962 assert_eq!(updates_2.update_fail_htlcs.len(), 1);
963 assert!(updates_2.update_fail_malformed_htlcs.is_empty());
964 assert!(updates_2.update_fee.is_none());
966 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fail_htlcs[0]);
967 commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
969 expect_payment_failed!(nodes[0], our_payment_hash, false);
971 let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
972 assert_eq!(msg_events.len(), 2);
973 let node_0_closing_signed = match msg_events[0] {
974 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
975 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
978 _ => panic!("Unexpected event"),
980 match msg_events[1] {
981 MessageSendEvent::PaymentFailureNetworkUpdate { update: msgs::HTLCFailChannelUpdate::ChannelUpdateMessage { ref msg }} => {
982 assert_eq!(msg.contents.short_channel_id, chan_1.0.contents.short_channel_id);
984 _ => panic!("Unexpected event"),
987 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
988 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
989 let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
990 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
991 let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
992 assert!(node_0_none.is_none());
994 assert!(nodes[0].node.list_channels().is_empty());
996 assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
997 nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
998 close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
999 assert!(nodes[1].node.list_channels().is_empty());
1000 assert!(nodes[2].node.list_channels().is_empty());
1003 fn do_test_shutdown_rebroadcast(recv_count: u8) {
1004 // Test that shutdown/closing_signed is re-sent on reconnect with a variable number of
1005 // messages delivered prior to disconnect
1006 let chanmon_cfgs = create_chanmon_cfgs(3);
1007 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1008 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1009 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1010 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
1011 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
1013 let (our_payment_preimage, _, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100000);
1015 nodes[1].node.close_channel(&chan_1.2).unwrap();
1016 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
1018 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_shutdown);
1019 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
1021 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
1025 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
1026 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
1028 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1029 let node_0_reestablish = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
1030 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1031 let node_1_reestablish = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
1033 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_reestablish);
1034 let node_1_2nd_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
1035 assert!(node_1_shutdown == node_1_2nd_shutdown);
1037 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &node_1_reestablish);
1038 let node_0_2nd_shutdown = if recv_count > 0 {
1039 let node_0_2nd_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
1040 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_2nd_shutdown);
1043 let node_0_chan_update = get_event_msg!(nodes[0], MessageSendEvent::SendChannelUpdate, nodes[1].node.get_our_node_id());
1044 assert_eq!(node_0_chan_update.contents.flags & 2, 0); // "disabled" flag must not be set as we just reconnected.
1045 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_2nd_shutdown);
1046 get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id())
1048 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_2nd_shutdown);
1050 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1051 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1053 assert!(nodes[2].node.claim_funds(our_payment_preimage));
1054 check_added_monitors!(nodes[2], 1);
1055 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1056 assert!(updates.update_add_htlcs.is_empty());
1057 assert!(updates.update_fail_htlcs.is_empty());
1058 assert!(updates.update_fail_malformed_htlcs.is_empty());
1059 assert!(updates.update_fee.is_none());
1060 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
1061 nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
1062 check_added_monitors!(nodes[1], 1);
1063 let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1064 commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
1066 assert!(updates_2.update_add_htlcs.is_empty());
1067 assert!(updates_2.update_fail_htlcs.is_empty());
1068 assert!(updates_2.update_fail_malformed_htlcs.is_empty());
1069 assert!(updates_2.update_fee.is_none());
1070 assert_eq!(updates_2.update_fulfill_htlcs.len(), 1);
1071 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fulfill_htlcs[0]);
1072 commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
1074 let events = nodes[0].node.get_and_clear_pending_events();
1075 assert_eq!(events.len(), 1);
1077 Event::PaymentSent { ref payment_preimage } => {
1078 assert_eq!(our_payment_preimage, *payment_preimage);
1080 _ => panic!("Unexpected event"),
1083 let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
1085 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
1086 let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
1087 assert!(node_1_closing_signed.is_some());
1090 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
1091 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
1093 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1094 let node_0_2nd_reestablish = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
1095 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1096 if recv_count == 0 {
1097 // If all closing_signeds weren't delivered we can just resume where we left off...
1098 let node_1_2nd_reestablish = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
1100 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &node_1_2nd_reestablish);
1101 let node_0_3rd_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
1102 assert!(node_0_2nd_shutdown == node_0_3rd_shutdown);
1104 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_2nd_reestablish);
1105 let node_1_3rd_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
1106 assert!(node_1_3rd_shutdown == node_1_2nd_shutdown);
1108 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_3rd_shutdown);
1109 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1111 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_3rd_shutdown);
1112 let node_0_2nd_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
1113 assert!(node_0_closing_signed == node_0_2nd_closing_signed);
1115 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed);
1116 let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
1117 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
1118 let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
1119 assert!(node_0_none.is_none());
1121 // If one node, however, received + responded with an identical closing_signed we end
1122 // up erroring and node[0] will try to broadcast its own latest commitment transaction.
1123 // There isn't really anything better we can do simply, but in the future we might
1124 // explore storing a set of recently-closed channels that got disconnected during
1125 // closing_signed and avoiding broadcasting local commitment txn for some timeout to
1126 // give our counterparty enough time to (potentially) broadcast a cooperative closing
1128 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1130 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_2nd_reestablish);
1131 let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
1132 assert_eq!(msg_events.len(), 1);
1133 if let MessageSendEvent::HandleError { ref action, .. } = msg_events[0] {
1135 &ErrorAction::SendErrorMessage { ref msg } => {
1136 nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msg);
1137 assert_eq!(msg.channel_id, chan_1.2);
1139 _ => panic!("Unexpected event!"),
1141 } else { panic!("Needed SendErrorMessage close"); }
1143 // get_closing_signed_broadcast usually eats the BroadcastChannelUpdate for us and
1144 // checks it, but in this case nodes[0] didn't ever get a chance to receive a
1145 // closing_signed so we do it ourselves
1146 check_closed_broadcast!(nodes[0], false);
1147 check_added_monitors!(nodes[0], 1);
1150 assert!(nodes[0].node.list_channels().is_empty());
1152 assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
1153 nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
1154 close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
1155 assert!(nodes[1].node.list_channels().is_empty());
1156 assert!(nodes[2].node.list_channels().is_empty());
1160 fn test_shutdown_rebroadcast() {
1161 do_test_shutdown_rebroadcast(0);
1162 do_test_shutdown_rebroadcast(1);
1163 do_test_shutdown_rebroadcast(2);
1167 fn fake_network_test() {
1168 // Simple test which builds a network of ChannelManagers, connects them to each other, and
1169 // tests that payments get routed and transactions broadcast in semi-reasonable ways.
1170 let chanmon_cfgs = create_chanmon_cfgs(4);
1171 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
1172 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
1173 let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
1175 // Create some initial channels
1176 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
1177 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
1178 let chan_3 = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
1180 // Rebalance the network a bit by relaying one payment through all the channels...
1181 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000);
1182 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000);
1183 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000);
1184 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000);
1186 // Send some more payments
1187 send_payment(&nodes[1], &vec!(&nodes[2], &nodes[3])[..], 1000000);
1188 send_payment(&nodes[3], &vec!(&nodes[2], &nodes[1], &nodes[0])[..], 1000000);
1189 send_payment(&nodes[3], &vec!(&nodes[2], &nodes[1])[..], 1000000);
1191 // Test failure packets
1192 let payment_hash_1 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 1000000).1;
1193 fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], payment_hash_1);
1195 // Add a new channel that skips 3
1196 let chan_4 = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known());
1198 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 1000000);
1199 send_payment(&nodes[2], &vec!(&nodes[3])[..], 1000000);
1200 send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
1201 send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
1202 send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
1203 send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
1204 send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
1206 // Do some rebalance loop payments, simultaneously
1207 let mut hops = Vec::with_capacity(3);
1208 hops.push(RouteHop {
1209 pubkey: nodes[2].node.get_our_node_id(),
1210 node_features: NodeFeatures::empty(),
1211 short_channel_id: chan_2.0.contents.short_channel_id,
1212 channel_features: ChannelFeatures::empty(),
1214 cltv_expiry_delta: chan_3.0.contents.cltv_expiry_delta as u32
1216 hops.push(RouteHop {
1217 pubkey: nodes[3].node.get_our_node_id(),
1218 node_features: NodeFeatures::empty(),
1219 short_channel_id: chan_3.0.contents.short_channel_id,
1220 channel_features: ChannelFeatures::empty(),
1222 cltv_expiry_delta: chan_4.1.contents.cltv_expiry_delta as u32
1224 hops.push(RouteHop {
1225 pubkey: nodes[1].node.get_our_node_id(),
1226 node_features: NodeFeatures::known(),
1227 short_channel_id: chan_4.0.contents.short_channel_id,
1228 channel_features: ChannelFeatures::known(),
1230 cltv_expiry_delta: TEST_FINAL_CLTV,
1232 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;
1233 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;
1234 let payment_preimage_1 = send_along_route(&nodes[1], Route { paths: vec![hops] }, &vec!(&nodes[2], &nodes[3], &nodes[1])[..], 1000000).0;
1236 let mut hops = Vec::with_capacity(3);
1237 hops.push(RouteHop {
1238 pubkey: nodes[3].node.get_our_node_id(),
1239 node_features: NodeFeatures::empty(),
1240 short_channel_id: chan_4.0.contents.short_channel_id,
1241 channel_features: ChannelFeatures::empty(),
1243 cltv_expiry_delta: chan_3.1.contents.cltv_expiry_delta as u32
1245 hops.push(RouteHop {
1246 pubkey: nodes[2].node.get_our_node_id(),
1247 node_features: NodeFeatures::empty(),
1248 short_channel_id: chan_3.0.contents.short_channel_id,
1249 channel_features: ChannelFeatures::empty(),
1251 cltv_expiry_delta: chan_2.1.contents.cltv_expiry_delta as u32
1253 hops.push(RouteHop {
1254 pubkey: nodes[1].node.get_our_node_id(),
1255 node_features: NodeFeatures::known(),
1256 short_channel_id: chan_2.0.contents.short_channel_id,
1257 channel_features: ChannelFeatures::known(),
1259 cltv_expiry_delta: TEST_FINAL_CLTV,
1261 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;
1262 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;
1263 let payment_hash_2 = send_along_route(&nodes[1], Route { paths: vec![hops] }, &vec!(&nodes[3], &nodes[2], &nodes[1])[..], 1000000).1;
1265 // Claim the rebalances...
1266 fail_payment(&nodes[1], &vec!(&nodes[3], &nodes[2], &nodes[1])[..], payment_hash_2);
1267 claim_payment(&nodes[1], &vec!(&nodes[2], &nodes[3], &nodes[1])[..], payment_preimage_1);
1269 // Add a duplicate new channel from 2 to 4
1270 let chan_5 = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known());
1272 // Send some payments across both channels
1273 let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
1274 let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
1275 let payment_preimage_5 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
1278 route_over_limit(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000);
1279 let events = nodes[0].node.get_and_clear_pending_msg_events();
1280 assert_eq!(events.len(), 0);
1281 nodes[0].logger.assert_log_regex("lightning::ln::channelmanager".to_string(), regex::Regex::new(r"Cannot send value that would put us over the max HTLC value in flight our peer will accept \(\d+\)").unwrap(), 1);
1283 //TODO: Test that routes work again here as we've been notified that the channel is full
1285 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_3);
1286 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_4);
1287 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_5);
1289 // Close down the channels...
1290 close_channel(&nodes[0], &nodes[1], &chan_1.2, chan_1.3, true);
1291 close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, false);
1292 close_channel(&nodes[2], &nodes[3], &chan_3.2, chan_3.3, true);
1293 close_channel(&nodes[1], &nodes[3], &chan_4.2, chan_4.3, false);
1294 close_channel(&nodes[1], &nodes[3], &chan_5.2, chan_5.3, false);
1298 fn holding_cell_htlc_counting() {
1299 // Tests that HTLCs in the holding cell count towards the pending HTLC limits on outbound HTLCs
1300 // to ensure we don't end up with HTLCs sitting around in our holding cell for several
1301 // commitment dance rounds.
1302 let chanmon_cfgs = create_chanmon_cfgs(3);
1303 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1304 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1305 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1306 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
1307 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
1308 let logger = test_utils::TestLogger::new();
1310 let mut payments = Vec::new();
1311 for _ in 0..::ln::channel::OUR_MAX_HTLCS {
1312 let (payment_preimage, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[2]);
1313 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
1314 let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[2].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
1315 nodes[1].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
1316 payments.push((payment_preimage, payment_hash));
1318 check_added_monitors!(nodes[1], 1);
1320 let mut events = nodes[1].node.get_and_clear_pending_msg_events();
1321 assert_eq!(events.len(), 1);
1322 let initial_payment_event = SendEvent::from_event(events.pop().unwrap());
1323 assert_eq!(initial_payment_event.node_id, nodes[2].node.get_our_node_id());
1325 // There is now one HTLC in an outbound commitment transaction and (OUR_MAX_HTLCS - 1) HTLCs in
1326 // the holding cell waiting on B's RAA to send. At this point we should not be able to add
1328 let (_, payment_hash_1, payment_secret_1) = get_payment_preimage_hash!(nodes[2]);
1330 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
1331 let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[2].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
1332 unwrap_send_err!(nodes[1].node.send_payment(&route, payment_hash_1, &Some(payment_secret_1)), true, APIError::ChannelUnavailable { ref err },
1333 assert!(regex::Regex::new(r"Cannot push more than their max accepted HTLCs \(\d+\)").unwrap().is_match(err)));
1334 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1335 nodes[1].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot push more than their max accepted HTLCs".to_string(), 1);
1338 // This should also be true if we try to forward a payment.
1339 let (_, payment_hash_2, payment_secret_2) = get_payment_preimage_hash!(nodes[2]);
1341 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
1342 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[2].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
1343 nodes[0].node.send_payment(&route, payment_hash_2, &Some(payment_secret_2)).unwrap();
1344 check_added_monitors!(nodes[0], 1);
1347 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1348 assert_eq!(events.len(), 1);
1349 let payment_event = SendEvent::from_event(events.pop().unwrap());
1350 assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
1352 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1353 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
1354 // We have to forward pending HTLCs twice - once tries to forward the payment forward (and
1355 // fails), the second will process the resulting failure and fail the HTLC backward.
1356 expect_pending_htlcs_forwardable!(nodes[1]);
1357 expect_pending_htlcs_forwardable!(nodes[1]);
1358 check_added_monitors!(nodes[1], 1);
1360 let bs_fail_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1361 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &bs_fail_updates.update_fail_htlcs[0]);
1362 commitment_signed_dance!(nodes[0], nodes[1], bs_fail_updates.commitment_signed, false, true);
1364 expect_payment_failure_chan_update!(nodes[0], chan_2.0.contents.short_channel_id, false);
1365 expect_payment_failed!(nodes[0], payment_hash_2, false);
1367 // Now forward all the pending HTLCs and claim them back
1368 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &initial_payment_event.msgs[0]);
1369 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &initial_payment_event.commitment_msg);
1370 check_added_monitors!(nodes[2], 1);
1372 let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1373 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_revoke_and_ack);
1374 check_added_monitors!(nodes[1], 1);
1375 let as_updates = get_htlc_update_msgs!(nodes[1], nodes[2].node.get_our_node_id());
1377 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &bs_commitment_signed);
1378 check_added_monitors!(nodes[1], 1);
1379 let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
1381 for ref update in as_updates.update_add_htlcs.iter() {
1382 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), update);
1384 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &as_updates.commitment_signed);
1385 check_added_monitors!(nodes[2], 1);
1386 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
1387 check_added_monitors!(nodes[2], 1);
1388 let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1390 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_revoke_and_ack);
1391 check_added_monitors!(nodes[1], 1);
1392 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &bs_commitment_signed);
1393 check_added_monitors!(nodes[1], 1);
1394 let as_final_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
1396 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_final_raa);
1397 check_added_monitors!(nodes[2], 1);
1399 expect_pending_htlcs_forwardable!(nodes[2]);
1401 let events = nodes[2].node.get_and_clear_pending_events();
1402 assert_eq!(events.len(), payments.len());
1403 for (event, &(_, ref hash)) in events.iter().zip(payments.iter()) {
1405 &Event::PaymentReceived { ref payment_hash, .. } => {
1406 assert_eq!(*payment_hash, *hash);
1408 _ => panic!("Unexpected event"),
1412 for (preimage, _) in payments.drain(..) {
1413 claim_payment(&nodes[1], &[&nodes[2]], preimage);
1416 send_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1000000);
1420 fn duplicate_htlc_test() {
1421 // Test that we accept duplicate payment_hash HTLCs across the network and that
1422 // claiming/failing them are all separate and don't affect each other
1423 let chanmon_cfgs = create_chanmon_cfgs(6);
1424 let node_cfgs = create_node_cfgs(6, &chanmon_cfgs);
1425 let node_chanmgrs = create_node_chanmgrs(6, &node_cfgs, &[None, None, None, None, None, None]);
1426 let mut nodes = create_network(6, &node_cfgs, &node_chanmgrs);
1428 // Create some initial channels to route via 3 to 4/5 from 0/1/2
1429 create_announced_chan_between_nodes(&nodes, 0, 3, InitFeatures::known(), InitFeatures::known());
1430 create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known());
1431 create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
1432 create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::known(), InitFeatures::known());
1433 create_announced_chan_between_nodes(&nodes, 3, 5, InitFeatures::known(), InitFeatures::known());
1435 let (payment_preimage, payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[3], &nodes[4])[..], 1000000);
1437 *nodes[0].network_payment_count.borrow_mut() -= 1;
1438 assert_eq!(route_payment(&nodes[1], &vec!(&nodes[3])[..], 1000000).0, payment_preimage);
1440 *nodes[0].network_payment_count.borrow_mut() -= 1;
1441 assert_eq!(route_payment(&nodes[2], &vec!(&nodes[3], &nodes[5])[..], 1000000).0, payment_preimage);
1443 claim_payment(&nodes[0], &vec!(&nodes[3], &nodes[4])[..], payment_preimage);
1444 fail_payment(&nodes[2], &vec!(&nodes[3], &nodes[5])[..], payment_hash);
1445 claim_payment(&nodes[1], &vec!(&nodes[3])[..], payment_preimage);
1449 fn test_duplicate_htlc_different_direction_onchain() {
1450 // Test that ChannelMonitor doesn't generate 2 preimage txn
1451 // when we have 2 HTLCs with same preimage that go across a node
1452 // in opposite directions, even with the same payment secret.
1453 let chanmon_cfgs = create_chanmon_cfgs(2);
1454 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1455 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1456 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1458 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
1459 let logger = test_utils::TestLogger::new();
1462 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
1464 let (payment_preimage, payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 900_000);
1466 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
1467 let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[0].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 800_000, TEST_FINAL_CLTV, &logger).unwrap();
1468 let node_a_payment_secret = nodes[0].node.create_inbound_payment_for_hash(payment_hash, None, 7200, 0).unwrap();
1469 send_along_route_with_secret(&nodes[1], route, &[&[&nodes[0]]], 800_000, payment_hash, node_a_payment_secret);
1471 // Provide preimage to node 0 by claiming payment
1472 nodes[0].node.claim_funds(payment_preimage);
1473 check_added_monitors!(nodes[0], 1);
1475 // Broadcast node 1 commitment txn
1476 let remote_txn = get_local_commitment_txn!(nodes[1], chan_1.2);
1478 assert_eq!(remote_txn[0].output.len(), 4); // 1 local, 1 remote, 1 htlc inbound, 1 htlc outbound
1479 let mut has_both_htlcs = 0; // check htlcs match ones committed
1480 for outp in remote_txn[0].output.iter() {
1481 if outp.value == 800_000 / 1000 {
1482 has_both_htlcs += 1;
1483 } else if outp.value == 900_000 / 1000 {
1484 has_both_htlcs += 1;
1487 assert_eq!(has_both_htlcs, 2);
1489 mine_transaction(&nodes[0], &remote_txn[0]);
1490 check_added_monitors!(nodes[0], 1);
1491 connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
1493 // Check we only broadcast 1 timeout tx
1494 let claim_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
1495 assert_eq!(claim_txn.len(), 8);
1496 assert_eq!(claim_txn[1], claim_txn[4]);
1497 assert_eq!(claim_txn[2], claim_txn[5]);
1498 check_spends!(claim_txn[1], chan_1.3);
1499 check_spends!(claim_txn[2], claim_txn[1]);
1500 check_spends!(claim_txn[7], claim_txn[1]);
1502 assert_eq!(claim_txn[0].input.len(), 1);
1503 assert_eq!(claim_txn[3].input.len(), 1);
1504 assert_eq!(claim_txn[0].input[0].previous_output, claim_txn[3].input[0].previous_output);
1506 assert_eq!(claim_txn[0].input.len(), 1);
1507 assert_eq!(claim_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC 1 <--> 0, preimage tx
1508 check_spends!(claim_txn[0], remote_txn[0]);
1509 assert_eq!(remote_txn[0].output[claim_txn[0].input[0].previous_output.vout as usize].value, 800);
1510 assert_eq!(claim_txn[6].input.len(), 1);
1511 assert_eq!(claim_txn[6].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // HTLC 0 <--> 1, timeout tx
1512 check_spends!(claim_txn[6], remote_txn[0]);
1513 assert_eq!(remote_txn[0].output[claim_txn[6].input[0].previous_output.vout as usize].value, 900);
1515 let events = nodes[0].node.get_and_clear_pending_msg_events();
1516 assert_eq!(events.len(), 3);
1519 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
1520 MessageSendEvent::HandleError { node_id, action: msgs::ErrorAction::SendErrorMessage { ref msg } } => {
1521 assert_eq!(node_id, nodes[1].node.get_our_node_id());
1522 assert_eq!(msg.data, "Commitment or closing transaction was confirmed on chain.");
1524 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, .. } } => {
1525 assert!(update_add_htlcs.is_empty());
1526 assert!(update_fail_htlcs.is_empty());
1527 assert_eq!(update_fulfill_htlcs.len(), 1);
1528 assert!(update_fail_malformed_htlcs.is_empty());
1529 assert_eq!(nodes[1].node.get_our_node_id(), *node_id);
1531 _ => panic!("Unexpected event"),
1537 fn test_basic_channel_reserve() {
1538 let chanmon_cfgs = create_chanmon_cfgs(2);
1539 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1540 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1541 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1542 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1543 let logger = test_utils::TestLogger::new();
1545 let chan_stat = get_channel_value_stat!(nodes[0], chan.2);
1546 let channel_reserve = chan_stat.channel_reserve_msat;
1548 // The 2* and +1 are for the fee spike reserve.
1549 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
1550 let commit_tx_fee = 2 * commit_tx_fee_msat(get_feerate!(nodes[0], chan.2), 1 + 1);
1551 let max_can_send = 5000000 - channel_reserve - commit_tx_fee;
1552 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
1553 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes.last().unwrap().node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), max_can_send + 1, TEST_FINAL_CLTV, &logger).unwrap();
1554 let err = nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).err().unwrap();
1556 PaymentSendFailure::AllFailedRetrySafe(ref fails) => {
1558 &APIError::ChannelUnavailable{ref err} =>
1559 assert!(regex::Regex::new(r"Cannot send value that would put our balance under counterparty-announced channel reserve value \(\d+\)").unwrap().is_match(err)),
1560 _ => panic!("Unexpected error variant"),
1563 _ => panic!("Unexpected error variant"),
1565 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1566 nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot send value that would put our balance under counterparty-announced channel reserve value".to_string(), 1);
1568 send_payment(&nodes[0], &vec![&nodes[1]], max_can_send);
1572 fn test_fee_spike_violation_fails_htlc() {
1573 let chanmon_cfgs = create_chanmon_cfgs(2);
1574 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1575 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1576 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1577 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1579 let (route, payment_hash, _, payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], 3460001);
1580 // Need to manually create the update_add_htlc message to go around the channel reserve check in send_htlc()
1581 let secp_ctx = Secp256k1::new();
1582 let session_priv = SecretKey::from_slice(&[42; 32]).expect("RNG is bad!");
1584 let cur_height = nodes[1].node.best_block.read().unwrap().height() + 1;
1586 let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route.paths[0], &session_priv).unwrap();
1587 let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 3460001, &Some(payment_secret), cur_height).unwrap();
1588 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
1589 let msg = msgs::UpdateAddHTLC {
1592 amount_msat: htlc_msat,
1593 payment_hash: payment_hash,
1594 cltv_expiry: htlc_cltv,
1595 onion_routing_packet: onion_packet,
1598 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
1600 // Now manually create the commitment_signed message corresponding to the update_add
1601 // nodes[0] just sent. In the code for construction of this message, "local" refers
1602 // to the sender of the message, and "remote" refers to the receiver.
1604 let feerate_per_kw = get_feerate!(nodes[0], chan.2);
1606 const INITIAL_COMMITMENT_NUMBER: u64 = (1 << 48) - 1;
1608 // Get the EnforcingSigner for each channel, which will be used to (1) get the keys
1609 // needed to sign the new commitment tx and (2) sign the new commitment tx.
1610 let (local_revocation_basepoint, local_htlc_basepoint, local_secret, next_local_point) = {
1611 let chan_lock = nodes[0].node.channel_state.lock().unwrap();
1612 let local_chan = chan_lock.by_id.get(&chan.2).unwrap();
1613 let chan_signer = local_chan.get_signer();
1614 let pubkeys = chan_signer.pubkeys();
1615 (pubkeys.revocation_basepoint, pubkeys.htlc_basepoint,
1616 chan_signer.release_commitment_secret(INITIAL_COMMITMENT_NUMBER),
1617 chan_signer.get_per_commitment_point(INITIAL_COMMITMENT_NUMBER - 2, &secp_ctx))
1619 let (remote_delayed_payment_basepoint, remote_htlc_basepoint,remote_point) = {
1620 let chan_lock = nodes[1].node.channel_state.lock().unwrap();
1621 let remote_chan = chan_lock.by_id.get(&chan.2).unwrap();
1622 let chan_signer = remote_chan.get_signer();
1623 let pubkeys = chan_signer.pubkeys();
1624 (pubkeys.delayed_payment_basepoint, pubkeys.htlc_basepoint,
1625 chan_signer.get_per_commitment_point(INITIAL_COMMITMENT_NUMBER - 1, &secp_ctx))
1628 // Assemble the set of keys we can use for signatures for our commitment_signed message.
1629 let commit_tx_keys = chan_utils::TxCreationKeys::derive_new(&secp_ctx, &remote_point, &remote_delayed_payment_basepoint,
1630 &remote_htlc_basepoint, &local_revocation_basepoint, &local_htlc_basepoint).unwrap();
1632 // Build the remote commitment transaction so we can sign it, and then later use the
1633 // signature for the commitment_signed message.
1634 let local_chan_balance = 1313;
1636 let accepted_htlc_info = chan_utils::HTLCOutputInCommitment {
1638 amount_msat: 3460001,
1639 cltv_expiry: htlc_cltv,
1641 transaction_output_index: Some(1),
1644 let commitment_number = INITIAL_COMMITMENT_NUMBER - 1;
1647 let local_chan_lock = nodes[0].node.channel_state.lock().unwrap();
1648 let local_chan = local_chan_lock.by_id.get(&chan.2).unwrap();
1649 let local_chan_signer = local_chan.get_signer();
1650 let commitment_tx = CommitmentTransaction::new_with_auxiliary_htlc_data(
1654 commit_tx_keys.clone(),
1656 &mut vec![(accepted_htlc_info, ())],
1657 &local_chan.channel_transaction_parameters.as_counterparty_broadcastable()
1659 local_chan_signer.sign_counterparty_commitment(&commitment_tx, &secp_ctx).unwrap()
1662 let commit_signed_msg = msgs::CommitmentSigned {
1665 htlc_signatures: res.1
1668 // Send the commitment_signed message to the nodes[1].
1669 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commit_signed_msg);
1670 let _ = nodes[1].node.get_and_clear_pending_msg_events();
1672 // Send the RAA to nodes[1].
1673 let raa_msg = msgs::RevokeAndACK {
1675 per_commitment_secret: local_secret,
1676 next_per_commitment_point: next_local_point
1678 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &raa_msg);
1680 let events = nodes[1].node.get_and_clear_pending_msg_events();
1681 assert_eq!(events.len(), 1);
1682 // Make sure the HTLC failed in the way we expect.
1684 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fail_htlcs, .. }, .. } => {
1685 assert_eq!(update_fail_htlcs.len(), 1);
1686 update_fail_htlcs[0].clone()
1688 _ => panic!("Unexpected event"),
1690 nodes[1].logger.assert_log("lightning::ln::channel".to_string(),
1691 format!("Attempting to fail HTLC due to fee spike buffer violation in channel {}. Rebalancing is required.", ::hex::encode(raa_msg.channel_id)), 1);
1693 check_added_monitors!(nodes[1], 2);
1697 fn test_chan_reserve_violation_outbound_htlc_inbound_chan() {
1698 let mut chanmon_cfgs = create_chanmon_cfgs(2);
1699 // Set the fee rate for the channel very high, to the point where the fundee
1700 // sending any above-dust amount would result in a channel reserve violation.
1701 // In this test we check that we would be prevented from sending an HTLC in
1703 chanmon_cfgs[0].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(6000) };
1704 chanmon_cfgs[1].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(6000) };
1705 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1706 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1707 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1708 let _ = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1710 let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[1], nodes[0], 4843000);
1711 unwrap_send_err!(nodes[1].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
1712 assert_eq!(err, "Cannot send value that would put counterparty balance under holder-announced channel reserve value"));
1713 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1714 nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Cannot send value that would put counterparty balance under holder-announced channel reserve value".to_string(), 1);
1718 fn test_chan_reserve_violation_inbound_htlc_outbound_channel() {
1719 let mut chanmon_cfgs = create_chanmon_cfgs(2);
1720 // Set the fee rate for the channel very high, to the point where the funder
1721 // receiving 1 update_add_htlc would result in them closing the channel due
1722 // to channel reserve violation. This close could also happen if the fee went
1723 // up a more realistic amount, but many HTLCs were outstanding at the time of
1724 // the update_add_htlc.
1725 chanmon_cfgs[0].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(6000) };
1726 chanmon_cfgs[1].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(6000) };
1727 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1728 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1729 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1730 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1732 let (route, payment_hash, _, payment_secret) = get_route_and_payment_hash!(nodes[1], nodes[0], 1000);
1733 // Need to manually create the update_add_htlc message to go around the channel reserve check in send_htlc()
1734 let secp_ctx = Secp256k1::new();
1735 let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
1736 let cur_height = nodes[1].node.best_block.read().unwrap().height() + 1;
1737 let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route.paths[0], &session_priv).unwrap();
1738 let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 1000, &Some(payment_secret), cur_height).unwrap();
1739 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
1740 let msg = msgs::UpdateAddHTLC {
1743 amount_msat: htlc_msat + 1,
1744 payment_hash: payment_hash,
1745 cltv_expiry: htlc_cltv,
1746 onion_routing_packet: onion_packet,
1749 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &msg);
1750 // Check that the payment failed and the channel is closed in response to the malicious UpdateAdd.
1751 nodes[0].logger.assert_log("lightning::ln::channelmanager".to_string(), "Cannot accept HTLC that would put our balance under counterparty-announced channel reserve value".to_string(), 1);
1752 assert_eq!(nodes[0].node.list_channels().len(), 0);
1753 let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
1754 assert_eq!(err_msg.data, "Cannot accept HTLC that would put our balance under counterparty-announced channel reserve value");
1755 check_added_monitors!(nodes[0], 1);
1759 fn test_chan_reserve_dust_inbound_htlcs_outbound_chan() {
1760 // Test that if we receive many dust HTLCs over an outbound channel, they don't count when
1761 // calculating our commitment transaction fee (this was previously broken).
1762 let chanmon_cfgs = create_chanmon_cfgs(2);
1763 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1764 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None, None]);
1765 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1767 // Set nodes[0]'s balance such that they will consider any above-dust received HTLC to be a
1768 // channel reserve violation (so their balance is channel reserve (1000 sats) + commitment
1769 // transaction fee with 0 HTLCs (183 sats)).
1770 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 98817000, InitFeatures::known(), InitFeatures::known());
1772 let dust_amt = 329000; // Dust amount
1773 // In the previous code, routing this dust payment would cause nodes[0] to perceive a channel
1774 // reserve violation even though it's a dust HTLC and therefore shouldn't count towards the
1775 // commitment transaction fee.
1776 let (_, _, _) = route_payment(&nodes[1], &[&nodes[0]], dust_amt);
1780 fn test_chan_reserve_dust_inbound_htlcs_inbound_chan() {
1781 // Test that if we receive many dust HTLCs over an inbound channel, they don't count when
1782 // calculating our counterparty's commitment transaction fee (this was previously broken).
1783 let chanmon_cfgs = create_chanmon_cfgs(2);
1784 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1785 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None, None]);
1786 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1787 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 98000000, InitFeatures::known(), InitFeatures::known());
1789 let payment_amt = 46000; // Dust amount
1790 // In the previous code, these first four payments would succeed.
1791 let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1792 let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1793 let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1794 let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1796 // Then these next 5 would be interpreted by nodes[1] as violating the fee spike buffer.
1797 let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1798 let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1799 let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1800 let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1801 let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1803 // And this last payment previously resulted in nodes[1] closing on its inbound-channel
1804 // counterparty, because it counted all the previous dust HTLCs against nodes[0]'s commitment
1805 // transaction fee and therefore perceived this next payment as a channel reserve violation.
1806 let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1810 fn test_chan_reserve_violation_inbound_htlc_inbound_chan() {
1811 let chanmon_cfgs = create_chanmon_cfgs(3);
1812 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1813 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1814 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1815 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1816 let _ = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1819 let total_routing_fee_msat = (nodes.len() - 2) as u64 * feemsat;
1820 let chan_stat = get_channel_value_stat!(nodes[0], chan.2);
1821 let feerate = get_feerate!(nodes[0], chan.2);
1823 // Add a 2* and +1 for the fee spike reserve.
1824 let commit_tx_fee_2_htlc = 2*commit_tx_fee_msat(feerate, 2 + 1);
1825 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;
1826 let amt_msat_1 = recv_value_1 + total_routing_fee_msat;
1828 // Add a pending HTLC.
1829 let (route_1, our_payment_hash_1, _, our_payment_secret_1) = get_route_and_payment_hash!(nodes[0], nodes[2], amt_msat_1);
1830 let payment_event_1 = {
1831 nodes[0].node.send_payment(&route_1, our_payment_hash_1, &Some(our_payment_secret_1)).unwrap();
1832 check_added_monitors!(nodes[0], 1);
1834 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1835 assert_eq!(events.len(), 1);
1836 SendEvent::from_event(events.remove(0))
1838 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event_1.msgs[0]);
1840 // Attempt to trigger a channel reserve violation --> payment failure.
1841 let commit_tx_fee_2_htlcs = commit_tx_fee_msat(feerate, 2);
1842 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;
1843 let amt_msat_2 = recv_value_2 + total_routing_fee_msat;
1844 let (route_2, _, _, _) = get_route_and_payment_hash!(nodes[0], nodes[2], amt_msat_2);
1846 // Need to manually create the update_add_htlc message to go around the channel reserve check in send_htlc()
1847 let secp_ctx = Secp256k1::new();
1848 let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
1849 let cur_height = nodes[0].node.best_block.read().unwrap().height() + 1;
1850 let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route_2.paths[0], &session_priv).unwrap();
1851 let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route_2.paths[0], recv_value_2, &None, cur_height).unwrap();
1852 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &our_payment_hash_1);
1853 let msg = msgs::UpdateAddHTLC {
1856 amount_msat: htlc_msat + 1,
1857 payment_hash: our_payment_hash_1,
1858 cltv_expiry: htlc_cltv,
1859 onion_routing_packet: onion_packet,
1862 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
1863 // Check that the payment failed and the channel is closed in response to the malicious UpdateAdd.
1864 nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Remote HTLC add would put them under remote reserve value".to_string(), 1);
1865 assert_eq!(nodes[1].node.list_channels().len(), 1);
1866 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
1867 assert_eq!(err_msg.data, "Remote HTLC add would put them under remote reserve value");
1868 check_added_monitors!(nodes[1], 1);
1872 fn test_inbound_outbound_capacity_is_not_zero() {
1873 let chanmon_cfgs = create_chanmon_cfgs(2);
1874 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1875 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1876 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1877 let _ = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1878 let channels0 = node_chanmgrs[0].list_channels();
1879 let channels1 = node_chanmgrs[1].list_channels();
1880 assert_eq!(channels0.len(), 1);
1881 assert_eq!(channels1.len(), 1);
1883 let reserve = Channel::<EnforcingSigner>::get_holder_selected_channel_reserve_satoshis(100000);
1884 assert_eq!(channels0[0].inbound_capacity_msat, 95000000 - reserve*1000);
1885 assert_eq!(channels1[0].outbound_capacity_msat, 95000000 - reserve*1000);
1887 assert_eq!(channels0[0].outbound_capacity_msat, 100000 * 1000 - 95000000 - reserve*1000);
1888 assert_eq!(channels1[0].inbound_capacity_msat, 100000 * 1000 - 95000000 - reserve*1000);
1891 fn commit_tx_fee_msat(feerate: u32, num_htlcs: u64) -> u64 {
1892 (COMMITMENT_TX_BASE_WEIGHT + num_htlcs * COMMITMENT_TX_WEIGHT_PER_HTLC) * feerate as u64 / 1000 * 1000
1896 fn test_channel_reserve_holding_cell_htlcs() {
1897 let chanmon_cfgs = create_chanmon_cfgs(3);
1898 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1899 // When this test was written, the default base fee floated based on the HTLC count.
1900 // It is now fixed, so we simply set the fee to the expected value here.
1901 let mut config = test_default_channel_config();
1902 config.channel_options.forwarding_fee_base_msat = 239;
1903 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[Some(config.clone()), Some(config.clone()), Some(config.clone())]);
1904 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1905 let chan_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 190000, 1001, InitFeatures::known(), InitFeatures::known());
1906 let chan_2 = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 190000, 1001, InitFeatures::known(), InitFeatures::known());
1908 let mut stat01 = get_channel_value_stat!(nodes[0], chan_1.2);
1909 let mut stat11 = get_channel_value_stat!(nodes[1], chan_1.2);
1911 let mut stat12 = get_channel_value_stat!(nodes[1], chan_2.2);
1912 let mut stat22 = get_channel_value_stat!(nodes[2], chan_2.2);
1914 macro_rules! expect_forward {
1916 let mut events = $node.node.get_and_clear_pending_msg_events();
1917 assert_eq!(events.len(), 1);
1918 check_added_monitors!($node, 1);
1919 let payment_event = SendEvent::from_event(events.remove(0));
1924 let feemsat = 239; // set above
1925 let total_fee_msat = (nodes.len() - 2) as u64 * feemsat;
1926 let feerate = get_feerate!(nodes[0], chan_1.2);
1928 let recv_value_0 = stat01.counterparty_max_htlc_value_in_flight_msat - total_fee_msat;
1930 // attempt to send amt_msat > their_max_htlc_value_in_flight_msat
1932 let (mut route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], recv_value_0);
1933 route.paths[0].last_mut().unwrap().fee_msat += 1;
1934 assert!(route.paths[0].iter().rev().skip(1).all(|h| h.fee_msat == feemsat));
1935 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
1936 assert!(regex::Regex::new(r"Cannot send value that would put us over the max HTLC value in flight our peer will accept \(\d+\)").unwrap().is_match(err)));
1937 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1938 nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot send value that would put us over the max HTLC value in flight our peer will accept".to_string(), 1);
1941 // channel reserve is bigger than their_max_htlc_value_in_flight_msat so loop to deplete
1942 // nodes[0]'s wealth
1944 let amt_msat = recv_value_0 + total_fee_msat;
1945 // 3 for the 3 HTLCs that will be sent, 2* and +1 for the fee spike reserve.
1946 // Also, ensure that each payment has enough to be over the dust limit to
1947 // ensure it'll be included in each commit tx fee calculation.
1948 let commit_tx_fee_all_htlcs = 2*commit_tx_fee_msat(feerate, 3 + 1);
1949 let ensure_htlc_amounts_above_dust_buffer = 3 * (stat01.counterparty_dust_limit_msat + 1000);
1950 if stat01.value_to_self_msat < stat01.channel_reserve_msat + commit_tx_fee_all_htlcs + ensure_htlc_amounts_above_dust_buffer + amt_msat {
1953 send_payment(&nodes[0], &vec![&nodes[1], &nodes[2]][..], recv_value_0);
1955 let (stat01_, stat11_, stat12_, stat22_) = (
1956 get_channel_value_stat!(nodes[0], chan_1.2),
1957 get_channel_value_stat!(nodes[1], chan_1.2),
1958 get_channel_value_stat!(nodes[1], chan_2.2),
1959 get_channel_value_stat!(nodes[2], chan_2.2),
1962 assert_eq!(stat01_.value_to_self_msat, stat01.value_to_self_msat - amt_msat);
1963 assert_eq!(stat11_.value_to_self_msat, stat11.value_to_self_msat + amt_msat);
1964 assert_eq!(stat12_.value_to_self_msat, stat12.value_to_self_msat - (amt_msat - feemsat));
1965 assert_eq!(stat22_.value_to_self_msat, stat22.value_to_self_msat + (amt_msat - feemsat));
1966 stat01 = stat01_; stat11 = stat11_; stat12 = stat12_; stat22 = stat22_;
1969 // adding pending output.
1970 // 2* and +1 HTLCs on the commit tx fee for the fee spike reserve.
1971 // The reason we're dividing by two here is as follows: the dividend is the total outbound liquidity
1972 // after fees, the channel reserve, and the fee spike buffer are removed. We eventually want to
1973 // divide this quantity into 3 portions, that will each be sent in an HTLC. This allows us
1974 // to test channel channel reserve policy at the edges of what amount is sendable, i.e.
1975 // cases where 1 msat over X amount will cause a payment failure, but anything less than
1976 // that can be sent successfully. So, dividing by two is a somewhat arbitrary way of getting
1977 // the amount of the first of these aforementioned 3 payments. The reason we split into 3 payments
1978 // is to test the behavior of the holding cell with respect to channel reserve and commit tx fee
1980 let commit_tx_fee_2_htlcs = 2*commit_tx_fee_msat(feerate, 2 + 1);
1981 let recv_value_1 = (stat01.value_to_self_msat - stat01.channel_reserve_msat - total_fee_msat - commit_tx_fee_2_htlcs)/2;
1982 let amt_msat_1 = recv_value_1 + total_fee_msat;
1984 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);
1985 let payment_event_1 = {
1986 nodes[0].node.send_payment(&route_1, our_payment_hash_1, &Some(our_payment_secret_1)).unwrap();
1987 check_added_monitors!(nodes[0], 1);
1989 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1990 assert_eq!(events.len(), 1);
1991 SendEvent::from_event(events.remove(0))
1993 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event_1.msgs[0]);
1995 // channel reserve test with htlc pending output > 0
1996 let recv_value_2 = stat01.value_to_self_msat - amt_msat_1 - stat01.channel_reserve_msat - total_fee_msat - commit_tx_fee_2_htlcs;
1998 let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], recv_value_2 + 1);
1999 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
2000 assert!(regex::Regex::new(r"Cannot send value that would put our balance under counterparty-announced channel reserve value \(\d+\)").unwrap().is_match(err)));
2001 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
2004 // split the rest to test holding cell
2005 let commit_tx_fee_3_htlcs = 2*commit_tx_fee_msat(feerate, 3 + 1);
2006 let additional_htlc_cost_msat = commit_tx_fee_3_htlcs - commit_tx_fee_2_htlcs;
2007 let recv_value_21 = recv_value_2/2 - additional_htlc_cost_msat/2;
2008 let recv_value_22 = recv_value_2 - recv_value_21 - total_fee_msat - additional_htlc_cost_msat;
2010 let stat = get_channel_value_stat!(nodes[0], chan_1.2);
2011 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);
2014 // now see if they go through on both sides
2015 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);
2016 // but this will stuck in the holding cell
2017 nodes[0].node.send_payment(&route_21, our_payment_hash_21, &Some(our_payment_secret_21)).unwrap();
2018 check_added_monitors!(nodes[0], 0);
2019 let events = nodes[0].node.get_and_clear_pending_events();
2020 assert_eq!(events.len(), 0);
2022 // test with outbound holding cell amount > 0
2024 let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], recv_value_22+1);
2025 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
2026 assert!(regex::Regex::new(r"Cannot send value that would put our balance under counterparty-announced channel reserve value \(\d+\)").unwrap().is_match(err)));
2027 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
2028 nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot send value that would put our balance under counterparty-announced channel reserve value".to_string(), 2);
2031 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);
2032 // this will also stuck in the holding cell
2033 nodes[0].node.send_payment(&route_22, our_payment_hash_22, &Some(our_payment_secret_22)).unwrap();
2034 check_added_monitors!(nodes[0], 0);
2035 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
2036 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
2038 // flush the pending htlc
2039 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event_1.commitment_msg);
2040 let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2041 check_added_monitors!(nodes[1], 1);
2043 // the pending htlc should be promoted to committed
2044 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_revoke_and_ack);
2045 check_added_monitors!(nodes[0], 1);
2046 let commitment_update_2 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2048 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &as_commitment_signed);
2049 let bs_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2050 // No commitment_signed so get_event_msg's assert(len == 1) passes
2051 check_added_monitors!(nodes[0], 1);
2053 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &bs_revoke_and_ack);
2054 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2055 check_added_monitors!(nodes[1], 1);
2057 expect_pending_htlcs_forwardable!(nodes[1]);
2059 let ref payment_event_11 = expect_forward!(nodes[1]);
2060 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_11.msgs[0]);
2061 commitment_signed_dance!(nodes[2], nodes[1], payment_event_11.commitment_msg, false);
2063 expect_pending_htlcs_forwardable!(nodes[2]);
2064 expect_payment_received!(nodes[2], our_payment_hash_1, our_payment_secret_1, recv_value_1);
2066 // flush the htlcs in the holding cell
2067 assert_eq!(commitment_update_2.update_add_htlcs.len(), 2);
2068 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &commitment_update_2.update_add_htlcs[0]);
2069 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &commitment_update_2.update_add_htlcs[1]);
2070 commitment_signed_dance!(nodes[1], nodes[0], &commitment_update_2.commitment_signed, false);
2071 expect_pending_htlcs_forwardable!(nodes[1]);
2073 let ref payment_event_3 = expect_forward!(nodes[1]);
2074 assert_eq!(payment_event_3.msgs.len(), 2);
2075 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_3.msgs[0]);
2076 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_3.msgs[1]);
2078 commitment_signed_dance!(nodes[2], nodes[1], &payment_event_3.commitment_msg, false);
2079 expect_pending_htlcs_forwardable!(nodes[2]);
2081 let events = nodes[2].node.get_and_clear_pending_events();
2082 assert_eq!(events.len(), 2);
2084 Event::PaymentReceived { ref payment_hash, ref payment_preimage, ref payment_secret, amt, user_payment_id: _ } => {
2085 assert_eq!(our_payment_hash_21, *payment_hash);
2086 assert!(payment_preimage.is_none());
2087 assert_eq!(our_payment_secret_21, *payment_secret);
2088 assert_eq!(recv_value_21, amt);
2090 _ => panic!("Unexpected event"),
2093 Event::PaymentReceived { ref payment_hash, ref payment_preimage, ref payment_secret, amt, user_payment_id: _ } => {
2094 assert_eq!(our_payment_hash_22, *payment_hash);
2095 assert!(payment_preimage.is_none());
2096 assert_eq!(our_payment_secret_22, *payment_secret);
2097 assert_eq!(recv_value_22, amt);
2099 _ => panic!("Unexpected event"),
2102 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_1);
2103 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_21);
2104 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_22);
2106 let commit_tx_fee_0_htlcs = 2*commit_tx_fee_msat(feerate, 1);
2107 let recv_value_3 = commit_tx_fee_2_htlcs - commit_tx_fee_0_htlcs - total_fee_msat;
2108 send_payment(&nodes[0], &vec![&nodes[1], &nodes[2]][..], recv_value_3);
2110 let commit_tx_fee_1_htlc = 2*commit_tx_fee_msat(feerate, 1 + 1);
2111 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);
2112 let stat0 = get_channel_value_stat!(nodes[0], chan_1.2);
2113 assert_eq!(stat0.value_to_self_msat, expected_value_to_self);
2114 assert_eq!(stat0.value_to_self_msat, stat0.channel_reserve_msat + commit_tx_fee_1_htlc);
2116 let stat2 = get_channel_value_stat!(nodes[2], chan_2.2);
2117 assert_eq!(stat2.value_to_self_msat, stat22.value_to_self_msat + recv_value_1 + recv_value_21 + recv_value_22 + recv_value_3);
2121 fn channel_reserve_in_flight_removes() {
2122 // In cases where one side claims an HTLC, it thinks it has additional available funds that it
2123 // can send to its counterparty, but due to update ordering, the other side may not yet have
2124 // considered those HTLCs fully removed.
2125 // This tests that we don't count HTLCs which will not be included in the next remote
2126 // commitment transaction towards the reserve value (as it implies no commitment transaction
2127 // will be generated which violates the remote reserve value).
2128 // This was broken previously, and discovered by the chanmon_fail_consistency fuzz test.
2130 // * route two HTLCs from A to B (note that, at a high level, this test is checking that, when
2131 // you consider the values of both of these HTLCs, B may not send an HTLC back to A, but if
2132 // you only consider the value of the first HTLC, it may not),
2133 // * start routing a third HTLC from A to B,
2134 // * claim the first two HTLCs (though B will generate an update_fulfill for one, and put
2135 // the other claim in its holding cell, as it immediately goes into AwaitingRAA),
2136 // * deliver the first fulfill from B
2137 // * deliver the update_add and an RAA from A, resulting in B freeing the second holding cell
2139 // * deliver A's response CS and RAA.
2140 // This results in A having the second HTLC in AwaitingRemovedRemoteRevoke, but B having
2141 // removed it fully. B now has the push_msat plus the first two HTLCs in value.
2142 // * Now B happily sends another HTLC, potentially violating its reserve value from A's point
2143 // of view (if A counts the AwaitingRemovedRemoteRevoke HTLC).
2144 let chanmon_cfgs = create_chanmon_cfgs(2);
2145 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2146 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2147 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2148 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2149 let logger = test_utils::TestLogger::new();
2151 let b_chan_values = get_channel_value_stat!(nodes[1], chan_1.2);
2152 // Route the first two HTLCs.
2153 let (payment_preimage_1, _, _) = route_payment(&nodes[0], &[&nodes[1]], b_chan_values.channel_reserve_msat - b_chan_values.value_to_self_msat - 10000);
2154 let (payment_preimage_2, _, _) = route_payment(&nodes[0], &[&nodes[1]], 20000);
2156 // Start routing the third HTLC (this is just used to get everyone in the right state).
2157 let (payment_preimage_3, payment_hash_3, payment_secret_3) = get_payment_preimage_hash!(nodes[1]);
2159 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
2160 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
2161 nodes[0].node.send_payment(&route, payment_hash_3, &Some(payment_secret_3)).unwrap();
2162 check_added_monitors!(nodes[0], 1);
2163 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
2164 assert_eq!(events.len(), 1);
2165 SendEvent::from_event(events.remove(0))
2168 // Now claim both of the first two HTLCs on B's end, putting B in AwaitingRAA and generating an
2169 // initial fulfill/CS.
2170 assert!(nodes[1].node.claim_funds(payment_preimage_1));
2171 check_added_monitors!(nodes[1], 1);
2172 let bs_removes = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2174 // This claim goes in B's holding cell, allowing us to have a pending B->A RAA which does not
2175 // remove the second HTLC when we send the HTLC back from B to A.
2176 assert!(nodes[1].node.claim_funds(payment_preimage_2));
2177 check_added_monitors!(nodes[1], 1);
2178 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2180 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_removes.update_fulfill_htlcs[0]);
2181 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_removes.commitment_signed);
2182 check_added_monitors!(nodes[0], 1);
2183 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2184 expect_payment_sent!(nodes[0], payment_preimage_1);
2186 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_1.msgs[0]);
2187 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &send_1.commitment_msg);
2188 check_added_monitors!(nodes[1], 1);
2189 // B is already AwaitingRAA, so cant generate a CS here
2190 let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2192 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
2193 check_added_monitors!(nodes[1], 1);
2194 let bs_cs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2196 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2197 check_added_monitors!(nodes[0], 1);
2198 let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2200 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
2201 check_added_monitors!(nodes[1], 1);
2202 let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2204 // The second HTLCis removed, but as A is in AwaitingRAA it can't generate a CS here, so the
2205 // RAA that B generated above doesn't fully resolve the second HTLC from A's point of view.
2206 // However, the RAA A generates here *does* fully resolve the HTLC from B's point of view (as A
2207 // can no longer broadcast a commitment transaction with it and B has the preimage so can go
2208 // on-chain as necessary).
2209 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_cs.update_fulfill_htlcs[0]);
2210 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_cs.commitment_signed);
2211 check_added_monitors!(nodes[0], 1);
2212 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2213 expect_payment_sent!(nodes[0], payment_preimage_2);
2215 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
2216 check_added_monitors!(nodes[1], 1);
2217 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2219 expect_pending_htlcs_forwardable!(nodes[1]);
2220 expect_payment_received!(nodes[1], payment_hash_3, payment_secret_3, 100000);
2222 // Note that as this RAA was generated before the delivery of the update_fulfill it shouldn't
2223 // resolve the second HTLC from A's point of view.
2224 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2225 check_added_monitors!(nodes[0], 1);
2226 let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2228 // Now that B doesn't have the second RAA anymore, but A still does, send a payment from B back
2229 // to A to ensure that A doesn't count the almost-removed HTLC in update_add processing.
2230 let (payment_preimage_4, payment_hash_4, payment_secret_4) = get_payment_preimage_hash!(nodes[0]);
2232 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
2233 let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[0].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 10000, TEST_FINAL_CLTV, &logger).unwrap();
2234 nodes[1].node.send_payment(&route, payment_hash_4, &Some(payment_secret_4)).unwrap();
2235 check_added_monitors!(nodes[1], 1);
2236 let mut events = nodes[1].node.get_and_clear_pending_msg_events();
2237 assert_eq!(events.len(), 1);
2238 SendEvent::from_event(events.remove(0))
2241 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &send_2.msgs[0]);
2242 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &send_2.commitment_msg);
2243 check_added_monitors!(nodes[0], 1);
2244 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2246 // Now just resolve all the outstanding messages/HTLCs for completeness...
2248 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
2249 check_added_monitors!(nodes[1], 1);
2250 let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2252 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
2253 check_added_monitors!(nodes[1], 1);
2255 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2256 check_added_monitors!(nodes[0], 1);
2257 let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2259 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
2260 check_added_monitors!(nodes[1], 1);
2261 let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2263 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2264 check_added_monitors!(nodes[0], 1);
2266 expect_pending_htlcs_forwardable!(nodes[0]);
2267 expect_payment_received!(nodes[0], payment_hash_4, payment_secret_4, 10000);
2269 claim_payment(&nodes[1], &[&nodes[0]], payment_preimage_4);
2270 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_3);
2274 fn channel_monitor_network_test() {
2275 // Simple test which builds a network of ChannelManagers, connects them to each other, and
2276 // tests that ChannelMonitor is able to recover from various states.
2277 let chanmon_cfgs = create_chanmon_cfgs(5);
2278 let node_cfgs = create_node_cfgs(5, &chanmon_cfgs);
2279 let node_chanmgrs = create_node_chanmgrs(5, &node_cfgs, &[None, None, None, None, None]);
2280 let nodes = create_network(5, &node_cfgs, &node_chanmgrs);
2282 // Create some initial channels
2283 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2284 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
2285 let chan_3 = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
2286 let chan_4 = create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::known(), InitFeatures::known());
2288 // Make sure all nodes are at the same starting height
2289 connect_blocks(&nodes[0], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[0].best_block_info().1);
2290 connect_blocks(&nodes[1], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[1].best_block_info().1);
2291 connect_blocks(&nodes[2], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[2].best_block_info().1);
2292 connect_blocks(&nodes[3], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[3].best_block_info().1);
2293 connect_blocks(&nodes[4], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[4].best_block_info().1);
2295 // Rebalance the network a bit by relaying one payment through all the channels...
2296 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
2297 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
2298 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
2299 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
2301 // Simple case with no pending HTLCs:
2302 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), true);
2303 check_added_monitors!(nodes[1], 1);
2304 check_closed_broadcast!(nodes[1], false);
2306 let mut node_txn = test_txn_broadcast(&nodes[1], &chan_1, None, HTLCType::NONE);
2307 assert_eq!(node_txn.len(), 1);
2308 mine_transaction(&nodes[0], &node_txn[0]);
2309 check_added_monitors!(nodes[0], 1);
2310 test_txn_broadcast(&nodes[0], &chan_1, None, HTLCType::NONE);
2312 check_closed_broadcast!(nodes[0], true);
2313 assert_eq!(nodes[0].node.list_channels().len(), 0);
2314 assert_eq!(nodes[1].node.list_channels().len(), 1);
2316 // One pending HTLC is discarded by the force-close:
2317 let payment_preimage_1 = route_payment(&nodes[1], &vec!(&nodes[2], &nodes[3])[..], 3000000).0;
2319 // Simple case of one pending HTLC to HTLC-Timeout (note that the HTLC-Timeout is not
2320 // broadcasted until we reach the timelock time).
2321 nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id(), true);
2322 check_closed_broadcast!(nodes[1], false);
2323 check_added_monitors!(nodes[1], 1);
2325 let mut node_txn = test_txn_broadcast(&nodes[1], &chan_2, None, HTLCType::NONE);
2326 connect_blocks(&nodes[1], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + MIN_CLTV_EXPIRY_DELTA as u32 + 1);
2327 test_txn_broadcast(&nodes[1], &chan_2, None, HTLCType::TIMEOUT);
2328 mine_transaction(&nodes[2], &node_txn[0]);
2329 check_added_monitors!(nodes[2], 1);
2330 test_txn_broadcast(&nodes[2], &chan_2, None, HTLCType::NONE);
2332 check_closed_broadcast!(nodes[2], true);
2333 assert_eq!(nodes[1].node.list_channels().len(), 0);
2334 assert_eq!(nodes[2].node.list_channels().len(), 1);
2336 macro_rules! claim_funds {
2337 ($node: expr, $prev_node: expr, $preimage: expr) => {
2339 assert!($node.node.claim_funds($preimage));
2340 check_added_monitors!($node, 1);
2342 let events = $node.node.get_and_clear_pending_msg_events();
2343 assert_eq!(events.len(), 1);
2345 MessageSendEvent::UpdateHTLCs { ref node_id, updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fail_htlcs, .. } } => {
2346 assert!(update_add_htlcs.is_empty());
2347 assert!(update_fail_htlcs.is_empty());
2348 assert_eq!(*node_id, $prev_node.node.get_our_node_id());
2350 _ => panic!("Unexpected event"),
2356 // nodes[3] gets the preimage, but nodes[2] already disconnected, resulting in a nodes[2]
2357 // HTLC-Timeout and a nodes[3] claim against it (+ its own announces)
2358 nodes[2].node.peer_disconnected(&nodes[3].node.get_our_node_id(), true);
2359 check_added_monitors!(nodes[2], 1);
2360 check_closed_broadcast!(nodes[2], false);
2361 let node2_commitment_txid;
2363 let node_txn = test_txn_broadcast(&nodes[2], &chan_3, None, HTLCType::NONE);
2364 connect_blocks(&nodes[2], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + MIN_CLTV_EXPIRY_DELTA as u32 + 1);
2365 test_txn_broadcast(&nodes[2], &chan_3, None, HTLCType::TIMEOUT);
2366 node2_commitment_txid = node_txn[0].txid();
2368 // Claim the payment on nodes[3], giving it knowledge of the preimage
2369 claim_funds!(nodes[3], nodes[2], payment_preimage_1);
2370 mine_transaction(&nodes[3], &node_txn[0]);
2371 check_added_monitors!(nodes[3], 1);
2372 check_preimage_claim(&nodes[3], &node_txn);
2374 check_closed_broadcast!(nodes[3], true);
2375 assert_eq!(nodes[2].node.list_channels().len(), 0);
2376 assert_eq!(nodes[3].node.list_channels().len(), 1);
2378 // Drop the ChannelMonitor for the previous channel to avoid it broadcasting transactions and
2379 // confusing us in the following tests.
2380 let chan_3_mon = nodes[3].chain_monitor.chain_monitor.monitors.write().unwrap().remove(&OutPoint { txid: chan_3.3.txid(), index: 0 }).unwrap();
2382 // One pending HTLC to time out:
2383 let payment_preimage_2 = route_payment(&nodes[3], &vec!(&nodes[4])[..], 3000000).0;
2384 // CLTV expires at TEST_FINAL_CLTV + 1 (current height) + 1 (added in send_payment for
2387 let (close_chan_update_1, close_chan_update_2) = {
2388 connect_blocks(&nodes[3], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + 1);
2389 let events = nodes[3].node.get_and_clear_pending_msg_events();
2390 assert_eq!(events.len(), 2);
2391 let close_chan_update_1 = match events[0] {
2392 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
2395 _ => panic!("Unexpected event"),
2398 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { .. }, node_id } => {
2399 assert_eq!(node_id, nodes[4].node.get_our_node_id());
2401 _ => panic!("Unexpected event"),
2403 check_added_monitors!(nodes[3], 1);
2405 // Clear bumped claiming txn spending node 2 commitment tx. Bumped txn are generated after reaching some height timer.
2407 let mut node_txn = nodes[3].tx_broadcaster.txn_broadcasted.lock().unwrap();
2408 node_txn.retain(|tx| {
2409 if tx.input[0].previous_output.txid == node2_commitment_txid {
2415 let node_txn = test_txn_broadcast(&nodes[3], &chan_4, None, HTLCType::TIMEOUT);
2417 // Claim the payment on nodes[4], giving it knowledge of the preimage
2418 claim_funds!(nodes[4], nodes[3], payment_preimage_2);
2420 connect_blocks(&nodes[4], TEST_FINAL_CLTV - CLTV_CLAIM_BUFFER + 2);
2421 let events = nodes[4].node.get_and_clear_pending_msg_events();
2422 assert_eq!(events.len(), 2);
2423 let close_chan_update_2 = match events[0] {
2424 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
2427 _ => panic!("Unexpected event"),
2430 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { .. }, node_id } => {
2431 assert_eq!(node_id, nodes[3].node.get_our_node_id());
2433 _ => panic!("Unexpected event"),
2435 check_added_monitors!(nodes[4], 1);
2436 test_txn_broadcast(&nodes[4], &chan_4, None, HTLCType::SUCCESS);
2438 mine_transaction(&nodes[4], &node_txn[0]);
2439 check_preimage_claim(&nodes[4], &node_txn);
2440 (close_chan_update_1, close_chan_update_2)
2442 nodes[3].net_graph_msg_handler.handle_channel_update(&close_chan_update_2).unwrap();
2443 nodes[4].net_graph_msg_handler.handle_channel_update(&close_chan_update_1).unwrap();
2444 assert_eq!(nodes[3].node.list_channels().len(), 0);
2445 assert_eq!(nodes[4].node.list_channels().len(), 0);
2447 nodes[3].chain_monitor.chain_monitor.monitors.write().unwrap().insert(OutPoint { txid: chan_3.3.txid(), index: 0 }, chan_3_mon);
2451 fn test_justice_tx() {
2452 // Test justice txn built on revoked HTLC-Success tx, against both sides
2453 let mut alice_config = UserConfig::default();
2454 alice_config.channel_options.announced_channel = true;
2455 alice_config.peer_channel_config_limits.force_announced_channel_preference = false;
2456 alice_config.own_channel_config.our_to_self_delay = 6 * 24 * 5;
2457 let mut bob_config = UserConfig::default();
2458 bob_config.channel_options.announced_channel = true;
2459 bob_config.peer_channel_config_limits.force_announced_channel_preference = false;
2460 bob_config.own_channel_config.our_to_self_delay = 6 * 24 * 3;
2461 let user_cfgs = [Some(alice_config), Some(bob_config)];
2462 let mut chanmon_cfgs = create_chanmon_cfgs(2);
2463 chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
2464 chanmon_cfgs[1].keys_manager.disable_revocation_policy_check = true;
2465 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2466 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &user_cfgs);
2467 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2468 // Create some new channels:
2469 let chan_5 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2471 // A pending HTLC which will be revoked:
2472 let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2473 // Get the will-be-revoked local txn from nodes[0]
2474 let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_5.2);
2475 assert_eq!(revoked_local_txn.len(), 2); // First commitment tx, then HTLC tx
2476 assert_eq!(revoked_local_txn[0].input.len(), 1);
2477 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_5.3.txid());
2478 assert_eq!(revoked_local_txn[0].output.len(), 2); // Only HTLC and output back to 0 are present
2479 assert_eq!(revoked_local_txn[1].input.len(), 1);
2480 assert_eq!(revoked_local_txn[1].input[0].previous_output.txid, revoked_local_txn[0].txid());
2481 assert_eq!(revoked_local_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC-Timeout
2482 // Revoke the old state
2483 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_3);
2486 mine_transaction(&nodes[1], &revoked_local_txn[0]);
2488 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2489 assert_eq!(node_txn.len(), 2); // ChannelMonitor: penalty tx, ChannelManager: local commitment tx
2490 assert_eq!(node_txn[0].input.len(), 2); // We should claim the revoked output and the HTLC output
2492 check_spends!(node_txn[0], revoked_local_txn[0]);
2493 node_txn.swap_remove(0);
2494 node_txn.truncate(1);
2496 check_added_monitors!(nodes[1], 1);
2497 test_txn_broadcast(&nodes[1], &chan_5, None, HTLCType::NONE);
2499 mine_transaction(&nodes[0], &revoked_local_txn[0]);
2500 connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
2501 // Verify broadcast of revoked HTLC-timeout
2502 let node_txn = test_txn_broadcast(&nodes[0], &chan_5, Some(revoked_local_txn[0].clone()), HTLCType::TIMEOUT);
2503 check_added_monitors!(nodes[0], 1);
2504 // Broadcast revoked HTLC-timeout on node 1
2505 mine_transaction(&nodes[1], &node_txn[1]);
2506 test_revoked_htlc_claim_txn_broadcast(&nodes[1], node_txn[1].clone(), revoked_local_txn[0].clone());
2508 get_announce_close_broadcast_events(&nodes, 0, 1);
2510 assert_eq!(nodes[0].node.list_channels().len(), 0);
2511 assert_eq!(nodes[1].node.list_channels().len(), 0);
2513 // We test justice_tx build by A on B's revoked HTLC-Success tx
2514 // Create some new channels:
2515 let chan_6 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2517 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2521 // A pending HTLC which will be revoked:
2522 let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2523 // Get the will-be-revoked local txn from B
2524 let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan_6.2);
2525 assert_eq!(revoked_local_txn.len(), 1); // Only commitment tx
2526 assert_eq!(revoked_local_txn[0].input.len(), 1);
2527 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_6.3.txid());
2528 assert_eq!(revoked_local_txn[0].output.len(), 2); // Only HTLC and output back to A are present
2529 // Revoke the old state
2530 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_4);
2532 mine_transaction(&nodes[0], &revoked_local_txn[0]);
2534 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
2535 assert_eq!(node_txn.len(), 2); //ChannelMonitor: penalty tx, ChannelManager: local commitment tx
2536 assert_eq!(node_txn[0].input.len(), 1); // We claim the received HTLC output
2538 check_spends!(node_txn[0], revoked_local_txn[0]);
2539 node_txn.swap_remove(0);
2541 check_added_monitors!(nodes[0], 1);
2542 test_txn_broadcast(&nodes[0], &chan_6, None, HTLCType::NONE);
2544 mine_transaction(&nodes[1], &revoked_local_txn[0]);
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 test_revoked_htlc_claim_txn_broadcast(&nodes[0], node_txn[1].clone(), revoked_local_txn[0].clone());
2550 get_announce_close_broadcast_events(&nodes, 0, 1);
2551 assert_eq!(nodes[0].node.list_channels().len(), 0);
2552 assert_eq!(nodes[1].node.list_channels().len(), 0);
2556 fn revoked_output_claim() {
2557 // Simple test to ensure a node will claim a revoked output when a stale remote commitment
2558 // transaction is broadcast by its counterparty
2559 let chanmon_cfgs = create_chanmon_cfgs(2);
2560 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2561 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2562 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2563 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2564 // node[0] is gonna to revoke an old state thus node[1] should be able to claim the revoked output
2565 let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2566 assert_eq!(revoked_local_txn.len(), 1);
2567 // Only output is the full channel value back to nodes[0]:
2568 assert_eq!(revoked_local_txn[0].output.len(), 1);
2569 // Send a payment through, updating everyone's latest commitment txn
2570 send_payment(&nodes[0], &vec!(&nodes[1])[..], 5000000);
2572 // Inform nodes[1] that nodes[0] broadcast a stale tx
2573 mine_transaction(&nodes[1], &revoked_local_txn[0]);
2574 check_added_monitors!(nodes[1], 1);
2575 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2576 assert_eq!(node_txn.len(), 2); // ChannelMonitor: justice tx against revoked to_local output, ChannelManager: local commitment tx
2578 check_spends!(node_txn[0], revoked_local_txn[0]);
2579 check_spends!(node_txn[1], chan_1.3);
2581 // Inform nodes[0] that a watchtower cheated on its behalf, so it will force-close the chan
2582 mine_transaction(&nodes[0], &revoked_local_txn[0]);
2583 get_announce_close_broadcast_events(&nodes, 0, 1);
2584 check_added_monitors!(nodes[0], 1)
2588 fn claim_htlc_outputs_shared_tx() {
2589 // Node revoked old state, htlcs haven't time out yet, claim them in shared justice tx
2590 let mut chanmon_cfgs = create_chanmon_cfgs(2);
2591 chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
2592 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2593 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2594 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2596 // Create some new channel:
2597 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2599 // Rebalance the network to generate htlc in the two directions
2600 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
2601 // 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
2602 let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2603 let (_payment_preimage_2, payment_hash_2, _) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000);
2605 // Get the will-be-revoked local txn from node[0]
2606 let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2607 assert_eq!(revoked_local_txn.len(), 2); // commitment tx + 1 HTLC-Timeout tx
2608 assert_eq!(revoked_local_txn[0].input.len(), 1);
2609 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
2610 assert_eq!(revoked_local_txn[1].input.len(), 1);
2611 assert_eq!(revoked_local_txn[1].input[0].previous_output.txid, revoked_local_txn[0].txid());
2612 assert_eq!(revoked_local_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC-Timeout
2613 check_spends!(revoked_local_txn[1], revoked_local_txn[0]);
2615 //Revoke the old state
2616 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_1);
2619 mine_transaction(&nodes[0], &revoked_local_txn[0]);
2620 check_added_monitors!(nodes[0], 1);
2621 mine_transaction(&nodes[1], &revoked_local_txn[0]);
2622 check_added_monitors!(nodes[1], 1);
2623 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
2624 expect_payment_failed!(nodes[1], payment_hash_2, true);
2626 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2627 assert_eq!(node_txn.len(), 2); // ChannelMonitor: penalty tx, ChannelManager: local commitment
2629 assert_eq!(node_txn[0].input.len(), 3); // Claim the revoked output + both revoked HTLC outputs
2630 check_spends!(node_txn[0], revoked_local_txn[0]);
2632 let mut witness_lens = BTreeSet::new();
2633 witness_lens.insert(node_txn[0].input[0].witness.last().unwrap().len());
2634 witness_lens.insert(node_txn[0].input[1].witness.last().unwrap().len());
2635 witness_lens.insert(node_txn[0].input[2].witness.last().unwrap().len());
2636 assert_eq!(witness_lens.len(), 3);
2637 assert_eq!(*witness_lens.iter().skip(0).next().unwrap(), 77); // revoked to_local
2638 assert_eq!(*witness_lens.iter().skip(1).next().unwrap(), OFFERED_HTLC_SCRIPT_WEIGHT); // revoked offered HTLC
2639 assert_eq!(*witness_lens.iter().skip(2).next().unwrap(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // revoked received HTLC
2641 // Next nodes[1] broadcasts its current local tx state:
2642 assert_eq!(node_txn[1].input.len(), 1);
2643 assert_eq!(node_txn[1].input[0].previous_output.txid, chan_1.3.txid()); //Spending funding tx unique txouput, tx broadcasted by ChannelManager
2645 get_announce_close_broadcast_events(&nodes, 0, 1);
2646 assert_eq!(nodes[0].node.list_channels().len(), 0);
2647 assert_eq!(nodes[1].node.list_channels().len(), 0);
2651 fn claim_htlc_outputs_single_tx() {
2652 // Node revoked old state, htlcs have timed out, claim each of them in separated justice tx
2653 let mut chanmon_cfgs = create_chanmon_cfgs(2);
2654 chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
2655 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2656 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2657 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2659 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2661 // Rebalance the network to generate htlc in the two directions
2662 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
2663 // 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
2664 // time as two different claim transactions as we're gonna to timeout htlc with given a high current height
2665 let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2666 let (_payment_preimage_2, payment_hash_2, _payment_secret_2) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000);
2668 // Get the will-be-revoked local txn from node[0]
2669 let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2671 //Revoke the old state
2672 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_1);
2675 confirm_transaction_at(&nodes[0], &revoked_local_txn[0], 100);
2676 check_added_monitors!(nodes[0], 1);
2677 confirm_transaction_at(&nodes[1], &revoked_local_txn[0], 100);
2678 check_added_monitors!(nodes[1], 1);
2679 expect_pending_htlcs_forwardable_ignore!(nodes[0]);
2681 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
2682 expect_payment_failed!(nodes[1], payment_hash_2, true);
2684 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2685 assert_eq!(node_txn.len(), 9);
2686 // ChannelMonitor: justice tx revoked offered htlc, justice tx revoked received htlc, justice tx revoked to_local (3)
2687 // ChannelManager: local commmitment + local HTLC-timeout (2)
2688 // ChannelMonitor: bumped justice tx, after one increase, bumps on HTLC aren't generated not being substantial anymore, bump on revoked to_local isn't generated due to more room for expiration (2)
2689 // ChannelMonitor: local commitment + local HTLC-timeout (2)
2691 // Check the pair local commitment and HTLC-timeout broadcast due to HTLC expiration
2692 assert_eq!(node_txn[0].input.len(), 1);
2693 check_spends!(node_txn[0], chan_1.3);
2694 assert_eq!(node_txn[1].input.len(), 1);
2695 let witness_script = node_txn[1].input[0].witness.last().unwrap();
2696 assert_eq!(witness_script.len(), OFFERED_HTLC_SCRIPT_WEIGHT); //Spending an offered htlc output
2697 check_spends!(node_txn[1], node_txn[0]);
2699 // Justice transactions are indices 1-2-4
2700 assert_eq!(node_txn[2].input.len(), 1);
2701 assert_eq!(node_txn[3].input.len(), 1);
2702 assert_eq!(node_txn[4].input.len(), 1);
2704 check_spends!(node_txn[2], revoked_local_txn[0]);
2705 check_spends!(node_txn[3], revoked_local_txn[0]);
2706 check_spends!(node_txn[4], revoked_local_txn[0]);
2708 let mut witness_lens = BTreeSet::new();
2709 witness_lens.insert(node_txn[2].input[0].witness.last().unwrap().len());
2710 witness_lens.insert(node_txn[3].input[0].witness.last().unwrap().len());
2711 witness_lens.insert(node_txn[4].input[0].witness.last().unwrap().len());
2712 assert_eq!(witness_lens.len(), 3);
2713 assert_eq!(*witness_lens.iter().skip(0).next().unwrap(), 77); // revoked to_local
2714 assert_eq!(*witness_lens.iter().skip(1).next().unwrap(), OFFERED_HTLC_SCRIPT_WEIGHT); // revoked offered HTLC
2715 assert_eq!(*witness_lens.iter().skip(2).next().unwrap(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // revoked received HTLC
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 test_htlc_on_chain_success() {
2724 // Test that in case of a unilateral close onchain, we detect the state of output and pass
2725 // the preimage backward accordingly. So here we test that ChannelManager is
2726 // broadcasting the right event to other nodes in payment path.
2727 // We test with two HTLCs simultaneously as that was not handled correctly in the past.
2728 // A --------------------> B ----------------------> C (preimage)
2729 // First, C should claim the HTLC outputs via HTLC-Success when its own latest local
2730 // commitment transaction was broadcast.
2731 // Then, B should learn the preimage from said transactions, attempting to claim backwards
2733 // B should be able to claim via preimage if A then broadcasts its local tx.
2734 // Finally, when A sees B's latest local commitment transaction it should be able to claim
2735 // the HTLC outputs via the preimage it learned (which, once confirmed should generate a
2736 // PaymentSent event).
2738 let chanmon_cfgs = create_chanmon_cfgs(3);
2739 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2740 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2741 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2743 // Create some initial channels
2744 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2745 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
2747 // Ensure all nodes are at the same height
2748 let node_max_height = nodes.iter().map(|node| node.blocks.lock().unwrap().len()).max().unwrap() as u32;
2749 connect_blocks(&nodes[0], node_max_height - nodes[0].best_block_info().1);
2750 connect_blocks(&nodes[1], node_max_height - nodes[1].best_block_info().1);
2751 connect_blocks(&nodes[2], node_max_height - nodes[2].best_block_info().1);
2753 // Rebalance the network a bit by relaying one payment through all the channels...
2754 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
2755 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
2757 let (our_payment_preimage, _payment_hash, _payment_secret) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2758 let (our_payment_preimage_2, _payment_hash_2, _payment_secret_2) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2760 // Broadcast legit commitment tx from C on B's chain
2761 // Broadcast HTLC Success transaction by C on received output from C's commitment tx on B's chain
2762 let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
2763 assert_eq!(commitment_tx.len(), 1);
2764 check_spends!(commitment_tx[0], chan_2.3);
2765 nodes[2].node.claim_funds(our_payment_preimage);
2766 nodes[2].node.claim_funds(our_payment_preimage_2);
2767 check_added_monitors!(nodes[2], 2);
2768 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2769 assert!(updates.update_add_htlcs.is_empty());
2770 assert!(updates.update_fail_htlcs.is_empty());
2771 assert!(updates.update_fail_malformed_htlcs.is_empty());
2772 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
2774 mine_transaction(&nodes[2], &commitment_tx[0]);
2775 check_closed_broadcast!(nodes[2], true);
2776 check_added_monitors!(nodes[2], 1);
2777 let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 3 (commitment tx, 2*htlc-success tx), ChannelMonitor : 2 (2 * HTLC-Success tx)
2778 assert_eq!(node_txn.len(), 5);
2779 assert_eq!(node_txn[0], node_txn[3]);
2780 assert_eq!(node_txn[1], node_txn[4]);
2781 assert_eq!(node_txn[2], commitment_tx[0]);
2782 check_spends!(node_txn[0], commitment_tx[0]);
2783 check_spends!(node_txn[1], commitment_tx[0]);
2784 assert_eq!(node_txn[0].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2785 assert_eq!(node_txn[1].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2786 assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2787 assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2788 assert_eq!(node_txn[0].lock_time, 0);
2789 assert_eq!(node_txn[1].lock_time, 0);
2791 // Verify that B's ChannelManager is able to extract preimage from HTLC Success tx and pass it backward
2792 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2793 connect_block(&nodes[1], &Block { header, txdata: node_txn});
2794 connect_blocks(&nodes[1], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
2796 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
2797 assert_eq!(added_monitors.len(), 1);
2798 assert_eq!(added_monitors[0].0.txid, chan_2.3.txid());
2799 added_monitors.clear();
2801 let events = nodes[1].node.get_and_clear_pending_msg_events();
2803 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
2804 assert_eq!(added_monitors.len(), 2);
2805 assert_eq!(added_monitors[0].0.txid, chan_1.3.txid());
2806 assert_eq!(added_monitors[1].0.txid, chan_1.3.txid());
2807 added_monitors.clear();
2809 assert_eq!(events.len(), 3);
2811 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
2812 _ => panic!("Unexpected event"),
2815 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { .. }, node_id: _ } => {},
2816 _ => panic!("Unexpected event"),
2820 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, .. } } => {
2821 assert!(update_add_htlcs.is_empty());
2822 assert!(update_fail_htlcs.is_empty());
2823 assert_eq!(update_fulfill_htlcs.len(), 1);
2824 assert!(update_fail_malformed_htlcs.is_empty());
2825 assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
2827 _ => panic!("Unexpected event"),
2829 macro_rules! check_tx_local_broadcast {
2830 ($node: expr, $htlc_offered: expr, $commitment_tx: expr, $chan_tx: expr) => { {
2831 let mut node_txn = $node.tx_broadcaster.txn_broadcasted.lock().unwrap();
2832 assert_eq!(node_txn.len(), 3);
2833 // Node[1]: ChannelManager: 3 (commitment tx, 2*HTLC-Timeout tx), ChannelMonitor: 2 (timeout tx)
2834 // Node[0]: ChannelManager: 3 (commtiemtn tx, 2*HTLC-Timeout tx), ChannelMonitor: 2 HTLC-timeout
2835 check_spends!(node_txn[1], $commitment_tx);
2836 check_spends!(node_txn[2], $commitment_tx);
2837 assert_ne!(node_txn[1].lock_time, 0);
2838 assert_ne!(node_txn[2].lock_time, 0);
2840 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2841 assert_eq!(node_txn[2].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2842 assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2843 assert!(node_txn[2].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2845 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2846 assert_eq!(node_txn[2].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2847 assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2848 assert!(node_txn[2].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2850 check_spends!(node_txn[0], $chan_tx);
2851 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), 71);
2855 // nodes[1] now broadcasts its own local state as a fallback, suggesting an alternate
2856 // commitment transaction with a corresponding HTLC-Timeout transactions, as well as a
2857 // timeout-claim of the output that nodes[2] just claimed via success.
2858 check_tx_local_broadcast!(nodes[1], false, commitment_tx[0], chan_2.3);
2860 // Broadcast legit commitment tx from A on B's chain
2861 // Broadcast preimage tx by B on offered output from A commitment tx on A's chain
2862 let node_a_commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
2863 check_spends!(node_a_commitment_tx[0], chan_1.3);
2864 mine_transaction(&nodes[1], &node_a_commitment_tx[0]);
2865 check_closed_broadcast!(nodes[1], true);
2866 check_added_monitors!(nodes[1], 1);
2867 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
2868 assert_eq!(node_txn.len(), 6); // ChannelManager : 3 (commitment tx + HTLC-Sucess * 2), ChannelMonitor : 3 (HTLC-Success, 2* RBF bumps of above HTLC txn)
2869 let commitment_spend =
2870 if node_txn[0].input[0].previous_output.txid == node_a_commitment_tx[0].txid() {
2871 check_spends!(node_txn[1], commitment_tx[0]);
2872 check_spends!(node_txn[2], commitment_tx[0]);
2873 assert_ne!(node_txn[1].input[0].previous_output.vout, node_txn[2].input[0].previous_output.vout);
2876 check_spends!(node_txn[0], commitment_tx[0]);
2877 check_spends!(node_txn[1], commitment_tx[0]);
2878 assert_ne!(node_txn[0].input[0].previous_output.vout, node_txn[1].input[0].previous_output.vout);
2882 check_spends!(commitment_spend, node_a_commitment_tx[0]);
2883 assert_eq!(commitment_spend.input.len(), 2);
2884 assert_eq!(commitment_spend.input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2885 assert_eq!(commitment_spend.input[1].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2886 assert_eq!(commitment_spend.lock_time, 0);
2887 assert!(commitment_spend.output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2888 check_spends!(node_txn[3], chan_1.3);
2889 assert_eq!(node_txn[3].input[0].witness.clone().last().unwrap().len(), 71);
2890 check_spends!(node_txn[4], node_txn[3]);
2891 check_spends!(node_txn[5], node_txn[3]);
2892 // We don't bother to check that B can claim the HTLC output on its commitment tx here as
2893 // we already checked the same situation with A.
2895 // Verify that A's ChannelManager is able to extract preimage from preimage tx and generate PaymentSent
2896 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2897 connect_block(&nodes[0], &Block { header, txdata: vec![node_a_commitment_tx[0].clone(), commitment_spend.clone()] });
2898 connect_blocks(&nodes[0], TEST_FINAL_CLTV + MIN_CLTV_EXPIRY_DELTA as u32 - 1); // Confirm blocks until the HTLC expires
2899 check_closed_broadcast!(nodes[0], true);
2900 check_added_monitors!(nodes[0], 1);
2901 let events = nodes[0].node.get_and_clear_pending_events();
2902 assert_eq!(events.len(), 2);
2903 let mut first_claimed = false;
2904 for event in events {
2906 Event::PaymentSent { payment_preimage } => {
2907 if payment_preimage == our_payment_preimage {
2908 assert!(!first_claimed);
2909 first_claimed = true;
2911 assert_eq!(payment_preimage, our_payment_preimage_2);
2914 _ => panic!("Unexpected event"),
2917 check_tx_local_broadcast!(nodes[0], true, node_a_commitment_tx[0], chan_1.3);
2920 fn do_test_htlc_on_chain_timeout(connect_style: ConnectStyle) {
2921 // Test that in case of a unilateral close onchain, we detect the state of output and
2922 // timeout the HTLC backward accordingly. So here we test that ChannelManager is
2923 // broadcasting the right event to other nodes in payment path.
2924 // A ------------------> B ----------------------> C (timeout)
2925 // B's commitment tx C's commitment tx
2927 // B's HTLC timeout tx B's timeout tx
2929 let chanmon_cfgs = create_chanmon_cfgs(3);
2930 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2931 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2932 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2933 *nodes[0].connect_style.borrow_mut() = connect_style;
2934 *nodes[1].connect_style.borrow_mut() = connect_style;
2935 *nodes[2].connect_style.borrow_mut() = connect_style;
2937 // Create some intial channels
2938 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2939 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
2941 // Rebalance the network a bit by relaying one payment thorugh all the channels...
2942 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
2943 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
2945 let (_payment_preimage, payment_hash, _payment_secret) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2947 // Broadcast legit commitment tx from C on B's chain
2948 let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
2949 check_spends!(commitment_tx[0], chan_2.3);
2950 nodes[2].node.fail_htlc_backwards(&payment_hash);
2951 check_added_monitors!(nodes[2], 0);
2952 expect_pending_htlcs_forwardable!(nodes[2]);
2953 check_added_monitors!(nodes[2], 1);
2955 let events = nodes[2].node.get_and_clear_pending_msg_events();
2956 assert_eq!(events.len(), 1);
2958 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, .. } } => {
2959 assert!(update_add_htlcs.is_empty());
2960 assert!(!update_fail_htlcs.is_empty());
2961 assert!(update_fulfill_htlcs.is_empty());
2962 assert!(update_fail_malformed_htlcs.is_empty());
2963 assert_eq!(nodes[1].node.get_our_node_id(), *node_id);
2965 _ => panic!("Unexpected event"),
2967 mine_transaction(&nodes[2], &commitment_tx[0]);
2968 check_closed_broadcast!(nodes[2], true);
2969 check_added_monitors!(nodes[2], 1);
2970 let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 1 (commitment tx)
2971 assert_eq!(node_txn.len(), 1);
2972 check_spends!(node_txn[0], chan_2.3);
2973 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), 71);
2975 // Broadcast timeout transaction by B on received output from C's commitment tx on B's chain
2976 // Verify that B's ChannelManager is able to detect that HTLC is timeout by its own tx and react backward in consequence
2977 connect_blocks(&nodes[1], 200 - nodes[2].best_block_info().1);
2978 mine_transaction(&nodes[1], &commitment_tx[0]);
2981 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2982 assert_eq!(node_txn.len(), 5); // ChannelManager : 2 (commitment tx, HTLC-Timeout tx), ChannelMonitor : 2 (local commitment tx + HTLC-timeout), 1 timeout tx
2983 assert_eq!(node_txn[0], node_txn[3]);
2984 assert_eq!(node_txn[1], node_txn[4]);
2986 check_spends!(node_txn[2], commitment_tx[0]);
2987 assert_eq!(node_txn[2].clone().input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2989 check_spends!(node_txn[0], chan_2.3);
2990 check_spends!(node_txn[1], node_txn[0]);
2991 assert_eq!(node_txn[0].clone().input[0].witness.last().unwrap().len(), 71);
2992 assert_eq!(node_txn[1].clone().input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2994 timeout_tx = node_txn[2].clone();
2998 mine_transaction(&nodes[1], &timeout_tx);
2999 check_added_monitors!(nodes[1], 1);
3000 check_closed_broadcast!(nodes[1], true);
3002 // B will rebroadcast a fee-bumped timeout transaction here.
3003 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
3004 assert_eq!(node_txn.len(), 1);
3005 check_spends!(node_txn[0], commitment_tx[0]);
3008 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
3010 // B may rebroadcast its own holder commitment transaction here, as a safeguard against
3011 // some incredibly unlikely partial-eclipse-attack scenarios. That said, because the
3012 // original commitment_tx[0] (also spending chan_2.3) has reached ANTI_REORG_DELAY B really
3013 // shouldn't broadcast anything here, and in some connect style scenarios we do not.
3014 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
3015 if node_txn.len() == 1 {
3016 check_spends!(node_txn[0], chan_2.3);
3018 assert_eq!(node_txn.len(), 0);
3022 expect_pending_htlcs_forwardable!(nodes[1]);
3023 check_added_monitors!(nodes[1], 1);
3024 let events = nodes[1].node.get_and_clear_pending_msg_events();
3025 assert_eq!(events.len(), 1);
3027 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, .. } } => {
3028 assert!(update_add_htlcs.is_empty());
3029 assert!(!update_fail_htlcs.is_empty());
3030 assert!(update_fulfill_htlcs.is_empty());
3031 assert!(update_fail_malformed_htlcs.is_empty());
3032 assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
3034 _ => panic!("Unexpected event"),
3037 // Broadcast legit commitment tx from B on A's chain
3038 let commitment_tx = get_local_commitment_txn!(nodes[1], chan_1.2);
3039 check_spends!(commitment_tx[0], chan_1.3);
3041 mine_transaction(&nodes[0], &commitment_tx[0]);
3042 connect_blocks(&nodes[0], TEST_FINAL_CLTV + MIN_CLTV_EXPIRY_DELTA as u32 - 1); // Confirm blocks until the HTLC expires
3044 check_closed_broadcast!(nodes[0], true);
3045 check_added_monitors!(nodes[0], 1);
3046 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 1 commitment tx, ChannelMonitor : 1 timeout tx
3047 assert_eq!(node_txn.len(), 2);
3048 check_spends!(node_txn[0], chan_1.3);
3049 assert_eq!(node_txn[0].clone().input[0].witness.last().unwrap().len(), 71);
3050 check_spends!(node_txn[1], commitment_tx[0]);
3051 assert_eq!(node_txn[1].clone().input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
3055 fn test_htlc_on_chain_timeout() {
3056 do_test_htlc_on_chain_timeout(ConnectStyle::BestBlockFirstSkippingBlocks);
3057 do_test_htlc_on_chain_timeout(ConnectStyle::TransactionsFirstSkippingBlocks);
3058 do_test_htlc_on_chain_timeout(ConnectStyle::FullBlockViaListen);
3062 fn test_simple_commitment_revoked_fail_backward() {
3063 // Test that in case of a revoked commitment tx, we detect the resolution of output by justice tx
3064 // and fail backward accordingly.
3066 let chanmon_cfgs = create_chanmon_cfgs(3);
3067 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3068 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3069 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3071 // Create some initial channels
3072 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3073 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3075 let (payment_preimage, _payment_hash, _payment_secret) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3000000);
3076 // Get the will-be-revoked local txn from nodes[2]
3077 let revoked_local_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
3078 // Revoke the old state
3079 claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage);
3081 let (_, payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3000000);
3083 mine_transaction(&nodes[1], &revoked_local_txn[0]);
3084 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
3085 check_added_monitors!(nodes[1], 1);
3086 check_closed_broadcast!(nodes[1], true);
3088 expect_pending_htlcs_forwardable!(nodes[1]);
3089 check_added_monitors!(nodes[1], 1);
3090 let events = nodes[1].node.get_and_clear_pending_msg_events();
3091 assert_eq!(events.len(), 1);
3093 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, .. } } => {
3094 assert!(update_add_htlcs.is_empty());
3095 assert_eq!(update_fail_htlcs.len(), 1);
3096 assert!(update_fulfill_htlcs.is_empty());
3097 assert!(update_fail_malformed_htlcs.is_empty());
3098 assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
3100 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
3101 commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
3102 expect_payment_failure_chan_update!(nodes[0], chan_2.0.contents.short_channel_id, true);
3103 expect_payment_failed!(nodes[0], payment_hash, false);
3105 _ => panic!("Unexpected event"),
3109 fn do_test_commitment_revoked_fail_backward_exhaustive(deliver_bs_raa: bool, use_dust: bool, no_to_remote: bool) {
3110 // Test that if our counterparty broadcasts a revoked commitment transaction we fail all
3111 // pending HTLCs on that channel backwards even if the HTLCs aren't present in our latest
3112 // commitment transaction anymore.
3113 // To do this, we have the peer which will broadcast a revoked commitment transaction send
3114 // a number of update_fail/commitment_signed updates without ever sending the RAA in
3115 // response to our commitment_signed. This is somewhat misbehavior-y, though not
3116 // technically disallowed and we should probably handle it reasonably.
3117 // Note that this is pretty exhaustive as an outbound HTLC which we haven't yet
3118 // failed/fulfilled backwards must be in at least one of the latest two remote commitment
3120 // * Once we move it out of our holding cell/add it, we will immediately include it in a
3121 // commitment_signed (implying it will be in the latest remote commitment transaction).
3122 // * Once they remove it, we will send a (the first) commitment_signed without the HTLC,
3123 // and once they revoke the previous commitment transaction (allowing us to send a new
3124 // commitment_signed) we will be free to fail/fulfill the HTLC backwards.
3125 let chanmon_cfgs = create_chanmon_cfgs(3);
3126 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3127 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3128 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3130 // Create some initial channels
3131 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3132 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3134 let (payment_preimage, _payment_hash, _payment_secret) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], if no_to_remote { 10_000 } else { 3_000_000 });
3135 // Get the will-be-revoked local txn from nodes[2]
3136 let revoked_local_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
3137 assert_eq!(revoked_local_txn[0].output.len(), if no_to_remote { 1 } else { 2 });
3138 // Revoke the old state
3139 claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage);
3141 let value = if use_dust {
3142 // The dust limit applied to HTLC outputs considers the fee of the HTLC transaction as
3143 // well, so HTLCs at exactly the dust limit will not be included in commitment txn.
3144 nodes[2].node.channel_state.lock().unwrap().by_id.get(&chan_2.2).unwrap().holder_dust_limit_satoshis * 1000
3147 let (_, first_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
3148 let (_, second_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
3149 let (_, third_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
3151 assert!(nodes[2].node.fail_htlc_backwards(&first_payment_hash));
3152 expect_pending_htlcs_forwardable!(nodes[2]);
3153 check_added_monitors!(nodes[2], 1);
3154 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3155 assert!(updates.update_add_htlcs.is_empty());
3156 assert!(updates.update_fulfill_htlcs.is_empty());
3157 assert!(updates.update_fail_malformed_htlcs.is_empty());
3158 assert_eq!(updates.update_fail_htlcs.len(), 1);
3159 assert!(updates.update_fee.is_none());
3160 nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
3161 let bs_raa = commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false, true, false, true);
3162 // Drop the last RAA from 3 -> 2
3164 assert!(nodes[2].node.fail_htlc_backwards(&second_payment_hash));
3165 expect_pending_htlcs_forwardable!(nodes[2]);
3166 check_added_monitors!(nodes[2], 1);
3167 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3168 assert!(updates.update_add_htlcs.is_empty());
3169 assert!(updates.update_fulfill_htlcs.is_empty());
3170 assert!(updates.update_fail_malformed_htlcs.is_empty());
3171 assert_eq!(updates.update_fail_htlcs.len(), 1);
3172 assert!(updates.update_fee.is_none());
3173 nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
3174 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &updates.commitment_signed);
3175 check_added_monitors!(nodes[1], 1);
3176 // Note that nodes[1] is in AwaitingRAA, so won't send a CS
3177 let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
3178 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
3179 check_added_monitors!(nodes[2], 1);
3181 assert!(nodes[2].node.fail_htlc_backwards(&third_payment_hash));
3182 expect_pending_htlcs_forwardable!(nodes[2]);
3183 check_added_monitors!(nodes[2], 1);
3184 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3185 assert!(updates.update_add_htlcs.is_empty());
3186 assert!(updates.update_fulfill_htlcs.is_empty());
3187 assert!(updates.update_fail_malformed_htlcs.is_empty());
3188 assert_eq!(updates.update_fail_htlcs.len(), 1);
3189 assert!(updates.update_fee.is_none());
3190 nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
3191 // At this point first_payment_hash has dropped out of the latest two commitment
3192 // transactions that nodes[1] is tracking...
3193 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &updates.commitment_signed);
3194 check_added_monitors!(nodes[1], 1);
3195 // Note that nodes[1] is (still) in AwaitingRAA, so won't send a CS
3196 let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
3197 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
3198 check_added_monitors!(nodes[2], 1);
3200 // Add a fourth HTLC, this one will get sequestered away in nodes[1]'s holding cell waiting
3201 // on nodes[2]'s RAA.
3202 let (_, fourth_payment_hash, fourth_payment_secret) = get_payment_preimage_hash!(nodes[2]);
3203 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
3204 let logger = test_utils::TestLogger::new();
3205 let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[2].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
3206 nodes[1].node.send_payment(&route, fourth_payment_hash, &Some(fourth_payment_secret)).unwrap();
3207 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3208 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
3209 check_added_monitors!(nodes[1], 0);
3212 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_raa);
3213 // One monitor for the new revocation preimage, no second on as we won't generate a new
3214 // commitment transaction for nodes[0] until process_pending_htlc_forwards().
3215 check_added_monitors!(nodes[1], 1);
3216 let events = nodes[1].node.get_and_clear_pending_events();
3217 assert_eq!(events.len(), 1);
3219 Event::PendingHTLCsForwardable { .. } => { },
3220 _ => panic!("Unexpected event"),
3222 // Deliberately don't process the pending fail-back so they all fail back at once after
3223 // block connection just like the !deliver_bs_raa case
3226 let mut failed_htlcs = HashSet::new();
3227 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
3229 mine_transaction(&nodes[1], &revoked_local_txn[0]);
3230 check_added_monitors!(nodes[1], 1);
3231 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
3233 let events = nodes[1].node.get_and_clear_pending_events();
3234 assert_eq!(events.len(), if deliver_bs_raa { 1 } else { 2 });
3236 Event::PaymentFailed { ref payment_hash, .. } => {
3237 assert_eq!(*payment_hash, fourth_payment_hash);
3239 _ => panic!("Unexpected event"),
3241 if !deliver_bs_raa {
3243 Event::PendingHTLCsForwardable { .. } => { },
3244 _ => panic!("Unexpected event"),
3247 nodes[1].node.process_pending_htlc_forwards();
3248 check_added_monitors!(nodes[1], 1);
3250 let events = nodes[1].node.get_and_clear_pending_msg_events();
3251 assert_eq!(events.len(), if deliver_bs_raa { 4 } else { 3 });
3252 match events[if deliver_bs_raa { 1 } else { 0 }] {
3253 MessageSendEvent::BroadcastChannelUpdate { msg: msgs::ChannelUpdate { .. } } => {},
3254 _ => panic!("Unexpected event"),
3256 match events[if deliver_bs_raa { 2 } else { 1 }] {
3257 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { msg: msgs::ErrorMessage { channel_id, ref data } }, node_id: _ } => {
3258 assert_eq!(channel_id, chan_2.2);
3259 assert_eq!(data.as_str(), "Commitment or closing transaction was confirmed on chain.");
3261 _ => panic!("Unexpected event"),
3265 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, .. } } => {
3266 assert_eq!(nodes[2].node.get_our_node_id(), *node_id);
3267 assert_eq!(update_add_htlcs.len(), 1);
3268 assert!(update_fulfill_htlcs.is_empty());
3269 assert!(update_fail_htlcs.is_empty());
3270 assert!(update_fail_malformed_htlcs.is_empty());
3272 _ => panic!("Unexpected event"),
3275 match events[if deliver_bs_raa { 3 } else { 2 }] {
3276 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, .. } } => {
3277 assert!(update_add_htlcs.is_empty());
3278 assert_eq!(update_fail_htlcs.len(), 3);
3279 assert!(update_fulfill_htlcs.is_empty());
3280 assert!(update_fail_malformed_htlcs.is_empty());
3281 assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
3283 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
3284 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[1]);
3285 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[2]);
3287 commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
3289 let events = nodes[0].node.get_and_clear_pending_msg_events();
3290 // If we delivered B's RAA we got an unknown preimage error, not something
3291 // that we should update our routing table for.
3292 assert_eq!(events.len(), if deliver_bs_raa { 2 } else { 3 });
3293 for event in events {
3295 MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
3296 _ => panic!("Unexpected event"),
3299 let events = nodes[0].node.get_and_clear_pending_events();
3300 assert_eq!(events.len(), 3);
3302 Event::PaymentFailed { ref payment_hash, .. } => {
3303 assert!(failed_htlcs.insert(payment_hash.0));
3305 _ => panic!("Unexpected event"),
3308 Event::PaymentFailed { ref payment_hash, .. } => {
3309 assert!(failed_htlcs.insert(payment_hash.0));
3311 _ => panic!("Unexpected event"),
3314 Event::PaymentFailed { ref payment_hash, .. } => {
3315 assert!(failed_htlcs.insert(payment_hash.0));
3317 _ => panic!("Unexpected event"),
3320 _ => panic!("Unexpected event"),
3323 assert!(failed_htlcs.contains(&first_payment_hash.0));
3324 assert!(failed_htlcs.contains(&second_payment_hash.0));
3325 assert!(failed_htlcs.contains(&third_payment_hash.0));
3329 fn test_commitment_revoked_fail_backward_exhaustive_a() {
3330 do_test_commitment_revoked_fail_backward_exhaustive(false, true, false);
3331 do_test_commitment_revoked_fail_backward_exhaustive(true, true, false);
3332 do_test_commitment_revoked_fail_backward_exhaustive(false, false, false);
3333 do_test_commitment_revoked_fail_backward_exhaustive(true, false, false);
3337 fn test_commitment_revoked_fail_backward_exhaustive_b() {
3338 do_test_commitment_revoked_fail_backward_exhaustive(false, true, true);
3339 do_test_commitment_revoked_fail_backward_exhaustive(true, true, true);
3340 do_test_commitment_revoked_fail_backward_exhaustive(false, false, true);
3341 do_test_commitment_revoked_fail_backward_exhaustive(true, false, true);
3345 fn fail_backward_pending_htlc_upon_channel_failure() {
3346 let chanmon_cfgs = create_chanmon_cfgs(2);
3347 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3348 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3349 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3350 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1_000_000, 500_000_000, InitFeatures::known(), InitFeatures::known());
3351 let logger = test_utils::TestLogger::new();
3353 // Alice -> Bob: Route a payment but without Bob sending revoke_and_ack.
3355 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1]);
3356 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3357 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 50_000, TEST_FINAL_CLTV, &logger).unwrap();
3358 nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
3359 check_added_monitors!(nodes[0], 1);
3361 let payment_event = {
3362 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3363 assert_eq!(events.len(), 1);
3364 SendEvent::from_event(events.remove(0))
3366 assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
3367 assert_eq!(payment_event.msgs.len(), 1);
3370 // Alice -> Bob: Route another payment but now Alice waits for Bob's earlier revoke_and_ack.
3371 let (_, failed_payment_hash, failed_payment_secret) = get_payment_preimage_hash!(nodes[1]);
3373 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3374 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 50_000, TEST_FINAL_CLTV, &logger).unwrap();
3375 nodes[0].node.send_payment(&route, failed_payment_hash, &Some(failed_payment_secret)).unwrap();
3376 check_added_monitors!(nodes[0], 0);
3378 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3381 // Alice <- Bob: Send a malformed update_add_htlc so Alice fails the channel.
3383 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[0]);
3385 let secp_ctx = Secp256k1::new();
3386 let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
3387 let current_height = nodes[1].node.best_block.read().unwrap().height() + 1;
3388 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
3389 let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[0].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 50_000, TEST_FINAL_CLTV, &logger).unwrap();
3390 let (onion_payloads, _amount_msat, cltv_expiry) = onion_utils::build_onion_payloads(&route.paths[0], 50_000, &Some(payment_secret), current_height).unwrap();
3391 let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route.paths[0], &session_priv).unwrap();
3392 let onion_routing_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
3394 // Send a 0-msat update_add_htlc to fail the channel.
3395 let update_add_htlc = msgs::UpdateAddHTLC {
3401 onion_routing_packet,
3403 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &update_add_htlc);
3406 // Check that Alice fails backward the pending HTLC from the second payment.
3407 expect_payment_failed!(nodes[0], failed_payment_hash, true);
3408 check_closed_broadcast!(nodes[0], true);
3409 check_added_monitors!(nodes[0], 1);
3413 fn test_htlc_ignore_latest_remote_commitment() {
3414 // Test that HTLC transactions spending the latest remote commitment transaction are simply
3415 // ignored if we cannot claim them. This originally tickled an invalid unwrap().
3416 let chanmon_cfgs = create_chanmon_cfgs(2);
3417 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3418 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3419 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3420 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3422 route_payment(&nodes[0], &[&nodes[1]], 10000000);
3423 nodes[0].node.force_close_channel(&nodes[0].node.list_channels()[0].channel_id).unwrap();
3424 connect_blocks(&nodes[0], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + 1);
3425 check_closed_broadcast!(nodes[0], true);
3426 check_added_monitors!(nodes[0], 1);
3428 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
3429 assert_eq!(node_txn.len(), 3);
3430 assert_eq!(node_txn[0], node_txn[1]);
3432 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3433 connect_block(&nodes[1], &Block { header, txdata: vec![node_txn[0].clone(), node_txn[1].clone()]});
3434 check_closed_broadcast!(nodes[1], true);
3435 check_added_monitors!(nodes[1], 1);
3437 // Duplicate the connect_block call since this may happen due to other listeners
3438 // registering new transactions
3439 header.prev_blockhash = header.block_hash();
3440 connect_block(&nodes[1], &Block { header, txdata: vec![node_txn[0].clone(), node_txn[2].clone()]});
3444 fn test_force_close_fail_back() {
3445 // Check which HTLCs are failed-backwards on channel force-closure
3446 let chanmon_cfgs = create_chanmon_cfgs(3);
3447 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3448 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3449 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3450 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3451 create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3452 let logger = test_utils::TestLogger::new();
3454 let (our_payment_preimage, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[2]);
3456 let mut payment_event = {
3457 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3458 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[2].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 1000000, 42, &logger).unwrap();
3459 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
3460 check_added_monitors!(nodes[0], 1);
3462 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3463 assert_eq!(events.len(), 1);
3464 SendEvent::from_event(events.remove(0))
3467 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
3468 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
3470 expect_pending_htlcs_forwardable!(nodes[1]);
3472 let mut events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3473 assert_eq!(events_2.len(), 1);
3474 payment_event = SendEvent::from_event(events_2.remove(0));
3475 assert_eq!(payment_event.msgs.len(), 1);
3477 check_added_monitors!(nodes[1], 1);
3478 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
3479 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg);
3480 check_added_monitors!(nodes[2], 1);
3481 let (_, _) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3483 // nodes[2] now has the latest commitment transaction, but hasn't revoked its previous
3484 // state or updated nodes[1]' state. Now force-close and broadcast that commitment/HTLC
3485 // transaction and ensure nodes[1] doesn't fail-backwards (this was originally a bug!).
3487 nodes[2].node.force_close_channel(&payment_event.commitment_msg.channel_id).unwrap();
3488 check_closed_broadcast!(nodes[2], true);
3489 check_added_monitors!(nodes[2], 1);
3491 let mut node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap();
3492 // Note that we don't bother broadcasting the HTLC-Success transaction here as we don't
3493 // have a use for it unless nodes[2] learns the preimage somehow, the funds will go
3494 // back to nodes[1] upon timeout otherwise.
3495 assert_eq!(node_txn.len(), 1);
3499 mine_transaction(&nodes[1], &tx);
3501 // Note no UpdateHTLCs event here from nodes[1] to nodes[0]!
3502 check_closed_broadcast!(nodes[1], true);
3503 check_added_monitors!(nodes[1], 1);
3505 // Now check that if we add the preimage to ChannelMonitor it broadcasts our HTLC-Success..
3507 let mut monitors = nodes[2].chain_monitor.chain_monitor.monitors.read().unwrap();
3508 monitors.get(&OutPoint{ txid: Txid::from_slice(&payment_event.commitment_msg.channel_id[..]).unwrap(), index: 0 }).unwrap()
3509 .provide_payment_preimage(&our_payment_hash, &our_payment_preimage, &node_cfgs[2].tx_broadcaster, &node_cfgs[2].fee_estimator, &&logger);
3511 mine_transaction(&nodes[2], &tx);
3512 let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap();
3513 assert_eq!(node_txn.len(), 1);
3514 assert_eq!(node_txn[0].input.len(), 1);
3515 assert_eq!(node_txn[0].input[0].previous_output.txid, tx.txid());
3516 assert_eq!(node_txn[0].lock_time, 0); // Must be an HTLC-Success
3517 assert_eq!(node_txn[0].input[0].witness.len(), 5); // Must be an HTLC-Success
3519 check_spends!(node_txn[0], tx);
3523 fn test_dup_events_on_peer_disconnect() {
3524 // Test that if we receive a duplicative update_fulfill_htlc message after a reconnect we do
3525 // not generate a corresponding duplicative PaymentSent event. This did not use to be the case
3526 // as we used to generate the event immediately upon receipt of the payment preimage in the
3527 // update_fulfill_htlc message.
3529 let chanmon_cfgs = create_chanmon_cfgs(2);
3530 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3531 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3532 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3533 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3535 let payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 1000000).0;
3537 assert!(nodes[1].node.claim_funds(payment_preimage));
3538 check_added_monitors!(nodes[1], 1);
3539 let claim_msgs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3540 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &claim_msgs.update_fulfill_htlcs[0]);
3541 expect_payment_sent!(nodes[0], payment_preimage);
3543 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3544 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3546 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (1, 0), (0, 0), (0, 0), (false, false));
3547 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
3551 fn test_simple_peer_disconnect() {
3552 // Test that we can reconnect when there are no lost messages
3553 let chanmon_cfgs = create_chanmon_cfgs(3);
3554 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3555 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3556 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3557 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3558 create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3560 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3561 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3562 reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3564 let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3565 let payment_hash_2 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3566 fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_hash_2);
3567 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_preimage_1);
3569 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3570 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3571 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3573 let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3574 let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3575 let payment_hash_5 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3576 let payment_hash_6 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3578 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3579 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3581 claim_payment_along_route(&nodes[0], &[&[&nodes[1], &nodes[2]]], true, payment_preimage_3);
3582 fail_payment_along_route(&nodes[0], &[&nodes[1], &nodes[2]], true, payment_hash_5);
3584 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (1, 0), (1, 0), (false, false));
3586 let events = nodes[0].node.get_and_clear_pending_events();
3587 assert_eq!(events.len(), 2);
3589 Event::PaymentSent { payment_preimage } => {
3590 assert_eq!(payment_preimage, payment_preimage_3);
3592 _ => panic!("Unexpected event"),
3595 Event::PaymentFailed { payment_hash, rejected_by_dest, .. } => {
3596 assert_eq!(payment_hash, payment_hash_5);
3597 assert!(rejected_by_dest);
3599 _ => panic!("Unexpected event"),
3603 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_preimage_4);
3604 fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_hash_6);
3607 fn do_test_drop_messages_peer_disconnect(messages_delivered: u8, simulate_broken_lnd: bool) {
3608 // Test that we can reconnect when in-flight HTLC updates get dropped
3609 let chanmon_cfgs = create_chanmon_cfgs(2);
3610 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3611 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3612 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3614 let mut as_funding_locked = None;
3615 if messages_delivered == 0 {
3616 let (funding_locked, _, _) = create_chan_between_nodes_with_value_a(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
3617 as_funding_locked = Some(funding_locked);
3618 // nodes[1] doesn't receive the funding_locked message (it'll be re-sent on reconnect)
3619 // Note that we store it so that if we're running with `simulate_broken_lnd` we can deliver
3620 // it before the channel_reestablish message.
3622 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3625 let (payment_preimage_1, payment_hash_1, payment_secret_1) = get_payment_preimage_hash!(nodes[1]);
3627 let logger = test_utils::TestLogger::new();
3628 let payment_event = {
3629 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3630 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(),
3631 &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), Some(&nodes[0].node.list_usable_channels().iter().collect::<Vec<_>>()),
3632 &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
3633 nodes[0].node.send_payment(&route, payment_hash_1, &Some(payment_secret_1)).unwrap();
3634 check_added_monitors!(nodes[0], 1);
3636 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3637 assert_eq!(events.len(), 1);
3638 SendEvent::from_event(events.remove(0))
3640 assert_eq!(nodes[1].node.get_our_node_id(), payment_event.node_id);
3642 if messages_delivered < 2 {
3643 // Drop the payment_event messages, and let them get re-generated in reconnect_nodes!
3645 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
3646 if messages_delivered >= 3 {
3647 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
3648 check_added_monitors!(nodes[1], 1);
3649 let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3651 if messages_delivered >= 4 {
3652 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3653 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3654 check_added_monitors!(nodes[0], 1);
3656 if messages_delivered >= 5 {
3657 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_commitment_signed);
3658 let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3659 // No commitment_signed so get_event_msg's assert(len == 1) passes
3660 check_added_monitors!(nodes[0], 1);
3662 if messages_delivered >= 6 {
3663 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3664 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3665 check_added_monitors!(nodes[1], 1);
3672 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3673 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3674 if messages_delivered < 3 {
3675 if simulate_broken_lnd {
3676 // lnd has a long-standing bug where they send a funding_locked prior to a
3677 // channel_reestablish if you reconnect prior to funding_locked time.
3679 // Here we simulate that behavior, delivering a funding_locked immediately on
3680 // reconnect. Note that we don't bother skipping the now-duplicate funding_locked sent
3681 // in `reconnect_nodes` but we currently don't fail based on that.
3683 // See-also <https://github.com/lightningnetwork/lnd/issues/4006>
3684 nodes[1].node.handle_funding_locked(&nodes[0].node.get_our_node_id(), &as_funding_locked.as_ref().unwrap().0);
3686 // Even if the funding_locked messages get exchanged, as long as nothing further was
3687 // received on either side, both sides will need to resend them.
3688 reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 1), (0, 0), (0, 0), (0, 0), (false, false));
3689 } else if messages_delivered == 3 {
3690 // nodes[0] still wants its RAA + commitment_signed
3691 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (-1, 0), (0, 0), (0, 0), (0, 0), (true, false));
3692 } else if messages_delivered == 4 {
3693 // nodes[0] still wants its commitment_signed
3694 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (-1, 0), (0, 0), (0, 0), (0, 0), (false, false));
3695 } else if messages_delivered == 5 {
3696 // nodes[1] still wants its final RAA
3697 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, true));
3698 } else if messages_delivered == 6 {
3699 // Everything was delivered...
3700 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3703 let events_1 = nodes[1].node.get_and_clear_pending_events();
3704 assert_eq!(events_1.len(), 1);
3706 Event::PendingHTLCsForwardable { .. } => { },
3707 _ => panic!("Unexpected event"),
3710 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3711 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3712 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3714 nodes[1].node.process_pending_htlc_forwards();
3716 let events_2 = nodes[1].node.get_and_clear_pending_events();
3717 assert_eq!(events_2.len(), 1);
3719 Event::PaymentReceived { ref payment_hash, ref payment_preimage, ref payment_secret, amt, user_payment_id: _ } => {
3720 assert_eq!(payment_hash_1, *payment_hash);
3721 assert!(payment_preimage.is_none());
3722 assert_eq!(payment_secret_1, *payment_secret);
3723 assert_eq!(amt, 1000000);
3725 _ => panic!("Unexpected event"),
3728 nodes[1].node.claim_funds(payment_preimage_1);
3729 check_added_monitors!(nodes[1], 1);
3731 let events_3 = nodes[1].node.get_and_clear_pending_msg_events();
3732 assert_eq!(events_3.len(), 1);
3733 let (update_fulfill_htlc, commitment_signed) = match events_3[0] {
3734 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
3735 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3736 assert!(updates.update_add_htlcs.is_empty());
3737 assert!(updates.update_fail_htlcs.is_empty());
3738 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
3739 assert!(updates.update_fail_malformed_htlcs.is_empty());
3740 assert!(updates.update_fee.is_none());
3741 (updates.update_fulfill_htlcs[0].clone(), updates.commitment_signed.clone())
3743 _ => panic!("Unexpected event"),
3746 if messages_delivered >= 1 {
3747 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlc);
3749 let events_4 = nodes[0].node.get_and_clear_pending_events();
3750 assert_eq!(events_4.len(), 1);
3752 Event::PaymentSent { ref payment_preimage } => {
3753 assert_eq!(payment_preimage_1, *payment_preimage);
3755 _ => panic!("Unexpected event"),
3758 if messages_delivered >= 2 {
3759 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
3760 check_added_monitors!(nodes[0], 1);
3761 let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
3763 if messages_delivered >= 3 {
3764 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3765 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3766 check_added_monitors!(nodes[1], 1);
3768 if messages_delivered >= 4 {
3769 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed);
3770 let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3771 // No commitment_signed so get_event_msg's assert(len == 1) passes
3772 check_added_monitors!(nodes[1], 1);
3774 if messages_delivered >= 5 {
3775 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3776 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3777 check_added_monitors!(nodes[0], 1);
3784 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3785 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3786 if messages_delivered < 2 {
3787 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (1, 0), (0, 0), (0, 0), (false, false));
3788 if messages_delivered < 1 {
3789 let events_4 = nodes[0].node.get_and_clear_pending_events();
3790 assert_eq!(events_4.len(), 1);
3792 Event::PaymentSent { ref payment_preimage } => {
3793 assert_eq!(payment_preimage_1, *payment_preimage);
3795 _ => panic!("Unexpected event"),
3798 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3800 } else if messages_delivered == 2 {
3801 // nodes[0] still wants its RAA + commitment_signed
3802 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, -1), (0, 0), (0, 0), (0, 0), (false, true));
3803 } else if messages_delivered == 3 {
3804 // nodes[0] still wants its commitment_signed
3805 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, -1), (0, 0), (0, 0), (0, 0), (false, false));
3806 } else if messages_delivered == 4 {
3807 // nodes[1] still wants its final RAA
3808 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (true, false));
3809 } else if messages_delivered == 5 {
3810 // Everything was delivered...
3811 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3814 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3815 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3816 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3818 // Channel should still work fine...
3819 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3820 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(),
3821 &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), Some(&nodes[0].node.list_usable_channels().iter().collect::<Vec<_>>()),
3822 &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
3823 let payment_preimage_2 = send_along_route(&nodes[0], route, &[&nodes[1]], 1000000).0;
3824 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
3828 fn test_drop_messages_peer_disconnect_a() {
3829 do_test_drop_messages_peer_disconnect(0, true);
3830 do_test_drop_messages_peer_disconnect(0, false);
3831 do_test_drop_messages_peer_disconnect(1, false);
3832 do_test_drop_messages_peer_disconnect(2, false);
3836 fn test_drop_messages_peer_disconnect_b() {
3837 do_test_drop_messages_peer_disconnect(3, false);
3838 do_test_drop_messages_peer_disconnect(4, false);
3839 do_test_drop_messages_peer_disconnect(5, false);
3840 do_test_drop_messages_peer_disconnect(6, false);
3844 fn test_funding_peer_disconnect() {
3845 // Test that we can lock in our funding tx while disconnected
3846 let chanmon_cfgs = create_chanmon_cfgs(2);
3847 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3848 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3849 let persister: test_utils::TestPersister;
3850 let new_chain_monitor: test_utils::TestChainMonitor;
3851 let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
3852 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3853 let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
3855 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3856 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3858 confirm_transaction(&nodes[0], &tx);
3859 let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
3860 assert_eq!(events_1.len(), 1);
3862 MessageSendEvent::SendFundingLocked { ref node_id, msg: _ } => {
3863 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
3865 _ => panic!("Unexpected event"),
3868 reconnect_nodes(&nodes[0], &nodes[1], (false, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3870 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3871 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3873 confirm_transaction(&nodes[1], &tx);
3874 let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3875 assert_eq!(events_2.len(), 2);
3876 let funding_locked = match events_2[0] {
3877 MessageSendEvent::SendFundingLocked { ref node_id, ref msg } => {
3878 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3881 _ => panic!("Unexpected event"),
3883 let bs_announcement_sigs = match events_2[1] {
3884 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
3885 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3888 _ => panic!("Unexpected event"),
3891 reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3893 nodes[0].node.handle_funding_locked(&nodes[1].node.get_our_node_id(), &funding_locked);
3894 nodes[0].node.handle_announcement_signatures(&nodes[1].node.get_our_node_id(), &bs_announcement_sigs);
3895 let events_3 = nodes[0].node.get_and_clear_pending_msg_events();
3896 assert_eq!(events_3.len(), 2);
3897 let as_announcement_sigs = match events_3[0] {
3898 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
3899 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
3902 _ => panic!("Unexpected event"),
3904 let (as_announcement, as_update) = match events_3[1] {
3905 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
3906 (msg.clone(), update_msg.clone())
3908 _ => panic!("Unexpected event"),
3911 nodes[1].node.handle_announcement_signatures(&nodes[0].node.get_our_node_id(), &as_announcement_sigs);
3912 let events_4 = nodes[1].node.get_and_clear_pending_msg_events();
3913 assert_eq!(events_4.len(), 1);
3914 let (_, bs_update) = match events_4[0] {
3915 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
3916 (msg.clone(), update_msg.clone())
3918 _ => panic!("Unexpected event"),
3921 nodes[0].net_graph_msg_handler.handle_channel_announcement(&as_announcement).unwrap();
3922 nodes[0].net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
3923 nodes[0].net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
3925 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3926 let logger = test_utils::TestLogger::new();
3927 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
3928 let (payment_preimage, _, _) = send_along_route(&nodes[0], route, &[&nodes[1]], 1000000);
3929 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage);
3931 // Check that after deserialization and reconnection we can still generate an identical
3932 // channel_announcement from the cached signatures.
3933 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3935 let nodes_0_serialized = nodes[0].node.encode();
3936 let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
3937 nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
3939 persister = test_utils::TestPersister::new();
3940 let keys_manager = &chanmon_cfgs[0].keys_manager;
3941 new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), nodes[0].logger, node_cfgs[0].fee_estimator, &persister, keys_manager);
3942 nodes[0].chain_monitor = &new_chain_monitor;
3943 let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
3944 let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
3945 &mut chan_0_monitor_read, keys_manager).unwrap();
3946 assert!(chan_0_monitor_read.is_empty());
3948 let mut nodes_0_read = &nodes_0_serialized[..];
3949 let (_, nodes_0_deserialized_tmp) = {
3950 let mut channel_monitors = HashMap::new();
3951 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
3952 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
3953 default_config: UserConfig::default(),
3955 fee_estimator: node_cfgs[0].fee_estimator,
3956 chain_monitor: nodes[0].chain_monitor,
3957 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
3958 logger: nodes[0].logger,
3962 nodes_0_deserialized = nodes_0_deserialized_tmp;
3963 assert!(nodes_0_read.is_empty());
3965 assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
3966 nodes[0].node = &nodes_0_deserialized;
3967 check_added_monitors!(nodes[0], 1);
3969 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3971 // as_announcement should be re-generated exactly by broadcast_node_announcement.
3972 nodes[0].node.broadcast_node_announcement([0, 0, 0], [0; 32], Vec::new());
3973 let msgs = nodes[0].node.get_and_clear_pending_msg_events();
3974 let mut found_announcement = false;
3975 for event in msgs.iter() {
3977 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, .. } => {
3978 if *msg == as_announcement { found_announcement = true; }
3980 MessageSendEvent::BroadcastNodeAnnouncement { .. } => {},
3981 _ => panic!("Unexpected event"),
3984 assert!(found_announcement);
3988 fn test_drop_messages_peer_disconnect_dual_htlc() {
3989 // Test that we can handle reconnecting when both sides of a channel have pending
3990 // commitment_updates when we disconnect.
3991 let chanmon_cfgs = create_chanmon_cfgs(2);
3992 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3993 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3994 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3995 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3996 let logger = test_utils::TestLogger::new();
3998 let (payment_preimage_1, _, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
4000 // Now try to send a second payment which will fail to send
4001 let (payment_preimage_2, payment_hash_2, payment_secret_2) = get_payment_preimage_hash!(nodes[1]);
4002 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
4003 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
4004 nodes[0].node.send_payment(&route, payment_hash_2, &Some(payment_secret_2)).unwrap();
4005 check_added_monitors!(nodes[0], 1);
4007 let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
4008 assert_eq!(events_1.len(), 1);
4010 MessageSendEvent::UpdateHTLCs { .. } => {},
4011 _ => panic!("Unexpected event"),
4014 assert!(nodes[1].node.claim_funds(payment_preimage_1));
4015 check_added_monitors!(nodes[1], 1);
4017 let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
4018 assert_eq!(events_2.len(), 1);
4020 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 } } => {
4021 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
4022 assert!(update_add_htlcs.is_empty());
4023 assert_eq!(update_fulfill_htlcs.len(), 1);
4024 assert!(update_fail_htlcs.is_empty());
4025 assert!(update_fail_malformed_htlcs.is_empty());
4026 assert!(update_fee.is_none());
4028 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlcs[0]);
4029 let events_3 = nodes[0].node.get_and_clear_pending_events();
4030 assert_eq!(events_3.len(), 1);
4032 Event::PaymentSent { ref payment_preimage } => {
4033 assert_eq!(*payment_preimage, payment_preimage_1);
4035 _ => panic!("Unexpected event"),
4038 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), commitment_signed);
4039 let _ = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
4040 // No commitment_signed so get_event_msg's assert(len == 1) passes
4041 check_added_monitors!(nodes[0], 1);
4043 _ => panic!("Unexpected event"),
4046 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
4047 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4049 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4050 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
4051 assert_eq!(reestablish_1.len(), 1);
4052 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4053 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
4054 assert_eq!(reestablish_2.len(), 1);
4056 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
4057 let as_resp = handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
4058 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
4059 let bs_resp = handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
4061 assert!(as_resp.0.is_none());
4062 assert!(bs_resp.0.is_none());
4064 assert!(bs_resp.1.is_none());
4065 assert!(bs_resp.2.is_none());
4067 assert!(as_resp.3 == RAACommitmentOrder::CommitmentFirst);
4069 assert_eq!(as_resp.2.as_ref().unwrap().update_add_htlcs.len(), 1);
4070 assert!(as_resp.2.as_ref().unwrap().update_fulfill_htlcs.is_empty());
4071 assert!(as_resp.2.as_ref().unwrap().update_fail_htlcs.is_empty());
4072 assert!(as_resp.2.as_ref().unwrap().update_fail_malformed_htlcs.is_empty());
4073 assert!(as_resp.2.as_ref().unwrap().update_fee.is_none());
4074 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &as_resp.2.as_ref().unwrap().update_add_htlcs[0]);
4075 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_resp.2.as_ref().unwrap().commitment_signed);
4076 let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
4077 // No commitment_signed so get_event_msg's assert(len == 1) passes
4078 check_added_monitors!(nodes[1], 1);
4080 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), as_resp.1.as_ref().unwrap());
4081 let bs_second_commitment_signed = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4082 assert!(bs_second_commitment_signed.update_add_htlcs.is_empty());
4083 assert!(bs_second_commitment_signed.update_fulfill_htlcs.is_empty());
4084 assert!(bs_second_commitment_signed.update_fail_htlcs.is_empty());
4085 assert!(bs_second_commitment_signed.update_fail_malformed_htlcs.is_empty());
4086 assert!(bs_second_commitment_signed.update_fee.is_none());
4087 check_added_monitors!(nodes[1], 1);
4089 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
4090 let as_commitment_signed = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
4091 assert!(as_commitment_signed.update_add_htlcs.is_empty());
4092 assert!(as_commitment_signed.update_fulfill_htlcs.is_empty());
4093 assert!(as_commitment_signed.update_fail_htlcs.is_empty());
4094 assert!(as_commitment_signed.update_fail_malformed_htlcs.is_empty());
4095 assert!(as_commitment_signed.update_fee.is_none());
4096 check_added_monitors!(nodes[0], 1);
4098 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_commitment_signed.commitment_signed);
4099 let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
4100 // No commitment_signed so get_event_msg's assert(len == 1) passes
4101 check_added_monitors!(nodes[0], 1);
4103 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed.commitment_signed);
4104 let bs_second_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
4105 // No commitment_signed so get_event_msg's assert(len == 1) passes
4106 check_added_monitors!(nodes[1], 1);
4108 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
4109 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4110 check_added_monitors!(nodes[1], 1);
4112 expect_pending_htlcs_forwardable!(nodes[1]);
4114 let events_5 = nodes[1].node.get_and_clear_pending_events();
4115 assert_eq!(events_5.len(), 1);
4117 Event::PaymentReceived { ref payment_hash, ref payment_preimage, ref payment_secret, amt: _, user_payment_id: _ } => {
4118 assert_eq!(payment_hash_2, *payment_hash);
4119 assert!(payment_preimage.is_none());
4120 assert_eq!(payment_secret_2, *payment_secret);
4122 _ => panic!("Unexpected event"),
4125 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke_and_ack);
4126 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4127 check_added_monitors!(nodes[0], 1);
4129 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
4132 fn do_test_htlc_timeout(send_partial_mpp: bool) {
4133 // If the user fails to claim/fail an HTLC within the HTLC CLTV timeout we fail it for them
4134 // to avoid our counterparty failing the channel.
4135 let chanmon_cfgs = create_chanmon_cfgs(2);
4136 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4137 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4138 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4140 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4141 let logger = test_utils::TestLogger::new();
4143 let our_payment_hash = if send_partial_mpp {
4144 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
4145 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
4146 let (_, our_payment_hash, payment_secret) = get_payment_preimage_hash!(&nodes[1]);
4147 // Use the utility function send_payment_along_path to send the payment with MPP data which
4148 // indicates there are more HTLCs coming.
4149 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.
4150 nodes[0].node.send_payment_along_path(&route.paths[0], &our_payment_hash, &Some(payment_secret), 200000, cur_height).unwrap();
4151 check_added_monitors!(nodes[0], 1);
4152 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
4153 assert_eq!(events.len(), 1);
4154 // Now do the relevant commitment_signed/RAA dances along the path, noting that the final
4155 // hop should *not* yet generate any PaymentReceived event(s).
4156 pass_along_path(&nodes[0], &[&nodes[1]], 100000, our_payment_hash, payment_secret, events.drain(..).next().unwrap(), false);
4159 route_payment(&nodes[0], &[&nodes[1]], 100000).1
4162 let mut block = Block {
4163 header: BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
4166 connect_block(&nodes[0], &block);
4167 connect_block(&nodes[1], &block);
4168 let block_count = TEST_FINAL_CLTV + CHAN_CONFIRM_DEPTH + 2 - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS;
4169 for _ in CHAN_CONFIRM_DEPTH + 2..block_count {
4170 block.header.prev_blockhash = block.block_hash();
4171 connect_block(&nodes[0], &block);
4172 connect_block(&nodes[1], &block);
4175 expect_pending_htlcs_forwardable!(nodes[1]);
4177 check_added_monitors!(nodes[1], 1);
4178 let htlc_timeout_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4179 assert!(htlc_timeout_updates.update_add_htlcs.is_empty());
4180 assert_eq!(htlc_timeout_updates.update_fail_htlcs.len(), 1);
4181 assert!(htlc_timeout_updates.update_fail_malformed_htlcs.is_empty());
4182 assert!(htlc_timeout_updates.update_fee.is_none());
4184 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_timeout_updates.update_fail_htlcs[0]);
4185 commitment_signed_dance!(nodes[0], nodes[1], htlc_timeout_updates.commitment_signed, false);
4186 // 100_000 msat as u64, followed by the height at which we failed back above
4187 let mut expected_failure_data = byte_utils::be64_to_array(100_000).to_vec();
4188 expected_failure_data.extend_from_slice(&byte_utils::be32_to_array(block_count - 1));
4189 expect_payment_failed!(nodes[0], our_payment_hash, true, 0x4000 | 15, &expected_failure_data[..]);
4193 fn test_htlc_timeout() {
4194 do_test_htlc_timeout(true);
4195 do_test_htlc_timeout(false);
4198 fn do_test_holding_cell_htlc_add_timeouts(forwarded_htlc: bool) {
4199 // Tests that HTLCs in the holding cell are timed out after the requisite number of blocks.
4200 let chanmon_cfgs = create_chanmon_cfgs(3);
4201 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
4202 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
4203 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
4204 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4205 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
4207 // Make sure all nodes are at the same starting height
4208 connect_blocks(&nodes[0], 2*CHAN_CONFIRM_DEPTH + 1 - nodes[0].best_block_info().1);
4209 connect_blocks(&nodes[1], 2*CHAN_CONFIRM_DEPTH + 1 - nodes[1].best_block_info().1);
4210 connect_blocks(&nodes[2], 2*CHAN_CONFIRM_DEPTH + 1 - nodes[2].best_block_info().1);
4212 let logger = test_utils::TestLogger::new();
4214 // Route a first payment to get the 1 -> 2 channel in awaiting_raa...
4215 let (_, first_payment_hash, first_payment_secret) = get_payment_preimage_hash!(nodes[2]);
4217 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
4218 let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[2].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
4219 nodes[1].node.send_payment(&route, first_payment_hash, &Some(first_payment_secret)).unwrap();
4221 assert_eq!(nodes[1].node.get_and_clear_pending_msg_events().len(), 1);
4222 check_added_monitors!(nodes[1], 1);
4224 // Now attempt to route a second payment, which should be placed in the holding cell
4225 let (_, second_payment_hash, second_payment_secret) = get_payment_preimage_hash!(nodes[2]);
4227 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
4228 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[2].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
4229 nodes[0].node.send_payment(&route, second_payment_hash, &Some(first_payment_secret)).unwrap();
4230 check_added_monitors!(nodes[0], 1);
4231 let payment_event = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
4232 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
4233 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
4234 expect_pending_htlcs_forwardable!(nodes[1]);
4235 check_added_monitors!(nodes[1], 0);
4237 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
4238 let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[2].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
4239 nodes[1].node.send_payment(&route, second_payment_hash, &Some(second_payment_secret)).unwrap();
4240 check_added_monitors!(nodes[1], 0);
4243 connect_blocks(&nodes[1], TEST_FINAL_CLTV - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS);
4244 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4245 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
4246 connect_blocks(&nodes[1], 1);
4249 expect_pending_htlcs_forwardable!(nodes[1]);
4250 check_added_monitors!(nodes[1], 1);
4251 let fail_commit = nodes[1].node.get_and_clear_pending_msg_events();
4252 assert_eq!(fail_commit.len(), 1);
4253 match fail_commit[0] {
4254 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fail_htlcs, ref commitment_signed, .. }, .. } => {
4255 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
4256 commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, true, true);
4258 _ => unreachable!(),
4260 expect_payment_failed!(nodes[0], second_payment_hash, false);
4261 expect_payment_failure_chan_update!(nodes[0], chan_2.0.contents.short_channel_id, false);
4263 expect_payment_failed!(nodes[1], second_payment_hash, true);
4268 fn test_holding_cell_htlc_add_timeouts() {
4269 do_test_holding_cell_htlc_add_timeouts(false);
4270 do_test_holding_cell_htlc_add_timeouts(true);
4274 fn test_invalid_channel_announcement() {
4275 //Test BOLT 7 channel_announcement msg requirement for final node, gather data to build customed channel_announcement msgs
4276 let secp_ctx = Secp256k1::new();
4277 let chanmon_cfgs = create_chanmon_cfgs(2);
4278 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4279 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4280 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4282 let chan_announcement = create_chan_between_nodes(&nodes[0], &nodes[1], InitFeatures::known(), InitFeatures::known());
4284 let a_channel_lock = nodes[0].node.channel_state.lock().unwrap();
4285 let b_channel_lock = nodes[1].node.channel_state.lock().unwrap();
4286 let as_chan = a_channel_lock.by_id.get(&chan_announcement.3).unwrap();
4287 let bs_chan = b_channel_lock.by_id.get(&chan_announcement.3).unwrap();
4289 nodes[0].net_graph_msg_handler.handle_htlc_fail_channel_update(&msgs::HTLCFailChannelUpdate::ChannelClosed { short_channel_id : as_chan.get_short_channel_id().unwrap(), is_permanent: false } );
4291 let as_bitcoin_key = as_chan.get_signer().inner.holder_channel_pubkeys.funding_pubkey;
4292 let bs_bitcoin_key = bs_chan.get_signer().inner.holder_channel_pubkeys.funding_pubkey;
4294 let as_network_key = nodes[0].node.get_our_node_id();
4295 let bs_network_key = nodes[1].node.get_our_node_id();
4297 let were_node_one = as_bitcoin_key.serialize()[..] < bs_bitcoin_key.serialize()[..];
4299 let mut chan_announcement;
4301 macro_rules! dummy_unsigned_msg {
4303 msgs::UnsignedChannelAnnouncement {
4304 features: ChannelFeatures::known(),
4305 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
4306 short_channel_id: as_chan.get_short_channel_id().unwrap(),
4307 node_id_1: if were_node_one { as_network_key } else { bs_network_key },
4308 node_id_2: if were_node_one { bs_network_key } else { as_network_key },
4309 bitcoin_key_1: if were_node_one { as_bitcoin_key } else { bs_bitcoin_key },
4310 bitcoin_key_2: if were_node_one { bs_bitcoin_key } else { as_bitcoin_key },
4311 excess_data: Vec::new(),
4316 macro_rules! sign_msg {
4317 ($unsigned_msg: expr) => {
4318 let msghash = Message::from_slice(&Sha256dHash::hash(&$unsigned_msg.encode()[..])[..]).unwrap();
4319 let as_bitcoin_sig = secp_ctx.sign(&msghash, &as_chan.get_signer().inner.funding_key);
4320 let bs_bitcoin_sig = secp_ctx.sign(&msghash, &bs_chan.get_signer().inner.funding_key);
4321 let as_node_sig = secp_ctx.sign(&msghash, &nodes[0].keys_manager.get_node_secret());
4322 let bs_node_sig = secp_ctx.sign(&msghash, &nodes[1].keys_manager.get_node_secret());
4323 chan_announcement = msgs::ChannelAnnouncement {
4324 node_signature_1 : if were_node_one { as_node_sig } else { bs_node_sig},
4325 node_signature_2 : if were_node_one { bs_node_sig } else { as_node_sig},
4326 bitcoin_signature_1: if were_node_one { as_bitcoin_sig } else { bs_bitcoin_sig },
4327 bitcoin_signature_2 : if were_node_one { bs_bitcoin_sig } else { as_bitcoin_sig },
4328 contents: $unsigned_msg
4333 let unsigned_msg = dummy_unsigned_msg!();
4334 sign_msg!(unsigned_msg);
4335 assert_eq!(nodes[0].net_graph_msg_handler.handle_channel_announcement(&chan_announcement).unwrap(), true);
4336 let _ = nodes[0].net_graph_msg_handler.handle_htlc_fail_channel_update(&msgs::HTLCFailChannelUpdate::ChannelClosed { short_channel_id : as_chan.get_short_channel_id().unwrap(), is_permanent: false } );
4338 // Configured with Network::Testnet
4339 let mut unsigned_msg = dummy_unsigned_msg!();
4340 unsigned_msg.chain_hash = genesis_block(Network::Bitcoin).header.block_hash();
4341 sign_msg!(unsigned_msg);
4342 assert!(nodes[0].net_graph_msg_handler.handle_channel_announcement(&chan_announcement).is_err());
4344 let mut unsigned_msg = dummy_unsigned_msg!();
4345 unsigned_msg.chain_hash = BlockHash::hash(&[1,2,3,4,5,6,7,8,9]);
4346 sign_msg!(unsigned_msg);
4347 assert!(nodes[0].net_graph_msg_handler.handle_channel_announcement(&chan_announcement).is_err());
4351 fn test_no_txn_manager_serialize_deserialize() {
4352 let chanmon_cfgs = create_chanmon_cfgs(2);
4353 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4354 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4355 let logger: test_utils::TestLogger;
4356 let fee_estimator: test_utils::TestFeeEstimator;
4357 let persister: test_utils::TestPersister;
4358 let new_chain_monitor: test_utils::TestChainMonitor;
4359 let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4360 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4362 let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
4364 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4366 let nodes_0_serialized = nodes[0].node.encode();
4367 let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4368 nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
4370 logger = test_utils::TestLogger::new();
4371 fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
4372 persister = test_utils::TestPersister::new();
4373 let keys_manager = &chanmon_cfgs[0].keys_manager;
4374 new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator, &persister, keys_manager);
4375 nodes[0].chain_monitor = &new_chain_monitor;
4376 let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4377 let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
4378 &mut chan_0_monitor_read, keys_manager).unwrap();
4379 assert!(chan_0_monitor_read.is_empty());
4381 let mut nodes_0_read = &nodes_0_serialized[..];
4382 let config = UserConfig::default();
4383 let (_, nodes_0_deserialized_tmp) = {
4384 let mut channel_monitors = HashMap::new();
4385 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4386 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4387 default_config: config,
4389 fee_estimator: &fee_estimator,
4390 chain_monitor: nodes[0].chain_monitor,
4391 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4396 nodes_0_deserialized = nodes_0_deserialized_tmp;
4397 assert!(nodes_0_read.is_empty());
4399 assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4400 nodes[0].node = &nodes_0_deserialized;
4401 assert_eq!(nodes[0].node.list_channels().len(), 1);
4402 check_added_monitors!(nodes[0], 1);
4404 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4405 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
4406 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4407 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
4409 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
4410 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4411 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
4412 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4414 let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
4415 let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
4416 for node in nodes.iter() {
4417 assert!(node.net_graph_msg_handler.handle_channel_announcement(&announcement).unwrap());
4418 node.net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
4419 node.net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
4422 send_payment(&nodes[0], &[&nodes[1]], 1000000);
4426 fn test_dup_htlc_onchain_fails_on_reload() {
4427 // When a Channel is closed, any outbound HTLCs which were relayed through it are simply
4428 // dropped when the Channel is. From there, the ChannelManager relies on the ChannelMonitor
4429 // having a copy of the relevant fail-/claim-back data and processes the HTLC fail/claim when
4430 // the ChannelMonitor tells it to.
4432 // If, due to an on-chain event, an HTLC is failed/claimed, and then we serialize the
4433 // ChannelManager, we generally expect there not to be a duplicate HTLC fail/claim (eg via a
4434 // PaymentFailed event appearing). However, because we may not serialize the relevant
4435 // ChannelMonitor at the same time, this isn't strictly guaranteed. In order to provide this
4436 // consistency, the ChannelManager explicitly tracks pending-onchain-resolution outbound HTLCs
4437 // and de-duplicates ChannelMonitor events.
4439 // This tests that explicit tracking behavior.
4440 let chanmon_cfgs = create_chanmon_cfgs(2);
4441 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4442 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4443 let persister: test_utils::TestPersister;
4444 let new_chain_monitor: test_utils::TestChainMonitor;
4445 let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4446 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4448 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4450 // Route a payment, but force-close the channel before the HTLC fulfill message arrives at
4452 let (payment_preimage, _, _) = route_payment(&nodes[0], &[&nodes[1]], 10000000);
4453 nodes[0].node.force_close_channel(&nodes[0].node.list_channels()[0].channel_id).unwrap();
4454 check_closed_broadcast!(nodes[0], true);
4455 check_added_monitors!(nodes[0], 1);
4457 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
4458 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4460 // Connect blocks until the CLTV timeout is up so that we get an HTLC-Timeout transaction
4461 connect_blocks(&nodes[0], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + 1);
4462 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
4463 assert_eq!(node_txn.len(), 3);
4464 assert_eq!(node_txn[0], node_txn[1]);
4466 assert!(nodes[1].node.claim_funds(payment_preimage));
4467 check_added_monitors!(nodes[1], 1);
4469 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4470 connect_block(&nodes[1], &Block { header, txdata: vec![node_txn[1].clone(), node_txn[2].clone()]});
4471 check_closed_broadcast!(nodes[1], true);
4472 check_added_monitors!(nodes[1], 1);
4473 let claim_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
4475 header.prev_blockhash = nodes[0].best_block_hash();
4476 connect_block(&nodes[0], &Block { header, txdata: vec![node_txn[1].clone(), node_txn[2].clone()]});
4478 // Serialize out the ChannelMonitor before connecting the on-chain claim transactions. This is
4479 // fairly normal behavior as ChannelMonitor(s) are often not re-serialized when on-chain events
4480 // happen, unlike ChannelManager which tends to be re-serialized after any relevant event(s).
4481 let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4482 nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
4484 header.prev_blockhash = nodes[0].best_block_hash();
4485 let claim_block = Block { header, txdata: claim_txn};
4486 connect_block(&nodes[0], &claim_block);
4487 expect_payment_sent!(nodes[0], payment_preimage);
4489 // ChannelManagers generally get re-serialized after any relevant event(s). Since we just
4490 // connected a highly-relevant block, it likely gets serialized out now.
4491 let mut chan_manager_serialized = test_utils::TestVecWriter(Vec::new());
4492 nodes[0].node.write(&mut chan_manager_serialized).unwrap();
4494 // Now reload nodes[0]...
4495 persister = test_utils::TestPersister::new();
4496 let keys_manager = &chanmon_cfgs[0].keys_manager;
4497 new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), nodes[0].logger, node_cfgs[0].fee_estimator, &persister, keys_manager);
4498 nodes[0].chain_monitor = &new_chain_monitor;
4499 let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4500 let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
4501 &mut chan_0_monitor_read, keys_manager).unwrap();
4502 assert!(chan_0_monitor_read.is_empty());
4504 let (_, nodes_0_deserialized_tmp) = {
4505 let mut channel_monitors = HashMap::new();
4506 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4507 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>
4508 ::read(&mut std::io::Cursor::new(&chan_manager_serialized.0[..]), ChannelManagerReadArgs {
4509 default_config: Default::default(),
4511 fee_estimator: node_cfgs[0].fee_estimator,
4512 chain_monitor: nodes[0].chain_monitor,
4513 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4514 logger: nodes[0].logger,
4518 nodes_0_deserialized = nodes_0_deserialized_tmp;
4520 assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4521 check_added_monitors!(nodes[0], 1);
4522 nodes[0].node = &nodes_0_deserialized;
4524 // Note that if we re-connect the block which exposed nodes[0] to the payment preimage (but
4525 // which the current ChannelMonitor has not seen), the ChannelManager's de-duplication of
4526 // payment events should kick in, leaving us with no pending events here.
4527 let height = nodes[0].blocks.lock().unwrap().len() as u32 - 1;
4528 nodes[0].chain_monitor.chain_monitor.block_connected(&claim_block, height);
4529 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
4533 fn test_manager_serialize_deserialize_events() {
4534 // This test makes sure the events field in ChannelManager survives de/serialization
4535 let chanmon_cfgs = create_chanmon_cfgs(2);
4536 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4537 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4538 let fee_estimator: test_utils::TestFeeEstimator;
4539 let persister: test_utils::TestPersister;
4540 let logger: test_utils::TestLogger;
4541 let new_chain_monitor: test_utils::TestChainMonitor;
4542 let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4543 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4545 // Start creating a channel, but stop right before broadcasting the funding transaction
4546 let channel_value = 100000;
4547 let push_msat = 10001;
4548 let a_flags = InitFeatures::known();
4549 let b_flags = InitFeatures::known();
4550 let node_a = nodes.remove(0);
4551 let node_b = nodes.remove(0);
4552 node_a.node.create_channel(node_b.node.get_our_node_id(), channel_value, push_msat, 42, None).unwrap();
4553 node_b.node.handle_open_channel(&node_a.node.get_our_node_id(), a_flags, &get_event_msg!(node_a, MessageSendEvent::SendOpenChannel, node_b.node.get_our_node_id()));
4554 node_a.node.handle_accept_channel(&node_b.node.get_our_node_id(), b_flags, &get_event_msg!(node_b, MessageSendEvent::SendAcceptChannel, node_a.node.get_our_node_id()));
4556 let (temporary_channel_id, tx, funding_output) = create_funding_transaction(&node_a, channel_value, 42);
4558 node_a.node.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
4559 check_added_monitors!(node_a, 0);
4561 node_b.node.handle_funding_created(&node_a.node.get_our_node_id(), &get_event_msg!(node_a, MessageSendEvent::SendFundingCreated, node_b.node.get_our_node_id()));
4563 let mut added_monitors = node_b.chain_monitor.added_monitors.lock().unwrap();
4564 assert_eq!(added_monitors.len(), 1);
4565 assert_eq!(added_monitors[0].0, funding_output);
4566 added_monitors.clear();
4569 node_a.node.handle_funding_signed(&node_b.node.get_our_node_id(), &get_event_msg!(node_b, MessageSendEvent::SendFundingSigned, node_a.node.get_our_node_id()));
4571 let mut added_monitors = node_a.chain_monitor.added_monitors.lock().unwrap();
4572 assert_eq!(added_monitors.len(), 1);
4573 assert_eq!(added_monitors[0].0, funding_output);
4574 added_monitors.clear();
4576 // Normally, this is where node_a would broadcast the funding transaction, but the test de/serializes first instead
4581 // Start the de/seriailization process mid-channel creation to check that the channel manager will hold onto events that are serialized
4582 let nodes_0_serialized = nodes[0].node.encode();
4583 let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4584 nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
4586 fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
4587 logger = test_utils::TestLogger::new();
4588 persister = test_utils::TestPersister::new();
4589 let keys_manager = &chanmon_cfgs[0].keys_manager;
4590 new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator, &persister, keys_manager);
4591 nodes[0].chain_monitor = &new_chain_monitor;
4592 let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4593 let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
4594 &mut chan_0_monitor_read, keys_manager).unwrap();
4595 assert!(chan_0_monitor_read.is_empty());
4597 let mut nodes_0_read = &nodes_0_serialized[..];
4598 let config = UserConfig::default();
4599 let (_, nodes_0_deserialized_tmp) = {
4600 let mut channel_monitors = HashMap::new();
4601 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4602 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4603 default_config: config,
4605 fee_estimator: &fee_estimator,
4606 chain_monitor: nodes[0].chain_monitor,
4607 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4612 nodes_0_deserialized = nodes_0_deserialized_tmp;
4613 assert!(nodes_0_read.is_empty());
4615 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4617 assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4618 nodes[0].node = &nodes_0_deserialized;
4620 // After deserializing, make sure the funding_transaction is still held by the channel manager
4621 let events_4 = nodes[0].node.get_and_clear_pending_events();
4622 assert_eq!(events_4.len(), 0);
4623 assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
4624 assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0].txid(), funding_output.txid);
4626 // Make sure the channel is functioning as though the de/serialization never happened
4627 assert_eq!(nodes[0].node.list_channels().len(), 1);
4628 check_added_monitors!(nodes[0], 1);
4630 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4631 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
4632 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4633 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
4635 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
4636 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4637 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
4638 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4640 let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
4641 let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
4642 for node in nodes.iter() {
4643 assert!(node.net_graph_msg_handler.handle_channel_announcement(&announcement).unwrap());
4644 node.net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
4645 node.net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
4648 send_payment(&nodes[0], &[&nodes[1]], 1000000);
4652 fn test_simple_manager_serialize_deserialize() {
4653 let chanmon_cfgs = create_chanmon_cfgs(2);
4654 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4655 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4656 let logger: test_utils::TestLogger;
4657 let fee_estimator: test_utils::TestFeeEstimator;
4658 let persister: test_utils::TestPersister;
4659 let new_chain_monitor: test_utils::TestChainMonitor;
4660 let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4661 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4662 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4664 let (our_payment_preimage, _, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
4665 let (_, our_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
4667 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4669 let nodes_0_serialized = nodes[0].node.encode();
4670 let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4671 nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
4673 logger = test_utils::TestLogger::new();
4674 fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
4675 persister = test_utils::TestPersister::new();
4676 let keys_manager = &chanmon_cfgs[0].keys_manager;
4677 new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator, &persister, keys_manager);
4678 nodes[0].chain_monitor = &new_chain_monitor;
4679 let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4680 let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
4681 &mut chan_0_monitor_read, keys_manager).unwrap();
4682 assert!(chan_0_monitor_read.is_empty());
4684 let mut nodes_0_read = &nodes_0_serialized[..];
4685 let (_, nodes_0_deserialized_tmp) = {
4686 let mut channel_monitors = HashMap::new();
4687 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4688 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4689 default_config: UserConfig::default(),
4691 fee_estimator: &fee_estimator,
4692 chain_monitor: nodes[0].chain_monitor,
4693 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4698 nodes_0_deserialized = nodes_0_deserialized_tmp;
4699 assert!(nodes_0_read.is_empty());
4701 assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4702 nodes[0].node = &nodes_0_deserialized;
4703 check_added_monitors!(nodes[0], 1);
4705 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
4707 fail_payment(&nodes[0], &[&nodes[1]], our_payment_hash);
4708 claim_payment(&nodes[0], &[&nodes[1]], our_payment_preimage);
4712 fn test_manager_serialize_deserialize_inconsistent_monitor() {
4713 // Test deserializing a ChannelManager with an out-of-date ChannelMonitor
4714 let chanmon_cfgs = create_chanmon_cfgs(4);
4715 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
4716 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
4717 let logger: test_utils::TestLogger;
4718 let fee_estimator: test_utils::TestFeeEstimator;
4719 let persister: test_utils::TestPersister;
4720 let new_chain_monitor: test_utils::TestChainMonitor;
4721 let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4722 let mut nodes = create_network(4, &node_cfgs, &node_chanmgrs);
4723 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4724 create_announced_chan_between_nodes(&nodes, 2, 0, InitFeatures::known(), InitFeatures::known());
4725 let (_, _, channel_id, funding_tx) = create_announced_chan_between_nodes(&nodes, 0, 3, InitFeatures::known(), InitFeatures::known());
4727 let mut node_0_stale_monitors_serialized = Vec::new();
4728 for monitor in nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter() {
4729 let mut writer = test_utils::TestVecWriter(Vec::new());
4730 monitor.1.write(&mut writer).unwrap();
4731 node_0_stale_monitors_serialized.push(writer.0);
4734 let (our_payment_preimage, _, _) = route_payment(&nodes[2], &[&nodes[0], &nodes[1]], 1000000);
4736 // Serialize the ChannelManager here, but the monitor we keep up-to-date
4737 let nodes_0_serialized = nodes[0].node.encode();
4739 route_payment(&nodes[0], &[&nodes[3]], 1000000);
4740 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4741 nodes[2].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4742 nodes[3].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4744 // Now the ChannelMonitor (which is now out-of-sync with ChannelManager for channel w/
4746 let mut node_0_monitors_serialized = Vec::new();
4747 for monitor in nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter() {
4748 let mut writer = test_utils::TestVecWriter(Vec::new());
4749 monitor.1.write(&mut writer).unwrap();
4750 node_0_monitors_serialized.push(writer.0);
4753 logger = test_utils::TestLogger::new();
4754 fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
4755 persister = test_utils::TestPersister::new();
4756 let keys_manager = &chanmon_cfgs[0].keys_manager;
4757 new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator, &persister, keys_manager);
4758 nodes[0].chain_monitor = &new_chain_monitor;
4761 let mut node_0_stale_monitors = Vec::new();
4762 for serialized in node_0_stale_monitors_serialized.iter() {
4763 let mut read = &serialized[..];
4764 let (_, monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(&mut read, keys_manager).unwrap();
4765 assert!(read.is_empty());
4766 node_0_stale_monitors.push(monitor);
4769 let mut node_0_monitors = Vec::new();
4770 for serialized in node_0_monitors_serialized.iter() {
4771 let mut read = &serialized[..];
4772 let (_, monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(&mut read, keys_manager).unwrap();
4773 assert!(read.is_empty());
4774 node_0_monitors.push(monitor);
4777 let mut nodes_0_read = &nodes_0_serialized[..];
4778 if let Err(msgs::DecodeError::InvalidValue) =
4779 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4780 default_config: UserConfig::default(),
4782 fee_estimator: &fee_estimator,
4783 chain_monitor: nodes[0].chain_monitor,
4784 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4786 channel_monitors: node_0_stale_monitors.iter_mut().map(|monitor| { (monitor.get_funding_txo().0, monitor) }).collect(),
4788 panic!("If the monitor(s) are stale, this indicates a bug and we should get an Err return");
4791 let mut nodes_0_read = &nodes_0_serialized[..];
4792 let (_, nodes_0_deserialized_tmp) =
4793 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4794 default_config: UserConfig::default(),
4796 fee_estimator: &fee_estimator,
4797 chain_monitor: nodes[0].chain_monitor,
4798 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4800 channel_monitors: node_0_monitors.iter_mut().map(|monitor| { (monitor.get_funding_txo().0, monitor) }).collect(),
4802 nodes_0_deserialized = nodes_0_deserialized_tmp;
4803 assert!(nodes_0_read.is_empty());
4805 { // Channel close should result in a commitment tx
4806 let txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4807 assert_eq!(txn.len(), 1);
4808 check_spends!(txn[0], funding_tx);
4809 assert_eq!(txn[0].input[0].previous_output.txid, funding_tx.txid());
4812 for monitor in node_0_monitors.drain(..) {
4813 assert!(nodes[0].chain_monitor.watch_channel(monitor.get_funding_txo().0, monitor).is_ok());
4814 check_added_monitors!(nodes[0], 1);
4816 nodes[0].node = &nodes_0_deserialized;
4818 // nodes[1] and nodes[2] have no lost state with nodes[0]...
4819 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
4820 reconnect_nodes(&nodes[0], &nodes[2], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
4821 //... and we can even still claim the payment!
4822 claim_payment(&nodes[2], &[&nodes[0], &nodes[1]], our_payment_preimage);
4824 nodes[3].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4825 let reestablish = get_event_msg!(nodes[3], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
4826 nodes[0].node.peer_connected(&nodes[3].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4827 nodes[0].node.handle_channel_reestablish(&nodes[3].node.get_our_node_id(), &reestablish);
4828 let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
4829 assert_eq!(msg_events.len(), 1);
4830 if let MessageSendEvent::HandleError { ref action, .. } = msg_events[0] {
4832 &ErrorAction::SendErrorMessage { ref msg } => {
4833 assert_eq!(msg.channel_id, channel_id);
4835 _ => panic!("Unexpected event!"),
4840 macro_rules! check_spendable_outputs {
4841 ($node: expr, $keysinterface: expr) => {
4843 let mut events = $node.chain_monitor.chain_monitor.get_and_clear_pending_events();
4844 let mut txn = Vec::new();
4845 let mut all_outputs = Vec::new();
4846 let secp_ctx = Secp256k1::new();
4847 for event in events.drain(..) {
4849 Event::SpendableOutputs { mut outputs } => {
4850 for outp in outputs.drain(..) {
4851 txn.push($keysinterface.backing.spend_spendable_outputs(&[&outp], Vec::new(), Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(), 253, &secp_ctx).unwrap());
4852 all_outputs.push(outp);
4855 _ => panic!("Unexpected event"),
4858 if all_outputs.len() > 1 {
4859 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, &secp_ctx) {
4869 fn test_claim_sizeable_push_msat() {
4870 // Incidentally test SpendableOutput event generation due to detection of to_local output on commitment tx
4871 let chanmon_cfgs = create_chanmon_cfgs(2);
4872 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4873 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4874 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4876 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 99000000, InitFeatures::known(), InitFeatures::known());
4877 nodes[1].node.force_close_channel(&chan.2).unwrap();
4878 check_closed_broadcast!(nodes[1], true);
4879 check_added_monitors!(nodes[1], 1);
4880 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4881 assert_eq!(node_txn.len(), 1);
4882 check_spends!(node_txn[0], chan.3);
4883 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
4885 mine_transaction(&nodes[1], &node_txn[0]);
4886 connect_blocks(&nodes[1], BREAKDOWN_TIMEOUT as u32 - 1);
4888 let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
4889 assert_eq!(spend_txn.len(), 1);
4890 assert_eq!(spend_txn[0].input.len(), 1);
4891 check_spends!(spend_txn[0], node_txn[0]);
4892 assert_eq!(spend_txn[0].input[0].sequence, BREAKDOWN_TIMEOUT as u32);
4896 fn test_claim_on_remote_sizeable_push_msat() {
4897 // Same test as previous, just test on remote commitment tx, as per_commitment_point registration changes following you're funder/fundee and
4898 // to_remote output is encumbered by a P2WPKH
4899 let chanmon_cfgs = create_chanmon_cfgs(2);
4900 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4901 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4902 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4904 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 99000000, InitFeatures::known(), InitFeatures::known());
4905 nodes[0].node.force_close_channel(&chan.2).unwrap();
4906 check_closed_broadcast!(nodes[0], true);
4907 check_added_monitors!(nodes[0], 1);
4909 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4910 assert_eq!(node_txn.len(), 1);
4911 check_spends!(node_txn[0], chan.3);
4912 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
4914 mine_transaction(&nodes[1], &node_txn[0]);
4915 check_closed_broadcast!(nodes[1], true);
4916 check_added_monitors!(nodes[1], 1);
4917 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4919 let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
4920 assert_eq!(spend_txn.len(), 1);
4921 check_spends!(spend_txn[0], node_txn[0]);
4925 fn test_claim_on_remote_revoked_sizeable_push_msat() {
4926 // Same test as previous, just test on remote revoked commitment tx, as per_commitment_point registration changes following you're funder/fundee and
4927 // to_remote output is encumbered by a P2WPKH
4929 let chanmon_cfgs = create_chanmon_cfgs(2);
4930 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4931 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4932 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4934 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 59000000, InitFeatures::known(), InitFeatures::known());
4935 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4936 let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan.2);
4937 assert_eq!(revoked_local_txn[0].input.len(), 1);
4938 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
4940 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
4941 mine_transaction(&nodes[1], &revoked_local_txn[0]);
4942 check_closed_broadcast!(nodes[1], true);
4943 check_added_monitors!(nodes[1], 1);
4945 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4946 mine_transaction(&nodes[1], &node_txn[0]);
4947 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4949 let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
4950 assert_eq!(spend_txn.len(), 3);
4951 check_spends!(spend_txn[0], revoked_local_txn[0]); // to_remote output on revoked remote commitment_tx
4952 check_spends!(spend_txn[1], node_txn[0]);
4953 check_spends!(spend_txn[2], revoked_local_txn[0], node_txn[0]); // Both outputs
4957 fn test_static_spendable_outputs_preimage_tx() {
4958 let chanmon_cfgs = create_chanmon_cfgs(2);
4959 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4960 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4961 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4963 // Create some initial channels
4964 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4966 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4968 let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
4969 assert_eq!(commitment_tx[0].input.len(), 1);
4970 assert_eq!(commitment_tx[0].input[0].previous_output.txid, chan_1.3.txid());
4972 // Settle A's commitment tx on B's chain
4973 assert!(nodes[1].node.claim_funds(payment_preimage));
4974 check_added_monitors!(nodes[1], 1);
4975 mine_transaction(&nodes[1], &commitment_tx[0]);
4976 check_added_monitors!(nodes[1], 1);
4977 let events = nodes[1].node.get_and_clear_pending_msg_events();
4979 MessageSendEvent::UpdateHTLCs { .. } => {},
4980 _ => panic!("Unexpected event"),
4983 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
4984 _ => panic!("Unexepected event"),
4987 // Check B's monitor was able to send back output descriptor event for preimage tx on A's commitment tx
4988 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap(); // ChannelManager : 2 (local commitment tx + HTLC-Success), ChannelMonitor: preimage tx
4989 assert_eq!(node_txn.len(), 3);
4990 check_spends!(node_txn[0], commitment_tx[0]);
4991 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
4992 check_spends!(node_txn[1], chan_1.3);
4993 check_spends!(node_txn[2], node_txn[1]);
4995 mine_transaction(&nodes[1], &node_txn[0]);
4996 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4998 let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
4999 assert_eq!(spend_txn.len(), 1);
5000 check_spends!(spend_txn[0], node_txn[0]);
5004 fn test_static_spendable_outputs_timeout_tx() {
5005 let chanmon_cfgs = create_chanmon_cfgs(2);
5006 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5007 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5008 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5010 // Create some initial channels
5011 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5013 // Rebalance the network a bit by relaying one payment through all the channels ...
5014 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
5016 let (_, our_payment_hash, _) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3_000_000);
5018 let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
5019 assert_eq!(commitment_tx[0].input.len(), 1);
5020 assert_eq!(commitment_tx[0].input[0].previous_output.txid, chan_1.3.txid());
5022 // Settle A's commitment tx on B' chain
5023 mine_transaction(&nodes[1], &commitment_tx[0]);
5024 check_added_monitors!(nodes[1], 1);
5025 let events = nodes[1].node.get_and_clear_pending_msg_events();
5027 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5028 _ => panic!("Unexpected event"),
5030 connect_blocks(&nodes[1], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
5032 // Check B's monitor was able to send back output descriptor event for timeout tx on A's commitment tx
5033 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
5034 assert_eq!(node_txn.len(), 2); // ChannelManager : 1 local commitent tx, ChannelMonitor: timeout tx
5035 check_spends!(node_txn[0], chan_1.3.clone());
5036 check_spends!(node_txn[1], commitment_tx[0].clone());
5037 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5039 mine_transaction(&nodes[1], &node_txn[1]);
5040 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
5041 expect_payment_failed!(nodes[1], our_payment_hash, true);
5043 let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
5044 assert_eq!(spend_txn.len(), 3); // SpendableOutput: remote_commitment_tx.to_remote, timeout_tx.output
5045 check_spends!(spend_txn[0], commitment_tx[0]);
5046 check_spends!(spend_txn[1], node_txn[1]);
5047 check_spends!(spend_txn[2], node_txn[1], commitment_tx[0]); // All outputs
5051 fn test_static_spendable_outputs_justice_tx_revoked_commitment_tx() {
5052 let chanmon_cfgs = create_chanmon_cfgs(2);
5053 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5054 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5055 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5057 // Create some initial channels
5058 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5060 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
5061 let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
5062 assert_eq!(revoked_local_txn[0].input.len(), 1);
5063 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
5065 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
5067 mine_transaction(&nodes[1], &revoked_local_txn[0]);
5068 check_closed_broadcast!(nodes[1], true);
5069 check_added_monitors!(nodes[1], 1);
5071 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5072 assert_eq!(node_txn.len(), 2);
5073 assert_eq!(node_txn[0].input.len(), 2);
5074 check_spends!(node_txn[0], revoked_local_txn[0]);
5076 mine_transaction(&nodes[1], &node_txn[0]);
5077 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
5079 let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
5080 assert_eq!(spend_txn.len(), 1);
5081 check_spends!(spend_txn[0], node_txn[0]);
5085 fn test_static_spendable_outputs_justice_tx_revoked_htlc_timeout_tx() {
5086 let mut chanmon_cfgs = create_chanmon_cfgs(2);
5087 chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
5088 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5089 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5090 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5092 // Create some initial channels
5093 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5095 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
5096 let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
5097 assert_eq!(revoked_local_txn[0].input.len(), 1);
5098 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
5100 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
5102 // A will generate HTLC-Timeout from revoked commitment tx
5103 mine_transaction(&nodes[0], &revoked_local_txn[0]);
5104 check_closed_broadcast!(nodes[0], true);
5105 check_added_monitors!(nodes[0], 1);
5106 connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
5108 let revoked_htlc_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5109 assert_eq!(revoked_htlc_txn.len(), 2);
5110 check_spends!(revoked_htlc_txn[0], chan_1.3);
5111 assert_eq!(revoked_htlc_txn[1].input.len(), 1);
5112 assert_eq!(revoked_htlc_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5113 check_spends!(revoked_htlc_txn[1], revoked_local_txn[0]);
5114 assert_ne!(revoked_htlc_txn[1].lock_time, 0); // HTLC-Timeout
5116 // B will generate justice tx from A's revoked commitment/HTLC tx
5117 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5118 connect_block(&nodes[1], &Block { header, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[1].clone()] });
5119 check_closed_broadcast!(nodes[1], true);
5120 check_added_monitors!(nodes[1], 1);
5122 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5123 assert_eq!(node_txn.len(), 3); // ChannelMonitor: bogus justice tx, justice tx on revoked outputs, ChannelManager: local commitment tx
5124 // The first transaction generated is bogus - it spends both outputs of revoked_local_txn[0]
5125 // including the one already spent by revoked_htlc_txn[1]. That's OK, we'll spend with valid
5126 // transactions next...
5127 assert_eq!(node_txn[0].input.len(), 3);
5128 check_spends!(node_txn[0], revoked_local_txn[0], revoked_htlc_txn[1]);
5130 assert_eq!(node_txn[1].input.len(), 2);
5131 check_spends!(node_txn[1], revoked_local_txn[0], revoked_htlc_txn[1]);
5132 if node_txn[1].input[1].previous_output.txid == revoked_htlc_txn[1].txid() {
5133 assert_ne!(node_txn[1].input[0].previous_output, revoked_htlc_txn[1].input[0].previous_output);
5135 assert_eq!(node_txn[1].input[0].previous_output.txid, revoked_htlc_txn[1].txid());
5136 assert_ne!(node_txn[1].input[1].previous_output, revoked_htlc_txn[1].input[0].previous_output);
5139 assert_eq!(node_txn[2].input.len(), 1);
5140 check_spends!(node_txn[2], chan_1.3);
5142 mine_transaction(&nodes[1], &node_txn[1]);
5143 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
5145 // Check B's ChannelMonitor was able to generate the right spendable output descriptor
5146 let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
5147 assert_eq!(spend_txn.len(), 1);
5148 assert_eq!(spend_txn[0].input.len(), 1);
5149 check_spends!(spend_txn[0], node_txn[1]);
5153 fn test_static_spendable_outputs_justice_tx_revoked_htlc_success_tx() {
5154 let mut chanmon_cfgs = create_chanmon_cfgs(2);
5155 chanmon_cfgs[1].keys_manager.disable_revocation_policy_check = true;
5156 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5157 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5158 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5160 // Create some initial channels
5161 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5163 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
5164 let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan_1.2);
5165 assert_eq!(revoked_local_txn[0].input.len(), 1);
5166 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
5168 // The to-be-revoked commitment tx should have one HTLC and one to_remote output
5169 assert_eq!(revoked_local_txn[0].output.len(), 2);
5171 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
5173 // B will generate HTLC-Success from revoked commitment tx
5174 mine_transaction(&nodes[1], &revoked_local_txn[0]);
5175 check_closed_broadcast!(nodes[1], true);
5176 check_added_monitors!(nodes[1], 1);
5177 let revoked_htlc_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5179 assert_eq!(revoked_htlc_txn.len(), 2);
5180 assert_eq!(revoked_htlc_txn[0].input.len(), 1);
5181 assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5182 check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
5184 // Check that the unspent (of two) outputs on revoked_local_txn[0] is a P2WPKH:
5185 let unspent_local_txn_output = revoked_htlc_txn[0].input[0].previous_output.vout as usize ^ 1;
5186 assert_eq!(revoked_local_txn[0].output[unspent_local_txn_output].script_pubkey.len(), 2 + 20); // P2WPKH
5188 // A will generate justice tx from B's revoked commitment/HTLC tx
5189 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5190 connect_block(&nodes[0], &Block { header, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[0].clone()] });
5191 check_closed_broadcast!(nodes[0], true);
5192 check_added_monitors!(nodes[0], 1);
5194 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5195 assert_eq!(node_txn.len(), 3); // ChannelMonitor: justice tx on revoked commitment, justice tx on revoked HTLC-success, ChannelManager: local commitment tx
5197 // The first transaction generated is bogus - it spends both outputs of revoked_local_txn[0]
5198 // including the one already spent by revoked_htlc_txn[0]. That's OK, we'll spend with valid
5199 // transactions next...
5200 assert_eq!(node_txn[0].input.len(), 2);
5201 check_spends!(node_txn[0], revoked_local_txn[0], revoked_htlc_txn[0]);
5202 if node_txn[0].input[1].previous_output.txid == revoked_htlc_txn[0].txid() {
5203 assert_eq!(node_txn[0].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
5205 assert_eq!(node_txn[0].input[0].previous_output.txid, revoked_htlc_txn[0].txid());
5206 assert_eq!(node_txn[0].input[1].previous_output, revoked_htlc_txn[0].input[0].previous_output);
5209 assert_eq!(node_txn[1].input.len(), 1);
5210 check_spends!(node_txn[1], revoked_htlc_txn[0]);
5212 check_spends!(node_txn[2], chan_1.3);
5214 mine_transaction(&nodes[0], &node_txn[1]);
5215 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
5217 // Note that nodes[0]'s tx_broadcaster is still locked, so if we get here the channelmonitor
5218 // didn't try to generate any new transactions.
5220 // Check A's ChannelMonitor was able to generate the right spendable output descriptor
5221 let spend_txn = check_spendable_outputs!(nodes[0], node_cfgs[0].keys_manager);
5222 assert_eq!(spend_txn.len(), 3);
5223 assert_eq!(spend_txn[0].input.len(), 1);
5224 check_spends!(spend_txn[0], revoked_local_txn[0]); // spending to_remote output from revoked local tx
5225 assert_ne!(spend_txn[0].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
5226 check_spends!(spend_txn[1], node_txn[1]); // spending justice tx output on the htlc success tx
5227 check_spends!(spend_txn[2], revoked_local_txn[0], node_txn[1]); // Both outputs
5231 fn test_onchain_to_onchain_claim() {
5232 // Test that in case of channel closure, we detect the state of output and claim HTLC
5233 // on downstream peer's remote commitment tx.
5234 // First, have C claim an HTLC against its own latest commitment transaction.
5235 // Then, broadcast these to B, which should update the monitor downstream on the A<->B
5237 // Finally, check that B will claim the HTLC output if A's latest commitment transaction
5240 let chanmon_cfgs = create_chanmon_cfgs(3);
5241 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5242 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5243 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5245 // Create some initial channels
5246 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5247 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
5249 // Ensure all nodes are at the same height
5250 let node_max_height = nodes.iter().map(|node| node.blocks.lock().unwrap().len()).max().unwrap() as u32;
5251 connect_blocks(&nodes[0], node_max_height - nodes[0].best_block_info().1);
5252 connect_blocks(&nodes[1], node_max_height - nodes[1].best_block_info().1);
5253 connect_blocks(&nodes[2], node_max_height - nodes[2].best_block_info().1);
5255 // Rebalance the network a bit by relaying one payment through all the channels ...
5256 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
5257 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
5259 let (payment_preimage, _payment_hash, _payment_secret) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
5260 let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
5261 check_spends!(commitment_tx[0], chan_2.3);
5262 nodes[2].node.claim_funds(payment_preimage);
5263 check_added_monitors!(nodes[2], 1);
5264 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
5265 assert!(updates.update_add_htlcs.is_empty());
5266 assert!(updates.update_fail_htlcs.is_empty());
5267 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
5268 assert!(updates.update_fail_malformed_htlcs.is_empty());
5270 mine_transaction(&nodes[2], &commitment_tx[0]);
5271 check_closed_broadcast!(nodes[2], true);
5272 check_added_monitors!(nodes[2], 1);
5274 let c_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 2 (commitment tx, HTLC-Success tx), ChannelMonitor : 1 (HTLC-Success tx)
5275 assert_eq!(c_txn.len(), 3);
5276 assert_eq!(c_txn[0], c_txn[2]);
5277 assert_eq!(commitment_tx[0], c_txn[1]);
5278 check_spends!(c_txn[1], chan_2.3);
5279 check_spends!(c_txn[2], c_txn[1]);
5280 assert_eq!(c_txn[1].input[0].witness.clone().last().unwrap().len(), 71);
5281 assert_eq!(c_txn[2].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5282 assert!(c_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
5283 assert_eq!(c_txn[0].lock_time, 0); // Success tx
5285 // 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
5286 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
5287 connect_block(&nodes[1], &Block { header, txdata: vec![c_txn[1].clone(), c_txn[2].clone()]});
5288 connect_blocks(&nodes[1], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
5290 let mut b_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5291 // ChannelMonitor: claim tx, ChannelManager: local commitment tx
5292 assert_eq!(b_txn.len(), 2);
5293 check_spends!(b_txn[0], chan_2.3); // B local commitment tx, issued by ChannelManager
5294 check_spends!(b_txn[1], c_txn[1]); // timeout tx on C remote commitment tx, issued by ChannelMonitor
5295 assert_eq!(b_txn[1].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5296 assert!(b_txn[1].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
5297 assert_ne!(b_txn[1].lock_time, 0); // Timeout tx
5300 check_added_monitors!(nodes[1], 1);
5301 let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
5302 assert_eq!(msg_events.len(), 3);
5303 check_added_monitors!(nodes[1], 1);
5304 match msg_events[0] {
5305 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5306 _ => panic!("Unexpected event"),
5308 match msg_events[1] {
5309 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { .. }, node_id: _ } => {},
5310 _ => panic!("Unexpected event"),
5312 match msg_events[2] {
5313 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, .. } } => {
5314 assert!(update_add_htlcs.is_empty());
5315 assert!(update_fail_htlcs.is_empty());
5316 assert_eq!(update_fulfill_htlcs.len(), 1);
5317 assert!(update_fail_malformed_htlcs.is_empty());
5318 assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
5320 _ => panic!("Unexpected event"),
5322 // Broadcast A's commitment tx on B's chain to see if we are able to claim inbound HTLC with our HTLC-Success tx
5323 let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
5324 mine_transaction(&nodes[1], &commitment_tx[0]);
5325 let b_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5326 // ChannelMonitor: HTLC-Success tx + HTLC-Timeout RBF Bump, ChannelManager: local commitment tx + HTLC-Success tx
5327 assert_eq!(b_txn.len(), 4);
5328 check_spends!(b_txn[2], chan_1.3);
5329 check_spends!(b_txn[3], b_txn[2]);
5330 let (htlc_success_claim, htlc_timeout_bumped) =
5331 if b_txn[0].input[0].previous_output.txid == commitment_tx[0].txid()
5332 { (&b_txn[0], &b_txn[1]) } else { (&b_txn[1], &b_txn[0]) };
5333 check_spends!(htlc_success_claim, commitment_tx[0]);
5334 assert_eq!(htlc_success_claim.input[0].witness.clone().last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5335 assert!(htlc_success_claim.output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
5336 assert_eq!(htlc_success_claim.lock_time, 0); // Success tx
5337 check_spends!(htlc_timeout_bumped, c_txn[1]); // timeout tx on C remote commitment tx, issued by ChannelMonitor
5338 assert_ne!(htlc_timeout_bumped.lock_time, 0); // Success tx
5340 check_closed_broadcast!(nodes[1], true);
5341 check_added_monitors!(nodes[1], 1);
5345 fn test_duplicate_payment_hash_one_failure_one_success() {
5346 // Topology : A --> B --> C --> D
5347 // We route 2 payments with same hash between B and C, one will be timeout, the other successfully claim
5348 // Note that because C will refuse to generate two payment secrets for the same payment hash,
5349 // we forward one of the payments onwards to D.
5350 let chanmon_cfgs = create_chanmon_cfgs(4);
5351 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
5352 // When this test was written, the default base fee floated based on the HTLC count.
5353 // It is now fixed, so we simply set the fee to the expected value here.
5354 let mut config = test_default_channel_config();
5355 config.channel_options.forwarding_fee_base_msat = 196;
5356 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs,
5357 &[Some(config.clone()), Some(config.clone()), Some(config.clone()), Some(config.clone())]);
5358 let mut nodes = create_network(4, &node_cfgs, &node_chanmgrs);
5360 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5361 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
5362 create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
5364 let node_max_height = nodes.iter().map(|node| node.blocks.lock().unwrap().len()).max().unwrap() as u32;
5365 connect_blocks(&nodes[0], node_max_height - nodes[0].best_block_info().1);
5366 connect_blocks(&nodes[1], node_max_height - nodes[1].best_block_info().1);
5367 connect_blocks(&nodes[2], node_max_height - nodes[2].best_block_info().1);
5368 connect_blocks(&nodes[3], node_max_height - nodes[3].best_block_info().1);
5370 let (our_payment_preimage, duplicate_payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 900000);
5372 let payment_secret = nodes[3].node.create_inbound_payment_for_hash(duplicate_payment_hash, None, 7200, 0).unwrap();
5373 // We reduce the final CLTV here by a somewhat arbitrary constant to keep it under the one-byte
5374 // script push size limit so that the below script length checks match
5375 // ACCEPTED_HTLC_SCRIPT_WEIGHT.
5376 let route = get_route(&nodes[0].node.get_our_node_id(), &nodes[0].net_graph_msg_handler.network_graph.read().unwrap(),
5377 &nodes[3].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 900000, TEST_FINAL_CLTV - 40, nodes[0].logger).unwrap();
5378 send_along_route_with_secret(&nodes[0], route, &[&[&nodes[1], &nodes[2], &nodes[3]]], 900000, duplicate_payment_hash, payment_secret);
5380 let commitment_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
5381 assert_eq!(commitment_txn[0].input.len(), 1);
5382 check_spends!(commitment_txn[0], chan_2.3);
5384 mine_transaction(&nodes[1], &commitment_txn[0]);
5385 check_closed_broadcast!(nodes[1], true);
5386 check_added_monitors!(nodes[1], 1);
5387 connect_blocks(&nodes[1], TEST_FINAL_CLTV - 40 + MIN_CLTV_EXPIRY_DELTA as u32 - 1); // Confirm blocks until the HTLC expires
5389 let htlc_timeout_tx;
5390 { // Extract one of the two HTLC-Timeout transaction
5391 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5392 // ChannelMonitor: timeout tx * 3, ChannelManager: local commitment tx
5393 assert_eq!(node_txn.len(), 4);
5394 check_spends!(node_txn[0], chan_2.3);
5396 check_spends!(node_txn[1], commitment_txn[0]);
5397 assert_eq!(node_txn[1].input.len(), 1);
5398 check_spends!(node_txn[2], commitment_txn[0]);
5399 assert_eq!(node_txn[2].input.len(), 1);
5400 assert_eq!(node_txn[1].input[0].previous_output, node_txn[2].input[0].previous_output);
5401 check_spends!(node_txn[3], commitment_txn[0]);
5402 assert_ne!(node_txn[1].input[0].previous_output, node_txn[3].input[0].previous_output);
5404 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5405 assert_eq!(node_txn[2].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5406 assert_eq!(node_txn[3].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5407 htlc_timeout_tx = node_txn[1].clone();
5410 nodes[2].node.claim_funds(our_payment_preimage);
5411 mine_transaction(&nodes[2], &commitment_txn[0]);
5412 check_added_monitors!(nodes[2], 2);
5413 let events = nodes[2].node.get_and_clear_pending_msg_events();
5415 MessageSendEvent::UpdateHTLCs { .. } => {},
5416 _ => panic!("Unexpected event"),
5419 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5420 _ => panic!("Unexepected event"),
5422 let htlc_success_txn: Vec<_> = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
5423 assert_eq!(htlc_success_txn.len(), 5); // ChannelMonitor: HTLC-Success txn (*2 due to 2-HTLC outputs), ChannelManager: local commitment tx + HTLC-Success txn (*2 due to 2-HTLC outputs)
5424 check_spends!(htlc_success_txn[0], commitment_txn[0]);
5425 check_spends!(htlc_success_txn[1], commitment_txn[0]);
5426 assert_eq!(htlc_success_txn[0].input.len(), 1);
5427 assert_eq!(htlc_success_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5428 assert_eq!(htlc_success_txn[1].input.len(), 1);
5429 assert_eq!(htlc_success_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5430 assert_ne!(htlc_success_txn[0].input[0].previous_output, htlc_success_txn[1].input[0].previous_output);
5431 assert_eq!(htlc_success_txn[2], commitment_txn[0]);
5432 assert_eq!(htlc_success_txn[3], htlc_success_txn[0]);
5433 assert_eq!(htlc_success_txn[4], htlc_success_txn[1]);
5434 assert_ne!(htlc_success_txn[0].input[0].previous_output, htlc_timeout_tx.input[0].previous_output);
5436 mine_transaction(&nodes[1], &htlc_timeout_tx);
5437 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
5438 expect_pending_htlcs_forwardable!(nodes[1]);
5439 let htlc_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5440 assert!(htlc_updates.update_add_htlcs.is_empty());
5441 assert_eq!(htlc_updates.update_fail_htlcs.len(), 1);
5442 let first_htlc_id = htlc_updates.update_fail_htlcs[0].htlc_id;
5443 assert!(htlc_updates.update_fulfill_htlcs.is_empty());
5444 assert!(htlc_updates.update_fail_malformed_htlcs.is_empty());
5445 check_added_monitors!(nodes[1], 1);
5447 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_updates.update_fail_htlcs[0]);
5448 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
5450 commitment_signed_dance!(nodes[0], nodes[1], &htlc_updates.commitment_signed, false, true);
5451 expect_payment_failure_chan_update!(nodes[0], chan_2.0.contents.short_channel_id, true);
5453 expect_payment_failed!(nodes[0], duplicate_payment_hash, false);
5455 // Solve 2nd HTLC by broadcasting on B's chain HTLC-Success Tx from C
5456 mine_transaction(&nodes[1], &htlc_success_txn[0]);
5457 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5458 assert!(updates.update_add_htlcs.is_empty());
5459 assert!(updates.update_fail_htlcs.is_empty());
5460 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
5461 assert_ne!(updates.update_fulfill_htlcs[0].htlc_id, first_htlc_id);
5462 assert!(updates.update_fail_malformed_htlcs.is_empty());
5463 check_added_monitors!(nodes[1], 1);
5465 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
5466 commitment_signed_dance!(nodes[0], nodes[1], &updates.commitment_signed, false);
5468 let events = nodes[0].node.get_and_clear_pending_events();
5470 Event::PaymentSent { ref payment_preimage } => {
5471 assert_eq!(*payment_preimage, our_payment_preimage);
5473 _ => panic!("Unexpected event"),
5478 fn test_dynamic_spendable_outputs_local_htlc_success_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, InitFeatures::known(), InitFeatures::known());
5487 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000).0;
5488 let local_txn = get_local_commitment_txn!(nodes[1], chan_1.2);
5489 assert_eq!(local_txn.len(), 1);
5490 assert_eq!(local_txn[0].input.len(), 1);
5491 check_spends!(local_txn[0], chan_1.3);
5493 // Give B knowledge of preimage to be able to generate a local HTLC-Success Tx
5494 nodes[1].node.claim_funds(payment_preimage);
5495 check_added_monitors!(nodes[1], 1);
5496 mine_transaction(&nodes[1], &local_txn[0]);
5497 check_added_monitors!(nodes[1], 1);
5498 let events = nodes[1].node.get_and_clear_pending_msg_events();
5500 MessageSendEvent::UpdateHTLCs { .. } => {},
5501 _ => panic!("Unexpected event"),
5504 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5505 _ => panic!("Unexepected event"),
5508 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5509 assert_eq!(node_txn.len(), 3);
5510 assert_eq!(node_txn[0], node_txn[2]);
5511 assert_eq!(node_txn[1], local_txn[0]);
5512 assert_eq!(node_txn[0].input.len(), 1);
5513 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5514 check_spends!(node_txn[0], local_txn[0]);
5518 mine_transaction(&nodes[1], &node_tx);
5519 connect_blocks(&nodes[1], BREAKDOWN_TIMEOUT as u32 - 1);
5521 // Verify that B is able to spend its own HTLC-Success tx thanks to spendable output event given back by its ChannelMonitor
5522 let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
5523 assert_eq!(spend_txn.len(), 1);
5524 assert_eq!(spend_txn[0].input.len(), 1);
5525 check_spends!(spend_txn[0], node_tx);
5526 assert_eq!(spend_txn[0].input[0].sequence, BREAKDOWN_TIMEOUT as u32);
5529 fn do_test_fail_backwards_unrevoked_remote_announce(deliver_last_raa: bool, announce_latest: bool) {
5530 // Test that we fail backwards the full set of HTLCs we need to when remote broadcasts an
5531 // unrevoked commitment transaction.
5532 // This includes HTLCs which were below the dust threshold as well as HTLCs which were awaiting
5533 // a remote RAA before they could be failed backwards (and combinations thereof).
5534 // We also test duplicate-hash HTLCs by adding two nodes on each side of the target nodes which
5535 // use the same payment hashes.
5536 // Thus, we use a six-node network:
5541 // And test where C fails back to A/B when D announces its latest commitment transaction
5542 let chanmon_cfgs = create_chanmon_cfgs(6);
5543 let node_cfgs = create_node_cfgs(6, &chanmon_cfgs);
5544 // When this test was written, the default base fee floated based on the HTLC count.
5545 // It is now fixed, so we simply set the fee to the expected value here.
5546 let mut config = test_default_channel_config();
5547 config.channel_options.forwarding_fee_base_msat = 196;
5548 let node_chanmgrs = create_node_chanmgrs(6, &node_cfgs,
5549 &[Some(config.clone()), Some(config.clone()), Some(config.clone()), Some(config.clone()), Some(config.clone()), Some(config.clone())]);
5550 let nodes = create_network(6, &node_cfgs, &node_chanmgrs);
5551 let logger = test_utils::TestLogger::new();
5553 create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known());
5554 create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
5555 let chan = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
5556 create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::known(), InitFeatures::known());
5557 create_announced_chan_between_nodes(&nodes, 3, 5, InitFeatures::known(), InitFeatures::known());
5559 // Rebalance and check output sanity...
5560 send_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 500000);
5561 send_payment(&nodes[1], &[&nodes[2], &nodes[3], &nodes[5]], 500000);
5562 assert_eq!(get_local_commitment_txn!(nodes[3], chan.2)[0].output.len(), 2);
5564 let ds_dust_limit = nodes[3].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().holder_dust_limit_satoshis;
5566 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
5568 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
5569 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
5570 let our_node_id = &nodes[1].node.get_our_node_id();
5571 let route = get_route(our_node_id, &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[5].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), ds_dust_limit*1000, TEST_FINAL_CLTV, &logger).unwrap();
5573 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, 0).unwrap()); // not added < dust limit + HTLC tx fee
5575 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, 0).unwrap()); // not added < dust limit + HTLC tx fee
5577 let (_, payment_hash_3, _) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
5579 let (_, payment_hash_4, _) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
5580 let route = get_route(our_node_id, &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[5].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
5582 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, 0).unwrap());
5584 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, 0).unwrap());
5587 let (_, payment_hash_5, _) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
5589 let route = get_route(our_node_id, &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[5].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), ds_dust_limit*1000, TEST_FINAL_CLTV, &logger).unwrap();
5590 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, 0).unwrap()); // not added < dust limit + HTLC tx fee
5593 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
5595 let route = get_route(our_node_id, &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[5].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
5596 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, 0).unwrap());
5598 // Double-check that six of the new HTLC were added
5599 // We now have six HTLCs pending over the dust limit and six HTLCs under the dust limit (ie,
5600 // with to_local and to_remote outputs, 8 outputs and 6 HTLCs not included).
5601 assert_eq!(get_local_commitment_txn!(nodes[3], chan.2).len(), 1);
5602 assert_eq!(get_local_commitment_txn!(nodes[3], chan.2)[0].output.len(), 8);
5604 // Now fail back three of the over-dust-limit and three of the under-dust-limit payments in one go.
5605 // Fail 0th below-dust, 4th above-dust, 8th above-dust, 10th below-dust HTLCs
5606 assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_1));
5607 assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_3));
5608 assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_5));
5609 assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_6));
5610 check_added_monitors!(nodes[4], 0);
5611 expect_pending_htlcs_forwardable!(nodes[4]);
5612 check_added_monitors!(nodes[4], 1);
5614 let four_removes = get_htlc_update_msgs!(nodes[4], nodes[3].node.get_our_node_id());
5615 nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[0]);
5616 nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[1]);
5617 nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[2]);
5618 nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[3]);
5619 commitment_signed_dance!(nodes[3], nodes[4], four_removes.commitment_signed, false);
5621 // Fail 3rd below-dust and 7th above-dust HTLCs
5622 assert!(nodes[5].node.fail_htlc_backwards(&payment_hash_2));
5623 assert!(nodes[5].node.fail_htlc_backwards(&payment_hash_4));
5624 check_added_monitors!(nodes[5], 0);
5625 expect_pending_htlcs_forwardable!(nodes[5]);
5626 check_added_monitors!(nodes[5], 1);
5628 let two_removes = get_htlc_update_msgs!(nodes[5], nodes[3].node.get_our_node_id());
5629 nodes[3].node.handle_update_fail_htlc(&nodes[5].node.get_our_node_id(), &two_removes.update_fail_htlcs[0]);
5630 nodes[3].node.handle_update_fail_htlc(&nodes[5].node.get_our_node_id(), &two_removes.update_fail_htlcs[1]);
5631 commitment_signed_dance!(nodes[3], nodes[5], two_removes.commitment_signed, false);
5633 let ds_prev_commitment_tx = get_local_commitment_txn!(nodes[3], chan.2);
5635 expect_pending_htlcs_forwardable!(nodes[3]);
5636 check_added_monitors!(nodes[3], 1);
5637 let six_removes = get_htlc_update_msgs!(nodes[3], nodes[2].node.get_our_node_id());
5638 nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[0]);
5639 nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[1]);
5640 nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[2]);
5641 nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[3]);
5642 nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[4]);
5643 nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[5]);
5644 if deliver_last_raa {
5645 commitment_signed_dance!(nodes[2], nodes[3], six_removes.commitment_signed, false);
5647 let _cs_last_raa = commitment_signed_dance!(nodes[2], nodes[3], six_removes.commitment_signed, false, true, false, true);
5650 // D's latest commitment transaction now contains 1st + 2nd + 9th HTLCs (implicitly, they're
5651 // below the dust limit) and the 5th + 6th + 11th HTLCs. It has failed back the 0th, 3rd, 4th,
5652 // 7th, 8th, and 10th, but as we haven't yet delivered the final RAA to C, the fails haven't
5653 // propagated back to A/B yet (and D has two unrevoked commitment transactions).
5655 // We now broadcast the latest commitment transaction, which *should* result in failures for
5656 // the 0th, 1st, 2nd, 3rd, 4th, 7th, 8th, 9th, and 10th HTLCs, ie all the below-dust HTLCs and
5657 // the non-broadcast above-dust HTLCs.
5659 // Alternatively, we may broadcast the previous commitment transaction, which should only
5660 // result in failures for the below-dust HTLCs, ie the 0th, 1st, 2nd, 3rd, 9th, and 10th HTLCs.
5661 let ds_last_commitment_tx = get_local_commitment_txn!(nodes[3], chan.2);
5663 if announce_latest {
5664 mine_transaction(&nodes[2], &ds_last_commitment_tx[0]);
5666 mine_transaction(&nodes[2], &ds_prev_commitment_tx[0]);
5668 connect_blocks(&nodes[2], ANTI_REORG_DELAY - 1);
5669 check_closed_broadcast!(nodes[2], true);
5670 expect_pending_htlcs_forwardable!(nodes[2]);
5671 check_added_monitors!(nodes[2], 3);
5673 let cs_msgs = nodes[2].node.get_and_clear_pending_msg_events();
5674 assert_eq!(cs_msgs.len(), 2);
5675 let mut a_done = false;
5676 for msg in cs_msgs {
5678 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
5679 // Both under-dust HTLCs and the one above-dust HTLC that we had already failed
5680 // should be failed-backwards here.
5681 let target = if *node_id == nodes[0].node.get_our_node_id() {
5682 // If announce_latest, expect 0th, 1st, 4th, 8th, 10th HTLCs, else only 0th, 1st, 10th below-dust HTLCs
5683 for htlc in &updates.update_fail_htlcs {
5684 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 });
5686 assert_eq!(updates.update_fail_htlcs.len(), if announce_latest { 5 } else { 3 });
5691 // If announce_latest, expect 2nd, 3rd, 7th, 9th HTLCs, else only 2nd, 3rd, 9th below-dust HTLCs
5692 for htlc in &updates.update_fail_htlcs {
5693 assert!(htlc.htlc_id == 1 || htlc.htlc_id == 2 || htlc.htlc_id == 5 || if announce_latest { htlc.htlc_id == 4 } else { false });
5695 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
5696 assert_eq!(updates.update_fail_htlcs.len(), if announce_latest { 4 } else { 3 });
5699 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
5700 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[1]);
5701 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[2]);
5702 if announce_latest {
5703 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[3]);
5704 if *node_id == nodes[0].node.get_our_node_id() {
5705 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[4]);
5708 commitment_signed_dance!(target, nodes[2], updates.commitment_signed, false, true);
5710 _ => panic!("Unexpected event"),
5714 let as_events = nodes[0].node.get_and_clear_pending_events();
5715 assert_eq!(as_events.len(), if announce_latest { 5 } else { 3 });
5716 let mut as_failds = HashSet::new();
5717 for event in as_events.iter() {
5718 if let &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, .. } = event {
5719 assert!(as_failds.insert(*payment_hash));
5720 if *payment_hash != payment_hash_2 {
5721 assert_eq!(*rejected_by_dest, deliver_last_raa);
5723 assert!(!rejected_by_dest);
5725 } else { panic!("Unexpected event"); }
5727 assert!(as_failds.contains(&payment_hash_1));
5728 assert!(as_failds.contains(&payment_hash_2));
5729 if announce_latest {
5730 assert!(as_failds.contains(&payment_hash_3));
5731 assert!(as_failds.contains(&payment_hash_5));
5733 assert!(as_failds.contains(&payment_hash_6));
5735 let bs_events = nodes[1].node.get_and_clear_pending_events();
5736 assert_eq!(bs_events.len(), if announce_latest { 4 } else { 3 });
5737 let mut bs_failds = HashSet::new();
5738 for event in bs_events.iter() {
5739 if let &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, .. } = event {
5740 assert!(bs_failds.insert(*payment_hash));
5741 if *payment_hash != payment_hash_1 && *payment_hash != payment_hash_5 {
5742 assert_eq!(*rejected_by_dest, deliver_last_raa);
5744 assert!(!rejected_by_dest);
5746 } else { panic!("Unexpected event"); }
5748 assert!(bs_failds.contains(&payment_hash_1));
5749 assert!(bs_failds.contains(&payment_hash_2));
5750 if announce_latest {
5751 assert!(bs_failds.contains(&payment_hash_4));
5753 assert!(bs_failds.contains(&payment_hash_5));
5755 // For each HTLC which was not failed-back by normal process (ie deliver_last_raa), we should
5756 // get a PaymentFailureNetworkUpdate. A should have gotten 4 HTLCs which were failed-back due
5757 // to unknown-preimage-etc, B should have gotten 2. Thus, in the
5758 // announce_latest && deliver_last_raa case, we should have 5-4=1 and 4-2=2
5759 // PaymentFailureNetworkUpdates.
5760 let as_msg_events = nodes[0].node.get_and_clear_pending_msg_events();
5761 assert_eq!(as_msg_events.len(), if deliver_last_raa { 1 } else if !announce_latest { 3 } else { 5 });
5762 let bs_msg_events = nodes[1].node.get_and_clear_pending_msg_events();
5763 assert_eq!(bs_msg_events.len(), if deliver_last_raa { 2 } else if !announce_latest { 3 } else { 4 });
5764 for event in as_msg_events.iter().chain(bs_msg_events.iter()) {
5766 &MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
5767 _ => panic!("Unexpected event"),
5773 fn test_fail_backwards_latest_remote_announce_a() {
5774 do_test_fail_backwards_unrevoked_remote_announce(false, true);
5778 fn test_fail_backwards_latest_remote_announce_b() {
5779 do_test_fail_backwards_unrevoked_remote_announce(true, true);
5783 fn test_fail_backwards_previous_remote_announce() {
5784 do_test_fail_backwards_unrevoked_remote_announce(false, false);
5785 // Note that true, true doesn't make sense as it implies we announce a revoked state, which is
5786 // tested for in test_commitment_revoked_fail_backward_exhaustive()
5790 fn test_dynamic_spendable_outputs_local_htlc_timeout_tx() {
5791 let chanmon_cfgs = create_chanmon_cfgs(2);
5792 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5793 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5794 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5796 // Create some initial channels
5797 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5799 let (_, our_payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000);
5800 let local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
5801 assert_eq!(local_txn[0].input.len(), 1);
5802 check_spends!(local_txn[0], chan_1.3);
5804 // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
5805 mine_transaction(&nodes[0], &local_txn[0]);
5806 check_closed_broadcast!(nodes[0], true);
5807 check_added_monitors!(nodes[0], 1);
5808 connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
5810 let htlc_timeout = {
5811 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5812 assert_eq!(node_txn.len(), 2);
5813 check_spends!(node_txn[0], chan_1.3);
5814 assert_eq!(node_txn[1].input.len(), 1);
5815 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5816 check_spends!(node_txn[1], local_txn[0]);
5820 mine_transaction(&nodes[0], &htlc_timeout);
5821 connect_blocks(&nodes[0], BREAKDOWN_TIMEOUT as u32 - 1);
5822 expect_payment_failed!(nodes[0], our_payment_hash, true);
5824 // Verify that A is able to spend its own HTLC-Timeout tx thanks to spendable output event given back by its ChannelMonitor
5825 let spend_txn = check_spendable_outputs!(nodes[0], node_cfgs[0].keys_manager);
5826 assert_eq!(spend_txn.len(), 3);
5827 check_spends!(spend_txn[0], local_txn[0]);
5828 assert_eq!(spend_txn[1].input.len(), 1);
5829 check_spends!(spend_txn[1], htlc_timeout);
5830 assert_eq!(spend_txn[1].input[0].sequence, BREAKDOWN_TIMEOUT as u32);
5831 assert_eq!(spend_txn[2].input.len(), 2);
5832 check_spends!(spend_txn[2], local_txn[0], htlc_timeout);
5833 assert!(spend_txn[2].input[0].sequence == BREAKDOWN_TIMEOUT as u32 ||
5834 spend_txn[2].input[1].sequence == BREAKDOWN_TIMEOUT as u32);
5838 fn test_key_derivation_params() {
5839 // This test is a copy of test_dynamic_spendable_outputs_local_htlc_timeout_tx, with
5840 // a key manager rotation to test that key_derivation_params returned in DynamicOutputP2WSH
5841 // let us re-derive the channel key set to then derive a delayed_payment_key.
5843 let chanmon_cfgs = create_chanmon_cfgs(3);
5845 // We manually create the node configuration to backup the seed.
5846 let seed = [42; 32];
5847 let keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
5848 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);
5849 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, chain_monitor, keys_manager: &keys_manager, node_seed: seed };
5850 let mut node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5851 node_cfgs.remove(0);
5852 node_cfgs.insert(0, node);
5854 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5855 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5857 // Create some initial channels
5858 // Create a dummy channel to advance index by one and thus test re-derivation correctness
5860 let chan_0 = create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known());
5861 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5862 assert_ne!(chan_0.3.output[0].script_pubkey, chan_1.3.output[0].script_pubkey);
5864 // Ensure all nodes are at the same height
5865 let node_max_height = nodes.iter().map(|node| node.blocks.lock().unwrap().len()).max().unwrap() as u32;
5866 connect_blocks(&nodes[0], node_max_height - nodes[0].best_block_info().1);
5867 connect_blocks(&nodes[1], node_max_height - nodes[1].best_block_info().1);
5868 connect_blocks(&nodes[2], node_max_height - nodes[2].best_block_info().1);
5870 let (_, our_payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000);
5871 let local_txn_0 = get_local_commitment_txn!(nodes[0], chan_0.2);
5872 let local_txn_1 = get_local_commitment_txn!(nodes[0], chan_1.2);
5873 assert_eq!(local_txn_1[0].input.len(), 1);
5874 check_spends!(local_txn_1[0], chan_1.3);
5876 // We check funding pubkey are unique
5877 let (from_0_funding_key_0, from_0_funding_key_1) = (PublicKey::from_slice(&local_txn_0[0].input[0].witness[3][2..35]), PublicKey::from_slice(&local_txn_0[0].input[0].witness[3][36..69]));
5878 let (from_1_funding_key_0, from_1_funding_key_1) = (PublicKey::from_slice(&local_txn_1[0].input[0].witness[3][2..35]), PublicKey::from_slice(&local_txn_1[0].input[0].witness[3][36..69]));
5879 if from_0_funding_key_0 == from_1_funding_key_0
5880 || from_0_funding_key_0 == from_1_funding_key_1
5881 || from_0_funding_key_1 == from_1_funding_key_0
5882 || from_0_funding_key_1 == from_1_funding_key_1 {
5883 panic!("Funding pubkeys aren't unique");
5886 // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
5887 mine_transaction(&nodes[0], &local_txn_1[0]);
5888 connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
5889 check_closed_broadcast!(nodes[0], true);
5890 check_added_monitors!(nodes[0], 1);
5892 let htlc_timeout = {
5893 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5894 assert_eq!(node_txn[1].input.len(), 1);
5895 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5896 check_spends!(node_txn[1], local_txn_1[0]);
5900 mine_transaction(&nodes[0], &htlc_timeout);
5901 connect_blocks(&nodes[0], BREAKDOWN_TIMEOUT as u32 - 1);
5902 expect_payment_failed!(nodes[0], our_payment_hash, true);
5904 // Verify that A is able to spend its own HTLC-Timeout tx thanks to spendable output event given back by its ChannelMonitor
5905 let new_keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
5906 let spend_txn = check_spendable_outputs!(nodes[0], new_keys_manager);
5907 assert_eq!(spend_txn.len(), 3);
5908 check_spends!(spend_txn[0], local_txn_1[0]);
5909 assert_eq!(spend_txn[1].input.len(), 1);
5910 check_spends!(spend_txn[1], htlc_timeout);
5911 assert_eq!(spend_txn[1].input[0].sequence, BREAKDOWN_TIMEOUT as u32);
5912 assert_eq!(spend_txn[2].input.len(), 2);
5913 check_spends!(spend_txn[2], local_txn_1[0], htlc_timeout);
5914 assert!(spend_txn[2].input[0].sequence == BREAKDOWN_TIMEOUT as u32 ||
5915 spend_txn[2].input[1].sequence == BREAKDOWN_TIMEOUT as u32);
5919 fn test_static_output_closing_tx() {
5920 let chanmon_cfgs = create_chanmon_cfgs(2);
5921 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5922 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5923 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5925 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5927 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
5928 let closing_tx = close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true).2;
5930 mine_transaction(&nodes[0], &closing_tx);
5931 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
5933 let spend_txn = check_spendable_outputs!(nodes[0], node_cfgs[0].keys_manager);
5934 assert_eq!(spend_txn.len(), 1);
5935 check_spends!(spend_txn[0], closing_tx);
5937 mine_transaction(&nodes[1], &closing_tx);
5938 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
5940 let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
5941 assert_eq!(spend_txn.len(), 1);
5942 check_spends!(spend_txn[0], closing_tx);
5945 fn do_htlc_claim_local_commitment_only(use_dust: bool) {
5946 let chanmon_cfgs = create_chanmon_cfgs(2);
5947 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5948 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5949 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5950 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5952 let (our_payment_preimage, _, _) = route_payment(&nodes[0], &[&nodes[1]], if use_dust { 50000 } else { 3000000 });
5954 // Claim the payment, but don't deliver A's commitment_signed, resulting in the HTLC only being
5955 // present in B's local commitment transaction, but none of A's commitment transactions.
5956 assert!(nodes[1].node.claim_funds(our_payment_preimage));
5957 check_added_monitors!(nodes[1], 1);
5959 let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5960 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fulfill_htlcs[0]);
5961 let events = nodes[0].node.get_and_clear_pending_events();
5962 assert_eq!(events.len(), 1);
5964 Event::PaymentSent { payment_preimage } => {
5965 assert_eq!(payment_preimage, our_payment_preimage);
5967 _ => panic!("Unexpected event"),
5970 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_updates.commitment_signed);
5971 check_added_monitors!(nodes[0], 1);
5972 let as_updates = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5973 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_updates.0);
5974 check_added_monitors!(nodes[1], 1);
5976 let starting_block = nodes[1].best_block_info();
5977 let mut block = Block {
5978 header: BlockHeader { version: 0x20000000, prev_blockhash: starting_block.0, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
5981 for _ in starting_block.1 + 1..TEST_FINAL_CLTV - CLTV_CLAIM_BUFFER + starting_block.1 + 2 {
5982 connect_block(&nodes[1], &block);
5983 block.header.prev_blockhash = block.block_hash();
5985 test_txn_broadcast(&nodes[1], &chan, None, if use_dust { HTLCType::NONE } else { HTLCType::SUCCESS });
5986 check_closed_broadcast!(nodes[1], true);
5987 check_added_monitors!(nodes[1], 1);
5990 fn do_htlc_claim_current_remote_commitment_only(use_dust: bool) {
5991 let chanmon_cfgs = create_chanmon_cfgs(2);
5992 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5993 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5994 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5995 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5996 let logger = test_utils::TestLogger::new();
5998 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1]);
5999 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6000 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), if use_dust { 50000 } else { 3000000 }, TEST_FINAL_CLTV, &logger).unwrap();
6001 nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
6002 check_added_monitors!(nodes[0], 1);
6004 let _as_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6006 // As far as A is concerned, the HTLC is now present only in the latest remote commitment
6007 // transaction, however it is not in A's latest local commitment, so we can just broadcast that
6008 // to "time out" the HTLC.
6010 let starting_block = nodes[1].best_block_info();
6011 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: starting_block.0, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6013 for _ in starting_block.1 + 1..TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + starting_block.1 + 2 {
6014 connect_block(&nodes[0], &Block { header, txdata: Vec::new()});
6015 header.prev_blockhash = header.block_hash();
6017 test_txn_broadcast(&nodes[0], &chan, None, HTLCType::NONE);
6018 check_closed_broadcast!(nodes[0], true);
6019 check_added_monitors!(nodes[0], 1);
6022 fn do_htlc_claim_previous_remote_commitment_only(use_dust: bool, check_revoke_no_close: bool) {
6023 let chanmon_cfgs = create_chanmon_cfgs(3);
6024 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
6025 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
6026 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
6027 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6029 // Fail the payment, but don't deliver A's final RAA, resulting in the HTLC only being present
6030 // in B's previous (unrevoked) commitment transaction, but none of A's commitment transactions.
6031 // Also optionally test that we *don't* fail the channel in case the commitment transaction was
6032 // actually revoked.
6033 let htlc_value = if use_dust { 50000 } else { 3000000 };
6034 let (_, our_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1]], htlc_value);
6035 assert!(nodes[1].node.fail_htlc_backwards(&our_payment_hash));
6036 expect_pending_htlcs_forwardable!(nodes[1]);
6037 check_added_monitors!(nodes[1], 1);
6039 let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6040 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fail_htlcs[0]);
6041 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_updates.commitment_signed);
6042 check_added_monitors!(nodes[0], 1);
6043 let as_updates = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6044 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_updates.0);
6045 check_added_monitors!(nodes[1], 1);
6046 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_updates.1);
6047 check_added_monitors!(nodes[1], 1);
6048 let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
6050 if check_revoke_no_close {
6051 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
6052 check_added_monitors!(nodes[0], 1);
6055 let starting_block = nodes[1].best_block_info();
6056 let mut block = Block {
6057 header: BlockHeader { version: 0x20000000, prev_blockhash: starting_block.0, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
6060 for _ in starting_block.1 + 1..TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + CHAN_CONFIRM_DEPTH + 2 {
6061 connect_block(&nodes[0], &block);
6062 block.header.prev_blockhash = block.block_hash();
6064 if !check_revoke_no_close {
6065 test_txn_broadcast(&nodes[0], &chan, None, HTLCType::NONE);
6066 check_closed_broadcast!(nodes[0], true);
6067 check_added_monitors!(nodes[0], 1);
6069 expect_payment_failed!(nodes[0], our_payment_hash, true);
6073 // Test that we close channels on-chain when broadcastable HTLCs reach their timeout window.
6074 // There are only a few cases to test here:
6075 // * its not really normative behavior, but we test that below-dust HTLCs "included" in
6076 // broadcastable commitment transactions result in channel closure,
6077 // * its included in an unrevoked-but-previous remote commitment transaction,
6078 // * its included in the latest remote or local commitment transactions.
6079 // We test each of the three possible commitment transactions individually and use both dust and
6081 // Note that we don't bother testing both outbound and inbound HTLC failures for each case, and we
6082 // assume they are handled the same across all six cases, as both outbound and inbound failures are
6083 // tested for at least one of the cases in other tests.
6085 fn htlc_claim_single_commitment_only_a() {
6086 do_htlc_claim_local_commitment_only(true);
6087 do_htlc_claim_local_commitment_only(false);
6089 do_htlc_claim_current_remote_commitment_only(true);
6090 do_htlc_claim_current_remote_commitment_only(false);
6094 fn htlc_claim_single_commitment_only_b() {
6095 do_htlc_claim_previous_remote_commitment_only(true, false);
6096 do_htlc_claim_previous_remote_commitment_only(false, false);
6097 do_htlc_claim_previous_remote_commitment_only(true, true);
6098 do_htlc_claim_previous_remote_commitment_only(false, true);
6103 fn bolt2_open_channel_sending_node_checks_part1() { //This test needs to be on its own as we are catching a panic
6104 let chanmon_cfgs = create_chanmon_cfgs(2);
6105 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6106 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6107 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6108 //Force duplicate channel ids
6109 for node in nodes.iter() {
6110 *node.keys_manager.override_channel_id_priv.lock().unwrap() = Some([0; 32]);
6113 // BOLT #2 spec: Sending node must ensure temporary_channel_id is unique from any other channel ID with the same peer.
6114 let channel_value_satoshis=10000;
6115 let push_msat=10001;
6116 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).unwrap();
6117 let node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
6118 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &node0_to_1_send_open_channel);
6120 //Create a second channel with a channel_id collision
6121 assert!(nodes[0].node.create_channel(nodes[0].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
6125 fn bolt2_open_channel_sending_node_checks_part2() {
6126 let chanmon_cfgs = create_chanmon_cfgs(2);
6127 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6128 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6129 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6131 // BOLT #2 spec: Sending node must set funding_satoshis to less than 2^24 satoshis
6132 let channel_value_satoshis=2^24;
6133 let push_msat=10001;
6134 assert!(nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
6136 // BOLT #2 spec: Sending node must set push_msat to equal or less than 1000 * funding_satoshis
6137 let channel_value_satoshis=10000;
6138 // Test when push_msat is equal to 1000 * funding_satoshis.
6139 let push_msat=1000*channel_value_satoshis+1;
6140 assert!(nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
6142 // BOLT #2 spec: Sending node must set set channel_reserve_satoshis greater than or equal to dust_limit_satoshis
6143 let channel_value_satoshis=10000;
6144 let push_msat=10001;
6145 assert!(nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_ok()); //Create a valid channel
6146 let node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
6147 assert!(node0_to_1_send_open_channel.channel_reserve_satoshis>=node0_to_1_send_open_channel.dust_limit_satoshis);
6149 // BOLT #2 spec: Sending node must set undefined bits in channel_flags to 0
6150 // 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
6151 assert!(node0_to_1_send_open_channel.channel_flags<=1);
6153 // 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.
6154 assert!(BREAKDOWN_TIMEOUT>0);
6155 assert!(node0_to_1_send_open_channel.to_self_delay==BREAKDOWN_TIMEOUT);
6157 // BOLT #2 spec: Sending node must ensure the chain_hash value identifies the chain it wishes to open the channel within.
6158 let chain_hash=genesis_block(Network::Testnet).header.block_hash();
6159 assert_eq!(node0_to_1_send_open_channel.chain_hash,chain_hash);
6161 // 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.
6162 assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.funding_pubkey.serialize()).is_ok());
6163 assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.revocation_basepoint.serialize()).is_ok());
6164 assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.htlc_basepoint.serialize()).is_ok());
6165 assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.payment_point.serialize()).is_ok());
6166 assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.delayed_payment_basepoint.serialize()).is_ok());
6170 fn bolt2_open_channel_sane_dust_limit() {
6171 let chanmon_cfgs = create_chanmon_cfgs(2);
6172 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6173 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6174 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6176 let channel_value_satoshis=1000000;
6177 let push_msat=10001;
6178 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).unwrap();
6179 let mut node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
6180 node0_to_1_send_open_channel.dust_limit_satoshis = 661;
6181 node0_to_1_send_open_channel.channel_reserve_satoshis = 100001;
6183 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &node0_to_1_send_open_channel);
6184 let events = nodes[1].node.get_and_clear_pending_msg_events();
6185 let err_msg = match events[0] {
6186 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id: _ } => {
6189 _ => panic!("Unexpected event"),
6191 assert_eq!(err_msg.data, "dust_limit_satoshis (661) is greater than the implementation limit (660)");
6194 // Test that if we fail to send an HTLC that is being freed from the holding cell, and the HTLC
6195 // originated from our node, its failure is surfaced to the user. We trigger this failure to
6196 // free the HTLC by increasing our fee while the HTLC is in the holding cell such that the HTLC
6197 // is no longer affordable once it's freed.
6199 fn test_fail_holding_cell_htlc_upon_free() {
6200 let chanmon_cfgs = create_chanmon_cfgs(2);
6201 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6202 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6203 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6204 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6205 let logger = test_utils::TestLogger::new();
6207 // First nodes[0] generates an update_fee, setting the channel's
6208 // pending_update_fee.
6209 nodes[0].node.update_fee(chan.2, get_feerate!(nodes[0], chan.2) + 20).unwrap();
6210 check_added_monitors!(nodes[0], 1);
6212 let events = nodes[0].node.get_and_clear_pending_msg_events();
6213 assert_eq!(events.len(), 1);
6214 let (update_msg, commitment_signed) = match events[0] {
6215 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
6216 (update_fee.as_ref(), commitment_signed)
6218 _ => panic!("Unexpected event"),
6221 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
6223 let mut chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6224 let channel_reserve = chan_stat.channel_reserve_msat;
6225 let feerate = get_feerate!(nodes[0], chan.2);
6227 // 2* and +1 HTLCs on the commit tx fee calculation for the fee spike reserve.
6228 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6229 let max_can_send = 5000000 - channel_reserve - 2*commit_tx_fee_msat(feerate, 1 + 1);
6230 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6231 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], max_can_send, TEST_FINAL_CLTV, &logger).unwrap();
6233 // Send a payment which passes reserve checks but gets stuck in the holding cell.
6234 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6235 chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6236 assert_eq!(chan_stat.holding_cell_outbound_amount_msat, max_can_send);
6238 // Flush the pending fee update.
6239 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
6240 let (as_revoke_and_ack, _) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6241 check_added_monitors!(nodes[1], 1);
6242 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_revoke_and_ack);
6243 check_added_monitors!(nodes[0], 1);
6245 // Upon receipt of the RAA, there will be an attempt to resend the holding cell
6246 // HTLC, but now that the fee has been raised the payment will now fail, causing
6247 // us to surface its failure to the user.
6248 chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6249 assert_eq!(chan_stat.holding_cell_outbound_amount_msat, 0);
6250 nodes[0].logger.assert_log("lightning::ln::channel".to_string(), format!("Freeing holding cell with 1 HTLC updates in channel {}", hex::encode(chan.2)), 1);
6251 let failure_log = format!("Failed to send HTLC with payment_hash {} due to Cannot send value that would put our balance under counterparty-announced channel reserve value ({}) in channel {}",
6252 hex::encode(our_payment_hash.0), chan_stat.channel_reserve_msat, hex::encode(chan.2));
6253 nodes[0].logger.assert_log("lightning::ln::channel".to_string(), failure_log.to_string(), 1);
6255 // Check that the payment failed to be sent out.
6256 let events = nodes[0].node.get_and_clear_pending_events();
6257 assert_eq!(events.len(), 1);
6259 &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, ref error_code, ref error_data } => {
6260 assert_eq!(our_payment_hash.clone(), *payment_hash);
6261 assert_eq!(*rejected_by_dest, false);
6262 assert_eq!(*error_code, None);
6263 assert_eq!(*error_data, None);
6265 _ => panic!("Unexpected event"),
6269 // Test that if multiple HTLCs are released from the holding cell and one is
6270 // valid but the other is no longer valid upon release, the valid HTLC can be
6271 // successfully completed while the other one fails as expected.
6273 fn test_free_and_fail_holding_cell_htlcs() {
6274 let chanmon_cfgs = create_chanmon_cfgs(2);
6275 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6276 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6277 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6278 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6279 let logger = test_utils::TestLogger::new();
6281 // First nodes[0] generates an update_fee, setting the channel's
6282 // pending_update_fee.
6283 nodes[0].node.update_fee(chan.2, get_feerate!(nodes[0], chan.2) + 200).unwrap();
6284 check_added_monitors!(nodes[0], 1);
6286 let events = nodes[0].node.get_and_clear_pending_msg_events();
6287 assert_eq!(events.len(), 1);
6288 let (update_msg, commitment_signed) = match events[0] {
6289 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
6290 (update_fee.as_ref(), commitment_signed)
6292 _ => panic!("Unexpected event"),
6295 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
6297 let mut chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6298 let channel_reserve = chan_stat.channel_reserve_msat;
6299 let feerate = get_feerate!(nodes[0], chan.2);
6301 // 2* and +1 HTLCs on the commit tx fee calculation for the fee spike reserve.
6302 let (payment_preimage_1, payment_hash_1, payment_secret_1) = get_payment_preimage_hash!(nodes[1]);
6304 let (_, payment_hash_2, payment_secret_2) = get_payment_preimage_hash!(nodes[1]);
6305 let amt_2 = 5000000 - channel_reserve - 2*commit_tx_fee_msat(feerate, 2 + 1) - amt_1;
6306 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6307 let route_1 = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], amt_1, TEST_FINAL_CLTV, &logger).unwrap();
6308 let route_2 = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], amt_2, TEST_FINAL_CLTV, &logger).unwrap();
6310 // Send 2 payments which pass reserve checks but get stuck in the holding cell.
6311 nodes[0].node.send_payment(&route_1, payment_hash_1, &Some(payment_secret_1)).unwrap();
6312 chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6313 assert_eq!(chan_stat.holding_cell_outbound_amount_msat, amt_1);
6314 nodes[0].node.send_payment(&route_2, payment_hash_2, &Some(payment_secret_2)).unwrap();
6315 chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6316 assert_eq!(chan_stat.holding_cell_outbound_amount_msat, amt_1 + amt_2);
6318 // Flush the pending fee update.
6319 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
6320 let (revoke_and_ack, commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6321 check_added_monitors!(nodes[1], 1);
6322 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_and_ack);
6323 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
6324 check_added_monitors!(nodes[0], 2);
6326 // Upon receipt of the RAA, there will be an attempt to resend the holding cell HTLCs,
6327 // but now that the fee has been raised the second payment will now fail, causing us
6328 // to surface its failure to the user. The first payment should succeed.
6329 chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6330 assert_eq!(chan_stat.holding_cell_outbound_amount_msat, 0);
6331 nodes[0].logger.assert_log("lightning::ln::channel".to_string(), format!("Freeing holding cell with 2 HTLC updates in channel {}", hex::encode(chan.2)), 1);
6332 let failure_log = format!("Failed to send HTLC with payment_hash {} due to Cannot send value that would put our balance under counterparty-announced channel reserve value ({}) in channel {}",
6333 hex::encode(payment_hash_2.0), chan_stat.channel_reserve_msat, hex::encode(chan.2));
6334 nodes[0].logger.assert_log("lightning::ln::channel".to_string(), failure_log.to_string(), 1);
6336 // Check that the second payment failed to be sent out.
6337 let events = nodes[0].node.get_and_clear_pending_events();
6338 assert_eq!(events.len(), 1);
6340 &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, ref error_code, ref error_data } => {
6341 assert_eq!(payment_hash_2.clone(), *payment_hash);
6342 assert_eq!(*rejected_by_dest, false);
6343 assert_eq!(*error_code, None);
6344 assert_eq!(*error_data, None);
6346 _ => panic!("Unexpected event"),
6349 // Complete the first payment and the RAA from the fee update.
6350 let (payment_event, send_raa_event) = {
6351 let mut msgs = nodes[0].node.get_and_clear_pending_msg_events();
6352 assert_eq!(msgs.len(), 2);
6353 (SendEvent::from_event(msgs.remove(0)), msgs.remove(0))
6355 let raa = match send_raa_event {
6356 MessageSendEvent::SendRevokeAndACK { msg, .. } => msg,
6357 _ => panic!("Unexpected event"),
6359 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &raa);
6360 check_added_monitors!(nodes[1], 1);
6361 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6362 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6363 let events = nodes[1].node.get_and_clear_pending_events();
6364 assert_eq!(events.len(), 1);
6366 Event::PendingHTLCsForwardable { .. } => {},
6367 _ => panic!("Unexpected event"),
6369 nodes[1].node.process_pending_htlc_forwards();
6370 let events = nodes[1].node.get_and_clear_pending_events();
6371 assert_eq!(events.len(), 1);
6373 Event::PaymentReceived { .. } => {},
6374 _ => panic!("Unexpected event"),
6376 nodes[1].node.claim_funds(payment_preimage_1);
6377 check_added_monitors!(nodes[1], 1);
6378 let update_msgs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6379 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_msgs.update_fulfill_htlcs[0]);
6380 commitment_signed_dance!(nodes[0], nodes[1], update_msgs.commitment_signed, false, true);
6381 let events = nodes[0].node.get_and_clear_pending_events();
6382 assert_eq!(events.len(), 1);
6384 Event::PaymentSent { ref payment_preimage } => {
6385 assert_eq!(*payment_preimage, payment_preimage_1);
6387 _ => panic!("Unexpected event"),
6391 // Test that if we fail to forward an HTLC that is being freed from the holding cell that the
6392 // HTLC is failed backwards. We trigger this failure to forward the freed HTLC by increasing
6393 // our fee while the HTLC is in the holding cell such that the HTLC is no longer affordable
6396 fn test_fail_holding_cell_htlc_upon_free_multihop() {
6397 let chanmon_cfgs = create_chanmon_cfgs(3);
6398 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
6399 // When this test was written, the default base fee floated based on the HTLC count.
6400 // It is now fixed, so we simply set the fee to the expected value here.
6401 let mut config = test_default_channel_config();
6402 config.channel_options.forwarding_fee_base_msat = 196;
6403 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[Some(config.clone()), Some(config.clone()), Some(config.clone())]);
6404 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
6405 let chan_0_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6406 let chan_1_2 = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6407 let logger = test_utils::TestLogger::new();
6409 // First nodes[1] generates an update_fee, setting the channel's
6410 // pending_update_fee.
6411 nodes[1].node.update_fee(chan_1_2.2, get_feerate!(nodes[1], chan_1_2.2) + 20).unwrap();
6412 check_added_monitors!(nodes[1], 1);
6414 let events = nodes[1].node.get_and_clear_pending_msg_events();
6415 assert_eq!(events.len(), 1);
6416 let (update_msg, commitment_signed) = match events[0] {
6417 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
6418 (update_fee.as_ref(), commitment_signed)
6420 _ => panic!("Unexpected event"),
6423 nodes[2].node.handle_update_fee(&nodes[1].node.get_our_node_id(), update_msg.unwrap());
6425 let mut chan_stat = get_channel_value_stat!(nodes[0], chan_0_1.2);
6426 let channel_reserve = chan_stat.channel_reserve_msat;
6427 let feerate = get_feerate!(nodes[0], chan_0_1.2);
6429 // Send a payment which passes reserve checks but gets stuck in the holding cell.
6431 let total_routing_fee_msat = (nodes.len() - 2) as u64 * feemsat;
6432 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[2]);
6433 let max_can_send = 5000000 - channel_reserve - 2*commit_tx_fee_msat(feerate, 1 + 1) - total_routing_fee_msat;
6434 let payment_event = {
6435 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6436 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[2].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], max_can_send, TEST_FINAL_CLTV, &logger).unwrap();
6437 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6438 check_added_monitors!(nodes[0], 1);
6440 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
6441 assert_eq!(events.len(), 1);
6443 SendEvent::from_event(events.remove(0))
6445 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6446 check_added_monitors!(nodes[1], 0);
6447 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6448 expect_pending_htlcs_forwardable!(nodes[1]);
6450 chan_stat = get_channel_value_stat!(nodes[1], chan_1_2.2);
6451 assert_eq!(chan_stat.holding_cell_outbound_amount_msat, max_can_send);
6453 // Flush the pending fee update.
6454 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), commitment_signed);
6455 let (raa, commitment_signed) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
6456 check_added_monitors!(nodes[2], 1);
6457 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &raa);
6458 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &commitment_signed);
6459 check_added_monitors!(nodes[1], 2);
6461 // A final RAA message is generated to finalize the fee update.
6462 let events = nodes[1].node.get_and_clear_pending_msg_events();
6463 assert_eq!(events.len(), 1);
6465 let raa_msg = match &events[0] {
6466 &MessageSendEvent::SendRevokeAndACK { ref msg, .. } => {
6469 _ => panic!("Unexpected event"),
6472 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &raa_msg);
6473 check_added_monitors!(nodes[2], 1);
6474 assert!(nodes[2].node.get_and_clear_pending_msg_events().is_empty());
6476 // nodes[1]'s ChannelManager will now signal that we have HTLC forwards to process.
6477 let process_htlc_forwards_event = nodes[1].node.get_and_clear_pending_events();
6478 assert_eq!(process_htlc_forwards_event.len(), 1);
6479 match &process_htlc_forwards_event[0] {
6480 &Event::PendingHTLCsForwardable { .. } => {},
6481 _ => panic!("Unexpected event"),
6484 // In response, we call ChannelManager's process_pending_htlc_forwards
6485 nodes[1].node.process_pending_htlc_forwards();
6486 check_added_monitors!(nodes[1], 1);
6488 // This causes the HTLC to be failed backwards.
6489 let fail_event = nodes[1].node.get_and_clear_pending_msg_events();
6490 assert_eq!(fail_event.len(), 1);
6491 let (fail_msg, commitment_signed) = match &fail_event[0] {
6492 &MessageSendEvent::UpdateHTLCs { ref updates, .. } => {
6493 assert_eq!(updates.update_add_htlcs.len(), 0);
6494 assert_eq!(updates.update_fulfill_htlcs.len(), 0);
6495 assert_eq!(updates.update_fail_malformed_htlcs.len(), 0);
6496 assert_eq!(updates.update_fail_htlcs.len(), 1);
6497 (updates.update_fail_htlcs[0].clone(), updates.commitment_signed.clone())
6499 _ => panic!("Unexpected event"),
6502 // Pass the failure messages back to nodes[0].
6503 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
6504 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
6506 // Complete the HTLC failure+removal process.
6507 let (raa, commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6508 check_added_monitors!(nodes[0], 1);
6509 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &raa);
6510 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commitment_signed);
6511 check_added_monitors!(nodes[1], 2);
6512 let final_raa_event = nodes[1].node.get_and_clear_pending_msg_events();
6513 assert_eq!(final_raa_event.len(), 1);
6514 let raa = match &final_raa_event[0] {
6515 &MessageSendEvent::SendRevokeAndACK { ref msg, .. } => msg.clone(),
6516 _ => panic!("Unexpected event"),
6518 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &raa);
6519 expect_payment_failure_chan_update!(nodes[0], chan_1_2.0.contents.short_channel_id, false);
6520 expect_payment_failed!(nodes[0], our_payment_hash, false);
6521 check_added_monitors!(nodes[0], 1);
6524 // BOLT 2 Requirements for the Sender when constructing and sending an update_add_htlc message.
6525 // 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.
6526 //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.
6529 fn test_update_add_htlc_bolt2_sender_value_below_minimum_msat() {
6530 //BOLT2 Requirement: MUST NOT offer amount_msat below the receiving node's htlc_minimum_msat (same validation check catches both of these)
6531 let chanmon_cfgs = create_chanmon_cfgs(2);
6532 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6533 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6534 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6535 let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6537 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6538 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6539 let logger = test_utils::TestLogger::new();
6540 let mut route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
6541 route.paths[0][0].fee_msat = 100;
6543 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
6544 assert!(regex::Regex::new(r"Cannot send less than their minimum HTLC value \(\d+\)").unwrap().is_match(err)));
6545 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6546 nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot send less than their minimum HTLC value".to_string(), 1);
6550 fn test_update_add_htlc_bolt2_sender_zero_value_msat() {
6551 //BOLT2 Requirement: MUST offer amount_msat greater than 0.
6552 let chanmon_cfgs = create_chanmon_cfgs(2);
6553 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6554 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6555 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6556 let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6557 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6559 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6560 let logger = test_utils::TestLogger::new();
6561 let mut route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
6562 route.paths[0][0].fee_msat = 0;
6563 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
6564 assert_eq!(err, "Cannot send 0-msat HTLC"));
6566 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6567 nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot send 0-msat HTLC".to_string(), 1);
6571 fn test_update_add_htlc_bolt2_receiver_zero_value_msat() {
6572 //BOLT2 Requirement: MUST offer amount_msat greater than 0.
6573 let chanmon_cfgs = create_chanmon_cfgs(2);
6574 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6575 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6576 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6577 let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6579 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6580 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6581 let logger = test_utils::TestLogger::new();
6582 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
6583 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6584 check_added_monitors!(nodes[0], 1);
6585 let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6586 updates.update_add_htlcs[0].amount_msat = 0;
6588 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6589 nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Remote side tried to send a 0-msat HTLC".to_string(), 1);
6590 check_closed_broadcast!(nodes[1], true).unwrap();
6591 check_added_monitors!(nodes[1], 1);
6595 fn test_update_add_htlc_bolt2_sender_cltv_expiry_too_high() {
6596 //BOLT 2 Requirement: MUST set cltv_expiry less than 500000000.
6597 //It is enforced when constructing a route.
6598 let chanmon_cfgs = create_chanmon_cfgs(2);
6599 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6600 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6601 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6602 let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 0, InitFeatures::known(), InitFeatures::known());
6603 let logger = test_utils::TestLogger::new();
6605 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6607 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6608 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100000000, 500000001, &logger).unwrap();
6609 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::RouteError { ref err },
6610 assert_eq!(err, &"Channel CLTV overflowed?"));
6614 fn test_update_add_htlc_bolt2_sender_exceed_max_htlc_num_and_htlc_id_increment() {
6615 //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.
6616 //BOLT 2 Requirement: for the first HTLC it offers MUST set id to 0.
6617 //BOLT 2 Requirement: MUST increase the value of id by 1 for each successive offer.
6618 let chanmon_cfgs = create_chanmon_cfgs(2);
6619 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6620 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6621 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6622 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 0, InitFeatures::known(), InitFeatures::known());
6623 let max_accepted_htlcs = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().counterparty_max_accepted_htlcs as u64;
6625 let logger = test_utils::TestLogger::new();
6626 for i in 0..max_accepted_htlcs {
6627 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6628 let payment_event = {
6629 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6630 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
6631 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6632 check_added_monitors!(nodes[0], 1);
6634 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
6635 assert_eq!(events.len(), 1);
6636 if let MessageSendEvent::UpdateHTLCs { node_id: _, updates: msgs::CommitmentUpdate{ update_add_htlcs: ref htlcs, .. }, } = events[0] {
6637 assert_eq!(htlcs[0].htlc_id, i);
6641 SendEvent::from_event(events.remove(0))
6643 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6644 check_added_monitors!(nodes[1], 0);
6645 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6647 expect_pending_htlcs_forwardable!(nodes[1]);
6648 expect_payment_received!(nodes[1], our_payment_hash, our_payment_secret, 100000);
6650 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6651 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6652 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
6653 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
6654 assert!(regex::Regex::new(r"Cannot push more than their max accepted HTLCs \(\d+\)").unwrap().is_match(err)));
6656 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6657 nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot push more than their max accepted HTLCs".to_string(), 1);
6661 fn test_update_add_htlc_bolt2_sender_exceed_max_htlc_value_in_flight() {
6662 //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.
6663 let chanmon_cfgs = create_chanmon_cfgs(2);
6664 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6665 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6666 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6667 let channel_value = 100000;
6668 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, channel_value, 0, InitFeatures::known(), InitFeatures::known());
6669 let max_in_flight = get_channel_value_stat!(nodes[0], chan.2).counterparty_max_htlc_value_in_flight_msat;
6671 send_payment(&nodes[0], &vec!(&nodes[1])[..], max_in_flight);
6673 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6674 // Manually create a route over our max in flight (which our router normally automatically
6676 let route = Route { paths: vec![vec![RouteHop {
6677 pubkey: nodes[1].node.get_our_node_id(), node_features: NodeFeatures::known(), channel_features: ChannelFeatures::known(),
6678 short_channel_id: nodes[1].node.list_usable_channels()[0].short_channel_id.unwrap(),
6679 fee_msat: max_in_flight + 1, cltv_expiry_delta: TEST_FINAL_CLTV
6681 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
6682 assert!(regex::Regex::new(r"Cannot send value that would put us over the max HTLC value in flight our peer will accept \(\d+\)").unwrap().is_match(err)));
6684 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6685 nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot send value that would put us over the max HTLC value in flight our peer will accept".to_string(), 1);
6687 send_payment(&nodes[0], &[&nodes[1]], max_in_flight);
6690 // BOLT 2 Requirements for the Receiver when handling an update_add_htlc message.
6692 fn test_update_add_htlc_bolt2_receiver_check_amount_received_more_than_min() {
6693 //BOLT2 Requirement: receiving an amount_msat equal to 0, OR less than its own htlc_minimum_msat -> SHOULD fail the channel.
6694 let chanmon_cfgs = create_chanmon_cfgs(2);
6695 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6696 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6697 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6698 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6699 let htlc_minimum_msat: u64;
6701 let chan_lock = nodes[0].node.channel_state.lock().unwrap();
6702 let channel = chan_lock.by_id.get(&chan.2).unwrap();
6703 htlc_minimum_msat = channel.get_holder_htlc_minimum_msat();
6706 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6707 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6708 let logger = test_utils::TestLogger::new();
6709 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], htlc_minimum_msat, TEST_FINAL_CLTV, &logger).unwrap();
6710 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6711 check_added_monitors!(nodes[0], 1);
6712 let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6713 updates.update_add_htlcs[0].amount_msat = htlc_minimum_msat-1;
6714 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6715 assert!(nodes[1].node.list_channels().is_empty());
6716 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6717 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()));
6718 check_added_monitors!(nodes[1], 1);
6722 fn test_update_add_htlc_bolt2_receiver_sender_can_afford_amount_sent() {
6723 //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
6724 let chanmon_cfgs = create_chanmon_cfgs(2);
6725 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6726 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6727 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6728 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6729 let logger = test_utils::TestLogger::new();
6731 let chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6732 let channel_reserve = chan_stat.channel_reserve_msat;
6733 let feerate = get_feerate!(nodes[0], chan.2);
6734 // The 2* and +1 are for the fee spike reserve.
6735 let commit_tx_fee_outbound = 2 * commit_tx_fee_msat(feerate, 1 + 1);
6737 let max_can_send = 5000000 - channel_reserve - commit_tx_fee_outbound;
6738 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6739 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6740 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], max_can_send, TEST_FINAL_CLTV, &logger).unwrap();
6741 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6742 check_added_monitors!(nodes[0], 1);
6743 let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6745 // Even though channel-initiator senders are required to respect the fee_spike_reserve,
6746 // at this time channel-initiatee receivers are not required to enforce that senders
6747 // respect the fee_spike_reserve.
6748 updates.update_add_htlcs[0].amount_msat = max_can_send + commit_tx_fee_outbound + 1;
6749 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6751 assert!(nodes[1].node.list_channels().is_empty());
6752 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6753 assert_eq!(err_msg.data, "Remote HTLC add would put them under remote reserve value");
6754 check_added_monitors!(nodes[1], 1);
6758 fn test_update_add_htlc_bolt2_receiver_check_max_htlc_limit() {
6759 //BOLT 2 Requirement: if a sending node adds more than its max_accepted_htlcs HTLCs to its local commitment transaction: SHOULD fail the channel
6760 //BOLT 2 Requirement: MUST allow multiple HTLCs with the same payment_hash.
6761 let chanmon_cfgs = create_chanmon_cfgs(2);
6762 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6763 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6764 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6765 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6766 let logger = test_utils::TestLogger::new();
6768 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6769 let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
6771 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6772 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 3999999, TEST_FINAL_CLTV, &logger).unwrap();
6774 let cur_height = nodes[0].node.best_block.read().unwrap().height() + 1;
6775 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::signing_only(), &route.paths[0], &session_priv).unwrap();
6776 let (onion_payloads, _htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 3999999, &Some(our_payment_secret), cur_height).unwrap();
6777 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &our_payment_hash);
6779 let mut msg = msgs::UpdateAddHTLC {
6783 payment_hash: our_payment_hash,
6784 cltv_expiry: htlc_cltv,
6785 onion_routing_packet: onion_packet.clone(),
6788 for i in 0..super::channel::OUR_MAX_HTLCS {
6789 msg.htlc_id = i as u64;
6790 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
6792 msg.htlc_id = (super::channel::OUR_MAX_HTLCS) as u64;
6793 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
6795 assert!(nodes[1].node.list_channels().is_empty());
6796 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6797 assert!(regex::Regex::new(r"Remote tried to push more than our max accepted HTLCs \(\d+\)").unwrap().is_match(err_msg.data.as_str()));
6798 check_added_monitors!(nodes[1], 1);
6802 fn test_update_add_htlc_bolt2_receiver_check_max_in_flight_msat() {
6803 //OR adds more than its max_htlc_value_in_flight_msat worth of offered HTLCs to its local commitment transaction: SHOULD fail the channel
6804 let chanmon_cfgs = create_chanmon_cfgs(2);
6805 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6806 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6807 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6808 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
6809 let logger = test_utils::TestLogger::new();
6811 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6812 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6813 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 1000000, TEST_FINAL_CLTV, &logger).unwrap();
6814 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6815 check_added_monitors!(nodes[0], 1);
6816 let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6817 updates.update_add_htlcs[0].amount_msat = get_channel_value_stat!(nodes[1], chan.2).counterparty_max_htlc_value_in_flight_msat + 1;
6818 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6820 assert!(nodes[1].node.list_channels().is_empty());
6821 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6822 assert!(regex::Regex::new("Remote HTLC add would put them over our max HTLC value").unwrap().is_match(err_msg.data.as_str()));
6823 check_added_monitors!(nodes[1], 1);
6827 fn test_update_add_htlc_bolt2_receiver_check_cltv_expiry() {
6828 //BOLT2 Requirement: if sending node sets cltv_expiry to greater or equal to 500000000: SHOULD fail the channel.
6829 let chanmon_cfgs = create_chanmon_cfgs(2);
6830 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6831 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6832 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6833 let logger = test_utils::TestLogger::new();
6835 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6836 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6837 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6838 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 1000000, TEST_FINAL_CLTV, &logger).unwrap();
6839 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6840 check_added_monitors!(nodes[0], 1);
6841 let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6842 updates.update_add_htlcs[0].cltv_expiry = 500000000;
6843 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6845 assert!(nodes[1].node.list_channels().is_empty());
6846 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6847 assert_eq!(err_msg.data,"Remote provided CLTV expiry in seconds instead of block height");
6848 check_added_monitors!(nodes[1], 1);
6852 fn test_update_add_htlc_bolt2_receiver_check_repeated_id_ignore() {
6853 //BOLT 2 requirement: if the sender did not previously acknowledge the commitment of that HTLC: MUST ignore a repeated id value after a reconnection.
6854 // We test this by first testing that that repeated HTLCs pass commitment signature checks
6855 // after disconnect and that non-sequential htlc_ids result in a channel failure.
6856 let chanmon_cfgs = create_chanmon_cfgs(2);
6857 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6858 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6859 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6860 let logger = test_utils::TestLogger::new();
6862 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6863 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6864 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6865 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 1000000, TEST_FINAL_CLTV, &logger).unwrap();
6866 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6867 check_added_monitors!(nodes[0], 1);
6868 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6869 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6871 //Disconnect and Reconnect
6872 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
6873 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
6874 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
6875 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
6876 assert_eq!(reestablish_1.len(), 1);
6877 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
6878 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
6879 assert_eq!(reestablish_2.len(), 1);
6880 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
6881 handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
6882 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
6883 handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
6886 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6887 assert_eq!(updates.commitment_signed.htlc_signatures.len(), 1);
6888 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &updates.commitment_signed);
6889 check_added_monitors!(nodes[1], 1);
6890 let _bs_responses = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6892 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6894 assert!(nodes[1].node.list_channels().is_empty());
6895 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6896 assert!(regex::Regex::new(r"Remote skipped HTLC ID \(skipped ID: \d+\)").unwrap().is_match(err_msg.data.as_str()));
6897 check_added_monitors!(nodes[1], 1);
6901 fn test_update_fulfill_htlc_bolt2_update_fulfill_htlc_before_commitment() {
6902 //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.
6904 let chanmon_cfgs = create_chanmon_cfgs(2);
6905 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6906 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6907 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6908 let logger = test_utils::TestLogger::new();
6909 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6910 let (our_payment_preimage, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6911 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6912 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 1000000, TEST_FINAL_CLTV, &logger).unwrap();
6913 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6915 check_added_monitors!(nodes[0], 1);
6916 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6917 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6919 let update_msg = msgs::UpdateFulfillHTLC{
6922 payment_preimage: our_payment_preimage,
6925 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6927 assert!(nodes[0].node.list_channels().is_empty());
6928 let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6929 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()));
6930 check_added_monitors!(nodes[0], 1);
6934 fn test_update_fulfill_htlc_bolt2_update_fail_htlc_before_commitment() {
6935 //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.
6937 let chanmon_cfgs = create_chanmon_cfgs(2);
6938 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6939 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6940 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6941 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6942 let logger = test_utils::TestLogger::new();
6944 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6945 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6946 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 1000000, TEST_FINAL_CLTV, &logger).unwrap();
6947 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6948 check_added_monitors!(nodes[0], 1);
6949 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6950 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6952 let update_msg = msgs::UpdateFailHTLC{
6955 reason: msgs::OnionErrorPacket { data: Vec::new()},
6958 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6960 assert!(nodes[0].node.list_channels().is_empty());
6961 let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6962 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()));
6963 check_added_monitors!(nodes[0], 1);
6967 fn test_update_fulfill_htlc_bolt2_update_fail_malformed_htlc_before_commitment() {
6968 //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.
6970 let chanmon_cfgs = create_chanmon_cfgs(2);
6971 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6972 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6973 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6974 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6975 let logger = test_utils::TestLogger::new();
6977 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6978 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6979 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 1000000, TEST_FINAL_CLTV, &logger).unwrap();
6980 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6981 check_added_monitors!(nodes[0], 1);
6982 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6983 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6984 let update_msg = msgs::UpdateFailMalformedHTLC{
6987 sha256_of_onion: [1; 32],
6988 failure_code: 0x8000,
6991 nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6993 assert!(nodes[0].node.list_channels().is_empty());
6994 let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6995 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()));
6996 check_added_monitors!(nodes[0], 1);
7000 fn test_update_fulfill_htlc_bolt2_incorrect_htlc_id() {
7001 //BOLT 2 Requirement: A receiving node: if the id does not correspond to an HTLC in its current commitment transaction MUST fail the channel.
7003 let chanmon_cfgs = create_chanmon_cfgs(2);
7004 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7005 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7006 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7007 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7009 let our_payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 100000).0;
7011 nodes[1].node.claim_funds(our_payment_preimage);
7012 check_added_monitors!(nodes[1], 1);
7014 let events = nodes[1].node.get_and_clear_pending_msg_events();
7015 assert_eq!(events.len(), 1);
7016 let mut update_fulfill_msg: msgs::UpdateFulfillHTLC = {
7018 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, .. } } => {
7019 assert!(update_add_htlcs.is_empty());
7020 assert_eq!(update_fulfill_htlcs.len(), 1);
7021 assert!(update_fail_htlcs.is_empty());
7022 assert!(update_fail_malformed_htlcs.is_empty());
7023 assert!(update_fee.is_none());
7024 update_fulfill_htlcs[0].clone()
7026 _ => panic!("Unexpected event"),
7030 update_fulfill_msg.htlc_id = 1;
7032 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_msg);
7034 assert!(nodes[0].node.list_channels().is_empty());
7035 let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
7036 assert_eq!(err_msg.data, "Remote tried to fulfill/fail an HTLC we couldn't find");
7037 check_added_monitors!(nodes[0], 1);
7041 fn test_update_fulfill_htlc_bolt2_wrong_preimage() {
7042 //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.
7044 let chanmon_cfgs = create_chanmon_cfgs(2);
7045 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7046 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7047 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7048 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7050 let our_payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 100000).0;
7052 nodes[1].node.claim_funds(our_payment_preimage);
7053 check_added_monitors!(nodes[1], 1);
7055 let events = nodes[1].node.get_and_clear_pending_msg_events();
7056 assert_eq!(events.len(), 1);
7057 let mut update_fulfill_msg: msgs::UpdateFulfillHTLC = {
7059 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, .. } } => {
7060 assert!(update_add_htlcs.is_empty());
7061 assert_eq!(update_fulfill_htlcs.len(), 1);
7062 assert!(update_fail_htlcs.is_empty());
7063 assert!(update_fail_malformed_htlcs.is_empty());
7064 assert!(update_fee.is_none());
7065 update_fulfill_htlcs[0].clone()
7067 _ => panic!("Unexpected event"),
7071 update_fulfill_msg.payment_preimage = PaymentPreimage([1; 32]);
7073 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_msg);
7075 assert!(nodes[0].node.list_channels().is_empty());
7076 let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
7077 assert!(regex::Regex::new(r"Remote tried to fulfill HTLC \(\d+\) with an incorrect preimage").unwrap().is_match(err_msg.data.as_str()));
7078 check_added_monitors!(nodes[0], 1);
7082 fn test_update_fulfill_htlc_bolt2_missing_badonion_bit_for_malformed_htlc_message() {
7083 //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.
7085 let chanmon_cfgs = create_chanmon_cfgs(2);
7086 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7087 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7088 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7089 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7090 let logger = test_utils::TestLogger::new();
7092 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
7093 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
7094 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 1000000, TEST_FINAL_CLTV, &logger).unwrap();
7095 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
7096 check_added_monitors!(nodes[0], 1);
7098 let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
7099 updates.update_add_htlcs[0].onion_routing_packet.version = 1; //Produce a malformed HTLC message
7101 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
7102 check_added_monitors!(nodes[1], 0);
7103 commitment_signed_dance!(nodes[1], nodes[0], updates.commitment_signed, false, true);
7105 let events = nodes[1].node.get_and_clear_pending_msg_events();
7107 let mut update_msg: msgs::UpdateFailMalformedHTLC = {
7109 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, .. } } => {
7110 assert!(update_add_htlcs.is_empty());
7111 assert!(update_fulfill_htlcs.is_empty());
7112 assert!(update_fail_htlcs.is_empty());
7113 assert_eq!(update_fail_malformed_htlcs.len(), 1);
7114 assert!(update_fee.is_none());
7115 update_fail_malformed_htlcs[0].clone()
7117 _ => panic!("Unexpected event"),
7120 update_msg.failure_code &= !0x8000;
7121 nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
7123 assert!(nodes[0].node.list_channels().is_empty());
7124 let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
7125 assert_eq!(err_msg.data, "Got update_fail_malformed_htlc with BADONION not set");
7126 check_added_monitors!(nodes[0], 1);
7130 fn test_update_fulfill_htlc_bolt2_after_malformed_htlc_message_must_forward_update_fail_htlc() {
7131 //BOLT 2 Requirement: a receiving node which has an outgoing HTLC canceled by update_fail_malformed_htlc:
7132 // * 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.
7134 let chanmon_cfgs = create_chanmon_cfgs(3);
7135 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7136 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
7137 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7138 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7139 create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7140 let logger = test_utils::TestLogger::new();
7142 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[2]);
7145 let mut payment_event = {
7146 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
7147 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[2].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
7148 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
7149 check_added_monitors!(nodes[0], 1);
7150 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
7151 assert_eq!(events.len(), 1);
7152 SendEvent::from_event(events.remove(0))
7154 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
7155 check_added_monitors!(nodes[1], 0);
7156 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
7157 expect_pending_htlcs_forwardable!(nodes[1]);
7158 let mut events_2 = nodes[1].node.get_and_clear_pending_msg_events();
7159 assert_eq!(events_2.len(), 1);
7160 check_added_monitors!(nodes[1], 1);
7161 payment_event = SendEvent::from_event(events_2.remove(0));
7162 assert_eq!(payment_event.msgs.len(), 1);
7165 payment_event.msgs[0].onion_routing_packet.version = 1; //Produce a malformed HTLC message
7166 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
7167 check_added_monitors!(nodes[2], 0);
7168 commitment_signed_dance!(nodes[2], nodes[1], payment_event.commitment_msg, false, true);
7170 let events_3 = nodes[2].node.get_and_clear_pending_msg_events();
7171 assert_eq!(events_3.len(), 1);
7172 let update_msg : (msgs::UpdateFailMalformedHTLC, msgs::CommitmentSigned) = {
7174 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 } } => {
7175 assert!(update_add_htlcs.is_empty());
7176 assert!(update_fulfill_htlcs.is_empty());
7177 assert!(update_fail_htlcs.is_empty());
7178 assert_eq!(update_fail_malformed_htlcs.len(), 1);
7179 assert!(update_fee.is_none());
7180 (update_fail_malformed_htlcs[0].clone(), commitment_signed.clone())
7182 _ => panic!("Unexpected event"),
7186 nodes[1].node.handle_update_fail_malformed_htlc(&nodes[2].node.get_our_node_id(), &update_msg.0);
7188 check_added_monitors!(nodes[1], 0);
7189 commitment_signed_dance!(nodes[1], nodes[2], update_msg.1, false, true);
7190 expect_pending_htlcs_forwardable!(nodes[1]);
7191 let events_4 = nodes[1].node.get_and_clear_pending_msg_events();
7192 assert_eq!(events_4.len(), 1);
7194 //Confirm that handlinge the update_malformed_htlc message produces an update_fail_htlc message to be forwarded back along the route
7196 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, .. } } => {
7197 assert!(update_add_htlcs.is_empty());
7198 assert!(update_fulfill_htlcs.is_empty());
7199 assert_eq!(update_fail_htlcs.len(), 1);
7200 assert!(update_fail_malformed_htlcs.is_empty());
7201 assert!(update_fee.is_none());
7203 _ => panic!("Unexpected event"),
7206 check_added_monitors!(nodes[1], 1);
7209 fn do_test_failure_delay_dust_htlc_local_commitment(announce_latest: bool) {
7210 // Dust-HTLC failure updates must be delayed until failure-trigger tx (in this case local commitment) reach ANTI_REORG_DELAY
7211 // 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
7212 // HTLC could have been removed from lastest local commitment tx but still valid until we get remote RAA
7214 let mut chanmon_cfgs = create_chanmon_cfgs(2);
7215 chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
7216 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7217 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7218 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7219 let chan =create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7221 let bs_dust_limit = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().holder_dust_limit_satoshis;
7223 // We route 2 dust-HTLCs between A and B
7224 let (_, payment_hash_1, _) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
7225 let (_, payment_hash_2, _) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
7226 route_payment(&nodes[0], &[&nodes[1]], 1000000);
7228 // Cache one local commitment tx as previous
7229 let as_prev_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
7231 // Fail one HTLC to prune it in the will-be-latest-local commitment tx
7232 assert!(nodes[1].node.fail_htlc_backwards(&payment_hash_2));
7233 check_added_monitors!(nodes[1], 0);
7234 expect_pending_htlcs_forwardable!(nodes[1]);
7235 check_added_monitors!(nodes[1], 1);
7237 let remove = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
7238 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &remove.update_fail_htlcs[0]);
7239 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &remove.commitment_signed);
7240 check_added_monitors!(nodes[0], 1);
7242 // Cache one local commitment tx as lastest
7243 let as_last_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
7245 let events = nodes[0].node.get_and_clear_pending_msg_events();
7247 MessageSendEvent::SendRevokeAndACK { node_id, .. } => {
7248 assert_eq!(node_id, nodes[1].node.get_our_node_id());
7250 _ => panic!("Unexpected event"),
7253 MessageSendEvent::UpdateHTLCs { node_id, .. } => {
7254 assert_eq!(node_id, nodes[1].node.get_our_node_id());
7256 _ => panic!("Unexpected event"),
7259 assert_ne!(as_prev_commitment_tx, as_last_commitment_tx);
7260 // Fail the 2 dust-HTLCs, move their failure in maturation buffer (htlc_updated_waiting_threshold_conf)
7261 if announce_latest {
7262 mine_transaction(&nodes[0], &as_last_commitment_tx[0]);
7264 mine_transaction(&nodes[0], &as_prev_commitment_tx[0]);
7267 check_closed_broadcast!(nodes[0], true);
7268 check_added_monitors!(nodes[0], 1);
7270 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7271 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7272 let events = nodes[0].node.get_and_clear_pending_events();
7273 // Only 2 PaymentFailed events should show up, over-dust HTLC has to be failed by timeout tx
7274 assert_eq!(events.len(), 2);
7275 let mut first_failed = false;
7276 for event in events {
7278 Event::PaymentFailed { payment_hash, .. } => {
7279 if payment_hash == payment_hash_1 {
7280 assert!(!first_failed);
7281 first_failed = true;
7283 assert_eq!(payment_hash, payment_hash_2);
7286 _ => panic!("Unexpected event"),
7292 fn test_failure_delay_dust_htlc_local_commitment() {
7293 do_test_failure_delay_dust_htlc_local_commitment(true);
7294 do_test_failure_delay_dust_htlc_local_commitment(false);
7297 fn do_test_sweep_outbound_htlc_failure_update(revoked: bool, local: bool) {
7298 // Outbound HTLC-failure updates must be cancelled if we get a reorg before we reach ANTI_REORG_DELAY.
7299 // Broadcast of revoked remote commitment tx, trigger failure-update of dust/non-dust HTLCs
7300 // Broadcast of remote commitment tx, trigger failure-update of dust-HTLCs
7301 // Broadcast of timeout tx on remote commitment tx, trigger failure-udate of non-dust HTLCs
7302 // Broadcast of local commitment tx, trigger failure-update of dust-HTLCs
7303 // Broadcast of HTLC-timeout tx on local commitment tx, trigger failure-update of non-dust HTLCs
7305 let chanmon_cfgs = create_chanmon_cfgs(3);
7306 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7307 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
7308 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7309 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7311 let bs_dust_limit = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().holder_dust_limit_satoshis;
7313 let (_payment_preimage_1, dust_hash, _payment_secret_1) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
7314 let (_payment_preimage_2, non_dust_hash, _payment_secret_2) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
7316 let as_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
7317 let bs_commitment_tx = get_local_commitment_txn!(nodes[1], chan.2);
7319 // We revoked bs_commitment_tx
7321 let (payment_preimage_3, _, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
7322 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_3);
7325 let mut timeout_tx = Vec::new();
7327 // We fail dust-HTLC 1 by broadcast of local commitment tx
7328 mine_transaction(&nodes[0], &as_commitment_tx[0]);
7329 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7330 expect_payment_failed!(nodes[0], dust_hash, true);
7332 connect_blocks(&nodes[0], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS - ANTI_REORG_DELAY);
7333 check_closed_broadcast!(nodes[0], true);
7334 check_added_monitors!(nodes[0], 1);
7335 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7336 timeout_tx.push(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[1].clone());
7337 assert_eq!(timeout_tx[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
7338 // We fail non-dust-HTLC 2 by broadcast of local HTLC-timeout tx on local commitment tx
7339 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7340 mine_transaction(&nodes[0], &timeout_tx[0]);
7341 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7342 expect_payment_failed!(nodes[0], non_dust_hash, true);
7344 // We fail dust-HTLC 1 by broadcast of remote commitment tx. If revoked, fail also non-dust HTLC
7345 mine_transaction(&nodes[0], &bs_commitment_tx[0]);
7346 check_closed_broadcast!(nodes[0], true);
7347 check_added_monitors!(nodes[0], 1);
7348 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7349 connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
7350 timeout_tx.push(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[1].clone());
7352 expect_payment_failed!(nodes[0], dust_hash, true);
7353 assert_eq!(timeout_tx[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
7354 // We fail non-dust-HTLC 2 by broadcast of local timeout tx on remote commitment tx
7355 mine_transaction(&nodes[0], &timeout_tx[0]);
7356 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7357 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7358 expect_payment_failed!(nodes[0], non_dust_hash, true);
7360 // If revoked, both dust & non-dust HTLCs should have been failed after ANTI_REORG_DELAY confs of revoked
7362 let events = nodes[0].node.get_and_clear_pending_events();
7363 assert_eq!(events.len(), 2);
7366 Event::PaymentFailed { payment_hash, .. } => {
7367 if payment_hash == dust_hash { first = true; }
7368 else { first = false; }
7370 _ => panic!("Unexpected event"),
7373 Event::PaymentFailed { payment_hash, .. } => {
7374 if first { assert_eq!(payment_hash, non_dust_hash); }
7375 else { assert_eq!(payment_hash, dust_hash); }
7377 _ => panic!("Unexpected event"),
7384 fn test_sweep_outbound_htlc_failure_update() {
7385 do_test_sweep_outbound_htlc_failure_update(false, true);
7386 do_test_sweep_outbound_htlc_failure_update(false, false);
7387 do_test_sweep_outbound_htlc_failure_update(true, false);
7391 fn test_upfront_shutdown_script() {
7392 // BOLT 2 : Option upfront shutdown script, if peer commit its closing_script at channel opening
7393 // enforce it at shutdown message
7395 let mut config = UserConfig::default();
7396 config.channel_options.announced_channel = true;
7397 config.peer_channel_config_limits.force_announced_channel_preference = false;
7398 config.channel_options.commit_upfront_shutdown_pubkey = false;
7399 let user_cfgs = [None, Some(config), None];
7400 let chanmon_cfgs = create_chanmon_cfgs(3);
7401 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7402 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
7403 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7405 // We test that in case of peer committing upfront to a script, if it changes at closing, we refuse to sign
7406 let flags = InitFeatures::known();
7407 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 1000000, 1000000, flags.clone(), flags.clone());
7408 nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7409 let mut node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[2].node.get_our_node_id());
7410 node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
7411 // Test we enforce upfront_scriptpbukey if by providing a diffrent one at closing that we disconnect peer
7412 nodes[2].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
7413 assert!(regex::Regex::new(r"Got shutdown request with a scriptpubkey \([A-Fa-f0-9]+\) which did not match their previous scriptpubkey.").unwrap().is_match(check_closed_broadcast!(nodes[2], true).unwrap().data.as_str()));
7414 check_added_monitors!(nodes[2], 1);
7416 // We test that in case of peer committing upfront to a script, if it doesn't change at closing, we sign
7417 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 1000000, 1000000, flags.clone(), flags.clone());
7418 nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7419 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[2].node.get_our_node_id());
7420 // We test that in case of peer committing upfront to a script, if it oesn't change at closing, we sign
7421 nodes[2].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
7422 let events = nodes[2].node.get_and_clear_pending_msg_events();
7423 assert_eq!(events.len(), 1);
7425 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[0].node.get_our_node_id()) }
7426 _ => panic!("Unexpected event"),
7429 // We test that if case of peer non-signaling we don't enforce committed script at channel opening
7430 let flags_no = InitFeatures::known().clear_upfront_shutdown_script();
7431 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, flags_no, flags.clone());
7432 nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7433 let mut node_1_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
7434 node_1_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
7435 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_1_shutdown);
7436 let events = nodes[1].node.get_and_clear_pending_msg_events();
7437 assert_eq!(events.len(), 1);
7439 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[0].node.get_our_node_id()) }
7440 _ => panic!("Unexpected event"),
7443 // We test that if user opt-out, we provide a zero-length script at channel opening and we are able to close
7444 // channel smoothly, opt-out is from channel initiator here
7445 let chan = create_announced_chan_between_nodes_with_value(&nodes, 1, 0, 1000000, 1000000, flags.clone(), flags.clone());
7446 nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7447 let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
7448 node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
7449 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
7450 let events = nodes[0].node.get_and_clear_pending_msg_events();
7451 assert_eq!(events.len(), 1);
7453 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7454 _ => panic!("Unexpected event"),
7457 //// We test that if user opt-out, we provide a zero-length script at channel opening and we are able to close
7458 //// channel smoothly
7459 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, flags.clone(), flags.clone());
7460 nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7461 let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
7462 node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
7463 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
7464 let events = nodes[0].node.get_and_clear_pending_msg_events();
7465 assert_eq!(events.len(), 2);
7467 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7468 _ => panic!("Unexpected event"),
7471 MessageSendEvent::SendClosingSigned { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7472 _ => panic!("Unexpected event"),
7477 fn test_upfront_shutdown_script_unsupport_segwit() {
7478 // We test that channel is closed early
7479 // if a segwit program is passed as upfront shutdown script,
7480 // but the peer does not support segwit.
7481 let chanmon_cfgs = create_chanmon_cfgs(2);
7482 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7483 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7484 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7486 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
7488 let mut open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
7489 open_channel.shutdown_scriptpubkey = Present(Builder::new().push_int(16)
7490 .push_slice(&[0, 0])
7493 let features = InitFeatures::known().clear_shutdown_anysegwit();
7494 nodes[0].node.handle_open_channel(&nodes[0].node.get_our_node_id(), features, &open_channel);
7496 let events = nodes[0].node.get_and_clear_pending_msg_events();
7497 assert_eq!(events.len(), 1);
7499 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
7500 assert_eq!(node_id, nodes[0].node.get_our_node_id());
7501 assert!(regex::Regex::new(r"Peer is signaling upfront_shutdown but has provided a non-accepted scriptpubkey format. script: (\([A-Fa-f0-9]+\))").unwrap().is_match(&*msg.data));
7503 _ => panic!("Unexpected event"),
7508 fn test_shutdown_script_any_segwit_allowed() {
7509 let mut config = UserConfig::default();
7510 config.channel_options.announced_channel = true;
7511 config.peer_channel_config_limits.force_announced_channel_preference = false;
7512 config.channel_options.commit_upfront_shutdown_pubkey = false;
7513 let user_cfgs = [None, Some(config), None];
7514 let chanmon_cfgs = create_chanmon_cfgs(3);
7515 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7516 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
7517 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7519 //// We test if the remote peer accepts opt_shutdown_anysegwit, a witness program can be used on shutdown
7520 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7521 nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7522 let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
7523 node_0_shutdown.scriptpubkey = Builder::new().push_int(16)
7524 .push_slice(&[0, 0])
7526 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
7527 let events = nodes[0].node.get_and_clear_pending_msg_events();
7528 assert_eq!(events.len(), 2);
7530 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7531 _ => panic!("Unexpected event"),
7534 MessageSendEvent::SendClosingSigned { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7535 _ => panic!("Unexpected event"),
7540 fn test_shutdown_script_any_segwit_not_allowed() {
7541 let mut config = UserConfig::default();
7542 config.channel_options.announced_channel = true;
7543 config.peer_channel_config_limits.force_announced_channel_preference = false;
7544 config.channel_options.commit_upfront_shutdown_pubkey = false;
7545 let user_cfgs = [None, Some(config), None];
7546 let chanmon_cfgs = create_chanmon_cfgs(3);
7547 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7548 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
7549 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7551 //// We test that if the remote peer does not accept opt_shutdown_anysegwit, the witness program cannot be used on shutdown
7552 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7553 nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7554 let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
7555 // Make an any segwit version script
7556 node_0_shutdown.scriptpubkey = Builder::new().push_int(16)
7557 .push_slice(&[0, 0])
7559 let flags_no = InitFeatures::known().clear_shutdown_anysegwit();
7560 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &flags_no, &node_0_shutdown);
7561 let events = nodes[0].node.get_and_clear_pending_msg_events();
7562 assert_eq!(events.len(), 2);
7564 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
7565 assert_eq!(node_id, nodes[1].node.get_our_node_id());
7566 assert_eq!(msg.data, "Got a nonstandard scriptpubkey (60020000) from remote peer".to_owned())
7568 _ => panic!("Unexpected event"),
7570 check_added_monitors!(nodes[0], 1);
7574 fn test_shutdown_script_segwit_but_not_anysegwit() {
7575 let mut config = UserConfig::default();
7576 config.channel_options.announced_channel = true;
7577 config.peer_channel_config_limits.force_announced_channel_preference = false;
7578 config.channel_options.commit_upfront_shutdown_pubkey = false;
7579 let user_cfgs = [None, Some(config), None];
7580 let chanmon_cfgs = create_chanmon_cfgs(3);
7581 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7582 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
7583 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7585 //// We test that if shutdown any segwit is supported and we send a witness script with 0 version, this is not accepted
7586 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7587 nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7588 let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
7589 // Make a segwit script that is not a valid as any segwit
7590 node_0_shutdown.scriptpubkey = Builder::new().push_int(0)
7591 .push_slice(&[0, 0])
7593 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
7594 let events = nodes[0].node.get_and_clear_pending_msg_events();
7595 assert_eq!(events.len(), 2);
7597 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
7598 assert_eq!(node_id, nodes[1].node.get_our_node_id());
7599 assert_eq!(msg.data, "Got a nonstandard scriptpubkey (00020000) from remote peer".to_owned())
7601 _ => panic!("Unexpected event"),
7603 check_added_monitors!(nodes[0], 1);
7607 fn test_user_configurable_csv_delay() {
7608 // We test our channel constructors yield errors when we pass them absurd csv delay
7610 let mut low_our_to_self_config = UserConfig::default();
7611 low_our_to_self_config.own_channel_config.our_to_self_delay = 6;
7612 let mut high_their_to_self_config = UserConfig::default();
7613 high_their_to_self_config.peer_channel_config_limits.their_to_self_delay = 100;
7614 let user_cfgs = [Some(high_their_to_self_config.clone()), None];
7615 let chanmon_cfgs = create_chanmon_cfgs(2);
7616 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7617 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &user_cfgs);
7618 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7620 // We test config.our_to_self > BREAKDOWN_TIMEOUT is enforced in Channel::new_outbound()
7621 if let Err(error) = Channel::new_outbound(&&test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) }, &nodes[0].keys_manager, nodes[1].node.get_our_node_id(), 1000000, 1000000, 0, &low_our_to_self_config) {
7623 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())); },
7624 _ => panic!("Unexpected event"),
7626 } else { assert!(false) }
7628 // We test config.our_to_self > BREAKDOWN_TIMEOUT is enforced in Channel::new_from_req()
7629 nodes[1].node.create_channel(nodes[0].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
7630 let mut open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
7631 open_channel.to_self_delay = 200;
7632 if let Err(error) = Channel::new_from_req(&&test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) }, &nodes[0].keys_manager, nodes[1].node.get_our_node_id(), InitFeatures::known(), &open_channel, 0, &low_our_to_self_config) {
7634 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())); },
7635 _ => panic!("Unexpected event"),
7637 } else { assert!(false); }
7639 // We test msg.to_self_delay <= config.their_to_self_delay is enforced in Chanel::accept_channel()
7640 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
7641 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id()));
7642 let mut accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
7643 accept_channel.to_self_delay = 200;
7644 nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &accept_channel);
7645 if let MessageSendEvent::HandleError { ref action, .. } = nodes[0].node.get_and_clear_pending_msg_events()[0] {
7647 &ErrorAction::SendErrorMessage { ref msg } => {
7648 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()));
7650 _ => { assert!(false); }
7652 } else { assert!(false); }
7654 // We test msg.to_self_delay <= config.their_to_self_delay is enforced in Channel::new_from_req()
7655 nodes[1].node.create_channel(nodes[0].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
7656 let mut open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
7657 open_channel.to_self_delay = 200;
7658 if let Err(error) = Channel::new_from_req(&&test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) }, &nodes[0].keys_manager, nodes[1].node.get_our_node_id(), InitFeatures::known(), &open_channel, 0, &high_their_to_self_config) {
7660 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())); },
7661 _ => panic!("Unexpected event"),
7663 } else { assert!(false); }
7667 fn test_data_loss_protect() {
7668 // We want to be sure that :
7669 // * we don't broadcast our Local Commitment Tx in case of fallen behind
7670 // (but this is not quite true - we broadcast during Drop because chanmon is out of sync with chanmgr)
7671 // * we close channel in case of detecting other being fallen behind
7672 // * we are able to claim our own outputs thanks to to_remote being static
7673 // TODO: this test is incomplete and the data_loss_protect implementation is incomplete - see issue #775
7679 let mut chanmon_cfgs = create_chanmon_cfgs(2);
7680 // We broadcast during Drop because chanmon is out of sync with chanmgr, which would cause a panic
7681 // during signing due to revoked tx
7682 chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
7683 let keys_manager = &chanmon_cfgs[0].keys_manager;
7686 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7687 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7688 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7690 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7692 // Cache node A state before any channel update
7693 let previous_node_state = nodes[0].node.encode();
7694 let mut previous_chain_monitor_state = test_utils::TestVecWriter(Vec::new());
7695 nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut previous_chain_monitor_state).unwrap();
7697 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
7698 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
7700 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
7701 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
7703 // Restore node A from previous state
7704 logger = test_utils::TestLogger::with_id(format!("node {}", 0));
7705 let mut chain_monitor = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(&mut ::std::io::Cursor::new(previous_chain_monitor_state.0), keys_manager).unwrap().1;
7706 chain_source = test_utils::TestChainSource::new(Network::Testnet);
7707 tx_broadcaster = test_utils::TestBroadcaster{txn_broadcasted: Mutex::new(Vec::new()), blocks: Arc::new(Mutex::new(Vec::new()))};
7708 fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
7709 persister = test_utils::TestPersister::new();
7710 monitor = test_utils::TestChainMonitor::new(Some(&chain_source), &tx_broadcaster, &logger, &fee_estimator, &persister, keys_manager);
7712 let mut channel_monitors = HashMap::new();
7713 channel_monitors.insert(OutPoint { txid: chan.3.txid(), index: 0 }, &mut chain_monitor);
7714 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut ::std::io::Cursor::new(previous_node_state), ChannelManagerReadArgs {
7715 keys_manager: keys_manager,
7716 fee_estimator: &fee_estimator,
7717 chain_monitor: &monitor,
7719 tx_broadcaster: &tx_broadcaster,
7720 default_config: UserConfig::default(),
7724 nodes[0].node = &node_state_0;
7725 assert!(monitor.watch_channel(OutPoint { txid: chan.3.txid(), index: 0 }, chain_monitor).is_ok());
7726 nodes[0].chain_monitor = &monitor;
7727 nodes[0].chain_source = &chain_source;
7729 check_added_monitors!(nodes[0], 1);
7731 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7732 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7734 let reestablish_0 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
7736 // Check we don't broadcast any transactions following learning of per_commitment_point from B
7737 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_0[0]);
7738 check_added_monitors!(nodes[0], 1);
7741 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
7742 assert_eq!(node_txn.len(), 0);
7745 let mut reestablish_1 = Vec::with_capacity(1);
7746 for msg in nodes[0].node.get_and_clear_pending_msg_events() {
7747 if let MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } = msg {
7748 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
7749 reestablish_1.push(msg.clone());
7750 } else if let MessageSendEvent::BroadcastChannelUpdate { .. } = msg {
7751 } else if let MessageSendEvent::HandleError { ref action, .. } = msg {
7753 &ErrorAction::SendErrorMessage { ref msg } => {
7754 assert_eq!(msg.data, "We have fallen behind - we have received proof that if we broadcast remote is going to claim our funds - we can't do any automated broadcasting");
7756 _ => panic!("Unexpected event!"),
7759 panic!("Unexpected event")
7763 // Check we close channel detecting A is fallen-behind
7764 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
7765 assert_eq!(check_closed_broadcast!(nodes[1], true).unwrap().data, "Peer attempted to reestablish channel with a very old local commitment transaction");
7766 check_added_monitors!(nodes[1], 1);
7769 // Check A is able to claim to_remote output
7770 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
7771 assert_eq!(node_txn.len(), 1);
7772 check_spends!(node_txn[0], chan.3);
7773 assert_eq!(node_txn[0].output.len(), 2);
7774 mine_transaction(&nodes[0], &node_txn[0]);
7775 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7776 let spend_txn = check_spendable_outputs!(nodes[0], node_cfgs[0].keys_manager);
7777 assert_eq!(spend_txn.len(), 1);
7778 check_spends!(spend_txn[0], node_txn[0]);
7782 fn test_check_htlc_underpaying() {
7783 // Send payment through A -> B but A is maliciously
7784 // sending a probe payment (i.e less than expected value0
7785 // to B, B should refuse payment.
7787 let chanmon_cfgs = create_chanmon_cfgs(2);
7788 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7789 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7790 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7792 // Create some initial channels
7793 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7795 let route = get_route(&nodes[0].node.get_our_node_id(), &nodes[0].net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 10_000, TEST_FINAL_CLTV, nodes[0].logger).unwrap();
7796 let (_, our_payment_hash, _) = get_payment_preimage_hash!(nodes[0]);
7797 let our_payment_secret = nodes[1].node.create_inbound_payment_for_hash(our_payment_hash, Some(100_000), 7200, 0).unwrap();
7798 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
7799 check_added_monitors!(nodes[0], 1);
7801 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
7802 assert_eq!(events.len(), 1);
7803 let mut payment_event = SendEvent::from_event(events.pop().unwrap());
7804 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
7805 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
7807 // Note that we first have to wait a random delay before processing the receipt of the HTLC,
7808 // and then will wait a second random delay before failing the HTLC back:
7809 expect_pending_htlcs_forwardable!(nodes[1]);
7810 expect_pending_htlcs_forwardable!(nodes[1]);
7812 // Node 3 is expecting payment of 100_000 but received 10_000,
7813 // it should fail htlc like we didn't know the preimage.
7814 nodes[1].node.process_pending_htlc_forwards();
7816 let events = nodes[1].node.get_and_clear_pending_msg_events();
7817 assert_eq!(events.len(), 1);
7818 let (update_fail_htlc, commitment_signed) = match events[0] {
7819 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 } } => {
7820 assert!(update_add_htlcs.is_empty());
7821 assert!(update_fulfill_htlcs.is_empty());
7822 assert_eq!(update_fail_htlcs.len(), 1);
7823 assert!(update_fail_malformed_htlcs.is_empty());
7824 assert!(update_fee.is_none());
7825 (update_fail_htlcs[0].clone(), commitment_signed)
7827 _ => panic!("Unexpected event"),
7829 check_added_monitors!(nodes[1], 1);
7831 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlc);
7832 commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
7834 // 10_000 msat as u64, followed by a height of CHAN_CONFIRM_DEPTH as u32
7835 let mut expected_failure_data = byte_utils::be64_to_array(10_000).to_vec();
7836 expected_failure_data.extend_from_slice(&byte_utils::be32_to_array(CHAN_CONFIRM_DEPTH));
7837 expect_payment_failed!(nodes[0], our_payment_hash, true, 0x4000|15, &expected_failure_data[..]);
7841 fn test_announce_disable_channels() {
7842 // Create 2 channels between A and B. Disconnect B. Call timer_tick_occurred and check for generated
7843 // ChannelUpdate. Reconnect B, reestablish and check there is non-generated ChannelUpdate.
7845 let chanmon_cfgs = create_chanmon_cfgs(2);
7846 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7847 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7848 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7850 let short_id_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
7851 let short_id_2 = create_announced_chan_between_nodes(&nodes, 1, 0, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
7852 let short_id_3 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
7855 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
7856 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
7858 nodes[0].node.timer_tick_occurred(); // Enabled -> DisabledStaged
7859 nodes[0].node.timer_tick_occurred(); // DisabledStaged -> Disabled
7860 let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
7861 assert_eq!(msg_events.len(), 3);
7862 let mut chans_disabled: HashSet<u64> = [short_id_1, short_id_2, short_id_3].iter().map(|a| *a).collect();
7863 for e in msg_events {
7865 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
7866 assert_eq!(msg.contents.flags & (1<<1), 1<<1); // The "channel disabled" bit should be set
7867 // Check that each channel gets updated exactly once
7868 if !chans_disabled.remove(&msg.contents.short_channel_id) {
7869 panic!("Generated ChannelUpdate for wrong chan!");
7872 _ => panic!("Unexpected event"),
7876 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7877 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
7878 assert_eq!(reestablish_1.len(), 3);
7879 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7880 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
7881 assert_eq!(reestablish_2.len(), 3);
7883 // Reestablish chan_1
7884 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
7885 handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
7886 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
7887 handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
7888 // Reestablish chan_2
7889 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[1]);
7890 handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
7891 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[1]);
7892 handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
7893 // Reestablish chan_3
7894 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[2]);
7895 handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
7896 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[2]);
7897 handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
7899 nodes[0].node.timer_tick_occurred();
7900 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
7901 nodes[0].node.timer_tick_occurred();
7902 let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
7903 assert_eq!(msg_events.len(), 3);
7904 chans_disabled = [short_id_1, short_id_2, short_id_3].iter().map(|a| *a).collect();
7905 for e in msg_events {
7907 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
7908 assert_eq!(msg.contents.flags & (1<<1), 0); // The "channel disabled" bit should be off
7909 // Check that each channel gets updated exactly once
7910 if !chans_disabled.remove(&msg.contents.short_channel_id) {
7911 panic!("Generated ChannelUpdate for wrong chan!");
7914 _ => panic!("Unexpected event"),
7920 fn test_priv_forwarding_rejection() {
7921 // If we have a private channel with outbound liquidity, and
7922 // UserConfig::accept_forwards_to_priv_channels is set to false, we should reject any attempts
7923 // to forward through that channel.
7924 let chanmon_cfgs = create_chanmon_cfgs(3);
7925 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7926 let mut no_announce_cfg = test_default_channel_config();
7927 no_announce_cfg.channel_options.announced_channel = false;
7928 no_announce_cfg.accept_forwards_to_priv_channels = false;
7929 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, Some(no_announce_cfg), None]);
7930 let persister: test_utils::TestPersister;
7931 let new_chain_monitor: test_utils::TestChainMonitor;
7932 let nodes_1_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
7933 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7935 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1_000_000, 500_000_000, InitFeatures::known(), InitFeatures::known());
7937 // Note that the create_*_chan functions in utils requires announcement_signatures, which we do
7938 // not send for private channels.
7939 nodes[1].node.create_channel(nodes[2].node.get_our_node_id(), 1_000_000, 500_000_000, 42, None).unwrap();
7940 let open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[2].node.get_our_node_id());
7941 nodes[2].node.handle_open_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &open_channel);
7942 let accept_channel = get_event_msg!(nodes[2], MessageSendEvent::SendAcceptChannel, nodes[1].node.get_our_node_id());
7943 nodes[1].node.handle_accept_channel(&nodes[2].node.get_our_node_id(), InitFeatures::known(), &accept_channel);
7945 let (temporary_channel_id, tx, _) = create_funding_transaction(&nodes[1], 1_000_000, 42);
7946 nodes[1].node.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
7947 nodes[2].node.handle_funding_created(&nodes[1].node.get_our_node_id(), &get_event_msg!(nodes[1], MessageSendEvent::SendFundingCreated, nodes[2].node.get_our_node_id()));
7948 check_added_monitors!(nodes[2], 1);
7950 nodes[1].node.handle_funding_signed(&nodes[2].node.get_our_node_id(), &get_event_msg!(nodes[2], MessageSendEvent::SendFundingSigned, nodes[1].node.get_our_node_id()));
7951 check_added_monitors!(nodes[1], 1);
7953 let conf_height = core::cmp::max(nodes[1].best_block_info().1 + 1, nodes[2].best_block_info().1 + 1);
7954 confirm_transaction_at(&nodes[1], &tx, conf_height);
7955 connect_blocks(&nodes[1], CHAN_CONFIRM_DEPTH - 1);
7956 confirm_transaction_at(&nodes[2], &tx, conf_height);
7957 connect_blocks(&nodes[2], CHAN_CONFIRM_DEPTH - 1);
7958 let as_funding_locked = get_event_msg!(nodes[1], MessageSendEvent::SendFundingLocked, nodes[2].node.get_our_node_id());
7959 nodes[1].node.handle_funding_locked(&nodes[2].node.get_our_node_id(), &get_event_msg!(nodes[2], MessageSendEvent::SendFundingLocked, nodes[1].node.get_our_node_id()));
7960 get_event_msg!(nodes[1], MessageSendEvent::SendChannelUpdate, nodes[2].node.get_our_node_id());
7961 nodes[2].node.handle_funding_locked(&nodes[1].node.get_our_node_id(), &as_funding_locked);
7962 get_event_msg!(nodes[2], MessageSendEvent::SendChannelUpdate, nodes[1].node.get_our_node_id());
7964 assert!(nodes[0].node.list_usable_channels()[0].is_public);
7965 assert_eq!(nodes[1].node.list_usable_channels().len(), 2);
7966 assert!(!nodes[2].node.list_usable_channels()[0].is_public);
7968 // We should always be able to forward through nodes[1] as long as its out through a public
7970 send_payment(&nodes[2], &[&nodes[1], &nodes[0]], 10_000);
7972 // ... however, if we send to nodes[2], we will have to pass the private channel from nodes[1]
7973 // to nodes[2], which should be rejected:
7974 let (our_payment_preimage, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[2]);
7975 let route = get_route(&nodes[0].node.get_our_node_id(),
7976 &nodes[0].net_graph_msg_handler.network_graph.read().unwrap(),
7977 &nodes[2].node.get_our_node_id(), Some(InvoiceFeatures::known()), None,
7978 &[&RouteHint(vec![RouteHintHop {
7979 src_node_id: nodes[1].node.get_our_node_id(),
7980 short_channel_id: nodes[2].node.list_channels()[0].short_channel_id.unwrap(),
7981 fees: RoutingFees { base_msat: 1000, proportional_millionths: 0 },
7982 cltv_expiry_delta: MIN_CLTV_EXPIRY_DELTA,
7983 htlc_minimum_msat: None,
7984 htlc_maximum_msat: None,
7985 }])], 10_000, TEST_FINAL_CLTV, nodes[0].logger).unwrap();
7987 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
7988 check_added_monitors!(nodes[0], 1);
7989 let payment_event = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
7990 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
7991 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false, true);
7993 let htlc_fail_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
7994 assert!(htlc_fail_updates.update_add_htlcs.is_empty());
7995 assert_eq!(htlc_fail_updates.update_fail_htlcs.len(), 1);
7996 assert!(htlc_fail_updates.update_fail_malformed_htlcs.is_empty());
7997 assert!(htlc_fail_updates.update_fee.is_none());
7999 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_fail_updates.update_fail_htlcs[0]);
8000 commitment_signed_dance!(nodes[0], nodes[1], htlc_fail_updates.commitment_signed, true, true);
8001 expect_payment_failed!(nodes[0], our_payment_hash, false);
8002 expect_payment_failure_chan_update!(nodes[0], nodes[2].node.list_channels()[0].short_channel_id.unwrap(), true);
8004 // Now disconnect nodes[1] from its peers and restart with accept_forwards_to_priv_channels set
8005 // to true. Sadly there is currently no way to change it at runtime.
8007 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
8008 nodes[2].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
8010 let nodes_1_serialized = nodes[1].node.encode();
8011 let mut monitor_a_serialized = test_utils::TestVecWriter(Vec::new());
8012 let mut monitor_b_serialized = test_utils::TestVecWriter(Vec::new());
8014 let mons = nodes[1].chain_monitor.chain_monitor.monitors.read().unwrap();
8015 let mut mon_iter = mons.iter();
8016 mon_iter.next().unwrap().1.write(&mut monitor_a_serialized).unwrap();
8017 mon_iter.next().unwrap().1.write(&mut monitor_b_serialized).unwrap();
8020 persister = test_utils::TestPersister::new();
8021 let keys_manager = &chanmon_cfgs[1].keys_manager;
8022 new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[1].chain_source), nodes[1].tx_broadcaster.clone(), nodes[1].logger, node_cfgs[1].fee_estimator, &persister, keys_manager);
8023 nodes[1].chain_monitor = &new_chain_monitor;
8025 let mut monitor_a_read = &monitor_a_serialized.0[..];
8026 let mut monitor_b_read = &monitor_b_serialized.0[..];
8027 let (_, mut monitor_a) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(&mut monitor_a_read, keys_manager).unwrap();
8028 let (_, mut monitor_b) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(&mut monitor_b_read, keys_manager).unwrap();
8029 assert!(monitor_a_read.is_empty());
8030 assert!(monitor_b_read.is_empty());
8032 no_announce_cfg.accept_forwards_to_priv_channels = true;
8034 let mut nodes_1_read = &nodes_1_serialized[..];
8035 let (_, nodes_1_deserialized_tmp) = {
8036 let mut channel_monitors = HashMap::new();
8037 channel_monitors.insert(monitor_a.get_funding_txo().0, &mut monitor_a);
8038 channel_monitors.insert(monitor_b.get_funding_txo().0, &mut monitor_b);
8039 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_1_read, ChannelManagerReadArgs {
8040 default_config: no_announce_cfg,
8042 fee_estimator: node_cfgs[1].fee_estimator,
8043 chain_monitor: nodes[1].chain_monitor,
8044 tx_broadcaster: nodes[1].tx_broadcaster.clone(),
8045 logger: nodes[1].logger,
8049 assert!(nodes_1_read.is_empty());
8050 nodes_1_deserialized = nodes_1_deserialized_tmp;
8052 assert!(nodes[1].chain_monitor.watch_channel(monitor_a.get_funding_txo().0, monitor_a).is_ok());
8053 assert!(nodes[1].chain_monitor.watch_channel(monitor_b.get_funding_txo().0, monitor_b).is_ok());
8054 check_added_monitors!(nodes[1], 2);
8055 nodes[1].node = &nodes_1_deserialized;
8057 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::known() });
8058 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
8059 let as_reestablish = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
8060 let bs_reestablish = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
8061 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &as_reestablish);
8062 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &bs_reestablish);
8063 get_event_msg!(nodes[0], MessageSendEvent::SendChannelUpdate, nodes[1].node.get_our_node_id());
8064 get_event_msg!(nodes[1], MessageSendEvent::SendChannelUpdate, nodes[0].node.get_our_node_id());
8066 nodes[1].node.peer_connected(&nodes[2].node.get_our_node_id(), &msgs::Init { features: InitFeatures::known() });
8067 nodes[2].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
8068 let bs_reestablish = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[2].node.get_our_node_id());
8069 let cs_reestablish = get_event_msg!(nodes[2], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
8070 nodes[2].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &bs_reestablish);
8071 nodes[1].node.handle_channel_reestablish(&nodes[2].node.get_our_node_id(), &cs_reestablish);
8072 get_event_msg!(nodes[1], MessageSendEvent::SendChannelUpdate, nodes[2].node.get_our_node_id());
8073 get_event_msg!(nodes[2], MessageSendEvent::SendChannelUpdate, nodes[1].node.get_our_node_id());
8075 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
8076 check_added_monitors!(nodes[0], 1);
8077 pass_along_route(&nodes[0], &[&[&nodes[1], &nodes[2]]], 10_000, our_payment_hash, our_payment_secret);
8078 claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], our_payment_preimage);
8082 fn test_bump_penalty_txn_on_revoked_commitment() {
8083 // In case of penalty txn with too low feerates for getting into mempools, RBF-bump them to be sure
8084 // we're able to claim outputs on revoked commitment transaction before timelocks expiration
8086 let chanmon_cfgs = create_chanmon_cfgs(2);
8087 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8088 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8089 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8091 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
8092 let logger = test_utils::TestLogger::new();
8094 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
8095 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
8096 let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[0].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 3000000, 30, &logger).unwrap();
8097 send_along_route(&nodes[1], route, &vec!(&nodes[0])[..], 3000000);
8099 let revoked_txn = get_local_commitment_txn!(nodes[0], chan.2);
8100 // Revoked commitment txn with 4 outputs : to_local, to_remote, 1 outgoing HTLC, 1 incoming HTLC
8101 assert_eq!(revoked_txn[0].output.len(), 4);
8102 assert_eq!(revoked_txn[0].input.len(), 1);
8103 assert_eq!(revoked_txn[0].input[0].previous_output.txid, chan.3.txid());
8104 let revoked_txid = revoked_txn[0].txid();
8106 let mut penalty_sum = 0;
8107 for outp in revoked_txn[0].output.iter() {
8108 if outp.script_pubkey.is_v0_p2wsh() {
8109 penalty_sum += outp.value;
8113 // Connect blocks to change height_timer range to see if we use right soonest_timelock
8114 let header_114 = connect_blocks(&nodes[1], 14);
8116 // Actually revoke tx by claiming a HTLC
8117 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
8118 let header = BlockHeader { version: 0x20000000, prev_blockhash: header_114, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8119 connect_block(&nodes[1], &Block { header, txdata: vec![revoked_txn[0].clone()] });
8120 check_added_monitors!(nodes[1], 1);
8122 // One or more justice tx should have been broadcast, check it
8126 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8127 assert_eq!(node_txn.len(), 2); // justice tx (broadcasted from ChannelMonitor) + local commitment tx
8128 assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
8129 assert_eq!(node_txn[0].output.len(), 1);
8130 check_spends!(node_txn[0], revoked_txn[0]);
8131 let fee_1 = penalty_sum - node_txn[0].output[0].value;
8132 feerate_1 = fee_1 * 1000 / node_txn[0].get_weight() as u64;
8133 penalty_1 = node_txn[0].txid();
8137 // After exhaustion of height timer, a new bumped justice tx should have been broadcast, check it
8138 connect_blocks(&nodes[1], 15);
8139 let mut penalty_2 = penalty_1;
8140 let mut feerate_2 = 0;
8142 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8143 assert_eq!(node_txn.len(), 1);
8144 if node_txn[0].input[0].previous_output.txid == revoked_txid {
8145 assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
8146 assert_eq!(node_txn[0].output.len(), 1);
8147 check_spends!(node_txn[0], revoked_txn[0]);
8148 penalty_2 = node_txn[0].txid();
8149 // Verify new bumped tx is different from last claiming transaction, we don't want spurrious rebroadcast
8150 assert_ne!(penalty_2, penalty_1);
8151 let fee_2 = penalty_sum - node_txn[0].output[0].value;
8152 feerate_2 = fee_2 * 1000 / node_txn[0].get_weight() as u64;
8153 // Verify 25% bump heuristic
8154 assert!(feerate_2 * 100 >= feerate_1 * 125);
8158 assert_ne!(feerate_2, 0);
8160 // After exhaustion of height timer for a 2nd time, a new bumped justice tx should have been broadcast, check it
8161 connect_blocks(&nodes[1], 1);
8163 let mut feerate_3 = 0;
8165 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8166 assert_eq!(node_txn.len(), 1);
8167 if node_txn[0].input[0].previous_output.txid == revoked_txid {
8168 assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
8169 assert_eq!(node_txn[0].output.len(), 1);
8170 check_spends!(node_txn[0], revoked_txn[0]);
8171 penalty_3 = node_txn[0].txid();
8172 // Verify new bumped tx is different from last claiming transaction, we don't want spurrious rebroadcast
8173 assert_ne!(penalty_3, penalty_2);
8174 let fee_3 = penalty_sum - node_txn[0].output[0].value;
8175 feerate_3 = fee_3 * 1000 / node_txn[0].get_weight() as u64;
8176 // Verify 25% bump heuristic
8177 assert!(feerate_3 * 100 >= feerate_2 * 125);
8181 assert_ne!(feerate_3, 0);
8183 nodes[1].node.get_and_clear_pending_events();
8184 nodes[1].node.get_and_clear_pending_msg_events();
8188 fn test_bump_penalty_txn_on_revoked_htlcs() {
8189 // In case of penalty txn with too low feerates for getting into mempools, RBF-bump them to sure
8190 // we're able to claim outputs on revoked HTLC transactions before timelocks expiration
8192 let mut chanmon_cfgs = create_chanmon_cfgs(2);
8193 chanmon_cfgs[1].keys_manager.disable_revocation_policy_check = true;
8194 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8195 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8196 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8198 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
8199 // Lock HTLC in both directions (using a slightly lower CLTV delay to provide timely RBF bumps)
8200 let route = get_route(&nodes[0].node.get_our_node_id(), &nodes[0].net_graph_msg_handler.network_graph.read().unwrap(),
8201 &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 3_000_000, 50, nodes[0].logger).unwrap();
8202 let payment_preimage = send_along_route(&nodes[0], route, &[&nodes[1]], 3_000_000).0;
8203 let route = get_route(&nodes[1].node.get_our_node_id(), &nodes[1].net_graph_msg_handler.network_graph.read().unwrap(),
8204 &nodes[0].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 3_000_000, 50, nodes[0].logger).unwrap();
8205 send_along_route(&nodes[1], route, &[&nodes[0]], 3_000_000);
8207 let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan.2);
8208 assert_eq!(revoked_local_txn[0].input.len(), 1);
8209 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
8211 // Revoke local commitment tx
8212 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
8214 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8215 // B will generate both revoked HTLC-timeout/HTLC-preimage txn from revoked commitment tx
8216 connect_block(&nodes[1], &Block { header, txdata: vec![revoked_local_txn[0].clone()] });
8217 check_closed_broadcast!(nodes[1], true);
8218 check_added_monitors!(nodes[1], 1);
8219 connect_blocks(&nodes[1], 49); // Confirm blocks until the HTLC expires (note CLTV was explicitly 50 above)
8221 let revoked_htlc_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8222 assert_eq!(revoked_htlc_txn.len(), 3);
8223 check_spends!(revoked_htlc_txn[1], chan.3);
8225 assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
8226 assert_eq!(revoked_htlc_txn[0].input.len(), 1);
8227 check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
8229 assert_eq!(revoked_htlc_txn[2].input.len(), 1);
8230 assert_eq!(revoked_htlc_txn[2].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
8231 assert_eq!(revoked_htlc_txn[2].output.len(), 1);
8232 check_spends!(revoked_htlc_txn[2], revoked_local_txn[0]);
8234 // Broadcast set of revoked txn on A
8235 let hash_128 = connect_blocks(&nodes[0], 40);
8236 let header_11 = BlockHeader { version: 0x20000000, prev_blockhash: hash_128, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8237 connect_block(&nodes[0], &Block { header: header_11, txdata: vec![revoked_local_txn[0].clone()] });
8238 let header_129 = BlockHeader { version: 0x20000000, prev_blockhash: header_11.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8239 connect_block(&nodes[0], &Block { header: header_129, txdata: vec![revoked_htlc_txn[0].clone(), revoked_htlc_txn[2].clone()] });
8240 expect_pending_htlcs_forwardable_ignore!(nodes[0]);
8245 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8246 assert_eq!(node_txn.len(), 5); // 3 penalty txn on revoked commitment tx + A commitment tx + 1 penalty tnx on revoked HTLC txn
8247 // Verify claim tx are spending revoked HTLC txn
8249 // node_txn 0-2 each spend a separate revoked output from revoked_local_txn[0]
8250 // Note that node_txn[0] and node_txn[1] are bogus - they double spend the revoked_htlc_txn
8251 // which are included in the same block (they are broadcasted because we scan the
8252 // transactions linearly and generate claims as we go, they likely should be removed in the
8254 assert_eq!(node_txn[0].input.len(), 1);
8255 check_spends!(node_txn[0], revoked_local_txn[0]);
8256 assert_eq!(node_txn[1].input.len(), 1);
8257 check_spends!(node_txn[1], revoked_local_txn[0]);
8258 assert_eq!(node_txn[2].input.len(), 1);
8259 check_spends!(node_txn[2], revoked_local_txn[0]);
8261 // Each of the three justice transactions claim a separate (single) output of the three
8262 // available, which we check here:
8263 assert_ne!(node_txn[0].input[0].previous_output, node_txn[1].input[0].previous_output);
8264 assert_ne!(node_txn[0].input[0].previous_output, node_txn[2].input[0].previous_output);
8265 assert_ne!(node_txn[1].input[0].previous_output, node_txn[2].input[0].previous_output);
8267 assert_eq!(node_txn[0].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
8268 assert_eq!(node_txn[1].input[0].previous_output, revoked_htlc_txn[2].input[0].previous_output);
8270 // node_txn[3] is the local commitment tx broadcast just because (and somewhat in case of
8271 // reorgs, though its not clear its ever worth broadcasting conflicting txn like this when
8272 // a remote commitment tx has already been confirmed).
8273 check_spends!(node_txn[3], chan.3);
8275 // node_txn[4] spends the revoked outputs from the revoked_htlc_txn (which only have one
8276 // output, checked above).
8277 assert_eq!(node_txn[4].input.len(), 2);
8278 assert_eq!(node_txn[4].output.len(), 1);
8279 check_spends!(node_txn[4], revoked_htlc_txn[0], revoked_htlc_txn[2]);
8281 first = node_txn[4].txid();
8282 // Store both feerates for later comparison
8283 let fee_1 = revoked_htlc_txn[0].output[0].value + revoked_htlc_txn[2].output[0].value - node_txn[4].output[0].value;
8284 feerate_1 = fee_1 * 1000 / node_txn[4].get_weight() as u64;
8285 penalty_txn = vec![node_txn[2].clone()];
8289 // Connect one more block to see if bumped penalty are issued for HTLC txn
8290 let header_130 = BlockHeader { version: 0x20000000, prev_blockhash: header_129.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8291 connect_block(&nodes[0], &Block { header: header_130, txdata: penalty_txn });
8292 let header_131 = BlockHeader { version: 0x20000000, prev_blockhash: header_130.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8293 connect_block(&nodes[0], &Block { header: header_131, txdata: Vec::new() });
8295 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8296 assert_eq!(node_txn.len(), 2); // 2 bumped penalty txn on revoked commitment tx
8298 check_spends!(node_txn[0], revoked_local_txn[0]);
8299 check_spends!(node_txn[1], revoked_local_txn[0]);
8300 // Note that these are both bogus - they spend outputs already claimed in block 129:
8301 if node_txn[0].input[0].previous_output == revoked_htlc_txn[0].input[0].previous_output {
8302 assert_eq!(node_txn[1].input[0].previous_output, revoked_htlc_txn[2].input[0].previous_output);
8304 assert_eq!(node_txn[0].input[0].previous_output, revoked_htlc_txn[2].input[0].previous_output);
8305 assert_eq!(node_txn[1].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
8311 // Few more blocks to confirm penalty txn
8312 connect_blocks(&nodes[0], 4);
8313 assert!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
8314 let header_144 = connect_blocks(&nodes[0], 9);
8316 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8317 assert_eq!(node_txn.len(), 1);
8319 assert_eq!(node_txn[0].input.len(), 2);
8320 check_spends!(node_txn[0], revoked_htlc_txn[0], revoked_htlc_txn[2]);
8321 // Verify bumped tx is different and 25% bump heuristic
8322 assert_ne!(first, node_txn[0].txid());
8323 let fee_2 = revoked_htlc_txn[0].output[0].value + revoked_htlc_txn[2].output[0].value - node_txn[0].output[0].value;
8324 let feerate_2 = fee_2 * 1000 / node_txn[0].get_weight() as u64;
8325 assert!(feerate_2 * 100 > feerate_1 * 125);
8326 let txn = vec![node_txn[0].clone()];
8330 // Broadcast claim txn and confirm blocks to avoid further bumps on this outputs
8331 let header_145 = BlockHeader { version: 0x20000000, prev_blockhash: header_144, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8332 connect_block(&nodes[0], &Block { header: header_145, txdata: node_txn });
8333 connect_blocks(&nodes[0], 20);
8335 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8336 // We verify than no new transaction has been broadcast because previously
8337 // we were buggy on this exact behavior by not tracking for monitoring remote HTLC outputs (see #411)
8338 // which means we wouldn't see a spend of them by a justice tx and bumped justice tx
8339 // were generated forever instead of safe cleaning after confirmation and ANTI_REORG_SAFE_DELAY blocks.
8340 // Enforce spending of revoked htlc output by claiming transaction remove request as expected and dry
8341 // up bumped justice generation.
8342 assert_eq!(node_txn.len(), 0);
8345 check_closed_broadcast!(nodes[0], true);
8346 check_added_monitors!(nodes[0], 1);
8350 fn test_bump_penalty_txn_on_remote_commitment() {
8351 // In case of claim txn with too low feerates for getting into mempools, RBF-bump them to be sure
8352 // we're able to claim outputs on remote commitment transaction before timelocks expiration
8355 // Provide preimage for one
8356 // Check aggregation
8358 let chanmon_cfgs = create_chanmon_cfgs(2);
8359 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8360 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8361 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8363 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
8364 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
8365 route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000).0;
8367 // Remote commitment txn with 4 outputs : to_local, to_remote, 1 outgoing HTLC, 1 incoming HTLC
8368 let remote_txn = get_local_commitment_txn!(nodes[0], chan.2);
8369 assert_eq!(remote_txn[0].output.len(), 4);
8370 assert_eq!(remote_txn[0].input.len(), 1);
8371 assert_eq!(remote_txn[0].input[0].previous_output.txid, chan.3.txid());
8373 // Claim a HTLC without revocation (provide B monitor with preimage)
8374 nodes[1].node.claim_funds(payment_preimage);
8375 mine_transaction(&nodes[1], &remote_txn[0]);
8376 check_added_monitors!(nodes[1], 2);
8377 connect_blocks(&nodes[1], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
8379 // One or more claim tx should have been broadcast, check it
8383 let feerate_timeout;
8384 let feerate_preimage;
8386 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8387 // 9 transactions including:
8388 // 1*2 ChannelManager local broadcasts of commitment + HTLC-Success
8389 // 1*3 ChannelManager local broadcasts of commitment + HTLC-Success + HTLC-Timeout
8390 // 2 * HTLC-Success (one RBF bump we'll check later)
8392 assert_eq!(node_txn.len(), 8);
8393 assert_eq!(node_txn[0].input.len(), 1);
8394 assert_eq!(node_txn[6].input.len(), 1);
8395 check_spends!(node_txn[0], remote_txn[0]);
8396 check_spends!(node_txn[6], remote_txn[0]);
8397 assert_eq!(node_txn[0].input[0].previous_output, node_txn[3].input[0].previous_output);
8398 preimage_bump = node_txn[3].clone();
8400 check_spends!(node_txn[1], chan.3);
8401 check_spends!(node_txn[2], node_txn[1]);
8402 assert_eq!(node_txn[1], node_txn[4]);
8403 assert_eq!(node_txn[2], node_txn[5]);
8405 timeout = node_txn[6].txid();
8406 let index = node_txn[6].input[0].previous_output.vout;
8407 let fee = remote_txn[0].output[index as usize].value - node_txn[6].output[0].value;
8408 feerate_timeout = fee * 1000 / node_txn[6].get_weight() as u64;
8410 preimage = node_txn[0].txid();
8411 let index = node_txn[0].input[0].previous_output.vout;
8412 let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
8413 feerate_preimage = fee * 1000 / node_txn[0].get_weight() as u64;
8417 assert_ne!(feerate_timeout, 0);
8418 assert_ne!(feerate_preimage, 0);
8420 // After exhaustion of height timer, new bumped claim txn should have been broadcast, check it
8421 connect_blocks(&nodes[1], 15);
8423 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8424 assert_eq!(node_txn.len(), 1);
8425 assert_eq!(node_txn[0].input.len(), 1);
8426 assert_eq!(preimage_bump.input.len(), 1);
8427 check_spends!(node_txn[0], remote_txn[0]);
8428 check_spends!(preimage_bump, remote_txn[0]);
8430 let index = preimage_bump.input[0].previous_output.vout;
8431 let fee = remote_txn[0].output[index as usize].value - preimage_bump.output[0].value;
8432 let new_feerate = fee * 1000 / preimage_bump.get_weight() as u64;
8433 assert!(new_feerate * 100 > feerate_timeout * 125);
8434 assert_ne!(timeout, preimage_bump.txid());
8436 let index = node_txn[0].input[0].previous_output.vout;
8437 let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
8438 let new_feerate = fee * 1000 / node_txn[0].get_weight() as u64;
8439 assert!(new_feerate * 100 > feerate_preimage * 125);
8440 assert_ne!(preimage, node_txn[0].txid());
8445 nodes[1].node.get_and_clear_pending_events();
8446 nodes[1].node.get_and_clear_pending_msg_events();
8450 fn test_counterparty_raa_skip_no_crash() {
8451 // Previously, if our counterparty sent two RAAs in a row without us having provided a
8452 // commitment transaction, we would have happily carried on and provided them the next
8453 // commitment transaction based on one RAA forward. This would probably eventually have led to
8454 // channel closure, but it would not have resulted in funds loss. Still, our
8455 // EnforcingSigner would have paniced as it doesn't like jumps into the future. Here, we
8456 // check simply that the channel is closed in response to such an RAA, but don't check whether
8457 // we decide to punish our counterparty for revoking their funds (as we don't currently
8459 let chanmon_cfgs = create_chanmon_cfgs(2);
8460 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8461 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8462 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8463 let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).2;
8465 let mut guard = nodes[0].node.channel_state.lock().unwrap();
8466 let keys = &guard.by_id.get_mut(&channel_id).unwrap().get_signer();
8467 const INITIAL_COMMITMENT_NUMBER: u64 = (1 << 48) - 1;
8468 let per_commitment_secret = keys.release_commitment_secret(INITIAL_COMMITMENT_NUMBER);
8469 // Must revoke without gaps
8470 keys.release_commitment_secret(INITIAL_COMMITMENT_NUMBER - 1);
8471 let next_per_commitment_point = PublicKey::from_secret_key(&Secp256k1::new(),
8472 &SecretKey::from_slice(&keys.release_commitment_secret(INITIAL_COMMITMENT_NUMBER - 2)).unwrap());
8474 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(),
8475 &msgs::RevokeAndACK { channel_id, per_commitment_secret, next_per_commitment_point });
8476 assert_eq!(check_closed_broadcast!(nodes[1], true).unwrap().data, "Received an unexpected revoke_and_ack");
8477 check_added_monitors!(nodes[1], 1);
8481 fn test_bump_txn_sanitize_tracking_maps() {
8482 // Sanitizing pendning_claim_request and claimable_outpoints used to be buggy,
8483 // verify we clean then right after expiration of ANTI_REORG_DELAY.
8485 let chanmon_cfgs = create_chanmon_cfgs(2);
8486 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8487 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8488 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8490 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
8491 // Lock HTLC in both directions
8492 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000).0;
8493 route_payment(&nodes[1], &vec!(&nodes[0])[..], 9_000_000).0;
8495 let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan.2);
8496 assert_eq!(revoked_local_txn[0].input.len(), 1);
8497 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
8499 // Revoke local commitment tx
8500 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
8502 // Broadcast set of revoked txn on A
8503 connect_blocks(&nodes[0], TEST_FINAL_CLTV + 2 - CHAN_CONFIRM_DEPTH);
8504 expect_pending_htlcs_forwardable_ignore!(nodes[0]);
8505 assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 0);
8507 mine_transaction(&nodes[0], &revoked_local_txn[0]);
8508 check_closed_broadcast!(nodes[0], true);
8509 check_added_monitors!(nodes[0], 1);
8511 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8512 assert_eq!(node_txn.len(), 4); //ChannelMonitor: justice txn * 3, ChannelManager: local commitment tx
8513 check_spends!(node_txn[0], revoked_local_txn[0]);
8514 check_spends!(node_txn[1], revoked_local_txn[0]);
8515 check_spends!(node_txn[2], revoked_local_txn[0]);
8516 let penalty_txn = vec![node_txn[0].clone(), node_txn[1].clone(), node_txn[2].clone()];
8520 let header_130 = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8521 connect_block(&nodes[0], &Block { header: header_130, txdata: penalty_txn });
8522 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
8524 let monitors = nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap();
8525 if let Some(monitor) = monitors.get(&OutPoint { txid: chan.3.txid(), index: 0 }) {
8526 assert!(monitor.inner.lock().unwrap().onchain_tx_handler.pending_claim_requests.is_empty());
8527 assert!(monitor.inner.lock().unwrap().onchain_tx_handler.claimable_outpoints.is_empty());
8533 fn test_override_channel_config() {
8534 let chanmon_cfgs = create_chanmon_cfgs(2);
8535 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8536 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8537 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8539 // Node0 initiates a channel to node1 using the override config.
8540 let mut override_config = UserConfig::default();
8541 override_config.own_channel_config.our_to_self_delay = 200;
8543 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 16_000_000, 12_000_000, 42, Some(override_config)).unwrap();
8545 // Assert the channel created by node0 is using the override config.
8546 let res = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8547 assert_eq!(res.channel_flags, 0);
8548 assert_eq!(res.to_self_delay, 200);
8552 fn test_override_0msat_htlc_minimum() {
8553 let mut zero_config = UserConfig::default();
8554 zero_config.own_channel_config.our_htlc_minimum_msat = 0;
8555 let chanmon_cfgs = create_chanmon_cfgs(2);
8556 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8557 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, Some(zero_config.clone())]);
8558 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8560 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 16_000_000, 12_000_000, 42, Some(zero_config)).unwrap();
8561 let res = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8562 assert_eq!(res.htlc_minimum_msat, 1);
8564 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &res);
8565 let res = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
8566 assert_eq!(res.htlc_minimum_msat, 1);
8570 fn test_simple_mpp() {
8571 // Simple test of sending a multi-path payment.
8572 let chanmon_cfgs = create_chanmon_cfgs(4);
8573 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
8574 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
8575 let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
8577 let chan_1_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8578 let chan_2_id = create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8579 let chan_3_id = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8580 let chan_4_id = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8581 let logger = test_utils::TestLogger::new();
8583 let (payment_preimage, payment_hash, payment_secret) = get_payment_preimage_hash!(&nodes[3]);
8584 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
8585 let mut route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[3].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
8586 let path = route.paths[0].clone();
8587 route.paths.push(path);
8588 route.paths[0][0].pubkey = nodes[1].node.get_our_node_id();
8589 route.paths[0][0].short_channel_id = chan_1_id;
8590 route.paths[0][1].short_channel_id = chan_3_id;
8591 route.paths[1][0].pubkey = nodes[2].node.get_our_node_id();
8592 route.paths[1][0].short_channel_id = chan_2_id;
8593 route.paths[1][1].short_channel_id = chan_4_id;
8594 send_along_route_with_secret(&nodes[0], route, &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], 200_000, payment_hash, payment_secret);
8595 claim_payment_along_route(&nodes[0], &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], false, payment_preimage);
8599 fn test_preimage_storage() {
8600 // Simple test of payment preimage storage allowing no client-side storage to claim payments
8601 let chanmon_cfgs = create_chanmon_cfgs(2);
8602 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8603 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8604 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8606 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8609 let (payment_hash, payment_secret) = nodes[1].node.create_inbound_payment(Some(100_000), 7200, 42);
8611 let logger = test_utils::TestLogger::new();
8612 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
8613 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100_000, TEST_FINAL_CLTV, &logger).unwrap();
8614 nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
8615 check_added_monitors!(nodes[0], 1);
8616 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
8617 let mut payment_event = SendEvent::from_event(events.pop().unwrap());
8618 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
8619 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
8621 // Note that after leaving the above scope we have no knowledge of any arguments or return
8622 // values from previous calls.
8623 expect_pending_htlcs_forwardable!(nodes[1]);
8624 let events = nodes[1].node.get_and_clear_pending_events();
8625 assert_eq!(events.len(), 1);
8627 Event::PaymentReceived { payment_preimage, user_payment_id, .. } => {
8628 assert_eq!(user_payment_id, 42);
8629 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage.unwrap());
8631 _ => panic!("Unexpected event"),
8636 fn test_secret_timeout() {
8637 // Simple test of payment secret storage time outs
8638 let chanmon_cfgs = create_chanmon_cfgs(2);
8639 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8640 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8641 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8643 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8645 let (payment_hash, payment_secret_1) = nodes[1].node.create_inbound_payment(Some(100_000), 2, 0);
8647 // We should fail to register the same payment hash twice, at least until we've connected a
8648 // block with time 7200 + CHAN_CONFIRM_DEPTH + 1.
8649 if let Err(APIError::APIMisuseError { err }) = nodes[1].node.create_inbound_payment_for_hash(payment_hash, Some(100_000), 2, 0) {
8650 assert_eq!(err, "Duplicate payment hash");
8651 } else { panic!(); }
8653 let node_1_blocks = nodes[1].blocks.lock().unwrap();
8655 header: BlockHeader {
8657 prev_blockhash: node_1_blocks.last().unwrap().0.block_hash(),
8658 merkle_root: Default::default(),
8659 time: node_1_blocks.len() as u32 + 7200, bits: 42, nonce: 42 },
8663 connect_block(&nodes[1], &block);
8664 if let Err(APIError::APIMisuseError { err }) = nodes[1].node.create_inbound_payment_for_hash(payment_hash, Some(100_000), 2, 0) {
8665 assert_eq!(err, "Duplicate payment hash");
8666 } else { panic!(); }
8668 // If we then connect the second block, we should be able to register the same payment hash
8669 // again with a different user_payment_id (this time getting a new payment secret).
8670 block.header.prev_blockhash = block.header.block_hash();
8671 block.header.time += 1;
8672 connect_block(&nodes[1], &block);
8673 let our_payment_secret = nodes[1].node.create_inbound_payment_for_hash(payment_hash, Some(100_000), 2, 42).unwrap();
8674 assert_ne!(payment_secret_1, our_payment_secret);
8677 let logger = test_utils::TestLogger::new();
8678 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
8679 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100_000, TEST_FINAL_CLTV, &logger).unwrap();
8680 nodes[0].node.send_payment(&route, payment_hash, &Some(our_payment_secret)).unwrap();
8681 check_added_monitors!(nodes[0], 1);
8682 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
8683 let mut payment_event = SendEvent::from_event(events.pop().unwrap());
8684 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
8685 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
8687 // Note that after leaving the above scope we have no knowledge of any arguments or return
8688 // values from previous calls.
8689 expect_pending_htlcs_forwardable!(nodes[1]);
8690 let events = nodes[1].node.get_and_clear_pending_events();
8691 assert_eq!(events.len(), 1);
8693 Event::PaymentReceived { payment_preimage, payment_secret, user_payment_id, .. } => {
8694 assert!(payment_preimage.is_none());
8695 assert_eq!(user_payment_id, 42);
8696 assert_eq!(payment_secret, our_payment_secret);
8697 // We don't actually have the payment preimage with which to claim this payment!
8699 _ => panic!("Unexpected event"),
8704 fn test_bad_secret_hash() {
8705 // Simple test of unregistered payment hash/invalid payment secret handling
8706 let chanmon_cfgs = create_chanmon_cfgs(2);
8707 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8708 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8709 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8711 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8713 let random_payment_hash = PaymentHash([42; 32]);
8714 let random_payment_secret = PaymentSecret([43; 32]);
8715 let (our_payment_hash, our_payment_secret) = nodes[1].node.create_inbound_payment(Some(100_000), 2, 0);
8717 let logger = test_utils::TestLogger::new();
8718 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
8719 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100_000, TEST_FINAL_CLTV, &logger).unwrap();
8721 // All the below cases should end up being handled exactly identically, so we macro the
8722 // resulting events.
8723 macro_rules! handle_unknown_invalid_payment_data {
8725 check_added_monitors!(nodes[0], 1);
8726 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
8727 let payment_event = SendEvent::from_event(events.pop().unwrap());
8728 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
8729 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
8731 // We have to forward pending HTLCs once to process the receipt of the HTLC and then
8732 // again to process the pending backwards-failure of the HTLC
8733 expect_pending_htlcs_forwardable!(nodes[1]);
8734 expect_pending_htlcs_forwardable!(nodes[1]);
8735 check_added_monitors!(nodes[1], 1);
8737 // We should fail the payment back
8738 let mut events = nodes[1].node.get_and_clear_pending_msg_events();
8739 match events.pop().unwrap() {
8740 MessageSendEvent::UpdateHTLCs { node_id: _, updates: msgs::CommitmentUpdate { update_fail_htlcs, commitment_signed, .. } } => {
8741 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
8742 commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false);
8744 _ => panic!("Unexpected event"),
8749 let expected_error_code = 0x4000|15; // incorrect_or_unknown_payment_details
8750 // Error data is the HTLC value (100,000) and current block height
8751 let expected_error_data = [0, 0, 0, 0, 0, 1, 0x86, 0xa0, 0, 0, 0, CHAN_CONFIRM_DEPTH as u8];
8753 // Send a payment with the right payment hash but the wrong payment secret
8754 nodes[0].node.send_payment(&route, our_payment_hash, &Some(random_payment_secret)).unwrap();
8755 handle_unknown_invalid_payment_data!();
8756 expect_payment_failed!(nodes[0], our_payment_hash, true, expected_error_code, expected_error_data);
8758 // Send a payment with a random payment hash, but the right payment secret
8759 nodes[0].node.send_payment(&route, random_payment_hash, &Some(our_payment_secret)).unwrap();
8760 handle_unknown_invalid_payment_data!();
8761 expect_payment_failed!(nodes[0], random_payment_hash, true, expected_error_code, expected_error_data);
8763 // Send a payment with a random payment hash and random payment secret
8764 nodes[0].node.send_payment(&route, random_payment_hash, &Some(random_payment_secret)).unwrap();
8765 handle_unknown_invalid_payment_data!();
8766 expect_payment_failed!(nodes[0], random_payment_hash, true, expected_error_code, expected_error_data);
8770 fn test_update_err_monitor_lockdown() {
8771 // Our monitor will lock update of local commitment transaction if a broadcastion condition
8772 // has been fulfilled (either force-close from Channel or block height requiring a HTLC-
8773 // timeout). Trying to update monitor after lockdown should return a ChannelMonitorUpdateErr.
8775 // This scenario may happen in a watchtower setup, where watchtower process a block height
8776 // triggering a timeout while a slow-block-processing ChannelManager receives a local signed
8777 // commitment at same time.
8779 let chanmon_cfgs = create_chanmon_cfgs(2);
8780 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8781 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8782 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8784 // Create some initial channel
8785 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
8786 let outpoint = OutPoint { txid: chan_1.3.txid(), index: 0 };
8788 // Rebalance the network to generate htlc in the two directions
8789 send_payment(&nodes[0], &vec!(&nodes[1])[..], 10_000_000);
8791 // Route a HTLC from node 0 to node 1 (but don't settle)
8792 let preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000).0;
8794 // Copy ChainMonitor to simulate a watchtower and update block height of node 0 until its ChannelMonitor timeout HTLC onchain
8795 let chain_source = test_utils::TestChainSource::new(Network::Testnet);
8796 let logger = test_utils::TestLogger::with_id(format!("node {}", 0));
8797 let persister = test_utils::TestPersister::new();
8799 let monitors = nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap();
8800 let monitor = monitors.get(&outpoint).unwrap();
8801 let mut w = test_utils::TestVecWriter(Vec::new());
8802 monitor.write(&mut w).unwrap();
8803 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingSigner>)>::read(
8804 &mut ::std::io::Cursor::new(&w.0), &test_utils::OnlyReadsKeysInterface {}).unwrap().1;
8805 assert!(new_monitor == *monitor);
8806 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);
8807 assert!(watchtower.watch_channel(outpoint, new_monitor).is_ok());
8810 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8811 // Make the tx_broadcaster aware of enough blocks that it doesn't think we're violating
8812 // transaction lock time requirements here.
8813 chanmon_cfgs[0].tx_broadcaster.blocks.lock().unwrap().resize(200, (header, 0));
8814 watchtower.chain_monitor.block_connected(&Block { header, txdata: vec![] }, 200);
8816 // Try to update ChannelMonitor
8817 assert!(nodes[1].node.claim_funds(preimage));
8818 check_added_monitors!(nodes[1], 1);
8819 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
8820 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
8821 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
8822 if let Some(ref mut channel) = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan_1.2) {
8823 if let Ok((_, _, _, update)) = channel.commitment_signed(&updates.commitment_signed, &node_cfgs[0].fee_estimator, &node_cfgs[0].logger) {
8824 if let Err(_) = watchtower.chain_monitor.update_channel(outpoint, update.clone()) {} else { assert!(false); }
8825 if let Ok(_) = nodes[0].chain_monitor.update_channel(outpoint, update) {} else { assert!(false); }
8826 } else { assert!(false); }
8827 } else { assert!(false); };
8828 // Our local monitor is in-sync and hasn't processed yet timeout
8829 check_added_monitors!(nodes[0], 1);
8830 let events = nodes[0].node.get_and_clear_pending_events();
8831 assert_eq!(events.len(), 1);
8835 fn test_concurrent_monitor_claim() {
8836 // Watchtower A receives block, broadcasts state N, then channel receives new state N+1,
8837 // sending it to both watchtowers, Bob accepts N+1, then receives block and broadcasts
8838 // the latest state N+1, Alice rejects state N+1, but Bob has already broadcast it,
8839 // state N+1 confirms. Alice claims output from state N+1.
8841 let chanmon_cfgs = create_chanmon_cfgs(2);
8842 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8843 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8844 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8846 // Create some initial channel
8847 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
8848 let outpoint = OutPoint { txid: chan_1.3.txid(), index: 0 };
8850 // Rebalance the network to generate htlc in the two directions
8851 send_payment(&nodes[0], &vec!(&nodes[1])[..], 10_000_000);
8853 // Route a HTLC from node 0 to node 1 (but don't settle)
8854 route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000).0;
8856 // Copy ChainMonitor to simulate watchtower Alice and update block height her ChannelMonitor timeout HTLC onchain
8857 let chain_source = test_utils::TestChainSource::new(Network::Testnet);
8858 let logger = test_utils::TestLogger::with_id(format!("node {}", "Alice"));
8859 let persister = test_utils::TestPersister::new();
8860 let watchtower_alice = {
8861 let monitors = nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap();
8862 let monitor = monitors.get(&outpoint).unwrap();
8863 let mut w = test_utils::TestVecWriter(Vec::new());
8864 monitor.write(&mut w).unwrap();
8865 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingSigner>)>::read(
8866 &mut ::std::io::Cursor::new(&w.0), &test_utils::OnlyReadsKeysInterface {}).unwrap().1;
8867 assert!(new_monitor == *monitor);
8868 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);
8869 assert!(watchtower.watch_channel(outpoint, new_monitor).is_ok());
8872 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8873 // Make the tx_broadcaster aware of enough blocks that it doesn't think we're violating
8874 // transaction lock time requirements here.
8875 chanmon_cfgs[0].tx_broadcaster.blocks.lock().unwrap().resize((CHAN_CONFIRM_DEPTH + 1 + TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS) as usize, (header, 0));
8876 watchtower_alice.chain_monitor.block_connected(&Block { header, txdata: vec![] }, CHAN_CONFIRM_DEPTH + 1 + TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS);
8878 // Watchtower Alice should have broadcast a commitment/HTLC-timeout
8880 let mut txn = chanmon_cfgs[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8881 assert_eq!(txn.len(), 2);
8885 // Copy ChainMonitor to simulate watchtower Bob and make it receive a commitment update first.
8886 let chain_source = test_utils::TestChainSource::new(Network::Testnet);
8887 let logger = test_utils::TestLogger::with_id(format!("node {}", "Bob"));
8888 let persister = test_utils::TestPersister::new();
8889 let watchtower_bob = {
8890 let monitors = nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap();
8891 let monitor = monitors.get(&outpoint).unwrap();
8892 let mut w = test_utils::TestVecWriter(Vec::new());
8893 monitor.write(&mut w).unwrap();
8894 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingSigner>)>::read(
8895 &mut ::std::io::Cursor::new(&w.0), &test_utils::OnlyReadsKeysInterface {}).unwrap().1;
8896 assert!(new_monitor == *monitor);
8897 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);
8898 assert!(watchtower.watch_channel(outpoint, new_monitor).is_ok());
8901 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8902 watchtower_bob.chain_monitor.block_connected(&Block { header, txdata: vec![] }, CHAN_CONFIRM_DEPTH + TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS);
8904 // Route another payment to generate another update with still previous HTLC pending
8905 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[0]);
8907 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
8908 let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[0].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 3000000 , TEST_FINAL_CLTV, &logger).unwrap();
8909 nodes[1].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
8911 check_added_monitors!(nodes[1], 1);
8913 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
8914 assert_eq!(updates.update_add_htlcs.len(), 1);
8915 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &updates.update_add_htlcs[0]);
8916 if let Some(ref mut channel) = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan_1.2) {
8917 if let Ok((_, _, _, update)) = channel.commitment_signed(&updates.commitment_signed, &node_cfgs[0].fee_estimator, &node_cfgs[0].logger) {
8918 // Watchtower Alice should already have seen the block and reject the update
8919 if let Err(_) = watchtower_alice.chain_monitor.update_channel(outpoint, update.clone()) {} else { assert!(false); }
8920 if let Ok(_) = watchtower_bob.chain_monitor.update_channel(outpoint, update.clone()) {} else { assert!(false); }
8921 if let Ok(_) = nodes[0].chain_monitor.update_channel(outpoint, update) {} else { assert!(false); }
8922 } else { assert!(false); }
8923 } else { assert!(false); };
8924 // Our local monitor is in-sync and hasn't processed yet timeout
8925 check_added_monitors!(nodes[0], 1);
8927 //// Provide one more block to watchtower Bob, expect broadcast of commitment and HTLC-Timeout
8928 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8929 watchtower_bob.chain_monitor.block_connected(&Block { header, txdata: vec![] }, CHAN_CONFIRM_DEPTH + 1 + TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS);
8931 // Watchtower Bob should have broadcast a commitment/HTLC-timeout
8934 let mut txn = chanmon_cfgs[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8935 assert_eq!(txn.len(), 2);
8936 bob_state_y = txn[0].clone();
8940 // We confirm Bob's state Y on Alice, she should broadcast a HTLC-timeout
8941 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8942 watchtower_alice.chain_monitor.block_connected(&Block { header, txdata: vec![bob_state_y.clone()] }, CHAN_CONFIRM_DEPTH + 2 + TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS);
8944 let htlc_txn = chanmon_cfgs[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8945 // We broadcast twice the transaction, once due to the HTLC-timeout, once due
8946 // the onchain detection of the HTLC output
8947 assert_eq!(htlc_txn.len(), 2);
8948 check_spends!(htlc_txn[0], bob_state_y);
8949 check_spends!(htlc_txn[1], bob_state_y);
8954 fn test_pre_lockin_no_chan_closed_update() {
8955 // Test that if a peer closes a channel in response to a funding_created message we don't
8956 // generate a channel update (as the channel cannot appear on chain without a funding_signed
8959 // Doing so would imply a channel monitor update before the initial channel monitor
8960 // registration, violating our API guarantees.
8962 // Previously, full_stack_target managed to hit this case by opening then closing a channel,
8963 // then opening a second channel with the same funding output as the first (which is not
8964 // rejected because the first channel does not exist in the ChannelManager) and closing it
8965 // before receiving funding_signed.
8966 let chanmon_cfgs = create_chanmon_cfgs(2);
8967 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8968 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8969 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8971 // Create an initial channel
8972 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
8973 let mut open_chan_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8974 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_msg);
8975 let accept_chan_msg = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
8976 nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &accept_chan_msg);
8978 // Move the first channel through the funding flow...
8979 let (temporary_channel_id, tx, _) = create_funding_transaction(&nodes[0], 100000, 42);
8981 nodes[0].node.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
8982 check_added_monitors!(nodes[0], 0);
8984 let funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
8985 let channel_id = ::chain::transaction::OutPoint { txid: funding_created_msg.funding_txid, index: funding_created_msg.funding_output_index }.to_channel_id();
8986 nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msgs::ErrorMessage { channel_id, data: "Hi".to_owned() });
8987 assert!(nodes[0].chain_monitor.added_monitors.lock().unwrap().is_empty());
8991 fn test_htlc_no_detection() {
8992 // This test is a mutation to underscore the detection logic bug we had
8993 // before #653. HTLC value routed is above the remaining balance, thus
8994 // inverting HTLC and `to_remote` output. HTLC will come second and
8995 // it wouldn't be seen by pre-#653 detection as we were enumerate()'ing
8996 // on a watched outputs vector (Vec<TxOut>) thus implicitly relying on
8997 // outputs order detection for correct spending children filtring.
8999 let chanmon_cfgs = create_chanmon_cfgs(2);
9000 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
9001 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
9002 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
9004 // Create some initial channels
9005 let chan_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
9007 send_payment(&nodes[0], &vec!(&nodes[1])[..], 1_000_000);
9008 let (_, our_payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 2_000_000);
9009 let local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
9010 assert_eq!(local_txn[0].input.len(), 1);
9011 assert_eq!(local_txn[0].output.len(), 3);
9012 check_spends!(local_txn[0], chan_1.3);
9014 // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
9015 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
9016 connect_block(&nodes[0], &Block { header, txdata: vec![local_txn[0].clone()] });
9017 // We deliberately connect the local tx twice as this should provoke a failure calling
9018 // this test before #653 fix.
9019 chain::Listen::block_connected(&nodes[0].chain_monitor.chain_monitor, &Block { header, txdata: vec![local_txn[0].clone()] }, nodes[0].best_block_info().1 + 1);
9020 check_closed_broadcast!(nodes[0], true);
9021 check_added_monitors!(nodes[0], 1);
9022 connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1);
9024 let htlc_timeout = {
9025 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
9026 assert_eq!(node_txn[1].input.len(), 1);
9027 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
9028 check_spends!(node_txn[1], local_txn[0]);
9032 let header_201 = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
9033 connect_block(&nodes[0], &Block { header: header_201, txdata: vec![htlc_timeout.clone()] });
9034 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
9035 expect_payment_failed!(nodes[0], our_payment_hash, true);
9038 fn do_test_onchain_htlc_settlement_after_close(broadcast_alice: bool, go_onchain_before_fulfill: bool) {
9039 // If we route an HTLC, then learn the HTLC's preimage after the upstream channel has been
9040 // force-closed, we must claim that HTLC on-chain. (Given an HTLC forwarded from Alice --> Bob -->
9041 // Carol, Alice would be the upstream node, and Carol the downstream.)
9043 // Steps of the test:
9044 // 1) Alice sends a HTLC to Carol through Bob.
9045 // 2) Carol doesn't settle the HTLC.
9046 // 3) If broadcast_alice is true, Alice force-closes her channel with Bob. Else Bob force closes.
9047 // Steps 4 and 5 may be reordered depending on go_onchain_before_fulfill.
9048 // 4) Bob sees the Alice's commitment on his chain or vice versa. An offered output is present
9049 // but can't be claimed as Bob doesn't have yet knowledge of the preimage.
9050 // 5) Carol release the preimage to Bob off-chain.
9051 // 6) Bob claims the offered output on the broadcasted commitment.
9052 let chanmon_cfgs = create_chanmon_cfgs(3);
9053 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
9054 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
9055 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
9057 // Create some initial channels
9058 let chan_ab = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
9059 create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 100000, 10001, InitFeatures::known(), InitFeatures::known());
9061 // Steps (1) and (2):
9062 // Send an HTLC Alice --> Bob --> Carol, but Carol doesn't settle the HTLC back.
9063 let (payment_preimage, _payment_hash, _payment_secret) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3_000_000);
9065 // Check that Alice's commitment transaction now contains an output for this HTLC.
9066 let alice_txn = get_local_commitment_txn!(nodes[0], chan_ab.2);
9067 check_spends!(alice_txn[0], chan_ab.3);
9068 assert_eq!(alice_txn[0].output.len(), 2);
9069 check_spends!(alice_txn[1], alice_txn[0]); // 2nd transaction is a non-final HTLC-timeout
9070 assert_eq!(alice_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
9071 assert_eq!(alice_txn.len(), 2);
9073 // Steps (3) and (4):
9074 // If `go_onchain_before_fufill`, broadcast the relevant commitment transaction and check that Bob
9075 // responds by (1) broadcasting a channel update and (2) adding a new ChannelMonitor.
9076 let mut force_closing_node = 0; // Alice force-closes
9077 if !broadcast_alice { force_closing_node = 1; } // Bob force-closes
9078 nodes[force_closing_node].node.force_close_channel(&chan_ab.2).unwrap();
9079 check_closed_broadcast!(nodes[force_closing_node], true);
9080 check_added_monitors!(nodes[force_closing_node], 1);
9081 if go_onchain_before_fulfill {
9082 let txn_to_broadcast = match broadcast_alice {
9083 true => alice_txn.clone(),
9084 false => get_local_commitment_txn!(nodes[1], chan_ab.2)
9086 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
9087 connect_block(&nodes[1], &Block { header, txdata: vec![txn_to_broadcast[0].clone()]});
9088 let mut bob_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
9089 if broadcast_alice {
9090 check_closed_broadcast!(nodes[1], true);
9091 check_added_monitors!(nodes[1], 1);
9093 assert_eq!(bob_txn.len(), 1);
9094 check_spends!(bob_txn[0], chan_ab.3);
9098 // Carol then claims the funds and sends an update_fulfill message to Bob, and they go through the
9099 // process of removing the HTLC from their commitment transactions.
9100 assert!(nodes[2].node.claim_funds(payment_preimage));
9101 check_added_monitors!(nodes[2], 1);
9102 let carol_updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
9103 assert!(carol_updates.update_add_htlcs.is_empty());
9104 assert!(carol_updates.update_fail_htlcs.is_empty());
9105 assert!(carol_updates.update_fail_malformed_htlcs.is_empty());
9106 assert!(carol_updates.update_fee.is_none());
9107 assert_eq!(carol_updates.update_fulfill_htlcs.len(), 1);
9109 nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &carol_updates.update_fulfill_htlcs[0]);
9110 // If Alice broadcasted but Bob doesn't know yet, here he prepares to tell her about the preimage.
9111 if !go_onchain_before_fulfill && broadcast_alice {
9112 let events = nodes[1].node.get_and_clear_pending_msg_events();
9113 assert_eq!(events.len(), 1);
9115 MessageSendEvent::UpdateHTLCs { ref node_id, .. } => {
9116 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
9118 _ => panic!("Unexpected event"),
9121 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &carol_updates.commitment_signed);
9122 // One monitor update for the preimage to update the Bob<->Alice channel, one monitor update
9123 // Carol<->Bob's updated commitment transaction info.
9124 check_added_monitors!(nodes[1], 2);
9126 let events = nodes[1].node.get_and_clear_pending_msg_events();
9127 assert_eq!(events.len(), 2);
9128 let bob_revocation = match events[0] {
9129 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
9130 assert_eq!(*node_id, nodes[2].node.get_our_node_id());
9133 _ => panic!("Unexpected event"),
9135 let bob_updates = match events[1] {
9136 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
9137 assert_eq!(*node_id, nodes[2].node.get_our_node_id());
9140 _ => panic!("Unexpected event"),
9143 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bob_revocation);
9144 check_added_monitors!(nodes[2], 1);
9145 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bob_updates.commitment_signed);
9146 check_added_monitors!(nodes[2], 1);
9148 let events = nodes[2].node.get_and_clear_pending_msg_events();
9149 assert_eq!(events.len(), 1);
9150 let carol_revocation = match events[0] {
9151 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
9152 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
9155 _ => panic!("Unexpected event"),
9157 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &carol_revocation);
9158 check_added_monitors!(nodes[1], 1);
9160 // If this test requires the force-closed channel to not be on-chain until after the fulfill,
9161 // here's where we put said channel's commitment tx on-chain.
9162 let mut txn_to_broadcast = alice_txn.clone();
9163 if !broadcast_alice { txn_to_broadcast = get_local_commitment_txn!(nodes[1], chan_ab.2); }
9164 if !go_onchain_before_fulfill {
9165 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
9166 connect_block(&nodes[1], &Block { header, txdata: vec![txn_to_broadcast[0].clone()]});
9167 // If Bob was the one to force-close, he will have already passed these checks earlier.
9168 if broadcast_alice {
9169 check_closed_broadcast!(nodes[1], true);
9170 check_added_monitors!(nodes[1], 1);
9172 let mut bob_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
9173 if broadcast_alice {
9174 // In `connect_block()`, the ChainMonitor and ChannelManager are separately notified about a
9175 // new block being connected. The ChannelManager being notified triggers a monitor update,
9176 // which triggers broadcasting our commitment tx and an HTLC-claiming tx. The ChainMonitor
9177 // being notified triggers the HTLC-claiming tx redundantly, resulting in 3 total txs being
9179 assert_eq!(bob_txn.len(), 3);
9180 check_spends!(bob_txn[1], chan_ab.3);
9182 assert_eq!(bob_txn.len(), 2);
9183 check_spends!(bob_txn[0], chan_ab.3);
9188 // Finally, check that Bob broadcasted a preimage-claiming transaction for the HTLC output on the
9189 // broadcasted commitment transaction.
9191 let bob_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
9192 if go_onchain_before_fulfill {
9193 // Bob should now have an extra broadcasted tx, for the preimage-claiming transaction.
9194 assert_eq!(bob_txn.len(), 2);
9196 let script_weight = match broadcast_alice {
9197 true => OFFERED_HTLC_SCRIPT_WEIGHT,
9198 false => ACCEPTED_HTLC_SCRIPT_WEIGHT
9200 // If Alice force-closed and Bob didn't receive her commitment transaction until after he
9201 // received Carol's fulfill, he broadcasts the HTLC-output-claiming transaction first. Else if
9202 // Bob force closed or if he found out about Alice's commitment tx before receiving Carol's
9203 // fulfill, then he broadcasts the HTLC-output-claiming transaction second.
9204 if broadcast_alice && !go_onchain_before_fulfill {
9205 check_spends!(bob_txn[0], txn_to_broadcast[0]);
9206 assert_eq!(bob_txn[0].input[0].witness.last().unwrap().len(), script_weight);
9208 check_spends!(bob_txn[1], txn_to_broadcast[0]);
9209 assert_eq!(bob_txn[1].input[0].witness.last().unwrap().len(), script_weight);
9215 fn test_onchain_htlc_settlement_after_close() {
9216 do_test_onchain_htlc_settlement_after_close(true, true);
9217 do_test_onchain_htlc_settlement_after_close(false, true); // Technically redundant, but may as well
9218 do_test_onchain_htlc_settlement_after_close(true, false);
9219 do_test_onchain_htlc_settlement_after_close(false, false);
9223 fn test_duplicate_chan_id() {
9224 // Test that if a given peer tries to open a channel with the same channel_id as one that is
9225 // already open we reject it and keep the old channel.
9227 // Previously, full_stack_target managed to figure out that if you tried to open two channels
9228 // with the same funding output (ie post-funding channel_id), we'd create a monitor update for
9229 // the existing channel when we detect the duplicate new channel, screwing up our monitor
9230 // updating logic for the existing channel.
9231 let chanmon_cfgs = create_chanmon_cfgs(2);
9232 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
9233 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
9234 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
9236 // Create an initial channel
9237 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
9238 let mut open_chan_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
9239 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_msg);
9240 nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id()));
9242 // Try to create a second channel with the same temporary_channel_id as the first and check
9243 // that it is rejected.
9244 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_msg);
9246 let events = nodes[1].node.get_and_clear_pending_msg_events();
9247 assert_eq!(events.len(), 1);
9249 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
9250 // Technically, at this point, nodes[1] would be justified in thinking both the
9251 // first (valid) and second (invalid) channels are closed, given they both have
9252 // the same non-temporary channel_id. However, currently we do not, so we just
9253 // move forward with it.
9254 assert_eq!(msg.channel_id, open_chan_msg.temporary_channel_id);
9255 assert_eq!(node_id, nodes[0].node.get_our_node_id());
9257 _ => panic!("Unexpected event"),
9261 // Move the first channel through the funding flow...
9262 let (temporary_channel_id, tx, funding_output) = create_funding_transaction(&nodes[0], 100000, 42);
9264 nodes[0].node.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
9265 check_added_monitors!(nodes[0], 0);
9267 let mut funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
9268 nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created_msg);
9270 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
9271 assert_eq!(added_monitors.len(), 1);
9272 assert_eq!(added_monitors[0].0, funding_output);
9273 added_monitors.clear();
9275 let funding_signed_msg = get_event_msg!(nodes[1], MessageSendEvent::SendFundingSigned, nodes[0].node.get_our_node_id());
9277 let funding_outpoint = ::chain::transaction::OutPoint { txid: funding_created_msg.funding_txid, index: funding_created_msg.funding_output_index };
9278 let channel_id = funding_outpoint.to_channel_id();
9280 // Now we have the first channel past funding_created (ie it has a txid-based channel_id, not a
9283 // First try to open a second channel with a temporary channel id equal to the txid-based one.
9284 // Technically this is allowed by the spec, but we don't support it and there's little reason
9285 // to. Still, it shouldn't cause any other issues.
9286 open_chan_msg.temporary_channel_id = channel_id;
9287 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_msg);
9289 let events = nodes[1].node.get_and_clear_pending_msg_events();
9290 assert_eq!(events.len(), 1);
9292 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
9293 // Technically, at this point, nodes[1] would be justified in thinking both
9294 // channels are closed, but currently we do not, so we just move forward with it.
9295 assert_eq!(msg.channel_id, open_chan_msg.temporary_channel_id);
9296 assert_eq!(node_id, nodes[0].node.get_our_node_id());
9298 _ => panic!("Unexpected event"),
9302 // Now try to create a second channel which has a duplicate funding output.
9303 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
9304 let open_chan_2_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
9305 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_2_msg);
9306 nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id()));
9307 create_funding_transaction(&nodes[0], 100000, 42); // Get and check the FundingGenerationReady event
9309 let funding_created = {
9310 let mut a_channel_lock = nodes[0].node.channel_state.lock().unwrap();
9311 let mut as_chan = a_channel_lock.by_id.get_mut(&open_chan_2_msg.temporary_channel_id).unwrap();
9312 let logger = test_utils::TestLogger::new();
9313 as_chan.get_outbound_funding_created(tx.clone(), funding_outpoint, &&logger).unwrap()
9315 check_added_monitors!(nodes[0], 0);
9316 nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created);
9317 // At this point we'll try to add a duplicate channel monitor, which will be rejected, but
9318 // still needs to be cleared here.
9319 check_added_monitors!(nodes[1], 1);
9321 // ...still, nodes[1] will reject the duplicate channel.
9323 let events = nodes[1].node.get_and_clear_pending_msg_events();
9324 assert_eq!(events.len(), 1);
9326 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
9327 // Technically, at this point, nodes[1] would be justified in thinking both
9328 // channels are closed, but currently we do not, so we just move forward with it.
9329 assert_eq!(msg.channel_id, channel_id);
9330 assert_eq!(node_id, nodes[0].node.get_our_node_id());
9332 _ => panic!("Unexpected event"),
9336 // finally, finish creating the original channel and send a payment over it to make sure
9337 // everything is functional.
9338 nodes[0].node.handle_funding_signed(&nodes[1].node.get_our_node_id(), &funding_signed_msg);
9340 let mut added_monitors = nodes[0].chain_monitor.added_monitors.lock().unwrap();
9341 assert_eq!(added_monitors.len(), 1);
9342 assert_eq!(added_monitors[0].0, funding_output);
9343 added_monitors.clear();
9346 let events_4 = nodes[0].node.get_and_clear_pending_events();
9347 assert_eq!(events_4.len(), 0);
9348 assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
9349 assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0].txid(), funding_output.txid);
9351 let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
9352 let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
9353 update_nodes_with_chan_announce(&nodes, 0, 1, &announcement, &as_update, &bs_update);
9354 send_payment(&nodes[0], &[&nodes[1]], 8000000);
9358 fn test_error_chans_closed() {
9359 // Test that we properly handle error messages, closing appropriate channels.
9361 // Prior to #787 we'd allow a peer to make us force-close a channel we had with a different
9362 // peer. The "real" fix for that is to index channels with peers_ids, however in the mean time
9363 // we can test various edge cases around it to ensure we don't regress.
9364 let chanmon_cfgs = create_chanmon_cfgs(3);
9365 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
9366 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
9367 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
9369 // Create some initial channels
9370 let chan_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
9371 let chan_2 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
9372 let chan_3 = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 100000, 10001, InitFeatures::known(), InitFeatures::known());
9374 assert_eq!(nodes[0].node.list_usable_channels().len(), 3);
9375 assert_eq!(nodes[1].node.list_usable_channels().len(), 2);
9376 assert_eq!(nodes[2].node.list_usable_channels().len(), 1);
9378 // Closing a channel from a different peer has no effect
9379 nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msgs::ErrorMessage { channel_id: chan_3.2, data: "ERR".to_owned() });
9380 assert_eq!(nodes[0].node.list_usable_channels().len(), 3);
9382 // Closing one channel doesn't impact others
9383 nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msgs::ErrorMessage { channel_id: chan_2.2, data: "ERR".to_owned() });
9384 check_added_monitors!(nodes[0], 1);
9385 check_closed_broadcast!(nodes[0], false);
9386 assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0).len(), 1);
9387 assert_eq!(nodes[0].node.list_usable_channels().len(), 2);
9388 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);
9389 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);
9391 // A null channel ID should close all channels
9392 let _chan_4 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
9393 nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msgs::ErrorMessage { channel_id: [0; 32], data: "ERR".to_owned() });
9394 check_added_monitors!(nodes[0], 2);
9395 let events = nodes[0].node.get_and_clear_pending_msg_events();
9396 assert_eq!(events.len(), 2);
9398 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
9399 assert_eq!(msg.contents.flags & 2, 2);
9401 _ => panic!("Unexpected event"),
9404 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
9405 assert_eq!(msg.contents.flags & 2, 2);
9407 _ => panic!("Unexpected event"),
9409 // Note that at this point users of a standard PeerHandler will end up calling
9410 // peer_disconnected with no_connection_possible set to false, duplicating the
9411 // close-all-channels logic. That's OK, we don't want to end up not force-closing channels for
9412 // users with their own peer handling logic. We duplicate the call here, however.
9413 assert_eq!(nodes[0].node.list_usable_channels().len(), 1);
9414 assert!(nodes[0].node.list_usable_channels()[0].channel_id == chan_3.2);
9416 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), true);
9417 assert_eq!(nodes[0].node.list_usable_channels().len(), 1);
9418 assert!(nodes[0].node.list_usable_channels()[0].channel_id == chan_3.2);
9422 fn test_invalid_funding_tx() {
9423 // Test that we properly handle invalid funding transactions sent to us from a peer.
9425 // Previously, all other major lightning implementations had failed to properly sanitize
9426 // funding transactions from their counterparties, leading to a multi-implementation critical
9427 // security vulnerability (though we always sanitized properly, we've previously had
9428 // un-released crashes in the sanitization process).
9429 let chanmon_cfgs = create_chanmon_cfgs(2);
9430 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
9431 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
9432 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
9434 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100_000, 10_000, 42, None).unwrap();
9435 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id()));
9436 nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id()));
9438 let (temporary_channel_id, mut tx, _) = create_funding_transaction(&nodes[0], 100_000, 42);
9439 for output in tx.output.iter_mut() {
9440 // Make the confirmed funding transaction have a bogus script_pubkey
9441 output.script_pubkey = bitcoin::Script::new();
9444 nodes[0].node.funding_transaction_generated_unchecked(&temporary_channel_id, tx.clone(), 0).unwrap();
9445 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()));
9446 check_added_monitors!(nodes[1], 1);
9448 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()));
9449 check_added_monitors!(nodes[0], 1);
9451 let events_1 = nodes[0].node.get_and_clear_pending_events();
9452 assert_eq!(events_1.len(), 0);
9454 assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
9455 assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0], tx);
9456 nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
9458 confirm_transaction_at(&nodes[1], &tx, 1);
9459 check_added_monitors!(nodes[1], 1);
9460 let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
9461 assert_eq!(events_2.len(), 1);
9462 if let MessageSendEvent::HandleError { node_id, action } = &events_2[0] {
9463 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
9464 if let msgs::ErrorAction::SendErrorMessage { msg } = action {
9465 assert_eq!(msg.data, "funding tx had wrong script/value or output index");
9466 } else { panic!(); }
9467 } else { panic!(); }
9468 assert_eq!(nodes[1].node.list_channels().len(), 0);
9471 fn do_test_tx_confirmed_skipping_blocks_immediate_broadcast(test_height_before_timelock: bool) {
9472 // In the first version of the chain::Confirm interface, after a refactor was made to not
9473 // broadcast CSV-locked transactions until their CSV lock is up, we wouldn't reliably broadcast
9474 // transactions after a `transactions_confirmed` call. Specifically, if the chain, provided via
9475 // `best_block_updated` is at height N, and a transaction output which we wish to spend at
9476 // height N-1 (due to a CSV to height N-1) is provided at height N, we will not broadcast the
9477 // spending transaction until height N+1 (or greater). This was due to the way
9478 // `ChannelMonitor::transactions_confirmed` worked, only checking if we should broadcast a
9479 // spending transaction at the height the input transaction was confirmed at, not whether we
9480 // should broadcast a spending transaction at the current height.
9481 // A second, similar, issue involved failing HTLCs backwards - because we only provided the
9482 // height at which transactions were confirmed to `OnchainTx::update_claims_view`, it wasn't
9483 // aware that the anti-reorg-delay had, in fact, already expired, waiting to fail-backwards
9484 // until we learned about an additional block.
9486 // As an additional check, if `test_height_before_timelock` is set, we instead test that we
9487 // aren't broadcasting transactions too early (ie not broadcasting them at all).
9488 let chanmon_cfgs = create_chanmon_cfgs(3);
9489 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
9490 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
9491 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
9492 *nodes[0].connect_style.borrow_mut() = ConnectStyle::BestBlockFirstSkippingBlocks;
9494 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
9495 let (chan_announce, _, channel_id, _) = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
9496 let (_, payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1_000_000);
9497 nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id(), false);
9498 nodes[2].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
9500 nodes[1].node.force_close_channel(&channel_id).unwrap();
9501 check_closed_broadcast!(nodes[1], true);
9502 check_added_monitors!(nodes[1], 1);
9503 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
9504 assert_eq!(node_txn.len(), 1);
9506 let conf_height = nodes[1].best_block_info().1;
9507 if !test_height_before_timelock {
9508 connect_blocks(&nodes[1], 24 * 6);
9510 nodes[1].chain_monitor.chain_monitor.transactions_confirmed(
9511 &nodes[1].get_block_header(conf_height), &[(0, &node_txn[0])], conf_height);
9512 if test_height_before_timelock {
9513 // If we confirmed the close transaction, but timelocks have not yet expired, we should not
9514 // generate any events or broadcast any transactions
9515 assert!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
9516 assert!(nodes[1].chain_monitor.chain_monitor.get_and_clear_pending_events().is_empty());
9518 // We should broadcast an HTLC transaction spending our funding transaction first
9519 let spending_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
9520 assert_eq!(spending_txn.len(), 2);
9521 assert_eq!(spending_txn[0], node_txn[0]);
9522 check_spends!(spending_txn[1], node_txn[0]);
9523 // We should also generate a SpendableOutputs event with the to_self output (as its
9525 let descriptor_spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
9526 assert_eq!(descriptor_spend_txn.len(), 1);
9528 // If we also discover that the HTLC-Timeout transaction was confirmed some time ago, we
9529 // should immediately fail-backwards the HTLC to the previous hop, without waiting for an
9530 // additional block built on top of the current chain.
9531 nodes[1].chain_monitor.chain_monitor.transactions_confirmed(
9532 &nodes[1].get_block_header(conf_height + 1), &[(0, &spending_txn[1])], conf_height + 1);
9533 expect_pending_htlcs_forwardable!(nodes[1]);
9534 check_added_monitors!(nodes[1], 1);
9536 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
9537 assert!(updates.update_add_htlcs.is_empty());
9538 assert!(updates.update_fulfill_htlcs.is_empty());
9539 assert_eq!(updates.update_fail_htlcs.len(), 1);
9540 assert!(updates.update_fail_malformed_htlcs.is_empty());
9541 assert!(updates.update_fee.is_none());
9542 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
9543 commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, true, true);
9544 expect_payment_failed!(nodes[0], payment_hash, false);
9545 expect_payment_failure_chan_update!(nodes[0], chan_announce.contents.short_channel_id, true);
9549 fn test_tx_confirmed_skipping_blocks_immediate_broadcast() {
9550 do_test_tx_confirmed_skipping_blocks_immediate_broadcast(false);
9551 do_test_tx_confirmed_skipping_blocks_immediate_broadcast(true);