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.
17 use chain::channelmonitor;
18 use chain::channelmonitor::{ChannelMonitor, CLTV_CLAIM_BUFFER, LATENCY_GRACE_PERIOD_BLOCKS, ANTI_REORG_DELAY};
19 use chain::transaction::OutPoint;
20 use chain::keysinterface::{KeysInterface, BaseSign};
21 use ln::{PaymentPreimage, PaymentSecret, PaymentHash};
22 use ln::channel::{COMMITMENT_TX_BASE_WEIGHT, COMMITMENT_TX_WEIGHT_PER_HTLC};
23 use ln::channelmanager::{ChannelManager, ChannelManagerReadArgs, RAACommitmentOrder, PaymentSendFailure, BREAKDOWN_TIMEOUT, MIN_CLTV_EXPIRY_DELTA};
24 use ln::channel::{Channel, ChannelError};
25 use ln::{chan_utils, onion_utils};
26 use routing::router::{Route, RouteHop, get_route};
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 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1044 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_2nd_shutdown);
1045 get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id())
1047 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_2nd_shutdown);
1049 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1050 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1052 assert!(nodes[2].node.claim_funds(our_payment_preimage));
1053 check_added_monitors!(nodes[2], 1);
1054 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1055 assert!(updates.update_add_htlcs.is_empty());
1056 assert!(updates.update_fail_htlcs.is_empty());
1057 assert!(updates.update_fail_malformed_htlcs.is_empty());
1058 assert!(updates.update_fee.is_none());
1059 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
1060 nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
1061 check_added_monitors!(nodes[1], 1);
1062 let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1063 commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
1065 assert!(updates_2.update_add_htlcs.is_empty());
1066 assert!(updates_2.update_fail_htlcs.is_empty());
1067 assert!(updates_2.update_fail_malformed_htlcs.is_empty());
1068 assert!(updates_2.update_fee.is_none());
1069 assert_eq!(updates_2.update_fulfill_htlcs.len(), 1);
1070 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fulfill_htlcs[0]);
1071 commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
1073 let events = nodes[0].node.get_and_clear_pending_events();
1074 assert_eq!(events.len(), 1);
1076 Event::PaymentSent { ref payment_preimage } => {
1077 assert_eq!(our_payment_preimage, *payment_preimage);
1079 _ => panic!("Unexpected event"),
1082 let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
1084 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
1085 let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
1086 assert!(node_1_closing_signed.is_some());
1089 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
1090 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
1092 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1093 let node_0_2nd_reestablish = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
1094 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1095 if recv_count == 0 {
1096 // If all closing_signeds weren't delivered we can just resume where we left off...
1097 let node_1_2nd_reestablish = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
1099 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &node_1_2nd_reestablish);
1100 let node_0_3rd_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
1101 assert!(node_0_2nd_shutdown == node_0_3rd_shutdown);
1103 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_2nd_reestablish);
1104 let node_1_3rd_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
1105 assert!(node_1_3rd_shutdown == node_1_2nd_shutdown);
1107 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_3rd_shutdown);
1108 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1110 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_3rd_shutdown);
1111 let node_0_2nd_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
1112 assert!(node_0_closing_signed == node_0_2nd_closing_signed);
1114 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed);
1115 let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
1116 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
1117 let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
1118 assert!(node_0_none.is_none());
1120 // If one node, however, received + responded with an identical closing_signed we end
1121 // up erroring and node[0] will try to broadcast its own latest commitment transaction.
1122 // There isn't really anything better we can do simply, but in the future we might
1123 // explore storing a set of recently-closed channels that got disconnected during
1124 // closing_signed and avoiding broadcasting local commitment txn for some timeout to
1125 // give our counterparty enough time to (potentially) broadcast a cooperative closing
1127 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1129 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_2nd_reestablish);
1130 let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
1131 assert_eq!(msg_events.len(), 1);
1132 if let MessageSendEvent::HandleError { ref action, .. } = msg_events[0] {
1134 &ErrorAction::SendErrorMessage { ref msg } => {
1135 nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msg);
1136 assert_eq!(msg.channel_id, chan_1.2);
1138 _ => panic!("Unexpected event!"),
1140 } else { panic!("Needed SendErrorMessage close"); }
1142 // get_closing_signed_broadcast usually eats the BroadcastChannelUpdate for us and
1143 // checks it, but in this case nodes[0] didn't ever get a chance to receive a
1144 // closing_signed so we do it ourselves
1145 check_closed_broadcast!(nodes[0], false);
1146 check_added_monitors!(nodes[0], 1);
1149 assert!(nodes[0].node.list_channels().is_empty());
1151 assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
1152 nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
1153 close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
1154 assert!(nodes[1].node.list_channels().is_empty());
1155 assert!(nodes[2].node.list_channels().is_empty());
1159 fn test_shutdown_rebroadcast() {
1160 do_test_shutdown_rebroadcast(0);
1161 do_test_shutdown_rebroadcast(1);
1162 do_test_shutdown_rebroadcast(2);
1166 fn fake_network_test() {
1167 // Simple test which builds a network of ChannelManagers, connects them to each other, and
1168 // tests that payments get routed and transactions broadcast in semi-reasonable ways.
1169 let chanmon_cfgs = create_chanmon_cfgs(4);
1170 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
1171 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
1172 let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
1174 // Create some initial channels
1175 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
1176 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
1177 let chan_3 = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
1179 // Rebalance the network a bit by relaying one payment through all the channels...
1180 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000);
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);
1185 // Send some more payments
1186 send_payment(&nodes[1], &vec!(&nodes[2], &nodes[3])[..], 1000000);
1187 send_payment(&nodes[3], &vec!(&nodes[2], &nodes[1], &nodes[0])[..], 1000000);
1188 send_payment(&nodes[3], &vec!(&nodes[2], &nodes[1])[..], 1000000);
1190 // Test failure packets
1191 let payment_hash_1 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 1000000).1;
1192 fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], payment_hash_1);
1194 // Add a new channel that skips 3
1195 let chan_4 = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known());
1197 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 1000000);
1198 send_payment(&nodes[2], &vec!(&nodes[3])[..], 1000000);
1199 send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
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);
1205 // Do some rebalance loop payments, simultaneously
1206 let mut hops = Vec::with_capacity(3);
1207 hops.push(RouteHop {
1208 pubkey: nodes[2].node.get_our_node_id(),
1209 node_features: NodeFeatures::empty(),
1210 short_channel_id: chan_2.0.contents.short_channel_id,
1211 channel_features: ChannelFeatures::empty(),
1213 cltv_expiry_delta: chan_3.0.contents.cltv_expiry_delta as u32
1215 hops.push(RouteHop {
1216 pubkey: nodes[3].node.get_our_node_id(),
1217 node_features: NodeFeatures::empty(),
1218 short_channel_id: chan_3.0.contents.short_channel_id,
1219 channel_features: ChannelFeatures::empty(),
1221 cltv_expiry_delta: chan_4.1.contents.cltv_expiry_delta as u32
1223 hops.push(RouteHop {
1224 pubkey: nodes[1].node.get_our_node_id(),
1225 node_features: NodeFeatures::known(),
1226 short_channel_id: chan_4.0.contents.short_channel_id,
1227 channel_features: ChannelFeatures::known(),
1229 cltv_expiry_delta: TEST_FINAL_CLTV,
1231 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;
1232 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;
1233 let payment_preimage_1 = send_along_route(&nodes[1], Route { paths: vec![hops] }, &vec!(&nodes[2], &nodes[3], &nodes[1])[..], 1000000).0;
1235 let mut hops = Vec::with_capacity(3);
1236 hops.push(RouteHop {
1237 pubkey: nodes[3].node.get_our_node_id(),
1238 node_features: NodeFeatures::empty(),
1239 short_channel_id: chan_4.0.contents.short_channel_id,
1240 channel_features: ChannelFeatures::empty(),
1242 cltv_expiry_delta: chan_3.1.contents.cltv_expiry_delta as u32
1244 hops.push(RouteHop {
1245 pubkey: nodes[2].node.get_our_node_id(),
1246 node_features: NodeFeatures::empty(),
1247 short_channel_id: chan_3.0.contents.short_channel_id,
1248 channel_features: ChannelFeatures::empty(),
1250 cltv_expiry_delta: chan_2.1.contents.cltv_expiry_delta as u32
1252 hops.push(RouteHop {
1253 pubkey: nodes[1].node.get_our_node_id(),
1254 node_features: NodeFeatures::known(),
1255 short_channel_id: chan_2.0.contents.short_channel_id,
1256 channel_features: ChannelFeatures::known(),
1258 cltv_expiry_delta: TEST_FINAL_CLTV,
1260 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;
1261 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;
1262 let payment_hash_2 = send_along_route(&nodes[1], Route { paths: vec![hops] }, &vec!(&nodes[3], &nodes[2], &nodes[1])[..], 1000000).1;
1264 // Claim the rebalances...
1265 fail_payment(&nodes[1], &vec!(&nodes[3], &nodes[2], &nodes[1])[..], payment_hash_2);
1266 claim_payment(&nodes[1], &vec!(&nodes[2], &nodes[3], &nodes[1])[..], payment_preimage_1);
1268 // Add a duplicate new channel from 2 to 4
1269 let chan_5 = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known());
1271 // Send some payments across both channels
1272 let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
1273 let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
1274 let payment_preimage_5 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
1277 route_over_limit(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000);
1278 let events = nodes[0].node.get_and_clear_pending_msg_events();
1279 assert_eq!(events.len(), 0);
1280 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);
1282 //TODO: Test that routes work again here as we've been notified that the channel is full
1284 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_3);
1285 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_4);
1286 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_5);
1288 // Close down the channels...
1289 close_channel(&nodes[0], &nodes[1], &chan_1.2, chan_1.3, true);
1290 close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, false);
1291 close_channel(&nodes[2], &nodes[3], &chan_3.2, chan_3.3, true);
1292 close_channel(&nodes[1], &nodes[3], &chan_4.2, chan_4.3, false);
1293 close_channel(&nodes[1], &nodes[3], &chan_5.2, chan_5.3, false);
1297 fn holding_cell_htlc_counting() {
1298 // Tests that HTLCs in the holding cell count towards the pending HTLC limits on outbound HTLCs
1299 // to ensure we don't end up with HTLCs sitting around in our holding cell for several
1300 // commitment dance rounds.
1301 let chanmon_cfgs = create_chanmon_cfgs(3);
1302 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1303 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1304 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1305 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
1306 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
1307 let logger = test_utils::TestLogger::new();
1309 let mut payments = Vec::new();
1310 for _ in 0..::ln::channel::OUR_MAX_HTLCS {
1311 let (payment_preimage, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[2]);
1312 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
1313 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();
1314 nodes[1].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
1315 payments.push((payment_preimage, payment_hash));
1317 check_added_monitors!(nodes[1], 1);
1319 let mut events = nodes[1].node.get_and_clear_pending_msg_events();
1320 assert_eq!(events.len(), 1);
1321 let initial_payment_event = SendEvent::from_event(events.pop().unwrap());
1322 assert_eq!(initial_payment_event.node_id, nodes[2].node.get_our_node_id());
1324 // There is now one HTLC in an outbound commitment transaction and (OUR_MAX_HTLCS - 1) HTLCs in
1325 // the holding cell waiting on B's RAA to send. At this point we should not be able to add
1327 let (_, payment_hash_1, payment_secret_1) = get_payment_preimage_hash!(nodes[2]);
1329 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
1330 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();
1331 unwrap_send_err!(nodes[1].node.send_payment(&route, payment_hash_1, &Some(payment_secret_1)), true, APIError::ChannelUnavailable { ref err },
1332 assert!(regex::Regex::new(r"Cannot push more than their max accepted HTLCs \(\d+\)").unwrap().is_match(err)));
1333 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1334 nodes[1].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot push more than their max accepted HTLCs".to_string(), 1);
1337 // This should also be true if we try to forward a payment.
1338 let (_, payment_hash_2, payment_secret_2) = get_payment_preimage_hash!(nodes[2]);
1340 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
1341 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();
1342 nodes[0].node.send_payment(&route, payment_hash_2, &Some(payment_secret_2)).unwrap();
1343 check_added_monitors!(nodes[0], 1);
1346 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1347 assert_eq!(events.len(), 1);
1348 let payment_event = SendEvent::from_event(events.pop().unwrap());
1349 assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
1351 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1352 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
1353 // We have to forward pending HTLCs twice - once tries to forward the payment forward (and
1354 // fails), the second will process the resulting failure and fail the HTLC backward.
1355 expect_pending_htlcs_forwardable!(nodes[1]);
1356 expect_pending_htlcs_forwardable!(nodes[1]);
1357 check_added_monitors!(nodes[1], 1);
1359 let bs_fail_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1360 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &bs_fail_updates.update_fail_htlcs[0]);
1361 commitment_signed_dance!(nodes[0], nodes[1], bs_fail_updates.commitment_signed, false, true);
1363 expect_payment_failure_chan_update!(nodes[0], chan_2.0.contents.short_channel_id, false);
1364 expect_payment_failed!(nodes[0], payment_hash_2, false);
1366 // Now forward all the pending HTLCs and claim them back
1367 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &initial_payment_event.msgs[0]);
1368 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &initial_payment_event.commitment_msg);
1369 check_added_monitors!(nodes[2], 1);
1371 let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1372 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_revoke_and_ack);
1373 check_added_monitors!(nodes[1], 1);
1374 let as_updates = get_htlc_update_msgs!(nodes[1], nodes[2].node.get_our_node_id());
1376 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &bs_commitment_signed);
1377 check_added_monitors!(nodes[1], 1);
1378 let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
1380 for ref update in as_updates.update_add_htlcs.iter() {
1381 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), update);
1383 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &as_updates.commitment_signed);
1384 check_added_monitors!(nodes[2], 1);
1385 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
1386 check_added_monitors!(nodes[2], 1);
1387 let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1389 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_revoke_and_ack);
1390 check_added_monitors!(nodes[1], 1);
1391 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &bs_commitment_signed);
1392 check_added_monitors!(nodes[1], 1);
1393 let as_final_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
1395 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_final_raa);
1396 check_added_monitors!(nodes[2], 1);
1398 expect_pending_htlcs_forwardable!(nodes[2]);
1400 let events = nodes[2].node.get_and_clear_pending_events();
1401 assert_eq!(events.len(), payments.len());
1402 for (event, &(_, ref hash)) in events.iter().zip(payments.iter()) {
1404 &Event::PaymentReceived { ref payment_hash, .. } => {
1405 assert_eq!(*payment_hash, *hash);
1407 _ => panic!("Unexpected event"),
1411 for (preimage, _) in payments.drain(..) {
1412 claim_payment(&nodes[1], &[&nodes[2]], preimage);
1415 send_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1000000);
1419 fn duplicate_htlc_test() {
1420 // Test that we accept duplicate payment_hash HTLCs across the network and that
1421 // claiming/failing them are all separate and don't affect each other
1422 let chanmon_cfgs = create_chanmon_cfgs(6);
1423 let node_cfgs = create_node_cfgs(6, &chanmon_cfgs);
1424 let node_chanmgrs = create_node_chanmgrs(6, &node_cfgs, &[None, None, None, None, None, None]);
1425 let mut nodes = create_network(6, &node_cfgs, &node_chanmgrs);
1427 // Create some initial channels to route via 3 to 4/5 from 0/1/2
1428 create_announced_chan_between_nodes(&nodes, 0, 3, InitFeatures::known(), InitFeatures::known());
1429 create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known());
1430 create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
1431 create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::known(), InitFeatures::known());
1432 create_announced_chan_between_nodes(&nodes, 3, 5, InitFeatures::known(), InitFeatures::known());
1434 let (payment_preimage, payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[3], &nodes[4])[..], 1000000);
1436 *nodes[0].network_payment_count.borrow_mut() -= 1;
1437 assert_eq!(route_payment(&nodes[1], &vec!(&nodes[3])[..], 1000000).0, payment_preimage);
1439 *nodes[0].network_payment_count.borrow_mut() -= 1;
1440 assert_eq!(route_payment(&nodes[2], &vec!(&nodes[3], &nodes[5])[..], 1000000).0, payment_preimage);
1442 claim_payment(&nodes[0], &vec!(&nodes[3], &nodes[4])[..], payment_preimage);
1443 fail_payment(&nodes[2], &vec!(&nodes[3], &nodes[5])[..], payment_hash);
1444 claim_payment(&nodes[1], &vec!(&nodes[3])[..], payment_preimage);
1448 fn test_duplicate_htlc_different_direction_onchain() {
1449 // Test that ChannelMonitor doesn't generate 2 preimage txn
1450 // when we have 2 HTLCs with same preimage that go across a node
1451 // in opposite directions, even with the same payment secret.
1452 let chanmon_cfgs = create_chanmon_cfgs(2);
1453 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1454 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1455 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1457 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
1458 let logger = test_utils::TestLogger::new();
1461 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
1463 let (payment_preimage, payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 900_000);
1465 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
1466 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();
1467 let node_a_payment_secret = nodes[0].node.create_inbound_payment_for_hash(payment_hash, None, 7200, 0).unwrap();
1468 send_along_route_with_secret(&nodes[1], route, &[&[&nodes[0]]], 800_000, payment_hash, node_a_payment_secret);
1470 // Provide preimage to node 0 by claiming payment
1471 nodes[0].node.claim_funds(payment_preimage);
1472 check_added_monitors!(nodes[0], 1);
1474 // Broadcast node 1 commitment txn
1475 let remote_txn = get_local_commitment_txn!(nodes[1], chan_1.2);
1477 assert_eq!(remote_txn[0].output.len(), 4); // 1 local, 1 remote, 1 htlc inbound, 1 htlc outbound
1478 let mut has_both_htlcs = 0; // check htlcs match ones committed
1479 for outp in remote_txn[0].output.iter() {
1480 if outp.value == 800_000 / 1000 {
1481 has_both_htlcs += 1;
1482 } else if outp.value == 900_000 / 1000 {
1483 has_both_htlcs += 1;
1486 assert_eq!(has_both_htlcs, 2);
1488 mine_transaction(&nodes[0], &remote_txn[0]);
1489 check_added_monitors!(nodes[0], 1);
1490 connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
1492 // Check we only broadcast 1 timeout tx
1493 let claim_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
1494 assert_eq!(claim_txn.len(), 8);
1495 assert_eq!(claim_txn[1], claim_txn[4]);
1496 assert_eq!(claim_txn[2], claim_txn[5]);
1497 check_spends!(claim_txn[1], chan_1.3);
1498 check_spends!(claim_txn[2], claim_txn[1]);
1499 check_spends!(claim_txn[7], claim_txn[1]);
1501 assert_eq!(claim_txn[0].input.len(), 1);
1502 assert_eq!(claim_txn[3].input.len(), 1);
1503 assert_eq!(claim_txn[0].input[0].previous_output, claim_txn[3].input[0].previous_output);
1505 assert_eq!(claim_txn[0].input.len(), 1);
1506 assert_eq!(claim_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC 1 <--> 0, preimage tx
1507 check_spends!(claim_txn[0], remote_txn[0]);
1508 assert_eq!(remote_txn[0].output[claim_txn[0].input[0].previous_output.vout as usize].value, 800);
1509 assert_eq!(claim_txn[6].input.len(), 1);
1510 assert_eq!(claim_txn[6].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // HTLC 0 <--> 1, timeout tx
1511 check_spends!(claim_txn[6], remote_txn[0]);
1512 assert_eq!(remote_txn[0].output[claim_txn[6].input[0].previous_output.vout as usize].value, 900);
1514 let events = nodes[0].node.get_and_clear_pending_msg_events();
1515 assert_eq!(events.len(), 3);
1518 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
1519 MessageSendEvent::HandleError { node_id, action: msgs::ErrorAction::SendErrorMessage { ref msg } } => {
1520 assert_eq!(node_id, nodes[1].node.get_our_node_id());
1521 assert_eq!(msg.data, "Commitment or closing transaction was confirmed on chain.");
1523 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, .. } } => {
1524 assert!(update_add_htlcs.is_empty());
1525 assert!(update_fail_htlcs.is_empty());
1526 assert_eq!(update_fulfill_htlcs.len(), 1);
1527 assert!(update_fail_malformed_htlcs.is_empty());
1528 assert_eq!(nodes[1].node.get_our_node_id(), *node_id);
1530 _ => panic!("Unexpected event"),
1536 fn test_basic_channel_reserve() {
1537 let chanmon_cfgs = create_chanmon_cfgs(2);
1538 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1539 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1540 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1541 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1542 let logger = test_utils::TestLogger::new();
1544 let chan_stat = get_channel_value_stat!(nodes[0], chan.2);
1545 let channel_reserve = chan_stat.channel_reserve_msat;
1547 // The 2* and +1 are for the fee spike reserve.
1548 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
1549 let commit_tx_fee = 2 * commit_tx_fee_msat(get_feerate!(nodes[0], chan.2), 1 + 1);
1550 let max_can_send = 5000000 - channel_reserve - commit_tx_fee;
1551 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
1552 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();
1553 let err = nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).err().unwrap();
1555 PaymentSendFailure::AllFailedRetrySafe(ref fails) => {
1557 &APIError::ChannelUnavailable{ref err} =>
1558 assert!(regex::Regex::new(r"Cannot send value that would put our balance under counterparty-announced channel reserve value \(\d+\)").unwrap().is_match(err)),
1559 _ => panic!("Unexpected error variant"),
1562 _ => panic!("Unexpected error variant"),
1564 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1565 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);
1567 send_payment(&nodes[0], &vec![&nodes[1]], max_can_send);
1571 fn test_fee_spike_violation_fails_htlc() {
1572 let chanmon_cfgs = create_chanmon_cfgs(2);
1573 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1574 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1575 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1576 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1578 let (route, payment_hash, _, payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], 3460001);
1579 // Need to manually create the update_add_htlc message to go around the channel reserve check in send_htlc()
1580 let secp_ctx = Secp256k1::new();
1581 let session_priv = SecretKey::from_slice(&[42; 32]).expect("RNG is bad!");
1583 let cur_height = nodes[1].node.best_block.read().unwrap().height() + 1;
1585 let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route.paths[0], &session_priv).unwrap();
1586 let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 3460001, &Some(payment_secret), cur_height).unwrap();
1587 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
1588 let msg = msgs::UpdateAddHTLC {
1591 amount_msat: htlc_msat,
1592 payment_hash: payment_hash,
1593 cltv_expiry: htlc_cltv,
1594 onion_routing_packet: onion_packet,
1597 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
1599 // Now manually create the commitment_signed message corresponding to the update_add
1600 // nodes[0] just sent. In the code for construction of this message, "local" refers
1601 // to the sender of the message, and "remote" refers to the receiver.
1603 let feerate_per_kw = get_feerate!(nodes[0], chan.2);
1605 const INITIAL_COMMITMENT_NUMBER: u64 = (1 << 48) - 1;
1607 // Get the EnforcingSigner for each channel, which will be used to (1) get the keys
1608 // needed to sign the new commitment tx and (2) sign the new commitment tx.
1609 let (local_revocation_basepoint, local_htlc_basepoint, local_secret, next_local_point) = {
1610 let chan_lock = nodes[0].node.channel_state.lock().unwrap();
1611 let local_chan = chan_lock.by_id.get(&chan.2).unwrap();
1612 let chan_signer = local_chan.get_signer();
1613 let pubkeys = chan_signer.pubkeys();
1614 (pubkeys.revocation_basepoint, pubkeys.htlc_basepoint,
1615 chan_signer.release_commitment_secret(INITIAL_COMMITMENT_NUMBER),
1616 chan_signer.get_per_commitment_point(INITIAL_COMMITMENT_NUMBER - 2, &secp_ctx))
1618 let (remote_delayed_payment_basepoint, remote_htlc_basepoint,remote_point) = {
1619 let chan_lock = nodes[1].node.channel_state.lock().unwrap();
1620 let remote_chan = chan_lock.by_id.get(&chan.2).unwrap();
1621 let chan_signer = remote_chan.get_signer();
1622 let pubkeys = chan_signer.pubkeys();
1623 (pubkeys.delayed_payment_basepoint, pubkeys.htlc_basepoint,
1624 chan_signer.get_per_commitment_point(INITIAL_COMMITMENT_NUMBER - 1, &secp_ctx))
1627 // Assemble the set of keys we can use for signatures for our commitment_signed message.
1628 let commit_tx_keys = chan_utils::TxCreationKeys::derive_new(&secp_ctx, &remote_point, &remote_delayed_payment_basepoint,
1629 &remote_htlc_basepoint, &local_revocation_basepoint, &local_htlc_basepoint).unwrap();
1631 // Build the remote commitment transaction so we can sign it, and then later use the
1632 // signature for the commitment_signed message.
1633 let local_chan_balance = 1313;
1635 let accepted_htlc_info = chan_utils::HTLCOutputInCommitment {
1637 amount_msat: 3460001,
1638 cltv_expiry: htlc_cltv,
1640 transaction_output_index: Some(1),
1643 let commitment_number = INITIAL_COMMITMENT_NUMBER - 1;
1646 let local_chan_lock = nodes[0].node.channel_state.lock().unwrap();
1647 let local_chan = local_chan_lock.by_id.get(&chan.2).unwrap();
1648 let local_chan_signer = local_chan.get_signer();
1649 let commitment_tx = CommitmentTransaction::new_with_auxiliary_htlc_data(
1653 commit_tx_keys.clone(),
1655 &mut vec![(accepted_htlc_info, ())],
1656 &local_chan.channel_transaction_parameters.as_counterparty_broadcastable()
1658 local_chan_signer.sign_counterparty_commitment(&commitment_tx, &secp_ctx).unwrap()
1661 let commit_signed_msg = msgs::CommitmentSigned {
1664 htlc_signatures: res.1
1667 // Send the commitment_signed message to the nodes[1].
1668 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commit_signed_msg);
1669 let _ = nodes[1].node.get_and_clear_pending_msg_events();
1671 // Send the RAA to nodes[1].
1672 let raa_msg = msgs::RevokeAndACK {
1674 per_commitment_secret: local_secret,
1675 next_per_commitment_point: next_local_point
1677 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &raa_msg);
1679 let events = nodes[1].node.get_and_clear_pending_msg_events();
1680 assert_eq!(events.len(), 1);
1681 // Make sure the HTLC failed in the way we expect.
1683 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fail_htlcs, .. }, .. } => {
1684 assert_eq!(update_fail_htlcs.len(), 1);
1685 update_fail_htlcs[0].clone()
1687 _ => panic!("Unexpected event"),
1689 nodes[1].logger.assert_log("lightning::ln::channel".to_string(),
1690 format!("Attempting to fail HTLC due to fee spike buffer violation in channel {}. Rebalancing is required.", ::hex::encode(raa_msg.channel_id)), 1);
1692 check_added_monitors!(nodes[1], 2);
1696 fn test_chan_reserve_violation_outbound_htlc_inbound_chan() {
1697 let mut chanmon_cfgs = create_chanmon_cfgs(2);
1698 // Set the fee rate for the channel very high, to the point where the fundee
1699 // sending any above-dust amount would result in a channel reserve violation.
1700 // In this test we check that we would be prevented from sending an HTLC in
1702 chanmon_cfgs[0].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 6000 };
1703 chanmon_cfgs[1].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 6000 };
1704 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1705 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1706 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1707 let _ = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1709 let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[1], nodes[0], 4843000);
1710 unwrap_send_err!(nodes[1].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
1711 assert_eq!(err, "Cannot send value that would put counterparty balance under holder-announced channel reserve value"));
1712 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1713 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);
1717 fn test_chan_reserve_violation_inbound_htlc_outbound_channel() {
1718 let mut chanmon_cfgs = create_chanmon_cfgs(2);
1719 // Set the fee rate for the channel very high, to the point where the funder
1720 // receiving 1 update_add_htlc would result in them closing the channel due
1721 // to channel reserve violation. This close could also happen if the fee went
1722 // up a more realistic amount, but many HTLCs were outstanding at the time of
1723 // the update_add_htlc.
1724 chanmon_cfgs[0].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 6000 };
1725 chanmon_cfgs[1].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 6000 };
1726 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1727 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1728 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1729 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1731 let (route, payment_hash, _, payment_secret) = get_route_and_payment_hash!(nodes[1], nodes[0], 1000);
1732 // Need to manually create the update_add_htlc message to go around the channel reserve check in send_htlc()
1733 let secp_ctx = Secp256k1::new();
1734 let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
1735 let cur_height = nodes[1].node.best_block.read().unwrap().height() + 1;
1736 let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route.paths[0], &session_priv).unwrap();
1737 let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 1000, &Some(payment_secret), cur_height).unwrap();
1738 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
1739 let msg = msgs::UpdateAddHTLC {
1742 amount_msat: htlc_msat + 1,
1743 payment_hash: payment_hash,
1744 cltv_expiry: htlc_cltv,
1745 onion_routing_packet: onion_packet,
1748 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &msg);
1749 // Check that the payment failed and the channel is closed in response to the malicious UpdateAdd.
1750 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);
1751 assert_eq!(nodes[0].node.list_channels().len(), 0);
1752 let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
1753 assert_eq!(err_msg.data, "Cannot accept HTLC that would put our balance under counterparty-announced channel reserve value");
1754 check_added_monitors!(nodes[0], 1);
1758 fn test_chan_reserve_dust_inbound_htlcs_outbound_chan() {
1759 // Test that if we receive many dust HTLCs over an outbound channel, they don't count when
1760 // calculating our commitment transaction fee (this was previously broken).
1761 let chanmon_cfgs = create_chanmon_cfgs(2);
1762 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1763 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None, None]);
1764 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1766 // Set nodes[0]'s balance such that they will consider any above-dust received HTLC to be a
1767 // channel reserve violation (so their balance is channel reserve (1000 sats) + commitment
1768 // transaction fee with 0 HTLCs (183 sats)).
1769 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 98817000, InitFeatures::known(), InitFeatures::known());
1771 let dust_amt = 329000; // Dust amount
1772 // In the previous code, routing this dust payment would cause nodes[0] to perceive a channel
1773 // reserve violation even though it's a dust HTLC and therefore shouldn't count towards the
1774 // commitment transaction fee.
1775 let (_, _, _) = route_payment(&nodes[1], &[&nodes[0]], dust_amt);
1779 fn test_chan_reserve_dust_inbound_htlcs_inbound_chan() {
1780 // Test that if we receive many dust HTLCs over an inbound channel, they don't count when
1781 // calculating our counterparty's commitment transaction fee (this was previously broken).
1782 let chanmon_cfgs = create_chanmon_cfgs(2);
1783 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1784 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None, None]);
1785 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1786 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 98000000, InitFeatures::known(), InitFeatures::known());
1788 let payment_amt = 46000; // Dust amount
1789 // In the previous code, these first four payments would succeed.
1790 let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
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);
1795 // Then these next 5 would be interpreted by nodes[1] as violating the fee spike buffer.
1796 let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
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);
1802 // And this last payment previously resulted in nodes[1] closing on its inbound-channel
1803 // counterparty, because it counted all the previous dust HTLCs against nodes[0]'s commitment
1804 // transaction fee and therefore perceived this next payment as a channel reserve violation.
1805 let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1809 fn test_chan_reserve_violation_inbound_htlc_inbound_chan() {
1810 let chanmon_cfgs = create_chanmon_cfgs(3);
1811 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1812 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1813 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1814 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1815 let _ = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1818 let total_routing_fee_msat = (nodes.len() - 2) as u64 * feemsat;
1819 let chan_stat = get_channel_value_stat!(nodes[0], chan.2);
1820 let feerate = get_feerate!(nodes[0], chan.2);
1822 // Add a 2* and +1 for the fee spike reserve.
1823 let commit_tx_fee_2_htlc = 2*commit_tx_fee_msat(feerate, 2 + 1);
1824 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;
1825 let amt_msat_1 = recv_value_1 + total_routing_fee_msat;
1827 // Add a pending HTLC.
1828 let (route_1, our_payment_hash_1, _, our_payment_secret_1) = get_route_and_payment_hash!(nodes[0], nodes[2], amt_msat_1);
1829 let payment_event_1 = {
1830 nodes[0].node.send_payment(&route_1, our_payment_hash_1, &Some(our_payment_secret_1)).unwrap();
1831 check_added_monitors!(nodes[0], 1);
1833 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1834 assert_eq!(events.len(), 1);
1835 SendEvent::from_event(events.remove(0))
1837 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event_1.msgs[0]);
1839 // Attempt to trigger a channel reserve violation --> payment failure.
1840 let commit_tx_fee_2_htlcs = commit_tx_fee_msat(feerate, 2);
1841 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;
1842 let amt_msat_2 = recv_value_2 + total_routing_fee_msat;
1843 let (route_2, _, _, _) = get_route_and_payment_hash!(nodes[0], nodes[2], amt_msat_2);
1845 // Need to manually create the update_add_htlc message to go around the channel reserve check in send_htlc()
1846 let secp_ctx = Secp256k1::new();
1847 let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
1848 let cur_height = nodes[0].node.best_block.read().unwrap().height() + 1;
1849 let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route_2.paths[0], &session_priv).unwrap();
1850 let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route_2.paths[0], recv_value_2, &None, cur_height).unwrap();
1851 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &our_payment_hash_1);
1852 let msg = msgs::UpdateAddHTLC {
1855 amount_msat: htlc_msat + 1,
1856 payment_hash: our_payment_hash_1,
1857 cltv_expiry: htlc_cltv,
1858 onion_routing_packet: onion_packet,
1861 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
1862 // Check that the payment failed and the channel is closed in response to the malicious UpdateAdd.
1863 nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Remote HTLC add would put them under remote reserve value".to_string(), 1);
1864 assert_eq!(nodes[1].node.list_channels().len(), 1);
1865 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
1866 assert_eq!(err_msg.data, "Remote HTLC add would put them under remote reserve value");
1867 check_added_monitors!(nodes[1], 1);
1871 fn test_inbound_outbound_capacity_is_not_zero() {
1872 let chanmon_cfgs = create_chanmon_cfgs(2);
1873 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1874 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1875 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1876 let _ = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1877 let channels0 = node_chanmgrs[0].list_channels();
1878 let channels1 = node_chanmgrs[1].list_channels();
1879 assert_eq!(channels0.len(), 1);
1880 assert_eq!(channels1.len(), 1);
1882 assert_eq!(channels0[0].inbound_capacity_msat, 95000000);
1883 assert_eq!(channels1[0].outbound_capacity_msat, 95000000);
1885 assert_eq!(channels0[0].outbound_capacity_msat, 100000 * 1000 - 95000000);
1886 assert_eq!(channels1[0].inbound_capacity_msat, 100000 * 1000 - 95000000);
1889 fn commit_tx_fee_msat(feerate: u32, num_htlcs: u64) -> u64 {
1890 (COMMITMENT_TX_BASE_WEIGHT + num_htlcs * COMMITMENT_TX_WEIGHT_PER_HTLC) * feerate as u64 / 1000 * 1000
1894 fn test_channel_reserve_holding_cell_htlcs() {
1895 let chanmon_cfgs = create_chanmon_cfgs(3);
1896 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1897 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1898 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1899 let chan_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 190000, 1001, InitFeatures::known(), InitFeatures::known());
1900 let chan_2 = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 190000, 1001, InitFeatures::known(), InitFeatures::known());
1902 let mut stat01 = get_channel_value_stat!(nodes[0], chan_1.2);
1903 let mut stat11 = get_channel_value_stat!(nodes[1], chan_1.2);
1905 let mut stat12 = get_channel_value_stat!(nodes[1], chan_2.2);
1906 let mut stat22 = get_channel_value_stat!(nodes[2], chan_2.2);
1908 macro_rules! expect_forward {
1910 let mut events = $node.node.get_and_clear_pending_msg_events();
1911 assert_eq!(events.len(), 1);
1912 check_added_monitors!($node, 1);
1913 let payment_event = SendEvent::from_event(events.remove(0));
1918 let feemsat = 239; // somehow we know?
1919 let total_fee_msat = (nodes.len() - 2) as u64 * feemsat;
1920 let feerate = get_feerate!(nodes[0], chan_1.2);
1922 let recv_value_0 = stat01.counterparty_max_htlc_value_in_flight_msat - total_fee_msat;
1924 // attempt to send amt_msat > their_max_htlc_value_in_flight_msat
1926 let (mut route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], recv_value_0);
1927 route.paths[0].last_mut().unwrap().fee_msat += 1;
1928 assert!(route.paths[0].iter().rev().skip(1).all(|h| h.fee_msat == feemsat));
1929 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
1930 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)));
1931 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1932 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);
1935 // channel reserve is bigger than their_max_htlc_value_in_flight_msat so loop to deplete
1936 // nodes[0]'s wealth
1938 let amt_msat = recv_value_0 + total_fee_msat;
1939 // 3 for the 3 HTLCs that will be sent, 2* and +1 for the fee spike reserve.
1940 // Also, ensure that each payment has enough to be over the dust limit to
1941 // ensure it'll be included in each commit tx fee calculation.
1942 let commit_tx_fee_all_htlcs = 2*commit_tx_fee_msat(feerate, 3 + 1);
1943 let ensure_htlc_amounts_above_dust_buffer = 3 * (stat01.counterparty_dust_limit_msat + 1000);
1944 if stat01.value_to_self_msat < stat01.channel_reserve_msat + commit_tx_fee_all_htlcs + ensure_htlc_amounts_above_dust_buffer + amt_msat {
1947 send_payment(&nodes[0], &vec![&nodes[1], &nodes[2]][..], recv_value_0);
1949 let (stat01_, stat11_, stat12_, stat22_) = (
1950 get_channel_value_stat!(nodes[0], chan_1.2),
1951 get_channel_value_stat!(nodes[1], chan_1.2),
1952 get_channel_value_stat!(nodes[1], chan_2.2),
1953 get_channel_value_stat!(nodes[2], chan_2.2),
1956 assert_eq!(stat01_.value_to_self_msat, stat01.value_to_self_msat - amt_msat);
1957 assert_eq!(stat11_.value_to_self_msat, stat11.value_to_self_msat + amt_msat);
1958 assert_eq!(stat12_.value_to_self_msat, stat12.value_to_self_msat - (amt_msat - feemsat));
1959 assert_eq!(stat22_.value_to_self_msat, stat22.value_to_self_msat + (amt_msat - feemsat));
1960 stat01 = stat01_; stat11 = stat11_; stat12 = stat12_; stat22 = stat22_;
1963 // adding pending output.
1964 // 2* and +1 HTLCs on the commit tx fee for the fee spike reserve.
1965 // The reason we're dividing by two here is as follows: the dividend is the total outbound liquidity
1966 // after fees, the channel reserve, and the fee spike buffer are removed. We eventually want to
1967 // divide this quantity into 3 portions, that will each be sent in an HTLC. This allows us
1968 // to test channel channel reserve policy at the edges of what amount is sendable, i.e.
1969 // cases where 1 msat over X amount will cause a payment failure, but anything less than
1970 // that can be sent successfully. So, dividing by two is a somewhat arbitrary way of getting
1971 // the amount of the first of these aforementioned 3 payments. The reason we split into 3 payments
1972 // is to test the behavior of the holding cell with respect to channel reserve and commit tx fee
1974 let commit_tx_fee_2_htlcs = 2*commit_tx_fee_msat(feerate, 2 + 1);
1975 let recv_value_1 = (stat01.value_to_self_msat - stat01.channel_reserve_msat - total_fee_msat - commit_tx_fee_2_htlcs)/2;
1976 let amt_msat_1 = recv_value_1 + total_fee_msat;
1978 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);
1979 let payment_event_1 = {
1980 nodes[0].node.send_payment(&route_1, our_payment_hash_1, &Some(our_payment_secret_1)).unwrap();
1981 check_added_monitors!(nodes[0], 1);
1983 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1984 assert_eq!(events.len(), 1);
1985 SendEvent::from_event(events.remove(0))
1987 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event_1.msgs[0]);
1989 // channel reserve test with htlc pending output > 0
1990 let recv_value_2 = stat01.value_to_self_msat - amt_msat_1 - stat01.channel_reserve_msat - total_fee_msat - commit_tx_fee_2_htlcs;
1992 let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], recv_value_2 + 1);
1993 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
1994 assert!(regex::Regex::new(r"Cannot send value that would put our balance under counterparty-announced channel reserve value \(\d+\)").unwrap().is_match(err)));
1995 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1998 // split the rest to test holding cell
1999 let commit_tx_fee_3_htlcs = 2*commit_tx_fee_msat(feerate, 3 + 1);
2000 let additional_htlc_cost_msat = commit_tx_fee_3_htlcs - commit_tx_fee_2_htlcs;
2001 let recv_value_21 = recv_value_2/2 - additional_htlc_cost_msat/2;
2002 let recv_value_22 = recv_value_2 - recv_value_21 - total_fee_msat - additional_htlc_cost_msat;
2004 let stat = get_channel_value_stat!(nodes[0], chan_1.2);
2005 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);
2008 // now see if they go through on both sides
2009 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);
2010 // but this will stuck in the holding cell
2011 nodes[0].node.send_payment(&route_21, our_payment_hash_21, &Some(our_payment_secret_21)).unwrap();
2012 check_added_monitors!(nodes[0], 0);
2013 let events = nodes[0].node.get_and_clear_pending_events();
2014 assert_eq!(events.len(), 0);
2016 // test with outbound holding cell amount > 0
2018 let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], recv_value_22+1);
2019 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
2020 assert!(regex::Regex::new(r"Cannot send value that would put our balance under counterparty-announced channel reserve value \(\d+\)").unwrap().is_match(err)));
2021 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
2022 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);
2025 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);
2026 // this will also stuck in the holding cell
2027 nodes[0].node.send_payment(&route_22, our_payment_hash_22, &Some(our_payment_secret_22)).unwrap();
2028 check_added_monitors!(nodes[0], 0);
2029 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
2030 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
2032 // flush the pending htlc
2033 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event_1.commitment_msg);
2034 let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2035 check_added_monitors!(nodes[1], 1);
2037 // the pending htlc should be promoted to committed
2038 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_revoke_and_ack);
2039 check_added_monitors!(nodes[0], 1);
2040 let commitment_update_2 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2042 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &as_commitment_signed);
2043 let bs_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2044 // No commitment_signed so get_event_msg's assert(len == 1) passes
2045 check_added_monitors!(nodes[0], 1);
2047 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &bs_revoke_and_ack);
2048 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2049 check_added_monitors!(nodes[1], 1);
2051 expect_pending_htlcs_forwardable!(nodes[1]);
2053 let ref payment_event_11 = expect_forward!(nodes[1]);
2054 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_11.msgs[0]);
2055 commitment_signed_dance!(nodes[2], nodes[1], payment_event_11.commitment_msg, false);
2057 expect_pending_htlcs_forwardable!(nodes[2]);
2058 expect_payment_received!(nodes[2], our_payment_hash_1, our_payment_secret_1, recv_value_1);
2060 // flush the htlcs in the holding cell
2061 assert_eq!(commitment_update_2.update_add_htlcs.len(), 2);
2062 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &commitment_update_2.update_add_htlcs[0]);
2063 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &commitment_update_2.update_add_htlcs[1]);
2064 commitment_signed_dance!(nodes[1], nodes[0], &commitment_update_2.commitment_signed, false);
2065 expect_pending_htlcs_forwardable!(nodes[1]);
2067 let ref payment_event_3 = expect_forward!(nodes[1]);
2068 assert_eq!(payment_event_3.msgs.len(), 2);
2069 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_3.msgs[0]);
2070 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_3.msgs[1]);
2072 commitment_signed_dance!(nodes[2], nodes[1], &payment_event_3.commitment_msg, false);
2073 expect_pending_htlcs_forwardable!(nodes[2]);
2075 let events = nodes[2].node.get_and_clear_pending_events();
2076 assert_eq!(events.len(), 2);
2078 Event::PaymentReceived { ref payment_hash, ref payment_preimage, ref payment_secret, amt, user_payment_id: _ } => {
2079 assert_eq!(our_payment_hash_21, *payment_hash);
2080 assert!(payment_preimage.is_none());
2081 assert_eq!(our_payment_secret_21, *payment_secret);
2082 assert_eq!(recv_value_21, amt);
2084 _ => panic!("Unexpected event"),
2087 Event::PaymentReceived { ref payment_hash, ref payment_preimage, ref payment_secret, amt, user_payment_id: _ } => {
2088 assert_eq!(our_payment_hash_22, *payment_hash);
2089 assert!(payment_preimage.is_none());
2090 assert_eq!(our_payment_secret_22, *payment_secret);
2091 assert_eq!(recv_value_22, amt);
2093 _ => panic!("Unexpected event"),
2096 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_1);
2097 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_21);
2098 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_22);
2100 let commit_tx_fee_0_htlcs = 2*commit_tx_fee_msat(feerate, 1);
2101 let recv_value_3 = commit_tx_fee_2_htlcs - commit_tx_fee_0_htlcs - total_fee_msat;
2102 send_payment(&nodes[0], &vec![&nodes[1], &nodes[2]][..], recv_value_3);
2104 let commit_tx_fee_1_htlc = 2*commit_tx_fee_msat(feerate, 1 + 1);
2105 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);
2106 let stat0 = get_channel_value_stat!(nodes[0], chan_1.2);
2107 assert_eq!(stat0.value_to_self_msat, expected_value_to_self);
2108 assert_eq!(stat0.value_to_self_msat, stat0.channel_reserve_msat + commit_tx_fee_1_htlc);
2110 let stat2 = get_channel_value_stat!(nodes[2], chan_2.2);
2111 assert_eq!(stat2.value_to_self_msat, stat22.value_to_self_msat + recv_value_1 + recv_value_21 + recv_value_22 + recv_value_3);
2115 fn channel_reserve_in_flight_removes() {
2116 // In cases where one side claims an HTLC, it thinks it has additional available funds that it
2117 // can send to its counterparty, but due to update ordering, the other side may not yet have
2118 // considered those HTLCs fully removed.
2119 // This tests that we don't count HTLCs which will not be included in the next remote
2120 // commitment transaction towards the reserve value (as it implies no commitment transaction
2121 // will be generated which violates the remote reserve value).
2122 // This was broken previously, and discovered by the chanmon_fail_consistency fuzz test.
2124 // * route two HTLCs from A to B (note that, at a high level, this test is checking that, when
2125 // you consider the values of both of these HTLCs, B may not send an HTLC back to A, but if
2126 // you only consider the value of the first HTLC, it may not),
2127 // * start routing a third HTLC from A to B,
2128 // * claim the first two HTLCs (though B will generate an update_fulfill for one, and put
2129 // the other claim in its holding cell, as it immediately goes into AwaitingRAA),
2130 // * deliver the first fulfill from B
2131 // * deliver the update_add and an RAA from A, resulting in B freeing the second holding cell
2133 // * deliver A's response CS and RAA.
2134 // This results in A having the second HTLC in AwaitingRemovedRemoteRevoke, but B having
2135 // removed it fully. B now has the push_msat plus the first two HTLCs in value.
2136 // * Now B happily sends another HTLC, potentially violating its reserve value from A's point
2137 // of view (if A counts the AwaitingRemovedRemoteRevoke HTLC).
2138 let chanmon_cfgs = create_chanmon_cfgs(2);
2139 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2140 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2141 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2142 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2143 let logger = test_utils::TestLogger::new();
2145 let b_chan_values = get_channel_value_stat!(nodes[1], chan_1.2);
2146 // Route the first two HTLCs.
2147 let (payment_preimage_1, _, _) = route_payment(&nodes[0], &[&nodes[1]], b_chan_values.channel_reserve_msat - b_chan_values.value_to_self_msat - 10000);
2148 let (payment_preimage_2, _, _) = route_payment(&nodes[0], &[&nodes[1]], 20000);
2150 // Start routing the third HTLC (this is just used to get everyone in the right state).
2151 let (payment_preimage_3, payment_hash_3, payment_secret_3) = get_payment_preimage_hash!(nodes[1]);
2153 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
2154 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();
2155 nodes[0].node.send_payment(&route, payment_hash_3, &Some(payment_secret_3)).unwrap();
2156 check_added_monitors!(nodes[0], 1);
2157 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
2158 assert_eq!(events.len(), 1);
2159 SendEvent::from_event(events.remove(0))
2162 // Now claim both of the first two HTLCs on B's end, putting B in AwaitingRAA and generating an
2163 // initial fulfill/CS.
2164 assert!(nodes[1].node.claim_funds(payment_preimage_1));
2165 check_added_monitors!(nodes[1], 1);
2166 let bs_removes = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2168 // This claim goes in B's holding cell, allowing us to have a pending B->A RAA which does not
2169 // remove the second HTLC when we send the HTLC back from B to A.
2170 assert!(nodes[1].node.claim_funds(payment_preimage_2));
2171 check_added_monitors!(nodes[1], 1);
2172 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2174 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_removes.update_fulfill_htlcs[0]);
2175 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_removes.commitment_signed);
2176 check_added_monitors!(nodes[0], 1);
2177 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2178 expect_payment_sent!(nodes[0], payment_preimage_1);
2180 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_1.msgs[0]);
2181 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &send_1.commitment_msg);
2182 check_added_monitors!(nodes[1], 1);
2183 // B is already AwaitingRAA, so cant generate a CS here
2184 let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2186 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
2187 check_added_monitors!(nodes[1], 1);
2188 let bs_cs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2190 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2191 check_added_monitors!(nodes[0], 1);
2192 let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2194 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
2195 check_added_monitors!(nodes[1], 1);
2196 let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2198 // The second HTLCis removed, but as A is in AwaitingRAA it can't generate a CS here, so the
2199 // RAA that B generated above doesn't fully resolve the second HTLC from A's point of view.
2200 // However, the RAA A generates here *does* fully resolve the HTLC from B's point of view (as A
2201 // can no longer broadcast a commitment transaction with it and B has the preimage so can go
2202 // on-chain as necessary).
2203 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_cs.update_fulfill_htlcs[0]);
2204 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_cs.commitment_signed);
2205 check_added_monitors!(nodes[0], 1);
2206 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2207 expect_payment_sent!(nodes[0], payment_preimage_2);
2209 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
2210 check_added_monitors!(nodes[1], 1);
2211 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2213 expect_pending_htlcs_forwardable!(nodes[1]);
2214 expect_payment_received!(nodes[1], payment_hash_3, payment_secret_3, 100000);
2216 // Note that as this RAA was generated before the delivery of the update_fulfill it shouldn't
2217 // resolve the second HTLC from A's point of view.
2218 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2219 check_added_monitors!(nodes[0], 1);
2220 let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2222 // Now that B doesn't have the second RAA anymore, but A still does, send a payment from B back
2223 // to A to ensure that A doesn't count the almost-removed HTLC in update_add processing.
2224 let (payment_preimage_4, payment_hash_4, payment_secret_4) = get_payment_preimage_hash!(nodes[0]);
2226 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
2227 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();
2228 nodes[1].node.send_payment(&route, payment_hash_4, &Some(payment_secret_4)).unwrap();
2229 check_added_monitors!(nodes[1], 1);
2230 let mut events = nodes[1].node.get_and_clear_pending_msg_events();
2231 assert_eq!(events.len(), 1);
2232 SendEvent::from_event(events.remove(0))
2235 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &send_2.msgs[0]);
2236 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &send_2.commitment_msg);
2237 check_added_monitors!(nodes[0], 1);
2238 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2240 // Now just resolve all the outstanding messages/HTLCs for completeness...
2242 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
2243 check_added_monitors!(nodes[1], 1);
2244 let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2246 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
2247 check_added_monitors!(nodes[1], 1);
2249 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2250 check_added_monitors!(nodes[0], 1);
2251 let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2253 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
2254 check_added_monitors!(nodes[1], 1);
2255 let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2257 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2258 check_added_monitors!(nodes[0], 1);
2260 expect_pending_htlcs_forwardable!(nodes[0]);
2261 expect_payment_received!(nodes[0], payment_hash_4, payment_secret_4, 10000);
2263 claim_payment(&nodes[1], &[&nodes[0]], payment_preimage_4);
2264 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_3);
2268 fn channel_monitor_network_test() {
2269 // Simple test which builds a network of ChannelManagers, connects them to each other, and
2270 // tests that ChannelMonitor is able to recover from various states.
2271 let chanmon_cfgs = create_chanmon_cfgs(5);
2272 let node_cfgs = create_node_cfgs(5, &chanmon_cfgs);
2273 let node_chanmgrs = create_node_chanmgrs(5, &node_cfgs, &[None, None, None, None, None]);
2274 let nodes = create_network(5, &node_cfgs, &node_chanmgrs);
2276 // Create some initial channels
2277 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2278 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
2279 let chan_3 = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
2280 let chan_4 = create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::known(), InitFeatures::known());
2282 // Make sure all nodes are at the same starting height
2283 connect_blocks(&nodes[0], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[0].best_block_info().1);
2284 connect_blocks(&nodes[1], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[1].best_block_info().1);
2285 connect_blocks(&nodes[2], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[2].best_block_info().1);
2286 connect_blocks(&nodes[3], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[3].best_block_info().1);
2287 connect_blocks(&nodes[4], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[4].best_block_info().1);
2289 // Rebalance the network a bit by relaying one payment through all the channels...
2290 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
2291 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
2292 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
2293 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
2295 // Simple case with no pending HTLCs:
2296 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), true);
2297 check_added_monitors!(nodes[1], 1);
2298 check_closed_broadcast!(nodes[1], false);
2300 let mut node_txn = test_txn_broadcast(&nodes[1], &chan_1, None, HTLCType::NONE);
2301 assert_eq!(node_txn.len(), 1);
2302 mine_transaction(&nodes[0], &node_txn[0]);
2303 check_added_monitors!(nodes[0], 1);
2304 test_txn_broadcast(&nodes[0], &chan_1, None, HTLCType::NONE);
2306 check_closed_broadcast!(nodes[0], true);
2307 assert_eq!(nodes[0].node.list_channels().len(), 0);
2308 assert_eq!(nodes[1].node.list_channels().len(), 1);
2310 // One pending HTLC is discarded by the force-close:
2311 let payment_preimage_1 = route_payment(&nodes[1], &vec!(&nodes[2], &nodes[3])[..], 3000000).0;
2313 // Simple case of one pending HTLC to HTLC-Timeout (note that the HTLC-Timeout is not
2314 // broadcasted until we reach the timelock time).
2315 nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id(), true);
2316 check_closed_broadcast!(nodes[1], false);
2317 check_added_monitors!(nodes[1], 1);
2319 let mut node_txn = test_txn_broadcast(&nodes[1], &chan_2, None, HTLCType::NONE);
2320 connect_blocks(&nodes[1], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + MIN_CLTV_EXPIRY_DELTA as u32 + 1);
2321 test_txn_broadcast(&nodes[1], &chan_2, None, HTLCType::TIMEOUT);
2322 mine_transaction(&nodes[2], &node_txn[0]);
2323 check_added_monitors!(nodes[2], 1);
2324 test_txn_broadcast(&nodes[2], &chan_2, None, HTLCType::NONE);
2326 check_closed_broadcast!(nodes[2], true);
2327 assert_eq!(nodes[1].node.list_channels().len(), 0);
2328 assert_eq!(nodes[2].node.list_channels().len(), 1);
2330 macro_rules! claim_funds {
2331 ($node: expr, $prev_node: expr, $preimage: expr) => {
2333 assert!($node.node.claim_funds($preimage));
2334 check_added_monitors!($node, 1);
2336 let events = $node.node.get_and_clear_pending_msg_events();
2337 assert_eq!(events.len(), 1);
2339 MessageSendEvent::UpdateHTLCs { ref node_id, updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fail_htlcs, .. } } => {
2340 assert!(update_add_htlcs.is_empty());
2341 assert!(update_fail_htlcs.is_empty());
2342 assert_eq!(*node_id, $prev_node.node.get_our_node_id());
2344 _ => panic!("Unexpected event"),
2350 // nodes[3] gets the preimage, but nodes[2] already disconnected, resulting in a nodes[2]
2351 // HTLC-Timeout and a nodes[3] claim against it (+ its own announces)
2352 nodes[2].node.peer_disconnected(&nodes[3].node.get_our_node_id(), true);
2353 check_added_monitors!(nodes[2], 1);
2354 check_closed_broadcast!(nodes[2], false);
2355 let node2_commitment_txid;
2357 let node_txn = test_txn_broadcast(&nodes[2], &chan_3, None, HTLCType::NONE);
2358 connect_blocks(&nodes[2], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + MIN_CLTV_EXPIRY_DELTA as u32 + 1);
2359 test_txn_broadcast(&nodes[2], &chan_3, None, HTLCType::TIMEOUT);
2360 node2_commitment_txid = node_txn[0].txid();
2362 // Claim the payment on nodes[3], giving it knowledge of the preimage
2363 claim_funds!(nodes[3], nodes[2], payment_preimage_1);
2364 mine_transaction(&nodes[3], &node_txn[0]);
2365 check_added_monitors!(nodes[3], 1);
2366 check_preimage_claim(&nodes[3], &node_txn);
2368 check_closed_broadcast!(nodes[3], true);
2369 assert_eq!(nodes[2].node.list_channels().len(), 0);
2370 assert_eq!(nodes[3].node.list_channels().len(), 1);
2372 // Drop the ChannelMonitor for the previous channel to avoid it broadcasting transactions and
2373 // confusing us in the following tests.
2374 let chan_3_mon = nodes[3].chain_monitor.chain_monitor.monitors.write().unwrap().remove(&OutPoint { txid: chan_3.3.txid(), index: 0 }).unwrap();
2376 // One pending HTLC to time out:
2377 let payment_preimage_2 = route_payment(&nodes[3], &vec!(&nodes[4])[..], 3000000).0;
2378 // CLTV expires at TEST_FINAL_CLTV + 1 (current height) + 1 (added in send_payment for
2381 let (close_chan_update_1, close_chan_update_2) = {
2382 connect_blocks(&nodes[3], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + 1);
2383 let events = nodes[3].node.get_and_clear_pending_msg_events();
2384 assert_eq!(events.len(), 2);
2385 let close_chan_update_1 = match events[0] {
2386 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
2389 _ => panic!("Unexpected event"),
2392 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { .. }, node_id } => {
2393 assert_eq!(node_id, nodes[4].node.get_our_node_id());
2395 _ => panic!("Unexpected event"),
2397 check_added_monitors!(nodes[3], 1);
2399 // Clear bumped claiming txn spending node 2 commitment tx. Bumped txn are generated after reaching some height timer.
2401 let mut node_txn = nodes[3].tx_broadcaster.txn_broadcasted.lock().unwrap();
2402 node_txn.retain(|tx| {
2403 if tx.input[0].previous_output.txid == node2_commitment_txid {
2409 let node_txn = test_txn_broadcast(&nodes[3], &chan_4, None, HTLCType::TIMEOUT);
2411 // Claim the payment on nodes[4], giving it knowledge of the preimage
2412 claim_funds!(nodes[4], nodes[3], payment_preimage_2);
2414 connect_blocks(&nodes[4], TEST_FINAL_CLTV - CLTV_CLAIM_BUFFER + 2);
2415 let events = nodes[4].node.get_and_clear_pending_msg_events();
2416 assert_eq!(events.len(), 2);
2417 let close_chan_update_2 = match events[0] {
2418 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
2421 _ => panic!("Unexpected event"),
2424 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { .. }, node_id } => {
2425 assert_eq!(node_id, nodes[3].node.get_our_node_id());
2427 _ => panic!("Unexpected event"),
2429 check_added_monitors!(nodes[4], 1);
2430 test_txn_broadcast(&nodes[4], &chan_4, None, HTLCType::SUCCESS);
2432 mine_transaction(&nodes[4], &node_txn[0]);
2433 check_preimage_claim(&nodes[4], &node_txn);
2434 (close_chan_update_1, close_chan_update_2)
2436 nodes[3].net_graph_msg_handler.handle_channel_update(&close_chan_update_2).unwrap();
2437 nodes[4].net_graph_msg_handler.handle_channel_update(&close_chan_update_1).unwrap();
2438 assert_eq!(nodes[3].node.list_channels().len(), 0);
2439 assert_eq!(nodes[4].node.list_channels().len(), 0);
2441 nodes[3].chain_monitor.chain_monitor.monitors.write().unwrap().insert(OutPoint { txid: chan_3.3.txid(), index: 0 }, chan_3_mon);
2445 fn test_justice_tx() {
2446 // Test justice txn built on revoked HTLC-Success tx, against both sides
2447 let mut alice_config = UserConfig::default();
2448 alice_config.channel_options.announced_channel = true;
2449 alice_config.peer_channel_config_limits.force_announced_channel_preference = false;
2450 alice_config.own_channel_config.our_to_self_delay = 6 * 24 * 5;
2451 let mut bob_config = UserConfig::default();
2452 bob_config.channel_options.announced_channel = true;
2453 bob_config.peer_channel_config_limits.force_announced_channel_preference = false;
2454 bob_config.own_channel_config.our_to_self_delay = 6 * 24 * 3;
2455 let user_cfgs = [Some(alice_config), Some(bob_config)];
2456 let mut chanmon_cfgs = create_chanmon_cfgs(2);
2457 chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
2458 chanmon_cfgs[1].keys_manager.disable_revocation_policy_check = true;
2459 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2460 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &user_cfgs);
2461 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2462 // Create some new channels:
2463 let chan_5 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2465 // A pending HTLC which will be revoked:
2466 let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2467 // Get the will-be-revoked local txn from nodes[0]
2468 let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_5.2);
2469 assert_eq!(revoked_local_txn.len(), 2); // First commitment tx, then HTLC tx
2470 assert_eq!(revoked_local_txn[0].input.len(), 1);
2471 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_5.3.txid());
2472 assert_eq!(revoked_local_txn[0].output.len(), 2); // Only HTLC and output back to 0 are present
2473 assert_eq!(revoked_local_txn[1].input.len(), 1);
2474 assert_eq!(revoked_local_txn[1].input[0].previous_output.txid, revoked_local_txn[0].txid());
2475 assert_eq!(revoked_local_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC-Timeout
2476 // Revoke the old state
2477 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_3);
2480 mine_transaction(&nodes[1], &revoked_local_txn[0]);
2482 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2483 assert_eq!(node_txn.len(), 2); // ChannelMonitor: penalty tx, ChannelManager: local commitment tx
2484 assert_eq!(node_txn[0].input.len(), 2); // We should claim the revoked output and the HTLC output
2486 check_spends!(node_txn[0], revoked_local_txn[0]);
2487 node_txn.swap_remove(0);
2488 node_txn.truncate(1);
2490 check_added_monitors!(nodes[1], 1);
2491 test_txn_broadcast(&nodes[1], &chan_5, None, HTLCType::NONE);
2493 mine_transaction(&nodes[0], &revoked_local_txn[0]);
2494 connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
2495 // Verify broadcast of revoked HTLC-timeout
2496 let node_txn = test_txn_broadcast(&nodes[0], &chan_5, Some(revoked_local_txn[0].clone()), HTLCType::TIMEOUT);
2497 check_added_monitors!(nodes[0], 1);
2498 // Broadcast revoked HTLC-timeout on node 1
2499 mine_transaction(&nodes[1], &node_txn[1]);
2500 test_revoked_htlc_claim_txn_broadcast(&nodes[1], node_txn[1].clone(), revoked_local_txn[0].clone());
2502 get_announce_close_broadcast_events(&nodes, 0, 1);
2504 assert_eq!(nodes[0].node.list_channels().len(), 0);
2505 assert_eq!(nodes[1].node.list_channels().len(), 0);
2507 // We test justice_tx build by A on B's revoked HTLC-Success tx
2508 // Create some new channels:
2509 let chan_6 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2511 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2515 // A pending HTLC which will be revoked:
2516 let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2517 // Get the will-be-revoked local txn from B
2518 let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan_6.2);
2519 assert_eq!(revoked_local_txn.len(), 1); // Only commitment tx
2520 assert_eq!(revoked_local_txn[0].input.len(), 1);
2521 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_6.3.txid());
2522 assert_eq!(revoked_local_txn[0].output.len(), 2); // Only HTLC and output back to A are present
2523 // Revoke the old state
2524 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_4);
2526 mine_transaction(&nodes[0], &revoked_local_txn[0]);
2528 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
2529 assert_eq!(node_txn.len(), 2); //ChannelMonitor: penalty tx, ChannelManager: local commitment tx
2530 assert_eq!(node_txn[0].input.len(), 1); // We claim the received HTLC output
2532 check_spends!(node_txn[0], revoked_local_txn[0]);
2533 node_txn.swap_remove(0);
2535 check_added_monitors!(nodes[0], 1);
2536 test_txn_broadcast(&nodes[0], &chan_6, None, HTLCType::NONE);
2538 mine_transaction(&nodes[1], &revoked_local_txn[0]);
2539 let node_txn = test_txn_broadcast(&nodes[1], &chan_6, Some(revoked_local_txn[0].clone()), HTLCType::SUCCESS);
2540 check_added_monitors!(nodes[1], 1);
2541 mine_transaction(&nodes[0], &node_txn[1]);
2542 test_revoked_htlc_claim_txn_broadcast(&nodes[0], node_txn[1].clone(), revoked_local_txn[0].clone());
2544 get_announce_close_broadcast_events(&nodes, 0, 1);
2545 assert_eq!(nodes[0].node.list_channels().len(), 0);
2546 assert_eq!(nodes[1].node.list_channels().len(), 0);
2550 fn revoked_output_claim() {
2551 // Simple test to ensure a node will claim a revoked output when a stale remote commitment
2552 // transaction is broadcast by its counterparty
2553 let chanmon_cfgs = create_chanmon_cfgs(2);
2554 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2555 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2556 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2557 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2558 // node[0] is gonna to revoke an old state thus node[1] should be able to claim the revoked output
2559 let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2560 assert_eq!(revoked_local_txn.len(), 1);
2561 // Only output is the full channel value back to nodes[0]:
2562 assert_eq!(revoked_local_txn[0].output.len(), 1);
2563 // Send a payment through, updating everyone's latest commitment txn
2564 send_payment(&nodes[0], &vec!(&nodes[1])[..], 5000000);
2566 // Inform nodes[1] that nodes[0] broadcast a stale tx
2567 mine_transaction(&nodes[1], &revoked_local_txn[0]);
2568 check_added_monitors!(nodes[1], 1);
2569 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2570 assert_eq!(node_txn.len(), 2); // ChannelMonitor: justice tx against revoked to_local output, ChannelManager: local commitment tx
2572 check_spends!(node_txn[0], revoked_local_txn[0]);
2573 check_spends!(node_txn[1], chan_1.3);
2575 // Inform nodes[0] that a watchtower cheated on its behalf, so it will force-close the chan
2576 mine_transaction(&nodes[0], &revoked_local_txn[0]);
2577 get_announce_close_broadcast_events(&nodes, 0, 1);
2578 check_added_monitors!(nodes[0], 1)
2582 fn claim_htlc_outputs_shared_tx() {
2583 // Node revoked old state, htlcs haven't time out yet, claim them in shared justice tx
2584 let mut chanmon_cfgs = create_chanmon_cfgs(2);
2585 chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
2586 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2587 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2588 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2590 // Create some new channel:
2591 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2593 // Rebalance the network to generate htlc in the two directions
2594 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
2595 // 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
2596 let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2597 let (_payment_preimage_2, payment_hash_2, _) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000);
2599 // Get the will-be-revoked local txn from node[0]
2600 let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2601 assert_eq!(revoked_local_txn.len(), 2); // commitment tx + 1 HTLC-Timeout tx
2602 assert_eq!(revoked_local_txn[0].input.len(), 1);
2603 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
2604 assert_eq!(revoked_local_txn[1].input.len(), 1);
2605 assert_eq!(revoked_local_txn[1].input[0].previous_output.txid, revoked_local_txn[0].txid());
2606 assert_eq!(revoked_local_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC-Timeout
2607 check_spends!(revoked_local_txn[1], revoked_local_txn[0]);
2609 //Revoke the old state
2610 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_1);
2613 mine_transaction(&nodes[0], &revoked_local_txn[0]);
2614 check_added_monitors!(nodes[0], 1);
2615 mine_transaction(&nodes[1], &revoked_local_txn[0]);
2616 check_added_monitors!(nodes[1], 1);
2617 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
2618 expect_payment_failed!(nodes[1], payment_hash_2, true);
2620 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2621 assert_eq!(node_txn.len(), 2); // ChannelMonitor: penalty tx, ChannelManager: local commitment
2623 assert_eq!(node_txn[0].input.len(), 3); // Claim the revoked output + both revoked HTLC outputs
2624 check_spends!(node_txn[0], revoked_local_txn[0]);
2626 let mut witness_lens = BTreeSet::new();
2627 witness_lens.insert(node_txn[0].input[0].witness.last().unwrap().len());
2628 witness_lens.insert(node_txn[0].input[1].witness.last().unwrap().len());
2629 witness_lens.insert(node_txn[0].input[2].witness.last().unwrap().len());
2630 assert_eq!(witness_lens.len(), 3);
2631 assert_eq!(*witness_lens.iter().skip(0).next().unwrap(), 77); // revoked to_local
2632 assert_eq!(*witness_lens.iter().skip(1).next().unwrap(), OFFERED_HTLC_SCRIPT_WEIGHT); // revoked offered HTLC
2633 assert_eq!(*witness_lens.iter().skip(2).next().unwrap(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // revoked received HTLC
2635 // Next nodes[1] broadcasts its current local tx state:
2636 assert_eq!(node_txn[1].input.len(), 1);
2637 assert_eq!(node_txn[1].input[0].previous_output.txid, chan_1.3.txid()); //Spending funding tx unique txouput, tx broadcasted by ChannelManager
2639 get_announce_close_broadcast_events(&nodes, 0, 1);
2640 assert_eq!(nodes[0].node.list_channels().len(), 0);
2641 assert_eq!(nodes[1].node.list_channels().len(), 0);
2645 fn claim_htlc_outputs_single_tx() {
2646 // Node revoked old state, htlcs have timed out, claim each of them in separated justice tx
2647 let mut chanmon_cfgs = create_chanmon_cfgs(2);
2648 chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
2649 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2650 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2651 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2653 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2655 // Rebalance the network to generate htlc in the two directions
2656 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
2657 // 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
2658 // time as two different claim transactions as we're gonna to timeout htlc with given a high current height
2659 let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2660 let (_payment_preimage_2, payment_hash_2, _payment_secret_2) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000);
2662 // Get the will-be-revoked local txn from node[0]
2663 let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2665 //Revoke the old state
2666 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_1);
2669 confirm_transaction_at(&nodes[0], &revoked_local_txn[0], 100);
2670 check_added_monitors!(nodes[0], 1);
2671 confirm_transaction_at(&nodes[1], &revoked_local_txn[0], 100);
2672 check_added_monitors!(nodes[1], 1);
2673 expect_pending_htlcs_forwardable_ignore!(nodes[0]);
2675 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
2676 expect_payment_failed!(nodes[1], payment_hash_2, true);
2678 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2679 assert_eq!(node_txn.len(), 9);
2680 // ChannelMonitor: justice tx revoked offered htlc, justice tx revoked received htlc, justice tx revoked to_local (3)
2681 // ChannelManager: local commmitment + local HTLC-timeout (2)
2682 // 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)
2683 // ChannelMonitor: local commitment + local HTLC-timeout (2)
2685 // Check the pair local commitment and HTLC-timeout broadcast due to HTLC expiration
2686 assert_eq!(node_txn[0].input.len(), 1);
2687 check_spends!(node_txn[0], chan_1.3);
2688 assert_eq!(node_txn[1].input.len(), 1);
2689 let witness_script = node_txn[1].input[0].witness.last().unwrap();
2690 assert_eq!(witness_script.len(), OFFERED_HTLC_SCRIPT_WEIGHT); //Spending an offered htlc output
2691 check_spends!(node_txn[1], node_txn[0]);
2693 // Justice transactions are indices 1-2-4
2694 assert_eq!(node_txn[2].input.len(), 1);
2695 assert_eq!(node_txn[3].input.len(), 1);
2696 assert_eq!(node_txn[4].input.len(), 1);
2698 check_spends!(node_txn[2], revoked_local_txn[0]);
2699 check_spends!(node_txn[3], revoked_local_txn[0]);
2700 check_spends!(node_txn[4], revoked_local_txn[0]);
2702 let mut witness_lens = BTreeSet::new();
2703 witness_lens.insert(node_txn[2].input[0].witness.last().unwrap().len());
2704 witness_lens.insert(node_txn[3].input[0].witness.last().unwrap().len());
2705 witness_lens.insert(node_txn[4].input[0].witness.last().unwrap().len());
2706 assert_eq!(witness_lens.len(), 3);
2707 assert_eq!(*witness_lens.iter().skip(0).next().unwrap(), 77); // revoked to_local
2708 assert_eq!(*witness_lens.iter().skip(1).next().unwrap(), OFFERED_HTLC_SCRIPT_WEIGHT); // revoked offered HTLC
2709 assert_eq!(*witness_lens.iter().skip(2).next().unwrap(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // revoked received HTLC
2711 get_announce_close_broadcast_events(&nodes, 0, 1);
2712 assert_eq!(nodes[0].node.list_channels().len(), 0);
2713 assert_eq!(nodes[1].node.list_channels().len(), 0);
2717 fn test_htlc_on_chain_success() {
2718 // Test that in case of a unilateral close onchain, we detect the state of output and pass
2719 // the preimage backward accordingly. So here we test that ChannelManager is
2720 // broadcasting the right event to other nodes in payment path.
2721 // We test with two HTLCs simultaneously as that was not handled correctly in the past.
2722 // A --------------------> B ----------------------> C (preimage)
2723 // First, C should claim the HTLC outputs via HTLC-Success when its own latest local
2724 // commitment transaction was broadcast.
2725 // Then, B should learn the preimage from said transactions, attempting to claim backwards
2727 // B should be able to claim via preimage if A then broadcasts its local tx.
2728 // Finally, when A sees B's latest local commitment transaction it should be able to claim
2729 // the HTLC outputs via the preimage it learned (which, once confirmed should generate a
2730 // PaymentSent event).
2732 let chanmon_cfgs = create_chanmon_cfgs(3);
2733 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2734 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2735 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2737 // Create some initial channels
2738 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2739 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
2741 // Ensure all nodes are at the same height
2742 let node_max_height = nodes.iter().map(|node| node.blocks.lock().unwrap().len()).max().unwrap() as u32;
2743 connect_blocks(&nodes[0], node_max_height - nodes[0].best_block_info().1);
2744 connect_blocks(&nodes[1], node_max_height - nodes[1].best_block_info().1);
2745 connect_blocks(&nodes[2], node_max_height - nodes[2].best_block_info().1);
2747 // Rebalance the network a bit by relaying one payment through all the channels...
2748 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
2749 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
2751 let (our_payment_preimage, _payment_hash, _payment_secret) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2752 let (our_payment_preimage_2, _payment_hash_2, _payment_secret_2) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2754 // Broadcast legit commitment tx from C on B's chain
2755 // Broadcast HTLC Success transaction by C on received output from C's commitment tx on B's chain
2756 let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
2757 assert_eq!(commitment_tx.len(), 1);
2758 check_spends!(commitment_tx[0], chan_2.3);
2759 nodes[2].node.claim_funds(our_payment_preimage);
2760 nodes[2].node.claim_funds(our_payment_preimage_2);
2761 check_added_monitors!(nodes[2], 2);
2762 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2763 assert!(updates.update_add_htlcs.is_empty());
2764 assert!(updates.update_fail_htlcs.is_empty());
2765 assert!(updates.update_fail_malformed_htlcs.is_empty());
2766 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
2768 mine_transaction(&nodes[2], &commitment_tx[0]);
2769 check_closed_broadcast!(nodes[2], true);
2770 check_added_monitors!(nodes[2], 1);
2771 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)
2772 assert_eq!(node_txn.len(), 5);
2773 assert_eq!(node_txn[0], node_txn[3]);
2774 assert_eq!(node_txn[1], node_txn[4]);
2775 assert_eq!(node_txn[2], commitment_tx[0]);
2776 check_spends!(node_txn[0], commitment_tx[0]);
2777 check_spends!(node_txn[1], commitment_tx[0]);
2778 assert_eq!(node_txn[0].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2779 assert_eq!(node_txn[1].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2780 assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2781 assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2782 assert_eq!(node_txn[0].lock_time, 0);
2783 assert_eq!(node_txn[1].lock_time, 0);
2785 // Verify that B's ChannelManager is able to extract preimage from HTLC Success tx and pass it backward
2786 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2787 connect_block(&nodes[1], &Block { header, txdata: node_txn});
2788 connect_blocks(&nodes[1], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
2790 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
2791 assert_eq!(added_monitors.len(), 1);
2792 assert_eq!(added_monitors[0].0.txid, chan_2.3.txid());
2793 added_monitors.clear();
2795 let events = nodes[1].node.get_and_clear_pending_msg_events();
2797 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
2798 assert_eq!(added_monitors.len(), 2);
2799 assert_eq!(added_monitors[0].0.txid, chan_1.3.txid());
2800 assert_eq!(added_monitors[1].0.txid, chan_1.3.txid());
2801 added_monitors.clear();
2803 assert_eq!(events.len(), 3);
2805 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
2806 _ => panic!("Unexpected event"),
2809 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { .. }, node_id: _ } => {},
2810 _ => panic!("Unexpected event"),
2814 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, .. } } => {
2815 assert!(update_add_htlcs.is_empty());
2816 assert!(update_fail_htlcs.is_empty());
2817 assert_eq!(update_fulfill_htlcs.len(), 1);
2818 assert!(update_fail_malformed_htlcs.is_empty());
2819 assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
2821 _ => panic!("Unexpected event"),
2823 macro_rules! check_tx_local_broadcast {
2824 ($node: expr, $htlc_offered: expr, $commitment_tx: expr, $chan_tx: expr) => { {
2825 let mut node_txn = $node.tx_broadcaster.txn_broadcasted.lock().unwrap();
2826 assert_eq!(node_txn.len(), 3);
2827 // Node[1]: ChannelManager: 3 (commitment tx, 2*HTLC-Timeout tx), ChannelMonitor: 2 (timeout tx)
2828 // Node[0]: ChannelManager: 3 (commtiemtn tx, 2*HTLC-Timeout tx), ChannelMonitor: 2 HTLC-timeout
2829 check_spends!(node_txn[1], $commitment_tx);
2830 check_spends!(node_txn[2], $commitment_tx);
2831 assert_ne!(node_txn[1].lock_time, 0);
2832 assert_ne!(node_txn[2].lock_time, 0);
2834 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2835 assert_eq!(node_txn[2].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2836 assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2837 assert!(node_txn[2].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2839 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2840 assert_eq!(node_txn[2].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2841 assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2842 assert!(node_txn[2].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2844 check_spends!(node_txn[0], $chan_tx);
2845 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), 71);
2849 // nodes[1] now broadcasts its own local state as a fallback, suggesting an alternate
2850 // commitment transaction with a corresponding HTLC-Timeout transactions, as well as a
2851 // timeout-claim of the output that nodes[2] just claimed via success.
2852 check_tx_local_broadcast!(nodes[1], false, commitment_tx[0], chan_2.3);
2854 // Broadcast legit commitment tx from A on B's chain
2855 // Broadcast preimage tx by B on offered output from A commitment tx on A's chain
2856 let node_a_commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
2857 check_spends!(node_a_commitment_tx[0], chan_1.3);
2858 mine_transaction(&nodes[1], &node_a_commitment_tx[0]);
2859 check_closed_broadcast!(nodes[1], true);
2860 check_added_monitors!(nodes[1], 1);
2861 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
2862 assert_eq!(node_txn.len(), 6); // ChannelManager : 3 (commitment tx + HTLC-Sucess * 2), ChannelMonitor : 3 (HTLC-Success, 2* RBF bumps of above HTLC txn)
2863 let commitment_spend =
2864 if node_txn[0].input[0].previous_output.txid == node_a_commitment_tx[0].txid() {
2865 check_spends!(node_txn[1], commitment_tx[0]);
2866 check_spends!(node_txn[2], commitment_tx[0]);
2867 assert_ne!(node_txn[1].input[0].previous_output.vout, node_txn[2].input[0].previous_output.vout);
2870 check_spends!(node_txn[0], commitment_tx[0]);
2871 check_spends!(node_txn[1], commitment_tx[0]);
2872 assert_ne!(node_txn[0].input[0].previous_output.vout, node_txn[1].input[0].previous_output.vout);
2876 check_spends!(commitment_spend, node_a_commitment_tx[0]);
2877 assert_eq!(commitment_spend.input.len(), 2);
2878 assert_eq!(commitment_spend.input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2879 assert_eq!(commitment_spend.input[1].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2880 assert_eq!(commitment_spend.lock_time, 0);
2881 assert!(commitment_spend.output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2882 check_spends!(node_txn[3], chan_1.3);
2883 assert_eq!(node_txn[3].input[0].witness.clone().last().unwrap().len(), 71);
2884 check_spends!(node_txn[4], node_txn[3]);
2885 check_spends!(node_txn[5], node_txn[3]);
2886 // We don't bother to check that B can claim the HTLC output on its commitment tx here as
2887 // we already checked the same situation with A.
2889 // Verify that A's ChannelManager is able to extract preimage from preimage tx and generate PaymentSent
2890 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2891 connect_block(&nodes[0], &Block { header, txdata: vec![node_a_commitment_tx[0].clone(), commitment_spend.clone()] });
2892 connect_blocks(&nodes[0], TEST_FINAL_CLTV + MIN_CLTV_EXPIRY_DELTA as u32 - 1); // Confirm blocks until the HTLC expires
2893 check_closed_broadcast!(nodes[0], true);
2894 check_added_monitors!(nodes[0], 1);
2895 let events = nodes[0].node.get_and_clear_pending_events();
2896 assert_eq!(events.len(), 2);
2897 let mut first_claimed = false;
2898 for event in events {
2900 Event::PaymentSent { payment_preimage } => {
2901 if payment_preimage == our_payment_preimage {
2902 assert!(!first_claimed);
2903 first_claimed = true;
2905 assert_eq!(payment_preimage, our_payment_preimage_2);
2908 _ => panic!("Unexpected event"),
2911 check_tx_local_broadcast!(nodes[0], true, node_a_commitment_tx[0], chan_1.3);
2914 fn do_test_htlc_on_chain_timeout(connect_style: ConnectStyle) {
2915 // Test that in case of a unilateral close onchain, we detect the state of output and
2916 // timeout the HTLC backward accordingly. So here we test that ChannelManager is
2917 // broadcasting the right event to other nodes in payment path.
2918 // A ------------------> B ----------------------> C (timeout)
2919 // B's commitment tx C's commitment tx
2921 // B's HTLC timeout tx B's timeout tx
2923 let chanmon_cfgs = create_chanmon_cfgs(3);
2924 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2925 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2926 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2927 *nodes[0].connect_style.borrow_mut() = connect_style;
2928 *nodes[1].connect_style.borrow_mut() = connect_style;
2929 *nodes[2].connect_style.borrow_mut() = connect_style;
2931 // Create some intial channels
2932 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2933 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
2935 // Rebalance the network a bit by relaying one payment thorugh all the channels...
2936 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
2937 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
2939 let (_payment_preimage, payment_hash, _payment_secret) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2941 // Broadcast legit commitment tx from C on B's chain
2942 let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
2943 check_spends!(commitment_tx[0], chan_2.3);
2944 nodes[2].node.fail_htlc_backwards(&payment_hash);
2945 check_added_monitors!(nodes[2], 0);
2946 expect_pending_htlcs_forwardable!(nodes[2]);
2947 check_added_monitors!(nodes[2], 1);
2949 let events = nodes[2].node.get_and_clear_pending_msg_events();
2950 assert_eq!(events.len(), 1);
2952 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, .. } } => {
2953 assert!(update_add_htlcs.is_empty());
2954 assert!(!update_fail_htlcs.is_empty());
2955 assert!(update_fulfill_htlcs.is_empty());
2956 assert!(update_fail_malformed_htlcs.is_empty());
2957 assert_eq!(nodes[1].node.get_our_node_id(), *node_id);
2959 _ => panic!("Unexpected event"),
2961 mine_transaction(&nodes[2], &commitment_tx[0]);
2962 check_closed_broadcast!(nodes[2], true);
2963 check_added_monitors!(nodes[2], 1);
2964 let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 1 (commitment tx)
2965 assert_eq!(node_txn.len(), 1);
2966 check_spends!(node_txn[0], chan_2.3);
2967 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), 71);
2969 // Broadcast timeout transaction by B on received output from C's commitment tx on B's chain
2970 // Verify that B's ChannelManager is able to detect that HTLC is timeout by its own tx and react backward in consequence
2971 connect_blocks(&nodes[1], 200 - nodes[2].best_block_info().1);
2972 mine_transaction(&nodes[1], &commitment_tx[0]);
2975 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2976 assert_eq!(node_txn.len(), 5); // ChannelManager : 2 (commitment tx, HTLC-Timeout tx), ChannelMonitor : 2 (local commitment tx + HTLC-timeout), 1 timeout tx
2977 assert_eq!(node_txn[0], node_txn[3]);
2978 assert_eq!(node_txn[1], node_txn[4]);
2980 check_spends!(node_txn[2], commitment_tx[0]);
2981 assert_eq!(node_txn[2].clone().input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2983 check_spends!(node_txn[0], chan_2.3);
2984 check_spends!(node_txn[1], node_txn[0]);
2985 assert_eq!(node_txn[0].clone().input[0].witness.last().unwrap().len(), 71);
2986 assert_eq!(node_txn[1].clone().input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2988 timeout_tx = node_txn[2].clone();
2992 mine_transaction(&nodes[1], &timeout_tx);
2993 check_added_monitors!(nodes[1], 1);
2994 check_closed_broadcast!(nodes[1], true);
2996 // B will rebroadcast a fee-bumped timeout transaction here.
2997 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
2998 assert_eq!(node_txn.len(), 1);
2999 check_spends!(node_txn[0], commitment_tx[0]);
3002 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
3004 // B may rebroadcast its own holder commitment transaction here, as a safeguard against
3005 // some incredibly unlikely partial-eclipse-attack scenarios. That said, because the
3006 // original commitment_tx[0] (also spending chan_2.3) has reached ANTI_REORG_DELAY B really
3007 // shouldn't broadcast anything here, and in some connect style scenarios we do not.
3008 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
3009 if node_txn.len() == 1 {
3010 check_spends!(node_txn[0], chan_2.3);
3012 assert_eq!(node_txn.len(), 0);
3016 expect_pending_htlcs_forwardable!(nodes[1]);
3017 check_added_monitors!(nodes[1], 1);
3018 let events = nodes[1].node.get_and_clear_pending_msg_events();
3019 assert_eq!(events.len(), 1);
3021 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, .. } } => {
3022 assert!(update_add_htlcs.is_empty());
3023 assert!(!update_fail_htlcs.is_empty());
3024 assert!(update_fulfill_htlcs.is_empty());
3025 assert!(update_fail_malformed_htlcs.is_empty());
3026 assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
3028 _ => panic!("Unexpected event"),
3031 // Broadcast legit commitment tx from B on A's chain
3032 let commitment_tx = get_local_commitment_txn!(nodes[1], chan_1.2);
3033 check_spends!(commitment_tx[0], chan_1.3);
3035 mine_transaction(&nodes[0], &commitment_tx[0]);
3036 connect_blocks(&nodes[0], TEST_FINAL_CLTV + MIN_CLTV_EXPIRY_DELTA as u32 - 1); // Confirm blocks until the HTLC expires
3038 check_closed_broadcast!(nodes[0], true);
3039 check_added_monitors!(nodes[0], 1);
3040 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 1 commitment tx, ChannelMonitor : 1 timeout tx
3041 assert_eq!(node_txn.len(), 2);
3042 check_spends!(node_txn[0], chan_1.3);
3043 assert_eq!(node_txn[0].clone().input[0].witness.last().unwrap().len(), 71);
3044 check_spends!(node_txn[1], commitment_tx[0]);
3045 assert_eq!(node_txn[1].clone().input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
3049 fn test_htlc_on_chain_timeout() {
3050 do_test_htlc_on_chain_timeout(ConnectStyle::BestBlockFirstSkippingBlocks);
3051 do_test_htlc_on_chain_timeout(ConnectStyle::TransactionsFirstSkippingBlocks);
3052 do_test_htlc_on_chain_timeout(ConnectStyle::FullBlockViaListen);
3056 fn test_simple_commitment_revoked_fail_backward() {
3057 // Test that in case of a revoked commitment tx, we detect the resolution of output by justice tx
3058 // and fail backward accordingly.
3060 let chanmon_cfgs = create_chanmon_cfgs(3);
3061 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3062 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3063 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3065 // Create some initial channels
3066 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3067 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3069 let (payment_preimage, _payment_hash, _payment_secret) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3000000);
3070 // Get the will-be-revoked local txn from nodes[2]
3071 let revoked_local_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
3072 // Revoke the old state
3073 claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage);
3075 let (_, payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3000000);
3077 mine_transaction(&nodes[1], &revoked_local_txn[0]);
3078 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
3079 check_added_monitors!(nodes[1], 1);
3080 check_closed_broadcast!(nodes[1], true);
3082 expect_pending_htlcs_forwardable!(nodes[1]);
3083 check_added_monitors!(nodes[1], 1);
3084 let events = nodes[1].node.get_and_clear_pending_msg_events();
3085 assert_eq!(events.len(), 1);
3087 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, .. } } => {
3088 assert!(update_add_htlcs.is_empty());
3089 assert_eq!(update_fail_htlcs.len(), 1);
3090 assert!(update_fulfill_htlcs.is_empty());
3091 assert!(update_fail_malformed_htlcs.is_empty());
3092 assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
3094 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
3095 commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
3096 expect_payment_failure_chan_update!(nodes[0], chan_2.0.contents.short_channel_id, true);
3097 expect_payment_failed!(nodes[0], payment_hash, false);
3099 _ => panic!("Unexpected event"),
3103 fn do_test_commitment_revoked_fail_backward_exhaustive(deliver_bs_raa: bool, use_dust: bool, no_to_remote: bool) {
3104 // Test that if our counterparty broadcasts a revoked commitment transaction we fail all
3105 // pending HTLCs on that channel backwards even if the HTLCs aren't present in our latest
3106 // commitment transaction anymore.
3107 // To do this, we have the peer which will broadcast a revoked commitment transaction send
3108 // a number of update_fail/commitment_signed updates without ever sending the RAA in
3109 // response to our commitment_signed. This is somewhat misbehavior-y, though not
3110 // technically disallowed and we should probably handle it reasonably.
3111 // Note that this is pretty exhaustive as an outbound HTLC which we haven't yet
3112 // failed/fulfilled backwards must be in at least one of the latest two remote commitment
3114 // * Once we move it out of our holding cell/add it, we will immediately include it in a
3115 // commitment_signed (implying it will be in the latest remote commitment transaction).
3116 // * Once they remove it, we will send a (the first) commitment_signed without the HTLC,
3117 // and once they revoke the previous commitment transaction (allowing us to send a new
3118 // commitment_signed) we will be free to fail/fulfill the HTLC backwards.
3119 let chanmon_cfgs = create_chanmon_cfgs(3);
3120 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3121 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3122 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3124 // Create some initial channels
3125 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3126 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3128 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 });
3129 // Get the will-be-revoked local txn from nodes[2]
3130 let revoked_local_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
3131 assert_eq!(revoked_local_txn[0].output.len(), if no_to_remote { 1 } else { 2 });
3132 // Revoke the old state
3133 claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage);
3135 let value = if use_dust {
3136 // The dust limit applied to HTLC outputs considers the fee of the HTLC transaction as
3137 // well, so HTLCs at exactly the dust limit will not be included in commitment txn.
3138 nodes[2].node.channel_state.lock().unwrap().by_id.get(&chan_2.2).unwrap().holder_dust_limit_satoshis * 1000
3141 let (_, first_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
3142 let (_, second_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
3143 let (_, third_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
3145 assert!(nodes[2].node.fail_htlc_backwards(&first_payment_hash));
3146 expect_pending_htlcs_forwardable!(nodes[2]);
3147 check_added_monitors!(nodes[2], 1);
3148 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3149 assert!(updates.update_add_htlcs.is_empty());
3150 assert!(updates.update_fulfill_htlcs.is_empty());
3151 assert!(updates.update_fail_malformed_htlcs.is_empty());
3152 assert_eq!(updates.update_fail_htlcs.len(), 1);
3153 assert!(updates.update_fee.is_none());
3154 nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
3155 let bs_raa = commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false, true, false, true);
3156 // Drop the last RAA from 3 -> 2
3158 assert!(nodes[2].node.fail_htlc_backwards(&second_payment_hash));
3159 expect_pending_htlcs_forwardable!(nodes[2]);
3160 check_added_monitors!(nodes[2], 1);
3161 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3162 assert!(updates.update_add_htlcs.is_empty());
3163 assert!(updates.update_fulfill_htlcs.is_empty());
3164 assert!(updates.update_fail_malformed_htlcs.is_empty());
3165 assert_eq!(updates.update_fail_htlcs.len(), 1);
3166 assert!(updates.update_fee.is_none());
3167 nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
3168 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &updates.commitment_signed);
3169 check_added_monitors!(nodes[1], 1);
3170 // Note that nodes[1] is in AwaitingRAA, so won't send a CS
3171 let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
3172 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
3173 check_added_monitors!(nodes[2], 1);
3175 assert!(nodes[2].node.fail_htlc_backwards(&third_payment_hash));
3176 expect_pending_htlcs_forwardable!(nodes[2]);
3177 check_added_monitors!(nodes[2], 1);
3178 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3179 assert!(updates.update_add_htlcs.is_empty());
3180 assert!(updates.update_fulfill_htlcs.is_empty());
3181 assert!(updates.update_fail_malformed_htlcs.is_empty());
3182 assert_eq!(updates.update_fail_htlcs.len(), 1);
3183 assert!(updates.update_fee.is_none());
3184 nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
3185 // At this point first_payment_hash has dropped out of the latest two commitment
3186 // transactions that nodes[1] is tracking...
3187 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &updates.commitment_signed);
3188 check_added_monitors!(nodes[1], 1);
3189 // Note that nodes[1] is (still) in AwaitingRAA, so won't send a CS
3190 let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
3191 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
3192 check_added_monitors!(nodes[2], 1);
3194 // Add a fourth HTLC, this one will get sequestered away in nodes[1]'s holding cell waiting
3195 // on nodes[2]'s RAA.
3196 let (_, fourth_payment_hash, fourth_payment_secret) = get_payment_preimage_hash!(nodes[2]);
3197 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
3198 let logger = test_utils::TestLogger::new();
3199 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();
3200 nodes[1].node.send_payment(&route, fourth_payment_hash, &Some(fourth_payment_secret)).unwrap();
3201 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3202 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
3203 check_added_monitors!(nodes[1], 0);
3206 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_raa);
3207 // One monitor for the new revocation preimage, no second on as we won't generate a new
3208 // commitment transaction for nodes[0] until process_pending_htlc_forwards().
3209 check_added_monitors!(nodes[1], 1);
3210 let events = nodes[1].node.get_and_clear_pending_events();
3211 assert_eq!(events.len(), 1);
3213 Event::PendingHTLCsForwardable { .. } => { },
3214 _ => panic!("Unexpected event"),
3216 // Deliberately don't process the pending fail-back so they all fail back at once after
3217 // block connection just like the !deliver_bs_raa case
3220 let mut failed_htlcs = HashSet::new();
3221 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
3223 mine_transaction(&nodes[1], &revoked_local_txn[0]);
3224 check_added_monitors!(nodes[1], 1);
3225 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
3227 let events = nodes[1].node.get_and_clear_pending_events();
3228 assert_eq!(events.len(), if deliver_bs_raa { 1 } else { 2 });
3230 Event::PaymentFailed { ref payment_hash, .. } => {
3231 assert_eq!(*payment_hash, fourth_payment_hash);
3233 _ => panic!("Unexpected event"),
3235 if !deliver_bs_raa {
3237 Event::PendingHTLCsForwardable { .. } => { },
3238 _ => panic!("Unexpected event"),
3241 nodes[1].node.process_pending_htlc_forwards();
3242 check_added_monitors!(nodes[1], 1);
3244 let events = nodes[1].node.get_and_clear_pending_msg_events();
3245 assert_eq!(events.len(), if deliver_bs_raa { 4 } else { 3 });
3246 match events[if deliver_bs_raa { 1 } else { 0 }] {
3247 MessageSendEvent::BroadcastChannelUpdate { msg: msgs::ChannelUpdate { .. } } => {},
3248 _ => panic!("Unexpected event"),
3250 match events[if deliver_bs_raa { 2 } else { 1 }] {
3251 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { msg: msgs::ErrorMessage { channel_id, ref data } }, node_id: _ } => {
3252 assert_eq!(channel_id, chan_2.2);
3253 assert_eq!(data.as_str(), "Commitment or closing transaction was confirmed on chain.");
3255 _ => panic!("Unexpected event"),
3259 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, .. } } => {
3260 assert_eq!(nodes[2].node.get_our_node_id(), *node_id);
3261 assert_eq!(update_add_htlcs.len(), 1);
3262 assert!(update_fulfill_htlcs.is_empty());
3263 assert!(update_fail_htlcs.is_empty());
3264 assert!(update_fail_malformed_htlcs.is_empty());
3266 _ => panic!("Unexpected event"),
3269 match events[if deliver_bs_raa { 3 } else { 2 }] {
3270 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, .. } } => {
3271 assert!(update_add_htlcs.is_empty());
3272 assert_eq!(update_fail_htlcs.len(), 3);
3273 assert!(update_fulfill_htlcs.is_empty());
3274 assert!(update_fail_malformed_htlcs.is_empty());
3275 assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
3277 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
3278 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[1]);
3279 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[2]);
3281 commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
3283 let events = nodes[0].node.get_and_clear_pending_msg_events();
3284 // If we delivered B's RAA we got an unknown preimage error, not something
3285 // that we should update our routing table for.
3286 assert_eq!(events.len(), if deliver_bs_raa { 2 } else { 3 });
3287 for event in events {
3289 MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
3290 _ => panic!("Unexpected event"),
3293 let events = nodes[0].node.get_and_clear_pending_events();
3294 assert_eq!(events.len(), 3);
3296 Event::PaymentFailed { ref payment_hash, .. } => {
3297 assert!(failed_htlcs.insert(payment_hash.0));
3299 _ => panic!("Unexpected event"),
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 _ => panic!("Unexpected event"),
3317 assert!(failed_htlcs.contains(&first_payment_hash.0));
3318 assert!(failed_htlcs.contains(&second_payment_hash.0));
3319 assert!(failed_htlcs.contains(&third_payment_hash.0));
3323 fn test_commitment_revoked_fail_backward_exhaustive_a() {
3324 do_test_commitment_revoked_fail_backward_exhaustive(false, true, false);
3325 do_test_commitment_revoked_fail_backward_exhaustive(true, true, false);
3326 do_test_commitment_revoked_fail_backward_exhaustive(false, false, false);
3327 do_test_commitment_revoked_fail_backward_exhaustive(true, false, false);
3331 fn test_commitment_revoked_fail_backward_exhaustive_b() {
3332 do_test_commitment_revoked_fail_backward_exhaustive(false, true, true);
3333 do_test_commitment_revoked_fail_backward_exhaustive(true, true, true);
3334 do_test_commitment_revoked_fail_backward_exhaustive(false, false, true);
3335 do_test_commitment_revoked_fail_backward_exhaustive(true, false, true);
3339 fn fail_backward_pending_htlc_upon_channel_failure() {
3340 let chanmon_cfgs = create_chanmon_cfgs(2);
3341 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3342 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3343 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3344 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1_000_000, 500_000_000, InitFeatures::known(), InitFeatures::known());
3345 let logger = test_utils::TestLogger::new();
3347 // Alice -> Bob: Route a payment but without Bob sending revoke_and_ack.
3349 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1]);
3350 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3351 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();
3352 nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
3353 check_added_monitors!(nodes[0], 1);
3355 let payment_event = {
3356 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3357 assert_eq!(events.len(), 1);
3358 SendEvent::from_event(events.remove(0))
3360 assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
3361 assert_eq!(payment_event.msgs.len(), 1);
3364 // Alice -> Bob: Route another payment but now Alice waits for Bob's earlier revoke_and_ack.
3365 let (_, failed_payment_hash, failed_payment_secret) = get_payment_preimage_hash!(nodes[1]);
3367 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3368 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();
3369 nodes[0].node.send_payment(&route, failed_payment_hash, &Some(failed_payment_secret)).unwrap();
3370 check_added_monitors!(nodes[0], 0);
3372 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3375 // Alice <- Bob: Send a malformed update_add_htlc so Alice fails the channel.
3377 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[0]);
3379 let secp_ctx = Secp256k1::new();
3380 let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
3381 let current_height = nodes[1].node.best_block.read().unwrap().height() + 1;
3382 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
3383 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();
3384 let (onion_payloads, _amount_msat, cltv_expiry) = onion_utils::build_onion_payloads(&route.paths[0], 50_000, &Some(payment_secret), current_height).unwrap();
3385 let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route.paths[0], &session_priv).unwrap();
3386 let onion_routing_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
3388 // Send a 0-msat update_add_htlc to fail the channel.
3389 let update_add_htlc = msgs::UpdateAddHTLC {
3395 onion_routing_packet,
3397 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &update_add_htlc);
3400 // Check that Alice fails backward the pending HTLC from the second payment.
3401 expect_payment_failed!(nodes[0], failed_payment_hash, true);
3402 check_closed_broadcast!(nodes[0], true);
3403 check_added_monitors!(nodes[0], 1);
3407 fn test_htlc_ignore_latest_remote_commitment() {
3408 // Test that HTLC transactions spending the latest remote commitment transaction are simply
3409 // ignored if we cannot claim them. This originally tickled an invalid unwrap().
3410 let chanmon_cfgs = create_chanmon_cfgs(2);
3411 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3412 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3413 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3414 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3416 route_payment(&nodes[0], &[&nodes[1]], 10000000);
3417 nodes[0].node.force_close_channel(&nodes[0].node.list_channels()[0].channel_id).unwrap();
3418 connect_blocks(&nodes[0], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + 1);
3419 check_closed_broadcast!(nodes[0], true);
3420 check_added_monitors!(nodes[0], 1);
3422 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
3423 assert_eq!(node_txn.len(), 3);
3424 assert_eq!(node_txn[0], node_txn[1]);
3426 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3427 connect_block(&nodes[1], &Block { header, txdata: vec![node_txn[0].clone(), node_txn[1].clone()]});
3428 check_closed_broadcast!(nodes[1], true);
3429 check_added_monitors!(nodes[1], 1);
3431 // Duplicate the connect_block call since this may happen due to other listeners
3432 // registering new transactions
3433 header.prev_blockhash = header.block_hash();
3434 connect_block(&nodes[1], &Block { header, txdata: vec![node_txn[0].clone(), node_txn[2].clone()]});
3438 fn test_force_close_fail_back() {
3439 // Check which HTLCs are failed-backwards on channel force-closure
3440 let chanmon_cfgs = create_chanmon_cfgs(3);
3441 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3442 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3443 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3444 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3445 create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3446 let logger = test_utils::TestLogger::new();
3448 let (our_payment_preimage, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[2]);
3450 let mut payment_event = {
3451 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3452 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();
3453 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
3454 check_added_monitors!(nodes[0], 1);
3456 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3457 assert_eq!(events.len(), 1);
3458 SendEvent::from_event(events.remove(0))
3461 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
3462 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
3464 expect_pending_htlcs_forwardable!(nodes[1]);
3466 let mut events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3467 assert_eq!(events_2.len(), 1);
3468 payment_event = SendEvent::from_event(events_2.remove(0));
3469 assert_eq!(payment_event.msgs.len(), 1);
3471 check_added_monitors!(nodes[1], 1);
3472 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
3473 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg);
3474 check_added_monitors!(nodes[2], 1);
3475 let (_, _) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3477 // nodes[2] now has the latest commitment transaction, but hasn't revoked its previous
3478 // state or updated nodes[1]' state. Now force-close and broadcast that commitment/HTLC
3479 // transaction and ensure nodes[1] doesn't fail-backwards (this was originally a bug!).
3481 nodes[2].node.force_close_channel(&payment_event.commitment_msg.channel_id).unwrap();
3482 check_closed_broadcast!(nodes[2], true);
3483 check_added_monitors!(nodes[2], 1);
3485 let mut node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap();
3486 // Note that we don't bother broadcasting the HTLC-Success transaction here as we don't
3487 // have a use for it unless nodes[2] learns the preimage somehow, the funds will go
3488 // back to nodes[1] upon timeout otherwise.
3489 assert_eq!(node_txn.len(), 1);
3493 mine_transaction(&nodes[1], &tx);
3495 // Note no UpdateHTLCs event here from nodes[1] to nodes[0]!
3496 check_closed_broadcast!(nodes[1], true);
3497 check_added_monitors!(nodes[1], 1);
3499 // Now check that if we add the preimage to ChannelMonitor it broadcasts our HTLC-Success..
3501 let mut monitors = nodes[2].chain_monitor.chain_monitor.monitors.read().unwrap();
3502 monitors.get(&OutPoint{ txid: Txid::from_slice(&payment_event.commitment_msg.channel_id[..]).unwrap(), index: 0 }).unwrap()
3503 .provide_payment_preimage(&our_payment_hash, &our_payment_preimage, &node_cfgs[2].tx_broadcaster, &node_cfgs[2].fee_estimator, &&logger);
3505 mine_transaction(&nodes[2], &tx);
3506 let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap();
3507 assert_eq!(node_txn.len(), 1);
3508 assert_eq!(node_txn[0].input.len(), 1);
3509 assert_eq!(node_txn[0].input[0].previous_output.txid, tx.txid());
3510 assert_eq!(node_txn[0].lock_time, 0); // Must be an HTLC-Success
3511 assert_eq!(node_txn[0].input[0].witness.len(), 5); // Must be an HTLC-Success
3513 check_spends!(node_txn[0], tx);
3517 fn test_dup_events_on_peer_disconnect() {
3518 // Test that if we receive a duplicative update_fulfill_htlc message after a reconnect we do
3519 // not generate a corresponding duplicative PaymentSent event. This did not use to be the case
3520 // as we used to generate the event immediately upon receipt of the payment preimage in the
3521 // update_fulfill_htlc message.
3523 let chanmon_cfgs = create_chanmon_cfgs(2);
3524 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3525 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3526 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3527 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3529 let payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 1000000).0;
3531 assert!(nodes[1].node.claim_funds(payment_preimage));
3532 check_added_monitors!(nodes[1], 1);
3533 let claim_msgs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3534 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &claim_msgs.update_fulfill_htlcs[0]);
3535 expect_payment_sent!(nodes[0], payment_preimage);
3537 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3538 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3540 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (1, 0), (0, 0), (0, 0), (false, false));
3541 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
3545 fn test_simple_peer_disconnect() {
3546 // Test that we can reconnect when there are no lost messages
3547 let chanmon_cfgs = create_chanmon_cfgs(3);
3548 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3549 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3550 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3551 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3552 create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3554 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3555 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3556 reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3558 let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3559 let payment_hash_2 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3560 fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_hash_2);
3561 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_preimage_1);
3563 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3564 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3565 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3567 let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3568 let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3569 let payment_hash_5 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3570 let payment_hash_6 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3572 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3573 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3575 claim_payment_along_route(&nodes[0], &[&[&nodes[1], &nodes[2]]], true, payment_preimage_3);
3576 fail_payment_along_route(&nodes[0], &[&nodes[1], &nodes[2]], true, payment_hash_5);
3578 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (1, 0), (1, 0), (false, false));
3580 let events = nodes[0].node.get_and_clear_pending_events();
3581 assert_eq!(events.len(), 2);
3583 Event::PaymentSent { payment_preimage } => {
3584 assert_eq!(payment_preimage, payment_preimage_3);
3586 _ => panic!("Unexpected event"),
3589 Event::PaymentFailed { payment_hash, rejected_by_dest, .. } => {
3590 assert_eq!(payment_hash, payment_hash_5);
3591 assert!(rejected_by_dest);
3593 _ => panic!("Unexpected event"),
3597 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_preimage_4);
3598 fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_hash_6);
3601 fn do_test_drop_messages_peer_disconnect(messages_delivered: u8, simulate_broken_lnd: bool) {
3602 // Test that we can reconnect when in-flight HTLC updates get dropped
3603 let chanmon_cfgs = create_chanmon_cfgs(2);
3604 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3605 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3606 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3608 let mut as_funding_locked = None;
3609 if messages_delivered == 0 {
3610 let (funding_locked, _, _) = create_chan_between_nodes_with_value_a(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
3611 as_funding_locked = Some(funding_locked);
3612 // nodes[1] doesn't receive the funding_locked message (it'll be re-sent on reconnect)
3613 // Note that we store it so that if we're running with `simulate_broken_lnd` we can deliver
3614 // it before the channel_reestablish message.
3616 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3619 let (payment_preimage_1, payment_hash_1, payment_secret_1) = get_payment_preimage_hash!(nodes[1]);
3621 let logger = test_utils::TestLogger::new();
3622 let payment_event = {
3623 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3624 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(),
3625 &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), Some(&nodes[0].node.list_usable_channels().iter().collect::<Vec<_>>()),
3626 &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
3627 nodes[0].node.send_payment(&route, payment_hash_1, &Some(payment_secret_1)).unwrap();
3628 check_added_monitors!(nodes[0], 1);
3630 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3631 assert_eq!(events.len(), 1);
3632 SendEvent::from_event(events.remove(0))
3634 assert_eq!(nodes[1].node.get_our_node_id(), payment_event.node_id);
3636 if messages_delivered < 2 {
3637 // Drop the payment_event messages, and let them get re-generated in reconnect_nodes!
3639 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
3640 if messages_delivered >= 3 {
3641 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
3642 check_added_monitors!(nodes[1], 1);
3643 let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3645 if messages_delivered >= 4 {
3646 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3647 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3648 check_added_monitors!(nodes[0], 1);
3650 if messages_delivered >= 5 {
3651 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_commitment_signed);
3652 let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3653 // No commitment_signed so get_event_msg's assert(len == 1) passes
3654 check_added_monitors!(nodes[0], 1);
3656 if messages_delivered >= 6 {
3657 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3658 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3659 check_added_monitors!(nodes[1], 1);
3666 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3667 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3668 if messages_delivered < 3 {
3669 if simulate_broken_lnd {
3670 // lnd has a long-standing bug where they send a funding_locked prior to a
3671 // channel_reestablish if you reconnect prior to funding_locked time.
3673 // Here we simulate that behavior, delivering a funding_locked immediately on
3674 // reconnect. Note that we don't bother skipping the now-duplicate funding_locked sent
3675 // in `reconnect_nodes` but we currently don't fail based on that.
3677 // See-also <https://github.com/lightningnetwork/lnd/issues/4006>
3678 nodes[1].node.handle_funding_locked(&nodes[0].node.get_our_node_id(), &as_funding_locked.as_ref().unwrap().0);
3680 // Even if the funding_locked messages get exchanged, as long as nothing further was
3681 // received on either side, both sides will need to resend them.
3682 reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 1), (0, 0), (0, 0), (0, 0), (false, false));
3683 } else if messages_delivered == 3 {
3684 // nodes[0] still wants its RAA + commitment_signed
3685 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (-1, 0), (0, 0), (0, 0), (0, 0), (true, false));
3686 } else if messages_delivered == 4 {
3687 // nodes[0] still wants its commitment_signed
3688 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (-1, 0), (0, 0), (0, 0), (0, 0), (false, false));
3689 } else if messages_delivered == 5 {
3690 // nodes[1] still wants its final RAA
3691 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, true));
3692 } else if messages_delivered == 6 {
3693 // Everything was delivered...
3694 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3697 let events_1 = nodes[1].node.get_and_clear_pending_events();
3698 assert_eq!(events_1.len(), 1);
3700 Event::PendingHTLCsForwardable { .. } => { },
3701 _ => panic!("Unexpected event"),
3704 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3705 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3706 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3708 nodes[1].node.process_pending_htlc_forwards();
3710 let events_2 = nodes[1].node.get_and_clear_pending_events();
3711 assert_eq!(events_2.len(), 1);
3713 Event::PaymentReceived { ref payment_hash, ref payment_preimage, ref payment_secret, amt, user_payment_id: _ } => {
3714 assert_eq!(payment_hash_1, *payment_hash);
3715 assert!(payment_preimage.is_none());
3716 assert_eq!(payment_secret_1, *payment_secret);
3717 assert_eq!(amt, 1000000);
3719 _ => panic!("Unexpected event"),
3722 nodes[1].node.claim_funds(payment_preimage_1);
3723 check_added_monitors!(nodes[1], 1);
3725 let events_3 = nodes[1].node.get_and_clear_pending_msg_events();
3726 assert_eq!(events_3.len(), 1);
3727 let (update_fulfill_htlc, commitment_signed) = match events_3[0] {
3728 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
3729 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3730 assert!(updates.update_add_htlcs.is_empty());
3731 assert!(updates.update_fail_htlcs.is_empty());
3732 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
3733 assert!(updates.update_fail_malformed_htlcs.is_empty());
3734 assert!(updates.update_fee.is_none());
3735 (updates.update_fulfill_htlcs[0].clone(), updates.commitment_signed.clone())
3737 _ => panic!("Unexpected event"),
3740 if messages_delivered >= 1 {
3741 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlc);
3743 let events_4 = nodes[0].node.get_and_clear_pending_events();
3744 assert_eq!(events_4.len(), 1);
3746 Event::PaymentSent { ref payment_preimage } => {
3747 assert_eq!(payment_preimage_1, *payment_preimage);
3749 _ => panic!("Unexpected event"),
3752 if messages_delivered >= 2 {
3753 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
3754 check_added_monitors!(nodes[0], 1);
3755 let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
3757 if messages_delivered >= 3 {
3758 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3759 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3760 check_added_monitors!(nodes[1], 1);
3762 if messages_delivered >= 4 {
3763 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed);
3764 let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3765 // No commitment_signed so get_event_msg's assert(len == 1) passes
3766 check_added_monitors!(nodes[1], 1);
3768 if messages_delivered >= 5 {
3769 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3770 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3771 check_added_monitors!(nodes[0], 1);
3778 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3779 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3780 if messages_delivered < 2 {
3781 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (1, 0), (0, 0), (0, 0), (false, false));
3782 if messages_delivered < 1 {
3783 let events_4 = nodes[0].node.get_and_clear_pending_events();
3784 assert_eq!(events_4.len(), 1);
3786 Event::PaymentSent { ref payment_preimage } => {
3787 assert_eq!(payment_preimage_1, *payment_preimage);
3789 _ => panic!("Unexpected event"),
3792 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3794 } else if messages_delivered == 2 {
3795 // nodes[0] still wants its RAA + commitment_signed
3796 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, -1), (0, 0), (0, 0), (0, 0), (false, true));
3797 } else if messages_delivered == 3 {
3798 // nodes[0] still wants its commitment_signed
3799 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, -1), (0, 0), (0, 0), (0, 0), (false, false));
3800 } else if messages_delivered == 4 {
3801 // nodes[1] still wants its final RAA
3802 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (true, false));
3803 } else if messages_delivered == 5 {
3804 // Everything was delivered...
3805 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3808 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3809 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3810 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3812 // Channel should still work fine...
3813 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3814 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(),
3815 &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), Some(&nodes[0].node.list_usable_channels().iter().collect::<Vec<_>>()),
3816 &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
3817 let payment_preimage_2 = send_along_route(&nodes[0], route, &[&nodes[1]], 1000000).0;
3818 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
3822 fn test_drop_messages_peer_disconnect_a() {
3823 do_test_drop_messages_peer_disconnect(0, true);
3824 do_test_drop_messages_peer_disconnect(0, false);
3825 do_test_drop_messages_peer_disconnect(1, false);
3826 do_test_drop_messages_peer_disconnect(2, false);
3830 fn test_drop_messages_peer_disconnect_b() {
3831 do_test_drop_messages_peer_disconnect(3, false);
3832 do_test_drop_messages_peer_disconnect(4, false);
3833 do_test_drop_messages_peer_disconnect(5, false);
3834 do_test_drop_messages_peer_disconnect(6, false);
3838 fn test_funding_peer_disconnect() {
3839 // Test that we can lock in our funding tx while disconnected
3840 let chanmon_cfgs = create_chanmon_cfgs(2);
3841 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3842 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3843 let persister: test_utils::TestPersister;
3844 let new_chain_monitor: test_utils::TestChainMonitor;
3845 let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
3846 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3847 let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
3849 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3850 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3852 confirm_transaction(&nodes[0], &tx);
3853 let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
3854 assert_eq!(events_1.len(), 1);
3856 MessageSendEvent::SendFundingLocked { ref node_id, msg: _ } => {
3857 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
3859 _ => panic!("Unexpected event"),
3862 reconnect_nodes(&nodes[0], &nodes[1], (false, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3864 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3865 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3867 confirm_transaction(&nodes[1], &tx);
3868 let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3869 assert_eq!(events_2.len(), 2);
3870 let funding_locked = match events_2[0] {
3871 MessageSendEvent::SendFundingLocked { ref node_id, ref msg } => {
3872 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3875 _ => panic!("Unexpected event"),
3877 let bs_announcement_sigs = match events_2[1] {
3878 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
3879 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3882 _ => panic!("Unexpected event"),
3885 reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3887 nodes[0].node.handle_funding_locked(&nodes[1].node.get_our_node_id(), &funding_locked);
3888 nodes[0].node.handle_announcement_signatures(&nodes[1].node.get_our_node_id(), &bs_announcement_sigs);
3889 let events_3 = nodes[0].node.get_and_clear_pending_msg_events();
3890 assert_eq!(events_3.len(), 2);
3891 let as_announcement_sigs = match events_3[0] {
3892 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
3893 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
3896 _ => panic!("Unexpected event"),
3898 let (as_announcement, as_update) = match events_3[1] {
3899 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
3900 (msg.clone(), update_msg.clone())
3902 _ => panic!("Unexpected event"),
3905 nodes[1].node.handle_announcement_signatures(&nodes[0].node.get_our_node_id(), &as_announcement_sigs);
3906 let events_4 = nodes[1].node.get_and_clear_pending_msg_events();
3907 assert_eq!(events_4.len(), 1);
3908 let (_, bs_update) = match events_4[0] {
3909 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
3910 (msg.clone(), update_msg.clone())
3912 _ => panic!("Unexpected event"),
3915 nodes[0].net_graph_msg_handler.handle_channel_announcement(&as_announcement).unwrap();
3916 nodes[0].net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
3917 nodes[0].net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
3919 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3920 let logger = test_utils::TestLogger::new();
3921 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();
3922 let (payment_preimage, _, _) = send_along_route(&nodes[0], route, &[&nodes[1]], 1000000);
3923 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage);
3925 // Check that after deserialization and reconnection we can still generate an identical
3926 // channel_announcement from the cached signatures.
3927 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3929 let nodes_0_serialized = nodes[0].node.encode();
3930 let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
3931 nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
3933 persister = test_utils::TestPersister::new();
3934 let keys_manager = &chanmon_cfgs[0].keys_manager;
3935 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);
3936 nodes[0].chain_monitor = &new_chain_monitor;
3937 let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
3938 let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
3939 &mut chan_0_monitor_read, keys_manager).unwrap();
3940 assert!(chan_0_monitor_read.is_empty());
3942 let mut nodes_0_read = &nodes_0_serialized[..];
3943 let (_, nodes_0_deserialized_tmp) = {
3944 let mut channel_monitors = HashMap::new();
3945 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
3946 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
3947 default_config: UserConfig::default(),
3949 fee_estimator: node_cfgs[0].fee_estimator,
3950 chain_monitor: nodes[0].chain_monitor,
3951 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
3952 logger: nodes[0].logger,
3956 nodes_0_deserialized = nodes_0_deserialized_tmp;
3957 assert!(nodes_0_read.is_empty());
3959 assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
3960 nodes[0].node = &nodes_0_deserialized;
3961 check_added_monitors!(nodes[0], 1);
3963 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3965 // as_announcement should be re-generated exactly by broadcast_node_announcement.
3966 nodes[0].node.broadcast_node_announcement([0, 0, 0], [0; 32], Vec::new());
3967 let msgs = nodes[0].node.get_and_clear_pending_msg_events();
3968 let mut found_announcement = false;
3969 for event in msgs.iter() {
3971 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, .. } => {
3972 if *msg == as_announcement { found_announcement = true; }
3974 MessageSendEvent::BroadcastNodeAnnouncement { .. } => {},
3975 _ => panic!("Unexpected event"),
3978 assert!(found_announcement);
3982 fn test_drop_messages_peer_disconnect_dual_htlc() {
3983 // Test that we can handle reconnecting when both sides of a channel have pending
3984 // commitment_updates when we disconnect.
3985 let chanmon_cfgs = create_chanmon_cfgs(2);
3986 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3987 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3988 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3989 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3990 let logger = test_utils::TestLogger::new();
3992 let (payment_preimage_1, _, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
3994 // Now try to send a second payment which will fail to send
3995 let (payment_preimage_2, payment_hash_2, payment_secret_2) = get_payment_preimage_hash!(nodes[1]);
3996 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3997 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();
3998 nodes[0].node.send_payment(&route, payment_hash_2, &Some(payment_secret_2)).unwrap();
3999 check_added_monitors!(nodes[0], 1);
4001 let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
4002 assert_eq!(events_1.len(), 1);
4004 MessageSendEvent::UpdateHTLCs { .. } => {},
4005 _ => panic!("Unexpected event"),
4008 assert!(nodes[1].node.claim_funds(payment_preimage_1));
4009 check_added_monitors!(nodes[1], 1);
4011 let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
4012 assert_eq!(events_2.len(), 1);
4014 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 } } => {
4015 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
4016 assert!(update_add_htlcs.is_empty());
4017 assert_eq!(update_fulfill_htlcs.len(), 1);
4018 assert!(update_fail_htlcs.is_empty());
4019 assert!(update_fail_malformed_htlcs.is_empty());
4020 assert!(update_fee.is_none());
4022 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlcs[0]);
4023 let events_3 = nodes[0].node.get_and_clear_pending_events();
4024 assert_eq!(events_3.len(), 1);
4026 Event::PaymentSent { ref payment_preimage } => {
4027 assert_eq!(*payment_preimage, payment_preimage_1);
4029 _ => panic!("Unexpected event"),
4032 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), commitment_signed);
4033 let _ = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
4034 // No commitment_signed so get_event_msg's assert(len == 1) passes
4035 check_added_monitors!(nodes[0], 1);
4037 _ => panic!("Unexpected event"),
4040 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
4041 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4043 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4044 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
4045 assert_eq!(reestablish_1.len(), 1);
4046 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4047 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
4048 assert_eq!(reestablish_2.len(), 1);
4050 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
4051 let as_resp = handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
4052 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
4053 let bs_resp = handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
4055 assert!(as_resp.0.is_none());
4056 assert!(bs_resp.0.is_none());
4058 assert!(bs_resp.1.is_none());
4059 assert!(bs_resp.2.is_none());
4061 assert!(as_resp.3 == RAACommitmentOrder::CommitmentFirst);
4063 assert_eq!(as_resp.2.as_ref().unwrap().update_add_htlcs.len(), 1);
4064 assert!(as_resp.2.as_ref().unwrap().update_fulfill_htlcs.is_empty());
4065 assert!(as_resp.2.as_ref().unwrap().update_fail_htlcs.is_empty());
4066 assert!(as_resp.2.as_ref().unwrap().update_fail_malformed_htlcs.is_empty());
4067 assert!(as_resp.2.as_ref().unwrap().update_fee.is_none());
4068 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &as_resp.2.as_ref().unwrap().update_add_htlcs[0]);
4069 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_resp.2.as_ref().unwrap().commitment_signed);
4070 let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
4071 // No commitment_signed so get_event_msg's assert(len == 1) passes
4072 check_added_monitors!(nodes[1], 1);
4074 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), as_resp.1.as_ref().unwrap());
4075 let bs_second_commitment_signed = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4076 assert!(bs_second_commitment_signed.update_add_htlcs.is_empty());
4077 assert!(bs_second_commitment_signed.update_fulfill_htlcs.is_empty());
4078 assert!(bs_second_commitment_signed.update_fail_htlcs.is_empty());
4079 assert!(bs_second_commitment_signed.update_fail_malformed_htlcs.is_empty());
4080 assert!(bs_second_commitment_signed.update_fee.is_none());
4081 check_added_monitors!(nodes[1], 1);
4083 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
4084 let as_commitment_signed = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
4085 assert!(as_commitment_signed.update_add_htlcs.is_empty());
4086 assert!(as_commitment_signed.update_fulfill_htlcs.is_empty());
4087 assert!(as_commitment_signed.update_fail_htlcs.is_empty());
4088 assert!(as_commitment_signed.update_fail_malformed_htlcs.is_empty());
4089 assert!(as_commitment_signed.update_fee.is_none());
4090 check_added_monitors!(nodes[0], 1);
4092 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_commitment_signed.commitment_signed);
4093 let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
4094 // No commitment_signed so get_event_msg's assert(len == 1) passes
4095 check_added_monitors!(nodes[0], 1);
4097 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed.commitment_signed);
4098 let bs_second_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
4099 // No commitment_signed so get_event_msg's assert(len == 1) passes
4100 check_added_monitors!(nodes[1], 1);
4102 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
4103 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4104 check_added_monitors!(nodes[1], 1);
4106 expect_pending_htlcs_forwardable!(nodes[1]);
4108 let events_5 = nodes[1].node.get_and_clear_pending_events();
4109 assert_eq!(events_5.len(), 1);
4111 Event::PaymentReceived { ref payment_hash, ref payment_preimage, ref payment_secret, amt: _, user_payment_id: _ } => {
4112 assert_eq!(payment_hash_2, *payment_hash);
4113 assert!(payment_preimage.is_none());
4114 assert_eq!(payment_secret_2, *payment_secret);
4116 _ => panic!("Unexpected event"),
4119 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke_and_ack);
4120 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4121 check_added_monitors!(nodes[0], 1);
4123 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
4126 fn do_test_htlc_timeout(send_partial_mpp: bool) {
4127 // If the user fails to claim/fail an HTLC within the HTLC CLTV timeout we fail it for them
4128 // to avoid our counterparty failing the channel.
4129 let chanmon_cfgs = create_chanmon_cfgs(2);
4130 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4131 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4132 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4134 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4135 let logger = test_utils::TestLogger::new();
4137 let our_payment_hash = if send_partial_mpp {
4138 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
4139 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();
4140 let (_, our_payment_hash, payment_secret) = get_payment_preimage_hash!(&nodes[1]);
4141 // Use the utility function send_payment_along_path to send the payment with MPP data which
4142 // indicates there are more HTLCs coming.
4143 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.
4144 nodes[0].node.send_payment_along_path(&route.paths[0], &our_payment_hash, &Some(payment_secret), 200000, cur_height).unwrap();
4145 check_added_monitors!(nodes[0], 1);
4146 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
4147 assert_eq!(events.len(), 1);
4148 // Now do the relevant commitment_signed/RAA dances along the path, noting that the final
4149 // hop should *not* yet generate any PaymentReceived event(s).
4150 pass_along_path(&nodes[0], &[&nodes[1]], 100000, our_payment_hash, payment_secret, events.drain(..).next().unwrap(), false);
4153 route_payment(&nodes[0], &[&nodes[1]], 100000).1
4156 let mut block = Block {
4157 header: BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
4160 connect_block(&nodes[0], &block);
4161 connect_block(&nodes[1], &block);
4162 let block_count = TEST_FINAL_CLTV + CHAN_CONFIRM_DEPTH + 2 - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS;
4163 for _ in CHAN_CONFIRM_DEPTH + 2..block_count {
4164 block.header.prev_blockhash = block.block_hash();
4165 connect_block(&nodes[0], &block);
4166 connect_block(&nodes[1], &block);
4169 expect_pending_htlcs_forwardable!(nodes[1]);
4171 check_added_monitors!(nodes[1], 1);
4172 let htlc_timeout_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4173 assert!(htlc_timeout_updates.update_add_htlcs.is_empty());
4174 assert_eq!(htlc_timeout_updates.update_fail_htlcs.len(), 1);
4175 assert!(htlc_timeout_updates.update_fail_malformed_htlcs.is_empty());
4176 assert!(htlc_timeout_updates.update_fee.is_none());
4178 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_timeout_updates.update_fail_htlcs[0]);
4179 commitment_signed_dance!(nodes[0], nodes[1], htlc_timeout_updates.commitment_signed, false);
4180 // 100_000 msat as u64, followed by the height at which we failed back above
4181 let mut expected_failure_data = byte_utils::be64_to_array(100_000).to_vec();
4182 expected_failure_data.extend_from_slice(&byte_utils::be32_to_array(block_count - 1));
4183 expect_payment_failed!(nodes[0], our_payment_hash, true, 0x4000 | 15, &expected_failure_data[..]);
4187 fn test_htlc_timeout() {
4188 do_test_htlc_timeout(true);
4189 do_test_htlc_timeout(false);
4192 fn do_test_holding_cell_htlc_add_timeouts(forwarded_htlc: bool) {
4193 // Tests that HTLCs in the holding cell are timed out after the requisite number of blocks.
4194 let chanmon_cfgs = create_chanmon_cfgs(3);
4195 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
4196 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
4197 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
4198 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4199 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
4201 // Make sure all nodes are at the same starting height
4202 connect_blocks(&nodes[0], 2*CHAN_CONFIRM_DEPTH + 1 - nodes[0].best_block_info().1);
4203 connect_blocks(&nodes[1], 2*CHAN_CONFIRM_DEPTH + 1 - nodes[1].best_block_info().1);
4204 connect_blocks(&nodes[2], 2*CHAN_CONFIRM_DEPTH + 1 - nodes[2].best_block_info().1);
4206 let logger = test_utils::TestLogger::new();
4208 // Route a first payment to get the 1 -> 2 channel in awaiting_raa...
4209 let (_, first_payment_hash, first_payment_secret) = get_payment_preimage_hash!(nodes[2]);
4211 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
4212 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();
4213 nodes[1].node.send_payment(&route, first_payment_hash, &Some(first_payment_secret)).unwrap();
4215 assert_eq!(nodes[1].node.get_and_clear_pending_msg_events().len(), 1);
4216 check_added_monitors!(nodes[1], 1);
4218 // Now attempt to route a second payment, which should be placed in the holding cell
4219 let (_, second_payment_hash, second_payment_secret) = get_payment_preimage_hash!(nodes[2]);
4221 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
4222 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();
4223 nodes[0].node.send_payment(&route, second_payment_hash, &Some(first_payment_secret)).unwrap();
4224 check_added_monitors!(nodes[0], 1);
4225 let payment_event = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
4226 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
4227 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
4228 expect_pending_htlcs_forwardable!(nodes[1]);
4229 check_added_monitors!(nodes[1], 0);
4231 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
4232 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();
4233 nodes[1].node.send_payment(&route, second_payment_hash, &Some(second_payment_secret)).unwrap();
4234 check_added_monitors!(nodes[1], 0);
4237 connect_blocks(&nodes[1], TEST_FINAL_CLTV - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS);
4238 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4239 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
4240 connect_blocks(&nodes[1], 1);
4243 expect_pending_htlcs_forwardable!(nodes[1]);
4244 check_added_monitors!(nodes[1], 1);
4245 let fail_commit = nodes[1].node.get_and_clear_pending_msg_events();
4246 assert_eq!(fail_commit.len(), 1);
4247 match fail_commit[0] {
4248 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fail_htlcs, ref commitment_signed, .. }, .. } => {
4249 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
4250 commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, true, true);
4252 _ => unreachable!(),
4254 expect_payment_failed!(nodes[0], second_payment_hash, false);
4255 expect_payment_failure_chan_update!(nodes[0], chan_2.0.contents.short_channel_id, false);
4257 expect_payment_failed!(nodes[1], second_payment_hash, true);
4262 fn test_holding_cell_htlc_add_timeouts() {
4263 do_test_holding_cell_htlc_add_timeouts(false);
4264 do_test_holding_cell_htlc_add_timeouts(true);
4268 fn test_invalid_channel_announcement() {
4269 //Test BOLT 7 channel_announcement msg requirement for final node, gather data to build customed channel_announcement msgs
4270 let secp_ctx = Secp256k1::new();
4271 let chanmon_cfgs = create_chanmon_cfgs(2);
4272 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4273 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4274 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4276 let chan_announcement = create_chan_between_nodes(&nodes[0], &nodes[1], InitFeatures::known(), InitFeatures::known());
4278 let a_channel_lock = nodes[0].node.channel_state.lock().unwrap();
4279 let b_channel_lock = nodes[1].node.channel_state.lock().unwrap();
4280 let as_chan = a_channel_lock.by_id.get(&chan_announcement.3).unwrap();
4281 let bs_chan = b_channel_lock.by_id.get(&chan_announcement.3).unwrap();
4283 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 } );
4285 let as_bitcoin_key = as_chan.get_signer().inner.holder_channel_pubkeys.funding_pubkey;
4286 let bs_bitcoin_key = bs_chan.get_signer().inner.holder_channel_pubkeys.funding_pubkey;
4288 let as_network_key = nodes[0].node.get_our_node_id();
4289 let bs_network_key = nodes[1].node.get_our_node_id();
4291 let were_node_one = as_bitcoin_key.serialize()[..] < bs_bitcoin_key.serialize()[..];
4293 let mut chan_announcement;
4295 macro_rules! dummy_unsigned_msg {
4297 msgs::UnsignedChannelAnnouncement {
4298 features: ChannelFeatures::known(),
4299 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
4300 short_channel_id: as_chan.get_short_channel_id().unwrap(),
4301 node_id_1: if were_node_one { as_network_key } else { bs_network_key },
4302 node_id_2: if were_node_one { bs_network_key } else { as_network_key },
4303 bitcoin_key_1: if were_node_one { as_bitcoin_key } else { bs_bitcoin_key },
4304 bitcoin_key_2: if were_node_one { bs_bitcoin_key } else { as_bitcoin_key },
4305 excess_data: Vec::new(),
4310 macro_rules! sign_msg {
4311 ($unsigned_msg: expr) => {
4312 let msghash = Message::from_slice(&Sha256dHash::hash(&$unsigned_msg.encode()[..])[..]).unwrap();
4313 let as_bitcoin_sig = secp_ctx.sign(&msghash, &as_chan.get_signer().inner.funding_key);
4314 let bs_bitcoin_sig = secp_ctx.sign(&msghash, &bs_chan.get_signer().inner.funding_key);
4315 let as_node_sig = secp_ctx.sign(&msghash, &nodes[0].keys_manager.get_node_secret());
4316 let bs_node_sig = secp_ctx.sign(&msghash, &nodes[1].keys_manager.get_node_secret());
4317 chan_announcement = msgs::ChannelAnnouncement {
4318 node_signature_1 : if were_node_one { as_node_sig } else { bs_node_sig},
4319 node_signature_2 : if were_node_one { bs_node_sig } else { as_node_sig},
4320 bitcoin_signature_1: if were_node_one { as_bitcoin_sig } else { bs_bitcoin_sig },
4321 bitcoin_signature_2 : if were_node_one { bs_bitcoin_sig } else { as_bitcoin_sig },
4322 contents: $unsigned_msg
4327 let unsigned_msg = dummy_unsigned_msg!();
4328 sign_msg!(unsigned_msg);
4329 assert_eq!(nodes[0].net_graph_msg_handler.handle_channel_announcement(&chan_announcement).unwrap(), true);
4330 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 } );
4332 // Configured with Network::Testnet
4333 let mut unsigned_msg = dummy_unsigned_msg!();
4334 unsigned_msg.chain_hash = genesis_block(Network::Bitcoin).header.block_hash();
4335 sign_msg!(unsigned_msg);
4336 assert!(nodes[0].net_graph_msg_handler.handle_channel_announcement(&chan_announcement).is_err());
4338 let mut unsigned_msg = dummy_unsigned_msg!();
4339 unsigned_msg.chain_hash = BlockHash::hash(&[1,2,3,4,5,6,7,8,9]);
4340 sign_msg!(unsigned_msg);
4341 assert!(nodes[0].net_graph_msg_handler.handle_channel_announcement(&chan_announcement).is_err());
4345 fn test_no_txn_manager_serialize_deserialize() {
4346 let chanmon_cfgs = create_chanmon_cfgs(2);
4347 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4348 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4349 let logger: test_utils::TestLogger;
4350 let fee_estimator: test_utils::TestFeeEstimator;
4351 let persister: test_utils::TestPersister;
4352 let new_chain_monitor: test_utils::TestChainMonitor;
4353 let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4354 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4356 let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
4358 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4360 let nodes_0_serialized = nodes[0].node.encode();
4361 let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4362 nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
4364 logger = test_utils::TestLogger::new();
4365 fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
4366 persister = test_utils::TestPersister::new();
4367 let keys_manager = &chanmon_cfgs[0].keys_manager;
4368 new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator, &persister, keys_manager);
4369 nodes[0].chain_monitor = &new_chain_monitor;
4370 let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4371 let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
4372 &mut chan_0_monitor_read, keys_manager).unwrap();
4373 assert!(chan_0_monitor_read.is_empty());
4375 let mut nodes_0_read = &nodes_0_serialized[..];
4376 let config = UserConfig::default();
4377 let (_, nodes_0_deserialized_tmp) = {
4378 let mut channel_monitors = HashMap::new();
4379 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4380 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4381 default_config: config,
4383 fee_estimator: &fee_estimator,
4384 chain_monitor: nodes[0].chain_monitor,
4385 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4390 nodes_0_deserialized = nodes_0_deserialized_tmp;
4391 assert!(nodes_0_read.is_empty());
4393 assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4394 nodes[0].node = &nodes_0_deserialized;
4395 assert_eq!(nodes[0].node.list_channels().len(), 1);
4396 check_added_monitors!(nodes[0], 1);
4398 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4399 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
4400 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4401 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
4403 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
4404 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4405 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
4406 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4408 let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
4409 let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
4410 for node in nodes.iter() {
4411 assert!(node.net_graph_msg_handler.handle_channel_announcement(&announcement).unwrap());
4412 node.net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
4413 node.net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
4416 send_payment(&nodes[0], &[&nodes[1]], 1000000);
4420 fn test_dup_htlc_onchain_fails_on_reload() {
4421 // When a Channel is closed, any outbound HTLCs which were relayed through it are simply
4422 // dropped when the Channel is. From there, the ChannelManager relies on the ChannelMonitor
4423 // having a copy of the relevant fail-/claim-back data and processes the HTLC fail/claim when
4424 // the ChannelMonitor tells it to.
4426 // If, due to an on-chain event, an HTLC is failed/claimed, and then we serialize the
4427 // ChannelManager, we generally expect there not to be a duplicate HTLC fail/claim (eg via a
4428 // PaymentFailed event appearing). However, because we may not serialize the relevant
4429 // ChannelMonitor at the same time, this isn't strictly guaranteed. In order to provide this
4430 // consistency, the ChannelManager explicitly tracks pending-onchain-resolution outbound HTLCs
4431 // and de-duplicates ChannelMonitor events.
4433 // This tests that explicit tracking behavior.
4434 let chanmon_cfgs = create_chanmon_cfgs(2);
4435 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4436 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4437 let persister: test_utils::TestPersister;
4438 let new_chain_monitor: test_utils::TestChainMonitor;
4439 let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4440 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4442 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4444 // Route a payment, but force-close the channel before the HTLC fulfill message arrives at
4446 let (payment_preimage, _, _) = route_payment(&nodes[0], &[&nodes[1]], 10000000);
4447 nodes[0].node.force_close_channel(&nodes[0].node.list_channels()[0].channel_id).unwrap();
4448 check_closed_broadcast!(nodes[0], true);
4449 check_added_monitors!(nodes[0], 1);
4451 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
4452 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4454 // Connect blocks until the CLTV timeout is up so that we get an HTLC-Timeout transaction
4455 connect_blocks(&nodes[0], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + 1);
4456 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
4457 assert_eq!(node_txn.len(), 3);
4458 assert_eq!(node_txn[0], node_txn[1]);
4460 assert!(nodes[1].node.claim_funds(payment_preimage));
4461 check_added_monitors!(nodes[1], 1);
4463 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4464 connect_block(&nodes[1], &Block { header, txdata: vec![node_txn[1].clone(), node_txn[2].clone()]});
4465 check_closed_broadcast!(nodes[1], true);
4466 check_added_monitors!(nodes[1], 1);
4467 let claim_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
4469 header.prev_blockhash = nodes[0].best_block_hash();
4470 connect_block(&nodes[0], &Block { header, txdata: vec![node_txn[1].clone(), node_txn[2].clone()]});
4472 // Serialize out the ChannelMonitor before connecting the on-chain claim transactions. This is
4473 // fairly normal behavior as ChannelMonitor(s) are often not re-serialized when on-chain events
4474 // happen, unlike ChannelManager which tends to be re-serialized after any relevant event(s).
4475 let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4476 nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
4478 header.prev_blockhash = nodes[0].best_block_hash();
4479 let claim_block = Block { header, txdata: claim_txn};
4480 connect_block(&nodes[0], &claim_block);
4481 expect_payment_sent!(nodes[0], payment_preimage);
4483 // ChannelManagers generally get re-serialized after any relevant event(s). Since we just
4484 // connected a highly-relevant block, it likely gets serialized out now.
4485 let mut chan_manager_serialized = test_utils::TestVecWriter(Vec::new());
4486 nodes[0].node.write(&mut chan_manager_serialized).unwrap();
4488 // Now reload nodes[0]...
4489 persister = test_utils::TestPersister::new();
4490 let keys_manager = &chanmon_cfgs[0].keys_manager;
4491 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);
4492 nodes[0].chain_monitor = &new_chain_monitor;
4493 let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4494 let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
4495 &mut chan_0_monitor_read, keys_manager).unwrap();
4496 assert!(chan_0_monitor_read.is_empty());
4498 let (_, nodes_0_deserialized_tmp) = {
4499 let mut channel_monitors = HashMap::new();
4500 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4501 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>
4502 ::read(&mut std::io::Cursor::new(&chan_manager_serialized.0[..]), ChannelManagerReadArgs {
4503 default_config: Default::default(),
4505 fee_estimator: node_cfgs[0].fee_estimator,
4506 chain_monitor: nodes[0].chain_monitor,
4507 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4508 logger: nodes[0].logger,
4512 nodes_0_deserialized = nodes_0_deserialized_tmp;
4514 assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4515 check_added_monitors!(nodes[0], 1);
4516 nodes[0].node = &nodes_0_deserialized;
4518 // Note that if we re-connect the block which exposed nodes[0] to the payment preimage (but
4519 // which the current ChannelMonitor has not seen), the ChannelManager's de-duplication of
4520 // payment events should kick in, leaving us with no pending events here.
4521 let height = nodes[0].blocks.lock().unwrap().len() as u32 - 1;
4522 nodes[0].chain_monitor.chain_monitor.block_connected(&claim_block, height);
4523 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
4527 fn test_manager_serialize_deserialize_events() {
4528 // This test makes sure the events field in ChannelManager survives de/serialization
4529 let chanmon_cfgs = create_chanmon_cfgs(2);
4530 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4531 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4532 let fee_estimator: test_utils::TestFeeEstimator;
4533 let persister: test_utils::TestPersister;
4534 let logger: test_utils::TestLogger;
4535 let new_chain_monitor: test_utils::TestChainMonitor;
4536 let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4537 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4539 // Start creating a channel, but stop right before broadcasting the funding transaction
4540 let channel_value = 100000;
4541 let push_msat = 10001;
4542 let a_flags = InitFeatures::known();
4543 let b_flags = InitFeatures::known();
4544 let node_a = nodes.remove(0);
4545 let node_b = nodes.remove(0);
4546 node_a.node.create_channel(node_b.node.get_our_node_id(), channel_value, push_msat, 42, None).unwrap();
4547 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()));
4548 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()));
4550 let (temporary_channel_id, tx, funding_output) = create_funding_transaction(&node_a, channel_value, 42);
4552 node_a.node.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
4553 check_added_monitors!(node_a, 0);
4555 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()));
4557 let mut added_monitors = node_b.chain_monitor.added_monitors.lock().unwrap();
4558 assert_eq!(added_monitors.len(), 1);
4559 assert_eq!(added_monitors[0].0, funding_output);
4560 added_monitors.clear();
4563 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()));
4565 let mut added_monitors = node_a.chain_monitor.added_monitors.lock().unwrap();
4566 assert_eq!(added_monitors.len(), 1);
4567 assert_eq!(added_monitors[0].0, funding_output);
4568 added_monitors.clear();
4570 // Normally, this is where node_a would broadcast the funding transaction, but the test de/serializes first instead
4575 // Start the de/seriailization process mid-channel creation to check that the channel manager will hold onto events that are serialized
4576 let nodes_0_serialized = nodes[0].node.encode();
4577 let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4578 nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
4580 fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
4581 logger = test_utils::TestLogger::new();
4582 persister = test_utils::TestPersister::new();
4583 let keys_manager = &chanmon_cfgs[0].keys_manager;
4584 new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator, &persister, keys_manager);
4585 nodes[0].chain_monitor = &new_chain_monitor;
4586 let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4587 let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
4588 &mut chan_0_monitor_read, keys_manager).unwrap();
4589 assert!(chan_0_monitor_read.is_empty());
4591 let mut nodes_0_read = &nodes_0_serialized[..];
4592 let config = UserConfig::default();
4593 let (_, nodes_0_deserialized_tmp) = {
4594 let mut channel_monitors = HashMap::new();
4595 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4596 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4597 default_config: config,
4599 fee_estimator: &fee_estimator,
4600 chain_monitor: nodes[0].chain_monitor,
4601 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4606 nodes_0_deserialized = nodes_0_deserialized_tmp;
4607 assert!(nodes_0_read.is_empty());
4609 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4611 assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4612 nodes[0].node = &nodes_0_deserialized;
4614 // After deserializing, make sure the funding_transaction is still held by the channel manager
4615 let events_4 = nodes[0].node.get_and_clear_pending_events();
4616 assert_eq!(events_4.len(), 0);
4617 assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
4618 assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0].txid(), funding_output.txid);
4620 // Make sure the channel is functioning as though the de/serialization never happened
4621 assert_eq!(nodes[0].node.list_channels().len(), 1);
4622 check_added_monitors!(nodes[0], 1);
4624 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4625 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
4626 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4627 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
4629 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
4630 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4631 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
4632 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4634 let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
4635 let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
4636 for node in nodes.iter() {
4637 assert!(node.net_graph_msg_handler.handle_channel_announcement(&announcement).unwrap());
4638 node.net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
4639 node.net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
4642 send_payment(&nodes[0], &[&nodes[1]], 1000000);
4646 fn test_simple_manager_serialize_deserialize() {
4647 let chanmon_cfgs = create_chanmon_cfgs(2);
4648 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4649 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4650 let logger: test_utils::TestLogger;
4651 let fee_estimator: test_utils::TestFeeEstimator;
4652 let persister: test_utils::TestPersister;
4653 let new_chain_monitor: test_utils::TestChainMonitor;
4654 let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4655 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4656 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4658 let (our_payment_preimage, _, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
4659 let (_, our_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
4661 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4663 let nodes_0_serialized = nodes[0].node.encode();
4664 let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4665 nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
4667 logger = test_utils::TestLogger::new();
4668 fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
4669 persister = test_utils::TestPersister::new();
4670 let keys_manager = &chanmon_cfgs[0].keys_manager;
4671 new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator, &persister, keys_manager);
4672 nodes[0].chain_monitor = &new_chain_monitor;
4673 let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4674 let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
4675 &mut chan_0_monitor_read, keys_manager).unwrap();
4676 assert!(chan_0_monitor_read.is_empty());
4678 let mut nodes_0_read = &nodes_0_serialized[..];
4679 let (_, nodes_0_deserialized_tmp) = {
4680 let mut channel_monitors = HashMap::new();
4681 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4682 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4683 default_config: UserConfig::default(),
4685 fee_estimator: &fee_estimator,
4686 chain_monitor: nodes[0].chain_monitor,
4687 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4692 nodes_0_deserialized = nodes_0_deserialized_tmp;
4693 assert!(nodes_0_read.is_empty());
4695 assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4696 nodes[0].node = &nodes_0_deserialized;
4697 check_added_monitors!(nodes[0], 1);
4699 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
4701 fail_payment(&nodes[0], &[&nodes[1]], our_payment_hash);
4702 claim_payment(&nodes[0], &[&nodes[1]], our_payment_preimage);
4706 fn test_manager_serialize_deserialize_inconsistent_monitor() {
4707 // Test deserializing a ChannelManager with an out-of-date ChannelMonitor
4708 let chanmon_cfgs = create_chanmon_cfgs(4);
4709 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
4710 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
4711 let logger: test_utils::TestLogger;
4712 let fee_estimator: test_utils::TestFeeEstimator;
4713 let persister: test_utils::TestPersister;
4714 let new_chain_monitor: test_utils::TestChainMonitor;
4715 let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4716 let mut nodes = create_network(4, &node_cfgs, &node_chanmgrs);
4717 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4718 create_announced_chan_between_nodes(&nodes, 2, 0, InitFeatures::known(), InitFeatures::known());
4719 let (_, _, channel_id, funding_tx) = create_announced_chan_between_nodes(&nodes, 0, 3, InitFeatures::known(), InitFeatures::known());
4721 let mut node_0_stale_monitors_serialized = Vec::new();
4722 for monitor in nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter() {
4723 let mut writer = test_utils::TestVecWriter(Vec::new());
4724 monitor.1.write(&mut writer).unwrap();
4725 node_0_stale_monitors_serialized.push(writer.0);
4728 let (our_payment_preimage, _, _) = route_payment(&nodes[2], &[&nodes[0], &nodes[1]], 1000000);
4730 // Serialize the ChannelManager here, but the monitor we keep up-to-date
4731 let nodes_0_serialized = nodes[0].node.encode();
4733 route_payment(&nodes[0], &[&nodes[3]], 1000000);
4734 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4735 nodes[2].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4736 nodes[3].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4738 // Now the ChannelMonitor (which is now out-of-sync with ChannelManager for channel w/
4740 let mut node_0_monitors_serialized = Vec::new();
4741 for monitor in nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter() {
4742 let mut writer = test_utils::TestVecWriter(Vec::new());
4743 monitor.1.write(&mut writer).unwrap();
4744 node_0_monitors_serialized.push(writer.0);
4747 logger = test_utils::TestLogger::new();
4748 fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
4749 persister = test_utils::TestPersister::new();
4750 let keys_manager = &chanmon_cfgs[0].keys_manager;
4751 new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator, &persister, keys_manager);
4752 nodes[0].chain_monitor = &new_chain_monitor;
4755 let mut node_0_stale_monitors = Vec::new();
4756 for serialized in node_0_stale_monitors_serialized.iter() {
4757 let mut read = &serialized[..];
4758 let (_, monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(&mut read, keys_manager).unwrap();
4759 assert!(read.is_empty());
4760 node_0_stale_monitors.push(monitor);
4763 let mut node_0_monitors = Vec::new();
4764 for serialized in node_0_monitors_serialized.iter() {
4765 let mut read = &serialized[..];
4766 let (_, monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(&mut read, keys_manager).unwrap();
4767 assert!(read.is_empty());
4768 node_0_monitors.push(monitor);
4771 let mut nodes_0_read = &nodes_0_serialized[..];
4772 if let Err(msgs::DecodeError::InvalidValue) =
4773 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4774 default_config: UserConfig::default(),
4776 fee_estimator: &fee_estimator,
4777 chain_monitor: nodes[0].chain_monitor,
4778 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4780 channel_monitors: node_0_stale_monitors.iter_mut().map(|monitor| { (monitor.get_funding_txo().0, monitor) }).collect(),
4782 panic!("If the monitor(s) are stale, this indicates a bug and we should get an Err return");
4785 let mut nodes_0_read = &nodes_0_serialized[..];
4786 let (_, nodes_0_deserialized_tmp) =
4787 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4788 default_config: UserConfig::default(),
4790 fee_estimator: &fee_estimator,
4791 chain_monitor: nodes[0].chain_monitor,
4792 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4794 channel_monitors: node_0_monitors.iter_mut().map(|monitor| { (monitor.get_funding_txo().0, monitor) }).collect(),
4796 nodes_0_deserialized = nodes_0_deserialized_tmp;
4797 assert!(nodes_0_read.is_empty());
4799 { // Channel close should result in a commitment tx
4800 let txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4801 assert_eq!(txn.len(), 1);
4802 check_spends!(txn[0], funding_tx);
4803 assert_eq!(txn[0].input[0].previous_output.txid, funding_tx.txid());
4806 for monitor in node_0_monitors.drain(..) {
4807 assert!(nodes[0].chain_monitor.watch_channel(monitor.get_funding_txo().0, monitor).is_ok());
4808 check_added_monitors!(nodes[0], 1);
4810 nodes[0].node = &nodes_0_deserialized;
4812 // nodes[1] and nodes[2] have no lost state with nodes[0]...
4813 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
4814 reconnect_nodes(&nodes[0], &nodes[2], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
4815 //... and we can even still claim the payment!
4816 claim_payment(&nodes[2], &[&nodes[0], &nodes[1]], our_payment_preimage);
4818 nodes[3].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4819 let reestablish = get_event_msg!(nodes[3], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
4820 nodes[0].node.peer_connected(&nodes[3].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4821 nodes[0].node.handle_channel_reestablish(&nodes[3].node.get_our_node_id(), &reestablish);
4822 let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
4823 assert_eq!(msg_events.len(), 1);
4824 if let MessageSendEvent::HandleError { ref action, .. } = msg_events[0] {
4826 &ErrorAction::SendErrorMessage { ref msg } => {
4827 assert_eq!(msg.channel_id, channel_id);
4829 _ => panic!("Unexpected event!"),
4834 macro_rules! check_spendable_outputs {
4835 ($node: expr, $keysinterface: expr) => {
4837 let mut events = $node.chain_monitor.chain_monitor.get_and_clear_pending_events();
4838 let mut txn = Vec::new();
4839 let mut all_outputs = Vec::new();
4840 let secp_ctx = Secp256k1::new();
4841 for event in events.drain(..) {
4843 Event::SpendableOutputs { mut outputs } => {
4844 for outp in outputs.drain(..) {
4845 txn.push($keysinterface.backing.spend_spendable_outputs(&[&outp], Vec::new(), Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(), 253, &secp_ctx).unwrap());
4846 all_outputs.push(outp);
4849 _ => panic!("Unexpected event"),
4852 if all_outputs.len() > 1 {
4853 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) {
4863 fn test_claim_sizeable_push_msat() {
4864 // Incidentally test SpendableOutput event generation due to detection of to_local output on commitment tx
4865 let chanmon_cfgs = create_chanmon_cfgs(2);
4866 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4867 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4868 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4870 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 99000000, InitFeatures::known(), InitFeatures::known());
4871 nodes[1].node.force_close_channel(&chan.2).unwrap();
4872 check_closed_broadcast!(nodes[1], true);
4873 check_added_monitors!(nodes[1], 1);
4874 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4875 assert_eq!(node_txn.len(), 1);
4876 check_spends!(node_txn[0], chan.3);
4877 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
4879 mine_transaction(&nodes[1], &node_txn[0]);
4880 connect_blocks(&nodes[1], BREAKDOWN_TIMEOUT as u32 - 1);
4882 let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
4883 assert_eq!(spend_txn.len(), 1);
4884 assert_eq!(spend_txn[0].input.len(), 1);
4885 check_spends!(spend_txn[0], node_txn[0]);
4886 assert_eq!(spend_txn[0].input[0].sequence, BREAKDOWN_TIMEOUT as u32);
4890 fn test_claim_on_remote_sizeable_push_msat() {
4891 // Same test as previous, just test on remote commitment tx, as per_commitment_point registration changes following you're funder/fundee and
4892 // to_remote output is encumbered by a P2WPKH
4893 let chanmon_cfgs = create_chanmon_cfgs(2);
4894 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4895 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4896 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4898 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 99000000, InitFeatures::known(), InitFeatures::known());
4899 nodes[0].node.force_close_channel(&chan.2).unwrap();
4900 check_closed_broadcast!(nodes[0], true);
4901 check_added_monitors!(nodes[0], 1);
4903 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4904 assert_eq!(node_txn.len(), 1);
4905 check_spends!(node_txn[0], chan.3);
4906 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
4908 mine_transaction(&nodes[1], &node_txn[0]);
4909 check_closed_broadcast!(nodes[1], true);
4910 check_added_monitors!(nodes[1], 1);
4911 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4913 let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
4914 assert_eq!(spend_txn.len(), 1);
4915 check_spends!(spend_txn[0], node_txn[0]);
4919 fn test_claim_on_remote_revoked_sizeable_push_msat() {
4920 // Same test as previous, just test on remote revoked commitment tx, as per_commitment_point registration changes following you're funder/fundee and
4921 // to_remote output is encumbered by a P2WPKH
4923 let chanmon_cfgs = create_chanmon_cfgs(2);
4924 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4925 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4926 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4928 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 59000000, InitFeatures::known(), InitFeatures::known());
4929 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4930 let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan.2);
4931 assert_eq!(revoked_local_txn[0].input.len(), 1);
4932 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
4934 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
4935 mine_transaction(&nodes[1], &revoked_local_txn[0]);
4936 check_closed_broadcast!(nodes[1], true);
4937 check_added_monitors!(nodes[1], 1);
4939 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4940 mine_transaction(&nodes[1], &node_txn[0]);
4941 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4943 let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
4944 assert_eq!(spend_txn.len(), 3);
4945 check_spends!(spend_txn[0], revoked_local_txn[0]); // to_remote output on revoked remote commitment_tx
4946 check_spends!(spend_txn[1], node_txn[0]);
4947 check_spends!(spend_txn[2], revoked_local_txn[0], node_txn[0]); // Both outputs
4951 fn test_static_spendable_outputs_preimage_tx() {
4952 let chanmon_cfgs = create_chanmon_cfgs(2);
4953 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4954 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4955 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4957 // Create some initial channels
4958 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4960 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4962 let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
4963 assert_eq!(commitment_tx[0].input.len(), 1);
4964 assert_eq!(commitment_tx[0].input[0].previous_output.txid, chan_1.3.txid());
4966 // Settle A's commitment tx on B's chain
4967 assert!(nodes[1].node.claim_funds(payment_preimage));
4968 check_added_monitors!(nodes[1], 1);
4969 mine_transaction(&nodes[1], &commitment_tx[0]);
4970 check_added_monitors!(nodes[1], 1);
4971 let events = nodes[1].node.get_and_clear_pending_msg_events();
4973 MessageSendEvent::UpdateHTLCs { .. } => {},
4974 _ => panic!("Unexpected event"),
4977 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
4978 _ => panic!("Unexepected event"),
4981 // Check B's monitor was able to send back output descriptor event for preimage tx on A's commitment tx
4982 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap(); // ChannelManager : 2 (local commitment tx + HTLC-Success), ChannelMonitor: preimage tx
4983 assert_eq!(node_txn.len(), 3);
4984 check_spends!(node_txn[0], commitment_tx[0]);
4985 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
4986 check_spends!(node_txn[1], chan_1.3);
4987 check_spends!(node_txn[2], node_txn[1]);
4989 mine_transaction(&nodes[1], &node_txn[0]);
4990 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4992 let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
4993 assert_eq!(spend_txn.len(), 1);
4994 check_spends!(spend_txn[0], node_txn[0]);
4998 fn test_static_spendable_outputs_timeout_tx() {
4999 let chanmon_cfgs = create_chanmon_cfgs(2);
5000 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5001 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5002 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5004 // Create some initial channels
5005 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5007 // Rebalance the network a bit by relaying one payment through all the channels ...
5008 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
5010 let (_, our_payment_hash, _) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3_000_000);
5012 let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
5013 assert_eq!(commitment_tx[0].input.len(), 1);
5014 assert_eq!(commitment_tx[0].input[0].previous_output.txid, chan_1.3.txid());
5016 // Settle A's commitment tx on B' chain
5017 mine_transaction(&nodes[1], &commitment_tx[0]);
5018 check_added_monitors!(nodes[1], 1);
5019 let events = nodes[1].node.get_and_clear_pending_msg_events();
5021 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5022 _ => panic!("Unexpected event"),
5024 connect_blocks(&nodes[1], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
5026 // Check B's monitor was able to send back output descriptor event for timeout tx on A's commitment tx
5027 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
5028 assert_eq!(node_txn.len(), 2); // ChannelManager : 1 local commitent tx, ChannelMonitor: timeout tx
5029 check_spends!(node_txn[0], chan_1.3.clone());
5030 check_spends!(node_txn[1], commitment_tx[0].clone());
5031 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5033 mine_transaction(&nodes[1], &node_txn[1]);
5034 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
5035 expect_payment_failed!(nodes[1], our_payment_hash, true);
5037 let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
5038 assert_eq!(spend_txn.len(), 3); // SpendableOutput: remote_commitment_tx.to_remote, timeout_tx.output
5039 check_spends!(spend_txn[0], commitment_tx[0]);
5040 check_spends!(spend_txn[1], node_txn[1]);
5041 check_spends!(spend_txn[2], node_txn[1], commitment_tx[0]); // All outputs
5045 fn test_static_spendable_outputs_justice_tx_revoked_commitment_tx() {
5046 let chanmon_cfgs = create_chanmon_cfgs(2);
5047 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5048 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5049 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5051 // Create some initial channels
5052 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5054 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
5055 let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
5056 assert_eq!(revoked_local_txn[0].input.len(), 1);
5057 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
5059 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
5061 mine_transaction(&nodes[1], &revoked_local_txn[0]);
5062 check_closed_broadcast!(nodes[1], true);
5063 check_added_monitors!(nodes[1], 1);
5065 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5066 assert_eq!(node_txn.len(), 2);
5067 assert_eq!(node_txn[0].input.len(), 2);
5068 check_spends!(node_txn[0], revoked_local_txn[0]);
5070 mine_transaction(&nodes[1], &node_txn[0]);
5071 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
5073 let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
5074 assert_eq!(spend_txn.len(), 1);
5075 check_spends!(spend_txn[0], node_txn[0]);
5079 fn test_static_spendable_outputs_justice_tx_revoked_htlc_timeout_tx() {
5080 let mut chanmon_cfgs = create_chanmon_cfgs(2);
5081 chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
5082 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5083 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5084 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5086 // Create some initial channels
5087 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5089 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
5090 let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
5091 assert_eq!(revoked_local_txn[0].input.len(), 1);
5092 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
5094 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
5096 // A will generate HTLC-Timeout from revoked commitment tx
5097 mine_transaction(&nodes[0], &revoked_local_txn[0]);
5098 check_closed_broadcast!(nodes[0], true);
5099 check_added_monitors!(nodes[0], 1);
5100 connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
5102 let revoked_htlc_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5103 assert_eq!(revoked_htlc_txn.len(), 2);
5104 check_spends!(revoked_htlc_txn[0], chan_1.3);
5105 assert_eq!(revoked_htlc_txn[1].input.len(), 1);
5106 assert_eq!(revoked_htlc_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5107 check_spends!(revoked_htlc_txn[1], revoked_local_txn[0]);
5108 assert_ne!(revoked_htlc_txn[1].lock_time, 0); // HTLC-Timeout
5110 // B will generate justice tx from A's revoked commitment/HTLC tx
5111 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5112 connect_block(&nodes[1], &Block { header, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[1].clone()] });
5113 check_closed_broadcast!(nodes[1], true);
5114 check_added_monitors!(nodes[1], 1);
5116 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5117 assert_eq!(node_txn.len(), 3); // ChannelMonitor: bogus justice tx, justice tx on revoked outputs, ChannelManager: local commitment tx
5118 // The first transaction generated is bogus - it spends both outputs of revoked_local_txn[0]
5119 // including the one already spent by revoked_htlc_txn[1]. That's OK, we'll spend with valid
5120 // transactions next...
5121 assert_eq!(node_txn[0].input.len(), 3);
5122 check_spends!(node_txn[0], revoked_local_txn[0], revoked_htlc_txn[1]);
5124 assert_eq!(node_txn[1].input.len(), 2);
5125 check_spends!(node_txn[1], revoked_local_txn[0], revoked_htlc_txn[1]);
5126 if node_txn[1].input[1].previous_output.txid == revoked_htlc_txn[1].txid() {
5127 assert_ne!(node_txn[1].input[0].previous_output, revoked_htlc_txn[1].input[0].previous_output);
5129 assert_eq!(node_txn[1].input[0].previous_output.txid, revoked_htlc_txn[1].txid());
5130 assert_ne!(node_txn[1].input[1].previous_output, revoked_htlc_txn[1].input[0].previous_output);
5133 assert_eq!(node_txn[2].input.len(), 1);
5134 check_spends!(node_txn[2], chan_1.3);
5136 mine_transaction(&nodes[1], &node_txn[1]);
5137 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
5139 // Check B's ChannelMonitor was able to generate the right spendable output descriptor
5140 let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
5141 assert_eq!(spend_txn.len(), 1);
5142 assert_eq!(spend_txn[0].input.len(), 1);
5143 check_spends!(spend_txn[0], node_txn[1]);
5147 fn test_static_spendable_outputs_justice_tx_revoked_htlc_success_tx() {
5148 let mut chanmon_cfgs = create_chanmon_cfgs(2);
5149 chanmon_cfgs[1].keys_manager.disable_revocation_policy_check = true;
5150 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5151 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5152 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5154 // Create some initial channels
5155 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5157 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
5158 let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan_1.2);
5159 assert_eq!(revoked_local_txn[0].input.len(), 1);
5160 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
5162 // The to-be-revoked commitment tx should have one HTLC and one to_remote output
5163 assert_eq!(revoked_local_txn[0].output.len(), 2);
5165 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
5167 // B will generate HTLC-Success from revoked commitment tx
5168 mine_transaction(&nodes[1], &revoked_local_txn[0]);
5169 check_closed_broadcast!(nodes[1], true);
5170 check_added_monitors!(nodes[1], 1);
5171 let revoked_htlc_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5173 assert_eq!(revoked_htlc_txn.len(), 2);
5174 assert_eq!(revoked_htlc_txn[0].input.len(), 1);
5175 assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5176 check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
5178 // Check that the unspent (of two) outputs on revoked_local_txn[0] is a P2WPKH:
5179 let unspent_local_txn_output = revoked_htlc_txn[0].input[0].previous_output.vout as usize ^ 1;
5180 assert_eq!(revoked_local_txn[0].output[unspent_local_txn_output].script_pubkey.len(), 2 + 20); // P2WPKH
5182 // A will generate justice tx from B's revoked commitment/HTLC tx
5183 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5184 connect_block(&nodes[0], &Block { header, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[0].clone()] });
5185 check_closed_broadcast!(nodes[0], true);
5186 check_added_monitors!(nodes[0], 1);
5188 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5189 assert_eq!(node_txn.len(), 3); // ChannelMonitor: justice tx on revoked commitment, justice tx on revoked HTLC-success, ChannelManager: local commitment tx
5191 // The first transaction generated is bogus - it spends both outputs of revoked_local_txn[0]
5192 // including the one already spent by revoked_htlc_txn[0]. That's OK, we'll spend with valid
5193 // transactions next...
5194 assert_eq!(node_txn[0].input.len(), 2);
5195 check_spends!(node_txn[0], revoked_local_txn[0], revoked_htlc_txn[0]);
5196 if node_txn[0].input[1].previous_output.txid == revoked_htlc_txn[0].txid() {
5197 assert_eq!(node_txn[0].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
5199 assert_eq!(node_txn[0].input[0].previous_output.txid, revoked_htlc_txn[0].txid());
5200 assert_eq!(node_txn[0].input[1].previous_output, revoked_htlc_txn[0].input[0].previous_output);
5203 assert_eq!(node_txn[1].input.len(), 1);
5204 check_spends!(node_txn[1], revoked_htlc_txn[0]);
5206 check_spends!(node_txn[2], chan_1.3);
5208 mine_transaction(&nodes[0], &node_txn[1]);
5209 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
5211 // Note that nodes[0]'s tx_broadcaster is still locked, so if we get here the channelmonitor
5212 // didn't try to generate any new transactions.
5214 // Check A's ChannelMonitor was able to generate the right spendable output descriptor
5215 let spend_txn = check_spendable_outputs!(nodes[0], node_cfgs[0].keys_manager);
5216 assert_eq!(spend_txn.len(), 3);
5217 assert_eq!(spend_txn[0].input.len(), 1);
5218 check_spends!(spend_txn[0], revoked_local_txn[0]); // spending to_remote output from revoked local tx
5219 assert_ne!(spend_txn[0].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
5220 check_spends!(spend_txn[1], node_txn[1]); // spending justice tx output on the htlc success tx
5221 check_spends!(spend_txn[2], revoked_local_txn[0], node_txn[1]); // Both outputs
5225 fn test_onchain_to_onchain_claim() {
5226 // Test that in case of channel closure, we detect the state of output and claim HTLC
5227 // on downstream peer's remote commitment tx.
5228 // First, have C claim an HTLC against its own latest commitment transaction.
5229 // Then, broadcast these to B, which should update the monitor downstream on the A<->B
5231 // Finally, check that B will claim the HTLC output if A's latest commitment transaction
5234 let chanmon_cfgs = create_chanmon_cfgs(3);
5235 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5236 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5237 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5239 // Create some initial channels
5240 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5241 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
5243 // Ensure all nodes are at the same height
5244 let node_max_height = nodes.iter().map(|node| node.blocks.lock().unwrap().len()).max().unwrap() as u32;
5245 connect_blocks(&nodes[0], node_max_height - nodes[0].best_block_info().1);
5246 connect_blocks(&nodes[1], node_max_height - nodes[1].best_block_info().1);
5247 connect_blocks(&nodes[2], node_max_height - nodes[2].best_block_info().1);
5249 // Rebalance the network a bit by relaying one payment through all the channels ...
5250 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
5251 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
5253 let (payment_preimage, _payment_hash, _payment_secret) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
5254 let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
5255 check_spends!(commitment_tx[0], chan_2.3);
5256 nodes[2].node.claim_funds(payment_preimage);
5257 check_added_monitors!(nodes[2], 1);
5258 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
5259 assert!(updates.update_add_htlcs.is_empty());
5260 assert!(updates.update_fail_htlcs.is_empty());
5261 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
5262 assert!(updates.update_fail_malformed_htlcs.is_empty());
5264 mine_transaction(&nodes[2], &commitment_tx[0]);
5265 check_closed_broadcast!(nodes[2], true);
5266 check_added_monitors!(nodes[2], 1);
5268 let c_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 2 (commitment tx, HTLC-Success tx), ChannelMonitor : 1 (HTLC-Success tx)
5269 assert_eq!(c_txn.len(), 3);
5270 assert_eq!(c_txn[0], c_txn[2]);
5271 assert_eq!(commitment_tx[0], c_txn[1]);
5272 check_spends!(c_txn[1], chan_2.3);
5273 check_spends!(c_txn[2], c_txn[1]);
5274 assert_eq!(c_txn[1].input[0].witness.clone().last().unwrap().len(), 71);
5275 assert_eq!(c_txn[2].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5276 assert!(c_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
5277 assert_eq!(c_txn[0].lock_time, 0); // Success tx
5279 // 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
5280 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
5281 connect_block(&nodes[1], &Block { header, txdata: vec![c_txn[1].clone(), c_txn[2].clone()]});
5282 connect_blocks(&nodes[1], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
5284 let mut b_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5285 // ChannelMonitor: claim tx, ChannelManager: local commitment tx
5286 assert_eq!(b_txn.len(), 2);
5287 check_spends!(b_txn[0], chan_2.3); // B local commitment tx, issued by ChannelManager
5288 check_spends!(b_txn[1], c_txn[1]); // timeout tx on C remote commitment tx, issued by ChannelMonitor
5289 assert_eq!(b_txn[1].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5290 assert!(b_txn[1].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
5291 assert_ne!(b_txn[1].lock_time, 0); // Timeout tx
5294 check_added_monitors!(nodes[1], 1);
5295 let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
5296 assert_eq!(msg_events.len(), 3);
5297 check_added_monitors!(nodes[1], 1);
5298 match msg_events[0] {
5299 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5300 _ => panic!("Unexpected event"),
5302 match msg_events[1] {
5303 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { .. }, node_id: _ } => {},
5304 _ => panic!("Unexpected event"),
5306 match msg_events[2] {
5307 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, .. } } => {
5308 assert!(update_add_htlcs.is_empty());
5309 assert!(update_fail_htlcs.is_empty());
5310 assert_eq!(update_fulfill_htlcs.len(), 1);
5311 assert!(update_fail_malformed_htlcs.is_empty());
5312 assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
5314 _ => panic!("Unexpected event"),
5316 // Broadcast A's commitment tx on B's chain to see if we are able to claim inbound HTLC with our HTLC-Success tx
5317 let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
5318 mine_transaction(&nodes[1], &commitment_tx[0]);
5319 let b_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5320 // ChannelMonitor: HTLC-Success tx + HTLC-Timeout RBF Bump, ChannelManager: local commitment tx + HTLC-Success tx
5321 assert_eq!(b_txn.len(), 4);
5322 check_spends!(b_txn[2], chan_1.3);
5323 check_spends!(b_txn[3], b_txn[2]);
5324 let (htlc_success_claim, htlc_timeout_bumped) =
5325 if b_txn[0].input[0].previous_output.txid == commitment_tx[0].txid()
5326 { (&b_txn[0], &b_txn[1]) } else { (&b_txn[1], &b_txn[0]) };
5327 check_spends!(htlc_success_claim, commitment_tx[0]);
5328 assert_eq!(htlc_success_claim.input[0].witness.clone().last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5329 assert!(htlc_success_claim.output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
5330 assert_eq!(htlc_success_claim.lock_time, 0); // Success tx
5331 check_spends!(htlc_timeout_bumped, c_txn[1]); // timeout tx on C remote commitment tx, issued by ChannelMonitor
5332 assert_ne!(htlc_timeout_bumped.lock_time, 0); // Success tx
5334 check_closed_broadcast!(nodes[1], true);
5335 check_added_monitors!(nodes[1], 1);
5339 fn test_duplicate_payment_hash_one_failure_one_success() {
5340 // Topology : A --> B --> C --> D
5341 // We route 2 payments with same hash between B and C, one will be timeout, the other successfully claim
5342 // Note that because C will refuse to generate two payment secrets for the same payment hash,
5343 // we forward one of the payments onwards to D.
5344 let chanmon_cfgs = create_chanmon_cfgs(4);
5345 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
5346 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
5347 let mut nodes = create_network(4, &node_cfgs, &node_chanmgrs);
5349 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5350 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
5351 create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
5353 let node_max_height = nodes.iter().map(|node| node.blocks.lock().unwrap().len()).max().unwrap() as u32;
5354 connect_blocks(&nodes[0], node_max_height - nodes[0].best_block_info().1);
5355 connect_blocks(&nodes[1], node_max_height - nodes[1].best_block_info().1);
5356 connect_blocks(&nodes[2], node_max_height - nodes[2].best_block_info().1);
5357 connect_blocks(&nodes[3], node_max_height - nodes[3].best_block_info().1);
5359 let (our_payment_preimage, duplicate_payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 900000);
5361 let payment_secret = nodes[3].node.create_inbound_payment_for_hash(duplicate_payment_hash, None, 7200, 0).unwrap();
5362 // We reduce the final CLTV here by a somewhat arbitrary constant to keep it under the one-byte
5363 // script push size limit so that the below script length checks match
5364 // ACCEPTED_HTLC_SCRIPT_WEIGHT.
5365 let route = get_route(&nodes[0].node.get_our_node_id(), &nodes[0].net_graph_msg_handler.network_graph.read().unwrap(),
5366 &nodes[3].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 900000, TEST_FINAL_CLTV - 40, nodes[0].logger).unwrap();
5367 send_along_route_with_secret(&nodes[0], route, &[&[&nodes[1], &nodes[2], &nodes[3]]], 900000, duplicate_payment_hash, payment_secret);
5369 let commitment_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
5370 assert_eq!(commitment_txn[0].input.len(), 1);
5371 check_spends!(commitment_txn[0], chan_2.3);
5373 mine_transaction(&nodes[1], &commitment_txn[0]);
5374 check_closed_broadcast!(nodes[1], true);
5375 check_added_monitors!(nodes[1], 1);
5376 connect_blocks(&nodes[1], TEST_FINAL_CLTV - 40 + MIN_CLTV_EXPIRY_DELTA as u32 - 1); // Confirm blocks until the HTLC expires
5378 let htlc_timeout_tx;
5379 { // Extract one of the two HTLC-Timeout transaction
5380 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5381 // ChannelMonitor: timeout tx * 3, ChannelManager: local commitment tx
5382 assert_eq!(node_txn.len(), 4);
5383 check_spends!(node_txn[0], chan_2.3);
5385 check_spends!(node_txn[1], commitment_txn[0]);
5386 assert_eq!(node_txn[1].input.len(), 1);
5387 check_spends!(node_txn[2], commitment_txn[0]);
5388 assert_eq!(node_txn[2].input.len(), 1);
5389 assert_eq!(node_txn[1].input[0].previous_output, node_txn[2].input[0].previous_output);
5390 check_spends!(node_txn[3], commitment_txn[0]);
5391 assert_ne!(node_txn[1].input[0].previous_output, node_txn[3].input[0].previous_output);
5393 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5394 assert_eq!(node_txn[2].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5395 assert_eq!(node_txn[3].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5396 htlc_timeout_tx = node_txn[1].clone();
5399 nodes[2].node.claim_funds(our_payment_preimage);
5400 mine_transaction(&nodes[2], &commitment_txn[0]);
5401 check_added_monitors!(nodes[2], 2);
5402 let events = nodes[2].node.get_and_clear_pending_msg_events();
5404 MessageSendEvent::UpdateHTLCs { .. } => {},
5405 _ => panic!("Unexpected event"),
5408 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5409 _ => panic!("Unexepected event"),
5411 let htlc_success_txn: Vec<_> = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
5412 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)
5413 check_spends!(htlc_success_txn[0], commitment_txn[0]);
5414 check_spends!(htlc_success_txn[1], commitment_txn[0]);
5415 assert_eq!(htlc_success_txn[0].input.len(), 1);
5416 assert_eq!(htlc_success_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5417 assert_eq!(htlc_success_txn[1].input.len(), 1);
5418 assert_eq!(htlc_success_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5419 assert_ne!(htlc_success_txn[0].input[0].previous_output, htlc_success_txn[1].input[0].previous_output);
5420 assert_eq!(htlc_success_txn[2], commitment_txn[0]);
5421 assert_eq!(htlc_success_txn[3], htlc_success_txn[0]);
5422 assert_eq!(htlc_success_txn[4], htlc_success_txn[1]);
5423 assert_ne!(htlc_success_txn[0].input[0].previous_output, htlc_timeout_tx.input[0].previous_output);
5425 mine_transaction(&nodes[1], &htlc_timeout_tx);
5426 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
5427 expect_pending_htlcs_forwardable!(nodes[1]);
5428 let htlc_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5429 assert!(htlc_updates.update_add_htlcs.is_empty());
5430 assert_eq!(htlc_updates.update_fail_htlcs.len(), 1);
5431 let first_htlc_id = htlc_updates.update_fail_htlcs[0].htlc_id;
5432 assert!(htlc_updates.update_fulfill_htlcs.is_empty());
5433 assert!(htlc_updates.update_fail_malformed_htlcs.is_empty());
5434 check_added_monitors!(nodes[1], 1);
5436 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_updates.update_fail_htlcs[0]);
5437 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
5439 commitment_signed_dance!(nodes[0], nodes[1], &htlc_updates.commitment_signed, false, true);
5440 expect_payment_failure_chan_update!(nodes[0], chan_2.0.contents.short_channel_id, true);
5442 expect_payment_failed!(nodes[0], duplicate_payment_hash, false);
5444 // Solve 2nd HTLC by broadcasting on B's chain HTLC-Success Tx from C
5445 mine_transaction(&nodes[1], &htlc_success_txn[0]);
5446 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5447 assert!(updates.update_add_htlcs.is_empty());
5448 assert!(updates.update_fail_htlcs.is_empty());
5449 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
5450 assert_ne!(updates.update_fulfill_htlcs[0].htlc_id, first_htlc_id);
5451 assert!(updates.update_fail_malformed_htlcs.is_empty());
5452 check_added_monitors!(nodes[1], 1);
5454 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
5455 commitment_signed_dance!(nodes[0], nodes[1], &updates.commitment_signed, false);
5457 let events = nodes[0].node.get_and_clear_pending_events();
5459 Event::PaymentSent { ref payment_preimage } => {
5460 assert_eq!(*payment_preimage, our_payment_preimage);
5462 _ => panic!("Unexpected event"),
5467 fn test_dynamic_spendable_outputs_local_htlc_success_tx() {
5468 let chanmon_cfgs = create_chanmon_cfgs(2);
5469 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5470 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5471 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5473 // Create some initial channels
5474 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5476 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000).0;
5477 let local_txn = get_local_commitment_txn!(nodes[1], chan_1.2);
5478 assert_eq!(local_txn.len(), 1);
5479 assert_eq!(local_txn[0].input.len(), 1);
5480 check_spends!(local_txn[0], chan_1.3);
5482 // Give B knowledge of preimage to be able to generate a local HTLC-Success Tx
5483 nodes[1].node.claim_funds(payment_preimage);
5484 check_added_monitors!(nodes[1], 1);
5485 mine_transaction(&nodes[1], &local_txn[0]);
5486 check_added_monitors!(nodes[1], 1);
5487 let events = nodes[1].node.get_and_clear_pending_msg_events();
5489 MessageSendEvent::UpdateHTLCs { .. } => {},
5490 _ => panic!("Unexpected event"),
5493 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5494 _ => panic!("Unexepected event"),
5497 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5498 assert_eq!(node_txn.len(), 3);
5499 assert_eq!(node_txn[0], node_txn[2]);
5500 assert_eq!(node_txn[1], local_txn[0]);
5501 assert_eq!(node_txn[0].input.len(), 1);
5502 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5503 check_spends!(node_txn[0], local_txn[0]);
5507 mine_transaction(&nodes[1], &node_tx);
5508 connect_blocks(&nodes[1], BREAKDOWN_TIMEOUT as u32 - 1);
5510 // Verify that B is able to spend its own HTLC-Success tx thanks to spendable output event given back by its ChannelMonitor
5511 let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
5512 assert_eq!(spend_txn.len(), 1);
5513 assert_eq!(spend_txn[0].input.len(), 1);
5514 check_spends!(spend_txn[0], node_tx);
5515 assert_eq!(spend_txn[0].input[0].sequence, BREAKDOWN_TIMEOUT as u32);
5518 fn do_test_fail_backwards_unrevoked_remote_announce(deliver_last_raa: bool, announce_latest: bool) {
5519 // Test that we fail backwards the full set of HTLCs we need to when remote broadcasts an
5520 // unrevoked commitment transaction.
5521 // This includes HTLCs which were below the dust threshold as well as HTLCs which were awaiting
5522 // a remote RAA before they could be failed backwards (and combinations thereof).
5523 // We also test duplicate-hash HTLCs by adding two nodes on each side of the target nodes which
5524 // use the same payment hashes.
5525 // Thus, we use a six-node network:
5530 // And test where C fails back to A/B when D announces its latest commitment transaction
5531 let chanmon_cfgs = create_chanmon_cfgs(6);
5532 let node_cfgs = create_node_cfgs(6, &chanmon_cfgs);
5533 let node_chanmgrs = create_node_chanmgrs(6, &node_cfgs, &[None, None, None, None, None, None]);
5534 let nodes = create_network(6, &node_cfgs, &node_chanmgrs);
5535 let logger = test_utils::TestLogger::new();
5537 create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known());
5538 create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
5539 let chan = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
5540 create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::known(), InitFeatures::known());
5541 create_announced_chan_between_nodes(&nodes, 3, 5, InitFeatures::known(), InitFeatures::known());
5543 // Rebalance and check output sanity...
5544 send_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 500000);
5545 send_payment(&nodes[1], &[&nodes[2], &nodes[3], &nodes[5]], 500000);
5546 assert_eq!(get_local_commitment_txn!(nodes[3], chan.2)[0].output.len(), 2);
5548 let ds_dust_limit = nodes[3].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().holder_dust_limit_satoshis;
5550 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
5552 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
5553 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
5554 let our_node_id = &nodes[1].node.get_our_node_id();
5555 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();
5557 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
5559 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
5561 let (_, payment_hash_3, _) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
5563 let (_, payment_hash_4, _) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
5564 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();
5566 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());
5568 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());
5571 let (_, payment_hash_5, _) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
5573 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();
5574 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
5577 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
5579 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();
5580 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());
5582 // Double-check that six of the new HTLC were added
5583 // We now have six HTLCs pending over the dust limit and six HTLCs under the dust limit (ie,
5584 // with to_local and to_remote outputs, 8 outputs and 6 HTLCs not included).
5585 assert_eq!(get_local_commitment_txn!(nodes[3], chan.2).len(), 1);
5586 assert_eq!(get_local_commitment_txn!(nodes[3], chan.2)[0].output.len(), 8);
5588 // Now fail back three of the over-dust-limit and three of the under-dust-limit payments in one go.
5589 // Fail 0th below-dust, 4th above-dust, 8th above-dust, 10th below-dust HTLCs
5590 assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_1));
5591 assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_3));
5592 assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_5));
5593 assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_6));
5594 check_added_monitors!(nodes[4], 0);
5595 expect_pending_htlcs_forwardable!(nodes[4]);
5596 check_added_monitors!(nodes[4], 1);
5598 let four_removes = get_htlc_update_msgs!(nodes[4], nodes[3].node.get_our_node_id());
5599 nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[0]);
5600 nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[1]);
5601 nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[2]);
5602 nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[3]);
5603 commitment_signed_dance!(nodes[3], nodes[4], four_removes.commitment_signed, false);
5605 // Fail 3rd below-dust and 7th above-dust HTLCs
5606 assert!(nodes[5].node.fail_htlc_backwards(&payment_hash_2));
5607 assert!(nodes[5].node.fail_htlc_backwards(&payment_hash_4));
5608 check_added_monitors!(nodes[5], 0);
5609 expect_pending_htlcs_forwardable!(nodes[5]);
5610 check_added_monitors!(nodes[5], 1);
5612 let two_removes = get_htlc_update_msgs!(nodes[5], nodes[3].node.get_our_node_id());
5613 nodes[3].node.handle_update_fail_htlc(&nodes[5].node.get_our_node_id(), &two_removes.update_fail_htlcs[0]);
5614 nodes[3].node.handle_update_fail_htlc(&nodes[5].node.get_our_node_id(), &two_removes.update_fail_htlcs[1]);
5615 commitment_signed_dance!(nodes[3], nodes[5], two_removes.commitment_signed, false);
5617 let ds_prev_commitment_tx = get_local_commitment_txn!(nodes[3], chan.2);
5619 expect_pending_htlcs_forwardable!(nodes[3]);
5620 check_added_monitors!(nodes[3], 1);
5621 let six_removes = get_htlc_update_msgs!(nodes[3], nodes[2].node.get_our_node_id());
5622 nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[0]);
5623 nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[1]);
5624 nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[2]);
5625 nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[3]);
5626 nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[4]);
5627 nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[5]);
5628 if deliver_last_raa {
5629 commitment_signed_dance!(nodes[2], nodes[3], six_removes.commitment_signed, false);
5631 let _cs_last_raa = commitment_signed_dance!(nodes[2], nodes[3], six_removes.commitment_signed, false, true, false, true);
5634 // D's latest commitment transaction now contains 1st + 2nd + 9th HTLCs (implicitly, they're
5635 // below the dust limit) and the 5th + 6th + 11th HTLCs. It has failed back the 0th, 3rd, 4th,
5636 // 7th, 8th, and 10th, but as we haven't yet delivered the final RAA to C, the fails haven't
5637 // propagated back to A/B yet (and D has two unrevoked commitment transactions).
5639 // We now broadcast the latest commitment transaction, which *should* result in failures for
5640 // the 0th, 1st, 2nd, 3rd, 4th, 7th, 8th, 9th, and 10th HTLCs, ie all the below-dust HTLCs and
5641 // the non-broadcast above-dust HTLCs.
5643 // Alternatively, we may broadcast the previous commitment transaction, which should only
5644 // result in failures for the below-dust HTLCs, ie the 0th, 1st, 2nd, 3rd, 9th, and 10th HTLCs.
5645 let ds_last_commitment_tx = get_local_commitment_txn!(nodes[3], chan.2);
5647 if announce_latest {
5648 mine_transaction(&nodes[2], &ds_last_commitment_tx[0]);
5650 mine_transaction(&nodes[2], &ds_prev_commitment_tx[0]);
5652 connect_blocks(&nodes[2], ANTI_REORG_DELAY - 1);
5653 check_closed_broadcast!(nodes[2], true);
5654 expect_pending_htlcs_forwardable!(nodes[2]);
5655 check_added_monitors!(nodes[2], 3);
5657 let cs_msgs = nodes[2].node.get_and_clear_pending_msg_events();
5658 assert_eq!(cs_msgs.len(), 2);
5659 let mut a_done = false;
5660 for msg in cs_msgs {
5662 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
5663 // Both under-dust HTLCs and the one above-dust HTLC that we had already failed
5664 // should be failed-backwards here.
5665 let target = if *node_id == nodes[0].node.get_our_node_id() {
5666 // If announce_latest, expect 0th, 1st, 4th, 8th, 10th HTLCs, else only 0th, 1st, 10th below-dust HTLCs
5667 for htlc in &updates.update_fail_htlcs {
5668 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 });
5670 assert_eq!(updates.update_fail_htlcs.len(), if announce_latest { 5 } else { 3 });
5675 // If announce_latest, expect 2nd, 3rd, 7th, 9th HTLCs, else only 2nd, 3rd, 9th below-dust HTLCs
5676 for htlc in &updates.update_fail_htlcs {
5677 assert!(htlc.htlc_id == 1 || htlc.htlc_id == 2 || htlc.htlc_id == 5 || if announce_latest { htlc.htlc_id == 4 } else { false });
5679 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
5680 assert_eq!(updates.update_fail_htlcs.len(), if announce_latest { 4 } else { 3 });
5683 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
5684 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[1]);
5685 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[2]);
5686 if announce_latest {
5687 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[3]);
5688 if *node_id == nodes[0].node.get_our_node_id() {
5689 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[4]);
5692 commitment_signed_dance!(target, nodes[2], updates.commitment_signed, false, true);
5694 _ => panic!("Unexpected event"),
5698 let as_events = nodes[0].node.get_and_clear_pending_events();
5699 assert_eq!(as_events.len(), if announce_latest { 5 } else { 3 });
5700 let mut as_failds = HashSet::new();
5701 for event in as_events.iter() {
5702 if let &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, .. } = event {
5703 assert!(as_failds.insert(*payment_hash));
5704 if *payment_hash != payment_hash_2 {
5705 assert_eq!(*rejected_by_dest, deliver_last_raa);
5707 assert!(!rejected_by_dest);
5709 } else { panic!("Unexpected event"); }
5711 assert!(as_failds.contains(&payment_hash_1));
5712 assert!(as_failds.contains(&payment_hash_2));
5713 if announce_latest {
5714 assert!(as_failds.contains(&payment_hash_3));
5715 assert!(as_failds.contains(&payment_hash_5));
5717 assert!(as_failds.contains(&payment_hash_6));
5719 let bs_events = nodes[1].node.get_and_clear_pending_events();
5720 assert_eq!(bs_events.len(), if announce_latest { 4 } else { 3 });
5721 let mut bs_failds = HashSet::new();
5722 for event in bs_events.iter() {
5723 if let &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, .. } = event {
5724 assert!(bs_failds.insert(*payment_hash));
5725 if *payment_hash != payment_hash_1 && *payment_hash != payment_hash_5 {
5726 assert_eq!(*rejected_by_dest, deliver_last_raa);
5728 assert!(!rejected_by_dest);
5730 } else { panic!("Unexpected event"); }
5732 assert!(bs_failds.contains(&payment_hash_1));
5733 assert!(bs_failds.contains(&payment_hash_2));
5734 if announce_latest {
5735 assert!(bs_failds.contains(&payment_hash_4));
5737 assert!(bs_failds.contains(&payment_hash_5));
5739 // For each HTLC which was not failed-back by normal process (ie deliver_last_raa), we should
5740 // get a PaymentFailureNetworkUpdate. A should have gotten 4 HTLCs which were failed-back due
5741 // to unknown-preimage-etc, B should have gotten 2. Thus, in the
5742 // announce_latest && deliver_last_raa case, we should have 5-4=1 and 4-2=2
5743 // PaymentFailureNetworkUpdates.
5744 let as_msg_events = nodes[0].node.get_and_clear_pending_msg_events();
5745 assert_eq!(as_msg_events.len(), if deliver_last_raa { 1 } else if !announce_latest { 3 } else { 5 });
5746 let bs_msg_events = nodes[1].node.get_and_clear_pending_msg_events();
5747 assert_eq!(bs_msg_events.len(), if deliver_last_raa { 2 } else if !announce_latest { 3 } else { 4 });
5748 for event in as_msg_events.iter().chain(bs_msg_events.iter()) {
5750 &MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
5751 _ => panic!("Unexpected event"),
5757 fn test_fail_backwards_latest_remote_announce_a() {
5758 do_test_fail_backwards_unrevoked_remote_announce(false, true);
5762 fn test_fail_backwards_latest_remote_announce_b() {
5763 do_test_fail_backwards_unrevoked_remote_announce(true, true);
5767 fn test_fail_backwards_previous_remote_announce() {
5768 do_test_fail_backwards_unrevoked_remote_announce(false, false);
5769 // Note that true, true doesn't make sense as it implies we announce a revoked state, which is
5770 // tested for in test_commitment_revoked_fail_backward_exhaustive()
5774 fn test_dynamic_spendable_outputs_local_htlc_timeout_tx() {
5775 let chanmon_cfgs = create_chanmon_cfgs(2);
5776 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5777 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5778 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5780 // Create some initial channels
5781 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5783 let (_, our_payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000);
5784 let local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
5785 assert_eq!(local_txn[0].input.len(), 1);
5786 check_spends!(local_txn[0], chan_1.3);
5788 // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
5789 mine_transaction(&nodes[0], &local_txn[0]);
5790 check_closed_broadcast!(nodes[0], true);
5791 check_added_monitors!(nodes[0], 1);
5792 connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
5794 let htlc_timeout = {
5795 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5796 assert_eq!(node_txn.len(), 2);
5797 check_spends!(node_txn[0], chan_1.3);
5798 assert_eq!(node_txn[1].input.len(), 1);
5799 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5800 check_spends!(node_txn[1], local_txn[0]);
5804 mine_transaction(&nodes[0], &htlc_timeout);
5805 connect_blocks(&nodes[0], BREAKDOWN_TIMEOUT as u32 - 1);
5806 expect_payment_failed!(nodes[0], our_payment_hash, true);
5808 // Verify that A is able to spend its own HTLC-Timeout tx thanks to spendable output event given back by its ChannelMonitor
5809 let spend_txn = check_spendable_outputs!(nodes[0], node_cfgs[0].keys_manager);
5810 assert_eq!(spend_txn.len(), 3);
5811 check_spends!(spend_txn[0], local_txn[0]);
5812 assert_eq!(spend_txn[1].input.len(), 1);
5813 check_spends!(spend_txn[1], htlc_timeout);
5814 assert_eq!(spend_txn[1].input[0].sequence, BREAKDOWN_TIMEOUT as u32);
5815 assert_eq!(spend_txn[2].input.len(), 2);
5816 check_spends!(spend_txn[2], local_txn[0], htlc_timeout);
5817 assert!(spend_txn[2].input[0].sequence == BREAKDOWN_TIMEOUT as u32 ||
5818 spend_txn[2].input[1].sequence == BREAKDOWN_TIMEOUT as u32);
5822 fn test_key_derivation_params() {
5823 // This test is a copy of test_dynamic_spendable_outputs_local_htlc_timeout_tx, with
5824 // a key manager rotation to test that key_derivation_params returned in DynamicOutputP2WSH
5825 // let us re-derive the channel key set to then derive a delayed_payment_key.
5827 let chanmon_cfgs = create_chanmon_cfgs(3);
5829 // We manually create the node configuration to backup the seed.
5830 let seed = [42; 32];
5831 let keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
5832 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);
5833 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 };
5834 let mut node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5835 node_cfgs.remove(0);
5836 node_cfgs.insert(0, node);
5838 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5839 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5841 // Create some initial channels
5842 // Create a dummy channel to advance index by one and thus test re-derivation correctness
5844 let chan_0 = create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known());
5845 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5846 assert_ne!(chan_0.3.output[0].script_pubkey, chan_1.3.output[0].script_pubkey);
5848 // Ensure all nodes are at the same height
5849 let node_max_height = nodes.iter().map(|node| node.blocks.lock().unwrap().len()).max().unwrap() as u32;
5850 connect_blocks(&nodes[0], node_max_height - nodes[0].best_block_info().1);
5851 connect_blocks(&nodes[1], node_max_height - nodes[1].best_block_info().1);
5852 connect_blocks(&nodes[2], node_max_height - nodes[2].best_block_info().1);
5854 let (_, our_payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000);
5855 let local_txn_0 = get_local_commitment_txn!(nodes[0], chan_0.2);
5856 let local_txn_1 = get_local_commitment_txn!(nodes[0], chan_1.2);
5857 assert_eq!(local_txn_1[0].input.len(), 1);
5858 check_spends!(local_txn_1[0], chan_1.3);
5860 // We check funding pubkey are unique
5861 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]));
5862 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]));
5863 if from_0_funding_key_0 == from_1_funding_key_0
5864 || from_0_funding_key_0 == from_1_funding_key_1
5865 || from_0_funding_key_1 == from_1_funding_key_0
5866 || from_0_funding_key_1 == from_1_funding_key_1 {
5867 panic!("Funding pubkeys aren't unique");
5870 // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
5871 mine_transaction(&nodes[0], &local_txn_1[0]);
5872 connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
5873 check_closed_broadcast!(nodes[0], true);
5874 check_added_monitors!(nodes[0], 1);
5876 let htlc_timeout = {
5877 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5878 assert_eq!(node_txn[1].input.len(), 1);
5879 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5880 check_spends!(node_txn[1], local_txn_1[0]);
5884 mine_transaction(&nodes[0], &htlc_timeout);
5885 connect_blocks(&nodes[0], BREAKDOWN_TIMEOUT as u32 - 1);
5886 expect_payment_failed!(nodes[0], our_payment_hash, true);
5888 // Verify that A is able to spend its own HTLC-Timeout tx thanks to spendable output event given back by its ChannelMonitor
5889 let new_keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
5890 let spend_txn = check_spendable_outputs!(nodes[0], new_keys_manager);
5891 assert_eq!(spend_txn.len(), 3);
5892 check_spends!(spend_txn[0], local_txn_1[0]);
5893 assert_eq!(spend_txn[1].input.len(), 1);
5894 check_spends!(spend_txn[1], htlc_timeout);
5895 assert_eq!(spend_txn[1].input[0].sequence, BREAKDOWN_TIMEOUT as u32);
5896 assert_eq!(spend_txn[2].input.len(), 2);
5897 check_spends!(spend_txn[2], local_txn_1[0], htlc_timeout);
5898 assert!(spend_txn[2].input[0].sequence == BREAKDOWN_TIMEOUT as u32 ||
5899 spend_txn[2].input[1].sequence == BREAKDOWN_TIMEOUT as u32);
5903 fn test_static_output_closing_tx() {
5904 let chanmon_cfgs = create_chanmon_cfgs(2);
5905 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5906 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5907 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5909 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5911 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
5912 let closing_tx = close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true).2;
5914 mine_transaction(&nodes[0], &closing_tx);
5915 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
5917 let spend_txn = check_spendable_outputs!(nodes[0], node_cfgs[0].keys_manager);
5918 assert_eq!(spend_txn.len(), 1);
5919 check_spends!(spend_txn[0], closing_tx);
5921 mine_transaction(&nodes[1], &closing_tx);
5922 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
5924 let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
5925 assert_eq!(spend_txn.len(), 1);
5926 check_spends!(spend_txn[0], closing_tx);
5929 fn do_htlc_claim_local_commitment_only(use_dust: bool) {
5930 let chanmon_cfgs = create_chanmon_cfgs(2);
5931 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5932 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5933 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5934 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5936 let (our_payment_preimage, _, _) = route_payment(&nodes[0], &[&nodes[1]], if use_dust { 50000 } else { 3000000 });
5938 // Claim the payment, but don't deliver A's commitment_signed, resulting in the HTLC only being
5939 // present in B's local commitment transaction, but none of A's commitment transactions.
5940 assert!(nodes[1].node.claim_funds(our_payment_preimage));
5941 check_added_monitors!(nodes[1], 1);
5943 let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5944 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fulfill_htlcs[0]);
5945 let events = nodes[0].node.get_and_clear_pending_events();
5946 assert_eq!(events.len(), 1);
5948 Event::PaymentSent { payment_preimage } => {
5949 assert_eq!(payment_preimage, our_payment_preimage);
5951 _ => panic!("Unexpected event"),
5954 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_updates.commitment_signed);
5955 check_added_monitors!(nodes[0], 1);
5956 let as_updates = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5957 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_updates.0);
5958 check_added_monitors!(nodes[1], 1);
5960 let starting_block = nodes[1].best_block_info();
5961 let mut block = Block {
5962 header: BlockHeader { version: 0x20000000, prev_blockhash: starting_block.0, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
5965 for _ in starting_block.1 + 1..TEST_FINAL_CLTV - CLTV_CLAIM_BUFFER + starting_block.1 + 2 {
5966 connect_block(&nodes[1], &block);
5967 block.header.prev_blockhash = block.block_hash();
5969 test_txn_broadcast(&nodes[1], &chan, None, if use_dust { HTLCType::NONE } else { HTLCType::SUCCESS });
5970 check_closed_broadcast!(nodes[1], true);
5971 check_added_monitors!(nodes[1], 1);
5974 fn do_htlc_claim_current_remote_commitment_only(use_dust: bool) {
5975 let chanmon_cfgs = create_chanmon_cfgs(2);
5976 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5977 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5978 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5979 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5980 let logger = test_utils::TestLogger::new();
5982 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1]);
5983 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
5984 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();
5985 nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
5986 check_added_monitors!(nodes[0], 1);
5988 let _as_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5990 // As far as A is concerned, the HTLC is now present only in the latest remote commitment
5991 // transaction, however it is not in A's latest local commitment, so we can just broadcast that
5992 // to "time out" the HTLC.
5994 let starting_block = nodes[1].best_block_info();
5995 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: starting_block.0, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5997 for _ in starting_block.1 + 1..TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + starting_block.1 + 2 {
5998 connect_block(&nodes[0], &Block { header, txdata: Vec::new()});
5999 header.prev_blockhash = header.block_hash();
6001 test_txn_broadcast(&nodes[0], &chan, None, HTLCType::NONE);
6002 check_closed_broadcast!(nodes[0], true);
6003 check_added_monitors!(nodes[0], 1);
6006 fn do_htlc_claim_previous_remote_commitment_only(use_dust: bool, check_revoke_no_close: bool) {
6007 let chanmon_cfgs = create_chanmon_cfgs(3);
6008 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
6009 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
6010 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
6011 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6013 // Fail the payment, but don't deliver A's final RAA, resulting in the HTLC only being present
6014 // in B's previous (unrevoked) commitment transaction, but none of A's commitment transactions.
6015 // Also optionally test that we *don't* fail the channel in case the commitment transaction was
6016 // actually revoked.
6017 let htlc_value = if use_dust { 50000 } else { 3000000 };
6018 let (_, our_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1]], htlc_value);
6019 assert!(nodes[1].node.fail_htlc_backwards(&our_payment_hash));
6020 expect_pending_htlcs_forwardable!(nodes[1]);
6021 check_added_monitors!(nodes[1], 1);
6023 let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6024 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fail_htlcs[0]);
6025 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_updates.commitment_signed);
6026 check_added_monitors!(nodes[0], 1);
6027 let as_updates = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6028 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_updates.0);
6029 check_added_monitors!(nodes[1], 1);
6030 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_updates.1);
6031 check_added_monitors!(nodes[1], 1);
6032 let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
6034 if check_revoke_no_close {
6035 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
6036 check_added_monitors!(nodes[0], 1);
6039 let starting_block = nodes[1].best_block_info();
6040 let mut block = Block {
6041 header: BlockHeader { version: 0x20000000, prev_blockhash: starting_block.0, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
6044 for _ in starting_block.1 + 1..TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + CHAN_CONFIRM_DEPTH + 2 {
6045 connect_block(&nodes[0], &block);
6046 block.header.prev_blockhash = block.block_hash();
6048 if !check_revoke_no_close {
6049 test_txn_broadcast(&nodes[0], &chan, None, HTLCType::NONE);
6050 check_closed_broadcast!(nodes[0], true);
6051 check_added_monitors!(nodes[0], 1);
6053 expect_payment_failed!(nodes[0], our_payment_hash, true);
6057 // Test that we close channels on-chain when broadcastable HTLCs reach their timeout window.
6058 // There are only a few cases to test here:
6059 // * its not really normative behavior, but we test that below-dust HTLCs "included" in
6060 // broadcastable commitment transactions result in channel closure,
6061 // * its included in an unrevoked-but-previous remote commitment transaction,
6062 // * its included in the latest remote or local commitment transactions.
6063 // We test each of the three possible commitment transactions individually and use both dust and
6065 // Note that we don't bother testing both outbound and inbound HTLC failures for each case, and we
6066 // assume they are handled the same across all six cases, as both outbound and inbound failures are
6067 // tested for at least one of the cases in other tests.
6069 fn htlc_claim_single_commitment_only_a() {
6070 do_htlc_claim_local_commitment_only(true);
6071 do_htlc_claim_local_commitment_only(false);
6073 do_htlc_claim_current_remote_commitment_only(true);
6074 do_htlc_claim_current_remote_commitment_only(false);
6078 fn htlc_claim_single_commitment_only_b() {
6079 do_htlc_claim_previous_remote_commitment_only(true, false);
6080 do_htlc_claim_previous_remote_commitment_only(false, false);
6081 do_htlc_claim_previous_remote_commitment_only(true, true);
6082 do_htlc_claim_previous_remote_commitment_only(false, true);
6087 fn bolt2_open_channel_sending_node_checks_part1() { //This test needs to be on its own as we are catching a panic
6088 let chanmon_cfgs = create_chanmon_cfgs(2);
6089 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6090 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6091 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6092 //Force duplicate channel ids
6093 for node in nodes.iter() {
6094 *node.keys_manager.override_channel_id_priv.lock().unwrap() = Some([0; 32]);
6097 // BOLT #2 spec: Sending node must ensure temporary_channel_id is unique from any other channel ID with the same peer.
6098 let channel_value_satoshis=10000;
6099 let push_msat=10001;
6100 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).unwrap();
6101 let node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
6102 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &node0_to_1_send_open_channel);
6104 //Create a second channel with a channel_id collision
6105 assert!(nodes[0].node.create_channel(nodes[0].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
6109 fn bolt2_open_channel_sending_node_checks_part2() {
6110 let chanmon_cfgs = create_chanmon_cfgs(2);
6111 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6112 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6113 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6115 // BOLT #2 spec: Sending node must set funding_satoshis to less than 2^24 satoshis
6116 let channel_value_satoshis=2^24;
6117 let push_msat=10001;
6118 assert!(nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
6120 // BOLT #2 spec: Sending node must set push_msat to equal or less than 1000 * funding_satoshis
6121 let channel_value_satoshis=10000;
6122 // Test when push_msat is equal to 1000 * funding_satoshis.
6123 let push_msat=1000*channel_value_satoshis+1;
6124 assert!(nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
6126 // BOLT #2 spec: Sending node must set set channel_reserve_satoshis greater than or equal to dust_limit_satoshis
6127 let channel_value_satoshis=10000;
6128 let push_msat=10001;
6129 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
6130 let node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
6131 assert!(node0_to_1_send_open_channel.channel_reserve_satoshis>=node0_to_1_send_open_channel.dust_limit_satoshis);
6133 // BOLT #2 spec: Sending node must set undefined bits in channel_flags to 0
6134 // 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
6135 assert!(node0_to_1_send_open_channel.channel_flags<=1);
6137 // 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.
6138 assert!(BREAKDOWN_TIMEOUT>0);
6139 assert!(node0_to_1_send_open_channel.to_self_delay==BREAKDOWN_TIMEOUT);
6141 // BOLT #2 spec: Sending node must ensure the chain_hash value identifies the chain it wishes to open the channel within.
6142 let chain_hash=genesis_block(Network::Testnet).header.block_hash();
6143 assert_eq!(node0_to_1_send_open_channel.chain_hash,chain_hash);
6145 // 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.
6146 assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.funding_pubkey.serialize()).is_ok());
6147 assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.revocation_basepoint.serialize()).is_ok());
6148 assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.htlc_basepoint.serialize()).is_ok());
6149 assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.payment_point.serialize()).is_ok());
6150 assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.delayed_payment_basepoint.serialize()).is_ok());
6154 fn bolt2_open_channel_sane_dust_limit() {
6155 let chanmon_cfgs = create_chanmon_cfgs(2);
6156 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6157 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6158 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6160 let channel_value_satoshis=1000000;
6161 let push_msat=10001;
6162 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).unwrap();
6163 let mut node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
6164 node0_to_1_send_open_channel.dust_limit_satoshis = 661;
6165 node0_to_1_send_open_channel.channel_reserve_satoshis = 100001;
6167 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &node0_to_1_send_open_channel);
6168 let events = nodes[1].node.get_and_clear_pending_msg_events();
6169 let err_msg = match events[0] {
6170 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id: _ } => {
6173 _ => panic!("Unexpected event"),
6175 assert_eq!(err_msg.data, "dust_limit_satoshis (661) is greater than the implementation limit (660)");
6178 // Test that if we fail to send an HTLC that is being freed from the holding cell, and the HTLC
6179 // originated from our node, its failure is surfaced to the user. We trigger this failure to
6180 // free the HTLC by increasing our fee while the HTLC is in the holding cell such that the HTLC
6181 // is no longer affordable once it's freed.
6183 fn test_fail_holding_cell_htlc_upon_free() {
6184 let chanmon_cfgs = create_chanmon_cfgs(2);
6185 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6186 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6187 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6188 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6189 let logger = test_utils::TestLogger::new();
6191 // First nodes[0] generates an update_fee, setting the channel's
6192 // pending_update_fee.
6193 nodes[0].node.update_fee(chan.2, get_feerate!(nodes[0], chan.2) + 20).unwrap();
6194 check_added_monitors!(nodes[0], 1);
6196 let events = nodes[0].node.get_and_clear_pending_msg_events();
6197 assert_eq!(events.len(), 1);
6198 let (update_msg, commitment_signed) = match events[0] {
6199 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
6200 (update_fee.as_ref(), commitment_signed)
6202 _ => panic!("Unexpected event"),
6205 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
6207 let mut chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6208 let channel_reserve = chan_stat.channel_reserve_msat;
6209 let feerate = get_feerate!(nodes[0], chan.2);
6211 // 2* and +1 HTLCs on the commit tx fee calculation for the fee spike reserve.
6212 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6213 let max_can_send = 5000000 - channel_reserve - 2*commit_tx_fee_msat(feerate, 1 + 1);
6214 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6215 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();
6217 // Send a payment which passes reserve checks but gets stuck in the holding cell.
6218 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6219 chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6220 assert_eq!(chan_stat.holding_cell_outbound_amount_msat, max_can_send);
6222 // Flush the pending fee update.
6223 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
6224 let (as_revoke_and_ack, _) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6225 check_added_monitors!(nodes[1], 1);
6226 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_revoke_and_ack);
6227 check_added_monitors!(nodes[0], 1);
6229 // Upon receipt of the RAA, there will be an attempt to resend the holding cell
6230 // HTLC, but now that the fee has been raised the payment will now fail, causing
6231 // us to surface its failure to the user.
6232 chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6233 assert_eq!(chan_stat.holding_cell_outbound_amount_msat, 0);
6234 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);
6235 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 {}",
6236 hex::encode(our_payment_hash.0), chan_stat.channel_reserve_msat, hex::encode(chan.2));
6237 nodes[0].logger.assert_log("lightning::ln::channel".to_string(), failure_log.to_string(), 1);
6239 // Check that the payment failed to be sent out.
6240 let events = nodes[0].node.get_and_clear_pending_events();
6241 assert_eq!(events.len(), 1);
6243 &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, ref error_code, ref error_data } => {
6244 assert_eq!(our_payment_hash.clone(), *payment_hash);
6245 assert_eq!(*rejected_by_dest, false);
6246 assert_eq!(*error_code, None);
6247 assert_eq!(*error_data, None);
6249 _ => panic!("Unexpected event"),
6253 // Test that if multiple HTLCs are released from the holding cell and one is
6254 // valid but the other is no longer valid upon release, the valid HTLC can be
6255 // successfully completed while the other one fails as expected.
6257 fn test_free_and_fail_holding_cell_htlcs() {
6258 let chanmon_cfgs = create_chanmon_cfgs(2);
6259 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6260 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6261 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6262 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6263 let logger = test_utils::TestLogger::new();
6265 // First nodes[0] generates an update_fee, setting the channel's
6266 // pending_update_fee.
6267 nodes[0].node.update_fee(chan.2, get_feerate!(nodes[0], chan.2) + 200).unwrap();
6268 check_added_monitors!(nodes[0], 1);
6270 let events = nodes[0].node.get_and_clear_pending_msg_events();
6271 assert_eq!(events.len(), 1);
6272 let (update_msg, commitment_signed) = match events[0] {
6273 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
6274 (update_fee.as_ref(), commitment_signed)
6276 _ => panic!("Unexpected event"),
6279 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
6281 let mut chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6282 let channel_reserve = chan_stat.channel_reserve_msat;
6283 let feerate = get_feerate!(nodes[0], chan.2);
6285 // 2* and +1 HTLCs on the commit tx fee calculation for the fee spike reserve.
6286 let (payment_preimage_1, payment_hash_1, payment_secret_1) = get_payment_preimage_hash!(nodes[1]);
6288 let (_, payment_hash_2, payment_secret_2) = get_payment_preimage_hash!(nodes[1]);
6289 let amt_2 = 5000000 - channel_reserve - 2*commit_tx_fee_msat(feerate, 2 + 1) - amt_1;
6290 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6291 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();
6292 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();
6294 // Send 2 payments which pass reserve checks but get stuck in the holding cell.
6295 nodes[0].node.send_payment(&route_1, payment_hash_1, &Some(payment_secret_1)).unwrap();
6296 chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6297 assert_eq!(chan_stat.holding_cell_outbound_amount_msat, amt_1);
6298 nodes[0].node.send_payment(&route_2, payment_hash_2, &Some(payment_secret_2)).unwrap();
6299 chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6300 assert_eq!(chan_stat.holding_cell_outbound_amount_msat, amt_1 + amt_2);
6302 // Flush the pending fee update.
6303 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
6304 let (revoke_and_ack, commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6305 check_added_monitors!(nodes[1], 1);
6306 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_and_ack);
6307 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
6308 check_added_monitors!(nodes[0], 2);
6310 // Upon receipt of the RAA, there will be an attempt to resend the holding cell HTLCs,
6311 // but now that the fee has been raised the second payment will now fail, causing us
6312 // to surface its failure to the user. The first payment should succeed.
6313 chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6314 assert_eq!(chan_stat.holding_cell_outbound_amount_msat, 0);
6315 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);
6316 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 {}",
6317 hex::encode(payment_hash_2.0), chan_stat.channel_reserve_msat, hex::encode(chan.2));
6318 nodes[0].logger.assert_log("lightning::ln::channel".to_string(), failure_log.to_string(), 1);
6320 // Check that the second payment failed to be sent out.
6321 let events = nodes[0].node.get_and_clear_pending_events();
6322 assert_eq!(events.len(), 1);
6324 &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, ref error_code, ref error_data } => {
6325 assert_eq!(payment_hash_2.clone(), *payment_hash);
6326 assert_eq!(*rejected_by_dest, false);
6327 assert_eq!(*error_code, None);
6328 assert_eq!(*error_data, None);
6330 _ => panic!("Unexpected event"),
6333 // Complete the first payment and the RAA from the fee update.
6334 let (payment_event, send_raa_event) = {
6335 let mut msgs = nodes[0].node.get_and_clear_pending_msg_events();
6336 assert_eq!(msgs.len(), 2);
6337 (SendEvent::from_event(msgs.remove(0)), msgs.remove(0))
6339 let raa = match send_raa_event {
6340 MessageSendEvent::SendRevokeAndACK { msg, .. } => msg,
6341 _ => panic!("Unexpected event"),
6343 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &raa);
6344 check_added_monitors!(nodes[1], 1);
6345 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6346 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6347 let events = nodes[1].node.get_and_clear_pending_events();
6348 assert_eq!(events.len(), 1);
6350 Event::PendingHTLCsForwardable { .. } => {},
6351 _ => panic!("Unexpected event"),
6353 nodes[1].node.process_pending_htlc_forwards();
6354 let events = nodes[1].node.get_and_clear_pending_events();
6355 assert_eq!(events.len(), 1);
6357 Event::PaymentReceived { .. } => {},
6358 _ => panic!("Unexpected event"),
6360 nodes[1].node.claim_funds(payment_preimage_1);
6361 check_added_monitors!(nodes[1], 1);
6362 let update_msgs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6363 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_msgs.update_fulfill_htlcs[0]);
6364 commitment_signed_dance!(nodes[0], nodes[1], update_msgs.commitment_signed, false, true);
6365 let events = nodes[0].node.get_and_clear_pending_events();
6366 assert_eq!(events.len(), 1);
6368 Event::PaymentSent { ref payment_preimage } => {
6369 assert_eq!(*payment_preimage, payment_preimage_1);
6371 _ => panic!("Unexpected event"),
6375 // Test that if we fail to forward an HTLC that is being freed from the holding cell that the
6376 // HTLC is failed backwards. We trigger this failure to forward the freed HTLC by increasing
6377 // our fee while the HTLC is in the holding cell such that the HTLC is no longer affordable
6380 fn test_fail_holding_cell_htlc_upon_free_multihop() {
6381 let chanmon_cfgs = create_chanmon_cfgs(3);
6382 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
6383 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
6384 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
6385 let chan_0_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6386 let chan_1_2 = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6387 let logger = test_utils::TestLogger::new();
6389 // First nodes[1] generates an update_fee, setting the channel's
6390 // pending_update_fee.
6391 nodes[1].node.update_fee(chan_1_2.2, get_feerate!(nodes[1], chan_1_2.2) + 20).unwrap();
6392 check_added_monitors!(nodes[1], 1);
6394 let events = nodes[1].node.get_and_clear_pending_msg_events();
6395 assert_eq!(events.len(), 1);
6396 let (update_msg, commitment_signed) = match events[0] {
6397 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
6398 (update_fee.as_ref(), commitment_signed)
6400 _ => panic!("Unexpected event"),
6403 nodes[2].node.handle_update_fee(&nodes[1].node.get_our_node_id(), update_msg.unwrap());
6405 let mut chan_stat = get_channel_value_stat!(nodes[0], chan_0_1.2);
6406 let channel_reserve = chan_stat.channel_reserve_msat;
6407 let feerate = get_feerate!(nodes[0], chan_0_1.2);
6409 // Send a payment which passes reserve checks but gets stuck in the holding cell.
6411 let total_routing_fee_msat = (nodes.len() - 2) as u64 * feemsat;
6412 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[2]);
6413 let max_can_send = 5000000 - channel_reserve - 2*commit_tx_fee_msat(feerate, 1 + 1) - total_routing_fee_msat;
6414 let payment_event = {
6415 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6416 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();
6417 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6418 check_added_monitors!(nodes[0], 1);
6420 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
6421 assert_eq!(events.len(), 1);
6423 SendEvent::from_event(events.remove(0))
6425 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6426 check_added_monitors!(nodes[1], 0);
6427 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6428 expect_pending_htlcs_forwardable!(nodes[1]);
6430 chan_stat = get_channel_value_stat!(nodes[1], chan_1_2.2);
6431 assert_eq!(chan_stat.holding_cell_outbound_amount_msat, max_can_send);
6433 // Flush the pending fee update.
6434 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), commitment_signed);
6435 let (raa, commitment_signed) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
6436 check_added_monitors!(nodes[2], 1);
6437 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &raa);
6438 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &commitment_signed);
6439 check_added_monitors!(nodes[1], 2);
6441 // A final RAA message is generated to finalize the fee update.
6442 let events = nodes[1].node.get_and_clear_pending_msg_events();
6443 assert_eq!(events.len(), 1);
6445 let raa_msg = match &events[0] {
6446 &MessageSendEvent::SendRevokeAndACK { ref msg, .. } => {
6449 _ => panic!("Unexpected event"),
6452 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &raa_msg);
6453 check_added_monitors!(nodes[2], 1);
6454 assert!(nodes[2].node.get_and_clear_pending_msg_events().is_empty());
6456 // nodes[1]'s ChannelManager will now signal that we have HTLC forwards to process.
6457 let process_htlc_forwards_event = nodes[1].node.get_and_clear_pending_events();
6458 assert_eq!(process_htlc_forwards_event.len(), 1);
6459 match &process_htlc_forwards_event[0] {
6460 &Event::PendingHTLCsForwardable { .. } => {},
6461 _ => panic!("Unexpected event"),
6464 // In response, we call ChannelManager's process_pending_htlc_forwards
6465 nodes[1].node.process_pending_htlc_forwards();
6466 check_added_monitors!(nodes[1], 1);
6468 // This causes the HTLC to be failed backwards.
6469 let fail_event = nodes[1].node.get_and_clear_pending_msg_events();
6470 assert_eq!(fail_event.len(), 1);
6471 let (fail_msg, commitment_signed) = match &fail_event[0] {
6472 &MessageSendEvent::UpdateHTLCs { ref updates, .. } => {
6473 assert_eq!(updates.update_add_htlcs.len(), 0);
6474 assert_eq!(updates.update_fulfill_htlcs.len(), 0);
6475 assert_eq!(updates.update_fail_malformed_htlcs.len(), 0);
6476 assert_eq!(updates.update_fail_htlcs.len(), 1);
6477 (updates.update_fail_htlcs[0].clone(), updates.commitment_signed.clone())
6479 _ => panic!("Unexpected event"),
6482 // Pass the failure messages back to nodes[0].
6483 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
6484 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
6486 // Complete the HTLC failure+removal process.
6487 let (raa, commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6488 check_added_monitors!(nodes[0], 1);
6489 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &raa);
6490 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commitment_signed);
6491 check_added_monitors!(nodes[1], 2);
6492 let final_raa_event = nodes[1].node.get_and_clear_pending_msg_events();
6493 assert_eq!(final_raa_event.len(), 1);
6494 let raa = match &final_raa_event[0] {
6495 &MessageSendEvent::SendRevokeAndACK { ref msg, .. } => msg.clone(),
6496 _ => panic!("Unexpected event"),
6498 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &raa);
6499 expect_payment_failure_chan_update!(nodes[0], chan_1_2.0.contents.short_channel_id, false);
6500 expect_payment_failed!(nodes[0], our_payment_hash, false);
6501 check_added_monitors!(nodes[0], 1);
6504 // BOLT 2 Requirements for the Sender when constructing and sending an update_add_htlc message.
6505 // 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.
6506 //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.
6509 fn test_update_add_htlc_bolt2_sender_value_below_minimum_msat() {
6510 //BOLT2 Requirement: MUST NOT offer amount_msat below the receiving node's htlc_minimum_msat (same validation check catches both of these)
6511 let chanmon_cfgs = create_chanmon_cfgs(2);
6512 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6513 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6514 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6515 let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6517 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6518 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6519 let logger = test_utils::TestLogger::new();
6520 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();
6521 route.paths[0][0].fee_msat = 100;
6523 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
6524 assert!(regex::Regex::new(r"Cannot send less than their minimum HTLC value \(\d+\)").unwrap().is_match(err)));
6525 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6526 nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot send less than their minimum HTLC value".to_string(), 1);
6530 fn test_update_add_htlc_bolt2_sender_zero_value_msat() {
6531 //BOLT2 Requirement: MUST offer amount_msat greater than 0.
6532 let chanmon_cfgs = create_chanmon_cfgs(2);
6533 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6534 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6535 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6536 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]);
6539 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6540 let logger = test_utils::TestLogger::new();
6541 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();
6542 route.paths[0][0].fee_msat = 0;
6543 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
6544 assert_eq!(err, "Cannot send 0-msat HTLC"));
6546 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6547 nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot send 0-msat HTLC".to_string(), 1);
6551 fn test_update_add_htlc_bolt2_receiver_zero_value_msat() {
6552 //BOLT2 Requirement: MUST offer amount_msat greater than 0.
6553 let chanmon_cfgs = create_chanmon_cfgs(2);
6554 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6555 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6556 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6557 let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6559 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6560 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6561 let logger = test_utils::TestLogger::new();
6562 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();
6563 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6564 check_added_monitors!(nodes[0], 1);
6565 let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6566 updates.update_add_htlcs[0].amount_msat = 0;
6568 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6569 nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Remote side tried to send a 0-msat HTLC".to_string(), 1);
6570 check_closed_broadcast!(nodes[1], true).unwrap();
6571 check_added_monitors!(nodes[1], 1);
6575 fn test_update_add_htlc_bolt2_sender_cltv_expiry_too_high() {
6576 //BOLT 2 Requirement: MUST set cltv_expiry less than 500000000.
6577 //It is enforced when constructing a route.
6578 let chanmon_cfgs = create_chanmon_cfgs(2);
6579 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6580 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6581 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6582 let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 0, InitFeatures::known(), InitFeatures::known());
6583 let logger = test_utils::TestLogger::new();
6585 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6587 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6588 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();
6589 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::RouteError { ref err },
6590 assert_eq!(err, &"Channel CLTV overflowed?"));
6594 fn test_update_add_htlc_bolt2_sender_exceed_max_htlc_num_and_htlc_id_increment() {
6595 //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.
6596 //BOLT 2 Requirement: for the first HTLC it offers MUST set id to 0.
6597 //BOLT 2 Requirement: MUST increase the value of id by 1 for each successive offer.
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 max_accepted_htlcs = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().counterparty_max_accepted_htlcs as u64;
6605 let logger = test_utils::TestLogger::new();
6606 for i in 0..max_accepted_htlcs {
6607 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6608 let payment_event = {
6609 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6610 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();
6611 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6612 check_added_monitors!(nodes[0], 1);
6614 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
6615 assert_eq!(events.len(), 1);
6616 if let MessageSendEvent::UpdateHTLCs { node_id: _, updates: msgs::CommitmentUpdate{ update_add_htlcs: ref htlcs, .. }, } = events[0] {
6617 assert_eq!(htlcs[0].htlc_id, i);
6621 SendEvent::from_event(events.remove(0))
6623 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6624 check_added_monitors!(nodes[1], 0);
6625 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6627 expect_pending_htlcs_forwardable!(nodes[1]);
6628 expect_payment_received!(nodes[1], our_payment_hash, our_payment_secret, 100000);
6630 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6631 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6632 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();
6633 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
6634 assert!(regex::Regex::new(r"Cannot push more than their max accepted HTLCs \(\d+\)").unwrap().is_match(err)));
6636 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6637 nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot push more than their max accepted HTLCs".to_string(), 1);
6641 fn test_update_add_htlc_bolt2_sender_exceed_max_htlc_value_in_flight() {
6642 //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.
6643 let chanmon_cfgs = create_chanmon_cfgs(2);
6644 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6645 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6646 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6647 let channel_value = 100000;
6648 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, channel_value, 0, InitFeatures::known(), InitFeatures::known());
6649 let max_in_flight = get_channel_value_stat!(nodes[0], chan.2).counterparty_max_htlc_value_in_flight_msat;
6651 send_payment(&nodes[0], &vec!(&nodes[1])[..], max_in_flight);
6653 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6654 // Manually create a route over our max in flight (which our router normally automatically
6656 let route = Route { paths: vec![vec![RouteHop {
6657 pubkey: nodes[1].node.get_our_node_id(), node_features: NodeFeatures::known(), channel_features: ChannelFeatures::known(),
6658 short_channel_id: nodes[1].node.list_usable_channels()[0].short_channel_id.unwrap(),
6659 fee_msat: max_in_flight + 1, cltv_expiry_delta: TEST_FINAL_CLTV
6661 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
6662 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)));
6664 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6665 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);
6667 send_payment(&nodes[0], &[&nodes[1]], max_in_flight);
6670 // BOLT 2 Requirements for the Receiver when handling an update_add_htlc message.
6672 fn test_update_add_htlc_bolt2_receiver_check_amount_received_more_than_min() {
6673 //BOLT2 Requirement: receiving an amount_msat equal to 0, OR less than its own htlc_minimum_msat -> SHOULD fail the channel.
6674 let chanmon_cfgs = create_chanmon_cfgs(2);
6675 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6676 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6677 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6678 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6679 let htlc_minimum_msat: u64;
6681 let chan_lock = nodes[0].node.channel_state.lock().unwrap();
6682 let channel = chan_lock.by_id.get(&chan.2).unwrap();
6683 htlc_minimum_msat = channel.get_holder_htlc_minimum_msat();
6686 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6687 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6688 let logger = test_utils::TestLogger::new();
6689 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();
6690 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6691 check_added_monitors!(nodes[0], 1);
6692 let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6693 updates.update_add_htlcs[0].amount_msat = htlc_minimum_msat-1;
6694 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6695 assert!(nodes[1].node.list_channels().is_empty());
6696 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6697 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()));
6698 check_added_monitors!(nodes[1], 1);
6702 fn test_update_add_htlc_bolt2_receiver_sender_can_afford_amount_sent() {
6703 //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
6704 let chanmon_cfgs = create_chanmon_cfgs(2);
6705 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6706 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6707 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6708 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6709 let logger = test_utils::TestLogger::new();
6711 let chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6712 let channel_reserve = chan_stat.channel_reserve_msat;
6713 let feerate = get_feerate!(nodes[0], chan.2);
6714 // The 2* and +1 are for the fee spike reserve.
6715 let commit_tx_fee_outbound = 2 * commit_tx_fee_msat(feerate, 1 + 1);
6717 let max_can_send = 5000000 - channel_reserve - commit_tx_fee_outbound;
6718 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6719 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6720 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();
6721 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6722 check_added_monitors!(nodes[0], 1);
6723 let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6725 // Even though channel-initiator senders are required to respect the fee_spike_reserve,
6726 // at this time channel-initiatee receivers are not required to enforce that senders
6727 // respect the fee_spike_reserve.
6728 updates.update_add_htlcs[0].amount_msat = max_can_send + commit_tx_fee_outbound + 1;
6729 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6731 assert!(nodes[1].node.list_channels().is_empty());
6732 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6733 assert_eq!(err_msg.data, "Remote HTLC add would put them under remote reserve value");
6734 check_added_monitors!(nodes[1], 1);
6738 fn test_update_add_htlc_bolt2_receiver_check_max_htlc_limit() {
6739 //BOLT 2 Requirement: if a sending node adds more than its max_accepted_htlcs HTLCs to its local commitment transaction: SHOULD fail the channel
6740 //BOLT 2 Requirement: MUST allow multiple HTLCs with the same payment_hash.
6741 let chanmon_cfgs = create_chanmon_cfgs(2);
6742 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6743 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6744 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6745 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6746 let logger = test_utils::TestLogger::new();
6748 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6749 let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
6751 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6752 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();
6754 let cur_height = nodes[0].node.best_block.read().unwrap().height() + 1;
6755 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::signing_only(), &route.paths[0], &session_priv).unwrap();
6756 let (onion_payloads, _htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 3999999, &Some(our_payment_secret), cur_height).unwrap();
6757 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &our_payment_hash);
6759 let mut msg = msgs::UpdateAddHTLC {
6763 payment_hash: our_payment_hash,
6764 cltv_expiry: htlc_cltv,
6765 onion_routing_packet: onion_packet.clone(),
6768 for i in 0..super::channel::OUR_MAX_HTLCS {
6769 msg.htlc_id = i as u64;
6770 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
6772 msg.htlc_id = (super::channel::OUR_MAX_HTLCS) as u64;
6773 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
6775 assert!(nodes[1].node.list_channels().is_empty());
6776 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6777 assert!(regex::Regex::new(r"Remote tried to push more than our max accepted HTLCs \(\d+\)").unwrap().is_match(err_msg.data.as_str()));
6778 check_added_monitors!(nodes[1], 1);
6782 fn test_update_add_htlc_bolt2_receiver_check_max_in_flight_msat() {
6783 //OR adds more than its max_htlc_value_in_flight_msat worth of offered HTLCs to its local commitment transaction: SHOULD fail the channel
6784 let chanmon_cfgs = create_chanmon_cfgs(2);
6785 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6786 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6787 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6788 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
6789 let logger = test_utils::TestLogger::new();
6791 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6792 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6793 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();
6794 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6795 check_added_monitors!(nodes[0], 1);
6796 let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6797 updates.update_add_htlcs[0].amount_msat = get_channel_value_stat!(nodes[1], chan.2).counterparty_max_htlc_value_in_flight_msat + 1;
6798 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6800 assert!(nodes[1].node.list_channels().is_empty());
6801 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6802 assert!(regex::Regex::new("Remote HTLC add would put them over our max HTLC value").unwrap().is_match(err_msg.data.as_str()));
6803 check_added_monitors!(nodes[1], 1);
6807 fn test_update_add_htlc_bolt2_receiver_check_cltv_expiry() {
6808 //BOLT2 Requirement: if sending node sets cltv_expiry to greater or equal to 500000000: SHOULD fail the channel.
6809 let chanmon_cfgs = create_chanmon_cfgs(2);
6810 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6811 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6812 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6813 let logger = test_utils::TestLogger::new();
6815 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6816 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6817 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6818 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();
6819 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6820 check_added_monitors!(nodes[0], 1);
6821 let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6822 updates.update_add_htlcs[0].cltv_expiry = 500000000;
6823 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6825 assert!(nodes[1].node.list_channels().is_empty());
6826 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6827 assert_eq!(err_msg.data,"Remote provided CLTV expiry in seconds instead of block height");
6828 check_added_monitors!(nodes[1], 1);
6832 fn test_update_add_htlc_bolt2_receiver_check_repeated_id_ignore() {
6833 //BOLT 2 requirement: if the sender did not previously acknowledge the commitment of that HTLC: MUST ignore a repeated id value after a reconnection.
6834 // We test this by first testing that that repeated HTLCs pass commitment signature checks
6835 // after disconnect and that non-sequential htlc_ids result in a channel failure.
6836 let chanmon_cfgs = create_chanmon_cfgs(2);
6837 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6838 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6839 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6840 let logger = test_utils::TestLogger::new();
6842 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6843 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6844 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6845 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();
6846 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6847 check_added_monitors!(nodes[0], 1);
6848 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6849 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6851 //Disconnect and Reconnect
6852 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
6853 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
6854 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
6855 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
6856 assert_eq!(reestablish_1.len(), 1);
6857 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
6858 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
6859 assert_eq!(reestablish_2.len(), 1);
6860 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
6861 handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
6862 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
6863 handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
6866 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6867 assert_eq!(updates.commitment_signed.htlc_signatures.len(), 1);
6868 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &updates.commitment_signed);
6869 check_added_monitors!(nodes[1], 1);
6870 let _bs_responses = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6872 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6874 assert!(nodes[1].node.list_channels().is_empty());
6875 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6876 assert!(regex::Regex::new(r"Remote skipped HTLC ID \(skipped ID: \d+\)").unwrap().is_match(err_msg.data.as_str()));
6877 check_added_monitors!(nodes[1], 1);
6881 fn test_update_fulfill_htlc_bolt2_update_fulfill_htlc_before_commitment() {
6882 //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.
6884 let chanmon_cfgs = create_chanmon_cfgs(2);
6885 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6886 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6887 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6888 let logger = test_utils::TestLogger::new();
6889 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6890 let (our_payment_preimage, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6891 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6892 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();
6893 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6895 check_added_monitors!(nodes[0], 1);
6896 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6897 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6899 let update_msg = msgs::UpdateFulfillHTLC{
6902 payment_preimage: our_payment_preimage,
6905 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6907 assert!(nodes[0].node.list_channels().is_empty());
6908 let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6909 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()));
6910 check_added_monitors!(nodes[0], 1);
6914 fn test_update_fulfill_htlc_bolt2_update_fail_htlc_before_commitment() {
6915 //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.
6917 let chanmon_cfgs = create_chanmon_cfgs(2);
6918 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6919 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6920 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6921 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6922 let logger = test_utils::TestLogger::new();
6924 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6925 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6926 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();
6927 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6928 check_added_monitors!(nodes[0], 1);
6929 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6930 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6932 let update_msg = msgs::UpdateFailHTLC{
6935 reason: msgs::OnionErrorPacket { data: Vec::new()},
6938 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6940 assert!(nodes[0].node.list_channels().is_empty());
6941 let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6942 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()));
6943 check_added_monitors!(nodes[0], 1);
6947 fn test_update_fulfill_htlc_bolt2_update_fail_malformed_htlc_before_commitment() {
6948 //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.
6950 let chanmon_cfgs = create_chanmon_cfgs(2);
6951 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6952 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6953 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6954 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6955 let logger = test_utils::TestLogger::new();
6957 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6958 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6959 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();
6960 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6961 check_added_monitors!(nodes[0], 1);
6962 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6963 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6964 let update_msg = msgs::UpdateFailMalformedHTLC{
6967 sha256_of_onion: [1; 32],
6968 failure_code: 0x8000,
6971 nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6973 assert!(nodes[0].node.list_channels().is_empty());
6974 let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6975 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()));
6976 check_added_monitors!(nodes[0], 1);
6980 fn test_update_fulfill_htlc_bolt2_incorrect_htlc_id() {
6981 //BOLT 2 Requirement: A receiving node: if the id does not correspond to an HTLC in its current commitment transaction MUST fail the channel.
6983 let chanmon_cfgs = create_chanmon_cfgs(2);
6984 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6985 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6986 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6987 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6989 let our_payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 100000).0;
6991 nodes[1].node.claim_funds(our_payment_preimage);
6992 check_added_monitors!(nodes[1], 1);
6994 let events = nodes[1].node.get_and_clear_pending_msg_events();
6995 assert_eq!(events.len(), 1);
6996 let mut update_fulfill_msg: msgs::UpdateFulfillHTLC = {
6998 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, .. } } => {
6999 assert!(update_add_htlcs.is_empty());
7000 assert_eq!(update_fulfill_htlcs.len(), 1);
7001 assert!(update_fail_htlcs.is_empty());
7002 assert!(update_fail_malformed_htlcs.is_empty());
7003 assert!(update_fee.is_none());
7004 update_fulfill_htlcs[0].clone()
7006 _ => panic!("Unexpected event"),
7010 update_fulfill_msg.htlc_id = 1;
7012 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_msg);
7014 assert!(nodes[0].node.list_channels().is_empty());
7015 let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
7016 assert_eq!(err_msg.data, "Remote tried to fulfill/fail an HTLC we couldn't find");
7017 check_added_monitors!(nodes[0], 1);
7021 fn test_update_fulfill_htlc_bolt2_wrong_preimage() {
7022 //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.
7024 let chanmon_cfgs = create_chanmon_cfgs(2);
7025 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7026 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7027 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7028 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7030 let our_payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 100000).0;
7032 nodes[1].node.claim_funds(our_payment_preimage);
7033 check_added_monitors!(nodes[1], 1);
7035 let events = nodes[1].node.get_and_clear_pending_msg_events();
7036 assert_eq!(events.len(), 1);
7037 let mut update_fulfill_msg: msgs::UpdateFulfillHTLC = {
7039 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, .. } } => {
7040 assert!(update_add_htlcs.is_empty());
7041 assert_eq!(update_fulfill_htlcs.len(), 1);
7042 assert!(update_fail_htlcs.is_empty());
7043 assert!(update_fail_malformed_htlcs.is_empty());
7044 assert!(update_fee.is_none());
7045 update_fulfill_htlcs[0].clone()
7047 _ => panic!("Unexpected event"),
7051 update_fulfill_msg.payment_preimage = PaymentPreimage([1; 32]);
7053 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_msg);
7055 assert!(nodes[0].node.list_channels().is_empty());
7056 let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
7057 assert!(regex::Regex::new(r"Remote tried to fulfill HTLC \(\d+\) with an incorrect preimage").unwrap().is_match(err_msg.data.as_str()));
7058 check_added_monitors!(nodes[0], 1);
7062 fn test_update_fulfill_htlc_bolt2_missing_badonion_bit_for_malformed_htlc_message() {
7063 //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.
7065 let chanmon_cfgs = create_chanmon_cfgs(2);
7066 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7067 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7068 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7069 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7070 let logger = test_utils::TestLogger::new();
7072 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
7073 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
7074 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();
7075 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
7076 check_added_monitors!(nodes[0], 1);
7078 let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
7079 updates.update_add_htlcs[0].onion_routing_packet.version = 1; //Produce a malformed HTLC message
7081 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
7082 check_added_monitors!(nodes[1], 0);
7083 commitment_signed_dance!(nodes[1], nodes[0], updates.commitment_signed, false, true);
7085 let events = nodes[1].node.get_and_clear_pending_msg_events();
7087 let mut update_msg: msgs::UpdateFailMalformedHTLC = {
7089 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, .. } } => {
7090 assert!(update_add_htlcs.is_empty());
7091 assert!(update_fulfill_htlcs.is_empty());
7092 assert!(update_fail_htlcs.is_empty());
7093 assert_eq!(update_fail_malformed_htlcs.len(), 1);
7094 assert!(update_fee.is_none());
7095 update_fail_malformed_htlcs[0].clone()
7097 _ => panic!("Unexpected event"),
7100 update_msg.failure_code &= !0x8000;
7101 nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
7103 assert!(nodes[0].node.list_channels().is_empty());
7104 let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
7105 assert_eq!(err_msg.data, "Got update_fail_malformed_htlc with BADONION not set");
7106 check_added_monitors!(nodes[0], 1);
7110 fn test_update_fulfill_htlc_bolt2_after_malformed_htlc_message_must_forward_update_fail_htlc() {
7111 //BOLT 2 Requirement: a receiving node which has an outgoing HTLC canceled by update_fail_malformed_htlc:
7112 // * 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.
7114 let chanmon_cfgs = create_chanmon_cfgs(3);
7115 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7116 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
7117 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7118 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7119 create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7120 let logger = test_utils::TestLogger::new();
7122 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[2]);
7125 let mut payment_event = {
7126 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
7127 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();
7128 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
7129 check_added_monitors!(nodes[0], 1);
7130 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
7131 assert_eq!(events.len(), 1);
7132 SendEvent::from_event(events.remove(0))
7134 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
7135 check_added_monitors!(nodes[1], 0);
7136 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
7137 expect_pending_htlcs_forwardable!(nodes[1]);
7138 let mut events_2 = nodes[1].node.get_and_clear_pending_msg_events();
7139 assert_eq!(events_2.len(), 1);
7140 check_added_monitors!(nodes[1], 1);
7141 payment_event = SendEvent::from_event(events_2.remove(0));
7142 assert_eq!(payment_event.msgs.len(), 1);
7145 payment_event.msgs[0].onion_routing_packet.version = 1; //Produce a malformed HTLC message
7146 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
7147 check_added_monitors!(nodes[2], 0);
7148 commitment_signed_dance!(nodes[2], nodes[1], payment_event.commitment_msg, false, true);
7150 let events_3 = nodes[2].node.get_and_clear_pending_msg_events();
7151 assert_eq!(events_3.len(), 1);
7152 let update_msg : (msgs::UpdateFailMalformedHTLC, msgs::CommitmentSigned) = {
7154 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 } } => {
7155 assert!(update_add_htlcs.is_empty());
7156 assert!(update_fulfill_htlcs.is_empty());
7157 assert!(update_fail_htlcs.is_empty());
7158 assert_eq!(update_fail_malformed_htlcs.len(), 1);
7159 assert!(update_fee.is_none());
7160 (update_fail_malformed_htlcs[0].clone(), commitment_signed.clone())
7162 _ => panic!("Unexpected event"),
7166 nodes[1].node.handle_update_fail_malformed_htlc(&nodes[2].node.get_our_node_id(), &update_msg.0);
7168 check_added_monitors!(nodes[1], 0);
7169 commitment_signed_dance!(nodes[1], nodes[2], update_msg.1, false, true);
7170 expect_pending_htlcs_forwardable!(nodes[1]);
7171 let events_4 = nodes[1].node.get_and_clear_pending_msg_events();
7172 assert_eq!(events_4.len(), 1);
7174 //Confirm that handlinge the update_malformed_htlc message produces an update_fail_htlc message to be forwarded back along the route
7176 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, .. } } => {
7177 assert!(update_add_htlcs.is_empty());
7178 assert!(update_fulfill_htlcs.is_empty());
7179 assert_eq!(update_fail_htlcs.len(), 1);
7180 assert!(update_fail_malformed_htlcs.is_empty());
7181 assert!(update_fee.is_none());
7183 _ => panic!("Unexpected event"),
7186 check_added_monitors!(nodes[1], 1);
7189 fn do_test_failure_delay_dust_htlc_local_commitment(announce_latest: bool) {
7190 // Dust-HTLC failure updates must be delayed until failure-trigger tx (in this case local commitment) reach ANTI_REORG_DELAY
7191 // 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
7192 // HTLC could have been removed from lastest local commitment tx but still valid until we get remote RAA
7194 let mut chanmon_cfgs = create_chanmon_cfgs(2);
7195 chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
7196 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7197 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7198 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7199 let chan =create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7201 let bs_dust_limit = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().holder_dust_limit_satoshis;
7203 // We route 2 dust-HTLCs between A and B
7204 let (_, payment_hash_1, _) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
7205 let (_, payment_hash_2, _) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
7206 route_payment(&nodes[0], &[&nodes[1]], 1000000);
7208 // Cache one local commitment tx as previous
7209 let as_prev_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
7211 // Fail one HTLC to prune it in the will-be-latest-local commitment tx
7212 assert!(nodes[1].node.fail_htlc_backwards(&payment_hash_2));
7213 check_added_monitors!(nodes[1], 0);
7214 expect_pending_htlcs_forwardable!(nodes[1]);
7215 check_added_monitors!(nodes[1], 1);
7217 let remove = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
7218 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &remove.update_fail_htlcs[0]);
7219 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &remove.commitment_signed);
7220 check_added_monitors!(nodes[0], 1);
7222 // Cache one local commitment tx as lastest
7223 let as_last_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
7225 let events = nodes[0].node.get_and_clear_pending_msg_events();
7227 MessageSendEvent::SendRevokeAndACK { node_id, .. } => {
7228 assert_eq!(node_id, nodes[1].node.get_our_node_id());
7230 _ => panic!("Unexpected event"),
7233 MessageSendEvent::UpdateHTLCs { node_id, .. } => {
7234 assert_eq!(node_id, nodes[1].node.get_our_node_id());
7236 _ => panic!("Unexpected event"),
7239 assert_ne!(as_prev_commitment_tx, as_last_commitment_tx);
7240 // Fail the 2 dust-HTLCs, move their failure in maturation buffer (htlc_updated_waiting_threshold_conf)
7241 if announce_latest {
7242 mine_transaction(&nodes[0], &as_last_commitment_tx[0]);
7244 mine_transaction(&nodes[0], &as_prev_commitment_tx[0]);
7247 check_closed_broadcast!(nodes[0], true);
7248 check_added_monitors!(nodes[0], 1);
7250 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7251 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7252 let events = nodes[0].node.get_and_clear_pending_events();
7253 // Only 2 PaymentFailed events should show up, over-dust HTLC has to be failed by timeout tx
7254 assert_eq!(events.len(), 2);
7255 let mut first_failed = false;
7256 for event in events {
7258 Event::PaymentFailed { payment_hash, .. } => {
7259 if payment_hash == payment_hash_1 {
7260 assert!(!first_failed);
7261 first_failed = true;
7263 assert_eq!(payment_hash, payment_hash_2);
7266 _ => panic!("Unexpected event"),
7272 fn test_failure_delay_dust_htlc_local_commitment() {
7273 do_test_failure_delay_dust_htlc_local_commitment(true);
7274 do_test_failure_delay_dust_htlc_local_commitment(false);
7277 fn do_test_sweep_outbound_htlc_failure_update(revoked: bool, local: bool) {
7278 // Outbound HTLC-failure updates must be cancelled if we get a reorg before we reach ANTI_REORG_DELAY.
7279 // Broadcast of revoked remote commitment tx, trigger failure-update of dust/non-dust HTLCs
7280 // Broadcast of remote commitment tx, trigger failure-update of dust-HTLCs
7281 // Broadcast of timeout tx on remote commitment tx, trigger failure-udate of non-dust HTLCs
7282 // Broadcast of local commitment tx, trigger failure-update of dust-HTLCs
7283 // Broadcast of HTLC-timeout tx on local commitment tx, trigger failure-update of non-dust HTLCs
7285 let chanmon_cfgs = create_chanmon_cfgs(3);
7286 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7287 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
7288 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7289 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7291 let bs_dust_limit = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().holder_dust_limit_satoshis;
7293 let (_payment_preimage_1, dust_hash, _payment_secret_1) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
7294 let (_payment_preimage_2, non_dust_hash, _payment_secret_2) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
7296 let as_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
7297 let bs_commitment_tx = get_local_commitment_txn!(nodes[1], chan.2);
7299 // We revoked bs_commitment_tx
7301 let (payment_preimage_3, _, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
7302 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_3);
7305 let mut timeout_tx = Vec::new();
7307 // We fail dust-HTLC 1 by broadcast of local commitment tx
7308 mine_transaction(&nodes[0], &as_commitment_tx[0]);
7309 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7310 expect_payment_failed!(nodes[0], dust_hash, true);
7312 connect_blocks(&nodes[0], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS - ANTI_REORG_DELAY);
7313 check_closed_broadcast!(nodes[0], true);
7314 check_added_monitors!(nodes[0], 1);
7315 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7316 timeout_tx.push(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[1].clone());
7317 assert_eq!(timeout_tx[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
7318 // We fail non-dust-HTLC 2 by broadcast of local HTLC-timeout tx on local commitment tx
7319 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7320 mine_transaction(&nodes[0], &timeout_tx[0]);
7321 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7322 expect_payment_failed!(nodes[0], non_dust_hash, true);
7324 // We fail dust-HTLC 1 by broadcast of remote commitment tx. If revoked, fail also non-dust HTLC
7325 mine_transaction(&nodes[0], &bs_commitment_tx[0]);
7326 check_closed_broadcast!(nodes[0], true);
7327 check_added_monitors!(nodes[0], 1);
7328 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7329 connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
7330 timeout_tx.push(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[1].clone());
7332 expect_payment_failed!(nodes[0], dust_hash, true);
7333 assert_eq!(timeout_tx[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
7334 // We fail non-dust-HTLC 2 by broadcast of local timeout tx on remote commitment tx
7335 mine_transaction(&nodes[0], &timeout_tx[0]);
7336 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7337 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7338 expect_payment_failed!(nodes[0], non_dust_hash, true);
7340 // If revoked, both dust & non-dust HTLCs should have been failed after ANTI_REORG_DELAY confs of revoked
7342 let events = nodes[0].node.get_and_clear_pending_events();
7343 assert_eq!(events.len(), 2);
7346 Event::PaymentFailed { payment_hash, .. } => {
7347 if payment_hash == dust_hash { first = true; }
7348 else { first = false; }
7350 _ => panic!("Unexpected event"),
7353 Event::PaymentFailed { payment_hash, .. } => {
7354 if first { assert_eq!(payment_hash, non_dust_hash); }
7355 else { assert_eq!(payment_hash, dust_hash); }
7357 _ => panic!("Unexpected event"),
7364 fn test_sweep_outbound_htlc_failure_update() {
7365 do_test_sweep_outbound_htlc_failure_update(false, true);
7366 do_test_sweep_outbound_htlc_failure_update(false, false);
7367 do_test_sweep_outbound_htlc_failure_update(true, false);
7371 fn test_upfront_shutdown_script() {
7372 // BOLT 2 : Option upfront shutdown script, if peer commit its closing_script at channel opening
7373 // enforce it at shutdown message
7375 let mut config = UserConfig::default();
7376 config.channel_options.announced_channel = true;
7377 config.peer_channel_config_limits.force_announced_channel_preference = false;
7378 config.channel_options.commit_upfront_shutdown_pubkey = false;
7379 let user_cfgs = [None, Some(config), None];
7380 let chanmon_cfgs = create_chanmon_cfgs(3);
7381 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7382 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
7383 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7385 // We test that in case of peer committing upfront to a script, if it changes at closing, we refuse to sign
7386 let flags = InitFeatures::known();
7387 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 1000000, 1000000, flags.clone(), flags.clone());
7388 nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7389 let mut node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[2].node.get_our_node_id());
7390 node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
7391 // Test we enforce upfront_scriptpbukey if by providing a diffrent one at closing that we disconnect peer
7392 nodes[2].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
7393 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()));
7394 check_added_monitors!(nodes[2], 1);
7396 // We test that in case of peer committing upfront to a script, if it doesn't change at closing, we sign
7397 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 1000000, 1000000, flags.clone(), flags.clone());
7398 nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7399 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[2].node.get_our_node_id());
7400 // We test that in case of peer committing upfront to a script, if it oesn't change at closing, we sign
7401 nodes[2].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
7402 let events = nodes[2].node.get_and_clear_pending_msg_events();
7403 assert_eq!(events.len(), 1);
7405 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[0].node.get_our_node_id()) }
7406 _ => panic!("Unexpected event"),
7409 // We test that if case of peer non-signaling we don't enforce committed script at channel opening
7410 let flags_no = InitFeatures::known().clear_upfront_shutdown_script();
7411 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, flags_no, flags.clone());
7412 nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7413 let mut node_1_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
7414 node_1_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
7415 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_1_shutdown);
7416 let events = nodes[1].node.get_and_clear_pending_msg_events();
7417 assert_eq!(events.len(), 1);
7419 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[0].node.get_our_node_id()) }
7420 _ => panic!("Unexpected event"),
7423 // We test that if user opt-out, we provide a zero-length script at channel opening and we are able to close
7424 // channel smoothly, opt-out is from channel initiator here
7425 let chan = create_announced_chan_between_nodes_with_value(&nodes, 1, 0, 1000000, 1000000, flags.clone(), flags.clone());
7426 nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7427 let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
7428 node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
7429 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
7430 let events = nodes[0].node.get_and_clear_pending_msg_events();
7431 assert_eq!(events.len(), 1);
7433 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7434 _ => panic!("Unexpected event"),
7437 //// We test that if user opt-out, we provide a zero-length script at channel opening and we are able to close
7438 //// channel smoothly
7439 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, flags.clone(), flags.clone());
7440 nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7441 let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
7442 node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
7443 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
7444 let events = nodes[0].node.get_and_clear_pending_msg_events();
7445 assert_eq!(events.len(), 2);
7447 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7448 _ => panic!("Unexpected event"),
7451 MessageSendEvent::SendClosingSigned { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7452 _ => panic!("Unexpected event"),
7457 fn test_upfront_shutdown_script_unsupport_segwit() {
7458 // We test that channel is closed early
7459 // if a segwit program is passed as upfront shutdown script,
7460 // but the peer does not support segwit.
7461 let chanmon_cfgs = create_chanmon_cfgs(2);
7462 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7463 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7464 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7466 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
7468 let mut open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
7469 open_channel.shutdown_scriptpubkey = Present(Builder::new().push_int(16)
7470 .push_slice(&[0, 0])
7473 let features = InitFeatures::known().clear_shutdown_anysegwit();
7474 nodes[0].node.handle_open_channel(&nodes[0].node.get_our_node_id(), features, &open_channel);
7476 let events = nodes[0].node.get_and_clear_pending_msg_events();
7477 assert_eq!(events.len(), 1);
7479 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
7480 assert_eq!(node_id, nodes[0].node.get_our_node_id());
7481 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));
7483 _ => panic!("Unexpected event"),
7488 fn test_shutdown_script_any_segwit_allowed() {
7489 let mut config = UserConfig::default();
7490 config.channel_options.announced_channel = true;
7491 config.peer_channel_config_limits.force_announced_channel_preference = false;
7492 config.channel_options.commit_upfront_shutdown_pubkey = false;
7493 let user_cfgs = [None, Some(config), None];
7494 let chanmon_cfgs = create_chanmon_cfgs(3);
7495 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7496 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
7497 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7499 //// We test if the remote peer accepts opt_shutdown_anysegwit, a witness program can be used on shutdown
7500 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7501 nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7502 let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
7503 node_0_shutdown.scriptpubkey = Builder::new().push_int(16)
7504 .push_slice(&[0, 0])
7506 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
7507 let events = nodes[0].node.get_and_clear_pending_msg_events();
7508 assert_eq!(events.len(), 2);
7510 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7511 _ => panic!("Unexpected event"),
7514 MessageSendEvent::SendClosingSigned { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7515 _ => panic!("Unexpected event"),
7520 fn test_shutdown_script_any_segwit_not_allowed() {
7521 let mut config = UserConfig::default();
7522 config.channel_options.announced_channel = true;
7523 config.peer_channel_config_limits.force_announced_channel_preference = false;
7524 config.channel_options.commit_upfront_shutdown_pubkey = false;
7525 let user_cfgs = [None, Some(config), None];
7526 let chanmon_cfgs = create_chanmon_cfgs(3);
7527 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7528 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
7529 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7531 //// We test that if the remote peer does not accept opt_shutdown_anysegwit, the witness program cannot be used on shutdown
7532 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7533 nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7534 let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
7535 // Make an any segwit version script
7536 node_0_shutdown.scriptpubkey = Builder::new().push_int(16)
7537 .push_slice(&[0, 0])
7539 let flags_no = InitFeatures::known().clear_shutdown_anysegwit();
7540 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &flags_no, &node_0_shutdown);
7541 let events = nodes[0].node.get_and_clear_pending_msg_events();
7542 assert_eq!(events.len(), 2);
7544 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
7545 assert_eq!(node_id, nodes[1].node.get_our_node_id());
7546 assert_eq!(msg.data, "Got a nonstandard scriptpubkey (60020000) from remote peer".to_owned())
7548 _ => panic!("Unexpected event"),
7550 check_added_monitors!(nodes[0], 1);
7554 fn test_shutdown_script_segwit_but_not_anysegwit() {
7555 let mut config = UserConfig::default();
7556 config.channel_options.announced_channel = true;
7557 config.peer_channel_config_limits.force_announced_channel_preference = false;
7558 config.channel_options.commit_upfront_shutdown_pubkey = false;
7559 let user_cfgs = [None, Some(config), None];
7560 let chanmon_cfgs = create_chanmon_cfgs(3);
7561 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7562 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
7563 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7565 //// We test that if shutdown any segwit is supported and we send a witness script with 0 version, this is not accepted
7566 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7567 nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7568 let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
7569 // Make a segwit script that is not a valid as any segwit
7570 node_0_shutdown.scriptpubkey = Builder::new().push_int(0)
7571 .push_slice(&[0, 0])
7573 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
7574 let events = nodes[0].node.get_and_clear_pending_msg_events();
7575 assert_eq!(events.len(), 2);
7577 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
7578 assert_eq!(node_id, nodes[1].node.get_our_node_id());
7579 assert_eq!(msg.data, "Got a nonstandard scriptpubkey (00020000) from remote peer".to_owned())
7581 _ => panic!("Unexpected event"),
7583 check_added_monitors!(nodes[0], 1);
7587 fn test_user_configurable_csv_delay() {
7588 // We test our channel constructors yield errors when we pass them absurd csv delay
7590 let mut low_our_to_self_config = UserConfig::default();
7591 low_our_to_self_config.own_channel_config.our_to_self_delay = 6;
7592 let mut high_their_to_self_config = UserConfig::default();
7593 high_their_to_self_config.peer_channel_config_limits.their_to_self_delay = 100;
7594 let user_cfgs = [Some(high_their_to_self_config.clone()), None];
7595 let chanmon_cfgs = create_chanmon_cfgs(2);
7596 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7597 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &user_cfgs);
7598 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7600 // We test config.our_to_self > BREAKDOWN_TIMEOUT is enforced in Channel::new_outbound()
7601 if let Err(error) = Channel::new_outbound(&&test_utils::TestFeeEstimator { sat_per_kw: 253 }, &nodes[0].keys_manager, nodes[1].node.get_our_node_id(), 1000000, 1000000, 0, &low_our_to_self_config) {
7603 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())); },
7604 _ => panic!("Unexpected event"),
7606 } else { assert!(false) }
7608 // We test config.our_to_self > BREAKDOWN_TIMEOUT is enforced in Channel::new_from_req()
7609 nodes[1].node.create_channel(nodes[0].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
7610 let mut open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
7611 open_channel.to_self_delay = 200;
7612 if let Err(error) = Channel::new_from_req(&&test_utils::TestFeeEstimator { sat_per_kw: 253 }, &nodes[0].keys_manager, nodes[1].node.get_our_node_id(), InitFeatures::known(), &open_channel, 0, &low_our_to_self_config) {
7614 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())); },
7615 _ => panic!("Unexpected event"),
7617 } else { assert!(false); }
7619 // We test msg.to_self_delay <= config.their_to_self_delay is enforced in Chanel::accept_channel()
7620 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
7621 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()));
7622 let mut accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
7623 accept_channel.to_self_delay = 200;
7624 nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &accept_channel);
7625 if let MessageSendEvent::HandleError { ref action, .. } = nodes[0].node.get_and_clear_pending_msg_events()[0] {
7627 &ErrorAction::SendErrorMessage { ref msg } => {
7628 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()));
7630 _ => { assert!(false); }
7632 } else { assert!(false); }
7634 // We test msg.to_self_delay <= config.their_to_self_delay is enforced in Channel::new_from_req()
7635 nodes[1].node.create_channel(nodes[0].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
7636 let mut open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
7637 open_channel.to_self_delay = 200;
7638 if let Err(error) = Channel::new_from_req(&&test_utils::TestFeeEstimator { sat_per_kw: 253 }, &nodes[0].keys_manager, nodes[1].node.get_our_node_id(), InitFeatures::known(), &open_channel, 0, &high_their_to_self_config) {
7640 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())); },
7641 _ => panic!("Unexpected event"),
7643 } else { assert!(false); }
7647 fn test_data_loss_protect() {
7648 // We want to be sure that :
7649 // * we don't broadcast our Local Commitment Tx in case of fallen behind
7650 // (but this is not quite true - we broadcast during Drop because chanmon is out of sync with chanmgr)
7651 // * we close channel in case of detecting other being fallen behind
7652 // * we are able to claim our own outputs thanks to to_remote being static
7653 // TODO: this test is incomplete and the data_loss_protect implementation is incomplete - see issue #775
7659 let mut chanmon_cfgs = create_chanmon_cfgs(2);
7660 // We broadcast during Drop because chanmon is out of sync with chanmgr, which would cause a panic
7661 // during signing due to revoked tx
7662 chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
7663 let keys_manager = &chanmon_cfgs[0].keys_manager;
7666 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7667 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7668 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7670 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7672 // Cache node A state before any channel update
7673 let previous_node_state = nodes[0].node.encode();
7674 let mut previous_chain_monitor_state = test_utils::TestVecWriter(Vec::new());
7675 nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut previous_chain_monitor_state).unwrap();
7677 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
7678 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
7680 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
7681 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
7683 // Restore node A from previous state
7684 logger = test_utils::TestLogger::with_id(format!("node {}", 0));
7685 let mut chain_monitor = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(&mut ::std::io::Cursor::new(previous_chain_monitor_state.0), keys_manager).unwrap().1;
7686 chain_source = test_utils::TestChainSource::new(Network::Testnet);
7687 tx_broadcaster = test_utils::TestBroadcaster{txn_broadcasted: Mutex::new(Vec::new()), blocks: Arc::new(Mutex::new(Vec::new()))};
7688 fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
7689 persister = test_utils::TestPersister::new();
7690 monitor = test_utils::TestChainMonitor::new(Some(&chain_source), &tx_broadcaster, &logger, &fee_estimator, &persister, keys_manager);
7692 let mut channel_monitors = HashMap::new();
7693 channel_monitors.insert(OutPoint { txid: chan.3.txid(), index: 0 }, &mut chain_monitor);
7694 <(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 {
7695 keys_manager: keys_manager,
7696 fee_estimator: &fee_estimator,
7697 chain_monitor: &monitor,
7699 tx_broadcaster: &tx_broadcaster,
7700 default_config: UserConfig::default(),
7704 nodes[0].node = &node_state_0;
7705 assert!(monitor.watch_channel(OutPoint { txid: chan.3.txid(), index: 0 }, chain_monitor).is_ok());
7706 nodes[0].chain_monitor = &monitor;
7707 nodes[0].chain_source = &chain_source;
7709 check_added_monitors!(nodes[0], 1);
7711 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7712 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7714 let reestablish_0 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
7716 // Check we don't broadcast any transactions following learning of per_commitment_point from B
7717 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_0[0]);
7718 check_added_monitors!(nodes[0], 1);
7721 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
7722 assert_eq!(node_txn.len(), 0);
7725 let mut reestablish_1 = Vec::with_capacity(1);
7726 for msg in nodes[0].node.get_and_clear_pending_msg_events() {
7727 if let MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } = msg {
7728 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
7729 reestablish_1.push(msg.clone());
7730 } else if let MessageSendEvent::BroadcastChannelUpdate { .. } = msg {
7731 } else if let MessageSendEvent::HandleError { ref action, .. } = msg {
7733 &ErrorAction::SendErrorMessage { ref msg } => {
7734 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");
7736 _ => panic!("Unexpected event!"),
7739 panic!("Unexpected event")
7743 // Check we close channel detecting A is fallen-behind
7744 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
7745 assert_eq!(check_closed_broadcast!(nodes[1], true).unwrap().data, "Peer attempted to reestablish channel with a very old local commitment transaction");
7746 check_added_monitors!(nodes[1], 1);
7749 // Check A is able to claim to_remote output
7750 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
7751 assert_eq!(node_txn.len(), 1);
7752 check_spends!(node_txn[0], chan.3);
7753 assert_eq!(node_txn[0].output.len(), 2);
7754 mine_transaction(&nodes[0], &node_txn[0]);
7755 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7756 let spend_txn = check_spendable_outputs!(nodes[0], node_cfgs[0].keys_manager);
7757 assert_eq!(spend_txn.len(), 1);
7758 check_spends!(spend_txn[0], node_txn[0]);
7762 fn test_check_htlc_underpaying() {
7763 // Send payment through A -> B but A is maliciously
7764 // sending a probe payment (i.e less than expected value0
7765 // to B, B should refuse payment.
7767 let chanmon_cfgs = create_chanmon_cfgs(2);
7768 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7769 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7770 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7772 // Create some initial channels
7773 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7775 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();
7776 let (_, our_payment_hash, _) = get_payment_preimage_hash!(nodes[0]);
7777 let our_payment_secret = nodes[1].node.create_inbound_payment_for_hash(our_payment_hash, Some(100_000), 7200, 0).unwrap();
7778 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
7779 check_added_monitors!(nodes[0], 1);
7781 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
7782 assert_eq!(events.len(), 1);
7783 let mut payment_event = SendEvent::from_event(events.pop().unwrap());
7784 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
7785 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
7787 // Note that we first have to wait a random delay before processing the receipt of the HTLC,
7788 // and then will wait a second random delay before failing the HTLC back:
7789 expect_pending_htlcs_forwardable!(nodes[1]);
7790 expect_pending_htlcs_forwardable!(nodes[1]);
7792 // Node 3 is expecting payment of 100_000 but received 10_000,
7793 // it should fail htlc like we didn't know the preimage.
7794 nodes[1].node.process_pending_htlc_forwards();
7796 let events = nodes[1].node.get_and_clear_pending_msg_events();
7797 assert_eq!(events.len(), 1);
7798 let (update_fail_htlc, commitment_signed) = match events[0] {
7799 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 } } => {
7800 assert!(update_add_htlcs.is_empty());
7801 assert!(update_fulfill_htlcs.is_empty());
7802 assert_eq!(update_fail_htlcs.len(), 1);
7803 assert!(update_fail_malformed_htlcs.is_empty());
7804 assert!(update_fee.is_none());
7805 (update_fail_htlcs[0].clone(), commitment_signed)
7807 _ => panic!("Unexpected event"),
7809 check_added_monitors!(nodes[1], 1);
7811 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlc);
7812 commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
7814 // 10_000 msat as u64, followed by a height of CHAN_CONFIRM_DEPTH as u32
7815 let mut expected_failure_data = byte_utils::be64_to_array(10_000).to_vec();
7816 expected_failure_data.extend_from_slice(&byte_utils::be32_to_array(CHAN_CONFIRM_DEPTH));
7817 expect_payment_failed!(nodes[0], our_payment_hash, true, 0x4000|15, &expected_failure_data[..]);
7821 fn test_announce_disable_channels() {
7822 // Create 2 channels between A and B. Disconnect B. Call timer_tick_occurred and check for generated
7823 // ChannelUpdate. Reconnect B, reestablish and check there is non-generated ChannelUpdate.
7825 let chanmon_cfgs = create_chanmon_cfgs(2);
7826 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7827 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7828 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7830 let short_id_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
7831 let short_id_2 = create_announced_chan_between_nodes(&nodes, 1, 0, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
7832 let short_id_3 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
7835 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
7836 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
7838 nodes[0].node.timer_tick_occurred(); // Enabled -> DisabledStaged
7839 nodes[0].node.timer_tick_occurred(); // DisabledStaged -> Disabled
7840 let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
7841 assert_eq!(msg_events.len(), 3);
7842 let mut chans_disabled: HashSet<u64> = [short_id_1, short_id_2, short_id_3].iter().map(|a| *a).collect();
7843 for e in msg_events {
7845 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
7846 assert_eq!(msg.contents.flags & (1<<1), 1<<1); // The "channel disabled" bit should be set
7847 // Check that each channel gets updated exactly once
7848 if !chans_disabled.remove(&msg.contents.short_channel_id) {
7849 panic!("Generated ChannelUpdate for wrong chan!");
7852 _ => panic!("Unexpected event"),
7856 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7857 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
7858 assert_eq!(reestablish_1.len(), 3);
7859 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7860 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
7861 assert_eq!(reestablish_2.len(), 3);
7863 // Reestablish chan_1
7864 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
7865 handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
7866 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
7867 handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
7868 // Reestablish chan_2
7869 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[1]);
7870 handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
7871 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[1]);
7872 handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
7873 // Reestablish chan_3
7874 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[2]);
7875 handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
7876 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[2]);
7877 handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
7879 nodes[0].node.timer_tick_occurred();
7880 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
7881 nodes[0].node.timer_tick_occurred();
7882 let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
7883 assert_eq!(msg_events.len(), 3);
7884 chans_disabled = [short_id_1, short_id_2, short_id_3].iter().map(|a| *a).collect();
7885 for e in msg_events {
7887 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
7888 assert_eq!(msg.contents.flags & (1<<1), 0); // The "channel disabled" bit should be off
7889 // Check that each channel gets updated exactly once
7890 if !chans_disabled.remove(&msg.contents.short_channel_id) {
7891 panic!("Generated ChannelUpdate for wrong chan!");
7894 _ => panic!("Unexpected event"),
7900 fn test_bump_penalty_txn_on_revoked_commitment() {
7901 // In case of penalty txn with too low feerates for getting into mempools, RBF-bump them to be sure
7902 // we're able to claim outputs on revoked commitment transaction before timelocks expiration
7904 let chanmon_cfgs = create_chanmon_cfgs(2);
7905 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7906 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7907 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7909 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
7910 let logger = test_utils::TestLogger::new();
7912 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
7913 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
7914 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();
7915 send_along_route(&nodes[1], route, &vec!(&nodes[0])[..], 3000000);
7917 let revoked_txn = get_local_commitment_txn!(nodes[0], chan.2);
7918 // Revoked commitment txn with 4 outputs : to_local, to_remote, 1 outgoing HTLC, 1 incoming HTLC
7919 assert_eq!(revoked_txn[0].output.len(), 4);
7920 assert_eq!(revoked_txn[0].input.len(), 1);
7921 assert_eq!(revoked_txn[0].input[0].previous_output.txid, chan.3.txid());
7922 let revoked_txid = revoked_txn[0].txid();
7924 let mut penalty_sum = 0;
7925 for outp in revoked_txn[0].output.iter() {
7926 if outp.script_pubkey.is_v0_p2wsh() {
7927 penalty_sum += outp.value;
7931 // Connect blocks to change height_timer range to see if we use right soonest_timelock
7932 let header_114 = connect_blocks(&nodes[1], 14);
7934 // Actually revoke tx by claiming a HTLC
7935 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
7936 let header = BlockHeader { version: 0x20000000, prev_blockhash: header_114, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7937 connect_block(&nodes[1], &Block { header, txdata: vec![revoked_txn[0].clone()] });
7938 check_added_monitors!(nodes[1], 1);
7940 // One or more justice tx should have been broadcast, check it
7944 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7945 assert_eq!(node_txn.len(), 2); // justice tx (broadcasted from ChannelMonitor) + local commitment tx
7946 assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
7947 assert_eq!(node_txn[0].output.len(), 1);
7948 check_spends!(node_txn[0], revoked_txn[0]);
7949 let fee_1 = penalty_sum - node_txn[0].output[0].value;
7950 feerate_1 = fee_1 * 1000 / node_txn[0].get_weight() as u64;
7951 penalty_1 = node_txn[0].txid();
7955 // After exhaustion of height timer, a new bumped justice tx should have been broadcast, check it
7956 connect_blocks(&nodes[1], 15);
7957 let mut penalty_2 = penalty_1;
7958 let mut feerate_2 = 0;
7960 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7961 assert_eq!(node_txn.len(), 1);
7962 if node_txn[0].input[0].previous_output.txid == revoked_txid {
7963 assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
7964 assert_eq!(node_txn[0].output.len(), 1);
7965 check_spends!(node_txn[0], revoked_txn[0]);
7966 penalty_2 = node_txn[0].txid();
7967 // Verify new bumped tx is different from last claiming transaction, we don't want spurrious rebroadcast
7968 assert_ne!(penalty_2, penalty_1);
7969 let fee_2 = penalty_sum - node_txn[0].output[0].value;
7970 feerate_2 = fee_2 * 1000 / node_txn[0].get_weight() as u64;
7971 // Verify 25% bump heuristic
7972 assert!(feerate_2 * 100 >= feerate_1 * 125);
7976 assert_ne!(feerate_2, 0);
7978 // After exhaustion of height timer for a 2nd time, a new bumped justice tx should have been broadcast, check it
7979 connect_blocks(&nodes[1], 1);
7981 let mut feerate_3 = 0;
7983 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7984 assert_eq!(node_txn.len(), 1);
7985 if node_txn[0].input[0].previous_output.txid == revoked_txid {
7986 assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
7987 assert_eq!(node_txn[0].output.len(), 1);
7988 check_spends!(node_txn[0], revoked_txn[0]);
7989 penalty_3 = node_txn[0].txid();
7990 // Verify new bumped tx is different from last claiming transaction, we don't want spurrious rebroadcast
7991 assert_ne!(penalty_3, penalty_2);
7992 let fee_3 = penalty_sum - node_txn[0].output[0].value;
7993 feerate_3 = fee_3 * 1000 / node_txn[0].get_weight() as u64;
7994 // Verify 25% bump heuristic
7995 assert!(feerate_3 * 100 >= feerate_2 * 125);
7999 assert_ne!(feerate_3, 0);
8001 nodes[1].node.get_and_clear_pending_events();
8002 nodes[1].node.get_and_clear_pending_msg_events();
8006 fn test_bump_penalty_txn_on_revoked_htlcs() {
8007 // In case of penalty txn with too low feerates for getting into mempools, RBF-bump them to sure
8008 // we're able to claim outputs on revoked HTLC transactions before timelocks expiration
8010 let mut chanmon_cfgs = create_chanmon_cfgs(2);
8011 chanmon_cfgs[1].keys_manager.disable_revocation_policy_check = true;
8012 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8013 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8014 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8016 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
8017 // Lock HTLC in both directions (using a slightly lower CLTV delay to provide timely RBF bumps)
8018 let route = get_route(&nodes[0].node.get_our_node_id(), &nodes[0].net_graph_msg_handler.network_graph.read().unwrap(),
8019 &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 3_000_000, 50, nodes[0].logger).unwrap();
8020 let payment_preimage = send_along_route(&nodes[0], route, &[&nodes[1]], 3_000_000).0;
8021 let route = get_route(&nodes[1].node.get_our_node_id(), &nodes[1].net_graph_msg_handler.network_graph.read().unwrap(),
8022 &nodes[0].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 3_000_000, 50, nodes[0].logger).unwrap();
8023 send_along_route(&nodes[1], route, &[&nodes[0]], 3_000_000);
8025 let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan.2);
8026 assert_eq!(revoked_local_txn[0].input.len(), 1);
8027 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
8029 // Revoke local commitment tx
8030 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
8032 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8033 // B will generate both revoked HTLC-timeout/HTLC-preimage txn from revoked commitment tx
8034 connect_block(&nodes[1], &Block { header, txdata: vec![revoked_local_txn[0].clone()] });
8035 check_closed_broadcast!(nodes[1], true);
8036 check_added_monitors!(nodes[1], 1);
8037 connect_blocks(&nodes[1], 49); // Confirm blocks until the HTLC expires (note CLTV was explicitly 50 above)
8039 let revoked_htlc_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8040 assert_eq!(revoked_htlc_txn.len(), 3);
8041 check_spends!(revoked_htlc_txn[1], chan.3);
8043 assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
8044 assert_eq!(revoked_htlc_txn[0].input.len(), 1);
8045 check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
8047 assert_eq!(revoked_htlc_txn[2].input.len(), 1);
8048 assert_eq!(revoked_htlc_txn[2].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
8049 assert_eq!(revoked_htlc_txn[2].output.len(), 1);
8050 check_spends!(revoked_htlc_txn[2], revoked_local_txn[0]);
8052 // Broadcast set of revoked txn on A
8053 let hash_128 = connect_blocks(&nodes[0], 40);
8054 let header_11 = BlockHeader { version: 0x20000000, prev_blockhash: hash_128, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8055 connect_block(&nodes[0], &Block { header: header_11, txdata: vec![revoked_local_txn[0].clone()] });
8056 let header_129 = BlockHeader { version: 0x20000000, prev_blockhash: header_11.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8057 connect_block(&nodes[0], &Block { header: header_129, txdata: vec![revoked_htlc_txn[0].clone(), revoked_htlc_txn[2].clone()] });
8058 expect_pending_htlcs_forwardable_ignore!(nodes[0]);
8063 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8064 assert_eq!(node_txn.len(), 5); // 3 penalty txn on revoked commitment tx + A commitment tx + 1 penalty tnx on revoked HTLC txn
8065 // Verify claim tx are spending revoked HTLC txn
8067 // node_txn 0-2 each spend a separate revoked output from revoked_local_txn[0]
8068 // Note that node_txn[0] and node_txn[1] are bogus - they double spend the revoked_htlc_txn
8069 // which are included in the same block (they are broadcasted because we scan the
8070 // transactions linearly and generate claims as we go, they likely should be removed in the
8072 assert_eq!(node_txn[0].input.len(), 1);
8073 check_spends!(node_txn[0], revoked_local_txn[0]);
8074 assert_eq!(node_txn[1].input.len(), 1);
8075 check_spends!(node_txn[1], revoked_local_txn[0]);
8076 assert_eq!(node_txn[2].input.len(), 1);
8077 check_spends!(node_txn[2], revoked_local_txn[0]);
8079 // Each of the three justice transactions claim a separate (single) output of the three
8080 // available, which we check here:
8081 assert_ne!(node_txn[0].input[0].previous_output, node_txn[1].input[0].previous_output);
8082 assert_ne!(node_txn[0].input[0].previous_output, node_txn[2].input[0].previous_output);
8083 assert_ne!(node_txn[1].input[0].previous_output, node_txn[2].input[0].previous_output);
8085 assert_eq!(node_txn[0].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
8086 assert_eq!(node_txn[1].input[0].previous_output, revoked_htlc_txn[2].input[0].previous_output);
8088 // node_txn[3] is the local commitment tx broadcast just because (and somewhat in case of
8089 // reorgs, though its not clear its ever worth broadcasting conflicting txn like this when
8090 // a remote commitment tx has already been confirmed).
8091 check_spends!(node_txn[3], chan.3);
8093 // node_txn[4] spends the revoked outputs from the revoked_htlc_txn (which only have one
8094 // output, checked above).
8095 assert_eq!(node_txn[4].input.len(), 2);
8096 assert_eq!(node_txn[4].output.len(), 1);
8097 check_spends!(node_txn[4], revoked_htlc_txn[0], revoked_htlc_txn[2]);
8099 first = node_txn[4].txid();
8100 // Store both feerates for later comparison
8101 let fee_1 = revoked_htlc_txn[0].output[0].value + revoked_htlc_txn[2].output[0].value - node_txn[4].output[0].value;
8102 feerate_1 = fee_1 * 1000 / node_txn[4].get_weight() as u64;
8103 penalty_txn = vec![node_txn[2].clone()];
8107 // Connect one more block to see if bumped penalty are issued for HTLC txn
8108 let header_130 = BlockHeader { version: 0x20000000, prev_blockhash: header_129.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8109 connect_block(&nodes[0], &Block { header: header_130, txdata: penalty_txn });
8110 let header_131 = BlockHeader { version: 0x20000000, prev_blockhash: header_130.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8111 connect_block(&nodes[0], &Block { header: header_131, txdata: Vec::new() });
8113 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8114 assert_eq!(node_txn.len(), 2); // 2 bumped penalty txn on revoked commitment tx
8116 check_spends!(node_txn[0], revoked_local_txn[0]);
8117 check_spends!(node_txn[1], revoked_local_txn[0]);
8118 // Note that these are both bogus - they spend outputs already claimed in block 129:
8119 if node_txn[0].input[0].previous_output == revoked_htlc_txn[0].input[0].previous_output {
8120 assert_eq!(node_txn[1].input[0].previous_output, revoked_htlc_txn[2].input[0].previous_output);
8122 assert_eq!(node_txn[0].input[0].previous_output, revoked_htlc_txn[2].input[0].previous_output);
8123 assert_eq!(node_txn[1].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
8129 // Few more blocks to confirm penalty txn
8130 connect_blocks(&nodes[0], 4);
8131 assert!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
8132 let header_144 = connect_blocks(&nodes[0], 9);
8134 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8135 assert_eq!(node_txn.len(), 1);
8137 assert_eq!(node_txn[0].input.len(), 2);
8138 check_spends!(node_txn[0], revoked_htlc_txn[0], revoked_htlc_txn[2]);
8139 // Verify bumped tx is different and 25% bump heuristic
8140 assert_ne!(first, node_txn[0].txid());
8141 let fee_2 = revoked_htlc_txn[0].output[0].value + revoked_htlc_txn[2].output[0].value - node_txn[0].output[0].value;
8142 let feerate_2 = fee_2 * 1000 / node_txn[0].get_weight() as u64;
8143 assert!(feerate_2 * 100 > feerate_1 * 125);
8144 let txn = vec![node_txn[0].clone()];
8148 // Broadcast claim txn and confirm blocks to avoid further bumps on this outputs
8149 let header_145 = BlockHeader { version: 0x20000000, prev_blockhash: header_144, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8150 connect_block(&nodes[0], &Block { header: header_145, txdata: node_txn });
8151 connect_blocks(&nodes[0], 20);
8153 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8154 // We verify than no new transaction has been broadcast because previously
8155 // we were buggy on this exact behavior by not tracking for monitoring remote HTLC outputs (see #411)
8156 // which means we wouldn't see a spend of them by a justice tx and bumped justice tx
8157 // were generated forever instead of safe cleaning after confirmation and ANTI_REORG_SAFE_DELAY blocks.
8158 // Enforce spending of revoked htlc output by claiming transaction remove request as expected and dry
8159 // up bumped justice generation.
8160 assert_eq!(node_txn.len(), 0);
8163 check_closed_broadcast!(nodes[0], true);
8164 check_added_monitors!(nodes[0], 1);
8168 fn test_bump_penalty_txn_on_remote_commitment() {
8169 // In case of claim txn with too low feerates for getting into mempools, RBF-bump them to be sure
8170 // we're able to claim outputs on remote commitment transaction before timelocks expiration
8173 // Provide preimage for one
8174 // Check aggregation
8176 let chanmon_cfgs = create_chanmon_cfgs(2);
8177 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8178 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8179 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8181 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
8182 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
8183 route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000).0;
8185 // Remote commitment txn with 4 outputs : to_local, to_remote, 1 outgoing HTLC, 1 incoming HTLC
8186 let remote_txn = get_local_commitment_txn!(nodes[0], chan.2);
8187 assert_eq!(remote_txn[0].output.len(), 4);
8188 assert_eq!(remote_txn[0].input.len(), 1);
8189 assert_eq!(remote_txn[0].input[0].previous_output.txid, chan.3.txid());
8191 // Claim a HTLC without revocation (provide B monitor with preimage)
8192 nodes[1].node.claim_funds(payment_preimage);
8193 mine_transaction(&nodes[1], &remote_txn[0]);
8194 check_added_monitors!(nodes[1], 2);
8195 connect_blocks(&nodes[1], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
8197 // One or more claim tx should have been broadcast, check it
8201 let feerate_timeout;
8202 let feerate_preimage;
8204 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8205 // 9 transactions including:
8206 // 1*2 ChannelManager local broadcasts of commitment + HTLC-Success
8207 // 1*3 ChannelManager local broadcasts of commitment + HTLC-Success + HTLC-Timeout
8208 // 2 * HTLC-Success (one RBF bump we'll check later)
8210 assert_eq!(node_txn.len(), 8);
8211 assert_eq!(node_txn[0].input.len(), 1);
8212 assert_eq!(node_txn[6].input.len(), 1);
8213 check_spends!(node_txn[0], remote_txn[0]);
8214 check_spends!(node_txn[6], remote_txn[0]);
8215 assert_eq!(node_txn[0].input[0].previous_output, node_txn[3].input[0].previous_output);
8216 preimage_bump = node_txn[3].clone();
8218 check_spends!(node_txn[1], chan.3);
8219 check_spends!(node_txn[2], node_txn[1]);
8220 assert_eq!(node_txn[1], node_txn[4]);
8221 assert_eq!(node_txn[2], node_txn[5]);
8223 timeout = node_txn[6].txid();
8224 let index = node_txn[6].input[0].previous_output.vout;
8225 let fee = remote_txn[0].output[index as usize].value - node_txn[6].output[0].value;
8226 feerate_timeout = fee * 1000 / node_txn[6].get_weight() as u64;
8228 preimage = node_txn[0].txid();
8229 let index = node_txn[0].input[0].previous_output.vout;
8230 let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
8231 feerate_preimage = fee * 1000 / node_txn[0].get_weight() as u64;
8235 assert_ne!(feerate_timeout, 0);
8236 assert_ne!(feerate_preimage, 0);
8238 // After exhaustion of height timer, new bumped claim txn should have been broadcast, check it
8239 connect_blocks(&nodes[1], 15);
8241 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8242 assert_eq!(node_txn.len(), 1);
8243 assert_eq!(node_txn[0].input.len(), 1);
8244 assert_eq!(preimage_bump.input.len(), 1);
8245 check_spends!(node_txn[0], remote_txn[0]);
8246 check_spends!(preimage_bump, remote_txn[0]);
8248 let index = preimage_bump.input[0].previous_output.vout;
8249 let fee = remote_txn[0].output[index as usize].value - preimage_bump.output[0].value;
8250 let new_feerate = fee * 1000 / preimage_bump.get_weight() as u64;
8251 assert!(new_feerate * 100 > feerate_timeout * 125);
8252 assert_ne!(timeout, preimage_bump.txid());
8254 let index = node_txn[0].input[0].previous_output.vout;
8255 let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
8256 let new_feerate = fee * 1000 / node_txn[0].get_weight() as u64;
8257 assert!(new_feerate * 100 > feerate_preimage * 125);
8258 assert_ne!(preimage, node_txn[0].txid());
8263 nodes[1].node.get_and_clear_pending_events();
8264 nodes[1].node.get_and_clear_pending_msg_events();
8268 fn test_counterparty_raa_skip_no_crash() {
8269 // Previously, if our counterparty sent two RAAs in a row without us having provided a
8270 // commitment transaction, we would have happily carried on and provided them the next
8271 // commitment transaction based on one RAA forward. This would probably eventually have led to
8272 // channel closure, but it would not have resulted in funds loss. Still, our
8273 // EnforcingSigner would have paniced as it doesn't like jumps into the future. Here, we
8274 // check simply that the channel is closed in response to such an RAA, but don't check whether
8275 // we decide to punish our counterparty for revoking their funds (as we don't currently
8277 let chanmon_cfgs = create_chanmon_cfgs(2);
8278 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8279 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8280 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8281 let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).2;
8283 let mut guard = nodes[0].node.channel_state.lock().unwrap();
8284 let keys = &guard.by_id.get_mut(&channel_id).unwrap().get_signer();
8285 const INITIAL_COMMITMENT_NUMBER: u64 = (1 << 48) - 1;
8286 let per_commitment_secret = keys.release_commitment_secret(INITIAL_COMMITMENT_NUMBER);
8287 // Must revoke without gaps
8288 keys.release_commitment_secret(INITIAL_COMMITMENT_NUMBER - 1);
8289 let next_per_commitment_point = PublicKey::from_secret_key(&Secp256k1::new(),
8290 &SecretKey::from_slice(&keys.release_commitment_secret(INITIAL_COMMITMENT_NUMBER - 2)).unwrap());
8292 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(),
8293 &msgs::RevokeAndACK { channel_id, per_commitment_secret, next_per_commitment_point });
8294 assert_eq!(check_closed_broadcast!(nodes[1], true).unwrap().data, "Received an unexpected revoke_and_ack");
8295 check_added_monitors!(nodes[1], 1);
8299 fn test_bump_txn_sanitize_tracking_maps() {
8300 // Sanitizing pendning_claim_request and claimable_outpoints used to be buggy,
8301 // verify we clean then right after expiration of ANTI_REORG_DELAY.
8303 let chanmon_cfgs = create_chanmon_cfgs(2);
8304 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8305 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8306 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8308 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
8309 // Lock HTLC in both directions
8310 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000).0;
8311 route_payment(&nodes[1], &vec!(&nodes[0])[..], 9_000_000).0;
8313 let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan.2);
8314 assert_eq!(revoked_local_txn[0].input.len(), 1);
8315 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
8317 // Revoke local commitment tx
8318 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
8320 // Broadcast set of revoked txn on A
8321 connect_blocks(&nodes[0], TEST_FINAL_CLTV + 2 - CHAN_CONFIRM_DEPTH);
8322 expect_pending_htlcs_forwardable_ignore!(nodes[0]);
8323 assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 0);
8325 mine_transaction(&nodes[0], &revoked_local_txn[0]);
8326 check_closed_broadcast!(nodes[0], true);
8327 check_added_monitors!(nodes[0], 1);
8329 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8330 assert_eq!(node_txn.len(), 4); //ChannelMonitor: justice txn * 3, ChannelManager: local commitment tx
8331 check_spends!(node_txn[0], revoked_local_txn[0]);
8332 check_spends!(node_txn[1], revoked_local_txn[0]);
8333 check_spends!(node_txn[2], revoked_local_txn[0]);
8334 let penalty_txn = vec![node_txn[0].clone(), node_txn[1].clone(), node_txn[2].clone()];
8338 let header_130 = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8339 connect_block(&nodes[0], &Block { header: header_130, txdata: penalty_txn });
8340 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
8342 let monitors = nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap();
8343 if let Some(monitor) = monitors.get(&OutPoint { txid: chan.3.txid(), index: 0 }) {
8344 assert!(monitor.inner.lock().unwrap().onchain_tx_handler.pending_claim_requests.is_empty());
8345 assert!(monitor.inner.lock().unwrap().onchain_tx_handler.claimable_outpoints.is_empty());
8351 fn test_override_channel_config() {
8352 let chanmon_cfgs = create_chanmon_cfgs(2);
8353 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8354 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8355 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8357 // Node0 initiates a channel to node1 using the override config.
8358 let mut override_config = UserConfig::default();
8359 override_config.own_channel_config.our_to_self_delay = 200;
8361 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 16_000_000, 12_000_000, 42, Some(override_config)).unwrap();
8363 // Assert the channel created by node0 is using the override config.
8364 let res = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8365 assert_eq!(res.channel_flags, 0);
8366 assert_eq!(res.to_self_delay, 200);
8370 fn test_override_0msat_htlc_minimum() {
8371 let mut zero_config = UserConfig::default();
8372 zero_config.own_channel_config.our_htlc_minimum_msat = 0;
8373 let chanmon_cfgs = create_chanmon_cfgs(2);
8374 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8375 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, Some(zero_config.clone())]);
8376 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8378 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 16_000_000, 12_000_000, 42, Some(zero_config)).unwrap();
8379 let res = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8380 assert_eq!(res.htlc_minimum_msat, 1);
8382 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &res);
8383 let res = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
8384 assert_eq!(res.htlc_minimum_msat, 1);
8388 fn test_simple_mpp() {
8389 // Simple test of sending a multi-path payment.
8390 let chanmon_cfgs = create_chanmon_cfgs(4);
8391 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
8392 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
8393 let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
8395 let chan_1_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8396 let chan_2_id = create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8397 let chan_3_id = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8398 let chan_4_id = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8399 let logger = test_utils::TestLogger::new();
8401 let (payment_preimage, payment_hash, payment_secret) = get_payment_preimage_hash!(&nodes[3]);
8402 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
8403 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();
8404 let path = route.paths[0].clone();
8405 route.paths.push(path);
8406 route.paths[0][0].pubkey = nodes[1].node.get_our_node_id();
8407 route.paths[0][0].short_channel_id = chan_1_id;
8408 route.paths[0][1].short_channel_id = chan_3_id;
8409 route.paths[1][0].pubkey = nodes[2].node.get_our_node_id();
8410 route.paths[1][0].short_channel_id = chan_2_id;
8411 route.paths[1][1].short_channel_id = chan_4_id;
8412 send_along_route_with_secret(&nodes[0], route, &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], 200_000, payment_hash, payment_secret);
8413 claim_payment_along_route(&nodes[0], &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], false, payment_preimage);
8417 fn test_preimage_storage() {
8418 // Simple test of payment preimage storage allowing no client-side storage to claim payments
8419 let chanmon_cfgs = create_chanmon_cfgs(2);
8420 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8421 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8422 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8424 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8427 let (payment_hash, payment_secret) = nodes[1].node.create_inbound_payment(Some(100_000), 7200, 42);
8429 let logger = test_utils::TestLogger::new();
8430 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
8431 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();
8432 nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
8433 check_added_monitors!(nodes[0], 1);
8434 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
8435 let mut payment_event = SendEvent::from_event(events.pop().unwrap());
8436 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
8437 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
8439 // Note that after leaving the above scope we have no knowledge of any arguments or return
8440 // values from previous calls.
8441 expect_pending_htlcs_forwardable!(nodes[1]);
8442 let events = nodes[1].node.get_and_clear_pending_events();
8443 assert_eq!(events.len(), 1);
8445 Event::PaymentReceived { payment_preimage, user_payment_id, .. } => {
8446 assert_eq!(user_payment_id, 42);
8447 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage.unwrap());
8449 _ => panic!("Unexpected event"),
8454 fn test_secret_timeout() {
8455 // Simple test of payment secret storage time outs
8456 let chanmon_cfgs = create_chanmon_cfgs(2);
8457 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8458 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8459 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8461 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8463 let (payment_hash, payment_secret_1) = nodes[1].node.create_inbound_payment(Some(100_000), 2, 0);
8465 // We should fail to register the same payment hash twice, at least until we've connected a
8466 // block with time 7200 + CHAN_CONFIRM_DEPTH + 1.
8467 if let Err(APIError::APIMisuseError { err }) = nodes[1].node.create_inbound_payment_for_hash(payment_hash, Some(100_000), 2, 0) {
8468 assert_eq!(err, "Duplicate payment hash");
8469 } else { panic!(); }
8471 let node_1_blocks = nodes[1].blocks.lock().unwrap();
8473 header: BlockHeader {
8475 prev_blockhash: node_1_blocks.last().unwrap().0.block_hash(),
8476 merkle_root: Default::default(),
8477 time: node_1_blocks.len() as u32 + 7200, bits: 42, nonce: 42 },
8481 connect_block(&nodes[1], &block);
8482 if let Err(APIError::APIMisuseError { err }) = nodes[1].node.create_inbound_payment_for_hash(payment_hash, Some(100_000), 2, 0) {
8483 assert_eq!(err, "Duplicate payment hash");
8484 } else { panic!(); }
8486 // If we then connect the second block, we should be able to register the same payment hash
8487 // again with a different user_payment_id (this time getting a new payment secret).
8488 block.header.prev_blockhash = block.header.block_hash();
8489 block.header.time += 1;
8490 connect_block(&nodes[1], &block);
8491 let our_payment_secret = nodes[1].node.create_inbound_payment_for_hash(payment_hash, Some(100_000), 2, 42).unwrap();
8492 assert_ne!(payment_secret_1, our_payment_secret);
8495 let logger = test_utils::TestLogger::new();
8496 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
8497 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();
8498 nodes[0].node.send_payment(&route, payment_hash, &Some(our_payment_secret)).unwrap();
8499 check_added_monitors!(nodes[0], 1);
8500 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
8501 let mut payment_event = SendEvent::from_event(events.pop().unwrap());
8502 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
8503 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
8505 // Note that after leaving the above scope we have no knowledge of any arguments or return
8506 // values from previous calls.
8507 expect_pending_htlcs_forwardable!(nodes[1]);
8508 let events = nodes[1].node.get_and_clear_pending_events();
8509 assert_eq!(events.len(), 1);
8511 Event::PaymentReceived { payment_preimage, payment_secret, user_payment_id, .. } => {
8512 assert!(payment_preimage.is_none());
8513 assert_eq!(user_payment_id, 42);
8514 assert_eq!(payment_secret, our_payment_secret);
8515 // We don't actually have the payment preimage with which to claim this payment!
8517 _ => panic!("Unexpected event"),
8522 fn test_bad_secret_hash() {
8523 // Simple test of unregistered payment hash/invalid payment secret handling
8524 let chanmon_cfgs = create_chanmon_cfgs(2);
8525 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8526 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8527 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8529 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8531 let random_payment_hash = PaymentHash([42; 32]);
8532 let random_payment_secret = PaymentSecret([43; 32]);
8533 let (our_payment_hash, our_payment_secret) = nodes[1].node.create_inbound_payment(Some(100_000), 2, 0);
8535 let logger = test_utils::TestLogger::new();
8536 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
8537 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();
8539 // All the below cases should end up being handled exactly identically, so we macro the
8540 // resulting events.
8541 macro_rules! handle_unknown_invalid_payment_data {
8543 check_added_monitors!(nodes[0], 1);
8544 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
8545 let payment_event = SendEvent::from_event(events.pop().unwrap());
8546 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
8547 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
8549 // We have to forward pending HTLCs once to process the receipt of the HTLC and then
8550 // again to process the pending backwards-failure of the HTLC
8551 expect_pending_htlcs_forwardable!(nodes[1]);
8552 expect_pending_htlcs_forwardable!(nodes[1]);
8553 check_added_monitors!(nodes[1], 1);
8555 // We should fail the payment back
8556 let mut events = nodes[1].node.get_and_clear_pending_msg_events();
8557 match events.pop().unwrap() {
8558 MessageSendEvent::UpdateHTLCs { node_id: _, updates: msgs::CommitmentUpdate { update_fail_htlcs, commitment_signed, .. } } => {
8559 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
8560 commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false);
8562 _ => panic!("Unexpected event"),
8567 let expected_error_code = 0x4000|15; // incorrect_or_unknown_payment_details
8568 // Error data is the HTLC value (100,000) and current block height
8569 let expected_error_data = [0, 0, 0, 0, 0, 1, 0x86, 0xa0, 0, 0, 0, CHAN_CONFIRM_DEPTH as u8];
8571 // Send a payment with the right payment hash but the wrong payment secret
8572 nodes[0].node.send_payment(&route, our_payment_hash, &Some(random_payment_secret)).unwrap();
8573 handle_unknown_invalid_payment_data!();
8574 expect_payment_failed!(nodes[0], our_payment_hash, true, expected_error_code, expected_error_data);
8576 // Send a payment with a random payment hash, but the right payment secret
8577 nodes[0].node.send_payment(&route, random_payment_hash, &Some(our_payment_secret)).unwrap();
8578 handle_unknown_invalid_payment_data!();
8579 expect_payment_failed!(nodes[0], random_payment_hash, true, expected_error_code, expected_error_data);
8581 // Send a payment with a random payment hash and random payment secret
8582 nodes[0].node.send_payment(&route, random_payment_hash, &Some(random_payment_secret)).unwrap();
8583 handle_unknown_invalid_payment_data!();
8584 expect_payment_failed!(nodes[0], random_payment_hash, true, expected_error_code, expected_error_data);
8588 fn test_update_err_monitor_lockdown() {
8589 // Our monitor will lock update of local commitment transaction if a broadcastion condition
8590 // has been fulfilled (either force-close from Channel or block height requiring a HTLC-
8591 // timeout). Trying to update monitor after lockdown should return a ChannelMonitorUpdateErr.
8593 // This scenario may happen in a watchtower setup, where watchtower process a block height
8594 // triggering a timeout while a slow-block-processing ChannelManager receives a local signed
8595 // commitment at same time.
8597 let chanmon_cfgs = create_chanmon_cfgs(2);
8598 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8599 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8600 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8602 // Create some initial channel
8603 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
8604 let outpoint = OutPoint { txid: chan_1.3.txid(), index: 0 };
8606 // Rebalance the network to generate htlc in the two directions
8607 send_payment(&nodes[0], &vec!(&nodes[1])[..], 10_000_000);
8609 // Route a HTLC from node 0 to node 1 (but don't settle)
8610 let preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000).0;
8612 // Copy ChainMonitor to simulate a watchtower and update block height of node 0 until its ChannelMonitor timeout HTLC onchain
8613 let chain_source = test_utils::TestChainSource::new(Network::Testnet);
8614 let logger = test_utils::TestLogger::with_id(format!("node {}", 0));
8615 let persister = test_utils::TestPersister::new();
8617 let monitors = nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap();
8618 let monitor = monitors.get(&outpoint).unwrap();
8619 let mut w = test_utils::TestVecWriter(Vec::new());
8620 monitor.write(&mut w).unwrap();
8621 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingSigner>)>::read(
8622 &mut ::std::io::Cursor::new(&w.0), &test_utils::OnlyReadsKeysInterface {}).unwrap().1;
8623 assert!(new_monitor == *monitor);
8624 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);
8625 assert!(watchtower.watch_channel(outpoint, new_monitor).is_ok());
8628 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8629 // Make the tx_broadcaster aware of enough blocks that it doesn't think we're violating
8630 // transaction lock time requirements here.
8631 chanmon_cfgs[0].tx_broadcaster.blocks.lock().unwrap().resize(200, (header, 0));
8632 watchtower.chain_monitor.block_connected(&Block { header, txdata: vec![] }, 200);
8634 // Try to update ChannelMonitor
8635 assert!(nodes[1].node.claim_funds(preimage));
8636 check_added_monitors!(nodes[1], 1);
8637 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
8638 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
8639 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
8640 if let Some(ref mut channel) = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan_1.2) {
8641 if let Ok((_, _, _, update)) = channel.commitment_signed(&updates.commitment_signed, &node_cfgs[0].fee_estimator, &node_cfgs[0].logger) {
8642 if let Err(_) = watchtower.chain_monitor.update_channel(outpoint, update.clone()) {} else { assert!(false); }
8643 if let Ok(_) = nodes[0].chain_monitor.update_channel(outpoint, update) {} else { assert!(false); }
8644 } else { assert!(false); }
8645 } else { assert!(false); };
8646 // Our local monitor is in-sync and hasn't processed yet timeout
8647 check_added_monitors!(nodes[0], 1);
8648 let events = nodes[0].node.get_and_clear_pending_events();
8649 assert_eq!(events.len(), 1);
8653 fn test_concurrent_monitor_claim() {
8654 // Watchtower A receives block, broadcasts state N, then channel receives new state N+1,
8655 // sending it to both watchtowers, Bob accepts N+1, then receives block and broadcasts
8656 // the latest state N+1, Alice rejects state N+1, but Bob has already broadcast it,
8657 // state N+1 confirms. Alice claims output from state N+1.
8659 let chanmon_cfgs = create_chanmon_cfgs(2);
8660 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8661 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8662 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8664 // Create some initial channel
8665 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
8666 let outpoint = OutPoint { txid: chan_1.3.txid(), index: 0 };
8668 // Rebalance the network to generate htlc in the two directions
8669 send_payment(&nodes[0], &vec!(&nodes[1])[..], 10_000_000);
8671 // Route a HTLC from node 0 to node 1 (but don't settle)
8672 route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000).0;
8674 // Copy ChainMonitor to simulate watchtower Alice and update block height her ChannelMonitor timeout HTLC onchain
8675 let chain_source = test_utils::TestChainSource::new(Network::Testnet);
8676 let logger = test_utils::TestLogger::with_id(format!("node {}", "Alice"));
8677 let persister = test_utils::TestPersister::new();
8678 let watchtower_alice = {
8679 let monitors = nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap();
8680 let monitor = monitors.get(&outpoint).unwrap();
8681 let mut w = test_utils::TestVecWriter(Vec::new());
8682 monitor.write(&mut w).unwrap();
8683 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingSigner>)>::read(
8684 &mut ::std::io::Cursor::new(&w.0), &test_utils::OnlyReadsKeysInterface {}).unwrap().1;
8685 assert!(new_monitor == *monitor);
8686 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);
8687 assert!(watchtower.watch_channel(outpoint, new_monitor).is_ok());
8690 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8691 // Make the tx_broadcaster aware of enough blocks that it doesn't think we're violating
8692 // transaction lock time requirements here.
8693 chanmon_cfgs[0].tx_broadcaster.blocks.lock().unwrap().resize((CHAN_CONFIRM_DEPTH + 1 + TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS) as usize, (header, 0));
8694 watchtower_alice.chain_monitor.block_connected(&Block { header, txdata: vec![] }, CHAN_CONFIRM_DEPTH + 1 + TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS);
8696 // Watchtower Alice should have broadcast a commitment/HTLC-timeout
8698 let mut txn = chanmon_cfgs[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8699 assert_eq!(txn.len(), 2);
8703 // Copy ChainMonitor to simulate watchtower Bob and make it receive a commitment update first.
8704 let chain_source = test_utils::TestChainSource::new(Network::Testnet);
8705 let logger = test_utils::TestLogger::with_id(format!("node {}", "Bob"));
8706 let persister = test_utils::TestPersister::new();
8707 let watchtower_bob = {
8708 let monitors = nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap();
8709 let monitor = monitors.get(&outpoint).unwrap();
8710 let mut w = test_utils::TestVecWriter(Vec::new());
8711 monitor.write(&mut w).unwrap();
8712 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingSigner>)>::read(
8713 &mut ::std::io::Cursor::new(&w.0), &test_utils::OnlyReadsKeysInterface {}).unwrap().1;
8714 assert!(new_monitor == *monitor);
8715 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);
8716 assert!(watchtower.watch_channel(outpoint, new_monitor).is_ok());
8719 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8720 watchtower_bob.chain_monitor.block_connected(&Block { header, txdata: vec![] }, CHAN_CONFIRM_DEPTH + TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS);
8722 // Route another payment to generate another update with still previous HTLC pending
8723 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[0]);
8725 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
8726 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();
8727 nodes[1].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
8729 check_added_monitors!(nodes[1], 1);
8731 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
8732 assert_eq!(updates.update_add_htlcs.len(), 1);
8733 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &updates.update_add_htlcs[0]);
8734 if let Some(ref mut channel) = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan_1.2) {
8735 if let Ok((_, _, _, update)) = channel.commitment_signed(&updates.commitment_signed, &node_cfgs[0].fee_estimator, &node_cfgs[0].logger) {
8736 // Watchtower Alice should already have seen the block and reject the update
8737 if let Err(_) = watchtower_alice.chain_monitor.update_channel(outpoint, update.clone()) {} else { assert!(false); }
8738 if let Ok(_) = watchtower_bob.chain_monitor.update_channel(outpoint, update.clone()) {} else { assert!(false); }
8739 if let Ok(_) = nodes[0].chain_monitor.update_channel(outpoint, update) {} else { assert!(false); }
8740 } else { assert!(false); }
8741 } else { assert!(false); };
8742 // Our local monitor is in-sync and hasn't processed yet timeout
8743 check_added_monitors!(nodes[0], 1);
8745 //// Provide one more block to watchtower Bob, expect broadcast of commitment and HTLC-Timeout
8746 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8747 watchtower_bob.chain_monitor.block_connected(&Block { header, txdata: vec![] }, CHAN_CONFIRM_DEPTH + 1 + TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS);
8749 // Watchtower Bob should have broadcast a commitment/HTLC-timeout
8752 let mut txn = chanmon_cfgs[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8753 assert_eq!(txn.len(), 2);
8754 bob_state_y = txn[0].clone();
8758 // We confirm Bob's state Y on Alice, she should broadcast a HTLC-timeout
8759 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8760 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);
8762 let htlc_txn = chanmon_cfgs[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8763 // We broadcast twice the transaction, once due to the HTLC-timeout, once due
8764 // the onchain detection of the HTLC output
8765 assert_eq!(htlc_txn.len(), 2);
8766 check_spends!(htlc_txn[0], bob_state_y);
8767 check_spends!(htlc_txn[1], bob_state_y);
8772 fn test_pre_lockin_no_chan_closed_update() {
8773 // Test that if a peer closes a channel in response to a funding_created message we don't
8774 // generate a channel update (as the channel cannot appear on chain without a funding_signed
8777 // Doing so would imply a channel monitor update before the initial channel monitor
8778 // registration, violating our API guarantees.
8780 // Previously, full_stack_target managed to hit this case by opening then closing a channel,
8781 // then opening a second channel with the same funding output as the first (which is not
8782 // rejected because the first channel does not exist in the ChannelManager) and closing it
8783 // before receiving funding_signed.
8784 let chanmon_cfgs = create_chanmon_cfgs(2);
8785 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8786 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8787 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8789 // Create an initial channel
8790 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
8791 let mut open_chan_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8792 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_msg);
8793 let accept_chan_msg = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
8794 nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &accept_chan_msg);
8796 // Move the first channel through the funding flow...
8797 let (temporary_channel_id, tx, _) = create_funding_transaction(&nodes[0], 100000, 42);
8799 nodes[0].node.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
8800 check_added_monitors!(nodes[0], 0);
8802 let funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
8803 let channel_id = ::chain::transaction::OutPoint { txid: funding_created_msg.funding_txid, index: funding_created_msg.funding_output_index }.to_channel_id();
8804 nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msgs::ErrorMessage { channel_id, data: "Hi".to_owned() });
8805 assert!(nodes[0].chain_monitor.added_monitors.lock().unwrap().is_empty());
8809 fn test_htlc_no_detection() {
8810 // This test is a mutation to underscore the detection logic bug we had
8811 // before #653. HTLC value routed is above the remaining balance, thus
8812 // inverting HTLC and `to_remote` output. HTLC will come second and
8813 // it wouldn't be seen by pre-#653 detection as we were enumerate()'ing
8814 // on a watched outputs vector (Vec<TxOut>) thus implicitly relying on
8815 // outputs order detection for correct spending children filtring.
8817 let chanmon_cfgs = create_chanmon_cfgs(2);
8818 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8819 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8820 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8822 // Create some initial channels
8823 let chan_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
8825 send_payment(&nodes[0], &vec!(&nodes[1])[..], 1_000_000);
8826 let (_, our_payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 2_000_000);
8827 let local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
8828 assert_eq!(local_txn[0].input.len(), 1);
8829 assert_eq!(local_txn[0].output.len(), 3);
8830 check_spends!(local_txn[0], chan_1.3);
8832 // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
8833 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8834 connect_block(&nodes[0], &Block { header, txdata: vec![local_txn[0].clone()] });
8835 // We deliberately connect the local tx twice as this should provoke a failure calling
8836 // this test before #653 fix.
8837 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);
8838 check_closed_broadcast!(nodes[0], true);
8839 check_added_monitors!(nodes[0], 1);
8840 connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1);
8842 let htlc_timeout = {
8843 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8844 assert_eq!(node_txn[1].input.len(), 1);
8845 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
8846 check_spends!(node_txn[1], local_txn[0]);
8850 let header_201 = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8851 connect_block(&nodes[0], &Block { header: header_201, txdata: vec![htlc_timeout.clone()] });
8852 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
8853 expect_payment_failed!(nodes[0], our_payment_hash, true);
8856 fn do_test_onchain_htlc_settlement_after_close(broadcast_alice: bool, go_onchain_before_fulfill: bool) {
8857 // If we route an HTLC, then learn the HTLC's preimage after the upstream channel has been
8858 // force-closed, we must claim that HTLC on-chain. (Given an HTLC forwarded from Alice --> Bob -->
8859 // Carol, Alice would be the upstream node, and Carol the downstream.)
8861 // Steps of the test:
8862 // 1) Alice sends a HTLC to Carol through Bob.
8863 // 2) Carol doesn't settle the HTLC.
8864 // 3) If broadcast_alice is true, Alice force-closes her channel with Bob. Else Bob force closes.
8865 // Steps 4 and 5 may be reordered depending on go_onchain_before_fulfill.
8866 // 4) Bob sees the Alice's commitment on his chain or vice versa. An offered output is present
8867 // but can't be claimed as Bob doesn't have yet knowledge of the preimage.
8868 // 5) Carol release the preimage to Bob off-chain.
8869 // 6) Bob claims the offered output on the broadcasted commitment.
8870 let chanmon_cfgs = create_chanmon_cfgs(3);
8871 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
8872 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
8873 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
8875 // Create some initial channels
8876 let chan_ab = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
8877 create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 100000, 10001, InitFeatures::known(), InitFeatures::known());
8879 // Steps (1) and (2):
8880 // Send an HTLC Alice --> Bob --> Carol, but Carol doesn't settle the HTLC back.
8881 let (payment_preimage, _payment_hash, _payment_secret) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3_000_000);
8883 // Check that Alice's commitment transaction now contains an output for this HTLC.
8884 let alice_txn = get_local_commitment_txn!(nodes[0], chan_ab.2);
8885 check_spends!(alice_txn[0], chan_ab.3);
8886 assert_eq!(alice_txn[0].output.len(), 2);
8887 check_spends!(alice_txn[1], alice_txn[0]); // 2nd transaction is a non-final HTLC-timeout
8888 assert_eq!(alice_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
8889 assert_eq!(alice_txn.len(), 2);
8891 // Steps (3) and (4):
8892 // If `go_onchain_before_fufill`, broadcast the relevant commitment transaction and check that Bob
8893 // responds by (1) broadcasting a channel update and (2) adding a new ChannelMonitor.
8894 let mut force_closing_node = 0; // Alice force-closes
8895 if !broadcast_alice { force_closing_node = 1; } // Bob force-closes
8896 nodes[force_closing_node].node.force_close_channel(&chan_ab.2).unwrap();
8897 check_closed_broadcast!(nodes[force_closing_node], true);
8898 check_added_monitors!(nodes[force_closing_node], 1);
8899 if go_onchain_before_fulfill {
8900 let txn_to_broadcast = match broadcast_alice {
8901 true => alice_txn.clone(),
8902 false => get_local_commitment_txn!(nodes[1], chan_ab.2)
8904 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
8905 connect_block(&nodes[1], &Block { header, txdata: vec![txn_to_broadcast[0].clone()]});
8906 let mut bob_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8907 if broadcast_alice {
8908 check_closed_broadcast!(nodes[1], true);
8909 check_added_monitors!(nodes[1], 1);
8911 assert_eq!(bob_txn.len(), 1);
8912 check_spends!(bob_txn[0], chan_ab.3);
8916 // Carol then claims the funds and sends an update_fulfill message to Bob, and they go through the
8917 // process of removing the HTLC from their commitment transactions.
8918 assert!(nodes[2].node.claim_funds(payment_preimage));
8919 check_added_monitors!(nodes[2], 1);
8920 let carol_updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
8921 assert!(carol_updates.update_add_htlcs.is_empty());
8922 assert!(carol_updates.update_fail_htlcs.is_empty());
8923 assert!(carol_updates.update_fail_malformed_htlcs.is_empty());
8924 assert!(carol_updates.update_fee.is_none());
8925 assert_eq!(carol_updates.update_fulfill_htlcs.len(), 1);
8927 nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &carol_updates.update_fulfill_htlcs[0]);
8928 // If Alice broadcasted but Bob doesn't know yet, here he prepares to tell her about the preimage.
8929 if !go_onchain_before_fulfill && broadcast_alice {
8930 let events = nodes[1].node.get_and_clear_pending_msg_events();
8931 assert_eq!(events.len(), 1);
8933 MessageSendEvent::UpdateHTLCs { ref node_id, .. } => {
8934 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
8936 _ => panic!("Unexpected event"),
8939 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &carol_updates.commitment_signed);
8940 // One monitor update for the preimage to update the Bob<->Alice channel, one monitor update
8941 // Carol<->Bob's updated commitment transaction info.
8942 check_added_monitors!(nodes[1], 2);
8944 let events = nodes[1].node.get_and_clear_pending_msg_events();
8945 assert_eq!(events.len(), 2);
8946 let bob_revocation = match events[0] {
8947 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
8948 assert_eq!(*node_id, nodes[2].node.get_our_node_id());
8951 _ => panic!("Unexpected event"),
8953 let bob_updates = match events[1] {
8954 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
8955 assert_eq!(*node_id, nodes[2].node.get_our_node_id());
8958 _ => panic!("Unexpected event"),
8961 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bob_revocation);
8962 check_added_monitors!(nodes[2], 1);
8963 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bob_updates.commitment_signed);
8964 check_added_monitors!(nodes[2], 1);
8966 let events = nodes[2].node.get_and_clear_pending_msg_events();
8967 assert_eq!(events.len(), 1);
8968 let carol_revocation = match events[0] {
8969 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
8970 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
8973 _ => panic!("Unexpected event"),
8975 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &carol_revocation);
8976 check_added_monitors!(nodes[1], 1);
8978 // If this test requires the force-closed channel to not be on-chain until after the fulfill,
8979 // here's where we put said channel's commitment tx on-chain.
8980 let mut txn_to_broadcast = alice_txn.clone();
8981 if !broadcast_alice { txn_to_broadcast = get_local_commitment_txn!(nodes[1], chan_ab.2); }
8982 if !go_onchain_before_fulfill {
8983 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
8984 connect_block(&nodes[1], &Block { header, txdata: vec![txn_to_broadcast[0].clone()]});
8985 // If Bob was the one to force-close, he will have already passed these checks earlier.
8986 if broadcast_alice {
8987 check_closed_broadcast!(nodes[1], true);
8988 check_added_monitors!(nodes[1], 1);
8990 let mut bob_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8991 if broadcast_alice {
8992 // In `connect_block()`, the ChainMonitor and ChannelManager are separately notified about a
8993 // new block being connected. The ChannelManager being notified triggers a monitor update,
8994 // which triggers broadcasting our commitment tx and an HTLC-claiming tx. The ChainMonitor
8995 // being notified triggers the HTLC-claiming tx redundantly, resulting in 3 total txs being
8997 assert_eq!(bob_txn.len(), 3);
8998 check_spends!(bob_txn[1], chan_ab.3);
9000 assert_eq!(bob_txn.len(), 2);
9001 check_spends!(bob_txn[0], chan_ab.3);
9006 // Finally, check that Bob broadcasted a preimage-claiming transaction for the HTLC output on the
9007 // broadcasted commitment transaction.
9009 let bob_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
9010 if go_onchain_before_fulfill {
9011 // Bob should now have an extra broadcasted tx, for the preimage-claiming transaction.
9012 assert_eq!(bob_txn.len(), 2);
9014 let script_weight = match broadcast_alice {
9015 true => OFFERED_HTLC_SCRIPT_WEIGHT,
9016 false => ACCEPTED_HTLC_SCRIPT_WEIGHT
9018 // If Alice force-closed and Bob didn't receive her commitment transaction until after he
9019 // received Carol's fulfill, he broadcasts the HTLC-output-claiming transaction first. Else if
9020 // Bob force closed or if he found out about Alice's commitment tx before receiving Carol's
9021 // fulfill, then he broadcasts the HTLC-output-claiming transaction second.
9022 if broadcast_alice && !go_onchain_before_fulfill {
9023 check_spends!(bob_txn[0], txn_to_broadcast[0]);
9024 assert_eq!(bob_txn[0].input[0].witness.last().unwrap().len(), script_weight);
9026 check_spends!(bob_txn[1], txn_to_broadcast[0]);
9027 assert_eq!(bob_txn[1].input[0].witness.last().unwrap().len(), script_weight);
9033 fn test_onchain_htlc_settlement_after_close() {
9034 do_test_onchain_htlc_settlement_after_close(true, true);
9035 do_test_onchain_htlc_settlement_after_close(false, true); // Technically redundant, but may as well
9036 do_test_onchain_htlc_settlement_after_close(true, false);
9037 do_test_onchain_htlc_settlement_after_close(false, false);
9041 fn test_duplicate_chan_id() {
9042 // Test that if a given peer tries to open a channel with the same channel_id as one that is
9043 // already open we reject it and keep the old channel.
9045 // Previously, full_stack_target managed to figure out that if you tried to open two channels
9046 // with the same funding output (ie post-funding channel_id), we'd create a monitor update for
9047 // the existing channel when we detect the duplicate new channel, screwing up our monitor
9048 // updating logic for the existing channel.
9049 let chanmon_cfgs = create_chanmon_cfgs(2);
9050 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
9051 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
9052 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
9054 // Create an initial channel
9055 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
9056 let mut open_chan_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
9057 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_msg);
9058 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()));
9060 // Try to create a second channel with the same temporary_channel_id as the first and check
9061 // that it is rejected.
9062 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_msg);
9064 let events = nodes[1].node.get_and_clear_pending_msg_events();
9065 assert_eq!(events.len(), 1);
9067 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
9068 // Technically, at this point, nodes[1] would be justified in thinking both the
9069 // first (valid) and second (invalid) channels are closed, given they both have
9070 // the same non-temporary channel_id. However, currently we do not, so we just
9071 // move forward with it.
9072 assert_eq!(msg.channel_id, open_chan_msg.temporary_channel_id);
9073 assert_eq!(node_id, nodes[0].node.get_our_node_id());
9075 _ => panic!("Unexpected event"),
9079 // Move the first channel through the funding flow...
9080 let (temporary_channel_id, tx, funding_output) = create_funding_transaction(&nodes[0], 100000, 42);
9082 nodes[0].node.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
9083 check_added_monitors!(nodes[0], 0);
9085 let mut funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
9086 nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created_msg);
9088 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
9089 assert_eq!(added_monitors.len(), 1);
9090 assert_eq!(added_monitors[0].0, funding_output);
9091 added_monitors.clear();
9093 let funding_signed_msg = get_event_msg!(nodes[1], MessageSendEvent::SendFundingSigned, nodes[0].node.get_our_node_id());
9095 let funding_outpoint = ::chain::transaction::OutPoint { txid: funding_created_msg.funding_txid, index: funding_created_msg.funding_output_index };
9096 let channel_id = funding_outpoint.to_channel_id();
9098 // Now we have the first channel past funding_created (ie it has a txid-based channel_id, not a
9101 // First try to open a second channel with a temporary channel id equal to the txid-based one.
9102 // Technically this is allowed by the spec, but we don't support it and there's little reason
9103 // to. Still, it shouldn't cause any other issues.
9104 open_chan_msg.temporary_channel_id = channel_id;
9105 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_msg);
9107 let events = nodes[1].node.get_and_clear_pending_msg_events();
9108 assert_eq!(events.len(), 1);
9110 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
9111 // Technically, at this point, nodes[1] would be justified in thinking both
9112 // channels are closed, but currently we do not, so we just move forward with it.
9113 assert_eq!(msg.channel_id, open_chan_msg.temporary_channel_id);
9114 assert_eq!(node_id, nodes[0].node.get_our_node_id());
9116 _ => panic!("Unexpected event"),
9120 // Now try to create a second channel which has a duplicate funding output.
9121 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
9122 let open_chan_2_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
9123 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_2_msg);
9124 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()));
9125 create_funding_transaction(&nodes[0], 100000, 42); // Get and check the FundingGenerationReady event
9127 let funding_created = {
9128 let mut a_channel_lock = nodes[0].node.channel_state.lock().unwrap();
9129 let mut as_chan = a_channel_lock.by_id.get_mut(&open_chan_2_msg.temporary_channel_id).unwrap();
9130 let logger = test_utils::TestLogger::new();
9131 as_chan.get_outbound_funding_created(tx.clone(), funding_outpoint, &&logger).unwrap()
9133 check_added_monitors!(nodes[0], 0);
9134 nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created);
9135 // At this point we'll try to add a duplicate channel monitor, which will be rejected, but
9136 // still needs to be cleared here.
9137 check_added_monitors!(nodes[1], 1);
9139 // ...still, nodes[1] will reject the duplicate channel.
9141 let events = nodes[1].node.get_and_clear_pending_msg_events();
9142 assert_eq!(events.len(), 1);
9144 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
9145 // Technically, at this point, nodes[1] would be justified in thinking both
9146 // channels are closed, but currently we do not, so we just move forward with it.
9147 assert_eq!(msg.channel_id, channel_id);
9148 assert_eq!(node_id, nodes[0].node.get_our_node_id());
9150 _ => panic!("Unexpected event"),
9154 // finally, finish creating the original channel and send a payment over it to make sure
9155 // everything is functional.
9156 nodes[0].node.handle_funding_signed(&nodes[1].node.get_our_node_id(), &funding_signed_msg);
9158 let mut added_monitors = nodes[0].chain_monitor.added_monitors.lock().unwrap();
9159 assert_eq!(added_monitors.len(), 1);
9160 assert_eq!(added_monitors[0].0, funding_output);
9161 added_monitors.clear();
9164 let events_4 = nodes[0].node.get_and_clear_pending_events();
9165 assert_eq!(events_4.len(), 0);
9166 assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
9167 assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0].txid(), funding_output.txid);
9169 let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
9170 let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
9171 update_nodes_with_chan_announce(&nodes, 0, 1, &announcement, &as_update, &bs_update);
9172 send_payment(&nodes[0], &[&nodes[1]], 8000000);
9176 fn test_error_chans_closed() {
9177 // Test that we properly handle error messages, closing appropriate channels.
9179 // Prior to #787 we'd allow a peer to make us force-close a channel we had with a different
9180 // peer. The "real" fix for that is to index channels with peers_ids, however in the mean time
9181 // we can test various edge cases around it to ensure we don't regress.
9182 let chanmon_cfgs = create_chanmon_cfgs(3);
9183 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
9184 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
9185 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
9187 // Create some initial channels
9188 let chan_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
9189 let chan_2 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
9190 let chan_3 = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 100000, 10001, InitFeatures::known(), InitFeatures::known());
9192 assert_eq!(nodes[0].node.list_usable_channels().len(), 3);
9193 assert_eq!(nodes[1].node.list_usable_channels().len(), 2);
9194 assert_eq!(nodes[2].node.list_usable_channels().len(), 1);
9196 // Closing a channel from a different peer has no effect
9197 nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msgs::ErrorMessage { channel_id: chan_3.2, data: "ERR".to_owned() });
9198 assert_eq!(nodes[0].node.list_usable_channels().len(), 3);
9200 // Closing one channel doesn't impact others
9201 nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msgs::ErrorMessage { channel_id: chan_2.2, data: "ERR".to_owned() });
9202 check_added_monitors!(nodes[0], 1);
9203 check_closed_broadcast!(nodes[0], false);
9204 assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0).len(), 1);
9205 assert_eq!(nodes[0].node.list_usable_channels().len(), 2);
9206 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);
9207 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);
9209 // A null channel ID should close all channels
9210 let _chan_4 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
9211 nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msgs::ErrorMessage { channel_id: [0; 32], data: "ERR".to_owned() });
9212 check_added_monitors!(nodes[0], 2);
9213 let events = nodes[0].node.get_and_clear_pending_msg_events();
9214 assert_eq!(events.len(), 2);
9216 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
9217 assert_eq!(msg.contents.flags & 2, 2);
9219 _ => panic!("Unexpected event"),
9222 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
9223 assert_eq!(msg.contents.flags & 2, 2);
9225 _ => panic!("Unexpected event"),
9227 // Note that at this point users of a standard PeerHandler will end up calling
9228 // peer_disconnected with no_connection_possible set to false, duplicating the
9229 // close-all-channels logic. That's OK, we don't want to end up not force-closing channels for
9230 // users with their own peer handling logic. We duplicate the call here, however.
9231 assert_eq!(nodes[0].node.list_usable_channels().len(), 1);
9232 assert!(nodes[0].node.list_usable_channels()[0].channel_id == chan_3.2);
9234 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), true);
9235 assert_eq!(nodes[0].node.list_usable_channels().len(), 1);
9236 assert!(nodes[0].node.list_usable_channels()[0].channel_id == chan_3.2);
9240 fn test_invalid_funding_tx() {
9241 // Test that we properly handle invalid funding transactions sent to us from a peer.
9243 // Previously, all other major lightning implementations had failed to properly sanitize
9244 // funding transactions from their counterparties, leading to a multi-implementation critical
9245 // security vulnerability (though we always sanitized properly, we've previously had
9246 // un-released crashes in the sanitization process).
9247 let chanmon_cfgs = create_chanmon_cfgs(2);
9248 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
9249 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
9250 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
9252 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100_000, 10_000, 42, None).unwrap();
9253 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()));
9254 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()));
9256 let (temporary_channel_id, mut tx, _) = create_funding_transaction(&nodes[0], 100_000, 42);
9257 for output in tx.output.iter_mut() {
9258 // Make the confirmed funding transaction have a bogus script_pubkey
9259 output.script_pubkey = bitcoin::Script::new();
9262 nodes[0].node.funding_transaction_generated_unchecked(&temporary_channel_id, tx.clone(), 0).unwrap();
9263 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()));
9264 check_added_monitors!(nodes[1], 1);
9266 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()));
9267 check_added_monitors!(nodes[0], 1);
9269 let events_1 = nodes[0].node.get_and_clear_pending_events();
9270 assert_eq!(events_1.len(), 0);
9272 assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
9273 assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0], tx);
9274 nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
9276 confirm_transaction_at(&nodes[1], &tx, 1);
9277 check_added_monitors!(nodes[1], 1);
9278 let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
9279 assert_eq!(events_2.len(), 1);
9280 if let MessageSendEvent::HandleError { node_id, action } = &events_2[0] {
9281 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
9282 if let msgs::ErrorAction::SendErrorMessage { msg } = action {
9283 assert_eq!(msg.data, "funding tx had wrong script/value or output index");
9284 } else { panic!(); }
9285 } else { panic!(); }
9286 assert_eq!(nodes[1].node.list_channels().len(), 0);