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 let events = nodes[0].node.get_and_clear_pending_msg_events();
1364 assert_eq!(events.len(), 1);
1366 MessageSendEvent::PaymentFailureNetworkUpdate { update: msgs::HTLCFailChannelUpdate::ChannelUpdateMessage { ref msg }} => {
1367 assert_eq!(msg.contents.short_channel_id, chan_2.0.contents.short_channel_id);
1369 _ => panic!("Unexpected event"),
1372 expect_payment_failed!(nodes[0], payment_hash_2, false);
1374 // Now forward all the pending HTLCs and claim them back
1375 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &initial_payment_event.msgs[0]);
1376 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &initial_payment_event.commitment_msg);
1377 check_added_monitors!(nodes[2], 1);
1379 let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1380 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_revoke_and_ack);
1381 check_added_monitors!(nodes[1], 1);
1382 let as_updates = get_htlc_update_msgs!(nodes[1], nodes[2].node.get_our_node_id());
1384 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &bs_commitment_signed);
1385 check_added_monitors!(nodes[1], 1);
1386 let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
1388 for ref update in as_updates.update_add_htlcs.iter() {
1389 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), update);
1391 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &as_updates.commitment_signed);
1392 check_added_monitors!(nodes[2], 1);
1393 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
1394 check_added_monitors!(nodes[2], 1);
1395 let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1397 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_revoke_and_ack);
1398 check_added_monitors!(nodes[1], 1);
1399 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &bs_commitment_signed);
1400 check_added_monitors!(nodes[1], 1);
1401 let as_final_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
1403 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_final_raa);
1404 check_added_monitors!(nodes[2], 1);
1406 expect_pending_htlcs_forwardable!(nodes[2]);
1408 let events = nodes[2].node.get_and_clear_pending_events();
1409 assert_eq!(events.len(), payments.len());
1410 for (event, &(_, ref hash)) in events.iter().zip(payments.iter()) {
1412 &Event::PaymentReceived { ref payment_hash, .. } => {
1413 assert_eq!(*payment_hash, *hash);
1415 _ => panic!("Unexpected event"),
1419 for (preimage, _) in payments.drain(..) {
1420 claim_payment(&nodes[1], &[&nodes[2]], preimage);
1423 send_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1000000);
1427 fn duplicate_htlc_test() {
1428 // Test that we accept duplicate payment_hash HTLCs across the network and that
1429 // claiming/failing them are all separate and don't affect each other
1430 let chanmon_cfgs = create_chanmon_cfgs(6);
1431 let node_cfgs = create_node_cfgs(6, &chanmon_cfgs);
1432 let node_chanmgrs = create_node_chanmgrs(6, &node_cfgs, &[None, None, None, None, None, None]);
1433 let mut nodes = create_network(6, &node_cfgs, &node_chanmgrs);
1435 // Create some initial channels to route via 3 to 4/5 from 0/1/2
1436 create_announced_chan_between_nodes(&nodes, 0, 3, InitFeatures::known(), InitFeatures::known());
1437 create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known());
1438 create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
1439 create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::known(), InitFeatures::known());
1440 create_announced_chan_between_nodes(&nodes, 3, 5, InitFeatures::known(), InitFeatures::known());
1442 let (payment_preimage, payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[3], &nodes[4])[..], 1000000);
1444 *nodes[0].network_payment_count.borrow_mut() -= 1;
1445 assert_eq!(route_payment(&nodes[1], &vec!(&nodes[3])[..], 1000000).0, payment_preimage);
1447 *nodes[0].network_payment_count.borrow_mut() -= 1;
1448 assert_eq!(route_payment(&nodes[2], &vec!(&nodes[3], &nodes[5])[..], 1000000).0, payment_preimage);
1450 claim_payment(&nodes[0], &vec!(&nodes[3], &nodes[4])[..], payment_preimage);
1451 fail_payment(&nodes[2], &vec!(&nodes[3], &nodes[5])[..], payment_hash);
1452 claim_payment(&nodes[1], &vec!(&nodes[3])[..], payment_preimage);
1456 fn test_duplicate_htlc_different_direction_onchain() {
1457 // Test that ChannelMonitor doesn't generate 2 preimage txn
1458 // when we have 2 HTLCs with same preimage that go across a node
1459 // in opposite directions, even with the same payment secret.
1460 let chanmon_cfgs = create_chanmon_cfgs(2);
1461 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1462 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1463 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1465 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
1466 let logger = test_utils::TestLogger::new();
1469 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
1471 let (payment_preimage, payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 900_000);
1473 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
1474 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();
1475 let node_a_payment_secret = nodes[0].node.create_inbound_payment_for_hash(payment_hash, None, 7200, 0).unwrap();
1476 send_along_route_with_secret(&nodes[1], route, &[&[&nodes[0]]], 800_000, payment_hash, node_a_payment_secret);
1478 // Provide preimage to node 0 by claiming payment
1479 nodes[0].node.claim_funds(payment_preimage);
1480 check_added_monitors!(nodes[0], 1);
1482 // Broadcast node 1 commitment txn
1483 let remote_txn = get_local_commitment_txn!(nodes[1], chan_1.2);
1485 assert_eq!(remote_txn[0].output.len(), 4); // 1 local, 1 remote, 1 htlc inbound, 1 htlc outbound
1486 let mut has_both_htlcs = 0; // check htlcs match ones committed
1487 for outp in remote_txn[0].output.iter() {
1488 if outp.value == 800_000 / 1000 {
1489 has_both_htlcs += 1;
1490 } else if outp.value == 900_000 / 1000 {
1491 has_both_htlcs += 1;
1494 assert_eq!(has_both_htlcs, 2);
1496 mine_transaction(&nodes[0], &remote_txn[0]);
1497 check_added_monitors!(nodes[0], 1);
1498 connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
1500 // Check we only broadcast 1 timeout tx
1501 let claim_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
1502 assert_eq!(claim_txn.len(), 8);
1503 assert_eq!(claim_txn[1], claim_txn[4]);
1504 assert_eq!(claim_txn[2], claim_txn[5]);
1505 check_spends!(claim_txn[1], chan_1.3);
1506 check_spends!(claim_txn[2], claim_txn[1]);
1507 check_spends!(claim_txn[7], claim_txn[1]);
1509 assert_eq!(claim_txn[0].input.len(), 1);
1510 assert_eq!(claim_txn[3].input.len(), 1);
1511 assert_eq!(claim_txn[0].input[0].previous_output, claim_txn[3].input[0].previous_output);
1513 assert_eq!(claim_txn[0].input.len(), 1);
1514 assert_eq!(claim_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC 1 <--> 0, preimage tx
1515 check_spends!(claim_txn[0], remote_txn[0]);
1516 assert_eq!(remote_txn[0].output[claim_txn[0].input[0].previous_output.vout as usize].value, 800);
1517 assert_eq!(claim_txn[6].input.len(), 1);
1518 assert_eq!(claim_txn[6].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // HTLC 0 <--> 1, timeout tx
1519 check_spends!(claim_txn[6], remote_txn[0]);
1520 assert_eq!(remote_txn[0].output[claim_txn[6].input[0].previous_output.vout as usize].value, 900);
1522 let events = nodes[0].node.get_and_clear_pending_msg_events();
1523 assert_eq!(events.len(), 3);
1526 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
1527 MessageSendEvent::HandleError { node_id, action: msgs::ErrorAction::SendErrorMessage { ref msg } } => {
1528 assert_eq!(node_id, nodes[1].node.get_our_node_id());
1529 assert_eq!(msg.data, "Commitment or closing transaction was confirmed on chain.");
1531 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, .. } } => {
1532 assert!(update_add_htlcs.is_empty());
1533 assert!(update_fail_htlcs.is_empty());
1534 assert_eq!(update_fulfill_htlcs.len(), 1);
1535 assert!(update_fail_malformed_htlcs.is_empty());
1536 assert_eq!(nodes[1].node.get_our_node_id(), *node_id);
1538 _ => panic!("Unexpected event"),
1544 fn test_basic_channel_reserve() {
1545 let chanmon_cfgs = create_chanmon_cfgs(2);
1546 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1547 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1548 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1549 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1550 let logger = test_utils::TestLogger::new();
1552 let chan_stat = get_channel_value_stat!(nodes[0], chan.2);
1553 let channel_reserve = chan_stat.channel_reserve_msat;
1555 // The 2* and +1 are for the fee spike reserve.
1556 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
1557 let commit_tx_fee = 2 * commit_tx_fee_msat(get_feerate!(nodes[0], chan.2), 1 + 1);
1558 let max_can_send = 5000000 - channel_reserve - commit_tx_fee;
1559 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
1560 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();
1561 let err = nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).err().unwrap();
1563 PaymentSendFailure::AllFailedRetrySafe(ref fails) => {
1565 &APIError::ChannelUnavailable{ref err} =>
1566 assert!(regex::Regex::new(r"Cannot send value that would put our balance under counterparty-announced channel reserve value \(\d+\)").unwrap().is_match(err)),
1567 _ => panic!("Unexpected error variant"),
1570 _ => panic!("Unexpected error variant"),
1572 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1573 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);
1575 send_payment(&nodes[0], &vec![&nodes[1]], max_can_send);
1579 fn test_fee_spike_violation_fails_htlc() {
1580 let chanmon_cfgs = create_chanmon_cfgs(2);
1581 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1582 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1583 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1584 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1586 let (route, payment_hash, _, payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], 3460001);
1587 // Need to manually create the update_add_htlc message to go around the channel reserve check in send_htlc()
1588 let secp_ctx = Secp256k1::new();
1589 let session_priv = SecretKey::from_slice(&[42; 32]).expect("RNG is bad!");
1591 let cur_height = nodes[1].node.best_block.read().unwrap().height() + 1;
1593 let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route.paths[0], &session_priv).unwrap();
1594 let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 3460001, &Some(payment_secret), cur_height).unwrap();
1595 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
1596 let msg = msgs::UpdateAddHTLC {
1599 amount_msat: htlc_msat,
1600 payment_hash: payment_hash,
1601 cltv_expiry: htlc_cltv,
1602 onion_routing_packet: onion_packet,
1605 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
1607 // Now manually create the commitment_signed message corresponding to the update_add
1608 // nodes[0] just sent. In the code for construction of this message, "local" refers
1609 // to the sender of the message, and "remote" refers to the receiver.
1611 let feerate_per_kw = get_feerate!(nodes[0], chan.2);
1613 const INITIAL_COMMITMENT_NUMBER: u64 = (1 << 48) - 1;
1615 // Get the EnforcingSigner for each channel, which will be used to (1) get the keys
1616 // needed to sign the new commitment tx and (2) sign the new commitment tx.
1617 let (local_revocation_basepoint, local_htlc_basepoint, local_secret, next_local_point) = {
1618 let chan_lock = nodes[0].node.channel_state.lock().unwrap();
1619 let local_chan = chan_lock.by_id.get(&chan.2).unwrap();
1620 let chan_signer = local_chan.get_signer();
1621 let pubkeys = chan_signer.pubkeys();
1622 (pubkeys.revocation_basepoint, pubkeys.htlc_basepoint,
1623 chan_signer.release_commitment_secret(INITIAL_COMMITMENT_NUMBER),
1624 chan_signer.get_per_commitment_point(INITIAL_COMMITMENT_NUMBER - 2, &secp_ctx))
1626 let (remote_delayed_payment_basepoint, remote_htlc_basepoint,remote_point) = {
1627 let chan_lock = nodes[1].node.channel_state.lock().unwrap();
1628 let remote_chan = chan_lock.by_id.get(&chan.2).unwrap();
1629 let chan_signer = remote_chan.get_signer();
1630 let pubkeys = chan_signer.pubkeys();
1631 (pubkeys.delayed_payment_basepoint, pubkeys.htlc_basepoint,
1632 chan_signer.get_per_commitment_point(INITIAL_COMMITMENT_NUMBER - 1, &secp_ctx))
1635 // Assemble the set of keys we can use for signatures for our commitment_signed message.
1636 let commit_tx_keys = chan_utils::TxCreationKeys::derive_new(&secp_ctx, &remote_point, &remote_delayed_payment_basepoint,
1637 &remote_htlc_basepoint, &local_revocation_basepoint, &local_htlc_basepoint).unwrap();
1639 // Build the remote commitment transaction so we can sign it, and then later use the
1640 // signature for the commitment_signed message.
1641 let local_chan_balance = 1313;
1643 let accepted_htlc_info = chan_utils::HTLCOutputInCommitment {
1645 amount_msat: 3460001,
1646 cltv_expiry: htlc_cltv,
1648 transaction_output_index: Some(1),
1651 let commitment_number = INITIAL_COMMITMENT_NUMBER - 1;
1654 let local_chan_lock = nodes[0].node.channel_state.lock().unwrap();
1655 let local_chan = local_chan_lock.by_id.get(&chan.2).unwrap();
1656 let local_chan_signer = local_chan.get_signer();
1657 let commitment_tx = CommitmentTransaction::new_with_auxiliary_htlc_data(
1661 commit_tx_keys.clone(),
1663 &mut vec![(accepted_htlc_info, ())],
1664 &local_chan.channel_transaction_parameters.as_counterparty_broadcastable()
1666 local_chan_signer.sign_counterparty_commitment(&commitment_tx, &secp_ctx).unwrap()
1669 let commit_signed_msg = msgs::CommitmentSigned {
1672 htlc_signatures: res.1
1675 // Send the commitment_signed message to the nodes[1].
1676 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commit_signed_msg);
1677 let _ = nodes[1].node.get_and_clear_pending_msg_events();
1679 // Send the RAA to nodes[1].
1680 let raa_msg = msgs::RevokeAndACK {
1682 per_commitment_secret: local_secret,
1683 next_per_commitment_point: next_local_point
1685 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &raa_msg);
1687 let events = nodes[1].node.get_and_clear_pending_msg_events();
1688 assert_eq!(events.len(), 1);
1689 // Make sure the HTLC failed in the way we expect.
1691 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fail_htlcs, .. }, .. } => {
1692 assert_eq!(update_fail_htlcs.len(), 1);
1693 update_fail_htlcs[0].clone()
1695 _ => panic!("Unexpected event"),
1697 nodes[1].logger.assert_log("lightning::ln::channel".to_string(), "Attempting to fail HTLC due to fee spike buffer violation".to_string(), 1);
1699 check_added_monitors!(nodes[1], 2);
1703 fn test_chan_reserve_violation_outbound_htlc_inbound_chan() {
1704 let mut chanmon_cfgs = create_chanmon_cfgs(2);
1705 // Set the fee rate for the channel very high, to the point where the fundee
1706 // sending any above-dust amount would result in a channel reserve violation.
1707 // In this test we check that we would be prevented from sending an HTLC in
1709 chanmon_cfgs[0].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 6000 };
1710 chanmon_cfgs[1].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 6000 };
1711 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1712 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1713 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1714 let _ = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1716 let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[1], nodes[0], 4843000);
1717 unwrap_send_err!(nodes[1].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
1718 assert_eq!(err, "Cannot send value that would put counterparty balance under holder-announced channel reserve value"));
1719 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1720 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);
1724 fn test_chan_reserve_violation_inbound_htlc_outbound_channel() {
1725 let mut chanmon_cfgs = create_chanmon_cfgs(2);
1726 // Set the fee rate for the channel very high, to the point where the funder
1727 // receiving 1 update_add_htlc would result in them closing the channel due
1728 // to channel reserve violation. This close could also happen if the fee went
1729 // up a more realistic amount, but many HTLCs were outstanding at the time of
1730 // the update_add_htlc.
1731 chanmon_cfgs[0].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 6000 };
1732 chanmon_cfgs[1].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 6000 };
1733 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1734 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1735 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1736 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1738 let (route, payment_hash, _, payment_secret) = get_route_and_payment_hash!(nodes[1], nodes[0], 1000);
1739 // Need to manually create the update_add_htlc message to go around the channel reserve check in send_htlc()
1740 let secp_ctx = Secp256k1::new();
1741 let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
1742 let cur_height = nodes[1].node.best_block.read().unwrap().height() + 1;
1743 let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route.paths[0], &session_priv).unwrap();
1744 let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 1000, &Some(payment_secret), cur_height).unwrap();
1745 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
1746 let msg = msgs::UpdateAddHTLC {
1749 amount_msat: htlc_msat + 1,
1750 payment_hash: payment_hash,
1751 cltv_expiry: htlc_cltv,
1752 onion_routing_packet: onion_packet,
1755 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &msg);
1756 // Check that the payment failed and the channel is closed in response to the malicious UpdateAdd.
1757 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);
1758 assert_eq!(nodes[0].node.list_channels().len(), 0);
1759 let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
1760 assert_eq!(err_msg.data, "Cannot accept HTLC that would put our balance under counterparty-announced channel reserve value");
1761 check_added_monitors!(nodes[0], 1);
1765 fn test_chan_reserve_dust_inbound_htlcs_outbound_chan() {
1766 // Test that if we receive many dust HTLCs over an outbound channel, they don't count when
1767 // calculating our commitment transaction fee (this was previously broken).
1768 let chanmon_cfgs = create_chanmon_cfgs(2);
1769 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1770 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None, None]);
1771 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1773 // Set nodes[0]'s balance such that they will consider any above-dust received HTLC to be a
1774 // channel reserve violation (so their balance is channel reserve (1000 sats) + commitment
1775 // transaction fee with 0 HTLCs (183 sats)).
1776 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 98817000, InitFeatures::known(), InitFeatures::known());
1778 let dust_amt = 329000; // Dust amount
1779 // In the previous code, routing this dust payment would cause nodes[0] to perceive a channel
1780 // reserve violation even though it's a dust HTLC and therefore shouldn't count towards the
1781 // commitment transaction fee.
1782 let (_, _, _) = route_payment(&nodes[1], &[&nodes[0]], dust_amt);
1786 fn test_chan_reserve_dust_inbound_htlcs_inbound_chan() {
1787 // Test that if we receive many dust HTLCs over an inbound channel, they don't count when
1788 // calculating our counterparty's commitment transaction fee (this was previously broken).
1789 let chanmon_cfgs = create_chanmon_cfgs(2);
1790 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1791 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None, None]);
1792 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1793 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 98000000, InitFeatures::known(), InitFeatures::known());
1795 let payment_amt = 46000; // Dust amount
1796 // In the previous code, these first four payments would succeed.
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 // Then these next 5 would be interpreted by nodes[1] as violating the fee spike buffer.
1803 let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1804 let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1805 let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1806 let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1807 let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1809 // And this last payment previously resulted in nodes[1] closing on its inbound-channel
1810 // counterparty, because it counted all the previous dust HTLCs against nodes[0]'s commitment
1811 // transaction fee and therefore perceived this next payment as a channel reserve violation.
1812 let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1816 fn test_chan_reserve_violation_inbound_htlc_inbound_chan() {
1817 let chanmon_cfgs = create_chanmon_cfgs(3);
1818 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1819 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1820 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1821 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1822 let _ = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1825 let total_routing_fee_msat = (nodes.len() - 2) as u64 * feemsat;
1826 let chan_stat = get_channel_value_stat!(nodes[0], chan.2);
1827 let feerate = get_feerate!(nodes[0], chan.2);
1829 // Add a 2* and +1 for the fee spike reserve.
1830 let commit_tx_fee_2_htlc = 2*commit_tx_fee_msat(feerate, 2 + 1);
1831 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;
1832 let amt_msat_1 = recv_value_1 + total_routing_fee_msat;
1834 // Add a pending HTLC.
1835 let (route_1, our_payment_hash_1, _, our_payment_secret_1) = get_route_and_payment_hash!(nodes[0], nodes[2], amt_msat_1);
1836 let payment_event_1 = {
1837 nodes[0].node.send_payment(&route_1, our_payment_hash_1, &Some(our_payment_secret_1)).unwrap();
1838 check_added_monitors!(nodes[0], 1);
1840 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1841 assert_eq!(events.len(), 1);
1842 SendEvent::from_event(events.remove(0))
1844 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event_1.msgs[0]);
1846 // Attempt to trigger a channel reserve violation --> payment failure.
1847 let commit_tx_fee_2_htlcs = commit_tx_fee_msat(feerate, 2);
1848 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;
1849 let amt_msat_2 = recv_value_2 + total_routing_fee_msat;
1850 let (route_2, _, _, _) = get_route_and_payment_hash!(nodes[0], nodes[2], amt_msat_2);
1852 // Need to manually create the update_add_htlc message to go around the channel reserve check in send_htlc()
1853 let secp_ctx = Secp256k1::new();
1854 let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
1855 let cur_height = nodes[0].node.best_block.read().unwrap().height() + 1;
1856 let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route_2.paths[0], &session_priv).unwrap();
1857 let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route_2.paths[0], recv_value_2, &None, cur_height).unwrap();
1858 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &our_payment_hash_1);
1859 let msg = msgs::UpdateAddHTLC {
1862 amount_msat: htlc_msat + 1,
1863 payment_hash: our_payment_hash_1,
1864 cltv_expiry: htlc_cltv,
1865 onion_routing_packet: onion_packet,
1868 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
1869 // Check that the payment failed and the channel is closed in response to the malicious UpdateAdd.
1870 nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Remote HTLC add would put them under remote reserve value".to_string(), 1);
1871 assert_eq!(nodes[1].node.list_channels().len(), 1);
1872 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
1873 assert_eq!(err_msg.data, "Remote HTLC add would put them under remote reserve value");
1874 check_added_monitors!(nodes[1], 1);
1878 fn test_inbound_outbound_capacity_is_not_zero() {
1879 let chanmon_cfgs = create_chanmon_cfgs(2);
1880 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1881 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1882 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1883 let _ = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1884 let channels0 = node_chanmgrs[0].list_channels();
1885 let channels1 = node_chanmgrs[1].list_channels();
1886 assert_eq!(channels0.len(), 1);
1887 assert_eq!(channels1.len(), 1);
1889 assert_eq!(channels0[0].inbound_capacity_msat, 95000000);
1890 assert_eq!(channels1[0].outbound_capacity_msat, 95000000);
1892 assert_eq!(channels0[0].outbound_capacity_msat, 100000 * 1000 - 95000000);
1893 assert_eq!(channels1[0].inbound_capacity_msat, 100000 * 1000 - 95000000);
1896 fn commit_tx_fee_msat(feerate: u32, num_htlcs: u64) -> u64 {
1897 (COMMITMENT_TX_BASE_WEIGHT + num_htlcs * COMMITMENT_TX_WEIGHT_PER_HTLC) * feerate as u64 / 1000 * 1000
1901 fn test_channel_reserve_holding_cell_htlcs() {
1902 let chanmon_cfgs = create_chanmon_cfgs(3);
1903 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1904 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1905 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1906 let chan_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 190000, 1001, InitFeatures::known(), InitFeatures::known());
1907 let chan_2 = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 190000, 1001, InitFeatures::known(), InitFeatures::known());
1909 let mut stat01 = get_channel_value_stat!(nodes[0], chan_1.2);
1910 let mut stat11 = get_channel_value_stat!(nodes[1], chan_1.2);
1912 let mut stat12 = get_channel_value_stat!(nodes[1], chan_2.2);
1913 let mut stat22 = get_channel_value_stat!(nodes[2], chan_2.2);
1915 macro_rules! expect_forward {
1917 let mut events = $node.node.get_and_clear_pending_msg_events();
1918 assert_eq!(events.len(), 1);
1919 check_added_monitors!($node, 1);
1920 let payment_event = SendEvent::from_event(events.remove(0));
1925 let feemsat = 239; // somehow we know?
1926 let total_fee_msat = (nodes.len() - 2) as u64 * feemsat;
1927 let feerate = get_feerate!(nodes[0], chan_1.2);
1929 let recv_value_0 = stat01.counterparty_max_htlc_value_in_flight_msat - total_fee_msat;
1931 // attempt to send amt_msat > their_max_htlc_value_in_flight_msat
1933 let (mut route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], recv_value_0);
1934 route.paths[0].last_mut().unwrap().fee_msat += 1;
1935 assert!(route.paths[0].iter().rev().skip(1).all(|h| h.fee_msat == feemsat));
1936 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
1937 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)));
1938 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1939 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);
1942 // channel reserve is bigger than their_max_htlc_value_in_flight_msat so loop to deplete
1943 // nodes[0]'s wealth
1945 let amt_msat = recv_value_0 + total_fee_msat;
1946 // 3 for the 3 HTLCs that will be sent, 2* and +1 for the fee spike reserve.
1947 // Also, ensure that each payment has enough to be over the dust limit to
1948 // ensure it'll be included in each commit tx fee calculation.
1949 let commit_tx_fee_all_htlcs = 2*commit_tx_fee_msat(feerate, 3 + 1);
1950 let ensure_htlc_amounts_above_dust_buffer = 3 * (stat01.counterparty_dust_limit_msat + 1000);
1951 if stat01.value_to_self_msat < stat01.channel_reserve_msat + commit_tx_fee_all_htlcs + ensure_htlc_amounts_above_dust_buffer + amt_msat {
1954 send_payment(&nodes[0], &vec![&nodes[1], &nodes[2]][..], recv_value_0);
1956 let (stat01_, stat11_, stat12_, stat22_) = (
1957 get_channel_value_stat!(nodes[0], chan_1.2),
1958 get_channel_value_stat!(nodes[1], chan_1.2),
1959 get_channel_value_stat!(nodes[1], chan_2.2),
1960 get_channel_value_stat!(nodes[2], chan_2.2),
1963 assert_eq!(stat01_.value_to_self_msat, stat01.value_to_self_msat - amt_msat);
1964 assert_eq!(stat11_.value_to_self_msat, stat11.value_to_self_msat + amt_msat);
1965 assert_eq!(stat12_.value_to_self_msat, stat12.value_to_self_msat - (amt_msat - feemsat));
1966 assert_eq!(stat22_.value_to_self_msat, stat22.value_to_self_msat + (amt_msat - feemsat));
1967 stat01 = stat01_; stat11 = stat11_; stat12 = stat12_; stat22 = stat22_;
1970 // adding pending output.
1971 // 2* and +1 HTLCs on the commit tx fee for the fee spike reserve.
1972 // The reason we're dividing by two here is as follows: the dividend is the total outbound liquidity
1973 // after fees, the channel reserve, and the fee spike buffer are removed. We eventually want to
1974 // divide this quantity into 3 portions, that will each be sent in an HTLC. This allows us
1975 // to test channel channel reserve policy at the edges of what amount is sendable, i.e.
1976 // cases where 1 msat over X amount will cause a payment failure, but anything less than
1977 // that can be sent successfully. So, dividing by two is a somewhat arbitrary way of getting
1978 // the amount of the first of these aforementioned 3 payments. The reason we split into 3 payments
1979 // is to test the behavior of the holding cell with respect to channel reserve and commit tx fee
1981 let commit_tx_fee_2_htlcs = 2*commit_tx_fee_msat(feerate, 2 + 1);
1982 let recv_value_1 = (stat01.value_to_self_msat - stat01.channel_reserve_msat - total_fee_msat - commit_tx_fee_2_htlcs)/2;
1983 let amt_msat_1 = recv_value_1 + total_fee_msat;
1985 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);
1986 let payment_event_1 = {
1987 nodes[0].node.send_payment(&route_1, our_payment_hash_1, &Some(our_payment_secret_1)).unwrap();
1988 check_added_monitors!(nodes[0], 1);
1990 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1991 assert_eq!(events.len(), 1);
1992 SendEvent::from_event(events.remove(0))
1994 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event_1.msgs[0]);
1996 // channel reserve test with htlc pending output > 0
1997 let recv_value_2 = stat01.value_to_self_msat - amt_msat_1 - stat01.channel_reserve_msat - total_fee_msat - commit_tx_fee_2_htlcs;
1999 let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], recv_value_2 + 1);
2000 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
2001 assert!(regex::Regex::new(r"Cannot send value that would put our balance under counterparty-announced channel reserve value \(\d+\)").unwrap().is_match(err)));
2002 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
2005 // split the rest to test holding cell
2006 let commit_tx_fee_3_htlcs = 2*commit_tx_fee_msat(feerate, 3 + 1);
2007 let additional_htlc_cost_msat = commit_tx_fee_3_htlcs - commit_tx_fee_2_htlcs;
2008 let recv_value_21 = recv_value_2/2 - additional_htlc_cost_msat/2;
2009 let recv_value_22 = recv_value_2 - recv_value_21 - total_fee_msat - additional_htlc_cost_msat;
2011 let stat = get_channel_value_stat!(nodes[0], chan_1.2);
2012 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);
2015 // now see if they go through on both sides
2016 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);
2017 // but this will stuck in the holding cell
2018 nodes[0].node.send_payment(&route_21, our_payment_hash_21, &Some(our_payment_secret_21)).unwrap();
2019 check_added_monitors!(nodes[0], 0);
2020 let events = nodes[0].node.get_and_clear_pending_events();
2021 assert_eq!(events.len(), 0);
2023 // test with outbound holding cell amount > 0
2025 let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], recv_value_22+1);
2026 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
2027 assert!(regex::Regex::new(r"Cannot send value that would put our balance under counterparty-announced channel reserve value \(\d+\)").unwrap().is_match(err)));
2028 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
2029 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);
2032 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);
2033 // this will also stuck in the holding cell
2034 nodes[0].node.send_payment(&route_22, our_payment_hash_22, &Some(our_payment_secret_22)).unwrap();
2035 check_added_monitors!(nodes[0], 0);
2036 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
2037 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
2039 // flush the pending htlc
2040 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event_1.commitment_msg);
2041 let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2042 check_added_monitors!(nodes[1], 1);
2044 // the pending htlc should be promoted to committed
2045 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_revoke_and_ack);
2046 check_added_monitors!(nodes[0], 1);
2047 let commitment_update_2 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2049 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &as_commitment_signed);
2050 let bs_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2051 // No commitment_signed so get_event_msg's assert(len == 1) passes
2052 check_added_monitors!(nodes[0], 1);
2054 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &bs_revoke_and_ack);
2055 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2056 check_added_monitors!(nodes[1], 1);
2058 expect_pending_htlcs_forwardable!(nodes[1]);
2060 let ref payment_event_11 = expect_forward!(nodes[1]);
2061 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_11.msgs[0]);
2062 commitment_signed_dance!(nodes[2], nodes[1], payment_event_11.commitment_msg, false);
2064 expect_pending_htlcs_forwardable!(nodes[2]);
2065 expect_payment_received!(nodes[2], our_payment_hash_1, our_payment_secret_1, recv_value_1);
2067 // flush the htlcs in the holding cell
2068 assert_eq!(commitment_update_2.update_add_htlcs.len(), 2);
2069 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &commitment_update_2.update_add_htlcs[0]);
2070 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &commitment_update_2.update_add_htlcs[1]);
2071 commitment_signed_dance!(nodes[1], nodes[0], &commitment_update_2.commitment_signed, false);
2072 expect_pending_htlcs_forwardable!(nodes[1]);
2074 let ref payment_event_3 = expect_forward!(nodes[1]);
2075 assert_eq!(payment_event_3.msgs.len(), 2);
2076 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_3.msgs[0]);
2077 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_3.msgs[1]);
2079 commitment_signed_dance!(nodes[2], nodes[1], &payment_event_3.commitment_msg, false);
2080 expect_pending_htlcs_forwardable!(nodes[2]);
2082 let events = nodes[2].node.get_and_clear_pending_events();
2083 assert_eq!(events.len(), 2);
2085 Event::PaymentReceived { ref payment_hash, ref payment_preimage, ref payment_secret, amt, user_payment_id: _ } => {
2086 assert_eq!(our_payment_hash_21, *payment_hash);
2087 assert!(payment_preimage.is_none());
2088 assert_eq!(our_payment_secret_21, *payment_secret);
2089 assert_eq!(recv_value_21, amt);
2091 _ => panic!("Unexpected event"),
2094 Event::PaymentReceived { ref payment_hash, ref payment_preimage, ref payment_secret, amt, user_payment_id: _ } => {
2095 assert_eq!(our_payment_hash_22, *payment_hash);
2096 assert!(payment_preimage.is_none());
2097 assert_eq!(our_payment_secret_22, *payment_secret);
2098 assert_eq!(recv_value_22, amt);
2100 _ => panic!("Unexpected event"),
2103 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_1);
2104 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_21);
2105 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_22);
2107 let commit_tx_fee_0_htlcs = 2*commit_tx_fee_msat(feerate, 1);
2108 let recv_value_3 = commit_tx_fee_2_htlcs - commit_tx_fee_0_htlcs - total_fee_msat;
2109 send_payment(&nodes[0], &vec![&nodes[1], &nodes[2]][..], recv_value_3);
2111 let commit_tx_fee_1_htlc = 2*commit_tx_fee_msat(feerate, 1 + 1);
2112 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);
2113 let stat0 = get_channel_value_stat!(nodes[0], chan_1.2);
2114 assert_eq!(stat0.value_to_self_msat, expected_value_to_self);
2115 assert_eq!(stat0.value_to_self_msat, stat0.channel_reserve_msat + commit_tx_fee_1_htlc);
2117 let stat2 = get_channel_value_stat!(nodes[2], chan_2.2);
2118 assert_eq!(stat2.value_to_self_msat, stat22.value_to_self_msat + recv_value_1 + recv_value_21 + recv_value_22 + recv_value_3);
2122 fn channel_reserve_in_flight_removes() {
2123 // In cases where one side claims an HTLC, it thinks it has additional available funds that it
2124 // can send to its counterparty, but due to update ordering, the other side may not yet have
2125 // considered those HTLCs fully removed.
2126 // This tests that we don't count HTLCs which will not be included in the next remote
2127 // commitment transaction towards the reserve value (as it implies no commitment transaction
2128 // will be generated which violates the remote reserve value).
2129 // This was broken previously, and discovered by the chanmon_fail_consistency fuzz test.
2131 // * route two HTLCs from A to B (note that, at a high level, this test is checking that, when
2132 // you consider the values of both of these HTLCs, B may not send an HTLC back to A, but if
2133 // you only consider the value of the first HTLC, it may not),
2134 // * start routing a third HTLC from A to B,
2135 // * claim the first two HTLCs (though B will generate an update_fulfill for one, and put
2136 // the other claim in its holding cell, as it immediately goes into AwaitingRAA),
2137 // * deliver the first fulfill from B
2138 // * deliver the update_add and an RAA from A, resulting in B freeing the second holding cell
2140 // * deliver A's response CS and RAA.
2141 // This results in A having the second HTLC in AwaitingRemovedRemoteRevoke, but B having
2142 // removed it fully. B now has the push_msat plus the first two HTLCs in value.
2143 // * Now B happily sends another HTLC, potentially violating its reserve value from A's point
2144 // of view (if A counts the AwaitingRemovedRemoteRevoke HTLC).
2145 let chanmon_cfgs = create_chanmon_cfgs(2);
2146 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2147 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2148 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2149 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2150 let logger = test_utils::TestLogger::new();
2152 let b_chan_values = get_channel_value_stat!(nodes[1], chan_1.2);
2153 // Route the first two HTLCs.
2154 let (payment_preimage_1, _, _) = route_payment(&nodes[0], &[&nodes[1]], b_chan_values.channel_reserve_msat - b_chan_values.value_to_self_msat - 10000);
2155 let (payment_preimage_2, _, _) = route_payment(&nodes[0], &[&nodes[1]], 20000);
2157 // Start routing the third HTLC (this is just used to get everyone in the right state).
2158 let (payment_preimage_3, payment_hash_3, payment_secret_3) = get_payment_preimage_hash!(nodes[1]);
2160 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
2161 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();
2162 nodes[0].node.send_payment(&route, payment_hash_3, &Some(payment_secret_3)).unwrap();
2163 check_added_monitors!(nodes[0], 1);
2164 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
2165 assert_eq!(events.len(), 1);
2166 SendEvent::from_event(events.remove(0))
2169 // Now claim both of the first two HTLCs on B's end, putting B in AwaitingRAA and generating an
2170 // initial fulfill/CS.
2171 assert!(nodes[1].node.claim_funds(payment_preimage_1));
2172 check_added_monitors!(nodes[1], 1);
2173 let bs_removes = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2175 // This claim goes in B's holding cell, allowing us to have a pending B->A RAA which does not
2176 // remove the second HTLC when we send the HTLC back from B to A.
2177 assert!(nodes[1].node.claim_funds(payment_preimage_2));
2178 check_added_monitors!(nodes[1], 1);
2179 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2181 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_removes.update_fulfill_htlcs[0]);
2182 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_removes.commitment_signed);
2183 check_added_monitors!(nodes[0], 1);
2184 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2185 expect_payment_sent!(nodes[0], payment_preimage_1);
2187 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_1.msgs[0]);
2188 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &send_1.commitment_msg);
2189 check_added_monitors!(nodes[1], 1);
2190 // B is already AwaitingRAA, so cant generate a CS here
2191 let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2193 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
2194 check_added_monitors!(nodes[1], 1);
2195 let bs_cs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2197 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2198 check_added_monitors!(nodes[0], 1);
2199 let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2201 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
2202 check_added_monitors!(nodes[1], 1);
2203 let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2205 // The second HTLCis removed, but as A is in AwaitingRAA it can't generate a CS here, so the
2206 // RAA that B generated above doesn't fully resolve the second HTLC from A's point of view.
2207 // However, the RAA A generates here *does* fully resolve the HTLC from B's point of view (as A
2208 // can no longer broadcast a commitment transaction with it and B has the preimage so can go
2209 // on-chain as necessary).
2210 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_cs.update_fulfill_htlcs[0]);
2211 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_cs.commitment_signed);
2212 check_added_monitors!(nodes[0], 1);
2213 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2214 expect_payment_sent!(nodes[0], payment_preimage_2);
2216 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
2217 check_added_monitors!(nodes[1], 1);
2218 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2220 expect_pending_htlcs_forwardable!(nodes[1]);
2221 expect_payment_received!(nodes[1], payment_hash_3, payment_secret_3, 100000);
2223 // Note that as this RAA was generated before the delivery of the update_fulfill it shouldn't
2224 // resolve the second HTLC from A's point of view.
2225 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2226 check_added_monitors!(nodes[0], 1);
2227 let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2229 // Now that B doesn't have the second RAA anymore, but A still does, send a payment from B back
2230 // to A to ensure that A doesn't count the almost-removed HTLC in update_add processing.
2231 let (payment_preimage_4, payment_hash_4, payment_secret_4) = get_payment_preimage_hash!(nodes[0]);
2233 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
2234 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();
2235 nodes[1].node.send_payment(&route, payment_hash_4, &Some(payment_secret_4)).unwrap();
2236 check_added_monitors!(nodes[1], 1);
2237 let mut events = nodes[1].node.get_and_clear_pending_msg_events();
2238 assert_eq!(events.len(), 1);
2239 SendEvent::from_event(events.remove(0))
2242 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &send_2.msgs[0]);
2243 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &send_2.commitment_msg);
2244 check_added_monitors!(nodes[0], 1);
2245 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2247 // Now just resolve all the outstanding messages/HTLCs for completeness...
2249 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
2250 check_added_monitors!(nodes[1], 1);
2251 let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2253 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
2254 check_added_monitors!(nodes[1], 1);
2256 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2257 check_added_monitors!(nodes[0], 1);
2258 let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2260 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
2261 check_added_monitors!(nodes[1], 1);
2262 let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2264 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2265 check_added_monitors!(nodes[0], 1);
2267 expect_pending_htlcs_forwardable!(nodes[0]);
2268 expect_payment_received!(nodes[0], payment_hash_4, payment_secret_4, 10000);
2270 claim_payment(&nodes[1], &[&nodes[0]], payment_preimage_4);
2271 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_3);
2275 fn channel_monitor_network_test() {
2276 // Simple test which builds a network of ChannelManagers, connects them to each other, and
2277 // tests that ChannelMonitor is able to recover from various states.
2278 let chanmon_cfgs = create_chanmon_cfgs(5);
2279 let node_cfgs = create_node_cfgs(5, &chanmon_cfgs);
2280 let node_chanmgrs = create_node_chanmgrs(5, &node_cfgs, &[None, None, None, None, None]);
2281 let nodes = create_network(5, &node_cfgs, &node_chanmgrs);
2283 // Create some initial channels
2284 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2285 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
2286 let chan_3 = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
2287 let chan_4 = create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::known(), InitFeatures::known());
2289 // Make sure all nodes are at the same starting height
2290 connect_blocks(&nodes[0], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[0].best_block_info().1);
2291 connect_blocks(&nodes[1], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[1].best_block_info().1);
2292 connect_blocks(&nodes[2], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[2].best_block_info().1);
2293 connect_blocks(&nodes[3], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[3].best_block_info().1);
2294 connect_blocks(&nodes[4], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[4].best_block_info().1);
2296 // Rebalance the network a bit by relaying one payment through all the channels...
2297 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
2298 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
2299 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
2300 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
2302 // Simple case with no pending HTLCs:
2303 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), true);
2304 check_added_monitors!(nodes[1], 1);
2305 check_closed_broadcast!(nodes[1], false);
2307 let mut node_txn = test_txn_broadcast(&nodes[1], &chan_1, None, HTLCType::NONE);
2308 assert_eq!(node_txn.len(), 1);
2309 mine_transaction(&nodes[0], &node_txn[0]);
2310 check_added_monitors!(nodes[0], 1);
2311 test_txn_broadcast(&nodes[0], &chan_1, None, HTLCType::NONE);
2313 check_closed_broadcast!(nodes[0], true);
2314 assert_eq!(nodes[0].node.list_channels().len(), 0);
2315 assert_eq!(nodes[1].node.list_channels().len(), 1);
2317 // One pending HTLC is discarded by the force-close:
2318 let payment_preimage_1 = route_payment(&nodes[1], &vec!(&nodes[2], &nodes[3])[..], 3000000).0;
2320 // Simple case of one pending HTLC to HTLC-Timeout (note that the HTLC-Timeout is not
2321 // broadcasted until we reach the timelock time).
2322 nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id(), true);
2323 check_closed_broadcast!(nodes[1], false);
2324 check_added_monitors!(nodes[1], 1);
2326 let mut node_txn = test_txn_broadcast(&nodes[1], &chan_2, None, HTLCType::NONE);
2327 connect_blocks(&nodes[1], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + MIN_CLTV_EXPIRY_DELTA as u32 + 1);
2328 test_txn_broadcast(&nodes[1], &chan_2, None, HTLCType::TIMEOUT);
2329 mine_transaction(&nodes[2], &node_txn[0]);
2330 check_added_monitors!(nodes[2], 1);
2331 test_txn_broadcast(&nodes[2], &chan_2, None, HTLCType::NONE);
2333 check_closed_broadcast!(nodes[2], true);
2334 assert_eq!(nodes[1].node.list_channels().len(), 0);
2335 assert_eq!(nodes[2].node.list_channels().len(), 1);
2337 macro_rules! claim_funds {
2338 ($node: expr, $prev_node: expr, $preimage: expr) => {
2340 assert!($node.node.claim_funds($preimage));
2341 check_added_monitors!($node, 1);
2343 let events = $node.node.get_and_clear_pending_msg_events();
2344 assert_eq!(events.len(), 1);
2346 MessageSendEvent::UpdateHTLCs { ref node_id, updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fail_htlcs, .. } } => {
2347 assert!(update_add_htlcs.is_empty());
2348 assert!(update_fail_htlcs.is_empty());
2349 assert_eq!(*node_id, $prev_node.node.get_our_node_id());
2351 _ => panic!("Unexpected event"),
2357 // nodes[3] gets the preimage, but nodes[2] already disconnected, resulting in a nodes[2]
2358 // HTLC-Timeout and a nodes[3] claim against it (+ its own announces)
2359 nodes[2].node.peer_disconnected(&nodes[3].node.get_our_node_id(), true);
2360 check_added_monitors!(nodes[2], 1);
2361 check_closed_broadcast!(nodes[2], false);
2362 let node2_commitment_txid;
2364 let node_txn = test_txn_broadcast(&nodes[2], &chan_3, None, HTLCType::NONE);
2365 connect_blocks(&nodes[2], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + MIN_CLTV_EXPIRY_DELTA as u32 + 1);
2366 test_txn_broadcast(&nodes[2], &chan_3, None, HTLCType::TIMEOUT);
2367 node2_commitment_txid = node_txn[0].txid();
2369 // Claim the payment on nodes[3], giving it knowledge of the preimage
2370 claim_funds!(nodes[3], nodes[2], payment_preimage_1);
2371 mine_transaction(&nodes[3], &node_txn[0]);
2372 check_added_monitors!(nodes[3], 1);
2373 check_preimage_claim(&nodes[3], &node_txn);
2375 check_closed_broadcast!(nodes[3], true);
2376 assert_eq!(nodes[2].node.list_channels().len(), 0);
2377 assert_eq!(nodes[3].node.list_channels().len(), 1);
2379 // Drop the ChannelMonitor for the previous channel to avoid it broadcasting transactions and
2380 // confusing us in the following tests.
2381 let chan_3_mon = nodes[3].chain_monitor.chain_monitor.monitors.write().unwrap().remove(&OutPoint { txid: chan_3.3.txid(), index: 0 }).unwrap();
2383 // One pending HTLC to time out:
2384 let payment_preimage_2 = route_payment(&nodes[3], &vec!(&nodes[4])[..], 3000000).0;
2385 // CLTV expires at TEST_FINAL_CLTV + 1 (current height) + 1 (added in send_payment for
2388 let (close_chan_update_1, close_chan_update_2) = {
2389 connect_blocks(&nodes[3], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + 1);
2390 let events = nodes[3].node.get_and_clear_pending_msg_events();
2391 assert_eq!(events.len(), 2);
2392 let close_chan_update_1 = match events[0] {
2393 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
2396 _ => panic!("Unexpected event"),
2399 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { .. }, node_id } => {
2400 assert_eq!(node_id, nodes[4].node.get_our_node_id());
2402 _ => panic!("Unexpected event"),
2404 check_added_monitors!(nodes[3], 1);
2406 // Clear bumped claiming txn spending node 2 commitment tx. Bumped txn are generated after reaching some height timer.
2408 let mut node_txn = nodes[3].tx_broadcaster.txn_broadcasted.lock().unwrap();
2409 node_txn.retain(|tx| {
2410 if tx.input[0].previous_output.txid == node2_commitment_txid {
2416 let node_txn = test_txn_broadcast(&nodes[3], &chan_4, None, HTLCType::TIMEOUT);
2418 // Claim the payment on nodes[4], giving it knowledge of the preimage
2419 claim_funds!(nodes[4], nodes[3], payment_preimage_2);
2421 connect_blocks(&nodes[4], TEST_FINAL_CLTV - CLTV_CLAIM_BUFFER + 2);
2422 let events = nodes[4].node.get_and_clear_pending_msg_events();
2423 assert_eq!(events.len(), 2);
2424 let close_chan_update_2 = match events[0] {
2425 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
2428 _ => panic!("Unexpected event"),
2431 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { .. }, node_id } => {
2432 assert_eq!(node_id, nodes[3].node.get_our_node_id());
2434 _ => panic!("Unexpected event"),
2436 check_added_monitors!(nodes[4], 1);
2437 test_txn_broadcast(&nodes[4], &chan_4, None, HTLCType::SUCCESS);
2439 mine_transaction(&nodes[4], &node_txn[0]);
2440 check_preimage_claim(&nodes[4], &node_txn);
2441 (close_chan_update_1, close_chan_update_2)
2443 nodes[3].net_graph_msg_handler.handle_channel_update(&close_chan_update_2).unwrap();
2444 nodes[4].net_graph_msg_handler.handle_channel_update(&close_chan_update_1).unwrap();
2445 assert_eq!(nodes[3].node.list_channels().len(), 0);
2446 assert_eq!(nodes[4].node.list_channels().len(), 0);
2448 nodes[3].chain_monitor.chain_monitor.monitors.write().unwrap().insert(OutPoint { txid: chan_3.3.txid(), index: 0 }, chan_3_mon);
2452 fn test_justice_tx() {
2453 // Test justice txn built on revoked HTLC-Success tx, against both sides
2454 let mut alice_config = UserConfig::default();
2455 alice_config.channel_options.announced_channel = true;
2456 alice_config.peer_channel_config_limits.force_announced_channel_preference = false;
2457 alice_config.own_channel_config.our_to_self_delay = 6 * 24 * 5;
2458 let mut bob_config = UserConfig::default();
2459 bob_config.channel_options.announced_channel = true;
2460 bob_config.peer_channel_config_limits.force_announced_channel_preference = false;
2461 bob_config.own_channel_config.our_to_self_delay = 6 * 24 * 3;
2462 let user_cfgs = [Some(alice_config), Some(bob_config)];
2463 let mut chanmon_cfgs = create_chanmon_cfgs(2);
2464 chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
2465 chanmon_cfgs[1].keys_manager.disable_revocation_policy_check = true;
2466 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2467 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &user_cfgs);
2468 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2469 // Create some new channels:
2470 let chan_5 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2472 // A pending HTLC which will be revoked:
2473 let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2474 // Get the will-be-revoked local txn from nodes[0]
2475 let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_5.2);
2476 assert_eq!(revoked_local_txn.len(), 2); // First commitment tx, then HTLC tx
2477 assert_eq!(revoked_local_txn[0].input.len(), 1);
2478 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_5.3.txid());
2479 assert_eq!(revoked_local_txn[0].output.len(), 2); // Only HTLC and output back to 0 are present
2480 assert_eq!(revoked_local_txn[1].input.len(), 1);
2481 assert_eq!(revoked_local_txn[1].input[0].previous_output.txid, revoked_local_txn[0].txid());
2482 assert_eq!(revoked_local_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC-Timeout
2483 // Revoke the old state
2484 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_3);
2487 mine_transaction(&nodes[1], &revoked_local_txn[0]);
2489 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2490 assert_eq!(node_txn.len(), 2); // ChannelMonitor: penalty tx, ChannelManager: local commitment tx
2491 assert_eq!(node_txn[0].input.len(), 2); // We should claim the revoked output and the HTLC output
2493 check_spends!(node_txn[0], revoked_local_txn[0]);
2494 node_txn.swap_remove(0);
2495 node_txn.truncate(1);
2497 check_added_monitors!(nodes[1], 1);
2498 test_txn_broadcast(&nodes[1], &chan_5, None, HTLCType::NONE);
2500 mine_transaction(&nodes[0], &revoked_local_txn[0]);
2501 connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
2502 // Verify broadcast of revoked HTLC-timeout
2503 let node_txn = test_txn_broadcast(&nodes[0], &chan_5, Some(revoked_local_txn[0].clone()), HTLCType::TIMEOUT);
2504 check_added_monitors!(nodes[0], 1);
2505 // Broadcast revoked HTLC-timeout on node 1
2506 mine_transaction(&nodes[1], &node_txn[1]);
2507 test_revoked_htlc_claim_txn_broadcast(&nodes[1], node_txn[1].clone(), revoked_local_txn[0].clone());
2509 get_announce_close_broadcast_events(&nodes, 0, 1);
2511 assert_eq!(nodes[0].node.list_channels().len(), 0);
2512 assert_eq!(nodes[1].node.list_channels().len(), 0);
2514 // We test justice_tx build by A on B's revoked HTLC-Success tx
2515 // Create some new channels:
2516 let chan_6 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2518 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2522 // A pending HTLC which will be revoked:
2523 let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2524 // Get the will-be-revoked local txn from B
2525 let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan_6.2);
2526 assert_eq!(revoked_local_txn.len(), 1); // Only commitment tx
2527 assert_eq!(revoked_local_txn[0].input.len(), 1);
2528 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_6.3.txid());
2529 assert_eq!(revoked_local_txn[0].output.len(), 2); // Only HTLC and output back to A are present
2530 // Revoke the old state
2531 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_4);
2533 mine_transaction(&nodes[0], &revoked_local_txn[0]);
2535 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
2536 assert_eq!(node_txn.len(), 2); //ChannelMonitor: penalty tx, ChannelManager: local commitment tx
2537 assert_eq!(node_txn[0].input.len(), 1); // We claim the received HTLC output
2539 check_spends!(node_txn[0], revoked_local_txn[0]);
2540 node_txn.swap_remove(0);
2542 check_added_monitors!(nodes[0], 1);
2543 test_txn_broadcast(&nodes[0], &chan_6, None, HTLCType::NONE);
2545 mine_transaction(&nodes[1], &revoked_local_txn[0]);
2546 let node_txn = test_txn_broadcast(&nodes[1], &chan_6, Some(revoked_local_txn[0].clone()), HTLCType::SUCCESS);
2547 check_added_monitors!(nodes[1], 1);
2548 mine_transaction(&nodes[0], &node_txn[1]);
2549 test_revoked_htlc_claim_txn_broadcast(&nodes[0], node_txn[1].clone(), revoked_local_txn[0].clone());
2551 get_announce_close_broadcast_events(&nodes, 0, 1);
2552 assert_eq!(nodes[0].node.list_channels().len(), 0);
2553 assert_eq!(nodes[1].node.list_channels().len(), 0);
2557 fn revoked_output_claim() {
2558 // Simple test to ensure a node will claim a revoked output when a stale remote commitment
2559 // transaction is broadcast by its counterparty
2560 let chanmon_cfgs = create_chanmon_cfgs(2);
2561 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2562 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2563 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2564 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2565 // node[0] is gonna to revoke an old state thus node[1] should be able to claim the revoked output
2566 let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2567 assert_eq!(revoked_local_txn.len(), 1);
2568 // Only output is the full channel value back to nodes[0]:
2569 assert_eq!(revoked_local_txn[0].output.len(), 1);
2570 // Send a payment through, updating everyone's latest commitment txn
2571 send_payment(&nodes[0], &vec!(&nodes[1])[..], 5000000);
2573 // Inform nodes[1] that nodes[0] broadcast a stale tx
2574 mine_transaction(&nodes[1], &revoked_local_txn[0]);
2575 check_added_monitors!(nodes[1], 1);
2576 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2577 assert_eq!(node_txn.len(), 2); // ChannelMonitor: justice tx against revoked to_local output, ChannelManager: local commitment tx
2579 check_spends!(node_txn[0], revoked_local_txn[0]);
2580 check_spends!(node_txn[1], chan_1.3);
2582 // Inform nodes[0] that a watchtower cheated on its behalf, so it will force-close the chan
2583 mine_transaction(&nodes[0], &revoked_local_txn[0]);
2584 get_announce_close_broadcast_events(&nodes, 0, 1);
2585 check_added_monitors!(nodes[0], 1)
2589 fn claim_htlc_outputs_shared_tx() {
2590 // Node revoked old state, htlcs haven't time out yet, claim them in shared justice tx
2591 let mut chanmon_cfgs = create_chanmon_cfgs(2);
2592 chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
2593 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2594 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2595 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2597 // Create some new channel:
2598 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2600 // Rebalance the network to generate htlc in the two directions
2601 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
2602 // 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
2603 let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2604 let (_payment_preimage_2, payment_hash_2, _) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000);
2606 // Get the will-be-revoked local txn from node[0]
2607 let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2608 assert_eq!(revoked_local_txn.len(), 2); // commitment tx + 1 HTLC-Timeout tx
2609 assert_eq!(revoked_local_txn[0].input.len(), 1);
2610 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
2611 assert_eq!(revoked_local_txn[1].input.len(), 1);
2612 assert_eq!(revoked_local_txn[1].input[0].previous_output.txid, revoked_local_txn[0].txid());
2613 assert_eq!(revoked_local_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC-Timeout
2614 check_spends!(revoked_local_txn[1], revoked_local_txn[0]);
2616 //Revoke the old state
2617 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_1);
2620 mine_transaction(&nodes[0], &revoked_local_txn[0]);
2621 check_added_monitors!(nodes[0], 1);
2622 mine_transaction(&nodes[1], &revoked_local_txn[0]);
2623 check_added_monitors!(nodes[1], 1);
2624 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
2625 expect_payment_failed!(nodes[1], payment_hash_2, true);
2627 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2628 assert_eq!(node_txn.len(), 2); // ChannelMonitor: penalty tx, ChannelManager: local commitment
2630 assert_eq!(node_txn[0].input.len(), 3); // Claim the revoked output + both revoked HTLC outputs
2631 check_spends!(node_txn[0], revoked_local_txn[0]);
2633 let mut witness_lens = BTreeSet::new();
2634 witness_lens.insert(node_txn[0].input[0].witness.last().unwrap().len());
2635 witness_lens.insert(node_txn[0].input[1].witness.last().unwrap().len());
2636 witness_lens.insert(node_txn[0].input[2].witness.last().unwrap().len());
2637 assert_eq!(witness_lens.len(), 3);
2638 assert_eq!(*witness_lens.iter().skip(0).next().unwrap(), 77); // revoked to_local
2639 assert_eq!(*witness_lens.iter().skip(1).next().unwrap(), OFFERED_HTLC_SCRIPT_WEIGHT); // revoked offered HTLC
2640 assert_eq!(*witness_lens.iter().skip(2).next().unwrap(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // revoked received HTLC
2642 // Next nodes[1] broadcasts its current local tx state:
2643 assert_eq!(node_txn[1].input.len(), 1);
2644 assert_eq!(node_txn[1].input[0].previous_output.txid, chan_1.3.txid()); //Spending funding tx unique txouput, tx broadcasted by ChannelManager
2646 get_announce_close_broadcast_events(&nodes, 0, 1);
2647 assert_eq!(nodes[0].node.list_channels().len(), 0);
2648 assert_eq!(nodes[1].node.list_channels().len(), 0);
2652 fn claim_htlc_outputs_single_tx() {
2653 // Node revoked old state, htlcs have timed out, claim each of them in separated justice tx
2654 let mut chanmon_cfgs = create_chanmon_cfgs(2);
2655 chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
2656 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2657 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2658 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2660 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2662 // Rebalance the network to generate htlc in the two directions
2663 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
2664 // 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
2665 // time as two different claim transactions as we're gonna to timeout htlc with given a high current height
2666 let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2667 let (_payment_preimage_2, payment_hash_2, _payment_secret_2) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000);
2669 // Get the will-be-revoked local txn from node[0]
2670 let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2672 //Revoke the old state
2673 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_1);
2676 confirm_transaction_at(&nodes[0], &revoked_local_txn[0], 100);
2677 check_added_monitors!(nodes[0], 1);
2678 confirm_transaction_at(&nodes[1], &revoked_local_txn[0], 100);
2679 check_added_monitors!(nodes[1], 1);
2680 expect_pending_htlcs_forwardable_ignore!(nodes[0]);
2682 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
2683 expect_payment_failed!(nodes[1], payment_hash_2, true);
2685 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2686 assert_eq!(node_txn.len(), 9);
2687 // ChannelMonitor: justice tx revoked offered htlc, justice tx revoked received htlc, justice tx revoked to_local (3)
2688 // ChannelManager: local commmitment + local HTLC-timeout (2)
2689 // 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)
2690 // ChannelMonitor: local commitment + local HTLC-timeout (2)
2692 // Check the pair local commitment and HTLC-timeout broadcast due to HTLC expiration
2693 assert_eq!(node_txn[0].input.len(), 1);
2694 check_spends!(node_txn[0], chan_1.3);
2695 assert_eq!(node_txn[1].input.len(), 1);
2696 let witness_script = node_txn[1].input[0].witness.last().unwrap();
2697 assert_eq!(witness_script.len(), OFFERED_HTLC_SCRIPT_WEIGHT); //Spending an offered htlc output
2698 check_spends!(node_txn[1], node_txn[0]);
2700 // Justice transactions are indices 1-2-4
2701 assert_eq!(node_txn[2].input.len(), 1);
2702 assert_eq!(node_txn[3].input.len(), 1);
2703 assert_eq!(node_txn[4].input.len(), 1);
2705 check_spends!(node_txn[2], revoked_local_txn[0]);
2706 check_spends!(node_txn[3], revoked_local_txn[0]);
2707 check_spends!(node_txn[4], revoked_local_txn[0]);
2709 let mut witness_lens = BTreeSet::new();
2710 witness_lens.insert(node_txn[2].input[0].witness.last().unwrap().len());
2711 witness_lens.insert(node_txn[3].input[0].witness.last().unwrap().len());
2712 witness_lens.insert(node_txn[4].input[0].witness.last().unwrap().len());
2713 assert_eq!(witness_lens.len(), 3);
2714 assert_eq!(*witness_lens.iter().skip(0).next().unwrap(), 77); // revoked to_local
2715 assert_eq!(*witness_lens.iter().skip(1).next().unwrap(), OFFERED_HTLC_SCRIPT_WEIGHT); // revoked offered HTLC
2716 assert_eq!(*witness_lens.iter().skip(2).next().unwrap(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // revoked received HTLC
2718 get_announce_close_broadcast_events(&nodes, 0, 1);
2719 assert_eq!(nodes[0].node.list_channels().len(), 0);
2720 assert_eq!(nodes[1].node.list_channels().len(), 0);
2724 fn test_htlc_on_chain_success() {
2725 // Test that in case of a unilateral close onchain, we detect the state of output and pass
2726 // the preimage backward accordingly. So here we test that ChannelManager is
2727 // broadcasting the right event to other nodes in payment path.
2728 // We test with two HTLCs simultaneously as that was not handled correctly in the past.
2729 // A --------------------> B ----------------------> C (preimage)
2730 // First, C should claim the HTLC outputs via HTLC-Success when its own latest local
2731 // commitment transaction was broadcast.
2732 // Then, B should learn the preimage from said transactions, attempting to claim backwards
2734 // B should be able to claim via preimage if A then broadcasts its local tx.
2735 // Finally, when A sees B's latest local commitment transaction it should be able to claim
2736 // the HTLC outputs via the preimage it learned (which, once confirmed should generate a
2737 // PaymentSent event).
2739 let chanmon_cfgs = create_chanmon_cfgs(3);
2740 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2741 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2742 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2744 // Create some initial channels
2745 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2746 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
2748 // Ensure all nodes are at the same height
2749 let node_max_height = nodes.iter().map(|node| node.blocks.lock().unwrap().len()).max().unwrap() as u32;
2750 connect_blocks(&nodes[0], node_max_height - nodes[0].best_block_info().1);
2751 connect_blocks(&nodes[1], node_max_height - nodes[1].best_block_info().1);
2752 connect_blocks(&nodes[2], node_max_height - nodes[2].best_block_info().1);
2754 // Rebalance the network a bit by relaying one payment through all the channels...
2755 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
2756 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
2758 let (our_payment_preimage, _payment_hash, _payment_secret) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2759 let (our_payment_preimage_2, _payment_hash_2, _payment_secret_2) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2761 // Broadcast legit commitment tx from C on B's chain
2762 // Broadcast HTLC Success transaction by C on received output from C's commitment tx on B's chain
2763 let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
2764 assert_eq!(commitment_tx.len(), 1);
2765 check_spends!(commitment_tx[0], chan_2.3);
2766 nodes[2].node.claim_funds(our_payment_preimage);
2767 nodes[2].node.claim_funds(our_payment_preimage_2);
2768 check_added_monitors!(nodes[2], 2);
2769 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2770 assert!(updates.update_add_htlcs.is_empty());
2771 assert!(updates.update_fail_htlcs.is_empty());
2772 assert!(updates.update_fail_malformed_htlcs.is_empty());
2773 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
2775 mine_transaction(&nodes[2], &commitment_tx[0]);
2776 check_closed_broadcast!(nodes[2], true);
2777 check_added_monitors!(nodes[2], 1);
2778 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)
2779 assert_eq!(node_txn.len(), 5);
2780 assert_eq!(node_txn[0], node_txn[3]);
2781 assert_eq!(node_txn[1], node_txn[4]);
2782 assert_eq!(node_txn[2], commitment_tx[0]);
2783 check_spends!(node_txn[0], commitment_tx[0]);
2784 check_spends!(node_txn[1], commitment_tx[0]);
2785 assert_eq!(node_txn[0].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2786 assert_eq!(node_txn[1].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2787 assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2788 assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2789 assert_eq!(node_txn[0].lock_time, 0);
2790 assert_eq!(node_txn[1].lock_time, 0);
2792 // Verify that B's ChannelManager is able to extract preimage from HTLC Success tx and pass it backward
2793 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2794 connect_block(&nodes[1], &Block { header, txdata: node_txn});
2795 connect_blocks(&nodes[1], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
2797 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
2798 assert_eq!(added_monitors.len(), 1);
2799 assert_eq!(added_monitors[0].0.txid, chan_2.3.txid());
2800 added_monitors.clear();
2802 let events = nodes[1].node.get_and_clear_pending_msg_events();
2804 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
2805 assert_eq!(added_monitors.len(), 2);
2806 assert_eq!(added_monitors[0].0.txid, chan_1.3.txid());
2807 assert_eq!(added_monitors[1].0.txid, chan_1.3.txid());
2808 added_monitors.clear();
2810 assert_eq!(events.len(), 3);
2812 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
2813 _ => panic!("Unexpected event"),
2816 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { .. }, node_id: _ } => {},
2817 _ => panic!("Unexpected event"),
2821 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, .. } } => {
2822 assert!(update_add_htlcs.is_empty());
2823 assert!(update_fail_htlcs.is_empty());
2824 assert_eq!(update_fulfill_htlcs.len(), 1);
2825 assert!(update_fail_malformed_htlcs.is_empty());
2826 assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
2828 _ => panic!("Unexpected event"),
2830 macro_rules! check_tx_local_broadcast {
2831 ($node: expr, $htlc_offered: expr, $commitment_tx: expr, $chan_tx: expr) => { {
2832 let mut node_txn = $node.tx_broadcaster.txn_broadcasted.lock().unwrap();
2833 assert_eq!(node_txn.len(), 3);
2834 // Node[1]: ChannelManager: 3 (commitment tx, 2*HTLC-Timeout tx), ChannelMonitor: 2 (timeout tx)
2835 // Node[0]: ChannelManager: 3 (commtiemtn tx, 2*HTLC-Timeout tx), ChannelMonitor: 2 HTLC-timeout
2836 check_spends!(node_txn[1], $commitment_tx);
2837 check_spends!(node_txn[2], $commitment_tx);
2838 assert_ne!(node_txn[1].lock_time, 0);
2839 assert_ne!(node_txn[2].lock_time, 0);
2841 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2842 assert_eq!(node_txn[2].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2843 assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2844 assert!(node_txn[2].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2846 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2847 assert_eq!(node_txn[2].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2848 assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2849 assert!(node_txn[2].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2851 check_spends!(node_txn[0], $chan_tx);
2852 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), 71);
2856 // nodes[1] now broadcasts its own local state as a fallback, suggesting an alternate
2857 // commitment transaction with a corresponding HTLC-Timeout transactions, as well as a
2858 // timeout-claim of the output that nodes[2] just claimed via success.
2859 check_tx_local_broadcast!(nodes[1], false, commitment_tx[0], chan_2.3);
2861 // Broadcast legit commitment tx from A on B's chain
2862 // Broadcast preimage tx by B on offered output from A commitment tx on A's chain
2863 let node_a_commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
2864 check_spends!(node_a_commitment_tx[0], chan_1.3);
2865 mine_transaction(&nodes[1], &node_a_commitment_tx[0]);
2866 check_closed_broadcast!(nodes[1], true);
2867 check_added_monitors!(nodes[1], 1);
2868 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
2869 assert_eq!(node_txn.len(), 6); // ChannelManager : 3 (commitment tx + HTLC-Sucess * 2), ChannelMonitor : 3 (HTLC-Success, 2* RBF bumps of above HTLC txn)
2870 let commitment_spend =
2871 if node_txn[0].input[0].previous_output.txid == node_a_commitment_tx[0].txid() {
2872 check_spends!(node_txn[1], commitment_tx[0]);
2873 check_spends!(node_txn[2], commitment_tx[0]);
2874 assert_ne!(node_txn[1].input[0].previous_output.vout, node_txn[2].input[0].previous_output.vout);
2877 check_spends!(node_txn[0], commitment_tx[0]);
2878 check_spends!(node_txn[1], commitment_tx[0]);
2879 assert_ne!(node_txn[0].input[0].previous_output.vout, node_txn[1].input[0].previous_output.vout);
2883 check_spends!(commitment_spend, node_a_commitment_tx[0]);
2884 assert_eq!(commitment_spend.input.len(), 2);
2885 assert_eq!(commitment_spend.input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2886 assert_eq!(commitment_spend.input[1].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2887 assert_eq!(commitment_spend.lock_time, 0);
2888 assert!(commitment_spend.output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2889 check_spends!(node_txn[3], chan_1.3);
2890 assert_eq!(node_txn[3].input[0].witness.clone().last().unwrap().len(), 71);
2891 check_spends!(node_txn[4], node_txn[3]);
2892 check_spends!(node_txn[5], node_txn[3]);
2893 // We don't bother to check that B can claim the HTLC output on its commitment tx here as
2894 // we already checked the same situation with A.
2896 // Verify that A's ChannelManager is able to extract preimage from preimage tx and generate PaymentSent
2897 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2898 connect_block(&nodes[0], &Block { header, txdata: vec![node_a_commitment_tx[0].clone(), commitment_spend.clone()] });
2899 connect_blocks(&nodes[0], TEST_FINAL_CLTV + MIN_CLTV_EXPIRY_DELTA as u32 - 1); // Confirm blocks until the HTLC expires
2900 check_closed_broadcast!(nodes[0], true);
2901 check_added_monitors!(nodes[0], 1);
2902 let events = nodes[0].node.get_and_clear_pending_events();
2903 assert_eq!(events.len(), 2);
2904 let mut first_claimed = false;
2905 for event in events {
2907 Event::PaymentSent { payment_preimage } => {
2908 if payment_preimage == our_payment_preimage {
2909 assert!(!first_claimed);
2910 first_claimed = true;
2912 assert_eq!(payment_preimage, our_payment_preimage_2);
2915 _ => panic!("Unexpected event"),
2918 check_tx_local_broadcast!(nodes[0], true, node_a_commitment_tx[0], chan_1.3);
2921 fn do_test_htlc_on_chain_timeout(connect_style: ConnectStyle) {
2922 // Test that in case of a unilateral close onchain, we detect the state of output and
2923 // timeout the HTLC backward accordingly. So here we test that ChannelManager is
2924 // broadcasting the right event to other nodes in payment path.
2925 // A ------------------> B ----------------------> C (timeout)
2926 // B's commitment tx C's commitment tx
2928 // B's HTLC timeout tx B's timeout tx
2930 let chanmon_cfgs = create_chanmon_cfgs(3);
2931 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2932 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2933 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2934 *nodes[0].connect_style.borrow_mut() = connect_style;
2935 *nodes[1].connect_style.borrow_mut() = connect_style;
2936 *nodes[2].connect_style.borrow_mut() = connect_style;
2938 // Create some intial channels
2939 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2940 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
2942 // Rebalance the network a bit by relaying one payment thorugh all the channels...
2943 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
2944 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
2946 let (_payment_preimage, payment_hash, _payment_secret) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2948 // Broadcast legit commitment tx from C on B's chain
2949 let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
2950 check_spends!(commitment_tx[0], chan_2.3);
2951 nodes[2].node.fail_htlc_backwards(&payment_hash);
2952 check_added_monitors!(nodes[2], 0);
2953 expect_pending_htlcs_forwardable!(nodes[2]);
2954 check_added_monitors!(nodes[2], 1);
2956 let events = nodes[2].node.get_and_clear_pending_msg_events();
2957 assert_eq!(events.len(), 1);
2959 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, .. } } => {
2960 assert!(update_add_htlcs.is_empty());
2961 assert!(!update_fail_htlcs.is_empty());
2962 assert!(update_fulfill_htlcs.is_empty());
2963 assert!(update_fail_malformed_htlcs.is_empty());
2964 assert_eq!(nodes[1].node.get_our_node_id(), *node_id);
2966 _ => panic!("Unexpected event"),
2968 mine_transaction(&nodes[2], &commitment_tx[0]);
2969 check_closed_broadcast!(nodes[2], true);
2970 check_added_monitors!(nodes[2], 1);
2971 let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 1 (commitment tx)
2972 assert_eq!(node_txn.len(), 1);
2973 check_spends!(node_txn[0], chan_2.3);
2974 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), 71);
2976 // Broadcast timeout transaction by B on received output from C's commitment tx on B's chain
2977 // Verify that B's ChannelManager is able to detect that HTLC is timeout by its own tx and react backward in consequence
2978 connect_blocks(&nodes[1], 200 - nodes[2].best_block_info().1);
2979 mine_transaction(&nodes[1], &commitment_tx[0]);
2982 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2983 assert_eq!(node_txn.len(), 5); // ChannelManager : 2 (commitment tx, HTLC-Timeout tx), ChannelMonitor : 2 (local commitment tx + HTLC-timeout), 1 timeout tx
2984 assert_eq!(node_txn[0], node_txn[3]);
2985 assert_eq!(node_txn[1], node_txn[4]);
2987 check_spends!(node_txn[2], commitment_tx[0]);
2988 assert_eq!(node_txn[2].clone().input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2990 check_spends!(node_txn[0], chan_2.3);
2991 check_spends!(node_txn[1], node_txn[0]);
2992 assert_eq!(node_txn[0].clone().input[0].witness.last().unwrap().len(), 71);
2993 assert_eq!(node_txn[1].clone().input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2995 timeout_tx = node_txn[2].clone();
2999 mine_transaction(&nodes[1], &timeout_tx);
3000 check_added_monitors!(nodes[1], 1);
3001 check_closed_broadcast!(nodes[1], true);
3003 // B will rebroadcast a fee-bumped timeout transaction here.
3004 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
3005 assert_eq!(node_txn.len(), 1);
3006 check_spends!(node_txn[0], commitment_tx[0]);
3009 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
3011 // B will rebroadcast its own holder commitment transaction here...just because
3012 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
3013 assert_eq!(node_txn.len(), 1);
3014 check_spends!(node_txn[0], chan_2.3);
3017 expect_pending_htlcs_forwardable!(nodes[1]);
3018 check_added_monitors!(nodes[1], 1);
3019 let events = nodes[1].node.get_and_clear_pending_msg_events();
3020 assert_eq!(events.len(), 1);
3022 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, .. } } => {
3023 assert!(update_add_htlcs.is_empty());
3024 assert!(!update_fail_htlcs.is_empty());
3025 assert!(update_fulfill_htlcs.is_empty());
3026 assert!(update_fail_malformed_htlcs.is_empty());
3027 assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
3029 _ => panic!("Unexpected event"),
3032 // Broadcast legit commitment tx from B on A's chain
3033 let commitment_tx = get_local_commitment_txn!(nodes[1], chan_1.2);
3034 check_spends!(commitment_tx[0], chan_1.3);
3036 mine_transaction(&nodes[0], &commitment_tx[0]);
3037 connect_blocks(&nodes[0], TEST_FINAL_CLTV + MIN_CLTV_EXPIRY_DELTA as u32 - 1); // Confirm blocks until the HTLC expires
3039 check_closed_broadcast!(nodes[0], true);
3040 check_added_monitors!(nodes[0], 1);
3041 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 1 commitment tx, ChannelMonitor : 1 timeout tx
3042 assert_eq!(node_txn.len(), 2);
3043 check_spends!(node_txn[0], chan_1.3);
3044 assert_eq!(node_txn[0].clone().input[0].witness.last().unwrap().len(), 71);
3045 check_spends!(node_txn[1], commitment_tx[0]);
3046 assert_eq!(node_txn[1].clone().input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
3050 fn test_htlc_on_chain_timeout() {
3051 do_test_htlc_on_chain_timeout(ConnectStyle::BestBlockFirstSkippingBlocks);
3052 do_test_htlc_on_chain_timeout(ConnectStyle::TransactionsFirstSkippingBlocks);
3053 do_test_htlc_on_chain_timeout(ConnectStyle::FullBlockViaListen);
3057 fn test_simple_commitment_revoked_fail_backward() {
3058 // Test that in case of a revoked commitment tx, we detect the resolution of output by justice tx
3059 // and fail backward accordingly.
3061 let chanmon_cfgs = create_chanmon_cfgs(3);
3062 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3063 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3064 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3066 // Create some initial channels
3067 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3068 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3070 let (payment_preimage, _payment_hash, _payment_secret) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3000000);
3071 // Get the will-be-revoked local txn from nodes[2]
3072 let revoked_local_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
3073 // Revoke the old state
3074 claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage);
3076 let (_, payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3000000);
3078 mine_transaction(&nodes[1], &revoked_local_txn[0]);
3079 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
3080 check_added_monitors!(nodes[1], 1);
3081 check_closed_broadcast!(nodes[1], true);
3083 expect_pending_htlcs_forwardable!(nodes[1]);
3084 check_added_monitors!(nodes[1], 1);
3085 let events = nodes[1].node.get_and_clear_pending_msg_events();
3086 assert_eq!(events.len(), 1);
3088 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, .. } } => {
3089 assert!(update_add_htlcs.is_empty());
3090 assert_eq!(update_fail_htlcs.len(), 1);
3091 assert!(update_fulfill_htlcs.is_empty());
3092 assert!(update_fail_malformed_htlcs.is_empty());
3093 assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
3095 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
3096 commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
3098 let events = nodes[0].node.get_and_clear_pending_msg_events();
3099 assert_eq!(events.len(), 1);
3101 MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
3102 _ => panic!("Unexpected event"),
3104 expect_payment_failed!(nodes[0], payment_hash, false);
3106 _ => panic!("Unexpected event"),
3110 fn do_test_commitment_revoked_fail_backward_exhaustive(deliver_bs_raa: bool, use_dust: bool, no_to_remote: bool) {
3111 // Test that if our counterparty broadcasts a revoked commitment transaction we fail all
3112 // pending HTLCs on that channel backwards even if the HTLCs aren't present in our latest
3113 // commitment transaction anymore.
3114 // To do this, we have the peer which will broadcast a revoked commitment transaction send
3115 // a number of update_fail/commitment_signed updates without ever sending the RAA in
3116 // response to our commitment_signed. This is somewhat misbehavior-y, though not
3117 // technically disallowed and we should probably handle it reasonably.
3118 // Note that this is pretty exhaustive as an outbound HTLC which we haven't yet
3119 // failed/fulfilled backwards must be in at least one of the latest two remote commitment
3121 // * Once we move it out of our holding cell/add it, we will immediately include it in a
3122 // commitment_signed (implying it will be in the latest remote commitment transaction).
3123 // * Once they remove it, we will send a (the first) commitment_signed without the HTLC,
3124 // and once they revoke the previous commitment transaction (allowing us to send a new
3125 // commitment_signed) we will be free to fail/fulfill the HTLC backwards.
3126 let chanmon_cfgs = create_chanmon_cfgs(3);
3127 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3128 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3129 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3131 // Create some initial channels
3132 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3133 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3135 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 });
3136 // Get the will-be-revoked local txn from nodes[2]
3137 let revoked_local_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
3138 assert_eq!(revoked_local_txn[0].output.len(), if no_to_remote { 1 } else { 2 });
3139 // Revoke the old state
3140 claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage);
3142 let value = if use_dust {
3143 // The dust limit applied to HTLC outputs considers the fee of the HTLC transaction as
3144 // well, so HTLCs at exactly the dust limit will not be included in commitment txn.
3145 nodes[2].node.channel_state.lock().unwrap().by_id.get(&chan_2.2).unwrap().holder_dust_limit_satoshis * 1000
3148 let (_, first_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
3149 let (_, second_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
3150 let (_, third_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
3152 assert!(nodes[2].node.fail_htlc_backwards(&first_payment_hash));
3153 expect_pending_htlcs_forwardable!(nodes[2]);
3154 check_added_monitors!(nodes[2], 1);
3155 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3156 assert!(updates.update_add_htlcs.is_empty());
3157 assert!(updates.update_fulfill_htlcs.is_empty());
3158 assert!(updates.update_fail_malformed_htlcs.is_empty());
3159 assert_eq!(updates.update_fail_htlcs.len(), 1);
3160 assert!(updates.update_fee.is_none());
3161 nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
3162 let bs_raa = commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false, true, false, true);
3163 // Drop the last RAA from 3 -> 2
3165 assert!(nodes[2].node.fail_htlc_backwards(&second_payment_hash));
3166 expect_pending_htlcs_forwardable!(nodes[2]);
3167 check_added_monitors!(nodes[2], 1);
3168 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3169 assert!(updates.update_add_htlcs.is_empty());
3170 assert!(updates.update_fulfill_htlcs.is_empty());
3171 assert!(updates.update_fail_malformed_htlcs.is_empty());
3172 assert_eq!(updates.update_fail_htlcs.len(), 1);
3173 assert!(updates.update_fee.is_none());
3174 nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
3175 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &updates.commitment_signed);
3176 check_added_monitors!(nodes[1], 1);
3177 // Note that nodes[1] is in AwaitingRAA, so won't send a CS
3178 let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
3179 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
3180 check_added_monitors!(nodes[2], 1);
3182 assert!(nodes[2].node.fail_htlc_backwards(&third_payment_hash));
3183 expect_pending_htlcs_forwardable!(nodes[2]);
3184 check_added_monitors!(nodes[2], 1);
3185 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3186 assert!(updates.update_add_htlcs.is_empty());
3187 assert!(updates.update_fulfill_htlcs.is_empty());
3188 assert!(updates.update_fail_malformed_htlcs.is_empty());
3189 assert_eq!(updates.update_fail_htlcs.len(), 1);
3190 assert!(updates.update_fee.is_none());
3191 nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
3192 // At this point first_payment_hash has dropped out of the latest two commitment
3193 // transactions that nodes[1] is tracking...
3194 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &updates.commitment_signed);
3195 check_added_monitors!(nodes[1], 1);
3196 // Note that nodes[1] is (still) in AwaitingRAA, so won't send a CS
3197 let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
3198 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
3199 check_added_monitors!(nodes[2], 1);
3201 // Add a fourth HTLC, this one will get sequestered away in nodes[1]'s holding cell waiting
3202 // on nodes[2]'s RAA.
3203 let (_, fourth_payment_hash, fourth_payment_secret) = get_payment_preimage_hash!(nodes[2]);
3204 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
3205 let logger = test_utils::TestLogger::new();
3206 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();
3207 nodes[1].node.send_payment(&route, fourth_payment_hash, &Some(fourth_payment_secret)).unwrap();
3208 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3209 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
3210 check_added_monitors!(nodes[1], 0);
3213 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_raa);
3214 // One monitor for the new revocation preimage, no second on as we won't generate a new
3215 // commitment transaction for nodes[0] until process_pending_htlc_forwards().
3216 check_added_monitors!(nodes[1], 1);
3217 let events = nodes[1].node.get_and_clear_pending_events();
3218 assert_eq!(events.len(), 1);
3220 Event::PendingHTLCsForwardable { .. } => { },
3221 _ => panic!("Unexpected event"),
3223 // Deliberately don't process the pending fail-back so they all fail back at once after
3224 // block connection just like the !deliver_bs_raa case
3227 let mut failed_htlcs = HashSet::new();
3228 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
3230 mine_transaction(&nodes[1], &revoked_local_txn[0]);
3231 check_added_monitors!(nodes[1], 1);
3232 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
3234 let events = nodes[1].node.get_and_clear_pending_events();
3235 assert_eq!(events.len(), if deliver_bs_raa { 1 } else { 2 });
3237 Event::PaymentFailed { ref payment_hash, .. } => {
3238 assert_eq!(*payment_hash, fourth_payment_hash);
3240 _ => panic!("Unexpected event"),
3242 if !deliver_bs_raa {
3244 Event::PendingHTLCsForwardable { .. } => { },
3245 _ => panic!("Unexpected event"),
3248 nodes[1].node.process_pending_htlc_forwards();
3249 check_added_monitors!(nodes[1], 1);
3251 let events = nodes[1].node.get_and_clear_pending_msg_events();
3252 assert_eq!(events.len(), if deliver_bs_raa { 4 } else { 3 });
3253 match events[if deliver_bs_raa { 1 } else { 0 }] {
3254 MessageSendEvent::BroadcastChannelUpdate { msg: msgs::ChannelUpdate { .. } } => {},
3255 _ => panic!("Unexpected event"),
3257 match events[if deliver_bs_raa { 2 } else { 1 }] {
3258 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { msg: msgs::ErrorMessage { channel_id, ref data } }, node_id: _ } => {
3259 assert_eq!(channel_id, chan_2.2);
3260 assert_eq!(data.as_str(), "Commitment or closing transaction was confirmed on chain.");
3262 _ => panic!("Unexpected event"),
3266 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, .. } } => {
3267 assert_eq!(nodes[2].node.get_our_node_id(), *node_id);
3268 assert_eq!(update_add_htlcs.len(), 1);
3269 assert!(update_fulfill_htlcs.is_empty());
3270 assert!(update_fail_htlcs.is_empty());
3271 assert!(update_fail_malformed_htlcs.is_empty());
3273 _ => panic!("Unexpected event"),
3276 match events[if deliver_bs_raa { 3 } else { 2 }] {
3277 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, .. } } => {
3278 assert!(update_add_htlcs.is_empty());
3279 assert_eq!(update_fail_htlcs.len(), 3);
3280 assert!(update_fulfill_htlcs.is_empty());
3281 assert!(update_fail_malformed_htlcs.is_empty());
3282 assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
3284 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
3285 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[1]);
3286 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[2]);
3288 commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
3290 let events = nodes[0].node.get_and_clear_pending_msg_events();
3291 // If we delivered B's RAA we got an unknown preimage error, not something
3292 // that we should update our routing table for.
3293 assert_eq!(events.len(), if deliver_bs_raa { 2 } else { 3 });
3294 for event in events {
3296 MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
3297 _ => panic!("Unexpected event"),
3300 let events = nodes[0].node.get_and_clear_pending_events();
3301 assert_eq!(events.len(), 3);
3303 Event::PaymentFailed { ref payment_hash, .. } => {
3304 assert!(failed_htlcs.insert(payment_hash.0));
3306 _ => panic!("Unexpected event"),
3309 Event::PaymentFailed { ref payment_hash, .. } => {
3310 assert!(failed_htlcs.insert(payment_hash.0));
3312 _ => panic!("Unexpected event"),
3315 Event::PaymentFailed { ref payment_hash, .. } => {
3316 assert!(failed_htlcs.insert(payment_hash.0));
3318 _ => panic!("Unexpected event"),
3321 _ => panic!("Unexpected event"),
3324 assert!(failed_htlcs.contains(&first_payment_hash.0));
3325 assert!(failed_htlcs.contains(&second_payment_hash.0));
3326 assert!(failed_htlcs.contains(&third_payment_hash.0));
3330 fn test_commitment_revoked_fail_backward_exhaustive_a() {
3331 do_test_commitment_revoked_fail_backward_exhaustive(false, true, false);
3332 do_test_commitment_revoked_fail_backward_exhaustive(true, true, false);
3333 do_test_commitment_revoked_fail_backward_exhaustive(false, false, false);
3334 do_test_commitment_revoked_fail_backward_exhaustive(true, false, false);
3338 fn test_commitment_revoked_fail_backward_exhaustive_b() {
3339 do_test_commitment_revoked_fail_backward_exhaustive(false, true, true);
3340 do_test_commitment_revoked_fail_backward_exhaustive(true, true, true);
3341 do_test_commitment_revoked_fail_backward_exhaustive(false, false, true);
3342 do_test_commitment_revoked_fail_backward_exhaustive(true, false, true);
3346 fn fail_backward_pending_htlc_upon_channel_failure() {
3347 let chanmon_cfgs = create_chanmon_cfgs(2);
3348 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3349 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3350 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3351 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1_000_000, 500_000_000, InitFeatures::known(), InitFeatures::known());
3352 let logger = test_utils::TestLogger::new();
3354 // Alice -> Bob: Route a payment but without Bob sending revoke_and_ack.
3356 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1]);
3357 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3358 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();
3359 nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
3360 check_added_monitors!(nodes[0], 1);
3362 let payment_event = {
3363 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3364 assert_eq!(events.len(), 1);
3365 SendEvent::from_event(events.remove(0))
3367 assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
3368 assert_eq!(payment_event.msgs.len(), 1);
3371 // Alice -> Bob: Route another payment but now Alice waits for Bob's earlier revoke_and_ack.
3372 let (_, failed_payment_hash, failed_payment_secret) = get_payment_preimage_hash!(nodes[1]);
3374 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3375 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();
3376 nodes[0].node.send_payment(&route, failed_payment_hash, &Some(failed_payment_secret)).unwrap();
3377 check_added_monitors!(nodes[0], 0);
3379 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3382 // Alice <- Bob: Send a malformed update_add_htlc so Alice fails the channel.
3384 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[0]);
3386 let secp_ctx = Secp256k1::new();
3387 let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
3388 let current_height = nodes[1].node.best_block.read().unwrap().height() + 1;
3389 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
3390 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();
3391 let (onion_payloads, _amount_msat, cltv_expiry) = onion_utils::build_onion_payloads(&route.paths[0], 50_000, &Some(payment_secret), current_height).unwrap();
3392 let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route.paths[0], &session_priv).unwrap();
3393 let onion_routing_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
3395 // Send a 0-msat update_add_htlc to fail the channel.
3396 let update_add_htlc = msgs::UpdateAddHTLC {
3402 onion_routing_packet,
3404 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &update_add_htlc);
3407 // Check that Alice fails backward the pending HTLC from the second payment.
3408 expect_payment_failed!(nodes[0], failed_payment_hash, true);
3409 check_closed_broadcast!(nodes[0], true);
3410 check_added_monitors!(nodes[0], 1);
3414 fn test_htlc_ignore_latest_remote_commitment() {
3415 // Test that HTLC transactions spending the latest remote commitment transaction are simply
3416 // ignored if we cannot claim them. This originally tickled an invalid unwrap().
3417 let chanmon_cfgs = create_chanmon_cfgs(2);
3418 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3419 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3420 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3421 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3423 route_payment(&nodes[0], &[&nodes[1]], 10000000);
3424 nodes[0].node.force_close_channel(&nodes[0].node.list_channels()[0].channel_id).unwrap();
3425 connect_blocks(&nodes[0], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + 1);
3426 check_closed_broadcast!(nodes[0], true);
3427 check_added_monitors!(nodes[0], 1);
3429 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
3430 assert_eq!(node_txn.len(), 3);
3431 assert_eq!(node_txn[0], node_txn[1]);
3433 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3434 connect_block(&nodes[1], &Block { header, txdata: vec![node_txn[0].clone(), node_txn[1].clone()]});
3435 check_closed_broadcast!(nodes[1], true);
3436 check_added_monitors!(nodes[1], 1);
3438 // Duplicate the connect_block call since this may happen due to other listeners
3439 // registering new transactions
3440 header.prev_blockhash = header.block_hash();
3441 connect_block(&nodes[1], &Block { header, txdata: vec![node_txn[0].clone(), node_txn[2].clone()]});
3445 fn test_force_close_fail_back() {
3446 // Check which HTLCs are failed-backwards on channel force-closure
3447 let chanmon_cfgs = create_chanmon_cfgs(3);
3448 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3449 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3450 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3451 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3452 create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3453 let logger = test_utils::TestLogger::new();
3455 let (our_payment_preimage, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[2]);
3457 let mut payment_event = {
3458 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3459 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();
3460 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
3461 check_added_monitors!(nodes[0], 1);
3463 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3464 assert_eq!(events.len(), 1);
3465 SendEvent::from_event(events.remove(0))
3468 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
3469 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
3471 expect_pending_htlcs_forwardable!(nodes[1]);
3473 let mut events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3474 assert_eq!(events_2.len(), 1);
3475 payment_event = SendEvent::from_event(events_2.remove(0));
3476 assert_eq!(payment_event.msgs.len(), 1);
3478 check_added_monitors!(nodes[1], 1);
3479 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
3480 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg);
3481 check_added_monitors!(nodes[2], 1);
3482 let (_, _) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3484 // nodes[2] now has the latest commitment transaction, but hasn't revoked its previous
3485 // state or updated nodes[1]' state. Now force-close and broadcast that commitment/HTLC
3486 // transaction and ensure nodes[1] doesn't fail-backwards (this was originally a bug!).
3488 nodes[2].node.force_close_channel(&payment_event.commitment_msg.channel_id).unwrap();
3489 check_closed_broadcast!(nodes[2], true);
3490 check_added_monitors!(nodes[2], 1);
3492 let mut node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap();
3493 // Note that we don't bother broadcasting the HTLC-Success transaction here as we don't
3494 // have a use for it unless nodes[2] learns the preimage somehow, the funds will go
3495 // back to nodes[1] upon timeout otherwise.
3496 assert_eq!(node_txn.len(), 1);
3500 mine_transaction(&nodes[1], &tx);
3502 // Note no UpdateHTLCs event here from nodes[1] to nodes[0]!
3503 check_closed_broadcast!(nodes[1], true);
3504 check_added_monitors!(nodes[1], 1);
3506 // Now check that if we add the preimage to ChannelMonitor it broadcasts our HTLC-Success..
3508 let mut monitors = nodes[2].chain_monitor.chain_monitor.monitors.read().unwrap();
3509 monitors.get(&OutPoint{ txid: Txid::from_slice(&payment_event.commitment_msg.channel_id[..]).unwrap(), index: 0 }).unwrap()
3510 .provide_payment_preimage(&our_payment_hash, &our_payment_preimage, &node_cfgs[2].tx_broadcaster, &node_cfgs[2].fee_estimator, &&logger);
3512 mine_transaction(&nodes[2], &tx);
3513 let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap();
3514 assert_eq!(node_txn.len(), 1);
3515 assert_eq!(node_txn[0].input.len(), 1);
3516 assert_eq!(node_txn[0].input[0].previous_output.txid, tx.txid());
3517 assert_eq!(node_txn[0].lock_time, 0); // Must be an HTLC-Success
3518 assert_eq!(node_txn[0].input[0].witness.len(), 5); // Must be an HTLC-Success
3520 check_spends!(node_txn[0], tx);
3524 fn test_dup_events_on_peer_disconnect() {
3525 // Test that if we receive a duplicative update_fulfill_htlc message after a reconnect we do
3526 // not generate a corresponding duplicative PaymentSent event. This did not use to be the case
3527 // as we used to generate the event immediately upon receipt of the payment preimage in the
3528 // update_fulfill_htlc message.
3530 let chanmon_cfgs = create_chanmon_cfgs(2);
3531 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3532 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3533 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3534 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3536 let payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 1000000).0;
3538 assert!(nodes[1].node.claim_funds(payment_preimage));
3539 check_added_monitors!(nodes[1], 1);
3540 let claim_msgs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3541 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &claim_msgs.update_fulfill_htlcs[0]);
3542 expect_payment_sent!(nodes[0], payment_preimage);
3544 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3545 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3547 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (1, 0), (0, 0), (0, 0), (false, false));
3548 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
3552 fn test_simple_peer_disconnect() {
3553 // Test that we can reconnect when there are no lost messages
3554 let chanmon_cfgs = create_chanmon_cfgs(3);
3555 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3556 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3557 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3558 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3559 create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3561 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3562 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3563 reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3565 let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3566 let payment_hash_2 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3567 fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_hash_2);
3568 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_preimage_1);
3570 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3571 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3572 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3574 let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3575 let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3576 let payment_hash_5 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3577 let payment_hash_6 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3579 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3580 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3582 claim_payment_along_route(&nodes[0], &[&[&nodes[1], &nodes[2]]], true, payment_preimage_3);
3583 fail_payment_along_route(&nodes[0], &[&nodes[1], &nodes[2]], true, payment_hash_5);
3585 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (1, 0), (1, 0), (false, false));
3587 let events = nodes[0].node.get_and_clear_pending_events();
3588 assert_eq!(events.len(), 2);
3590 Event::PaymentSent { payment_preimage } => {
3591 assert_eq!(payment_preimage, payment_preimage_3);
3593 _ => panic!("Unexpected event"),
3596 Event::PaymentFailed { payment_hash, rejected_by_dest, .. } => {
3597 assert_eq!(payment_hash, payment_hash_5);
3598 assert!(rejected_by_dest);
3600 _ => panic!("Unexpected event"),
3604 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_preimage_4);
3605 fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_hash_6);
3608 fn do_test_drop_messages_peer_disconnect(messages_delivered: u8, simulate_broken_lnd: bool) {
3609 // Test that we can reconnect when in-flight HTLC updates get dropped
3610 let chanmon_cfgs = create_chanmon_cfgs(2);
3611 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3612 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3613 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3615 let mut as_funding_locked = None;
3616 if messages_delivered == 0 {
3617 let (funding_locked, _, _) = create_chan_between_nodes_with_value_a(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
3618 as_funding_locked = Some(funding_locked);
3619 // nodes[1] doesn't receive the funding_locked message (it'll be re-sent on reconnect)
3620 // Note that we store it so that if we're running with `simulate_broken_lnd` we can deliver
3621 // it before the channel_reestablish message.
3623 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3626 let (payment_preimage_1, payment_hash_1, payment_secret_1) = get_payment_preimage_hash!(nodes[1]);
3628 let logger = test_utils::TestLogger::new();
3629 let payment_event = {
3630 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3631 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(),
3632 &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), Some(&nodes[0].node.list_usable_channels().iter().collect::<Vec<_>>()),
3633 &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
3634 nodes[0].node.send_payment(&route, payment_hash_1, &Some(payment_secret_1)).unwrap();
3635 check_added_monitors!(nodes[0], 1);
3637 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3638 assert_eq!(events.len(), 1);
3639 SendEvent::from_event(events.remove(0))
3641 assert_eq!(nodes[1].node.get_our_node_id(), payment_event.node_id);
3643 if messages_delivered < 2 {
3644 // Drop the payment_event messages, and let them get re-generated in reconnect_nodes!
3646 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
3647 if messages_delivered >= 3 {
3648 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
3649 check_added_monitors!(nodes[1], 1);
3650 let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3652 if messages_delivered >= 4 {
3653 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3654 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3655 check_added_monitors!(nodes[0], 1);
3657 if messages_delivered >= 5 {
3658 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_commitment_signed);
3659 let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3660 // No commitment_signed so get_event_msg's assert(len == 1) passes
3661 check_added_monitors!(nodes[0], 1);
3663 if messages_delivered >= 6 {
3664 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3665 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3666 check_added_monitors!(nodes[1], 1);
3673 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3674 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3675 if messages_delivered < 3 {
3676 if simulate_broken_lnd {
3677 // lnd has a long-standing bug where they send a funding_locked prior to a
3678 // channel_reestablish if you reconnect prior to funding_locked time.
3680 // Here we simulate that behavior, delivering a funding_locked immediately on
3681 // reconnect. Note that we don't bother skipping the now-duplicate funding_locked sent
3682 // in `reconnect_nodes` but we currently don't fail based on that.
3684 // See-also <https://github.com/lightningnetwork/lnd/issues/4006>
3685 nodes[1].node.handle_funding_locked(&nodes[0].node.get_our_node_id(), &as_funding_locked.as_ref().unwrap().0);
3687 // Even if the funding_locked messages get exchanged, as long as nothing further was
3688 // received on either side, both sides will need to resend them.
3689 reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 1), (0, 0), (0, 0), (0, 0), (false, false));
3690 } else if messages_delivered == 3 {
3691 // nodes[0] still wants its RAA + commitment_signed
3692 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (-1, 0), (0, 0), (0, 0), (0, 0), (true, false));
3693 } else if messages_delivered == 4 {
3694 // nodes[0] still wants its commitment_signed
3695 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (-1, 0), (0, 0), (0, 0), (0, 0), (false, false));
3696 } else if messages_delivered == 5 {
3697 // nodes[1] still wants its final RAA
3698 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, true));
3699 } else if messages_delivered == 6 {
3700 // Everything was delivered...
3701 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3704 let events_1 = nodes[1].node.get_and_clear_pending_events();
3705 assert_eq!(events_1.len(), 1);
3707 Event::PendingHTLCsForwardable { .. } => { },
3708 _ => panic!("Unexpected event"),
3711 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3712 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3713 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3715 nodes[1].node.process_pending_htlc_forwards();
3717 let events_2 = nodes[1].node.get_and_clear_pending_events();
3718 assert_eq!(events_2.len(), 1);
3720 Event::PaymentReceived { ref payment_hash, ref payment_preimage, ref payment_secret, amt, user_payment_id: _ } => {
3721 assert_eq!(payment_hash_1, *payment_hash);
3722 assert!(payment_preimage.is_none());
3723 assert_eq!(payment_secret_1, *payment_secret);
3724 assert_eq!(amt, 1000000);
3726 _ => panic!("Unexpected event"),
3729 nodes[1].node.claim_funds(payment_preimage_1);
3730 check_added_monitors!(nodes[1], 1);
3732 let events_3 = nodes[1].node.get_and_clear_pending_msg_events();
3733 assert_eq!(events_3.len(), 1);
3734 let (update_fulfill_htlc, commitment_signed) = match events_3[0] {
3735 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
3736 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3737 assert!(updates.update_add_htlcs.is_empty());
3738 assert!(updates.update_fail_htlcs.is_empty());
3739 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
3740 assert!(updates.update_fail_malformed_htlcs.is_empty());
3741 assert!(updates.update_fee.is_none());
3742 (updates.update_fulfill_htlcs[0].clone(), updates.commitment_signed.clone())
3744 _ => panic!("Unexpected event"),
3747 if messages_delivered >= 1 {
3748 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlc);
3750 let events_4 = nodes[0].node.get_and_clear_pending_events();
3751 assert_eq!(events_4.len(), 1);
3753 Event::PaymentSent { ref payment_preimage } => {
3754 assert_eq!(payment_preimage_1, *payment_preimage);
3756 _ => panic!("Unexpected event"),
3759 if messages_delivered >= 2 {
3760 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
3761 check_added_monitors!(nodes[0], 1);
3762 let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
3764 if messages_delivered >= 3 {
3765 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3766 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3767 check_added_monitors!(nodes[1], 1);
3769 if messages_delivered >= 4 {
3770 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed);
3771 let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3772 // No commitment_signed so get_event_msg's assert(len == 1) passes
3773 check_added_monitors!(nodes[1], 1);
3775 if messages_delivered >= 5 {
3776 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3777 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3778 check_added_monitors!(nodes[0], 1);
3785 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3786 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3787 if messages_delivered < 2 {
3788 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (1, 0), (0, 0), (0, 0), (false, false));
3789 if messages_delivered < 1 {
3790 let events_4 = nodes[0].node.get_and_clear_pending_events();
3791 assert_eq!(events_4.len(), 1);
3793 Event::PaymentSent { ref payment_preimage } => {
3794 assert_eq!(payment_preimage_1, *payment_preimage);
3796 _ => panic!("Unexpected event"),
3799 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3801 } else if messages_delivered == 2 {
3802 // nodes[0] still wants its RAA + commitment_signed
3803 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, -1), (0, 0), (0, 0), (0, 0), (false, true));
3804 } else if messages_delivered == 3 {
3805 // nodes[0] still wants its commitment_signed
3806 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, -1), (0, 0), (0, 0), (0, 0), (false, false));
3807 } else if messages_delivered == 4 {
3808 // nodes[1] still wants its final RAA
3809 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (true, false));
3810 } else if messages_delivered == 5 {
3811 // Everything was delivered...
3812 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3815 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3816 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3817 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3819 // Channel should still work fine...
3820 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3821 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(),
3822 &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), Some(&nodes[0].node.list_usable_channels().iter().collect::<Vec<_>>()),
3823 &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
3824 let payment_preimage_2 = send_along_route(&nodes[0], route, &[&nodes[1]], 1000000).0;
3825 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
3829 fn test_drop_messages_peer_disconnect_a() {
3830 do_test_drop_messages_peer_disconnect(0, true);
3831 do_test_drop_messages_peer_disconnect(0, false);
3832 do_test_drop_messages_peer_disconnect(1, false);
3833 do_test_drop_messages_peer_disconnect(2, false);
3837 fn test_drop_messages_peer_disconnect_b() {
3838 do_test_drop_messages_peer_disconnect(3, false);
3839 do_test_drop_messages_peer_disconnect(4, false);
3840 do_test_drop_messages_peer_disconnect(5, false);
3841 do_test_drop_messages_peer_disconnect(6, false);
3845 fn test_funding_peer_disconnect() {
3846 // Test that we can lock in our funding tx while disconnected
3847 let chanmon_cfgs = create_chanmon_cfgs(2);
3848 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3849 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3850 let persister: test_utils::TestPersister;
3851 let new_chain_monitor: test_utils::TestChainMonitor;
3852 let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
3853 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3854 let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
3856 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3857 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3859 confirm_transaction(&nodes[0], &tx);
3860 let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
3861 assert_eq!(events_1.len(), 1);
3863 MessageSendEvent::SendFundingLocked { ref node_id, msg: _ } => {
3864 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
3866 _ => panic!("Unexpected event"),
3869 reconnect_nodes(&nodes[0], &nodes[1], (false, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3871 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3872 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3874 confirm_transaction(&nodes[1], &tx);
3875 let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3876 assert_eq!(events_2.len(), 2);
3877 let funding_locked = match events_2[0] {
3878 MessageSendEvent::SendFundingLocked { ref node_id, ref msg } => {
3879 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3882 _ => panic!("Unexpected event"),
3884 let bs_announcement_sigs = match events_2[1] {
3885 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
3886 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3889 _ => panic!("Unexpected event"),
3892 reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3894 nodes[0].node.handle_funding_locked(&nodes[1].node.get_our_node_id(), &funding_locked);
3895 nodes[0].node.handle_announcement_signatures(&nodes[1].node.get_our_node_id(), &bs_announcement_sigs);
3896 let events_3 = nodes[0].node.get_and_clear_pending_msg_events();
3897 assert_eq!(events_3.len(), 2);
3898 let as_announcement_sigs = match events_3[0] {
3899 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
3900 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
3903 _ => panic!("Unexpected event"),
3905 let (as_announcement, as_update) = match events_3[1] {
3906 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
3907 (msg.clone(), update_msg.clone())
3909 _ => panic!("Unexpected event"),
3912 nodes[1].node.handle_announcement_signatures(&nodes[0].node.get_our_node_id(), &as_announcement_sigs);
3913 let events_4 = nodes[1].node.get_and_clear_pending_msg_events();
3914 assert_eq!(events_4.len(), 1);
3915 let (_, bs_update) = match events_4[0] {
3916 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
3917 (msg.clone(), update_msg.clone())
3919 _ => panic!("Unexpected event"),
3922 nodes[0].net_graph_msg_handler.handle_channel_announcement(&as_announcement).unwrap();
3923 nodes[0].net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
3924 nodes[0].net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
3926 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3927 let logger = test_utils::TestLogger::new();
3928 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();
3929 let (payment_preimage, _, _) = send_along_route(&nodes[0], route, &[&nodes[1]], 1000000);
3930 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage);
3932 // Check that after deserialization and reconnection we can still generate an identical
3933 // channel_announcement from the cached signatures.
3934 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3936 let nodes_0_serialized = nodes[0].node.encode();
3937 let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
3938 nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
3940 persister = test_utils::TestPersister::new();
3941 let keys_manager = &chanmon_cfgs[0].keys_manager;
3942 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);
3943 nodes[0].chain_monitor = &new_chain_monitor;
3944 let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
3945 let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
3946 &mut chan_0_monitor_read, keys_manager).unwrap();
3947 assert!(chan_0_monitor_read.is_empty());
3949 let mut nodes_0_read = &nodes_0_serialized[..];
3950 let (_, nodes_0_deserialized_tmp) = {
3951 let mut channel_monitors = HashMap::new();
3952 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
3953 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
3954 default_config: UserConfig::default(),
3956 fee_estimator: node_cfgs[0].fee_estimator,
3957 chain_monitor: nodes[0].chain_monitor,
3958 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
3959 logger: nodes[0].logger,
3963 nodes_0_deserialized = nodes_0_deserialized_tmp;
3964 assert!(nodes_0_read.is_empty());
3966 assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
3967 nodes[0].node = &nodes_0_deserialized;
3968 check_added_monitors!(nodes[0], 1);
3970 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3972 // as_announcement should be re-generated exactly by broadcast_node_announcement.
3973 nodes[0].node.broadcast_node_announcement([0, 0, 0], [0; 32], Vec::new());
3974 let msgs = nodes[0].node.get_and_clear_pending_msg_events();
3975 let mut found_announcement = false;
3976 for event in msgs.iter() {
3978 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, .. } => {
3979 if *msg == as_announcement { found_announcement = true; }
3981 MessageSendEvent::BroadcastNodeAnnouncement { .. } => {},
3982 _ => panic!("Unexpected event"),
3985 assert!(found_announcement);
3989 fn test_drop_messages_peer_disconnect_dual_htlc() {
3990 // Test that we can handle reconnecting when both sides of a channel have pending
3991 // commitment_updates when we disconnect.
3992 let chanmon_cfgs = create_chanmon_cfgs(2);
3993 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3994 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3995 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3996 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3997 let logger = test_utils::TestLogger::new();
3999 let (payment_preimage_1, _, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
4001 // Now try to send a second payment which will fail to send
4002 let (payment_preimage_2, payment_hash_2, payment_secret_2) = get_payment_preimage_hash!(nodes[1]);
4003 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
4004 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();
4005 nodes[0].node.send_payment(&route, payment_hash_2, &Some(payment_secret_2)).unwrap();
4006 check_added_monitors!(nodes[0], 1);
4008 let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
4009 assert_eq!(events_1.len(), 1);
4011 MessageSendEvent::UpdateHTLCs { .. } => {},
4012 _ => panic!("Unexpected event"),
4015 assert!(nodes[1].node.claim_funds(payment_preimage_1));
4016 check_added_monitors!(nodes[1], 1);
4018 let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
4019 assert_eq!(events_2.len(), 1);
4021 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 } } => {
4022 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
4023 assert!(update_add_htlcs.is_empty());
4024 assert_eq!(update_fulfill_htlcs.len(), 1);
4025 assert!(update_fail_htlcs.is_empty());
4026 assert!(update_fail_malformed_htlcs.is_empty());
4027 assert!(update_fee.is_none());
4029 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlcs[0]);
4030 let events_3 = nodes[0].node.get_and_clear_pending_events();
4031 assert_eq!(events_3.len(), 1);
4033 Event::PaymentSent { ref payment_preimage } => {
4034 assert_eq!(*payment_preimage, payment_preimage_1);
4036 _ => panic!("Unexpected event"),
4039 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), commitment_signed);
4040 let _ = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
4041 // No commitment_signed so get_event_msg's assert(len == 1) passes
4042 check_added_monitors!(nodes[0], 1);
4044 _ => panic!("Unexpected event"),
4047 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
4048 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4050 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4051 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
4052 assert_eq!(reestablish_1.len(), 1);
4053 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4054 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
4055 assert_eq!(reestablish_2.len(), 1);
4057 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
4058 let as_resp = handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
4059 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
4060 let bs_resp = handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
4062 assert!(as_resp.0.is_none());
4063 assert!(bs_resp.0.is_none());
4065 assert!(bs_resp.1.is_none());
4066 assert!(bs_resp.2.is_none());
4068 assert!(as_resp.3 == RAACommitmentOrder::CommitmentFirst);
4070 assert_eq!(as_resp.2.as_ref().unwrap().update_add_htlcs.len(), 1);
4071 assert!(as_resp.2.as_ref().unwrap().update_fulfill_htlcs.is_empty());
4072 assert!(as_resp.2.as_ref().unwrap().update_fail_htlcs.is_empty());
4073 assert!(as_resp.2.as_ref().unwrap().update_fail_malformed_htlcs.is_empty());
4074 assert!(as_resp.2.as_ref().unwrap().update_fee.is_none());
4075 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &as_resp.2.as_ref().unwrap().update_add_htlcs[0]);
4076 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_resp.2.as_ref().unwrap().commitment_signed);
4077 let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
4078 // No commitment_signed so get_event_msg's assert(len == 1) passes
4079 check_added_monitors!(nodes[1], 1);
4081 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), as_resp.1.as_ref().unwrap());
4082 let bs_second_commitment_signed = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4083 assert!(bs_second_commitment_signed.update_add_htlcs.is_empty());
4084 assert!(bs_second_commitment_signed.update_fulfill_htlcs.is_empty());
4085 assert!(bs_second_commitment_signed.update_fail_htlcs.is_empty());
4086 assert!(bs_second_commitment_signed.update_fail_malformed_htlcs.is_empty());
4087 assert!(bs_second_commitment_signed.update_fee.is_none());
4088 check_added_monitors!(nodes[1], 1);
4090 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
4091 let as_commitment_signed = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
4092 assert!(as_commitment_signed.update_add_htlcs.is_empty());
4093 assert!(as_commitment_signed.update_fulfill_htlcs.is_empty());
4094 assert!(as_commitment_signed.update_fail_htlcs.is_empty());
4095 assert!(as_commitment_signed.update_fail_malformed_htlcs.is_empty());
4096 assert!(as_commitment_signed.update_fee.is_none());
4097 check_added_monitors!(nodes[0], 1);
4099 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_commitment_signed.commitment_signed);
4100 let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
4101 // No commitment_signed so get_event_msg's assert(len == 1) passes
4102 check_added_monitors!(nodes[0], 1);
4104 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed.commitment_signed);
4105 let bs_second_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
4106 // No commitment_signed so get_event_msg's assert(len == 1) passes
4107 check_added_monitors!(nodes[1], 1);
4109 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
4110 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4111 check_added_monitors!(nodes[1], 1);
4113 expect_pending_htlcs_forwardable!(nodes[1]);
4115 let events_5 = nodes[1].node.get_and_clear_pending_events();
4116 assert_eq!(events_5.len(), 1);
4118 Event::PaymentReceived { ref payment_hash, ref payment_preimage, ref payment_secret, amt: _, user_payment_id: _ } => {
4119 assert_eq!(payment_hash_2, *payment_hash);
4120 assert!(payment_preimage.is_none());
4121 assert_eq!(payment_secret_2, *payment_secret);
4123 _ => panic!("Unexpected event"),
4126 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke_and_ack);
4127 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4128 check_added_monitors!(nodes[0], 1);
4130 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
4133 fn do_test_htlc_timeout(send_partial_mpp: bool) {
4134 // If the user fails to claim/fail an HTLC within the HTLC CLTV timeout we fail it for them
4135 // to avoid our counterparty failing the channel.
4136 let chanmon_cfgs = create_chanmon_cfgs(2);
4137 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4138 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4139 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4141 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4142 let logger = test_utils::TestLogger::new();
4144 let our_payment_hash = if send_partial_mpp {
4145 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
4146 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();
4147 let (_, our_payment_hash, payment_secret) = get_payment_preimage_hash!(&nodes[1]);
4148 // Use the utility function send_payment_along_path to send the payment with MPP data which
4149 // indicates there are more HTLCs coming.
4150 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.
4151 nodes[0].node.send_payment_along_path(&route.paths[0], &our_payment_hash, &Some(payment_secret), 200000, cur_height).unwrap();
4152 check_added_monitors!(nodes[0], 1);
4153 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
4154 assert_eq!(events.len(), 1);
4155 // Now do the relevant commitment_signed/RAA dances along the path, noting that the final
4156 // hop should *not* yet generate any PaymentReceived event(s).
4157 pass_along_path(&nodes[0], &[&nodes[1]], 100000, our_payment_hash, payment_secret, events.drain(..).next().unwrap(), false);
4160 route_payment(&nodes[0], &[&nodes[1]], 100000).1
4163 let mut block = Block {
4164 header: BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
4167 connect_block(&nodes[0], &block);
4168 connect_block(&nodes[1], &block);
4169 let block_count = TEST_FINAL_CLTV + CHAN_CONFIRM_DEPTH + 2 - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS;
4170 for _ in CHAN_CONFIRM_DEPTH + 2..block_count {
4171 block.header.prev_blockhash = block.block_hash();
4172 connect_block(&nodes[0], &block);
4173 connect_block(&nodes[1], &block);
4176 expect_pending_htlcs_forwardable!(nodes[1]);
4178 check_added_monitors!(nodes[1], 1);
4179 let htlc_timeout_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4180 assert!(htlc_timeout_updates.update_add_htlcs.is_empty());
4181 assert_eq!(htlc_timeout_updates.update_fail_htlcs.len(), 1);
4182 assert!(htlc_timeout_updates.update_fail_malformed_htlcs.is_empty());
4183 assert!(htlc_timeout_updates.update_fee.is_none());
4185 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_timeout_updates.update_fail_htlcs[0]);
4186 commitment_signed_dance!(nodes[0], nodes[1], htlc_timeout_updates.commitment_signed, false);
4187 // 100_000 msat as u64, followed by the height at which we failed back above
4188 let mut expected_failure_data = byte_utils::be64_to_array(100_000).to_vec();
4189 expected_failure_data.extend_from_slice(&byte_utils::be32_to_array(block_count - 1));
4190 expect_payment_failed!(nodes[0], our_payment_hash, true, 0x4000 | 15, &expected_failure_data[..]);
4194 fn test_htlc_timeout() {
4195 do_test_htlc_timeout(true);
4196 do_test_htlc_timeout(false);
4199 fn do_test_holding_cell_htlc_add_timeouts(forwarded_htlc: bool) {
4200 // Tests that HTLCs in the holding cell are timed out after the requisite number of blocks.
4201 let chanmon_cfgs = create_chanmon_cfgs(3);
4202 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
4203 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
4204 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
4205 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4206 create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
4208 // Make sure all nodes are at the same starting height
4209 connect_blocks(&nodes[0], 2*CHAN_CONFIRM_DEPTH + 1 - nodes[0].best_block_info().1);
4210 connect_blocks(&nodes[1], 2*CHAN_CONFIRM_DEPTH + 1 - nodes[1].best_block_info().1);
4211 connect_blocks(&nodes[2], 2*CHAN_CONFIRM_DEPTH + 1 - nodes[2].best_block_info().1);
4213 let logger = test_utils::TestLogger::new();
4215 // Route a first payment to get the 1 -> 2 channel in awaiting_raa...
4216 let (_, first_payment_hash, first_payment_secret) = get_payment_preimage_hash!(nodes[2]);
4218 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
4219 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();
4220 nodes[1].node.send_payment(&route, first_payment_hash, &Some(first_payment_secret)).unwrap();
4222 assert_eq!(nodes[1].node.get_and_clear_pending_msg_events().len(), 1);
4223 check_added_monitors!(nodes[1], 1);
4225 // Now attempt to route a second payment, which should be placed in the holding cell
4226 let (_, second_payment_hash, second_payment_secret) = get_payment_preimage_hash!(nodes[2]);
4228 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
4229 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();
4230 nodes[0].node.send_payment(&route, second_payment_hash, &Some(first_payment_secret)).unwrap();
4231 check_added_monitors!(nodes[0], 1);
4232 let payment_event = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
4233 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
4234 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
4235 expect_pending_htlcs_forwardable!(nodes[1]);
4236 check_added_monitors!(nodes[1], 0);
4238 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
4239 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();
4240 nodes[1].node.send_payment(&route, second_payment_hash, &Some(second_payment_secret)).unwrap();
4241 check_added_monitors!(nodes[1], 0);
4244 connect_blocks(&nodes[1], TEST_FINAL_CLTV - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS);
4245 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4246 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
4247 connect_blocks(&nodes[1], 1);
4250 expect_pending_htlcs_forwardable!(nodes[1]);
4251 check_added_monitors!(nodes[1], 1);
4252 let fail_commit = nodes[1].node.get_and_clear_pending_msg_events();
4253 assert_eq!(fail_commit.len(), 1);
4254 match fail_commit[0] {
4255 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fail_htlcs, ref commitment_signed, .. }, .. } => {
4256 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
4257 commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, true, true);
4259 _ => unreachable!(),
4261 expect_payment_failed!(nodes[0], second_payment_hash, false);
4262 if let &MessageSendEvent::PaymentFailureNetworkUpdate { ref update } = &nodes[0].node.get_and_clear_pending_msg_events()[0] {
4264 &HTLCFailChannelUpdate::ChannelUpdateMessage { .. } => {},
4265 _ => panic!("Unexpected event"),
4268 panic!("Unexpected event");
4271 expect_payment_failed!(nodes[1], second_payment_hash, true);
4276 fn test_holding_cell_htlc_add_timeouts() {
4277 do_test_holding_cell_htlc_add_timeouts(false);
4278 do_test_holding_cell_htlc_add_timeouts(true);
4282 fn test_invalid_channel_announcement() {
4283 //Test BOLT 7 channel_announcement msg requirement for final node, gather data to build customed channel_announcement msgs
4284 let secp_ctx = Secp256k1::new();
4285 let chanmon_cfgs = create_chanmon_cfgs(2);
4286 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4287 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4288 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4290 let chan_announcement = create_chan_between_nodes(&nodes[0], &nodes[1], InitFeatures::known(), InitFeatures::known());
4292 let a_channel_lock = nodes[0].node.channel_state.lock().unwrap();
4293 let b_channel_lock = nodes[1].node.channel_state.lock().unwrap();
4294 let as_chan = a_channel_lock.by_id.get(&chan_announcement.3).unwrap();
4295 let bs_chan = b_channel_lock.by_id.get(&chan_announcement.3).unwrap();
4297 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 } );
4299 let as_bitcoin_key = as_chan.get_signer().inner.holder_channel_pubkeys.funding_pubkey;
4300 let bs_bitcoin_key = bs_chan.get_signer().inner.holder_channel_pubkeys.funding_pubkey;
4302 let as_network_key = nodes[0].node.get_our_node_id();
4303 let bs_network_key = nodes[1].node.get_our_node_id();
4305 let were_node_one = as_bitcoin_key.serialize()[..] < bs_bitcoin_key.serialize()[..];
4307 let mut chan_announcement;
4309 macro_rules! dummy_unsigned_msg {
4311 msgs::UnsignedChannelAnnouncement {
4312 features: ChannelFeatures::known(),
4313 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
4314 short_channel_id: as_chan.get_short_channel_id().unwrap(),
4315 node_id_1: if were_node_one { as_network_key } else { bs_network_key },
4316 node_id_2: if were_node_one { bs_network_key } else { as_network_key },
4317 bitcoin_key_1: if were_node_one { as_bitcoin_key } else { bs_bitcoin_key },
4318 bitcoin_key_2: if were_node_one { bs_bitcoin_key } else { as_bitcoin_key },
4319 excess_data: Vec::new(),
4324 macro_rules! sign_msg {
4325 ($unsigned_msg: expr) => {
4326 let msghash = Message::from_slice(&Sha256dHash::hash(&$unsigned_msg.encode()[..])[..]).unwrap();
4327 let as_bitcoin_sig = secp_ctx.sign(&msghash, &as_chan.get_signer().inner.funding_key);
4328 let bs_bitcoin_sig = secp_ctx.sign(&msghash, &bs_chan.get_signer().inner.funding_key);
4329 let as_node_sig = secp_ctx.sign(&msghash, &nodes[0].keys_manager.get_node_secret());
4330 let bs_node_sig = secp_ctx.sign(&msghash, &nodes[1].keys_manager.get_node_secret());
4331 chan_announcement = msgs::ChannelAnnouncement {
4332 node_signature_1 : if were_node_one { as_node_sig } else { bs_node_sig},
4333 node_signature_2 : if were_node_one { bs_node_sig } else { as_node_sig},
4334 bitcoin_signature_1: if were_node_one { as_bitcoin_sig } else { bs_bitcoin_sig },
4335 bitcoin_signature_2 : if were_node_one { bs_bitcoin_sig } else { as_bitcoin_sig },
4336 contents: $unsigned_msg
4341 let unsigned_msg = dummy_unsigned_msg!();
4342 sign_msg!(unsigned_msg);
4343 assert_eq!(nodes[0].net_graph_msg_handler.handle_channel_announcement(&chan_announcement).unwrap(), true);
4344 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 } );
4346 // Configured with Network::Testnet
4347 let mut unsigned_msg = dummy_unsigned_msg!();
4348 unsigned_msg.chain_hash = genesis_block(Network::Bitcoin).header.block_hash();
4349 sign_msg!(unsigned_msg);
4350 assert!(nodes[0].net_graph_msg_handler.handle_channel_announcement(&chan_announcement).is_err());
4352 let mut unsigned_msg = dummy_unsigned_msg!();
4353 unsigned_msg.chain_hash = BlockHash::hash(&[1,2,3,4,5,6,7,8,9]);
4354 sign_msg!(unsigned_msg);
4355 assert!(nodes[0].net_graph_msg_handler.handle_channel_announcement(&chan_announcement).is_err());
4359 fn test_no_txn_manager_serialize_deserialize() {
4360 let chanmon_cfgs = create_chanmon_cfgs(2);
4361 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4362 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4363 let logger: test_utils::TestLogger;
4364 let fee_estimator: test_utils::TestFeeEstimator;
4365 let persister: test_utils::TestPersister;
4366 let new_chain_monitor: test_utils::TestChainMonitor;
4367 let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4368 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4370 let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
4372 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4374 let nodes_0_serialized = nodes[0].node.encode();
4375 let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4376 nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
4378 logger = test_utils::TestLogger::new();
4379 fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
4380 persister = test_utils::TestPersister::new();
4381 let keys_manager = &chanmon_cfgs[0].keys_manager;
4382 new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator, &persister, keys_manager);
4383 nodes[0].chain_monitor = &new_chain_monitor;
4384 let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4385 let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
4386 &mut chan_0_monitor_read, keys_manager).unwrap();
4387 assert!(chan_0_monitor_read.is_empty());
4389 let mut nodes_0_read = &nodes_0_serialized[..];
4390 let config = UserConfig::default();
4391 let (_, nodes_0_deserialized_tmp) = {
4392 let mut channel_monitors = HashMap::new();
4393 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4394 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4395 default_config: config,
4397 fee_estimator: &fee_estimator,
4398 chain_monitor: nodes[0].chain_monitor,
4399 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4404 nodes_0_deserialized = nodes_0_deserialized_tmp;
4405 assert!(nodes_0_read.is_empty());
4407 assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4408 nodes[0].node = &nodes_0_deserialized;
4409 assert_eq!(nodes[0].node.list_channels().len(), 1);
4410 check_added_monitors!(nodes[0], 1);
4412 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4413 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
4414 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4415 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
4417 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
4418 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4419 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
4420 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4422 let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
4423 let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
4424 for node in nodes.iter() {
4425 assert!(node.net_graph_msg_handler.handle_channel_announcement(&announcement).unwrap());
4426 node.net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
4427 node.net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
4430 send_payment(&nodes[0], &[&nodes[1]], 1000000);
4434 fn test_dup_htlc_onchain_fails_on_reload() {
4435 // When a Channel is closed, any outbound HTLCs which were relayed through it are simply
4436 // dropped when the Channel is. From there, the ChannelManager relies on the ChannelMonitor
4437 // having a copy of the relevant fail-/claim-back data and processes the HTLC fail/claim when
4438 // the ChannelMonitor tells it to.
4440 // If, due to an on-chain event, an HTLC is failed/claimed, and then we serialize the
4441 // ChannelManager, we generally expect there not to be a duplicate HTLC fail/claim (eg via a
4442 // PaymentFailed event appearing). However, because we may not serialize the relevant
4443 // ChannelMonitor at the same time, this isn't strictly guaranteed. In order to provide this
4444 // consistency, the ChannelManager explicitly tracks pending-onchain-resolution outbound HTLCs
4445 // and de-duplicates ChannelMonitor events.
4447 // This tests that explicit tracking behavior.
4448 let chanmon_cfgs = create_chanmon_cfgs(2);
4449 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4450 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4451 let persister: test_utils::TestPersister;
4452 let new_chain_monitor: test_utils::TestChainMonitor;
4453 let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4454 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4456 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4458 // Route a payment, but force-close the channel before the HTLC fulfill message arrives at
4460 let (payment_preimage, _, _) = route_payment(&nodes[0], &[&nodes[1]], 10000000);
4461 nodes[0].node.force_close_channel(&nodes[0].node.list_channels()[0].channel_id).unwrap();
4462 check_closed_broadcast!(nodes[0], true);
4463 check_added_monitors!(nodes[0], 1);
4465 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
4466 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4468 // Connect blocks until the CLTV timeout is up so that we get an HTLC-Timeout transaction
4469 connect_blocks(&nodes[0], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + 1);
4470 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
4471 assert_eq!(node_txn.len(), 3);
4472 assert_eq!(node_txn[0], node_txn[1]);
4474 assert!(nodes[1].node.claim_funds(payment_preimage));
4475 check_added_monitors!(nodes[1], 1);
4477 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4478 connect_block(&nodes[1], &Block { header, txdata: vec![node_txn[1].clone(), node_txn[2].clone()]});
4479 check_closed_broadcast!(nodes[1], true);
4480 check_added_monitors!(nodes[1], 1);
4481 let claim_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
4483 header.prev_blockhash = nodes[0].best_block_hash();
4484 connect_block(&nodes[0], &Block { header, txdata: vec![node_txn[1].clone(), node_txn[2].clone()]});
4486 // Serialize out the ChannelMonitor before connecting the on-chain claim transactions. This is
4487 // fairly normal behavior as ChannelMonitor(s) are often not re-serialized when on-chain events
4488 // happen, unlike ChannelManager which tends to be re-serialized after any relevant event(s).
4489 let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4490 nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
4492 header.prev_blockhash = nodes[0].best_block_hash();
4493 let claim_block = Block { header, txdata: claim_txn};
4494 connect_block(&nodes[0], &claim_block);
4495 expect_payment_sent!(nodes[0], payment_preimage);
4497 // ChannelManagers generally get re-serialized after any relevant event(s). Since we just
4498 // connected a highly-relevant block, it likely gets serialized out now.
4499 let mut chan_manager_serialized = test_utils::TestVecWriter(Vec::new());
4500 nodes[0].node.write(&mut chan_manager_serialized).unwrap();
4502 // Now reload nodes[0]...
4503 persister = test_utils::TestPersister::new();
4504 let keys_manager = &chanmon_cfgs[0].keys_manager;
4505 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);
4506 nodes[0].chain_monitor = &new_chain_monitor;
4507 let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4508 let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
4509 &mut chan_0_monitor_read, keys_manager).unwrap();
4510 assert!(chan_0_monitor_read.is_empty());
4512 let (_, nodes_0_deserialized_tmp) = {
4513 let mut channel_monitors = HashMap::new();
4514 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4515 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>
4516 ::read(&mut std::io::Cursor::new(&chan_manager_serialized.0[..]), ChannelManagerReadArgs {
4517 default_config: Default::default(),
4519 fee_estimator: node_cfgs[0].fee_estimator,
4520 chain_monitor: nodes[0].chain_monitor,
4521 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4522 logger: nodes[0].logger,
4526 nodes_0_deserialized = nodes_0_deserialized_tmp;
4528 assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4529 check_added_monitors!(nodes[0], 1);
4530 nodes[0].node = &nodes_0_deserialized;
4532 // Note that if we re-connect the block which exposed nodes[0] to the payment preimage (but
4533 // which the current ChannelMonitor has not seen), the ChannelManager's de-duplication of
4534 // payment events should kick in, leaving us with no pending events here.
4535 let height = nodes[0].blocks.lock().unwrap().len() as u32 - 1;
4536 nodes[0].chain_monitor.chain_monitor.block_connected(&claim_block, height);
4537 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
4541 fn test_manager_serialize_deserialize_events() {
4542 // This test makes sure the events field in ChannelManager survives de/serialization
4543 let chanmon_cfgs = create_chanmon_cfgs(2);
4544 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4545 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4546 let fee_estimator: test_utils::TestFeeEstimator;
4547 let persister: test_utils::TestPersister;
4548 let logger: test_utils::TestLogger;
4549 let new_chain_monitor: test_utils::TestChainMonitor;
4550 let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4551 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4553 // Start creating a channel, but stop right before broadcasting the funding transaction
4554 let channel_value = 100000;
4555 let push_msat = 10001;
4556 let a_flags = InitFeatures::known();
4557 let b_flags = InitFeatures::known();
4558 let node_a = nodes.remove(0);
4559 let node_b = nodes.remove(0);
4560 node_a.node.create_channel(node_b.node.get_our_node_id(), channel_value, push_msat, 42, None).unwrap();
4561 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()));
4562 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()));
4564 let (temporary_channel_id, tx, funding_output) = create_funding_transaction(&node_a, channel_value, 42);
4566 node_a.node.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
4567 check_added_monitors!(node_a, 0);
4569 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()));
4571 let mut added_monitors = node_b.chain_monitor.added_monitors.lock().unwrap();
4572 assert_eq!(added_monitors.len(), 1);
4573 assert_eq!(added_monitors[0].0, funding_output);
4574 added_monitors.clear();
4577 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()));
4579 let mut added_monitors = node_a.chain_monitor.added_monitors.lock().unwrap();
4580 assert_eq!(added_monitors.len(), 1);
4581 assert_eq!(added_monitors[0].0, funding_output);
4582 added_monitors.clear();
4584 // Normally, this is where node_a would broadcast the funding transaction, but the test de/serializes first instead
4589 // Start the de/seriailization process mid-channel creation to check that the channel manager will hold onto events that are serialized
4590 let nodes_0_serialized = nodes[0].node.encode();
4591 let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4592 nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
4594 fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
4595 logger = test_utils::TestLogger::new();
4596 persister = test_utils::TestPersister::new();
4597 let keys_manager = &chanmon_cfgs[0].keys_manager;
4598 new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator, &persister, keys_manager);
4599 nodes[0].chain_monitor = &new_chain_monitor;
4600 let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4601 let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
4602 &mut chan_0_monitor_read, keys_manager).unwrap();
4603 assert!(chan_0_monitor_read.is_empty());
4605 let mut nodes_0_read = &nodes_0_serialized[..];
4606 let config = UserConfig::default();
4607 let (_, nodes_0_deserialized_tmp) = {
4608 let mut channel_monitors = HashMap::new();
4609 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4610 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4611 default_config: config,
4613 fee_estimator: &fee_estimator,
4614 chain_monitor: nodes[0].chain_monitor,
4615 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4620 nodes_0_deserialized = nodes_0_deserialized_tmp;
4621 assert!(nodes_0_read.is_empty());
4623 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4625 assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4626 nodes[0].node = &nodes_0_deserialized;
4628 // After deserializing, make sure the funding_transaction is still held by the channel manager
4629 let events_4 = nodes[0].node.get_and_clear_pending_events();
4630 assert_eq!(events_4.len(), 0);
4631 assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
4632 assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0].txid(), funding_output.txid);
4634 // Make sure the channel is functioning as though the de/serialization never happened
4635 assert_eq!(nodes[0].node.list_channels().len(), 1);
4636 check_added_monitors!(nodes[0], 1);
4638 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4639 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
4640 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4641 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
4643 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
4644 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4645 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
4646 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4648 let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
4649 let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
4650 for node in nodes.iter() {
4651 assert!(node.net_graph_msg_handler.handle_channel_announcement(&announcement).unwrap());
4652 node.net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
4653 node.net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
4656 send_payment(&nodes[0], &[&nodes[1]], 1000000);
4660 fn test_simple_manager_serialize_deserialize() {
4661 let chanmon_cfgs = create_chanmon_cfgs(2);
4662 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4663 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4664 let logger: test_utils::TestLogger;
4665 let fee_estimator: test_utils::TestFeeEstimator;
4666 let persister: test_utils::TestPersister;
4667 let new_chain_monitor: test_utils::TestChainMonitor;
4668 let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4669 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4670 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4672 let (our_payment_preimage, _, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
4673 let (_, our_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
4675 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4677 let nodes_0_serialized = nodes[0].node.encode();
4678 let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4679 nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
4681 logger = test_utils::TestLogger::new();
4682 fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
4683 persister = test_utils::TestPersister::new();
4684 let keys_manager = &chanmon_cfgs[0].keys_manager;
4685 new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator, &persister, keys_manager);
4686 nodes[0].chain_monitor = &new_chain_monitor;
4687 let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4688 let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
4689 &mut chan_0_monitor_read, keys_manager).unwrap();
4690 assert!(chan_0_monitor_read.is_empty());
4692 let mut nodes_0_read = &nodes_0_serialized[..];
4693 let (_, nodes_0_deserialized_tmp) = {
4694 let mut channel_monitors = HashMap::new();
4695 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4696 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4697 default_config: UserConfig::default(),
4699 fee_estimator: &fee_estimator,
4700 chain_monitor: nodes[0].chain_monitor,
4701 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4706 nodes_0_deserialized = nodes_0_deserialized_tmp;
4707 assert!(nodes_0_read.is_empty());
4709 assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4710 nodes[0].node = &nodes_0_deserialized;
4711 check_added_monitors!(nodes[0], 1);
4713 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
4715 fail_payment(&nodes[0], &[&nodes[1]], our_payment_hash);
4716 claim_payment(&nodes[0], &[&nodes[1]], our_payment_preimage);
4720 fn test_manager_serialize_deserialize_inconsistent_monitor() {
4721 // Test deserializing a ChannelManager with an out-of-date ChannelMonitor
4722 let chanmon_cfgs = create_chanmon_cfgs(4);
4723 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
4724 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
4725 let logger: test_utils::TestLogger;
4726 let fee_estimator: test_utils::TestFeeEstimator;
4727 let persister: test_utils::TestPersister;
4728 let new_chain_monitor: test_utils::TestChainMonitor;
4729 let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4730 let mut nodes = create_network(4, &node_cfgs, &node_chanmgrs);
4731 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4732 create_announced_chan_between_nodes(&nodes, 2, 0, InitFeatures::known(), InitFeatures::known());
4733 let (_, _, channel_id, funding_tx) = create_announced_chan_between_nodes(&nodes, 0, 3, InitFeatures::known(), InitFeatures::known());
4735 let mut node_0_stale_monitors_serialized = Vec::new();
4736 for monitor in nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter() {
4737 let mut writer = test_utils::TestVecWriter(Vec::new());
4738 monitor.1.write(&mut writer).unwrap();
4739 node_0_stale_monitors_serialized.push(writer.0);
4742 let (our_payment_preimage, _, _) = route_payment(&nodes[2], &[&nodes[0], &nodes[1]], 1000000);
4744 // Serialize the ChannelManager here, but the monitor we keep up-to-date
4745 let nodes_0_serialized = nodes[0].node.encode();
4747 route_payment(&nodes[0], &[&nodes[3]], 1000000);
4748 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4749 nodes[2].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4750 nodes[3].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4752 // Now the ChannelMonitor (which is now out-of-sync with ChannelManager for channel w/
4754 let mut node_0_monitors_serialized = Vec::new();
4755 for monitor in nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter() {
4756 let mut writer = test_utils::TestVecWriter(Vec::new());
4757 monitor.1.write(&mut writer).unwrap();
4758 node_0_monitors_serialized.push(writer.0);
4761 logger = test_utils::TestLogger::new();
4762 fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
4763 persister = test_utils::TestPersister::new();
4764 let keys_manager = &chanmon_cfgs[0].keys_manager;
4765 new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator, &persister, keys_manager);
4766 nodes[0].chain_monitor = &new_chain_monitor;
4769 let mut node_0_stale_monitors = Vec::new();
4770 for serialized in node_0_stale_monitors_serialized.iter() {
4771 let mut read = &serialized[..];
4772 let (_, monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(&mut read, keys_manager).unwrap();
4773 assert!(read.is_empty());
4774 node_0_stale_monitors.push(monitor);
4777 let mut node_0_monitors = Vec::new();
4778 for serialized in node_0_monitors_serialized.iter() {
4779 let mut read = &serialized[..];
4780 let (_, monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(&mut read, keys_manager).unwrap();
4781 assert!(read.is_empty());
4782 node_0_monitors.push(monitor);
4785 let mut nodes_0_read = &nodes_0_serialized[..];
4786 if let Err(msgs::DecodeError::InvalidValue) =
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_stale_monitors.iter_mut().map(|monitor| { (monitor.get_funding_txo().0, monitor) }).collect(),
4796 panic!("If the monitor(s) are stale, this indicates a bug and we should get an Err return");
4799 let mut nodes_0_read = &nodes_0_serialized[..];
4800 let (_, nodes_0_deserialized_tmp) =
4801 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4802 default_config: UserConfig::default(),
4804 fee_estimator: &fee_estimator,
4805 chain_monitor: nodes[0].chain_monitor,
4806 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4808 channel_monitors: node_0_monitors.iter_mut().map(|monitor| { (monitor.get_funding_txo().0, monitor) }).collect(),
4810 nodes_0_deserialized = nodes_0_deserialized_tmp;
4811 assert!(nodes_0_read.is_empty());
4813 { // Channel close should result in a commitment tx
4814 let txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4815 assert_eq!(txn.len(), 1);
4816 check_spends!(txn[0], funding_tx);
4817 assert_eq!(txn[0].input[0].previous_output.txid, funding_tx.txid());
4820 for monitor in node_0_monitors.drain(..) {
4821 assert!(nodes[0].chain_monitor.watch_channel(monitor.get_funding_txo().0, monitor).is_ok());
4822 check_added_monitors!(nodes[0], 1);
4824 nodes[0].node = &nodes_0_deserialized;
4826 // nodes[1] and nodes[2] have no lost state with nodes[0]...
4827 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
4828 reconnect_nodes(&nodes[0], &nodes[2], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
4829 //... and we can even still claim the payment!
4830 claim_payment(&nodes[2], &[&nodes[0], &nodes[1]], our_payment_preimage);
4832 nodes[3].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4833 let reestablish = get_event_msg!(nodes[3], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
4834 nodes[0].node.peer_connected(&nodes[3].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4835 nodes[0].node.handle_channel_reestablish(&nodes[3].node.get_our_node_id(), &reestablish);
4836 let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
4837 assert_eq!(msg_events.len(), 1);
4838 if let MessageSendEvent::HandleError { ref action, .. } = msg_events[0] {
4840 &ErrorAction::SendErrorMessage { ref msg } => {
4841 assert_eq!(msg.channel_id, channel_id);
4843 _ => panic!("Unexpected event!"),
4848 macro_rules! check_spendable_outputs {
4849 ($node: expr, $der_idx: expr, $keysinterface: expr, $chan_value: expr) => {
4851 let mut events = $node.chain_monitor.chain_monitor.get_and_clear_pending_events();
4852 let mut txn = Vec::new();
4853 let mut all_outputs = Vec::new();
4854 let secp_ctx = Secp256k1::new();
4855 for event in events.drain(..) {
4857 Event::SpendableOutputs { mut outputs } => {
4858 for outp in outputs.drain(..) {
4859 txn.push($keysinterface.backing.spend_spendable_outputs(&[&outp], Vec::new(), Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(), 253, &secp_ctx).unwrap());
4860 all_outputs.push(outp);
4863 _ => panic!("Unexpected event"),
4866 if all_outputs.len() > 1 {
4867 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) {
4877 fn test_claim_sizeable_push_msat() {
4878 // Incidentally test SpendableOutput event generation due to detection of to_local output on commitment tx
4879 let chanmon_cfgs = create_chanmon_cfgs(2);
4880 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4881 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4882 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4884 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 99000000, InitFeatures::known(), InitFeatures::known());
4885 nodes[1].node.force_close_channel(&chan.2).unwrap();
4886 check_closed_broadcast!(nodes[1], true);
4887 check_added_monitors!(nodes[1], 1);
4888 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4889 assert_eq!(node_txn.len(), 1);
4890 check_spends!(node_txn[0], chan.3);
4891 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
4893 mine_transaction(&nodes[1], &node_txn[0]);
4894 connect_blocks(&nodes[1], BREAKDOWN_TIMEOUT as u32 - 1);
4896 let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
4897 assert_eq!(spend_txn.len(), 1);
4898 assert_eq!(spend_txn[0].input.len(), 1);
4899 check_spends!(spend_txn[0], node_txn[0]);
4900 assert_eq!(spend_txn[0].input[0].sequence, BREAKDOWN_TIMEOUT as u32);
4904 fn test_claim_on_remote_sizeable_push_msat() {
4905 // Same test as previous, just test on remote commitment tx, as per_commitment_point registration changes following you're funder/fundee and
4906 // to_remote output is encumbered by a P2WPKH
4907 let chanmon_cfgs = create_chanmon_cfgs(2);
4908 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4909 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4910 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4912 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 99000000, InitFeatures::known(), InitFeatures::known());
4913 nodes[0].node.force_close_channel(&chan.2).unwrap();
4914 check_closed_broadcast!(nodes[0], true);
4915 check_added_monitors!(nodes[0], 1);
4917 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4918 assert_eq!(node_txn.len(), 1);
4919 check_spends!(node_txn[0], chan.3);
4920 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
4922 mine_transaction(&nodes[1], &node_txn[0]);
4923 check_closed_broadcast!(nodes[1], true);
4924 check_added_monitors!(nodes[1], 1);
4925 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4927 let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
4928 assert_eq!(spend_txn.len(), 1);
4929 check_spends!(spend_txn[0], node_txn[0]);
4933 fn test_claim_on_remote_revoked_sizeable_push_msat() {
4934 // Same test as previous, just test on remote revoked commitment tx, as per_commitment_point registration changes following you're funder/fundee and
4935 // to_remote output is encumbered by a P2WPKH
4937 let chanmon_cfgs = create_chanmon_cfgs(2);
4938 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4939 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4940 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4942 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 59000000, InitFeatures::known(), InitFeatures::known());
4943 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4944 let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan.2);
4945 assert_eq!(revoked_local_txn[0].input.len(), 1);
4946 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
4948 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
4949 mine_transaction(&nodes[1], &revoked_local_txn[0]);
4950 check_closed_broadcast!(nodes[1], true);
4951 check_added_monitors!(nodes[1], 1);
4953 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4954 mine_transaction(&nodes[1], &node_txn[0]);
4955 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4957 let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
4958 assert_eq!(spend_txn.len(), 3);
4959 check_spends!(spend_txn[0], revoked_local_txn[0]); // to_remote output on revoked remote commitment_tx
4960 check_spends!(spend_txn[1], node_txn[0]);
4961 check_spends!(spend_txn[2], revoked_local_txn[0], node_txn[0]); // Both outputs
4965 fn test_static_spendable_outputs_preimage_tx() {
4966 let chanmon_cfgs = create_chanmon_cfgs(2);
4967 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4968 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4969 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4971 // Create some initial channels
4972 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4974 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4976 let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
4977 assert_eq!(commitment_tx[0].input.len(), 1);
4978 assert_eq!(commitment_tx[0].input[0].previous_output.txid, chan_1.3.txid());
4980 // Settle A's commitment tx on B's chain
4981 assert!(nodes[1].node.claim_funds(payment_preimage));
4982 check_added_monitors!(nodes[1], 1);
4983 mine_transaction(&nodes[1], &commitment_tx[0]);
4984 check_added_monitors!(nodes[1], 1);
4985 let events = nodes[1].node.get_and_clear_pending_msg_events();
4987 MessageSendEvent::UpdateHTLCs { .. } => {},
4988 _ => panic!("Unexpected event"),
4991 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
4992 _ => panic!("Unexepected event"),
4995 // Check B's monitor was able to send back output descriptor event for preimage tx on A's commitment tx
4996 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap(); // ChannelManager : 2 (local commitment tx + HTLC-Success), ChannelMonitor: preimage tx
4997 assert_eq!(node_txn.len(), 3);
4998 check_spends!(node_txn[0], commitment_tx[0]);
4999 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5000 check_spends!(node_txn[1], chan_1.3);
5001 check_spends!(node_txn[2], node_txn[1]);
5003 mine_transaction(&nodes[1], &node_txn[0]);
5004 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
5006 let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
5007 assert_eq!(spend_txn.len(), 1);
5008 check_spends!(spend_txn[0], node_txn[0]);
5012 fn test_static_spendable_outputs_timeout_tx() {
5013 let chanmon_cfgs = create_chanmon_cfgs(2);
5014 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5015 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5016 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5018 // Create some initial channels
5019 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5021 // Rebalance the network a bit by relaying one payment through all the channels ...
5022 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
5024 let (_, our_payment_hash, _) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3_000_000);
5026 let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
5027 assert_eq!(commitment_tx[0].input.len(), 1);
5028 assert_eq!(commitment_tx[0].input[0].previous_output.txid, chan_1.3.txid());
5030 // Settle A's commitment tx on B' chain
5031 mine_transaction(&nodes[1], &commitment_tx[0]);
5032 check_added_monitors!(nodes[1], 1);
5033 let events = nodes[1].node.get_and_clear_pending_msg_events();
5035 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5036 _ => panic!("Unexpected event"),
5038 connect_blocks(&nodes[1], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
5040 // Check B's monitor was able to send back output descriptor event for timeout tx on A's commitment tx
5041 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
5042 assert_eq!(node_txn.len(), 2); // ChannelManager : 1 local commitent tx, ChannelMonitor: timeout tx
5043 check_spends!(node_txn[0], chan_1.3.clone());
5044 check_spends!(node_txn[1], commitment_tx[0].clone());
5045 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5047 mine_transaction(&nodes[1], &node_txn[1]);
5048 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
5049 expect_payment_failed!(nodes[1], our_payment_hash, true);
5051 let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
5052 assert_eq!(spend_txn.len(), 3); // SpendableOutput: remote_commitment_tx.to_remote, timeout_tx.output
5053 check_spends!(spend_txn[0], commitment_tx[0]);
5054 check_spends!(spend_txn[1], node_txn[1]);
5055 check_spends!(spend_txn[2], node_txn[1], commitment_tx[0]); // All outputs
5059 fn test_static_spendable_outputs_justice_tx_revoked_commitment_tx() {
5060 let chanmon_cfgs = create_chanmon_cfgs(2);
5061 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5062 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5063 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5065 // Create some initial channels
5066 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5068 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
5069 let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
5070 assert_eq!(revoked_local_txn[0].input.len(), 1);
5071 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
5073 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
5075 mine_transaction(&nodes[1], &revoked_local_txn[0]);
5076 check_closed_broadcast!(nodes[1], true);
5077 check_added_monitors!(nodes[1], 1);
5079 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5080 assert_eq!(node_txn.len(), 2);
5081 assert_eq!(node_txn[0].input.len(), 2);
5082 check_spends!(node_txn[0], revoked_local_txn[0]);
5084 mine_transaction(&nodes[1], &node_txn[0]);
5085 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
5087 let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
5088 assert_eq!(spend_txn.len(), 1);
5089 check_spends!(spend_txn[0], node_txn[0]);
5093 fn test_static_spendable_outputs_justice_tx_revoked_htlc_timeout_tx() {
5094 let mut chanmon_cfgs = create_chanmon_cfgs(2);
5095 chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
5096 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5097 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5098 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5100 // Create some initial channels
5101 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5103 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
5104 let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
5105 assert_eq!(revoked_local_txn[0].input.len(), 1);
5106 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
5108 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
5110 // A will generate HTLC-Timeout from revoked commitment tx
5111 mine_transaction(&nodes[0], &revoked_local_txn[0]);
5112 check_closed_broadcast!(nodes[0], true);
5113 check_added_monitors!(nodes[0], 1);
5114 connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
5116 let revoked_htlc_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5117 assert_eq!(revoked_htlc_txn.len(), 2);
5118 check_spends!(revoked_htlc_txn[0], chan_1.3);
5119 assert_eq!(revoked_htlc_txn[1].input.len(), 1);
5120 assert_eq!(revoked_htlc_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5121 check_spends!(revoked_htlc_txn[1], revoked_local_txn[0]);
5122 assert_ne!(revoked_htlc_txn[1].lock_time, 0); // HTLC-Timeout
5124 // B will generate justice tx from A's revoked commitment/HTLC tx
5125 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5126 connect_block(&nodes[1], &Block { header, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[1].clone()] });
5127 check_closed_broadcast!(nodes[1], true);
5128 check_added_monitors!(nodes[1], 1);
5130 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5131 assert_eq!(node_txn.len(), 3); // ChannelMonitor: bogus justice tx, justice tx on revoked outputs, ChannelManager: local commitment tx
5132 // The first transaction generated is bogus - it spends both outputs of revoked_local_txn[0]
5133 // including the one already spent by revoked_htlc_txn[1]. That's OK, we'll spend with valid
5134 // transactions next...
5135 assert_eq!(node_txn[0].input.len(), 3);
5136 check_spends!(node_txn[0], revoked_local_txn[0], revoked_htlc_txn[1]);
5138 assert_eq!(node_txn[1].input.len(), 2);
5139 check_spends!(node_txn[1], revoked_local_txn[0], revoked_htlc_txn[1]);
5140 if node_txn[1].input[1].previous_output.txid == revoked_htlc_txn[1].txid() {
5141 assert_ne!(node_txn[1].input[0].previous_output, revoked_htlc_txn[1].input[0].previous_output);
5143 assert_eq!(node_txn[1].input[0].previous_output.txid, revoked_htlc_txn[1].txid());
5144 assert_ne!(node_txn[1].input[1].previous_output, revoked_htlc_txn[1].input[0].previous_output);
5147 assert_eq!(node_txn[2].input.len(), 1);
5148 check_spends!(node_txn[2], chan_1.3);
5150 mine_transaction(&nodes[1], &node_txn[1]);
5151 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
5153 // Check B's ChannelMonitor was able to generate the right spendable output descriptor
5154 let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
5155 assert_eq!(spend_txn.len(), 1);
5156 assert_eq!(spend_txn[0].input.len(), 1);
5157 check_spends!(spend_txn[0], node_txn[1]);
5161 fn test_static_spendable_outputs_justice_tx_revoked_htlc_success_tx() {
5162 let mut chanmon_cfgs = create_chanmon_cfgs(2);
5163 chanmon_cfgs[1].keys_manager.disable_revocation_policy_check = true;
5164 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5165 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5166 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5168 // Create some initial channels
5169 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5171 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
5172 let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan_1.2);
5173 assert_eq!(revoked_local_txn[0].input.len(), 1);
5174 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
5176 // The to-be-revoked commitment tx should have one HTLC and one to_remote output
5177 assert_eq!(revoked_local_txn[0].output.len(), 2);
5179 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
5181 // B will generate HTLC-Success from revoked commitment tx
5182 mine_transaction(&nodes[1], &revoked_local_txn[0]);
5183 check_closed_broadcast!(nodes[1], true);
5184 check_added_monitors!(nodes[1], 1);
5185 let revoked_htlc_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5187 assert_eq!(revoked_htlc_txn.len(), 2);
5188 assert_eq!(revoked_htlc_txn[0].input.len(), 1);
5189 assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5190 check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
5192 // Check that the unspent (of two) outputs on revoked_local_txn[0] is a P2WPKH:
5193 let unspent_local_txn_output = revoked_htlc_txn[0].input[0].previous_output.vout as usize ^ 1;
5194 assert_eq!(revoked_local_txn[0].output[unspent_local_txn_output].script_pubkey.len(), 2 + 20); // P2WPKH
5196 // A will generate justice tx from B's revoked commitment/HTLC tx
5197 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5198 connect_block(&nodes[0], &Block { header, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[0].clone()] });
5199 check_closed_broadcast!(nodes[0], true);
5200 check_added_monitors!(nodes[0], 1);
5202 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5203 assert_eq!(node_txn.len(), 3); // ChannelMonitor: justice tx on revoked commitment, justice tx on revoked HTLC-success, ChannelManager: local commitment tx
5205 // The first transaction generated is bogus - it spends both outputs of revoked_local_txn[0]
5206 // including the one already spent by revoked_htlc_txn[0]. That's OK, we'll spend with valid
5207 // transactions next...
5208 assert_eq!(node_txn[0].input.len(), 2);
5209 check_spends!(node_txn[0], revoked_local_txn[0], revoked_htlc_txn[0]);
5210 if node_txn[0].input[1].previous_output.txid == revoked_htlc_txn[0].txid() {
5211 assert_eq!(node_txn[0].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
5213 assert_eq!(node_txn[0].input[0].previous_output.txid, revoked_htlc_txn[0].txid());
5214 assert_eq!(node_txn[0].input[1].previous_output, revoked_htlc_txn[0].input[0].previous_output);
5217 assert_eq!(node_txn[1].input.len(), 1);
5218 check_spends!(node_txn[1], revoked_htlc_txn[0]);
5220 check_spends!(node_txn[2], chan_1.3);
5222 mine_transaction(&nodes[0], &node_txn[1]);
5223 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
5225 // Note that nodes[0]'s tx_broadcaster is still locked, so if we get here the channelmonitor
5226 // didn't try to generate any new transactions.
5228 // Check A's ChannelMonitor was able to generate the right spendable output descriptor
5229 let spend_txn = check_spendable_outputs!(nodes[0], 1, node_cfgs[0].keys_manager, 100000);
5230 assert_eq!(spend_txn.len(), 3);
5231 assert_eq!(spend_txn[0].input.len(), 1);
5232 check_spends!(spend_txn[0], revoked_local_txn[0]); // spending to_remote output from revoked local tx
5233 assert_ne!(spend_txn[0].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
5234 check_spends!(spend_txn[1], node_txn[1]); // spending justice tx output on the htlc success tx
5235 check_spends!(spend_txn[2], revoked_local_txn[0], node_txn[1]); // Both outputs
5239 fn test_onchain_to_onchain_claim() {
5240 // Test that in case of channel closure, we detect the state of output and claim HTLC
5241 // on downstream peer's remote commitment tx.
5242 // First, have C claim an HTLC against its own latest commitment transaction.
5243 // Then, broadcast these to B, which should update the monitor downstream on the A<->B
5245 // Finally, check that B will claim the HTLC output if A's latest commitment transaction
5248 let chanmon_cfgs = create_chanmon_cfgs(3);
5249 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5250 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5251 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5253 // Create some initial channels
5254 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5255 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
5257 // Ensure all nodes are at the same height
5258 let node_max_height = nodes.iter().map(|node| node.blocks.lock().unwrap().len()).max().unwrap() as u32;
5259 connect_blocks(&nodes[0], node_max_height - nodes[0].best_block_info().1);
5260 connect_blocks(&nodes[1], node_max_height - nodes[1].best_block_info().1);
5261 connect_blocks(&nodes[2], node_max_height - nodes[2].best_block_info().1);
5263 // Rebalance the network a bit by relaying one payment through all the channels ...
5264 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
5265 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
5267 let (payment_preimage, _payment_hash, _payment_secret) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
5268 let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
5269 check_spends!(commitment_tx[0], chan_2.3);
5270 nodes[2].node.claim_funds(payment_preimage);
5271 check_added_monitors!(nodes[2], 1);
5272 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
5273 assert!(updates.update_add_htlcs.is_empty());
5274 assert!(updates.update_fail_htlcs.is_empty());
5275 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
5276 assert!(updates.update_fail_malformed_htlcs.is_empty());
5278 mine_transaction(&nodes[2], &commitment_tx[0]);
5279 check_closed_broadcast!(nodes[2], true);
5280 check_added_monitors!(nodes[2], 1);
5282 let c_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 2 (commitment tx, HTLC-Success tx), ChannelMonitor : 1 (HTLC-Success tx)
5283 assert_eq!(c_txn.len(), 3);
5284 assert_eq!(c_txn[0], c_txn[2]);
5285 assert_eq!(commitment_tx[0], c_txn[1]);
5286 check_spends!(c_txn[1], chan_2.3);
5287 check_spends!(c_txn[2], c_txn[1]);
5288 assert_eq!(c_txn[1].input[0].witness.clone().last().unwrap().len(), 71);
5289 assert_eq!(c_txn[2].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5290 assert!(c_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
5291 assert_eq!(c_txn[0].lock_time, 0); // Success tx
5293 // 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
5294 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
5295 connect_block(&nodes[1], &Block { header, txdata: vec![c_txn[1].clone(), c_txn[2].clone()]});
5296 connect_blocks(&nodes[1], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
5298 let mut b_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5299 // ChannelMonitor: claim tx, ChannelManager: local commitment tx
5300 assert_eq!(b_txn.len(), 2);
5301 check_spends!(b_txn[0], chan_2.3); // B local commitment tx, issued by ChannelManager
5302 check_spends!(b_txn[1], c_txn[1]); // timeout tx on C remote commitment tx, issued by ChannelMonitor
5303 assert_eq!(b_txn[1].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5304 assert!(b_txn[1].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
5305 assert_ne!(b_txn[1].lock_time, 0); // Timeout tx
5308 check_added_monitors!(nodes[1], 1);
5309 let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
5310 assert_eq!(msg_events.len(), 3);
5311 check_added_monitors!(nodes[1], 1);
5312 match msg_events[0] {
5313 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5314 _ => panic!("Unexpected event"),
5316 match msg_events[1] {
5317 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { .. }, node_id: _ } => {},
5318 _ => panic!("Unexpected event"),
5320 match msg_events[2] {
5321 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, .. } } => {
5322 assert!(update_add_htlcs.is_empty());
5323 assert!(update_fail_htlcs.is_empty());
5324 assert_eq!(update_fulfill_htlcs.len(), 1);
5325 assert!(update_fail_malformed_htlcs.is_empty());
5326 assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
5328 _ => panic!("Unexpected event"),
5330 // Broadcast A's commitment tx on B's chain to see if we are able to claim inbound HTLC with our HTLC-Success tx
5331 let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
5332 mine_transaction(&nodes[1], &commitment_tx[0]);
5333 let b_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5334 // ChannelMonitor: HTLC-Success tx + HTLC-Timeout RBF Bump, ChannelManager: local commitment tx + HTLC-Success tx
5335 assert_eq!(b_txn.len(), 4);
5336 check_spends!(b_txn[2], chan_1.3);
5337 check_spends!(b_txn[3], b_txn[2]);
5338 let (htlc_success_claim, htlc_timeout_bumped) =
5339 if b_txn[0].input[0].previous_output.txid == commitment_tx[0].txid()
5340 { (&b_txn[0], &b_txn[1]) } else { (&b_txn[1], &b_txn[0]) };
5341 check_spends!(htlc_success_claim, commitment_tx[0]);
5342 assert_eq!(htlc_success_claim.input[0].witness.clone().last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5343 assert!(htlc_success_claim.output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
5344 assert_eq!(htlc_success_claim.lock_time, 0); // Success tx
5345 check_spends!(htlc_timeout_bumped, c_txn[1]); // timeout tx on C remote commitment tx, issued by ChannelMonitor
5346 assert_ne!(htlc_timeout_bumped.lock_time, 0); // Success tx
5348 check_closed_broadcast!(nodes[1], true);
5349 check_added_monitors!(nodes[1], 1);
5353 fn test_duplicate_payment_hash_one_failure_one_success() {
5354 // Topology : A --> B --> C --> D
5355 // We route 2 payments with same hash between B and C, one will be timeout, the other successfully claim
5356 // Note that because C will refuse to generate two payment secrets for the same payment hash,
5357 // we forward one of the payments onwards to D.
5358 let chanmon_cfgs = create_chanmon_cfgs(4);
5359 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
5360 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
5361 let mut nodes = create_network(4, &node_cfgs, &node_chanmgrs);
5363 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5364 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
5365 create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
5367 let node_max_height = nodes.iter().map(|node| node.blocks.lock().unwrap().len()).max().unwrap() as u32;
5368 connect_blocks(&nodes[0], node_max_height - nodes[0].best_block_info().1);
5369 connect_blocks(&nodes[1], node_max_height - nodes[1].best_block_info().1);
5370 connect_blocks(&nodes[2], node_max_height - nodes[2].best_block_info().1);
5371 connect_blocks(&nodes[3], node_max_height - nodes[3].best_block_info().1);
5373 let (our_payment_preimage, duplicate_payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 900000);
5375 let payment_secret = nodes[3].node.create_inbound_payment_for_hash(duplicate_payment_hash, None, 7200, 0).unwrap();
5376 // We reduce the final CLTV here by a somewhat arbitrary constant to keep it under the one-byte
5377 // script push size limit so that the below script length checks match
5378 // ACCEPTED_HTLC_SCRIPT_WEIGHT.
5379 let route = get_route(&nodes[0].node.get_our_node_id(), &nodes[0].net_graph_msg_handler.network_graph.read().unwrap(),
5380 &nodes[3].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 900000, TEST_FINAL_CLTV - 40, nodes[0].logger).unwrap();
5381 send_along_route_with_secret(&nodes[0], route, &[&[&nodes[1], &nodes[2], &nodes[3]]], 900000, duplicate_payment_hash, payment_secret);
5383 let commitment_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
5384 assert_eq!(commitment_txn[0].input.len(), 1);
5385 check_spends!(commitment_txn[0], chan_2.3);
5387 mine_transaction(&nodes[1], &commitment_txn[0]);
5388 check_closed_broadcast!(nodes[1], true);
5389 check_added_monitors!(nodes[1], 1);
5390 connect_blocks(&nodes[1], TEST_FINAL_CLTV - 40 + MIN_CLTV_EXPIRY_DELTA as u32 - 1); // Confirm blocks until the HTLC expires
5392 let htlc_timeout_tx;
5393 { // Extract one of the two HTLC-Timeout transaction
5394 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5395 // ChannelMonitor: timeout tx * 3, ChannelManager: local commitment tx
5396 assert_eq!(node_txn.len(), 4);
5397 check_spends!(node_txn[0], chan_2.3);
5399 check_spends!(node_txn[1], commitment_txn[0]);
5400 assert_eq!(node_txn[1].input.len(), 1);
5401 check_spends!(node_txn[2], commitment_txn[0]);
5402 assert_eq!(node_txn[2].input.len(), 1);
5403 assert_eq!(node_txn[1].input[0].previous_output, node_txn[2].input[0].previous_output);
5404 check_spends!(node_txn[3], commitment_txn[0]);
5405 assert_ne!(node_txn[1].input[0].previous_output, node_txn[3].input[0].previous_output);
5407 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5408 assert_eq!(node_txn[2].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5409 assert_eq!(node_txn[3].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5410 htlc_timeout_tx = node_txn[1].clone();
5413 nodes[2].node.claim_funds(our_payment_preimage);
5414 mine_transaction(&nodes[2], &commitment_txn[0]);
5415 check_added_monitors!(nodes[2], 2);
5416 let events = nodes[2].node.get_and_clear_pending_msg_events();
5418 MessageSendEvent::UpdateHTLCs { .. } => {},
5419 _ => panic!("Unexpected event"),
5422 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5423 _ => panic!("Unexepected event"),
5425 let htlc_success_txn: Vec<_> = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
5426 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)
5427 check_spends!(htlc_success_txn[0], commitment_txn[0]);
5428 check_spends!(htlc_success_txn[1], commitment_txn[0]);
5429 assert_eq!(htlc_success_txn[0].input.len(), 1);
5430 assert_eq!(htlc_success_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5431 assert_eq!(htlc_success_txn[1].input.len(), 1);
5432 assert_eq!(htlc_success_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5433 assert_ne!(htlc_success_txn[0].input[0].previous_output, htlc_success_txn[1].input[0].previous_output);
5434 assert_eq!(htlc_success_txn[2], commitment_txn[0]);
5435 assert_eq!(htlc_success_txn[3], htlc_success_txn[0]);
5436 assert_eq!(htlc_success_txn[4], htlc_success_txn[1]);
5437 assert_ne!(htlc_success_txn[0].input[0].previous_output, htlc_timeout_tx.input[0].previous_output);
5439 mine_transaction(&nodes[1], &htlc_timeout_tx);
5440 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
5441 expect_pending_htlcs_forwardable!(nodes[1]);
5442 let htlc_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5443 assert!(htlc_updates.update_add_htlcs.is_empty());
5444 assert_eq!(htlc_updates.update_fail_htlcs.len(), 1);
5445 let first_htlc_id = htlc_updates.update_fail_htlcs[0].htlc_id;
5446 assert!(htlc_updates.update_fulfill_htlcs.is_empty());
5447 assert!(htlc_updates.update_fail_malformed_htlcs.is_empty());
5448 check_added_monitors!(nodes[1], 1);
5450 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_updates.update_fail_htlcs[0]);
5451 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
5453 commitment_signed_dance!(nodes[0], nodes[1], &htlc_updates.commitment_signed, false, true);
5454 let events = nodes[0].node.get_and_clear_pending_msg_events();
5455 assert_eq!(events.len(), 1);
5457 MessageSendEvent::PaymentFailureNetworkUpdate { update: msgs::HTLCFailChannelUpdate::ChannelClosed { .. } } => {
5459 _ => { panic!("Unexpected event"); }
5462 expect_payment_failed!(nodes[0], duplicate_payment_hash, false);
5464 // Solve 2nd HTLC by broadcasting on B's chain HTLC-Success Tx from C
5465 mine_transaction(&nodes[1], &htlc_success_txn[0]);
5466 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5467 assert!(updates.update_add_htlcs.is_empty());
5468 assert!(updates.update_fail_htlcs.is_empty());
5469 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
5470 assert_ne!(updates.update_fulfill_htlcs[0].htlc_id, first_htlc_id);
5471 assert!(updates.update_fail_malformed_htlcs.is_empty());
5472 check_added_monitors!(nodes[1], 1);
5474 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
5475 commitment_signed_dance!(nodes[0], nodes[1], &updates.commitment_signed, false);
5477 let events = nodes[0].node.get_and_clear_pending_events();
5479 Event::PaymentSent { ref payment_preimage } => {
5480 assert_eq!(*payment_preimage, our_payment_preimage);
5482 _ => panic!("Unexpected event"),
5487 fn test_dynamic_spendable_outputs_local_htlc_success_tx() {
5488 let chanmon_cfgs = create_chanmon_cfgs(2);
5489 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5490 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5491 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5493 // Create some initial channels
5494 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5496 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000).0;
5497 let local_txn = get_local_commitment_txn!(nodes[1], chan_1.2);
5498 assert_eq!(local_txn.len(), 1);
5499 assert_eq!(local_txn[0].input.len(), 1);
5500 check_spends!(local_txn[0], chan_1.3);
5502 // Give B knowledge of preimage to be able to generate a local HTLC-Success Tx
5503 nodes[1].node.claim_funds(payment_preimage);
5504 check_added_monitors!(nodes[1], 1);
5505 mine_transaction(&nodes[1], &local_txn[0]);
5506 check_added_monitors!(nodes[1], 1);
5507 let events = nodes[1].node.get_and_clear_pending_msg_events();
5509 MessageSendEvent::UpdateHTLCs { .. } => {},
5510 _ => panic!("Unexpected event"),
5513 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5514 _ => panic!("Unexepected event"),
5517 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5518 assert_eq!(node_txn.len(), 3);
5519 assert_eq!(node_txn[0], node_txn[2]);
5520 assert_eq!(node_txn[1], local_txn[0]);
5521 assert_eq!(node_txn[0].input.len(), 1);
5522 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5523 check_spends!(node_txn[0], local_txn[0]);
5527 mine_transaction(&nodes[1], &node_tx);
5528 connect_blocks(&nodes[1], BREAKDOWN_TIMEOUT as u32 - 1);
5530 // Verify that B is able to spend its own HTLC-Success tx thanks to spendable output event given back by its ChannelMonitor
5531 let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
5532 assert_eq!(spend_txn.len(), 1);
5533 assert_eq!(spend_txn[0].input.len(), 1);
5534 check_spends!(spend_txn[0], node_tx);
5535 assert_eq!(spend_txn[0].input[0].sequence, BREAKDOWN_TIMEOUT as u32);
5538 fn do_test_fail_backwards_unrevoked_remote_announce(deliver_last_raa: bool, announce_latest: bool) {
5539 // Test that we fail backwards the full set of HTLCs we need to when remote broadcasts an
5540 // unrevoked commitment transaction.
5541 // This includes HTLCs which were below the dust threshold as well as HTLCs which were awaiting
5542 // a remote RAA before they could be failed backwards (and combinations thereof).
5543 // We also test duplicate-hash HTLCs by adding two nodes on each side of the target nodes which
5544 // use the same payment hashes.
5545 // Thus, we use a six-node network:
5550 // And test where C fails back to A/B when D announces its latest commitment transaction
5551 let chanmon_cfgs = create_chanmon_cfgs(6);
5552 let node_cfgs = create_node_cfgs(6, &chanmon_cfgs);
5553 let node_chanmgrs = create_node_chanmgrs(6, &node_cfgs, &[None, None, None, None, None, None]);
5554 let nodes = create_network(6, &node_cfgs, &node_chanmgrs);
5555 let logger = test_utils::TestLogger::new();
5557 create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known());
5558 create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
5559 let chan = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
5560 create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::known(), InitFeatures::known());
5561 create_announced_chan_between_nodes(&nodes, 3, 5, InitFeatures::known(), InitFeatures::known());
5563 // Rebalance and check output sanity...
5564 send_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 500000);
5565 send_payment(&nodes[1], &[&nodes[2], &nodes[3], &nodes[5]], 500000);
5566 assert_eq!(get_local_commitment_txn!(nodes[3], chan.2)[0].output.len(), 2);
5568 let ds_dust_limit = nodes[3].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().holder_dust_limit_satoshis;
5570 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
5572 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
5573 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
5574 let our_node_id = &nodes[1].node.get_our_node_id();
5575 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();
5577 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
5579 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
5581 let (_, payment_hash_3, _) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
5583 let (_, payment_hash_4, _) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
5584 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();
5586 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());
5588 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());
5591 let (_, payment_hash_5, _) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
5593 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();
5594 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
5597 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
5599 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();
5600 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());
5602 // Double-check that six of the new HTLC were added
5603 // We now have six HTLCs pending over the dust limit and six HTLCs under the dust limit (ie,
5604 // with to_local and to_remote outputs, 8 outputs and 6 HTLCs not included).
5605 assert_eq!(get_local_commitment_txn!(nodes[3], chan.2).len(), 1);
5606 assert_eq!(get_local_commitment_txn!(nodes[3], chan.2)[0].output.len(), 8);
5608 // Now fail back three of the over-dust-limit and three of the under-dust-limit payments in one go.
5609 // Fail 0th below-dust, 4th above-dust, 8th above-dust, 10th below-dust HTLCs
5610 assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_1));
5611 assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_3));
5612 assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_5));
5613 assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_6));
5614 check_added_monitors!(nodes[4], 0);
5615 expect_pending_htlcs_forwardable!(nodes[4]);
5616 check_added_monitors!(nodes[4], 1);
5618 let four_removes = get_htlc_update_msgs!(nodes[4], nodes[3].node.get_our_node_id());
5619 nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[0]);
5620 nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[1]);
5621 nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[2]);
5622 nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[3]);
5623 commitment_signed_dance!(nodes[3], nodes[4], four_removes.commitment_signed, false);
5625 // Fail 3rd below-dust and 7th above-dust HTLCs
5626 assert!(nodes[5].node.fail_htlc_backwards(&payment_hash_2));
5627 assert!(nodes[5].node.fail_htlc_backwards(&payment_hash_4));
5628 check_added_monitors!(nodes[5], 0);
5629 expect_pending_htlcs_forwardable!(nodes[5]);
5630 check_added_monitors!(nodes[5], 1);
5632 let two_removes = get_htlc_update_msgs!(nodes[5], nodes[3].node.get_our_node_id());
5633 nodes[3].node.handle_update_fail_htlc(&nodes[5].node.get_our_node_id(), &two_removes.update_fail_htlcs[0]);
5634 nodes[3].node.handle_update_fail_htlc(&nodes[5].node.get_our_node_id(), &two_removes.update_fail_htlcs[1]);
5635 commitment_signed_dance!(nodes[3], nodes[5], two_removes.commitment_signed, false);
5637 let ds_prev_commitment_tx = get_local_commitment_txn!(nodes[3], chan.2);
5639 expect_pending_htlcs_forwardable!(nodes[3]);
5640 check_added_monitors!(nodes[3], 1);
5641 let six_removes = get_htlc_update_msgs!(nodes[3], nodes[2].node.get_our_node_id());
5642 nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[0]);
5643 nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[1]);
5644 nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[2]);
5645 nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[3]);
5646 nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[4]);
5647 nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[5]);
5648 if deliver_last_raa {
5649 commitment_signed_dance!(nodes[2], nodes[3], six_removes.commitment_signed, false);
5651 let _cs_last_raa = commitment_signed_dance!(nodes[2], nodes[3], six_removes.commitment_signed, false, true, false, true);
5654 // D's latest commitment transaction now contains 1st + 2nd + 9th HTLCs (implicitly, they're
5655 // below the dust limit) and the 5th + 6th + 11th HTLCs. It has failed back the 0th, 3rd, 4th,
5656 // 7th, 8th, and 10th, but as we haven't yet delivered the final RAA to C, the fails haven't
5657 // propagated back to A/B yet (and D has two unrevoked commitment transactions).
5659 // We now broadcast the latest commitment transaction, which *should* result in failures for
5660 // the 0th, 1st, 2nd, 3rd, 4th, 7th, 8th, 9th, and 10th HTLCs, ie all the below-dust HTLCs and
5661 // the non-broadcast above-dust HTLCs.
5663 // Alternatively, we may broadcast the previous commitment transaction, which should only
5664 // result in failures for the below-dust HTLCs, ie the 0th, 1st, 2nd, 3rd, 9th, and 10th HTLCs.
5665 let ds_last_commitment_tx = get_local_commitment_txn!(nodes[3], chan.2);
5667 if announce_latest {
5668 mine_transaction(&nodes[2], &ds_last_commitment_tx[0]);
5670 mine_transaction(&nodes[2], &ds_prev_commitment_tx[0]);
5672 connect_blocks(&nodes[2], ANTI_REORG_DELAY - 1);
5673 check_closed_broadcast!(nodes[2], true);
5674 expect_pending_htlcs_forwardable!(nodes[2]);
5675 check_added_monitors!(nodes[2], 3);
5677 let cs_msgs = nodes[2].node.get_and_clear_pending_msg_events();
5678 assert_eq!(cs_msgs.len(), 2);
5679 let mut a_done = false;
5680 for msg in cs_msgs {
5682 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
5683 // Both under-dust HTLCs and the one above-dust HTLC that we had already failed
5684 // should be failed-backwards here.
5685 let target = if *node_id == nodes[0].node.get_our_node_id() {
5686 // If announce_latest, expect 0th, 1st, 4th, 8th, 10th HTLCs, else only 0th, 1st, 10th below-dust HTLCs
5687 for htlc in &updates.update_fail_htlcs {
5688 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 });
5690 assert_eq!(updates.update_fail_htlcs.len(), if announce_latest { 5 } else { 3 });
5695 // If announce_latest, expect 2nd, 3rd, 7th, 9th HTLCs, else only 2nd, 3rd, 9th below-dust HTLCs
5696 for htlc in &updates.update_fail_htlcs {
5697 assert!(htlc.htlc_id == 1 || htlc.htlc_id == 2 || htlc.htlc_id == 5 || if announce_latest { htlc.htlc_id == 4 } else { false });
5699 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
5700 assert_eq!(updates.update_fail_htlcs.len(), if announce_latest { 4 } else { 3 });
5703 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
5704 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[1]);
5705 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[2]);
5706 if announce_latest {
5707 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[3]);
5708 if *node_id == nodes[0].node.get_our_node_id() {
5709 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[4]);
5712 commitment_signed_dance!(target, nodes[2], updates.commitment_signed, false, true);
5714 _ => panic!("Unexpected event"),
5718 let as_events = nodes[0].node.get_and_clear_pending_events();
5719 assert_eq!(as_events.len(), if announce_latest { 5 } else { 3 });
5720 let mut as_failds = HashSet::new();
5721 for event in as_events.iter() {
5722 if let &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, .. } = event {
5723 assert!(as_failds.insert(*payment_hash));
5724 if *payment_hash != payment_hash_2 {
5725 assert_eq!(*rejected_by_dest, deliver_last_raa);
5727 assert!(!rejected_by_dest);
5729 } else { panic!("Unexpected event"); }
5731 assert!(as_failds.contains(&payment_hash_1));
5732 assert!(as_failds.contains(&payment_hash_2));
5733 if announce_latest {
5734 assert!(as_failds.contains(&payment_hash_3));
5735 assert!(as_failds.contains(&payment_hash_5));
5737 assert!(as_failds.contains(&payment_hash_6));
5739 let bs_events = nodes[1].node.get_and_clear_pending_events();
5740 assert_eq!(bs_events.len(), if announce_latest { 4 } else { 3 });
5741 let mut bs_failds = HashSet::new();
5742 for event in bs_events.iter() {
5743 if let &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, .. } = event {
5744 assert!(bs_failds.insert(*payment_hash));
5745 if *payment_hash != payment_hash_1 && *payment_hash != payment_hash_5 {
5746 assert_eq!(*rejected_by_dest, deliver_last_raa);
5748 assert!(!rejected_by_dest);
5750 } else { panic!("Unexpected event"); }
5752 assert!(bs_failds.contains(&payment_hash_1));
5753 assert!(bs_failds.contains(&payment_hash_2));
5754 if announce_latest {
5755 assert!(bs_failds.contains(&payment_hash_4));
5757 assert!(bs_failds.contains(&payment_hash_5));
5759 // For each HTLC which was not failed-back by normal process (ie deliver_last_raa), we should
5760 // get a PaymentFailureNetworkUpdate. A should have gotten 4 HTLCs which were failed-back due
5761 // to unknown-preimage-etc, B should have gotten 2. Thus, in the
5762 // announce_latest && deliver_last_raa case, we should have 5-4=1 and 4-2=2
5763 // PaymentFailureNetworkUpdates.
5764 let as_msg_events = nodes[0].node.get_and_clear_pending_msg_events();
5765 assert_eq!(as_msg_events.len(), if deliver_last_raa { 1 } else if !announce_latest { 3 } else { 5 });
5766 let bs_msg_events = nodes[1].node.get_and_clear_pending_msg_events();
5767 assert_eq!(bs_msg_events.len(), if deliver_last_raa { 2 } else if !announce_latest { 3 } else { 4 });
5768 for event in as_msg_events.iter().chain(bs_msg_events.iter()) {
5770 &MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
5771 _ => panic!("Unexpected event"),
5777 fn test_fail_backwards_latest_remote_announce_a() {
5778 do_test_fail_backwards_unrevoked_remote_announce(false, true);
5782 fn test_fail_backwards_latest_remote_announce_b() {
5783 do_test_fail_backwards_unrevoked_remote_announce(true, true);
5787 fn test_fail_backwards_previous_remote_announce() {
5788 do_test_fail_backwards_unrevoked_remote_announce(false, false);
5789 // Note that true, true doesn't make sense as it implies we announce a revoked state, which is
5790 // tested for in test_commitment_revoked_fail_backward_exhaustive()
5794 fn test_dynamic_spendable_outputs_local_htlc_timeout_tx() {
5795 let chanmon_cfgs = create_chanmon_cfgs(2);
5796 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5797 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5798 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5800 // Create some initial channels
5801 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5803 let (_, our_payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000);
5804 let local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
5805 assert_eq!(local_txn[0].input.len(), 1);
5806 check_spends!(local_txn[0], chan_1.3);
5808 // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
5809 mine_transaction(&nodes[0], &local_txn[0]);
5810 check_closed_broadcast!(nodes[0], true);
5811 check_added_monitors!(nodes[0], 1);
5812 connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
5814 let htlc_timeout = {
5815 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5816 assert_eq!(node_txn.len(), 2);
5817 check_spends!(node_txn[0], chan_1.3);
5818 assert_eq!(node_txn[1].input.len(), 1);
5819 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5820 check_spends!(node_txn[1], local_txn[0]);
5824 mine_transaction(&nodes[0], &htlc_timeout);
5825 connect_blocks(&nodes[0], BREAKDOWN_TIMEOUT as u32 - 1);
5826 expect_payment_failed!(nodes[0], our_payment_hash, true);
5828 // Verify that A is able to spend its own HTLC-Timeout tx thanks to spendable output event given back by its ChannelMonitor
5829 let spend_txn = check_spendable_outputs!(nodes[0], 1, node_cfgs[0].keys_manager, 100000);
5830 assert_eq!(spend_txn.len(), 3);
5831 check_spends!(spend_txn[0], local_txn[0]);
5832 assert_eq!(spend_txn[1].input.len(), 1);
5833 check_spends!(spend_txn[1], htlc_timeout);
5834 assert_eq!(spend_txn[1].input[0].sequence, BREAKDOWN_TIMEOUT as u32);
5835 assert_eq!(spend_txn[2].input.len(), 2);
5836 check_spends!(spend_txn[2], local_txn[0], htlc_timeout);
5837 assert!(spend_txn[2].input[0].sequence == BREAKDOWN_TIMEOUT as u32 ||
5838 spend_txn[2].input[1].sequence == BREAKDOWN_TIMEOUT as u32);
5842 fn test_key_derivation_params() {
5843 // This test is a copy of test_dynamic_spendable_outputs_local_htlc_timeout_tx, with
5844 // a key manager rotation to test that key_derivation_params returned in DynamicOutputP2WSH
5845 // let us re-derive the channel key set to then derive a delayed_payment_key.
5847 let chanmon_cfgs = create_chanmon_cfgs(3);
5849 // We manually create the node configuration to backup the seed.
5850 let seed = [42; 32];
5851 let keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
5852 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);
5853 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 };
5854 let mut node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5855 node_cfgs.remove(0);
5856 node_cfgs.insert(0, node);
5858 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5859 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5861 // Create some initial channels
5862 // Create a dummy channel to advance index by one and thus test re-derivation correctness
5864 let chan_0 = create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known());
5865 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5866 assert_ne!(chan_0.3.output[0].script_pubkey, chan_1.3.output[0].script_pubkey);
5868 // Ensure all nodes are at the same height
5869 let node_max_height = nodes.iter().map(|node| node.blocks.lock().unwrap().len()).max().unwrap() as u32;
5870 connect_blocks(&nodes[0], node_max_height - nodes[0].best_block_info().1);
5871 connect_blocks(&nodes[1], node_max_height - nodes[1].best_block_info().1);
5872 connect_blocks(&nodes[2], node_max_height - nodes[2].best_block_info().1);
5874 let (_, our_payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000);
5875 let local_txn_0 = get_local_commitment_txn!(nodes[0], chan_0.2);
5876 let local_txn_1 = get_local_commitment_txn!(nodes[0], chan_1.2);
5877 assert_eq!(local_txn_1[0].input.len(), 1);
5878 check_spends!(local_txn_1[0], chan_1.3);
5880 // We check funding pubkey are unique
5881 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]));
5882 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]));
5883 if from_0_funding_key_0 == from_1_funding_key_0
5884 || from_0_funding_key_0 == from_1_funding_key_1
5885 || from_0_funding_key_1 == from_1_funding_key_0
5886 || from_0_funding_key_1 == from_1_funding_key_1 {
5887 panic!("Funding pubkeys aren't unique");
5890 // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
5891 mine_transaction(&nodes[0], &local_txn_1[0]);
5892 connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
5893 check_closed_broadcast!(nodes[0], true);
5894 check_added_monitors!(nodes[0], 1);
5896 let htlc_timeout = {
5897 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5898 assert_eq!(node_txn[1].input.len(), 1);
5899 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5900 check_spends!(node_txn[1], local_txn_1[0]);
5904 mine_transaction(&nodes[0], &htlc_timeout);
5905 connect_blocks(&nodes[0], BREAKDOWN_TIMEOUT as u32 - 1);
5906 expect_payment_failed!(nodes[0], our_payment_hash, true);
5908 // Verify that A is able to spend its own HTLC-Timeout tx thanks to spendable output event given back by its ChannelMonitor
5909 let new_keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
5910 let spend_txn = check_spendable_outputs!(nodes[0], 1, new_keys_manager, 100000);
5911 assert_eq!(spend_txn.len(), 3);
5912 check_spends!(spend_txn[0], local_txn_1[0]);
5913 assert_eq!(spend_txn[1].input.len(), 1);
5914 check_spends!(spend_txn[1], htlc_timeout);
5915 assert_eq!(spend_txn[1].input[0].sequence, BREAKDOWN_TIMEOUT as u32);
5916 assert_eq!(spend_txn[2].input.len(), 2);
5917 check_spends!(spend_txn[2], local_txn_1[0], htlc_timeout);
5918 assert!(spend_txn[2].input[0].sequence == BREAKDOWN_TIMEOUT as u32 ||
5919 spend_txn[2].input[1].sequence == BREAKDOWN_TIMEOUT as u32);
5923 fn test_static_output_closing_tx() {
5924 let chanmon_cfgs = create_chanmon_cfgs(2);
5925 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5926 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5927 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5929 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5931 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
5932 let closing_tx = close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true).2;
5934 mine_transaction(&nodes[0], &closing_tx);
5935 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
5937 let spend_txn = check_spendable_outputs!(nodes[0], 2, node_cfgs[0].keys_manager, 100000);
5938 assert_eq!(spend_txn.len(), 1);
5939 check_spends!(spend_txn[0], closing_tx);
5941 mine_transaction(&nodes[1], &closing_tx);
5942 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
5944 let spend_txn = check_spendable_outputs!(nodes[1], 2, node_cfgs[1].keys_manager, 100000);
5945 assert_eq!(spend_txn.len(), 1);
5946 check_spends!(spend_txn[0], closing_tx);
5949 fn do_htlc_claim_local_commitment_only(use_dust: bool) {
5950 let chanmon_cfgs = create_chanmon_cfgs(2);
5951 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5952 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5953 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5954 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5956 let (our_payment_preimage, _, _) = route_payment(&nodes[0], &[&nodes[1]], if use_dust { 50000 } else { 3000000 });
5958 // Claim the payment, but don't deliver A's commitment_signed, resulting in the HTLC only being
5959 // present in B's local commitment transaction, but none of A's commitment transactions.
5960 assert!(nodes[1].node.claim_funds(our_payment_preimage));
5961 check_added_monitors!(nodes[1], 1);
5963 let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5964 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fulfill_htlcs[0]);
5965 let events = nodes[0].node.get_and_clear_pending_events();
5966 assert_eq!(events.len(), 1);
5968 Event::PaymentSent { payment_preimage } => {
5969 assert_eq!(payment_preimage, our_payment_preimage);
5971 _ => panic!("Unexpected event"),
5974 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_updates.commitment_signed);
5975 check_added_monitors!(nodes[0], 1);
5976 let as_updates = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5977 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_updates.0);
5978 check_added_monitors!(nodes[1], 1);
5980 let starting_block = nodes[1].best_block_info();
5981 let mut block = Block {
5982 header: BlockHeader { version: 0x20000000, prev_blockhash: starting_block.0, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
5985 for _ in starting_block.1 + 1..TEST_FINAL_CLTV - CLTV_CLAIM_BUFFER + starting_block.1 + 2 {
5986 connect_block(&nodes[1], &block);
5987 block.header.prev_blockhash = block.block_hash();
5989 test_txn_broadcast(&nodes[1], &chan, None, if use_dust { HTLCType::NONE } else { HTLCType::SUCCESS });
5990 check_closed_broadcast!(nodes[1], true);
5991 check_added_monitors!(nodes[1], 1);
5994 fn do_htlc_claim_current_remote_commitment_only(use_dust: bool) {
5995 let chanmon_cfgs = create_chanmon_cfgs(2);
5996 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5997 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5998 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5999 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6000 let logger = test_utils::TestLogger::new();
6002 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1]);
6003 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6004 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();
6005 nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
6006 check_added_monitors!(nodes[0], 1);
6008 let _as_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6010 // As far as A is concerned, the HTLC is now present only in the latest remote commitment
6011 // transaction, however it is not in A's latest local commitment, so we can just broadcast that
6012 // to "time out" the HTLC.
6014 let starting_block = nodes[1].best_block_info();
6015 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: starting_block.0, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6017 for _ in starting_block.1 + 1..TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + starting_block.1 + 2 {
6018 connect_block(&nodes[0], &Block { header, txdata: Vec::new()});
6019 header.prev_blockhash = header.block_hash();
6021 test_txn_broadcast(&nodes[0], &chan, None, HTLCType::NONE);
6022 check_closed_broadcast!(nodes[0], true);
6023 check_added_monitors!(nodes[0], 1);
6026 fn do_htlc_claim_previous_remote_commitment_only(use_dust: bool, check_revoke_no_close: bool) {
6027 let chanmon_cfgs = create_chanmon_cfgs(3);
6028 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
6029 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
6030 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
6031 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6033 // Fail the payment, but don't deliver A's final RAA, resulting in the HTLC only being present
6034 // in B's previous (unrevoked) commitment transaction, but none of A's commitment transactions.
6035 // Also optionally test that we *don't* fail the channel in case the commitment transaction was
6036 // actually revoked.
6037 let htlc_value = if use_dust { 50000 } else { 3000000 };
6038 let (_, our_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1]], htlc_value);
6039 assert!(nodes[1].node.fail_htlc_backwards(&our_payment_hash));
6040 expect_pending_htlcs_forwardable!(nodes[1]);
6041 check_added_monitors!(nodes[1], 1);
6043 let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6044 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fail_htlcs[0]);
6045 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_updates.commitment_signed);
6046 check_added_monitors!(nodes[0], 1);
6047 let as_updates = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6048 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_updates.0);
6049 check_added_monitors!(nodes[1], 1);
6050 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_updates.1);
6051 check_added_monitors!(nodes[1], 1);
6052 let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
6054 if check_revoke_no_close {
6055 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
6056 check_added_monitors!(nodes[0], 1);
6059 let starting_block = nodes[1].best_block_info();
6060 let mut block = Block {
6061 header: BlockHeader { version: 0x20000000, prev_blockhash: starting_block.0, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
6064 for _ in starting_block.1 + 1..TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + CHAN_CONFIRM_DEPTH + 2 {
6065 connect_block(&nodes[0], &block);
6066 block.header.prev_blockhash = block.block_hash();
6068 if !check_revoke_no_close {
6069 test_txn_broadcast(&nodes[0], &chan, None, HTLCType::NONE);
6070 check_closed_broadcast!(nodes[0], true);
6071 check_added_monitors!(nodes[0], 1);
6073 expect_payment_failed!(nodes[0], our_payment_hash, true);
6077 // Test that we close channels on-chain when broadcastable HTLCs reach their timeout window.
6078 // There are only a few cases to test here:
6079 // * its not really normative behavior, but we test that below-dust HTLCs "included" in
6080 // broadcastable commitment transactions result in channel closure,
6081 // * its included in an unrevoked-but-previous remote commitment transaction,
6082 // * its included in the latest remote or local commitment transactions.
6083 // We test each of the three possible commitment transactions individually and use both dust and
6085 // Note that we don't bother testing both outbound and inbound HTLC failures for each case, and we
6086 // assume they are handled the same across all six cases, as both outbound and inbound failures are
6087 // tested for at least one of the cases in other tests.
6089 fn htlc_claim_single_commitment_only_a() {
6090 do_htlc_claim_local_commitment_only(true);
6091 do_htlc_claim_local_commitment_only(false);
6093 do_htlc_claim_current_remote_commitment_only(true);
6094 do_htlc_claim_current_remote_commitment_only(false);
6098 fn htlc_claim_single_commitment_only_b() {
6099 do_htlc_claim_previous_remote_commitment_only(true, false);
6100 do_htlc_claim_previous_remote_commitment_only(false, false);
6101 do_htlc_claim_previous_remote_commitment_only(true, true);
6102 do_htlc_claim_previous_remote_commitment_only(false, true);
6107 fn bolt2_open_channel_sending_node_checks_part1() { //This test needs to be on its own as we are catching a panic
6108 let chanmon_cfgs = create_chanmon_cfgs(2);
6109 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6110 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6111 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6112 //Force duplicate channel ids
6113 for node in nodes.iter() {
6114 *node.keys_manager.override_channel_id_priv.lock().unwrap() = Some([0; 32]);
6117 // BOLT #2 spec: Sending node must ensure temporary_channel_id is unique from any other channel ID with the same peer.
6118 let channel_value_satoshis=10000;
6119 let push_msat=10001;
6120 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).unwrap();
6121 let node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
6122 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &node0_to_1_send_open_channel);
6124 //Create a second channel with a channel_id collision
6125 assert!(nodes[0].node.create_channel(nodes[0].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
6129 fn bolt2_open_channel_sending_node_checks_part2() {
6130 let chanmon_cfgs = create_chanmon_cfgs(2);
6131 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6132 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6133 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6135 // BOLT #2 spec: Sending node must set funding_satoshis to less than 2^24 satoshis
6136 let channel_value_satoshis=2^24;
6137 let push_msat=10001;
6138 assert!(nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
6140 // BOLT #2 spec: Sending node must set push_msat to equal or less than 1000 * funding_satoshis
6141 let channel_value_satoshis=10000;
6142 // Test when push_msat is equal to 1000 * funding_satoshis.
6143 let push_msat=1000*channel_value_satoshis+1;
6144 assert!(nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
6146 // BOLT #2 spec: Sending node must set set channel_reserve_satoshis greater than or equal to dust_limit_satoshis
6147 let channel_value_satoshis=10000;
6148 let push_msat=10001;
6149 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
6150 let node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
6151 assert!(node0_to_1_send_open_channel.channel_reserve_satoshis>=node0_to_1_send_open_channel.dust_limit_satoshis);
6153 // BOLT #2 spec: Sending node must set undefined bits in channel_flags to 0
6154 // 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
6155 assert!(node0_to_1_send_open_channel.channel_flags<=1);
6157 // 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.
6158 assert!(BREAKDOWN_TIMEOUT>0);
6159 assert!(node0_to_1_send_open_channel.to_self_delay==BREAKDOWN_TIMEOUT);
6161 // BOLT #2 spec: Sending node must ensure the chain_hash value identifies the chain it wishes to open the channel within.
6162 let chain_hash=genesis_block(Network::Testnet).header.block_hash();
6163 assert_eq!(node0_to_1_send_open_channel.chain_hash,chain_hash);
6165 // 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.
6166 assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.funding_pubkey.serialize()).is_ok());
6167 assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.revocation_basepoint.serialize()).is_ok());
6168 assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.htlc_basepoint.serialize()).is_ok());
6169 assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.payment_point.serialize()).is_ok());
6170 assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.delayed_payment_basepoint.serialize()).is_ok());
6174 fn bolt2_open_channel_sane_dust_limit() {
6175 let chanmon_cfgs = create_chanmon_cfgs(2);
6176 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6177 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6178 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6180 let channel_value_satoshis=1000000;
6181 let push_msat=10001;
6182 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).unwrap();
6183 let mut node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
6184 node0_to_1_send_open_channel.dust_limit_satoshis = 661;
6185 node0_to_1_send_open_channel.channel_reserve_satoshis = 100001;
6187 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &node0_to_1_send_open_channel);
6188 let events = nodes[1].node.get_and_clear_pending_msg_events();
6189 let err_msg = match events[0] {
6190 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id: _ } => {
6193 _ => panic!("Unexpected event"),
6195 assert_eq!(err_msg.data, "dust_limit_satoshis (661) is greater than the implementation limit (660)");
6198 // Test that if we fail to send an HTLC that is being freed from the holding cell, and the HTLC
6199 // originated from our node, its failure is surfaced to the user. We trigger this failure to
6200 // free the HTLC by increasing our fee while the HTLC is in the holding cell such that the HTLC
6201 // is no longer affordable once it's freed.
6203 fn test_fail_holding_cell_htlc_upon_free() {
6204 let chanmon_cfgs = create_chanmon_cfgs(2);
6205 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6206 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6207 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6208 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6209 let logger = test_utils::TestLogger::new();
6211 // First nodes[0] generates an update_fee, setting the channel's
6212 // pending_update_fee.
6213 nodes[0].node.update_fee(chan.2, get_feerate!(nodes[0], chan.2) + 20).unwrap();
6214 check_added_monitors!(nodes[0], 1);
6216 let events = nodes[0].node.get_and_clear_pending_msg_events();
6217 assert_eq!(events.len(), 1);
6218 let (update_msg, commitment_signed) = match events[0] {
6219 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
6220 (update_fee.as_ref(), commitment_signed)
6222 _ => panic!("Unexpected event"),
6225 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
6227 let mut chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6228 let channel_reserve = chan_stat.channel_reserve_msat;
6229 let feerate = get_feerate!(nodes[0], chan.2);
6231 // 2* and +1 HTLCs on the commit tx fee calculation for the fee spike reserve.
6232 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6233 let max_can_send = 5000000 - channel_reserve - 2*commit_tx_fee_msat(feerate, 1 + 1);
6234 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6235 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();
6237 // Send a payment which passes reserve checks but gets stuck in the holding cell.
6238 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6239 chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6240 assert_eq!(chan_stat.holding_cell_outbound_amount_msat, max_can_send);
6242 // Flush the pending fee update.
6243 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
6244 let (as_revoke_and_ack, _) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6245 check_added_monitors!(nodes[1], 1);
6246 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_revoke_and_ack);
6247 check_added_monitors!(nodes[0], 1);
6249 // Upon receipt of the RAA, there will be an attempt to resend the holding cell
6250 // HTLC, but now that the fee has been raised the payment will now fail, causing
6251 // us to surface its failure to the user.
6252 chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6253 assert_eq!(chan_stat.holding_cell_outbound_amount_msat, 0);
6254 nodes[0].logger.assert_log("lightning::ln::channel".to_string(), "Freeing holding cell with 1 HTLC updates".to_string(), 1);
6255 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 ({})", log_bytes!(our_payment_hash.0), chan_stat.channel_reserve_msat);
6256 nodes[0].logger.assert_log("lightning::ln::channel".to_string(), failure_log.to_string(), 1);
6258 // Check that the payment failed to be sent out.
6259 let events = nodes[0].node.get_and_clear_pending_events();
6260 assert_eq!(events.len(), 1);
6262 &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, ref error_code, ref error_data } => {
6263 assert_eq!(our_payment_hash.clone(), *payment_hash);
6264 assert_eq!(*rejected_by_dest, false);
6265 assert_eq!(*error_code, None);
6266 assert_eq!(*error_data, None);
6268 _ => panic!("Unexpected event"),
6272 // Test that if multiple HTLCs are released from the holding cell and one is
6273 // valid but the other is no longer valid upon release, the valid HTLC can be
6274 // successfully completed while the other one fails as expected.
6276 fn test_free_and_fail_holding_cell_htlcs() {
6277 let chanmon_cfgs = create_chanmon_cfgs(2);
6278 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6279 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6280 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6281 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6282 let logger = test_utils::TestLogger::new();
6284 // First nodes[0] generates an update_fee, setting the channel's
6285 // pending_update_fee.
6286 nodes[0].node.update_fee(chan.2, get_feerate!(nodes[0], chan.2) + 200).unwrap();
6287 check_added_monitors!(nodes[0], 1);
6289 let events = nodes[0].node.get_and_clear_pending_msg_events();
6290 assert_eq!(events.len(), 1);
6291 let (update_msg, commitment_signed) = match events[0] {
6292 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
6293 (update_fee.as_ref(), commitment_signed)
6295 _ => panic!("Unexpected event"),
6298 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
6300 let mut chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6301 let channel_reserve = chan_stat.channel_reserve_msat;
6302 let feerate = get_feerate!(nodes[0], chan.2);
6304 // 2* and +1 HTLCs on the commit tx fee calculation for the fee spike reserve.
6305 let (payment_preimage_1, payment_hash_1, payment_secret_1) = get_payment_preimage_hash!(nodes[1]);
6307 let (_, payment_hash_2, payment_secret_2) = get_payment_preimage_hash!(nodes[1]);
6308 let amt_2 = 5000000 - channel_reserve - 2*commit_tx_fee_msat(feerate, 2 + 1) - amt_1;
6309 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6310 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();
6311 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();
6313 // Send 2 payments which pass reserve checks but get stuck in the holding cell.
6314 nodes[0].node.send_payment(&route_1, payment_hash_1, &Some(payment_secret_1)).unwrap();
6315 chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6316 assert_eq!(chan_stat.holding_cell_outbound_amount_msat, amt_1);
6317 nodes[0].node.send_payment(&route_2, payment_hash_2, &Some(payment_secret_2)).unwrap();
6318 chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6319 assert_eq!(chan_stat.holding_cell_outbound_amount_msat, amt_1 + amt_2);
6321 // Flush the pending fee update.
6322 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
6323 let (revoke_and_ack, commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6324 check_added_monitors!(nodes[1], 1);
6325 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_and_ack);
6326 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
6327 check_added_monitors!(nodes[0], 2);
6329 // Upon receipt of the RAA, there will be an attempt to resend the holding cell HTLCs,
6330 // but now that the fee has been raised the second payment will now fail, causing us
6331 // to surface its failure to the user. The first payment should succeed.
6332 chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6333 assert_eq!(chan_stat.holding_cell_outbound_amount_msat, 0);
6334 nodes[0].logger.assert_log("lightning::ln::channel".to_string(), "Freeing holding cell with 2 HTLC updates".to_string(), 1);
6335 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 ({})", log_bytes!(payment_hash_2.0), chan_stat.channel_reserve_msat);
6336 nodes[0].logger.assert_log("lightning::ln::channel".to_string(), failure_log.to_string(), 1);
6338 // Check that the second payment failed to be sent out.
6339 let events = nodes[0].node.get_and_clear_pending_events();
6340 assert_eq!(events.len(), 1);
6342 &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, ref error_code, ref error_data } => {
6343 assert_eq!(payment_hash_2.clone(), *payment_hash);
6344 assert_eq!(*rejected_by_dest, false);
6345 assert_eq!(*error_code, None);
6346 assert_eq!(*error_data, None);
6348 _ => panic!("Unexpected event"),
6351 // Complete the first payment and the RAA from the fee update.
6352 let (payment_event, send_raa_event) = {
6353 let mut msgs = nodes[0].node.get_and_clear_pending_msg_events();
6354 assert_eq!(msgs.len(), 2);
6355 (SendEvent::from_event(msgs.remove(0)), msgs.remove(0))
6357 let raa = match send_raa_event {
6358 MessageSendEvent::SendRevokeAndACK { msg, .. } => msg,
6359 _ => panic!("Unexpected event"),
6361 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &raa);
6362 check_added_monitors!(nodes[1], 1);
6363 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6364 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6365 let events = nodes[1].node.get_and_clear_pending_events();
6366 assert_eq!(events.len(), 1);
6368 Event::PendingHTLCsForwardable { .. } => {},
6369 _ => panic!("Unexpected event"),
6371 nodes[1].node.process_pending_htlc_forwards();
6372 let events = nodes[1].node.get_and_clear_pending_events();
6373 assert_eq!(events.len(), 1);
6375 Event::PaymentReceived { .. } => {},
6376 _ => panic!("Unexpected event"),
6378 nodes[1].node.claim_funds(payment_preimage_1);
6379 check_added_monitors!(nodes[1], 1);
6380 let update_msgs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6381 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_msgs.update_fulfill_htlcs[0]);
6382 commitment_signed_dance!(nodes[0], nodes[1], update_msgs.commitment_signed, false, true);
6383 let events = nodes[0].node.get_and_clear_pending_events();
6384 assert_eq!(events.len(), 1);
6386 Event::PaymentSent { ref payment_preimage } => {
6387 assert_eq!(*payment_preimage, payment_preimage_1);
6389 _ => panic!("Unexpected event"),
6393 // Test that if we fail to forward an HTLC that is being freed from the holding cell that the
6394 // HTLC is failed backwards. We trigger this failure to forward the freed HTLC by increasing
6395 // our fee while the HTLC is in the holding cell such that the HTLC is no longer affordable
6398 fn test_fail_holding_cell_htlc_upon_free_multihop() {
6399 let chanmon_cfgs = create_chanmon_cfgs(3);
6400 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
6401 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
6402 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
6403 let chan_0_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6404 let chan_1_2 = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6405 let logger = test_utils::TestLogger::new();
6407 // First nodes[1] generates an update_fee, setting the channel's
6408 // pending_update_fee.
6409 nodes[1].node.update_fee(chan_1_2.2, get_feerate!(nodes[1], chan_1_2.2) + 20).unwrap();
6410 check_added_monitors!(nodes[1], 1);
6412 let events = nodes[1].node.get_and_clear_pending_msg_events();
6413 assert_eq!(events.len(), 1);
6414 let (update_msg, commitment_signed) = match events[0] {
6415 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
6416 (update_fee.as_ref(), commitment_signed)
6418 _ => panic!("Unexpected event"),
6421 nodes[2].node.handle_update_fee(&nodes[1].node.get_our_node_id(), update_msg.unwrap());
6423 let mut chan_stat = get_channel_value_stat!(nodes[0], chan_0_1.2);
6424 let channel_reserve = chan_stat.channel_reserve_msat;
6425 let feerate = get_feerate!(nodes[0], chan_0_1.2);
6427 // Send a payment which passes reserve checks but gets stuck in the holding cell.
6429 let total_routing_fee_msat = (nodes.len() - 2) as u64 * feemsat;
6430 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[2]);
6431 let max_can_send = 5000000 - channel_reserve - 2*commit_tx_fee_msat(feerate, 1 + 1) - total_routing_fee_msat;
6432 let payment_event = {
6433 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6434 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();
6435 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6436 check_added_monitors!(nodes[0], 1);
6438 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
6439 assert_eq!(events.len(), 1);
6441 SendEvent::from_event(events.remove(0))
6443 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6444 check_added_monitors!(nodes[1], 0);
6445 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6446 expect_pending_htlcs_forwardable!(nodes[1]);
6448 chan_stat = get_channel_value_stat!(nodes[1], chan_1_2.2);
6449 assert_eq!(chan_stat.holding_cell_outbound_amount_msat, max_can_send);
6451 // Flush the pending fee update.
6452 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), commitment_signed);
6453 let (raa, commitment_signed) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
6454 check_added_monitors!(nodes[2], 1);
6455 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &raa);
6456 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &commitment_signed);
6457 check_added_monitors!(nodes[1], 2);
6459 // A final RAA message is generated to finalize the fee update.
6460 let events = nodes[1].node.get_and_clear_pending_msg_events();
6461 assert_eq!(events.len(), 1);
6463 let raa_msg = match &events[0] {
6464 &MessageSendEvent::SendRevokeAndACK { ref msg, .. } => {
6467 _ => panic!("Unexpected event"),
6470 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &raa_msg);
6471 check_added_monitors!(nodes[2], 1);
6472 assert!(nodes[2].node.get_and_clear_pending_msg_events().is_empty());
6474 // nodes[1]'s ChannelManager will now signal that we have HTLC forwards to process.
6475 let process_htlc_forwards_event = nodes[1].node.get_and_clear_pending_events();
6476 assert_eq!(process_htlc_forwards_event.len(), 1);
6477 match &process_htlc_forwards_event[0] {
6478 &Event::PendingHTLCsForwardable { .. } => {},
6479 _ => panic!("Unexpected event"),
6482 // In response, we call ChannelManager's process_pending_htlc_forwards
6483 nodes[1].node.process_pending_htlc_forwards();
6484 check_added_monitors!(nodes[1], 1);
6486 // This causes the HTLC to be failed backwards.
6487 let fail_event = nodes[1].node.get_and_clear_pending_msg_events();
6488 assert_eq!(fail_event.len(), 1);
6489 let (fail_msg, commitment_signed) = match &fail_event[0] {
6490 &MessageSendEvent::UpdateHTLCs { ref updates, .. } => {
6491 assert_eq!(updates.update_add_htlcs.len(), 0);
6492 assert_eq!(updates.update_fulfill_htlcs.len(), 0);
6493 assert_eq!(updates.update_fail_malformed_htlcs.len(), 0);
6494 assert_eq!(updates.update_fail_htlcs.len(), 1);
6495 (updates.update_fail_htlcs[0].clone(), updates.commitment_signed.clone())
6497 _ => panic!("Unexpected event"),
6500 // Pass the failure messages back to nodes[0].
6501 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
6502 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
6504 // Complete the HTLC failure+removal process.
6505 let (raa, commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6506 check_added_monitors!(nodes[0], 1);
6507 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &raa);
6508 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commitment_signed);
6509 check_added_monitors!(nodes[1], 2);
6510 let final_raa_event = nodes[1].node.get_and_clear_pending_msg_events();
6511 assert_eq!(final_raa_event.len(), 1);
6512 let raa = match &final_raa_event[0] {
6513 &MessageSendEvent::SendRevokeAndACK { ref msg, .. } => msg.clone(),
6514 _ => panic!("Unexpected event"),
6516 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &raa);
6517 let fail_msg_event = nodes[0].node.get_and_clear_pending_msg_events();
6518 assert_eq!(fail_msg_event.len(), 1);
6519 match &fail_msg_event[0] {
6520 &MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
6521 _ => panic!("Unexpected event"),
6523 let failure_event = nodes[0].node.get_and_clear_pending_events();
6524 assert_eq!(failure_event.len(), 1);
6525 match &failure_event[0] {
6526 &Event::PaymentFailed { rejected_by_dest, .. } => {
6527 assert!(!rejected_by_dest);
6529 _ => panic!("Unexpected event"),
6531 check_added_monitors!(nodes[0], 1);
6534 // BOLT 2 Requirements for the Sender when constructing and sending an update_add_htlc message.
6535 // 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.
6536 //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.
6539 fn test_update_add_htlc_bolt2_sender_value_below_minimum_msat() {
6540 //BOLT2 Requirement: MUST NOT offer amount_msat below the receiving node's htlc_minimum_msat (same validation check catches both of these)
6541 let chanmon_cfgs = create_chanmon_cfgs(2);
6542 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6543 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6544 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6545 let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6547 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6548 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6549 let logger = test_utils::TestLogger::new();
6550 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();
6551 route.paths[0][0].fee_msat = 100;
6553 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
6554 assert!(regex::Regex::new(r"Cannot send less than their minimum HTLC value \(\d+\)").unwrap().is_match(err)));
6555 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6556 nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot send less than their minimum HTLC value".to_string(), 1);
6560 fn test_update_add_htlc_bolt2_sender_zero_value_msat() {
6561 //BOLT2 Requirement: MUST offer amount_msat greater than 0.
6562 let chanmon_cfgs = create_chanmon_cfgs(2);
6563 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6564 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6565 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6566 let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6567 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6569 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6570 let logger = test_utils::TestLogger::new();
6571 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();
6572 route.paths[0][0].fee_msat = 0;
6573 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
6574 assert_eq!(err, "Cannot send 0-msat HTLC"));
6576 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6577 nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot send 0-msat HTLC".to_string(), 1);
6581 fn test_update_add_htlc_bolt2_receiver_zero_value_msat() {
6582 //BOLT2 Requirement: MUST offer amount_msat greater than 0.
6583 let chanmon_cfgs = create_chanmon_cfgs(2);
6584 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6585 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6586 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6587 let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6589 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6590 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6591 let logger = test_utils::TestLogger::new();
6592 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();
6593 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6594 check_added_monitors!(nodes[0], 1);
6595 let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6596 updates.update_add_htlcs[0].amount_msat = 0;
6598 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6599 nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Remote side tried to send a 0-msat HTLC".to_string(), 1);
6600 check_closed_broadcast!(nodes[1], true).unwrap();
6601 check_added_monitors!(nodes[1], 1);
6605 fn test_update_add_htlc_bolt2_sender_cltv_expiry_too_high() {
6606 //BOLT 2 Requirement: MUST set cltv_expiry less than 500000000.
6607 //It is enforced when constructing a route.
6608 let chanmon_cfgs = create_chanmon_cfgs(2);
6609 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6610 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6611 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6612 let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 0, InitFeatures::known(), InitFeatures::known());
6613 let logger = test_utils::TestLogger::new();
6615 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6617 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6618 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();
6619 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::RouteError { ref err },
6620 assert_eq!(err, &"Channel CLTV overflowed?"));
6624 fn test_update_add_htlc_bolt2_sender_exceed_max_htlc_num_and_htlc_id_increment() {
6625 //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.
6626 //BOLT 2 Requirement: for the first HTLC it offers MUST set id to 0.
6627 //BOLT 2 Requirement: MUST increase the value of id by 1 for each successive offer.
6628 let chanmon_cfgs = create_chanmon_cfgs(2);
6629 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6630 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6631 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6632 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 0, InitFeatures::known(), InitFeatures::known());
6633 let max_accepted_htlcs = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().counterparty_max_accepted_htlcs as u64;
6635 let logger = test_utils::TestLogger::new();
6636 for i in 0..max_accepted_htlcs {
6637 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6638 let payment_event = {
6639 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6640 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();
6641 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6642 check_added_monitors!(nodes[0], 1);
6644 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
6645 assert_eq!(events.len(), 1);
6646 if let MessageSendEvent::UpdateHTLCs { node_id: _, updates: msgs::CommitmentUpdate{ update_add_htlcs: ref htlcs, .. }, } = events[0] {
6647 assert_eq!(htlcs[0].htlc_id, i);
6651 SendEvent::from_event(events.remove(0))
6653 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6654 check_added_monitors!(nodes[1], 0);
6655 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6657 expect_pending_htlcs_forwardable!(nodes[1]);
6658 expect_payment_received!(nodes[1], our_payment_hash, our_payment_secret, 100000);
6660 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6661 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6662 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();
6663 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
6664 assert!(regex::Regex::new(r"Cannot push more than their max accepted HTLCs \(\d+\)").unwrap().is_match(err)));
6666 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6667 nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot push more than their max accepted HTLCs".to_string(), 1);
6671 fn test_update_add_htlc_bolt2_sender_exceed_max_htlc_value_in_flight() {
6672 //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.
6673 let chanmon_cfgs = create_chanmon_cfgs(2);
6674 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6675 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6676 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6677 let channel_value = 100000;
6678 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, channel_value, 0, InitFeatures::known(), InitFeatures::known());
6679 let max_in_flight = get_channel_value_stat!(nodes[0], chan.2).counterparty_max_htlc_value_in_flight_msat;
6681 send_payment(&nodes[0], &vec!(&nodes[1])[..], max_in_flight);
6683 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6684 // Manually create a route over our max in flight (which our router normally automatically
6686 let route = Route { paths: vec![vec![RouteHop {
6687 pubkey: nodes[1].node.get_our_node_id(), node_features: NodeFeatures::known(), channel_features: ChannelFeatures::known(),
6688 short_channel_id: nodes[1].node.list_usable_channels()[0].short_channel_id.unwrap(),
6689 fee_msat: max_in_flight + 1, cltv_expiry_delta: TEST_FINAL_CLTV
6691 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
6692 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)));
6694 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6695 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);
6697 send_payment(&nodes[0], &[&nodes[1]], max_in_flight);
6700 // BOLT 2 Requirements for the Receiver when handling an update_add_htlc message.
6702 fn test_update_add_htlc_bolt2_receiver_check_amount_received_more_than_min() {
6703 //BOLT2 Requirement: receiving an amount_msat equal to 0, OR less than its own htlc_minimum_msat -> 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 htlc_minimum_msat: u64;
6711 let chan_lock = nodes[0].node.channel_state.lock().unwrap();
6712 let channel = chan_lock.by_id.get(&chan.2).unwrap();
6713 htlc_minimum_msat = channel.get_holder_htlc_minimum_msat();
6716 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6717 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6718 let logger = test_utils::TestLogger::new();
6719 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();
6720 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6721 check_added_monitors!(nodes[0], 1);
6722 let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6723 updates.update_add_htlcs[0].amount_msat = htlc_minimum_msat-1;
6724 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6725 assert!(nodes[1].node.list_channels().is_empty());
6726 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6727 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()));
6728 check_added_monitors!(nodes[1], 1);
6732 fn test_update_add_htlc_bolt2_receiver_sender_can_afford_amount_sent() {
6733 //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
6734 let chanmon_cfgs = create_chanmon_cfgs(2);
6735 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6736 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6737 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6738 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6739 let logger = test_utils::TestLogger::new();
6741 let chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6742 let channel_reserve = chan_stat.channel_reserve_msat;
6743 let feerate = get_feerate!(nodes[0], chan.2);
6744 // The 2* and +1 are for the fee spike reserve.
6745 let commit_tx_fee_outbound = 2 * commit_tx_fee_msat(feerate, 1 + 1);
6747 let max_can_send = 5000000 - channel_reserve - commit_tx_fee_outbound;
6748 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6749 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6750 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();
6751 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6752 check_added_monitors!(nodes[0], 1);
6753 let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6755 // Even though channel-initiator senders are required to respect the fee_spike_reserve,
6756 // at this time channel-initiatee receivers are not required to enforce that senders
6757 // respect the fee_spike_reserve.
6758 updates.update_add_htlcs[0].amount_msat = max_can_send + commit_tx_fee_outbound + 1;
6759 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6761 assert!(nodes[1].node.list_channels().is_empty());
6762 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6763 assert_eq!(err_msg.data, "Remote HTLC add would put them under remote reserve value");
6764 check_added_monitors!(nodes[1], 1);
6768 fn test_update_add_htlc_bolt2_receiver_check_max_htlc_limit() {
6769 //BOLT 2 Requirement: if a sending node adds more than its max_accepted_htlcs HTLCs to its local commitment transaction: SHOULD fail the channel
6770 //BOLT 2 Requirement: MUST allow multiple HTLCs with the same payment_hash.
6771 let chanmon_cfgs = create_chanmon_cfgs(2);
6772 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6773 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6774 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6775 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6776 let logger = test_utils::TestLogger::new();
6778 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6779 let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
6781 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6782 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();
6784 let cur_height = nodes[0].node.best_block.read().unwrap().height() + 1;
6785 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::signing_only(), &route.paths[0], &session_priv).unwrap();
6786 let (onion_payloads, _htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 3999999, &Some(our_payment_secret), cur_height).unwrap();
6787 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &our_payment_hash);
6789 let mut msg = msgs::UpdateAddHTLC {
6793 payment_hash: our_payment_hash,
6794 cltv_expiry: htlc_cltv,
6795 onion_routing_packet: onion_packet.clone(),
6798 for i in 0..super::channel::OUR_MAX_HTLCS {
6799 msg.htlc_id = i as u64;
6800 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
6802 msg.htlc_id = (super::channel::OUR_MAX_HTLCS) as u64;
6803 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
6805 assert!(nodes[1].node.list_channels().is_empty());
6806 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6807 assert!(regex::Regex::new(r"Remote tried to push more than our max accepted HTLCs \(\d+\)").unwrap().is_match(err_msg.data.as_str()));
6808 check_added_monitors!(nodes[1], 1);
6812 fn test_update_add_htlc_bolt2_receiver_check_max_in_flight_msat() {
6813 //OR adds more than its max_htlc_value_in_flight_msat worth of offered HTLCs to its local commitment transaction: SHOULD fail the channel
6814 let chanmon_cfgs = create_chanmon_cfgs(2);
6815 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6816 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6817 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6818 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
6819 let logger = test_utils::TestLogger::new();
6821 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6822 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6823 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();
6824 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6825 check_added_monitors!(nodes[0], 1);
6826 let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6827 updates.update_add_htlcs[0].amount_msat = get_channel_value_stat!(nodes[1], chan.2).counterparty_max_htlc_value_in_flight_msat + 1;
6828 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6830 assert!(nodes[1].node.list_channels().is_empty());
6831 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6832 assert!(regex::Regex::new("Remote HTLC add would put them over our max HTLC value").unwrap().is_match(err_msg.data.as_str()));
6833 check_added_monitors!(nodes[1], 1);
6837 fn test_update_add_htlc_bolt2_receiver_check_cltv_expiry() {
6838 //BOLT2 Requirement: if sending node sets cltv_expiry to greater or equal to 500000000: SHOULD fail the channel.
6839 let chanmon_cfgs = create_chanmon_cfgs(2);
6840 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6841 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6842 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6843 let logger = test_utils::TestLogger::new();
6845 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6846 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6847 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6848 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();
6849 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6850 check_added_monitors!(nodes[0], 1);
6851 let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6852 updates.update_add_htlcs[0].cltv_expiry = 500000000;
6853 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6855 assert!(nodes[1].node.list_channels().is_empty());
6856 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6857 assert_eq!(err_msg.data,"Remote provided CLTV expiry in seconds instead of block height");
6858 check_added_monitors!(nodes[1], 1);
6862 fn test_update_add_htlc_bolt2_receiver_check_repeated_id_ignore() {
6863 //BOLT 2 requirement: if the sender did not previously acknowledge the commitment of that HTLC: MUST ignore a repeated id value after a reconnection.
6864 // We test this by first testing that that repeated HTLCs pass commitment signature checks
6865 // after disconnect and that non-sequential htlc_ids result in a channel failure.
6866 let chanmon_cfgs = create_chanmon_cfgs(2);
6867 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6868 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6869 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6870 let logger = test_utils::TestLogger::new();
6872 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6873 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6874 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6875 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();
6876 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6877 check_added_monitors!(nodes[0], 1);
6878 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6879 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6881 //Disconnect and Reconnect
6882 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
6883 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
6884 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
6885 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
6886 assert_eq!(reestablish_1.len(), 1);
6887 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
6888 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
6889 assert_eq!(reestablish_2.len(), 1);
6890 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
6891 handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
6892 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
6893 handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
6896 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6897 assert_eq!(updates.commitment_signed.htlc_signatures.len(), 1);
6898 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &updates.commitment_signed);
6899 check_added_monitors!(nodes[1], 1);
6900 let _bs_responses = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6902 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6904 assert!(nodes[1].node.list_channels().is_empty());
6905 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6906 assert!(regex::Regex::new(r"Remote skipped HTLC ID \(skipped ID: \d+\)").unwrap().is_match(err_msg.data.as_str()));
6907 check_added_monitors!(nodes[1], 1);
6911 fn test_update_fulfill_htlc_bolt2_update_fulfill_htlc_before_commitment() {
6912 //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.
6914 let chanmon_cfgs = create_chanmon_cfgs(2);
6915 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6916 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6917 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6918 let logger = test_utils::TestLogger::new();
6919 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6920 let (our_payment_preimage, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6921 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6922 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();
6923 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6925 check_added_monitors!(nodes[0], 1);
6926 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6927 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6929 let update_msg = msgs::UpdateFulfillHTLC{
6932 payment_preimage: our_payment_preimage,
6935 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6937 assert!(nodes[0].node.list_channels().is_empty());
6938 let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6939 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()));
6940 check_added_monitors!(nodes[0], 1);
6944 fn test_update_fulfill_htlc_bolt2_update_fail_htlc_before_commitment() {
6945 //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.
6947 let chanmon_cfgs = create_chanmon_cfgs(2);
6948 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6949 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6950 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6951 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6952 let logger = test_utils::TestLogger::new();
6954 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6955 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6956 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();
6957 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6958 check_added_monitors!(nodes[0], 1);
6959 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6960 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6962 let update_msg = msgs::UpdateFailHTLC{
6965 reason: msgs::OnionErrorPacket { data: Vec::new()},
6968 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6970 assert!(nodes[0].node.list_channels().is_empty());
6971 let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6972 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()));
6973 check_added_monitors!(nodes[0], 1);
6977 fn test_update_fulfill_htlc_bolt2_update_fail_malformed_htlc_before_commitment() {
6978 //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.
6980 let chanmon_cfgs = create_chanmon_cfgs(2);
6981 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6982 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6983 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6984 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6985 let logger = test_utils::TestLogger::new();
6987 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6988 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6989 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();
6990 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6991 check_added_monitors!(nodes[0], 1);
6992 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6993 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6994 let update_msg = msgs::UpdateFailMalformedHTLC{
6997 sha256_of_onion: [1; 32],
6998 failure_code: 0x8000,
7001 nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
7003 assert!(nodes[0].node.list_channels().is_empty());
7004 let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
7005 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()));
7006 check_added_monitors!(nodes[0], 1);
7010 fn test_update_fulfill_htlc_bolt2_incorrect_htlc_id() {
7011 //BOLT 2 Requirement: A receiving node: if the id does not correspond to an HTLC in its current commitment transaction MUST fail the channel.
7013 let chanmon_cfgs = create_chanmon_cfgs(2);
7014 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7015 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7016 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7017 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7019 let our_payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 100000).0;
7021 nodes[1].node.claim_funds(our_payment_preimage);
7022 check_added_monitors!(nodes[1], 1);
7024 let events = nodes[1].node.get_and_clear_pending_msg_events();
7025 assert_eq!(events.len(), 1);
7026 let mut update_fulfill_msg: msgs::UpdateFulfillHTLC = {
7028 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, .. } } => {
7029 assert!(update_add_htlcs.is_empty());
7030 assert_eq!(update_fulfill_htlcs.len(), 1);
7031 assert!(update_fail_htlcs.is_empty());
7032 assert!(update_fail_malformed_htlcs.is_empty());
7033 assert!(update_fee.is_none());
7034 update_fulfill_htlcs[0].clone()
7036 _ => panic!("Unexpected event"),
7040 update_fulfill_msg.htlc_id = 1;
7042 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_msg);
7044 assert!(nodes[0].node.list_channels().is_empty());
7045 let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
7046 assert_eq!(err_msg.data, "Remote tried to fulfill/fail an HTLC we couldn't find");
7047 check_added_monitors!(nodes[0], 1);
7051 fn test_update_fulfill_htlc_bolt2_wrong_preimage() {
7052 //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.
7054 let chanmon_cfgs = create_chanmon_cfgs(2);
7055 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7056 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7057 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7058 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7060 let our_payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 100000).0;
7062 nodes[1].node.claim_funds(our_payment_preimage);
7063 check_added_monitors!(nodes[1], 1);
7065 let events = nodes[1].node.get_and_clear_pending_msg_events();
7066 assert_eq!(events.len(), 1);
7067 let mut update_fulfill_msg: msgs::UpdateFulfillHTLC = {
7069 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, .. } } => {
7070 assert!(update_add_htlcs.is_empty());
7071 assert_eq!(update_fulfill_htlcs.len(), 1);
7072 assert!(update_fail_htlcs.is_empty());
7073 assert!(update_fail_malformed_htlcs.is_empty());
7074 assert!(update_fee.is_none());
7075 update_fulfill_htlcs[0].clone()
7077 _ => panic!("Unexpected event"),
7081 update_fulfill_msg.payment_preimage = PaymentPreimage([1; 32]);
7083 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_msg);
7085 assert!(nodes[0].node.list_channels().is_empty());
7086 let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
7087 assert!(regex::Regex::new(r"Remote tried to fulfill HTLC \(\d+\) with an incorrect preimage").unwrap().is_match(err_msg.data.as_str()));
7088 check_added_monitors!(nodes[0], 1);
7092 fn test_update_fulfill_htlc_bolt2_missing_badonion_bit_for_malformed_htlc_message() {
7093 //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.
7095 let chanmon_cfgs = create_chanmon_cfgs(2);
7096 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7097 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7098 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7099 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7100 let logger = test_utils::TestLogger::new();
7102 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
7103 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
7104 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();
7105 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
7106 check_added_monitors!(nodes[0], 1);
7108 let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
7109 updates.update_add_htlcs[0].onion_routing_packet.version = 1; //Produce a malformed HTLC message
7111 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
7112 check_added_monitors!(nodes[1], 0);
7113 commitment_signed_dance!(nodes[1], nodes[0], updates.commitment_signed, false, true);
7115 let events = nodes[1].node.get_and_clear_pending_msg_events();
7117 let mut update_msg: msgs::UpdateFailMalformedHTLC = {
7119 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, .. } } => {
7120 assert!(update_add_htlcs.is_empty());
7121 assert!(update_fulfill_htlcs.is_empty());
7122 assert!(update_fail_htlcs.is_empty());
7123 assert_eq!(update_fail_malformed_htlcs.len(), 1);
7124 assert!(update_fee.is_none());
7125 update_fail_malformed_htlcs[0].clone()
7127 _ => panic!("Unexpected event"),
7130 update_msg.failure_code &= !0x8000;
7131 nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
7133 assert!(nodes[0].node.list_channels().is_empty());
7134 let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
7135 assert_eq!(err_msg.data, "Got update_fail_malformed_htlc with BADONION not set");
7136 check_added_monitors!(nodes[0], 1);
7140 fn test_update_fulfill_htlc_bolt2_after_malformed_htlc_message_must_forward_update_fail_htlc() {
7141 //BOLT 2 Requirement: a receiving node which has an outgoing HTLC canceled by update_fail_malformed_htlc:
7142 // * 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.
7144 let chanmon_cfgs = create_chanmon_cfgs(3);
7145 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7146 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
7147 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7148 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7149 create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7150 let logger = test_utils::TestLogger::new();
7152 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[2]);
7155 let mut payment_event = {
7156 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
7157 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();
7158 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
7159 check_added_monitors!(nodes[0], 1);
7160 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
7161 assert_eq!(events.len(), 1);
7162 SendEvent::from_event(events.remove(0))
7164 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
7165 check_added_monitors!(nodes[1], 0);
7166 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
7167 expect_pending_htlcs_forwardable!(nodes[1]);
7168 let mut events_2 = nodes[1].node.get_and_clear_pending_msg_events();
7169 assert_eq!(events_2.len(), 1);
7170 check_added_monitors!(nodes[1], 1);
7171 payment_event = SendEvent::from_event(events_2.remove(0));
7172 assert_eq!(payment_event.msgs.len(), 1);
7175 payment_event.msgs[0].onion_routing_packet.version = 1; //Produce a malformed HTLC message
7176 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
7177 check_added_monitors!(nodes[2], 0);
7178 commitment_signed_dance!(nodes[2], nodes[1], payment_event.commitment_msg, false, true);
7180 let events_3 = nodes[2].node.get_and_clear_pending_msg_events();
7181 assert_eq!(events_3.len(), 1);
7182 let update_msg : (msgs::UpdateFailMalformedHTLC, msgs::CommitmentSigned) = {
7184 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 } } => {
7185 assert!(update_add_htlcs.is_empty());
7186 assert!(update_fulfill_htlcs.is_empty());
7187 assert!(update_fail_htlcs.is_empty());
7188 assert_eq!(update_fail_malformed_htlcs.len(), 1);
7189 assert!(update_fee.is_none());
7190 (update_fail_malformed_htlcs[0].clone(), commitment_signed.clone())
7192 _ => panic!("Unexpected event"),
7196 nodes[1].node.handle_update_fail_malformed_htlc(&nodes[2].node.get_our_node_id(), &update_msg.0);
7198 check_added_monitors!(nodes[1], 0);
7199 commitment_signed_dance!(nodes[1], nodes[2], update_msg.1, false, true);
7200 expect_pending_htlcs_forwardable!(nodes[1]);
7201 let events_4 = nodes[1].node.get_and_clear_pending_msg_events();
7202 assert_eq!(events_4.len(), 1);
7204 //Confirm that handlinge the update_malformed_htlc message produces an update_fail_htlc message to be forwarded back along the route
7206 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, .. } } => {
7207 assert!(update_add_htlcs.is_empty());
7208 assert!(update_fulfill_htlcs.is_empty());
7209 assert_eq!(update_fail_htlcs.len(), 1);
7210 assert!(update_fail_malformed_htlcs.is_empty());
7211 assert!(update_fee.is_none());
7213 _ => panic!("Unexpected event"),
7216 check_added_monitors!(nodes[1], 1);
7219 fn do_test_failure_delay_dust_htlc_local_commitment(announce_latest: bool) {
7220 // Dust-HTLC failure updates must be delayed until failure-trigger tx (in this case local commitment) reach ANTI_REORG_DELAY
7221 // 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
7222 // HTLC could have been removed from lastest local commitment tx but still valid until we get remote RAA
7224 let mut chanmon_cfgs = create_chanmon_cfgs(2);
7225 chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
7226 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7227 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7228 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7229 let chan =create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7231 let bs_dust_limit = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().holder_dust_limit_satoshis;
7233 // We route 2 dust-HTLCs between A and B
7234 let (_, payment_hash_1, _) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
7235 let (_, payment_hash_2, _) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
7236 route_payment(&nodes[0], &[&nodes[1]], 1000000);
7238 // Cache one local commitment tx as previous
7239 let as_prev_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
7241 // Fail one HTLC to prune it in the will-be-latest-local commitment tx
7242 assert!(nodes[1].node.fail_htlc_backwards(&payment_hash_2));
7243 check_added_monitors!(nodes[1], 0);
7244 expect_pending_htlcs_forwardable!(nodes[1]);
7245 check_added_monitors!(nodes[1], 1);
7247 let remove = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
7248 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &remove.update_fail_htlcs[0]);
7249 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &remove.commitment_signed);
7250 check_added_monitors!(nodes[0], 1);
7252 // Cache one local commitment tx as lastest
7253 let as_last_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
7255 let events = nodes[0].node.get_and_clear_pending_msg_events();
7257 MessageSendEvent::SendRevokeAndACK { node_id, .. } => {
7258 assert_eq!(node_id, nodes[1].node.get_our_node_id());
7260 _ => panic!("Unexpected event"),
7263 MessageSendEvent::UpdateHTLCs { node_id, .. } => {
7264 assert_eq!(node_id, nodes[1].node.get_our_node_id());
7266 _ => panic!("Unexpected event"),
7269 assert_ne!(as_prev_commitment_tx, as_last_commitment_tx);
7270 // Fail the 2 dust-HTLCs, move their failure in maturation buffer (htlc_updated_waiting_threshold_conf)
7271 if announce_latest {
7272 mine_transaction(&nodes[0], &as_last_commitment_tx[0]);
7274 mine_transaction(&nodes[0], &as_prev_commitment_tx[0]);
7277 check_closed_broadcast!(nodes[0], true);
7278 check_added_monitors!(nodes[0], 1);
7280 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7281 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7282 let events = nodes[0].node.get_and_clear_pending_events();
7283 // Only 2 PaymentFailed events should show up, over-dust HTLC has to be failed by timeout tx
7284 assert_eq!(events.len(), 2);
7285 let mut first_failed = false;
7286 for event in events {
7288 Event::PaymentFailed { payment_hash, .. } => {
7289 if payment_hash == payment_hash_1 {
7290 assert!(!first_failed);
7291 first_failed = true;
7293 assert_eq!(payment_hash, payment_hash_2);
7296 _ => panic!("Unexpected event"),
7302 fn test_failure_delay_dust_htlc_local_commitment() {
7303 do_test_failure_delay_dust_htlc_local_commitment(true);
7304 do_test_failure_delay_dust_htlc_local_commitment(false);
7307 fn do_test_sweep_outbound_htlc_failure_update(revoked: bool, local: bool) {
7308 // Outbound HTLC-failure updates must be cancelled if we get a reorg before we reach ANTI_REORG_DELAY.
7309 // Broadcast of revoked remote commitment tx, trigger failure-update of dust/non-dust HTLCs
7310 // Broadcast of remote commitment tx, trigger failure-update of dust-HTLCs
7311 // Broadcast of timeout tx on remote commitment tx, trigger failure-udate of non-dust HTLCs
7312 // Broadcast of local commitment tx, trigger failure-update of dust-HTLCs
7313 // Broadcast of HTLC-timeout tx on local commitment tx, trigger failure-update of non-dust HTLCs
7315 let chanmon_cfgs = create_chanmon_cfgs(3);
7316 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7317 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
7318 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7319 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7321 let bs_dust_limit = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().holder_dust_limit_satoshis;
7323 let (_payment_preimage_1, dust_hash, _payment_secret_1) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
7324 let (_payment_preimage_2, non_dust_hash, _payment_secret_2) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
7326 let as_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
7327 let bs_commitment_tx = get_local_commitment_txn!(nodes[1], chan.2);
7329 // We revoked bs_commitment_tx
7331 let (payment_preimage_3, _, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
7332 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_3);
7335 let mut timeout_tx = Vec::new();
7337 // We fail dust-HTLC 1 by broadcast of local commitment tx
7338 mine_transaction(&nodes[0], &as_commitment_tx[0]);
7339 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7340 expect_payment_failed!(nodes[0], dust_hash, true);
7342 connect_blocks(&nodes[0], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS - ANTI_REORG_DELAY);
7343 check_closed_broadcast!(nodes[0], true);
7344 check_added_monitors!(nodes[0], 1);
7345 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7346 timeout_tx.push(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[1].clone());
7347 assert_eq!(timeout_tx[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
7348 // We fail non-dust-HTLC 2 by broadcast of local HTLC-timeout tx on local commitment tx
7349 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7350 mine_transaction(&nodes[0], &timeout_tx[0]);
7351 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7352 expect_payment_failed!(nodes[0], non_dust_hash, true);
7354 // We fail dust-HTLC 1 by broadcast of remote commitment tx. If revoked, fail also non-dust HTLC
7355 mine_transaction(&nodes[0], &bs_commitment_tx[0]);
7356 check_closed_broadcast!(nodes[0], true);
7357 check_added_monitors!(nodes[0], 1);
7358 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7359 connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
7360 timeout_tx.push(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[1].clone());
7362 expect_payment_failed!(nodes[0], dust_hash, true);
7363 assert_eq!(timeout_tx[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
7364 // We fail non-dust-HTLC 2 by broadcast of local timeout tx on remote commitment tx
7365 mine_transaction(&nodes[0], &timeout_tx[0]);
7366 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7367 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7368 expect_payment_failed!(nodes[0], non_dust_hash, true);
7370 // If revoked, both dust & non-dust HTLCs should have been failed after ANTI_REORG_DELAY confs of revoked
7372 let events = nodes[0].node.get_and_clear_pending_events();
7373 assert_eq!(events.len(), 2);
7376 Event::PaymentFailed { payment_hash, .. } => {
7377 if payment_hash == dust_hash { first = true; }
7378 else { first = false; }
7380 _ => panic!("Unexpected event"),
7383 Event::PaymentFailed { payment_hash, .. } => {
7384 if first { assert_eq!(payment_hash, non_dust_hash); }
7385 else { assert_eq!(payment_hash, dust_hash); }
7387 _ => panic!("Unexpected event"),
7394 fn test_sweep_outbound_htlc_failure_update() {
7395 do_test_sweep_outbound_htlc_failure_update(false, true);
7396 do_test_sweep_outbound_htlc_failure_update(false, false);
7397 do_test_sweep_outbound_htlc_failure_update(true, false);
7401 fn test_upfront_shutdown_script() {
7402 // BOLT 2 : Option upfront shutdown script, if peer commit its closing_script at channel opening
7403 // enforce it at shutdown message
7405 let mut config = UserConfig::default();
7406 config.channel_options.announced_channel = true;
7407 config.peer_channel_config_limits.force_announced_channel_preference = false;
7408 config.channel_options.commit_upfront_shutdown_pubkey = false;
7409 let user_cfgs = [None, Some(config), None];
7410 let chanmon_cfgs = create_chanmon_cfgs(3);
7411 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7412 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
7413 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7415 // We test that in case of peer committing upfront to a script, if it changes at closing, we refuse to sign
7416 let flags = InitFeatures::known();
7417 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 1000000, 1000000, flags.clone(), flags.clone());
7418 nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7419 let mut node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[2].node.get_our_node_id());
7420 node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
7421 // Test we enforce upfront_scriptpbukey if by providing a diffrent one at closing that we disconnect peer
7422 nodes[2].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
7423 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()));
7424 check_added_monitors!(nodes[2], 1);
7426 // We test that in case of peer committing upfront to a script, if it doesn't change at closing, we sign
7427 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 1000000, 1000000, flags.clone(), flags.clone());
7428 nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7429 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[2].node.get_our_node_id());
7430 // We test that in case of peer committing upfront to a script, if it oesn't change at closing, we sign
7431 nodes[2].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
7432 let events = nodes[2].node.get_and_clear_pending_msg_events();
7433 assert_eq!(events.len(), 1);
7435 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[0].node.get_our_node_id()) }
7436 _ => panic!("Unexpected event"),
7439 // We test that if case of peer non-signaling we don't enforce committed script at channel opening
7440 let flags_no = InitFeatures::known().clear_upfront_shutdown_script();
7441 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, flags_no, flags.clone());
7442 nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7443 let mut node_1_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
7444 node_1_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
7445 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_1_shutdown);
7446 let events = nodes[1].node.get_and_clear_pending_msg_events();
7447 assert_eq!(events.len(), 1);
7449 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[0].node.get_our_node_id()) }
7450 _ => panic!("Unexpected event"),
7453 // We test that if user opt-out, we provide a zero-length script at channel opening and we are able to close
7454 // channel smoothly, opt-out is from channel initiator here
7455 let chan = create_announced_chan_between_nodes_with_value(&nodes, 1, 0, 1000000, 1000000, flags.clone(), flags.clone());
7456 nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7457 let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
7458 node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
7459 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
7460 let events = nodes[0].node.get_and_clear_pending_msg_events();
7461 assert_eq!(events.len(), 1);
7463 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7464 _ => panic!("Unexpected event"),
7467 //// We test that if user opt-out, we provide a zero-length script at channel opening and we are able to close
7468 //// channel smoothly
7469 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, flags.clone(), flags.clone());
7470 nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7471 let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
7472 node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
7473 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
7474 let events = nodes[0].node.get_and_clear_pending_msg_events();
7475 assert_eq!(events.len(), 2);
7477 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7478 _ => panic!("Unexpected event"),
7481 MessageSendEvent::SendClosingSigned { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7482 _ => panic!("Unexpected event"),
7487 fn test_upfront_shutdown_script_unsupport_segwit() {
7488 // We test that channel is closed early
7489 // if a segwit program is passed as upfront shutdown script,
7490 // but the peer does not support segwit.
7491 let chanmon_cfgs = create_chanmon_cfgs(2);
7492 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7493 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7494 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7496 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
7498 let mut open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
7499 open_channel.shutdown_scriptpubkey = Present(Builder::new().push_int(16)
7500 .push_slice(&[0, 0])
7503 let features = InitFeatures::known().clear_shutdown_anysegwit();
7504 nodes[0].node.handle_open_channel(&nodes[0].node.get_our_node_id(), features, &open_channel);
7506 let events = nodes[0].node.get_and_clear_pending_msg_events();
7507 assert_eq!(events.len(), 1);
7509 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
7510 assert_eq!(node_id, nodes[0].node.get_our_node_id());
7511 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));
7513 _ => panic!("Unexpected event"),
7518 fn test_shutdown_script_any_segwit_allowed() {
7519 let mut config = UserConfig::default();
7520 config.channel_options.announced_channel = true;
7521 config.peer_channel_config_limits.force_announced_channel_preference = false;
7522 config.channel_options.commit_upfront_shutdown_pubkey = false;
7523 let user_cfgs = [None, Some(config), None];
7524 let chanmon_cfgs = create_chanmon_cfgs(3);
7525 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7526 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
7527 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7529 //// We test if the remote peer accepts opt_shutdown_anysegwit, a witness program can be used on shutdown
7530 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7531 nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7532 let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
7533 node_0_shutdown.scriptpubkey = Builder::new().push_int(16)
7534 .push_slice(&[0, 0])
7536 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
7537 let events = nodes[0].node.get_and_clear_pending_msg_events();
7538 assert_eq!(events.len(), 2);
7540 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7541 _ => panic!("Unexpected event"),
7544 MessageSendEvent::SendClosingSigned { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7545 _ => panic!("Unexpected event"),
7550 fn test_shutdown_script_any_segwit_not_allowed() {
7551 let mut config = UserConfig::default();
7552 config.channel_options.announced_channel = true;
7553 config.peer_channel_config_limits.force_announced_channel_preference = false;
7554 config.channel_options.commit_upfront_shutdown_pubkey = false;
7555 let user_cfgs = [None, Some(config), None];
7556 let chanmon_cfgs = create_chanmon_cfgs(3);
7557 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7558 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
7559 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7561 //// We test that if the remote peer does not accept opt_shutdown_anysegwit, the witness program cannot be used on shutdown
7562 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7563 nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7564 let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
7565 // Make an any segwit version script
7566 node_0_shutdown.scriptpubkey = Builder::new().push_int(16)
7567 .push_slice(&[0, 0])
7569 let flags_no = InitFeatures::known().clear_shutdown_anysegwit();
7570 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &flags_no, &node_0_shutdown);
7571 let events = nodes[0].node.get_and_clear_pending_msg_events();
7572 assert_eq!(events.len(), 2);
7574 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
7575 assert_eq!(node_id, nodes[1].node.get_our_node_id());
7576 assert_eq!(msg.data, "Got a nonstandard scriptpubkey (60020000) from remote peer".to_owned())
7578 _ => panic!("Unexpected event"),
7580 check_added_monitors!(nodes[0], 1);
7584 fn test_shutdown_script_segwit_but_not_anysegwit() {
7585 let mut config = UserConfig::default();
7586 config.channel_options.announced_channel = true;
7587 config.peer_channel_config_limits.force_announced_channel_preference = false;
7588 config.channel_options.commit_upfront_shutdown_pubkey = false;
7589 let user_cfgs = [None, Some(config), None];
7590 let chanmon_cfgs = create_chanmon_cfgs(3);
7591 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7592 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
7593 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7595 //// We test that if shutdown any segwit is supported and we send a witness script with 0 version, this is not accepted
7596 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7597 nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7598 let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
7599 // Make a segwit script that is not a valid as any segwit
7600 node_0_shutdown.scriptpubkey = Builder::new().push_int(0)
7601 .push_slice(&[0, 0])
7603 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
7604 let events = nodes[0].node.get_and_clear_pending_msg_events();
7605 assert_eq!(events.len(), 2);
7607 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
7608 assert_eq!(node_id, nodes[1].node.get_our_node_id());
7609 assert_eq!(msg.data, "Got a nonstandard scriptpubkey (00020000) from remote peer".to_owned())
7611 _ => panic!("Unexpected event"),
7613 check_added_monitors!(nodes[0], 1);
7617 fn test_user_configurable_csv_delay() {
7618 // We test our channel constructors yield errors when we pass them absurd csv delay
7620 let mut low_our_to_self_config = UserConfig::default();
7621 low_our_to_self_config.own_channel_config.our_to_self_delay = 6;
7622 let mut high_their_to_self_config = UserConfig::default();
7623 high_their_to_self_config.peer_channel_config_limits.their_to_self_delay = 100;
7624 let user_cfgs = [Some(high_their_to_self_config.clone()), None];
7625 let chanmon_cfgs = create_chanmon_cfgs(2);
7626 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7627 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &user_cfgs);
7628 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7630 // We test config.our_to_self > BREAKDOWN_TIMEOUT is enforced in Channel::new_outbound()
7631 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) {
7633 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())); },
7634 _ => panic!("Unexpected event"),
7636 } else { assert!(false) }
7638 // We test config.our_to_self > BREAKDOWN_TIMEOUT is enforced in Channel::new_from_req()
7639 nodes[1].node.create_channel(nodes[0].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
7640 let mut open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
7641 open_channel.to_self_delay = 200;
7642 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) {
7644 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())); },
7645 _ => panic!("Unexpected event"),
7647 } else { assert!(false); }
7649 // We test msg.to_self_delay <= config.their_to_self_delay is enforced in Chanel::accept_channel()
7650 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
7651 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()));
7652 let mut accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
7653 accept_channel.to_self_delay = 200;
7654 nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &accept_channel);
7655 if let MessageSendEvent::HandleError { ref action, .. } = nodes[0].node.get_and_clear_pending_msg_events()[0] {
7657 &ErrorAction::SendErrorMessage { ref msg } => {
7658 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()));
7660 _ => { assert!(false); }
7662 } else { assert!(false); }
7664 // We test msg.to_self_delay <= config.their_to_self_delay is enforced in Channel::new_from_req()
7665 nodes[1].node.create_channel(nodes[0].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
7666 let mut open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
7667 open_channel.to_self_delay = 200;
7668 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) {
7670 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())); },
7671 _ => panic!("Unexpected event"),
7673 } else { assert!(false); }
7677 fn test_data_loss_protect() {
7678 // We want to be sure that :
7679 // * we don't broadcast our Local Commitment Tx in case of fallen behind
7680 // (but this is not quite true - we broadcast during Drop because chanmon is out of sync with chanmgr)
7681 // * we close channel in case of detecting other being fallen behind
7682 // * we are able to claim our own outputs thanks to to_remote being static
7683 // TODO: this test is incomplete and the data_loss_protect implementation is incomplete - see issue #775
7689 let mut chanmon_cfgs = create_chanmon_cfgs(2);
7690 // We broadcast during Drop because chanmon is out of sync with chanmgr, which would cause a panic
7691 // during signing due to revoked tx
7692 chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
7693 let keys_manager = &chanmon_cfgs[0].keys_manager;
7696 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7697 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7698 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7700 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7702 // Cache node A state before any channel update
7703 let previous_node_state = nodes[0].node.encode();
7704 let mut previous_chain_monitor_state = test_utils::TestVecWriter(Vec::new());
7705 nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut previous_chain_monitor_state).unwrap();
7707 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
7708 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
7710 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
7711 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
7713 // Restore node A from previous state
7714 logger = test_utils::TestLogger::with_id(format!("node {}", 0));
7715 let mut chain_monitor = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(&mut ::std::io::Cursor::new(previous_chain_monitor_state.0), keys_manager).unwrap().1;
7716 chain_source = test_utils::TestChainSource::new(Network::Testnet);
7717 tx_broadcaster = test_utils::TestBroadcaster{txn_broadcasted: Mutex::new(Vec::new()), blocks: Arc::new(Mutex::new(Vec::new()))};
7718 fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
7719 persister = test_utils::TestPersister::new();
7720 monitor = test_utils::TestChainMonitor::new(Some(&chain_source), &tx_broadcaster, &logger, &fee_estimator, &persister, keys_manager);
7722 let mut channel_monitors = HashMap::new();
7723 channel_monitors.insert(OutPoint { txid: chan.3.txid(), index: 0 }, &mut chain_monitor);
7724 <(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 {
7725 keys_manager: keys_manager,
7726 fee_estimator: &fee_estimator,
7727 chain_monitor: &monitor,
7729 tx_broadcaster: &tx_broadcaster,
7730 default_config: UserConfig::default(),
7734 nodes[0].node = &node_state_0;
7735 assert!(monitor.watch_channel(OutPoint { txid: chan.3.txid(), index: 0 }, chain_monitor).is_ok());
7736 nodes[0].chain_monitor = &monitor;
7737 nodes[0].chain_source = &chain_source;
7739 check_added_monitors!(nodes[0], 1);
7741 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7742 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7744 let reestablish_0 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
7746 // Check we don't broadcast any transactions following learning of per_commitment_point from B
7747 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_0[0]);
7748 check_added_monitors!(nodes[0], 1);
7751 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
7752 assert_eq!(node_txn.len(), 0);
7755 let mut reestablish_1 = Vec::with_capacity(1);
7756 for msg in nodes[0].node.get_and_clear_pending_msg_events() {
7757 if let MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } = msg {
7758 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
7759 reestablish_1.push(msg.clone());
7760 } else if let MessageSendEvent::BroadcastChannelUpdate { .. } = msg {
7761 } else if let MessageSendEvent::HandleError { ref action, .. } = msg {
7763 &ErrorAction::SendErrorMessage { ref msg } => {
7764 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");
7766 _ => panic!("Unexpected event!"),
7769 panic!("Unexpected event")
7773 // Check we close channel detecting A is fallen-behind
7774 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
7775 assert_eq!(check_closed_broadcast!(nodes[1], true).unwrap().data, "Peer attempted to reestablish channel with a very old local commitment transaction");
7776 check_added_monitors!(nodes[1], 1);
7779 // Check A is able to claim to_remote output
7780 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
7781 assert_eq!(node_txn.len(), 1);
7782 check_spends!(node_txn[0], chan.3);
7783 assert_eq!(node_txn[0].output.len(), 2);
7784 mine_transaction(&nodes[0], &node_txn[0]);
7785 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7786 let spend_txn = check_spendable_outputs!(nodes[0], 1, node_cfgs[0].keys_manager, 1000000);
7787 assert_eq!(spend_txn.len(), 1);
7788 check_spends!(spend_txn[0], node_txn[0]);
7792 fn test_check_htlc_underpaying() {
7793 // Send payment through A -> B but A is maliciously
7794 // sending a probe payment (i.e less than expected value0
7795 // to B, B should refuse payment.
7797 let chanmon_cfgs = create_chanmon_cfgs(2);
7798 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7799 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7800 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7802 // Create some initial channels
7803 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7805 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();
7806 let (_, our_payment_hash, _) = get_payment_preimage_hash!(nodes[0]);
7807 let our_payment_secret = nodes[1].node.create_inbound_payment_for_hash(our_payment_hash, Some(100_000), 7200, 0).unwrap();
7808 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
7809 check_added_monitors!(nodes[0], 1);
7811 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
7812 assert_eq!(events.len(), 1);
7813 let mut payment_event = SendEvent::from_event(events.pop().unwrap());
7814 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
7815 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
7817 // Note that we first have to wait a random delay before processing the receipt of the HTLC,
7818 // and then will wait a second random delay before failing the HTLC back:
7819 expect_pending_htlcs_forwardable!(nodes[1]);
7820 expect_pending_htlcs_forwardable!(nodes[1]);
7822 // Node 3 is expecting payment of 100_000 but received 10_000,
7823 // it should fail htlc like we didn't know the preimage.
7824 nodes[1].node.process_pending_htlc_forwards();
7826 let events = nodes[1].node.get_and_clear_pending_msg_events();
7827 assert_eq!(events.len(), 1);
7828 let (update_fail_htlc, commitment_signed) = match events[0] {
7829 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 } } => {
7830 assert!(update_add_htlcs.is_empty());
7831 assert!(update_fulfill_htlcs.is_empty());
7832 assert_eq!(update_fail_htlcs.len(), 1);
7833 assert!(update_fail_malformed_htlcs.is_empty());
7834 assert!(update_fee.is_none());
7835 (update_fail_htlcs[0].clone(), commitment_signed)
7837 _ => panic!("Unexpected event"),
7839 check_added_monitors!(nodes[1], 1);
7841 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlc);
7842 commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
7844 // 10_000 msat as u64, followed by a height of CHAN_CONFIRM_DEPTH as u32
7845 let mut expected_failure_data = byte_utils::be64_to_array(10_000).to_vec();
7846 expected_failure_data.extend_from_slice(&byte_utils::be32_to_array(CHAN_CONFIRM_DEPTH));
7847 expect_payment_failed!(nodes[0], our_payment_hash, true, 0x4000|15, &expected_failure_data[..]);
7851 fn test_announce_disable_channels() {
7852 // Create 2 channels between A and B. Disconnect B. Call timer_tick_occurred and check for generated
7853 // ChannelUpdate. Reconnect B, reestablish and check there is non-generated ChannelUpdate.
7855 let chanmon_cfgs = create_chanmon_cfgs(2);
7856 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7857 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7858 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7860 let short_id_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
7861 let short_id_2 = create_announced_chan_between_nodes(&nodes, 1, 0, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
7862 let short_id_3 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
7865 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
7866 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
7868 nodes[0].node.timer_tick_occurred(); // Enabled -> DisabledStaged
7869 nodes[0].node.timer_tick_occurred(); // DisabledStaged -> Disabled
7870 let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
7871 assert_eq!(msg_events.len(), 3);
7872 let mut chans_disabled: HashSet<u64> = [short_id_1, short_id_2, short_id_3].iter().map(|a| *a).collect();
7873 for e in msg_events {
7875 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
7876 assert_eq!(msg.contents.flags & (1<<1), 1<<1); // The "channel disabled" bit should be set
7877 // Check that each channel gets updated exactly once
7878 if !chans_disabled.remove(&msg.contents.short_channel_id) {
7879 panic!("Generated ChannelUpdate for wrong chan!");
7882 _ => panic!("Unexpected event"),
7886 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7887 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
7888 assert_eq!(reestablish_1.len(), 3);
7889 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7890 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
7891 assert_eq!(reestablish_2.len(), 3);
7893 // Reestablish chan_1
7894 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
7895 handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
7896 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
7897 handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
7898 // Reestablish chan_2
7899 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[1]);
7900 handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
7901 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[1]);
7902 handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
7903 // Reestablish chan_3
7904 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[2]);
7905 handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
7906 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[2]);
7907 handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
7909 nodes[0].node.timer_tick_occurred();
7910 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
7911 nodes[0].node.timer_tick_occurred();
7912 let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
7913 assert_eq!(msg_events.len(), 3);
7914 chans_disabled = [short_id_1, short_id_2, short_id_3].iter().map(|a| *a).collect();
7915 for e in msg_events {
7917 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
7918 assert_eq!(msg.contents.flags & (1<<1), 0); // The "channel disabled" bit should be off
7919 // Check that each channel gets updated exactly once
7920 if !chans_disabled.remove(&msg.contents.short_channel_id) {
7921 panic!("Generated ChannelUpdate for wrong chan!");
7924 _ => panic!("Unexpected event"),
7930 fn test_bump_penalty_txn_on_revoked_commitment() {
7931 // In case of penalty txn with too low feerates for getting into mempools, RBF-bump them to be sure
7932 // we're able to claim outputs on revoked commitment transaction before timelocks expiration
7934 let chanmon_cfgs = create_chanmon_cfgs(2);
7935 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7936 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7937 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7939 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
7940 let logger = test_utils::TestLogger::new();
7942 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
7943 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
7944 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();
7945 send_along_route(&nodes[1], route, &vec!(&nodes[0])[..], 3000000);
7947 let revoked_txn = get_local_commitment_txn!(nodes[0], chan.2);
7948 // Revoked commitment txn with 4 outputs : to_local, to_remote, 1 outgoing HTLC, 1 incoming HTLC
7949 assert_eq!(revoked_txn[0].output.len(), 4);
7950 assert_eq!(revoked_txn[0].input.len(), 1);
7951 assert_eq!(revoked_txn[0].input[0].previous_output.txid, chan.3.txid());
7952 let revoked_txid = revoked_txn[0].txid();
7954 let mut penalty_sum = 0;
7955 for outp in revoked_txn[0].output.iter() {
7956 if outp.script_pubkey.is_v0_p2wsh() {
7957 penalty_sum += outp.value;
7961 // Connect blocks to change height_timer range to see if we use right soonest_timelock
7962 let header_114 = connect_blocks(&nodes[1], 14);
7964 // Actually revoke tx by claiming a HTLC
7965 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
7966 let header = BlockHeader { version: 0x20000000, prev_blockhash: header_114, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7967 connect_block(&nodes[1], &Block { header, txdata: vec![revoked_txn[0].clone()] });
7968 check_added_monitors!(nodes[1], 1);
7970 // One or more justice tx should have been broadcast, check it
7974 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7975 assert_eq!(node_txn.len(), 2); // justice tx (broadcasted from ChannelMonitor) + local commitment tx
7976 assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
7977 assert_eq!(node_txn[0].output.len(), 1);
7978 check_spends!(node_txn[0], revoked_txn[0]);
7979 let fee_1 = penalty_sum - node_txn[0].output[0].value;
7980 feerate_1 = fee_1 * 1000 / node_txn[0].get_weight() as u64;
7981 penalty_1 = node_txn[0].txid();
7985 // After exhaustion of height timer, a new bumped justice tx should have been broadcast, check it
7986 connect_blocks(&nodes[1], 15);
7987 let mut penalty_2 = penalty_1;
7988 let mut feerate_2 = 0;
7990 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7991 assert_eq!(node_txn.len(), 1);
7992 if node_txn[0].input[0].previous_output.txid == revoked_txid {
7993 assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
7994 assert_eq!(node_txn[0].output.len(), 1);
7995 check_spends!(node_txn[0], revoked_txn[0]);
7996 penalty_2 = node_txn[0].txid();
7997 // Verify new bumped tx is different from last claiming transaction, we don't want spurrious rebroadcast
7998 assert_ne!(penalty_2, penalty_1);
7999 let fee_2 = penalty_sum - node_txn[0].output[0].value;
8000 feerate_2 = fee_2 * 1000 / node_txn[0].get_weight() as u64;
8001 // Verify 25% bump heuristic
8002 assert!(feerate_2 * 100 >= feerate_1 * 125);
8006 assert_ne!(feerate_2, 0);
8008 // After exhaustion of height timer for a 2nd time, a new bumped justice tx should have been broadcast, check it
8009 connect_blocks(&nodes[1], 1);
8011 let mut feerate_3 = 0;
8013 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8014 assert_eq!(node_txn.len(), 1);
8015 if node_txn[0].input[0].previous_output.txid == revoked_txid {
8016 assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
8017 assert_eq!(node_txn[0].output.len(), 1);
8018 check_spends!(node_txn[0], revoked_txn[0]);
8019 penalty_3 = node_txn[0].txid();
8020 // Verify new bumped tx is different from last claiming transaction, we don't want spurrious rebroadcast
8021 assert_ne!(penalty_3, penalty_2);
8022 let fee_3 = penalty_sum - node_txn[0].output[0].value;
8023 feerate_3 = fee_3 * 1000 / node_txn[0].get_weight() as u64;
8024 // Verify 25% bump heuristic
8025 assert!(feerate_3 * 100 >= feerate_2 * 125);
8029 assert_ne!(feerate_3, 0);
8031 nodes[1].node.get_and_clear_pending_events();
8032 nodes[1].node.get_and_clear_pending_msg_events();
8036 fn test_bump_penalty_txn_on_revoked_htlcs() {
8037 // In case of penalty txn with too low feerates for getting into mempools, RBF-bump them to sure
8038 // we're able to claim outputs on revoked HTLC transactions before timelocks expiration
8040 let mut chanmon_cfgs = create_chanmon_cfgs(2);
8041 chanmon_cfgs[1].keys_manager.disable_revocation_policy_check = true;
8042 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8043 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8044 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8046 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
8047 // Lock HTLC in both directions (using a slightly lower CLTV delay to provide timely RBF bumps)
8048 let route = get_route(&nodes[0].node.get_our_node_id(), &nodes[0].net_graph_msg_handler.network_graph.read().unwrap(),
8049 &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 3_000_000, 50, nodes[0].logger).unwrap();
8050 let payment_preimage = send_along_route(&nodes[0], route, &[&nodes[1]], 3_000_000).0;
8051 let route = get_route(&nodes[1].node.get_our_node_id(), &nodes[1].net_graph_msg_handler.network_graph.read().unwrap(),
8052 &nodes[0].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 3_000_000, 50, nodes[0].logger).unwrap();
8053 send_along_route(&nodes[1], route, &[&nodes[0]], 3_000_000);
8055 let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan.2);
8056 assert_eq!(revoked_local_txn[0].input.len(), 1);
8057 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
8059 // Revoke local commitment tx
8060 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
8062 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8063 // B will generate both revoked HTLC-timeout/HTLC-preimage txn from revoked commitment tx
8064 connect_block(&nodes[1], &Block { header, txdata: vec![revoked_local_txn[0].clone()] });
8065 check_closed_broadcast!(nodes[1], true);
8066 check_added_monitors!(nodes[1], 1);
8067 connect_blocks(&nodes[1], 49); // Confirm blocks until the HTLC expires (note CLTV was explicitly 50 above)
8069 let revoked_htlc_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8070 assert_eq!(revoked_htlc_txn.len(), 3);
8071 check_spends!(revoked_htlc_txn[1], chan.3);
8073 assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
8074 assert_eq!(revoked_htlc_txn[0].input.len(), 1);
8075 check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
8077 assert_eq!(revoked_htlc_txn[2].input.len(), 1);
8078 assert_eq!(revoked_htlc_txn[2].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
8079 assert_eq!(revoked_htlc_txn[2].output.len(), 1);
8080 check_spends!(revoked_htlc_txn[2], revoked_local_txn[0]);
8082 // Broadcast set of revoked txn on A
8083 let hash_128 = connect_blocks(&nodes[0], 40);
8084 let header_11 = BlockHeader { version: 0x20000000, prev_blockhash: hash_128, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8085 connect_block(&nodes[0], &Block { header: header_11, txdata: vec![revoked_local_txn[0].clone()] });
8086 let header_129 = BlockHeader { version: 0x20000000, prev_blockhash: header_11.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8087 connect_block(&nodes[0], &Block { header: header_129, txdata: vec![revoked_htlc_txn[0].clone(), revoked_htlc_txn[2].clone()] });
8088 expect_pending_htlcs_forwardable_ignore!(nodes[0]);
8093 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8094 assert_eq!(node_txn.len(), 5); // 3 penalty txn on revoked commitment tx + A commitment tx + 1 penalty tnx on revoked HTLC txn
8095 // Verify claim tx are spending revoked HTLC txn
8097 // node_txn 0-2 each spend a separate revoked output from revoked_local_txn[0]
8098 // Note that node_txn[0] and node_txn[1] are bogus - they double spend the revoked_htlc_txn
8099 // which are included in the same block (they are broadcasted because we scan the
8100 // transactions linearly and generate claims as we go, they likely should be removed in the
8102 assert_eq!(node_txn[0].input.len(), 1);
8103 check_spends!(node_txn[0], revoked_local_txn[0]);
8104 assert_eq!(node_txn[1].input.len(), 1);
8105 check_spends!(node_txn[1], revoked_local_txn[0]);
8106 assert_eq!(node_txn[2].input.len(), 1);
8107 check_spends!(node_txn[2], revoked_local_txn[0]);
8109 // Each of the three justice transactions claim a separate (single) output of the three
8110 // available, which we check here:
8111 assert_ne!(node_txn[0].input[0].previous_output, node_txn[1].input[0].previous_output);
8112 assert_ne!(node_txn[0].input[0].previous_output, node_txn[2].input[0].previous_output);
8113 assert_ne!(node_txn[1].input[0].previous_output, node_txn[2].input[0].previous_output);
8115 assert_eq!(node_txn[0].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
8116 assert_eq!(node_txn[1].input[0].previous_output, revoked_htlc_txn[2].input[0].previous_output);
8118 // node_txn[3] is the local commitment tx broadcast just because (and somewhat in case of
8119 // reorgs, though its not clear its ever worth broadcasting conflicting txn like this when
8120 // a remote commitment tx has already been confirmed).
8121 check_spends!(node_txn[3], chan.3);
8123 // node_txn[4] spends the revoked outputs from the revoked_htlc_txn (which only have one
8124 // output, checked above).
8125 assert_eq!(node_txn[4].input.len(), 2);
8126 assert_eq!(node_txn[4].output.len(), 1);
8127 check_spends!(node_txn[4], revoked_htlc_txn[0], revoked_htlc_txn[2]);
8129 first = node_txn[4].txid();
8130 // Store both feerates for later comparison
8131 let fee_1 = revoked_htlc_txn[0].output[0].value + revoked_htlc_txn[2].output[0].value - node_txn[4].output[0].value;
8132 feerate_1 = fee_1 * 1000 / node_txn[4].get_weight() as u64;
8133 penalty_txn = vec![node_txn[2].clone()];
8137 // Connect one more block to see if bumped penalty are issued for HTLC txn
8138 let header_130 = BlockHeader { version: 0x20000000, prev_blockhash: header_129.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8139 connect_block(&nodes[0], &Block { header: header_130, txdata: penalty_txn });
8140 let header_131 = BlockHeader { version: 0x20000000, prev_blockhash: header_130.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8141 connect_block(&nodes[0], &Block { header: header_131, txdata: Vec::new() });
8143 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8144 assert_eq!(node_txn.len(), 2); // 2 bumped penalty txn on revoked commitment tx
8146 check_spends!(node_txn[0], revoked_local_txn[0]);
8147 check_spends!(node_txn[1], revoked_local_txn[0]);
8148 // Note that these are both bogus - they spend outputs already claimed in block 129:
8149 if node_txn[0].input[0].previous_output == revoked_htlc_txn[0].input[0].previous_output {
8150 assert_eq!(node_txn[1].input[0].previous_output, revoked_htlc_txn[2].input[0].previous_output);
8152 assert_eq!(node_txn[0].input[0].previous_output, revoked_htlc_txn[2].input[0].previous_output);
8153 assert_eq!(node_txn[1].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
8159 // Few more blocks to confirm penalty txn
8160 connect_blocks(&nodes[0], 4);
8161 assert!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
8162 let header_144 = connect_blocks(&nodes[0], 9);
8164 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8165 assert_eq!(node_txn.len(), 1);
8167 assert_eq!(node_txn[0].input.len(), 2);
8168 check_spends!(node_txn[0], revoked_htlc_txn[0], revoked_htlc_txn[2]);
8169 // Verify bumped tx is different and 25% bump heuristic
8170 assert_ne!(first, node_txn[0].txid());
8171 let fee_2 = revoked_htlc_txn[0].output[0].value + revoked_htlc_txn[2].output[0].value - node_txn[0].output[0].value;
8172 let feerate_2 = fee_2 * 1000 / node_txn[0].get_weight() as u64;
8173 assert!(feerate_2 * 100 > feerate_1 * 125);
8174 let txn = vec![node_txn[0].clone()];
8178 // Broadcast claim txn and confirm blocks to avoid further bumps on this outputs
8179 let header_145 = BlockHeader { version: 0x20000000, prev_blockhash: header_144, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8180 connect_block(&nodes[0], &Block { header: header_145, txdata: node_txn });
8181 connect_blocks(&nodes[0], 20);
8183 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8184 // We verify than no new transaction has been broadcast because previously
8185 // we were buggy on this exact behavior by not tracking for monitoring remote HTLC outputs (see #411)
8186 // which means we wouldn't see a spend of them by a justice tx and bumped justice tx
8187 // were generated forever instead of safe cleaning after confirmation and ANTI_REORG_SAFE_DELAY blocks.
8188 // Enforce spending of revoked htlc output by claiming transaction remove request as expected and dry
8189 // up bumped justice generation.
8190 assert_eq!(node_txn.len(), 0);
8193 check_closed_broadcast!(nodes[0], true);
8194 check_added_monitors!(nodes[0], 1);
8198 fn test_bump_penalty_txn_on_remote_commitment() {
8199 // In case of claim txn with too low feerates for getting into mempools, RBF-bump them to be sure
8200 // we're able to claim outputs on remote commitment transaction before timelocks expiration
8203 // Provide preimage for one
8204 // Check aggregation
8206 let chanmon_cfgs = create_chanmon_cfgs(2);
8207 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8208 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8209 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8211 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
8212 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
8213 route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000).0;
8215 // Remote commitment txn with 4 outputs : to_local, to_remote, 1 outgoing HTLC, 1 incoming HTLC
8216 let remote_txn = get_local_commitment_txn!(nodes[0], chan.2);
8217 assert_eq!(remote_txn[0].output.len(), 4);
8218 assert_eq!(remote_txn[0].input.len(), 1);
8219 assert_eq!(remote_txn[0].input[0].previous_output.txid, chan.3.txid());
8221 // Claim a HTLC without revocation (provide B monitor with preimage)
8222 nodes[1].node.claim_funds(payment_preimage);
8223 mine_transaction(&nodes[1], &remote_txn[0]);
8224 check_added_monitors!(nodes[1], 2);
8225 connect_blocks(&nodes[1], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
8227 // One or more claim tx should have been broadcast, check it
8231 let feerate_timeout;
8232 let feerate_preimage;
8234 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8235 // 9 transactions including:
8236 // 1*2 ChannelManager local broadcasts of commitment + HTLC-Success
8237 // 1*3 ChannelManager local broadcasts of commitment + HTLC-Success + HTLC-Timeout
8238 // 2 * HTLC-Success (one RBF bump we'll check later)
8240 assert_eq!(node_txn.len(), 8);
8241 assert_eq!(node_txn[0].input.len(), 1);
8242 assert_eq!(node_txn[6].input.len(), 1);
8243 check_spends!(node_txn[0], remote_txn[0]);
8244 check_spends!(node_txn[6], remote_txn[0]);
8245 assert_eq!(node_txn[0].input[0].previous_output, node_txn[3].input[0].previous_output);
8246 preimage_bump = node_txn[3].clone();
8248 check_spends!(node_txn[1], chan.3);
8249 check_spends!(node_txn[2], node_txn[1]);
8250 assert_eq!(node_txn[1], node_txn[4]);
8251 assert_eq!(node_txn[2], node_txn[5]);
8253 timeout = node_txn[6].txid();
8254 let index = node_txn[6].input[0].previous_output.vout;
8255 let fee = remote_txn[0].output[index as usize].value - node_txn[6].output[0].value;
8256 feerate_timeout = fee * 1000 / node_txn[6].get_weight() as u64;
8258 preimage = node_txn[0].txid();
8259 let index = node_txn[0].input[0].previous_output.vout;
8260 let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
8261 feerate_preimage = fee * 1000 / node_txn[0].get_weight() as u64;
8265 assert_ne!(feerate_timeout, 0);
8266 assert_ne!(feerate_preimage, 0);
8268 // After exhaustion of height timer, new bumped claim txn should have been broadcast, check it
8269 connect_blocks(&nodes[1], 15);
8271 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8272 assert_eq!(node_txn.len(), 1);
8273 assert_eq!(node_txn[0].input.len(), 1);
8274 assert_eq!(preimage_bump.input.len(), 1);
8275 check_spends!(node_txn[0], remote_txn[0]);
8276 check_spends!(preimage_bump, remote_txn[0]);
8278 let index = preimage_bump.input[0].previous_output.vout;
8279 let fee = remote_txn[0].output[index as usize].value - preimage_bump.output[0].value;
8280 let new_feerate = fee * 1000 / preimage_bump.get_weight() as u64;
8281 assert!(new_feerate * 100 > feerate_timeout * 125);
8282 assert_ne!(timeout, preimage_bump.txid());
8284 let index = node_txn[0].input[0].previous_output.vout;
8285 let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
8286 let new_feerate = fee * 1000 / node_txn[0].get_weight() as u64;
8287 assert!(new_feerate * 100 > feerate_preimage * 125);
8288 assert_ne!(preimage, node_txn[0].txid());
8293 nodes[1].node.get_and_clear_pending_events();
8294 nodes[1].node.get_and_clear_pending_msg_events();
8298 fn test_counterparty_raa_skip_no_crash() {
8299 // Previously, if our counterparty sent two RAAs in a row without us having provided a
8300 // commitment transaction, we would have happily carried on and provided them the next
8301 // commitment transaction based on one RAA forward. This would probably eventually have led to
8302 // channel closure, but it would not have resulted in funds loss. Still, our
8303 // EnforcingSigner would have paniced as it doesn't like jumps into the future. Here, we
8304 // check simply that the channel is closed in response to such an RAA, but don't check whether
8305 // we decide to punish our counterparty for revoking their funds (as we don't currently
8307 let chanmon_cfgs = create_chanmon_cfgs(2);
8308 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8309 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8310 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8311 let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).2;
8313 let mut guard = nodes[0].node.channel_state.lock().unwrap();
8314 let keys = &guard.by_id.get_mut(&channel_id).unwrap().get_signer();
8315 const INITIAL_COMMITMENT_NUMBER: u64 = (1 << 48) - 1;
8316 let per_commitment_secret = keys.release_commitment_secret(INITIAL_COMMITMENT_NUMBER);
8317 // Must revoke without gaps
8318 keys.release_commitment_secret(INITIAL_COMMITMENT_NUMBER - 1);
8319 let next_per_commitment_point = PublicKey::from_secret_key(&Secp256k1::new(),
8320 &SecretKey::from_slice(&keys.release_commitment_secret(INITIAL_COMMITMENT_NUMBER - 2)).unwrap());
8322 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(),
8323 &msgs::RevokeAndACK { channel_id, per_commitment_secret, next_per_commitment_point });
8324 assert_eq!(check_closed_broadcast!(nodes[1], true).unwrap().data, "Received an unexpected revoke_and_ack");
8325 check_added_monitors!(nodes[1], 1);
8329 fn test_bump_txn_sanitize_tracking_maps() {
8330 // Sanitizing pendning_claim_request and claimable_outpoints used to be buggy,
8331 // verify we clean then right after expiration of ANTI_REORG_DELAY.
8333 let chanmon_cfgs = create_chanmon_cfgs(2);
8334 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8335 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8336 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8338 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
8339 // Lock HTLC in both directions
8340 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000).0;
8341 route_payment(&nodes[1], &vec!(&nodes[0])[..], 9_000_000).0;
8343 let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan.2);
8344 assert_eq!(revoked_local_txn[0].input.len(), 1);
8345 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
8347 // Revoke local commitment tx
8348 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
8350 // Broadcast set of revoked txn on A
8351 connect_blocks(&nodes[0], TEST_FINAL_CLTV + 2 - CHAN_CONFIRM_DEPTH);
8352 expect_pending_htlcs_forwardable_ignore!(nodes[0]);
8353 assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 0);
8355 mine_transaction(&nodes[0], &revoked_local_txn[0]);
8356 check_closed_broadcast!(nodes[0], true);
8357 check_added_monitors!(nodes[0], 1);
8359 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8360 assert_eq!(node_txn.len(), 4); //ChannelMonitor: justice txn * 3, ChannelManager: local commitment tx
8361 check_spends!(node_txn[0], revoked_local_txn[0]);
8362 check_spends!(node_txn[1], revoked_local_txn[0]);
8363 check_spends!(node_txn[2], revoked_local_txn[0]);
8364 let penalty_txn = vec![node_txn[0].clone(), node_txn[1].clone(), node_txn[2].clone()];
8368 let header_130 = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8369 connect_block(&nodes[0], &Block { header: header_130, txdata: penalty_txn });
8370 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
8372 let monitors = nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap();
8373 if let Some(monitor) = monitors.get(&OutPoint { txid: chan.3.txid(), index: 0 }) {
8374 assert!(monitor.inner.lock().unwrap().onchain_tx_handler.pending_claim_requests.is_empty());
8375 assert!(monitor.inner.lock().unwrap().onchain_tx_handler.claimable_outpoints.is_empty());
8381 fn test_override_channel_config() {
8382 let chanmon_cfgs = create_chanmon_cfgs(2);
8383 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8384 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8385 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8387 // Node0 initiates a channel to node1 using the override config.
8388 let mut override_config = UserConfig::default();
8389 override_config.own_channel_config.our_to_self_delay = 200;
8391 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 16_000_000, 12_000_000, 42, Some(override_config)).unwrap();
8393 // Assert the channel created by node0 is using the override config.
8394 let res = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8395 assert_eq!(res.channel_flags, 0);
8396 assert_eq!(res.to_self_delay, 200);
8400 fn test_override_0msat_htlc_minimum() {
8401 let mut zero_config = UserConfig::default();
8402 zero_config.own_channel_config.our_htlc_minimum_msat = 0;
8403 let chanmon_cfgs = create_chanmon_cfgs(2);
8404 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8405 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, Some(zero_config.clone())]);
8406 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8408 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 16_000_000, 12_000_000, 42, Some(zero_config)).unwrap();
8409 let res = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8410 assert_eq!(res.htlc_minimum_msat, 1);
8412 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &res);
8413 let res = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
8414 assert_eq!(res.htlc_minimum_msat, 1);
8418 fn test_simple_mpp() {
8419 // Simple test of sending a multi-path payment.
8420 let chanmon_cfgs = create_chanmon_cfgs(4);
8421 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
8422 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
8423 let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
8425 let chan_1_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8426 let chan_2_id = create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8427 let chan_3_id = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8428 let chan_4_id = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8429 let logger = test_utils::TestLogger::new();
8431 let (payment_preimage, payment_hash, payment_secret) = get_payment_preimage_hash!(&nodes[3]);
8432 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
8433 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();
8434 let path = route.paths[0].clone();
8435 route.paths.push(path);
8436 route.paths[0][0].pubkey = nodes[1].node.get_our_node_id();
8437 route.paths[0][0].short_channel_id = chan_1_id;
8438 route.paths[0][1].short_channel_id = chan_3_id;
8439 route.paths[1][0].pubkey = nodes[2].node.get_our_node_id();
8440 route.paths[1][0].short_channel_id = chan_2_id;
8441 route.paths[1][1].short_channel_id = chan_4_id;
8442 send_along_route_with_secret(&nodes[0], route, &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], 200_000, payment_hash, payment_secret);
8443 claim_payment_along_route(&nodes[0], &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], false, payment_preimage);
8447 fn test_preimage_storage() {
8448 // Simple test of payment preimage storage allowing no client-side storage to claim payments
8449 let chanmon_cfgs = create_chanmon_cfgs(2);
8450 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8451 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8452 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8454 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8457 let (payment_hash, payment_secret) = nodes[1].node.create_inbound_payment(Some(100_000), 7200, 42);
8459 let logger = test_utils::TestLogger::new();
8460 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
8461 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();
8462 nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
8463 check_added_monitors!(nodes[0], 1);
8464 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
8465 let mut payment_event = SendEvent::from_event(events.pop().unwrap());
8466 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
8467 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
8469 // Note that after leaving the above scope we have no knowledge of any arguments or return
8470 // values from previous calls.
8471 expect_pending_htlcs_forwardable!(nodes[1]);
8472 let events = nodes[1].node.get_and_clear_pending_events();
8473 assert_eq!(events.len(), 1);
8475 Event::PaymentReceived { payment_preimage, user_payment_id, .. } => {
8476 assert_eq!(user_payment_id, 42);
8477 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage.unwrap());
8479 _ => panic!("Unexpected event"),
8484 fn test_secret_timeout() {
8485 // Simple test of payment secret storage time outs
8486 let chanmon_cfgs = create_chanmon_cfgs(2);
8487 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8488 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8489 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8491 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8493 let (payment_hash, payment_secret_1) = nodes[1].node.create_inbound_payment(Some(100_000), 2, 0);
8495 // We should fail to register the same payment hash twice, at least until we've connected a
8496 // block with time 7200 + CHAN_CONFIRM_DEPTH + 1.
8497 if let Err(APIError::APIMisuseError { err }) = nodes[1].node.create_inbound_payment_for_hash(payment_hash, Some(100_000), 2, 0) {
8498 assert_eq!(err, "Duplicate payment hash");
8499 } else { panic!(); }
8501 let node_1_blocks = nodes[1].blocks.lock().unwrap();
8503 header: BlockHeader {
8505 prev_blockhash: node_1_blocks.last().unwrap().0.block_hash(),
8506 merkle_root: Default::default(),
8507 time: node_1_blocks.len() as u32 + 7200, bits: 42, nonce: 42 },
8511 connect_block(&nodes[1], &block);
8512 if let Err(APIError::APIMisuseError { err }) = nodes[1].node.create_inbound_payment_for_hash(payment_hash, Some(100_000), 2, 0) {
8513 assert_eq!(err, "Duplicate payment hash");
8514 } else { panic!(); }
8516 // If we then connect the second block, we should be able to register the same payment hash
8517 // again with a different user_payment_id (this time getting a new payment secret).
8518 block.header.prev_blockhash = block.header.block_hash();
8519 block.header.time += 1;
8520 connect_block(&nodes[1], &block);
8521 let our_payment_secret = nodes[1].node.create_inbound_payment_for_hash(payment_hash, Some(100_000), 2, 42).unwrap();
8522 assert_ne!(payment_secret_1, our_payment_secret);
8525 let logger = test_utils::TestLogger::new();
8526 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
8527 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();
8528 nodes[0].node.send_payment(&route, payment_hash, &Some(our_payment_secret)).unwrap();
8529 check_added_monitors!(nodes[0], 1);
8530 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
8531 let mut payment_event = SendEvent::from_event(events.pop().unwrap());
8532 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
8533 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
8535 // Note that after leaving the above scope we have no knowledge of any arguments or return
8536 // values from previous calls.
8537 expect_pending_htlcs_forwardable!(nodes[1]);
8538 let events = nodes[1].node.get_and_clear_pending_events();
8539 assert_eq!(events.len(), 1);
8541 Event::PaymentReceived { payment_preimage, payment_secret, user_payment_id, .. } => {
8542 assert!(payment_preimage.is_none());
8543 assert_eq!(user_payment_id, 42);
8544 assert_eq!(payment_secret, our_payment_secret);
8545 // We don't actually have the payment preimage with which to claim this payment!
8547 _ => panic!("Unexpected event"),
8552 fn test_bad_secret_hash() {
8553 // Simple test of unregistered payment hash/invalid payment secret handling
8554 let chanmon_cfgs = create_chanmon_cfgs(2);
8555 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8556 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8557 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8559 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8561 let random_payment_hash = PaymentHash([42; 32]);
8562 let random_payment_secret = PaymentSecret([43; 32]);
8563 let (our_payment_hash, our_payment_secret) = nodes[1].node.create_inbound_payment(Some(100_000), 2, 0);
8565 let logger = test_utils::TestLogger::new();
8566 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
8567 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();
8569 // All the below cases should end up being handled exactly identically, so we macro the
8570 // resulting events.
8571 macro_rules! handle_unknown_invalid_payment_data {
8573 check_added_monitors!(nodes[0], 1);
8574 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
8575 let payment_event = SendEvent::from_event(events.pop().unwrap());
8576 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
8577 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
8579 // We have to forward pending HTLCs once to process the receipt of the HTLC and then
8580 // again to process the pending backwards-failure of the HTLC
8581 expect_pending_htlcs_forwardable!(nodes[1]);
8582 expect_pending_htlcs_forwardable!(nodes[1]);
8583 check_added_monitors!(nodes[1], 1);
8585 // We should fail the payment back
8586 let mut events = nodes[1].node.get_and_clear_pending_msg_events();
8587 match events.pop().unwrap() {
8588 MessageSendEvent::UpdateHTLCs { node_id: _, updates: msgs::CommitmentUpdate { update_fail_htlcs, commitment_signed, .. } } => {
8589 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
8590 commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false);
8592 _ => panic!("Unexpected event"),
8597 let expected_error_code = 0x4000|15; // incorrect_or_unknown_payment_details
8598 // Error data is the HTLC value (100,000) and current block height
8599 let expected_error_data = [0, 0, 0, 0, 0, 1, 0x86, 0xa0, 0, 0, 0, CHAN_CONFIRM_DEPTH as u8];
8601 // Send a payment with the right payment hash but the wrong payment secret
8602 nodes[0].node.send_payment(&route, our_payment_hash, &Some(random_payment_secret)).unwrap();
8603 handle_unknown_invalid_payment_data!();
8604 expect_payment_failed!(nodes[0], our_payment_hash, true, expected_error_code, expected_error_data);
8606 // Send a payment with a random payment hash, but the right payment secret
8607 nodes[0].node.send_payment(&route, random_payment_hash, &Some(our_payment_secret)).unwrap();
8608 handle_unknown_invalid_payment_data!();
8609 expect_payment_failed!(nodes[0], random_payment_hash, true, expected_error_code, expected_error_data);
8611 // Send a payment with a random payment hash and random payment secret
8612 nodes[0].node.send_payment(&route, random_payment_hash, &Some(random_payment_secret)).unwrap();
8613 handle_unknown_invalid_payment_data!();
8614 expect_payment_failed!(nodes[0], random_payment_hash, true, expected_error_code, expected_error_data);
8618 fn test_update_err_monitor_lockdown() {
8619 // Our monitor will lock update of local commitment transaction if a broadcastion condition
8620 // has been fulfilled (either force-close from Channel or block height requiring a HTLC-
8621 // timeout). Trying to update monitor after lockdown should return a ChannelMonitorUpdateErr.
8623 // This scenario may happen in a watchtower setup, where watchtower process a block height
8624 // triggering a timeout while a slow-block-processing ChannelManager receives a local signed
8625 // commitment at same time.
8627 let chanmon_cfgs = create_chanmon_cfgs(2);
8628 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8629 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8630 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8632 // Create some initial channel
8633 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
8634 let outpoint = OutPoint { txid: chan_1.3.txid(), index: 0 };
8636 // Rebalance the network to generate htlc in the two directions
8637 send_payment(&nodes[0], &vec!(&nodes[1])[..], 10_000_000);
8639 // Route a HTLC from node 0 to node 1 (but don't settle)
8640 let preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000).0;
8642 // Copy ChainMonitor to simulate a watchtower and update block height of node 0 until its ChannelMonitor timeout HTLC onchain
8643 let chain_source = test_utils::TestChainSource::new(Network::Testnet);
8644 let logger = test_utils::TestLogger::with_id(format!("node {}", 0));
8645 let persister = test_utils::TestPersister::new();
8647 let monitors = nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap();
8648 let monitor = monitors.get(&outpoint).unwrap();
8649 let mut w = test_utils::TestVecWriter(Vec::new());
8650 monitor.write(&mut w).unwrap();
8651 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingSigner>)>::read(
8652 &mut ::std::io::Cursor::new(&w.0), &test_utils::OnlyReadsKeysInterface {}).unwrap().1;
8653 assert!(new_monitor == *monitor);
8654 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);
8655 assert!(watchtower.watch_channel(outpoint, new_monitor).is_ok());
8658 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8659 // Make the tx_broadcaster aware of enough blocks that it doesn't think we're violating
8660 // transaction lock time requirements here.
8661 chanmon_cfgs[0].tx_broadcaster.blocks.lock().unwrap().resize(200, (header, 0));
8662 watchtower.chain_monitor.block_connected(&Block { header, txdata: vec![] }, 200);
8664 // Try to update ChannelMonitor
8665 assert!(nodes[1].node.claim_funds(preimage));
8666 check_added_monitors!(nodes[1], 1);
8667 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
8668 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
8669 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
8670 if let Some(ref mut channel) = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan_1.2) {
8671 if let Ok((_, _, _, update)) = channel.commitment_signed(&updates.commitment_signed, &node_cfgs[0].fee_estimator, &node_cfgs[0].logger) {
8672 if let Err(_) = watchtower.chain_monitor.update_channel(outpoint, update.clone()) {} else { assert!(false); }
8673 if let Ok(_) = nodes[0].chain_monitor.update_channel(outpoint, update) {} else { assert!(false); }
8674 } else { assert!(false); }
8675 } else { assert!(false); };
8676 // Our local monitor is in-sync and hasn't processed yet timeout
8677 check_added_monitors!(nodes[0], 1);
8678 let events = nodes[0].node.get_and_clear_pending_events();
8679 assert_eq!(events.len(), 1);
8683 fn test_concurrent_monitor_claim() {
8684 // Watchtower A receives block, broadcasts state N, then channel receives new state N+1,
8685 // sending it to both watchtowers, Bob accepts N+1, then receives block and broadcasts
8686 // the latest state N+1, Alice rejects state N+1, but Bob has already broadcast it,
8687 // state N+1 confirms. Alice claims output from state N+1.
8689 let chanmon_cfgs = create_chanmon_cfgs(2);
8690 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8691 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8692 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8694 // Create some initial channel
8695 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
8696 let outpoint = OutPoint { txid: chan_1.3.txid(), index: 0 };
8698 // Rebalance the network to generate htlc in the two directions
8699 send_payment(&nodes[0], &vec!(&nodes[1])[..], 10_000_000);
8701 // Route a HTLC from node 0 to node 1 (but don't settle)
8702 route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000).0;
8704 // Copy ChainMonitor to simulate watchtower Alice and update block height her ChannelMonitor timeout HTLC onchain
8705 let chain_source = test_utils::TestChainSource::new(Network::Testnet);
8706 let logger = test_utils::TestLogger::with_id(format!("node {}", "Alice"));
8707 let persister = test_utils::TestPersister::new();
8708 let watchtower_alice = {
8709 let monitors = nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap();
8710 let monitor = monitors.get(&outpoint).unwrap();
8711 let mut w = test_utils::TestVecWriter(Vec::new());
8712 monitor.write(&mut w).unwrap();
8713 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingSigner>)>::read(
8714 &mut ::std::io::Cursor::new(&w.0), &test_utils::OnlyReadsKeysInterface {}).unwrap().1;
8715 assert!(new_monitor == *monitor);
8716 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);
8717 assert!(watchtower.watch_channel(outpoint, new_monitor).is_ok());
8720 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8721 // Make the tx_broadcaster aware of enough blocks that it doesn't think we're violating
8722 // transaction lock time requirements here.
8723 chanmon_cfgs[0].tx_broadcaster.blocks.lock().unwrap().resize((CHAN_CONFIRM_DEPTH + 1 + TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS) as usize, (header, 0));
8724 watchtower_alice.chain_monitor.block_connected(&Block { header, txdata: vec![] }, CHAN_CONFIRM_DEPTH + 1 + TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS);
8726 // Watchtower Alice should have broadcast a commitment/HTLC-timeout
8728 let mut txn = chanmon_cfgs[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8729 assert_eq!(txn.len(), 2);
8733 // Copy ChainMonitor to simulate watchtower Bob and make it receive a commitment update first.
8734 let chain_source = test_utils::TestChainSource::new(Network::Testnet);
8735 let logger = test_utils::TestLogger::with_id(format!("node {}", "Bob"));
8736 let persister = test_utils::TestPersister::new();
8737 let watchtower_bob = {
8738 let monitors = nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap();
8739 let monitor = monitors.get(&outpoint).unwrap();
8740 let mut w = test_utils::TestVecWriter(Vec::new());
8741 monitor.write(&mut w).unwrap();
8742 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingSigner>)>::read(
8743 &mut ::std::io::Cursor::new(&w.0), &test_utils::OnlyReadsKeysInterface {}).unwrap().1;
8744 assert!(new_monitor == *monitor);
8745 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);
8746 assert!(watchtower.watch_channel(outpoint, new_monitor).is_ok());
8749 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8750 watchtower_bob.chain_monitor.block_connected(&Block { header, txdata: vec![] }, CHAN_CONFIRM_DEPTH + TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS);
8752 // Route another payment to generate another update with still previous HTLC pending
8753 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[0]);
8755 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
8756 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();
8757 nodes[1].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
8759 check_added_monitors!(nodes[1], 1);
8761 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
8762 assert_eq!(updates.update_add_htlcs.len(), 1);
8763 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &updates.update_add_htlcs[0]);
8764 if let Some(ref mut channel) = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan_1.2) {
8765 if let Ok((_, _, _, update)) = channel.commitment_signed(&updates.commitment_signed, &node_cfgs[0].fee_estimator, &node_cfgs[0].logger) {
8766 // Watchtower Alice should already have seen the block and reject the update
8767 if let Err(_) = watchtower_alice.chain_monitor.update_channel(outpoint, update.clone()) {} else { assert!(false); }
8768 if let Ok(_) = watchtower_bob.chain_monitor.update_channel(outpoint, update.clone()) {} else { assert!(false); }
8769 if let Ok(_) = nodes[0].chain_monitor.update_channel(outpoint, update) {} else { assert!(false); }
8770 } else { assert!(false); }
8771 } else { assert!(false); };
8772 // Our local monitor is in-sync and hasn't processed yet timeout
8773 check_added_monitors!(nodes[0], 1);
8775 //// Provide one more block to watchtower Bob, expect broadcast of commitment and HTLC-Timeout
8776 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8777 watchtower_bob.chain_monitor.block_connected(&Block { header, txdata: vec![] }, CHAN_CONFIRM_DEPTH + 1 + TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS);
8779 // Watchtower Bob should have broadcast a commitment/HTLC-timeout
8782 let mut txn = chanmon_cfgs[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8783 assert_eq!(txn.len(), 2);
8784 bob_state_y = txn[0].clone();
8788 // We confirm Bob's state Y on Alice, she should broadcast a HTLC-timeout
8789 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8790 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);
8792 let htlc_txn = chanmon_cfgs[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8793 // We broadcast twice the transaction, once due to the HTLC-timeout, once due
8794 // the onchain detection of the HTLC output
8795 assert_eq!(htlc_txn.len(), 2);
8796 check_spends!(htlc_txn[0], bob_state_y);
8797 check_spends!(htlc_txn[1], bob_state_y);
8802 fn test_pre_lockin_no_chan_closed_update() {
8803 // Test that if a peer closes a channel in response to a funding_created message we don't
8804 // generate a channel update (as the channel cannot appear on chain without a funding_signed
8807 // Doing so would imply a channel monitor update before the initial channel monitor
8808 // registration, violating our API guarantees.
8810 // Previously, full_stack_target managed to hit this case by opening then closing a channel,
8811 // then opening a second channel with the same funding output as the first (which is not
8812 // rejected because the first channel does not exist in the ChannelManager) and closing it
8813 // before receiving funding_signed.
8814 let chanmon_cfgs = create_chanmon_cfgs(2);
8815 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8816 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8817 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8819 // Create an initial channel
8820 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
8821 let mut open_chan_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8822 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_msg);
8823 let accept_chan_msg = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
8824 nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &accept_chan_msg);
8826 // Move the first channel through the funding flow...
8827 let (temporary_channel_id, tx, _) = create_funding_transaction(&nodes[0], 100000, 42);
8829 nodes[0].node.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
8830 check_added_monitors!(nodes[0], 0);
8832 let funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
8833 let channel_id = ::chain::transaction::OutPoint { txid: funding_created_msg.funding_txid, index: funding_created_msg.funding_output_index }.to_channel_id();
8834 nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msgs::ErrorMessage { channel_id, data: "Hi".to_owned() });
8835 assert!(nodes[0].chain_monitor.added_monitors.lock().unwrap().is_empty());
8839 fn test_htlc_no_detection() {
8840 // This test is a mutation to underscore the detection logic bug we had
8841 // before #653. HTLC value routed is above the remaining balance, thus
8842 // inverting HTLC and `to_remote` output. HTLC will come second and
8843 // it wouldn't be seen by pre-#653 detection as we were enumerate()'ing
8844 // on a watched outputs vector (Vec<TxOut>) thus implicitly relying on
8845 // outputs order detection for correct spending children filtring.
8847 let chanmon_cfgs = create_chanmon_cfgs(2);
8848 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8849 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8850 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8852 // Create some initial channels
8853 let chan_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
8855 send_payment(&nodes[0], &vec!(&nodes[1])[..], 1_000_000);
8856 let (_, our_payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 2_000_000);
8857 let local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
8858 assert_eq!(local_txn[0].input.len(), 1);
8859 assert_eq!(local_txn[0].output.len(), 3);
8860 check_spends!(local_txn[0], chan_1.3);
8862 // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
8863 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8864 connect_block(&nodes[0], &Block { header, txdata: vec![local_txn[0].clone()] });
8865 // We deliberately connect the local tx twice as this should provoke a failure calling
8866 // this test before #653 fix.
8867 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);
8868 check_closed_broadcast!(nodes[0], true);
8869 check_added_monitors!(nodes[0], 1);
8870 connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1);
8872 let htlc_timeout = {
8873 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8874 assert_eq!(node_txn[1].input.len(), 1);
8875 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
8876 check_spends!(node_txn[1], local_txn[0]);
8880 let header_201 = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8881 connect_block(&nodes[0], &Block { header: header_201, txdata: vec![htlc_timeout.clone()] });
8882 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
8883 expect_payment_failed!(nodes[0], our_payment_hash, true);
8886 fn do_test_onchain_htlc_settlement_after_close(broadcast_alice: bool, go_onchain_before_fulfill: bool) {
8887 // If we route an HTLC, then learn the HTLC's preimage after the upstream channel has been
8888 // force-closed, we must claim that HTLC on-chain. (Given an HTLC forwarded from Alice --> Bob -->
8889 // Carol, Alice would be the upstream node, and Carol the downstream.)
8891 // Steps of the test:
8892 // 1) Alice sends a HTLC to Carol through Bob.
8893 // 2) Carol doesn't settle the HTLC.
8894 // 3) If broadcast_alice is true, Alice force-closes her channel with Bob. Else Bob force closes.
8895 // Steps 4 and 5 may be reordered depending on go_onchain_before_fulfill.
8896 // 4) Bob sees the Alice's commitment on his chain or vice versa. An offered output is present
8897 // but can't be claimed as Bob doesn't have yet knowledge of the preimage.
8898 // 5) Carol release the preimage to Bob off-chain.
8899 // 6) Bob claims the offered output on the broadcasted commitment.
8900 let chanmon_cfgs = create_chanmon_cfgs(3);
8901 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
8902 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
8903 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
8905 // Create some initial channels
8906 let chan_ab = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
8907 create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 100000, 10001, InitFeatures::known(), InitFeatures::known());
8909 // Steps (1) and (2):
8910 // Send an HTLC Alice --> Bob --> Carol, but Carol doesn't settle the HTLC back.
8911 let (payment_preimage, _payment_hash, _payment_secret) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3_000_000);
8913 // Check that Alice's commitment transaction now contains an output for this HTLC.
8914 let alice_txn = get_local_commitment_txn!(nodes[0], chan_ab.2);
8915 check_spends!(alice_txn[0], chan_ab.3);
8916 assert_eq!(alice_txn[0].output.len(), 2);
8917 check_spends!(alice_txn[1], alice_txn[0]); // 2nd transaction is a non-final HTLC-timeout
8918 assert_eq!(alice_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
8919 assert_eq!(alice_txn.len(), 2);
8921 // Steps (3) and (4):
8922 // If `go_onchain_before_fufill`, broadcast the relevant commitment transaction and check that Bob
8923 // responds by (1) broadcasting a channel update and (2) adding a new ChannelMonitor.
8924 let mut force_closing_node = 0; // Alice force-closes
8925 if !broadcast_alice { force_closing_node = 1; } // Bob force-closes
8926 nodes[force_closing_node].node.force_close_channel(&chan_ab.2).unwrap();
8927 check_closed_broadcast!(nodes[force_closing_node], true);
8928 check_added_monitors!(nodes[force_closing_node], 1);
8929 if go_onchain_before_fulfill {
8930 let txn_to_broadcast = match broadcast_alice {
8931 true => alice_txn.clone(),
8932 false => get_local_commitment_txn!(nodes[1], chan_ab.2)
8934 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
8935 connect_block(&nodes[1], &Block { header, txdata: vec![txn_to_broadcast[0].clone()]});
8936 let mut bob_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8937 if broadcast_alice {
8938 check_closed_broadcast!(nodes[1], true);
8939 check_added_monitors!(nodes[1], 1);
8941 assert_eq!(bob_txn.len(), 1);
8942 check_spends!(bob_txn[0], chan_ab.3);
8946 // Carol then claims the funds and sends an update_fulfill message to Bob, and they go through the
8947 // process of removing the HTLC from their commitment transactions.
8948 assert!(nodes[2].node.claim_funds(payment_preimage));
8949 check_added_monitors!(nodes[2], 1);
8950 let carol_updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
8951 assert!(carol_updates.update_add_htlcs.is_empty());
8952 assert!(carol_updates.update_fail_htlcs.is_empty());
8953 assert!(carol_updates.update_fail_malformed_htlcs.is_empty());
8954 assert!(carol_updates.update_fee.is_none());
8955 assert_eq!(carol_updates.update_fulfill_htlcs.len(), 1);
8957 nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &carol_updates.update_fulfill_htlcs[0]);
8958 // If Alice broadcasted but Bob doesn't know yet, here he prepares to tell her about the preimage.
8959 if !go_onchain_before_fulfill && broadcast_alice {
8960 let events = nodes[1].node.get_and_clear_pending_msg_events();
8961 assert_eq!(events.len(), 1);
8963 MessageSendEvent::UpdateHTLCs { ref node_id, .. } => {
8964 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
8966 _ => panic!("Unexpected event"),
8969 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &carol_updates.commitment_signed);
8970 // One monitor update for the preimage to update the Bob<->Alice channel, one monitor update
8971 // Carol<->Bob's updated commitment transaction info.
8972 check_added_monitors!(nodes[1], 2);
8974 let events = nodes[1].node.get_and_clear_pending_msg_events();
8975 assert_eq!(events.len(), 2);
8976 let bob_revocation = match events[0] {
8977 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
8978 assert_eq!(*node_id, nodes[2].node.get_our_node_id());
8981 _ => panic!("Unexpected event"),
8983 let bob_updates = match events[1] {
8984 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
8985 assert_eq!(*node_id, nodes[2].node.get_our_node_id());
8988 _ => panic!("Unexpected event"),
8991 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bob_revocation);
8992 check_added_monitors!(nodes[2], 1);
8993 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bob_updates.commitment_signed);
8994 check_added_monitors!(nodes[2], 1);
8996 let events = nodes[2].node.get_and_clear_pending_msg_events();
8997 assert_eq!(events.len(), 1);
8998 let carol_revocation = match events[0] {
8999 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
9000 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
9003 _ => panic!("Unexpected event"),
9005 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &carol_revocation);
9006 check_added_monitors!(nodes[1], 1);
9008 // If this test requires the force-closed channel to not be on-chain until after the fulfill,
9009 // here's where we put said channel's commitment tx on-chain.
9010 let mut txn_to_broadcast = alice_txn.clone();
9011 if !broadcast_alice { txn_to_broadcast = get_local_commitment_txn!(nodes[1], chan_ab.2); }
9012 if !go_onchain_before_fulfill {
9013 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
9014 connect_block(&nodes[1], &Block { header, txdata: vec![txn_to_broadcast[0].clone()]});
9015 // If Bob was the one to force-close, he will have already passed these checks earlier.
9016 if broadcast_alice {
9017 check_closed_broadcast!(nodes[1], true);
9018 check_added_monitors!(nodes[1], 1);
9020 let mut bob_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
9021 if broadcast_alice {
9022 // In `connect_block()`, the ChainMonitor and ChannelManager are separately notified about a
9023 // new block being connected. The ChannelManager being notified triggers a monitor update,
9024 // which triggers broadcasting our commitment tx and an HTLC-claiming tx. The ChainMonitor
9025 // being notified triggers the HTLC-claiming tx redundantly, resulting in 3 total txs being
9027 assert_eq!(bob_txn.len(), 3);
9028 check_spends!(bob_txn[1], chan_ab.3);
9030 assert_eq!(bob_txn.len(), 2);
9031 check_spends!(bob_txn[0], chan_ab.3);
9036 // Finally, check that Bob broadcasted a preimage-claiming transaction for the HTLC output on the
9037 // broadcasted commitment transaction.
9039 let bob_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
9040 if go_onchain_before_fulfill {
9041 // Bob should now have an extra broadcasted tx, for the preimage-claiming transaction.
9042 assert_eq!(bob_txn.len(), 2);
9044 let script_weight = match broadcast_alice {
9045 true => OFFERED_HTLC_SCRIPT_WEIGHT,
9046 false => ACCEPTED_HTLC_SCRIPT_WEIGHT
9048 // If Alice force-closed and Bob didn't receive her commitment transaction until after he
9049 // received Carol's fulfill, he broadcasts the HTLC-output-claiming transaction first. Else if
9050 // Bob force closed or if he found out about Alice's commitment tx before receiving Carol's
9051 // fulfill, then he broadcasts the HTLC-output-claiming transaction second.
9052 if broadcast_alice && !go_onchain_before_fulfill {
9053 check_spends!(bob_txn[0], txn_to_broadcast[0]);
9054 assert_eq!(bob_txn[0].input[0].witness.last().unwrap().len(), script_weight);
9056 check_spends!(bob_txn[1], txn_to_broadcast[0]);
9057 assert_eq!(bob_txn[1].input[0].witness.last().unwrap().len(), script_weight);
9063 fn test_onchain_htlc_settlement_after_close() {
9064 do_test_onchain_htlc_settlement_after_close(true, true);
9065 do_test_onchain_htlc_settlement_after_close(false, true); // Technically redundant, but may as well
9066 do_test_onchain_htlc_settlement_after_close(true, false);
9067 do_test_onchain_htlc_settlement_after_close(false, false);
9071 fn test_duplicate_chan_id() {
9072 // Test that if a given peer tries to open a channel with the same channel_id as one that is
9073 // already open we reject it and keep the old channel.
9075 // Previously, full_stack_target managed to figure out that if you tried to open two channels
9076 // with the same funding output (ie post-funding channel_id), we'd create a monitor update for
9077 // the existing channel when we detect the duplicate new channel, screwing up our monitor
9078 // updating logic for the existing channel.
9079 let chanmon_cfgs = create_chanmon_cfgs(2);
9080 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
9081 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
9082 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
9084 // Create an initial channel
9085 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
9086 let mut open_chan_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
9087 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_msg);
9088 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()));
9090 // Try to create a second channel with the same temporary_channel_id as the first and check
9091 // that it is rejected.
9092 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_msg);
9094 let events = nodes[1].node.get_and_clear_pending_msg_events();
9095 assert_eq!(events.len(), 1);
9097 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
9098 // Technically, at this point, nodes[1] would be justified in thinking both the
9099 // first (valid) and second (invalid) channels are closed, given they both have
9100 // the same non-temporary channel_id. However, currently we do not, so we just
9101 // move forward with it.
9102 assert_eq!(msg.channel_id, open_chan_msg.temporary_channel_id);
9103 assert_eq!(node_id, nodes[0].node.get_our_node_id());
9105 _ => panic!("Unexpected event"),
9109 // Move the first channel through the funding flow...
9110 let (temporary_channel_id, tx, funding_output) = create_funding_transaction(&nodes[0], 100000, 42);
9112 nodes[0].node.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
9113 check_added_monitors!(nodes[0], 0);
9115 let mut funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
9116 nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created_msg);
9118 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
9119 assert_eq!(added_monitors.len(), 1);
9120 assert_eq!(added_monitors[0].0, funding_output);
9121 added_monitors.clear();
9123 let funding_signed_msg = get_event_msg!(nodes[1], MessageSendEvent::SendFundingSigned, nodes[0].node.get_our_node_id());
9125 let funding_outpoint = ::chain::transaction::OutPoint { txid: funding_created_msg.funding_txid, index: funding_created_msg.funding_output_index };
9126 let channel_id = funding_outpoint.to_channel_id();
9128 // Now we have the first channel past funding_created (ie it has a txid-based channel_id, not a
9131 // First try to open a second channel with a temporary channel id equal to the txid-based one.
9132 // Technically this is allowed by the spec, but we don't support it and there's little reason
9133 // to. Still, it shouldn't cause any other issues.
9134 open_chan_msg.temporary_channel_id = channel_id;
9135 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_msg);
9137 let events = nodes[1].node.get_and_clear_pending_msg_events();
9138 assert_eq!(events.len(), 1);
9140 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
9141 // Technically, at this point, nodes[1] would be justified in thinking both
9142 // channels are closed, but currently we do not, so we just move forward with it.
9143 assert_eq!(msg.channel_id, open_chan_msg.temporary_channel_id);
9144 assert_eq!(node_id, nodes[0].node.get_our_node_id());
9146 _ => panic!("Unexpected event"),
9150 // Now try to create a second channel which has a duplicate funding output.
9151 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
9152 let open_chan_2_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
9153 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_2_msg);
9154 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()));
9155 create_funding_transaction(&nodes[0], 100000, 42); // Get and check the FundingGenerationReady event
9157 let funding_created = {
9158 let mut a_channel_lock = nodes[0].node.channel_state.lock().unwrap();
9159 let mut as_chan = a_channel_lock.by_id.get_mut(&open_chan_2_msg.temporary_channel_id).unwrap();
9160 let logger = test_utils::TestLogger::new();
9161 as_chan.get_outbound_funding_created(tx.clone(), funding_outpoint, &&logger).unwrap()
9163 check_added_monitors!(nodes[0], 0);
9164 nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created);
9165 // At this point we'll try to add a duplicate channel monitor, which will be rejected, but
9166 // still needs to be cleared here.
9167 check_added_monitors!(nodes[1], 1);
9169 // ...still, nodes[1] will reject the duplicate channel.
9171 let events = nodes[1].node.get_and_clear_pending_msg_events();
9172 assert_eq!(events.len(), 1);
9174 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
9175 // Technically, at this point, nodes[1] would be justified in thinking both
9176 // channels are closed, but currently we do not, so we just move forward with it.
9177 assert_eq!(msg.channel_id, channel_id);
9178 assert_eq!(node_id, nodes[0].node.get_our_node_id());
9180 _ => panic!("Unexpected event"),
9184 // finally, finish creating the original channel and send a payment over it to make sure
9185 // everything is functional.
9186 nodes[0].node.handle_funding_signed(&nodes[1].node.get_our_node_id(), &funding_signed_msg);
9188 let mut added_monitors = nodes[0].chain_monitor.added_monitors.lock().unwrap();
9189 assert_eq!(added_monitors.len(), 1);
9190 assert_eq!(added_monitors[0].0, funding_output);
9191 added_monitors.clear();
9194 let events_4 = nodes[0].node.get_and_clear_pending_events();
9195 assert_eq!(events_4.len(), 0);
9196 assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
9197 assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0].txid(), funding_output.txid);
9199 let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
9200 let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
9201 update_nodes_with_chan_announce(&nodes, 0, 1, &announcement, &as_update, &bs_update);
9202 send_payment(&nodes[0], &[&nodes[1]], 8000000);
9206 fn test_error_chans_closed() {
9207 // Test that we properly handle error messages, closing appropriate channels.
9209 // Prior to #787 we'd allow a peer to make us force-close a channel we had with a different
9210 // peer. The "real" fix for that is to index channels with peers_ids, however in the mean time
9211 // we can test various edge cases around it to ensure we don't regress.
9212 let chanmon_cfgs = create_chanmon_cfgs(3);
9213 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
9214 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
9215 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
9217 // Create some initial channels
9218 let chan_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
9219 let chan_2 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
9220 let chan_3 = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 100000, 10001, InitFeatures::known(), InitFeatures::known());
9222 assert_eq!(nodes[0].node.list_usable_channels().len(), 3);
9223 assert_eq!(nodes[1].node.list_usable_channels().len(), 2);
9224 assert_eq!(nodes[2].node.list_usable_channels().len(), 1);
9226 // Closing a channel from a different peer has no effect
9227 nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msgs::ErrorMessage { channel_id: chan_3.2, data: "ERR".to_owned() });
9228 assert_eq!(nodes[0].node.list_usable_channels().len(), 3);
9230 // Closing one channel doesn't impact others
9231 nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msgs::ErrorMessage { channel_id: chan_2.2, data: "ERR".to_owned() });
9232 check_added_monitors!(nodes[0], 1);
9233 check_closed_broadcast!(nodes[0], false);
9234 assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0).len(), 1);
9235 assert_eq!(nodes[0].node.list_usable_channels().len(), 2);
9236 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);
9237 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);
9239 // A null channel ID should close all channels
9240 let _chan_4 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
9241 nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msgs::ErrorMessage { channel_id: [0; 32], data: "ERR".to_owned() });
9242 check_added_monitors!(nodes[0], 2);
9243 let events = nodes[0].node.get_and_clear_pending_msg_events();
9244 assert_eq!(events.len(), 2);
9246 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
9247 assert_eq!(msg.contents.flags & 2, 2);
9249 _ => panic!("Unexpected event"),
9252 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
9253 assert_eq!(msg.contents.flags & 2, 2);
9255 _ => panic!("Unexpected event"),
9257 // Note that at this point users of a standard PeerHandler will end up calling
9258 // peer_disconnected with no_connection_possible set to false, duplicating the
9259 // close-all-channels logic. That's OK, we don't want to end up not force-closing channels for
9260 // users with their own peer handling logic. We duplicate the call here, however.
9261 assert_eq!(nodes[0].node.list_usable_channels().len(), 1);
9262 assert!(nodes[0].node.list_usable_channels()[0].channel_id == chan_3.2);
9264 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), true);
9265 assert_eq!(nodes[0].node.list_usable_channels().len(), 1);
9266 assert!(nodes[0].node.list_usable_channels()[0].channel_id == chan_3.2);
9270 fn test_invalid_funding_tx() {
9271 // Test that we properly handle invalid funding transactions sent to us from a peer.
9273 // Previously, all other major lightning implementations had failed to properly sanitize
9274 // funding transactions from their counterparties, leading to a multi-implementation critical
9275 // security vulnerability (though we always sanitized properly, we've previously had
9276 // un-released crashes in the sanitization process).
9277 let chanmon_cfgs = create_chanmon_cfgs(2);
9278 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
9279 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
9280 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
9282 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100_000, 10_000, 42, None).unwrap();
9283 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()));
9284 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()));
9286 let (temporary_channel_id, mut tx, _) = create_funding_transaction(&nodes[0], 100_000, 42);
9287 for output in tx.output.iter_mut() {
9288 // Make the confirmed funding transaction have a bogus script_pubkey
9289 output.script_pubkey = bitcoin::Script::new();
9292 nodes[0].node.funding_transaction_generated_unchecked(&temporary_channel_id, tx.clone(), 0).unwrap();
9293 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()));
9294 check_added_monitors!(nodes[1], 1);
9296 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()));
9297 check_added_monitors!(nodes[0], 1);
9299 let events_1 = nodes[0].node.get_and_clear_pending_events();
9300 assert_eq!(events_1.len(), 0);
9302 assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
9303 assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0], tx);
9304 nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
9306 confirm_transaction_at(&nodes[1], &tx, 1);
9307 check_added_monitors!(nodes[1], 1);
9308 let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
9309 assert_eq!(events_2.len(), 1);
9310 if let MessageSendEvent::HandleError { node_id, action } = &events_2[0] {
9311 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
9312 if let msgs::ErrorAction::SendErrorMessage { msg } = action {
9313 assert_eq!(msg.data, "funding tx had wrong script/value or output index");
9314 } else { panic!(); }
9315 } else { panic!(); }
9316 assert_eq!(nodes[1].node.list_channels().len(), 0);