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) {
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);
3614 if messages_delivered == 0 {
3615 create_chan_between_nodes_with_value_a(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
3616 // nodes[1] doesn't receive the funding_locked message (it'll be re-sent on reconnect)
3618 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3621 let (payment_preimage_1, payment_hash_1, payment_secret_1) = get_payment_preimage_hash!(nodes[1]);
3623 let logger = test_utils::TestLogger::new();
3624 let payment_event = {
3625 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3626 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(),
3627 &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), Some(&nodes[0].node.list_usable_channels().iter().collect::<Vec<_>>()),
3628 &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
3629 nodes[0].node.send_payment(&route, payment_hash_1, &Some(payment_secret_1)).unwrap();
3630 check_added_monitors!(nodes[0], 1);
3632 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3633 assert_eq!(events.len(), 1);
3634 SendEvent::from_event(events.remove(0))
3636 assert_eq!(nodes[1].node.get_our_node_id(), payment_event.node_id);
3638 if messages_delivered < 2 {
3639 // Drop the payment_event messages, and let them get re-generated in reconnect_nodes!
3641 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
3642 if messages_delivered >= 3 {
3643 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
3644 check_added_monitors!(nodes[1], 1);
3645 let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3647 if messages_delivered >= 4 {
3648 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3649 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3650 check_added_monitors!(nodes[0], 1);
3652 if messages_delivered >= 5 {
3653 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_commitment_signed);
3654 let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3655 // No commitment_signed so get_event_msg's assert(len == 1) passes
3656 check_added_monitors!(nodes[0], 1);
3658 if messages_delivered >= 6 {
3659 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3660 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3661 check_added_monitors!(nodes[1], 1);
3668 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3669 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3670 if messages_delivered < 3 {
3671 // Even if the funding_locked messages get exchanged, as long as nothing further was
3672 // received on either side, both sides will need to resend them.
3673 reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 1), (0, 0), (0, 0), (0, 0), (false, false));
3674 } else if messages_delivered == 3 {
3675 // nodes[0] still wants its RAA + commitment_signed
3676 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (-1, 0), (0, 0), (0, 0), (0, 0), (true, false));
3677 } else if messages_delivered == 4 {
3678 // nodes[0] still wants its commitment_signed
3679 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (-1, 0), (0, 0), (0, 0), (0, 0), (false, false));
3680 } else if messages_delivered == 5 {
3681 // nodes[1] still wants its final RAA
3682 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, true));
3683 } else if messages_delivered == 6 {
3684 // Everything was delivered...
3685 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3688 let events_1 = nodes[1].node.get_and_clear_pending_events();
3689 assert_eq!(events_1.len(), 1);
3691 Event::PendingHTLCsForwardable { .. } => { },
3692 _ => panic!("Unexpected event"),
3695 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3696 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3697 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3699 nodes[1].node.process_pending_htlc_forwards();
3701 let events_2 = nodes[1].node.get_and_clear_pending_events();
3702 assert_eq!(events_2.len(), 1);
3704 Event::PaymentReceived { ref payment_hash, ref payment_preimage, ref payment_secret, amt, user_payment_id: _ } => {
3705 assert_eq!(payment_hash_1, *payment_hash);
3706 assert!(payment_preimage.is_none());
3707 assert_eq!(payment_secret_1, *payment_secret);
3708 assert_eq!(amt, 1000000);
3710 _ => panic!("Unexpected event"),
3713 nodes[1].node.claim_funds(payment_preimage_1);
3714 check_added_monitors!(nodes[1], 1);
3716 let events_3 = nodes[1].node.get_and_clear_pending_msg_events();
3717 assert_eq!(events_3.len(), 1);
3718 let (update_fulfill_htlc, commitment_signed) = match events_3[0] {
3719 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
3720 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3721 assert!(updates.update_add_htlcs.is_empty());
3722 assert!(updates.update_fail_htlcs.is_empty());
3723 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
3724 assert!(updates.update_fail_malformed_htlcs.is_empty());
3725 assert!(updates.update_fee.is_none());
3726 (updates.update_fulfill_htlcs[0].clone(), updates.commitment_signed.clone())
3728 _ => panic!("Unexpected event"),
3731 if messages_delivered >= 1 {
3732 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlc);
3734 let events_4 = nodes[0].node.get_and_clear_pending_events();
3735 assert_eq!(events_4.len(), 1);
3737 Event::PaymentSent { ref payment_preimage } => {
3738 assert_eq!(payment_preimage_1, *payment_preimage);
3740 _ => panic!("Unexpected event"),
3743 if messages_delivered >= 2 {
3744 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
3745 check_added_monitors!(nodes[0], 1);
3746 let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
3748 if messages_delivered >= 3 {
3749 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3750 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3751 check_added_monitors!(nodes[1], 1);
3753 if messages_delivered >= 4 {
3754 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed);
3755 let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3756 // No commitment_signed so get_event_msg's assert(len == 1) passes
3757 check_added_monitors!(nodes[1], 1);
3759 if messages_delivered >= 5 {
3760 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3761 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3762 check_added_monitors!(nodes[0], 1);
3769 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3770 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3771 if messages_delivered < 2 {
3772 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (1, 0), (0, 0), (0, 0), (false, false));
3773 if messages_delivered < 1 {
3774 let events_4 = nodes[0].node.get_and_clear_pending_events();
3775 assert_eq!(events_4.len(), 1);
3777 Event::PaymentSent { ref payment_preimage } => {
3778 assert_eq!(payment_preimage_1, *payment_preimage);
3780 _ => panic!("Unexpected event"),
3783 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3785 } else if messages_delivered == 2 {
3786 // nodes[0] still wants its RAA + commitment_signed
3787 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, -1), (0, 0), (0, 0), (0, 0), (false, true));
3788 } else if messages_delivered == 3 {
3789 // nodes[0] still wants its commitment_signed
3790 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, -1), (0, 0), (0, 0), (0, 0), (false, false));
3791 } else if messages_delivered == 4 {
3792 // nodes[1] still wants its final RAA
3793 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (true, false));
3794 } else if messages_delivered == 5 {
3795 // Everything was delivered...
3796 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3799 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3800 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3801 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3803 // Channel should still work fine...
3804 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3805 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(),
3806 &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), Some(&nodes[0].node.list_usable_channels().iter().collect::<Vec<_>>()),
3807 &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
3808 let payment_preimage_2 = send_along_route(&nodes[0], route, &[&nodes[1]], 1000000).0;
3809 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
3813 fn test_drop_messages_peer_disconnect_a() {
3814 do_test_drop_messages_peer_disconnect(0);
3815 do_test_drop_messages_peer_disconnect(1);
3816 do_test_drop_messages_peer_disconnect(2);
3817 do_test_drop_messages_peer_disconnect(3);
3821 fn test_drop_messages_peer_disconnect_b() {
3822 do_test_drop_messages_peer_disconnect(4);
3823 do_test_drop_messages_peer_disconnect(5);
3824 do_test_drop_messages_peer_disconnect(6);
3828 fn test_funding_peer_disconnect() {
3829 // Test that we can lock in our funding tx while disconnected
3830 let chanmon_cfgs = create_chanmon_cfgs(2);
3831 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3832 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3833 let persister: test_utils::TestPersister;
3834 let new_chain_monitor: test_utils::TestChainMonitor;
3835 let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
3836 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3837 let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
3839 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3840 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3842 confirm_transaction(&nodes[0], &tx);
3843 let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
3844 assert_eq!(events_1.len(), 1);
3846 MessageSendEvent::SendFundingLocked { ref node_id, msg: _ } => {
3847 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
3849 _ => panic!("Unexpected event"),
3852 reconnect_nodes(&nodes[0], &nodes[1], (false, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3854 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3855 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3857 confirm_transaction(&nodes[1], &tx);
3858 let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3859 assert_eq!(events_2.len(), 2);
3860 let funding_locked = match events_2[0] {
3861 MessageSendEvent::SendFundingLocked { ref node_id, ref msg } => {
3862 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3865 _ => panic!("Unexpected event"),
3867 let bs_announcement_sigs = match events_2[1] {
3868 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
3869 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3872 _ => panic!("Unexpected event"),
3875 reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3877 nodes[0].node.handle_funding_locked(&nodes[1].node.get_our_node_id(), &funding_locked);
3878 nodes[0].node.handle_announcement_signatures(&nodes[1].node.get_our_node_id(), &bs_announcement_sigs);
3879 let events_3 = nodes[0].node.get_and_clear_pending_msg_events();
3880 assert_eq!(events_3.len(), 2);
3881 let as_announcement_sigs = match events_3[0] {
3882 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
3883 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
3886 _ => panic!("Unexpected event"),
3888 let (as_announcement, as_update) = match events_3[1] {
3889 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
3890 (msg.clone(), update_msg.clone())
3892 _ => panic!("Unexpected event"),
3895 nodes[1].node.handle_announcement_signatures(&nodes[0].node.get_our_node_id(), &as_announcement_sigs);
3896 let events_4 = nodes[1].node.get_and_clear_pending_msg_events();
3897 assert_eq!(events_4.len(), 1);
3898 let (_, bs_update) = match events_4[0] {
3899 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
3900 (msg.clone(), update_msg.clone())
3902 _ => panic!("Unexpected event"),
3905 nodes[0].net_graph_msg_handler.handle_channel_announcement(&as_announcement).unwrap();
3906 nodes[0].net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
3907 nodes[0].net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
3909 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3910 let logger = test_utils::TestLogger::new();
3911 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();
3912 let (payment_preimage, _, _) = send_along_route(&nodes[0], route, &[&nodes[1]], 1000000);
3913 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage);
3915 // Check that after deserialization and reconnection we can still generate an identical
3916 // channel_announcement from the cached signatures.
3917 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3919 let nodes_0_serialized = nodes[0].node.encode();
3920 let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
3921 nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
3923 persister = test_utils::TestPersister::new();
3924 let keys_manager = &chanmon_cfgs[0].keys_manager;
3925 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);
3926 nodes[0].chain_monitor = &new_chain_monitor;
3927 let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
3928 let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
3929 &mut chan_0_monitor_read, keys_manager).unwrap();
3930 assert!(chan_0_monitor_read.is_empty());
3932 let mut nodes_0_read = &nodes_0_serialized[..];
3933 let (_, nodes_0_deserialized_tmp) = {
3934 let mut channel_monitors = HashMap::new();
3935 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
3936 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
3937 default_config: UserConfig::default(),
3939 fee_estimator: node_cfgs[0].fee_estimator,
3940 chain_monitor: nodes[0].chain_monitor,
3941 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
3942 logger: nodes[0].logger,
3946 nodes_0_deserialized = nodes_0_deserialized_tmp;
3947 assert!(nodes_0_read.is_empty());
3949 assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
3950 nodes[0].node = &nodes_0_deserialized;
3951 check_added_monitors!(nodes[0], 1);
3953 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3955 // as_announcement should be re-generated exactly by broadcast_node_announcement.
3956 nodes[0].node.broadcast_node_announcement([0, 0, 0], [0; 32], Vec::new());
3957 let msgs = nodes[0].node.get_and_clear_pending_msg_events();
3958 let mut found_announcement = false;
3959 for event in msgs.iter() {
3961 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, .. } => {
3962 if *msg == as_announcement { found_announcement = true; }
3964 MessageSendEvent::BroadcastNodeAnnouncement { .. } => {},
3965 _ => panic!("Unexpected event"),
3968 assert!(found_announcement);
3972 fn test_drop_messages_peer_disconnect_dual_htlc() {
3973 // Test that we can handle reconnecting when both sides of a channel have pending
3974 // commitment_updates when we disconnect.
3975 let chanmon_cfgs = create_chanmon_cfgs(2);
3976 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3977 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3978 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3979 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3980 let logger = test_utils::TestLogger::new();
3982 let (payment_preimage_1, _, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
3984 // Now try to send a second payment which will fail to send
3985 let (payment_preimage_2, payment_hash_2, payment_secret_2) = get_payment_preimage_hash!(nodes[1]);
3986 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3987 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();
3988 nodes[0].node.send_payment(&route, payment_hash_2, &Some(payment_secret_2)).unwrap();
3989 check_added_monitors!(nodes[0], 1);
3991 let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
3992 assert_eq!(events_1.len(), 1);
3994 MessageSendEvent::UpdateHTLCs { .. } => {},
3995 _ => panic!("Unexpected event"),
3998 assert!(nodes[1].node.claim_funds(payment_preimage_1));
3999 check_added_monitors!(nodes[1], 1);
4001 let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
4002 assert_eq!(events_2.len(), 1);
4004 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 } } => {
4005 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
4006 assert!(update_add_htlcs.is_empty());
4007 assert_eq!(update_fulfill_htlcs.len(), 1);
4008 assert!(update_fail_htlcs.is_empty());
4009 assert!(update_fail_malformed_htlcs.is_empty());
4010 assert!(update_fee.is_none());
4012 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlcs[0]);
4013 let events_3 = nodes[0].node.get_and_clear_pending_events();
4014 assert_eq!(events_3.len(), 1);
4016 Event::PaymentSent { ref payment_preimage } => {
4017 assert_eq!(*payment_preimage, payment_preimage_1);
4019 _ => panic!("Unexpected event"),
4022 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), commitment_signed);
4023 let _ = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
4024 // No commitment_signed so get_event_msg's assert(len == 1) passes
4025 check_added_monitors!(nodes[0], 1);
4027 _ => panic!("Unexpected event"),
4030 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
4031 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4033 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4034 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
4035 assert_eq!(reestablish_1.len(), 1);
4036 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4037 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
4038 assert_eq!(reestablish_2.len(), 1);
4040 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
4041 let as_resp = handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
4042 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
4043 let bs_resp = handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
4045 assert!(as_resp.0.is_none());
4046 assert!(bs_resp.0.is_none());
4048 assert!(bs_resp.1.is_none());
4049 assert!(bs_resp.2.is_none());
4051 assert!(as_resp.3 == RAACommitmentOrder::CommitmentFirst);
4053 assert_eq!(as_resp.2.as_ref().unwrap().update_add_htlcs.len(), 1);
4054 assert!(as_resp.2.as_ref().unwrap().update_fulfill_htlcs.is_empty());
4055 assert!(as_resp.2.as_ref().unwrap().update_fail_htlcs.is_empty());
4056 assert!(as_resp.2.as_ref().unwrap().update_fail_malformed_htlcs.is_empty());
4057 assert!(as_resp.2.as_ref().unwrap().update_fee.is_none());
4058 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &as_resp.2.as_ref().unwrap().update_add_htlcs[0]);
4059 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_resp.2.as_ref().unwrap().commitment_signed);
4060 let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
4061 // No commitment_signed so get_event_msg's assert(len == 1) passes
4062 check_added_monitors!(nodes[1], 1);
4064 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), as_resp.1.as_ref().unwrap());
4065 let bs_second_commitment_signed = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4066 assert!(bs_second_commitment_signed.update_add_htlcs.is_empty());
4067 assert!(bs_second_commitment_signed.update_fulfill_htlcs.is_empty());
4068 assert!(bs_second_commitment_signed.update_fail_htlcs.is_empty());
4069 assert!(bs_second_commitment_signed.update_fail_malformed_htlcs.is_empty());
4070 assert!(bs_second_commitment_signed.update_fee.is_none());
4071 check_added_monitors!(nodes[1], 1);
4073 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
4074 let as_commitment_signed = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
4075 assert!(as_commitment_signed.update_add_htlcs.is_empty());
4076 assert!(as_commitment_signed.update_fulfill_htlcs.is_empty());
4077 assert!(as_commitment_signed.update_fail_htlcs.is_empty());
4078 assert!(as_commitment_signed.update_fail_malformed_htlcs.is_empty());
4079 assert!(as_commitment_signed.update_fee.is_none());
4080 check_added_monitors!(nodes[0], 1);
4082 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_commitment_signed.commitment_signed);
4083 let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
4084 // No commitment_signed so get_event_msg's assert(len == 1) passes
4085 check_added_monitors!(nodes[0], 1);
4087 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed.commitment_signed);
4088 let bs_second_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
4089 // No commitment_signed so get_event_msg's assert(len == 1) passes
4090 check_added_monitors!(nodes[1], 1);
4092 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
4093 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4094 check_added_monitors!(nodes[1], 1);
4096 expect_pending_htlcs_forwardable!(nodes[1]);
4098 let events_5 = nodes[1].node.get_and_clear_pending_events();
4099 assert_eq!(events_5.len(), 1);
4101 Event::PaymentReceived { ref payment_hash, ref payment_preimage, ref payment_secret, amt: _, user_payment_id: _ } => {
4102 assert_eq!(payment_hash_2, *payment_hash);
4103 assert!(payment_preimage.is_none());
4104 assert_eq!(payment_secret_2, *payment_secret);
4106 _ => panic!("Unexpected event"),
4109 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke_and_ack);
4110 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4111 check_added_monitors!(nodes[0], 1);
4113 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
4116 fn do_test_htlc_timeout(send_partial_mpp: bool) {
4117 // If the user fails to claim/fail an HTLC within the HTLC CLTV timeout we fail it for them
4118 // to avoid our counterparty failing the channel.
4119 let chanmon_cfgs = create_chanmon_cfgs(2);
4120 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4121 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4122 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4124 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4125 let logger = test_utils::TestLogger::new();
4127 let our_payment_hash = if send_partial_mpp {
4128 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
4129 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();
4130 let (_, our_payment_hash, payment_secret) = get_payment_preimage_hash!(&nodes[1]);
4131 // Use the utility function send_payment_along_path to send the payment with MPP data which
4132 // indicates there are more HTLCs coming.
4133 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.
4134 nodes[0].node.send_payment_along_path(&route.paths[0], &our_payment_hash, &Some(payment_secret), 200000, cur_height).unwrap();
4135 check_added_monitors!(nodes[0], 1);
4136 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
4137 assert_eq!(events.len(), 1);
4138 // Now do the relevant commitment_signed/RAA dances along the path, noting that the final
4139 // hop should *not* yet generate any PaymentReceived event(s).
4140 pass_along_path(&nodes[0], &[&nodes[1]], 100000, our_payment_hash, payment_secret, events.drain(..).next().unwrap(), false);
4143 route_payment(&nodes[0], &[&nodes[1]], 100000).1
4146 let mut block = Block {
4147 header: BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
4150 connect_block(&nodes[0], &block);
4151 connect_block(&nodes[1], &block);
4152 let block_count = TEST_FINAL_CLTV + CHAN_CONFIRM_DEPTH + 2 - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS;
4153 for _ in CHAN_CONFIRM_DEPTH + 2..block_count {
4154 block.header.prev_blockhash = block.block_hash();
4155 connect_block(&nodes[0], &block);
4156 connect_block(&nodes[1], &block);
4159 expect_pending_htlcs_forwardable!(nodes[1]);
4161 check_added_monitors!(nodes[1], 1);
4162 let htlc_timeout_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4163 assert!(htlc_timeout_updates.update_add_htlcs.is_empty());
4164 assert_eq!(htlc_timeout_updates.update_fail_htlcs.len(), 1);
4165 assert!(htlc_timeout_updates.update_fail_malformed_htlcs.is_empty());
4166 assert!(htlc_timeout_updates.update_fee.is_none());
4168 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_timeout_updates.update_fail_htlcs[0]);
4169 commitment_signed_dance!(nodes[0], nodes[1], htlc_timeout_updates.commitment_signed, false);
4170 // 100_000 msat as u64, followed by the height at which we failed back above
4171 let mut expected_failure_data = byte_utils::be64_to_array(100_000).to_vec();
4172 expected_failure_data.extend_from_slice(&byte_utils::be32_to_array(block_count - 1));
4173 expect_payment_failed!(nodes[0], our_payment_hash, true, 0x4000 | 15, &expected_failure_data[..]);
4177 fn test_htlc_timeout() {
4178 do_test_htlc_timeout(true);
4179 do_test_htlc_timeout(false);
4182 fn do_test_holding_cell_htlc_add_timeouts(forwarded_htlc: bool) {
4183 // Tests that HTLCs in the holding cell are timed out after the requisite number of blocks.
4184 let chanmon_cfgs = create_chanmon_cfgs(3);
4185 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
4186 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
4187 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
4188 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4189 create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
4191 // Make sure all nodes are at the same starting height
4192 connect_blocks(&nodes[0], 2*CHAN_CONFIRM_DEPTH + 1 - nodes[0].best_block_info().1);
4193 connect_blocks(&nodes[1], 2*CHAN_CONFIRM_DEPTH + 1 - nodes[1].best_block_info().1);
4194 connect_blocks(&nodes[2], 2*CHAN_CONFIRM_DEPTH + 1 - nodes[2].best_block_info().1);
4196 let logger = test_utils::TestLogger::new();
4198 // Route a first payment to get the 1 -> 2 channel in awaiting_raa...
4199 let (_, first_payment_hash, first_payment_secret) = get_payment_preimage_hash!(nodes[2]);
4201 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
4202 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();
4203 nodes[1].node.send_payment(&route, first_payment_hash, &Some(first_payment_secret)).unwrap();
4205 assert_eq!(nodes[1].node.get_and_clear_pending_msg_events().len(), 1);
4206 check_added_monitors!(nodes[1], 1);
4208 // Now attempt to route a second payment, which should be placed in the holding cell
4209 let (_, second_payment_hash, second_payment_secret) = get_payment_preimage_hash!(nodes[2]);
4211 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
4212 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();
4213 nodes[0].node.send_payment(&route, second_payment_hash, &Some(first_payment_secret)).unwrap();
4214 check_added_monitors!(nodes[0], 1);
4215 let payment_event = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
4216 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
4217 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
4218 expect_pending_htlcs_forwardable!(nodes[1]);
4219 check_added_monitors!(nodes[1], 0);
4221 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
4222 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();
4223 nodes[1].node.send_payment(&route, second_payment_hash, &Some(second_payment_secret)).unwrap();
4224 check_added_monitors!(nodes[1], 0);
4227 connect_blocks(&nodes[1], TEST_FINAL_CLTV - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS);
4228 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4229 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
4230 connect_blocks(&nodes[1], 1);
4233 expect_pending_htlcs_forwardable!(nodes[1]);
4234 check_added_monitors!(nodes[1], 1);
4235 let fail_commit = nodes[1].node.get_and_clear_pending_msg_events();
4236 assert_eq!(fail_commit.len(), 1);
4237 match fail_commit[0] {
4238 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fail_htlcs, ref commitment_signed, .. }, .. } => {
4239 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
4240 commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, true, true);
4242 _ => unreachable!(),
4244 expect_payment_failed!(nodes[0], second_payment_hash, false);
4245 if let &MessageSendEvent::PaymentFailureNetworkUpdate { ref update } = &nodes[0].node.get_and_clear_pending_msg_events()[0] {
4247 &HTLCFailChannelUpdate::ChannelUpdateMessage { .. } => {},
4248 _ => panic!("Unexpected event"),
4251 panic!("Unexpected event");
4254 expect_payment_failed!(nodes[1], second_payment_hash, true);
4259 fn test_holding_cell_htlc_add_timeouts() {
4260 do_test_holding_cell_htlc_add_timeouts(false);
4261 do_test_holding_cell_htlc_add_timeouts(true);
4265 fn test_invalid_channel_announcement() {
4266 //Test BOLT 7 channel_announcement msg requirement for final node, gather data to build customed channel_announcement msgs
4267 let secp_ctx = Secp256k1::new();
4268 let chanmon_cfgs = create_chanmon_cfgs(2);
4269 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4270 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4271 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4273 let chan_announcement = create_chan_between_nodes(&nodes[0], &nodes[1], InitFeatures::known(), InitFeatures::known());
4275 let a_channel_lock = nodes[0].node.channel_state.lock().unwrap();
4276 let b_channel_lock = nodes[1].node.channel_state.lock().unwrap();
4277 let as_chan = a_channel_lock.by_id.get(&chan_announcement.3).unwrap();
4278 let bs_chan = b_channel_lock.by_id.get(&chan_announcement.3).unwrap();
4280 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 } );
4282 let as_bitcoin_key = as_chan.get_signer().inner.holder_channel_pubkeys.funding_pubkey;
4283 let bs_bitcoin_key = bs_chan.get_signer().inner.holder_channel_pubkeys.funding_pubkey;
4285 let as_network_key = nodes[0].node.get_our_node_id();
4286 let bs_network_key = nodes[1].node.get_our_node_id();
4288 let were_node_one = as_bitcoin_key.serialize()[..] < bs_bitcoin_key.serialize()[..];
4290 let mut chan_announcement;
4292 macro_rules! dummy_unsigned_msg {
4294 msgs::UnsignedChannelAnnouncement {
4295 features: ChannelFeatures::known(),
4296 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
4297 short_channel_id: as_chan.get_short_channel_id().unwrap(),
4298 node_id_1: if were_node_one { as_network_key } else { bs_network_key },
4299 node_id_2: if were_node_one { bs_network_key } else { as_network_key },
4300 bitcoin_key_1: if were_node_one { as_bitcoin_key } else { bs_bitcoin_key },
4301 bitcoin_key_2: if were_node_one { bs_bitcoin_key } else { as_bitcoin_key },
4302 excess_data: Vec::new(),
4307 macro_rules! sign_msg {
4308 ($unsigned_msg: expr) => {
4309 let msghash = Message::from_slice(&Sha256dHash::hash(&$unsigned_msg.encode()[..])[..]).unwrap();
4310 let as_bitcoin_sig = secp_ctx.sign(&msghash, &as_chan.get_signer().inner.funding_key);
4311 let bs_bitcoin_sig = secp_ctx.sign(&msghash, &bs_chan.get_signer().inner.funding_key);
4312 let as_node_sig = secp_ctx.sign(&msghash, &nodes[0].keys_manager.get_node_secret());
4313 let bs_node_sig = secp_ctx.sign(&msghash, &nodes[1].keys_manager.get_node_secret());
4314 chan_announcement = msgs::ChannelAnnouncement {
4315 node_signature_1 : if were_node_one { as_node_sig } else { bs_node_sig},
4316 node_signature_2 : if were_node_one { bs_node_sig } else { as_node_sig},
4317 bitcoin_signature_1: if were_node_one { as_bitcoin_sig } else { bs_bitcoin_sig },
4318 bitcoin_signature_2 : if were_node_one { bs_bitcoin_sig } else { as_bitcoin_sig },
4319 contents: $unsigned_msg
4324 let unsigned_msg = dummy_unsigned_msg!();
4325 sign_msg!(unsigned_msg);
4326 assert_eq!(nodes[0].net_graph_msg_handler.handle_channel_announcement(&chan_announcement).unwrap(), true);
4327 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 } );
4329 // Configured with Network::Testnet
4330 let mut unsigned_msg = dummy_unsigned_msg!();
4331 unsigned_msg.chain_hash = genesis_block(Network::Bitcoin).header.block_hash();
4332 sign_msg!(unsigned_msg);
4333 assert!(nodes[0].net_graph_msg_handler.handle_channel_announcement(&chan_announcement).is_err());
4335 let mut unsigned_msg = dummy_unsigned_msg!();
4336 unsigned_msg.chain_hash = BlockHash::hash(&[1,2,3,4,5,6,7,8,9]);
4337 sign_msg!(unsigned_msg);
4338 assert!(nodes[0].net_graph_msg_handler.handle_channel_announcement(&chan_announcement).is_err());
4342 fn test_no_txn_manager_serialize_deserialize() {
4343 let chanmon_cfgs = create_chanmon_cfgs(2);
4344 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4345 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4346 let logger: test_utils::TestLogger;
4347 let fee_estimator: test_utils::TestFeeEstimator;
4348 let persister: test_utils::TestPersister;
4349 let new_chain_monitor: test_utils::TestChainMonitor;
4350 let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4351 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4353 let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
4355 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4357 let nodes_0_serialized = nodes[0].node.encode();
4358 let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4359 nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
4361 logger = test_utils::TestLogger::new();
4362 fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
4363 persister = test_utils::TestPersister::new();
4364 let keys_manager = &chanmon_cfgs[0].keys_manager;
4365 new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator, &persister, keys_manager);
4366 nodes[0].chain_monitor = &new_chain_monitor;
4367 let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4368 let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
4369 &mut chan_0_monitor_read, keys_manager).unwrap();
4370 assert!(chan_0_monitor_read.is_empty());
4372 let mut nodes_0_read = &nodes_0_serialized[..];
4373 let config = UserConfig::default();
4374 let (_, nodes_0_deserialized_tmp) = {
4375 let mut channel_monitors = HashMap::new();
4376 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4377 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4378 default_config: config,
4380 fee_estimator: &fee_estimator,
4381 chain_monitor: nodes[0].chain_monitor,
4382 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4387 nodes_0_deserialized = nodes_0_deserialized_tmp;
4388 assert!(nodes_0_read.is_empty());
4390 assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4391 nodes[0].node = &nodes_0_deserialized;
4392 assert_eq!(nodes[0].node.list_channels().len(), 1);
4393 check_added_monitors!(nodes[0], 1);
4395 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4396 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
4397 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4398 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
4400 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
4401 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4402 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
4403 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4405 let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
4406 let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
4407 for node in nodes.iter() {
4408 assert!(node.net_graph_msg_handler.handle_channel_announcement(&announcement).unwrap());
4409 node.net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
4410 node.net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
4413 send_payment(&nodes[0], &[&nodes[1]], 1000000);
4417 fn test_dup_htlc_onchain_fails_on_reload() {
4418 // When a Channel is closed, any outbound HTLCs which were relayed through it are simply
4419 // dropped when the Channel is. From there, the ChannelManager relies on the ChannelMonitor
4420 // having a copy of the relevant fail-/claim-back data and processes the HTLC fail/claim when
4421 // the ChannelMonitor tells it to.
4423 // If, due to an on-chain event, an HTLC is failed/claimed, and then we serialize the
4424 // ChannelManager, we generally expect there not to be a duplicate HTLC fail/claim (eg via a
4425 // PaymentFailed event appearing). However, because we may not serialize the relevant
4426 // ChannelMonitor at the same time, this isn't strictly guaranteed. In order to provide this
4427 // consistency, the ChannelManager explicitly tracks pending-onchain-resolution outbound HTLCs
4428 // and de-duplicates ChannelMonitor events.
4430 // This tests that explicit tracking behavior.
4431 let chanmon_cfgs = create_chanmon_cfgs(2);
4432 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4433 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4434 let persister: test_utils::TestPersister;
4435 let new_chain_monitor: test_utils::TestChainMonitor;
4436 let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4437 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4439 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4441 // Route a payment, but force-close the channel before the HTLC fulfill message arrives at
4443 let (payment_preimage, _, _) = route_payment(&nodes[0], &[&nodes[1]], 10000000);
4444 nodes[0].node.force_close_channel(&nodes[0].node.list_channels()[0].channel_id).unwrap();
4445 check_closed_broadcast!(nodes[0], true);
4446 check_added_monitors!(nodes[0], 1);
4448 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
4449 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4451 // Connect blocks until the CLTV timeout is up so that we get an HTLC-Timeout transaction
4452 connect_blocks(&nodes[0], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + 1);
4453 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
4454 assert_eq!(node_txn.len(), 3);
4455 assert_eq!(node_txn[0], node_txn[1]);
4457 assert!(nodes[1].node.claim_funds(payment_preimage));
4458 check_added_monitors!(nodes[1], 1);
4460 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4461 connect_block(&nodes[1], &Block { header, txdata: vec![node_txn[1].clone(), node_txn[2].clone()]});
4462 check_closed_broadcast!(nodes[1], true);
4463 check_added_monitors!(nodes[1], 1);
4464 let claim_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
4466 header.prev_blockhash = nodes[0].best_block_hash();
4467 connect_block(&nodes[0], &Block { header, txdata: vec![node_txn[1].clone(), node_txn[2].clone()]});
4469 // Serialize out the ChannelMonitor before connecting the on-chain claim transactions. This is
4470 // fairly normal behavior as ChannelMonitor(s) are often not re-serialized when on-chain events
4471 // happen, unlike ChannelManager which tends to be re-serialized after any relevant event(s).
4472 let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4473 nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
4475 header.prev_blockhash = nodes[0].best_block_hash();
4476 let claim_block = Block { header, txdata: claim_txn};
4477 connect_block(&nodes[0], &claim_block);
4478 expect_payment_sent!(nodes[0], payment_preimage);
4480 // ChannelManagers generally get re-serialized after any relevant event(s). Since we just
4481 // connected a highly-relevant block, it likely gets serialized out now.
4482 let mut chan_manager_serialized = test_utils::TestVecWriter(Vec::new());
4483 nodes[0].node.write(&mut chan_manager_serialized).unwrap();
4485 // Now reload nodes[0]...
4486 persister = test_utils::TestPersister::new();
4487 let keys_manager = &chanmon_cfgs[0].keys_manager;
4488 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);
4489 nodes[0].chain_monitor = &new_chain_monitor;
4490 let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4491 let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
4492 &mut chan_0_monitor_read, keys_manager).unwrap();
4493 assert!(chan_0_monitor_read.is_empty());
4495 let (_, nodes_0_deserialized_tmp) = {
4496 let mut channel_monitors = HashMap::new();
4497 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4498 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>
4499 ::read(&mut std::io::Cursor::new(&chan_manager_serialized.0[..]), ChannelManagerReadArgs {
4500 default_config: Default::default(),
4502 fee_estimator: node_cfgs[0].fee_estimator,
4503 chain_monitor: nodes[0].chain_monitor,
4504 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4505 logger: nodes[0].logger,
4509 nodes_0_deserialized = nodes_0_deserialized_tmp;
4511 assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4512 check_added_monitors!(nodes[0], 1);
4513 nodes[0].node = &nodes_0_deserialized;
4515 // Note that if we re-connect the block which exposed nodes[0] to the payment preimage (but
4516 // which the current ChannelMonitor has not seen), the ChannelManager's de-duplication of
4517 // payment events should kick in, leaving us with no pending events here.
4518 let height = nodes[0].blocks.lock().unwrap().len() as u32 - 1;
4519 nodes[0].chain_monitor.chain_monitor.block_connected(&claim_block, height);
4520 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
4524 fn test_manager_serialize_deserialize_events() {
4525 // This test makes sure the events field in ChannelManager survives de/serialization
4526 let chanmon_cfgs = create_chanmon_cfgs(2);
4527 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4528 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4529 let fee_estimator: test_utils::TestFeeEstimator;
4530 let persister: test_utils::TestPersister;
4531 let logger: test_utils::TestLogger;
4532 let new_chain_monitor: test_utils::TestChainMonitor;
4533 let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4534 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4536 // Start creating a channel, but stop right before broadcasting the funding transaction
4537 let channel_value = 100000;
4538 let push_msat = 10001;
4539 let a_flags = InitFeatures::known();
4540 let b_flags = InitFeatures::known();
4541 let node_a = nodes.remove(0);
4542 let node_b = nodes.remove(0);
4543 node_a.node.create_channel(node_b.node.get_our_node_id(), channel_value, push_msat, 42, None).unwrap();
4544 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()));
4545 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()));
4547 let (temporary_channel_id, tx, funding_output) = create_funding_transaction(&node_a, channel_value, 42);
4549 node_a.node.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
4550 check_added_monitors!(node_a, 0);
4552 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()));
4554 let mut added_monitors = node_b.chain_monitor.added_monitors.lock().unwrap();
4555 assert_eq!(added_monitors.len(), 1);
4556 assert_eq!(added_monitors[0].0, funding_output);
4557 added_monitors.clear();
4560 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()));
4562 let mut added_monitors = node_a.chain_monitor.added_monitors.lock().unwrap();
4563 assert_eq!(added_monitors.len(), 1);
4564 assert_eq!(added_monitors[0].0, funding_output);
4565 added_monitors.clear();
4567 // Normally, this is where node_a would broadcast the funding transaction, but the test de/serializes first instead
4572 // Start the de/seriailization process mid-channel creation to check that the channel manager will hold onto events that are serialized
4573 let nodes_0_serialized = nodes[0].node.encode();
4574 let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4575 nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
4577 fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
4578 logger = test_utils::TestLogger::new();
4579 persister = test_utils::TestPersister::new();
4580 let keys_manager = &chanmon_cfgs[0].keys_manager;
4581 new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator, &persister, keys_manager);
4582 nodes[0].chain_monitor = &new_chain_monitor;
4583 let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4584 let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
4585 &mut chan_0_monitor_read, keys_manager).unwrap();
4586 assert!(chan_0_monitor_read.is_empty());
4588 let mut nodes_0_read = &nodes_0_serialized[..];
4589 let config = UserConfig::default();
4590 let (_, nodes_0_deserialized_tmp) = {
4591 let mut channel_monitors = HashMap::new();
4592 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4593 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4594 default_config: config,
4596 fee_estimator: &fee_estimator,
4597 chain_monitor: nodes[0].chain_monitor,
4598 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4603 nodes_0_deserialized = nodes_0_deserialized_tmp;
4604 assert!(nodes_0_read.is_empty());
4606 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4608 assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4609 nodes[0].node = &nodes_0_deserialized;
4611 // After deserializing, make sure the funding_transaction is still held by the channel manager
4612 let events_4 = nodes[0].node.get_and_clear_pending_events();
4613 assert_eq!(events_4.len(), 0);
4614 assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
4615 assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0].txid(), funding_output.txid);
4617 // Make sure the channel is functioning as though the de/serialization never happened
4618 assert_eq!(nodes[0].node.list_channels().len(), 1);
4619 check_added_monitors!(nodes[0], 1);
4621 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4622 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
4623 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4624 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
4626 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
4627 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4628 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
4629 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4631 let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
4632 let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
4633 for node in nodes.iter() {
4634 assert!(node.net_graph_msg_handler.handle_channel_announcement(&announcement).unwrap());
4635 node.net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
4636 node.net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
4639 send_payment(&nodes[0], &[&nodes[1]], 1000000);
4643 fn test_simple_manager_serialize_deserialize() {
4644 let chanmon_cfgs = create_chanmon_cfgs(2);
4645 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4646 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4647 let logger: test_utils::TestLogger;
4648 let fee_estimator: test_utils::TestFeeEstimator;
4649 let persister: test_utils::TestPersister;
4650 let new_chain_monitor: test_utils::TestChainMonitor;
4651 let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4652 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4653 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4655 let (our_payment_preimage, _, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
4656 let (_, our_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
4658 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4660 let nodes_0_serialized = nodes[0].node.encode();
4661 let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4662 nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
4664 logger = test_utils::TestLogger::new();
4665 fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
4666 persister = test_utils::TestPersister::new();
4667 let keys_manager = &chanmon_cfgs[0].keys_manager;
4668 new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator, &persister, keys_manager);
4669 nodes[0].chain_monitor = &new_chain_monitor;
4670 let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4671 let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
4672 &mut chan_0_monitor_read, keys_manager).unwrap();
4673 assert!(chan_0_monitor_read.is_empty());
4675 let mut nodes_0_read = &nodes_0_serialized[..];
4676 let (_, nodes_0_deserialized_tmp) = {
4677 let mut channel_monitors = HashMap::new();
4678 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4679 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4680 default_config: UserConfig::default(),
4682 fee_estimator: &fee_estimator,
4683 chain_monitor: nodes[0].chain_monitor,
4684 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4689 nodes_0_deserialized = nodes_0_deserialized_tmp;
4690 assert!(nodes_0_read.is_empty());
4692 assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4693 nodes[0].node = &nodes_0_deserialized;
4694 check_added_monitors!(nodes[0], 1);
4696 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
4698 fail_payment(&nodes[0], &[&nodes[1]], our_payment_hash);
4699 claim_payment(&nodes[0], &[&nodes[1]], our_payment_preimage);
4703 fn test_manager_serialize_deserialize_inconsistent_monitor() {
4704 // Test deserializing a ChannelManager with an out-of-date ChannelMonitor
4705 let chanmon_cfgs = create_chanmon_cfgs(4);
4706 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
4707 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
4708 let logger: test_utils::TestLogger;
4709 let fee_estimator: test_utils::TestFeeEstimator;
4710 let persister: test_utils::TestPersister;
4711 let new_chain_monitor: test_utils::TestChainMonitor;
4712 let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4713 let mut nodes = create_network(4, &node_cfgs, &node_chanmgrs);
4714 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4715 create_announced_chan_between_nodes(&nodes, 2, 0, InitFeatures::known(), InitFeatures::known());
4716 let (_, _, channel_id, funding_tx) = create_announced_chan_between_nodes(&nodes, 0, 3, InitFeatures::known(), InitFeatures::known());
4718 let mut node_0_stale_monitors_serialized = Vec::new();
4719 for monitor in nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter() {
4720 let mut writer = test_utils::TestVecWriter(Vec::new());
4721 monitor.1.write(&mut writer).unwrap();
4722 node_0_stale_monitors_serialized.push(writer.0);
4725 let (our_payment_preimage, _, _) = route_payment(&nodes[2], &[&nodes[0], &nodes[1]], 1000000);
4727 // Serialize the ChannelManager here, but the monitor we keep up-to-date
4728 let nodes_0_serialized = nodes[0].node.encode();
4730 route_payment(&nodes[0], &[&nodes[3]], 1000000);
4731 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4732 nodes[2].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4733 nodes[3].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4735 // Now the ChannelMonitor (which is now out-of-sync with ChannelManager for channel w/
4737 let mut node_0_monitors_serialized = Vec::new();
4738 for monitor in nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter() {
4739 let mut writer = test_utils::TestVecWriter(Vec::new());
4740 monitor.1.write(&mut writer).unwrap();
4741 node_0_monitors_serialized.push(writer.0);
4744 logger = test_utils::TestLogger::new();
4745 fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
4746 persister = test_utils::TestPersister::new();
4747 let keys_manager = &chanmon_cfgs[0].keys_manager;
4748 new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator, &persister, keys_manager);
4749 nodes[0].chain_monitor = &new_chain_monitor;
4752 let mut node_0_stale_monitors = Vec::new();
4753 for serialized in node_0_stale_monitors_serialized.iter() {
4754 let mut read = &serialized[..];
4755 let (_, monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(&mut read, keys_manager).unwrap();
4756 assert!(read.is_empty());
4757 node_0_stale_monitors.push(monitor);
4760 let mut node_0_monitors = Vec::new();
4761 for serialized in node_0_monitors_serialized.iter() {
4762 let mut read = &serialized[..];
4763 let (_, monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(&mut read, keys_manager).unwrap();
4764 assert!(read.is_empty());
4765 node_0_monitors.push(monitor);
4768 let mut nodes_0_read = &nodes_0_serialized[..];
4769 if let Err(msgs::DecodeError::InvalidValue) =
4770 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4771 default_config: UserConfig::default(),
4773 fee_estimator: &fee_estimator,
4774 chain_monitor: nodes[0].chain_monitor,
4775 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4777 channel_monitors: node_0_stale_monitors.iter_mut().map(|monitor| { (monitor.get_funding_txo().0, monitor) }).collect(),
4779 panic!("If the monitor(s) are stale, this indicates a bug and we should get an Err return");
4782 let mut nodes_0_read = &nodes_0_serialized[..];
4783 let (_, nodes_0_deserialized_tmp) =
4784 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4785 default_config: UserConfig::default(),
4787 fee_estimator: &fee_estimator,
4788 chain_monitor: nodes[0].chain_monitor,
4789 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4791 channel_monitors: node_0_monitors.iter_mut().map(|monitor| { (monitor.get_funding_txo().0, monitor) }).collect(),
4793 nodes_0_deserialized = nodes_0_deserialized_tmp;
4794 assert!(nodes_0_read.is_empty());
4796 { // Channel close should result in a commitment tx
4797 let txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4798 assert_eq!(txn.len(), 1);
4799 check_spends!(txn[0], funding_tx);
4800 assert_eq!(txn[0].input[0].previous_output.txid, funding_tx.txid());
4803 for monitor in node_0_monitors.drain(..) {
4804 assert!(nodes[0].chain_monitor.watch_channel(monitor.get_funding_txo().0, monitor).is_ok());
4805 check_added_monitors!(nodes[0], 1);
4807 nodes[0].node = &nodes_0_deserialized;
4809 // nodes[1] and nodes[2] have no lost state with nodes[0]...
4810 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
4811 reconnect_nodes(&nodes[0], &nodes[2], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
4812 //... and we can even still claim the payment!
4813 claim_payment(&nodes[2], &[&nodes[0], &nodes[1]], our_payment_preimage);
4815 nodes[3].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4816 let reestablish = get_event_msg!(nodes[3], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
4817 nodes[0].node.peer_connected(&nodes[3].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4818 nodes[0].node.handle_channel_reestablish(&nodes[3].node.get_our_node_id(), &reestablish);
4819 let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
4820 assert_eq!(msg_events.len(), 1);
4821 if let MessageSendEvent::HandleError { ref action, .. } = msg_events[0] {
4823 &ErrorAction::SendErrorMessage { ref msg } => {
4824 assert_eq!(msg.channel_id, channel_id);
4826 _ => panic!("Unexpected event!"),
4831 macro_rules! check_spendable_outputs {
4832 ($node: expr, $der_idx: expr, $keysinterface: expr, $chan_value: expr) => {
4834 let mut events = $node.chain_monitor.chain_monitor.get_and_clear_pending_events();
4835 let mut txn = Vec::new();
4836 let mut all_outputs = Vec::new();
4837 let secp_ctx = Secp256k1::new();
4838 for event in events.drain(..) {
4840 Event::SpendableOutputs { mut outputs } => {
4841 for outp in outputs.drain(..) {
4842 txn.push($keysinterface.backing.spend_spendable_outputs(&[&outp], Vec::new(), Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(), 253, &secp_ctx).unwrap());
4843 all_outputs.push(outp);
4846 _ => panic!("Unexpected event"),
4849 if all_outputs.len() > 1 {
4850 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) {
4860 fn test_claim_sizeable_push_msat() {
4861 // Incidentally test SpendableOutput event generation due to detection of to_local output on commitment tx
4862 let chanmon_cfgs = create_chanmon_cfgs(2);
4863 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4864 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4865 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4867 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 99000000, InitFeatures::known(), InitFeatures::known());
4868 nodes[1].node.force_close_channel(&chan.2).unwrap();
4869 check_closed_broadcast!(nodes[1], true);
4870 check_added_monitors!(nodes[1], 1);
4871 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4872 assert_eq!(node_txn.len(), 1);
4873 check_spends!(node_txn[0], chan.3);
4874 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
4876 mine_transaction(&nodes[1], &node_txn[0]);
4877 connect_blocks(&nodes[1], BREAKDOWN_TIMEOUT as u32 - 1);
4879 let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
4880 assert_eq!(spend_txn.len(), 1);
4881 assert_eq!(spend_txn[0].input.len(), 1);
4882 check_spends!(spend_txn[0], node_txn[0]);
4883 assert_eq!(spend_txn[0].input[0].sequence, BREAKDOWN_TIMEOUT as u32);
4887 fn test_claim_on_remote_sizeable_push_msat() {
4888 // Same test as previous, just test on remote commitment tx, as per_commitment_point registration changes following you're funder/fundee and
4889 // to_remote output is encumbered by a P2WPKH
4890 let chanmon_cfgs = create_chanmon_cfgs(2);
4891 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4892 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4893 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4895 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 99000000, InitFeatures::known(), InitFeatures::known());
4896 nodes[0].node.force_close_channel(&chan.2).unwrap();
4897 check_closed_broadcast!(nodes[0], true);
4898 check_added_monitors!(nodes[0], 1);
4900 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4901 assert_eq!(node_txn.len(), 1);
4902 check_spends!(node_txn[0], chan.3);
4903 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
4905 mine_transaction(&nodes[1], &node_txn[0]);
4906 check_closed_broadcast!(nodes[1], true);
4907 check_added_monitors!(nodes[1], 1);
4908 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4910 let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
4911 assert_eq!(spend_txn.len(), 1);
4912 check_spends!(spend_txn[0], node_txn[0]);
4916 fn test_claim_on_remote_revoked_sizeable_push_msat() {
4917 // Same test as previous, just test on remote revoked commitment tx, as per_commitment_point registration changes following you're funder/fundee and
4918 // to_remote output is encumbered by a P2WPKH
4920 let chanmon_cfgs = create_chanmon_cfgs(2);
4921 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4922 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4923 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4925 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 59000000, InitFeatures::known(), InitFeatures::known());
4926 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4927 let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan.2);
4928 assert_eq!(revoked_local_txn[0].input.len(), 1);
4929 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
4931 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
4932 mine_transaction(&nodes[1], &revoked_local_txn[0]);
4933 check_closed_broadcast!(nodes[1], true);
4934 check_added_monitors!(nodes[1], 1);
4936 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4937 mine_transaction(&nodes[1], &node_txn[0]);
4938 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4940 let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
4941 assert_eq!(spend_txn.len(), 3);
4942 check_spends!(spend_txn[0], revoked_local_txn[0]); // to_remote output on revoked remote commitment_tx
4943 check_spends!(spend_txn[1], node_txn[0]);
4944 check_spends!(spend_txn[2], revoked_local_txn[0], node_txn[0]); // Both outputs
4948 fn test_static_spendable_outputs_preimage_tx() {
4949 let chanmon_cfgs = create_chanmon_cfgs(2);
4950 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4951 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4952 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4954 // Create some initial channels
4955 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4957 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4959 let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
4960 assert_eq!(commitment_tx[0].input.len(), 1);
4961 assert_eq!(commitment_tx[0].input[0].previous_output.txid, chan_1.3.txid());
4963 // Settle A's commitment tx on B's chain
4964 assert!(nodes[1].node.claim_funds(payment_preimage));
4965 check_added_monitors!(nodes[1], 1);
4966 mine_transaction(&nodes[1], &commitment_tx[0]);
4967 check_added_monitors!(nodes[1], 1);
4968 let events = nodes[1].node.get_and_clear_pending_msg_events();
4970 MessageSendEvent::UpdateHTLCs { .. } => {},
4971 _ => panic!("Unexpected event"),
4974 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
4975 _ => panic!("Unexepected event"),
4978 // Check B's monitor was able to send back output descriptor event for preimage tx on A's commitment tx
4979 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap(); // ChannelManager : 2 (local commitment tx + HTLC-Success), ChannelMonitor: preimage tx
4980 assert_eq!(node_txn.len(), 3);
4981 check_spends!(node_txn[0], commitment_tx[0]);
4982 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
4983 check_spends!(node_txn[1], chan_1.3);
4984 check_spends!(node_txn[2], node_txn[1]);
4986 mine_transaction(&nodes[1], &node_txn[0]);
4987 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4989 let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
4990 assert_eq!(spend_txn.len(), 1);
4991 check_spends!(spend_txn[0], node_txn[0]);
4995 fn test_static_spendable_outputs_timeout_tx() {
4996 let chanmon_cfgs = create_chanmon_cfgs(2);
4997 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4998 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4999 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5001 // Create some initial channels
5002 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5004 // Rebalance the network a bit by relaying one payment through all the channels ...
5005 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
5007 let (_, our_payment_hash, _) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3_000_000);
5009 let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
5010 assert_eq!(commitment_tx[0].input.len(), 1);
5011 assert_eq!(commitment_tx[0].input[0].previous_output.txid, chan_1.3.txid());
5013 // Settle A's commitment tx on B' chain
5014 mine_transaction(&nodes[1], &commitment_tx[0]);
5015 check_added_monitors!(nodes[1], 1);
5016 let events = nodes[1].node.get_and_clear_pending_msg_events();
5018 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5019 _ => panic!("Unexpected event"),
5021 connect_blocks(&nodes[1], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
5023 // Check B's monitor was able to send back output descriptor event for timeout tx on A's commitment tx
5024 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
5025 assert_eq!(node_txn.len(), 2); // ChannelManager : 1 local commitent tx, ChannelMonitor: timeout tx
5026 check_spends!(node_txn[0], chan_1.3.clone());
5027 check_spends!(node_txn[1], commitment_tx[0].clone());
5028 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5030 mine_transaction(&nodes[1], &node_txn[1]);
5031 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
5032 expect_payment_failed!(nodes[1], our_payment_hash, true);
5034 let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
5035 assert_eq!(spend_txn.len(), 3); // SpendableOutput: remote_commitment_tx.to_remote, timeout_tx.output
5036 check_spends!(spend_txn[0], commitment_tx[0]);
5037 check_spends!(spend_txn[1], node_txn[1]);
5038 check_spends!(spend_txn[2], node_txn[1], commitment_tx[0]); // All outputs
5042 fn test_static_spendable_outputs_justice_tx_revoked_commitment_tx() {
5043 let chanmon_cfgs = create_chanmon_cfgs(2);
5044 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5045 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5046 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5048 // Create some initial channels
5049 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5051 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
5052 let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
5053 assert_eq!(revoked_local_txn[0].input.len(), 1);
5054 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
5056 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
5058 mine_transaction(&nodes[1], &revoked_local_txn[0]);
5059 check_closed_broadcast!(nodes[1], true);
5060 check_added_monitors!(nodes[1], 1);
5062 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5063 assert_eq!(node_txn.len(), 2);
5064 assert_eq!(node_txn[0].input.len(), 2);
5065 check_spends!(node_txn[0], revoked_local_txn[0]);
5067 mine_transaction(&nodes[1], &node_txn[0]);
5068 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
5070 let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
5071 assert_eq!(spend_txn.len(), 1);
5072 check_spends!(spend_txn[0], node_txn[0]);
5076 fn test_static_spendable_outputs_justice_tx_revoked_htlc_timeout_tx() {
5077 let mut chanmon_cfgs = create_chanmon_cfgs(2);
5078 chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
5079 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5080 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5081 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5083 // Create some initial channels
5084 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5086 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
5087 let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
5088 assert_eq!(revoked_local_txn[0].input.len(), 1);
5089 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
5091 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
5093 // A will generate HTLC-Timeout from revoked commitment tx
5094 mine_transaction(&nodes[0], &revoked_local_txn[0]);
5095 check_closed_broadcast!(nodes[0], true);
5096 check_added_monitors!(nodes[0], 1);
5097 connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
5099 let revoked_htlc_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5100 assert_eq!(revoked_htlc_txn.len(), 2);
5101 check_spends!(revoked_htlc_txn[0], chan_1.3);
5102 assert_eq!(revoked_htlc_txn[1].input.len(), 1);
5103 assert_eq!(revoked_htlc_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5104 check_spends!(revoked_htlc_txn[1], revoked_local_txn[0]);
5105 assert_ne!(revoked_htlc_txn[1].lock_time, 0); // HTLC-Timeout
5107 // B will generate justice tx from A's revoked commitment/HTLC tx
5108 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5109 connect_block(&nodes[1], &Block { header, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[1].clone()] });
5110 check_closed_broadcast!(nodes[1], true);
5111 check_added_monitors!(nodes[1], 1);
5113 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5114 assert_eq!(node_txn.len(), 3); // ChannelMonitor: bogus justice tx, justice tx on revoked outputs, ChannelManager: local commitment tx
5115 // The first transaction generated is bogus - it spends both outputs of revoked_local_txn[0]
5116 // including the one already spent by revoked_htlc_txn[1]. That's OK, we'll spend with valid
5117 // transactions next...
5118 assert_eq!(node_txn[0].input.len(), 3);
5119 check_spends!(node_txn[0], revoked_local_txn[0], revoked_htlc_txn[1]);
5121 assert_eq!(node_txn[1].input.len(), 2);
5122 check_spends!(node_txn[1], revoked_local_txn[0], revoked_htlc_txn[1]);
5123 if node_txn[1].input[1].previous_output.txid == revoked_htlc_txn[1].txid() {
5124 assert_ne!(node_txn[1].input[0].previous_output, revoked_htlc_txn[1].input[0].previous_output);
5126 assert_eq!(node_txn[1].input[0].previous_output.txid, revoked_htlc_txn[1].txid());
5127 assert_ne!(node_txn[1].input[1].previous_output, revoked_htlc_txn[1].input[0].previous_output);
5130 assert_eq!(node_txn[2].input.len(), 1);
5131 check_spends!(node_txn[2], chan_1.3);
5133 mine_transaction(&nodes[1], &node_txn[1]);
5134 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
5136 // Check B's ChannelMonitor was able to generate the right spendable output descriptor
5137 let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
5138 assert_eq!(spend_txn.len(), 1);
5139 assert_eq!(spend_txn[0].input.len(), 1);
5140 check_spends!(spend_txn[0], node_txn[1]);
5144 fn test_static_spendable_outputs_justice_tx_revoked_htlc_success_tx() {
5145 let mut chanmon_cfgs = create_chanmon_cfgs(2);
5146 chanmon_cfgs[1].keys_manager.disable_revocation_policy_check = true;
5147 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5148 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5149 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5151 // Create some initial channels
5152 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5154 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
5155 let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan_1.2);
5156 assert_eq!(revoked_local_txn[0].input.len(), 1);
5157 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
5159 // The to-be-revoked commitment tx should have one HTLC and one to_remote output
5160 assert_eq!(revoked_local_txn[0].output.len(), 2);
5162 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
5164 // B will generate HTLC-Success from revoked commitment tx
5165 mine_transaction(&nodes[1], &revoked_local_txn[0]);
5166 check_closed_broadcast!(nodes[1], true);
5167 check_added_monitors!(nodes[1], 1);
5168 let revoked_htlc_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5170 assert_eq!(revoked_htlc_txn.len(), 2);
5171 assert_eq!(revoked_htlc_txn[0].input.len(), 1);
5172 assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5173 check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
5175 // Check that the unspent (of two) outputs on revoked_local_txn[0] is a P2WPKH:
5176 let unspent_local_txn_output = revoked_htlc_txn[0].input[0].previous_output.vout as usize ^ 1;
5177 assert_eq!(revoked_local_txn[0].output[unspent_local_txn_output].script_pubkey.len(), 2 + 20); // P2WPKH
5179 // A will generate justice tx from B's revoked commitment/HTLC tx
5180 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5181 connect_block(&nodes[0], &Block { header, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[0].clone()] });
5182 check_closed_broadcast!(nodes[0], true);
5183 check_added_monitors!(nodes[0], 1);
5185 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5186 assert_eq!(node_txn.len(), 3); // ChannelMonitor: justice tx on revoked commitment, justice tx on revoked HTLC-success, ChannelManager: local commitment tx
5188 // The first transaction generated is bogus - it spends both outputs of revoked_local_txn[0]
5189 // including the one already spent by revoked_htlc_txn[0]. That's OK, we'll spend with valid
5190 // transactions next...
5191 assert_eq!(node_txn[0].input.len(), 2);
5192 check_spends!(node_txn[0], revoked_local_txn[0], revoked_htlc_txn[0]);
5193 if node_txn[0].input[1].previous_output.txid == revoked_htlc_txn[0].txid() {
5194 assert_eq!(node_txn[0].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
5196 assert_eq!(node_txn[0].input[0].previous_output.txid, revoked_htlc_txn[0].txid());
5197 assert_eq!(node_txn[0].input[1].previous_output, revoked_htlc_txn[0].input[0].previous_output);
5200 assert_eq!(node_txn[1].input.len(), 1);
5201 check_spends!(node_txn[1], revoked_htlc_txn[0]);
5203 check_spends!(node_txn[2], chan_1.3);
5205 mine_transaction(&nodes[0], &node_txn[1]);
5206 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
5208 // Note that nodes[0]'s tx_broadcaster is still locked, so if we get here the channelmonitor
5209 // didn't try to generate any new transactions.
5211 // Check A's ChannelMonitor was able to generate the right spendable output descriptor
5212 let spend_txn = check_spendable_outputs!(nodes[0], 1, node_cfgs[0].keys_manager, 100000);
5213 assert_eq!(spend_txn.len(), 3);
5214 assert_eq!(spend_txn[0].input.len(), 1);
5215 check_spends!(spend_txn[0], revoked_local_txn[0]); // spending to_remote output from revoked local tx
5216 assert_ne!(spend_txn[0].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
5217 check_spends!(spend_txn[1], node_txn[1]); // spending justice tx output on the htlc success tx
5218 check_spends!(spend_txn[2], revoked_local_txn[0], node_txn[1]); // Both outputs
5222 fn test_onchain_to_onchain_claim() {
5223 // Test that in case of channel closure, we detect the state of output and claim HTLC
5224 // on downstream peer's remote commitment tx.
5225 // First, have C claim an HTLC against its own latest commitment transaction.
5226 // Then, broadcast these to B, which should update the monitor downstream on the A<->B
5228 // Finally, check that B will claim the HTLC output if A's latest commitment transaction
5231 let chanmon_cfgs = create_chanmon_cfgs(3);
5232 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5233 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5234 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5236 // Create some initial channels
5237 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5238 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
5240 // Ensure all nodes are at the same height
5241 let node_max_height = nodes.iter().map(|node| node.blocks.lock().unwrap().len()).max().unwrap() as u32;
5242 connect_blocks(&nodes[0], node_max_height - nodes[0].best_block_info().1);
5243 connect_blocks(&nodes[1], node_max_height - nodes[1].best_block_info().1);
5244 connect_blocks(&nodes[2], node_max_height - nodes[2].best_block_info().1);
5246 // Rebalance the network a bit by relaying one payment through all the channels ...
5247 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
5248 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
5250 let (payment_preimage, _payment_hash, _payment_secret) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
5251 let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
5252 check_spends!(commitment_tx[0], chan_2.3);
5253 nodes[2].node.claim_funds(payment_preimage);
5254 check_added_monitors!(nodes[2], 1);
5255 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
5256 assert!(updates.update_add_htlcs.is_empty());
5257 assert!(updates.update_fail_htlcs.is_empty());
5258 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
5259 assert!(updates.update_fail_malformed_htlcs.is_empty());
5261 mine_transaction(&nodes[2], &commitment_tx[0]);
5262 check_closed_broadcast!(nodes[2], true);
5263 check_added_monitors!(nodes[2], 1);
5265 let c_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 2 (commitment tx, HTLC-Success tx), ChannelMonitor : 1 (HTLC-Success tx)
5266 assert_eq!(c_txn.len(), 3);
5267 assert_eq!(c_txn[0], c_txn[2]);
5268 assert_eq!(commitment_tx[0], c_txn[1]);
5269 check_spends!(c_txn[1], chan_2.3);
5270 check_spends!(c_txn[2], c_txn[1]);
5271 assert_eq!(c_txn[1].input[0].witness.clone().last().unwrap().len(), 71);
5272 assert_eq!(c_txn[2].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5273 assert!(c_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
5274 assert_eq!(c_txn[0].lock_time, 0); // Success tx
5276 // 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
5277 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
5278 connect_block(&nodes[1], &Block { header, txdata: vec![c_txn[1].clone(), c_txn[2].clone()]});
5279 connect_blocks(&nodes[1], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
5281 let mut b_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5282 // ChannelMonitor: claim tx, ChannelManager: local commitment tx
5283 assert_eq!(b_txn.len(), 2);
5284 check_spends!(b_txn[0], chan_2.3); // B local commitment tx, issued by ChannelManager
5285 check_spends!(b_txn[1], c_txn[1]); // timeout tx on C remote commitment tx, issued by ChannelMonitor
5286 assert_eq!(b_txn[1].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5287 assert!(b_txn[1].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
5288 assert_ne!(b_txn[1].lock_time, 0); // Timeout tx
5291 check_added_monitors!(nodes[1], 1);
5292 let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
5293 assert_eq!(msg_events.len(), 3);
5294 check_added_monitors!(nodes[1], 1);
5295 match msg_events[0] {
5296 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5297 _ => panic!("Unexpected event"),
5299 match msg_events[1] {
5300 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { .. }, node_id: _ } => {},
5301 _ => panic!("Unexpected event"),
5303 match msg_events[2] {
5304 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, .. } } => {
5305 assert!(update_add_htlcs.is_empty());
5306 assert!(update_fail_htlcs.is_empty());
5307 assert_eq!(update_fulfill_htlcs.len(), 1);
5308 assert!(update_fail_malformed_htlcs.is_empty());
5309 assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
5311 _ => panic!("Unexpected event"),
5313 // Broadcast A's commitment tx on B's chain to see if we are able to claim inbound HTLC with our HTLC-Success tx
5314 let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
5315 mine_transaction(&nodes[1], &commitment_tx[0]);
5316 let b_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5317 // ChannelMonitor: HTLC-Success tx + HTLC-Timeout RBF Bump, ChannelManager: local commitment tx + HTLC-Success tx
5318 assert_eq!(b_txn.len(), 4);
5319 check_spends!(b_txn[2], chan_1.3);
5320 check_spends!(b_txn[3], b_txn[2]);
5321 let (htlc_success_claim, htlc_timeout_bumped) =
5322 if b_txn[0].input[0].previous_output.txid == commitment_tx[0].txid()
5323 { (&b_txn[0], &b_txn[1]) } else { (&b_txn[1], &b_txn[0]) };
5324 check_spends!(htlc_success_claim, commitment_tx[0]);
5325 assert_eq!(htlc_success_claim.input[0].witness.clone().last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5326 assert!(htlc_success_claim.output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
5327 assert_eq!(htlc_success_claim.lock_time, 0); // Success tx
5328 check_spends!(htlc_timeout_bumped, c_txn[1]); // timeout tx on C remote commitment tx, issued by ChannelMonitor
5329 assert_ne!(htlc_timeout_bumped.lock_time, 0); // Success tx
5331 check_closed_broadcast!(nodes[1], true);
5332 check_added_monitors!(nodes[1], 1);
5336 fn test_duplicate_payment_hash_one_failure_one_success() {
5337 // Topology : A --> B --> C --> D
5338 // We route 2 payments with same hash between B and C, one will be timeout, the other successfully claim
5339 // Note that because C will refuse to generate two payment secrets for the same payment hash,
5340 // we forward one of the payments onwards to D.
5341 let chanmon_cfgs = create_chanmon_cfgs(4);
5342 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
5343 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
5344 let mut nodes = create_network(4, &node_cfgs, &node_chanmgrs);
5346 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5347 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
5348 create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
5350 let node_max_height = nodes.iter().map(|node| node.blocks.lock().unwrap().len()).max().unwrap() as u32;
5351 connect_blocks(&nodes[0], node_max_height - nodes[0].best_block_info().1);
5352 connect_blocks(&nodes[1], node_max_height - nodes[1].best_block_info().1);
5353 connect_blocks(&nodes[2], node_max_height - nodes[2].best_block_info().1);
5354 connect_blocks(&nodes[3], node_max_height - nodes[3].best_block_info().1);
5356 let (our_payment_preimage, duplicate_payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 900000);
5358 let payment_secret = nodes[3].node.create_inbound_payment_for_hash(duplicate_payment_hash, None, 7200, 0).unwrap();
5359 // We reduce the final CLTV here by a somewhat arbitrary constant to keep it under the one-byte
5360 // script push size limit so that the below script length checks match
5361 // ACCEPTED_HTLC_SCRIPT_WEIGHT.
5362 let route = get_route(&nodes[0].node.get_our_node_id(), &nodes[0].net_graph_msg_handler.network_graph.read().unwrap(),
5363 &nodes[3].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 900000, TEST_FINAL_CLTV - 40, nodes[0].logger).unwrap();
5364 send_along_route_with_secret(&nodes[0], route, &[&[&nodes[1], &nodes[2], &nodes[3]]], 900000, duplicate_payment_hash, payment_secret);
5366 let commitment_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
5367 assert_eq!(commitment_txn[0].input.len(), 1);
5368 check_spends!(commitment_txn[0], chan_2.3);
5370 mine_transaction(&nodes[1], &commitment_txn[0]);
5371 check_closed_broadcast!(nodes[1], true);
5372 check_added_monitors!(nodes[1], 1);
5373 connect_blocks(&nodes[1], TEST_FINAL_CLTV - 40 + MIN_CLTV_EXPIRY_DELTA as u32 - 1); // Confirm blocks until the HTLC expires
5375 let htlc_timeout_tx;
5376 { // Extract one of the two HTLC-Timeout transaction
5377 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5378 // ChannelMonitor: timeout tx * 3, ChannelManager: local commitment tx
5379 assert_eq!(node_txn.len(), 4);
5380 check_spends!(node_txn[0], chan_2.3);
5382 check_spends!(node_txn[1], commitment_txn[0]);
5383 assert_eq!(node_txn[1].input.len(), 1);
5384 check_spends!(node_txn[2], commitment_txn[0]);
5385 assert_eq!(node_txn[2].input.len(), 1);
5386 assert_eq!(node_txn[1].input[0].previous_output, node_txn[2].input[0].previous_output);
5387 check_spends!(node_txn[3], commitment_txn[0]);
5388 assert_ne!(node_txn[1].input[0].previous_output, node_txn[3].input[0].previous_output);
5390 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5391 assert_eq!(node_txn[2].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5392 assert_eq!(node_txn[3].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5393 htlc_timeout_tx = node_txn[1].clone();
5396 nodes[2].node.claim_funds(our_payment_preimage);
5397 mine_transaction(&nodes[2], &commitment_txn[0]);
5398 check_added_monitors!(nodes[2], 2);
5399 let events = nodes[2].node.get_and_clear_pending_msg_events();
5401 MessageSendEvent::UpdateHTLCs { .. } => {},
5402 _ => panic!("Unexpected event"),
5405 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5406 _ => panic!("Unexepected event"),
5408 let htlc_success_txn: Vec<_> = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
5409 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)
5410 check_spends!(htlc_success_txn[0], commitment_txn[0]);
5411 check_spends!(htlc_success_txn[1], commitment_txn[0]);
5412 assert_eq!(htlc_success_txn[0].input.len(), 1);
5413 assert_eq!(htlc_success_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5414 assert_eq!(htlc_success_txn[1].input.len(), 1);
5415 assert_eq!(htlc_success_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5416 assert_ne!(htlc_success_txn[0].input[0].previous_output, htlc_success_txn[1].input[0].previous_output);
5417 assert_eq!(htlc_success_txn[2], commitment_txn[0]);
5418 assert_eq!(htlc_success_txn[3], htlc_success_txn[0]);
5419 assert_eq!(htlc_success_txn[4], htlc_success_txn[1]);
5420 assert_ne!(htlc_success_txn[0].input[0].previous_output, htlc_timeout_tx.input[0].previous_output);
5422 mine_transaction(&nodes[1], &htlc_timeout_tx);
5423 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
5424 expect_pending_htlcs_forwardable!(nodes[1]);
5425 let htlc_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5426 assert!(htlc_updates.update_add_htlcs.is_empty());
5427 assert_eq!(htlc_updates.update_fail_htlcs.len(), 1);
5428 let first_htlc_id = htlc_updates.update_fail_htlcs[0].htlc_id;
5429 assert!(htlc_updates.update_fulfill_htlcs.is_empty());
5430 assert!(htlc_updates.update_fail_malformed_htlcs.is_empty());
5431 check_added_monitors!(nodes[1], 1);
5433 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_updates.update_fail_htlcs[0]);
5434 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
5436 commitment_signed_dance!(nodes[0], nodes[1], &htlc_updates.commitment_signed, false, true);
5437 let events = nodes[0].node.get_and_clear_pending_msg_events();
5438 assert_eq!(events.len(), 1);
5440 MessageSendEvent::PaymentFailureNetworkUpdate { update: msgs::HTLCFailChannelUpdate::ChannelClosed { .. } } => {
5442 _ => { panic!("Unexpected event"); }
5445 expect_payment_failed!(nodes[0], duplicate_payment_hash, false);
5447 // Solve 2nd HTLC by broadcasting on B's chain HTLC-Success Tx from C
5448 mine_transaction(&nodes[1], &htlc_success_txn[0]);
5449 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5450 assert!(updates.update_add_htlcs.is_empty());
5451 assert!(updates.update_fail_htlcs.is_empty());
5452 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
5453 assert_ne!(updates.update_fulfill_htlcs[0].htlc_id, first_htlc_id);
5454 assert!(updates.update_fail_malformed_htlcs.is_empty());
5455 check_added_monitors!(nodes[1], 1);
5457 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
5458 commitment_signed_dance!(nodes[0], nodes[1], &updates.commitment_signed, false);
5460 let events = nodes[0].node.get_and_clear_pending_events();
5462 Event::PaymentSent { ref payment_preimage } => {
5463 assert_eq!(*payment_preimage, our_payment_preimage);
5465 _ => panic!("Unexpected event"),
5470 fn test_dynamic_spendable_outputs_local_htlc_success_tx() {
5471 let chanmon_cfgs = create_chanmon_cfgs(2);
5472 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5473 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5474 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5476 // Create some initial channels
5477 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5479 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000).0;
5480 let local_txn = get_local_commitment_txn!(nodes[1], chan_1.2);
5481 assert_eq!(local_txn.len(), 1);
5482 assert_eq!(local_txn[0].input.len(), 1);
5483 check_spends!(local_txn[0], chan_1.3);
5485 // Give B knowledge of preimage to be able to generate a local HTLC-Success Tx
5486 nodes[1].node.claim_funds(payment_preimage);
5487 check_added_monitors!(nodes[1], 1);
5488 mine_transaction(&nodes[1], &local_txn[0]);
5489 check_added_monitors!(nodes[1], 1);
5490 let events = nodes[1].node.get_and_clear_pending_msg_events();
5492 MessageSendEvent::UpdateHTLCs { .. } => {},
5493 _ => panic!("Unexpected event"),
5496 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5497 _ => panic!("Unexepected event"),
5500 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5501 assert_eq!(node_txn.len(), 3);
5502 assert_eq!(node_txn[0], node_txn[2]);
5503 assert_eq!(node_txn[1], local_txn[0]);
5504 assert_eq!(node_txn[0].input.len(), 1);
5505 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5506 check_spends!(node_txn[0], local_txn[0]);
5510 mine_transaction(&nodes[1], &node_tx);
5511 connect_blocks(&nodes[1], BREAKDOWN_TIMEOUT as u32 - 1);
5513 // Verify that B is able to spend its own HTLC-Success tx thanks to spendable output event given back by its ChannelMonitor
5514 let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
5515 assert_eq!(spend_txn.len(), 1);
5516 assert_eq!(spend_txn[0].input.len(), 1);
5517 check_spends!(spend_txn[0], node_tx);
5518 assert_eq!(spend_txn[0].input[0].sequence, BREAKDOWN_TIMEOUT as u32);
5521 fn do_test_fail_backwards_unrevoked_remote_announce(deliver_last_raa: bool, announce_latest: bool) {
5522 // Test that we fail backwards the full set of HTLCs we need to when remote broadcasts an
5523 // unrevoked commitment transaction.
5524 // This includes HTLCs which were below the dust threshold as well as HTLCs which were awaiting
5525 // a remote RAA before they could be failed backwards (and combinations thereof).
5526 // We also test duplicate-hash HTLCs by adding two nodes on each side of the target nodes which
5527 // use the same payment hashes.
5528 // Thus, we use a six-node network:
5533 // And test where C fails back to A/B when D announces its latest commitment transaction
5534 let chanmon_cfgs = create_chanmon_cfgs(6);
5535 let node_cfgs = create_node_cfgs(6, &chanmon_cfgs);
5536 let node_chanmgrs = create_node_chanmgrs(6, &node_cfgs, &[None, None, None, None, None, None]);
5537 let nodes = create_network(6, &node_cfgs, &node_chanmgrs);
5538 let logger = test_utils::TestLogger::new();
5540 create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known());
5541 create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
5542 let chan = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
5543 create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::known(), InitFeatures::known());
5544 create_announced_chan_between_nodes(&nodes, 3, 5, InitFeatures::known(), InitFeatures::known());
5546 // Rebalance and check output sanity...
5547 send_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 500000);
5548 send_payment(&nodes[1], &[&nodes[2], &nodes[3], &nodes[5]], 500000);
5549 assert_eq!(get_local_commitment_txn!(nodes[3], chan.2)[0].output.len(), 2);
5551 let ds_dust_limit = nodes[3].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().holder_dust_limit_satoshis;
5553 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
5555 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
5556 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
5557 let our_node_id = &nodes[1].node.get_our_node_id();
5558 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();
5560 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
5562 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
5564 let (_, payment_hash_3, _) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
5566 let (_, payment_hash_4, _) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
5567 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();
5569 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());
5571 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());
5574 let (_, payment_hash_5, _) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
5576 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, &[&[&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
5580 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
5582 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();
5583 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());
5585 // Double-check that six of the new HTLC were added
5586 // We now have six HTLCs pending over the dust limit and six HTLCs under the dust limit (ie,
5587 // with to_local and to_remote outputs, 8 outputs and 6 HTLCs not included).
5588 assert_eq!(get_local_commitment_txn!(nodes[3], chan.2).len(), 1);
5589 assert_eq!(get_local_commitment_txn!(nodes[3], chan.2)[0].output.len(), 8);
5591 // Now fail back three of the over-dust-limit and three of the under-dust-limit payments in one go.
5592 // Fail 0th below-dust, 4th above-dust, 8th above-dust, 10th below-dust HTLCs
5593 assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_1));
5594 assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_3));
5595 assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_5));
5596 assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_6));
5597 check_added_monitors!(nodes[4], 0);
5598 expect_pending_htlcs_forwardable!(nodes[4]);
5599 check_added_monitors!(nodes[4], 1);
5601 let four_removes = get_htlc_update_msgs!(nodes[4], nodes[3].node.get_our_node_id());
5602 nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[0]);
5603 nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[1]);
5604 nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[2]);
5605 nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[3]);
5606 commitment_signed_dance!(nodes[3], nodes[4], four_removes.commitment_signed, false);
5608 // Fail 3rd below-dust and 7th above-dust HTLCs
5609 assert!(nodes[5].node.fail_htlc_backwards(&payment_hash_2));
5610 assert!(nodes[5].node.fail_htlc_backwards(&payment_hash_4));
5611 check_added_monitors!(nodes[5], 0);
5612 expect_pending_htlcs_forwardable!(nodes[5]);
5613 check_added_monitors!(nodes[5], 1);
5615 let two_removes = get_htlc_update_msgs!(nodes[5], nodes[3].node.get_our_node_id());
5616 nodes[3].node.handle_update_fail_htlc(&nodes[5].node.get_our_node_id(), &two_removes.update_fail_htlcs[0]);
5617 nodes[3].node.handle_update_fail_htlc(&nodes[5].node.get_our_node_id(), &two_removes.update_fail_htlcs[1]);
5618 commitment_signed_dance!(nodes[3], nodes[5], two_removes.commitment_signed, false);
5620 let ds_prev_commitment_tx = get_local_commitment_txn!(nodes[3], chan.2);
5622 expect_pending_htlcs_forwardable!(nodes[3]);
5623 check_added_monitors!(nodes[3], 1);
5624 let six_removes = get_htlc_update_msgs!(nodes[3], nodes[2].node.get_our_node_id());
5625 nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[0]);
5626 nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[1]);
5627 nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[2]);
5628 nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[3]);
5629 nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[4]);
5630 nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[5]);
5631 if deliver_last_raa {
5632 commitment_signed_dance!(nodes[2], nodes[3], six_removes.commitment_signed, false);
5634 let _cs_last_raa = commitment_signed_dance!(nodes[2], nodes[3], six_removes.commitment_signed, false, true, false, true);
5637 // D's latest commitment transaction now contains 1st + 2nd + 9th HTLCs (implicitly, they're
5638 // below the dust limit) and the 5th + 6th + 11th HTLCs. It has failed back the 0th, 3rd, 4th,
5639 // 7th, 8th, and 10th, but as we haven't yet delivered the final RAA to C, the fails haven't
5640 // propagated back to A/B yet (and D has two unrevoked commitment transactions).
5642 // We now broadcast the latest commitment transaction, which *should* result in failures for
5643 // the 0th, 1st, 2nd, 3rd, 4th, 7th, 8th, 9th, and 10th HTLCs, ie all the below-dust HTLCs and
5644 // the non-broadcast above-dust HTLCs.
5646 // Alternatively, we may broadcast the previous commitment transaction, which should only
5647 // result in failures for the below-dust HTLCs, ie the 0th, 1st, 2nd, 3rd, 9th, and 10th HTLCs.
5648 let ds_last_commitment_tx = get_local_commitment_txn!(nodes[3], chan.2);
5650 if announce_latest {
5651 mine_transaction(&nodes[2], &ds_last_commitment_tx[0]);
5653 mine_transaction(&nodes[2], &ds_prev_commitment_tx[0]);
5655 connect_blocks(&nodes[2], ANTI_REORG_DELAY - 1);
5656 check_closed_broadcast!(nodes[2], true);
5657 expect_pending_htlcs_forwardable!(nodes[2]);
5658 check_added_monitors!(nodes[2], 3);
5660 let cs_msgs = nodes[2].node.get_and_clear_pending_msg_events();
5661 assert_eq!(cs_msgs.len(), 2);
5662 let mut a_done = false;
5663 for msg in cs_msgs {
5665 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
5666 // Both under-dust HTLCs and the one above-dust HTLC that we had already failed
5667 // should be failed-backwards here.
5668 let target = if *node_id == nodes[0].node.get_our_node_id() {
5669 // If announce_latest, expect 0th, 1st, 4th, 8th, 10th HTLCs, else only 0th, 1st, 10th below-dust HTLCs
5670 for htlc in &updates.update_fail_htlcs {
5671 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 });
5673 assert_eq!(updates.update_fail_htlcs.len(), if announce_latest { 5 } else { 3 });
5678 // If announce_latest, expect 2nd, 3rd, 7th, 9th HTLCs, else only 2nd, 3rd, 9th below-dust HTLCs
5679 for htlc in &updates.update_fail_htlcs {
5680 assert!(htlc.htlc_id == 1 || htlc.htlc_id == 2 || htlc.htlc_id == 5 || if announce_latest { htlc.htlc_id == 4 } else { false });
5682 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
5683 assert_eq!(updates.update_fail_htlcs.len(), if announce_latest { 4 } else { 3 });
5686 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
5687 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[1]);
5688 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[2]);
5689 if announce_latest {
5690 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[3]);
5691 if *node_id == nodes[0].node.get_our_node_id() {
5692 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[4]);
5695 commitment_signed_dance!(target, nodes[2], updates.commitment_signed, false, true);
5697 _ => panic!("Unexpected event"),
5701 let as_events = nodes[0].node.get_and_clear_pending_events();
5702 assert_eq!(as_events.len(), if announce_latest { 5 } else { 3 });
5703 let mut as_failds = HashSet::new();
5704 for event in as_events.iter() {
5705 if let &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, .. } = event {
5706 assert!(as_failds.insert(*payment_hash));
5707 if *payment_hash != payment_hash_2 {
5708 assert_eq!(*rejected_by_dest, deliver_last_raa);
5710 assert!(!rejected_by_dest);
5712 } else { panic!("Unexpected event"); }
5714 assert!(as_failds.contains(&payment_hash_1));
5715 assert!(as_failds.contains(&payment_hash_2));
5716 if announce_latest {
5717 assert!(as_failds.contains(&payment_hash_3));
5718 assert!(as_failds.contains(&payment_hash_5));
5720 assert!(as_failds.contains(&payment_hash_6));
5722 let bs_events = nodes[1].node.get_and_clear_pending_events();
5723 assert_eq!(bs_events.len(), if announce_latest { 4 } else { 3 });
5724 let mut bs_failds = HashSet::new();
5725 for event in bs_events.iter() {
5726 if let &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, .. } = event {
5727 assert!(bs_failds.insert(*payment_hash));
5728 if *payment_hash != payment_hash_1 && *payment_hash != payment_hash_5 {
5729 assert_eq!(*rejected_by_dest, deliver_last_raa);
5731 assert!(!rejected_by_dest);
5733 } else { panic!("Unexpected event"); }
5735 assert!(bs_failds.contains(&payment_hash_1));
5736 assert!(bs_failds.contains(&payment_hash_2));
5737 if announce_latest {
5738 assert!(bs_failds.contains(&payment_hash_4));
5740 assert!(bs_failds.contains(&payment_hash_5));
5742 // For each HTLC which was not failed-back by normal process (ie deliver_last_raa), we should
5743 // get a PaymentFailureNetworkUpdate. A should have gotten 4 HTLCs which were failed-back due
5744 // to unknown-preimage-etc, B should have gotten 2. Thus, in the
5745 // announce_latest && deliver_last_raa case, we should have 5-4=1 and 4-2=2
5746 // PaymentFailureNetworkUpdates.
5747 let as_msg_events = nodes[0].node.get_and_clear_pending_msg_events();
5748 assert_eq!(as_msg_events.len(), if deliver_last_raa { 1 } else if !announce_latest { 3 } else { 5 });
5749 let bs_msg_events = nodes[1].node.get_and_clear_pending_msg_events();
5750 assert_eq!(bs_msg_events.len(), if deliver_last_raa { 2 } else if !announce_latest { 3 } else { 4 });
5751 for event in as_msg_events.iter().chain(bs_msg_events.iter()) {
5753 &MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
5754 _ => panic!("Unexpected event"),
5760 fn test_fail_backwards_latest_remote_announce_a() {
5761 do_test_fail_backwards_unrevoked_remote_announce(false, true);
5765 fn test_fail_backwards_latest_remote_announce_b() {
5766 do_test_fail_backwards_unrevoked_remote_announce(true, true);
5770 fn test_fail_backwards_previous_remote_announce() {
5771 do_test_fail_backwards_unrevoked_remote_announce(false, false);
5772 // Note that true, true doesn't make sense as it implies we announce a revoked state, which is
5773 // tested for in test_commitment_revoked_fail_backward_exhaustive()
5777 fn test_dynamic_spendable_outputs_local_htlc_timeout_tx() {
5778 let chanmon_cfgs = create_chanmon_cfgs(2);
5779 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5780 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5781 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5783 // Create some initial channels
5784 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5786 let (_, our_payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000);
5787 let local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
5788 assert_eq!(local_txn[0].input.len(), 1);
5789 check_spends!(local_txn[0], chan_1.3);
5791 // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
5792 mine_transaction(&nodes[0], &local_txn[0]);
5793 check_closed_broadcast!(nodes[0], true);
5794 check_added_monitors!(nodes[0], 1);
5795 connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
5797 let htlc_timeout = {
5798 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5799 assert_eq!(node_txn.len(), 2);
5800 check_spends!(node_txn[0], chan_1.3);
5801 assert_eq!(node_txn[1].input.len(), 1);
5802 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5803 check_spends!(node_txn[1], local_txn[0]);
5807 mine_transaction(&nodes[0], &htlc_timeout);
5808 connect_blocks(&nodes[0], BREAKDOWN_TIMEOUT as u32 - 1);
5809 expect_payment_failed!(nodes[0], our_payment_hash, true);
5811 // Verify that A is able to spend its own HTLC-Timeout tx thanks to spendable output event given back by its ChannelMonitor
5812 let spend_txn = check_spendable_outputs!(nodes[0], 1, node_cfgs[0].keys_manager, 100000);
5813 assert_eq!(spend_txn.len(), 3);
5814 check_spends!(spend_txn[0], local_txn[0]);
5815 assert_eq!(spend_txn[1].input.len(), 1);
5816 check_spends!(spend_txn[1], htlc_timeout);
5817 assert_eq!(spend_txn[1].input[0].sequence, BREAKDOWN_TIMEOUT as u32);
5818 assert_eq!(spend_txn[2].input.len(), 2);
5819 check_spends!(spend_txn[2], local_txn[0], htlc_timeout);
5820 assert!(spend_txn[2].input[0].sequence == BREAKDOWN_TIMEOUT as u32 ||
5821 spend_txn[2].input[1].sequence == BREAKDOWN_TIMEOUT as u32);
5825 fn test_key_derivation_params() {
5826 // This test is a copy of test_dynamic_spendable_outputs_local_htlc_timeout_tx, with
5827 // a key manager rotation to test that key_derivation_params returned in DynamicOutputP2WSH
5828 // let us re-derive the channel key set to then derive a delayed_payment_key.
5830 let chanmon_cfgs = create_chanmon_cfgs(3);
5832 // We manually create the node configuration to backup the seed.
5833 let seed = [42; 32];
5834 let keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
5835 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);
5836 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 };
5837 let mut node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5838 node_cfgs.remove(0);
5839 node_cfgs.insert(0, node);
5841 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5842 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5844 // Create some initial channels
5845 // Create a dummy channel to advance index by one and thus test re-derivation correctness
5847 let chan_0 = create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known());
5848 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5849 assert_ne!(chan_0.3.output[0].script_pubkey, chan_1.3.output[0].script_pubkey);
5851 // Ensure all nodes are at the same height
5852 let node_max_height = nodes.iter().map(|node| node.blocks.lock().unwrap().len()).max().unwrap() as u32;
5853 connect_blocks(&nodes[0], node_max_height - nodes[0].best_block_info().1);
5854 connect_blocks(&nodes[1], node_max_height - nodes[1].best_block_info().1);
5855 connect_blocks(&nodes[2], node_max_height - nodes[2].best_block_info().1);
5857 let (_, our_payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000);
5858 let local_txn_0 = get_local_commitment_txn!(nodes[0], chan_0.2);
5859 let local_txn_1 = get_local_commitment_txn!(nodes[0], chan_1.2);
5860 assert_eq!(local_txn_1[0].input.len(), 1);
5861 check_spends!(local_txn_1[0], chan_1.3);
5863 // We check funding pubkey are unique
5864 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]));
5865 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]));
5866 if from_0_funding_key_0 == from_1_funding_key_0
5867 || from_0_funding_key_0 == from_1_funding_key_1
5868 || from_0_funding_key_1 == from_1_funding_key_0
5869 || from_0_funding_key_1 == from_1_funding_key_1 {
5870 panic!("Funding pubkeys aren't unique");
5873 // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
5874 mine_transaction(&nodes[0], &local_txn_1[0]);
5875 connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
5876 check_closed_broadcast!(nodes[0], true);
5877 check_added_monitors!(nodes[0], 1);
5879 let htlc_timeout = {
5880 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5881 assert_eq!(node_txn[1].input.len(), 1);
5882 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5883 check_spends!(node_txn[1], local_txn_1[0]);
5887 mine_transaction(&nodes[0], &htlc_timeout);
5888 connect_blocks(&nodes[0], BREAKDOWN_TIMEOUT as u32 - 1);
5889 expect_payment_failed!(nodes[0], our_payment_hash, true);
5891 // Verify that A is able to spend its own HTLC-Timeout tx thanks to spendable output event given back by its ChannelMonitor
5892 let new_keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
5893 let spend_txn = check_spendable_outputs!(nodes[0], 1, new_keys_manager, 100000);
5894 assert_eq!(spend_txn.len(), 3);
5895 check_spends!(spend_txn[0], local_txn_1[0]);
5896 assert_eq!(spend_txn[1].input.len(), 1);
5897 check_spends!(spend_txn[1], htlc_timeout);
5898 assert_eq!(spend_txn[1].input[0].sequence, BREAKDOWN_TIMEOUT as u32);
5899 assert_eq!(spend_txn[2].input.len(), 2);
5900 check_spends!(spend_txn[2], local_txn_1[0], htlc_timeout);
5901 assert!(spend_txn[2].input[0].sequence == BREAKDOWN_TIMEOUT as u32 ||
5902 spend_txn[2].input[1].sequence == BREAKDOWN_TIMEOUT as u32);
5906 fn test_static_output_closing_tx() {
5907 let chanmon_cfgs = create_chanmon_cfgs(2);
5908 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5909 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5910 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5912 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5914 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
5915 let closing_tx = close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true).2;
5917 mine_transaction(&nodes[0], &closing_tx);
5918 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
5920 let spend_txn = check_spendable_outputs!(nodes[0], 2, node_cfgs[0].keys_manager, 100000);
5921 assert_eq!(spend_txn.len(), 1);
5922 check_spends!(spend_txn[0], closing_tx);
5924 mine_transaction(&nodes[1], &closing_tx);
5925 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
5927 let spend_txn = check_spendable_outputs!(nodes[1], 2, node_cfgs[1].keys_manager, 100000);
5928 assert_eq!(spend_txn.len(), 1);
5929 check_spends!(spend_txn[0], closing_tx);
5932 fn do_htlc_claim_local_commitment_only(use_dust: bool) {
5933 let chanmon_cfgs = create_chanmon_cfgs(2);
5934 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5935 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5936 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5937 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5939 let (our_payment_preimage, _, _) = route_payment(&nodes[0], &[&nodes[1]], if use_dust { 50000 } else { 3000000 });
5941 // Claim the payment, but don't deliver A's commitment_signed, resulting in the HTLC only being
5942 // present in B's local commitment transaction, but none of A's commitment transactions.
5943 assert!(nodes[1].node.claim_funds(our_payment_preimage));
5944 check_added_monitors!(nodes[1], 1);
5946 let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5947 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fulfill_htlcs[0]);
5948 let events = nodes[0].node.get_and_clear_pending_events();
5949 assert_eq!(events.len(), 1);
5951 Event::PaymentSent { payment_preimage } => {
5952 assert_eq!(payment_preimage, our_payment_preimage);
5954 _ => panic!("Unexpected event"),
5957 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_updates.commitment_signed);
5958 check_added_monitors!(nodes[0], 1);
5959 let as_updates = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5960 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_updates.0);
5961 check_added_monitors!(nodes[1], 1);
5963 let starting_block = nodes[1].best_block_info();
5964 let mut block = Block {
5965 header: BlockHeader { version: 0x20000000, prev_blockhash: starting_block.0, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
5968 for _ in starting_block.1 + 1..TEST_FINAL_CLTV - CLTV_CLAIM_BUFFER + starting_block.1 + 2 {
5969 connect_block(&nodes[1], &block);
5970 block.header.prev_blockhash = block.block_hash();
5972 test_txn_broadcast(&nodes[1], &chan, None, if use_dust { HTLCType::NONE } else { HTLCType::SUCCESS });
5973 check_closed_broadcast!(nodes[1], true);
5974 check_added_monitors!(nodes[1], 1);
5977 fn do_htlc_claim_current_remote_commitment_only(use_dust: bool) {
5978 let chanmon_cfgs = create_chanmon_cfgs(2);
5979 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5980 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5981 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5982 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5983 let logger = test_utils::TestLogger::new();
5985 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1]);
5986 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
5987 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();
5988 nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
5989 check_added_monitors!(nodes[0], 1);
5991 let _as_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5993 // As far as A is concerned, the HTLC is now present only in the latest remote commitment
5994 // transaction, however it is not in A's latest local commitment, so we can just broadcast that
5995 // to "time out" the HTLC.
5997 let starting_block = nodes[1].best_block_info();
5998 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: starting_block.0, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6000 for _ in starting_block.1 + 1..TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + starting_block.1 + 2 {
6001 connect_block(&nodes[0], &Block { header, txdata: Vec::new()});
6002 header.prev_blockhash = header.block_hash();
6004 test_txn_broadcast(&nodes[0], &chan, None, HTLCType::NONE);
6005 check_closed_broadcast!(nodes[0], true);
6006 check_added_monitors!(nodes[0], 1);
6009 fn do_htlc_claim_previous_remote_commitment_only(use_dust: bool, check_revoke_no_close: bool) {
6010 let chanmon_cfgs = create_chanmon_cfgs(3);
6011 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
6012 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
6013 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
6014 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6016 // Fail the payment, but don't deliver A's final RAA, resulting in the HTLC only being present
6017 // in B's previous (unrevoked) commitment transaction, but none of A's commitment transactions.
6018 // Also optionally test that we *don't* fail the channel in case the commitment transaction was
6019 // actually revoked.
6020 let htlc_value = if use_dust { 50000 } else { 3000000 };
6021 let (_, our_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1]], htlc_value);
6022 assert!(nodes[1].node.fail_htlc_backwards(&our_payment_hash));
6023 expect_pending_htlcs_forwardable!(nodes[1]);
6024 check_added_monitors!(nodes[1], 1);
6026 let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6027 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fail_htlcs[0]);
6028 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_updates.commitment_signed);
6029 check_added_monitors!(nodes[0], 1);
6030 let as_updates = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6031 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_updates.0);
6032 check_added_monitors!(nodes[1], 1);
6033 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_updates.1);
6034 check_added_monitors!(nodes[1], 1);
6035 let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
6037 if check_revoke_no_close {
6038 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
6039 check_added_monitors!(nodes[0], 1);
6042 let starting_block = nodes[1].best_block_info();
6043 let mut block = Block {
6044 header: BlockHeader { version: 0x20000000, prev_blockhash: starting_block.0, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
6047 for _ in starting_block.1 + 1..TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + CHAN_CONFIRM_DEPTH + 2 {
6048 connect_block(&nodes[0], &block);
6049 block.header.prev_blockhash = block.block_hash();
6051 if !check_revoke_no_close {
6052 test_txn_broadcast(&nodes[0], &chan, None, HTLCType::NONE);
6053 check_closed_broadcast!(nodes[0], true);
6054 check_added_monitors!(nodes[0], 1);
6056 expect_payment_failed!(nodes[0], our_payment_hash, true);
6060 // Test that we close channels on-chain when broadcastable HTLCs reach their timeout window.
6061 // There are only a few cases to test here:
6062 // * its not really normative behavior, but we test that below-dust HTLCs "included" in
6063 // broadcastable commitment transactions result in channel closure,
6064 // * its included in an unrevoked-but-previous remote commitment transaction,
6065 // * its included in the latest remote or local commitment transactions.
6066 // We test each of the three possible commitment transactions individually and use both dust and
6068 // Note that we don't bother testing both outbound and inbound HTLC failures for each case, and we
6069 // assume they are handled the same across all six cases, as both outbound and inbound failures are
6070 // tested for at least one of the cases in other tests.
6072 fn htlc_claim_single_commitment_only_a() {
6073 do_htlc_claim_local_commitment_only(true);
6074 do_htlc_claim_local_commitment_only(false);
6076 do_htlc_claim_current_remote_commitment_only(true);
6077 do_htlc_claim_current_remote_commitment_only(false);
6081 fn htlc_claim_single_commitment_only_b() {
6082 do_htlc_claim_previous_remote_commitment_only(true, false);
6083 do_htlc_claim_previous_remote_commitment_only(false, false);
6084 do_htlc_claim_previous_remote_commitment_only(true, true);
6085 do_htlc_claim_previous_remote_commitment_only(false, true);
6090 fn bolt2_open_channel_sending_node_checks_part1() { //This test needs to be on its own as we are catching a panic
6091 let chanmon_cfgs = create_chanmon_cfgs(2);
6092 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6093 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6094 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6095 //Force duplicate channel ids
6096 for node in nodes.iter() {
6097 *node.keys_manager.override_channel_id_priv.lock().unwrap() = Some([0; 32]);
6100 // BOLT #2 spec: Sending node must ensure temporary_channel_id is unique from any other channel ID with the same peer.
6101 let channel_value_satoshis=10000;
6102 let push_msat=10001;
6103 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).unwrap();
6104 let node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
6105 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &node0_to_1_send_open_channel);
6107 //Create a second channel with a channel_id collision
6108 assert!(nodes[0].node.create_channel(nodes[0].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
6112 fn bolt2_open_channel_sending_node_checks_part2() {
6113 let chanmon_cfgs = create_chanmon_cfgs(2);
6114 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6115 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6116 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6118 // BOLT #2 spec: Sending node must set funding_satoshis to less than 2^24 satoshis
6119 let channel_value_satoshis=2^24;
6120 let push_msat=10001;
6121 assert!(nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
6123 // BOLT #2 spec: Sending node must set push_msat to equal or less than 1000 * funding_satoshis
6124 let channel_value_satoshis=10000;
6125 // Test when push_msat is equal to 1000 * funding_satoshis.
6126 let push_msat=1000*channel_value_satoshis+1;
6127 assert!(nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
6129 // BOLT #2 spec: Sending node must set set channel_reserve_satoshis greater than or equal to dust_limit_satoshis
6130 let channel_value_satoshis=10000;
6131 let push_msat=10001;
6132 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
6133 let node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
6134 assert!(node0_to_1_send_open_channel.channel_reserve_satoshis>=node0_to_1_send_open_channel.dust_limit_satoshis);
6136 // BOLT #2 spec: Sending node must set undefined bits in channel_flags to 0
6137 // 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
6138 assert!(node0_to_1_send_open_channel.channel_flags<=1);
6140 // 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.
6141 assert!(BREAKDOWN_TIMEOUT>0);
6142 assert!(node0_to_1_send_open_channel.to_self_delay==BREAKDOWN_TIMEOUT);
6144 // BOLT #2 spec: Sending node must ensure the chain_hash value identifies the chain it wishes to open the channel within.
6145 let chain_hash=genesis_block(Network::Testnet).header.block_hash();
6146 assert_eq!(node0_to_1_send_open_channel.chain_hash,chain_hash);
6148 // 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.
6149 assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.funding_pubkey.serialize()).is_ok());
6150 assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.revocation_basepoint.serialize()).is_ok());
6151 assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.htlc_basepoint.serialize()).is_ok());
6152 assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.payment_point.serialize()).is_ok());
6153 assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.delayed_payment_basepoint.serialize()).is_ok());
6157 fn bolt2_open_channel_sane_dust_limit() {
6158 let chanmon_cfgs = create_chanmon_cfgs(2);
6159 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6160 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6161 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6163 let channel_value_satoshis=1000000;
6164 let push_msat=10001;
6165 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).unwrap();
6166 let mut node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
6167 node0_to_1_send_open_channel.dust_limit_satoshis = 661;
6168 node0_to_1_send_open_channel.channel_reserve_satoshis = 100001;
6170 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &node0_to_1_send_open_channel);
6171 let events = nodes[1].node.get_and_clear_pending_msg_events();
6172 let err_msg = match events[0] {
6173 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id: _ } => {
6176 _ => panic!("Unexpected event"),
6178 assert_eq!(err_msg.data, "dust_limit_satoshis (661) is greater than the implementation limit (660)");
6181 // Test that if we fail to send an HTLC that is being freed from the holding cell, and the HTLC
6182 // originated from our node, its failure is surfaced to the user. We trigger this failure to
6183 // free the HTLC by increasing our fee while the HTLC is in the holding cell such that the HTLC
6184 // is no longer affordable once it's freed.
6186 fn test_fail_holding_cell_htlc_upon_free() {
6187 let chanmon_cfgs = create_chanmon_cfgs(2);
6188 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6189 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6190 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6191 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6192 let logger = test_utils::TestLogger::new();
6194 // First nodes[0] generates an update_fee, setting the channel's
6195 // pending_update_fee.
6196 nodes[0].node.update_fee(chan.2, get_feerate!(nodes[0], chan.2) + 20).unwrap();
6197 check_added_monitors!(nodes[0], 1);
6199 let events = nodes[0].node.get_and_clear_pending_msg_events();
6200 assert_eq!(events.len(), 1);
6201 let (update_msg, commitment_signed) = match events[0] {
6202 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
6203 (update_fee.as_ref(), commitment_signed)
6205 _ => panic!("Unexpected event"),
6208 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
6210 let mut chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6211 let channel_reserve = chan_stat.channel_reserve_msat;
6212 let feerate = get_feerate!(nodes[0], chan.2);
6214 // 2* and +1 HTLCs on the commit tx fee calculation for the fee spike reserve.
6215 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6216 let max_can_send = 5000000 - channel_reserve - 2*commit_tx_fee_msat(feerate, 1 + 1);
6217 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6218 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();
6220 // Send a payment which passes reserve checks but gets stuck in the holding cell.
6221 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6222 chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6223 assert_eq!(chan_stat.holding_cell_outbound_amount_msat, max_can_send);
6225 // Flush the pending fee update.
6226 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
6227 let (as_revoke_and_ack, _) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6228 check_added_monitors!(nodes[1], 1);
6229 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_revoke_and_ack);
6230 check_added_monitors!(nodes[0], 1);
6232 // Upon receipt of the RAA, there will be an attempt to resend the holding cell
6233 // HTLC, but now that the fee has been raised the payment will now fail, causing
6234 // us to surface its failure to the user.
6235 chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6236 assert_eq!(chan_stat.holding_cell_outbound_amount_msat, 0);
6237 nodes[0].logger.assert_log("lightning::ln::channel".to_string(), "Freeing holding cell with 1 HTLC updates".to_string(), 1);
6238 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);
6239 nodes[0].logger.assert_log("lightning::ln::channel".to_string(), failure_log.to_string(), 1);
6241 // Check that the payment failed to be sent out.
6242 let events = nodes[0].node.get_and_clear_pending_events();
6243 assert_eq!(events.len(), 1);
6245 &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, ref error_code, ref error_data } => {
6246 assert_eq!(our_payment_hash.clone(), *payment_hash);
6247 assert_eq!(*rejected_by_dest, false);
6248 assert_eq!(*error_code, None);
6249 assert_eq!(*error_data, None);
6251 _ => panic!("Unexpected event"),
6255 // Test that if multiple HTLCs are released from the holding cell and one is
6256 // valid but the other is no longer valid upon release, the valid HTLC can be
6257 // successfully completed while the other one fails as expected.
6259 fn test_free_and_fail_holding_cell_htlcs() {
6260 let chanmon_cfgs = create_chanmon_cfgs(2);
6261 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6262 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6263 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6264 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6265 let logger = test_utils::TestLogger::new();
6267 // First nodes[0] generates an update_fee, setting the channel's
6268 // pending_update_fee.
6269 nodes[0].node.update_fee(chan.2, get_feerate!(nodes[0], chan.2) + 200).unwrap();
6270 check_added_monitors!(nodes[0], 1);
6272 let events = nodes[0].node.get_and_clear_pending_msg_events();
6273 assert_eq!(events.len(), 1);
6274 let (update_msg, commitment_signed) = match events[0] {
6275 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
6276 (update_fee.as_ref(), commitment_signed)
6278 _ => panic!("Unexpected event"),
6281 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
6283 let mut chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6284 let channel_reserve = chan_stat.channel_reserve_msat;
6285 let feerate = get_feerate!(nodes[0], chan.2);
6287 // 2* and +1 HTLCs on the commit tx fee calculation for the fee spike reserve.
6288 let (payment_preimage_1, payment_hash_1, payment_secret_1) = get_payment_preimage_hash!(nodes[1]);
6290 let (_, payment_hash_2, payment_secret_2) = get_payment_preimage_hash!(nodes[1]);
6291 let amt_2 = 5000000 - channel_reserve - 2*commit_tx_fee_msat(feerate, 2 + 1) - amt_1;
6292 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6293 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();
6294 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();
6296 // Send 2 payments which pass reserve checks but get stuck in the holding cell.
6297 nodes[0].node.send_payment(&route_1, payment_hash_1, &Some(payment_secret_1)).unwrap();
6298 chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6299 assert_eq!(chan_stat.holding_cell_outbound_amount_msat, amt_1);
6300 nodes[0].node.send_payment(&route_2, payment_hash_2, &Some(payment_secret_2)).unwrap();
6301 chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6302 assert_eq!(chan_stat.holding_cell_outbound_amount_msat, amt_1 + amt_2);
6304 // Flush the pending fee update.
6305 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
6306 let (revoke_and_ack, commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6307 check_added_monitors!(nodes[1], 1);
6308 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_and_ack);
6309 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
6310 check_added_monitors!(nodes[0], 2);
6312 // Upon receipt of the RAA, there will be an attempt to resend the holding cell HTLCs,
6313 // but now that the fee has been raised the second payment will now fail, causing us
6314 // to surface its failure to the user. The first payment should succeed.
6315 chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6316 assert_eq!(chan_stat.holding_cell_outbound_amount_msat, 0);
6317 nodes[0].logger.assert_log("lightning::ln::channel".to_string(), "Freeing holding cell with 2 HTLC updates".to_string(), 1);
6318 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);
6319 nodes[0].logger.assert_log("lightning::ln::channel".to_string(), failure_log.to_string(), 1);
6321 // Check that the second payment failed to be sent out.
6322 let events = nodes[0].node.get_and_clear_pending_events();
6323 assert_eq!(events.len(), 1);
6325 &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, ref error_code, ref error_data } => {
6326 assert_eq!(payment_hash_2.clone(), *payment_hash);
6327 assert_eq!(*rejected_by_dest, false);
6328 assert_eq!(*error_code, None);
6329 assert_eq!(*error_data, None);
6331 _ => panic!("Unexpected event"),
6334 // Complete the first payment and the RAA from the fee update.
6335 let (payment_event, send_raa_event) = {
6336 let mut msgs = nodes[0].node.get_and_clear_pending_msg_events();
6337 assert_eq!(msgs.len(), 2);
6338 (SendEvent::from_event(msgs.remove(0)), msgs.remove(0))
6340 let raa = match send_raa_event {
6341 MessageSendEvent::SendRevokeAndACK { msg, .. } => msg,
6342 _ => panic!("Unexpected event"),
6344 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &raa);
6345 check_added_monitors!(nodes[1], 1);
6346 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6347 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6348 let events = nodes[1].node.get_and_clear_pending_events();
6349 assert_eq!(events.len(), 1);
6351 Event::PendingHTLCsForwardable { .. } => {},
6352 _ => panic!("Unexpected event"),
6354 nodes[1].node.process_pending_htlc_forwards();
6355 let events = nodes[1].node.get_and_clear_pending_events();
6356 assert_eq!(events.len(), 1);
6358 Event::PaymentReceived { .. } => {},
6359 _ => panic!("Unexpected event"),
6361 nodes[1].node.claim_funds(payment_preimage_1);
6362 check_added_monitors!(nodes[1], 1);
6363 let update_msgs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6364 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_msgs.update_fulfill_htlcs[0]);
6365 commitment_signed_dance!(nodes[0], nodes[1], update_msgs.commitment_signed, false, true);
6366 let events = nodes[0].node.get_and_clear_pending_events();
6367 assert_eq!(events.len(), 1);
6369 Event::PaymentSent { ref payment_preimage } => {
6370 assert_eq!(*payment_preimage, payment_preimage_1);
6372 _ => panic!("Unexpected event"),
6376 // Test that if we fail to forward an HTLC that is being freed from the holding cell that the
6377 // HTLC is failed backwards. We trigger this failure to forward the freed HTLC by increasing
6378 // our fee while the HTLC is in the holding cell such that the HTLC is no longer affordable
6381 fn test_fail_holding_cell_htlc_upon_free_multihop() {
6382 let chanmon_cfgs = create_chanmon_cfgs(3);
6383 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
6384 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
6385 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
6386 let chan_0_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6387 let chan_1_2 = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6388 let logger = test_utils::TestLogger::new();
6390 // First nodes[1] generates an update_fee, setting the channel's
6391 // pending_update_fee.
6392 nodes[1].node.update_fee(chan_1_2.2, get_feerate!(nodes[1], chan_1_2.2) + 20).unwrap();
6393 check_added_monitors!(nodes[1], 1);
6395 let events = nodes[1].node.get_and_clear_pending_msg_events();
6396 assert_eq!(events.len(), 1);
6397 let (update_msg, commitment_signed) = match events[0] {
6398 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
6399 (update_fee.as_ref(), commitment_signed)
6401 _ => panic!("Unexpected event"),
6404 nodes[2].node.handle_update_fee(&nodes[1].node.get_our_node_id(), update_msg.unwrap());
6406 let mut chan_stat = get_channel_value_stat!(nodes[0], chan_0_1.2);
6407 let channel_reserve = chan_stat.channel_reserve_msat;
6408 let feerate = get_feerate!(nodes[0], chan_0_1.2);
6410 // Send a payment which passes reserve checks but gets stuck in the holding cell.
6412 let total_routing_fee_msat = (nodes.len() - 2) as u64 * feemsat;
6413 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[2]);
6414 let max_can_send = 5000000 - channel_reserve - 2*commit_tx_fee_msat(feerate, 1 + 1) - total_routing_fee_msat;
6415 let payment_event = {
6416 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6417 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();
6418 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6419 check_added_monitors!(nodes[0], 1);
6421 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
6422 assert_eq!(events.len(), 1);
6424 SendEvent::from_event(events.remove(0))
6426 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6427 check_added_monitors!(nodes[1], 0);
6428 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6429 expect_pending_htlcs_forwardable!(nodes[1]);
6431 chan_stat = get_channel_value_stat!(nodes[1], chan_1_2.2);
6432 assert_eq!(chan_stat.holding_cell_outbound_amount_msat, max_can_send);
6434 // Flush the pending fee update.
6435 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), commitment_signed);
6436 let (raa, commitment_signed) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
6437 check_added_monitors!(nodes[2], 1);
6438 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &raa);
6439 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &commitment_signed);
6440 check_added_monitors!(nodes[1], 2);
6442 // A final RAA message is generated to finalize the fee update.
6443 let events = nodes[1].node.get_and_clear_pending_msg_events();
6444 assert_eq!(events.len(), 1);
6446 let raa_msg = match &events[0] {
6447 &MessageSendEvent::SendRevokeAndACK { ref msg, .. } => {
6450 _ => panic!("Unexpected event"),
6453 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &raa_msg);
6454 check_added_monitors!(nodes[2], 1);
6455 assert!(nodes[2].node.get_and_clear_pending_msg_events().is_empty());
6457 // nodes[1]'s ChannelManager will now signal that we have HTLC forwards to process.
6458 let process_htlc_forwards_event = nodes[1].node.get_and_clear_pending_events();
6459 assert_eq!(process_htlc_forwards_event.len(), 1);
6460 match &process_htlc_forwards_event[0] {
6461 &Event::PendingHTLCsForwardable { .. } => {},
6462 _ => panic!("Unexpected event"),
6465 // In response, we call ChannelManager's process_pending_htlc_forwards
6466 nodes[1].node.process_pending_htlc_forwards();
6467 check_added_monitors!(nodes[1], 1);
6469 // This causes the HTLC to be failed backwards.
6470 let fail_event = nodes[1].node.get_and_clear_pending_msg_events();
6471 assert_eq!(fail_event.len(), 1);
6472 let (fail_msg, commitment_signed) = match &fail_event[0] {
6473 &MessageSendEvent::UpdateHTLCs { ref updates, .. } => {
6474 assert_eq!(updates.update_add_htlcs.len(), 0);
6475 assert_eq!(updates.update_fulfill_htlcs.len(), 0);
6476 assert_eq!(updates.update_fail_malformed_htlcs.len(), 0);
6477 assert_eq!(updates.update_fail_htlcs.len(), 1);
6478 (updates.update_fail_htlcs[0].clone(), updates.commitment_signed.clone())
6480 _ => panic!("Unexpected event"),
6483 // Pass the failure messages back to nodes[0].
6484 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
6485 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
6487 // Complete the HTLC failure+removal process.
6488 let (raa, commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6489 check_added_monitors!(nodes[0], 1);
6490 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &raa);
6491 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commitment_signed);
6492 check_added_monitors!(nodes[1], 2);
6493 let final_raa_event = nodes[1].node.get_and_clear_pending_msg_events();
6494 assert_eq!(final_raa_event.len(), 1);
6495 let raa = match &final_raa_event[0] {
6496 &MessageSendEvent::SendRevokeAndACK { ref msg, .. } => msg.clone(),
6497 _ => panic!("Unexpected event"),
6499 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &raa);
6500 let fail_msg_event = nodes[0].node.get_and_clear_pending_msg_events();
6501 assert_eq!(fail_msg_event.len(), 1);
6502 match &fail_msg_event[0] {
6503 &MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
6504 _ => panic!("Unexpected event"),
6506 let failure_event = nodes[0].node.get_and_clear_pending_events();
6507 assert_eq!(failure_event.len(), 1);
6508 match &failure_event[0] {
6509 &Event::PaymentFailed { rejected_by_dest, .. } => {
6510 assert!(!rejected_by_dest);
6512 _ => panic!("Unexpected event"),
6514 check_added_monitors!(nodes[0], 1);
6517 // BOLT 2 Requirements for the Sender when constructing and sending an update_add_htlc message.
6518 // 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.
6519 //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.
6522 fn test_update_add_htlc_bolt2_sender_value_below_minimum_msat() {
6523 //BOLT2 Requirement: MUST NOT offer amount_msat below the receiving node's htlc_minimum_msat (same validation check catches both of these)
6524 let chanmon_cfgs = create_chanmon_cfgs(2);
6525 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6526 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6527 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6528 let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6530 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6531 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6532 let logger = test_utils::TestLogger::new();
6533 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();
6534 route.paths[0][0].fee_msat = 100;
6536 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
6537 assert!(regex::Regex::new(r"Cannot send less than their minimum HTLC value \(\d+\)").unwrap().is_match(err)));
6538 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6539 nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot send less than their minimum HTLC value".to_string(), 1);
6543 fn test_update_add_htlc_bolt2_sender_zero_value_msat() {
6544 //BOLT2 Requirement: MUST offer amount_msat greater than 0.
6545 let chanmon_cfgs = create_chanmon_cfgs(2);
6546 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6547 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6548 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6549 let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6550 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6552 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6553 let logger = test_utils::TestLogger::new();
6554 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();
6555 route.paths[0][0].fee_msat = 0;
6556 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
6557 assert_eq!(err, "Cannot send 0-msat HTLC"));
6559 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6560 nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot send 0-msat HTLC".to_string(), 1);
6564 fn test_update_add_htlc_bolt2_receiver_zero_value_msat() {
6565 //BOLT2 Requirement: MUST offer amount_msat greater than 0.
6566 let chanmon_cfgs = create_chanmon_cfgs(2);
6567 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6568 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6569 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6570 let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6572 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6573 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6574 let logger = test_utils::TestLogger::new();
6575 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();
6576 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6577 check_added_monitors!(nodes[0], 1);
6578 let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6579 updates.update_add_htlcs[0].amount_msat = 0;
6581 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6582 nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Remote side tried to send a 0-msat HTLC".to_string(), 1);
6583 check_closed_broadcast!(nodes[1], true).unwrap();
6584 check_added_monitors!(nodes[1], 1);
6588 fn test_update_add_htlc_bolt2_sender_cltv_expiry_too_high() {
6589 //BOLT 2 Requirement: MUST set cltv_expiry less than 500000000.
6590 //It is enforced when constructing a route.
6591 let chanmon_cfgs = create_chanmon_cfgs(2);
6592 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6593 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6594 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6595 let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 0, InitFeatures::known(), InitFeatures::known());
6596 let logger = test_utils::TestLogger::new();
6598 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6600 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6601 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();
6602 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::RouteError { ref err },
6603 assert_eq!(err, &"Channel CLTV overflowed?"));
6607 fn test_update_add_htlc_bolt2_sender_exceed_max_htlc_num_and_htlc_id_increment() {
6608 //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.
6609 //BOLT 2 Requirement: for the first HTLC it offers MUST set id to 0.
6610 //BOLT 2 Requirement: MUST increase the value of id by 1 for each successive offer.
6611 let chanmon_cfgs = create_chanmon_cfgs(2);
6612 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6613 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6614 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6615 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 0, InitFeatures::known(), InitFeatures::known());
6616 let max_accepted_htlcs = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().counterparty_max_accepted_htlcs as u64;
6618 let logger = test_utils::TestLogger::new();
6619 for i in 0..max_accepted_htlcs {
6620 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6621 let payment_event = {
6622 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6623 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();
6624 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6625 check_added_monitors!(nodes[0], 1);
6627 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
6628 assert_eq!(events.len(), 1);
6629 if let MessageSendEvent::UpdateHTLCs { node_id: _, updates: msgs::CommitmentUpdate{ update_add_htlcs: ref htlcs, .. }, } = events[0] {
6630 assert_eq!(htlcs[0].htlc_id, i);
6634 SendEvent::from_event(events.remove(0))
6636 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6637 check_added_monitors!(nodes[1], 0);
6638 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6640 expect_pending_htlcs_forwardable!(nodes[1]);
6641 expect_payment_received!(nodes[1], our_payment_hash, our_payment_secret, 100000);
6643 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6644 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6645 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();
6646 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
6647 assert!(regex::Regex::new(r"Cannot push more than their max accepted HTLCs \(\d+\)").unwrap().is_match(err)));
6649 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6650 nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot push more than their max accepted HTLCs".to_string(), 1);
6654 fn test_update_add_htlc_bolt2_sender_exceed_max_htlc_value_in_flight() {
6655 //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.
6656 let chanmon_cfgs = create_chanmon_cfgs(2);
6657 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6658 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6659 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6660 let channel_value = 100000;
6661 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, channel_value, 0, InitFeatures::known(), InitFeatures::known());
6662 let max_in_flight = get_channel_value_stat!(nodes[0], chan.2).counterparty_max_htlc_value_in_flight_msat;
6664 send_payment(&nodes[0], &vec!(&nodes[1])[..], max_in_flight);
6666 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6667 // Manually create a route over our max in flight (which our router normally automatically
6669 let route = Route { paths: vec![vec![RouteHop {
6670 pubkey: nodes[1].node.get_our_node_id(), node_features: NodeFeatures::known(), channel_features: ChannelFeatures::known(),
6671 short_channel_id: nodes[1].node.list_usable_channels()[0].short_channel_id.unwrap(),
6672 fee_msat: max_in_flight + 1, cltv_expiry_delta: TEST_FINAL_CLTV
6674 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
6675 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)));
6677 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6678 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);
6680 send_payment(&nodes[0], &[&nodes[1]], max_in_flight);
6683 // BOLT 2 Requirements for the Receiver when handling an update_add_htlc message.
6685 fn test_update_add_htlc_bolt2_receiver_check_amount_received_more_than_min() {
6686 //BOLT2 Requirement: receiving an amount_msat equal to 0, OR less than its own htlc_minimum_msat -> SHOULD fail the channel.
6687 let chanmon_cfgs = create_chanmon_cfgs(2);
6688 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6689 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6690 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6691 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6692 let htlc_minimum_msat: u64;
6694 let chan_lock = nodes[0].node.channel_state.lock().unwrap();
6695 let channel = chan_lock.by_id.get(&chan.2).unwrap();
6696 htlc_minimum_msat = channel.get_holder_htlc_minimum_msat();
6699 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6700 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6701 let logger = test_utils::TestLogger::new();
6702 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();
6703 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6704 check_added_monitors!(nodes[0], 1);
6705 let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6706 updates.update_add_htlcs[0].amount_msat = htlc_minimum_msat-1;
6707 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6708 assert!(nodes[1].node.list_channels().is_empty());
6709 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6710 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()));
6711 check_added_monitors!(nodes[1], 1);
6715 fn test_update_add_htlc_bolt2_receiver_sender_can_afford_amount_sent() {
6716 //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
6717 let chanmon_cfgs = create_chanmon_cfgs(2);
6718 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6719 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6720 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6721 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6722 let logger = test_utils::TestLogger::new();
6724 let chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6725 let channel_reserve = chan_stat.channel_reserve_msat;
6726 let feerate = get_feerate!(nodes[0], chan.2);
6727 // The 2* and +1 are for the fee spike reserve.
6728 let commit_tx_fee_outbound = 2 * commit_tx_fee_msat(feerate, 1 + 1);
6730 let max_can_send = 5000000 - channel_reserve - commit_tx_fee_outbound;
6731 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6732 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6733 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();
6734 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6735 check_added_monitors!(nodes[0], 1);
6736 let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6738 // Even though channel-initiator senders are required to respect the fee_spike_reserve,
6739 // at this time channel-initiatee receivers are not required to enforce that senders
6740 // respect the fee_spike_reserve.
6741 updates.update_add_htlcs[0].amount_msat = max_can_send + commit_tx_fee_outbound + 1;
6742 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6744 assert!(nodes[1].node.list_channels().is_empty());
6745 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6746 assert_eq!(err_msg.data, "Remote HTLC add would put them under remote reserve value");
6747 check_added_monitors!(nodes[1], 1);
6751 fn test_update_add_htlc_bolt2_receiver_check_max_htlc_limit() {
6752 //BOLT 2 Requirement: if a sending node adds more than its max_accepted_htlcs HTLCs to its local commitment transaction: SHOULD fail the channel
6753 //BOLT 2 Requirement: MUST allow multiple HTLCs with the same payment_hash.
6754 let chanmon_cfgs = create_chanmon_cfgs(2);
6755 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6756 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6757 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6758 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6759 let logger = test_utils::TestLogger::new();
6761 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6762 let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
6764 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6765 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();
6767 let cur_height = nodes[0].node.best_block.read().unwrap().height() + 1;
6768 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::signing_only(), &route.paths[0], &session_priv).unwrap();
6769 let (onion_payloads, _htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 3999999, &Some(our_payment_secret), cur_height).unwrap();
6770 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &our_payment_hash);
6772 let mut msg = msgs::UpdateAddHTLC {
6776 payment_hash: our_payment_hash,
6777 cltv_expiry: htlc_cltv,
6778 onion_routing_packet: onion_packet.clone(),
6781 for i in 0..super::channel::OUR_MAX_HTLCS {
6782 msg.htlc_id = i as u64;
6783 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
6785 msg.htlc_id = (super::channel::OUR_MAX_HTLCS) as u64;
6786 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
6788 assert!(nodes[1].node.list_channels().is_empty());
6789 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6790 assert!(regex::Regex::new(r"Remote tried to push more than our max accepted HTLCs \(\d+\)").unwrap().is_match(err_msg.data.as_str()));
6791 check_added_monitors!(nodes[1], 1);
6795 fn test_update_add_htlc_bolt2_receiver_check_max_in_flight_msat() {
6796 //OR adds more than its max_htlc_value_in_flight_msat worth of offered HTLCs to its local commitment transaction: SHOULD fail the channel
6797 let chanmon_cfgs = create_chanmon_cfgs(2);
6798 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6799 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6800 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6801 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
6802 let logger = test_utils::TestLogger::new();
6804 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6805 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6806 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();
6807 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6808 check_added_monitors!(nodes[0], 1);
6809 let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6810 updates.update_add_htlcs[0].amount_msat = get_channel_value_stat!(nodes[1], chan.2).counterparty_max_htlc_value_in_flight_msat + 1;
6811 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6813 assert!(nodes[1].node.list_channels().is_empty());
6814 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6815 assert!(regex::Regex::new("Remote HTLC add would put them over our max HTLC value").unwrap().is_match(err_msg.data.as_str()));
6816 check_added_monitors!(nodes[1], 1);
6820 fn test_update_add_htlc_bolt2_receiver_check_cltv_expiry() {
6821 //BOLT2 Requirement: if sending node sets cltv_expiry to greater or equal to 500000000: SHOULD fail the channel.
6822 let chanmon_cfgs = create_chanmon_cfgs(2);
6823 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6824 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6825 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6826 let logger = test_utils::TestLogger::new();
6828 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6829 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6830 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6831 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();
6832 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6833 check_added_monitors!(nodes[0], 1);
6834 let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6835 updates.update_add_htlcs[0].cltv_expiry = 500000000;
6836 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6838 assert!(nodes[1].node.list_channels().is_empty());
6839 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6840 assert_eq!(err_msg.data,"Remote provided CLTV expiry in seconds instead of block height");
6841 check_added_monitors!(nodes[1], 1);
6845 fn test_update_add_htlc_bolt2_receiver_check_repeated_id_ignore() {
6846 //BOLT 2 requirement: if the sender did not previously acknowledge the commitment of that HTLC: MUST ignore a repeated id value after a reconnection.
6847 // We test this by first testing that that repeated HTLCs pass commitment signature checks
6848 // after disconnect and that non-sequential htlc_ids result in a channel failure.
6849 let chanmon_cfgs = create_chanmon_cfgs(2);
6850 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6851 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6852 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6853 let logger = test_utils::TestLogger::new();
6855 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6856 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6857 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6858 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();
6859 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6860 check_added_monitors!(nodes[0], 1);
6861 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6862 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6864 //Disconnect and Reconnect
6865 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
6866 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
6867 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
6868 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
6869 assert_eq!(reestablish_1.len(), 1);
6870 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
6871 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
6872 assert_eq!(reestablish_2.len(), 1);
6873 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
6874 handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
6875 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
6876 handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
6879 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6880 assert_eq!(updates.commitment_signed.htlc_signatures.len(), 1);
6881 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &updates.commitment_signed);
6882 check_added_monitors!(nodes[1], 1);
6883 let _bs_responses = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6885 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6887 assert!(nodes[1].node.list_channels().is_empty());
6888 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6889 assert!(regex::Regex::new(r"Remote skipped HTLC ID \(skipped ID: \d+\)").unwrap().is_match(err_msg.data.as_str()));
6890 check_added_monitors!(nodes[1], 1);
6894 fn test_update_fulfill_htlc_bolt2_update_fulfill_htlc_before_commitment() {
6895 //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.
6897 let chanmon_cfgs = create_chanmon_cfgs(2);
6898 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6899 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6900 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6901 let logger = test_utils::TestLogger::new();
6902 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6903 let (our_payment_preimage, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6904 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6905 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();
6906 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6908 check_added_monitors!(nodes[0], 1);
6909 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6910 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6912 let update_msg = msgs::UpdateFulfillHTLC{
6915 payment_preimage: our_payment_preimage,
6918 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6920 assert!(nodes[0].node.list_channels().is_empty());
6921 let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6922 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()));
6923 check_added_monitors!(nodes[0], 1);
6927 fn test_update_fulfill_htlc_bolt2_update_fail_htlc_before_commitment() {
6928 //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.
6930 let chanmon_cfgs = create_chanmon_cfgs(2);
6931 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6932 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6933 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6934 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6935 let logger = test_utils::TestLogger::new();
6937 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6938 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6939 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();
6940 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6941 check_added_monitors!(nodes[0], 1);
6942 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6943 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6945 let update_msg = msgs::UpdateFailHTLC{
6948 reason: msgs::OnionErrorPacket { data: Vec::new()},
6951 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6953 assert!(nodes[0].node.list_channels().is_empty());
6954 let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6955 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()));
6956 check_added_monitors!(nodes[0], 1);
6960 fn test_update_fulfill_htlc_bolt2_update_fail_malformed_htlc_before_commitment() {
6961 //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.
6963 let chanmon_cfgs = create_chanmon_cfgs(2);
6964 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6965 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6966 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6967 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6968 let logger = test_utils::TestLogger::new();
6970 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6971 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6972 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();
6973 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6974 check_added_monitors!(nodes[0], 1);
6975 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6976 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6977 let update_msg = msgs::UpdateFailMalformedHTLC{
6980 sha256_of_onion: [1; 32],
6981 failure_code: 0x8000,
6984 nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6986 assert!(nodes[0].node.list_channels().is_empty());
6987 let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6988 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()));
6989 check_added_monitors!(nodes[0], 1);
6993 fn test_update_fulfill_htlc_bolt2_incorrect_htlc_id() {
6994 //BOLT 2 Requirement: A receiving node: if the id does not correspond to an HTLC in its current commitment transaction MUST fail the channel.
6996 let chanmon_cfgs = create_chanmon_cfgs(2);
6997 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6998 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6999 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7000 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7002 let our_payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 100000).0;
7004 nodes[1].node.claim_funds(our_payment_preimage);
7005 check_added_monitors!(nodes[1], 1);
7007 let events = nodes[1].node.get_and_clear_pending_msg_events();
7008 assert_eq!(events.len(), 1);
7009 let mut update_fulfill_msg: msgs::UpdateFulfillHTLC = {
7011 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, .. } } => {
7012 assert!(update_add_htlcs.is_empty());
7013 assert_eq!(update_fulfill_htlcs.len(), 1);
7014 assert!(update_fail_htlcs.is_empty());
7015 assert!(update_fail_malformed_htlcs.is_empty());
7016 assert!(update_fee.is_none());
7017 update_fulfill_htlcs[0].clone()
7019 _ => panic!("Unexpected event"),
7023 update_fulfill_msg.htlc_id = 1;
7025 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_msg);
7027 assert!(nodes[0].node.list_channels().is_empty());
7028 let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
7029 assert_eq!(err_msg.data, "Remote tried to fulfill/fail an HTLC we couldn't find");
7030 check_added_monitors!(nodes[0], 1);
7034 fn test_update_fulfill_htlc_bolt2_wrong_preimage() {
7035 //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.
7037 let chanmon_cfgs = create_chanmon_cfgs(2);
7038 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7039 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7040 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7041 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7043 let our_payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 100000).0;
7045 nodes[1].node.claim_funds(our_payment_preimage);
7046 check_added_monitors!(nodes[1], 1);
7048 let events = nodes[1].node.get_and_clear_pending_msg_events();
7049 assert_eq!(events.len(), 1);
7050 let mut update_fulfill_msg: msgs::UpdateFulfillHTLC = {
7052 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, .. } } => {
7053 assert!(update_add_htlcs.is_empty());
7054 assert_eq!(update_fulfill_htlcs.len(), 1);
7055 assert!(update_fail_htlcs.is_empty());
7056 assert!(update_fail_malformed_htlcs.is_empty());
7057 assert!(update_fee.is_none());
7058 update_fulfill_htlcs[0].clone()
7060 _ => panic!("Unexpected event"),
7064 update_fulfill_msg.payment_preimage = PaymentPreimage([1; 32]);
7066 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_msg);
7068 assert!(nodes[0].node.list_channels().is_empty());
7069 let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
7070 assert!(regex::Regex::new(r"Remote tried to fulfill HTLC \(\d+\) with an incorrect preimage").unwrap().is_match(err_msg.data.as_str()));
7071 check_added_monitors!(nodes[0], 1);
7075 fn test_update_fulfill_htlc_bolt2_missing_badonion_bit_for_malformed_htlc_message() {
7076 //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.
7078 let chanmon_cfgs = create_chanmon_cfgs(2);
7079 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7080 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7081 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7082 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7083 let logger = test_utils::TestLogger::new();
7085 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
7086 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
7087 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();
7088 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
7089 check_added_monitors!(nodes[0], 1);
7091 let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
7092 updates.update_add_htlcs[0].onion_routing_packet.version = 1; //Produce a malformed HTLC message
7094 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
7095 check_added_monitors!(nodes[1], 0);
7096 commitment_signed_dance!(nodes[1], nodes[0], updates.commitment_signed, false, true);
7098 let events = nodes[1].node.get_and_clear_pending_msg_events();
7100 let mut update_msg: msgs::UpdateFailMalformedHTLC = {
7102 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, .. } } => {
7103 assert!(update_add_htlcs.is_empty());
7104 assert!(update_fulfill_htlcs.is_empty());
7105 assert!(update_fail_htlcs.is_empty());
7106 assert_eq!(update_fail_malformed_htlcs.len(), 1);
7107 assert!(update_fee.is_none());
7108 update_fail_malformed_htlcs[0].clone()
7110 _ => panic!("Unexpected event"),
7113 update_msg.failure_code &= !0x8000;
7114 nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
7116 assert!(nodes[0].node.list_channels().is_empty());
7117 let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
7118 assert_eq!(err_msg.data, "Got update_fail_malformed_htlc with BADONION not set");
7119 check_added_monitors!(nodes[0], 1);
7123 fn test_update_fulfill_htlc_bolt2_after_malformed_htlc_message_must_forward_update_fail_htlc() {
7124 //BOLT 2 Requirement: a receiving node which has an outgoing HTLC canceled by update_fail_malformed_htlc:
7125 // * 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.
7127 let chanmon_cfgs = create_chanmon_cfgs(3);
7128 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7129 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
7130 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7131 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7132 create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7133 let logger = test_utils::TestLogger::new();
7135 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[2]);
7138 let mut payment_event = {
7139 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
7140 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();
7141 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
7142 check_added_monitors!(nodes[0], 1);
7143 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
7144 assert_eq!(events.len(), 1);
7145 SendEvent::from_event(events.remove(0))
7147 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
7148 check_added_monitors!(nodes[1], 0);
7149 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
7150 expect_pending_htlcs_forwardable!(nodes[1]);
7151 let mut events_2 = nodes[1].node.get_and_clear_pending_msg_events();
7152 assert_eq!(events_2.len(), 1);
7153 check_added_monitors!(nodes[1], 1);
7154 payment_event = SendEvent::from_event(events_2.remove(0));
7155 assert_eq!(payment_event.msgs.len(), 1);
7158 payment_event.msgs[0].onion_routing_packet.version = 1; //Produce a malformed HTLC message
7159 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
7160 check_added_monitors!(nodes[2], 0);
7161 commitment_signed_dance!(nodes[2], nodes[1], payment_event.commitment_msg, false, true);
7163 let events_3 = nodes[2].node.get_and_clear_pending_msg_events();
7164 assert_eq!(events_3.len(), 1);
7165 let update_msg : (msgs::UpdateFailMalformedHTLC, msgs::CommitmentSigned) = {
7167 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 } } => {
7168 assert!(update_add_htlcs.is_empty());
7169 assert!(update_fulfill_htlcs.is_empty());
7170 assert!(update_fail_htlcs.is_empty());
7171 assert_eq!(update_fail_malformed_htlcs.len(), 1);
7172 assert!(update_fee.is_none());
7173 (update_fail_malformed_htlcs[0].clone(), commitment_signed.clone())
7175 _ => panic!("Unexpected event"),
7179 nodes[1].node.handle_update_fail_malformed_htlc(&nodes[2].node.get_our_node_id(), &update_msg.0);
7181 check_added_monitors!(nodes[1], 0);
7182 commitment_signed_dance!(nodes[1], nodes[2], update_msg.1, false, true);
7183 expect_pending_htlcs_forwardable!(nodes[1]);
7184 let events_4 = nodes[1].node.get_and_clear_pending_msg_events();
7185 assert_eq!(events_4.len(), 1);
7187 //Confirm that handlinge the update_malformed_htlc message produces an update_fail_htlc message to be forwarded back along the route
7189 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, .. } } => {
7190 assert!(update_add_htlcs.is_empty());
7191 assert!(update_fulfill_htlcs.is_empty());
7192 assert_eq!(update_fail_htlcs.len(), 1);
7193 assert!(update_fail_malformed_htlcs.is_empty());
7194 assert!(update_fee.is_none());
7196 _ => panic!("Unexpected event"),
7199 check_added_monitors!(nodes[1], 1);
7202 fn do_test_failure_delay_dust_htlc_local_commitment(announce_latest: bool) {
7203 // Dust-HTLC failure updates must be delayed until failure-trigger tx (in this case local commitment) reach ANTI_REORG_DELAY
7204 // 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
7205 // HTLC could have been removed from lastest local commitment tx but still valid until we get remote RAA
7207 let mut chanmon_cfgs = create_chanmon_cfgs(2);
7208 chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
7209 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7210 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7211 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7212 let chan =create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7214 let bs_dust_limit = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().holder_dust_limit_satoshis;
7216 // We route 2 dust-HTLCs between A and B
7217 let (_, payment_hash_1, _) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
7218 let (_, payment_hash_2, _) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
7219 route_payment(&nodes[0], &[&nodes[1]], 1000000);
7221 // Cache one local commitment tx as previous
7222 let as_prev_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
7224 // Fail one HTLC to prune it in the will-be-latest-local commitment tx
7225 assert!(nodes[1].node.fail_htlc_backwards(&payment_hash_2));
7226 check_added_monitors!(nodes[1], 0);
7227 expect_pending_htlcs_forwardable!(nodes[1]);
7228 check_added_monitors!(nodes[1], 1);
7230 let remove = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
7231 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &remove.update_fail_htlcs[0]);
7232 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &remove.commitment_signed);
7233 check_added_monitors!(nodes[0], 1);
7235 // Cache one local commitment tx as lastest
7236 let as_last_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
7238 let events = nodes[0].node.get_and_clear_pending_msg_events();
7240 MessageSendEvent::SendRevokeAndACK { node_id, .. } => {
7241 assert_eq!(node_id, nodes[1].node.get_our_node_id());
7243 _ => panic!("Unexpected event"),
7246 MessageSendEvent::UpdateHTLCs { node_id, .. } => {
7247 assert_eq!(node_id, nodes[1].node.get_our_node_id());
7249 _ => panic!("Unexpected event"),
7252 assert_ne!(as_prev_commitment_tx, as_last_commitment_tx);
7253 // Fail the 2 dust-HTLCs, move their failure in maturation buffer (htlc_updated_waiting_threshold_conf)
7254 if announce_latest {
7255 mine_transaction(&nodes[0], &as_last_commitment_tx[0]);
7257 mine_transaction(&nodes[0], &as_prev_commitment_tx[0]);
7260 check_closed_broadcast!(nodes[0], true);
7261 check_added_monitors!(nodes[0], 1);
7263 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7264 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7265 let events = nodes[0].node.get_and_clear_pending_events();
7266 // Only 2 PaymentFailed events should show up, over-dust HTLC has to be failed by timeout tx
7267 assert_eq!(events.len(), 2);
7268 let mut first_failed = false;
7269 for event in events {
7271 Event::PaymentFailed { payment_hash, .. } => {
7272 if payment_hash == payment_hash_1 {
7273 assert!(!first_failed);
7274 first_failed = true;
7276 assert_eq!(payment_hash, payment_hash_2);
7279 _ => panic!("Unexpected event"),
7285 fn test_failure_delay_dust_htlc_local_commitment() {
7286 do_test_failure_delay_dust_htlc_local_commitment(true);
7287 do_test_failure_delay_dust_htlc_local_commitment(false);
7290 fn do_test_sweep_outbound_htlc_failure_update(revoked: bool, local: bool) {
7291 // Outbound HTLC-failure updates must be cancelled if we get a reorg before we reach ANTI_REORG_DELAY.
7292 // Broadcast of revoked remote commitment tx, trigger failure-update of dust/non-dust HTLCs
7293 // Broadcast of remote commitment tx, trigger failure-update of dust-HTLCs
7294 // Broadcast of timeout tx on remote commitment tx, trigger failure-udate of non-dust HTLCs
7295 // Broadcast of local commitment tx, trigger failure-update of dust-HTLCs
7296 // Broadcast of HTLC-timeout tx on local commitment tx, trigger failure-update of non-dust HTLCs
7298 let chanmon_cfgs = create_chanmon_cfgs(3);
7299 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7300 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
7301 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7302 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7304 let bs_dust_limit = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().holder_dust_limit_satoshis;
7306 let (_payment_preimage_1, dust_hash, _payment_secret_1) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
7307 let (_payment_preimage_2, non_dust_hash, _payment_secret_2) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
7309 let as_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
7310 let bs_commitment_tx = get_local_commitment_txn!(nodes[1], chan.2);
7312 // We revoked bs_commitment_tx
7314 let (payment_preimage_3, _, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
7315 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_3);
7318 let mut timeout_tx = Vec::new();
7320 // We fail dust-HTLC 1 by broadcast of local commitment tx
7321 mine_transaction(&nodes[0], &as_commitment_tx[0]);
7322 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7323 expect_payment_failed!(nodes[0], dust_hash, true);
7325 connect_blocks(&nodes[0], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS - ANTI_REORG_DELAY);
7326 check_closed_broadcast!(nodes[0], true);
7327 check_added_monitors!(nodes[0], 1);
7328 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7329 timeout_tx.push(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[1].clone());
7330 assert_eq!(timeout_tx[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
7331 // We fail non-dust-HTLC 2 by broadcast of local HTLC-timeout tx on local commitment tx
7332 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7333 mine_transaction(&nodes[0], &timeout_tx[0]);
7334 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7335 expect_payment_failed!(nodes[0], non_dust_hash, true);
7337 // We fail dust-HTLC 1 by broadcast of remote commitment tx. If revoked, fail also non-dust HTLC
7338 mine_transaction(&nodes[0], &bs_commitment_tx[0]);
7339 check_closed_broadcast!(nodes[0], true);
7340 check_added_monitors!(nodes[0], 1);
7341 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7342 connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
7343 timeout_tx.push(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[1].clone());
7345 expect_payment_failed!(nodes[0], dust_hash, true);
7346 assert_eq!(timeout_tx[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
7347 // We fail non-dust-HTLC 2 by broadcast of local timeout tx on remote commitment tx
7348 mine_transaction(&nodes[0], &timeout_tx[0]);
7349 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7350 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7351 expect_payment_failed!(nodes[0], non_dust_hash, true);
7353 // If revoked, both dust & non-dust HTLCs should have been failed after ANTI_REORG_DELAY confs of revoked
7355 let events = nodes[0].node.get_and_clear_pending_events();
7356 assert_eq!(events.len(), 2);
7359 Event::PaymentFailed { payment_hash, .. } => {
7360 if payment_hash == dust_hash { first = true; }
7361 else { first = false; }
7363 _ => panic!("Unexpected event"),
7366 Event::PaymentFailed { payment_hash, .. } => {
7367 if first { assert_eq!(payment_hash, non_dust_hash); }
7368 else { assert_eq!(payment_hash, dust_hash); }
7370 _ => panic!("Unexpected event"),
7377 fn test_sweep_outbound_htlc_failure_update() {
7378 do_test_sweep_outbound_htlc_failure_update(false, true);
7379 do_test_sweep_outbound_htlc_failure_update(false, false);
7380 do_test_sweep_outbound_htlc_failure_update(true, false);
7384 fn test_upfront_shutdown_script() {
7385 // BOLT 2 : Option upfront shutdown script, if peer commit its closing_script at channel opening
7386 // enforce it at shutdown message
7388 let mut config = UserConfig::default();
7389 config.channel_options.announced_channel = true;
7390 config.peer_channel_config_limits.force_announced_channel_preference = false;
7391 config.channel_options.commit_upfront_shutdown_pubkey = false;
7392 let user_cfgs = [None, Some(config), None];
7393 let chanmon_cfgs = create_chanmon_cfgs(3);
7394 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7395 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
7396 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7398 // We test that in case of peer committing upfront to a script, if it changes at closing, we refuse to sign
7399 let flags = InitFeatures::known();
7400 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 1000000, 1000000, flags.clone(), flags.clone());
7401 nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7402 let mut node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[2].node.get_our_node_id());
7403 node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
7404 // Test we enforce upfront_scriptpbukey if by providing a diffrent one at closing that we disconnect peer
7405 nodes[2].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
7406 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()));
7407 check_added_monitors!(nodes[2], 1);
7409 // We test that in case of peer committing upfront to a script, if it doesn't change at closing, we sign
7410 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 1000000, 1000000, flags.clone(), flags.clone());
7411 nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7412 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[2].node.get_our_node_id());
7413 // We test that in case of peer committing upfront to a script, if it oesn't change at closing, we sign
7414 nodes[2].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
7415 let events = nodes[2].node.get_and_clear_pending_msg_events();
7416 assert_eq!(events.len(), 1);
7418 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[0].node.get_our_node_id()) }
7419 _ => panic!("Unexpected event"),
7422 // We test that if case of peer non-signaling we don't enforce committed script at channel opening
7423 let flags_no = InitFeatures::known().clear_upfront_shutdown_script();
7424 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, flags_no, flags.clone());
7425 nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7426 let mut node_1_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
7427 node_1_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
7428 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_1_shutdown);
7429 let events = nodes[1].node.get_and_clear_pending_msg_events();
7430 assert_eq!(events.len(), 1);
7432 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[0].node.get_our_node_id()) }
7433 _ => panic!("Unexpected event"),
7436 // We test that if user opt-out, we provide a zero-length script at channel opening and we are able to close
7437 // channel smoothly, opt-out is from channel initiator here
7438 let chan = create_announced_chan_between_nodes_with_value(&nodes, 1, 0, 1000000, 1000000, flags.clone(), flags.clone());
7439 nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7440 let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
7441 node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
7442 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
7443 let events = nodes[0].node.get_and_clear_pending_msg_events();
7444 assert_eq!(events.len(), 1);
7446 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7447 _ => panic!("Unexpected event"),
7450 //// We test that if user opt-out, we provide a zero-length script at channel opening and we are able to close
7451 //// channel smoothly
7452 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, flags.clone(), flags.clone());
7453 nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7454 let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
7455 node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
7456 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
7457 let events = nodes[0].node.get_and_clear_pending_msg_events();
7458 assert_eq!(events.len(), 2);
7460 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7461 _ => panic!("Unexpected event"),
7464 MessageSendEvent::SendClosingSigned { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7465 _ => panic!("Unexpected event"),
7470 fn test_upfront_shutdown_script_unsupport_segwit() {
7471 // We test that channel is closed early
7472 // if a segwit program is passed as upfront shutdown script,
7473 // but the peer does not support segwit.
7474 let chanmon_cfgs = create_chanmon_cfgs(2);
7475 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7476 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7477 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7479 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
7481 let mut open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
7482 open_channel.shutdown_scriptpubkey = Present(Builder::new().push_int(16)
7483 .push_slice(&[0, 0])
7486 let features = InitFeatures::known().clear_shutdown_anysegwit();
7487 nodes[0].node.handle_open_channel(&nodes[0].node.get_our_node_id(), features, &open_channel);
7489 let events = nodes[0].node.get_and_clear_pending_msg_events();
7490 assert_eq!(events.len(), 1);
7492 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
7493 assert_eq!(node_id, nodes[0].node.get_our_node_id());
7494 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));
7496 _ => panic!("Unexpected event"),
7501 fn test_shutdown_script_any_segwit_allowed() {
7502 let mut config = UserConfig::default();
7503 config.channel_options.announced_channel = true;
7504 config.peer_channel_config_limits.force_announced_channel_preference = false;
7505 config.channel_options.commit_upfront_shutdown_pubkey = false;
7506 let user_cfgs = [None, Some(config), None];
7507 let chanmon_cfgs = create_chanmon_cfgs(3);
7508 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7509 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
7510 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7512 //// We test if the remote peer accepts opt_shutdown_anysegwit, a witness program can be used on shutdown
7513 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7514 nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7515 let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
7516 node_0_shutdown.scriptpubkey = Builder::new().push_int(16)
7517 .push_slice(&[0, 0])
7519 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
7520 let events = nodes[0].node.get_and_clear_pending_msg_events();
7521 assert_eq!(events.len(), 2);
7523 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7524 _ => panic!("Unexpected event"),
7527 MessageSendEvent::SendClosingSigned { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7528 _ => panic!("Unexpected event"),
7533 fn test_shutdown_script_any_segwit_not_allowed() {
7534 let mut config = UserConfig::default();
7535 config.channel_options.announced_channel = true;
7536 config.peer_channel_config_limits.force_announced_channel_preference = false;
7537 config.channel_options.commit_upfront_shutdown_pubkey = false;
7538 let user_cfgs = [None, Some(config), None];
7539 let chanmon_cfgs = create_chanmon_cfgs(3);
7540 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7541 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
7542 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7544 //// We test that if the remote peer does not accept opt_shutdown_anysegwit, the witness program cannot be used on shutdown
7545 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7546 nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7547 let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
7548 // Make an any segwit version script
7549 node_0_shutdown.scriptpubkey = Builder::new().push_int(16)
7550 .push_slice(&[0, 0])
7552 let flags_no = InitFeatures::known().clear_shutdown_anysegwit();
7553 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &flags_no, &node_0_shutdown);
7554 let events = nodes[0].node.get_and_clear_pending_msg_events();
7555 assert_eq!(events.len(), 2);
7557 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
7558 assert_eq!(node_id, nodes[1].node.get_our_node_id());
7559 assert_eq!(msg.data, "Got a nonstandard scriptpubkey (60020000) from remote peer".to_owned())
7561 _ => panic!("Unexpected event"),
7563 check_added_monitors!(nodes[0], 1);
7567 fn test_shutdown_script_segwit_but_not_anysegwit() {
7568 let mut config = UserConfig::default();
7569 config.channel_options.announced_channel = true;
7570 config.peer_channel_config_limits.force_announced_channel_preference = false;
7571 config.channel_options.commit_upfront_shutdown_pubkey = false;
7572 let user_cfgs = [None, Some(config), None];
7573 let chanmon_cfgs = create_chanmon_cfgs(3);
7574 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7575 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
7576 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7578 //// We test that if shutdown any segwit is supported and we send a witness script with 0 version, this is not accepted
7579 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7580 nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7581 let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
7582 // Make a segwit script that is not a valid as any segwit
7583 node_0_shutdown.scriptpubkey = Builder::new().push_int(0)
7584 .push_slice(&[0, 0])
7586 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
7587 let events = nodes[0].node.get_and_clear_pending_msg_events();
7588 assert_eq!(events.len(), 2);
7590 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
7591 assert_eq!(node_id, nodes[1].node.get_our_node_id());
7592 assert_eq!(msg.data, "Got a nonstandard scriptpubkey (00020000) from remote peer".to_owned())
7594 _ => panic!("Unexpected event"),
7596 check_added_monitors!(nodes[0], 1);
7600 fn test_user_configurable_csv_delay() {
7601 // We test our channel constructors yield errors when we pass them absurd csv delay
7603 let mut low_our_to_self_config = UserConfig::default();
7604 low_our_to_self_config.own_channel_config.our_to_self_delay = 6;
7605 let mut high_their_to_self_config = UserConfig::default();
7606 high_their_to_self_config.peer_channel_config_limits.their_to_self_delay = 100;
7607 let user_cfgs = [Some(high_their_to_self_config.clone()), None];
7608 let chanmon_cfgs = create_chanmon_cfgs(2);
7609 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7610 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &user_cfgs);
7611 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7613 // We test config.our_to_self > BREAKDOWN_TIMEOUT is enforced in Channel::new_outbound()
7614 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) {
7616 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())); },
7617 _ => panic!("Unexpected event"),
7619 } else { assert!(false) }
7621 // We test config.our_to_self > BREAKDOWN_TIMEOUT is enforced in Channel::new_from_req()
7622 nodes[1].node.create_channel(nodes[0].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
7623 let mut open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
7624 open_channel.to_self_delay = 200;
7625 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) {
7627 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())); },
7628 _ => panic!("Unexpected event"),
7630 } else { assert!(false); }
7632 // We test msg.to_self_delay <= config.their_to_self_delay is enforced in Chanel::accept_channel()
7633 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
7634 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()));
7635 let mut accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
7636 accept_channel.to_self_delay = 200;
7637 nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &accept_channel);
7638 if let MessageSendEvent::HandleError { ref action, .. } = nodes[0].node.get_and_clear_pending_msg_events()[0] {
7640 &ErrorAction::SendErrorMessage { ref msg } => {
7641 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()));
7643 _ => { assert!(false); }
7645 } else { assert!(false); }
7647 // We test msg.to_self_delay <= config.their_to_self_delay is enforced in Channel::new_from_req()
7648 nodes[1].node.create_channel(nodes[0].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
7649 let mut open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
7650 open_channel.to_self_delay = 200;
7651 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) {
7653 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())); },
7654 _ => panic!("Unexpected event"),
7656 } else { assert!(false); }
7660 fn test_data_loss_protect() {
7661 // We want to be sure that :
7662 // * we don't broadcast our Local Commitment Tx in case of fallen behind
7663 // (but this is not quite true - we broadcast during Drop because chanmon is out of sync with chanmgr)
7664 // * we close channel in case of detecting other being fallen behind
7665 // * we are able to claim our own outputs thanks to to_remote being static
7666 // TODO: this test is incomplete and the data_loss_protect implementation is incomplete - see issue #775
7672 let mut chanmon_cfgs = create_chanmon_cfgs(2);
7673 // We broadcast during Drop because chanmon is out of sync with chanmgr, which would cause a panic
7674 // during signing due to revoked tx
7675 chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
7676 let keys_manager = &chanmon_cfgs[0].keys_manager;
7679 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7680 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7681 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7683 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7685 // Cache node A state before any channel update
7686 let previous_node_state = nodes[0].node.encode();
7687 let mut previous_chain_monitor_state = test_utils::TestVecWriter(Vec::new());
7688 nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut previous_chain_monitor_state).unwrap();
7690 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
7691 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
7693 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
7694 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
7696 // Restore node A from previous state
7697 logger = test_utils::TestLogger::with_id(format!("node {}", 0));
7698 let mut chain_monitor = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(&mut ::std::io::Cursor::new(previous_chain_monitor_state.0), keys_manager).unwrap().1;
7699 chain_source = test_utils::TestChainSource::new(Network::Testnet);
7700 tx_broadcaster = test_utils::TestBroadcaster{txn_broadcasted: Mutex::new(Vec::new()), blocks: Arc::new(Mutex::new(Vec::new()))};
7701 fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
7702 persister = test_utils::TestPersister::new();
7703 monitor = test_utils::TestChainMonitor::new(Some(&chain_source), &tx_broadcaster, &logger, &fee_estimator, &persister, keys_manager);
7705 let mut channel_monitors = HashMap::new();
7706 channel_monitors.insert(OutPoint { txid: chan.3.txid(), index: 0 }, &mut chain_monitor);
7707 <(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 {
7708 keys_manager: keys_manager,
7709 fee_estimator: &fee_estimator,
7710 chain_monitor: &monitor,
7712 tx_broadcaster: &tx_broadcaster,
7713 default_config: UserConfig::default(),
7717 nodes[0].node = &node_state_0;
7718 assert!(monitor.watch_channel(OutPoint { txid: chan.3.txid(), index: 0 }, chain_monitor).is_ok());
7719 nodes[0].chain_monitor = &monitor;
7720 nodes[0].chain_source = &chain_source;
7722 check_added_monitors!(nodes[0], 1);
7724 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7725 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7727 let reestablish_0 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
7729 // Check we don't broadcast any transactions following learning of per_commitment_point from B
7730 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_0[0]);
7731 check_added_monitors!(nodes[0], 1);
7734 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
7735 assert_eq!(node_txn.len(), 0);
7738 let mut reestablish_1 = Vec::with_capacity(1);
7739 for msg in nodes[0].node.get_and_clear_pending_msg_events() {
7740 if let MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } = msg {
7741 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
7742 reestablish_1.push(msg.clone());
7743 } else if let MessageSendEvent::BroadcastChannelUpdate { .. } = msg {
7744 } else if let MessageSendEvent::HandleError { ref action, .. } = msg {
7746 &ErrorAction::SendErrorMessage { ref msg } => {
7747 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");
7749 _ => panic!("Unexpected event!"),
7752 panic!("Unexpected event")
7756 // Check we close channel detecting A is fallen-behind
7757 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
7758 assert_eq!(check_closed_broadcast!(nodes[1], true).unwrap().data, "Peer attempted to reestablish channel with a very old local commitment transaction");
7759 check_added_monitors!(nodes[1], 1);
7762 // Check A is able to claim to_remote output
7763 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
7764 assert_eq!(node_txn.len(), 1);
7765 check_spends!(node_txn[0], chan.3);
7766 assert_eq!(node_txn[0].output.len(), 2);
7767 mine_transaction(&nodes[0], &node_txn[0]);
7768 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7769 let spend_txn = check_spendable_outputs!(nodes[0], 1, node_cfgs[0].keys_manager, 1000000);
7770 assert_eq!(spend_txn.len(), 1);
7771 check_spends!(spend_txn[0], node_txn[0]);
7775 fn test_check_htlc_underpaying() {
7776 // Send payment through A -> B but A is maliciously
7777 // sending a probe payment (i.e less than expected value0
7778 // to B, B should refuse payment.
7780 let chanmon_cfgs = create_chanmon_cfgs(2);
7781 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7782 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7783 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7785 // Create some initial channels
7786 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7788 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();
7789 let (_, our_payment_hash, _) = get_payment_preimage_hash!(nodes[0]);
7790 let our_payment_secret = nodes[1].node.create_inbound_payment_for_hash(our_payment_hash, Some(100_000), 7200, 0).unwrap();
7791 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
7792 check_added_monitors!(nodes[0], 1);
7794 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
7795 assert_eq!(events.len(), 1);
7796 let mut payment_event = SendEvent::from_event(events.pop().unwrap());
7797 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
7798 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
7800 // Note that we first have to wait a random delay before processing the receipt of the HTLC,
7801 // and then will wait a second random delay before failing the HTLC back:
7802 expect_pending_htlcs_forwardable!(nodes[1]);
7803 expect_pending_htlcs_forwardable!(nodes[1]);
7805 // Node 3 is expecting payment of 100_000 but received 10_000,
7806 // it should fail htlc like we didn't know the preimage.
7807 nodes[1].node.process_pending_htlc_forwards();
7809 let events = nodes[1].node.get_and_clear_pending_msg_events();
7810 assert_eq!(events.len(), 1);
7811 let (update_fail_htlc, commitment_signed) = match events[0] {
7812 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 } } => {
7813 assert!(update_add_htlcs.is_empty());
7814 assert!(update_fulfill_htlcs.is_empty());
7815 assert_eq!(update_fail_htlcs.len(), 1);
7816 assert!(update_fail_malformed_htlcs.is_empty());
7817 assert!(update_fee.is_none());
7818 (update_fail_htlcs[0].clone(), commitment_signed)
7820 _ => panic!("Unexpected event"),
7822 check_added_monitors!(nodes[1], 1);
7824 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlc);
7825 commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
7827 // 10_000 msat as u64, followed by a height of CHAN_CONFIRM_DEPTH as u32
7828 let mut expected_failure_data = byte_utils::be64_to_array(10_000).to_vec();
7829 expected_failure_data.extend_from_slice(&byte_utils::be32_to_array(CHAN_CONFIRM_DEPTH));
7830 expect_payment_failed!(nodes[0], our_payment_hash, true, 0x4000|15, &expected_failure_data[..]);
7834 fn test_announce_disable_channels() {
7835 // Create 2 channels between A and B. Disconnect B. Call timer_tick_occurred and check for generated
7836 // ChannelUpdate. Reconnect B, reestablish and check there is non-generated ChannelUpdate.
7838 let chanmon_cfgs = create_chanmon_cfgs(2);
7839 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7840 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7841 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7843 let short_id_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
7844 let short_id_2 = create_announced_chan_between_nodes(&nodes, 1, 0, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
7845 let short_id_3 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
7848 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
7849 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
7851 nodes[0].node.timer_tick_occurred(); // Enabled -> DisabledStaged
7852 nodes[0].node.timer_tick_occurred(); // DisabledStaged -> Disabled
7853 let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
7854 assert_eq!(msg_events.len(), 3);
7855 let mut chans_disabled: HashSet<u64> = [short_id_1, short_id_2, short_id_3].iter().map(|a| *a).collect();
7856 for e in msg_events {
7858 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
7859 assert_eq!(msg.contents.flags & (1<<1), 1<<1); // The "channel disabled" bit should be set
7860 // Check that each channel gets updated exactly once
7861 if !chans_disabled.remove(&msg.contents.short_channel_id) {
7862 panic!("Generated ChannelUpdate for wrong chan!");
7865 _ => panic!("Unexpected event"),
7869 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7870 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
7871 assert_eq!(reestablish_1.len(), 3);
7872 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7873 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
7874 assert_eq!(reestablish_2.len(), 3);
7876 // Reestablish chan_1
7877 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
7878 handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
7879 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
7880 handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
7881 // Reestablish chan_2
7882 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[1]);
7883 handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
7884 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[1]);
7885 handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
7886 // Reestablish chan_3
7887 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[2]);
7888 handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
7889 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[2]);
7890 handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
7892 nodes[0].node.timer_tick_occurred();
7893 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
7894 nodes[0].node.timer_tick_occurred();
7895 let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
7896 assert_eq!(msg_events.len(), 3);
7897 chans_disabled = [short_id_1, short_id_2, short_id_3].iter().map(|a| *a).collect();
7898 for e in msg_events {
7900 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
7901 assert_eq!(msg.contents.flags & (1<<1), 0); // The "channel disabled" bit should be off
7902 // Check that each channel gets updated exactly once
7903 if !chans_disabled.remove(&msg.contents.short_channel_id) {
7904 panic!("Generated ChannelUpdate for wrong chan!");
7907 _ => panic!("Unexpected event"),
7913 fn test_bump_penalty_txn_on_revoked_commitment() {
7914 // In case of penalty txn with too low feerates for getting into mempools, RBF-bump them to be sure
7915 // we're able to claim outputs on revoked commitment transaction before timelocks expiration
7917 let chanmon_cfgs = create_chanmon_cfgs(2);
7918 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7919 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7920 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7922 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
7923 let logger = test_utils::TestLogger::new();
7925 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
7926 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
7927 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();
7928 send_along_route(&nodes[1], route, &vec!(&nodes[0])[..], 3000000);
7930 let revoked_txn = get_local_commitment_txn!(nodes[0], chan.2);
7931 // Revoked commitment txn with 4 outputs : to_local, to_remote, 1 outgoing HTLC, 1 incoming HTLC
7932 assert_eq!(revoked_txn[0].output.len(), 4);
7933 assert_eq!(revoked_txn[0].input.len(), 1);
7934 assert_eq!(revoked_txn[0].input[0].previous_output.txid, chan.3.txid());
7935 let revoked_txid = revoked_txn[0].txid();
7937 let mut penalty_sum = 0;
7938 for outp in revoked_txn[0].output.iter() {
7939 if outp.script_pubkey.is_v0_p2wsh() {
7940 penalty_sum += outp.value;
7944 // Connect blocks to change height_timer range to see if we use right soonest_timelock
7945 let header_114 = connect_blocks(&nodes[1], 14);
7947 // Actually revoke tx by claiming a HTLC
7948 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
7949 let header = BlockHeader { version: 0x20000000, prev_blockhash: header_114, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7950 connect_block(&nodes[1], &Block { header, txdata: vec![revoked_txn[0].clone()] });
7951 check_added_monitors!(nodes[1], 1);
7953 // One or more justice tx should have been broadcast, check it
7957 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7958 assert_eq!(node_txn.len(), 2); // justice tx (broadcasted from ChannelMonitor) + local commitment tx
7959 assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
7960 assert_eq!(node_txn[0].output.len(), 1);
7961 check_spends!(node_txn[0], revoked_txn[0]);
7962 let fee_1 = penalty_sum - node_txn[0].output[0].value;
7963 feerate_1 = fee_1 * 1000 / node_txn[0].get_weight() as u64;
7964 penalty_1 = node_txn[0].txid();
7968 // After exhaustion of height timer, a new bumped justice tx should have been broadcast, check it
7969 connect_blocks(&nodes[1], 15);
7970 let mut penalty_2 = penalty_1;
7971 let mut feerate_2 = 0;
7973 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7974 assert_eq!(node_txn.len(), 1);
7975 if node_txn[0].input[0].previous_output.txid == revoked_txid {
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 penalty_2 = node_txn[0].txid();
7980 // Verify new bumped tx is different from last claiming transaction, we don't want spurrious rebroadcast
7981 assert_ne!(penalty_2, penalty_1);
7982 let fee_2 = penalty_sum - node_txn[0].output[0].value;
7983 feerate_2 = fee_2 * 1000 / node_txn[0].get_weight() as u64;
7984 // Verify 25% bump heuristic
7985 assert!(feerate_2 * 100 >= feerate_1 * 125);
7989 assert_ne!(feerate_2, 0);
7991 // After exhaustion of height timer for a 2nd time, a new bumped justice tx should have been broadcast, check it
7992 connect_blocks(&nodes[1], 1);
7994 let mut feerate_3 = 0;
7996 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7997 assert_eq!(node_txn.len(), 1);
7998 if node_txn[0].input[0].previous_output.txid == revoked_txid {
7999 assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
8000 assert_eq!(node_txn[0].output.len(), 1);
8001 check_spends!(node_txn[0], revoked_txn[0]);
8002 penalty_3 = node_txn[0].txid();
8003 // Verify new bumped tx is different from last claiming transaction, we don't want spurrious rebroadcast
8004 assert_ne!(penalty_3, penalty_2);
8005 let fee_3 = penalty_sum - node_txn[0].output[0].value;
8006 feerate_3 = fee_3 * 1000 / node_txn[0].get_weight() as u64;
8007 // Verify 25% bump heuristic
8008 assert!(feerate_3 * 100 >= feerate_2 * 125);
8012 assert_ne!(feerate_3, 0);
8014 nodes[1].node.get_and_clear_pending_events();
8015 nodes[1].node.get_and_clear_pending_msg_events();
8019 fn test_bump_penalty_txn_on_revoked_htlcs() {
8020 // In case of penalty txn with too low feerates for getting into mempools, RBF-bump them to sure
8021 // we're able to claim outputs on revoked HTLC transactions before timelocks expiration
8023 let mut chanmon_cfgs = create_chanmon_cfgs(2);
8024 chanmon_cfgs[1].keys_manager.disable_revocation_policy_check = true;
8025 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8026 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8027 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8029 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
8030 // Lock HTLC in both directions (using a slightly lower CLTV delay to provide timely RBF bumps)
8031 let route = get_route(&nodes[0].node.get_our_node_id(), &nodes[0].net_graph_msg_handler.network_graph.read().unwrap(),
8032 &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 3_000_000, 50, nodes[0].logger).unwrap();
8033 let payment_preimage = send_along_route(&nodes[0], route, &[&nodes[1]], 3_000_000).0;
8034 let route = get_route(&nodes[1].node.get_our_node_id(), &nodes[1].net_graph_msg_handler.network_graph.read().unwrap(),
8035 &nodes[0].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 3_000_000, 50, nodes[0].logger).unwrap();
8036 send_along_route(&nodes[1], route, &[&nodes[0]], 3_000_000);
8038 let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan.2);
8039 assert_eq!(revoked_local_txn[0].input.len(), 1);
8040 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
8042 // Revoke local commitment tx
8043 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
8045 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8046 // B will generate both revoked HTLC-timeout/HTLC-preimage txn from revoked commitment tx
8047 connect_block(&nodes[1], &Block { header, txdata: vec![revoked_local_txn[0].clone()] });
8048 check_closed_broadcast!(nodes[1], true);
8049 check_added_monitors!(nodes[1], 1);
8050 connect_blocks(&nodes[1], 49); // Confirm blocks until the HTLC expires (note CLTV was explicitly 50 above)
8052 let revoked_htlc_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8053 assert_eq!(revoked_htlc_txn.len(), 3);
8054 check_spends!(revoked_htlc_txn[1], chan.3);
8056 assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
8057 assert_eq!(revoked_htlc_txn[0].input.len(), 1);
8058 check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
8060 assert_eq!(revoked_htlc_txn[2].input.len(), 1);
8061 assert_eq!(revoked_htlc_txn[2].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
8062 assert_eq!(revoked_htlc_txn[2].output.len(), 1);
8063 check_spends!(revoked_htlc_txn[2], revoked_local_txn[0]);
8065 // Broadcast set of revoked txn on A
8066 let hash_128 = connect_blocks(&nodes[0], 40);
8067 let header_11 = BlockHeader { version: 0x20000000, prev_blockhash: hash_128, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8068 connect_block(&nodes[0], &Block { header: header_11, txdata: vec![revoked_local_txn[0].clone()] });
8069 let header_129 = BlockHeader { version: 0x20000000, prev_blockhash: header_11.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8070 connect_block(&nodes[0], &Block { header: header_129, txdata: vec![revoked_htlc_txn[0].clone(), revoked_htlc_txn[2].clone()] });
8071 expect_pending_htlcs_forwardable_ignore!(nodes[0]);
8076 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8077 assert_eq!(node_txn.len(), 5); // 3 penalty txn on revoked commitment tx + A commitment tx + 1 penalty tnx on revoked HTLC txn
8078 // Verify claim tx are spending revoked HTLC txn
8080 // node_txn 0-2 each spend a separate revoked output from revoked_local_txn[0]
8081 // Note that node_txn[0] and node_txn[1] are bogus - they double spend the revoked_htlc_txn
8082 // which are included in the same block (they are broadcasted because we scan the
8083 // transactions linearly and generate claims as we go, they likely should be removed in the
8085 assert_eq!(node_txn[0].input.len(), 1);
8086 check_spends!(node_txn[0], revoked_local_txn[0]);
8087 assert_eq!(node_txn[1].input.len(), 1);
8088 check_spends!(node_txn[1], revoked_local_txn[0]);
8089 assert_eq!(node_txn[2].input.len(), 1);
8090 check_spends!(node_txn[2], revoked_local_txn[0]);
8092 // Each of the three justice transactions claim a separate (single) output of the three
8093 // available, which we check here:
8094 assert_ne!(node_txn[0].input[0].previous_output, node_txn[1].input[0].previous_output);
8095 assert_ne!(node_txn[0].input[0].previous_output, node_txn[2].input[0].previous_output);
8096 assert_ne!(node_txn[1].input[0].previous_output, node_txn[2].input[0].previous_output);
8098 assert_eq!(node_txn[0].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
8099 assert_eq!(node_txn[1].input[0].previous_output, revoked_htlc_txn[2].input[0].previous_output);
8101 // node_txn[3] is the local commitment tx broadcast just because (and somewhat in case of
8102 // reorgs, though its not clear its ever worth broadcasting conflicting txn like this when
8103 // a remote commitment tx has already been confirmed).
8104 check_spends!(node_txn[3], chan.3);
8106 // node_txn[4] spends the revoked outputs from the revoked_htlc_txn (which only have one
8107 // output, checked above).
8108 assert_eq!(node_txn[4].input.len(), 2);
8109 assert_eq!(node_txn[4].output.len(), 1);
8110 check_spends!(node_txn[4], revoked_htlc_txn[0], revoked_htlc_txn[2]);
8112 first = node_txn[4].txid();
8113 // Store both feerates for later comparison
8114 let fee_1 = revoked_htlc_txn[0].output[0].value + revoked_htlc_txn[2].output[0].value - node_txn[4].output[0].value;
8115 feerate_1 = fee_1 * 1000 / node_txn[4].get_weight() as u64;
8116 penalty_txn = vec![node_txn[2].clone()];
8120 // Connect one more block to see if bumped penalty are issued for HTLC txn
8121 let header_130 = BlockHeader { version: 0x20000000, prev_blockhash: header_129.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8122 connect_block(&nodes[0], &Block { header: header_130, txdata: penalty_txn });
8123 let header_131 = BlockHeader { version: 0x20000000, prev_blockhash: header_130.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8124 connect_block(&nodes[0], &Block { header: header_131, txdata: Vec::new() });
8126 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8127 assert_eq!(node_txn.len(), 2); // 2 bumped penalty txn on revoked commitment tx
8129 check_spends!(node_txn[0], revoked_local_txn[0]);
8130 check_spends!(node_txn[1], revoked_local_txn[0]);
8131 // Note that these are both bogus - they spend outputs already claimed in block 129:
8132 if node_txn[0].input[0].previous_output == revoked_htlc_txn[0].input[0].previous_output {
8133 assert_eq!(node_txn[1].input[0].previous_output, revoked_htlc_txn[2].input[0].previous_output);
8135 assert_eq!(node_txn[0].input[0].previous_output, revoked_htlc_txn[2].input[0].previous_output);
8136 assert_eq!(node_txn[1].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
8142 // Few more blocks to confirm penalty txn
8143 connect_blocks(&nodes[0], 4);
8144 assert!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
8145 let header_144 = connect_blocks(&nodes[0], 9);
8147 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8148 assert_eq!(node_txn.len(), 1);
8150 assert_eq!(node_txn[0].input.len(), 2);
8151 check_spends!(node_txn[0], revoked_htlc_txn[0], revoked_htlc_txn[2]);
8152 // Verify bumped tx is different and 25% bump heuristic
8153 assert_ne!(first, node_txn[0].txid());
8154 let fee_2 = revoked_htlc_txn[0].output[0].value + revoked_htlc_txn[2].output[0].value - node_txn[0].output[0].value;
8155 let feerate_2 = fee_2 * 1000 / node_txn[0].get_weight() as u64;
8156 assert!(feerate_2 * 100 > feerate_1 * 125);
8157 let txn = vec![node_txn[0].clone()];
8161 // Broadcast claim txn and confirm blocks to avoid further bumps on this outputs
8162 let header_145 = BlockHeader { version: 0x20000000, prev_blockhash: header_144, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8163 connect_block(&nodes[0], &Block { header: header_145, txdata: node_txn });
8164 connect_blocks(&nodes[0], 20);
8166 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8167 // We verify than no new transaction has been broadcast because previously
8168 // we were buggy on this exact behavior by not tracking for monitoring remote HTLC outputs (see #411)
8169 // which means we wouldn't see a spend of them by a justice tx and bumped justice tx
8170 // were generated forever instead of safe cleaning after confirmation and ANTI_REORG_SAFE_DELAY blocks.
8171 // Enforce spending of revoked htlc output by claiming transaction remove request as expected and dry
8172 // up bumped justice generation.
8173 assert_eq!(node_txn.len(), 0);
8176 check_closed_broadcast!(nodes[0], true);
8177 check_added_monitors!(nodes[0], 1);
8181 fn test_bump_penalty_txn_on_remote_commitment() {
8182 // In case of claim txn with too low feerates for getting into mempools, RBF-bump them to be sure
8183 // we're able to claim outputs on remote commitment transaction before timelocks expiration
8186 // Provide preimage for one
8187 // Check aggregation
8189 let chanmon_cfgs = create_chanmon_cfgs(2);
8190 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8191 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8192 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8194 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
8195 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
8196 route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000).0;
8198 // Remote commitment txn with 4 outputs : to_local, to_remote, 1 outgoing HTLC, 1 incoming HTLC
8199 let remote_txn = get_local_commitment_txn!(nodes[0], chan.2);
8200 assert_eq!(remote_txn[0].output.len(), 4);
8201 assert_eq!(remote_txn[0].input.len(), 1);
8202 assert_eq!(remote_txn[0].input[0].previous_output.txid, chan.3.txid());
8204 // Claim a HTLC without revocation (provide B monitor with preimage)
8205 nodes[1].node.claim_funds(payment_preimage);
8206 mine_transaction(&nodes[1], &remote_txn[0]);
8207 check_added_monitors!(nodes[1], 2);
8208 connect_blocks(&nodes[1], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
8210 // One or more claim tx should have been broadcast, check it
8214 let feerate_timeout;
8215 let feerate_preimage;
8217 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8218 // 9 transactions including:
8219 // 1*2 ChannelManager local broadcasts of commitment + HTLC-Success
8220 // 1*3 ChannelManager local broadcasts of commitment + HTLC-Success + HTLC-Timeout
8221 // 2 * HTLC-Success (one RBF bump we'll check later)
8223 assert_eq!(node_txn.len(), 8);
8224 assert_eq!(node_txn[0].input.len(), 1);
8225 assert_eq!(node_txn[6].input.len(), 1);
8226 check_spends!(node_txn[0], remote_txn[0]);
8227 check_spends!(node_txn[6], remote_txn[0]);
8228 assert_eq!(node_txn[0].input[0].previous_output, node_txn[3].input[0].previous_output);
8229 preimage_bump = node_txn[3].clone();
8231 check_spends!(node_txn[1], chan.3);
8232 check_spends!(node_txn[2], node_txn[1]);
8233 assert_eq!(node_txn[1], node_txn[4]);
8234 assert_eq!(node_txn[2], node_txn[5]);
8236 timeout = node_txn[6].txid();
8237 let index = node_txn[6].input[0].previous_output.vout;
8238 let fee = remote_txn[0].output[index as usize].value - node_txn[6].output[0].value;
8239 feerate_timeout = fee * 1000 / node_txn[6].get_weight() as u64;
8241 preimage = node_txn[0].txid();
8242 let index = node_txn[0].input[0].previous_output.vout;
8243 let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
8244 feerate_preimage = fee * 1000 / node_txn[0].get_weight() as u64;
8248 assert_ne!(feerate_timeout, 0);
8249 assert_ne!(feerate_preimage, 0);
8251 // After exhaustion of height timer, new bumped claim txn should have been broadcast, check it
8252 connect_blocks(&nodes[1], 15);
8254 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8255 assert_eq!(node_txn.len(), 1);
8256 assert_eq!(node_txn[0].input.len(), 1);
8257 assert_eq!(preimage_bump.input.len(), 1);
8258 check_spends!(node_txn[0], remote_txn[0]);
8259 check_spends!(preimage_bump, remote_txn[0]);
8261 let index = preimage_bump.input[0].previous_output.vout;
8262 let fee = remote_txn[0].output[index as usize].value - preimage_bump.output[0].value;
8263 let new_feerate = fee * 1000 / preimage_bump.get_weight() as u64;
8264 assert!(new_feerate * 100 > feerate_timeout * 125);
8265 assert_ne!(timeout, preimage_bump.txid());
8267 let index = node_txn[0].input[0].previous_output.vout;
8268 let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
8269 let new_feerate = fee * 1000 / node_txn[0].get_weight() as u64;
8270 assert!(new_feerate * 100 > feerate_preimage * 125);
8271 assert_ne!(preimage, node_txn[0].txid());
8276 nodes[1].node.get_and_clear_pending_events();
8277 nodes[1].node.get_and_clear_pending_msg_events();
8281 fn test_counterparty_raa_skip_no_crash() {
8282 // Previously, if our counterparty sent two RAAs in a row without us having provided a
8283 // commitment transaction, we would have happily carried on and provided them the next
8284 // commitment transaction based on one RAA forward. This would probably eventually have led to
8285 // channel closure, but it would not have resulted in funds loss. Still, our
8286 // EnforcingSigner would have paniced as it doesn't like jumps into the future. Here, we
8287 // check simply that the channel is closed in response to such an RAA, but don't check whether
8288 // we decide to punish our counterparty for revoking their funds (as we don't currently
8290 let chanmon_cfgs = create_chanmon_cfgs(2);
8291 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8292 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8293 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8294 let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).2;
8296 let mut guard = nodes[0].node.channel_state.lock().unwrap();
8297 let keys = &guard.by_id.get_mut(&channel_id).unwrap().get_signer();
8298 const INITIAL_COMMITMENT_NUMBER: u64 = (1 << 48) - 1;
8299 let per_commitment_secret = keys.release_commitment_secret(INITIAL_COMMITMENT_NUMBER);
8300 // Must revoke without gaps
8301 keys.release_commitment_secret(INITIAL_COMMITMENT_NUMBER - 1);
8302 let next_per_commitment_point = PublicKey::from_secret_key(&Secp256k1::new(),
8303 &SecretKey::from_slice(&keys.release_commitment_secret(INITIAL_COMMITMENT_NUMBER - 2)).unwrap());
8305 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(),
8306 &msgs::RevokeAndACK { channel_id, per_commitment_secret, next_per_commitment_point });
8307 assert_eq!(check_closed_broadcast!(nodes[1], true).unwrap().data, "Received an unexpected revoke_and_ack");
8308 check_added_monitors!(nodes[1], 1);
8312 fn test_bump_txn_sanitize_tracking_maps() {
8313 // Sanitizing pendning_claim_request and claimable_outpoints used to be buggy,
8314 // verify we clean then right after expiration of ANTI_REORG_DELAY.
8316 let chanmon_cfgs = create_chanmon_cfgs(2);
8317 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8318 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8319 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8321 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
8322 // Lock HTLC in both directions
8323 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000).0;
8324 route_payment(&nodes[1], &vec!(&nodes[0])[..], 9_000_000).0;
8326 let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan.2);
8327 assert_eq!(revoked_local_txn[0].input.len(), 1);
8328 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
8330 // Revoke local commitment tx
8331 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
8333 // Broadcast set of revoked txn on A
8334 connect_blocks(&nodes[0], TEST_FINAL_CLTV + 2 - CHAN_CONFIRM_DEPTH);
8335 expect_pending_htlcs_forwardable_ignore!(nodes[0]);
8336 assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 0);
8338 mine_transaction(&nodes[0], &revoked_local_txn[0]);
8339 check_closed_broadcast!(nodes[0], true);
8340 check_added_monitors!(nodes[0], 1);
8342 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8343 assert_eq!(node_txn.len(), 4); //ChannelMonitor: justice txn * 3, ChannelManager: local commitment tx
8344 check_spends!(node_txn[0], revoked_local_txn[0]);
8345 check_spends!(node_txn[1], revoked_local_txn[0]);
8346 check_spends!(node_txn[2], revoked_local_txn[0]);
8347 let penalty_txn = vec![node_txn[0].clone(), node_txn[1].clone(), node_txn[2].clone()];
8351 let header_130 = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8352 connect_block(&nodes[0], &Block { header: header_130, txdata: penalty_txn });
8353 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
8355 let monitors = nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap();
8356 if let Some(monitor) = monitors.get(&OutPoint { txid: chan.3.txid(), index: 0 }) {
8357 assert!(monitor.inner.lock().unwrap().onchain_tx_handler.pending_claim_requests.is_empty());
8358 assert!(monitor.inner.lock().unwrap().onchain_tx_handler.claimable_outpoints.is_empty());
8364 fn test_override_channel_config() {
8365 let chanmon_cfgs = create_chanmon_cfgs(2);
8366 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8367 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8368 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8370 // Node0 initiates a channel to node1 using the override config.
8371 let mut override_config = UserConfig::default();
8372 override_config.own_channel_config.our_to_self_delay = 200;
8374 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 16_000_000, 12_000_000, 42, Some(override_config)).unwrap();
8376 // Assert the channel created by node0 is using the override config.
8377 let res = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8378 assert_eq!(res.channel_flags, 0);
8379 assert_eq!(res.to_self_delay, 200);
8383 fn test_override_0msat_htlc_minimum() {
8384 let mut zero_config = UserConfig::default();
8385 zero_config.own_channel_config.our_htlc_minimum_msat = 0;
8386 let chanmon_cfgs = create_chanmon_cfgs(2);
8387 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8388 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, Some(zero_config.clone())]);
8389 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8391 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 16_000_000, 12_000_000, 42, Some(zero_config)).unwrap();
8392 let res = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8393 assert_eq!(res.htlc_minimum_msat, 1);
8395 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &res);
8396 let res = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
8397 assert_eq!(res.htlc_minimum_msat, 1);
8401 fn test_simple_mpp() {
8402 // Simple test of sending a multi-path payment.
8403 let chanmon_cfgs = create_chanmon_cfgs(4);
8404 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
8405 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
8406 let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
8408 let chan_1_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8409 let chan_2_id = create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8410 let chan_3_id = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8411 let chan_4_id = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8412 let logger = test_utils::TestLogger::new();
8414 let (payment_preimage, payment_hash, payment_secret) = get_payment_preimage_hash!(&nodes[3]);
8415 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
8416 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();
8417 let path = route.paths[0].clone();
8418 route.paths.push(path);
8419 route.paths[0][0].pubkey = nodes[1].node.get_our_node_id();
8420 route.paths[0][0].short_channel_id = chan_1_id;
8421 route.paths[0][1].short_channel_id = chan_3_id;
8422 route.paths[1][0].pubkey = nodes[2].node.get_our_node_id();
8423 route.paths[1][0].short_channel_id = chan_2_id;
8424 route.paths[1][1].short_channel_id = chan_4_id;
8425 send_along_route_with_secret(&nodes[0], route, &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], 200_000, payment_hash, payment_secret);
8426 claim_payment_along_route(&nodes[0], &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], false, payment_preimage);
8430 fn test_preimage_storage() {
8431 // Simple test of payment preimage storage allowing no client-side storage to claim payments
8432 let chanmon_cfgs = create_chanmon_cfgs(2);
8433 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8434 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8435 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8437 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8440 let (payment_hash, payment_secret) = nodes[1].node.create_inbound_payment(Some(100_000), 7200, 42);
8442 let logger = test_utils::TestLogger::new();
8443 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
8444 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();
8445 nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
8446 check_added_monitors!(nodes[0], 1);
8447 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
8448 let mut payment_event = SendEvent::from_event(events.pop().unwrap());
8449 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
8450 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
8452 // Note that after leaving the above scope we have no knowledge of any arguments or return
8453 // values from previous calls.
8454 expect_pending_htlcs_forwardable!(nodes[1]);
8455 let events = nodes[1].node.get_and_clear_pending_events();
8456 assert_eq!(events.len(), 1);
8458 Event::PaymentReceived { payment_preimage, user_payment_id, .. } => {
8459 assert_eq!(user_payment_id, 42);
8460 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage.unwrap());
8462 _ => panic!("Unexpected event"),
8467 fn test_secret_timeout() {
8468 // Simple test of payment secret storage time outs
8469 let chanmon_cfgs = create_chanmon_cfgs(2);
8470 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8471 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8472 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8474 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8476 let (payment_hash, payment_secret_1) = nodes[1].node.create_inbound_payment(Some(100_000), 2, 0);
8478 // We should fail to register the same payment hash twice, at least until we've connected a
8479 // block with time 7200 + CHAN_CONFIRM_DEPTH + 1.
8480 if let Err(APIError::APIMisuseError { err }) = nodes[1].node.create_inbound_payment_for_hash(payment_hash, Some(100_000), 2, 0) {
8481 assert_eq!(err, "Duplicate payment hash");
8482 } else { panic!(); }
8484 let node_1_blocks = nodes[1].blocks.lock().unwrap();
8486 header: BlockHeader {
8488 prev_blockhash: node_1_blocks.last().unwrap().0.block_hash(),
8489 merkle_root: Default::default(),
8490 time: node_1_blocks.len() as u32 + 7200, bits: 42, nonce: 42 },
8494 connect_block(&nodes[1], &block);
8495 if let Err(APIError::APIMisuseError { err }) = nodes[1].node.create_inbound_payment_for_hash(payment_hash, Some(100_000), 2, 0) {
8496 assert_eq!(err, "Duplicate payment hash");
8497 } else { panic!(); }
8499 // If we then connect the second block, we should be able to register the same payment hash
8500 // again with a different user_payment_id (this time getting a new payment secret).
8501 block.header.prev_blockhash = block.header.block_hash();
8502 block.header.time += 1;
8503 connect_block(&nodes[1], &block);
8504 let our_payment_secret = nodes[1].node.create_inbound_payment_for_hash(payment_hash, Some(100_000), 2, 42).unwrap();
8505 assert_ne!(payment_secret_1, our_payment_secret);
8508 let logger = test_utils::TestLogger::new();
8509 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
8510 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();
8511 nodes[0].node.send_payment(&route, payment_hash, &Some(our_payment_secret)).unwrap();
8512 check_added_monitors!(nodes[0], 1);
8513 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
8514 let mut payment_event = SendEvent::from_event(events.pop().unwrap());
8515 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
8516 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
8518 // Note that after leaving the above scope we have no knowledge of any arguments or return
8519 // values from previous calls.
8520 expect_pending_htlcs_forwardable!(nodes[1]);
8521 let events = nodes[1].node.get_and_clear_pending_events();
8522 assert_eq!(events.len(), 1);
8524 Event::PaymentReceived { payment_preimage, payment_secret, user_payment_id, .. } => {
8525 assert!(payment_preimage.is_none());
8526 assert_eq!(user_payment_id, 42);
8527 assert_eq!(payment_secret, our_payment_secret);
8528 // We don't actually have the payment preimage with which to claim this payment!
8530 _ => panic!("Unexpected event"),
8535 fn test_bad_secret_hash() {
8536 // Simple test of unregistered payment hash/invalid payment secret handling
8537 let chanmon_cfgs = create_chanmon_cfgs(2);
8538 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8539 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8540 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8542 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8544 let random_payment_hash = PaymentHash([42; 32]);
8545 let random_payment_secret = PaymentSecret([43; 32]);
8546 let (our_payment_hash, our_payment_secret) = nodes[1].node.create_inbound_payment(Some(100_000), 2, 0);
8548 let logger = test_utils::TestLogger::new();
8549 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
8550 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();
8552 // All the below cases should end up being handled exactly identically, so we macro the
8553 // resulting events.
8554 macro_rules! handle_unknown_invalid_payment_data {
8556 check_added_monitors!(nodes[0], 1);
8557 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
8558 let payment_event = SendEvent::from_event(events.pop().unwrap());
8559 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
8560 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
8562 // We have to forward pending HTLCs once to process the receipt of the HTLC and then
8563 // again to process the pending backwards-failure of the HTLC
8564 expect_pending_htlcs_forwardable!(nodes[1]);
8565 expect_pending_htlcs_forwardable!(nodes[1]);
8566 check_added_monitors!(nodes[1], 1);
8568 // We should fail the payment back
8569 let mut events = nodes[1].node.get_and_clear_pending_msg_events();
8570 match events.pop().unwrap() {
8571 MessageSendEvent::UpdateHTLCs { node_id: _, updates: msgs::CommitmentUpdate { update_fail_htlcs, commitment_signed, .. } } => {
8572 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
8573 commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false);
8575 _ => panic!("Unexpected event"),
8580 let expected_error_code = 0x4000|15; // incorrect_or_unknown_payment_details
8581 // Error data is the HTLC value (100,000) and current block height
8582 let expected_error_data = [0, 0, 0, 0, 0, 1, 0x86, 0xa0, 0, 0, 0, CHAN_CONFIRM_DEPTH as u8];
8584 // Send a payment with the right payment hash but the wrong payment secret
8585 nodes[0].node.send_payment(&route, our_payment_hash, &Some(random_payment_secret)).unwrap();
8586 handle_unknown_invalid_payment_data!();
8587 expect_payment_failed!(nodes[0], our_payment_hash, true, expected_error_code, expected_error_data);
8589 // Send a payment with a random payment hash, but the right payment secret
8590 nodes[0].node.send_payment(&route, random_payment_hash, &Some(our_payment_secret)).unwrap();
8591 handle_unknown_invalid_payment_data!();
8592 expect_payment_failed!(nodes[0], random_payment_hash, true, expected_error_code, expected_error_data);
8594 // Send a payment with a random payment hash and random payment secret
8595 nodes[0].node.send_payment(&route, random_payment_hash, &Some(random_payment_secret)).unwrap();
8596 handle_unknown_invalid_payment_data!();
8597 expect_payment_failed!(nodes[0], random_payment_hash, true, expected_error_code, expected_error_data);
8601 fn test_update_err_monitor_lockdown() {
8602 // Our monitor will lock update of local commitment transaction if a broadcastion condition
8603 // has been fulfilled (either force-close from Channel or block height requiring a HTLC-
8604 // timeout). Trying to update monitor after lockdown should return a ChannelMonitorUpdateErr.
8606 // This scenario may happen in a watchtower setup, where watchtower process a block height
8607 // triggering a timeout while a slow-block-processing ChannelManager receives a local signed
8608 // commitment at same time.
8610 let chanmon_cfgs = create_chanmon_cfgs(2);
8611 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8612 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8613 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8615 // Create some initial channel
8616 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
8617 let outpoint = OutPoint { txid: chan_1.3.txid(), index: 0 };
8619 // Rebalance the network to generate htlc in the two directions
8620 send_payment(&nodes[0], &vec!(&nodes[1])[..], 10_000_000);
8622 // Route a HTLC from node 0 to node 1 (but don't settle)
8623 let preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000).0;
8625 // Copy ChainMonitor to simulate a watchtower and update block height of node 0 until its ChannelMonitor timeout HTLC onchain
8626 let chain_source = test_utils::TestChainSource::new(Network::Testnet);
8627 let logger = test_utils::TestLogger::with_id(format!("node {}", 0));
8628 let persister = test_utils::TestPersister::new();
8630 let monitors = nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap();
8631 let monitor = monitors.get(&outpoint).unwrap();
8632 let mut w = test_utils::TestVecWriter(Vec::new());
8633 monitor.write(&mut w).unwrap();
8634 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingSigner>)>::read(
8635 &mut ::std::io::Cursor::new(&w.0), &test_utils::OnlyReadsKeysInterface {}).unwrap().1;
8636 assert!(new_monitor == *monitor);
8637 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);
8638 assert!(watchtower.watch_channel(outpoint, new_monitor).is_ok());
8641 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8642 // Make the tx_broadcaster aware of enough blocks that it doesn't think we're violating
8643 // transaction lock time requirements here.
8644 chanmon_cfgs[0].tx_broadcaster.blocks.lock().unwrap().resize(200, (header, 0));
8645 watchtower.chain_monitor.block_connected(&Block { header, txdata: vec![] }, 200);
8647 // Try to update ChannelMonitor
8648 assert!(nodes[1].node.claim_funds(preimage));
8649 check_added_monitors!(nodes[1], 1);
8650 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
8651 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
8652 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
8653 if let Some(ref mut channel) = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan_1.2) {
8654 if let Ok((_, _, _, update)) = channel.commitment_signed(&updates.commitment_signed, &node_cfgs[0].fee_estimator, &node_cfgs[0].logger) {
8655 if let Err(_) = watchtower.chain_monitor.update_channel(outpoint, update.clone()) {} else { assert!(false); }
8656 if let Ok(_) = nodes[0].chain_monitor.update_channel(outpoint, update) {} else { assert!(false); }
8657 } else { assert!(false); }
8658 } else { assert!(false); };
8659 // Our local monitor is in-sync and hasn't processed yet timeout
8660 check_added_monitors!(nodes[0], 1);
8661 let events = nodes[0].node.get_and_clear_pending_events();
8662 assert_eq!(events.len(), 1);
8666 fn test_concurrent_monitor_claim() {
8667 // Watchtower A receives block, broadcasts state N, then channel receives new state N+1,
8668 // sending it to both watchtowers, Bob accepts N+1, then receives block and broadcasts
8669 // the latest state N+1, Alice rejects state N+1, but Bob has already broadcast it,
8670 // state N+1 confirms. Alice claims output from state N+1.
8672 let chanmon_cfgs = create_chanmon_cfgs(2);
8673 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8674 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8675 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8677 // Create some initial channel
8678 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
8679 let outpoint = OutPoint { txid: chan_1.3.txid(), index: 0 };
8681 // Rebalance the network to generate htlc in the two directions
8682 send_payment(&nodes[0], &vec!(&nodes[1])[..], 10_000_000);
8684 // Route a HTLC from node 0 to node 1 (but don't settle)
8685 route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000).0;
8687 // Copy ChainMonitor to simulate watchtower Alice and update block height her ChannelMonitor timeout HTLC onchain
8688 let chain_source = test_utils::TestChainSource::new(Network::Testnet);
8689 let logger = test_utils::TestLogger::with_id(format!("node {}", "Alice"));
8690 let persister = test_utils::TestPersister::new();
8691 let watchtower_alice = {
8692 let monitors = nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap();
8693 let monitor = monitors.get(&outpoint).unwrap();
8694 let mut w = test_utils::TestVecWriter(Vec::new());
8695 monitor.write(&mut w).unwrap();
8696 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingSigner>)>::read(
8697 &mut ::std::io::Cursor::new(&w.0), &test_utils::OnlyReadsKeysInterface {}).unwrap().1;
8698 assert!(new_monitor == *monitor);
8699 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);
8700 assert!(watchtower.watch_channel(outpoint, new_monitor).is_ok());
8703 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8704 // Make the tx_broadcaster aware of enough blocks that it doesn't think we're violating
8705 // transaction lock time requirements here.
8706 chanmon_cfgs[0].tx_broadcaster.blocks.lock().unwrap().resize((CHAN_CONFIRM_DEPTH + 1 + TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS) as usize, (header, 0));
8707 watchtower_alice.chain_monitor.block_connected(&Block { header, txdata: vec![] }, CHAN_CONFIRM_DEPTH + 1 + TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS);
8709 // Watchtower Alice should have broadcast a commitment/HTLC-timeout
8711 let mut txn = chanmon_cfgs[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8712 assert_eq!(txn.len(), 2);
8716 // Copy ChainMonitor to simulate watchtower Bob and make it receive a commitment update first.
8717 let chain_source = test_utils::TestChainSource::new(Network::Testnet);
8718 let logger = test_utils::TestLogger::with_id(format!("node {}", "Bob"));
8719 let persister = test_utils::TestPersister::new();
8720 let watchtower_bob = {
8721 let monitors = nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap();
8722 let monitor = monitors.get(&outpoint).unwrap();
8723 let mut w = test_utils::TestVecWriter(Vec::new());
8724 monitor.write(&mut w).unwrap();
8725 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingSigner>)>::read(
8726 &mut ::std::io::Cursor::new(&w.0), &test_utils::OnlyReadsKeysInterface {}).unwrap().1;
8727 assert!(new_monitor == *monitor);
8728 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);
8729 assert!(watchtower.watch_channel(outpoint, new_monitor).is_ok());
8732 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8733 watchtower_bob.chain_monitor.block_connected(&Block { header, txdata: vec![] }, CHAN_CONFIRM_DEPTH + TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS);
8735 // Route another payment to generate another update with still previous HTLC pending
8736 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[0]);
8738 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
8739 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();
8740 nodes[1].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
8742 check_added_monitors!(nodes[1], 1);
8744 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
8745 assert_eq!(updates.update_add_htlcs.len(), 1);
8746 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &updates.update_add_htlcs[0]);
8747 if let Some(ref mut channel) = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan_1.2) {
8748 if let Ok((_, _, _, update)) = channel.commitment_signed(&updates.commitment_signed, &node_cfgs[0].fee_estimator, &node_cfgs[0].logger) {
8749 // Watchtower Alice should already have seen the block and reject the update
8750 if let Err(_) = watchtower_alice.chain_monitor.update_channel(outpoint, update.clone()) {} else { assert!(false); }
8751 if let Ok(_) = watchtower_bob.chain_monitor.update_channel(outpoint, update.clone()) {} else { assert!(false); }
8752 if let Ok(_) = nodes[0].chain_monitor.update_channel(outpoint, update) {} else { assert!(false); }
8753 } else { assert!(false); }
8754 } else { assert!(false); };
8755 // Our local monitor is in-sync and hasn't processed yet timeout
8756 check_added_monitors!(nodes[0], 1);
8758 //// Provide one more block to watchtower Bob, expect broadcast of commitment and HTLC-Timeout
8759 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8760 watchtower_bob.chain_monitor.block_connected(&Block { header, txdata: vec![] }, CHAN_CONFIRM_DEPTH + 1 + TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS);
8762 // Watchtower Bob should have broadcast a commitment/HTLC-timeout
8765 let mut txn = chanmon_cfgs[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8766 assert_eq!(txn.len(), 2);
8767 bob_state_y = txn[0].clone();
8771 // We confirm Bob's state Y on Alice, she should broadcast a HTLC-timeout
8772 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8773 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);
8775 let htlc_txn = chanmon_cfgs[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8776 // We broadcast twice the transaction, once due to the HTLC-timeout, once due
8777 // the onchain detection of the HTLC output
8778 assert_eq!(htlc_txn.len(), 2);
8779 check_spends!(htlc_txn[0], bob_state_y);
8780 check_spends!(htlc_txn[1], bob_state_y);
8785 fn test_pre_lockin_no_chan_closed_update() {
8786 // Test that if a peer closes a channel in response to a funding_created message we don't
8787 // generate a channel update (as the channel cannot appear on chain without a funding_signed
8790 // Doing so would imply a channel monitor update before the initial channel monitor
8791 // registration, violating our API guarantees.
8793 // Previously, full_stack_target managed to hit this case by opening then closing a channel,
8794 // then opening a second channel with the same funding output as the first (which is not
8795 // rejected because the first channel does not exist in the ChannelManager) and closing it
8796 // before receiving funding_signed.
8797 let chanmon_cfgs = create_chanmon_cfgs(2);
8798 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8799 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8800 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8802 // Create an initial channel
8803 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
8804 let mut open_chan_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8805 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_msg);
8806 let accept_chan_msg = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
8807 nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &accept_chan_msg);
8809 // Move the first channel through the funding flow...
8810 let (temporary_channel_id, tx, _) = create_funding_transaction(&nodes[0], 100000, 42);
8812 nodes[0].node.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
8813 check_added_monitors!(nodes[0], 0);
8815 let funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
8816 let channel_id = ::chain::transaction::OutPoint { txid: funding_created_msg.funding_txid, index: funding_created_msg.funding_output_index }.to_channel_id();
8817 nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msgs::ErrorMessage { channel_id, data: "Hi".to_owned() });
8818 assert!(nodes[0].chain_monitor.added_monitors.lock().unwrap().is_empty());
8822 fn test_htlc_no_detection() {
8823 // This test is a mutation to underscore the detection logic bug we had
8824 // before #653. HTLC value routed is above the remaining balance, thus
8825 // inverting HTLC and `to_remote` output. HTLC will come second and
8826 // it wouldn't be seen by pre-#653 detection as we were enumerate()'ing
8827 // on a watched outputs vector (Vec<TxOut>) thus implicitly relying on
8828 // outputs order detection for correct spending children filtring.
8830 let chanmon_cfgs = create_chanmon_cfgs(2);
8831 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8832 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8833 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8835 // Create some initial channels
8836 let chan_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
8838 send_payment(&nodes[0], &vec!(&nodes[1])[..], 1_000_000);
8839 let (_, our_payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 2_000_000);
8840 let local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
8841 assert_eq!(local_txn[0].input.len(), 1);
8842 assert_eq!(local_txn[0].output.len(), 3);
8843 check_spends!(local_txn[0], chan_1.3);
8845 // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
8846 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8847 connect_block(&nodes[0], &Block { header, txdata: vec![local_txn[0].clone()] });
8848 // We deliberately connect the local tx twice as this should provoke a failure calling
8849 // this test before #653 fix.
8850 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);
8851 check_closed_broadcast!(nodes[0], true);
8852 check_added_monitors!(nodes[0], 1);
8853 connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1);
8855 let htlc_timeout = {
8856 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8857 assert_eq!(node_txn[1].input.len(), 1);
8858 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
8859 check_spends!(node_txn[1], local_txn[0]);
8863 let header_201 = 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: header_201, txdata: vec![htlc_timeout.clone()] });
8865 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
8866 expect_payment_failed!(nodes[0], our_payment_hash, true);
8869 fn do_test_onchain_htlc_settlement_after_close(broadcast_alice: bool, go_onchain_before_fulfill: bool) {
8870 // If we route an HTLC, then learn the HTLC's preimage after the upstream channel has been
8871 // force-closed, we must claim that HTLC on-chain. (Given an HTLC forwarded from Alice --> Bob -->
8872 // Carol, Alice would be the upstream node, and Carol the downstream.)
8874 // Steps of the test:
8875 // 1) Alice sends a HTLC to Carol through Bob.
8876 // 2) Carol doesn't settle the HTLC.
8877 // 3) If broadcast_alice is true, Alice force-closes her channel with Bob. Else Bob force closes.
8878 // Steps 4 and 5 may be reordered depending on go_onchain_before_fulfill.
8879 // 4) Bob sees the Alice's commitment on his chain or vice versa. An offered output is present
8880 // but can't be claimed as Bob doesn't have yet knowledge of the preimage.
8881 // 5) Carol release the preimage to Bob off-chain.
8882 // 6) Bob claims the offered output on the broadcasted commitment.
8883 let chanmon_cfgs = create_chanmon_cfgs(3);
8884 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
8885 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
8886 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
8888 // Create some initial channels
8889 let chan_ab = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
8890 create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 100000, 10001, InitFeatures::known(), InitFeatures::known());
8892 // Steps (1) and (2):
8893 // Send an HTLC Alice --> Bob --> Carol, but Carol doesn't settle the HTLC back.
8894 let (payment_preimage, _payment_hash, _payment_secret) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3_000_000);
8896 // Check that Alice's commitment transaction now contains an output for this HTLC.
8897 let alice_txn = get_local_commitment_txn!(nodes[0], chan_ab.2);
8898 check_spends!(alice_txn[0], chan_ab.3);
8899 assert_eq!(alice_txn[0].output.len(), 2);
8900 check_spends!(alice_txn[1], alice_txn[0]); // 2nd transaction is a non-final HTLC-timeout
8901 assert_eq!(alice_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
8902 assert_eq!(alice_txn.len(), 2);
8904 // Steps (3) and (4):
8905 // If `go_onchain_before_fufill`, broadcast the relevant commitment transaction and check that Bob
8906 // responds by (1) broadcasting a channel update and (2) adding a new ChannelMonitor.
8907 let mut force_closing_node = 0; // Alice force-closes
8908 if !broadcast_alice { force_closing_node = 1; } // Bob force-closes
8909 nodes[force_closing_node].node.force_close_channel(&chan_ab.2).unwrap();
8910 check_closed_broadcast!(nodes[force_closing_node], true);
8911 check_added_monitors!(nodes[force_closing_node], 1);
8912 if go_onchain_before_fulfill {
8913 let txn_to_broadcast = match broadcast_alice {
8914 true => alice_txn.clone(),
8915 false => get_local_commitment_txn!(nodes[1], chan_ab.2)
8917 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
8918 connect_block(&nodes[1], &Block { header, txdata: vec![txn_to_broadcast[0].clone()]});
8919 let mut bob_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8920 if broadcast_alice {
8921 check_closed_broadcast!(nodes[1], true);
8922 check_added_monitors!(nodes[1], 1);
8924 assert_eq!(bob_txn.len(), 1);
8925 check_spends!(bob_txn[0], chan_ab.3);
8929 // Carol then claims the funds and sends an update_fulfill message to Bob, and they go through the
8930 // process of removing the HTLC from their commitment transactions.
8931 assert!(nodes[2].node.claim_funds(payment_preimage));
8932 check_added_monitors!(nodes[2], 1);
8933 let carol_updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
8934 assert!(carol_updates.update_add_htlcs.is_empty());
8935 assert!(carol_updates.update_fail_htlcs.is_empty());
8936 assert!(carol_updates.update_fail_malformed_htlcs.is_empty());
8937 assert!(carol_updates.update_fee.is_none());
8938 assert_eq!(carol_updates.update_fulfill_htlcs.len(), 1);
8940 nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &carol_updates.update_fulfill_htlcs[0]);
8941 // If Alice broadcasted but Bob doesn't know yet, here he prepares to tell her about the preimage.
8942 if !go_onchain_before_fulfill && broadcast_alice {
8943 let events = nodes[1].node.get_and_clear_pending_msg_events();
8944 assert_eq!(events.len(), 1);
8946 MessageSendEvent::UpdateHTLCs { ref node_id, .. } => {
8947 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
8949 _ => panic!("Unexpected event"),
8952 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &carol_updates.commitment_signed);
8953 // One monitor update for the preimage to update the Bob<->Alice channel, one monitor update
8954 // Carol<->Bob's updated commitment transaction info.
8955 check_added_monitors!(nodes[1], 2);
8957 let events = nodes[1].node.get_and_clear_pending_msg_events();
8958 assert_eq!(events.len(), 2);
8959 let bob_revocation = match events[0] {
8960 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
8961 assert_eq!(*node_id, nodes[2].node.get_our_node_id());
8964 _ => panic!("Unexpected event"),
8966 let bob_updates = match events[1] {
8967 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
8968 assert_eq!(*node_id, nodes[2].node.get_our_node_id());
8971 _ => panic!("Unexpected event"),
8974 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bob_revocation);
8975 check_added_monitors!(nodes[2], 1);
8976 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bob_updates.commitment_signed);
8977 check_added_monitors!(nodes[2], 1);
8979 let events = nodes[2].node.get_and_clear_pending_msg_events();
8980 assert_eq!(events.len(), 1);
8981 let carol_revocation = match events[0] {
8982 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
8983 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
8986 _ => panic!("Unexpected event"),
8988 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &carol_revocation);
8989 check_added_monitors!(nodes[1], 1);
8991 // If this test requires the force-closed channel to not be on-chain until after the fulfill,
8992 // here's where we put said channel's commitment tx on-chain.
8993 let mut txn_to_broadcast = alice_txn.clone();
8994 if !broadcast_alice { txn_to_broadcast = get_local_commitment_txn!(nodes[1], chan_ab.2); }
8995 if !go_onchain_before_fulfill {
8996 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
8997 connect_block(&nodes[1], &Block { header, txdata: vec![txn_to_broadcast[0].clone()]});
8998 // If Bob was the one to force-close, he will have already passed these checks earlier.
8999 if broadcast_alice {
9000 check_closed_broadcast!(nodes[1], true);
9001 check_added_monitors!(nodes[1], 1);
9003 let mut bob_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
9004 if broadcast_alice {
9005 // In `connect_block()`, the ChainMonitor and ChannelManager are separately notified about a
9006 // new block being connected. The ChannelManager being notified triggers a monitor update,
9007 // which triggers broadcasting our commitment tx and an HTLC-claiming tx. The ChainMonitor
9008 // being notified triggers the HTLC-claiming tx redundantly, resulting in 3 total txs being
9010 assert_eq!(bob_txn.len(), 3);
9011 check_spends!(bob_txn[1], chan_ab.3);
9013 assert_eq!(bob_txn.len(), 2);
9014 check_spends!(bob_txn[0], chan_ab.3);
9019 // Finally, check that Bob broadcasted a preimage-claiming transaction for the HTLC output on the
9020 // broadcasted commitment transaction.
9022 let bob_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
9023 if go_onchain_before_fulfill {
9024 // Bob should now have an extra broadcasted tx, for the preimage-claiming transaction.
9025 assert_eq!(bob_txn.len(), 2);
9027 let script_weight = match broadcast_alice {
9028 true => OFFERED_HTLC_SCRIPT_WEIGHT,
9029 false => ACCEPTED_HTLC_SCRIPT_WEIGHT
9031 // If Alice force-closed and Bob didn't receive her commitment transaction until after he
9032 // received Carol's fulfill, he broadcasts the HTLC-output-claiming transaction first. Else if
9033 // Bob force closed or if he found out about Alice's commitment tx before receiving Carol's
9034 // fulfill, then he broadcasts the HTLC-output-claiming transaction second.
9035 if broadcast_alice && !go_onchain_before_fulfill {
9036 check_spends!(bob_txn[0], txn_to_broadcast[0]);
9037 assert_eq!(bob_txn[0].input[0].witness.last().unwrap().len(), script_weight);
9039 check_spends!(bob_txn[1], txn_to_broadcast[0]);
9040 assert_eq!(bob_txn[1].input[0].witness.last().unwrap().len(), script_weight);
9046 fn test_onchain_htlc_settlement_after_close() {
9047 do_test_onchain_htlc_settlement_after_close(true, true);
9048 do_test_onchain_htlc_settlement_after_close(false, true); // Technically redundant, but may as well
9049 do_test_onchain_htlc_settlement_after_close(true, false);
9050 do_test_onchain_htlc_settlement_after_close(false, false);
9054 fn test_duplicate_chan_id() {
9055 // Test that if a given peer tries to open a channel with the same channel_id as one that is
9056 // already open we reject it and keep the old channel.
9058 // Previously, full_stack_target managed to figure out that if you tried to open two channels
9059 // with the same funding output (ie post-funding channel_id), we'd create a monitor update for
9060 // the existing channel when we detect the duplicate new channel, screwing up our monitor
9061 // updating logic for the existing channel.
9062 let chanmon_cfgs = create_chanmon_cfgs(2);
9063 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
9064 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
9065 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
9067 // Create an initial channel
9068 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
9069 let mut open_chan_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
9070 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_msg);
9071 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()));
9073 // Try to create a second channel with the same temporary_channel_id as the first and check
9074 // that it is rejected.
9075 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_msg);
9077 let events = nodes[1].node.get_and_clear_pending_msg_events();
9078 assert_eq!(events.len(), 1);
9080 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
9081 // Technically, at this point, nodes[1] would be justified in thinking both the
9082 // first (valid) and second (invalid) channels are closed, given they both have
9083 // the same non-temporary channel_id. However, currently we do not, so we just
9084 // move forward with it.
9085 assert_eq!(msg.channel_id, open_chan_msg.temporary_channel_id);
9086 assert_eq!(node_id, nodes[0].node.get_our_node_id());
9088 _ => panic!("Unexpected event"),
9092 // Move the first channel through the funding flow...
9093 let (temporary_channel_id, tx, funding_output) = create_funding_transaction(&nodes[0], 100000, 42);
9095 nodes[0].node.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
9096 check_added_monitors!(nodes[0], 0);
9098 let mut funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
9099 nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created_msg);
9101 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
9102 assert_eq!(added_monitors.len(), 1);
9103 assert_eq!(added_monitors[0].0, funding_output);
9104 added_monitors.clear();
9106 let funding_signed_msg = get_event_msg!(nodes[1], MessageSendEvent::SendFundingSigned, nodes[0].node.get_our_node_id());
9108 let funding_outpoint = ::chain::transaction::OutPoint { txid: funding_created_msg.funding_txid, index: funding_created_msg.funding_output_index };
9109 let channel_id = funding_outpoint.to_channel_id();
9111 // Now we have the first channel past funding_created (ie it has a txid-based channel_id, not a
9114 // First try to open a second channel with a temporary channel id equal to the txid-based one.
9115 // Technically this is allowed by the spec, but we don't support it and there's little reason
9116 // to. Still, it shouldn't cause any other issues.
9117 open_chan_msg.temporary_channel_id = channel_id;
9118 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_msg);
9120 let events = nodes[1].node.get_and_clear_pending_msg_events();
9121 assert_eq!(events.len(), 1);
9123 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
9124 // Technically, at this point, nodes[1] would be justified in thinking both
9125 // channels are closed, but currently we do not, so we just move forward with it.
9126 assert_eq!(msg.channel_id, open_chan_msg.temporary_channel_id);
9127 assert_eq!(node_id, nodes[0].node.get_our_node_id());
9129 _ => panic!("Unexpected event"),
9133 // Now try to create a second channel which has a duplicate funding output.
9134 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
9135 let open_chan_2_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
9136 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_2_msg);
9137 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()));
9138 create_funding_transaction(&nodes[0], 100000, 42); // Get and check the FundingGenerationReady event
9140 let funding_created = {
9141 let mut a_channel_lock = nodes[0].node.channel_state.lock().unwrap();
9142 let mut as_chan = a_channel_lock.by_id.get_mut(&open_chan_2_msg.temporary_channel_id).unwrap();
9143 let logger = test_utils::TestLogger::new();
9144 as_chan.get_outbound_funding_created(tx.clone(), funding_outpoint, &&logger).unwrap()
9146 check_added_monitors!(nodes[0], 0);
9147 nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created);
9148 // At this point we'll try to add a duplicate channel monitor, which will be rejected, but
9149 // still needs to be cleared here.
9150 check_added_monitors!(nodes[1], 1);
9152 // ...still, nodes[1] will reject the duplicate channel.
9154 let events = nodes[1].node.get_and_clear_pending_msg_events();
9155 assert_eq!(events.len(), 1);
9157 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
9158 // Technically, at this point, nodes[1] would be justified in thinking both
9159 // channels are closed, but currently we do not, so we just move forward with it.
9160 assert_eq!(msg.channel_id, channel_id);
9161 assert_eq!(node_id, nodes[0].node.get_our_node_id());
9163 _ => panic!("Unexpected event"),
9167 // finally, finish creating the original channel and send a payment over it to make sure
9168 // everything is functional.
9169 nodes[0].node.handle_funding_signed(&nodes[1].node.get_our_node_id(), &funding_signed_msg);
9171 let mut added_monitors = nodes[0].chain_monitor.added_monitors.lock().unwrap();
9172 assert_eq!(added_monitors.len(), 1);
9173 assert_eq!(added_monitors[0].0, funding_output);
9174 added_monitors.clear();
9177 let events_4 = nodes[0].node.get_and_clear_pending_events();
9178 assert_eq!(events_4.len(), 0);
9179 assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
9180 assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0].txid(), funding_output.txid);
9182 let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
9183 let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
9184 update_nodes_with_chan_announce(&nodes, 0, 1, &announcement, &as_update, &bs_update);
9185 send_payment(&nodes[0], &[&nodes[1]], 8000000);
9189 fn test_error_chans_closed() {
9190 // Test that we properly handle error messages, closing appropriate channels.
9192 // Prior to #787 we'd allow a peer to make us force-close a channel we had with a different
9193 // peer. The "real" fix for that is to index channels with peers_ids, however in the mean time
9194 // we can test various edge cases around it to ensure we don't regress.
9195 let chanmon_cfgs = create_chanmon_cfgs(3);
9196 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
9197 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
9198 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
9200 // Create some initial channels
9201 let chan_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
9202 let chan_2 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
9203 let chan_3 = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 100000, 10001, InitFeatures::known(), InitFeatures::known());
9205 assert_eq!(nodes[0].node.list_usable_channels().len(), 3);
9206 assert_eq!(nodes[1].node.list_usable_channels().len(), 2);
9207 assert_eq!(nodes[2].node.list_usable_channels().len(), 1);
9209 // Closing a channel from a different peer has no effect
9210 nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msgs::ErrorMessage { channel_id: chan_3.2, data: "ERR".to_owned() });
9211 assert_eq!(nodes[0].node.list_usable_channels().len(), 3);
9213 // Closing one channel doesn't impact others
9214 nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msgs::ErrorMessage { channel_id: chan_2.2, data: "ERR".to_owned() });
9215 check_added_monitors!(nodes[0], 1);
9216 check_closed_broadcast!(nodes[0], false);
9217 assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0).len(), 1);
9218 assert_eq!(nodes[0].node.list_usable_channels().len(), 2);
9219 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);
9220 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);
9222 // A null channel ID should close all channels
9223 let _chan_4 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
9224 nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msgs::ErrorMessage { channel_id: [0; 32], data: "ERR".to_owned() });
9225 check_added_monitors!(nodes[0], 2);
9226 let events = nodes[0].node.get_and_clear_pending_msg_events();
9227 assert_eq!(events.len(), 2);
9229 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
9230 assert_eq!(msg.contents.flags & 2, 2);
9232 _ => panic!("Unexpected event"),
9235 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
9236 assert_eq!(msg.contents.flags & 2, 2);
9238 _ => panic!("Unexpected event"),
9240 // Note that at this point users of a standard PeerHandler will end up calling
9241 // peer_disconnected with no_connection_possible set to false, duplicating the
9242 // close-all-channels logic. That's OK, we don't want to end up not force-closing channels for
9243 // users with their own peer handling logic. We duplicate the call here, however.
9244 assert_eq!(nodes[0].node.list_usable_channels().len(), 1);
9245 assert!(nodes[0].node.list_usable_channels()[0].channel_id == chan_3.2);
9247 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), true);
9248 assert_eq!(nodes[0].node.list_usable_channels().len(), 1);
9249 assert!(nodes[0].node.list_usable_channels()[0].channel_id == chan_3.2);
9253 fn test_invalid_funding_tx() {
9254 // Test that we properly handle invalid funding transactions sent to us from a peer.
9256 // Previously, all other major lightning implementations had failed to properly sanitize
9257 // funding transactions from their counterparties, leading to a multi-implementation critical
9258 // security vulnerability (though we always sanitized properly, we've previously had
9259 // un-released crashes in the sanitization process).
9260 let chanmon_cfgs = create_chanmon_cfgs(2);
9261 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
9262 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
9263 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
9265 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100_000, 10_000, 42, None).unwrap();
9266 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()));
9267 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()));
9269 let (temporary_channel_id, mut tx, _) = create_funding_transaction(&nodes[0], 100_000, 42);
9270 for output in tx.output.iter_mut() {
9271 // Make the confirmed funding transaction have a bogus script_pubkey
9272 output.script_pubkey = bitcoin::Script::new();
9275 nodes[0].node.funding_transaction_generated_unchecked(&temporary_channel_id, tx.clone(), 0).unwrap();
9276 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()));
9277 check_added_monitors!(nodes[1], 1);
9279 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()));
9280 check_added_monitors!(nodes[0], 1);
9282 let events_1 = nodes[0].node.get_and_clear_pending_events();
9283 assert_eq!(events_1.len(), 0);
9285 assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
9286 assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0], tx);
9287 nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
9289 confirm_transaction_at(&nodes[1], &tx, 1);
9290 check_added_monitors!(nodes[1], 1);
9291 let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
9292 assert_eq!(events_2.len(), 1);
9293 if let MessageSendEvent::HandleError { node_id, action } = &events_2[0] {
9294 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
9295 if let msgs::ErrorAction::SendErrorMessage { msg } = action {
9296 assert_eq!(msg.data, "funding tx had wrong script/value or output index");
9297 } else { panic!(); }
9298 } else { panic!(); }
9299 assert_eq!(nodes[1].node.list_channels().len(), 0);