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(),
1698 format!("Attempting to fail HTLC due to fee spike buffer violation in channel {}. Rebalancing is required.", ::hex::encode(raa_msg.channel_id)), 1);
1700 check_added_monitors!(nodes[1], 2);
1704 fn test_chan_reserve_violation_outbound_htlc_inbound_chan() {
1705 let mut chanmon_cfgs = create_chanmon_cfgs(2);
1706 // Set the fee rate for the channel very high, to the point where the fundee
1707 // sending any above-dust amount would result in a channel reserve violation.
1708 // In this test we check that we would be prevented from sending an HTLC in
1710 chanmon_cfgs[0].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 6000 };
1711 chanmon_cfgs[1].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 6000 };
1712 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1713 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1714 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1715 let _ = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1717 let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[1], nodes[0], 4843000);
1718 unwrap_send_err!(nodes[1].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
1719 assert_eq!(err, "Cannot send value that would put counterparty balance under holder-announced channel reserve value"));
1720 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1721 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);
1725 fn test_chan_reserve_violation_inbound_htlc_outbound_channel() {
1726 let mut chanmon_cfgs = create_chanmon_cfgs(2);
1727 // Set the fee rate for the channel very high, to the point where the funder
1728 // receiving 1 update_add_htlc would result in them closing the channel due
1729 // to channel reserve violation. This close could also happen if the fee went
1730 // up a more realistic amount, but many HTLCs were outstanding at the time of
1731 // the update_add_htlc.
1732 chanmon_cfgs[0].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 6000 };
1733 chanmon_cfgs[1].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 6000 };
1734 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1735 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1736 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1737 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1739 let (route, payment_hash, _, payment_secret) = get_route_and_payment_hash!(nodes[1], nodes[0], 1000);
1740 // Need to manually create the update_add_htlc message to go around the channel reserve check in send_htlc()
1741 let secp_ctx = Secp256k1::new();
1742 let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
1743 let cur_height = nodes[1].node.best_block.read().unwrap().height() + 1;
1744 let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route.paths[0], &session_priv).unwrap();
1745 let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 1000, &Some(payment_secret), cur_height).unwrap();
1746 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
1747 let msg = msgs::UpdateAddHTLC {
1750 amount_msat: htlc_msat + 1,
1751 payment_hash: payment_hash,
1752 cltv_expiry: htlc_cltv,
1753 onion_routing_packet: onion_packet,
1756 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &msg);
1757 // Check that the payment failed and the channel is closed in response to the malicious UpdateAdd.
1758 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);
1759 assert_eq!(nodes[0].node.list_channels().len(), 0);
1760 let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
1761 assert_eq!(err_msg.data, "Cannot accept HTLC that would put our balance under counterparty-announced channel reserve value");
1762 check_added_monitors!(nodes[0], 1);
1766 fn test_chan_reserve_dust_inbound_htlcs_outbound_chan() {
1767 // Test that if we receive many dust HTLCs over an outbound channel, they don't count when
1768 // calculating our commitment transaction fee (this was previously broken).
1769 let chanmon_cfgs = create_chanmon_cfgs(2);
1770 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1771 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None, None]);
1772 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1774 // Set nodes[0]'s balance such that they will consider any above-dust received HTLC to be a
1775 // channel reserve violation (so their balance is channel reserve (1000 sats) + commitment
1776 // transaction fee with 0 HTLCs (183 sats)).
1777 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 98817000, InitFeatures::known(), InitFeatures::known());
1779 let dust_amt = 329000; // Dust amount
1780 // In the previous code, routing this dust payment would cause nodes[0] to perceive a channel
1781 // reserve violation even though it's a dust HTLC and therefore shouldn't count towards the
1782 // commitment transaction fee.
1783 let (_, _, _) = route_payment(&nodes[1], &[&nodes[0]], dust_amt);
1787 fn test_chan_reserve_dust_inbound_htlcs_inbound_chan() {
1788 // Test that if we receive many dust HTLCs over an inbound channel, they don't count when
1789 // calculating our counterparty's commitment transaction fee (this was previously broken).
1790 let chanmon_cfgs = create_chanmon_cfgs(2);
1791 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1792 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None, None]);
1793 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1794 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 98000000, InitFeatures::known(), InitFeatures::known());
1796 let payment_amt = 46000; // Dust amount
1797 // In the previous code, these first four payments would succeed.
1798 let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1799 let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1800 let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1801 let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1803 // Then these next 5 would be interpreted by nodes[1] as violating the fee spike buffer.
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);
1808 let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1810 // And this last payment previously resulted in nodes[1] closing on its inbound-channel
1811 // counterparty, because it counted all the previous dust HTLCs against nodes[0]'s commitment
1812 // transaction fee and therefore perceived this next payment as a channel reserve violation.
1813 let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1817 fn test_chan_reserve_violation_inbound_htlc_inbound_chan() {
1818 let chanmon_cfgs = create_chanmon_cfgs(3);
1819 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1820 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1821 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1822 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1823 let _ = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1826 let total_routing_fee_msat = (nodes.len() - 2) as u64 * feemsat;
1827 let chan_stat = get_channel_value_stat!(nodes[0], chan.2);
1828 let feerate = get_feerate!(nodes[0], chan.2);
1830 // Add a 2* and +1 for the fee spike reserve.
1831 let commit_tx_fee_2_htlc = 2*commit_tx_fee_msat(feerate, 2 + 1);
1832 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;
1833 let amt_msat_1 = recv_value_1 + total_routing_fee_msat;
1835 // Add a pending HTLC.
1836 let (route_1, our_payment_hash_1, _, our_payment_secret_1) = get_route_and_payment_hash!(nodes[0], nodes[2], amt_msat_1);
1837 let payment_event_1 = {
1838 nodes[0].node.send_payment(&route_1, our_payment_hash_1, &Some(our_payment_secret_1)).unwrap();
1839 check_added_monitors!(nodes[0], 1);
1841 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1842 assert_eq!(events.len(), 1);
1843 SendEvent::from_event(events.remove(0))
1845 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event_1.msgs[0]);
1847 // Attempt to trigger a channel reserve violation --> payment failure.
1848 let commit_tx_fee_2_htlcs = commit_tx_fee_msat(feerate, 2);
1849 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;
1850 let amt_msat_2 = recv_value_2 + total_routing_fee_msat;
1851 let (route_2, _, _, _) = get_route_and_payment_hash!(nodes[0], nodes[2], amt_msat_2);
1853 // Need to manually create the update_add_htlc message to go around the channel reserve check in send_htlc()
1854 let secp_ctx = Secp256k1::new();
1855 let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
1856 let cur_height = nodes[0].node.best_block.read().unwrap().height() + 1;
1857 let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route_2.paths[0], &session_priv).unwrap();
1858 let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route_2.paths[0], recv_value_2, &None, cur_height).unwrap();
1859 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &our_payment_hash_1);
1860 let msg = msgs::UpdateAddHTLC {
1863 amount_msat: htlc_msat + 1,
1864 payment_hash: our_payment_hash_1,
1865 cltv_expiry: htlc_cltv,
1866 onion_routing_packet: onion_packet,
1869 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
1870 // Check that the payment failed and the channel is closed in response to the malicious UpdateAdd.
1871 nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Remote HTLC add would put them under remote reserve value".to_string(), 1);
1872 assert_eq!(nodes[1].node.list_channels().len(), 1);
1873 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
1874 assert_eq!(err_msg.data, "Remote HTLC add would put them under remote reserve value");
1875 check_added_monitors!(nodes[1], 1);
1879 fn test_inbound_outbound_capacity_is_not_zero() {
1880 let chanmon_cfgs = create_chanmon_cfgs(2);
1881 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1882 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1883 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1884 let _ = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1885 let channels0 = node_chanmgrs[0].list_channels();
1886 let channels1 = node_chanmgrs[1].list_channels();
1887 assert_eq!(channels0.len(), 1);
1888 assert_eq!(channels1.len(), 1);
1890 assert_eq!(channels0[0].inbound_capacity_msat, 95000000);
1891 assert_eq!(channels1[0].outbound_capacity_msat, 95000000);
1893 assert_eq!(channels0[0].outbound_capacity_msat, 100000 * 1000 - 95000000);
1894 assert_eq!(channels1[0].inbound_capacity_msat, 100000 * 1000 - 95000000);
1897 fn commit_tx_fee_msat(feerate: u32, num_htlcs: u64) -> u64 {
1898 (COMMITMENT_TX_BASE_WEIGHT + num_htlcs * COMMITMENT_TX_WEIGHT_PER_HTLC) * feerate as u64 / 1000 * 1000
1902 fn test_channel_reserve_holding_cell_htlcs() {
1903 let chanmon_cfgs = create_chanmon_cfgs(3);
1904 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1905 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1906 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1907 let chan_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 190000, 1001, InitFeatures::known(), InitFeatures::known());
1908 let chan_2 = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 190000, 1001, InitFeatures::known(), InitFeatures::known());
1910 let mut stat01 = get_channel_value_stat!(nodes[0], chan_1.2);
1911 let mut stat11 = get_channel_value_stat!(nodes[1], chan_1.2);
1913 let mut stat12 = get_channel_value_stat!(nodes[1], chan_2.2);
1914 let mut stat22 = get_channel_value_stat!(nodes[2], chan_2.2);
1916 macro_rules! expect_forward {
1918 let mut events = $node.node.get_and_clear_pending_msg_events();
1919 assert_eq!(events.len(), 1);
1920 check_added_monitors!($node, 1);
1921 let payment_event = SendEvent::from_event(events.remove(0));
1926 let feemsat = 239; // somehow we know?
1927 let total_fee_msat = (nodes.len() - 2) as u64 * feemsat;
1928 let feerate = get_feerate!(nodes[0], chan_1.2);
1930 let recv_value_0 = stat01.counterparty_max_htlc_value_in_flight_msat - total_fee_msat;
1932 // attempt to send amt_msat > their_max_htlc_value_in_flight_msat
1934 let (mut route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], recv_value_0);
1935 route.paths[0].last_mut().unwrap().fee_msat += 1;
1936 assert!(route.paths[0].iter().rev().skip(1).all(|h| h.fee_msat == feemsat));
1937 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
1938 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)));
1939 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1940 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);
1943 // channel reserve is bigger than their_max_htlc_value_in_flight_msat so loop to deplete
1944 // nodes[0]'s wealth
1946 let amt_msat = recv_value_0 + total_fee_msat;
1947 // 3 for the 3 HTLCs that will be sent, 2* and +1 for the fee spike reserve.
1948 // Also, ensure that each payment has enough to be over the dust limit to
1949 // ensure it'll be included in each commit tx fee calculation.
1950 let commit_tx_fee_all_htlcs = 2*commit_tx_fee_msat(feerate, 3 + 1);
1951 let ensure_htlc_amounts_above_dust_buffer = 3 * (stat01.counterparty_dust_limit_msat + 1000);
1952 if stat01.value_to_self_msat < stat01.channel_reserve_msat + commit_tx_fee_all_htlcs + ensure_htlc_amounts_above_dust_buffer + amt_msat {
1955 send_payment(&nodes[0], &vec![&nodes[1], &nodes[2]][..], recv_value_0);
1957 let (stat01_, stat11_, stat12_, stat22_) = (
1958 get_channel_value_stat!(nodes[0], chan_1.2),
1959 get_channel_value_stat!(nodes[1], chan_1.2),
1960 get_channel_value_stat!(nodes[1], chan_2.2),
1961 get_channel_value_stat!(nodes[2], chan_2.2),
1964 assert_eq!(stat01_.value_to_self_msat, stat01.value_to_self_msat - amt_msat);
1965 assert_eq!(stat11_.value_to_self_msat, stat11.value_to_self_msat + amt_msat);
1966 assert_eq!(stat12_.value_to_self_msat, stat12.value_to_self_msat - (amt_msat - feemsat));
1967 assert_eq!(stat22_.value_to_self_msat, stat22.value_to_self_msat + (amt_msat - feemsat));
1968 stat01 = stat01_; stat11 = stat11_; stat12 = stat12_; stat22 = stat22_;
1971 // adding pending output.
1972 // 2* and +1 HTLCs on the commit tx fee for the fee spike reserve.
1973 // The reason we're dividing by two here is as follows: the dividend is the total outbound liquidity
1974 // after fees, the channel reserve, and the fee spike buffer are removed. We eventually want to
1975 // divide this quantity into 3 portions, that will each be sent in an HTLC. This allows us
1976 // to test channel channel reserve policy at the edges of what amount is sendable, i.e.
1977 // cases where 1 msat over X amount will cause a payment failure, but anything less than
1978 // that can be sent successfully. So, dividing by two is a somewhat arbitrary way of getting
1979 // the amount of the first of these aforementioned 3 payments. The reason we split into 3 payments
1980 // is to test the behavior of the holding cell with respect to channel reserve and commit tx fee
1982 let commit_tx_fee_2_htlcs = 2*commit_tx_fee_msat(feerate, 2 + 1);
1983 let recv_value_1 = (stat01.value_to_self_msat - stat01.channel_reserve_msat - total_fee_msat - commit_tx_fee_2_htlcs)/2;
1984 let amt_msat_1 = recv_value_1 + total_fee_msat;
1986 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);
1987 let payment_event_1 = {
1988 nodes[0].node.send_payment(&route_1, our_payment_hash_1, &Some(our_payment_secret_1)).unwrap();
1989 check_added_monitors!(nodes[0], 1);
1991 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1992 assert_eq!(events.len(), 1);
1993 SendEvent::from_event(events.remove(0))
1995 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event_1.msgs[0]);
1997 // channel reserve test with htlc pending output > 0
1998 let recv_value_2 = stat01.value_to_self_msat - amt_msat_1 - stat01.channel_reserve_msat - total_fee_msat - commit_tx_fee_2_htlcs;
2000 let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], recv_value_2 + 1);
2001 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
2002 assert!(regex::Regex::new(r"Cannot send value that would put our balance under counterparty-announced channel reserve value \(\d+\)").unwrap().is_match(err)));
2003 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
2006 // split the rest to test holding cell
2007 let commit_tx_fee_3_htlcs = 2*commit_tx_fee_msat(feerate, 3 + 1);
2008 let additional_htlc_cost_msat = commit_tx_fee_3_htlcs - commit_tx_fee_2_htlcs;
2009 let recv_value_21 = recv_value_2/2 - additional_htlc_cost_msat/2;
2010 let recv_value_22 = recv_value_2 - recv_value_21 - total_fee_msat - additional_htlc_cost_msat;
2012 let stat = get_channel_value_stat!(nodes[0], chan_1.2);
2013 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);
2016 // now see if they go through on both sides
2017 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);
2018 // but this will stuck in the holding cell
2019 nodes[0].node.send_payment(&route_21, our_payment_hash_21, &Some(our_payment_secret_21)).unwrap();
2020 check_added_monitors!(nodes[0], 0);
2021 let events = nodes[0].node.get_and_clear_pending_events();
2022 assert_eq!(events.len(), 0);
2024 // test with outbound holding cell amount > 0
2026 let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], recv_value_22+1);
2027 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
2028 assert!(regex::Regex::new(r"Cannot send value that would put our balance under counterparty-announced channel reserve value \(\d+\)").unwrap().is_match(err)));
2029 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
2030 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);
2033 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);
2034 // this will also stuck in the holding cell
2035 nodes[0].node.send_payment(&route_22, our_payment_hash_22, &Some(our_payment_secret_22)).unwrap();
2036 check_added_monitors!(nodes[0], 0);
2037 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
2038 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
2040 // flush the pending htlc
2041 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event_1.commitment_msg);
2042 let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2043 check_added_monitors!(nodes[1], 1);
2045 // the pending htlc should be promoted to committed
2046 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_revoke_and_ack);
2047 check_added_monitors!(nodes[0], 1);
2048 let commitment_update_2 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2050 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &as_commitment_signed);
2051 let bs_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2052 // No commitment_signed so get_event_msg's assert(len == 1) passes
2053 check_added_monitors!(nodes[0], 1);
2055 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &bs_revoke_and_ack);
2056 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2057 check_added_monitors!(nodes[1], 1);
2059 expect_pending_htlcs_forwardable!(nodes[1]);
2061 let ref payment_event_11 = expect_forward!(nodes[1]);
2062 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_11.msgs[0]);
2063 commitment_signed_dance!(nodes[2], nodes[1], payment_event_11.commitment_msg, false);
2065 expect_pending_htlcs_forwardable!(nodes[2]);
2066 expect_payment_received!(nodes[2], our_payment_hash_1, our_payment_secret_1, recv_value_1);
2068 // flush the htlcs in the holding cell
2069 assert_eq!(commitment_update_2.update_add_htlcs.len(), 2);
2070 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &commitment_update_2.update_add_htlcs[0]);
2071 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &commitment_update_2.update_add_htlcs[1]);
2072 commitment_signed_dance!(nodes[1], nodes[0], &commitment_update_2.commitment_signed, false);
2073 expect_pending_htlcs_forwardable!(nodes[1]);
2075 let ref payment_event_3 = expect_forward!(nodes[1]);
2076 assert_eq!(payment_event_3.msgs.len(), 2);
2077 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_3.msgs[0]);
2078 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_3.msgs[1]);
2080 commitment_signed_dance!(nodes[2], nodes[1], &payment_event_3.commitment_msg, false);
2081 expect_pending_htlcs_forwardable!(nodes[2]);
2083 let events = nodes[2].node.get_and_clear_pending_events();
2084 assert_eq!(events.len(), 2);
2086 Event::PaymentReceived { ref payment_hash, ref payment_preimage, ref payment_secret, amt, user_payment_id: _ } => {
2087 assert_eq!(our_payment_hash_21, *payment_hash);
2088 assert!(payment_preimage.is_none());
2089 assert_eq!(our_payment_secret_21, *payment_secret);
2090 assert_eq!(recv_value_21, amt);
2092 _ => panic!("Unexpected event"),
2095 Event::PaymentReceived { ref payment_hash, ref payment_preimage, ref payment_secret, amt, user_payment_id: _ } => {
2096 assert_eq!(our_payment_hash_22, *payment_hash);
2097 assert!(payment_preimage.is_none());
2098 assert_eq!(our_payment_secret_22, *payment_secret);
2099 assert_eq!(recv_value_22, amt);
2101 _ => panic!("Unexpected event"),
2104 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_1);
2105 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_21);
2106 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_22);
2108 let commit_tx_fee_0_htlcs = 2*commit_tx_fee_msat(feerate, 1);
2109 let recv_value_3 = commit_tx_fee_2_htlcs - commit_tx_fee_0_htlcs - total_fee_msat;
2110 send_payment(&nodes[0], &vec![&nodes[1], &nodes[2]][..], recv_value_3);
2112 let commit_tx_fee_1_htlc = 2*commit_tx_fee_msat(feerate, 1 + 1);
2113 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);
2114 let stat0 = get_channel_value_stat!(nodes[0], chan_1.2);
2115 assert_eq!(stat0.value_to_self_msat, expected_value_to_self);
2116 assert_eq!(stat0.value_to_self_msat, stat0.channel_reserve_msat + commit_tx_fee_1_htlc);
2118 let stat2 = get_channel_value_stat!(nodes[2], chan_2.2);
2119 assert_eq!(stat2.value_to_self_msat, stat22.value_to_self_msat + recv_value_1 + recv_value_21 + recv_value_22 + recv_value_3);
2123 fn channel_reserve_in_flight_removes() {
2124 // In cases where one side claims an HTLC, it thinks it has additional available funds that it
2125 // can send to its counterparty, but due to update ordering, the other side may not yet have
2126 // considered those HTLCs fully removed.
2127 // This tests that we don't count HTLCs which will not be included in the next remote
2128 // commitment transaction towards the reserve value (as it implies no commitment transaction
2129 // will be generated which violates the remote reserve value).
2130 // This was broken previously, and discovered by the chanmon_fail_consistency fuzz test.
2132 // * route two HTLCs from A to B (note that, at a high level, this test is checking that, when
2133 // you consider the values of both of these HTLCs, B may not send an HTLC back to A, but if
2134 // you only consider the value of the first HTLC, it may not),
2135 // * start routing a third HTLC from A to B,
2136 // * claim the first two HTLCs (though B will generate an update_fulfill for one, and put
2137 // the other claim in its holding cell, as it immediately goes into AwaitingRAA),
2138 // * deliver the first fulfill from B
2139 // * deliver the update_add and an RAA from A, resulting in B freeing the second holding cell
2141 // * deliver A's response CS and RAA.
2142 // This results in A having the second HTLC in AwaitingRemovedRemoteRevoke, but B having
2143 // removed it fully. B now has the push_msat plus the first two HTLCs in value.
2144 // * Now B happily sends another HTLC, potentially violating its reserve value from A's point
2145 // of view (if A counts the AwaitingRemovedRemoteRevoke HTLC).
2146 let chanmon_cfgs = create_chanmon_cfgs(2);
2147 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2148 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2149 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2150 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2151 let logger = test_utils::TestLogger::new();
2153 let b_chan_values = get_channel_value_stat!(nodes[1], chan_1.2);
2154 // Route the first two HTLCs.
2155 let (payment_preimage_1, _, _) = route_payment(&nodes[0], &[&nodes[1]], b_chan_values.channel_reserve_msat - b_chan_values.value_to_self_msat - 10000);
2156 let (payment_preimage_2, _, _) = route_payment(&nodes[0], &[&nodes[1]], 20000);
2158 // Start routing the third HTLC (this is just used to get everyone in the right state).
2159 let (payment_preimage_3, payment_hash_3, payment_secret_3) = get_payment_preimage_hash!(nodes[1]);
2161 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
2162 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();
2163 nodes[0].node.send_payment(&route, payment_hash_3, &Some(payment_secret_3)).unwrap();
2164 check_added_monitors!(nodes[0], 1);
2165 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
2166 assert_eq!(events.len(), 1);
2167 SendEvent::from_event(events.remove(0))
2170 // Now claim both of the first two HTLCs on B's end, putting B in AwaitingRAA and generating an
2171 // initial fulfill/CS.
2172 assert!(nodes[1].node.claim_funds(payment_preimage_1));
2173 check_added_monitors!(nodes[1], 1);
2174 let bs_removes = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2176 // This claim goes in B's holding cell, allowing us to have a pending B->A RAA which does not
2177 // remove the second HTLC when we send the HTLC back from B to A.
2178 assert!(nodes[1].node.claim_funds(payment_preimage_2));
2179 check_added_monitors!(nodes[1], 1);
2180 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2182 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_removes.update_fulfill_htlcs[0]);
2183 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_removes.commitment_signed);
2184 check_added_monitors!(nodes[0], 1);
2185 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2186 expect_payment_sent!(nodes[0], payment_preimage_1);
2188 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_1.msgs[0]);
2189 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &send_1.commitment_msg);
2190 check_added_monitors!(nodes[1], 1);
2191 // B is already AwaitingRAA, so cant generate a CS here
2192 let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2194 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
2195 check_added_monitors!(nodes[1], 1);
2196 let bs_cs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2198 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2199 check_added_monitors!(nodes[0], 1);
2200 let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2202 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
2203 check_added_monitors!(nodes[1], 1);
2204 let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2206 // The second HTLCis removed, but as A is in AwaitingRAA it can't generate a CS here, so the
2207 // RAA that B generated above doesn't fully resolve the second HTLC from A's point of view.
2208 // However, the RAA A generates here *does* fully resolve the HTLC from B's point of view (as A
2209 // can no longer broadcast a commitment transaction with it and B has the preimage so can go
2210 // on-chain as necessary).
2211 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_cs.update_fulfill_htlcs[0]);
2212 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_cs.commitment_signed);
2213 check_added_monitors!(nodes[0], 1);
2214 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2215 expect_payment_sent!(nodes[0], payment_preimage_2);
2217 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
2218 check_added_monitors!(nodes[1], 1);
2219 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2221 expect_pending_htlcs_forwardable!(nodes[1]);
2222 expect_payment_received!(nodes[1], payment_hash_3, payment_secret_3, 100000);
2224 // Note that as this RAA was generated before the delivery of the update_fulfill it shouldn't
2225 // resolve the second HTLC from A's point of view.
2226 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2227 check_added_monitors!(nodes[0], 1);
2228 let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2230 // Now that B doesn't have the second RAA anymore, but A still does, send a payment from B back
2231 // to A to ensure that A doesn't count the almost-removed HTLC in update_add processing.
2232 let (payment_preimage_4, payment_hash_4, payment_secret_4) = get_payment_preimage_hash!(nodes[0]);
2234 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
2235 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();
2236 nodes[1].node.send_payment(&route, payment_hash_4, &Some(payment_secret_4)).unwrap();
2237 check_added_monitors!(nodes[1], 1);
2238 let mut events = nodes[1].node.get_and_clear_pending_msg_events();
2239 assert_eq!(events.len(), 1);
2240 SendEvent::from_event(events.remove(0))
2243 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &send_2.msgs[0]);
2244 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &send_2.commitment_msg);
2245 check_added_monitors!(nodes[0], 1);
2246 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2248 // Now just resolve all the outstanding messages/HTLCs for completeness...
2250 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
2251 check_added_monitors!(nodes[1], 1);
2252 let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2254 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
2255 check_added_monitors!(nodes[1], 1);
2257 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2258 check_added_monitors!(nodes[0], 1);
2259 let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2261 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
2262 check_added_monitors!(nodes[1], 1);
2263 let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2265 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2266 check_added_monitors!(nodes[0], 1);
2268 expect_pending_htlcs_forwardable!(nodes[0]);
2269 expect_payment_received!(nodes[0], payment_hash_4, payment_secret_4, 10000);
2271 claim_payment(&nodes[1], &[&nodes[0]], payment_preimage_4);
2272 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_3);
2276 fn channel_monitor_network_test() {
2277 // Simple test which builds a network of ChannelManagers, connects them to each other, and
2278 // tests that ChannelMonitor is able to recover from various states.
2279 let chanmon_cfgs = create_chanmon_cfgs(5);
2280 let node_cfgs = create_node_cfgs(5, &chanmon_cfgs);
2281 let node_chanmgrs = create_node_chanmgrs(5, &node_cfgs, &[None, None, None, None, None]);
2282 let nodes = create_network(5, &node_cfgs, &node_chanmgrs);
2284 // Create some initial channels
2285 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2286 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
2287 let chan_3 = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
2288 let chan_4 = create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::known(), InitFeatures::known());
2290 // Make sure all nodes are at the same starting height
2291 connect_blocks(&nodes[0], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[0].best_block_info().1);
2292 connect_blocks(&nodes[1], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[1].best_block_info().1);
2293 connect_blocks(&nodes[2], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[2].best_block_info().1);
2294 connect_blocks(&nodes[3], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[3].best_block_info().1);
2295 connect_blocks(&nodes[4], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[4].best_block_info().1);
2297 // Rebalance the network a bit by relaying one payment through all the channels...
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);
2301 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
2303 // Simple case with no pending HTLCs:
2304 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), true);
2305 check_added_monitors!(nodes[1], 1);
2306 check_closed_broadcast!(nodes[1], false);
2308 let mut node_txn = test_txn_broadcast(&nodes[1], &chan_1, None, HTLCType::NONE);
2309 assert_eq!(node_txn.len(), 1);
2310 mine_transaction(&nodes[0], &node_txn[0]);
2311 check_added_monitors!(nodes[0], 1);
2312 test_txn_broadcast(&nodes[0], &chan_1, None, HTLCType::NONE);
2314 check_closed_broadcast!(nodes[0], true);
2315 assert_eq!(nodes[0].node.list_channels().len(), 0);
2316 assert_eq!(nodes[1].node.list_channels().len(), 1);
2318 // One pending HTLC is discarded by the force-close:
2319 let payment_preimage_1 = route_payment(&nodes[1], &vec!(&nodes[2], &nodes[3])[..], 3000000).0;
2321 // Simple case of one pending HTLC to HTLC-Timeout (note that the HTLC-Timeout is not
2322 // broadcasted until we reach the timelock time).
2323 nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id(), true);
2324 check_closed_broadcast!(nodes[1], false);
2325 check_added_monitors!(nodes[1], 1);
2327 let mut node_txn = test_txn_broadcast(&nodes[1], &chan_2, None, HTLCType::NONE);
2328 connect_blocks(&nodes[1], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + MIN_CLTV_EXPIRY_DELTA as u32 + 1);
2329 test_txn_broadcast(&nodes[1], &chan_2, None, HTLCType::TIMEOUT);
2330 mine_transaction(&nodes[2], &node_txn[0]);
2331 check_added_monitors!(nodes[2], 1);
2332 test_txn_broadcast(&nodes[2], &chan_2, None, HTLCType::NONE);
2334 check_closed_broadcast!(nodes[2], true);
2335 assert_eq!(nodes[1].node.list_channels().len(), 0);
2336 assert_eq!(nodes[2].node.list_channels().len(), 1);
2338 macro_rules! claim_funds {
2339 ($node: expr, $prev_node: expr, $preimage: expr) => {
2341 assert!($node.node.claim_funds($preimage));
2342 check_added_monitors!($node, 1);
2344 let events = $node.node.get_and_clear_pending_msg_events();
2345 assert_eq!(events.len(), 1);
2347 MessageSendEvent::UpdateHTLCs { ref node_id, updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fail_htlcs, .. } } => {
2348 assert!(update_add_htlcs.is_empty());
2349 assert!(update_fail_htlcs.is_empty());
2350 assert_eq!(*node_id, $prev_node.node.get_our_node_id());
2352 _ => panic!("Unexpected event"),
2358 // nodes[3] gets the preimage, but nodes[2] already disconnected, resulting in a nodes[2]
2359 // HTLC-Timeout and a nodes[3] claim against it (+ its own announces)
2360 nodes[2].node.peer_disconnected(&nodes[3].node.get_our_node_id(), true);
2361 check_added_monitors!(nodes[2], 1);
2362 check_closed_broadcast!(nodes[2], false);
2363 let node2_commitment_txid;
2365 let node_txn = test_txn_broadcast(&nodes[2], &chan_3, None, HTLCType::NONE);
2366 connect_blocks(&nodes[2], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + MIN_CLTV_EXPIRY_DELTA as u32 + 1);
2367 test_txn_broadcast(&nodes[2], &chan_3, None, HTLCType::TIMEOUT);
2368 node2_commitment_txid = node_txn[0].txid();
2370 // Claim the payment on nodes[3], giving it knowledge of the preimage
2371 claim_funds!(nodes[3], nodes[2], payment_preimage_1);
2372 mine_transaction(&nodes[3], &node_txn[0]);
2373 check_added_monitors!(nodes[3], 1);
2374 check_preimage_claim(&nodes[3], &node_txn);
2376 check_closed_broadcast!(nodes[3], true);
2377 assert_eq!(nodes[2].node.list_channels().len(), 0);
2378 assert_eq!(nodes[3].node.list_channels().len(), 1);
2380 // Drop the ChannelMonitor for the previous channel to avoid it broadcasting transactions and
2381 // confusing us in the following tests.
2382 let chan_3_mon = nodes[3].chain_monitor.chain_monitor.monitors.write().unwrap().remove(&OutPoint { txid: chan_3.3.txid(), index: 0 }).unwrap();
2384 // One pending HTLC to time out:
2385 let payment_preimage_2 = route_payment(&nodes[3], &vec!(&nodes[4])[..], 3000000).0;
2386 // CLTV expires at TEST_FINAL_CLTV + 1 (current height) + 1 (added in send_payment for
2389 let (close_chan_update_1, close_chan_update_2) = {
2390 connect_blocks(&nodes[3], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + 1);
2391 let events = nodes[3].node.get_and_clear_pending_msg_events();
2392 assert_eq!(events.len(), 2);
2393 let close_chan_update_1 = match events[0] {
2394 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
2397 _ => panic!("Unexpected event"),
2400 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { .. }, node_id } => {
2401 assert_eq!(node_id, nodes[4].node.get_our_node_id());
2403 _ => panic!("Unexpected event"),
2405 check_added_monitors!(nodes[3], 1);
2407 // Clear bumped claiming txn spending node 2 commitment tx. Bumped txn are generated after reaching some height timer.
2409 let mut node_txn = nodes[3].tx_broadcaster.txn_broadcasted.lock().unwrap();
2410 node_txn.retain(|tx| {
2411 if tx.input[0].previous_output.txid == node2_commitment_txid {
2417 let node_txn = test_txn_broadcast(&nodes[3], &chan_4, None, HTLCType::TIMEOUT);
2419 // Claim the payment on nodes[4], giving it knowledge of the preimage
2420 claim_funds!(nodes[4], nodes[3], payment_preimage_2);
2422 connect_blocks(&nodes[4], TEST_FINAL_CLTV - CLTV_CLAIM_BUFFER + 2);
2423 let events = nodes[4].node.get_and_clear_pending_msg_events();
2424 assert_eq!(events.len(), 2);
2425 let close_chan_update_2 = match events[0] {
2426 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
2429 _ => panic!("Unexpected event"),
2432 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { .. }, node_id } => {
2433 assert_eq!(node_id, nodes[3].node.get_our_node_id());
2435 _ => panic!("Unexpected event"),
2437 check_added_monitors!(nodes[4], 1);
2438 test_txn_broadcast(&nodes[4], &chan_4, None, HTLCType::SUCCESS);
2440 mine_transaction(&nodes[4], &node_txn[0]);
2441 check_preimage_claim(&nodes[4], &node_txn);
2442 (close_chan_update_1, close_chan_update_2)
2444 nodes[3].net_graph_msg_handler.handle_channel_update(&close_chan_update_2).unwrap();
2445 nodes[4].net_graph_msg_handler.handle_channel_update(&close_chan_update_1).unwrap();
2446 assert_eq!(nodes[3].node.list_channels().len(), 0);
2447 assert_eq!(nodes[4].node.list_channels().len(), 0);
2449 nodes[3].chain_monitor.chain_monitor.monitors.write().unwrap().insert(OutPoint { txid: chan_3.3.txid(), index: 0 }, chan_3_mon);
2453 fn test_justice_tx() {
2454 // Test justice txn built on revoked HTLC-Success tx, against both sides
2455 let mut alice_config = UserConfig::default();
2456 alice_config.channel_options.announced_channel = true;
2457 alice_config.peer_channel_config_limits.force_announced_channel_preference = false;
2458 alice_config.own_channel_config.our_to_self_delay = 6 * 24 * 5;
2459 let mut bob_config = UserConfig::default();
2460 bob_config.channel_options.announced_channel = true;
2461 bob_config.peer_channel_config_limits.force_announced_channel_preference = false;
2462 bob_config.own_channel_config.our_to_self_delay = 6 * 24 * 3;
2463 let user_cfgs = [Some(alice_config), Some(bob_config)];
2464 let mut chanmon_cfgs = create_chanmon_cfgs(2);
2465 chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
2466 chanmon_cfgs[1].keys_manager.disable_revocation_policy_check = true;
2467 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2468 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &user_cfgs);
2469 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2470 // Create some new channels:
2471 let chan_5 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2473 // A pending HTLC which will be revoked:
2474 let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2475 // Get the will-be-revoked local txn from nodes[0]
2476 let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_5.2);
2477 assert_eq!(revoked_local_txn.len(), 2); // First commitment tx, then HTLC tx
2478 assert_eq!(revoked_local_txn[0].input.len(), 1);
2479 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_5.3.txid());
2480 assert_eq!(revoked_local_txn[0].output.len(), 2); // Only HTLC and output back to 0 are present
2481 assert_eq!(revoked_local_txn[1].input.len(), 1);
2482 assert_eq!(revoked_local_txn[1].input[0].previous_output.txid, revoked_local_txn[0].txid());
2483 assert_eq!(revoked_local_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC-Timeout
2484 // Revoke the old state
2485 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_3);
2488 mine_transaction(&nodes[1], &revoked_local_txn[0]);
2490 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2491 assert_eq!(node_txn.len(), 2); // ChannelMonitor: penalty tx, ChannelManager: local commitment tx
2492 assert_eq!(node_txn[0].input.len(), 2); // We should claim the revoked output and the HTLC output
2494 check_spends!(node_txn[0], revoked_local_txn[0]);
2495 node_txn.swap_remove(0);
2496 node_txn.truncate(1);
2498 check_added_monitors!(nodes[1], 1);
2499 test_txn_broadcast(&nodes[1], &chan_5, None, HTLCType::NONE);
2501 mine_transaction(&nodes[0], &revoked_local_txn[0]);
2502 connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
2503 // Verify broadcast of revoked HTLC-timeout
2504 let node_txn = test_txn_broadcast(&nodes[0], &chan_5, Some(revoked_local_txn[0].clone()), HTLCType::TIMEOUT);
2505 check_added_monitors!(nodes[0], 1);
2506 // Broadcast revoked HTLC-timeout on node 1
2507 mine_transaction(&nodes[1], &node_txn[1]);
2508 test_revoked_htlc_claim_txn_broadcast(&nodes[1], node_txn[1].clone(), revoked_local_txn[0].clone());
2510 get_announce_close_broadcast_events(&nodes, 0, 1);
2512 assert_eq!(nodes[0].node.list_channels().len(), 0);
2513 assert_eq!(nodes[1].node.list_channels().len(), 0);
2515 // We test justice_tx build by A on B's revoked HTLC-Success tx
2516 // Create some new channels:
2517 let chan_6 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2519 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2523 // A pending HTLC which will be revoked:
2524 let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2525 // Get the will-be-revoked local txn from B
2526 let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan_6.2);
2527 assert_eq!(revoked_local_txn.len(), 1); // Only commitment tx
2528 assert_eq!(revoked_local_txn[0].input.len(), 1);
2529 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_6.3.txid());
2530 assert_eq!(revoked_local_txn[0].output.len(), 2); // Only HTLC and output back to A are present
2531 // Revoke the old state
2532 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_4);
2534 mine_transaction(&nodes[0], &revoked_local_txn[0]);
2536 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
2537 assert_eq!(node_txn.len(), 2); //ChannelMonitor: penalty tx, ChannelManager: local commitment tx
2538 assert_eq!(node_txn[0].input.len(), 1); // We claim the received HTLC output
2540 check_spends!(node_txn[0], revoked_local_txn[0]);
2541 node_txn.swap_remove(0);
2543 check_added_monitors!(nodes[0], 1);
2544 test_txn_broadcast(&nodes[0], &chan_6, None, HTLCType::NONE);
2546 mine_transaction(&nodes[1], &revoked_local_txn[0]);
2547 let node_txn = test_txn_broadcast(&nodes[1], &chan_6, Some(revoked_local_txn[0].clone()), HTLCType::SUCCESS);
2548 check_added_monitors!(nodes[1], 1);
2549 mine_transaction(&nodes[0], &node_txn[1]);
2550 test_revoked_htlc_claim_txn_broadcast(&nodes[0], node_txn[1].clone(), revoked_local_txn[0].clone());
2552 get_announce_close_broadcast_events(&nodes, 0, 1);
2553 assert_eq!(nodes[0].node.list_channels().len(), 0);
2554 assert_eq!(nodes[1].node.list_channels().len(), 0);
2558 fn revoked_output_claim() {
2559 // Simple test to ensure a node will claim a revoked output when a stale remote commitment
2560 // transaction is broadcast by its counterparty
2561 let chanmon_cfgs = create_chanmon_cfgs(2);
2562 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2563 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2564 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2565 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2566 // node[0] is gonna to revoke an old state thus node[1] should be able to claim the revoked output
2567 let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2568 assert_eq!(revoked_local_txn.len(), 1);
2569 // Only output is the full channel value back to nodes[0]:
2570 assert_eq!(revoked_local_txn[0].output.len(), 1);
2571 // Send a payment through, updating everyone's latest commitment txn
2572 send_payment(&nodes[0], &vec!(&nodes[1])[..], 5000000);
2574 // Inform nodes[1] that nodes[0] broadcast a stale tx
2575 mine_transaction(&nodes[1], &revoked_local_txn[0]);
2576 check_added_monitors!(nodes[1], 1);
2577 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2578 assert_eq!(node_txn.len(), 2); // ChannelMonitor: justice tx against revoked to_local output, ChannelManager: local commitment tx
2580 check_spends!(node_txn[0], revoked_local_txn[0]);
2581 check_spends!(node_txn[1], chan_1.3);
2583 // Inform nodes[0] that a watchtower cheated on its behalf, so it will force-close the chan
2584 mine_transaction(&nodes[0], &revoked_local_txn[0]);
2585 get_announce_close_broadcast_events(&nodes, 0, 1);
2586 check_added_monitors!(nodes[0], 1)
2590 fn claim_htlc_outputs_shared_tx() {
2591 // Node revoked old state, htlcs haven't time out yet, claim them in shared justice tx
2592 let mut chanmon_cfgs = create_chanmon_cfgs(2);
2593 chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
2594 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2595 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2596 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2598 // Create some new channel:
2599 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2601 // Rebalance the network to generate htlc in the two directions
2602 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
2603 // 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
2604 let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2605 let (_payment_preimage_2, payment_hash_2, _) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000);
2607 // Get the will-be-revoked local txn from node[0]
2608 let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2609 assert_eq!(revoked_local_txn.len(), 2); // commitment tx + 1 HTLC-Timeout tx
2610 assert_eq!(revoked_local_txn[0].input.len(), 1);
2611 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
2612 assert_eq!(revoked_local_txn[1].input.len(), 1);
2613 assert_eq!(revoked_local_txn[1].input[0].previous_output.txid, revoked_local_txn[0].txid());
2614 assert_eq!(revoked_local_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC-Timeout
2615 check_spends!(revoked_local_txn[1], revoked_local_txn[0]);
2617 //Revoke the old state
2618 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_1);
2621 mine_transaction(&nodes[0], &revoked_local_txn[0]);
2622 check_added_monitors!(nodes[0], 1);
2623 mine_transaction(&nodes[1], &revoked_local_txn[0]);
2624 check_added_monitors!(nodes[1], 1);
2625 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
2626 expect_payment_failed!(nodes[1], payment_hash_2, true);
2628 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2629 assert_eq!(node_txn.len(), 2); // ChannelMonitor: penalty tx, ChannelManager: local commitment
2631 assert_eq!(node_txn[0].input.len(), 3); // Claim the revoked output + both revoked HTLC outputs
2632 check_spends!(node_txn[0], revoked_local_txn[0]);
2634 let mut witness_lens = BTreeSet::new();
2635 witness_lens.insert(node_txn[0].input[0].witness.last().unwrap().len());
2636 witness_lens.insert(node_txn[0].input[1].witness.last().unwrap().len());
2637 witness_lens.insert(node_txn[0].input[2].witness.last().unwrap().len());
2638 assert_eq!(witness_lens.len(), 3);
2639 assert_eq!(*witness_lens.iter().skip(0).next().unwrap(), 77); // revoked to_local
2640 assert_eq!(*witness_lens.iter().skip(1).next().unwrap(), OFFERED_HTLC_SCRIPT_WEIGHT); // revoked offered HTLC
2641 assert_eq!(*witness_lens.iter().skip(2).next().unwrap(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // revoked received HTLC
2643 // Next nodes[1] broadcasts its current local tx state:
2644 assert_eq!(node_txn[1].input.len(), 1);
2645 assert_eq!(node_txn[1].input[0].previous_output.txid, chan_1.3.txid()); //Spending funding tx unique txouput, tx broadcasted by ChannelManager
2647 get_announce_close_broadcast_events(&nodes, 0, 1);
2648 assert_eq!(nodes[0].node.list_channels().len(), 0);
2649 assert_eq!(nodes[1].node.list_channels().len(), 0);
2653 fn claim_htlc_outputs_single_tx() {
2654 // Node revoked old state, htlcs have timed out, claim each of them in separated justice tx
2655 let mut chanmon_cfgs = create_chanmon_cfgs(2);
2656 chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
2657 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2658 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2659 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2661 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2663 // Rebalance the network to generate htlc in the two directions
2664 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
2665 // 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
2666 // time as two different claim transactions as we're gonna to timeout htlc with given a high current height
2667 let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2668 let (_payment_preimage_2, payment_hash_2, _payment_secret_2) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000);
2670 // Get the will-be-revoked local txn from node[0]
2671 let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2673 //Revoke the old state
2674 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_1);
2677 confirm_transaction_at(&nodes[0], &revoked_local_txn[0], 100);
2678 check_added_monitors!(nodes[0], 1);
2679 confirm_transaction_at(&nodes[1], &revoked_local_txn[0], 100);
2680 check_added_monitors!(nodes[1], 1);
2681 expect_pending_htlcs_forwardable_ignore!(nodes[0]);
2683 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
2684 expect_payment_failed!(nodes[1], payment_hash_2, true);
2686 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2687 assert_eq!(node_txn.len(), 9);
2688 // ChannelMonitor: justice tx revoked offered htlc, justice tx revoked received htlc, justice tx revoked to_local (3)
2689 // ChannelManager: local commmitment + local HTLC-timeout (2)
2690 // 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)
2691 // ChannelMonitor: local commitment + local HTLC-timeout (2)
2693 // Check the pair local commitment and HTLC-timeout broadcast due to HTLC expiration
2694 assert_eq!(node_txn[0].input.len(), 1);
2695 check_spends!(node_txn[0], chan_1.3);
2696 assert_eq!(node_txn[1].input.len(), 1);
2697 let witness_script = node_txn[1].input[0].witness.last().unwrap();
2698 assert_eq!(witness_script.len(), OFFERED_HTLC_SCRIPT_WEIGHT); //Spending an offered htlc output
2699 check_spends!(node_txn[1], node_txn[0]);
2701 // Justice transactions are indices 1-2-4
2702 assert_eq!(node_txn[2].input.len(), 1);
2703 assert_eq!(node_txn[3].input.len(), 1);
2704 assert_eq!(node_txn[4].input.len(), 1);
2706 check_spends!(node_txn[2], revoked_local_txn[0]);
2707 check_spends!(node_txn[3], revoked_local_txn[0]);
2708 check_spends!(node_txn[4], revoked_local_txn[0]);
2710 let mut witness_lens = BTreeSet::new();
2711 witness_lens.insert(node_txn[2].input[0].witness.last().unwrap().len());
2712 witness_lens.insert(node_txn[3].input[0].witness.last().unwrap().len());
2713 witness_lens.insert(node_txn[4].input[0].witness.last().unwrap().len());
2714 assert_eq!(witness_lens.len(), 3);
2715 assert_eq!(*witness_lens.iter().skip(0).next().unwrap(), 77); // revoked to_local
2716 assert_eq!(*witness_lens.iter().skip(1).next().unwrap(), OFFERED_HTLC_SCRIPT_WEIGHT); // revoked offered HTLC
2717 assert_eq!(*witness_lens.iter().skip(2).next().unwrap(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // revoked received HTLC
2719 get_announce_close_broadcast_events(&nodes, 0, 1);
2720 assert_eq!(nodes[0].node.list_channels().len(), 0);
2721 assert_eq!(nodes[1].node.list_channels().len(), 0);
2725 fn test_htlc_on_chain_success() {
2726 // Test that in case of a unilateral close onchain, we detect the state of output and pass
2727 // the preimage backward accordingly. So here we test that ChannelManager is
2728 // broadcasting the right event to other nodes in payment path.
2729 // We test with two HTLCs simultaneously as that was not handled correctly in the past.
2730 // A --------------------> B ----------------------> C (preimage)
2731 // First, C should claim the HTLC outputs via HTLC-Success when its own latest local
2732 // commitment transaction was broadcast.
2733 // Then, B should learn the preimage from said transactions, attempting to claim backwards
2735 // B should be able to claim via preimage if A then broadcasts its local tx.
2736 // Finally, when A sees B's latest local commitment transaction it should be able to claim
2737 // the HTLC outputs via the preimage it learned (which, once confirmed should generate a
2738 // PaymentSent event).
2740 let chanmon_cfgs = create_chanmon_cfgs(3);
2741 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2742 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2743 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2745 // Create some initial channels
2746 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2747 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
2749 // Ensure all nodes are at the same height
2750 let node_max_height = nodes.iter().map(|node| node.blocks.lock().unwrap().len()).max().unwrap() as u32;
2751 connect_blocks(&nodes[0], node_max_height - nodes[0].best_block_info().1);
2752 connect_blocks(&nodes[1], node_max_height - nodes[1].best_block_info().1);
2753 connect_blocks(&nodes[2], node_max_height - nodes[2].best_block_info().1);
2755 // Rebalance the network a bit by relaying one payment through all the channels...
2756 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
2757 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
2759 let (our_payment_preimage, _payment_hash, _payment_secret) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2760 let (our_payment_preimage_2, _payment_hash_2, _payment_secret_2) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2762 // Broadcast legit commitment tx from C on B's chain
2763 // Broadcast HTLC Success transaction by C on received output from C's commitment tx on B's chain
2764 let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
2765 assert_eq!(commitment_tx.len(), 1);
2766 check_spends!(commitment_tx[0], chan_2.3);
2767 nodes[2].node.claim_funds(our_payment_preimage);
2768 nodes[2].node.claim_funds(our_payment_preimage_2);
2769 check_added_monitors!(nodes[2], 2);
2770 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2771 assert!(updates.update_add_htlcs.is_empty());
2772 assert!(updates.update_fail_htlcs.is_empty());
2773 assert!(updates.update_fail_malformed_htlcs.is_empty());
2774 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
2776 mine_transaction(&nodes[2], &commitment_tx[0]);
2777 check_closed_broadcast!(nodes[2], true);
2778 check_added_monitors!(nodes[2], 1);
2779 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)
2780 assert_eq!(node_txn.len(), 5);
2781 assert_eq!(node_txn[0], node_txn[3]);
2782 assert_eq!(node_txn[1], node_txn[4]);
2783 assert_eq!(node_txn[2], commitment_tx[0]);
2784 check_spends!(node_txn[0], commitment_tx[0]);
2785 check_spends!(node_txn[1], commitment_tx[0]);
2786 assert_eq!(node_txn[0].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2787 assert_eq!(node_txn[1].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2788 assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2789 assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2790 assert_eq!(node_txn[0].lock_time, 0);
2791 assert_eq!(node_txn[1].lock_time, 0);
2793 // Verify that B's ChannelManager is able to extract preimage from HTLC Success tx and pass it backward
2794 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2795 connect_block(&nodes[1], &Block { header, txdata: node_txn});
2796 connect_blocks(&nodes[1], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
2798 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
2799 assert_eq!(added_monitors.len(), 1);
2800 assert_eq!(added_monitors[0].0.txid, chan_2.3.txid());
2801 added_monitors.clear();
2803 let events = nodes[1].node.get_and_clear_pending_msg_events();
2805 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
2806 assert_eq!(added_monitors.len(), 2);
2807 assert_eq!(added_monitors[0].0.txid, chan_1.3.txid());
2808 assert_eq!(added_monitors[1].0.txid, chan_1.3.txid());
2809 added_monitors.clear();
2811 assert_eq!(events.len(), 3);
2813 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
2814 _ => panic!("Unexpected event"),
2817 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { .. }, node_id: _ } => {},
2818 _ => panic!("Unexpected event"),
2822 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, .. } } => {
2823 assert!(update_add_htlcs.is_empty());
2824 assert!(update_fail_htlcs.is_empty());
2825 assert_eq!(update_fulfill_htlcs.len(), 1);
2826 assert!(update_fail_malformed_htlcs.is_empty());
2827 assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
2829 _ => panic!("Unexpected event"),
2831 macro_rules! check_tx_local_broadcast {
2832 ($node: expr, $htlc_offered: expr, $commitment_tx: expr, $chan_tx: expr) => { {
2833 let mut node_txn = $node.tx_broadcaster.txn_broadcasted.lock().unwrap();
2834 assert_eq!(node_txn.len(), 3);
2835 // Node[1]: ChannelManager: 3 (commitment tx, 2*HTLC-Timeout tx), ChannelMonitor: 2 (timeout tx)
2836 // Node[0]: ChannelManager: 3 (commtiemtn tx, 2*HTLC-Timeout tx), ChannelMonitor: 2 HTLC-timeout
2837 check_spends!(node_txn[1], $commitment_tx);
2838 check_spends!(node_txn[2], $commitment_tx);
2839 assert_ne!(node_txn[1].lock_time, 0);
2840 assert_ne!(node_txn[2].lock_time, 0);
2842 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2843 assert_eq!(node_txn[2].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2844 assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2845 assert!(node_txn[2].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2847 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2848 assert_eq!(node_txn[2].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2849 assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2850 assert!(node_txn[2].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2852 check_spends!(node_txn[0], $chan_tx);
2853 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), 71);
2857 // nodes[1] now broadcasts its own local state as a fallback, suggesting an alternate
2858 // commitment transaction with a corresponding HTLC-Timeout transactions, as well as a
2859 // timeout-claim of the output that nodes[2] just claimed via success.
2860 check_tx_local_broadcast!(nodes[1], false, commitment_tx[0], chan_2.3);
2862 // Broadcast legit commitment tx from A on B's chain
2863 // Broadcast preimage tx by B on offered output from A commitment tx on A's chain
2864 let node_a_commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
2865 check_spends!(node_a_commitment_tx[0], chan_1.3);
2866 mine_transaction(&nodes[1], &node_a_commitment_tx[0]);
2867 check_closed_broadcast!(nodes[1], true);
2868 check_added_monitors!(nodes[1], 1);
2869 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
2870 assert_eq!(node_txn.len(), 6); // ChannelManager : 3 (commitment tx + HTLC-Sucess * 2), ChannelMonitor : 3 (HTLC-Success, 2* RBF bumps of above HTLC txn)
2871 let commitment_spend =
2872 if node_txn[0].input[0].previous_output.txid == node_a_commitment_tx[0].txid() {
2873 check_spends!(node_txn[1], commitment_tx[0]);
2874 check_spends!(node_txn[2], commitment_tx[0]);
2875 assert_ne!(node_txn[1].input[0].previous_output.vout, node_txn[2].input[0].previous_output.vout);
2878 check_spends!(node_txn[0], commitment_tx[0]);
2879 check_spends!(node_txn[1], commitment_tx[0]);
2880 assert_ne!(node_txn[0].input[0].previous_output.vout, node_txn[1].input[0].previous_output.vout);
2884 check_spends!(commitment_spend, node_a_commitment_tx[0]);
2885 assert_eq!(commitment_spend.input.len(), 2);
2886 assert_eq!(commitment_spend.input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2887 assert_eq!(commitment_spend.input[1].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2888 assert_eq!(commitment_spend.lock_time, 0);
2889 assert!(commitment_spend.output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2890 check_spends!(node_txn[3], chan_1.3);
2891 assert_eq!(node_txn[3].input[0].witness.clone().last().unwrap().len(), 71);
2892 check_spends!(node_txn[4], node_txn[3]);
2893 check_spends!(node_txn[5], node_txn[3]);
2894 // We don't bother to check that B can claim the HTLC output on its commitment tx here as
2895 // we already checked the same situation with A.
2897 // Verify that A's ChannelManager is able to extract preimage from preimage tx and generate PaymentSent
2898 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2899 connect_block(&nodes[0], &Block { header, txdata: vec![node_a_commitment_tx[0].clone(), commitment_spend.clone()] });
2900 connect_blocks(&nodes[0], TEST_FINAL_CLTV + MIN_CLTV_EXPIRY_DELTA as u32 - 1); // Confirm blocks until the HTLC expires
2901 check_closed_broadcast!(nodes[0], true);
2902 check_added_monitors!(nodes[0], 1);
2903 let events = nodes[0].node.get_and_clear_pending_events();
2904 assert_eq!(events.len(), 2);
2905 let mut first_claimed = false;
2906 for event in events {
2908 Event::PaymentSent { payment_preimage } => {
2909 if payment_preimage == our_payment_preimage {
2910 assert!(!first_claimed);
2911 first_claimed = true;
2913 assert_eq!(payment_preimage, our_payment_preimage_2);
2916 _ => panic!("Unexpected event"),
2919 check_tx_local_broadcast!(nodes[0], true, node_a_commitment_tx[0], chan_1.3);
2922 fn do_test_htlc_on_chain_timeout(connect_style: ConnectStyle) {
2923 // Test that in case of a unilateral close onchain, we detect the state of output and
2924 // timeout the HTLC backward accordingly. So here we test that ChannelManager is
2925 // broadcasting the right event to other nodes in payment path.
2926 // A ------------------> B ----------------------> C (timeout)
2927 // B's commitment tx C's commitment tx
2929 // B's HTLC timeout tx B's timeout tx
2931 let chanmon_cfgs = create_chanmon_cfgs(3);
2932 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2933 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2934 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2935 *nodes[0].connect_style.borrow_mut() = connect_style;
2936 *nodes[1].connect_style.borrow_mut() = connect_style;
2937 *nodes[2].connect_style.borrow_mut() = connect_style;
2939 // Create some intial channels
2940 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2941 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
2943 // Rebalance the network a bit by relaying one payment thorugh all the channels...
2944 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
2945 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
2947 let (_payment_preimage, payment_hash, _payment_secret) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2949 // Broadcast legit commitment tx from C on B's chain
2950 let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
2951 check_spends!(commitment_tx[0], chan_2.3);
2952 nodes[2].node.fail_htlc_backwards(&payment_hash);
2953 check_added_monitors!(nodes[2], 0);
2954 expect_pending_htlcs_forwardable!(nodes[2]);
2955 check_added_monitors!(nodes[2], 1);
2957 let events = nodes[2].node.get_and_clear_pending_msg_events();
2958 assert_eq!(events.len(), 1);
2960 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, .. } } => {
2961 assert!(update_add_htlcs.is_empty());
2962 assert!(!update_fail_htlcs.is_empty());
2963 assert!(update_fulfill_htlcs.is_empty());
2964 assert!(update_fail_malformed_htlcs.is_empty());
2965 assert_eq!(nodes[1].node.get_our_node_id(), *node_id);
2967 _ => panic!("Unexpected event"),
2969 mine_transaction(&nodes[2], &commitment_tx[0]);
2970 check_closed_broadcast!(nodes[2], true);
2971 check_added_monitors!(nodes[2], 1);
2972 let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 1 (commitment tx)
2973 assert_eq!(node_txn.len(), 1);
2974 check_spends!(node_txn[0], chan_2.3);
2975 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), 71);
2977 // Broadcast timeout transaction by B on received output from C's commitment tx on B's chain
2978 // Verify that B's ChannelManager is able to detect that HTLC is timeout by its own tx and react backward in consequence
2979 connect_blocks(&nodes[1], 200 - nodes[2].best_block_info().1);
2980 mine_transaction(&nodes[1], &commitment_tx[0]);
2983 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2984 assert_eq!(node_txn.len(), 5); // ChannelManager : 2 (commitment tx, HTLC-Timeout tx), ChannelMonitor : 2 (local commitment tx + HTLC-timeout), 1 timeout tx
2985 assert_eq!(node_txn[0], node_txn[3]);
2986 assert_eq!(node_txn[1], node_txn[4]);
2988 check_spends!(node_txn[2], commitment_tx[0]);
2989 assert_eq!(node_txn[2].clone().input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2991 check_spends!(node_txn[0], chan_2.3);
2992 check_spends!(node_txn[1], node_txn[0]);
2993 assert_eq!(node_txn[0].clone().input[0].witness.last().unwrap().len(), 71);
2994 assert_eq!(node_txn[1].clone().input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2996 timeout_tx = node_txn[2].clone();
3000 mine_transaction(&nodes[1], &timeout_tx);
3001 check_added_monitors!(nodes[1], 1);
3002 check_closed_broadcast!(nodes[1], true);
3004 // B will rebroadcast a fee-bumped timeout transaction here.
3005 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
3006 assert_eq!(node_txn.len(), 1);
3007 check_spends!(node_txn[0], commitment_tx[0]);
3010 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
3012 // B will rebroadcast its own holder commitment transaction here...just because
3013 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
3014 assert_eq!(node_txn.len(), 1);
3015 check_spends!(node_txn[0], chan_2.3);
3018 expect_pending_htlcs_forwardable!(nodes[1]);
3019 check_added_monitors!(nodes[1], 1);
3020 let events = nodes[1].node.get_and_clear_pending_msg_events();
3021 assert_eq!(events.len(), 1);
3023 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, .. } } => {
3024 assert!(update_add_htlcs.is_empty());
3025 assert!(!update_fail_htlcs.is_empty());
3026 assert!(update_fulfill_htlcs.is_empty());
3027 assert!(update_fail_malformed_htlcs.is_empty());
3028 assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
3030 _ => panic!("Unexpected event"),
3033 // Broadcast legit commitment tx from B on A's chain
3034 let commitment_tx = get_local_commitment_txn!(nodes[1], chan_1.2);
3035 check_spends!(commitment_tx[0], chan_1.3);
3037 mine_transaction(&nodes[0], &commitment_tx[0]);
3038 connect_blocks(&nodes[0], TEST_FINAL_CLTV + MIN_CLTV_EXPIRY_DELTA as u32 - 1); // Confirm blocks until the HTLC expires
3040 check_closed_broadcast!(nodes[0], true);
3041 check_added_monitors!(nodes[0], 1);
3042 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 1 commitment tx, ChannelMonitor : 1 timeout tx
3043 assert_eq!(node_txn.len(), 2);
3044 check_spends!(node_txn[0], chan_1.3);
3045 assert_eq!(node_txn[0].clone().input[0].witness.last().unwrap().len(), 71);
3046 check_spends!(node_txn[1], commitment_tx[0]);
3047 assert_eq!(node_txn[1].clone().input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
3051 fn test_htlc_on_chain_timeout() {
3052 do_test_htlc_on_chain_timeout(ConnectStyle::BestBlockFirstSkippingBlocks);
3053 do_test_htlc_on_chain_timeout(ConnectStyle::TransactionsFirstSkippingBlocks);
3054 do_test_htlc_on_chain_timeout(ConnectStyle::FullBlockViaListen);
3058 fn test_simple_commitment_revoked_fail_backward() {
3059 // Test that in case of a revoked commitment tx, we detect the resolution of output by justice tx
3060 // and fail backward accordingly.
3062 let chanmon_cfgs = create_chanmon_cfgs(3);
3063 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3064 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3065 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3067 // Create some initial channels
3068 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3069 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3071 let (payment_preimage, _payment_hash, _payment_secret) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3000000);
3072 // Get the will-be-revoked local txn from nodes[2]
3073 let revoked_local_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
3074 // Revoke the old state
3075 claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage);
3077 let (_, payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3000000);
3079 mine_transaction(&nodes[1], &revoked_local_txn[0]);
3080 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
3081 check_added_monitors!(nodes[1], 1);
3082 check_closed_broadcast!(nodes[1], true);
3084 expect_pending_htlcs_forwardable!(nodes[1]);
3085 check_added_monitors!(nodes[1], 1);
3086 let events = nodes[1].node.get_and_clear_pending_msg_events();
3087 assert_eq!(events.len(), 1);
3089 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, .. } } => {
3090 assert!(update_add_htlcs.is_empty());
3091 assert_eq!(update_fail_htlcs.len(), 1);
3092 assert!(update_fulfill_htlcs.is_empty());
3093 assert!(update_fail_malformed_htlcs.is_empty());
3094 assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
3096 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
3097 commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
3099 let events = nodes[0].node.get_and_clear_pending_msg_events();
3100 assert_eq!(events.len(), 1);
3102 MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
3103 _ => panic!("Unexpected event"),
3105 expect_payment_failed!(nodes[0], payment_hash, false);
3107 _ => panic!("Unexpected event"),
3111 fn do_test_commitment_revoked_fail_backward_exhaustive(deliver_bs_raa: bool, use_dust: bool, no_to_remote: bool) {
3112 // Test that if our counterparty broadcasts a revoked commitment transaction we fail all
3113 // pending HTLCs on that channel backwards even if the HTLCs aren't present in our latest
3114 // commitment transaction anymore.
3115 // To do this, we have the peer which will broadcast a revoked commitment transaction send
3116 // a number of update_fail/commitment_signed updates without ever sending the RAA in
3117 // response to our commitment_signed. This is somewhat misbehavior-y, though not
3118 // technically disallowed and we should probably handle it reasonably.
3119 // Note that this is pretty exhaustive as an outbound HTLC which we haven't yet
3120 // failed/fulfilled backwards must be in at least one of the latest two remote commitment
3122 // * Once we move it out of our holding cell/add it, we will immediately include it in a
3123 // commitment_signed (implying it will be in the latest remote commitment transaction).
3124 // * Once they remove it, we will send a (the first) commitment_signed without the HTLC,
3125 // and once they revoke the previous commitment transaction (allowing us to send a new
3126 // commitment_signed) we will be free to fail/fulfill the HTLC backwards.
3127 let chanmon_cfgs = create_chanmon_cfgs(3);
3128 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3129 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3130 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3132 // Create some initial channels
3133 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3134 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3136 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 });
3137 // Get the will-be-revoked local txn from nodes[2]
3138 let revoked_local_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
3139 assert_eq!(revoked_local_txn[0].output.len(), if no_to_remote { 1 } else { 2 });
3140 // Revoke the old state
3141 claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage);
3143 let value = if use_dust {
3144 // The dust limit applied to HTLC outputs considers the fee of the HTLC transaction as
3145 // well, so HTLCs at exactly the dust limit will not be included in commitment txn.
3146 nodes[2].node.channel_state.lock().unwrap().by_id.get(&chan_2.2).unwrap().holder_dust_limit_satoshis * 1000
3149 let (_, first_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
3150 let (_, second_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
3151 let (_, third_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
3153 assert!(nodes[2].node.fail_htlc_backwards(&first_payment_hash));
3154 expect_pending_htlcs_forwardable!(nodes[2]);
3155 check_added_monitors!(nodes[2], 1);
3156 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3157 assert!(updates.update_add_htlcs.is_empty());
3158 assert!(updates.update_fulfill_htlcs.is_empty());
3159 assert!(updates.update_fail_malformed_htlcs.is_empty());
3160 assert_eq!(updates.update_fail_htlcs.len(), 1);
3161 assert!(updates.update_fee.is_none());
3162 nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
3163 let bs_raa = commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false, true, false, true);
3164 // Drop the last RAA from 3 -> 2
3166 assert!(nodes[2].node.fail_htlc_backwards(&second_payment_hash));
3167 expect_pending_htlcs_forwardable!(nodes[2]);
3168 check_added_monitors!(nodes[2], 1);
3169 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3170 assert!(updates.update_add_htlcs.is_empty());
3171 assert!(updates.update_fulfill_htlcs.is_empty());
3172 assert!(updates.update_fail_malformed_htlcs.is_empty());
3173 assert_eq!(updates.update_fail_htlcs.len(), 1);
3174 assert!(updates.update_fee.is_none());
3175 nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
3176 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &updates.commitment_signed);
3177 check_added_monitors!(nodes[1], 1);
3178 // Note that nodes[1] is in AwaitingRAA, so won't send a CS
3179 let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
3180 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
3181 check_added_monitors!(nodes[2], 1);
3183 assert!(nodes[2].node.fail_htlc_backwards(&third_payment_hash));
3184 expect_pending_htlcs_forwardable!(nodes[2]);
3185 check_added_monitors!(nodes[2], 1);
3186 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3187 assert!(updates.update_add_htlcs.is_empty());
3188 assert!(updates.update_fulfill_htlcs.is_empty());
3189 assert!(updates.update_fail_malformed_htlcs.is_empty());
3190 assert_eq!(updates.update_fail_htlcs.len(), 1);
3191 assert!(updates.update_fee.is_none());
3192 nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
3193 // At this point first_payment_hash has dropped out of the latest two commitment
3194 // transactions that nodes[1] is tracking...
3195 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &updates.commitment_signed);
3196 check_added_monitors!(nodes[1], 1);
3197 // Note that nodes[1] is (still) in AwaitingRAA, so won't send a CS
3198 let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
3199 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
3200 check_added_monitors!(nodes[2], 1);
3202 // Add a fourth HTLC, this one will get sequestered away in nodes[1]'s holding cell waiting
3203 // on nodes[2]'s RAA.
3204 let (_, fourth_payment_hash, fourth_payment_secret) = get_payment_preimage_hash!(nodes[2]);
3205 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
3206 let logger = test_utils::TestLogger::new();
3207 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();
3208 nodes[1].node.send_payment(&route, fourth_payment_hash, &Some(fourth_payment_secret)).unwrap();
3209 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3210 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
3211 check_added_monitors!(nodes[1], 0);
3214 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_raa);
3215 // One monitor for the new revocation preimage, no second on as we won't generate a new
3216 // commitment transaction for nodes[0] until process_pending_htlc_forwards().
3217 check_added_monitors!(nodes[1], 1);
3218 let events = nodes[1].node.get_and_clear_pending_events();
3219 assert_eq!(events.len(), 1);
3221 Event::PendingHTLCsForwardable { .. } => { },
3222 _ => panic!("Unexpected event"),
3224 // Deliberately don't process the pending fail-back so they all fail back at once after
3225 // block connection just like the !deliver_bs_raa case
3228 let mut failed_htlcs = HashSet::new();
3229 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
3231 mine_transaction(&nodes[1], &revoked_local_txn[0]);
3232 check_added_monitors!(nodes[1], 1);
3233 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
3235 let events = nodes[1].node.get_and_clear_pending_events();
3236 assert_eq!(events.len(), if deliver_bs_raa { 1 } else { 2 });
3238 Event::PaymentFailed { ref payment_hash, .. } => {
3239 assert_eq!(*payment_hash, fourth_payment_hash);
3241 _ => panic!("Unexpected event"),
3243 if !deliver_bs_raa {
3245 Event::PendingHTLCsForwardable { .. } => { },
3246 _ => panic!("Unexpected event"),
3249 nodes[1].node.process_pending_htlc_forwards();
3250 check_added_monitors!(nodes[1], 1);
3252 let events = nodes[1].node.get_and_clear_pending_msg_events();
3253 assert_eq!(events.len(), if deliver_bs_raa { 4 } else { 3 });
3254 match events[if deliver_bs_raa { 1 } else { 0 }] {
3255 MessageSendEvent::BroadcastChannelUpdate { msg: msgs::ChannelUpdate { .. } } => {},
3256 _ => panic!("Unexpected event"),
3258 match events[if deliver_bs_raa { 2 } else { 1 }] {
3259 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { msg: msgs::ErrorMessage { channel_id, ref data } }, node_id: _ } => {
3260 assert_eq!(channel_id, chan_2.2);
3261 assert_eq!(data.as_str(), "Commitment or closing transaction was confirmed on chain.");
3263 _ => panic!("Unexpected event"),
3267 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, .. } } => {
3268 assert_eq!(nodes[2].node.get_our_node_id(), *node_id);
3269 assert_eq!(update_add_htlcs.len(), 1);
3270 assert!(update_fulfill_htlcs.is_empty());
3271 assert!(update_fail_htlcs.is_empty());
3272 assert!(update_fail_malformed_htlcs.is_empty());
3274 _ => panic!("Unexpected event"),
3277 match events[if deliver_bs_raa { 3 } else { 2 }] {
3278 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, .. } } => {
3279 assert!(update_add_htlcs.is_empty());
3280 assert_eq!(update_fail_htlcs.len(), 3);
3281 assert!(update_fulfill_htlcs.is_empty());
3282 assert!(update_fail_malformed_htlcs.is_empty());
3283 assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
3285 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
3286 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[1]);
3287 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[2]);
3289 commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
3291 let events = nodes[0].node.get_and_clear_pending_msg_events();
3292 // If we delivered B's RAA we got an unknown preimage error, not something
3293 // that we should update our routing table for.
3294 assert_eq!(events.len(), if deliver_bs_raa { 2 } else { 3 });
3295 for event in events {
3297 MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
3298 _ => panic!("Unexpected event"),
3301 let events = nodes[0].node.get_and_clear_pending_events();
3302 assert_eq!(events.len(), 3);
3304 Event::PaymentFailed { ref payment_hash, .. } => {
3305 assert!(failed_htlcs.insert(payment_hash.0));
3307 _ => panic!("Unexpected event"),
3310 Event::PaymentFailed { ref payment_hash, .. } => {
3311 assert!(failed_htlcs.insert(payment_hash.0));
3313 _ => panic!("Unexpected event"),
3316 Event::PaymentFailed { ref payment_hash, .. } => {
3317 assert!(failed_htlcs.insert(payment_hash.0));
3319 _ => panic!("Unexpected event"),
3322 _ => panic!("Unexpected event"),
3325 assert!(failed_htlcs.contains(&first_payment_hash.0));
3326 assert!(failed_htlcs.contains(&second_payment_hash.0));
3327 assert!(failed_htlcs.contains(&third_payment_hash.0));
3331 fn test_commitment_revoked_fail_backward_exhaustive_a() {
3332 do_test_commitment_revoked_fail_backward_exhaustive(false, true, false);
3333 do_test_commitment_revoked_fail_backward_exhaustive(true, true, false);
3334 do_test_commitment_revoked_fail_backward_exhaustive(false, false, false);
3335 do_test_commitment_revoked_fail_backward_exhaustive(true, false, false);
3339 fn test_commitment_revoked_fail_backward_exhaustive_b() {
3340 do_test_commitment_revoked_fail_backward_exhaustive(false, true, true);
3341 do_test_commitment_revoked_fail_backward_exhaustive(true, true, true);
3342 do_test_commitment_revoked_fail_backward_exhaustive(false, false, true);
3343 do_test_commitment_revoked_fail_backward_exhaustive(true, false, true);
3347 fn fail_backward_pending_htlc_upon_channel_failure() {
3348 let chanmon_cfgs = create_chanmon_cfgs(2);
3349 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3350 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3351 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3352 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1_000_000, 500_000_000, InitFeatures::known(), InitFeatures::known());
3353 let logger = test_utils::TestLogger::new();
3355 // Alice -> Bob: Route a payment but without Bob sending revoke_and_ack.
3357 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1]);
3358 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3359 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();
3360 nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
3361 check_added_monitors!(nodes[0], 1);
3363 let payment_event = {
3364 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3365 assert_eq!(events.len(), 1);
3366 SendEvent::from_event(events.remove(0))
3368 assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
3369 assert_eq!(payment_event.msgs.len(), 1);
3372 // Alice -> Bob: Route another payment but now Alice waits for Bob's earlier revoke_and_ack.
3373 let (_, failed_payment_hash, failed_payment_secret) = get_payment_preimage_hash!(nodes[1]);
3375 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3376 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();
3377 nodes[0].node.send_payment(&route, failed_payment_hash, &Some(failed_payment_secret)).unwrap();
3378 check_added_monitors!(nodes[0], 0);
3380 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3383 // Alice <- Bob: Send a malformed update_add_htlc so Alice fails the channel.
3385 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[0]);
3387 let secp_ctx = Secp256k1::new();
3388 let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
3389 let current_height = nodes[1].node.best_block.read().unwrap().height() + 1;
3390 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
3391 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();
3392 let (onion_payloads, _amount_msat, cltv_expiry) = onion_utils::build_onion_payloads(&route.paths[0], 50_000, &Some(payment_secret), current_height).unwrap();
3393 let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route.paths[0], &session_priv).unwrap();
3394 let onion_routing_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
3396 // Send a 0-msat update_add_htlc to fail the channel.
3397 let update_add_htlc = msgs::UpdateAddHTLC {
3403 onion_routing_packet,
3405 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &update_add_htlc);
3408 // Check that Alice fails backward the pending HTLC from the second payment.
3409 expect_payment_failed!(nodes[0], failed_payment_hash, true);
3410 check_closed_broadcast!(nodes[0], true);
3411 check_added_monitors!(nodes[0], 1);
3415 fn test_htlc_ignore_latest_remote_commitment() {
3416 // Test that HTLC transactions spending the latest remote commitment transaction are simply
3417 // ignored if we cannot claim them. This originally tickled an invalid unwrap().
3418 let chanmon_cfgs = create_chanmon_cfgs(2);
3419 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3420 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3421 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3422 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3424 route_payment(&nodes[0], &[&nodes[1]], 10000000);
3425 nodes[0].node.force_close_channel(&nodes[0].node.list_channels()[0].channel_id).unwrap();
3426 connect_blocks(&nodes[0], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + 1);
3427 check_closed_broadcast!(nodes[0], true);
3428 check_added_monitors!(nodes[0], 1);
3430 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
3431 assert_eq!(node_txn.len(), 3);
3432 assert_eq!(node_txn[0], node_txn[1]);
3434 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3435 connect_block(&nodes[1], &Block { header, txdata: vec![node_txn[0].clone(), node_txn[1].clone()]});
3436 check_closed_broadcast!(nodes[1], true);
3437 check_added_monitors!(nodes[1], 1);
3439 // Duplicate the connect_block call since this may happen due to other listeners
3440 // registering new transactions
3441 header.prev_blockhash = header.block_hash();
3442 connect_block(&nodes[1], &Block { header, txdata: vec![node_txn[0].clone(), node_txn[2].clone()]});
3446 fn test_force_close_fail_back() {
3447 // Check which HTLCs are failed-backwards on channel force-closure
3448 let chanmon_cfgs = create_chanmon_cfgs(3);
3449 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3450 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3451 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3452 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3453 create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3454 let logger = test_utils::TestLogger::new();
3456 let (our_payment_preimage, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[2]);
3458 let mut payment_event = {
3459 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3460 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();
3461 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
3462 check_added_monitors!(nodes[0], 1);
3464 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3465 assert_eq!(events.len(), 1);
3466 SendEvent::from_event(events.remove(0))
3469 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
3470 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
3472 expect_pending_htlcs_forwardable!(nodes[1]);
3474 let mut events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3475 assert_eq!(events_2.len(), 1);
3476 payment_event = SendEvent::from_event(events_2.remove(0));
3477 assert_eq!(payment_event.msgs.len(), 1);
3479 check_added_monitors!(nodes[1], 1);
3480 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
3481 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg);
3482 check_added_monitors!(nodes[2], 1);
3483 let (_, _) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3485 // nodes[2] now has the latest commitment transaction, but hasn't revoked its previous
3486 // state or updated nodes[1]' state. Now force-close and broadcast that commitment/HTLC
3487 // transaction and ensure nodes[1] doesn't fail-backwards (this was originally a bug!).
3489 nodes[2].node.force_close_channel(&payment_event.commitment_msg.channel_id).unwrap();
3490 check_closed_broadcast!(nodes[2], true);
3491 check_added_monitors!(nodes[2], 1);
3493 let mut node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap();
3494 // Note that we don't bother broadcasting the HTLC-Success transaction here as we don't
3495 // have a use for it unless nodes[2] learns the preimage somehow, the funds will go
3496 // back to nodes[1] upon timeout otherwise.
3497 assert_eq!(node_txn.len(), 1);
3501 mine_transaction(&nodes[1], &tx);
3503 // Note no UpdateHTLCs event here from nodes[1] to nodes[0]!
3504 check_closed_broadcast!(nodes[1], true);
3505 check_added_monitors!(nodes[1], 1);
3507 // Now check that if we add the preimage to ChannelMonitor it broadcasts our HTLC-Success..
3509 let mut monitors = nodes[2].chain_monitor.chain_monitor.monitors.read().unwrap();
3510 monitors.get(&OutPoint{ txid: Txid::from_slice(&payment_event.commitment_msg.channel_id[..]).unwrap(), index: 0 }).unwrap()
3511 .provide_payment_preimage(&our_payment_hash, &our_payment_preimage, &node_cfgs[2].tx_broadcaster, &node_cfgs[2].fee_estimator, &&logger);
3513 mine_transaction(&nodes[2], &tx);
3514 let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap();
3515 assert_eq!(node_txn.len(), 1);
3516 assert_eq!(node_txn[0].input.len(), 1);
3517 assert_eq!(node_txn[0].input[0].previous_output.txid, tx.txid());
3518 assert_eq!(node_txn[0].lock_time, 0); // Must be an HTLC-Success
3519 assert_eq!(node_txn[0].input[0].witness.len(), 5); // Must be an HTLC-Success
3521 check_spends!(node_txn[0], tx);
3525 fn test_dup_events_on_peer_disconnect() {
3526 // Test that if we receive a duplicative update_fulfill_htlc message after a reconnect we do
3527 // not generate a corresponding duplicative PaymentSent event. This did not use to be the case
3528 // as we used to generate the event immediately upon receipt of the payment preimage in the
3529 // update_fulfill_htlc message.
3531 let chanmon_cfgs = create_chanmon_cfgs(2);
3532 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3533 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3534 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3535 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3537 let payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 1000000).0;
3539 assert!(nodes[1].node.claim_funds(payment_preimage));
3540 check_added_monitors!(nodes[1], 1);
3541 let claim_msgs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3542 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &claim_msgs.update_fulfill_htlcs[0]);
3543 expect_payment_sent!(nodes[0], payment_preimage);
3545 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3546 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3548 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (1, 0), (0, 0), (0, 0), (false, false));
3549 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
3553 fn test_simple_peer_disconnect() {
3554 // Test that we can reconnect when there are no lost messages
3555 let chanmon_cfgs = create_chanmon_cfgs(3);
3556 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3557 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3558 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3559 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3560 create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3562 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3563 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3564 reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3566 let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3567 let payment_hash_2 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3568 fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_hash_2);
3569 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_preimage_1);
3571 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3572 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3573 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3575 let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3576 let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3577 let payment_hash_5 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3578 let payment_hash_6 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3580 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3581 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3583 claim_payment_along_route(&nodes[0], &[&[&nodes[1], &nodes[2]]], true, payment_preimage_3);
3584 fail_payment_along_route(&nodes[0], &[&nodes[1], &nodes[2]], true, payment_hash_5);
3586 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (1, 0), (1, 0), (false, false));
3588 let events = nodes[0].node.get_and_clear_pending_events();
3589 assert_eq!(events.len(), 2);
3591 Event::PaymentSent { payment_preimage } => {
3592 assert_eq!(payment_preimage, payment_preimage_3);
3594 _ => panic!("Unexpected event"),
3597 Event::PaymentFailed { payment_hash, rejected_by_dest, .. } => {
3598 assert_eq!(payment_hash, payment_hash_5);
3599 assert!(rejected_by_dest);
3601 _ => panic!("Unexpected event"),
3605 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_preimage_4);
3606 fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_hash_6);
3609 fn do_test_drop_messages_peer_disconnect(messages_delivered: u8) {
3610 // Test that we can reconnect when in-flight HTLC updates get dropped
3611 let chanmon_cfgs = create_chanmon_cfgs(2);
3612 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3613 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3614 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3615 if messages_delivered == 0 {
3616 create_chan_between_nodes_with_value_a(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
3617 // nodes[1] doesn't receive the funding_locked message (it'll be re-sent on reconnect)
3619 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3622 let (payment_preimage_1, payment_hash_1, payment_secret_1) = get_payment_preimage_hash!(nodes[1]);
3624 let logger = test_utils::TestLogger::new();
3625 let payment_event = {
3626 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3627 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(),
3628 &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), Some(&nodes[0].node.list_usable_channels().iter().collect::<Vec<_>>()),
3629 &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
3630 nodes[0].node.send_payment(&route, payment_hash_1, &Some(payment_secret_1)).unwrap();
3631 check_added_monitors!(nodes[0], 1);
3633 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3634 assert_eq!(events.len(), 1);
3635 SendEvent::from_event(events.remove(0))
3637 assert_eq!(nodes[1].node.get_our_node_id(), payment_event.node_id);
3639 if messages_delivered < 2 {
3640 // Drop the payment_event messages, and let them get re-generated in reconnect_nodes!
3642 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
3643 if messages_delivered >= 3 {
3644 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
3645 check_added_monitors!(nodes[1], 1);
3646 let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3648 if messages_delivered >= 4 {
3649 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3650 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3651 check_added_monitors!(nodes[0], 1);
3653 if messages_delivered >= 5 {
3654 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_commitment_signed);
3655 let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3656 // No commitment_signed so get_event_msg's assert(len == 1) passes
3657 check_added_monitors!(nodes[0], 1);
3659 if messages_delivered >= 6 {
3660 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3661 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3662 check_added_monitors!(nodes[1], 1);
3669 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3670 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3671 if messages_delivered < 3 {
3672 // Even if the funding_locked messages get exchanged, as long as nothing further was
3673 // received on either side, both sides will need to resend them.
3674 reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 1), (0, 0), (0, 0), (0, 0), (false, false));
3675 } else if messages_delivered == 3 {
3676 // nodes[0] still wants its RAA + commitment_signed
3677 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (-1, 0), (0, 0), (0, 0), (0, 0), (true, false));
3678 } else if messages_delivered == 4 {
3679 // nodes[0] still wants its commitment_signed
3680 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (-1, 0), (0, 0), (0, 0), (0, 0), (false, false));
3681 } else if messages_delivered == 5 {
3682 // nodes[1] still wants its final RAA
3683 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, true));
3684 } else if messages_delivered == 6 {
3685 // Everything was delivered...
3686 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3689 let events_1 = nodes[1].node.get_and_clear_pending_events();
3690 assert_eq!(events_1.len(), 1);
3692 Event::PendingHTLCsForwardable { .. } => { },
3693 _ => panic!("Unexpected event"),
3696 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3697 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3698 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3700 nodes[1].node.process_pending_htlc_forwards();
3702 let events_2 = nodes[1].node.get_and_clear_pending_events();
3703 assert_eq!(events_2.len(), 1);
3705 Event::PaymentReceived { ref payment_hash, ref payment_preimage, ref payment_secret, amt, user_payment_id: _ } => {
3706 assert_eq!(payment_hash_1, *payment_hash);
3707 assert!(payment_preimage.is_none());
3708 assert_eq!(payment_secret_1, *payment_secret);
3709 assert_eq!(amt, 1000000);
3711 _ => panic!("Unexpected event"),
3714 nodes[1].node.claim_funds(payment_preimage_1);
3715 check_added_monitors!(nodes[1], 1);
3717 let events_3 = nodes[1].node.get_and_clear_pending_msg_events();
3718 assert_eq!(events_3.len(), 1);
3719 let (update_fulfill_htlc, commitment_signed) = match events_3[0] {
3720 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
3721 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3722 assert!(updates.update_add_htlcs.is_empty());
3723 assert!(updates.update_fail_htlcs.is_empty());
3724 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
3725 assert!(updates.update_fail_malformed_htlcs.is_empty());
3726 assert!(updates.update_fee.is_none());
3727 (updates.update_fulfill_htlcs[0].clone(), updates.commitment_signed.clone())
3729 _ => panic!("Unexpected event"),
3732 if messages_delivered >= 1 {
3733 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlc);
3735 let events_4 = nodes[0].node.get_and_clear_pending_events();
3736 assert_eq!(events_4.len(), 1);
3738 Event::PaymentSent { ref payment_preimage } => {
3739 assert_eq!(payment_preimage_1, *payment_preimage);
3741 _ => panic!("Unexpected event"),
3744 if messages_delivered >= 2 {
3745 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
3746 check_added_monitors!(nodes[0], 1);
3747 let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
3749 if messages_delivered >= 3 {
3750 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3751 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3752 check_added_monitors!(nodes[1], 1);
3754 if messages_delivered >= 4 {
3755 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed);
3756 let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3757 // No commitment_signed so get_event_msg's assert(len == 1) passes
3758 check_added_monitors!(nodes[1], 1);
3760 if messages_delivered >= 5 {
3761 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3762 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3763 check_added_monitors!(nodes[0], 1);
3770 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3771 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3772 if messages_delivered < 2 {
3773 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (1, 0), (0, 0), (0, 0), (false, false));
3774 if messages_delivered < 1 {
3775 let events_4 = nodes[0].node.get_and_clear_pending_events();
3776 assert_eq!(events_4.len(), 1);
3778 Event::PaymentSent { ref payment_preimage } => {
3779 assert_eq!(payment_preimage_1, *payment_preimage);
3781 _ => panic!("Unexpected event"),
3784 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3786 } else if messages_delivered == 2 {
3787 // nodes[0] still wants its RAA + commitment_signed
3788 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, -1), (0, 0), (0, 0), (0, 0), (false, true));
3789 } else if messages_delivered == 3 {
3790 // nodes[0] still wants its commitment_signed
3791 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, -1), (0, 0), (0, 0), (0, 0), (false, false));
3792 } else if messages_delivered == 4 {
3793 // nodes[1] still wants its final RAA
3794 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (true, false));
3795 } else if messages_delivered == 5 {
3796 // Everything was delivered...
3797 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3800 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3801 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3802 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3804 // Channel should still work fine...
3805 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3806 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(),
3807 &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), Some(&nodes[0].node.list_usable_channels().iter().collect::<Vec<_>>()),
3808 &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
3809 let payment_preimage_2 = send_along_route(&nodes[0], route, &[&nodes[1]], 1000000).0;
3810 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
3814 fn test_drop_messages_peer_disconnect_a() {
3815 do_test_drop_messages_peer_disconnect(0);
3816 do_test_drop_messages_peer_disconnect(1);
3817 do_test_drop_messages_peer_disconnect(2);
3818 do_test_drop_messages_peer_disconnect(3);
3822 fn test_drop_messages_peer_disconnect_b() {
3823 do_test_drop_messages_peer_disconnect(4);
3824 do_test_drop_messages_peer_disconnect(5);
3825 do_test_drop_messages_peer_disconnect(6);
3829 fn test_funding_peer_disconnect() {
3830 // Test that we can lock in our funding tx while disconnected
3831 let chanmon_cfgs = create_chanmon_cfgs(2);
3832 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3833 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3834 let persister: test_utils::TestPersister;
3835 let new_chain_monitor: test_utils::TestChainMonitor;
3836 let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
3837 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3838 let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
3840 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3841 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3843 confirm_transaction(&nodes[0], &tx);
3844 let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
3845 assert_eq!(events_1.len(), 1);
3847 MessageSendEvent::SendFundingLocked { ref node_id, msg: _ } => {
3848 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
3850 _ => panic!("Unexpected event"),
3853 reconnect_nodes(&nodes[0], &nodes[1], (false, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3855 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3856 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3858 confirm_transaction(&nodes[1], &tx);
3859 let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3860 assert_eq!(events_2.len(), 2);
3861 let funding_locked = match events_2[0] {
3862 MessageSendEvent::SendFundingLocked { ref node_id, ref msg } => {
3863 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3866 _ => panic!("Unexpected event"),
3868 let bs_announcement_sigs = match events_2[1] {
3869 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
3870 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3873 _ => panic!("Unexpected event"),
3876 reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3878 nodes[0].node.handle_funding_locked(&nodes[1].node.get_our_node_id(), &funding_locked);
3879 nodes[0].node.handle_announcement_signatures(&nodes[1].node.get_our_node_id(), &bs_announcement_sigs);
3880 let events_3 = nodes[0].node.get_and_clear_pending_msg_events();
3881 assert_eq!(events_3.len(), 2);
3882 let as_announcement_sigs = match events_3[0] {
3883 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
3884 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
3887 _ => panic!("Unexpected event"),
3889 let (as_announcement, as_update) = match events_3[1] {
3890 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
3891 (msg.clone(), update_msg.clone())
3893 _ => panic!("Unexpected event"),
3896 nodes[1].node.handle_announcement_signatures(&nodes[0].node.get_our_node_id(), &as_announcement_sigs);
3897 let events_4 = nodes[1].node.get_and_clear_pending_msg_events();
3898 assert_eq!(events_4.len(), 1);
3899 let (_, bs_update) = match events_4[0] {
3900 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
3901 (msg.clone(), update_msg.clone())
3903 _ => panic!("Unexpected event"),
3906 nodes[0].net_graph_msg_handler.handle_channel_announcement(&as_announcement).unwrap();
3907 nodes[0].net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
3908 nodes[0].net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
3910 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3911 let logger = test_utils::TestLogger::new();
3912 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();
3913 let (payment_preimage, _, _) = send_along_route(&nodes[0], route, &[&nodes[1]], 1000000);
3914 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage);
3916 // Check that after deserialization and reconnection we can still generate an identical
3917 // channel_announcement from the cached signatures.
3918 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3920 let nodes_0_serialized = nodes[0].node.encode();
3921 let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
3922 nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
3924 persister = test_utils::TestPersister::new();
3925 let keys_manager = &chanmon_cfgs[0].keys_manager;
3926 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);
3927 nodes[0].chain_monitor = &new_chain_monitor;
3928 let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
3929 let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
3930 &mut chan_0_monitor_read, keys_manager).unwrap();
3931 assert!(chan_0_monitor_read.is_empty());
3933 let mut nodes_0_read = &nodes_0_serialized[..];
3934 let (_, nodes_0_deserialized_tmp) = {
3935 let mut channel_monitors = HashMap::new();
3936 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
3937 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
3938 default_config: UserConfig::default(),
3940 fee_estimator: node_cfgs[0].fee_estimator,
3941 chain_monitor: nodes[0].chain_monitor,
3942 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
3943 logger: nodes[0].logger,
3947 nodes_0_deserialized = nodes_0_deserialized_tmp;
3948 assert!(nodes_0_read.is_empty());
3950 assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
3951 nodes[0].node = &nodes_0_deserialized;
3952 check_added_monitors!(nodes[0], 1);
3954 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3956 // as_announcement should be re-generated exactly by broadcast_node_announcement.
3957 nodes[0].node.broadcast_node_announcement([0, 0, 0], [0; 32], Vec::new());
3958 let msgs = nodes[0].node.get_and_clear_pending_msg_events();
3959 let mut found_announcement = false;
3960 for event in msgs.iter() {
3962 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, .. } => {
3963 if *msg == as_announcement { found_announcement = true; }
3965 MessageSendEvent::BroadcastNodeAnnouncement { .. } => {},
3966 _ => panic!("Unexpected event"),
3969 assert!(found_announcement);
3973 fn test_drop_messages_peer_disconnect_dual_htlc() {
3974 // Test that we can handle reconnecting when both sides of a channel have pending
3975 // commitment_updates when we disconnect.
3976 let chanmon_cfgs = create_chanmon_cfgs(2);
3977 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3978 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3979 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3980 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3981 let logger = test_utils::TestLogger::new();
3983 let (payment_preimage_1, _, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
3985 // Now try to send a second payment which will fail to send
3986 let (payment_preimage_2, payment_hash_2, payment_secret_2) = get_payment_preimage_hash!(nodes[1]);
3987 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3988 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();
3989 nodes[0].node.send_payment(&route, payment_hash_2, &Some(payment_secret_2)).unwrap();
3990 check_added_monitors!(nodes[0], 1);
3992 let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
3993 assert_eq!(events_1.len(), 1);
3995 MessageSendEvent::UpdateHTLCs { .. } => {},
3996 _ => panic!("Unexpected event"),
3999 assert!(nodes[1].node.claim_funds(payment_preimage_1));
4000 check_added_monitors!(nodes[1], 1);
4002 let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
4003 assert_eq!(events_2.len(), 1);
4005 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 } } => {
4006 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
4007 assert!(update_add_htlcs.is_empty());
4008 assert_eq!(update_fulfill_htlcs.len(), 1);
4009 assert!(update_fail_htlcs.is_empty());
4010 assert!(update_fail_malformed_htlcs.is_empty());
4011 assert!(update_fee.is_none());
4013 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlcs[0]);
4014 let events_3 = nodes[0].node.get_and_clear_pending_events();
4015 assert_eq!(events_3.len(), 1);
4017 Event::PaymentSent { ref payment_preimage } => {
4018 assert_eq!(*payment_preimage, payment_preimage_1);
4020 _ => panic!("Unexpected event"),
4023 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), commitment_signed);
4024 let _ = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
4025 // No commitment_signed so get_event_msg's assert(len == 1) passes
4026 check_added_monitors!(nodes[0], 1);
4028 _ => panic!("Unexpected event"),
4031 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
4032 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4034 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4035 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
4036 assert_eq!(reestablish_1.len(), 1);
4037 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4038 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
4039 assert_eq!(reestablish_2.len(), 1);
4041 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
4042 let as_resp = handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
4043 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
4044 let bs_resp = handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
4046 assert!(as_resp.0.is_none());
4047 assert!(bs_resp.0.is_none());
4049 assert!(bs_resp.1.is_none());
4050 assert!(bs_resp.2.is_none());
4052 assert!(as_resp.3 == RAACommitmentOrder::CommitmentFirst);
4054 assert_eq!(as_resp.2.as_ref().unwrap().update_add_htlcs.len(), 1);
4055 assert!(as_resp.2.as_ref().unwrap().update_fulfill_htlcs.is_empty());
4056 assert!(as_resp.2.as_ref().unwrap().update_fail_htlcs.is_empty());
4057 assert!(as_resp.2.as_ref().unwrap().update_fail_malformed_htlcs.is_empty());
4058 assert!(as_resp.2.as_ref().unwrap().update_fee.is_none());
4059 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &as_resp.2.as_ref().unwrap().update_add_htlcs[0]);
4060 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_resp.2.as_ref().unwrap().commitment_signed);
4061 let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
4062 // No commitment_signed so get_event_msg's assert(len == 1) passes
4063 check_added_monitors!(nodes[1], 1);
4065 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), as_resp.1.as_ref().unwrap());
4066 let bs_second_commitment_signed = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4067 assert!(bs_second_commitment_signed.update_add_htlcs.is_empty());
4068 assert!(bs_second_commitment_signed.update_fulfill_htlcs.is_empty());
4069 assert!(bs_second_commitment_signed.update_fail_htlcs.is_empty());
4070 assert!(bs_second_commitment_signed.update_fail_malformed_htlcs.is_empty());
4071 assert!(bs_second_commitment_signed.update_fee.is_none());
4072 check_added_monitors!(nodes[1], 1);
4074 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
4075 let as_commitment_signed = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
4076 assert!(as_commitment_signed.update_add_htlcs.is_empty());
4077 assert!(as_commitment_signed.update_fulfill_htlcs.is_empty());
4078 assert!(as_commitment_signed.update_fail_htlcs.is_empty());
4079 assert!(as_commitment_signed.update_fail_malformed_htlcs.is_empty());
4080 assert!(as_commitment_signed.update_fee.is_none());
4081 check_added_monitors!(nodes[0], 1);
4083 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_commitment_signed.commitment_signed);
4084 let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
4085 // No commitment_signed so get_event_msg's assert(len == 1) passes
4086 check_added_monitors!(nodes[0], 1);
4088 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed.commitment_signed);
4089 let bs_second_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
4090 // No commitment_signed so get_event_msg's assert(len == 1) passes
4091 check_added_monitors!(nodes[1], 1);
4093 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
4094 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4095 check_added_monitors!(nodes[1], 1);
4097 expect_pending_htlcs_forwardable!(nodes[1]);
4099 let events_5 = nodes[1].node.get_and_clear_pending_events();
4100 assert_eq!(events_5.len(), 1);
4102 Event::PaymentReceived { ref payment_hash, ref payment_preimage, ref payment_secret, amt: _, user_payment_id: _ } => {
4103 assert_eq!(payment_hash_2, *payment_hash);
4104 assert!(payment_preimage.is_none());
4105 assert_eq!(payment_secret_2, *payment_secret);
4107 _ => panic!("Unexpected event"),
4110 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke_and_ack);
4111 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4112 check_added_monitors!(nodes[0], 1);
4114 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
4117 fn do_test_htlc_timeout(send_partial_mpp: bool) {
4118 // If the user fails to claim/fail an HTLC within the HTLC CLTV timeout we fail it for them
4119 // to avoid our counterparty failing the channel.
4120 let chanmon_cfgs = create_chanmon_cfgs(2);
4121 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4122 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4123 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4125 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4126 let logger = test_utils::TestLogger::new();
4128 let our_payment_hash = if send_partial_mpp {
4129 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
4130 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();
4131 let (_, our_payment_hash, payment_secret) = get_payment_preimage_hash!(&nodes[1]);
4132 // Use the utility function send_payment_along_path to send the payment with MPP data which
4133 // indicates there are more HTLCs coming.
4134 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.
4135 nodes[0].node.send_payment_along_path(&route.paths[0], &our_payment_hash, &Some(payment_secret), 200000, cur_height).unwrap();
4136 check_added_monitors!(nodes[0], 1);
4137 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
4138 assert_eq!(events.len(), 1);
4139 // Now do the relevant commitment_signed/RAA dances along the path, noting that the final
4140 // hop should *not* yet generate any PaymentReceived event(s).
4141 pass_along_path(&nodes[0], &[&nodes[1]], 100000, our_payment_hash, payment_secret, events.drain(..).next().unwrap(), false);
4144 route_payment(&nodes[0], &[&nodes[1]], 100000).1
4147 let mut block = Block {
4148 header: BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
4151 connect_block(&nodes[0], &block);
4152 connect_block(&nodes[1], &block);
4153 let block_count = TEST_FINAL_CLTV + CHAN_CONFIRM_DEPTH + 2 - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS;
4154 for _ in CHAN_CONFIRM_DEPTH + 2..block_count {
4155 block.header.prev_blockhash = block.block_hash();
4156 connect_block(&nodes[0], &block);
4157 connect_block(&nodes[1], &block);
4160 expect_pending_htlcs_forwardable!(nodes[1]);
4162 check_added_monitors!(nodes[1], 1);
4163 let htlc_timeout_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4164 assert!(htlc_timeout_updates.update_add_htlcs.is_empty());
4165 assert_eq!(htlc_timeout_updates.update_fail_htlcs.len(), 1);
4166 assert!(htlc_timeout_updates.update_fail_malformed_htlcs.is_empty());
4167 assert!(htlc_timeout_updates.update_fee.is_none());
4169 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_timeout_updates.update_fail_htlcs[0]);
4170 commitment_signed_dance!(nodes[0], nodes[1], htlc_timeout_updates.commitment_signed, false);
4171 // 100_000 msat as u64, followed by the height at which we failed back above
4172 let mut expected_failure_data = byte_utils::be64_to_array(100_000).to_vec();
4173 expected_failure_data.extend_from_slice(&byte_utils::be32_to_array(block_count - 1));
4174 expect_payment_failed!(nodes[0], our_payment_hash, true, 0x4000 | 15, &expected_failure_data[..]);
4178 fn test_htlc_timeout() {
4179 do_test_htlc_timeout(true);
4180 do_test_htlc_timeout(false);
4183 fn do_test_holding_cell_htlc_add_timeouts(forwarded_htlc: bool) {
4184 // Tests that HTLCs in the holding cell are timed out after the requisite number of blocks.
4185 let chanmon_cfgs = create_chanmon_cfgs(3);
4186 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
4187 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
4188 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
4189 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4190 create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
4192 // Make sure all nodes are at the same starting height
4193 connect_blocks(&nodes[0], 2*CHAN_CONFIRM_DEPTH + 1 - nodes[0].best_block_info().1);
4194 connect_blocks(&nodes[1], 2*CHAN_CONFIRM_DEPTH + 1 - nodes[1].best_block_info().1);
4195 connect_blocks(&nodes[2], 2*CHAN_CONFIRM_DEPTH + 1 - nodes[2].best_block_info().1);
4197 let logger = test_utils::TestLogger::new();
4199 // Route a first payment to get the 1 -> 2 channel in awaiting_raa...
4200 let (_, first_payment_hash, first_payment_secret) = get_payment_preimage_hash!(nodes[2]);
4202 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
4203 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();
4204 nodes[1].node.send_payment(&route, first_payment_hash, &Some(first_payment_secret)).unwrap();
4206 assert_eq!(nodes[1].node.get_and_clear_pending_msg_events().len(), 1);
4207 check_added_monitors!(nodes[1], 1);
4209 // Now attempt to route a second payment, which should be placed in the holding cell
4210 let (_, second_payment_hash, second_payment_secret) = get_payment_preimage_hash!(nodes[2]);
4212 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
4213 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();
4214 nodes[0].node.send_payment(&route, second_payment_hash, &Some(first_payment_secret)).unwrap();
4215 check_added_monitors!(nodes[0], 1);
4216 let payment_event = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
4217 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
4218 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
4219 expect_pending_htlcs_forwardable!(nodes[1]);
4220 check_added_monitors!(nodes[1], 0);
4222 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
4223 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();
4224 nodes[1].node.send_payment(&route, second_payment_hash, &Some(second_payment_secret)).unwrap();
4225 check_added_monitors!(nodes[1], 0);
4228 connect_blocks(&nodes[1], TEST_FINAL_CLTV - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS);
4229 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4230 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
4231 connect_blocks(&nodes[1], 1);
4234 expect_pending_htlcs_forwardable!(nodes[1]);
4235 check_added_monitors!(nodes[1], 1);
4236 let fail_commit = nodes[1].node.get_and_clear_pending_msg_events();
4237 assert_eq!(fail_commit.len(), 1);
4238 match fail_commit[0] {
4239 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fail_htlcs, ref commitment_signed, .. }, .. } => {
4240 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
4241 commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, true, true);
4243 _ => unreachable!(),
4245 expect_payment_failed!(nodes[0], second_payment_hash, false);
4246 if let &MessageSendEvent::PaymentFailureNetworkUpdate { ref update } = &nodes[0].node.get_and_clear_pending_msg_events()[0] {
4248 &HTLCFailChannelUpdate::ChannelUpdateMessage { .. } => {},
4249 _ => panic!("Unexpected event"),
4252 panic!("Unexpected event");
4255 expect_payment_failed!(nodes[1], second_payment_hash, true);
4260 fn test_holding_cell_htlc_add_timeouts() {
4261 do_test_holding_cell_htlc_add_timeouts(false);
4262 do_test_holding_cell_htlc_add_timeouts(true);
4266 fn test_invalid_channel_announcement() {
4267 //Test BOLT 7 channel_announcement msg requirement for final node, gather data to build customed channel_announcement msgs
4268 let secp_ctx = Secp256k1::new();
4269 let chanmon_cfgs = create_chanmon_cfgs(2);
4270 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4271 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4272 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4274 let chan_announcement = create_chan_between_nodes(&nodes[0], &nodes[1], InitFeatures::known(), InitFeatures::known());
4276 let a_channel_lock = nodes[0].node.channel_state.lock().unwrap();
4277 let b_channel_lock = nodes[1].node.channel_state.lock().unwrap();
4278 let as_chan = a_channel_lock.by_id.get(&chan_announcement.3).unwrap();
4279 let bs_chan = b_channel_lock.by_id.get(&chan_announcement.3).unwrap();
4281 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 } );
4283 let as_bitcoin_key = as_chan.get_signer().inner.holder_channel_pubkeys.funding_pubkey;
4284 let bs_bitcoin_key = bs_chan.get_signer().inner.holder_channel_pubkeys.funding_pubkey;
4286 let as_network_key = nodes[0].node.get_our_node_id();
4287 let bs_network_key = nodes[1].node.get_our_node_id();
4289 let were_node_one = as_bitcoin_key.serialize()[..] < bs_bitcoin_key.serialize()[..];
4291 let mut chan_announcement;
4293 macro_rules! dummy_unsigned_msg {
4295 msgs::UnsignedChannelAnnouncement {
4296 features: ChannelFeatures::known(),
4297 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
4298 short_channel_id: as_chan.get_short_channel_id().unwrap(),
4299 node_id_1: if were_node_one { as_network_key } else { bs_network_key },
4300 node_id_2: if were_node_one { bs_network_key } else { as_network_key },
4301 bitcoin_key_1: if were_node_one { as_bitcoin_key } else { bs_bitcoin_key },
4302 bitcoin_key_2: if were_node_one { bs_bitcoin_key } else { as_bitcoin_key },
4303 excess_data: Vec::new(),
4308 macro_rules! sign_msg {
4309 ($unsigned_msg: expr) => {
4310 let msghash = Message::from_slice(&Sha256dHash::hash(&$unsigned_msg.encode()[..])[..]).unwrap();
4311 let as_bitcoin_sig = secp_ctx.sign(&msghash, &as_chan.get_signer().inner.funding_key);
4312 let bs_bitcoin_sig = secp_ctx.sign(&msghash, &bs_chan.get_signer().inner.funding_key);
4313 let as_node_sig = secp_ctx.sign(&msghash, &nodes[0].keys_manager.get_node_secret());
4314 let bs_node_sig = secp_ctx.sign(&msghash, &nodes[1].keys_manager.get_node_secret());
4315 chan_announcement = msgs::ChannelAnnouncement {
4316 node_signature_1 : if were_node_one { as_node_sig } else { bs_node_sig},
4317 node_signature_2 : if were_node_one { bs_node_sig } else { as_node_sig},
4318 bitcoin_signature_1: if were_node_one { as_bitcoin_sig } else { bs_bitcoin_sig },
4319 bitcoin_signature_2 : if were_node_one { bs_bitcoin_sig } else { as_bitcoin_sig },
4320 contents: $unsigned_msg
4325 let unsigned_msg = dummy_unsigned_msg!();
4326 sign_msg!(unsigned_msg);
4327 assert_eq!(nodes[0].net_graph_msg_handler.handle_channel_announcement(&chan_announcement).unwrap(), true);
4328 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 } );
4330 // Configured with Network::Testnet
4331 let mut unsigned_msg = dummy_unsigned_msg!();
4332 unsigned_msg.chain_hash = genesis_block(Network::Bitcoin).header.block_hash();
4333 sign_msg!(unsigned_msg);
4334 assert!(nodes[0].net_graph_msg_handler.handle_channel_announcement(&chan_announcement).is_err());
4336 let mut unsigned_msg = dummy_unsigned_msg!();
4337 unsigned_msg.chain_hash = BlockHash::hash(&[1,2,3,4,5,6,7,8,9]);
4338 sign_msg!(unsigned_msg);
4339 assert!(nodes[0].net_graph_msg_handler.handle_channel_announcement(&chan_announcement).is_err());
4343 fn test_no_txn_manager_serialize_deserialize() {
4344 let chanmon_cfgs = create_chanmon_cfgs(2);
4345 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4346 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4347 let logger: test_utils::TestLogger;
4348 let fee_estimator: test_utils::TestFeeEstimator;
4349 let persister: test_utils::TestPersister;
4350 let new_chain_monitor: test_utils::TestChainMonitor;
4351 let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4352 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4354 let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
4356 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4358 let nodes_0_serialized = nodes[0].node.encode();
4359 let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4360 nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
4362 logger = test_utils::TestLogger::new();
4363 fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
4364 persister = test_utils::TestPersister::new();
4365 let keys_manager = &chanmon_cfgs[0].keys_manager;
4366 new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator, &persister, keys_manager);
4367 nodes[0].chain_monitor = &new_chain_monitor;
4368 let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4369 let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
4370 &mut chan_0_monitor_read, keys_manager).unwrap();
4371 assert!(chan_0_monitor_read.is_empty());
4373 let mut nodes_0_read = &nodes_0_serialized[..];
4374 let config = UserConfig::default();
4375 let (_, nodes_0_deserialized_tmp) = {
4376 let mut channel_monitors = HashMap::new();
4377 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4378 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4379 default_config: config,
4381 fee_estimator: &fee_estimator,
4382 chain_monitor: nodes[0].chain_monitor,
4383 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4388 nodes_0_deserialized = nodes_0_deserialized_tmp;
4389 assert!(nodes_0_read.is_empty());
4391 assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4392 nodes[0].node = &nodes_0_deserialized;
4393 assert_eq!(nodes[0].node.list_channels().len(), 1);
4394 check_added_monitors!(nodes[0], 1);
4396 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4397 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
4398 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4399 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
4401 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
4402 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4403 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
4404 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4406 let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
4407 let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
4408 for node in nodes.iter() {
4409 assert!(node.net_graph_msg_handler.handle_channel_announcement(&announcement).unwrap());
4410 node.net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
4411 node.net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
4414 send_payment(&nodes[0], &[&nodes[1]], 1000000);
4418 fn test_dup_htlc_onchain_fails_on_reload() {
4419 // When a Channel is closed, any outbound HTLCs which were relayed through it are simply
4420 // dropped when the Channel is. From there, the ChannelManager relies on the ChannelMonitor
4421 // having a copy of the relevant fail-/claim-back data and processes the HTLC fail/claim when
4422 // the ChannelMonitor tells it to.
4424 // If, due to an on-chain event, an HTLC is failed/claimed, and then we serialize the
4425 // ChannelManager, we generally expect there not to be a duplicate HTLC fail/claim (eg via a
4426 // PaymentFailed event appearing). However, because we may not serialize the relevant
4427 // ChannelMonitor at the same time, this isn't strictly guaranteed. In order to provide this
4428 // consistency, the ChannelManager explicitly tracks pending-onchain-resolution outbound HTLCs
4429 // and de-duplicates ChannelMonitor events.
4431 // This tests that explicit tracking behavior.
4432 let chanmon_cfgs = create_chanmon_cfgs(2);
4433 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4434 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4435 let persister: test_utils::TestPersister;
4436 let new_chain_monitor: test_utils::TestChainMonitor;
4437 let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4438 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4440 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4442 // Route a payment, but force-close the channel before the HTLC fulfill message arrives at
4444 let (payment_preimage, _, _) = route_payment(&nodes[0], &[&nodes[1]], 10000000);
4445 nodes[0].node.force_close_channel(&nodes[0].node.list_channels()[0].channel_id).unwrap();
4446 check_closed_broadcast!(nodes[0], true);
4447 check_added_monitors!(nodes[0], 1);
4449 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
4450 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4452 // Connect blocks until the CLTV timeout is up so that we get an HTLC-Timeout transaction
4453 connect_blocks(&nodes[0], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + 1);
4454 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
4455 assert_eq!(node_txn.len(), 3);
4456 assert_eq!(node_txn[0], node_txn[1]);
4458 assert!(nodes[1].node.claim_funds(payment_preimage));
4459 check_added_monitors!(nodes[1], 1);
4461 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4462 connect_block(&nodes[1], &Block { header, txdata: vec![node_txn[1].clone(), node_txn[2].clone()]});
4463 check_closed_broadcast!(nodes[1], true);
4464 check_added_monitors!(nodes[1], 1);
4465 let claim_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
4467 header.prev_blockhash = nodes[0].best_block_hash();
4468 connect_block(&nodes[0], &Block { header, txdata: vec![node_txn[1].clone(), node_txn[2].clone()]});
4470 // Serialize out the ChannelMonitor before connecting the on-chain claim transactions. This is
4471 // fairly normal behavior as ChannelMonitor(s) are often not re-serialized when on-chain events
4472 // happen, unlike ChannelManager which tends to be re-serialized after any relevant event(s).
4473 let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4474 nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
4476 header.prev_blockhash = nodes[0].best_block_hash();
4477 let claim_block = Block { header, txdata: claim_txn};
4478 connect_block(&nodes[0], &claim_block);
4479 expect_payment_sent!(nodes[0], payment_preimage);
4481 // ChannelManagers generally get re-serialized after any relevant event(s). Since we just
4482 // connected a highly-relevant block, it likely gets serialized out now.
4483 let mut chan_manager_serialized = test_utils::TestVecWriter(Vec::new());
4484 nodes[0].node.write(&mut chan_manager_serialized).unwrap();
4486 // Now reload nodes[0]...
4487 persister = test_utils::TestPersister::new();
4488 let keys_manager = &chanmon_cfgs[0].keys_manager;
4489 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);
4490 nodes[0].chain_monitor = &new_chain_monitor;
4491 let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4492 let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
4493 &mut chan_0_monitor_read, keys_manager).unwrap();
4494 assert!(chan_0_monitor_read.is_empty());
4496 let (_, nodes_0_deserialized_tmp) = {
4497 let mut channel_monitors = HashMap::new();
4498 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4499 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>
4500 ::read(&mut std::io::Cursor::new(&chan_manager_serialized.0[..]), ChannelManagerReadArgs {
4501 default_config: Default::default(),
4503 fee_estimator: node_cfgs[0].fee_estimator,
4504 chain_monitor: nodes[0].chain_monitor,
4505 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4506 logger: nodes[0].logger,
4510 nodes_0_deserialized = nodes_0_deserialized_tmp;
4512 assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4513 check_added_monitors!(nodes[0], 1);
4514 nodes[0].node = &nodes_0_deserialized;
4516 // Note that if we re-connect the block which exposed nodes[0] to the payment preimage (but
4517 // which the current ChannelMonitor has not seen), the ChannelManager's de-duplication of
4518 // payment events should kick in, leaving us with no pending events here.
4519 let height = nodes[0].blocks.lock().unwrap().len() as u32 - 1;
4520 nodes[0].chain_monitor.chain_monitor.block_connected(&claim_block, height);
4521 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
4525 fn test_manager_serialize_deserialize_events() {
4526 // This test makes sure the events field in ChannelManager survives de/serialization
4527 let chanmon_cfgs = create_chanmon_cfgs(2);
4528 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4529 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4530 let fee_estimator: test_utils::TestFeeEstimator;
4531 let persister: test_utils::TestPersister;
4532 let logger: test_utils::TestLogger;
4533 let new_chain_monitor: test_utils::TestChainMonitor;
4534 let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4535 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4537 // Start creating a channel, but stop right before broadcasting the funding transaction
4538 let channel_value = 100000;
4539 let push_msat = 10001;
4540 let a_flags = InitFeatures::known();
4541 let b_flags = InitFeatures::known();
4542 let node_a = nodes.remove(0);
4543 let node_b = nodes.remove(0);
4544 node_a.node.create_channel(node_b.node.get_our_node_id(), channel_value, push_msat, 42, None).unwrap();
4545 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()));
4546 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()));
4548 let (temporary_channel_id, tx, funding_output) = create_funding_transaction(&node_a, channel_value, 42);
4550 node_a.node.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
4551 check_added_monitors!(node_a, 0);
4553 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()));
4555 let mut added_monitors = node_b.chain_monitor.added_monitors.lock().unwrap();
4556 assert_eq!(added_monitors.len(), 1);
4557 assert_eq!(added_monitors[0].0, funding_output);
4558 added_monitors.clear();
4561 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()));
4563 let mut added_monitors = node_a.chain_monitor.added_monitors.lock().unwrap();
4564 assert_eq!(added_monitors.len(), 1);
4565 assert_eq!(added_monitors[0].0, funding_output);
4566 added_monitors.clear();
4568 // Normally, this is where node_a would broadcast the funding transaction, but the test de/serializes first instead
4573 // Start the de/seriailization process mid-channel creation to check that the channel manager will hold onto events that are serialized
4574 let nodes_0_serialized = nodes[0].node.encode();
4575 let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4576 nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
4578 fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
4579 logger = test_utils::TestLogger::new();
4580 persister = test_utils::TestPersister::new();
4581 let keys_manager = &chanmon_cfgs[0].keys_manager;
4582 new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator, &persister, keys_manager);
4583 nodes[0].chain_monitor = &new_chain_monitor;
4584 let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4585 let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
4586 &mut chan_0_monitor_read, keys_manager).unwrap();
4587 assert!(chan_0_monitor_read.is_empty());
4589 let mut nodes_0_read = &nodes_0_serialized[..];
4590 let config = UserConfig::default();
4591 let (_, nodes_0_deserialized_tmp) = {
4592 let mut channel_monitors = HashMap::new();
4593 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4594 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4595 default_config: config,
4597 fee_estimator: &fee_estimator,
4598 chain_monitor: nodes[0].chain_monitor,
4599 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4604 nodes_0_deserialized = nodes_0_deserialized_tmp;
4605 assert!(nodes_0_read.is_empty());
4607 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4609 assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4610 nodes[0].node = &nodes_0_deserialized;
4612 // After deserializing, make sure the funding_transaction is still held by the channel manager
4613 let events_4 = nodes[0].node.get_and_clear_pending_events();
4614 assert_eq!(events_4.len(), 0);
4615 assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
4616 assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0].txid(), funding_output.txid);
4618 // Make sure the channel is functioning as though the de/serialization never happened
4619 assert_eq!(nodes[0].node.list_channels().len(), 1);
4620 check_added_monitors!(nodes[0], 1);
4622 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4623 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
4624 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4625 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
4627 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
4628 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4629 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
4630 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4632 let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
4633 let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
4634 for node in nodes.iter() {
4635 assert!(node.net_graph_msg_handler.handle_channel_announcement(&announcement).unwrap());
4636 node.net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
4637 node.net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
4640 send_payment(&nodes[0], &[&nodes[1]], 1000000);
4644 fn test_simple_manager_serialize_deserialize() {
4645 let chanmon_cfgs = create_chanmon_cfgs(2);
4646 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4647 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4648 let logger: test_utils::TestLogger;
4649 let fee_estimator: test_utils::TestFeeEstimator;
4650 let persister: test_utils::TestPersister;
4651 let new_chain_monitor: test_utils::TestChainMonitor;
4652 let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4653 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4654 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4656 let (our_payment_preimage, _, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
4657 let (_, our_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
4659 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4661 let nodes_0_serialized = nodes[0].node.encode();
4662 let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4663 nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
4665 logger = test_utils::TestLogger::new();
4666 fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
4667 persister = test_utils::TestPersister::new();
4668 let keys_manager = &chanmon_cfgs[0].keys_manager;
4669 new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator, &persister, keys_manager);
4670 nodes[0].chain_monitor = &new_chain_monitor;
4671 let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4672 let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
4673 &mut chan_0_monitor_read, keys_manager).unwrap();
4674 assert!(chan_0_monitor_read.is_empty());
4676 let mut nodes_0_read = &nodes_0_serialized[..];
4677 let (_, nodes_0_deserialized_tmp) = {
4678 let mut channel_monitors = HashMap::new();
4679 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4680 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4681 default_config: UserConfig::default(),
4683 fee_estimator: &fee_estimator,
4684 chain_monitor: nodes[0].chain_monitor,
4685 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4690 nodes_0_deserialized = nodes_0_deserialized_tmp;
4691 assert!(nodes_0_read.is_empty());
4693 assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4694 nodes[0].node = &nodes_0_deserialized;
4695 check_added_monitors!(nodes[0], 1);
4697 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
4699 fail_payment(&nodes[0], &[&nodes[1]], our_payment_hash);
4700 claim_payment(&nodes[0], &[&nodes[1]], our_payment_preimage);
4704 fn test_manager_serialize_deserialize_inconsistent_monitor() {
4705 // Test deserializing a ChannelManager with an out-of-date ChannelMonitor
4706 let chanmon_cfgs = create_chanmon_cfgs(4);
4707 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
4708 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
4709 let logger: test_utils::TestLogger;
4710 let fee_estimator: test_utils::TestFeeEstimator;
4711 let persister: test_utils::TestPersister;
4712 let new_chain_monitor: test_utils::TestChainMonitor;
4713 let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4714 let mut nodes = create_network(4, &node_cfgs, &node_chanmgrs);
4715 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4716 create_announced_chan_between_nodes(&nodes, 2, 0, InitFeatures::known(), InitFeatures::known());
4717 let (_, _, channel_id, funding_tx) = create_announced_chan_between_nodes(&nodes, 0, 3, InitFeatures::known(), InitFeatures::known());
4719 let mut node_0_stale_monitors_serialized = Vec::new();
4720 for monitor in nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter() {
4721 let mut writer = test_utils::TestVecWriter(Vec::new());
4722 monitor.1.write(&mut writer).unwrap();
4723 node_0_stale_monitors_serialized.push(writer.0);
4726 let (our_payment_preimage, _, _) = route_payment(&nodes[2], &[&nodes[0], &nodes[1]], 1000000);
4728 // Serialize the ChannelManager here, but the monitor we keep up-to-date
4729 let nodes_0_serialized = nodes[0].node.encode();
4731 route_payment(&nodes[0], &[&nodes[3]], 1000000);
4732 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4733 nodes[2].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4734 nodes[3].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4736 // Now the ChannelMonitor (which is now out-of-sync with ChannelManager for channel w/
4738 let mut node_0_monitors_serialized = Vec::new();
4739 for monitor in nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter() {
4740 let mut writer = test_utils::TestVecWriter(Vec::new());
4741 monitor.1.write(&mut writer).unwrap();
4742 node_0_monitors_serialized.push(writer.0);
4745 logger = test_utils::TestLogger::new();
4746 fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
4747 persister = test_utils::TestPersister::new();
4748 let keys_manager = &chanmon_cfgs[0].keys_manager;
4749 new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator, &persister, keys_manager);
4750 nodes[0].chain_monitor = &new_chain_monitor;
4753 let mut node_0_stale_monitors = Vec::new();
4754 for serialized in node_0_stale_monitors_serialized.iter() {
4755 let mut read = &serialized[..];
4756 let (_, monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(&mut read, keys_manager).unwrap();
4757 assert!(read.is_empty());
4758 node_0_stale_monitors.push(monitor);
4761 let mut node_0_monitors = Vec::new();
4762 for serialized in node_0_monitors_serialized.iter() {
4763 let mut read = &serialized[..];
4764 let (_, monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(&mut read, keys_manager).unwrap();
4765 assert!(read.is_empty());
4766 node_0_monitors.push(monitor);
4769 let mut nodes_0_read = &nodes_0_serialized[..];
4770 if let Err(msgs::DecodeError::InvalidValue) =
4771 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4772 default_config: UserConfig::default(),
4774 fee_estimator: &fee_estimator,
4775 chain_monitor: nodes[0].chain_monitor,
4776 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4778 channel_monitors: node_0_stale_monitors.iter_mut().map(|monitor| { (monitor.get_funding_txo().0, monitor) }).collect(),
4780 panic!("If the monitor(s) are stale, this indicates a bug and we should get an Err return");
4783 let mut nodes_0_read = &nodes_0_serialized[..];
4784 let (_, nodes_0_deserialized_tmp) =
4785 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4786 default_config: UserConfig::default(),
4788 fee_estimator: &fee_estimator,
4789 chain_monitor: nodes[0].chain_monitor,
4790 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4792 channel_monitors: node_0_monitors.iter_mut().map(|monitor| { (monitor.get_funding_txo().0, monitor) }).collect(),
4794 nodes_0_deserialized = nodes_0_deserialized_tmp;
4795 assert!(nodes_0_read.is_empty());
4797 { // Channel close should result in a commitment tx
4798 let txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4799 assert_eq!(txn.len(), 1);
4800 check_spends!(txn[0], funding_tx);
4801 assert_eq!(txn[0].input[0].previous_output.txid, funding_tx.txid());
4804 for monitor in node_0_monitors.drain(..) {
4805 assert!(nodes[0].chain_monitor.watch_channel(monitor.get_funding_txo().0, monitor).is_ok());
4806 check_added_monitors!(nodes[0], 1);
4808 nodes[0].node = &nodes_0_deserialized;
4810 // nodes[1] and nodes[2] have no lost state with nodes[0]...
4811 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
4812 reconnect_nodes(&nodes[0], &nodes[2], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
4813 //... and we can even still claim the payment!
4814 claim_payment(&nodes[2], &[&nodes[0], &nodes[1]], our_payment_preimage);
4816 nodes[3].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4817 let reestablish = get_event_msg!(nodes[3], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
4818 nodes[0].node.peer_connected(&nodes[3].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4819 nodes[0].node.handle_channel_reestablish(&nodes[3].node.get_our_node_id(), &reestablish);
4820 let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
4821 assert_eq!(msg_events.len(), 1);
4822 if let MessageSendEvent::HandleError { ref action, .. } = msg_events[0] {
4824 &ErrorAction::SendErrorMessage { ref msg } => {
4825 assert_eq!(msg.channel_id, channel_id);
4827 _ => panic!("Unexpected event!"),
4832 macro_rules! check_spendable_outputs {
4833 ($node: expr, $der_idx: expr, $keysinterface: expr, $chan_value: expr) => {
4835 let mut events = $node.chain_monitor.chain_monitor.get_and_clear_pending_events();
4836 let mut txn = Vec::new();
4837 let mut all_outputs = Vec::new();
4838 let secp_ctx = Secp256k1::new();
4839 for event in events.drain(..) {
4841 Event::SpendableOutputs { mut outputs } => {
4842 for outp in outputs.drain(..) {
4843 txn.push($keysinterface.backing.spend_spendable_outputs(&[&outp], Vec::new(), Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(), 253, &secp_ctx).unwrap());
4844 all_outputs.push(outp);
4847 _ => panic!("Unexpected event"),
4850 if all_outputs.len() > 1 {
4851 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) {
4861 fn test_claim_sizeable_push_msat() {
4862 // Incidentally test SpendableOutput event generation due to detection of to_local output on commitment tx
4863 let chanmon_cfgs = create_chanmon_cfgs(2);
4864 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4865 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4866 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4868 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 99000000, InitFeatures::known(), InitFeatures::known());
4869 nodes[1].node.force_close_channel(&chan.2).unwrap();
4870 check_closed_broadcast!(nodes[1], true);
4871 check_added_monitors!(nodes[1], 1);
4872 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4873 assert_eq!(node_txn.len(), 1);
4874 check_spends!(node_txn[0], chan.3);
4875 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
4877 mine_transaction(&nodes[1], &node_txn[0]);
4878 connect_blocks(&nodes[1], BREAKDOWN_TIMEOUT as u32 - 1);
4880 let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
4881 assert_eq!(spend_txn.len(), 1);
4882 assert_eq!(spend_txn[0].input.len(), 1);
4883 check_spends!(spend_txn[0], node_txn[0]);
4884 assert_eq!(spend_txn[0].input[0].sequence, BREAKDOWN_TIMEOUT as u32);
4888 fn test_claim_on_remote_sizeable_push_msat() {
4889 // Same test as previous, just test on remote commitment tx, as per_commitment_point registration changes following you're funder/fundee and
4890 // to_remote output is encumbered by a P2WPKH
4891 let chanmon_cfgs = create_chanmon_cfgs(2);
4892 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4893 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4894 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4896 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 99000000, InitFeatures::known(), InitFeatures::known());
4897 nodes[0].node.force_close_channel(&chan.2).unwrap();
4898 check_closed_broadcast!(nodes[0], true);
4899 check_added_monitors!(nodes[0], 1);
4901 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4902 assert_eq!(node_txn.len(), 1);
4903 check_spends!(node_txn[0], chan.3);
4904 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
4906 mine_transaction(&nodes[1], &node_txn[0]);
4907 check_closed_broadcast!(nodes[1], true);
4908 check_added_monitors!(nodes[1], 1);
4909 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4911 let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
4912 assert_eq!(spend_txn.len(), 1);
4913 check_spends!(spend_txn[0], node_txn[0]);
4917 fn test_claim_on_remote_revoked_sizeable_push_msat() {
4918 // Same test as previous, just test on remote revoked commitment tx, as per_commitment_point registration changes following you're funder/fundee and
4919 // to_remote output is encumbered by a P2WPKH
4921 let chanmon_cfgs = create_chanmon_cfgs(2);
4922 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4923 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4924 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4926 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 59000000, InitFeatures::known(), InitFeatures::known());
4927 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4928 let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan.2);
4929 assert_eq!(revoked_local_txn[0].input.len(), 1);
4930 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
4932 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
4933 mine_transaction(&nodes[1], &revoked_local_txn[0]);
4934 check_closed_broadcast!(nodes[1], true);
4935 check_added_monitors!(nodes[1], 1);
4937 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4938 mine_transaction(&nodes[1], &node_txn[0]);
4939 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4941 let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
4942 assert_eq!(spend_txn.len(), 3);
4943 check_spends!(spend_txn[0], revoked_local_txn[0]); // to_remote output on revoked remote commitment_tx
4944 check_spends!(spend_txn[1], node_txn[0]);
4945 check_spends!(spend_txn[2], revoked_local_txn[0], node_txn[0]); // Both outputs
4949 fn test_static_spendable_outputs_preimage_tx() {
4950 let chanmon_cfgs = create_chanmon_cfgs(2);
4951 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4952 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4953 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4955 // Create some initial channels
4956 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4958 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4960 let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
4961 assert_eq!(commitment_tx[0].input.len(), 1);
4962 assert_eq!(commitment_tx[0].input[0].previous_output.txid, chan_1.3.txid());
4964 // Settle A's commitment tx on B's chain
4965 assert!(nodes[1].node.claim_funds(payment_preimage));
4966 check_added_monitors!(nodes[1], 1);
4967 mine_transaction(&nodes[1], &commitment_tx[0]);
4968 check_added_monitors!(nodes[1], 1);
4969 let events = nodes[1].node.get_and_clear_pending_msg_events();
4971 MessageSendEvent::UpdateHTLCs { .. } => {},
4972 _ => panic!("Unexpected event"),
4975 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
4976 _ => panic!("Unexepected event"),
4979 // Check B's monitor was able to send back output descriptor event for preimage tx on A's commitment tx
4980 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap(); // ChannelManager : 2 (local commitment tx + HTLC-Success), ChannelMonitor: preimage tx
4981 assert_eq!(node_txn.len(), 3);
4982 check_spends!(node_txn[0], commitment_tx[0]);
4983 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
4984 check_spends!(node_txn[1], chan_1.3);
4985 check_spends!(node_txn[2], node_txn[1]);
4987 mine_transaction(&nodes[1], &node_txn[0]);
4988 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4990 let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
4991 assert_eq!(spend_txn.len(), 1);
4992 check_spends!(spend_txn[0], node_txn[0]);
4996 fn test_static_spendable_outputs_timeout_tx() {
4997 let chanmon_cfgs = create_chanmon_cfgs(2);
4998 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4999 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5000 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5002 // Create some initial channels
5003 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5005 // Rebalance the network a bit by relaying one payment through all the channels ...
5006 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
5008 let (_, our_payment_hash, _) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3_000_000);
5010 let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
5011 assert_eq!(commitment_tx[0].input.len(), 1);
5012 assert_eq!(commitment_tx[0].input[0].previous_output.txid, chan_1.3.txid());
5014 // Settle A's commitment tx on B' chain
5015 mine_transaction(&nodes[1], &commitment_tx[0]);
5016 check_added_monitors!(nodes[1], 1);
5017 let events = nodes[1].node.get_and_clear_pending_msg_events();
5019 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5020 _ => panic!("Unexpected event"),
5022 connect_blocks(&nodes[1], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
5024 // Check B's monitor was able to send back output descriptor event for timeout tx on A's commitment tx
5025 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
5026 assert_eq!(node_txn.len(), 2); // ChannelManager : 1 local commitent tx, ChannelMonitor: timeout tx
5027 check_spends!(node_txn[0], chan_1.3.clone());
5028 check_spends!(node_txn[1], commitment_tx[0].clone());
5029 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5031 mine_transaction(&nodes[1], &node_txn[1]);
5032 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
5033 expect_payment_failed!(nodes[1], our_payment_hash, true);
5035 let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
5036 assert_eq!(spend_txn.len(), 3); // SpendableOutput: remote_commitment_tx.to_remote, timeout_tx.output
5037 check_spends!(spend_txn[0], commitment_tx[0]);
5038 check_spends!(spend_txn[1], node_txn[1]);
5039 check_spends!(spend_txn[2], node_txn[1], commitment_tx[0]); // All outputs
5043 fn test_static_spendable_outputs_justice_tx_revoked_commitment_tx() {
5044 let chanmon_cfgs = create_chanmon_cfgs(2);
5045 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5046 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5047 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5049 // Create some initial channels
5050 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5052 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
5053 let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
5054 assert_eq!(revoked_local_txn[0].input.len(), 1);
5055 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
5057 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
5059 mine_transaction(&nodes[1], &revoked_local_txn[0]);
5060 check_closed_broadcast!(nodes[1], true);
5061 check_added_monitors!(nodes[1], 1);
5063 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5064 assert_eq!(node_txn.len(), 2);
5065 assert_eq!(node_txn[0].input.len(), 2);
5066 check_spends!(node_txn[0], revoked_local_txn[0]);
5068 mine_transaction(&nodes[1], &node_txn[0]);
5069 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
5071 let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
5072 assert_eq!(spend_txn.len(), 1);
5073 check_spends!(spend_txn[0], node_txn[0]);
5077 fn test_static_spendable_outputs_justice_tx_revoked_htlc_timeout_tx() {
5078 let mut chanmon_cfgs = create_chanmon_cfgs(2);
5079 chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
5080 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5081 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5082 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5084 // Create some initial channels
5085 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5087 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
5088 let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
5089 assert_eq!(revoked_local_txn[0].input.len(), 1);
5090 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
5092 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
5094 // A will generate HTLC-Timeout from revoked commitment tx
5095 mine_transaction(&nodes[0], &revoked_local_txn[0]);
5096 check_closed_broadcast!(nodes[0], true);
5097 check_added_monitors!(nodes[0], 1);
5098 connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
5100 let revoked_htlc_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5101 assert_eq!(revoked_htlc_txn.len(), 2);
5102 check_spends!(revoked_htlc_txn[0], chan_1.3);
5103 assert_eq!(revoked_htlc_txn[1].input.len(), 1);
5104 assert_eq!(revoked_htlc_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5105 check_spends!(revoked_htlc_txn[1], revoked_local_txn[0]);
5106 assert_ne!(revoked_htlc_txn[1].lock_time, 0); // HTLC-Timeout
5108 // B will generate justice tx from A's revoked commitment/HTLC tx
5109 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5110 connect_block(&nodes[1], &Block { header, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[1].clone()] });
5111 check_closed_broadcast!(nodes[1], true);
5112 check_added_monitors!(nodes[1], 1);
5114 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5115 assert_eq!(node_txn.len(), 3); // ChannelMonitor: bogus justice tx, justice tx on revoked outputs, ChannelManager: local commitment tx
5116 // The first transaction generated is bogus - it spends both outputs of revoked_local_txn[0]
5117 // including the one already spent by revoked_htlc_txn[1]. That's OK, we'll spend with valid
5118 // transactions next...
5119 assert_eq!(node_txn[0].input.len(), 3);
5120 check_spends!(node_txn[0], revoked_local_txn[0], revoked_htlc_txn[1]);
5122 assert_eq!(node_txn[1].input.len(), 2);
5123 check_spends!(node_txn[1], revoked_local_txn[0], revoked_htlc_txn[1]);
5124 if node_txn[1].input[1].previous_output.txid == revoked_htlc_txn[1].txid() {
5125 assert_ne!(node_txn[1].input[0].previous_output, revoked_htlc_txn[1].input[0].previous_output);
5127 assert_eq!(node_txn[1].input[0].previous_output.txid, revoked_htlc_txn[1].txid());
5128 assert_ne!(node_txn[1].input[1].previous_output, revoked_htlc_txn[1].input[0].previous_output);
5131 assert_eq!(node_txn[2].input.len(), 1);
5132 check_spends!(node_txn[2], chan_1.3);
5134 mine_transaction(&nodes[1], &node_txn[1]);
5135 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
5137 // Check B's ChannelMonitor was able to generate the right spendable output descriptor
5138 let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
5139 assert_eq!(spend_txn.len(), 1);
5140 assert_eq!(spend_txn[0].input.len(), 1);
5141 check_spends!(spend_txn[0], node_txn[1]);
5145 fn test_static_spendable_outputs_justice_tx_revoked_htlc_success_tx() {
5146 let mut chanmon_cfgs = create_chanmon_cfgs(2);
5147 chanmon_cfgs[1].keys_manager.disable_revocation_policy_check = true;
5148 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5149 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5150 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5152 // Create some initial channels
5153 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5155 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
5156 let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan_1.2);
5157 assert_eq!(revoked_local_txn[0].input.len(), 1);
5158 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
5160 // The to-be-revoked commitment tx should have one HTLC and one to_remote output
5161 assert_eq!(revoked_local_txn[0].output.len(), 2);
5163 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
5165 // B will generate HTLC-Success from revoked commitment tx
5166 mine_transaction(&nodes[1], &revoked_local_txn[0]);
5167 check_closed_broadcast!(nodes[1], true);
5168 check_added_monitors!(nodes[1], 1);
5169 let revoked_htlc_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5171 assert_eq!(revoked_htlc_txn.len(), 2);
5172 assert_eq!(revoked_htlc_txn[0].input.len(), 1);
5173 assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5174 check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
5176 // Check that the unspent (of two) outputs on revoked_local_txn[0] is a P2WPKH:
5177 let unspent_local_txn_output = revoked_htlc_txn[0].input[0].previous_output.vout as usize ^ 1;
5178 assert_eq!(revoked_local_txn[0].output[unspent_local_txn_output].script_pubkey.len(), 2 + 20); // P2WPKH
5180 // A will generate justice tx from B's revoked commitment/HTLC tx
5181 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5182 connect_block(&nodes[0], &Block { header, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[0].clone()] });
5183 check_closed_broadcast!(nodes[0], true);
5184 check_added_monitors!(nodes[0], 1);
5186 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5187 assert_eq!(node_txn.len(), 3); // ChannelMonitor: justice tx on revoked commitment, justice tx on revoked HTLC-success, ChannelManager: local commitment tx
5189 // The first transaction generated is bogus - it spends both outputs of revoked_local_txn[0]
5190 // including the one already spent by revoked_htlc_txn[0]. That's OK, we'll spend with valid
5191 // transactions next...
5192 assert_eq!(node_txn[0].input.len(), 2);
5193 check_spends!(node_txn[0], revoked_local_txn[0], revoked_htlc_txn[0]);
5194 if node_txn[0].input[1].previous_output.txid == revoked_htlc_txn[0].txid() {
5195 assert_eq!(node_txn[0].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
5197 assert_eq!(node_txn[0].input[0].previous_output.txid, revoked_htlc_txn[0].txid());
5198 assert_eq!(node_txn[0].input[1].previous_output, revoked_htlc_txn[0].input[0].previous_output);
5201 assert_eq!(node_txn[1].input.len(), 1);
5202 check_spends!(node_txn[1], revoked_htlc_txn[0]);
5204 check_spends!(node_txn[2], chan_1.3);
5206 mine_transaction(&nodes[0], &node_txn[1]);
5207 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
5209 // Note that nodes[0]'s tx_broadcaster is still locked, so if we get here the channelmonitor
5210 // didn't try to generate any new transactions.
5212 // Check A's ChannelMonitor was able to generate the right spendable output descriptor
5213 let spend_txn = check_spendable_outputs!(nodes[0], 1, node_cfgs[0].keys_manager, 100000);
5214 assert_eq!(spend_txn.len(), 3);
5215 assert_eq!(spend_txn[0].input.len(), 1);
5216 check_spends!(spend_txn[0], revoked_local_txn[0]); // spending to_remote output from revoked local tx
5217 assert_ne!(spend_txn[0].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
5218 check_spends!(spend_txn[1], node_txn[1]); // spending justice tx output on the htlc success tx
5219 check_spends!(spend_txn[2], revoked_local_txn[0], node_txn[1]); // Both outputs
5223 fn test_onchain_to_onchain_claim() {
5224 // Test that in case of channel closure, we detect the state of output and claim HTLC
5225 // on downstream peer's remote commitment tx.
5226 // First, have C claim an HTLC against its own latest commitment transaction.
5227 // Then, broadcast these to B, which should update the monitor downstream on the A<->B
5229 // Finally, check that B will claim the HTLC output if A's latest commitment transaction
5232 let chanmon_cfgs = create_chanmon_cfgs(3);
5233 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5234 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5235 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5237 // Create some initial channels
5238 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5239 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
5241 // Ensure all nodes are at the same height
5242 let node_max_height = nodes.iter().map(|node| node.blocks.lock().unwrap().len()).max().unwrap() as u32;
5243 connect_blocks(&nodes[0], node_max_height - nodes[0].best_block_info().1);
5244 connect_blocks(&nodes[1], node_max_height - nodes[1].best_block_info().1);
5245 connect_blocks(&nodes[2], node_max_height - nodes[2].best_block_info().1);
5247 // Rebalance the network a bit by relaying one payment through all the channels ...
5248 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
5249 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
5251 let (payment_preimage, _payment_hash, _payment_secret) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
5252 let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
5253 check_spends!(commitment_tx[0], chan_2.3);
5254 nodes[2].node.claim_funds(payment_preimage);
5255 check_added_monitors!(nodes[2], 1);
5256 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
5257 assert!(updates.update_add_htlcs.is_empty());
5258 assert!(updates.update_fail_htlcs.is_empty());
5259 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
5260 assert!(updates.update_fail_malformed_htlcs.is_empty());
5262 mine_transaction(&nodes[2], &commitment_tx[0]);
5263 check_closed_broadcast!(nodes[2], true);
5264 check_added_monitors!(nodes[2], 1);
5266 let c_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 2 (commitment tx, HTLC-Success tx), ChannelMonitor : 1 (HTLC-Success tx)
5267 assert_eq!(c_txn.len(), 3);
5268 assert_eq!(c_txn[0], c_txn[2]);
5269 assert_eq!(commitment_tx[0], c_txn[1]);
5270 check_spends!(c_txn[1], chan_2.3);
5271 check_spends!(c_txn[2], c_txn[1]);
5272 assert_eq!(c_txn[1].input[0].witness.clone().last().unwrap().len(), 71);
5273 assert_eq!(c_txn[2].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5274 assert!(c_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
5275 assert_eq!(c_txn[0].lock_time, 0); // Success tx
5277 // 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
5278 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
5279 connect_block(&nodes[1], &Block { header, txdata: vec![c_txn[1].clone(), c_txn[2].clone()]});
5280 connect_blocks(&nodes[1], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
5282 let mut b_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5283 // ChannelMonitor: claim tx, ChannelManager: local commitment tx
5284 assert_eq!(b_txn.len(), 2);
5285 check_spends!(b_txn[0], chan_2.3); // B local commitment tx, issued by ChannelManager
5286 check_spends!(b_txn[1], c_txn[1]); // timeout tx on C remote commitment tx, issued by ChannelMonitor
5287 assert_eq!(b_txn[1].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5288 assert!(b_txn[1].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
5289 assert_ne!(b_txn[1].lock_time, 0); // Timeout tx
5292 check_added_monitors!(nodes[1], 1);
5293 let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
5294 assert_eq!(msg_events.len(), 3);
5295 check_added_monitors!(nodes[1], 1);
5296 match msg_events[0] {
5297 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5298 _ => panic!("Unexpected event"),
5300 match msg_events[1] {
5301 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { .. }, node_id: _ } => {},
5302 _ => panic!("Unexpected event"),
5304 match msg_events[2] {
5305 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, .. } } => {
5306 assert!(update_add_htlcs.is_empty());
5307 assert!(update_fail_htlcs.is_empty());
5308 assert_eq!(update_fulfill_htlcs.len(), 1);
5309 assert!(update_fail_malformed_htlcs.is_empty());
5310 assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
5312 _ => panic!("Unexpected event"),
5314 // Broadcast A's commitment tx on B's chain to see if we are able to claim inbound HTLC with our HTLC-Success tx
5315 let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
5316 mine_transaction(&nodes[1], &commitment_tx[0]);
5317 let b_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5318 // ChannelMonitor: HTLC-Success tx + HTLC-Timeout RBF Bump, ChannelManager: local commitment tx + HTLC-Success tx
5319 assert_eq!(b_txn.len(), 4);
5320 check_spends!(b_txn[2], chan_1.3);
5321 check_spends!(b_txn[3], b_txn[2]);
5322 let (htlc_success_claim, htlc_timeout_bumped) =
5323 if b_txn[0].input[0].previous_output.txid == commitment_tx[0].txid()
5324 { (&b_txn[0], &b_txn[1]) } else { (&b_txn[1], &b_txn[0]) };
5325 check_spends!(htlc_success_claim, commitment_tx[0]);
5326 assert_eq!(htlc_success_claim.input[0].witness.clone().last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5327 assert!(htlc_success_claim.output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
5328 assert_eq!(htlc_success_claim.lock_time, 0); // Success tx
5329 check_spends!(htlc_timeout_bumped, c_txn[1]); // timeout tx on C remote commitment tx, issued by ChannelMonitor
5330 assert_ne!(htlc_timeout_bumped.lock_time, 0); // Success tx
5332 check_closed_broadcast!(nodes[1], true);
5333 check_added_monitors!(nodes[1], 1);
5337 fn test_duplicate_payment_hash_one_failure_one_success() {
5338 // Topology : A --> B --> C --> D
5339 // We route 2 payments with same hash between B and C, one will be timeout, the other successfully claim
5340 // Note that because C will refuse to generate two payment secrets for the same payment hash,
5341 // we forward one of the payments onwards to D.
5342 let chanmon_cfgs = create_chanmon_cfgs(4);
5343 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
5344 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
5345 let mut nodes = create_network(4, &node_cfgs, &node_chanmgrs);
5347 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5348 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
5349 create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
5351 let node_max_height = nodes.iter().map(|node| node.blocks.lock().unwrap().len()).max().unwrap() as u32;
5352 connect_blocks(&nodes[0], node_max_height - nodes[0].best_block_info().1);
5353 connect_blocks(&nodes[1], node_max_height - nodes[1].best_block_info().1);
5354 connect_blocks(&nodes[2], node_max_height - nodes[2].best_block_info().1);
5355 connect_blocks(&nodes[3], node_max_height - nodes[3].best_block_info().1);
5357 let (our_payment_preimage, duplicate_payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 900000);
5359 let payment_secret = nodes[3].node.create_inbound_payment_for_hash(duplicate_payment_hash, None, 7200, 0).unwrap();
5360 // We reduce the final CLTV here by a somewhat arbitrary constant to keep it under the one-byte
5361 // script push size limit so that the below script length checks match
5362 // ACCEPTED_HTLC_SCRIPT_WEIGHT.
5363 let route = get_route(&nodes[0].node.get_our_node_id(), &nodes[0].net_graph_msg_handler.network_graph.read().unwrap(),
5364 &nodes[3].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 900000, TEST_FINAL_CLTV - 40, nodes[0].logger).unwrap();
5365 send_along_route_with_secret(&nodes[0], route, &[&[&nodes[1], &nodes[2], &nodes[3]]], 900000, duplicate_payment_hash, payment_secret);
5367 let commitment_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
5368 assert_eq!(commitment_txn[0].input.len(), 1);
5369 check_spends!(commitment_txn[0], chan_2.3);
5371 mine_transaction(&nodes[1], &commitment_txn[0]);
5372 check_closed_broadcast!(nodes[1], true);
5373 check_added_monitors!(nodes[1], 1);
5374 connect_blocks(&nodes[1], TEST_FINAL_CLTV - 40 + MIN_CLTV_EXPIRY_DELTA as u32 - 1); // Confirm blocks until the HTLC expires
5376 let htlc_timeout_tx;
5377 { // Extract one of the two HTLC-Timeout transaction
5378 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5379 // ChannelMonitor: timeout tx * 3, ChannelManager: local commitment tx
5380 assert_eq!(node_txn.len(), 4);
5381 check_spends!(node_txn[0], chan_2.3);
5383 check_spends!(node_txn[1], commitment_txn[0]);
5384 assert_eq!(node_txn[1].input.len(), 1);
5385 check_spends!(node_txn[2], commitment_txn[0]);
5386 assert_eq!(node_txn[2].input.len(), 1);
5387 assert_eq!(node_txn[1].input[0].previous_output, node_txn[2].input[0].previous_output);
5388 check_spends!(node_txn[3], commitment_txn[0]);
5389 assert_ne!(node_txn[1].input[0].previous_output, node_txn[3].input[0].previous_output);
5391 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5392 assert_eq!(node_txn[2].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5393 assert_eq!(node_txn[3].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5394 htlc_timeout_tx = node_txn[1].clone();
5397 nodes[2].node.claim_funds(our_payment_preimage);
5398 mine_transaction(&nodes[2], &commitment_txn[0]);
5399 check_added_monitors!(nodes[2], 2);
5400 let events = nodes[2].node.get_and_clear_pending_msg_events();
5402 MessageSendEvent::UpdateHTLCs { .. } => {},
5403 _ => panic!("Unexpected event"),
5406 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5407 _ => panic!("Unexepected event"),
5409 let htlc_success_txn: Vec<_> = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
5410 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)
5411 check_spends!(htlc_success_txn[0], commitment_txn[0]);
5412 check_spends!(htlc_success_txn[1], commitment_txn[0]);
5413 assert_eq!(htlc_success_txn[0].input.len(), 1);
5414 assert_eq!(htlc_success_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5415 assert_eq!(htlc_success_txn[1].input.len(), 1);
5416 assert_eq!(htlc_success_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5417 assert_ne!(htlc_success_txn[0].input[0].previous_output, htlc_success_txn[1].input[0].previous_output);
5418 assert_eq!(htlc_success_txn[2], commitment_txn[0]);
5419 assert_eq!(htlc_success_txn[3], htlc_success_txn[0]);
5420 assert_eq!(htlc_success_txn[4], htlc_success_txn[1]);
5421 assert_ne!(htlc_success_txn[0].input[0].previous_output, htlc_timeout_tx.input[0].previous_output);
5423 mine_transaction(&nodes[1], &htlc_timeout_tx);
5424 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
5425 expect_pending_htlcs_forwardable!(nodes[1]);
5426 let htlc_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5427 assert!(htlc_updates.update_add_htlcs.is_empty());
5428 assert_eq!(htlc_updates.update_fail_htlcs.len(), 1);
5429 let first_htlc_id = htlc_updates.update_fail_htlcs[0].htlc_id;
5430 assert!(htlc_updates.update_fulfill_htlcs.is_empty());
5431 assert!(htlc_updates.update_fail_malformed_htlcs.is_empty());
5432 check_added_monitors!(nodes[1], 1);
5434 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_updates.update_fail_htlcs[0]);
5435 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
5437 commitment_signed_dance!(nodes[0], nodes[1], &htlc_updates.commitment_signed, false, true);
5438 let events = nodes[0].node.get_and_clear_pending_msg_events();
5439 assert_eq!(events.len(), 1);
5441 MessageSendEvent::PaymentFailureNetworkUpdate { update: msgs::HTLCFailChannelUpdate::ChannelClosed { .. } } => {
5443 _ => { panic!("Unexpected event"); }
5446 expect_payment_failed!(nodes[0], duplicate_payment_hash, false);
5448 // Solve 2nd HTLC by broadcasting on B's chain HTLC-Success Tx from C
5449 mine_transaction(&nodes[1], &htlc_success_txn[0]);
5450 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5451 assert!(updates.update_add_htlcs.is_empty());
5452 assert!(updates.update_fail_htlcs.is_empty());
5453 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
5454 assert_ne!(updates.update_fulfill_htlcs[0].htlc_id, first_htlc_id);
5455 assert!(updates.update_fail_malformed_htlcs.is_empty());
5456 check_added_monitors!(nodes[1], 1);
5458 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
5459 commitment_signed_dance!(nodes[0], nodes[1], &updates.commitment_signed, false);
5461 let events = nodes[0].node.get_and_clear_pending_events();
5463 Event::PaymentSent { ref payment_preimage } => {
5464 assert_eq!(*payment_preimage, our_payment_preimage);
5466 _ => panic!("Unexpected event"),
5471 fn test_dynamic_spendable_outputs_local_htlc_success_tx() {
5472 let chanmon_cfgs = create_chanmon_cfgs(2);
5473 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5474 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5475 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5477 // Create some initial channels
5478 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5480 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000).0;
5481 let local_txn = get_local_commitment_txn!(nodes[1], chan_1.2);
5482 assert_eq!(local_txn.len(), 1);
5483 assert_eq!(local_txn[0].input.len(), 1);
5484 check_spends!(local_txn[0], chan_1.3);
5486 // Give B knowledge of preimage to be able to generate a local HTLC-Success Tx
5487 nodes[1].node.claim_funds(payment_preimage);
5488 check_added_monitors!(nodes[1], 1);
5489 mine_transaction(&nodes[1], &local_txn[0]);
5490 check_added_monitors!(nodes[1], 1);
5491 let events = nodes[1].node.get_and_clear_pending_msg_events();
5493 MessageSendEvent::UpdateHTLCs { .. } => {},
5494 _ => panic!("Unexpected event"),
5497 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5498 _ => panic!("Unexepected event"),
5501 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5502 assert_eq!(node_txn.len(), 3);
5503 assert_eq!(node_txn[0], node_txn[2]);
5504 assert_eq!(node_txn[1], local_txn[0]);
5505 assert_eq!(node_txn[0].input.len(), 1);
5506 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5507 check_spends!(node_txn[0], local_txn[0]);
5511 mine_transaction(&nodes[1], &node_tx);
5512 connect_blocks(&nodes[1], BREAKDOWN_TIMEOUT as u32 - 1);
5514 // Verify that B is able to spend its own HTLC-Success tx thanks to spendable output event given back by its ChannelMonitor
5515 let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
5516 assert_eq!(spend_txn.len(), 1);
5517 assert_eq!(spend_txn[0].input.len(), 1);
5518 check_spends!(spend_txn[0], node_tx);
5519 assert_eq!(spend_txn[0].input[0].sequence, BREAKDOWN_TIMEOUT as u32);
5522 fn do_test_fail_backwards_unrevoked_remote_announce(deliver_last_raa: bool, announce_latest: bool) {
5523 // Test that we fail backwards the full set of HTLCs we need to when remote broadcasts an
5524 // unrevoked commitment transaction.
5525 // This includes HTLCs which were below the dust threshold as well as HTLCs which were awaiting
5526 // a remote RAA before they could be failed backwards (and combinations thereof).
5527 // We also test duplicate-hash HTLCs by adding two nodes on each side of the target nodes which
5528 // use the same payment hashes.
5529 // Thus, we use a six-node network:
5534 // And test where C fails back to A/B when D announces its latest commitment transaction
5535 let chanmon_cfgs = create_chanmon_cfgs(6);
5536 let node_cfgs = create_node_cfgs(6, &chanmon_cfgs);
5537 let node_chanmgrs = create_node_chanmgrs(6, &node_cfgs, &[None, None, None, None, None, None]);
5538 let nodes = create_network(6, &node_cfgs, &node_chanmgrs);
5539 let logger = test_utils::TestLogger::new();
5541 create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known());
5542 create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
5543 let chan = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
5544 create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::known(), InitFeatures::known());
5545 create_announced_chan_between_nodes(&nodes, 3, 5, InitFeatures::known(), InitFeatures::known());
5547 // Rebalance and check output sanity...
5548 send_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 500000);
5549 send_payment(&nodes[1], &[&nodes[2], &nodes[3], &nodes[5]], 500000);
5550 assert_eq!(get_local_commitment_txn!(nodes[3], chan.2)[0].output.len(), 2);
5552 let ds_dust_limit = nodes[3].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().holder_dust_limit_satoshis;
5554 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
5556 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
5557 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
5558 let our_node_id = &nodes[1].node.get_our_node_id();
5559 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();
5561 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
5563 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
5565 let (_, payment_hash_3, _) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
5567 let (_, payment_hash_4, _) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
5568 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();
5570 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());
5572 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());
5575 let (_, payment_hash_5, _) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
5577 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();
5578 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
5581 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
5583 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();
5584 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());
5586 // Double-check that six of the new HTLC were added
5587 // We now have six HTLCs pending over the dust limit and six HTLCs under the dust limit (ie,
5588 // with to_local and to_remote outputs, 8 outputs and 6 HTLCs not included).
5589 assert_eq!(get_local_commitment_txn!(nodes[3], chan.2).len(), 1);
5590 assert_eq!(get_local_commitment_txn!(nodes[3], chan.2)[0].output.len(), 8);
5592 // Now fail back three of the over-dust-limit and three of the under-dust-limit payments in one go.
5593 // Fail 0th below-dust, 4th above-dust, 8th above-dust, 10th below-dust HTLCs
5594 assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_1));
5595 assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_3));
5596 assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_5));
5597 assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_6));
5598 check_added_monitors!(nodes[4], 0);
5599 expect_pending_htlcs_forwardable!(nodes[4]);
5600 check_added_monitors!(nodes[4], 1);
5602 let four_removes = get_htlc_update_msgs!(nodes[4], nodes[3].node.get_our_node_id());
5603 nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[0]);
5604 nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[1]);
5605 nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[2]);
5606 nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[3]);
5607 commitment_signed_dance!(nodes[3], nodes[4], four_removes.commitment_signed, false);
5609 // Fail 3rd below-dust and 7th above-dust HTLCs
5610 assert!(nodes[5].node.fail_htlc_backwards(&payment_hash_2));
5611 assert!(nodes[5].node.fail_htlc_backwards(&payment_hash_4));
5612 check_added_monitors!(nodes[5], 0);
5613 expect_pending_htlcs_forwardable!(nodes[5]);
5614 check_added_monitors!(nodes[5], 1);
5616 let two_removes = get_htlc_update_msgs!(nodes[5], nodes[3].node.get_our_node_id());
5617 nodes[3].node.handle_update_fail_htlc(&nodes[5].node.get_our_node_id(), &two_removes.update_fail_htlcs[0]);
5618 nodes[3].node.handle_update_fail_htlc(&nodes[5].node.get_our_node_id(), &two_removes.update_fail_htlcs[1]);
5619 commitment_signed_dance!(nodes[3], nodes[5], two_removes.commitment_signed, false);
5621 let ds_prev_commitment_tx = get_local_commitment_txn!(nodes[3], chan.2);
5623 expect_pending_htlcs_forwardable!(nodes[3]);
5624 check_added_monitors!(nodes[3], 1);
5625 let six_removes = get_htlc_update_msgs!(nodes[3], nodes[2].node.get_our_node_id());
5626 nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[0]);
5627 nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[1]);
5628 nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[2]);
5629 nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[3]);
5630 nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[4]);
5631 nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[5]);
5632 if deliver_last_raa {
5633 commitment_signed_dance!(nodes[2], nodes[3], six_removes.commitment_signed, false);
5635 let _cs_last_raa = commitment_signed_dance!(nodes[2], nodes[3], six_removes.commitment_signed, false, true, false, true);
5638 // D's latest commitment transaction now contains 1st + 2nd + 9th HTLCs (implicitly, they're
5639 // below the dust limit) and the 5th + 6th + 11th HTLCs. It has failed back the 0th, 3rd, 4th,
5640 // 7th, 8th, and 10th, but as we haven't yet delivered the final RAA to C, the fails haven't
5641 // propagated back to A/B yet (and D has two unrevoked commitment transactions).
5643 // We now broadcast the latest commitment transaction, which *should* result in failures for
5644 // the 0th, 1st, 2nd, 3rd, 4th, 7th, 8th, 9th, and 10th HTLCs, ie all the below-dust HTLCs and
5645 // the non-broadcast above-dust HTLCs.
5647 // Alternatively, we may broadcast the previous commitment transaction, which should only
5648 // result in failures for the below-dust HTLCs, ie the 0th, 1st, 2nd, 3rd, 9th, and 10th HTLCs.
5649 let ds_last_commitment_tx = get_local_commitment_txn!(nodes[3], chan.2);
5651 if announce_latest {
5652 mine_transaction(&nodes[2], &ds_last_commitment_tx[0]);
5654 mine_transaction(&nodes[2], &ds_prev_commitment_tx[0]);
5656 connect_blocks(&nodes[2], ANTI_REORG_DELAY - 1);
5657 check_closed_broadcast!(nodes[2], true);
5658 expect_pending_htlcs_forwardable!(nodes[2]);
5659 check_added_monitors!(nodes[2], 3);
5661 let cs_msgs = nodes[2].node.get_and_clear_pending_msg_events();
5662 assert_eq!(cs_msgs.len(), 2);
5663 let mut a_done = false;
5664 for msg in cs_msgs {
5666 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
5667 // Both under-dust HTLCs and the one above-dust HTLC that we had already failed
5668 // should be failed-backwards here.
5669 let target = if *node_id == nodes[0].node.get_our_node_id() {
5670 // If announce_latest, expect 0th, 1st, 4th, 8th, 10th HTLCs, else only 0th, 1st, 10th below-dust HTLCs
5671 for htlc in &updates.update_fail_htlcs {
5672 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 });
5674 assert_eq!(updates.update_fail_htlcs.len(), if announce_latest { 5 } else { 3 });
5679 // If announce_latest, expect 2nd, 3rd, 7th, 9th HTLCs, else only 2nd, 3rd, 9th below-dust HTLCs
5680 for htlc in &updates.update_fail_htlcs {
5681 assert!(htlc.htlc_id == 1 || htlc.htlc_id == 2 || htlc.htlc_id == 5 || if announce_latest { htlc.htlc_id == 4 } else { false });
5683 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
5684 assert_eq!(updates.update_fail_htlcs.len(), if announce_latest { 4 } else { 3 });
5687 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
5688 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[1]);
5689 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[2]);
5690 if announce_latest {
5691 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[3]);
5692 if *node_id == nodes[0].node.get_our_node_id() {
5693 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[4]);
5696 commitment_signed_dance!(target, nodes[2], updates.commitment_signed, false, true);
5698 _ => panic!("Unexpected event"),
5702 let as_events = nodes[0].node.get_and_clear_pending_events();
5703 assert_eq!(as_events.len(), if announce_latest { 5 } else { 3 });
5704 let mut as_failds = HashSet::new();
5705 for event in as_events.iter() {
5706 if let &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, .. } = event {
5707 assert!(as_failds.insert(*payment_hash));
5708 if *payment_hash != payment_hash_2 {
5709 assert_eq!(*rejected_by_dest, deliver_last_raa);
5711 assert!(!rejected_by_dest);
5713 } else { panic!("Unexpected event"); }
5715 assert!(as_failds.contains(&payment_hash_1));
5716 assert!(as_failds.contains(&payment_hash_2));
5717 if announce_latest {
5718 assert!(as_failds.contains(&payment_hash_3));
5719 assert!(as_failds.contains(&payment_hash_5));
5721 assert!(as_failds.contains(&payment_hash_6));
5723 let bs_events = nodes[1].node.get_and_clear_pending_events();
5724 assert_eq!(bs_events.len(), if announce_latest { 4 } else { 3 });
5725 let mut bs_failds = HashSet::new();
5726 for event in bs_events.iter() {
5727 if let &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, .. } = event {
5728 assert!(bs_failds.insert(*payment_hash));
5729 if *payment_hash != payment_hash_1 && *payment_hash != payment_hash_5 {
5730 assert_eq!(*rejected_by_dest, deliver_last_raa);
5732 assert!(!rejected_by_dest);
5734 } else { panic!("Unexpected event"); }
5736 assert!(bs_failds.contains(&payment_hash_1));
5737 assert!(bs_failds.contains(&payment_hash_2));
5738 if announce_latest {
5739 assert!(bs_failds.contains(&payment_hash_4));
5741 assert!(bs_failds.contains(&payment_hash_5));
5743 // For each HTLC which was not failed-back by normal process (ie deliver_last_raa), we should
5744 // get a PaymentFailureNetworkUpdate. A should have gotten 4 HTLCs which were failed-back due
5745 // to unknown-preimage-etc, B should have gotten 2. Thus, in the
5746 // announce_latest && deliver_last_raa case, we should have 5-4=1 and 4-2=2
5747 // PaymentFailureNetworkUpdates.
5748 let as_msg_events = nodes[0].node.get_and_clear_pending_msg_events();
5749 assert_eq!(as_msg_events.len(), if deliver_last_raa { 1 } else if !announce_latest { 3 } else { 5 });
5750 let bs_msg_events = nodes[1].node.get_and_clear_pending_msg_events();
5751 assert_eq!(bs_msg_events.len(), if deliver_last_raa { 2 } else if !announce_latest { 3 } else { 4 });
5752 for event in as_msg_events.iter().chain(bs_msg_events.iter()) {
5754 &MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
5755 _ => panic!("Unexpected event"),
5761 fn test_fail_backwards_latest_remote_announce_a() {
5762 do_test_fail_backwards_unrevoked_remote_announce(false, true);
5766 fn test_fail_backwards_latest_remote_announce_b() {
5767 do_test_fail_backwards_unrevoked_remote_announce(true, true);
5771 fn test_fail_backwards_previous_remote_announce() {
5772 do_test_fail_backwards_unrevoked_remote_announce(false, false);
5773 // Note that true, true doesn't make sense as it implies we announce a revoked state, which is
5774 // tested for in test_commitment_revoked_fail_backward_exhaustive()
5778 fn test_dynamic_spendable_outputs_local_htlc_timeout_tx() {
5779 let chanmon_cfgs = create_chanmon_cfgs(2);
5780 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5781 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5782 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5784 // Create some initial channels
5785 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5787 let (_, our_payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000);
5788 let local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
5789 assert_eq!(local_txn[0].input.len(), 1);
5790 check_spends!(local_txn[0], chan_1.3);
5792 // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
5793 mine_transaction(&nodes[0], &local_txn[0]);
5794 check_closed_broadcast!(nodes[0], true);
5795 check_added_monitors!(nodes[0], 1);
5796 connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
5798 let htlc_timeout = {
5799 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5800 assert_eq!(node_txn.len(), 2);
5801 check_spends!(node_txn[0], chan_1.3);
5802 assert_eq!(node_txn[1].input.len(), 1);
5803 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5804 check_spends!(node_txn[1], local_txn[0]);
5808 mine_transaction(&nodes[0], &htlc_timeout);
5809 connect_blocks(&nodes[0], BREAKDOWN_TIMEOUT as u32 - 1);
5810 expect_payment_failed!(nodes[0], our_payment_hash, true);
5812 // Verify that A is able to spend its own HTLC-Timeout tx thanks to spendable output event given back by its ChannelMonitor
5813 let spend_txn = check_spendable_outputs!(nodes[0], 1, node_cfgs[0].keys_manager, 100000);
5814 assert_eq!(spend_txn.len(), 3);
5815 check_spends!(spend_txn[0], local_txn[0]);
5816 assert_eq!(spend_txn[1].input.len(), 1);
5817 check_spends!(spend_txn[1], htlc_timeout);
5818 assert_eq!(spend_txn[1].input[0].sequence, BREAKDOWN_TIMEOUT as u32);
5819 assert_eq!(spend_txn[2].input.len(), 2);
5820 check_spends!(spend_txn[2], local_txn[0], htlc_timeout);
5821 assert!(spend_txn[2].input[0].sequence == BREAKDOWN_TIMEOUT as u32 ||
5822 spend_txn[2].input[1].sequence == BREAKDOWN_TIMEOUT as u32);
5826 fn test_key_derivation_params() {
5827 // This test is a copy of test_dynamic_spendable_outputs_local_htlc_timeout_tx, with
5828 // a key manager rotation to test that key_derivation_params returned in DynamicOutputP2WSH
5829 // let us re-derive the channel key set to then derive a delayed_payment_key.
5831 let chanmon_cfgs = create_chanmon_cfgs(3);
5833 // We manually create the node configuration to backup the seed.
5834 let seed = [42; 32];
5835 let keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
5836 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);
5837 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 };
5838 let mut node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5839 node_cfgs.remove(0);
5840 node_cfgs.insert(0, node);
5842 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5843 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5845 // Create some initial channels
5846 // Create a dummy channel to advance index by one and thus test re-derivation correctness
5848 let chan_0 = create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known());
5849 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5850 assert_ne!(chan_0.3.output[0].script_pubkey, chan_1.3.output[0].script_pubkey);
5852 // Ensure all nodes are at the same height
5853 let node_max_height = nodes.iter().map(|node| node.blocks.lock().unwrap().len()).max().unwrap() as u32;
5854 connect_blocks(&nodes[0], node_max_height - nodes[0].best_block_info().1);
5855 connect_blocks(&nodes[1], node_max_height - nodes[1].best_block_info().1);
5856 connect_blocks(&nodes[2], node_max_height - nodes[2].best_block_info().1);
5858 let (_, our_payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000);
5859 let local_txn_0 = get_local_commitment_txn!(nodes[0], chan_0.2);
5860 let local_txn_1 = get_local_commitment_txn!(nodes[0], chan_1.2);
5861 assert_eq!(local_txn_1[0].input.len(), 1);
5862 check_spends!(local_txn_1[0], chan_1.3);
5864 // We check funding pubkey are unique
5865 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]));
5866 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]));
5867 if from_0_funding_key_0 == from_1_funding_key_0
5868 || from_0_funding_key_0 == from_1_funding_key_1
5869 || from_0_funding_key_1 == from_1_funding_key_0
5870 || from_0_funding_key_1 == from_1_funding_key_1 {
5871 panic!("Funding pubkeys aren't unique");
5874 // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
5875 mine_transaction(&nodes[0], &local_txn_1[0]);
5876 connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
5877 check_closed_broadcast!(nodes[0], true);
5878 check_added_monitors!(nodes[0], 1);
5880 let htlc_timeout = {
5881 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5882 assert_eq!(node_txn[1].input.len(), 1);
5883 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5884 check_spends!(node_txn[1], local_txn_1[0]);
5888 mine_transaction(&nodes[0], &htlc_timeout);
5889 connect_blocks(&nodes[0], BREAKDOWN_TIMEOUT as u32 - 1);
5890 expect_payment_failed!(nodes[0], our_payment_hash, true);
5892 // Verify that A is able to spend its own HTLC-Timeout tx thanks to spendable output event given back by its ChannelMonitor
5893 let new_keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
5894 let spend_txn = check_spendable_outputs!(nodes[0], 1, new_keys_manager, 100000);
5895 assert_eq!(spend_txn.len(), 3);
5896 check_spends!(spend_txn[0], local_txn_1[0]);
5897 assert_eq!(spend_txn[1].input.len(), 1);
5898 check_spends!(spend_txn[1], htlc_timeout);
5899 assert_eq!(spend_txn[1].input[0].sequence, BREAKDOWN_TIMEOUT as u32);
5900 assert_eq!(spend_txn[2].input.len(), 2);
5901 check_spends!(spend_txn[2], local_txn_1[0], htlc_timeout);
5902 assert!(spend_txn[2].input[0].sequence == BREAKDOWN_TIMEOUT as u32 ||
5903 spend_txn[2].input[1].sequence == BREAKDOWN_TIMEOUT as u32);
5907 fn test_static_output_closing_tx() {
5908 let chanmon_cfgs = create_chanmon_cfgs(2);
5909 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5910 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5911 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5913 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5915 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
5916 let closing_tx = close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true).2;
5918 mine_transaction(&nodes[0], &closing_tx);
5919 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
5921 let spend_txn = check_spendable_outputs!(nodes[0], 2, node_cfgs[0].keys_manager, 100000);
5922 assert_eq!(spend_txn.len(), 1);
5923 check_spends!(spend_txn[0], closing_tx);
5925 mine_transaction(&nodes[1], &closing_tx);
5926 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
5928 let spend_txn = check_spendable_outputs!(nodes[1], 2, node_cfgs[1].keys_manager, 100000);
5929 assert_eq!(spend_txn.len(), 1);
5930 check_spends!(spend_txn[0], closing_tx);
5933 fn do_htlc_claim_local_commitment_only(use_dust: bool) {
5934 let chanmon_cfgs = create_chanmon_cfgs(2);
5935 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5936 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5937 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5938 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5940 let (our_payment_preimage, _, _) = route_payment(&nodes[0], &[&nodes[1]], if use_dust { 50000 } else { 3000000 });
5942 // Claim the payment, but don't deliver A's commitment_signed, resulting in the HTLC only being
5943 // present in B's local commitment transaction, but none of A's commitment transactions.
5944 assert!(nodes[1].node.claim_funds(our_payment_preimage));
5945 check_added_monitors!(nodes[1], 1);
5947 let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5948 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fulfill_htlcs[0]);
5949 let events = nodes[0].node.get_and_clear_pending_events();
5950 assert_eq!(events.len(), 1);
5952 Event::PaymentSent { payment_preimage } => {
5953 assert_eq!(payment_preimage, our_payment_preimage);
5955 _ => panic!("Unexpected event"),
5958 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_updates.commitment_signed);
5959 check_added_monitors!(nodes[0], 1);
5960 let as_updates = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5961 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_updates.0);
5962 check_added_monitors!(nodes[1], 1);
5964 let starting_block = nodes[1].best_block_info();
5965 let mut block = Block {
5966 header: BlockHeader { version: 0x20000000, prev_blockhash: starting_block.0, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
5969 for _ in starting_block.1 + 1..TEST_FINAL_CLTV - CLTV_CLAIM_BUFFER + starting_block.1 + 2 {
5970 connect_block(&nodes[1], &block);
5971 block.header.prev_blockhash = block.block_hash();
5973 test_txn_broadcast(&nodes[1], &chan, None, if use_dust { HTLCType::NONE } else { HTLCType::SUCCESS });
5974 check_closed_broadcast!(nodes[1], true);
5975 check_added_monitors!(nodes[1], 1);
5978 fn do_htlc_claim_current_remote_commitment_only(use_dust: bool) {
5979 let chanmon_cfgs = create_chanmon_cfgs(2);
5980 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5981 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5982 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5983 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5984 let logger = test_utils::TestLogger::new();
5986 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1]);
5987 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
5988 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();
5989 nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
5990 check_added_monitors!(nodes[0], 1);
5992 let _as_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5994 // As far as A is concerned, the HTLC is now present only in the latest remote commitment
5995 // transaction, however it is not in A's latest local commitment, so we can just broadcast that
5996 // to "time out" the HTLC.
5998 let starting_block = nodes[1].best_block_info();
5999 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: starting_block.0, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6001 for _ in starting_block.1 + 1..TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + starting_block.1 + 2 {
6002 connect_block(&nodes[0], &Block { header, txdata: Vec::new()});
6003 header.prev_blockhash = header.block_hash();
6005 test_txn_broadcast(&nodes[0], &chan, None, HTLCType::NONE);
6006 check_closed_broadcast!(nodes[0], true);
6007 check_added_monitors!(nodes[0], 1);
6010 fn do_htlc_claim_previous_remote_commitment_only(use_dust: bool, check_revoke_no_close: bool) {
6011 let chanmon_cfgs = create_chanmon_cfgs(3);
6012 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
6013 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
6014 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
6015 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6017 // Fail the payment, but don't deliver A's final RAA, resulting in the HTLC only being present
6018 // in B's previous (unrevoked) commitment transaction, but none of A's commitment transactions.
6019 // Also optionally test that we *don't* fail the channel in case the commitment transaction was
6020 // actually revoked.
6021 let htlc_value = if use_dust { 50000 } else { 3000000 };
6022 let (_, our_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1]], htlc_value);
6023 assert!(nodes[1].node.fail_htlc_backwards(&our_payment_hash));
6024 expect_pending_htlcs_forwardable!(nodes[1]);
6025 check_added_monitors!(nodes[1], 1);
6027 let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6028 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fail_htlcs[0]);
6029 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_updates.commitment_signed);
6030 check_added_monitors!(nodes[0], 1);
6031 let as_updates = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6032 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_updates.0);
6033 check_added_monitors!(nodes[1], 1);
6034 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_updates.1);
6035 check_added_monitors!(nodes[1], 1);
6036 let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
6038 if check_revoke_no_close {
6039 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
6040 check_added_monitors!(nodes[0], 1);
6043 let starting_block = nodes[1].best_block_info();
6044 let mut block = Block {
6045 header: BlockHeader { version: 0x20000000, prev_blockhash: starting_block.0, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
6048 for _ in starting_block.1 + 1..TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + CHAN_CONFIRM_DEPTH + 2 {
6049 connect_block(&nodes[0], &block);
6050 block.header.prev_blockhash = block.block_hash();
6052 if !check_revoke_no_close {
6053 test_txn_broadcast(&nodes[0], &chan, None, HTLCType::NONE);
6054 check_closed_broadcast!(nodes[0], true);
6055 check_added_monitors!(nodes[0], 1);
6057 expect_payment_failed!(nodes[0], our_payment_hash, true);
6061 // Test that we close channels on-chain when broadcastable HTLCs reach their timeout window.
6062 // There are only a few cases to test here:
6063 // * its not really normative behavior, but we test that below-dust HTLCs "included" in
6064 // broadcastable commitment transactions result in channel closure,
6065 // * its included in an unrevoked-but-previous remote commitment transaction,
6066 // * its included in the latest remote or local commitment transactions.
6067 // We test each of the three possible commitment transactions individually and use both dust and
6069 // Note that we don't bother testing both outbound and inbound HTLC failures for each case, and we
6070 // assume they are handled the same across all six cases, as both outbound and inbound failures are
6071 // tested for at least one of the cases in other tests.
6073 fn htlc_claim_single_commitment_only_a() {
6074 do_htlc_claim_local_commitment_only(true);
6075 do_htlc_claim_local_commitment_only(false);
6077 do_htlc_claim_current_remote_commitment_only(true);
6078 do_htlc_claim_current_remote_commitment_only(false);
6082 fn htlc_claim_single_commitment_only_b() {
6083 do_htlc_claim_previous_remote_commitment_only(true, false);
6084 do_htlc_claim_previous_remote_commitment_only(false, false);
6085 do_htlc_claim_previous_remote_commitment_only(true, true);
6086 do_htlc_claim_previous_remote_commitment_only(false, true);
6091 fn bolt2_open_channel_sending_node_checks_part1() { //This test needs to be on its own as we are catching a panic
6092 let chanmon_cfgs = create_chanmon_cfgs(2);
6093 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6094 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6095 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6096 //Force duplicate channel ids
6097 for node in nodes.iter() {
6098 *node.keys_manager.override_channel_id_priv.lock().unwrap() = Some([0; 32]);
6101 // BOLT #2 spec: Sending node must ensure temporary_channel_id is unique from any other channel ID with the same peer.
6102 let channel_value_satoshis=10000;
6103 let push_msat=10001;
6104 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).unwrap();
6105 let node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
6106 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &node0_to_1_send_open_channel);
6108 //Create a second channel with a channel_id collision
6109 assert!(nodes[0].node.create_channel(nodes[0].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
6113 fn bolt2_open_channel_sending_node_checks_part2() {
6114 let chanmon_cfgs = create_chanmon_cfgs(2);
6115 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6116 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6117 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6119 // BOLT #2 spec: Sending node must set funding_satoshis to less than 2^24 satoshis
6120 let channel_value_satoshis=2^24;
6121 let push_msat=10001;
6122 assert!(nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
6124 // BOLT #2 spec: Sending node must set push_msat to equal or less than 1000 * funding_satoshis
6125 let channel_value_satoshis=10000;
6126 // Test when push_msat is equal to 1000 * funding_satoshis.
6127 let push_msat=1000*channel_value_satoshis+1;
6128 assert!(nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
6130 // BOLT #2 spec: Sending node must set set channel_reserve_satoshis greater than or equal to dust_limit_satoshis
6131 let channel_value_satoshis=10000;
6132 let push_msat=10001;
6133 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
6134 let node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
6135 assert!(node0_to_1_send_open_channel.channel_reserve_satoshis>=node0_to_1_send_open_channel.dust_limit_satoshis);
6137 // BOLT #2 spec: Sending node must set undefined bits in channel_flags to 0
6138 // 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
6139 assert!(node0_to_1_send_open_channel.channel_flags<=1);
6141 // 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.
6142 assert!(BREAKDOWN_TIMEOUT>0);
6143 assert!(node0_to_1_send_open_channel.to_self_delay==BREAKDOWN_TIMEOUT);
6145 // BOLT #2 spec: Sending node must ensure the chain_hash value identifies the chain it wishes to open the channel within.
6146 let chain_hash=genesis_block(Network::Testnet).header.block_hash();
6147 assert_eq!(node0_to_1_send_open_channel.chain_hash,chain_hash);
6149 // 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.
6150 assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.funding_pubkey.serialize()).is_ok());
6151 assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.revocation_basepoint.serialize()).is_ok());
6152 assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.htlc_basepoint.serialize()).is_ok());
6153 assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.payment_point.serialize()).is_ok());
6154 assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.delayed_payment_basepoint.serialize()).is_ok());
6158 fn bolt2_open_channel_sane_dust_limit() {
6159 let chanmon_cfgs = create_chanmon_cfgs(2);
6160 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6161 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6162 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6164 let channel_value_satoshis=1000000;
6165 let push_msat=10001;
6166 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).unwrap();
6167 let mut node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
6168 node0_to_1_send_open_channel.dust_limit_satoshis = 661;
6169 node0_to_1_send_open_channel.channel_reserve_satoshis = 100001;
6171 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &node0_to_1_send_open_channel);
6172 let events = nodes[1].node.get_and_clear_pending_msg_events();
6173 let err_msg = match events[0] {
6174 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id: _ } => {
6177 _ => panic!("Unexpected event"),
6179 assert_eq!(err_msg.data, "dust_limit_satoshis (661) is greater than the implementation limit (660)");
6182 // Test that if we fail to send an HTLC that is being freed from the holding cell, and the HTLC
6183 // originated from our node, its failure is surfaced to the user. We trigger this failure to
6184 // free the HTLC by increasing our fee while the HTLC is in the holding cell such that the HTLC
6185 // is no longer affordable once it's freed.
6187 fn test_fail_holding_cell_htlc_upon_free() {
6188 let chanmon_cfgs = create_chanmon_cfgs(2);
6189 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6190 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6191 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6192 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6193 let logger = test_utils::TestLogger::new();
6195 // First nodes[0] generates an update_fee, setting the channel's
6196 // pending_update_fee.
6197 nodes[0].node.update_fee(chan.2, get_feerate!(nodes[0], chan.2) + 20).unwrap();
6198 check_added_monitors!(nodes[0], 1);
6200 let events = nodes[0].node.get_and_clear_pending_msg_events();
6201 assert_eq!(events.len(), 1);
6202 let (update_msg, commitment_signed) = match events[0] {
6203 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
6204 (update_fee.as_ref(), commitment_signed)
6206 _ => panic!("Unexpected event"),
6209 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
6211 let mut chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6212 let channel_reserve = chan_stat.channel_reserve_msat;
6213 let feerate = get_feerate!(nodes[0], chan.2);
6215 // 2* and +1 HTLCs on the commit tx fee calculation for the fee spike reserve.
6216 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6217 let max_can_send = 5000000 - channel_reserve - 2*commit_tx_fee_msat(feerate, 1 + 1);
6218 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6219 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();
6221 // Send a payment which passes reserve checks but gets stuck in the holding cell.
6222 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6223 chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6224 assert_eq!(chan_stat.holding_cell_outbound_amount_msat, max_can_send);
6226 // Flush the pending fee update.
6227 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
6228 let (as_revoke_and_ack, _) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6229 check_added_monitors!(nodes[1], 1);
6230 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_revoke_and_ack);
6231 check_added_monitors!(nodes[0], 1);
6233 // Upon receipt of the RAA, there will be an attempt to resend the holding cell
6234 // HTLC, but now that the fee has been raised the payment will now fail, causing
6235 // us to surface its failure to the user.
6236 chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6237 assert_eq!(chan_stat.holding_cell_outbound_amount_msat, 0);
6238 nodes[0].logger.assert_log("lightning::ln::channel".to_string(), format!("Freeing holding cell with 1 HTLC updates in channel {}", hex::encode(chan.2)), 1);
6239 let failure_log = format!("Failed to send HTLC with payment_hash {} due to Cannot send value that would put our balance under counterparty-announced channel reserve value ({}) in channel {}",
6240 hex::encode(our_payment_hash.0), chan_stat.channel_reserve_msat, hex::encode(chan.2));
6241 nodes[0].logger.assert_log("lightning::ln::channel".to_string(), failure_log.to_string(), 1);
6243 // Check that the payment failed to be sent out.
6244 let events = nodes[0].node.get_and_clear_pending_events();
6245 assert_eq!(events.len(), 1);
6247 &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, ref error_code, ref error_data } => {
6248 assert_eq!(our_payment_hash.clone(), *payment_hash);
6249 assert_eq!(*rejected_by_dest, false);
6250 assert_eq!(*error_code, None);
6251 assert_eq!(*error_data, None);
6253 _ => panic!("Unexpected event"),
6257 // Test that if multiple HTLCs are released from the holding cell and one is
6258 // valid but the other is no longer valid upon release, the valid HTLC can be
6259 // successfully completed while the other one fails as expected.
6261 fn test_free_and_fail_holding_cell_htlcs() {
6262 let chanmon_cfgs = create_chanmon_cfgs(2);
6263 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6264 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6265 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6266 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6267 let logger = test_utils::TestLogger::new();
6269 // First nodes[0] generates an update_fee, setting the channel's
6270 // pending_update_fee.
6271 nodes[0].node.update_fee(chan.2, get_feerate!(nodes[0], chan.2) + 200).unwrap();
6272 check_added_monitors!(nodes[0], 1);
6274 let events = nodes[0].node.get_and_clear_pending_msg_events();
6275 assert_eq!(events.len(), 1);
6276 let (update_msg, commitment_signed) = match events[0] {
6277 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
6278 (update_fee.as_ref(), commitment_signed)
6280 _ => panic!("Unexpected event"),
6283 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
6285 let mut chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6286 let channel_reserve = chan_stat.channel_reserve_msat;
6287 let feerate = get_feerate!(nodes[0], chan.2);
6289 // 2* and +1 HTLCs on the commit tx fee calculation for the fee spike reserve.
6290 let (payment_preimage_1, payment_hash_1, payment_secret_1) = get_payment_preimage_hash!(nodes[1]);
6292 let (_, payment_hash_2, payment_secret_2) = get_payment_preimage_hash!(nodes[1]);
6293 let amt_2 = 5000000 - channel_reserve - 2*commit_tx_fee_msat(feerate, 2 + 1) - amt_1;
6294 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6295 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();
6296 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();
6298 // Send 2 payments which pass reserve checks but get stuck in the holding cell.
6299 nodes[0].node.send_payment(&route_1, payment_hash_1, &Some(payment_secret_1)).unwrap();
6300 chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6301 assert_eq!(chan_stat.holding_cell_outbound_amount_msat, amt_1);
6302 nodes[0].node.send_payment(&route_2, payment_hash_2, &Some(payment_secret_2)).unwrap();
6303 chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6304 assert_eq!(chan_stat.holding_cell_outbound_amount_msat, amt_1 + amt_2);
6306 // Flush the pending fee update.
6307 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
6308 let (revoke_and_ack, commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6309 check_added_monitors!(nodes[1], 1);
6310 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_and_ack);
6311 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
6312 check_added_monitors!(nodes[0], 2);
6314 // Upon receipt of the RAA, there will be an attempt to resend the holding cell HTLCs,
6315 // but now that the fee has been raised the second payment will now fail, causing us
6316 // to surface its failure to the user. The first payment should succeed.
6317 chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6318 assert_eq!(chan_stat.holding_cell_outbound_amount_msat, 0);
6319 nodes[0].logger.assert_log("lightning::ln::channel".to_string(), format!("Freeing holding cell with 2 HTLC updates in channel {}", hex::encode(chan.2)), 1);
6320 let failure_log = format!("Failed to send HTLC with payment_hash {} due to Cannot send value that would put our balance under counterparty-announced channel reserve value ({}) in channel {}",
6321 hex::encode(payment_hash_2.0), chan_stat.channel_reserve_msat, hex::encode(chan.2));
6322 nodes[0].logger.assert_log("lightning::ln::channel".to_string(), failure_log.to_string(), 1);
6324 // Check that the second payment failed to be sent out.
6325 let events = nodes[0].node.get_and_clear_pending_events();
6326 assert_eq!(events.len(), 1);
6328 &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, ref error_code, ref error_data } => {
6329 assert_eq!(payment_hash_2.clone(), *payment_hash);
6330 assert_eq!(*rejected_by_dest, false);
6331 assert_eq!(*error_code, None);
6332 assert_eq!(*error_data, None);
6334 _ => panic!("Unexpected event"),
6337 // Complete the first payment and the RAA from the fee update.
6338 let (payment_event, send_raa_event) = {
6339 let mut msgs = nodes[0].node.get_and_clear_pending_msg_events();
6340 assert_eq!(msgs.len(), 2);
6341 (SendEvent::from_event(msgs.remove(0)), msgs.remove(0))
6343 let raa = match send_raa_event {
6344 MessageSendEvent::SendRevokeAndACK { msg, .. } => msg,
6345 _ => panic!("Unexpected event"),
6347 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &raa);
6348 check_added_monitors!(nodes[1], 1);
6349 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6350 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6351 let events = nodes[1].node.get_and_clear_pending_events();
6352 assert_eq!(events.len(), 1);
6354 Event::PendingHTLCsForwardable { .. } => {},
6355 _ => panic!("Unexpected event"),
6357 nodes[1].node.process_pending_htlc_forwards();
6358 let events = nodes[1].node.get_and_clear_pending_events();
6359 assert_eq!(events.len(), 1);
6361 Event::PaymentReceived { .. } => {},
6362 _ => panic!("Unexpected event"),
6364 nodes[1].node.claim_funds(payment_preimage_1);
6365 check_added_monitors!(nodes[1], 1);
6366 let update_msgs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6367 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_msgs.update_fulfill_htlcs[0]);
6368 commitment_signed_dance!(nodes[0], nodes[1], update_msgs.commitment_signed, false, true);
6369 let events = nodes[0].node.get_and_clear_pending_events();
6370 assert_eq!(events.len(), 1);
6372 Event::PaymentSent { ref payment_preimage } => {
6373 assert_eq!(*payment_preimage, payment_preimage_1);
6375 _ => panic!("Unexpected event"),
6379 // Test that if we fail to forward an HTLC that is being freed from the holding cell that the
6380 // HTLC is failed backwards. We trigger this failure to forward the freed HTLC by increasing
6381 // our fee while the HTLC is in the holding cell such that the HTLC is no longer affordable
6384 fn test_fail_holding_cell_htlc_upon_free_multihop() {
6385 let chanmon_cfgs = create_chanmon_cfgs(3);
6386 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
6387 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
6388 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
6389 let chan_0_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6390 let chan_1_2 = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6391 let logger = test_utils::TestLogger::new();
6393 // First nodes[1] generates an update_fee, setting the channel's
6394 // pending_update_fee.
6395 nodes[1].node.update_fee(chan_1_2.2, get_feerate!(nodes[1], chan_1_2.2) + 20).unwrap();
6396 check_added_monitors!(nodes[1], 1);
6398 let events = nodes[1].node.get_and_clear_pending_msg_events();
6399 assert_eq!(events.len(), 1);
6400 let (update_msg, commitment_signed) = match events[0] {
6401 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
6402 (update_fee.as_ref(), commitment_signed)
6404 _ => panic!("Unexpected event"),
6407 nodes[2].node.handle_update_fee(&nodes[1].node.get_our_node_id(), update_msg.unwrap());
6409 let mut chan_stat = get_channel_value_stat!(nodes[0], chan_0_1.2);
6410 let channel_reserve = chan_stat.channel_reserve_msat;
6411 let feerate = get_feerate!(nodes[0], chan_0_1.2);
6413 // Send a payment which passes reserve checks but gets stuck in the holding cell.
6415 let total_routing_fee_msat = (nodes.len() - 2) as u64 * feemsat;
6416 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[2]);
6417 let max_can_send = 5000000 - channel_reserve - 2*commit_tx_fee_msat(feerate, 1 + 1) - total_routing_fee_msat;
6418 let payment_event = {
6419 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6420 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();
6421 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6422 check_added_monitors!(nodes[0], 1);
6424 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
6425 assert_eq!(events.len(), 1);
6427 SendEvent::from_event(events.remove(0))
6429 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6430 check_added_monitors!(nodes[1], 0);
6431 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6432 expect_pending_htlcs_forwardable!(nodes[1]);
6434 chan_stat = get_channel_value_stat!(nodes[1], chan_1_2.2);
6435 assert_eq!(chan_stat.holding_cell_outbound_amount_msat, max_can_send);
6437 // Flush the pending fee update.
6438 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), commitment_signed);
6439 let (raa, commitment_signed) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
6440 check_added_monitors!(nodes[2], 1);
6441 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &raa);
6442 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &commitment_signed);
6443 check_added_monitors!(nodes[1], 2);
6445 // A final RAA message is generated to finalize the fee update.
6446 let events = nodes[1].node.get_and_clear_pending_msg_events();
6447 assert_eq!(events.len(), 1);
6449 let raa_msg = match &events[0] {
6450 &MessageSendEvent::SendRevokeAndACK { ref msg, .. } => {
6453 _ => panic!("Unexpected event"),
6456 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &raa_msg);
6457 check_added_monitors!(nodes[2], 1);
6458 assert!(nodes[2].node.get_and_clear_pending_msg_events().is_empty());
6460 // nodes[1]'s ChannelManager will now signal that we have HTLC forwards to process.
6461 let process_htlc_forwards_event = nodes[1].node.get_and_clear_pending_events();
6462 assert_eq!(process_htlc_forwards_event.len(), 1);
6463 match &process_htlc_forwards_event[0] {
6464 &Event::PendingHTLCsForwardable { .. } => {},
6465 _ => panic!("Unexpected event"),
6468 // In response, we call ChannelManager's process_pending_htlc_forwards
6469 nodes[1].node.process_pending_htlc_forwards();
6470 check_added_monitors!(nodes[1], 1);
6472 // This causes the HTLC to be failed backwards.
6473 let fail_event = nodes[1].node.get_and_clear_pending_msg_events();
6474 assert_eq!(fail_event.len(), 1);
6475 let (fail_msg, commitment_signed) = match &fail_event[0] {
6476 &MessageSendEvent::UpdateHTLCs { ref updates, .. } => {
6477 assert_eq!(updates.update_add_htlcs.len(), 0);
6478 assert_eq!(updates.update_fulfill_htlcs.len(), 0);
6479 assert_eq!(updates.update_fail_malformed_htlcs.len(), 0);
6480 assert_eq!(updates.update_fail_htlcs.len(), 1);
6481 (updates.update_fail_htlcs[0].clone(), updates.commitment_signed.clone())
6483 _ => panic!("Unexpected event"),
6486 // Pass the failure messages back to nodes[0].
6487 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
6488 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
6490 // Complete the HTLC failure+removal process.
6491 let (raa, commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6492 check_added_monitors!(nodes[0], 1);
6493 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &raa);
6494 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commitment_signed);
6495 check_added_monitors!(nodes[1], 2);
6496 let final_raa_event = nodes[1].node.get_and_clear_pending_msg_events();
6497 assert_eq!(final_raa_event.len(), 1);
6498 let raa = match &final_raa_event[0] {
6499 &MessageSendEvent::SendRevokeAndACK { ref msg, .. } => msg.clone(),
6500 _ => panic!("Unexpected event"),
6502 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &raa);
6503 let fail_msg_event = nodes[0].node.get_and_clear_pending_msg_events();
6504 assert_eq!(fail_msg_event.len(), 1);
6505 match &fail_msg_event[0] {
6506 &MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
6507 _ => panic!("Unexpected event"),
6509 let failure_event = nodes[0].node.get_and_clear_pending_events();
6510 assert_eq!(failure_event.len(), 1);
6511 match &failure_event[0] {
6512 &Event::PaymentFailed { rejected_by_dest, .. } => {
6513 assert!(!rejected_by_dest);
6515 _ => panic!("Unexpected event"),
6517 check_added_monitors!(nodes[0], 1);
6520 // BOLT 2 Requirements for the Sender when constructing and sending an update_add_htlc message.
6521 // 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.
6522 //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.
6525 fn test_update_add_htlc_bolt2_sender_value_below_minimum_msat() {
6526 //BOLT2 Requirement: MUST NOT offer amount_msat below the receiving node's htlc_minimum_msat (same validation check catches both of these)
6527 let chanmon_cfgs = create_chanmon_cfgs(2);
6528 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6529 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6530 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6531 let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6533 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6534 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6535 let logger = test_utils::TestLogger::new();
6536 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();
6537 route.paths[0][0].fee_msat = 100;
6539 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
6540 assert!(regex::Regex::new(r"Cannot send less than their minimum HTLC value \(\d+\)").unwrap().is_match(err)));
6541 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6542 nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot send less than their minimum HTLC value".to_string(), 1);
6546 fn test_update_add_htlc_bolt2_sender_zero_value_msat() {
6547 //BOLT2 Requirement: MUST offer amount_msat greater than 0.
6548 let chanmon_cfgs = create_chanmon_cfgs(2);
6549 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6550 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6551 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6552 let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6553 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6555 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6556 let logger = test_utils::TestLogger::new();
6557 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();
6558 route.paths[0][0].fee_msat = 0;
6559 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
6560 assert_eq!(err, "Cannot send 0-msat HTLC"));
6562 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6563 nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot send 0-msat HTLC".to_string(), 1);
6567 fn test_update_add_htlc_bolt2_receiver_zero_value_msat() {
6568 //BOLT2 Requirement: MUST offer amount_msat greater than 0.
6569 let chanmon_cfgs = create_chanmon_cfgs(2);
6570 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6571 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6572 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6573 let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6575 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6576 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6577 let logger = test_utils::TestLogger::new();
6578 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();
6579 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6580 check_added_monitors!(nodes[0], 1);
6581 let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6582 updates.update_add_htlcs[0].amount_msat = 0;
6584 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6585 nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Remote side tried to send a 0-msat HTLC".to_string(), 1);
6586 check_closed_broadcast!(nodes[1], true).unwrap();
6587 check_added_monitors!(nodes[1], 1);
6591 fn test_update_add_htlc_bolt2_sender_cltv_expiry_too_high() {
6592 //BOLT 2 Requirement: MUST set cltv_expiry less than 500000000.
6593 //It is enforced when constructing a route.
6594 let chanmon_cfgs = create_chanmon_cfgs(2);
6595 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6596 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6597 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6598 let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 0, InitFeatures::known(), InitFeatures::known());
6599 let logger = test_utils::TestLogger::new();
6601 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6603 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6604 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();
6605 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::RouteError { ref err },
6606 assert_eq!(err, &"Channel CLTV overflowed?"));
6610 fn test_update_add_htlc_bolt2_sender_exceed_max_htlc_num_and_htlc_id_increment() {
6611 //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.
6612 //BOLT 2 Requirement: for the first HTLC it offers MUST set id to 0.
6613 //BOLT 2 Requirement: MUST increase the value of id by 1 for each successive offer.
6614 let chanmon_cfgs = create_chanmon_cfgs(2);
6615 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6616 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6617 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6618 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 0, InitFeatures::known(), InitFeatures::known());
6619 let max_accepted_htlcs = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().counterparty_max_accepted_htlcs as u64;
6621 let logger = test_utils::TestLogger::new();
6622 for i in 0..max_accepted_htlcs {
6623 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6624 let payment_event = {
6625 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6626 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();
6627 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6628 check_added_monitors!(nodes[0], 1);
6630 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
6631 assert_eq!(events.len(), 1);
6632 if let MessageSendEvent::UpdateHTLCs { node_id: _, updates: msgs::CommitmentUpdate{ update_add_htlcs: ref htlcs, .. }, } = events[0] {
6633 assert_eq!(htlcs[0].htlc_id, i);
6637 SendEvent::from_event(events.remove(0))
6639 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6640 check_added_monitors!(nodes[1], 0);
6641 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6643 expect_pending_htlcs_forwardable!(nodes[1]);
6644 expect_payment_received!(nodes[1], our_payment_hash, our_payment_secret, 100000);
6646 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6647 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6648 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();
6649 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
6650 assert!(regex::Regex::new(r"Cannot push more than their max accepted HTLCs \(\d+\)").unwrap().is_match(err)));
6652 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6653 nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot push more than their max accepted HTLCs".to_string(), 1);
6657 fn test_update_add_htlc_bolt2_sender_exceed_max_htlc_value_in_flight() {
6658 //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.
6659 let chanmon_cfgs = create_chanmon_cfgs(2);
6660 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6661 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6662 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6663 let channel_value = 100000;
6664 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, channel_value, 0, InitFeatures::known(), InitFeatures::known());
6665 let max_in_flight = get_channel_value_stat!(nodes[0], chan.2).counterparty_max_htlc_value_in_flight_msat;
6667 send_payment(&nodes[0], &vec!(&nodes[1])[..], max_in_flight);
6669 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6670 // Manually create a route over our max in flight (which our router normally automatically
6672 let route = Route { paths: vec![vec![RouteHop {
6673 pubkey: nodes[1].node.get_our_node_id(), node_features: NodeFeatures::known(), channel_features: ChannelFeatures::known(),
6674 short_channel_id: nodes[1].node.list_usable_channels()[0].short_channel_id.unwrap(),
6675 fee_msat: max_in_flight + 1, cltv_expiry_delta: TEST_FINAL_CLTV
6677 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
6678 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)));
6680 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6681 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);
6683 send_payment(&nodes[0], &[&nodes[1]], max_in_flight);
6686 // BOLT 2 Requirements for the Receiver when handling an update_add_htlc message.
6688 fn test_update_add_htlc_bolt2_receiver_check_amount_received_more_than_min() {
6689 //BOLT2 Requirement: receiving an amount_msat equal to 0, OR less than its own htlc_minimum_msat -> SHOULD fail the channel.
6690 let chanmon_cfgs = create_chanmon_cfgs(2);
6691 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6692 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6693 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6694 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6695 let htlc_minimum_msat: u64;
6697 let chan_lock = nodes[0].node.channel_state.lock().unwrap();
6698 let channel = chan_lock.by_id.get(&chan.2).unwrap();
6699 htlc_minimum_msat = channel.get_holder_htlc_minimum_msat();
6702 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6703 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6704 let logger = test_utils::TestLogger::new();
6705 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();
6706 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6707 check_added_monitors!(nodes[0], 1);
6708 let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6709 updates.update_add_htlcs[0].amount_msat = htlc_minimum_msat-1;
6710 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6711 assert!(nodes[1].node.list_channels().is_empty());
6712 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6713 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()));
6714 check_added_monitors!(nodes[1], 1);
6718 fn test_update_add_htlc_bolt2_receiver_sender_can_afford_amount_sent() {
6719 //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
6720 let chanmon_cfgs = create_chanmon_cfgs(2);
6721 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6722 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6723 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6724 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6725 let logger = test_utils::TestLogger::new();
6727 let chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6728 let channel_reserve = chan_stat.channel_reserve_msat;
6729 let feerate = get_feerate!(nodes[0], chan.2);
6730 // The 2* and +1 are for the fee spike reserve.
6731 let commit_tx_fee_outbound = 2 * commit_tx_fee_msat(feerate, 1 + 1);
6733 let max_can_send = 5000000 - channel_reserve - commit_tx_fee_outbound;
6734 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6735 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6736 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();
6737 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6738 check_added_monitors!(nodes[0], 1);
6739 let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6741 // Even though channel-initiator senders are required to respect the fee_spike_reserve,
6742 // at this time channel-initiatee receivers are not required to enforce that senders
6743 // respect the fee_spike_reserve.
6744 updates.update_add_htlcs[0].amount_msat = max_can_send + commit_tx_fee_outbound + 1;
6745 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6747 assert!(nodes[1].node.list_channels().is_empty());
6748 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6749 assert_eq!(err_msg.data, "Remote HTLC add would put them under remote reserve value");
6750 check_added_monitors!(nodes[1], 1);
6754 fn test_update_add_htlc_bolt2_receiver_check_max_htlc_limit() {
6755 //BOLT 2 Requirement: if a sending node adds more than its max_accepted_htlcs HTLCs to its local commitment transaction: SHOULD fail the channel
6756 //BOLT 2 Requirement: MUST allow multiple HTLCs with the same payment_hash.
6757 let chanmon_cfgs = create_chanmon_cfgs(2);
6758 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6759 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6760 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6761 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6762 let logger = test_utils::TestLogger::new();
6764 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6765 let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
6767 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6768 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();
6770 let cur_height = nodes[0].node.best_block.read().unwrap().height() + 1;
6771 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::signing_only(), &route.paths[0], &session_priv).unwrap();
6772 let (onion_payloads, _htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 3999999, &Some(our_payment_secret), cur_height).unwrap();
6773 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &our_payment_hash);
6775 let mut msg = msgs::UpdateAddHTLC {
6779 payment_hash: our_payment_hash,
6780 cltv_expiry: htlc_cltv,
6781 onion_routing_packet: onion_packet.clone(),
6784 for i in 0..super::channel::OUR_MAX_HTLCS {
6785 msg.htlc_id = i as u64;
6786 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
6788 msg.htlc_id = (super::channel::OUR_MAX_HTLCS) as u64;
6789 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
6791 assert!(nodes[1].node.list_channels().is_empty());
6792 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6793 assert!(regex::Regex::new(r"Remote tried to push more than our max accepted HTLCs \(\d+\)").unwrap().is_match(err_msg.data.as_str()));
6794 check_added_monitors!(nodes[1], 1);
6798 fn test_update_add_htlc_bolt2_receiver_check_max_in_flight_msat() {
6799 //OR adds more than its max_htlc_value_in_flight_msat worth of offered HTLCs to its local commitment transaction: SHOULD fail the channel
6800 let chanmon_cfgs = create_chanmon_cfgs(2);
6801 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6802 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6803 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6804 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
6805 let logger = test_utils::TestLogger::new();
6807 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6808 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6809 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();
6810 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6811 check_added_monitors!(nodes[0], 1);
6812 let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6813 updates.update_add_htlcs[0].amount_msat = get_channel_value_stat!(nodes[1], chan.2).counterparty_max_htlc_value_in_flight_msat + 1;
6814 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6816 assert!(nodes[1].node.list_channels().is_empty());
6817 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6818 assert!(regex::Regex::new("Remote HTLC add would put them over our max HTLC value").unwrap().is_match(err_msg.data.as_str()));
6819 check_added_monitors!(nodes[1], 1);
6823 fn test_update_add_htlc_bolt2_receiver_check_cltv_expiry() {
6824 //BOLT2 Requirement: if sending node sets cltv_expiry to greater or equal to 500000000: SHOULD fail the channel.
6825 let chanmon_cfgs = create_chanmon_cfgs(2);
6826 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6827 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6828 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6829 let logger = test_utils::TestLogger::new();
6831 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6832 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6833 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6834 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();
6835 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6836 check_added_monitors!(nodes[0], 1);
6837 let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6838 updates.update_add_htlcs[0].cltv_expiry = 500000000;
6839 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6841 assert!(nodes[1].node.list_channels().is_empty());
6842 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6843 assert_eq!(err_msg.data,"Remote provided CLTV expiry in seconds instead of block height");
6844 check_added_monitors!(nodes[1], 1);
6848 fn test_update_add_htlc_bolt2_receiver_check_repeated_id_ignore() {
6849 //BOLT 2 requirement: if the sender did not previously acknowledge the commitment of that HTLC: MUST ignore a repeated id value after a reconnection.
6850 // We test this by first testing that that repeated HTLCs pass commitment signature checks
6851 // after disconnect and that non-sequential htlc_ids result in a channel failure.
6852 let chanmon_cfgs = create_chanmon_cfgs(2);
6853 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6854 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6855 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6856 let logger = test_utils::TestLogger::new();
6858 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6859 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6860 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6861 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();
6862 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6863 check_added_monitors!(nodes[0], 1);
6864 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6865 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6867 //Disconnect and Reconnect
6868 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
6869 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
6870 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
6871 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
6872 assert_eq!(reestablish_1.len(), 1);
6873 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
6874 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
6875 assert_eq!(reestablish_2.len(), 1);
6876 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
6877 handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
6878 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
6879 handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
6882 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6883 assert_eq!(updates.commitment_signed.htlc_signatures.len(), 1);
6884 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &updates.commitment_signed);
6885 check_added_monitors!(nodes[1], 1);
6886 let _bs_responses = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6888 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6890 assert!(nodes[1].node.list_channels().is_empty());
6891 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6892 assert!(regex::Regex::new(r"Remote skipped HTLC ID \(skipped ID: \d+\)").unwrap().is_match(err_msg.data.as_str()));
6893 check_added_monitors!(nodes[1], 1);
6897 fn test_update_fulfill_htlc_bolt2_update_fulfill_htlc_before_commitment() {
6898 //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.
6900 let chanmon_cfgs = create_chanmon_cfgs(2);
6901 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6902 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6903 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6904 let logger = test_utils::TestLogger::new();
6905 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6906 let (our_payment_preimage, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6907 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6908 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();
6909 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6911 check_added_monitors!(nodes[0], 1);
6912 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6913 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6915 let update_msg = msgs::UpdateFulfillHTLC{
6918 payment_preimage: our_payment_preimage,
6921 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6923 assert!(nodes[0].node.list_channels().is_empty());
6924 let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6925 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()));
6926 check_added_monitors!(nodes[0], 1);
6930 fn test_update_fulfill_htlc_bolt2_update_fail_htlc_before_commitment() {
6931 //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.
6933 let chanmon_cfgs = create_chanmon_cfgs(2);
6934 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6935 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6936 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6937 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6938 let logger = test_utils::TestLogger::new();
6940 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6941 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6942 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();
6943 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6944 check_added_monitors!(nodes[0], 1);
6945 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6946 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6948 let update_msg = msgs::UpdateFailHTLC{
6951 reason: msgs::OnionErrorPacket { data: Vec::new()},
6954 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6956 assert!(nodes[0].node.list_channels().is_empty());
6957 let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6958 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()));
6959 check_added_monitors!(nodes[0], 1);
6963 fn test_update_fulfill_htlc_bolt2_update_fail_malformed_htlc_before_commitment() {
6964 //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.
6966 let chanmon_cfgs = create_chanmon_cfgs(2);
6967 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6968 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6969 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6970 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6971 let logger = test_utils::TestLogger::new();
6973 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6974 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6975 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();
6976 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6977 check_added_monitors!(nodes[0], 1);
6978 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6979 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6980 let update_msg = msgs::UpdateFailMalformedHTLC{
6983 sha256_of_onion: [1; 32],
6984 failure_code: 0x8000,
6987 nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6989 assert!(nodes[0].node.list_channels().is_empty());
6990 let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6991 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()));
6992 check_added_monitors!(nodes[0], 1);
6996 fn test_update_fulfill_htlc_bolt2_incorrect_htlc_id() {
6997 //BOLT 2 Requirement: A receiving node: if the id does not correspond to an HTLC in its current commitment transaction MUST fail the channel.
6999 let chanmon_cfgs = create_chanmon_cfgs(2);
7000 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7001 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7002 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7003 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7005 let our_payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 100000).0;
7007 nodes[1].node.claim_funds(our_payment_preimage);
7008 check_added_monitors!(nodes[1], 1);
7010 let events = nodes[1].node.get_and_clear_pending_msg_events();
7011 assert_eq!(events.len(), 1);
7012 let mut update_fulfill_msg: msgs::UpdateFulfillHTLC = {
7014 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, .. } } => {
7015 assert!(update_add_htlcs.is_empty());
7016 assert_eq!(update_fulfill_htlcs.len(), 1);
7017 assert!(update_fail_htlcs.is_empty());
7018 assert!(update_fail_malformed_htlcs.is_empty());
7019 assert!(update_fee.is_none());
7020 update_fulfill_htlcs[0].clone()
7022 _ => panic!("Unexpected event"),
7026 update_fulfill_msg.htlc_id = 1;
7028 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_msg);
7030 assert!(nodes[0].node.list_channels().is_empty());
7031 let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
7032 assert_eq!(err_msg.data, "Remote tried to fulfill/fail an HTLC we couldn't find");
7033 check_added_monitors!(nodes[0], 1);
7037 fn test_update_fulfill_htlc_bolt2_wrong_preimage() {
7038 //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.
7040 let chanmon_cfgs = create_chanmon_cfgs(2);
7041 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7042 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7043 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7044 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7046 let our_payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 100000).0;
7048 nodes[1].node.claim_funds(our_payment_preimage);
7049 check_added_monitors!(nodes[1], 1);
7051 let events = nodes[1].node.get_and_clear_pending_msg_events();
7052 assert_eq!(events.len(), 1);
7053 let mut update_fulfill_msg: msgs::UpdateFulfillHTLC = {
7055 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, .. } } => {
7056 assert!(update_add_htlcs.is_empty());
7057 assert_eq!(update_fulfill_htlcs.len(), 1);
7058 assert!(update_fail_htlcs.is_empty());
7059 assert!(update_fail_malformed_htlcs.is_empty());
7060 assert!(update_fee.is_none());
7061 update_fulfill_htlcs[0].clone()
7063 _ => panic!("Unexpected event"),
7067 update_fulfill_msg.payment_preimage = PaymentPreimage([1; 32]);
7069 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_msg);
7071 assert!(nodes[0].node.list_channels().is_empty());
7072 let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
7073 assert!(regex::Regex::new(r"Remote tried to fulfill HTLC \(\d+\) with an incorrect preimage").unwrap().is_match(err_msg.data.as_str()));
7074 check_added_monitors!(nodes[0], 1);
7078 fn test_update_fulfill_htlc_bolt2_missing_badonion_bit_for_malformed_htlc_message() {
7079 //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.
7081 let chanmon_cfgs = create_chanmon_cfgs(2);
7082 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7083 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7084 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7085 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7086 let logger = test_utils::TestLogger::new();
7088 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
7089 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
7090 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();
7091 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
7092 check_added_monitors!(nodes[0], 1);
7094 let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
7095 updates.update_add_htlcs[0].onion_routing_packet.version = 1; //Produce a malformed HTLC message
7097 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
7098 check_added_monitors!(nodes[1], 0);
7099 commitment_signed_dance!(nodes[1], nodes[0], updates.commitment_signed, false, true);
7101 let events = nodes[1].node.get_and_clear_pending_msg_events();
7103 let mut update_msg: msgs::UpdateFailMalformedHTLC = {
7105 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, .. } } => {
7106 assert!(update_add_htlcs.is_empty());
7107 assert!(update_fulfill_htlcs.is_empty());
7108 assert!(update_fail_htlcs.is_empty());
7109 assert_eq!(update_fail_malformed_htlcs.len(), 1);
7110 assert!(update_fee.is_none());
7111 update_fail_malformed_htlcs[0].clone()
7113 _ => panic!("Unexpected event"),
7116 update_msg.failure_code &= !0x8000;
7117 nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
7119 assert!(nodes[0].node.list_channels().is_empty());
7120 let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
7121 assert_eq!(err_msg.data, "Got update_fail_malformed_htlc with BADONION not set");
7122 check_added_monitors!(nodes[0], 1);
7126 fn test_update_fulfill_htlc_bolt2_after_malformed_htlc_message_must_forward_update_fail_htlc() {
7127 //BOLT 2 Requirement: a receiving node which has an outgoing HTLC canceled by update_fail_malformed_htlc:
7128 // * 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.
7130 let chanmon_cfgs = create_chanmon_cfgs(3);
7131 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7132 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
7133 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7134 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7135 create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7136 let logger = test_utils::TestLogger::new();
7138 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[2]);
7141 let mut payment_event = {
7142 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
7143 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();
7144 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
7145 check_added_monitors!(nodes[0], 1);
7146 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
7147 assert_eq!(events.len(), 1);
7148 SendEvent::from_event(events.remove(0))
7150 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
7151 check_added_monitors!(nodes[1], 0);
7152 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
7153 expect_pending_htlcs_forwardable!(nodes[1]);
7154 let mut events_2 = nodes[1].node.get_and_clear_pending_msg_events();
7155 assert_eq!(events_2.len(), 1);
7156 check_added_monitors!(nodes[1], 1);
7157 payment_event = SendEvent::from_event(events_2.remove(0));
7158 assert_eq!(payment_event.msgs.len(), 1);
7161 payment_event.msgs[0].onion_routing_packet.version = 1; //Produce a malformed HTLC message
7162 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
7163 check_added_monitors!(nodes[2], 0);
7164 commitment_signed_dance!(nodes[2], nodes[1], payment_event.commitment_msg, false, true);
7166 let events_3 = nodes[2].node.get_and_clear_pending_msg_events();
7167 assert_eq!(events_3.len(), 1);
7168 let update_msg : (msgs::UpdateFailMalformedHTLC, msgs::CommitmentSigned) = {
7170 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 } } => {
7171 assert!(update_add_htlcs.is_empty());
7172 assert!(update_fulfill_htlcs.is_empty());
7173 assert!(update_fail_htlcs.is_empty());
7174 assert_eq!(update_fail_malformed_htlcs.len(), 1);
7175 assert!(update_fee.is_none());
7176 (update_fail_malformed_htlcs[0].clone(), commitment_signed.clone())
7178 _ => panic!("Unexpected event"),
7182 nodes[1].node.handle_update_fail_malformed_htlc(&nodes[2].node.get_our_node_id(), &update_msg.0);
7184 check_added_monitors!(nodes[1], 0);
7185 commitment_signed_dance!(nodes[1], nodes[2], update_msg.1, false, true);
7186 expect_pending_htlcs_forwardable!(nodes[1]);
7187 let events_4 = nodes[1].node.get_and_clear_pending_msg_events();
7188 assert_eq!(events_4.len(), 1);
7190 //Confirm that handlinge the update_malformed_htlc message produces an update_fail_htlc message to be forwarded back along the route
7192 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, .. } } => {
7193 assert!(update_add_htlcs.is_empty());
7194 assert!(update_fulfill_htlcs.is_empty());
7195 assert_eq!(update_fail_htlcs.len(), 1);
7196 assert!(update_fail_malformed_htlcs.is_empty());
7197 assert!(update_fee.is_none());
7199 _ => panic!("Unexpected event"),
7202 check_added_monitors!(nodes[1], 1);
7205 fn do_test_failure_delay_dust_htlc_local_commitment(announce_latest: bool) {
7206 // Dust-HTLC failure updates must be delayed until failure-trigger tx (in this case local commitment) reach ANTI_REORG_DELAY
7207 // 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
7208 // HTLC could have been removed from lastest local commitment tx but still valid until we get remote RAA
7210 let mut chanmon_cfgs = create_chanmon_cfgs(2);
7211 chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
7212 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7213 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7214 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7215 let chan =create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7217 let bs_dust_limit = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().holder_dust_limit_satoshis;
7219 // We route 2 dust-HTLCs between A and B
7220 let (_, payment_hash_1, _) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
7221 let (_, payment_hash_2, _) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
7222 route_payment(&nodes[0], &[&nodes[1]], 1000000);
7224 // Cache one local commitment tx as previous
7225 let as_prev_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
7227 // Fail one HTLC to prune it in the will-be-latest-local commitment tx
7228 assert!(nodes[1].node.fail_htlc_backwards(&payment_hash_2));
7229 check_added_monitors!(nodes[1], 0);
7230 expect_pending_htlcs_forwardable!(nodes[1]);
7231 check_added_monitors!(nodes[1], 1);
7233 let remove = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
7234 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &remove.update_fail_htlcs[0]);
7235 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &remove.commitment_signed);
7236 check_added_monitors!(nodes[0], 1);
7238 // Cache one local commitment tx as lastest
7239 let as_last_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
7241 let events = nodes[0].node.get_and_clear_pending_msg_events();
7243 MessageSendEvent::SendRevokeAndACK { node_id, .. } => {
7244 assert_eq!(node_id, nodes[1].node.get_our_node_id());
7246 _ => panic!("Unexpected event"),
7249 MessageSendEvent::UpdateHTLCs { node_id, .. } => {
7250 assert_eq!(node_id, nodes[1].node.get_our_node_id());
7252 _ => panic!("Unexpected event"),
7255 assert_ne!(as_prev_commitment_tx, as_last_commitment_tx);
7256 // Fail the 2 dust-HTLCs, move their failure in maturation buffer (htlc_updated_waiting_threshold_conf)
7257 if announce_latest {
7258 mine_transaction(&nodes[0], &as_last_commitment_tx[0]);
7260 mine_transaction(&nodes[0], &as_prev_commitment_tx[0]);
7263 check_closed_broadcast!(nodes[0], true);
7264 check_added_monitors!(nodes[0], 1);
7266 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7267 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7268 let events = nodes[0].node.get_and_clear_pending_events();
7269 // Only 2 PaymentFailed events should show up, over-dust HTLC has to be failed by timeout tx
7270 assert_eq!(events.len(), 2);
7271 let mut first_failed = false;
7272 for event in events {
7274 Event::PaymentFailed { payment_hash, .. } => {
7275 if payment_hash == payment_hash_1 {
7276 assert!(!first_failed);
7277 first_failed = true;
7279 assert_eq!(payment_hash, payment_hash_2);
7282 _ => panic!("Unexpected event"),
7288 fn test_failure_delay_dust_htlc_local_commitment() {
7289 do_test_failure_delay_dust_htlc_local_commitment(true);
7290 do_test_failure_delay_dust_htlc_local_commitment(false);
7293 fn do_test_sweep_outbound_htlc_failure_update(revoked: bool, local: bool) {
7294 // Outbound HTLC-failure updates must be cancelled if we get a reorg before we reach ANTI_REORG_DELAY.
7295 // Broadcast of revoked remote commitment tx, trigger failure-update of dust/non-dust HTLCs
7296 // Broadcast of remote commitment tx, trigger failure-update of dust-HTLCs
7297 // Broadcast of timeout tx on remote commitment tx, trigger failure-udate of non-dust HTLCs
7298 // Broadcast of local commitment tx, trigger failure-update of dust-HTLCs
7299 // Broadcast of HTLC-timeout tx on local commitment tx, trigger failure-update of non-dust HTLCs
7301 let chanmon_cfgs = create_chanmon_cfgs(3);
7302 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7303 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
7304 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7305 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7307 let bs_dust_limit = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().holder_dust_limit_satoshis;
7309 let (_payment_preimage_1, dust_hash, _payment_secret_1) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
7310 let (_payment_preimage_2, non_dust_hash, _payment_secret_2) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
7312 let as_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
7313 let bs_commitment_tx = get_local_commitment_txn!(nodes[1], chan.2);
7315 // We revoked bs_commitment_tx
7317 let (payment_preimage_3, _, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
7318 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_3);
7321 let mut timeout_tx = Vec::new();
7323 // We fail dust-HTLC 1 by broadcast of local commitment tx
7324 mine_transaction(&nodes[0], &as_commitment_tx[0]);
7325 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7326 expect_payment_failed!(nodes[0], dust_hash, true);
7328 connect_blocks(&nodes[0], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS - ANTI_REORG_DELAY);
7329 check_closed_broadcast!(nodes[0], true);
7330 check_added_monitors!(nodes[0], 1);
7331 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7332 timeout_tx.push(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[1].clone());
7333 assert_eq!(timeout_tx[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
7334 // We fail non-dust-HTLC 2 by broadcast of local HTLC-timeout tx on local commitment tx
7335 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7336 mine_transaction(&nodes[0], &timeout_tx[0]);
7337 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7338 expect_payment_failed!(nodes[0], non_dust_hash, true);
7340 // We fail dust-HTLC 1 by broadcast of remote commitment tx. If revoked, fail also non-dust HTLC
7341 mine_transaction(&nodes[0], &bs_commitment_tx[0]);
7342 check_closed_broadcast!(nodes[0], true);
7343 check_added_monitors!(nodes[0], 1);
7344 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7345 connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
7346 timeout_tx.push(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[1].clone());
7348 expect_payment_failed!(nodes[0], dust_hash, true);
7349 assert_eq!(timeout_tx[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
7350 // We fail non-dust-HTLC 2 by broadcast of local timeout tx on remote commitment tx
7351 mine_transaction(&nodes[0], &timeout_tx[0]);
7352 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7353 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7354 expect_payment_failed!(nodes[0], non_dust_hash, true);
7356 // If revoked, both dust & non-dust HTLCs should have been failed after ANTI_REORG_DELAY confs of revoked
7358 let events = nodes[0].node.get_and_clear_pending_events();
7359 assert_eq!(events.len(), 2);
7362 Event::PaymentFailed { payment_hash, .. } => {
7363 if payment_hash == dust_hash { first = true; }
7364 else { first = false; }
7366 _ => panic!("Unexpected event"),
7369 Event::PaymentFailed { payment_hash, .. } => {
7370 if first { assert_eq!(payment_hash, non_dust_hash); }
7371 else { assert_eq!(payment_hash, dust_hash); }
7373 _ => panic!("Unexpected event"),
7380 fn test_sweep_outbound_htlc_failure_update() {
7381 do_test_sweep_outbound_htlc_failure_update(false, true);
7382 do_test_sweep_outbound_htlc_failure_update(false, false);
7383 do_test_sweep_outbound_htlc_failure_update(true, false);
7387 fn test_upfront_shutdown_script() {
7388 // BOLT 2 : Option upfront shutdown script, if peer commit its closing_script at channel opening
7389 // enforce it at shutdown message
7391 let mut config = UserConfig::default();
7392 config.channel_options.announced_channel = true;
7393 config.peer_channel_config_limits.force_announced_channel_preference = false;
7394 config.channel_options.commit_upfront_shutdown_pubkey = false;
7395 let user_cfgs = [None, Some(config), None];
7396 let chanmon_cfgs = create_chanmon_cfgs(3);
7397 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7398 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
7399 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7401 // We test that in case of peer committing upfront to a script, if it changes at closing, we refuse to sign
7402 let flags = InitFeatures::known();
7403 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 1000000, 1000000, flags.clone(), flags.clone());
7404 nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7405 let mut node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[2].node.get_our_node_id());
7406 node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
7407 // Test we enforce upfront_scriptpbukey if by providing a diffrent one at closing that we disconnect peer
7408 nodes[2].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
7409 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()));
7410 check_added_monitors!(nodes[2], 1);
7412 // We test that in case of peer committing upfront to a script, if it doesn't change at closing, we sign
7413 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 1000000, 1000000, flags.clone(), flags.clone());
7414 nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7415 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[2].node.get_our_node_id());
7416 // We test that in case of peer committing upfront to a script, if it oesn't change at closing, we sign
7417 nodes[2].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
7418 let events = nodes[2].node.get_and_clear_pending_msg_events();
7419 assert_eq!(events.len(), 1);
7421 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[0].node.get_our_node_id()) }
7422 _ => panic!("Unexpected event"),
7425 // We test that if case of peer non-signaling we don't enforce committed script at channel opening
7426 let flags_no = InitFeatures::known().clear_upfront_shutdown_script();
7427 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, flags_no, flags.clone());
7428 nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7429 let mut node_1_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
7430 node_1_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
7431 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_1_shutdown);
7432 let events = nodes[1].node.get_and_clear_pending_msg_events();
7433 assert_eq!(events.len(), 1);
7435 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[0].node.get_our_node_id()) }
7436 _ => panic!("Unexpected event"),
7439 // We test that if user opt-out, we provide a zero-length script at channel opening and we are able to close
7440 // channel smoothly, opt-out is from channel initiator here
7441 let chan = create_announced_chan_between_nodes_with_value(&nodes, 1, 0, 1000000, 1000000, flags.clone(), flags.clone());
7442 nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7443 let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
7444 node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
7445 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
7446 let events = nodes[0].node.get_and_clear_pending_msg_events();
7447 assert_eq!(events.len(), 1);
7449 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7450 _ => panic!("Unexpected event"),
7453 //// We test that if user opt-out, we provide a zero-length script at channel opening and we are able to close
7454 //// channel smoothly
7455 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, flags.clone(), flags.clone());
7456 nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7457 let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
7458 node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
7459 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
7460 let events = nodes[0].node.get_and_clear_pending_msg_events();
7461 assert_eq!(events.len(), 2);
7463 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7464 _ => panic!("Unexpected event"),
7467 MessageSendEvent::SendClosingSigned { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7468 _ => panic!("Unexpected event"),
7473 fn test_upfront_shutdown_script_unsupport_segwit() {
7474 // We test that channel is closed early
7475 // if a segwit program is passed as upfront shutdown script,
7476 // but the peer does not support segwit.
7477 let chanmon_cfgs = create_chanmon_cfgs(2);
7478 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7479 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7480 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7482 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
7484 let mut open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
7485 open_channel.shutdown_scriptpubkey = Present(Builder::new().push_int(16)
7486 .push_slice(&[0, 0])
7489 let features = InitFeatures::known().clear_shutdown_anysegwit();
7490 nodes[0].node.handle_open_channel(&nodes[0].node.get_our_node_id(), features, &open_channel);
7492 let events = nodes[0].node.get_and_clear_pending_msg_events();
7493 assert_eq!(events.len(), 1);
7495 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
7496 assert_eq!(node_id, nodes[0].node.get_our_node_id());
7497 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));
7499 _ => panic!("Unexpected event"),
7504 fn test_shutdown_script_any_segwit_allowed() {
7505 let mut config = UserConfig::default();
7506 config.channel_options.announced_channel = true;
7507 config.peer_channel_config_limits.force_announced_channel_preference = false;
7508 config.channel_options.commit_upfront_shutdown_pubkey = false;
7509 let user_cfgs = [None, Some(config), None];
7510 let chanmon_cfgs = create_chanmon_cfgs(3);
7511 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7512 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
7513 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7515 //// We test if the remote peer accepts opt_shutdown_anysegwit, a witness program can be used on shutdown
7516 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7517 nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7518 let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
7519 node_0_shutdown.scriptpubkey = Builder::new().push_int(16)
7520 .push_slice(&[0, 0])
7522 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
7523 let events = nodes[0].node.get_and_clear_pending_msg_events();
7524 assert_eq!(events.len(), 2);
7526 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7527 _ => panic!("Unexpected event"),
7530 MessageSendEvent::SendClosingSigned { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7531 _ => panic!("Unexpected event"),
7536 fn test_shutdown_script_any_segwit_not_allowed() {
7537 let mut config = UserConfig::default();
7538 config.channel_options.announced_channel = true;
7539 config.peer_channel_config_limits.force_announced_channel_preference = false;
7540 config.channel_options.commit_upfront_shutdown_pubkey = false;
7541 let user_cfgs = [None, Some(config), None];
7542 let chanmon_cfgs = create_chanmon_cfgs(3);
7543 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7544 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
7545 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7547 //// We test that if the remote peer does not accept opt_shutdown_anysegwit, the witness program cannot be used on shutdown
7548 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7549 nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7550 let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
7551 // Make an any segwit version script
7552 node_0_shutdown.scriptpubkey = Builder::new().push_int(16)
7553 .push_slice(&[0, 0])
7555 let flags_no = InitFeatures::known().clear_shutdown_anysegwit();
7556 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &flags_no, &node_0_shutdown);
7557 let events = nodes[0].node.get_and_clear_pending_msg_events();
7558 assert_eq!(events.len(), 2);
7560 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
7561 assert_eq!(node_id, nodes[1].node.get_our_node_id());
7562 assert_eq!(msg.data, "Got a nonstandard scriptpubkey (60020000) from remote peer".to_owned())
7564 _ => panic!("Unexpected event"),
7566 check_added_monitors!(nodes[0], 1);
7570 fn test_shutdown_script_segwit_but_not_anysegwit() {
7571 let mut config = UserConfig::default();
7572 config.channel_options.announced_channel = true;
7573 config.peer_channel_config_limits.force_announced_channel_preference = false;
7574 config.channel_options.commit_upfront_shutdown_pubkey = false;
7575 let user_cfgs = [None, Some(config), None];
7576 let chanmon_cfgs = create_chanmon_cfgs(3);
7577 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7578 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
7579 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7581 //// We test that if shutdown any segwit is supported and we send a witness script with 0 version, this is not accepted
7582 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7583 nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7584 let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
7585 // Make a segwit script that is not a valid as any segwit
7586 node_0_shutdown.scriptpubkey = Builder::new().push_int(0)
7587 .push_slice(&[0, 0])
7589 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
7590 let events = nodes[0].node.get_and_clear_pending_msg_events();
7591 assert_eq!(events.len(), 2);
7593 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
7594 assert_eq!(node_id, nodes[1].node.get_our_node_id());
7595 assert_eq!(msg.data, "Got a nonstandard scriptpubkey (00020000) from remote peer".to_owned())
7597 _ => panic!("Unexpected event"),
7599 check_added_monitors!(nodes[0], 1);
7603 fn test_user_configurable_csv_delay() {
7604 // We test our channel constructors yield errors when we pass them absurd csv delay
7606 let mut low_our_to_self_config = UserConfig::default();
7607 low_our_to_self_config.own_channel_config.our_to_self_delay = 6;
7608 let mut high_their_to_self_config = UserConfig::default();
7609 high_their_to_self_config.peer_channel_config_limits.their_to_self_delay = 100;
7610 let user_cfgs = [Some(high_their_to_self_config.clone()), None];
7611 let chanmon_cfgs = create_chanmon_cfgs(2);
7612 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7613 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &user_cfgs);
7614 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7616 // We test config.our_to_self > BREAKDOWN_TIMEOUT is enforced in Channel::new_outbound()
7617 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) {
7619 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())); },
7620 _ => panic!("Unexpected event"),
7622 } else { assert!(false) }
7624 // We test config.our_to_self > BREAKDOWN_TIMEOUT is enforced in Channel::new_from_req()
7625 nodes[1].node.create_channel(nodes[0].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
7626 let mut open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
7627 open_channel.to_self_delay = 200;
7628 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) {
7630 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())); },
7631 _ => panic!("Unexpected event"),
7633 } else { assert!(false); }
7635 // We test msg.to_self_delay <= config.their_to_self_delay is enforced in Chanel::accept_channel()
7636 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
7637 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()));
7638 let mut accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
7639 accept_channel.to_self_delay = 200;
7640 nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &accept_channel);
7641 if let MessageSendEvent::HandleError { ref action, .. } = nodes[0].node.get_and_clear_pending_msg_events()[0] {
7643 &ErrorAction::SendErrorMessage { ref msg } => {
7644 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()));
7646 _ => { assert!(false); }
7648 } else { assert!(false); }
7650 // We test msg.to_self_delay <= config.their_to_self_delay is enforced in Channel::new_from_req()
7651 nodes[1].node.create_channel(nodes[0].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
7652 let mut open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
7653 open_channel.to_self_delay = 200;
7654 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) {
7656 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())); },
7657 _ => panic!("Unexpected event"),
7659 } else { assert!(false); }
7663 fn test_data_loss_protect() {
7664 // We want to be sure that :
7665 // * we don't broadcast our Local Commitment Tx in case of fallen behind
7666 // (but this is not quite true - we broadcast during Drop because chanmon is out of sync with chanmgr)
7667 // * we close channel in case of detecting other being fallen behind
7668 // * we are able to claim our own outputs thanks to to_remote being static
7669 // TODO: this test is incomplete and the data_loss_protect implementation is incomplete - see issue #775
7675 let mut chanmon_cfgs = create_chanmon_cfgs(2);
7676 // We broadcast during Drop because chanmon is out of sync with chanmgr, which would cause a panic
7677 // during signing due to revoked tx
7678 chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
7679 let keys_manager = &chanmon_cfgs[0].keys_manager;
7682 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7683 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7684 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7686 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7688 // Cache node A state before any channel update
7689 let previous_node_state = nodes[0].node.encode();
7690 let mut previous_chain_monitor_state = test_utils::TestVecWriter(Vec::new());
7691 nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut previous_chain_monitor_state).unwrap();
7693 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
7694 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
7696 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
7697 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
7699 // Restore node A from previous state
7700 logger = test_utils::TestLogger::with_id(format!("node {}", 0));
7701 let mut chain_monitor = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(&mut ::std::io::Cursor::new(previous_chain_monitor_state.0), keys_manager).unwrap().1;
7702 chain_source = test_utils::TestChainSource::new(Network::Testnet);
7703 tx_broadcaster = test_utils::TestBroadcaster{txn_broadcasted: Mutex::new(Vec::new()), blocks: Arc::new(Mutex::new(Vec::new()))};
7704 fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
7705 persister = test_utils::TestPersister::new();
7706 monitor = test_utils::TestChainMonitor::new(Some(&chain_source), &tx_broadcaster, &logger, &fee_estimator, &persister, keys_manager);
7708 let mut channel_monitors = HashMap::new();
7709 channel_monitors.insert(OutPoint { txid: chan.3.txid(), index: 0 }, &mut chain_monitor);
7710 <(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 {
7711 keys_manager: keys_manager,
7712 fee_estimator: &fee_estimator,
7713 chain_monitor: &monitor,
7715 tx_broadcaster: &tx_broadcaster,
7716 default_config: UserConfig::default(),
7720 nodes[0].node = &node_state_0;
7721 assert!(monitor.watch_channel(OutPoint { txid: chan.3.txid(), index: 0 }, chain_monitor).is_ok());
7722 nodes[0].chain_monitor = &monitor;
7723 nodes[0].chain_source = &chain_source;
7725 check_added_monitors!(nodes[0], 1);
7727 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7728 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7730 let reestablish_0 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
7732 // Check we don't broadcast any transactions following learning of per_commitment_point from B
7733 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_0[0]);
7734 check_added_monitors!(nodes[0], 1);
7737 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
7738 assert_eq!(node_txn.len(), 0);
7741 let mut reestablish_1 = Vec::with_capacity(1);
7742 for msg in nodes[0].node.get_and_clear_pending_msg_events() {
7743 if let MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } = msg {
7744 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
7745 reestablish_1.push(msg.clone());
7746 } else if let MessageSendEvent::BroadcastChannelUpdate { .. } = msg {
7747 } else if let MessageSendEvent::HandleError { ref action, .. } = msg {
7749 &ErrorAction::SendErrorMessage { ref msg } => {
7750 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");
7752 _ => panic!("Unexpected event!"),
7755 panic!("Unexpected event")
7759 // Check we close channel detecting A is fallen-behind
7760 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
7761 assert_eq!(check_closed_broadcast!(nodes[1], true).unwrap().data, "Peer attempted to reestablish channel with a very old local commitment transaction");
7762 check_added_monitors!(nodes[1], 1);
7765 // Check A is able to claim to_remote output
7766 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
7767 assert_eq!(node_txn.len(), 1);
7768 check_spends!(node_txn[0], chan.3);
7769 assert_eq!(node_txn[0].output.len(), 2);
7770 mine_transaction(&nodes[0], &node_txn[0]);
7771 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7772 let spend_txn = check_spendable_outputs!(nodes[0], 1, node_cfgs[0].keys_manager, 1000000);
7773 assert_eq!(spend_txn.len(), 1);
7774 check_spends!(spend_txn[0], node_txn[0]);
7778 fn test_check_htlc_underpaying() {
7779 // Send payment through A -> B but A is maliciously
7780 // sending a probe payment (i.e less than expected value0
7781 // to B, B should refuse payment.
7783 let chanmon_cfgs = create_chanmon_cfgs(2);
7784 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7785 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7786 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7788 // Create some initial channels
7789 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7791 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();
7792 let (_, our_payment_hash, _) = get_payment_preimage_hash!(nodes[0]);
7793 let our_payment_secret = nodes[1].node.create_inbound_payment_for_hash(our_payment_hash, Some(100_000), 7200, 0).unwrap();
7794 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
7795 check_added_monitors!(nodes[0], 1);
7797 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
7798 assert_eq!(events.len(), 1);
7799 let mut payment_event = SendEvent::from_event(events.pop().unwrap());
7800 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
7801 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
7803 // Note that we first have to wait a random delay before processing the receipt of the HTLC,
7804 // and then will wait a second random delay before failing the HTLC back:
7805 expect_pending_htlcs_forwardable!(nodes[1]);
7806 expect_pending_htlcs_forwardable!(nodes[1]);
7808 // Node 3 is expecting payment of 100_000 but received 10_000,
7809 // it should fail htlc like we didn't know the preimage.
7810 nodes[1].node.process_pending_htlc_forwards();
7812 let events = nodes[1].node.get_and_clear_pending_msg_events();
7813 assert_eq!(events.len(), 1);
7814 let (update_fail_htlc, commitment_signed) = match events[0] {
7815 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 } } => {
7816 assert!(update_add_htlcs.is_empty());
7817 assert!(update_fulfill_htlcs.is_empty());
7818 assert_eq!(update_fail_htlcs.len(), 1);
7819 assert!(update_fail_malformed_htlcs.is_empty());
7820 assert!(update_fee.is_none());
7821 (update_fail_htlcs[0].clone(), commitment_signed)
7823 _ => panic!("Unexpected event"),
7825 check_added_monitors!(nodes[1], 1);
7827 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlc);
7828 commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
7830 // 10_000 msat as u64, followed by a height of CHAN_CONFIRM_DEPTH as u32
7831 let mut expected_failure_data = byte_utils::be64_to_array(10_000).to_vec();
7832 expected_failure_data.extend_from_slice(&byte_utils::be32_to_array(CHAN_CONFIRM_DEPTH));
7833 expect_payment_failed!(nodes[0], our_payment_hash, true, 0x4000|15, &expected_failure_data[..]);
7837 fn test_announce_disable_channels() {
7838 // Create 2 channels between A and B. Disconnect B. Call timer_tick_occurred and check for generated
7839 // ChannelUpdate. Reconnect B, reestablish and check there is non-generated ChannelUpdate.
7841 let chanmon_cfgs = create_chanmon_cfgs(2);
7842 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7843 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7844 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7846 let short_id_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
7847 let short_id_2 = create_announced_chan_between_nodes(&nodes, 1, 0, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
7848 let short_id_3 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
7851 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
7852 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
7854 nodes[0].node.timer_tick_occurred(); // Enabled -> DisabledStaged
7855 nodes[0].node.timer_tick_occurred(); // DisabledStaged -> Disabled
7856 let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
7857 assert_eq!(msg_events.len(), 3);
7858 let mut chans_disabled: HashSet<u64> = [short_id_1, short_id_2, short_id_3].iter().map(|a| *a).collect();
7859 for e in msg_events {
7861 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
7862 assert_eq!(msg.contents.flags & (1<<1), 1<<1); // The "channel disabled" bit should be set
7863 // Check that each channel gets updated exactly once
7864 if !chans_disabled.remove(&msg.contents.short_channel_id) {
7865 panic!("Generated ChannelUpdate for wrong chan!");
7868 _ => panic!("Unexpected event"),
7872 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7873 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
7874 assert_eq!(reestablish_1.len(), 3);
7875 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7876 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
7877 assert_eq!(reestablish_2.len(), 3);
7879 // Reestablish chan_1
7880 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
7881 handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
7882 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
7883 handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
7884 // Reestablish chan_2
7885 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[1]);
7886 handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
7887 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[1]);
7888 handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
7889 // Reestablish chan_3
7890 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[2]);
7891 handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
7892 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[2]);
7893 handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
7895 nodes[0].node.timer_tick_occurred();
7896 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
7897 nodes[0].node.timer_tick_occurred();
7898 let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
7899 assert_eq!(msg_events.len(), 3);
7900 chans_disabled = [short_id_1, short_id_2, short_id_3].iter().map(|a| *a).collect();
7901 for e in msg_events {
7903 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
7904 assert_eq!(msg.contents.flags & (1<<1), 0); // The "channel disabled" bit should be off
7905 // Check that each channel gets updated exactly once
7906 if !chans_disabled.remove(&msg.contents.short_channel_id) {
7907 panic!("Generated ChannelUpdate for wrong chan!");
7910 _ => panic!("Unexpected event"),
7916 fn test_bump_penalty_txn_on_revoked_commitment() {
7917 // In case of penalty txn with too low feerates for getting into mempools, RBF-bump them to be sure
7918 // we're able to claim outputs on revoked commitment transaction before timelocks expiration
7920 let chanmon_cfgs = create_chanmon_cfgs(2);
7921 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7922 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7923 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7925 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
7926 let logger = test_utils::TestLogger::new();
7928 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
7929 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
7930 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();
7931 send_along_route(&nodes[1], route, &vec!(&nodes[0])[..], 3000000);
7933 let revoked_txn = get_local_commitment_txn!(nodes[0], chan.2);
7934 // Revoked commitment txn with 4 outputs : to_local, to_remote, 1 outgoing HTLC, 1 incoming HTLC
7935 assert_eq!(revoked_txn[0].output.len(), 4);
7936 assert_eq!(revoked_txn[0].input.len(), 1);
7937 assert_eq!(revoked_txn[0].input[0].previous_output.txid, chan.3.txid());
7938 let revoked_txid = revoked_txn[0].txid();
7940 let mut penalty_sum = 0;
7941 for outp in revoked_txn[0].output.iter() {
7942 if outp.script_pubkey.is_v0_p2wsh() {
7943 penalty_sum += outp.value;
7947 // Connect blocks to change height_timer range to see if we use right soonest_timelock
7948 let header_114 = connect_blocks(&nodes[1], 14);
7950 // Actually revoke tx by claiming a HTLC
7951 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
7952 let header = BlockHeader { version: 0x20000000, prev_blockhash: header_114, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7953 connect_block(&nodes[1], &Block { header, txdata: vec![revoked_txn[0].clone()] });
7954 check_added_monitors!(nodes[1], 1);
7956 // One or more justice tx should have been broadcast, check it
7960 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7961 assert_eq!(node_txn.len(), 2); // justice tx (broadcasted from ChannelMonitor) + local commitment tx
7962 assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
7963 assert_eq!(node_txn[0].output.len(), 1);
7964 check_spends!(node_txn[0], revoked_txn[0]);
7965 let fee_1 = penalty_sum - node_txn[0].output[0].value;
7966 feerate_1 = fee_1 * 1000 / node_txn[0].get_weight() as u64;
7967 penalty_1 = node_txn[0].txid();
7971 // After exhaustion of height timer, a new bumped justice tx should have been broadcast, check it
7972 connect_blocks(&nodes[1], 15);
7973 let mut penalty_2 = penalty_1;
7974 let mut feerate_2 = 0;
7976 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7977 assert_eq!(node_txn.len(), 1);
7978 if node_txn[0].input[0].previous_output.txid == revoked_txid {
7979 assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
7980 assert_eq!(node_txn[0].output.len(), 1);
7981 check_spends!(node_txn[0], revoked_txn[0]);
7982 penalty_2 = node_txn[0].txid();
7983 // Verify new bumped tx is different from last claiming transaction, we don't want spurrious rebroadcast
7984 assert_ne!(penalty_2, penalty_1);
7985 let fee_2 = penalty_sum - node_txn[0].output[0].value;
7986 feerate_2 = fee_2 * 1000 / node_txn[0].get_weight() as u64;
7987 // Verify 25% bump heuristic
7988 assert!(feerate_2 * 100 >= feerate_1 * 125);
7992 assert_ne!(feerate_2, 0);
7994 // After exhaustion of height timer for a 2nd time, a new bumped justice tx should have been broadcast, check it
7995 connect_blocks(&nodes[1], 1);
7997 let mut feerate_3 = 0;
7999 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8000 assert_eq!(node_txn.len(), 1);
8001 if node_txn[0].input[0].previous_output.txid == revoked_txid {
8002 assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
8003 assert_eq!(node_txn[0].output.len(), 1);
8004 check_spends!(node_txn[0], revoked_txn[0]);
8005 penalty_3 = node_txn[0].txid();
8006 // Verify new bumped tx is different from last claiming transaction, we don't want spurrious rebroadcast
8007 assert_ne!(penalty_3, penalty_2);
8008 let fee_3 = penalty_sum - node_txn[0].output[0].value;
8009 feerate_3 = fee_3 * 1000 / node_txn[0].get_weight() as u64;
8010 // Verify 25% bump heuristic
8011 assert!(feerate_3 * 100 >= feerate_2 * 125);
8015 assert_ne!(feerate_3, 0);
8017 nodes[1].node.get_and_clear_pending_events();
8018 nodes[1].node.get_and_clear_pending_msg_events();
8022 fn test_bump_penalty_txn_on_revoked_htlcs() {
8023 // In case of penalty txn with too low feerates for getting into mempools, RBF-bump them to sure
8024 // we're able to claim outputs on revoked HTLC transactions before timelocks expiration
8026 let mut chanmon_cfgs = create_chanmon_cfgs(2);
8027 chanmon_cfgs[1].keys_manager.disable_revocation_policy_check = true;
8028 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8029 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8030 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8032 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
8033 // Lock HTLC in both directions (using a slightly lower CLTV delay to provide timely RBF bumps)
8034 let route = get_route(&nodes[0].node.get_our_node_id(), &nodes[0].net_graph_msg_handler.network_graph.read().unwrap(),
8035 &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 3_000_000, 50, nodes[0].logger).unwrap();
8036 let payment_preimage = send_along_route(&nodes[0], route, &[&nodes[1]], 3_000_000).0;
8037 let route = get_route(&nodes[1].node.get_our_node_id(), &nodes[1].net_graph_msg_handler.network_graph.read().unwrap(),
8038 &nodes[0].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 3_000_000, 50, nodes[0].logger).unwrap();
8039 send_along_route(&nodes[1], route, &[&nodes[0]], 3_000_000);
8041 let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan.2);
8042 assert_eq!(revoked_local_txn[0].input.len(), 1);
8043 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
8045 // Revoke local commitment tx
8046 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
8048 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8049 // B will generate both revoked HTLC-timeout/HTLC-preimage txn from revoked commitment tx
8050 connect_block(&nodes[1], &Block { header, txdata: vec![revoked_local_txn[0].clone()] });
8051 check_closed_broadcast!(nodes[1], true);
8052 check_added_monitors!(nodes[1], 1);
8053 connect_blocks(&nodes[1], 49); // Confirm blocks until the HTLC expires (note CLTV was explicitly 50 above)
8055 let revoked_htlc_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8056 assert_eq!(revoked_htlc_txn.len(), 3);
8057 check_spends!(revoked_htlc_txn[1], chan.3);
8059 assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
8060 assert_eq!(revoked_htlc_txn[0].input.len(), 1);
8061 check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
8063 assert_eq!(revoked_htlc_txn[2].input.len(), 1);
8064 assert_eq!(revoked_htlc_txn[2].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
8065 assert_eq!(revoked_htlc_txn[2].output.len(), 1);
8066 check_spends!(revoked_htlc_txn[2], revoked_local_txn[0]);
8068 // Broadcast set of revoked txn on A
8069 let hash_128 = connect_blocks(&nodes[0], 40);
8070 let header_11 = BlockHeader { version: 0x20000000, prev_blockhash: hash_128, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8071 connect_block(&nodes[0], &Block { header: header_11, txdata: vec![revoked_local_txn[0].clone()] });
8072 let header_129 = BlockHeader { version: 0x20000000, prev_blockhash: header_11.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8073 connect_block(&nodes[0], &Block { header: header_129, txdata: vec![revoked_htlc_txn[0].clone(), revoked_htlc_txn[2].clone()] });
8074 expect_pending_htlcs_forwardable_ignore!(nodes[0]);
8079 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8080 assert_eq!(node_txn.len(), 5); // 3 penalty txn on revoked commitment tx + A commitment tx + 1 penalty tnx on revoked HTLC txn
8081 // Verify claim tx are spending revoked HTLC txn
8083 // node_txn 0-2 each spend a separate revoked output from revoked_local_txn[0]
8084 // Note that node_txn[0] and node_txn[1] are bogus - they double spend the revoked_htlc_txn
8085 // which are included in the same block (they are broadcasted because we scan the
8086 // transactions linearly and generate claims as we go, they likely should be removed in the
8088 assert_eq!(node_txn[0].input.len(), 1);
8089 check_spends!(node_txn[0], revoked_local_txn[0]);
8090 assert_eq!(node_txn[1].input.len(), 1);
8091 check_spends!(node_txn[1], revoked_local_txn[0]);
8092 assert_eq!(node_txn[2].input.len(), 1);
8093 check_spends!(node_txn[2], revoked_local_txn[0]);
8095 // Each of the three justice transactions claim a separate (single) output of the three
8096 // available, which we check here:
8097 assert_ne!(node_txn[0].input[0].previous_output, node_txn[1].input[0].previous_output);
8098 assert_ne!(node_txn[0].input[0].previous_output, node_txn[2].input[0].previous_output);
8099 assert_ne!(node_txn[1].input[0].previous_output, node_txn[2].input[0].previous_output);
8101 assert_eq!(node_txn[0].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
8102 assert_eq!(node_txn[1].input[0].previous_output, revoked_htlc_txn[2].input[0].previous_output);
8104 // node_txn[3] is the local commitment tx broadcast just because (and somewhat in case of
8105 // reorgs, though its not clear its ever worth broadcasting conflicting txn like this when
8106 // a remote commitment tx has already been confirmed).
8107 check_spends!(node_txn[3], chan.3);
8109 // node_txn[4] spends the revoked outputs from the revoked_htlc_txn (which only have one
8110 // output, checked above).
8111 assert_eq!(node_txn[4].input.len(), 2);
8112 assert_eq!(node_txn[4].output.len(), 1);
8113 check_spends!(node_txn[4], revoked_htlc_txn[0], revoked_htlc_txn[2]);
8115 first = node_txn[4].txid();
8116 // Store both feerates for later comparison
8117 let fee_1 = revoked_htlc_txn[0].output[0].value + revoked_htlc_txn[2].output[0].value - node_txn[4].output[0].value;
8118 feerate_1 = fee_1 * 1000 / node_txn[4].get_weight() as u64;
8119 penalty_txn = vec![node_txn[2].clone()];
8123 // Connect one more block to see if bumped penalty are issued for HTLC txn
8124 let header_130 = BlockHeader { version: 0x20000000, prev_blockhash: header_129.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8125 connect_block(&nodes[0], &Block { header: header_130, txdata: penalty_txn });
8126 let header_131 = BlockHeader { version: 0x20000000, prev_blockhash: header_130.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8127 connect_block(&nodes[0], &Block { header: header_131, txdata: Vec::new() });
8129 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8130 assert_eq!(node_txn.len(), 2); // 2 bumped penalty txn on revoked commitment tx
8132 check_spends!(node_txn[0], revoked_local_txn[0]);
8133 check_spends!(node_txn[1], revoked_local_txn[0]);
8134 // Note that these are both bogus - they spend outputs already claimed in block 129:
8135 if node_txn[0].input[0].previous_output == revoked_htlc_txn[0].input[0].previous_output {
8136 assert_eq!(node_txn[1].input[0].previous_output, revoked_htlc_txn[2].input[0].previous_output);
8138 assert_eq!(node_txn[0].input[0].previous_output, revoked_htlc_txn[2].input[0].previous_output);
8139 assert_eq!(node_txn[1].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
8145 // Few more blocks to confirm penalty txn
8146 connect_blocks(&nodes[0], 4);
8147 assert!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
8148 let header_144 = connect_blocks(&nodes[0], 9);
8150 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8151 assert_eq!(node_txn.len(), 1);
8153 assert_eq!(node_txn[0].input.len(), 2);
8154 check_spends!(node_txn[0], revoked_htlc_txn[0], revoked_htlc_txn[2]);
8155 // Verify bumped tx is different and 25% bump heuristic
8156 assert_ne!(first, node_txn[0].txid());
8157 let fee_2 = revoked_htlc_txn[0].output[0].value + revoked_htlc_txn[2].output[0].value - node_txn[0].output[0].value;
8158 let feerate_2 = fee_2 * 1000 / node_txn[0].get_weight() as u64;
8159 assert!(feerate_2 * 100 > feerate_1 * 125);
8160 let txn = vec![node_txn[0].clone()];
8164 // Broadcast claim txn and confirm blocks to avoid further bumps on this outputs
8165 let header_145 = BlockHeader { version: 0x20000000, prev_blockhash: header_144, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8166 connect_block(&nodes[0], &Block { header: header_145, txdata: node_txn });
8167 connect_blocks(&nodes[0], 20);
8169 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8170 // We verify than no new transaction has been broadcast because previously
8171 // we were buggy on this exact behavior by not tracking for monitoring remote HTLC outputs (see #411)
8172 // which means we wouldn't see a spend of them by a justice tx and bumped justice tx
8173 // were generated forever instead of safe cleaning after confirmation and ANTI_REORG_SAFE_DELAY blocks.
8174 // Enforce spending of revoked htlc output by claiming transaction remove request as expected and dry
8175 // up bumped justice generation.
8176 assert_eq!(node_txn.len(), 0);
8179 check_closed_broadcast!(nodes[0], true);
8180 check_added_monitors!(nodes[0], 1);
8184 fn test_bump_penalty_txn_on_remote_commitment() {
8185 // In case of claim txn with too low feerates for getting into mempools, RBF-bump them to be sure
8186 // we're able to claim outputs on remote commitment transaction before timelocks expiration
8189 // Provide preimage for one
8190 // Check aggregation
8192 let chanmon_cfgs = create_chanmon_cfgs(2);
8193 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8194 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8195 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8197 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
8198 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
8199 route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000).0;
8201 // Remote commitment txn with 4 outputs : to_local, to_remote, 1 outgoing HTLC, 1 incoming HTLC
8202 let remote_txn = get_local_commitment_txn!(nodes[0], chan.2);
8203 assert_eq!(remote_txn[0].output.len(), 4);
8204 assert_eq!(remote_txn[0].input.len(), 1);
8205 assert_eq!(remote_txn[0].input[0].previous_output.txid, chan.3.txid());
8207 // Claim a HTLC without revocation (provide B monitor with preimage)
8208 nodes[1].node.claim_funds(payment_preimage);
8209 mine_transaction(&nodes[1], &remote_txn[0]);
8210 check_added_monitors!(nodes[1], 2);
8211 connect_blocks(&nodes[1], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
8213 // One or more claim tx should have been broadcast, check it
8217 let feerate_timeout;
8218 let feerate_preimage;
8220 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8221 // 9 transactions including:
8222 // 1*2 ChannelManager local broadcasts of commitment + HTLC-Success
8223 // 1*3 ChannelManager local broadcasts of commitment + HTLC-Success + HTLC-Timeout
8224 // 2 * HTLC-Success (one RBF bump we'll check later)
8226 assert_eq!(node_txn.len(), 8);
8227 assert_eq!(node_txn[0].input.len(), 1);
8228 assert_eq!(node_txn[6].input.len(), 1);
8229 check_spends!(node_txn[0], remote_txn[0]);
8230 check_spends!(node_txn[6], remote_txn[0]);
8231 assert_eq!(node_txn[0].input[0].previous_output, node_txn[3].input[0].previous_output);
8232 preimage_bump = node_txn[3].clone();
8234 check_spends!(node_txn[1], chan.3);
8235 check_spends!(node_txn[2], node_txn[1]);
8236 assert_eq!(node_txn[1], node_txn[4]);
8237 assert_eq!(node_txn[2], node_txn[5]);
8239 timeout = node_txn[6].txid();
8240 let index = node_txn[6].input[0].previous_output.vout;
8241 let fee = remote_txn[0].output[index as usize].value - node_txn[6].output[0].value;
8242 feerate_timeout = fee * 1000 / node_txn[6].get_weight() as u64;
8244 preimage = node_txn[0].txid();
8245 let index = node_txn[0].input[0].previous_output.vout;
8246 let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
8247 feerate_preimage = fee * 1000 / node_txn[0].get_weight() as u64;
8251 assert_ne!(feerate_timeout, 0);
8252 assert_ne!(feerate_preimage, 0);
8254 // After exhaustion of height timer, new bumped claim txn should have been broadcast, check it
8255 connect_blocks(&nodes[1], 15);
8257 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8258 assert_eq!(node_txn.len(), 1);
8259 assert_eq!(node_txn[0].input.len(), 1);
8260 assert_eq!(preimage_bump.input.len(), 1);
8261 check_spends!(node_txn[0], remote_txn[0]);
8262 check_spends!(preimage_bump, remote_txn[0]);
8264 let index = preimage_bump.input[0].previous_output.vout;
8265 let fee = remote_txn[0].output[index as usize].value - preimage_bump.output[0].value;
8266 let new_feerate = fee * 1000 / preimage_bump.get_weight() as u64;
8267 assert!(new_feerate * 100 > feerate_timeout * 125);
8268 assert_ne!(timeout, preimage_bump.txid());
8270 let index = node_txn[0].input[0].previous_output.vout;
8271 let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
8272 let new_feerate = fee * 1000 / node_txn[0].get_weight() as u64;
8273 assert!(new_feerate * 100 > feerate_preimage * 125);
8274 assert_ne!(preimage, node_txn[0].txid());
8279 nodes[1].node.get_and_clear_pending_events();
8280 nodes[1].node.get_and_clear_pending_msg_events();
8284 fn test_counterparty_raa_skip_no_crash() {
8285 // Previously, if our counterparty sent two RAAs in a row without us having provided a
8286 // commitment transaction, we would have happily carried on and provided them the next
8287 // commitment transaction based on one RAA forward. This would probably eventually have led to
8288 // channel closure, but it would not have resulted in funds loss. Still, our
8289 // EnforcingSigner would have paniced as it doesn't like jumps into the future. Here, we
8290 // check simply that the channel is closed in response to such an RAA, but don't check whether
8291 // we decide to punish our counterparty for revoking their funds (as we don't currently
8293 let chanmon_cfgs = create_chanmon_cfgs(2);
8294 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8295 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8296 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8297 let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).2;
8299 let mut guard = nodes[0].node.channel_state.lock().unwrap();
8300 let keys = &guard.by_id.get_mut(&channel_id).unwrap().get_signer();
8301 const INITIAL_COMMITMENT_NUMBER: u64 = (1 << 48) - 1;
8302 let per_commitment_secret = keys.release_commitment_secret(INITIAL_COMMITMENT_NUMBER);
8303 // Must revoke without gaps
8304 keys.release_commitment_secret(INITIAL_COMMITMENT_NUMBER - 1);
8305 let next_per_commitment_point = PublicKey::from_secret_key(&Secp256k1::new(),
8306 &SecretKey::from_slice(&keys.release_commitment_secret(INITIAL_COMMITMENT_NUMBER - 2)).unwrap());
8308 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(),
8309 &msgs::RevokeAndACK { channel_id, per_commitment_secret, next_per_commitment_point });
8310 assert_eq!(check_closed_broadcast!(nodes[1], true).unwrap().data, "Received an unexpected revoke_and_ack");
8311 check_added_monitors!(nodes[1], 1);
8315 fn test_bump_txn_sanitize_tracking_maps() {
8316 // Sanitizing pendning_claim_request and claimable_outpoints used to be buggy,
8317 // verify we clean then right after expiration of ANTI_REORG_DELAY.
8319 let chanmon_cfgs = create_chanmon_cfgs(2);
8320 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8321 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8322 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8324 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
8325 // Lock HTLC in both directions
8326 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000).0;
8327 route_payment(&nodes[1], &vec!(&nodes[0])[..], 9_000_000).0;
8329 let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan.2);
8330 assert_eq!(revoked_local_txn[0].input.len(), 1);
8331 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
8333 // Revoke local commitment tx
8334 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
8336 // Broadcast set of revoked txn on A
8337 connect_blocks(&nodes[0], TEST_FINAL_CLTV + 2 - CHAN_CONFIRM_DEPTH);
8338 expect_pending_htlcs_forwardable_ignore!(nodes[0]);
8339 assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 0);
8341 mine_transaction(&nodes[0], &revoked_local_txn[0]);
8342 check_closed_broadcast!(nodes[0], true);
8343 check_added_monitors!(nodes[0], 1);
8345 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8346 assert_eq!(node_txn.len(), 4); //ChannelMonitor: justice txn * 3, ChannelManager: local commitment tx
8347 check_spends!(node_txn[0], revoked_local_txn[0]);
8348 check_spends!(node_txn[1], revoked_local_txn[0]);
8349 check_spends!(node_txn[2], revoked_local_txn[0]);
8350 let penalty_txn = vec![node_txn[0].clone(), node_txn[1].clone(), node_txn[2].clone()];
8354 let header_130 = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8355 connect_block(&nodes[0], &Block { header: header_130, txdata: penalty_txn });
8356 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
8358 let monitors = nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap();
8359 if let Some(monitor) = monitors.get(&OutPoint { txid: chan.3.txid(), index: 0 }) {
8360 assert!(monitor.inner.lock().unwrap().onchain_tx_handler.pending_claim_requests.is_empty());
8361 assert!(monitor.inner.lock().unwrap().onchain_tx_handler.claimable_outpoints.is_empty());
8367 fn test_override_channel_config() {
8368 let chanmon_cfgs = create_chanmon_cfgs(2);
8369 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8370 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8371 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8373 // Node0 initiates a channel to node1 using the override config.
8374 let mut override_config = UserConfig::default();
8375 override_config.own_channel_config.our_to_self_delay = 200;
8377 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 16_000_000, 12_000_000, 42, Some(override_config)).unwrap();
8379 // Assert the channel created by node0 is using the override config.
8380 let res = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8381 assert_eq!(res.channel_flags, 0);
8382 assert_eq!(res.to_self_delay, 200);
8386 fn test_override_0msat_htlc_minimum() {
8387 let mut zero_config = UserConfig::default();
8388 zero_config.own_channel_config.our_htlc_minimum_msat = 0;
8389 let chanmon_cfgs = create_chanmon_cfgs(2);
8390 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8391 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, Some(zero_config.clone())]);
8392 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8394 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 16_000_000, 12_000_000, 42, Some(zero_config)).unwrap();
8395 let res = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8396 assert_eq!(res.htlc_minimum_msat, 1);
8398 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &res);
8399 let res = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
8400 assert_eq!(res.htlc_minimum_msat, 1);
8404 fn test_simple_mpp() {
8405 // Simple test of sending a multi-path payment.
8406 let chanmon_cfgs = create_chanmon_cfgs(4);
8407 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
8408 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
8409 let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
8411 let chan_1_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8412 let chan_2_id = create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8413 let chan_3_id = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8414 let chan_4_id = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8415 let logger = test_utils::TestLogger::new();
8417 let (payment_preimage, payment_hash, payment_secret) = get_payment_preimage_hash!(&nodes[3]);
8418 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
8419 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();
8420 let path = route.paths[0].clone();
8421 route.paths.push(path);
8422 route.paths[0][0].pubkey = nodes[1].node.get_our_node_id();
8423 route.paths[0][0].short_channel_id = chan_1_id;
8424 route.paths[0][1].short_channel_id = chan_3_id;
8425 route.paths[1][0].pubkey = nodes[2].node.get_our_node_id();
8426 route.paths[1][0].short_channel_id = chan_2_id;
8427 route.paths[1][1].short_channel_id = chan_4_id;
8428 send_along_route_with_secret(&nodes[0], route, &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], 200_000, payment_hash, payment_secret);
8429 claim_payment_along_route(&nodes[0], &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], false, payment_preimage);
8433 fn test_preimage_storage() {
8434 // Simple test of payment preimage storage allowing no client-side storage to claim payments
8435 let chanmon_cfgs = create_chanmon_cfgs(2);
8436 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8437 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8438 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8440 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8443 let (payment_hash, payment_secret) = nodes[1].node.create_inbound_payment(Some(100_000), 7200, 42);
8445 let logger = test_utils::TestLogger::new();
8446 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
8447 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();
8448 nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
8449 check_added_monitors!(nodes[0], 1);
8450 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
8451 let mut payment_event = SendEvent::from_event(events.pop().unwrap());
8452 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
8453 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
8455 // Note that after leaving the above scope we have no knowledge of any arguments or return
8456 // values from previous calls.
8457 expect_pending_htlcs_forwardable!(nodes[1]);
8458 let events = nodes[1].node.get_and_clear_pending_events();
8459 assert_eq!(events.len(), 1);
8461 Event::PaymentReceived { payment_preimage, user_payment_id, .. } => {
8462 assert_eq!(user_payment_id, 42);
8463 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage.unwrap());
8465 _ => panic!("Unexpected event"),
8470 fn test_secret_timeout() {
8471 // Simple test of payment secret storage time outs
8472 let chanmon_cfgs = create_chanmon_cfgs(2);
8473 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8474 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8475 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8477 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8479 let (payment_hash, payment_secret_1) = nodes[1].node.create_inbound_payment(Some(100_000), 2, 0);
8481 // We should fail to register the same payment hash twice, at least until we've connected a
8482 // block with time 7200 + CHAN_CONFIRM_DEPTH + 1.
8483 if let Err(APIError::APIMisuseError { err }) = nodes[1].node.create_inbound_payment_for_hash(payment_hash, Some(100_000), 2, 0) {
8484 assert_eq!(err, "Duplicate payment hash");
8485 } else { panic!(); }
8487 let node_1_blocks = nodes[1].blocks.lock().unwrap();
8489 header: BlockHeader {
8491 prev_blockhash: node_1_blocks.last().unwrap().0.block_hash(),
8492 merkle_root: Default::default(),
8493 time: node_1_blocks.len() as u32 + 7200, bits: 42, nonce: 42 },
8497 connect_block(&nodes[1], &block);
8498 if let Err(APIError::APIMisuseError { err }) = nodes[1].node.create_inbound_payment_for_hash(payment_hash, Some(100_000), 2, 0) {
8499 assert_eq!(err, "Duplicate payment hash");
8500 } else { panic!(); }
8502 // If we then connect the second block, we should be able to register the same payment hash
8503 // again with a different user_payment_id (this time getting a new payment secret).
8504 block.header.prev_blockhash = block.header.block_hash();
8505 block.header.time += 1;
8506 connect_block(&nodes[1], &block);
8507 let our_payment_secret = nodes[1].node.create_inbound_payment_for_hash(payment_hash, Some(100_000), 2, 42).unwrap();
8508 assert_ne!(payment_secret_1, our_payment_secret);
8511 let logger = test_utils::TestLogger::new();
8512 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
8513 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();
8514 nodes[0].node.send_payment(&route, payment_hash, &Some(our_payment_secret)).unwrap();
8515 check_added_monitors!(nodes[0], 1);
8516 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
8517 let mut payment_event = SendEvent::from_event(events.pop().unwrap());
8518 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
8519 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
8521 // Note that after leaving the above scope we have no knowledge of any arguments or return
8522 // values from previous calls.
8523 expect_pending_htlcs_forwardable!(nodes[1]);
8524 let events = nodes[1].node.get_and_clear_pending_events();
8525 assert_eq!(events.len(), 1);
8527 Event::PaymentReceived { payment_preimage, payment_secret, user_payment_id, .. } => {
8528 assert!(payment_preimage.is_none());
8529 assert_eq!(user_payment_id, 42);
8530 assert_eq!(payment_secret, our_payment_secret);
8531 // We don't actually have the payment preimage with which to claim this payment!
8533 _ => panic!("Unexpected event"),
8538 fn test_bad_secret_hash() {
8539 // Simple test of unregistered payment hash/invalid payment secret handling
8540 let chanmon_cfgs = create_chanmon_cfgs(2);
8541 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8542 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8543 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8545 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8547 let random_payment_hash = PaymentHash([42; 32]);
8548 let random_payment_secret = PaymentSecret([43; 32]);
8549 let (our_payment_hash, our_payment_secret) = nodes[1].node.create_inbound_payment(Some(100_000), 2, 0);
8551 let logger = test_utils::TestLogger::new();
8552 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
8553 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();
8555 // All the below cases should end up being handled exactly identically, so we macro the
8556 // resulting events.
8557 macro_rules! handle_unknown_invalid_payment_data {
8559 check_added_monitors!(nodes[0], 1);
8560 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
8561 let payment_event = SendEvent::from_event(events.pop().unwrap());
8562 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
8563 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
8565 // We have to forward pending HTLCs once to process the receipt of the HTLC and then
8566 // again to process the pending backwards-failure of the HTLC
8567 expect_pending_htlcs_forwardable!(nodes[1]);
8568 expect_pending_htlcs_forwardable!(nodes[1]);
8569 check_added_monitors!(nodes[1], 1);
8571 // We should fail the payment back
8572 let mut events = nodes[1].node.get_and_clear_pending_msg_events();
8573 match events.pop().unwrap() {
8574 MessageSendEvent::UpdateHTLCs { node_id: _, updates: msgs::CommitmentUpdate { update_fail_htlcs, commitment_signed, .. } } => {
8575 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
8576 commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false);
8578 _ => panic!("Unexpected event"),
8583 let expected_error_code = 0x4000|15; // incorrect_or_unknown_payment_details
8584 // Error data is the HTLC value (100,000) and current block height
8585 let expected_error_data = [0, 0, 0, 0, 0, 1, 0x86, 0xa0, 0, 0, 0, CHAN_CONFIRM_DEPTH as u8];
8587 // Send a payment with the right payment hash but the wrong payment secret
8588 nodes[0].node.send_payment(&route, our_payment_hash, &Some(random_payment_secret)).unwrap();
8589 handle_unknown_invalid_payment_data!();
8590 expect_payment_failed!(nodes[0], our_payment_hash, true, expected_error_code, expected_error_data);
8592 // Send a payment with a random payment hash, but the right payment secret
8593 nodes[0].node.send_payment(&route, random_payment_hash, &Some(our_payment_secret)).unwrap();
8594 handle_unknown_invalid_payment_data!();
8595 expect_payment_failed!(nodes[0], random_payment_hash, true, expected_error_code, expected_error_data);
8597 // Send a payment with a random payment hash and random payment secret
8598 nodes[0].node.send_payment(&route, random_payment_hash, &Some(random_payment_secret)).unwrap();
8599 handle_unknown_invalid_payment_data!();
8600 expect_payment_failed!(nodes[0], random_payment_hash, true, expected_error_code, expected_error_data);
8604 fn test_update_err_monitor_lockdown() {
8605 // Our monitor will lock update of local commitment transaction if a broadcastion condition
8606 // has been fulfilled (either force-close from Channel or block height requiring a HTLC-
8607 // timeout). Trying to update monitor after lockdown should return a ChannelMonitorUpdateErr.
8609 // This scenario may happen in a watchtower setup, where watchtower process a block height
8610 // triggering a timeout while a slow-block-processing ChannelManager receives a local signed
8611 // commitment at same time.
8613 let chanmon_cfgs = create_chanmon_cfgs(2);
8614 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8615 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8616 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8618 // Create some initial channel
8619 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
8620 let outpoint = OutPoint { txid: chan_1.3.txid(), index: 0 };
8622 // Rebalance the network to generate htlc in the two directions
8623 send_payment(&nodes[0], &vec!(&nodes[1])[..], 10_000_000);
8625 // Route a HTLC from node 0 to node 1 (but don't settle)
8626 let preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000).0;
8628 // Copy ChainMonitor to simulate a watchtower and update block height of node 0 until its ChannelMonitor timeout HTLC onchain
8629 let chain_source = test_utils::TestChainSource::new(Network::Testnet);
8630 let logger = test_utils::TestLogger::with_id(format!("node {}", 0));
8631 let persister = test_utils::TestPersister::new();
8633 let monitors = nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap();
8634 let monitor = monitors.get(&outpoint).unwrap();
8635 let mut w = test_utils::TestVecWriter(Vec::new());
8636 monitor.write(&mut w).unwrap();
8637 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingSigner>)>::read(
8638 &mut ::std::io::Cursor::new(&w.0), &test_utils::OnlyReadsKeysInterface {}).unwrap().1;
8639 assert!(new_monitor == *monitor);
8640 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);
8641 assert!(watchtower.watch_channel(outpoint, new_monitor).is_ok());
8644 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8645 // Make the tx_broadcaster aware of enough blocks that it doesn't think we're violating
8646 // transaction lock time requirements here.
8647 chanmon_cfgs[0].tx_broadcaster.blocks.lock().unwrap().resize(200, (header, 0));
8648 watchtower.chain_monitor.block_connected(&Block { header, txdata: vec![] }, 200);
8650 // Try to update ChannelMonitor
8651 assert!(nodes[1].node.claim_funds(preimage));
8652 check_added_monitors!(nodes[1], 1);
8653 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
8654 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
8655 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
8656 if let Some(ref mut channel) = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan_1.2) {
8657 if let Ok((_, _, _, update)) = channel.commitment_signed(&updates.commitment_signed, &node_cfgs[0].fee_estimator, &node_cfgs[0].logger) {
8658 if let Err(_) = watchtower.chain_monitor.update_channel(outpoint, update.clone()) {} else { assert!(false); }
8659 if let Ok(_) = nodes[0].chain_monitor.update_channel(outpoint, update) {} else { assert!(false); }
8660 } else { assert!(false); }
8661 } else { assert!(false); };
8662 // Our local monitor is in-sync and hasn't processed yet timeout
8663 check_added_monitors!(nodes[0], 1);
8664 let events = nodes[0].node.get_and_clear_pending_events();
8665 assert_eq!(events.len(), 1);
8669 fn test_concurrent_monitor_claim() {
8670 // Watchtower A receives block, broadcasts state N, then channel receives new state N+1,
8671 // sending it to both watchtowers, Bob accepts N+1, then receives block and broadcasts
8672 // the latest state N+1, Alice rejects state N+1, but Bob has already broadcast it,
8673 // state N+1 confirms. Alice claims output from state N+1.
8675 let chanmon_cfgs = create_chanmon_cfgs(2);
8676 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8677 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8678 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8680 // Create some initial channel
8681 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
8682 let outpoint = OutPoint { txid: chan_1.3.txid(), index: 0 };
8684 // Rebalance the network to generate htlc in the two directions
8685 send_payment(&nodes[0], &vec!(&nodes[1])[..], 10_000_000);
8687 // Route a HTLC from node 0 to node 1 (but don't settle)
8688 route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000).0;
8690 // Copy ChainMonitor to simulate watchtower Alice and update block height her ChannelMonitor timeout HTLC onchain
8691 let chain_source = test_utils::TestChainSource::new(Network::Testnet);
8692 let logger = test_utils::TestLogger::with_id(format!("node {}", "Alice"));
8693 let persister = test_utils::TestPersister::new();
8694 let watchtower_alice = {
8695 let monitors = nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap();
8696 let monitor = monitors.get(&outpoint).unwrap();
8697 let mut w = test_utils::TestVecWriter(Vec::new());
8698 monitor.write(&mut w).unwrap();
8699 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingSigner>)>::read(
8700 &mut ::std::io::Cursor::new(&w.0), &test_utils::OnlyReadsKeysInterface {}).unwrap().1;
8701 assert!(new_monitor == *monitor);
8702 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);
8703 assert!(watchtower.watch_channel(outpoint, new_monitor).is_ok());
8706 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8707 // Make the tx_broadcaster aware of enough blocks that it doesn't think we're violating
8708 // transaction lock time requirements here.
8709 chanmon_cfgs[0].tx_broadcaster.blocks.lock().unwrap().resize((CHAN_CONFIRM_DEPTH + 1 + TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS) as usize, (header, 0));
8710 watchtower_alice.chain_monitor.block_connected(&Block { header, txdata: vec![] }, CHAN_CONFIRM_DEPTH + 1 + TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS);
8712 // Watchtower Alice should have broadcast a commitment/HTLC-timeout
8714 let mut txn = chanmon_cfgs[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8715 assert_eq!(txn.len(), 2);
8719 // Copy ChainMonitor to simulate watchtower Bob and make it receive a commitment update first.
8720 let chain_source = test_utils::TestChainSource::new(Network::Testnet);
8721 let logger = test_utils::TestLogger::with_id(format!("node {}", "Bob"));
8722 let persister = test_utils::TestPersister::new();
8723 let watchtower_bob = {
8724 let monitors = nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap();
8725 let monitor = monitors.get(&outpoint).unwrap();
8726 let mut w = test_utils::TestVecWriter(Vec::new());
8727 monitor.write(&mut w).unwrap();
8728 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingSigner>)>::read(
8729 &mut ::std::io::Cursor::new(&w.0), &test_utils::OnlyReadsKeysInterface {}).unwrap().1;
8730 assert!(new_monitor == *monitor);
8731 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);
8732 assert!(watchtower.watch_channel(outpoint, new_monitor).is_ok());
8735 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8736 watchtower_bob.chain_monitor.block_connected(&Block { header, txdata: vec![] }, CHAN_CONFIRM_DEPTH + TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS);
8738 // Route another payment to generate another update with still previous HTLC pending
8739 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[0]);
8741 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
8742 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();
8743 nodes[1].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
8745 check_added_monitors!(nodes[1], 1);
8747 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
8748 assert_eq!(updates.update_add_htlcs.len(), 1);
8749 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &updates.update_add_htlcs[0]);
8750 if let Some(ref mut channel) = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan_1.2) {
8751 if let Ok((_, _, _, update)) = channel.commitment_signed(&updates.commitment_signed, &node_cfgs[0].fee_estimator, &node_cfgs[0].logger) {
8752 // Watchtower Alice should already have seen the block and reject the update
8753 if let Err(_) = watchtower_alice.chain_monitor.update_channel(outpoint, update.clone()) {} else { assert!(false); }
8754 if let Ok(_) = watchtower_bob.chain_monitor.update_channel(outpoint, update.clone()) {} else { assert!(false); }
8755 if let Ok(_) = nodes[0].chain_monitor.update_channel(outpoint, update) {} else { assert!(false); }
8756 } else { assert!(false); }
8757 } else { assert!(false); };
8758 // Our local monitor is in-sync and hasn't processed yet timeout
8759 check_added_monitors!(nodes[0], 1);
8761 //// Provide one more block to watchtower Bob, expect broadcast of commitment and HTLC-Timeout
8762 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8763 watchtower_bob.chain_monitor.block_connected(&Block { header, txdata: vec![] }, CHAN_CONFIRM_DEPTH + 1 + TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS);
8765 // Watchtower Bob should have broadcast a commitment/HTLC-timeout
8768 let mut txn = chanmon_cfgs[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8769 assert_eq!(txn.len(), 2);
8770 bob_state_y = txn[0].clone();
8774 // We confirm Bob's state Y on Alice, she should broadcast a HTLC-timeout
8775 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8776 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);
8778 let htlc_txn = chanmon_cfgs[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8779 // We broadcast twice the transaction, once due to the HTLC-timeout, once due
8780 // the onchain detection of the HTLC output
8781 assert_eq!(htlc_txn.len(), 2);
8782 check_spends!(htlc_txn[0], bob_state_y);
8783 check_spends!(htlc_txn[1], bob_state_y);
8788 fn test_pre_lockin_no_chan_closed_update() {
8789 // Test that if a peer closes a channel in response to a funding_created message we don't
8790 // generate a channel update (as the channel cannot appear on chain without a funding_signed
8793 // Doing so would imply a channel monitor update before the initial channel monitor
8794 // registration, violating our API guarantees.
8796 // Previously, full_stack_target managed to hit this case by opening then closing a channel,
8797 // then opening a second channel with the same funding output as the first (which is not
8798 // rejected because the first channel does not exist in the ChannelManager) and closing it
8799 // before receiving funding_signed.
8800 let chanmon_cfgs = create_chanmon_cfgs(2);
8801 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8802 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8803 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8805 // Create an initial channel
8806 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
8807 let mut open_chan_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8808 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_msg);
8809 let accept_chan_msg = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
8810 nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &accept_chan_msg);
8812 // Move the first channel through the funding flow...
8813 let (temporary_channel_id, tx, _) = create_funding_transaction(&nodes[0], 100000, 42);
8815 nodes[0].node.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
8816 check_added_monitors!(nodes[0], 0);
8818 let funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
8819 let channel_id = ::chain::transaction::OutPoint { txid: funding_created_msg.funding_txid, index: funding_created_msg.funding_output_index }.to_channel_id();
8820 nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msgs::ErrorMessage { channel_id, data: "Hi".to_owned() });
8821 assert!(nodes[0].chain_monitor.added_monitors.lock().unwrap().is_empty());
8825 fn test_htlc_no_detection() {
8826 // This test is a mutation to underscore the detection logic bug we had
8827 // before #653. HTLC value routed is above the remaining balance, thus
8828 // inverting HTLC and `to_remote` output. HTLC will come second and
8829 // it wouldn't be seen by pre-#653 detection as we were enumerate()'ing
8830 // on a watched outputs vector (Vec<TxOut>) thus implicitly relying on
8831 // outputs order detection for correct spending children filtring.
8833 let chanmon_cfgs = create_chanmon_cfgs(2);
8834 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8835 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8836 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8838 // Create some initial channels
8839 let chan_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
8841 send_payment(&nodes[0], &vec!(&nodes[1])[..], 1_000_000);
8842 let (_, our_payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 2_000_000);
8843 let local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
8844 assert_eq!(local_txn[0].input.len(), 1);
8845 assert_eq!(local_txn[0].output.len(), 3);
8846 check_spends!(local_txn[0], chan_1.3);
8848 // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
8849 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8850 connect_block(&nodes[0], &Block { header, txdata: vec![local_txn[0].clone()] });
8851 // We deliberately connect the local tx twice as this should provoke a failure calling
8852 // this test before #653 fix.
8853 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);
8854 check_closed_broadcast!(nodes[0], true);
8855 check_added_monitors!(nodes[0], 1);
8856 connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1);
8858 let htlc_timeout = {
8859 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8860 assert_eq!(node_txn[1].input.len(), 1);
8861 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
8862 check_spends!(node_txn[1], local_txn[0]);
8866 let header_201 = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8867 connect_block(&nodes[0], &Block { header: header_201, txdata: vec![htlc_timeout.clone()] });
8868 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
8869 expect_payment_failed!(nodes[0], our_payment_hash, true);
8872 fn do_test_onchain_htlc_settlement_after_close(broadcast_alice: bool, go_onchain_before_fulfill: bool) {
8873 // If we route an HTLC, then learn the HTLC's preimage after the upstream channel has been
8874 // force-closed, we must claim that HTLC on-chain. (Given an HTLC forwarded from Alice --> Bob -->
8875 // Carol, Alice would be the upstream node, and Carol the downstream.)
8877 // Steps of the test:
8878 // 1) Alice sends a HTLC to Carol through Bob.
8879 // 2) Carol doesn't settle the HTLC.
8880 // 3) If broadcast_alice is true, Alice force-closes her channel with Bob. Else Bob force closes.
8881 // Steps 4 and 5 may be reordered depending on go_onchain_before_fulfill.
8882 // 4) Bob sees the Alice's commitment on his chain or vice versa. An offered output is present
8883 // but can't be claimed as Bob doesn't have yet knowledge of the preimage.
8884 // 5) Carol release the preimage to Bob off-chain.
8885 // 6) Bob claims the offered output on the broadcasted commitment.
8886 let chanmon_cfgs = create_chanmon_cfgs(3);
8887 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
8888 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
8889 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
8891 // Create some initial channels
8892 let chan_ab = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
8893 create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 100000, 10001, InitFeatures::known(), InitFeatures::known());
8895 // Steps (1) and (2):
8896 // Send an HTLC Alice --> Bob --> Carol, but Carol doesn't settle the HTLC back.
8897 let (payment_preimage, _payment_hash, _payment_secret) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3_000_000);
8899 // Check that Alice's commitment transaction now contains an output for this HTLC.
8900 let alice_txn = get_local_commitment_txn!(nodes[0], chan_ab.2);
8901 check_spends!(alice_txn[0], chan_ab.3);
8902 assert_eq!(alice_txn[0].output.len(), 2);
8903 check_spends!(alice_txn[1], alice_txn[0]); // 2nd transaction is a non-final HTLC-timeout
8904 assert_eq!(alice_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
8905 assert_eq!(alice_txn.len(), 2);
8907 // Steps (3) and (4):
8908 // If `go_onchain_before_fufill`, broadcast the relevant commitment transaction and check that Bob
8909 // responds by (1) broadcasting a channel update and (2) adding a new ChannelMonitor.
8910 let mut force_closing_node = 0; // Alice force-closes
8911 if !broadcast_alice { force_closing_node = 1; } // Bob force-closes
8912 nodes[force_closing_node].node.force_close_channel(&chan_ab.2).unwrap();
8913 check_closed_broadcast!(nodes[force_closing_node], true);
8914 check_added_monitors!(nodes[force_closing_node], 1);
8915 if go_onchain_before_fulfill {
8916 let txn_to_broadcast = match broadcast_alice {
8917 true => alice_txn.clone(),
8918 false => get_local_commitment_txn!(nodes[1], chan_ab.2)
8920 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
8921 connect_block(&nodes[1], &Block { header, txdata: vec![txn_to_broadcast[0].clone()]});
8922 let mut bob_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8923 if broadcast_alice {
8924 check_closed_broadcast!(nodes[1], true);
8925 check_added_monitors!(nodes[1], 1);
8927 assert_eq!(bob_txn.len(), 1);
8928 check_spends!(bob_txn[0], chan_ab.3);
8932 // Carol then claims the funds and sends an update_fulfill message to Bob, and they go through the
8933 // process of removing the HTLC from their commitment transactions.
8934 assert!(nodes[2].node.claim_funds(payment_preimage));
8935 check_added_monitors!(nodes[2], 1);
8936 let carol_updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
8937 assert!(carol_updates.update_add_htlcs.is_empty());
8938 assert!(carol_updates.update_fail_htlcs.is_empty());
8939 assert!(carol_updates.update_fail_malformed_htlcs.is_empty());
8940 assert!(carol_updates.update_fee.is_none());
8941 assert_eq!(carol_updates.update_fulfill_htlcs.len(), 1);
8943 nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &carol_updates.update_fulfill_htlcs[0]);
8944 // If Alice broadcasted but Bob doesn't know yet, here he prepares to tell her about the preimage.
8945 if !go_onchain_before_fulfill && broadcast_alice {
8946 let events = nodes[1].node.get_and_clear_pending_msg_events();
8947 assert_eq!(events.len(), 1);
8949 MessageSendEvent::UpdateHTLCs { ref node_id, .. } => {
8950 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
8952 _ => panic!("Unexpected event"),
8955 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &carol_updates.commitment_signed);
8956 // One monitor update for the preimage to update the Bob<->Alice channel, one monitor update
8957 // Carol<->Bob's updated commitment transaction info.
8958 check_added_monitors!(nodes[1], 2);
8960 let events = nodes[1].node.get_and_clear_pending_msg_events();
8961 assert_eq!(events.len(), 2);
8962 let bob_revocation = match events[0] {
8963 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
8964 assert_eq!(*node_id, nodes[2].node.get_our_node_id());
8967 _ => panic!("Unexpected event"),
8969 let bob_updates = match events[1] {
8970 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
8971 assert_eq!(*node_id, nodes[2].node.get_our_node_id());
8974 _ => panic!("Unexpected event"),
8977 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bob_revocation);
8978 check_added_monitors!(nodes[2], 1);
8979 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bob_updates.commitment_signed);
8980 check_added_monitors!(nodes[2], 1);
8982 let events = nodes[2].node.get_and_clear_pending_msg_events();
8983 assert_eq!(events.len(), 1);
8984 let carol_revocation = match events[0] {
8985 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
8986 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
8989 _ => panic!("Unexpected event"),
8991 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &carol_revocation);
8992 check_added_monitors!(nodes[1], 1);
8994 // If this test requires the force-closed channel to not be on-chain until after the fulfill,
8995 // here's where we put said channel's commitment tx on-chain.
8996 let mut txn_to_broadcast = alice_txn.clone();
8997 if !broadcast_alice { txn_to_broadcast = get_local_commitment_txn!(nodes[1], chan_ab.2); }
8998 if !go_onchain_before_fulfill {
8999 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
9000 connect_block(&nodes[1], &Block { header, txdata: vec![txn_to_broadcast[0].clone()]});
9001 // If Bob was the one to force-close, he will have already passed these checks earlier.
9002 if broadcast_alice {
9003 check_closed_broadcast!(nodes[1], true);
9004 check_added_monitors!(nodes[1], 1);
9006 let mut bob_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
9007 if broadcast_alice {
9008 // In `connect_block()`, the ChainMonitor and ChannelManager are separately notified about a
9009 // new block being connected. The ChannelManager being notified triggers a monitor update,
9010 // which triggers broadcasting our commitment tx and an HTLC-claiming tx. The ChainMonitor
9011 // being notified triggers the HTLC-claiming tx redundantly, resulting in 3 total txs being
9013 assert_eq!(bob_txn.len(), 3);
9014 check_spends!(bob_txn[1], chan_ab.3);
9016 assert_eq!(bob_txn.len(), 2);
9017 check_spends!(bob_txn[0], chan_ab.3);
9022 // Finally, check that Bob broadcasted a preimage-claiming transaction for the HTLC output on the
9023 // broadcasted commitment transaction.
9025 let bob_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
9026 if go_onchain_before_fulfill {
9027 // Bob should now have an extra broadcasted tx, for the preimage-claiming transaction.
9028 assert_eq!(bob_txn.len(), 2);
9030 let script_weight = match broadcast_alice {
9031 true => OFFERED_HTLC_SCRIPT_WEIGHT,
9032 false => ACCEPTED_HTLC_SCRIPT_WEIGHT
9034 // If Alice force-closed and Bob didn't receive her commitment transaction until after he
9035 // received Carol's fulfill, he broadcasts the HTLC-output-claiming transaction first. Else if
9036 // Bob force closed or if he found out about Alice's commitment tx before receiving Carol's
9037 // fulfill, then he broadcasts the HTLC-output-claiming transaction second.
9038 if broadcast_alice && !go_onchain_before_fulfill {
9039 check_spends!(bob_txn[0], txn_to_broadcast[0]);
9040 assert_eq!(bob_txn[0].input[0].witness.last().unwrap().len(), script_weight);
9042 check_spends!(bob_txn[1], txn_to_broadcast[0]);
9043 assert_eq!(bob_txn[1].input[0].witness.last().unwrap().len(), script_weight);
9049 fn test_onchain_htlc_settlement_after_close() {
9050 do_test_onchain_htlc_settlement_after_close(true, true);
9051 do_test_onchain_htlc_settlement_after_close(false, true); // Technically redundant, but may as well
9052 do_test_onchain_htlc_settlement_after_close(true, false);
9053 do_test_onchain_htlc_settlement_after_close(false, false);
9057 fn test_duplicate_chan_id() {
9058 // Test that if a given peer tries to open a channel with the same channel_id as one that is
9059 // already open we reject it and keep the old channel.
9061 // Previously, full_stack_target managed to figure out that if you tried to open two channels
9062 // with the same funding output (ie post-funding channel_id), we'd create a monitor update for
9063 // the existing channel when we detect the duplicate new channel, screwing up our monitor
9064 // updating logic for the existing channel.
9065 let chanmon_cfgs = create_chanmon_cfgs(2);
9066 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
9067 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
9068 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
9070 // Create an initial channel
9071 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
9072 let mut open_chan_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
9073 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_msg);
9074 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()));
9076 // Try to create a second channel with the same temporary_channel_id as the first and check
9077 // that it is rejected.
9078 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_msg);
9080 let events = nodes[1].node.get_and_clear_pending_msg_events();
9081 assert_eq!(events.len(), 1);
9083 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
9084 // Technically, at this point, nodes[1] would be justified in thinking both the
9085 // first (valid) and second (invalid) channels are closed, given they both have
9086 // the same non-temporary channel_id. However, currently we do not, so we just
9087 // move forward with it.
9088 assert_eq!(msg.channel_id, open_chan_msg.temporary_channel_id);
9089 assert_eq!(node_id, nodes[0].node.get_our_node_id());
9091 _ => panic!("Unexpected event"),
9095 // Move the first channel through the funding flow...
9096 let (temporary_channel_id, tx, funding_output) = create_funding_transaction(&nodes[0], 100000, 42);
9098 nodes[0].node.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
9099 check_added_monitors!(nodes[0], 0);
9101 let mut funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
9102 nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created_msg);
9104 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
9105 assert_eq!(added_monitors.len(), 1);
9106 assert_eq!(added_monitors[0].0, funding_output);
9107 added_monitors.clear();
9109 let funding_signed_msg = get_event_msg!(nodes[1], MessageSendEvent::SendFundingSigned, nodes[0].node.get_our_node_id());
9111 let funding_outpoint = ::chain::transaction::OutPoint { txid: funding_created_msg.funding_txid, index: funding_created_msg.funding_output_index };
9112 let channel_id = funding_outpoint.to_channel_id();
9114 // Now we have the first channel past funding_created (ie it has a txid-based channel_id, not a
9117 // First try to open a second channel with a temporary channel id equal to the txid-based one.
9118 // Technically this is allowed by the spec, but we don't support it and there's little reason
9119 // to. Still, it shouldn't cause any other issues.
9120 open_chan_msg.temporary_channel_id = channel_id;
9121 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_msg);
9123 let events = nodes[1].node.get_and_clear_pending_msg_events();
9124 assert_eq!(events.len(), 1);
9126 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
9127 // Technically, at this point, nodes[1] would be justified in thinking both
9128 // channels are closed, but currently we do not, so we just move forward with it.
9129 assert_eq!(msg.channel_id, open_chan_msg.temporary_channel_id);
9130 assert_eq!(node_id, nodes[0].node.get_our_node_id());
9132 _ => panic!("Unexpected event"),
9136 // Now try to create a second channel which has a duplicate funding output.
9137 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
9138 let open_chan_2_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
9139 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_2_msg);
9140 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()));
9141 create_funding_transaction(&nodes[0], 100000, 42); // Get and check the FundingGenerationReady event
9143 let funding_created = {
9144 let mut a_channel_lock = nodes[0].node.channel_state.lock().unwrap();
9145 let mut as_chan = a_channel_lock.by_id.get_mut(&open_chan_2_msg.temporary_channel_id).unwrap();
9146 let logger = test_utils::TestLogger::new();
9147 as_chan.get_outbound_funding_created(tx.clone(), funding_outpoint, &&logger).unwrap()
9149 check_added_monitors!(nodes[0], 0);
9150 nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created);
9151 // At this point we'll try to add a duplicate channel monitor, which will be rejected, but
9152 // still needs to be cleared here.
9153 check_added_monitors!(nodes[1], 1);
9155 // ...still, nodes[1] will reject the duplicate channel.
9157 let events = nodes[1].node.get_and_clear_pending_msg_events();
9158 assert_eq!(events.len(), 1);
9160 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
9161 // Technically, at this point, nodes[1] would be justified in thinking both
9162 // channels are closed, but currently we do not, so we just move forward with it.
9163 assert_eq!(msg.channel_id, channel_id);
9164 assert_eq!(node_id, nodes[0].node.get_our_node_id());
9166 _ => panic!("Unexpected event"),
9170 // finally, finish creating the original channel and send a payment over it to make sure
9171 // everything is functional.
9172 nodes[0].node.handle_funding_signed(&nodes[1].node.get_our_node_id(), &funding_signed_msg);
9174 let mut added_monitors = nodes[0].chain_monitor.added_monitors.lock().unwrap();
9175 assert_eq!(added_monitors.len(), 1);
9176 assert_eq!(added_monitors[0].0, funding_output);
9177 added_monitors.clear();
9180 let events_4 = nodes[0].node.get_and_clear_pending_events();
9181 assert_eq!(events_4.len(), 0);
9182 assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
9183 assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0].txid(), funding_output.txid);
9185 let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
9186 let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
9187 update_nodes_with_chan_announce(&nodes, 0, 1, &announcement, &as_update, &bs_update);
9188 send_payment(&nodes[0], &[&nodes[1]], 8000000);
9192 fn test_error_chans_closed() {
9193 // Test that we properly handle error messages, closing appropriate channels.
9195 // Prior to #787 we'd allow a peer to make us force-close a channel we had with a different
9196 // peer. The "real" fix for that is to index channels with peers_ids, however in the mean time
9197 // we can test various edge cases around it to ensure we don't regress.
9198 let chanmon_cfgs = create_chanmon_cfgs(3);
9199 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
9200 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
9201 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
9203 // Create some initial channels
9204 let chan_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
9205 let chan_2 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
9206 let chan_3 = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 100000, 10001, InitFeatures::known(), InitFeatures::known());
9208 assert_eq!(nodes[0].node.list_usable_channels().len(), 3);
9209 assert_eq!(nodes[1].node.list_usable_channels().len(), 2);
9210 assert_eq!(nodes[2].node.list_usable_channels().len(), 1);
9212 // Closing a channel from a different peer has no effect
9213 nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msgs::ErrorMessage { channel_id: chan_3.2, data: "ERR".to_owned() });
9214 assert_eq!(nodes[0].node.list_usable_channels().len(), 3);
9216 // Closing one channel doesn't impact others
9217 nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msgs::ErrorMessage { channel_id: chan_2.2, data: "ERR".to_owned() });
9218 check_added_monitors!(nodes[0], 1);
9219 check_closed_broadcast!(nodes[0], false);
9220 assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0).len(), 1);
9221 assert_eq!(nodes[0].node.list_usable_channels().len(), 2);
9222 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);
9223 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);
9225 // A null channel ID should close all channels
9226 let _chan_4 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
9227 nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msgs::ErrorMessage { channel_id: [0; 32], data: "ERR".to_owned() });
9228 check_added_monitors!(nodes[0], 2);
9229 let events = nodes[0].node.get_and_clear_pending_msg_events();
9230 assert_eq!(events.len(), 2);
9232 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
9233 assert_eq!(msg.contents.flags & 2, 2);
9235 _ => panic!("Unexpected event"),
9238 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
9239 assert_eq!(msg.contents.flags & 2, 2);
9241 _ => panic!("Unexpected event"),
9243 // Note that at this point users of a standard PeerHandler will end up calling
9244 // peer_disconnected with no_connection_possible set to false, duplicating the
9245 // close-all-channels logic. That's OK, we don't want to end up not force-closing channels for
9246 // users with their own peer handling logic. We duplicate the call here, however.
9247 assert_eq!(nodes[0].node.list_usable_channels().len(), 1);
9248 assert!(nodes[0].node.list_usable_channels()[0].channel_id == chan_3.2);
9250 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), true);
9251 assert_eq!(nodes[0].node.list_usable_channels().len(), 1);
9252 assert!(nodes[0].node.list_usable_channels()[0].channel_id == chan_3.2);
9256 fn test_invalid_funding_tx() {
9257 // Test that we properly handle invalid funding transactions sent to us from a peer.
9259 // Previously, all other major lightning implementations had failed to properly sanitize
9260 // funding transactions from their counterparties, leading to a multi-implementation critical
9261 // security vulnerability (though we always sanitized properly, we've previously had
9262 // un-released crashes in the sanitization process).
9263 let chanmon_cfgs = create_chanmon_cfgs(2);
9264 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
9265 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
9266 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
9268 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100_000, 10_000, 42, None).unwrap();
9269 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()));
9270 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()));
9272 let (temporary_channel_id, mut tx, _) = create_funding_transaction(&nodes[0], 100_000, 42);
9273 for output in tx.output.iter_mut() {
9274 // Make the confirmed funding transaction have a bogus script_pubkey
9275 output.script_pubkey = bitcoin::Script::new();
9278 nodes[0].node.funding_transaction_generated_unchecked(&temporary_channel_id, tx.clone(), 0).unwrap();
9279 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()));
9280 check_added_monitors!(nodes[1], 1);
9282 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()));
9283 check_added_monitors!(nodes[0], 1);
9285 let events_1 = nodes[0].node.get_and_clear_pending_events();
9286 assert_eq!(events_1.len(), 0);
9288 assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
9289 assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0], tx);
9290 nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
9292 confirm_transaction_at(&nodes[1], &tx, 1);
9293 check_added_monitors!(nodes[1], 1);
9294 let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
9295 assert_eq!(events_2.len(), 1);
9296 if let MessageSendEvent::HandleError { node_id, action } = &events_2[0] {
9297 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
9298 if let msgs::ErrorAction::SendErrorMessage { msg } = action {
9299 assert_eq!(msg.data, "funding tx had wrong script/value or output index");
9300 } else { panic!(); }
9301 } else { panic!(); }
9302 assert_eq!(nodes[1].node.list_channels().len(), 0);