1 // This file is Copyright its original authors, visible in version control
4 // This file is licensed under the Apache License, Version 2.0 <LICENSE-APACHE
5 // or http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
6 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your option.
7 // You may not use this file except in accordance with one or both of these
10 //! Tests that test standing up a network of ChannelManagers, creating channels, sending
11 //! payments/messages between them, and often checking the resulting ChannelMonitors are able to
12 //! claim outputs on-chain.
15 use chain::{Confirm, Listen, Watch};
16 use chain::channelmonitor;
17 use chain::channelmonitor::{ChannelMonitor, CLTV_CLAIM_BUFFER, LATENCY_GRACE_PERIOD_BLOCKS, ANTI_REORG_DELAY};
18 use chain::transaction::OutPoint;
19 use chain::keysinterface::{KeysInterface, BaseSign};
20 use ln::{PaymentPreimage, PaymentSecret, PaymentHash};
21 use ln::channel::{COMMITMENT_TX_BASE_WEIGHT, COMMITMENT_TX_WEIGHT_PER_HTLC};
22 use ln::channelmanager::{ChannelManager, ChannelManagerReadArgs, RAACommitmentOrder, PaymentSendFailure, BREAKDOWN_TIMEOUT, MIN_CLTV_EXPIRY_DELTA};
23 use ln::channel::{Channel, ChannelError};
24 use ln::{chan_utils, onion_utils};
25 use ln::chan_utils::HTLC_SUCCESS_TX_WEIGHT;
26 use routing::router::{Route, RouteHop, RouteHint, RouteHintHop, get_route, get_keysend_route};
27 use routing::network_graph::RoutingFees;
28 use ln::features::{ChannelFeatures, InitFeatures, InvoiceFeatures, NodeFeatures};
30 use ln::msgs::{ChannelMessageHandler,RoutingMessageHandler,HTLCFailChannelUpdate, ErrorAction};
31 use util::enforcing_trait_impls::EnforcingSigner;
32 use util::{byte_utils, test_utils};
33 use util::events::{Event, MessageSendEvent, MessageSendEventsProvider, PaymentPurpose};
34 use util::errors::APIError;
35 use util::ser::{Writeable, ReadableArgs};
36 use util::config::UserConfig;
38 use bitcoin::hashes::sha256d::Hash as Sha256dHash;
39 use bitcoin::hash_types::{Txid, BlockHash};
40 use bitcoin::blockdata::block::{Block, BlockHeader};
41 use bitcoin::blockdata::script::Builder;
42 use bitcoin::blockdata::opcodes;
43 use bitcoin::blockdata::constants::genesis_block;
44 use bitcoin::network::constants::Network;
46 use bitcoin::hashes::sha256::Hash as Sha256;
47 use bitcoin::hashes::Hash;
49 use bitcoin::secp256k1::{Secp256k1, Message};
50 use bitcoin::secp256k1::key::{PublicKey,SecretKey};
56 use alloc::collections::BTreeSet;
57 use core::default::Default;
58 use sync::{Arc, Mutex};
60 use ln::functional_test_utils::*;
61 use ln::chan_utils::CommitmentTransaction;
62 use ln::msgs::OptionalField::Present;
65 fn test_insane_channel_opens() {
66 // Stand up a network of 2 nodes
67 let chanmon_cfgs = create_chanmon_cfgs(2);
68 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
69 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
70 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
72 // Instantiate channel parameters where we push the maximum msats given our
74 let channel_value_sat = 31337; // same as funding satoshis
75 let channel_reserve_satoshis = Channel::<EnforcingSigner>::get_holder_selected_channel_reserve_satoshis(channel_value_sat);
76 let push_msat = (channel_value_sat - channel_reserve_satoshis) * 1000;
78 // Have node0 initiate a channel to node1 with aforementioned parameters
79 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_sat, push_msat, 42, None).unwrap();
81 // Extract the channel open message from node0 to node1
82 let open_channel_message = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
84 // Test helper that asserts we get the correct error string given a mutator
85 // that supposedly makes the channel open message insane
86 let insane_open_helper = |expected_error_str: &str, message_mutator: fn(msgs::OpenChannel) -> msgs::OpenChannel| {
87 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &message_mutator(open_channel_message.clone()));
88 let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
89 assert_eq!(msg_events.len(), 1);
90 let expected_regex = regex::Regex::new(expected_error_str).unwrap();
91 if let MessageSendEvent::HandleError { ref action, .. } = msg_events[0] {
93 &ErrorAction::SendErrorMessage { .. } => {
94 nodes[1].logger.assert_log_regex("lightning::ln::channelmanager".to_string(), expected_regex, 1);
96 _ => panic!("unexpected event!"),
98 } else { assert!(false); }
101 use ln::channel::MAX_FUNDING_SATOSHIS;
102 use ln::channelmanager::MAX_LOCAL_BREAKDOWN_TIMEOUT;
104 // Test all mutations that would make the channel open message insane
105 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 });
107 insane_open_helper("Bogus channel_reserve_satoshis", |mut msg| { msg.channel_reserve_satoshis = msg.funding_satoshis + 1; msg });
109 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 });
111 insane_open_helper("Peer never wants payout outputs?", |mut msg| { msg.dust_limit_satoshis = msg.funding_satoshis + 1 ; msg });
113 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 });
115 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 });
117 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 });
119 insane_open_helper("0 max_accepted_htlcs makes for a useless channel", |mut msg| { msg.max_accepted_htlcs = 0; msg });
121 insane_open_helper("max_accepted_htlcs was 484. It must not be larger than 483", |mut msg| { msg.max_accepted_htlcs = 484; msg });
125 fn test_async_inbound_update_fee() {
126 let chanmon_cfgs = create_chanmon_cfgs(2);
127 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
128 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
129 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
130 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
131 let logger = test_utils::TestLogger::new();
132 let channel_id = chan.2;
135 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
139 // send (1) commitment_signed -.
140 // <- update_add_htlc/commitment_signed
141 // send (2) RAA (awaiting remote revoke) -.
142 // (1) commitment_signed is delivered ->
143 // .- send (3) RAA (awaiting remote revoke)
144 // (2) RAA is delivered ->
145 // .- send (4) commitment_signed
146 // <- (3) RAA is delivered
147 // send (5) commitment_signed -.
148 // <- (4) commitment_signed is delivered
150 // (5) commitment_signed is delivered ->
152 // (6) RAA is delivered ->
154 // First nodes[0] generates an update_fee
155 nodes[0].node.update_fee(channel_id, get_feerate!(nodes[0], channel_id) + 20).unwrap();
156 check_added_monitors!(nodes[0], 1);
158 let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
159 assert_eq!(events_0.len(), 1);
160 let (update_msg, commitment_signed) = match events_0[0] { // (1)
161 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
162 (update_fee.as_ref(), commitment_signed)
164 _ => panic!("Unexpected event"),
167 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
169 // ...but before it's delivered, nodes[1] starts to send a payment back to nodes[0]...
170 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[0]);
171 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
172 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();
173 check_added_monitors!(nodes[1], 1);
175 let payment_event = {
176 let mut events_1 = nodes[1].node.get_and_clear_pending_msg_events();
177 assert_eq!(events_1.len(), 1);
178 SendEvent::from_event(events_1.remove(0))
180 assert_eq!(payment_event.node_id, nodes[0].node.get_our_node_id());
181 assert_eq!(payment_event.msgs.len(), 1);
183 // ...now when the messages get delivered everyone should be happy
184 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
185 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg); // (2)
186 let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
187 // nodes[0] is awaiting nodes[1] revoke_and_ack so get_event_msg's assert(len == 1) passes
188 check_added_monitors!(nodes[0], 1);
190 // deliver(1), generate (3):
191 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
192 let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
193 // nodes[1] is awaiting nodes[0] revoke_and_ack so get_event_msg's assert(len == 1) passes
194 check_added_monitors!(nodes[1], 1);
196 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack); // deliver (2)
197 let bs_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
198 assert!(bs_update.update_add_htlcs.is_empty()); // (4)
199 assert!(bs_update.update_fulfill_htlcs.is_empty()); // (4)
200 assert!(bs_update.update_fail_htlcs.is_empty()); // (4)
201 assert!(bs_update.update_fail_malformed_htlcs.is_empty()); // (4)
202 assert!(bs_update.update_fee.is_none()); // (4)
203 check_added_monitors!(nodes[1], 1);
205 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack); // deliver (3)
206 let as_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
207 assert!(as_update.update_add_htlcs.is_empty()); // (5)
208 assert!(as_update.update_fulfill_htlcs.is_empty()); // (5)
209 assert!(as_update.update_fail_htlcs.is_empty()); // (5)
210 assert!(as_update.update_fail_malformed_htlcs.is_empty()); // (5)
211 assert!(as_update.update_fee.is_none()); // (5)
212 check_added_monitors!(nodes[0], 1);
214 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_update.commitment_signed); // deliver (4)
215 let as_second_revoke = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
216 // only (6) so get_event_msg's assert(len == 1) passes
217 check_added_monitors!(nodes[0], 1);
219 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_update.commitment_signed); // deliver (5)
220 let bs_second_revoke = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
221 check_added_monitors!(nodes[1], 1);
223 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke);
224 check_added_monitors!(nodes[0], 1);
226 let events_2 = nodes[0].node.get_and_clear_pending_events();
227 assert_eq!(events_2.len(), 1);
229 Event::PendingHTLCsForwardable {..} => {}, // If we actually processed we'd receive the payment
230 _ => panic!("Unexpected event"),
233 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_revoke); // deliver (6)
234 check_added_monitors!(nodes[1], 1);
238 fn test_update_fee_unordered_raa() {
239 // Just the intro to the previous test followed by an out-of-order RAA (which caused a
240 // crash in an earlier version of the update_fee patch)
241 let chanmon_cfgs = create_chanmon_cfgs(2);
242 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
243 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
244 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
245 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
246 let channel_id = chan.2;
247 let logger = test_utils::TestLogger::new();
250 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
252 // First nodes[0] generates an update_fee
253 nodes[0].node.update_fee(channel_id, get_feerate!(nodes[0], channel_id) + 20).unwrap();
254 check_added_monitors!(nodes[0], 1);
256 let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
257 assert_eq!(events_0.len(), 1);
258 let update_msg = match events_0[0] { // (1)
259 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, .. }, .. } => {
262 _ => panic!("Unexpected event"),
265 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
267 // ...but before it's delivered, nodes[1] starts to send a payment back to nodes[0]...
268 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[0]);
269 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
270 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();
271 check_added_monitors!(nodes[1], 1);
273 let payment_event = {
274 let mut events_1 = nodes[1].node.get_and_clear_pending_msg_events();
275 assert_eq!(events_1.len(), 1);
276 SendEvent::from_event(events_1.remove(0))
278 assert_eq!(payment_event.node_id, nodes[0].node.get_our_node_id());
279 assert_eq!(payment_event.msgs.len(), 1);
281 // ...now when the messages get delivered everyone should be happy
282 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
283 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg); // (2)
284 let as_revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
285 // nodes[0] is awaiting nodes[1] revoke_and_ack so get_event_msg's assert(len == 1) passes
286 check_added_monitors!(nodes[0], 1);
288 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_msg); // deliver (2)
289 check_added_monitors!(nodes[1], 1);
291 // We can't continue, sadly, because our (1) now has a bogus signature
295 fn test_multi_flight_update_fee() {
296 let chanmon_cfgs = create_chanmon_cfgs(2);
297 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
298 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
299 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
300 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
301 let channel_id = chan.2;
304 // update_fee/commitment_signed ->
305 // .- send (1) RAA and (2) commitment_signed
306 // update_fee (never committed) ->
308 // We have to manually generate the above update_fee, it is allowed by the protocol but we
309 // don't track which updates correspond to which revoke_and_ack responses so we're in
310 // AwaitingRAA mode and will not generate the update_fee yet.
311 // <- (1) RAA delivered
312 // (3) is generated and send (4) CS -.
313 // Note that A cannot generate (4) prior to (1) being delivered as it otherwise doesn't
314 // know the per_commitment_point to use for it.
315 // <- (2) commitment_signed delivered
317 // B should send no response here
318 // (4) commitment_signed delivered ->
319 // <- RAA/commitment_signed delivered
322 // First nodes[0] generates an update_fee
323 let initial_feerate = get_feerate!(nodes[0], channel_id);
324 nodes[0].node.update_fee(channel_id, initial_feerate + 20).unwrap();
325 check_added_monitors!(nodes[0], 1);
327 let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
328 assert_eq!(events_0.len(), 1);
329 let (update_msg_1, commitment_signed_1) = match events_0[0] { // (1)
330 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
331 (update_fee.as_ref().unwrap(), commitment_signed)
333 _ => panic!("Unexpected event"),
336 // Deliver first update_fee/commitment_signed pair, generating (1) and (2):
337 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg_1);
338 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed_1);
339 let (bs_revoke_msg, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
340 check_added_monitors!(nodes[1], 1);
342 // nodes[0] is awaiting a revoke from nodes[1] before it will create a new commitment
344 nodes[0].node.update_fee(channel_id, initial_feerate + 40).unwrap();
345 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
346 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
348 // Create the (3) update_fee message that nodes[0] will generate before it does...
349 let mut update_msg_2 = msgs::UpdateFee {
350 channel_id: update_msg_1.channel_id.clone(),
351 feerate_per_kw: (initial_feerate + 30) as u32,
354 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg_2);
356 update_msg_2.feerate_per_kw = (initial_feerate + 40) as u32;
358 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg_2);
360 // Deliver (1), generating (3) and (4)
361 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_msg);
362 let as_second_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
363 check_added_monitors!(nodes[0], 1);
364 assert!(as_second_update.update_add_htlcs.is_empty());
365 assert!(as_second_update.update_fulfill_htlcs.is_empty());
366 assert!(as_second_update.update_fail_htlcs.is_empty());
367 assert!(as_second_update.update_fail_malformed_htlcs.is_empty());
368 // Check that the update_fee newly generated matches what we delivered:
369 assert_eq!(as_second_update.update_fee.as_ref().unwrap().channel_id, update_msg_2.channel_id);
370 assert_eq!(as_second_update.update_fee.as_ref().unwrap().feerate_per_kw, update_msg_2.feerate_per_kw);
372 // Deliver (2) commitment_signed
373 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_commitment_signed);
374 let as_revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
375 check_added_monitors!(nodes[0], 1);
376 // No commitment_signed so get_event_msg's assert(len == 1) passes
378 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_msg);
379 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
380 check_added_monitors!(nodes[1], 1);
383 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_second_update.commitment_signed);
384 let (bs_second_revoke, bs_second_commitment) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
385 check_added_monitors!(nodes[1], 1);
387 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke);
388 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
389 check_added_monitors!(nodes[0], 1);
391 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_commitment);
392 let as_second_revoke = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
393 // No commitment_signed so get_event_msg's assert(len == 1) passes
394 check_added_monitors!(nodes[0], 1);
396 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_revoke);
397 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
398 check_added_monitors!(nodes[1], 1);
401 fn do_test_1_conf_open(connect_style: ConnectStyle) {
402 // Previously, if the minium_depth config was set to 1, we'd never send a funding_locked. This
403 // tests that we properly send one in that case.
404 let mut alice_config = UserConfig::default();
405 alice_config.own_channel_config.minimum_depth = 1;
406 alice_config.channel_options.announced_channel = true;
407 alice_config.peer_channel_config_limits.force_announced_channel_preference = false;
408 let mut bob_config = UserConfig::default();
409 bob_config.own_channel_config.minimum_depth = 1;
410 bob_config.channel_options.announced_channel = true;
411 bob_config.peer_channel_config_limits.force_announced_channel_preference = false;
412 let chanmon_cfgs = create_chanmon_cfgs(2);
413 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
414 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[Some(alice_config), Some(bob_config)]);
415 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
416 *nodes[0].connect_style.borrow_mut() = connect_style;
418 let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
419 mine_transaction(&nodes[1], &tx);
420 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()));
422 mine_transaction(&nodes[0], &tx);
423 let (funding_locked, _) = create_chan_between_nodes_with_value_confirm_second(&nodes[1], &nodes[0]);
424 let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
427 assert!(node.net_graph_msg_handler.handle_channel_announcement(&announcement).unwrap());
428 node.net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
429 node.net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
433 fn test_1_conf_open() {
434 do_test_1_conf_open(ConnectStyle::BestBlockFirst);
435 do_test_1_conf_open(ConnectStyle::TransactionsFirst);
436 do_test_1_conf_open(ConnectStyle::FullBlockViaListen);
439 fn do_test_sanity_on_in_flight_opens(steps: u8) {
440 // Previously, we had issues deserializing channels when we hadn't connected the first block
441 // after creation. To catch that and similar issues, we lean on the Node::drop impl to test
442 // serialization round-trips and simply do steps towards opening a channel and then drop the
445 let chanmon_cfgs = create_chanmon_cfgs(2);
446 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
447 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
448 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
450 if steps & 0b1000_0000 != 0{
452 header: BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
455 connect_block(&nodes[0], &block);
456 connect_block(&nodes[1], &block);
459 if steps & 0x0f == 0 { return; }
460 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
461 let open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
463 if steps & 0x0f == 1 { return; }
464 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_channel);
465 let accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
467 if steps & 0x0f == 2 { return; }
468 nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &accept_channel);
470 let (temporary_channel_id, tx, funding_output) = create_funding_transaction(&nodes[0], 100000, 42);
472 if steps & 0x0f == 3 { return; }
473 nodes[0].node.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
474 check_added_monitors!(nodes[0], 0);
475 let funding_created = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
477 if steps & 0x0f == 4 { return; }
478 nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created);
480 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
481 assert_eq!(added_monitors.len(), 1);
482 assert_eq!(added_monitors[0].0, funding_output);
483 added_monitors.clear();
485 let funding_signed = get_event_msg!(nodes[1], MessageSendEvent::SendFundingSigned, nodes[0].node.get_our_node_id());
487 if steps & 0x0f == 5 { return; }
488 nodes[0].node.handle_funding_signed(&nodes[1].node.get_our_node_id(), &funding_signed);
490 let mut added_monitors = nodes[0].chain_monitor.added_monitors.lock().unwrap();
491 assert_eq!(added_monitors.len(), 1);
492 assert_eq!(added_monitors[0].0, funding_output);
493 added_monitors.clear();
496 let events_4 = nodes[0].node.get_and_clear_pending_events();
497 assert_eq!(events_4.len(), 0);
499 if steps & 0x0f == 6 { return; }
500 create_chan_between_nodes_with_value_confirm_first(&nodes[0], &nodes[1], &tx, 2);
502 if steps & 0x0f == 7 { return; }
503 confirm_transaction_at(&nodes[0], &tx, 2);
504 connect_blocks(&nodes[0], CHAN_CONFIRM_DEPTH);
505 create_chan_between_nodes_with_value_confirm_second(&nodes[1], &nodes[0]);
509 fn test_sanity_on_in_flight_opens() {
510 do_test_sanity_on_in_flight_opens(0);
511 do_test_sanity_on_in_flight_opens(0 | 0b1000_0000);
512 do_test_sanity_on_in_flight_opens(1);
513 do_test_sanity_on_in_flight_opens(1 | 0b1000_0000);
514 do_test_sanity_on_in_flight_opens(2);
515 do_test_sanity_on_in_flight_opens(2 | 0b1000_0000);
516 do_test_sanity_on_in_flight_opens(3);
517 do_test_sanity_on_in_flight_opens(3 | 0b1000_0000);
518 do_test_sanity_on_in_flight_opens(4);
519 do_test_sanity_on_in_flight_opens(4 | 0b1000_0000);
520 do_test_sanity_on_in_flight_opens(5);
521 do_test_sanity_on_in_flight_opens(5 | 0b1000_0000);
522 do_test_sanity_on_in_flight_opens(6);
523 do_test_sanity_on_in_flight_opens(6 | 0b1000_0000);
524 do_test_sanity_on_in_flight_opens(7);
525 do_test_sanity_on_in_flight_opens(7 | 0b1000_0000);
526 do_test_sanity_on_in_flight_opens(8);
527 do_test_sanity_on_in_flight_opens(8 | 0b1000_0000);
531 fn test_update_fee_vanilla() {
532 let chanmon_cfgs = create_chanmon_cfgs(2);
533 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
534 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
535 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
536 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
537 let channel_id = chan.2;
539 let feerate = get_feerate!(nodes[0], channel_id);
540 nodes[0].node.update_fee(channel_id, feerate+25).unwrap();
541 check_added_monitors!(nodes[0], 1);
543 let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
544 assert_eq!(events_0.len(), 1);
545 let (update_msg, commitment_signed) = match events_0[0] {
546 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 } } => {
547 (update_fee.as_ref(), commitment_signed)
549 _ => panic!("Unexpected event"),
551 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
553 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
554 let (revoke_msg, commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
555 check_added_monitors!(nodes[1], 1);
557 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
558 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
559 check_added_monitors!(nodes[0], 1);
561 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
562 let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
563 // No commitment_signed so get_event_msg's assert(len == 1) passes
564 check_added_monitors!(nodes[0], 1);
566 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg);
567 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
568 check_added_monitors!(nodes[1], 1);
572 fn test_update_fee_that_funder_cannot_afford() {
573 let chanmon_cfgs = create_chanmon_cfgs(2);
574 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
575 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
576 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
577 let channel_value = 1888;
578 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, channel_value, 700000, InitFeatures::known(), InitFeatures::known());
579 let channel_id = chan.2;
582 nodes[0].node.update_fee(channel_id, feerate).unwrap();
583 check_added_monitors!(nodes[0], 1);
584 let update_msg = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
586 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg.update_fee.unwrap());
588 commitment_signed_dance!(nodes[1], nodes[0], update_msg.commitment_signed, false);
590 //Confirm that the new fee based on the last local commitment txn is what we expected based on the feerate of 260 set above.
591 //This value results in a fee that is exactly what the funder can afford (277 sat + 1000 sat channel reserve)
593 let commitment_tx = get_local_commitment_txn!(nodes[1], channel_id)[0].clone();
595 //We made sure neither party's funds are below the dust limit so -2 non-HTLC txns from number of outputs
596 let num_htlcs = commitment_tx.output.len() - 2;
597 let total_fee: u64 = feerate as u64 * (COMMITMENT_TX_BASE_WEIGHT + (num_htlcs as u64) * COMMITMENT_TX_WEIGHT_PER_HTLC) / 1000;
598 let mut actual_fee = commitment_tx.output.iter().fold(0, |acc, output| acc + output.value);
599 actual_fee = channel_value - actual_fee;
600 assert_eq!(total_fee, actual_fee);
603 //Add 2 to the previous fee rate to the final fee increases by 1 (with no HTLCs the fee is essentially
604 //fee_rate*(724/1000) so the increment of 1*0.724 is rounded back down)
605 nodes[0].node.update_fee(channel_id, feerate+2).unwrap();
606 check_added_monitors!(nodes[0], 1);
608 let update2_msg = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
610 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update2_msg.update_fee.unwrap());
612 //While producing the commitment_signed response after handling a received update_fee request the
613 //check to see if the funder, who sent the update_fee request, can afford the new fee (funder_balance >= fee+channel_reserve)
614 //Should produce and error.
615 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &update2_msg.commitment_signed);
616 nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Funding remote cannot afford proposed new fee".to_string(), 1);
617 check_added_monitors!(nodes[1], 1);
618 check_closed_broadcast!(nodes[1], true);
622 fn test_update_fee_with_fundee_update_add_htlc() {
623 let chanmon_cfgs = create_chanmon_cfgs(2);
624 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
625 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
626 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
627 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
628 let channel_id = chan.2;
629 let logger = test_utils::TestLogger::new();
632 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
634 let feerate = get_feerate!(nodes[0], channel_id);
635 nodes[0].node.update_fee(channel_id, feerate+20).unwrap();
636 check_added_monitors!(nodes[0], 1);
638 let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
639 assert_eq!(events_0.len(), 1);
640 let (update_msg, commitment_signed) = match events_0[0] {
641 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 } } => {
642 (update_fee.as_ref(), commitment_signed)
644 _ => panic!("Unexpected event"),
646 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
647 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
648 let (revoke_msg, commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
649 check_added_monitors!(nodes[1], 1);
651 let (our_payment_preimage, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[0]);
652 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
653 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();
655 // nothing happens since node[1] is in AwaitingRemoteRevoke
656 nodes[1].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
658 let mut added_monitors = nodes[0].chain_monitor.added_monitors.lock().unwrap();
659 assert_eq!(added_monitors.len(), 0);
660 added_monitors.clear();
662 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
663 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
664 // node[1] has nothing to do
666 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
667 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
668 check_added_monitors!(nodes[0], 1);
670 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
671 let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
672 // No commitment_signed so get_event_msg's assert(len == 1) passes
673 check_added_monitors!(nodes[0], 1);
674 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg);
675 check_added_monitors!(nodes[1], 1);
676 // AwaitingRemoteRevoke ends here
678 let commitment_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
679 assert_eq!(commitment_update.update_add_htlcs.len(), 1);
680 assert_eq!(commitment_update.update_fulfill_htlcs.len(), 0);
681 assert_eq!(commitment_update.update_fail_htlcs.len(), 0);
682 assert_eq!(commitment_update.update_fail_malformed_htlcs.len(), 0);
683 assert_eq!(commitment_update.update_fee.is_none(), true);
685 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &commitment_update.update_add_htlcs[0]);
686 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_update.commitment_signed);
687 check_added_monitors!(nodes[0], 1);
688 let (revoke, commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
690 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke);
691 check_added_monitors!(nodes[1], 1);
692 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
694 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commitment_signed);
695 check_added_monitors!(nodes[1], 1);
696 let revoke = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
697 // No commitment_signed so get_event_msg's assert(len == 1) passes
699 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke);
700 check_added_monitors!(nodes[0], 1);
701 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
703 expect_pending_htlcs_forwardable!(nodes[0]);
705 let events = nodes[0].node.get_and_clear_pending_events();
706 assert_eq!(events.len(), 1);
708 Event::PaymentReceived { .. } => { },
709 _ => panic!("Unexpected event"),
712 claim_payment(&nodes[1], &vec!(&nodes[0])[..], our_payment_preimage);
714 send_payment(&nodes[1], &vec!(&nodes[0])[..], 800000);
715 send_payment(&nodes[0], &vec!(&nodes[1])[..], 800000);
716 close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true);
720 fn test_update_fee() {
721 let chanmon_cfgs = create_chanmon_cfgs(2);
722 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
723 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
724 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
725 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
726 let channel_id = chan.2;
729 // (1) update_fee/commitment_signed ->
730 // <- (2) revoke_and_ack
731 // .- send (3) commitment_signed
732 // (4) update_fee/commitment_signed ->
733 // .- send (5) revoke_and_ack (no CS as we're awaiting a revoke)
734 // <- (3) commitment_signed delivered
735 // send (6) revoke_and_ack -.
736 // <- (5) deliver revoke_and_ack
737 // (6) deliver revoke_and_ack ->
738 // .- send (7) commitment_signed in response to (4)
739 // <- (7) deliver commitment_signed
742 // Create and deliver (1)...
743 let feerate = get_feerate!(nodes[0], channel_id);
744 nodes[0].node.update_fee(channel_id, feerate+20).unwrap();
745 check_added_monitors!(nodes[0], 1);
747 let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
748 assert_eq!(events_0.len(), 1);
749 let (update_msg, commitment_signed) = match events_0[0] {
750 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 } } => {
751 (update_fee.as_ref(), commitment_signed)
753 _ => panic!("Unexpected event"),
755 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
757 // Generate (2) and (3):
758 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
759 let (revoke_msg, commitment_signed_0) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
760 check_added_monitors!(nodes[1], 1);
763 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
764 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
765 check_added_monitors!(nodes[0], 1);
767 // Create and deliver (4)...
768 nodes[0].node.update_fee(channel_id, feerate+30).unwrap();
769 check_added_monitors!(nodes[0], 1);
770 let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
771 assert_eq!(events_0.len(), 1);
772 let (update_msg, commitment_signed) = match events_0[0] {
773 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 } } => {
774 (update_fee.as_ref(), commitment_signed)
776 _ => panic!("Unexpected event"),
779 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
780 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
781 check_added_monitors!(nodes[1], 1);
783 let revoke_msg = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
784 // No commitment_signed so get_event_msg's assert(len == 1) passes
786 // Handle (3), creating (6):
787 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed_0);
788 check_added_monitors!(nodes[0], 1);
789 let revoke_msg_0 = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
790 // No commitment_signed so get_event_msg's assert(len == 1) passes
793 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
794 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
795 check_added_monitors!(nodes[0], 1);
797 // Deliver (6), creating (7):
798 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg_0);
799 let commitment_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
800 assert!(commitment_update.update_add_htlcs.is_empty());
801 assert!(commitment_update.update_fulfill_htlcs.is_empty());
802 assert!(commitment_update.update_fail_htlcs.is_empty());
803 assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
804 assert!(commitment_update.update_fee.is_none());
805 check_added_monitors!(nodes[1], 1);
808 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_update.commitment_signed);
809 check_added_monitors!(nodes[0], 1);
810 let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
811 // No commitment_signed so get_event_msg's assert(len == 1) passes
813 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg);
814 check_added_monitors!(nodes[1], 1);
815 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
817 assert_eq!(get_feerate!(nodes[0], channel_id), feerate + 30);
818 assert_eq!(get_feerate!(nodes[1], channel_id), feerate + 30);
819 close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true);
823 fn pre_funding_lock_shutdown_test() {
824 // Test sending a shutdown prior to funding_locked after funding generation
825 let chanmon_cfgs = create_chanmon_cfgs(2);
826 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
827 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
828 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
829 let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 8000000, 0, InitFeatures::known(), InitFeatures::known());
830 mine_transaction(&nodes[0], &tx);
831 mine_transaction(&nodes[1], &tx);
833 nodes[0].node.close_channel(&OutPoint { txid: tx.txid(), index: 0 }.to_channel_id()).unwrap();
834 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
835 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
836 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
837 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_shutdown);
839 let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
840 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
841 let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
842 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
843 let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
844 assert!(node_0_none.is_none());
846 assert!(nodes[0].node.list_channels().is_empty());
847 assert!(nodes[1].node.list_channels().is_empty());
851 fn updates_shutdown_wait() {
852 // Test sending a shutdown with outstanding updates pending
853 let chanmon_cfgs = create_chanmon_cfgs(3);
854 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
855 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
856 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
857 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
858 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
859 let logger = test_utils::TestLogger::new();
861 let (our_payment_preimage, _, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100000);
863 nodes[0].node.close_channel(&chan_1.2).unwrap();
864 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
865 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
866 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
867 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_shutdown);
869 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
870 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
872 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[0]);
874 let net_graph_msg_handler0 = &nodes[0].net_graph_msg_handler;
875 let net_graph_msg_handler1 = &nodes[1].net_graph_msg_handler;
876 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();
877 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();
878 unwrap_send_err!(nodes[0].node.send_payment(&route_1, payment_hash, &Some(payment_secret)), true, APIError::ChannelUnavailable {..}, {});
879 unwrap_send_err!(nodes[1].node.send_payment(&route_2, payment_hash, &Some(payment_secret)), true, APIError::ChannelUnavailable {..}, {});
881 assert!(nodes[2].node.claim_funds(our_payment_preimage));
882 check_added_monitors!(nodes[2], 1);
883 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
884 assert!(updates.update_add_htlcs.is_empty());
885 assert!(updates.update_fail_htlcs.is_empty());
886 assert!(updates.update_fail_malformed_htlcs.is_empty());
887 assert!(updates.update_fee.is_none());
888 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
889 nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
890 expect_payment_forwarded!(nodes[1], Some(1000), false);
891 check_added_monitors!(nodes[1], 1);
892 let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
893 commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
895 assert!(updates_2.update_add_htlcs.is_empty());
896 assert!(updates_2.update_fail_htlcs.is_empty());
897 assert!(updates_2.update_fail_malformed_htlcs.is_empty());
898 assert!(updates_2.update_fee.is_none());
899 assert_eq!(updates_2.update_fulfill_htlcs.len(), 1);
900 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fulfill_htlcs[0]);
901 commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
903 let events = nodes[0].node.get_and_clear_pending_events();
904 assert_eq!(events.len(), 1);
906 Event::PaymentSent { ref payment_preimage } => {
907 assert_eq!(our_payment_preimage, *payment_preimage);
909 _ => panic!("Unexpected event"),
912 let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
913 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
914 let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
915 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
916 let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
917 assert!(node_0_none.is_none());
919 assert!(nodes[0].node.list_channels().is_empty());
921 assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
922 nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
923 close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
924 assert!(nodes[1].node.list_channels().is_empty());
925 assert!(nodes[2].node.list_channels().is_empty());
929 fn htlc_fail_async_shutdown() {
930 // Test HTLCs fail if shutdown starts even if messages are delivered out-of-order
931 let chanmon_cfgs = create_chanmon_cfgs(3);
932 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
933 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
934 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
935 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
936 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
937 let logger = test_utils::TestLogger::new();
939 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[2]);
940 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
941 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();
942 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
943 check_added_monitors!(nodes[0], 1);
944 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
945 assert_eq!(updates.update_add_htlcs.len(), 1);
946 assert!(updates.update_fulfill_htlcs.is_empty());
947 assert!(updates.update_fail_htlcs.is_empty());
948 assert!(updates.update_fail_malformed_htlcs.is_empty());
949 assert!(updates.update_fee.is_none());
951 nodes[1].node.close_channel(&chan_1.2).unwrap();
952 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
953 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_shutdown);
954 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
956 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
957 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &updates.commitment_signed);
958 check_added_monitors!(nodes[1], 1);
959 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
960 commitment_signed_dance!(nodes[1], nodes[0], (), false, true, false);
962 let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
963 assert!(updates_2.update_add_htlcs.is_empty());
964 assert!(updates_2.update_fulfill_htlcs.is_empty());
965 assert_eq!(updates_2.update_fail_htlcs.len(), 1);
966 assert!(updates_2.update_fail_malformed_htlcs.is_empty());
967 assert!(updates_2.update_fee.is_none());
969 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fail_htlcs[0]);
970 commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
972 expect_payment_failed!(nodes[0], our_payment_hash, false);
974 let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
975 assert_eq!(msg_events.len(), 2);
976 let node_0_closing_signed = match msg_events[0] {
977 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
978 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
981 _ => panic!("Unexpected event"),
983 match msg_events[1] {
984 MessageSendEvent::PaymentFailureNetworkUpdate { update: msgs::HTLCFailChannelUpdate::ChannelUpdateMessage { ref msg }} => {
985 assert_eq!(msg.contents.short_channel_id, chan_1.0.contents.short_channel_id);
987 _ => panic!("Unexpected event"),
990 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
991 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
992 let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
993 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
994 let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
995 assert!(node_0_none.is_none());
997 assert!(nodes[0].node.list_channels().is_empty());
999 assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
1000 nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
1001 close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
1002 assert!(nodes[1].node.list_channels().is_empty());
1003 assert!(nodes[2].node.list_channels().is_empty());
1006 fn do_test_shutdown_rebroadcast(recv_count: u8) {
1007 // Test that shutdown/closing_signed is re-sent on reconnect with a variable number of
1008 // messages delivered prior to disconnect
1009 let chanmon_cfgs = create_chanmon_cfgs(3);
1010 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1011 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1012 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1013 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
1014 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
1016 let (our_payment_preimage, _, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100000);
1018 nodes[1].node.close_channel(&chan_1.2).unwrap();
1019 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
1021 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_shutdown);
1022 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
1024 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
1028 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
1029 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
1031 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1032 let node_0_reestablish = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
1033 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1034 let node_1_reestablish = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
1036 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_reestablish);
1037 let node_1_2nd_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
1038 assert!(node_1_shutdown == node_1_2nd_shutdown);
1040 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &node_1_reestablish);
1041 let node_0_2nd_shutdown = if recv_count > 0 {
1042 let node_0_2nd_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
1043 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_2nd_shutdown);
1046 let node_0_chan_update = get_event_msg!(nodes[0], MessageSendEvent::SendChannelUpdate, nodes[1].node.get_our_node_id());
1047 assert_eq!(node_0_chan_update.contents.flags & 2, 0); // "disabled" flag must not be set as we just reconnected.
1048 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_2nd_shutdown);
1049 get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id())
1051 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_2nd_shutdown);
1053 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1054 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1056 assert!(nodes[2].node.claim_funds(our_payment_preimage));
1057 check_added_monitors!(nodes[2], 1);
1058 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1059 assert!(updates.update_add_htlcs.is_empty());
1060 assert!(updates.update_fail_htlcs.is_empty());
1061 assert!(updates.update_fail_malformed_htlcs.is_empty());
1062 assert!(updates.update_fee.is_none());
1063 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
1064 nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
1065 expect_payment_forwarded!(nodes[1], Some(1000), false);
1066 check_added_monitors!(nodes[1], 1);
1067 let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1068 commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
1070 assert!(updates_2.update_add_htlcs.is_empty());
1071 assert!(updates_2.update_fail_htlcs.is_empty());
1072 assert!(updates_2.update_fail_malformed_htlcs.is_empty());
1073 assert!(updates_2.update_fee.is_none());
1074 assert_eq!(updates_2.update_fulfill_htlcs.len(), 1);
1075 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fulfill_htlcs[0]);
1076 commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
1078 let events = nodes[0].node.get_and_clear_pending_events();
1079 assert_eq!(events.len(), 1);
1081 Event::PaymentSent { ref payment_preimage } => {
1082 assert_eq!(our_payment_preimage, *payment_preimage);
1084 _ => panic!("Unexpected event"),
1087 let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
1089 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
1090 let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
1091 assert!(node_1_closing_signed.is_some());
1094 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
1095 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
1097 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1098 let node_0_2nd_reestablish = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
1099 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1100 if recv_count == 0 {
1101 // If all closing_signeds weren't delivered we can just resume where we left off...
1102 let node_1_2nd_reestablish = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
1104 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &node_1_2nd_reestablish);
1105 let node_0_3rd_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
1106 assert!(node_0_2nd_shutdown == node_0_3rd_shutdown);
1108 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_2nd_reestablish);
1109 let node_1_3rd_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
1110 assert!(node_1_3rd_shutdown == node_1_2nd_shutdown);
1112 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_3rd_shutdown);
1113 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1115 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_3rd_shutdown);
1116 let node_0_2nd_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
1117 assert!(node_0_closing_signed == node_0_2nd_closing_signed);
1119 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed);
1120 let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
1121 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
1122 let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
1123 assert!(node_0_none.is_none());
1125 // If one node, however, received + responded with an identical closing_signed we end
1126 // up erroring and node[0] will try to broadcast its own latest commitment transaction.
1127 // There isn't really anything better we can do simply, but in the future we might
1128 // explore storing a set of recently-closed channels that got disconnected during
1129 // closing_signed and avoiding broadcasting local commitment txn for some timeout to
1130 // give our counterparty enough time to (potentially) broadcast a cooperative closing
1132 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1134 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_2nd_reestablish);
1135 let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
1136 assert_eq!(msg_events.len(), 1);
1137 if let MessageSendEvent::HandleError { ref action, .. } = msg_events[0] {
1139 &ErrorAction::SendErrorMessage { ref msg } => {
1140 nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msg);
1141 assert_eq!(msg.channel_id, chan_1.2);
1143 _ => panic!("Unexpected event!"),
1145 } else { panic!("Needed SendErrorMessage close"); }
1147 // get_closing_signed_broadcast usually eats the BroadcastChannelUpdate for us and
1148 // checks it, but in this case nodes[0] didn't ever get a chance to receive a
1149 // closing_signed so we do it ourselves
1150 check_closed_broadcast!(nodes[0], false);
1151 check_added_monitors!(nodes[0], 1);
1154 assert!(nodes[0].node.list_channels().is_empty());
1156 assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
1157 nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
1158 close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
1159 assert!(nodes[1].node.list_channels().is_empty());
1160 assert!(nodes[2].node.list_channels().is_empty());
1164 fn test_shutdown_rebroadcast() {
1165 do_test_shutdown_rebroadcast(0);
1166 do_test_shutdown_rebroadcast(1);
1167 do_test_shutdown_rebroadcast(2);
1171 fn fake_network_test() {
1172 // Simple test which builds a network of ChannelManagers, connects them to each other, and
1173 // tests that payments get routed and transactions broadcast in semi-reasonable ways.
1174 let chanmon_cfgs = create_chanmon_cfgs(4);
1175 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
1176 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
1177 let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
1179 // Create some initial channels
1180 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
1181 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
1182 let chan_3 = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
1184 // Rebalance the network a bit by relaying one payment through all the channels...
1185 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000);
1186 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000);
1187 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000);
1188 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000);
1190 // Send some more payments
1191 send_payment(&nodes[1], &vec!(&nodes[2], &nodes[3])[..], 1000000);
1192 send_payment(&nodes[3], &vec!(&nodes[2], &nodes[1], &nodes[0])[..], 1000000);
1193 send_payment(&nodes[3], &vec!(&nodes[2], &nodes[1])[..], 1000000);
1195 // Test failure packets
1196 let payment_hash_1 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 1000000).1;
1197 fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], payment_hash_1);
1199 // Add a new channel that skips 3
1200 let chan_4 = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known());
1202 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 1000000);
1203 send_payment(&nodes[2], &vec!(&nodes[3])[..], 1000000);
1204 send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
1205 send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
1206 send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
1207 send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
1208 send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
1210 // Do some rebalance loop payments, simultaneously
1211 let mut hops = Vec::with_capacity(3);
1212 hops.push(RouteHop {
1213 pubkey: nodes[2].node.get_our_node_id(),
1214 node_features: NodeFeatures::empty(),
1215 short_channel_id: chan_2.0.contents.short_channel_id,
1216 channel_features: ChannelFeatures::empty(),
1218 cltv_expiry_delta: chan_3.0.contents.cltv_expiry_delta as u32
1220 hops.push(RouteHop {
1221 pubkey: nodes[3].node.get_our_node_id(),
1222 node_features: NodeFeatures::empty(),
1223 short_channel_id: chan_3.0.contents.short_channel_id,
1224 channel_features: ChannelFeatures::empty(),
1226 cltv_expiry_delta: chan_4.1.contents.cltv_expiry_delta as u32
1228 hops.push(RouteHop {
1229 pubkey: nodes[1].node.get_our_node_id(),
1230 node_features: NodeFeatures::known(),
1231 short_channel_id: chan_4.0.contents.short_channel_id,
1232 channel_features: ChannelFeatures::known(),
1234 cltv_expiry_delta: TEST_FINAL_CLTV,
1236 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;
1237 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;
1238 let payment_preimage_1 = send_along_route(&nodes[1], Route { paths: vec![hops] }, &vec!(&nodes[2], &nodes[3], &nodes[1])[..], 1000000).0;
1240 let mut hops = Vec::with_capacity(3);
1241 hops.push(RouteHop {
1242 pubkey: nodes[3].node.get_our_node_id(),
1243 node_features: NodeFeatures::empty(),
1244 short_channel_id: chan_4.0.contents.short_channel_id,
1245 channel_features: ChannelFeatures::empty(),
1247 cltv_expiry_delta: chan_3.1.contents.cltv_expiry_delta as u32
1249 hops.push(RouteHop {
1250 pubkey: nodes[2].node.get_our_node_id(),
1251 node_features: NodeFeatures::empty(),
1252 short_channel_id: chan_3.0.contents.short_channel_id,
1253 channel_features: ChannelFeatures::empty(),
1255 cltv_expiry_delta: chan_2.1.contents.cltv_expiry_delta as u32
1257 hops.push(RouteHop {
1258 pubkey: nodes[1].node.get_our_node_id(),
1259 node_features: NodeFeatures::known(),
1260 short_channel_id: chan_2.0.contents.short_channel_id,
1261 channel_features: ChannelFeatures::known(),
1263 cltv_expiry_delta: TEST_FINAL_CLTV,
1265 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;
1266 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;
1267 let payment_hash_2 = send_along_route(&nodes[1], Route { paths: vec![hops] }, &vec!(&nodes[3], &nodes[2], &nodes[1])[..], 1000000).1;
1269 // Claim the rebalances...
1270 fail_payment(&nodes[1], &vec!(&nodes[3], &nodes[2], &nodes[1])[..], payment_hash_2);
1271 claim_payment(&nodes[1], &vec!(&nodes[2], &nodes[3], &nodes[1])[..], payment_preimage_1);
1273 // Add a duplicate new channel from 2 to 4
1274 let chan_5 = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known());
1276 // Send some payments across both channels
1277 let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
1278 let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
1279 let payment_preimage_5 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
1282 route_over_limit(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000);
1283 let events = nodes[0].node.get_and_clear_pending_msg_events();
1284 assert_eq!(events.len(), 0);
1285 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);
1287 //TODO: Test that routes work again here as we've been notified that the channel is full
1289 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_3);
1290 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_4);
1291 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_5);
1293 // Close down the channels...
1294 close_channel(&nodes[0], &nodes[1], &chan_1.2, chan_1.3, true);
1295 close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, false);
1296 close_channel(&nodes[2], &nodes[3], &chan_3.2, chan_3.3, true);
1297 close_channel(&nodes[1], &nodes[3], &chan_4.2, chan_4.3, false);
1298 close_channel(&nodes[1], &nodes[3], &chan_5.2, chan_5.3, false);
1302 fn holding_cell_htlc_counting() {
1303 // Tests that HTLCs in the holding cell count towards the pending HTLC limits on outbound HTLCs
1304 // to ensure we don't end up with HTLCs sitting around in our holding cell for several
1305 // commitment dance rounds.
1306 let chanmon_cfgs = create_chanmon_cfgs(3);
1307 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1308 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1309 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1310 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
1311 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
1312 let logger = test_utils::TestLogger::new();
1314 let mut payments = Vec::new();
1315 for _ in 0..::ln::channel::OUR_MAX_HTLCS {
1316 let (payment_preimage, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[2]);
1317 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
1318 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();
1319 nodes[1].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
1320 payments.push((payment_preimage, payment_hash));
1322 check_added_monitors!(nodes[1], 1);
1324 let mut events = nodes[1].node.get_and_clear_pending_msg_events();
1325 assert_eq!(events.len(), 1);
1326 let initial_payment_event = SendEvent::from_event(events.pop().unwrap());
1327 assert_eq!(initial_payment_event.node_id, nodes[2].node.get_our_node_id());
1329 // There is now one HTLC in an outbound commitment transaction and (OUR_MAX_HTLCS - 1) HTLCs in
1330 // the holding cell waiting on B's RAA to send. At this point we should not be able to add
1332 let (_, payment_hash_1, payment_secret_1) = get_payment_preimage_hash!(nodes[2]);
1334 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
1335 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();
1336 unwrap_send_err!(nodes[1].node.send_payment(&route, payment_hash_1, &Some(payment_secret_1)), true, APIError::ChannelUnavailable { ref err },
1337 assert!(regex::Regex::new(r"Cannot push more than their max accepted HTLCs \(\d+\)").unwrap().is_match(err)));
1338 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1339 nodes[1].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot push more than their max accepted HTLCs".to_string(), 1);
1342 // This should also be true if we try to forward a payment.
1343 let (_, payment_hash_2, payment_secret_2) = get_payment_preimage_hash!(nodes[2]);
1345 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
1346 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();
1347 nodes[0].node.send_payment(&route, payment_hash_2, &Some(payment_secret_2)).unwrap();
1348 check_added_monitors!(nodes[0], 1);
1351 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1352 assert_eq!(events.len(), 1);
1353 let payment_event = SendEvent::from_event(events.pop().unwrap());
1354 assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
1356 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1357 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
1358 // We have to forward pending HTLCs twice - once tries to forward the payment forward (and
1359 // fails), the second will process the resulting failure and fail the HTLC backward.
1360 expect_pending_htlcs_forwardable!(nodes[1]);
1361 expect_pending_htlcs_forwardable!(nodes[1]);
1362 check_added_monitors!(nodes[1], 1);
1364 let bs_fail_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1365 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &bs_fail_updates.update_fail_htlcs[0]);
1366 commitment_signed_dance!(nodes[0], nodes[1], bs_fail_updates.commitment_signed, false, true);
1368 expect_payment_failure_chan_update!(nodes[0], chan_2.0.contents.short_channel_id, false);
1369 expect_payment_failed!(nodes[0], payment_hash_2, false);
1371 // Now forward all the pending HTLCs and claim them back
1372 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &initial_payment_event.msgs[0]);
1373 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &initial_payment_event.commitment_msg);
1374 check_added_monitors!(nodes[2], 1);
1376 let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1377 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_revoke_and_ack);
1378 check_added_monitors!(nodes[1], 1);
1379 let as_updates = get_htlc_update_msgs!(nodes[1], nodes[2].node.get_our_node_id());
1381 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &bs_commitment_signed);
1382 check_added_monitors!(nodes[1], 1);
1383 let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
1385 for ref update in as_updates.update_add_htlcs.iter() {
1386 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), update);
1388 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &as_updates.commitment_signed);
1389 check_added_monitors!(nodes[2], 1);
1390 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
1391 check_added_monitors!(nodes[2], 1);
1392 let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1394 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_revoke_and_ack);
1395 check_added_monitors!(nodes[1], 1);
1396 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &bs_commitment_signed);
1397 check_added_monitors!(nodes[1], 1);
1398 let as_final_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
1400 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_final_raa);
1401 check_added_monitors!(nodes[2], 1);
1403 expect_pending_htlcs_forwardable!(nodes[2]);
1405 let events = nodes[2].node.get_and_clear_pending_events();
1406 assert_eq!(events.len(), payments.len());
1407 for (event, &(_, ref hash)) in events.iter().zip(payments.iter()) {
1409 &Event::PaymentReceived { ref payment_hash, .. } => {
1410 assert_eq!(*payment_hash, *hash);
1412 _ => panic!("Unexpected event"),
1416 for (preimage, _) in payments.drain(..) {
1417 claim_payment(&nodes[1], &[&nodes[2]], preimage);
1420 send_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1000000);
1424 fn duplicate_htlc_test() {
1425 // Test that we accept duplicate payment_hash HTLCs across the network and that
1426 // claiming/failing them are all separate and don't affect each other
1427 let chanmon_cfgs = create_chanmon_cfgs(6);
1428 let node_cfgs = create_node_cfgs(6, &chanmon_cfgs);
1429 let node_chanmgrs = create_node_chanmgrs(6, &node_cfgs, &[None, None, None, None, None, None]);
1430 let mut nodes = create_network(6, &node_cfgs, &node_chanmgrs);
1432 // Create some initial channels to route via 3 to 4/5 from 0/1/2
1433 create_announced_chan_between_nodes(&nodes, 0, 3, InitFeatures::known(), InitFeatures::known());
1434 create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known());
1435 create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
1436 create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::known(), InitFeatures::known());
1437 create_announced_chan_between_nodes(&nodes, 3, 5, InitFeatures::known(), InitFeatures::known());
1439 let (payment_preimage, payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[3], &nodes[4])[..], 1000000);
1441 *nodes[0].network_payment_count.borrow_mut() -= 1;
1442 assert_eq!(route_payment(&nodes[1], &vec!(&nodes[3])[..], 1000000).0, payment_preimage);
1444 *nodes[0].network_payment_count.borrow_mut() -= 1;
1445 assert_eq!(route_payment(&nodes[2], &vec!(&nodes[3], &nodes[5])[..], 1000000).0, payment_preimage);
1447 claim_payment(&nodes[0], &vec!(&nodes[3], &nodes[4])[..], payment_preimage);
1448 fail_payment(&nodes[2], &vec!(&nodes[3], &nodes[5])[..], payment_hash);
1449 claim_payment(&nodes[1], &vec!(&nodes[3])[..], payment_preimage);
1453 fn test_duplicate_htlc_different_direction_onchain() {
1454 // Test that ChannelMonitor doesn't generate 2 preimage txn
1455 // when we have 2 HTLCs with same preimage that go across a node
1456 // in opposite directions, even with the same payment secret.
1457 let chanmon_cfgs = create_chanmon_cfgs(2);
1458 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1459 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1460 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1462 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
1463 let logger = test_utils::TestLogger::new();
1466 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
1468 let (payment_preimage, payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 900_000);
1470 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
1471 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();
1472 let node_a_payment_secret = nodes[0].node.create_inbound_payment_for_hash(payment_hash, None, 7200, 0).unwrap();
1473 send_along_route_with_secret(&nodes[1], route, &[&[&nodes[0]]], 800_000, payment_hash, node_a_payment_secret);
1475 // Provide preimage to node 0 by claiming payment
1476 nodes[0].node.claim_funds(payment_preimage);
1477 check_added_monitors!(nodes[0], 1);
1479 // Broadcast node 1 commitment txn
1480 let remote_txn = get_local_commitment_txn!(nodes[1], chan_1.2);
1482 assert_eq!(remote_txn[0].output.len(), 4); // 1 local, 1 remote, 1 htlc inbound, 1 htlc outbound
1483 let mut has_both_htlcs = 0; // check htlcs match ones committed
1484 for outp in remote_txn[0].output.iter() {
1485 if outp.value == 800_000 / 1000 {
1486 has_both_htlcs += 1;
1487 } else if outp.value == 900_000 / 1000 {
1488 has_both_htlcs += 1;
1491 assert_eq!(has_both_htlcs, 2);
1493 mine_transaction(&nodes[0], &remote_txn[0]);
1494 check_added_monitors!(nodes[0], 1);
1495 connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
1497 // Check we only broadcast 1 timeout tx
1498 let claim_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
1499 assert_eq!(claim_txn.len(), 8);
1500 assert_eq!(claim_txn[1], claim_txn[4]);
1501 assert_eq!(claim_txn[2], claim_txn[5]);
1502 check_spends!(claim_txn[1], chan_1.3);
1503 check_spends!(claim_txn[2], claim_txn[1]);
1504 check_spends!(claim_txn[7], claim_txn[1]);
1506 assert_eq!(claim_txn[0].input.len(), 1);
1507 assert_eq!(claim_txn[3].input.len(), 1);
1508 assert_eq!(claim_txn[0].input[0].previous_output, claim_txn[3].input[0].previous_output);
1510 assert_eq!(claim_txn[0].input.len(), 1);
1511 assert_eq!(claim_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC 1 <--> 0, preimage tx
1512 check_spends!(claim_txn[0], remote_txn[0]);
1513 assert_eq!(remote_txn[0].output[claim_txn[0].input[0].previous_output.vout as usize].value, 800);
1514 assert_eq!(claim_txn[6].input.len(), 1);
1515 assert_eq!(claim_txn[6].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // HTLC 0 <--> 1, timeout tx
1516 check_spends!(claim_txn[6], remote_txn[0]);
1517 assert_eq!(remote_txn[0].output[claim_txn[6].input[0].previous_output.vout as usize].value, 900);
1519 let events = nodes[0].node.get_and_clear_pending_msg_events();
1520 assert_eq!(events.len(), 3);
1523 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
1524 MessageSendEvent::HandleError { node_id, action: msgs::ErrorAction::SendErrorMessage { ref msg } } => {
1525 assert_eq!(node_id, nodes[1].node.get_our_node_id());
1526 assert_eq!(msg.data, "Commitment or closing transaction was confirmed on chain.");
1528 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, .. } } => {
1529 assert!(update_add_htlcs.is_empty());
1530 assert!(update_fail_htlcs.is_empty());
1531 assert_eq!(update_fulfill_htlcs.len(), 1);
1532 assert!(update_fail_malformed_htlcs.is_empty());
1533 assert_eq!(nodes[1].node.get_our_node_id(), *node_id);
1535 _ => panic!("Unexpected event"),
1541 fn test_basic_channel_reserve() {
1542 let chanmon_cfgs = create_chanmon_cfgs(2);
1543 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1544 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1545 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1546 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1547 let logger = test_utils::TestLogger::new();
1549 let chan_stat = get_channel_value_stat!(nodes[0], chan.2);
1550 let channel_reserve = chan_stat.channel_reserve_msat;
1552 // The 2* and +1 are for the fee spike reserve.
1553 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
1554 let commit_tx_fee = 2 * commit_tx_fee_msat(get_feerate!(nodes[0], chan.2), 1 + 1);
1555 let max_can_send = 5000000 - channel_reserve - commit_tx_fee;
1556 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
1557 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();
1558 let err = nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).err().unwrap();
1560 PaymentSendFailure::AllFailedRetrySafe(ref fails) => {
1562 &APIError::ChannelUnavailable{ref err} =>
1563 assert!(regex::Regex::new(r"Cannot send value that would put our balance under counterparty-announced channel reserve value \(\d+\)").unwrap().is_match(err)),
1564 _ => panic!("Unexpected error variant"),
1567 _ => panic!("Unexpected error variant"),
1569 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1570 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);
1572 send_payment(&nodes[0], &vec![&nodes[1]], max_can_send);
1576 fn test_fee_spike_violation_fails_htlc() {
1577 let chanmon_cfgs = create_chanmon_cfgs(2);
1578 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1579 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1580 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1581 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1583 let (route, payment_hash, _, payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], 3460001);
1584 // Need to manually create the update_add_htlc message to go around the channel reserve check in send_htlc()
1585 let secp_ctx = Secp256k1::new();
1586 let session_priv = SecretKey::from_slice(&[42; 32]).expect("RNG is bad!");
1588 let cur_height = nodes[1].node.best_block.read().unwrap().height() + 1;
1590 let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route.paths[0], &session_priv).unwrap();
1591 let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 3460001, &Some(payment_secret), cur_height, &None).unwrap();
1592 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
1593 let msg = msgs::UpdateAddHTLC {
1596 amount_msat: htlc_msat,
1597 payment_hash: payment_hash,
1598 cltv_expiry: htlc_cltv,
1599 onion_routing_packet: onion_packet,
1602 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
1604 // Now manually create the commitment_signed message corresponding to the update_add
1605 // nodes[0] just sent. In the code for construction of this message, "local" refers
1606 // to the sender of the message, and "remote" refers to the receiver.
1608 let feerate_per_kw = get_feerate!(nodes[0], chan.2);
1610 const INITIAL_COMMITMENT_NUMBER: u64 = (1 << 48) - 1;
1612 // Get the EnforcingSigner for each channel, which will be used to (1) get the keys
1613 // needed to sign the new commitment tx and (2) sign the new commitment tx.
1614 let (local_revocation_basepoint, local_htlc_basepoint, local_secret, next_local_point) = {
1615 let chan_lock = nodes[0].node.channel_state.lock().unwrap();
1616 let local_chan = chan_lock.by_id.get(&chan.2).unwrap();
1617 let chan_signer = local_chan.get_signer();
1618 let pubkeys = chan_signer.pubkeys();
1619 (pubkeys.revocation_basepoint, pubkeys.htlc_basepoint,
1620 chan_signer.release_commitment_secret(INITIAL_COMMITMENT_NUMBER),
1621 chan_signer.get_per_commitment_point(INITIAL_COMMITMENT_NUMBER - 2, &secp_ctx))
1623 let (remote_delayed_payment_basepoint, remote_htlc_basepoint,remote_point) = {
1624 let chan_lock = nodes[1].node.channel_state.lock().unwrap();
1625 let remote_chan = chan_lock.by_id.get(&chan.2).unwrap();
1626 let chan_signer = remote_chan.get_signer();
1627 let pubkeys = chan_signer.pubkeys();
1628 (pubkeys.delayed_payment_basepoint, pubkeys.htlc_basepoint,
1629 chan_signer.get_per_commitment_point(INITIAL_COMMITMENT_NUMBER - 1, &secp_ctx))
1632 // Assemble the set of keys we can use for signatures for our commitment_signed message.
1633 let commit_tx_keys = chan_utils::TxCreationKeys::derive_new(&secp_ctx, &remote_point, &remote_delayed_payment_basepoint,
1634 &remote_htlc_basepoint, &local_revocation_basepoint, &local_htlc_basepoint).unwrap();
1636 // Build the remote commitment transaction so we can sign it, and then later use the
1637 // signature for the commitment_signed message.
1638 let local_chan_balance = 1313;
1640 let accepted_htlc_info = chan_utils::HTLCOutputInCommitment {
1642 amount_msat: 3460001,
1643 cltv_expiry: htlc_cltv,
1645 transaction_output_index: Some(1),
1648 let commitment_number = INITIAL_COMMITMENT_NUMBER - 1;
1651 let local_chan_lock = nodes[0].node.channel_state.lock().unwrap();
1652 let local_chan = local_chan_lock.by_id.get(&chan.2).unwrap();
1653 let local_chan_signer = local_chan.get_signer();
1654 let commitment_tx = CommitmentTransaction::new_with_auxiliary_htlc_data(
1658 commit_tx_keys.clone(),
1660 &mut vec![(accepted_htlc_info, ())],
1661 &local_chan.channel_transaction_parameters.as_counterparty_broadcastable()
1663 local_chan_signer.sign_counterparty_commitment(&commitment_tx, &secp_ctx).unwrap()
1666 let commit_signed_msg = msgs::CommitmentSigned {
1669 htlc_signatures: res.1
1672 // Send the commitment_signed message to the nodes[1].
1673 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commit_signed_msg);
1674 let _ = nodes[1].node.get_and_clear_pending_msg_events();
1676 // Send the RAA to nodes[1].
1677 let raa_msg = msgs::RevokeAndACK {
1679 per_commitment_secret: local_secret,
1680 next_per_commitment_point: next_local_point
1682 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &raa_msg);
1684 let events = nodes[1].node.get_and_clear_pending_msg_events();
1685 assert_eq!(events.len(), 1);
1686 // Make sure the HTLC failed in the way we expect.
1688 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fail_htlcs, .. }, .. } => {
1689 assert_eq!(update_fail_htlcs.len(), 1);
1690 update_fail_htlcs[0].clone()
1692 _ => panic!("Unexpected event"),
1694 nodes[1].logger.assert_log("lightning::ln::channel".to_string(),
1695 format!("Attempting to fail HTLC due to fee spike buffer violation in channel {}. Rebalancing is required.", ::hex::encode(raa_msg.channel_id)), 1);
1697 check_added_monitors!(nodes[1], 2);
1701 fn test_chan_reserve_violation_outbound_htlc_inbound_chan() {
1702 let mut chanmon_cfgs = create_chanmon_cfgs(2);
1703 // Set the fee rate for the channel very high, to the point where the fundee
1704 // sending any above-dust amount would result in a channel reserve violation.
1705 // In this test we check that we would be prevented from sending an HTLC in
1707 let feerate_per_kw = 253;
1708 chanmon_cfgs[0].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(feerate_per_kw) };
1709 chanmon_cfgs[1].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(feerate_per_kw) };
1710 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1711 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1712 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1714 let mut push_amt = 100_000_000;
1715 push_amt -= feerate_per_kw as u64 * (COMMITMENT_TX_BASE_WEIGHT + COMMITMENT_TX_WEIGHT_PER_HTLC) / 1000 * 1000;
1716 push_amt -= Channel::<EnforcingSigner>::get_holder_selected_channel_reserve_satoshis(100_000) * 1000;
1718 let _ = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100_000, push_amt, InitFeatures::known(), InitFeatures::known());
1720 // Sending exactly enough to hit the reserve amount should be accepted
1721 let (_, _, _) = route_payment(&nodes[1], &[&nodes[0]], 1_000_000);
1723 // However one more HTLC should be significantly over the reserve amount and fail.
1724 let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[1], nodes[0], 1_000_000);
1725 unwrap_send_err!(nodes[1].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
1726 assert_eq!(err, "Cannot send value that would put counterparty balance under holder-announced channel reserve value"));
1727 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1728 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);
1732 fn test_chan_reserve_violation_inbound_htlc_outbound_channel() {
1733 let mut chanmon_cfgs = create_chanmon_cfgs(2);
1734 // Set the fee rate for the channel very high, to the point where the funder
1735 // receiving 1 update_add_htlc would result in them closing the channel due
1736 // to channel reserve violation. This close could also happen if the fee went
1737 // up a more realistic amount, but many HTLCs were outstanding at the time of
1738 // the update_add_htlc.
1739 chanmon_cfgs[0].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(6000) };
1740 chanmon_cfgs[1].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(6000) };
1741 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1742 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1743 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1744 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1746 let (route, payment_hash, _, payment_secret) = get_route_and_payment_hash!(nodes[1], nodes[0], 1000);
1747 // Need to manually create the update_add_htlc message to go around the channel reserve check in send_htlc()
1748 let secp_ctx = Secp256k1::new();
1749 let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
1750 let cur_height = nodes[1].node.best_block.read().unwrap().height() + 1;
1751 let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route.paths[0], &session_priv).unwrap();
1752 let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 1000, &Some(payment_secret), cur_height, &None).unwrap();
1753 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
1754 let msg = msgs::UpdateAddHTLC {
1757 amount_msat: htlc_msat + 1,
1758 payment_hash: payment_hash,
1759 cltv_expiry: htlc_cltv,
1760 onion_routing_packet: onion_packet,
1763 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &msg);
1764 // Check that the payment failed and the channel is closed in response to the malicious UpdateAdd.
1765 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);
1766 assert_eq!(nodes[0].node.list_channels().len(), 0);
1767 let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
1768 assert_eq!(err_msg.data, "Cannot accept HTLC that would put our balance under counterparty-announced channel reserve value");
1769 check_added_monitors!(nodes[0], 1);
1773 fn test_chan_reserve_dust_inbound_htlcs_outbound_chan() {
1774 // Test that if we receive many dust HTLCs over an outbound channel, they don't count when
1775 // calculating our commitment transaction fee (this was previously broken).
1776 let mut chanmon_cfgs = create_chanmon_cfgs(2);
1777 let feerate_per_kw = 253;
1778 chanmon_cfgs[0].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(feerate_per_kw) };
1779 chanmon_cfgs[1].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(feerate_per_kw) };
1781 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1782 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None, None]);
1783 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1785 // Set nodes[0]'s balance such that they will consider any above-dust received HTLC to be a
1786 // channel reserve violation (so their balance is channel reserve (1000 sats) + commitment
1787 // transaction fee with 0 HTLCs (183 sats)).
1788 let mut push_amt = 100_000_000;
1789 push_amt -= feerate_per_kw as u64 * (COMMITMENT_TX_BASE_WEIGHT) / 1000 * 1000;
1790 push_amt -= Channel::<EnforcingSigner>::get_holder_selected_channel_reserve_satoshis(100_000) * 1000;
1791 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, push_amt, InitFeatures::known(), InitFeatures::known());
1793 let dust_amt = crate::ln::channel::MIN_DUST_LIMIT_SATOSHIS * 1000
1794 + feerate_per_kw as u64 * HTLC_SUCCESS_TX_WEIGHT / 1000 * 1000 - 1;
1795 // In the previous code, routing this dust payment would cause nodes[0] to perceive a channel
1796 // reserve violation even though it's a dust HTLC and therefore shouldn't count towards the
1797 // commitment transaction fee.
1798 let (_, _, _) = route_payment(&nodes[1], &[&nodes[0]], dust_amt);
1800 // One more than the dust amt should fail, however.
1801 let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[1], nodes[0], dust_amt + 1);
1802 unwrap_send_err!(nodes[1].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
1803 assert_eq!(err, "Cannot send value that would put counterparty balance under holder-announced channel reserve value"));
1807 fn test_chan_reserve_dust_inbound_htlcs_inbound_chan() {
1808 // Test that if we receive many dust HTLCs over an inbound channel, they don't count when
1809 // calculating our counterparty's commitment transaction fee (this was previously broken).
1810 let chanmon_cfgs = create_chanmon_cfgs(2);
1811 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1812 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None, None]);
1813 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1814 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 98000000, InitFeatures::known(), InitFeatures::known());
1816 let payment_amt = 46000; // Dust amount
1817 // In the previous code, these first four payments would succeed.
1818 let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1819 let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1820 let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1821 let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1823 // Then these next 5 would be interpreted by nodes[1] as violating the fee spike buffer.
1824 let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1825 let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1826 let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1827 let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1828 let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1830 // And this last payment previously resulted in nodes[1] closing on its inbound-channel
1831 // counterparty, because it counted all the previous dust HTLCs against nodes[0]'s commitment
1832 // transaction fee and therefore perceived this next payment as a channel reserve violation.
1833 let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1837 fn test_chan_reserve_violation_inbound_htlc_inbound_chan() {
1838 let chanmon_cfgs = create_chanmon_cfgs(3);
1839 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1840 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1841 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1842 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1843 let _ = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1846 let total_routing_fee_msat = (nodes.len() - 2) as u64 * feemsat;
1847 let chan_stat = get_channel_value_stat!(nodes[0], chan.2);
1848 let feerate = get_feerate!(nodes[0], chan.2);
1850 // Add a 2* and +1 for the fee spike reserve.
1851 let commit_tx_fee_2_htlc = 2*commit_tx_fee_msat(feerate, 2 + 1);
1852 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;
1853 let amt_msat_1 = recv_value_1 + total_routing_fee_msat;
1855 // Add a pending HTLC.
1856 let (route_1, our_payment_hash_1, _, our_payment_secret_1) = get_route_and_payment_hash!(nodes[0], nodes[2], amt_msat_1);
1857 let payment_event_1 = {
1858 nodes[0].node.send_payment(&route_1, our_payment_hash_1, &Some(our_payment_secret_1)).unwrap();
1859 check_added_monitors!(nodes[0], 1);
1861 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1862 assert_eq!(events.len(), 1);
1863 SendEvent::from_event(events.remove(0))
1865 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event_1.msgs[0]);
1867 // Attempt to trigger a channel reserve violation --> payment failure.
1868 let commit_tx_fee_2_htlcs = commit_tx_fee_msat(feerate, 2);
1869 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;
1870 let amt_msat_2 = recv_value_2 + total_routing_fee_msat;
1871 let (route_2, _, _, _) = get_route_and_payment_hash!(nodes[0], nodes[2], amt_msat_2);
1873 // Need to manually create the update_add_htlc message to go around the channel reserve check in send_htlc()
1874 let secp_ctx = Secp256k1::new();
1875 let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
1876 let cur_height = nodes[0].node.best_block.read().unwrap().height() + 1;
1877 let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route_2.paths[0], &session_priv).unwrap();
1878 let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route_2.paths[0], recv_value_2, &None, cur_height, &None).unwrap();
1879 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &our_payment_hash_1);
1880 let msg = msgs::UpdateAddHTLC {
1883 amount_msat: htlc_msat + 1,
1884 payment_hash: our_payment_hash_1,
1885 cltv_expiry: htlc_cltv,
1886 onion_routing_packet: onion_packet,
1889 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
1890 // Check that the payment failed and the channel is closed in response to the malicious UpdateAdd.
1891 nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Remote HTLC add would put them under remote reserve value".to_string(), 1);
1892 assert_eq!(nodes[1].node.list_channels().len(), 1);
1893 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
1894 assert_eq!(err_msg.data, "Remote HTLC add would put them under remote reserve value");
1895 check_added_monitors!(nodes[1], 1);
1899 fn test_inbound_outbound_capacity_is_not_zero() {
1900 let chanmon_cfgs = create_chanmon_cfgs(2);
1901 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1902 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1903 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1904 let _ = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1905 let channels0 = node_chanmgrs[0].list_channels();
1906 let channels1 = node_chanmgrs[1].list_channels();
1907 assert_eq!(channels0.len(), 1);
1908 assert_eq!(channels1.len(), 1);
1910 let reserve = Channel::<EnforcingSigner>::get_holder_selected_channel_reserve_satoshis(100000);
1911 assert_eq!(channels0[0].inbound_capacity_msat, 95000000 - reserve*1000);
1912 assert_eq!(channels1[0].outbound_capacity_msat, 95000000 - reserve*1000);
1914 assert_eq!(channels0[0].outbound_capacity_msat, 100000 * 1000 - 95000000 - reserve*1000);
1915 assert_eq!(channels1[0].inbound_capacity_msat, 100000 * 1000 - 95000000 - reserve*1000);
1918 fn commit_tx_fee_msat(feerate: u32, num_htlcs: u64) -> u64 {
1919 (COMMITMENT_TX_BASE_WEIGHT + num_htlcs * COMMITMENT_TX_WEIGHT_PER_HTLC) * feerate as u64 / 1000 * 1000
1923 fn test_channel_reserve_holding_cell_htlcs() {
1924 let chanmon_cfgs = create_chanmon_cfgs(3);
1925 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1926 // When this test was written, the default base fee floated based on the HTLC count.
1927 // It is now fixed, so we simply set the fee to the expected value here.
1928 let mut config = test_default_channel_config();
1929 config.channel_options.forwarding_fee_base_msat = 239;
1930 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[Some(config.clone()), Some(config.clone()), Some(config.clone())]);
1931 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1932 let chan_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 190000, 1001, InitFeatures::known(), InitFeatures::known());
1933 let chan_2 = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 190000, 1001, InitFeatures::known(), InitFeatures::known());
1935 let mut stat01 = get_channel_value_stat!(nodes[0], chan_1.2);
1936 let mut stat11 = get_channel_value_stat!(nodes[1], chan_1.2);
1938 let mut stat12 = get_channel_value_stat!(nodes[1], chan_2.2);
1939 let mut stat22 = get_channel_value_stat!(nodes[2], chan_2.2);
1941 macro_rules! expect_forward {
1943 let mut events = $node.node.get_and_clear_pending_msg_events();
1944 assert_eq!(events.len(), 1);
1945 check_added_monitors!($node, 1);
1946 let payment_event = SendEvent::from_event(events.remove(0));
1951 let feemsat = 239; // set above
1952 let total_fee_msat = (nodes.len() - 2) as u64 * feemsat;
1953 let feerate = get_feerate!(nodes[0], chan_1.2);
1955 let recv_value_0 = stat01.counterparty_max_htlc_value_in_flight_msat - total_fee_msat;
1957 // attempt to send amt_msat > their_max_htlc_value_in_flight_msat
1959 let (mut route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], recv_value_0);
1960 route.paths[0].last_mut().unwrap().fee_msat += 1;
1961 assert!(route.paths[0].iter().rev().skip(1).all(|h| h.fee_msat == feemsat));
1962 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
1963 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)));
1964 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1965 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);
1968 // channel reserve is bigger than their_max_htlc_value_in_flight_msat so loop to deplete
1969 // nodes[0]'s wealth
1971 let amt_msat = recv_value_0 + total_fee_msat;
1972 // 3 for the 3 HTLCs that will be sent, 2* and +1 for the fee spike reserve.
1973 // Also, ensure that each payment has enough to be over the dust limit to
1974 // ensure it'll be included in each commit tx fee calculation.
1975 let commit_tx_fee_all_htlcs = 2*commit_tx_fee_msat(feerate, 3 + 1);
1976 let ensure_htlc_amounts_above_dust_buffer = 3 * (stat01.counterparty_dust_limit_msat + 1000);
1977 if stat01.value_to_self_msat < stat01.channel_reserve_msat + commit_tx_fee_all_htlcs + ensure_htlc_amounts_above_dust_buffer + amt_msat {
1980 send_payment(&nodes[0], &vec![&nodes[1], &nodes[2]][..], recv_value_0);
1982 let (stat01_, stat11_, stat12_, stat22_) = (
1983 get_channel_value_stat!(nodes[0], chan_1.2),
1984 get_channel_value_stat!(nodes[1], chan_1.2),
1985 get_channel_value_stat!(nodes[1], chan_2.2),
1986 get_channel_value_stat!(nodes[2], chan_2.2),
1989 assert_eq!(stat01_.value_to_self_msat, stat01.value_to_self_msat - amt_msat);
1990 assert_eq!(stat11_.value_to_self_msat, stat11.value_to_self_msat + amt_msat);
1991 assert_eq!(stat12_.value_to_self_msat, stat12.value_to_self_msat - (amt_msat - feemsat));
1992 assert_eq!(stat22_.value_to_self_msat, stat22.value_to_self_msat + (amt_msat - feemsat));
1993 stat01 = stat01_; stat11 = stat11_; stat12 = stat12_; stat22 = stat22_;
1996 // adding pending output.
1997 // 2* and +1 HTLCs on the commit tx fee for the fee spike reserve.
1998 // The reason we're dividing by two here is as follows: the dividend is the total outbound liquidity
1999 // after fees, the channel reserve, and the fee spike buffer are removed. We eventually want to
2000 // divide this quantity into 3 portions, that will each be sent in an HTLC. This allows us
2001 // to test channel channel reserve policy at the edges of what amount is sendable, i.e.
2002 // cases where 1 msat over X amount will cause a payment failure, but anything less than
2003 // that can be sent successfully. So, dividing by two is a somewhat arbitrary way of getting
2004 // the amount of the first of these aforementioned 3 payments. The reason we split into 3 payments
2005 // is to test the behavior of the holding cell with respect to channel reserve and commit tx fee
2007 let commit_tx_fee_2_htlcs = 2*commit_tx_fee_msat(feerate, 2 + 1);
2008 let recv_value_1 = (stat01.value_to_self_msat - stat01.channel_reserve_msat - total_fee_msat - commit_tx_fee_2_htlcs)/2;
2009 let amt_msat_1 = recv_value_1 + total_fee_msat;
2011 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);
2012 let payment_event_1 = {
2013 nodes[0].node.send_payment(&route_1, our_payment_hash_1, &Some(our_payment_secret_1)).unwrap();
2014 check_added_monitors!(nodes[0], 1);
2016 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
2017 assert_eq!(events.len(), 1);
2018 SendEvent::from_event(events.remove(0))
2020 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event_1.msgs[0]);
2022 // channel reserve test with htlc pending output > 0
2023 let recv_value_2 = stat01.value_to_self_msat - amt_msat_1 - stat01.channel_reserve_msat - total_fee_msat - commit_tx_fee_2_htlcs;
2025 let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], recv_value_2 + 1);
2026 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
2027 assert!(regex::Regex::new(r"Cannot send value that would put our balance under counterparty-announced channel reserve value \(\d+\)").unwrap().is_match(err)));
2028 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
2031 // split the rest to test holding cell
2032 let commit_tx_fee_3_htlcs = 2*commit_tx_fee_msat(feerate, 3 + 1);
2033 let additional_htlc_cost_msat = commit_tx_fee_3_htlcs - commit_tx_fee_2_htlcs;
2034 let recv_value_21 = recv_value_2/2 - additional_htlc_cost_msat/2;
2035 let recv_value_22 = recv_value_2 - recv_value_21 - total_fee_msat - additional_htlc_cost_msat;
2037 let stat = get_channel_value_stat!(nodes[0], chan_1.2);
2038 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);
2041 // now see if they go through on both sides
2042 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);
2043 // but this will stuck in the holding cell
2044 nodes[0].node.send_payment(&route_21, our_payment_hash_21, &Some(our_payment_secret_21)).unwrap();
2045 check_added_monitors!(nodes[0], 0);
2046 let events = nodes[0].node.get_and_clear_pending_events();
2047 assert_eq!(events.len(), 0);
2049 // test with outbound holding cell amount > 0
2051 let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], recv_value_22+1);
2052 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
2053 assert!(regex::Regex::new(r"Cannot send value that would put our balance under counterparty-announced channel reserve value \(\d+\)").unwrap().is_match(err)));
2054 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
2055 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);
2058 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);
2059 // this will also stuck in the holding cell
2060 nodes[0].node.send_payment(&route_22, our_payment_hash_22, &Some(our_payment_secret_22)).unwrap();
2061 check_added_monitors!(nodes[0], 0);
2062 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
2063 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
2065 // flush the pending htlc
2066 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event_1.commitment_msg);
2067 let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2068 check_added_monitors!(nodes[1], 1);
2070 // the pending htlc should be promoted to committed
2071 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_revoke_and_ack);
2072 check_added_monitors!(nodes[0], 1);
2073 let commitment_update_2 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2075 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &as_commitment_signed);
2076 let bs_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2077 // No commitment_signed so get_event_msg's assert(len == 1) passes
2078 check_added_monitors!(nodes[0], 1);
2080 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &bs_revoke_and_ack);
2081 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2082 check_added_monitors!(nodes[1], 1);
2084 expect_pending_htlcs_forwardable!(nodes[1]);
2086 let ref payment_event_11 = expect_forward!(nodes[1]);
2087 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_11.msgs[0]);
2088 commitment_signed_dance!(nodes[2], nodes[1], payment_event_11.commitment_msg, false);
2090 expect_pending_htlcs_forwardable!(nodes[2]);
2091 expect_payment_received!(nodes[2], our_payment_hash_1, our_payment_secret_1, recv_value_1);
2093 // flush the htlcs in the holding cell
2094 assert_eq!(commitment_update_2.update_add_htlcs.len(), 2);
2095 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &commitment_update_2.update_add_htlcs[0]);
2096 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &commitment_update_2.update_add_htlcs[1]);
2097 commitment_signed_dance!(nodes[1], nodes[0], &commitment_update_2.commitment_signed, false);
2098 expect_pending_htlcs_forwardable!(nodes[1]);
2100 let ref payment_event_3 = expect_forward!(nodes[1]);
2101 assert_eq!(payment_event_3.msgs.len(), 2);
2102 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_3.msgs[0]);
2103 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_3.msgs[1]);
2105 commitment_signed_dance!(nodes[2], nodes[1], &payment_event_3.commitment_msg, false);
2106 expect_pending_htlcs_forwardable!(nodes[2]);
2108 let events = nodes[2].node.get_and_clear_pending_events();
2109 assert_eq!(events.len(), 2);
2111 Event::PaymentReceived { ref payment_hash, ref purpose, amt } => {
2112 assert_eq!(our_payment_hash_21, *payment_hash);
2113 assert_eq!(recv_value_21, amt);
2115 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
2116 assert!(payment_preimage.is_none());
2117 assert_eq!(our_payment_secret_21, *payment_secret);
2119 _ => panic!("expected PaymentPurpose::InvoicePayment")
2122 _ => panic!("Unexpected event"),
2125 Event::PaymentReceived { ref payment_hash, ref purpose, amt } => {
2126 assert_eq!(our_payment_hash_22, *payment_hash);
2127 assert_eq!(recv_value_22, amt);
2129 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
2130 assert!(payment_preimage.is_none());
2131 assert_eq!(our_payment_secret_22, *payment_secret);
2133 _ => panic!("expected PaymentPurpose::InvoicePayment")
2136 _ => panic!("Unexpected event"),
2139 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_1);
2140 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_21);
2141 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_22);
2143 let commit_tx_fee_0_htlcs = 2*commit_tx_fee_msat(feerate, 1);
2144 let recv_value_3 = commit_tx_fee_2_htlcs - commit_tx_fee_0_htlcs - total_fee_msat;
2145 send_payment(&nodes[0], &vec![&nodes[1], &nodes[2]][..], recv_value_3);
2147 let commit_tx_fee_1_htlc = 2*commit_tx_fee_msat(feerate, 1 + 1);
2148 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);
2149 let stat0 = get_channel_value_stat!(nodes[0], chan_1.2);
2150 assert_eq!(stat0.value_to_self_msat, expected_value_to_self);
2151 assert_eq!(stat0.value_to_self_msat, stat0.channel_reserve_msat + commit_tx_fee_1_htlc);
2153 let stat2 = get_channel_value_stat!(nodes[2], chan_2.2);
2154 assert_eq!(stat2.value_to_self_msat, stat22.value_to_self_msat + recv_value_1 + recv_value_21 + recv_value_22 + recv_value_3);
2158 fn channel_reserve_in_flight_removes() {
2159 // In cases where one side claims an HTLC, it thinks it has additional available funds that it
2160 // can send to its counterparty, but due to update ordering, the other side may not yet have
2161 // considered those HTLCs fully removed.
2162 // This tests that we don't count HTLCs which will not be included in the next remote
2163 // commitment transaction towards the reserve value (as it implies no commitment transaction
2164 // will be generated which violates the remote reserve value).
2165 // This was broken previously, and discovered by the chanmon_fail_consistency fuzz test.
2167 // * route two HTLCs from A to B (note that, at a high level, this test is checking that, when
2168 // you consider the values of both of these HTLCs, B may not send an HTLC back to A, but if
2169 // you only consider the value of the first HTLC, it may not),
2170 // * start routing a third HTLC from A to B,
2171 // * claim the first two HTLCs (though B will generate an update_fulfill for one, and put
2172 // the other claim in its holding cell, as it immediately goes into AwaitingRAA),
2173 // * deliver the first fulfill from B
2174 // * deliver the update_add and an RAA from A, resulting in B freeing the second holding cell
2176 // * deliver A's response CS and RAA.
2177 // This results in A having the second HTLC in AwaitingRemovedRemoteRevoke, but B having
2178 // removed it fully. B now has the push_msat plus the first two HTLCs in value.
2179 // * Now B happily sends another HTLC, potentially violating its reserve value from A's point
2180 // of view (if A counts the AwaitingRemovedRemoteRevoke HTLC).
2181 let chanmon_cfgs = create_chanmon_cfgs(2);
2182 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2183 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2184 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2185 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2186 let logger = test_utils::TestLogger::new();
2188 let b_chan_values = get_channel_value_stat!(nodes[1], chan_1.2);
2189 // Route the first two HTLCs.
2190 let (payment_preimage_1, _, _) = route_payment(&nodes[0], &[&nodes[1]], b_chan_values.channel_reserve_msat - b_chan_values.value_to_self_msat - 10000);
2191 let (payment_preimage_2, _, _) = route_payment(&nodes[0], &[&nodes[1]], 20000);
2193 // Start routing the third HTLC (this is just used to get everyone in the right state).
2194 let (payment_preimage_3, payment_hash_3, payment_secret_3) = get_payment_preimage_hash!(nodes[1]);
2196 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
2197 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();
2198 nodes[0].node.send_payment(&route, payment_hash_3, &Some(payment_secret_3)).unwrap();
2199 check_added_monitors!(nodes[0], 1);
2200 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
2201 assert_eq!(events.len(), 1);
2202 SendEvent::from_event(events.remove(0))
2205 // Now claim both of the first two HTLCs on B's end, putting B in AwaitingRAA and generating an
2206 // initial fulfill/CS.
2207 assert!(nodes[1].node.claim_funds(payment_preimage_1));
2208 check_added_monitors!(nodes[1], 1);
2209 let bs_removes = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2211 // This claim goes in B's holding cell, allowing us to have a pending B->A RAA which does not
2212 // remove the second HTLC when we send the HTLC back from B to A.
2213 assert!(nodes[1].node.claim_funds(payment_preimage_2));
2214 check_added_monitors!(nodes[1], 1);
2215 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2217 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_removes.update_fulfill_htlcs[0]);
2218 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_removes.commitment_signed);
2219 check_added_monitors!(nodes[0], 1);
2220 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2221 expect_payment_sent!(nodes[0], payment_preimage_1);
2223 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_1.msgs[0]);
2224 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &send_1.commitment_msg);
2225 check_added_monitors!(nodes[1], 1);
2226 // B is already AwaitingRAA, so cant generate a CS here
2227 let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2229 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
2230 check_added_monitors!(nodes[1], 1);
2231 let bs_cs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2233 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2234 check_added_monitors!(nodes[0], 1);
2235 let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2237 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
2238 check_added_monitors!(nodes[1], 1);
2239 let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2241 // The second HTLCis removed, but as A is in AwaitingRAA it can't generate a CS here, so the
2242 // RAA that B generated above doesn't fully resolve the second HTLC from A's point of view.
2243 // However, the RAA A generates here *does* fully resolve the HTLC from B's point of view (as A
2244 // can no longer broadcast a commitment transaction with it and B has the preimage so can go
2245 // on-chain as necessary).
2246 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_cs.update_fulfill_htlcs[0]);
2247 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_cs.commitment_signed);
2248 check_added_monitors!(nodes[0], 1);
2249 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2250 expect_payment_sent!(nodes[0], payment_preimage_2);
2252 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
2253 check_added_monitors!(nodes[1], 1);
2254 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2256 expect_pending_htlcs_forwardable!(nodes[1]);
2257 expect_payment_received!(nodes[1], payment_hash_3, payment_secret_3, 100000);
2259 // Note that as this RAA was generated before the delivery of the update_fulfill it shouldn't
2260 // resolve the second HTLC from A's point of view.
2261 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2262 check_added_monitors!(nodes[0], 1);
2263 let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2265 // Now that B doesn't have the second RAA anymore, but A still does, send a payment from B back
2266 // to A to ensure that A doesn't count the almost-removed HTLC in update_add processing.
2267 let (payment_preimage_4, payment_hash_4, payment_secret_4) = get_payment_preimage_hash!(nodes[0]);
2269 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
2270 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();
2271 nodes[1].node.send_payment(&route, payment_hash_4, &Some(payment_secret_4)).unwrap();
2272 check_added_monitors!(nodes[1], 1);
2273 let mut events = nodes[1].node.get_and_clear_pending_msg_events();
2274 assert_eq!(events.len(), 1);
2275 SendEvent::from_event(events.remove(0))
2278 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &send_2.msgs[0]);
2279 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &send_2.commitment_msg);
2280 check_added_monitors!(nodes[0], 1);
2281 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2283 // Now just resolve all the outstanding messages/HTLCs for completeness...
2285 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
2286 check_added_monitors!(nodes[1], 1);
2287 let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2289 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
2290 check_added_monitors!(nodes[1], 1);
2292 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2293 check_added_monitors!(nodes[0], 1);
2294 let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2296 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
2297 check_added_monitors!(nodes[1], 1);
2298 let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2300 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2301 check_added_monitors!(nodes[0], 1);
2303 expect_pending_htlcs_forwardable!(nodes[0]);
2304 expect_payment_received!(nodes[0], payment_hash_4, payment_secret_4, 10000);
2306 claim_payment(&nodes[1], &[&nodes[0]], payment_preimage_4);
2307 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_3);
2311 fn channel_monitor_network_test() {
2312 // Simple test which builds a network of ChannelManagers, connects them to each other, and
2313 // tests that ChannelMonitor is able to recover from various states.
2314 let chanmon_cfgs = create_chanmon_cfgs(5);
2315 let node_cfgs = create_node_cfgs(5, &chanmon_cfgs);
2316 let node_chanmgrs = create_node_chanmgrs(5, &node_cfgs, &[None, None, None, None, None]);
2317 let nodes = create_network(5, &node_cfgs, &node_chanmgrs);
2319 // Create some initial channels
2320 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2321 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
2322 let chan_3 = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
2323 let chan_4 = create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::known(), InitFeatures::known());
2325 // Make sure all nodes are at the same starting height
2326 connect_blocks(&nodes[0], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[0].best_block_info().1);
2327 connect_blocks(&nodes[1], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[1].best_block_info().1);
2328 connect_blocks(&nodes[2], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[2].best_block_info().1);
2329 connect_blocks(&nodes[3], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[3].best_block_info().1);
2330 connect_blocks(&nodes[4], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[4].best_block_info().1);
2332 // Rebalance the network a bit by relaying one payment through all the channels...
2333 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
2334 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
2335 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
2336 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
2338 // Simple case with no pending HTLCs:
2339 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), true);
2340 check_added_monitors!(nodes[1], 1);
2341 check_closed_broadcast!(nodes[1], false);
2343 let mut node_txn = test_txn_broadcast(&nodes[1], &chan_1, None, HTLCType::NONE);
2344 assert_eq!(node_txn.len(), 1);
2345 mine_transaction(&nodes[0], &node_txn[0]);
2346 check_added_monitors!(nodes[0], 1);
2347 test_txn_broadcast(&nodes[0], &chan_1, None, HTLCType::NONE);
2349 check_closed_broadcast!(nodes[0], true);
2350 assert_eq!(nodes[0].node.list_channels().len(), 0);
2351 assert_eq!(nodes[1].node.list_channels().len(), 1);
2353 // One pending HTLC is discarded by the force-close:
2354 let payment_preimage_1 = route_payment(&nodes[1], &vec!(&nodes[2], &nodes[3])[..], 3000000).0;
2356 // Simple case of one pending HTLC to HTLC-Timeout (note that the HTLC-Timeout is not
2357 // broadcasted until we reach the timelock time).
2358 nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id(), true);
2359 check_closed_broadcast!(nodes[1], false);
2360 check_added_monitors!(nodes[1], 1);
2362 let mut node_txn = test_txn_broadcast(&nodes[1], &chan_2, None, HTLCType::NONE);
2363 connect_blocks(&nodes[1], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + MIN_CLTV_EXPIRY_DELTA as u32 + 1);
2364 test_txn_broadcast(&nodes[1], &chan_2, None, HTLCType::TIMEOUT);
2365 mine_transaction(&nodes[2], &node_txn[0]);
2366 check_added_monitors!(nodes[2], 1);
2367 test_txn_broadcast(&nodes[2], &chan_2, None, HTLCType::NONE);
2369 check_closed_broadcast!(nodes[2], true);
2370 assert_eq!(nodes[1].node.list_channels().len(), 0);
2371 assert_eq!(nodes[2].node.list_channels().len(), 1);
2373 macro_rules! claim_funds {
2374 ($node: expr, $prev_node: expr, $preimage: expr) => {
2376 assert!($node.node.claim_funds($preimage));
2377 check_added_monitors!($node, 1);
2379 let events = $node.node.get_and_clear_pending_msg_events();
2380 assert_eq!(events.len(), 1);
2382 MessageSendEvent::UpdateHTLCs { ref node_id, updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fail_htlcs, .. } } => {
2383 assert!(update_add_htlcs.is_empty());
2384 assert!(update_fail_htlcs.is_empty());
2385 assert_eq!(*node_id, $prev_node.node.get_our_node_id());
2387 _ => panic!("Unexpected event"),
2393 // nodes[3] gets the preimage, but nodes[2] already disconnected, resulting in a nodes[2]
2394 // HTLC-Timeout and a nodes[3] claim against it (+ its own announces)
2395 nodes[2].node.peer_disconnected(&nodes[3].node.get_our_node_id(), true);
2396 check_added_monitors!(nodes[2], 1);
2397 check_closed_broadcast!(nodes[2], false);
2398 let node2_commitment_txid;
2400 let node_txn = test_txn_broadcast(&nodes[2], &chan_3, None, HTLCType::NONE);
2401 connect_blocks(&nodes[2], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + MIN_CLTV_EXPIRY_DELTA as u32 + 1);
2402 test_txn_broadcast(&nodes[2], &chan_3, None, HTLCType::TIMEOUT);
2403 node2_commitment_txid = node_txn[0].txid();
2405 // Claim the payment on nodes[3], giving it knowledge of the preimage
2406 claim_funds!(nodes[3], nodes[2], payment_preimage_1);
2407 mine_transaction(&nodes[3], &node_txn[0]);
2408 check_added_monitors!(nodes[3], 1);
2409 check_preimage_claim(&nodes[3], &node_txn);
2411 check_closed_broadcast!(nodes[3], true);
2412 assert_eq!(nodes[2].node.list_channels().len(), 0);
2413 assert_eq!(nodes[3].node.list_channels().len(), 1);
2415 // Drop the ChannelMonitor for the previous channel to avoid it broadcasting transactions and
2416 // confusing us in the following tests.
2417 let chan_3_mon = nodes[3].chain_monitor.chain_monitor.monitors.write().unwrap().remove(&OutPoint { txid: chan_3.3.txid(), index: 0 }).unwrap();
2419 // One pending HTLC to time out:
2420 let payment_preimage_2 = route_payment(&nodes[3], &vec!(&nodes[4])[..], 3000000).0;
2421 // CLTV expires at TEST_FINAL_CLTV + 1 (current height) + 1 (added in send_payment for
2424 let (close_chan_update_1, close_chan_update_2) = {
2425 connect_blocks(&nodes[3], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + 1);
2426 let events = nodes[3].node.get_and_clear_pending_msg_events();
2427 assert_eq!(events.len(), 2);
2428 let close_chan_update_1 = match events[0] {
2429 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
2432 _ => panic!("Unexpected event"),
2435 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { .. }, node_id } => {
2436 assert_eq!(node_id, nodes[4].node.get_our_node_id());
2438 _ => panic!("Unexpected event"),
2440 check_added_monitors!(nodes[3], 1);
2442 // Clear bumped claiming txn spending node 2 commitment tx. Bumped txn are generated after reaching some height timer.
2444 let mut node_txn = nodes[3].tx_broadcaster.txn_broadcasted.lock().unwrap();
2445 node_txn.retain(|tx| {
2446 if tx.input[0].previous_output.txid == node2_commitment_txid {
2452 let node_txn = test_txn_broadcast(&nodes[3], &chan_4, None, HTLCType::TIMEOUT);
2454 // Claim the payment on nodes[4], giving it knowledge of the preimage
2455 claim_funds!(nodes[4], nodes[3], payment_preimage_2);
2457 connect_blocks(&nodes[4], TEST_FINAL_CLTV - CLTV_CLAIM_BUFFER + 2);
2458 let events = nodes[4].node.get_and_clear_pending_msg_events();
2459 assert_eq!(events.len(), 2);
2460 let close_chan_update_2 = match events[0] {
2461 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
2464 _ => panic!("Unexpected event"),
2467 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { .. }, node_id } => {
2468 assert_eq!(node_id, nodes[3].node.get_our_node_id());
2470 _ => panic!("Unexpected event"),
2472 check_added_monitors!(nodes[4], 1);
2473 test_txn_broadcast(&nodes[4], &chan_4, None, HTLCType::SUCCESS);
2475 mine_transaction(&nodes[4], &node_txn[0]);
2476 check_preimage_claim(&nodes[4], &node_txn);
2477 (close_chan_update_1, close_chan_update_2)
2479 nodes[3].net_graph_msg_handler.handle_channel_update(&close_chan_update_2).unwrap();
2480 nodes[4].net_graph_msg_handler.handle_channel_update(&close_chan_update_1).unwrap();
2481 assert_eq!(nodes[3].node.list_channels().len(), 0);
2482 assert_eq!(nodes[4].node.list_channels().len(), 0);
2484 nodes[3].chain_monitor.chain_monitor.monitors.write().unwrap().insert(OutPoint { txid: chan_3.3.txid(), index: 0 }, chan_3_mon);
2488 fn test_justice_tx() {
2489 // Test justice txn built on revoked HTLC-Success tx, against both sides
2490 let mut alice_config = UserConfig::default();
2491 alice_config.channel_options.announced_channel = true;
2492 alice_config.peer_channel_config_limits.force_announced_channel_preference = false;
2493 alice_config.own_channel_config.our_to_self_delay = 6 * 24 * 5;
2494 let mut bob_config = UserConfig::default();
2495 bob_config.channel_options.announced_channel = true;
2496 bob_config.peer_channel_config_limits.force_announced_channel_preference = false;
2497 bob_config.own_channel_config.our_to_self_delay = 6 * 24 * 3;
2498 let user_cfgs = [Some(alice_config), Some(bob_config)];
2499 let mut chanmon_cfgs = create_chanmon_cfgs(2);
2500 chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
2501 chanmon_cfgs[1].keys_manager.disable_revocation_policy_check = true;
2502 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2503 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &user_cfgs);
2504 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2505 // Create some new channels:
2506 let chan_5 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2508 // A pending HTLC which will be revoked:
2509 let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2510 // Get the will-be-revoked local txn from nodes[0]
2511 let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_5.2);
2512 assert_eq!(revoked_local_txn.len(), 2); // First commitment tx, then HTLC tx
2513 assert_eq!(revoked_local_txn[0].input.len(), 1);
2514 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_5.3.txid());
2515 assert_eq!(revoked_local_txn[0].output.len(), 2); // Only HTLC and output back to 0 are present
2516 assert_eq!(revoked_local_txn[1].input.len(), 1);
2517 assert_eq!(revoked_local_txn[1].input[0].previous_output.txid, revoked_local_txn[0].txid());
2518 assert_eq!(revoked_local_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC-Timeout
2519 // Revoke the old state
2520 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_3);
2523 mine_transaction(&nodes[1], &revoked_local_txn[0]);
2525 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2526 assert_eq!(node_txn.len(), 2); // ChannelMonitor: penalty tx, ChannelManager: local commitment tx
2527 assert_eq!(node_txn[0].input.len(), 2); // We should claim the revoked output and the HTLC output
2529 check_spends!(node_txn[0], revoked_local_txn[0]);
2530 node_txn.swap_remove(0);
2531 node_txn.truncate(1);
2533 check_added_monitors!(nodes[1], 1);
2534 test_txn_broadcast(&nodes[1], &chan_5, None, HTLCType::NONE);
2536 mine_transaction(&nodes[0], &revoked_local_txn[0]);
2537 connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
2538 // Verify broadcast of revoked HTLC-timeout
2539 let node_txn = test_txn_broadcast(&nodes[0], &chan_5, Some(revoked_local_txn[0].clone()), HTLCType::TIMEOUT);
2540 check_added_monitors!(nodes[0], 1);
2541 // Broadcast revoked HTLC-timeout on node 1
2542 mine_transaction(&nodes[1], &node_txn[1]);
2543 test_revoked_htlc_claim_txn_broadcast(&nodes[1], node_txn[1].clone(), revoked_local_txn[0].clone());
2545 get_announce_close_broadcast_events(&nodes, 0, 1);
2547 assert_eq!(nodes[0].node.list_channels().len(), 0);
2548 assert_eq!(nodes[1].node.list_channels().len(), 0);
2550 // We test justice_tx build by A on B's revoked HTLC-Success tx
2551 // Create some new channels:
2552 let chan_6 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2554 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2558 // A pending HTLC which will be revoked:
2559 let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2560 // Get the will-be-revoked local txn from B
2561 let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan_6.2);
2562 assert_eq!(revoked_local_txn.len(), 1); // Only commitment tx
2563 assert_eq!(revoked_local_txn[0].input.len(), 1);
2564 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_6.3.txid());
2565 assert_eq!(revoked_local_txn[0].output.len(), 2); // Only HTLC and output back to A are present
2566 // Revoke the old state
2567 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_4);
2569 mine_transaction(&nodes[0], &revoked_local_txn[0]);
2571 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
2572 assert_eq!(node_txn.len(), 2); //ChannelMonitor: penalty tx, ChannelManager: local commitment tx
2573 assert_eq!(node_txn[0].input.len(), 1); // We claim the received HTLC output
2575 check_spends!(node_txn[0], revoked_local_txn[0]);
2576 node_txn.swap_remove(0);
2578 check_added_monitors!(nodes[0], 1);
2579 test_txn_broadcast(&nodes[0], &chan_6, None, HTLCType::NONE);
2581 mine_transaction(&nodes[1], &revoked_local_txn[0]);
2582 let node_txn = test_txn_broadcast(&nodes[1], &chan_6, Some(revoked_local_txn[0].clone()), HTLCType::SUCCESS);
2583 check_added_monitors!(nodes[1], 1);
2584 mine_transaction(&nodes[0], &node_txn[1]);
2585 test_revoked_htlc_claim_txn_broadcast(&nodes[0], node_txn[1].clone(), revoked_local_txn[0].clone());
2587 get_announce_close_broadcast_events(&nodes, 0, 1);
2588 assert_eq!(nodes[0].node.list_channels().len(), 0);
2589 assert_eq!(nodes[1].node.list_channels().len(), 0);
2593 fn revoked_output_claim() {
2594 // Simple test to ensure a node will claim a revoked output when a stale remote commitment
2595 // transaction is broadcast by its counterparty
2596 let chanmon_cfgs = create_chanmon_cfgs(2);
2597 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2598 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2599 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2600 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2601 // node[0] is gonna to revoke an old state thus node[1] should be able to claim the revoked output
2602 let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2603 assert_eq!(revoked_local_txn.len(), 1);
2604 // Only output is the full channel value back to nodes[0]:
2605 assert_eq!(revoked_local_txn[0].output.len(), 1);
2606 // Send a payment through, updating everyone's latest commitment txn
2607 send_payment(&nodes[0], &vec!(&nodes[1])[..], 5000000);
2609 // Inform nodes[1] that nodes[0] broadcast a stale tx
2610 mine_transaction(&nodes[1], &revoked_local_txn[0]);
2611 check_added_monitors!(nodes[1], 1);
2612 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2613 assert_eq!(node_txn.len(), 2); // ChannelMonitor: justice tx against revoked to_local output, ChannelManager: local commitment tx
2615 check_spends!(node_txn[0], revoked_local_txn[0]);
2616 check_spends!(node_txn[1], chan_1.3);
2618 // Inform nodes[0] that a watchtower cheated on its behalf, so it will force-close the chan
2619 mine_transaction(&nodes[0], &revoked_local_txn[0]);
2620 get_announce_close_broadcast_events(&nodes, 0, 1);
2621 check_added_monitors!(nodes[0], 1)
2625 fn claim_htlc_outputs_shared_tx() {
2626 // Node revoked old state, htlcs haven't time out yet, claim them in shared justice tx
2627 let mut chanmon_cfgs = create_chanmon_cfgs(2);
2628 chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
2629 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2630 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2631 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2633 // Create some new channel:
2634 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2636 // Rebalance the network to generate htlc in the two directions
2637 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
2638 // 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
2639 let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2640 let (_payment_preimage_2, payment_hash_2, _) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000);
2642 // Get the will-be-revoked local txn from node[0]
2643 let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2644 assert_eq!(revoked_local_txn.len(), 2); // commitment tx + 1 HTLC-Timeout tx
2645 assert_eq!(revoked_local_txn[0].input.len(), 1);
2646 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
2647 assert_eq!(revoked_local_txn[1].input.len(), 1);
2648 assert_eq!(revoked_local_txn[1].input[0].previous_output.txid, revoked_local_txn[0].txid());
2649 assert_eq!(revoked_local_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC-Timeout
2650 check_spends!(revoked_local_txn[1], revoked_local_txn[0]);
2652 //Revoke the old state
2653 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_1);
2656 mine_transaction(&nodes[0], &revoked_local_txn[0]);
2657 check_added_monitors!(nodes[0], 1);
2658 mine_transaction(&nodes[1], &revoked_local_txn[0]);
2659 check_added_monitors!(nodes[1], 1);
2660 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
2661 expect_payment_failed!(nodes[1], payment_hash_2, true);
2663 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2664 assert_eq!(node_txn.len(), 2); // ChannelMonitor: penalty tx, ChannelManager: local commitment
2666 assert_eq!(node_txn[0].input.len(), 3); // Claim the revoked output + both revoked HTLC outputs
2667 check_spends!(node_txn[0], revoked_local_txn[0]);
2669 let mut witness_lens = BTreeSet::new();
2670 witness_lens.insert(node_txn[0].input[0].witness.last().unwrap().len());
2671 witness_lens.insert(node_txn[0].input[1].witness.last().unwrap().len());
2672 witness_lens.insert(node_txn[0].input[2].witness.last().unwrap().len());
2673 assert_eq!(witness_lens.len(), 3);
2674 assert_eq!(*witness_lens.iter().skip(0).next().unwrap(), 77); // revoked to_local
2675 assert_eq!(*witness_lens.iter().skip(1).next().unwrap(), OFFERED_HTLC_SCRIPT_WEIGHT); // revoked offered HTLC
2676 assert_eq!(*witness_lens.iter().skip(2).next().unwrap(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // revoked received HTLC
2678 // Next nodes[1] broadcasts its current local tx state:
2679 assert_eq!(node_txn[1].input.len(), 1);
2680 assert_eq!(node_txn[1].input[0].previous_output.txid, chan_1.3.txid()); //Spending funding tx unique txouput, tx broadcasted by ChannelManager
2682 get_announce_close_broadcast_events(&nodes, 0, 1);
2683 assert_eq!(nodes[0].node.list_channels().len(), 0);
2684 assert_eq!(nodes[1].node.list_channels().len(), 0);
2688 fn claim_htlc_outputs_single_tx() {
2689 // Node revoked old state, htlcs have timed out, claim each of them in separated justice tx
2690 let mut chanmon_cfgs = create_chanmon_cfgs(2);
2691 chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
2692 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2693 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2694 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2696 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2698 // Rebalance the network to generate htlc in the two directions
2699 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
2700 // 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
2701 // time as two different claim transactions as we're gonna to timeout htlc with given a high current height
2702 let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2703 let (_payment_preimage_2, payment_hash_2, _payment_secret_2) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000);
2705 // Get the will-be-revoked local txn from node[0]
2706 let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2708 //Revoke the old state
2709 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_1);
2712 confirm_transaction_at(&nodes[0], &revoked_local_txn[0], 100);
2713 check_added_monitors!(nodes[0], 1);
2714 confirm_transaction_at(&nodes[1], &revoked_local_txn[0], 100);
2715 check_added_monitors!(nodes[1], 1);
2716 expect_pending_htlcs_forwardable_ignore!(nodes[0]);
2718 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
2719 expect_payment_failed!(nodes[1], payment_hash_2, true);
2721 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2722 assert_eq!(node_txn.len(), 9);
2723 // ChannelMonitor: justice tx revoked offered htlc, justice tx revoked received htlc, justice tx revoked to_local (3)
2724 // ChannelManager: local commmitment + local HTLC-timeout (2)
2725 // 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)
2726 // ChannelMonitor: local commitment + local HTLC-timeout (2)
2728 // Check the pair local commitment and HTLC-timeout broadcast due to HTLC expiration
2729 assert_eq!(node_txn[0].input.len(), 1);
2730 check_spends!(node_txn[0], chan_1.3);
2731 assert_eq!(node_txn[1].input.len(), 1);
2732 let witness_script = node_txn[1].input[0].witness.last().unwrap();
2733 assert_eq!(witness_script.len(), OFFERED_HTLC_SCRIPT_WEIGHT); //Spending an offered htlc output
2734 check_spends!(node_txn[1], node_txn[0]);
2736 // Justice transactions are indices 1-2-4
2737 assert_eq!(node_txn[2].input.len(), 1);
2738 assert_eq!(node_txn[3].input.len(), 1);
2739 assert_eq!(node_txn[4].input.len(), 1);
2741 check_spends!(node_txn[2], revoked_local_txn[0]);
2742 check_spends!(node_txn[3], revoked_local_txn[0]);
2743 check_spends!(node_txn[4], revoked_local_txn[0]);
2745 let mut witness_lens = BTreeSet::new();
2746 witness_lens.insert(node_txn[2].input[0].witness.last().unwrap().len());
2747 witness_lens.insert(node_txn[3].input[0].witness.last().unwrap().len());
2748 witness_lens.insert(node_txn[4].input[0].witness.last().unwrap().len());
2749 assert_eq!(witness_lens.len(), 3);
2750 assert_eq!(*witness_lens.iter().skip(0).next().unwrap(), 77); // revoked to_local
2751 assert_eq!(*witness_lens.iter().skip(1).next().unwrap(), OFFERED_HTLC_SCRIPT_WEIGHT); // revoked offered HTLC
2752 assert_eq!(*witness_lens.iter().skip(2).next().unwrap(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // revoked received HTLC
2754 get_announce_close_broadcast_events(&nodes, 0, 1);
2755 assert_eq!(nodes[0].node.list_channels().len(), 0);
2756 assert_eq!(nodes[1].node.list_channels().len(), 0);
2760 fn test_htlc_on_chain_success() {
2761 // Test that in case of a unilateral close onchain, we detect the state of output and pass
2762 // the preimage backward accordingly. So here we test that ChannelManager is
2763 // broadcasting the right event to other nodes in payment path.
2764 // We test with two HTLCs simultaneously as that was not handled correctly in the past.
2765 // A --------------------> B ----------------------> C (preimage)
2766 // First, C should claim the HTLC outputs via HTLC-Success when its own latest local
2767 // commitment transaction was broadcast.
2768 // Then, B should learn the preimage from said transactions, attempting to claim backwards
2770 // B should be able to claim via preimage if A then broadcasts its local tx.
2771 // Finally, when A sees B's latest local commitment transaction it should be able to claim
2772 // the HTLC outputs via the preimage it learned (which, once confirmed should generate a
2773 // PaymentSent event).
2775 let chanmon_cfgs = create_chanmon_cfgs(3);
2776 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2777 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2778 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2780 // Create some initial channels
2781 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2782 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
2784 // Ensure all nodes are at the same height
2785 let node_max_height = nodes.iter().map(|node| node.blocks.lock().unwrap().len()).max().unwrap() as u32;
2786 connect_blocks(&nodes[0], node_max_height - nodes[0].best_block_info().1);
2787 connect_blocks(&nodes[1], node_max_height - nodes[1].best_block_info().1);
2788 connect_blocks(&nodes[2], node_max_height - nodes[2].best_block_info().1);
2790 // Rebalance the network a bit by relaying one payment through all the channels...
2791 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
2792 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
2794 let (our_payment_preimage, _payment_hash, _payment_secret) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2795 let (our_payment_preimage_2, _payment_hash_2, _payment_secret_2) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2797 // Broadcast legit commitment tx from C on B's chain
2798 // Broadcast HTLC Success transaction by C on received output from C's commitment tx on B's chain
2799 let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
2800 assert_eq!(commitment_tx.len(), 1);
2801 check_spends!(commitment_tx[0], chan_2.3);
2802 nodes[2].node.claim_funds(our_payment_preimage);
2803 nodes[2].node.claim_funds(our_payment_preimage_2);
2804 check_added_monitors!(nodes[2], 2);
2805 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2806 assert!(updates.update_add_htlcs.is_empty());
2807 assert!(updates.update_fail_htlcs.is_empty());
2808 assert!(updates.update_fail_malformed_htlcs.is_empty());
2809 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
2811 mine_transaction(&nodes[2], &commitment_tx[0]);
2812 check_closed_broadcast!(nodes[2], true);
2813 check_added_monitors!(nodes[2], 1);
2814 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)
2815 assert_eq!(node_txn.len(), 5);
2816 assert_eq!(node_txn[0], node_txn[3]);
2817 assert_eq!(node_txn[1], node_txn[4]);
2818 assert_eq!(node_txn[2], commitment_tx[0]);
2819 check_spends!(node_txn[0], commitment_tx[0]);
2820 check_spends!(node_txn[1], commitment_tx[0]);
2821 assert_eq!(node_txn[0].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2822 assert_eq!(node_txn[1].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2823 assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2824 assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2825 assert_eq!(node_txn[0].lock_time, 0);
2826 assert_eq!(node_txn[1].lock_time, 0);
2828 // Verify that B's ChannelManager is able to extract preimage from HTLC Success tx and pass it backward
2829 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2830 connect_block(&nodes[1], &Block { header, txdata: node_txn});
2831 connect_blocks(&nodes[1], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
2833 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
2834 assert_eq!(added_monitors.len(), 1);
2835 assert_eq!(added_monitors[0].0.txid, chan_2.3.txid());
2836 added_monitors.clear();
2838 let forwarded_events = nodes[1].node.get_and_clear_pending_events();
2839 assert_eq!(forwarded_events.len(), 2);
2840 if let Event::PaymentForwarded { fee_earned_msat: Some(1000), claim_from_onchain_tx: true } = forwarded_events[0] {
2841 } else { panic!(); }
2842 if let Event::PaymentForwarded { fee_earned_msat: Some(1000), claim_from_onchain_tx: true } = forwarded_events[1] {
2843 } else { panic!(); }
2844 let events = nodes[1].node.get_and_clear_pending_msg_events();
2846 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
2847 assert_eq!(added_monitors.len(), 2);
2848 assert_eq!(added_monitors[0].0.txid, chan_1.3.txid());
2849 assert_eq!(added_monitors[1].0.txid, chan_1.3.txid());
2850 added_monitors.clear();
2852 assert_eq!(events.len(), 3);
2854 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
2855 _ => panic!("Unexpected event"),
2858 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { .. }, node_id: _ } => {},
2859 _ => panic!("Unexpected event"),
2863 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, .. } } => {
2864 assert!(update_add_htlcs.is_empty());
2865 assert!(update_fail_htlcs.is_empty());
2866 assert_eq!(update_fulfill_htlcs.len(), 1);
2867 assert!(update_fail_malformed_htlcs.is_empty());
2868 assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
2870 _ => panic!("Unexpected event"),
2872 macro_rules! check_tx_local_broadcast {
2873 ($node: expr, $htlc_offered: expr, $commitment_tx: expr, $chan_tx: expr) => { {
2874 let mut node_txn = $node.tx_broadcaster.txn_broadcasted.lock().unwrap();
2875 assert_eq!(node_txn.len(), 3);
2876 // Node[1]: ChannelManager: 3 (commitment tx, 2*HTLC-Timeout tx), ChannelMonitor: 2 (timeout tx)
2877 // Node[0]: ChannelManager: 3 (commtiemtn tx, 2*HTLC-Timeout tx), ChannelMonitor: 2 HTLC-timeout
2878 check_spends!(node_txn[1], $commitment_tx);
2879 check_spends!(node_txn[2], $commitment_tx);
2880 assert_ne!(node_txn[1].lock_time, 0);
2881 assert_ne!(node_txn[2].lock_time, 0);
2883 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2884 assert_eq!(node_txn[2].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2885 assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2886 assert!(node_txn[2].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2888 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2889 assert_eq!(node_txn[2].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2890 assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2891 assert!(node_txn[2].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2893 check_spends!(node_txn[0], $chan_tx);
2894 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), 71);
2898 // nodes[1] now broadcasts its own local state as a fallback, suggesting an alternate
2899 // commitment transaction with a corresponding HTLC-Timeout transactions, as well as a
2900 // timeout-claim of the output that nodes[2] just claimed via success.
2901 check_tx_local_broadcast!(nodes[1], false, commitment_tx[0], chan_2.3);
2903 // Broadcast legit commitment tx from A on B's chain
2904 // Broadcast preimage tx by B on offered output from A commitment tx on A's chain
2905 let node_a_commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
2906 check_spends!(node_a_commitment_tx[0], chan_1.3);
2907 mine_transaction(&nodes[1], &node_a_commitment_tx[0]);
2908 check_closed_broadcast!(nodes[1], true);
2909 check_added_monitors!(nodes[1], 1);
2910 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
2911 assert_eq!(node_txn.len(), 6); // ChannelManager : 3 (commitment tx + HTLC-Sucess * 2), ChannelMonitor : 3 (HTLC-Success, 2* RBF bumps of above HTLC txn)
2912 let commitment_spend =
2913 if node_txn[0].input[0].previous_output.txid == node_a_commitment_tx[0].txid() {
2914 check_spends!(node_txn[1], commitment_tx[0]);
2915 check_spends!(node_txn[2], commitment_tx[0]);
2916 assert_ne!(node_txn[1].input[0].previous_output.vout, node_txn[2].input[0].previous_output.vout);
2919 check_spends!(node_txn[0], commitment_tx[0]);
2920 check_spends!(node_txn[1], commitment_tx[0]);
2921 assert_ne!(node_txn[0].input[0].previous_output.vout, node_txn[1].input[0].previous_output.vout);
2925 check_spends!(commitment_spend, node_a_commitment_tx[0]);
2926 assert_eq!(commitment_spend.input.len(), 2);
2927 assert_eq!(commitment_spend.input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2928 assert_eq!(commitment_spend.input[1].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2929 assert_eq!(commitment_spend.lock_time, 0);
2930 assert!(commitment_spend.output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2931 check_spends!(node_txn[3], chan_1.3);
2932 assert_eq!(node_txn[3].input[0].witness.clone().last().unwrap().len(), 71);
2933 check_spends!(node_txn[4], node_txn[3]);
2934 check_spends!(node_txn[5], node_txn[3]);
2935 // We don't bother to check that B can claim the HTLC output on its commitment tx here as
2936 // we already checked the same situation with A.
2938 // Verify that A's ChannelManager is able to extract preimage from preimage tx and generate PaymentSent
2939 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2940 connect_block(&nodes[0], &Block { header, txdata: vec![node_a_commitment_tx[0].clone(), commitment_spend.clone()] });
2941 connect_blocks(&nodes[0], TEST_FINAL_CLTV + MIN_CLTV_EXPIRY_DELTA as u32 - 1); // Confirm blocks until the HTLC expires
2942 check_closed_broadcast!(nodes[0], true);
2943 check_added_monitors!(nodes[0], 1);
2944 let events = nodes[0].node.get_and_clear_pending_events();
2945 assert_eq!(events.len(), 2);
2946 let mut first_claimed = false;
2947 for event in events {
2949 Event::PaymentSent { payment_preimage } => {
2950 if payment_preimage == our_payment_preimage {
2951 assert!(!first_claimed);
2952 first_claimed = true;
2954 assert_eq!(payment_preimage, our_payment_preimage_2);
2957 _ => panic!("Unexpected event"),
2960 check_tx_local_broadcast!(nodes[0], true, node_a_commitment_tx[0], chan_1.3);
2963 fn do_test_htlc_on_chain_timeout(connect_style: ConnectStyle) {
2964 // Test that in case of a unilateral close onchain, we detect the state of output and
2965 // timeout the HTLC backward accordingly. So here we test that ChannelManager is
2966 // broadcasting the right event to other nodes in payment path.
2967 // A ------------------> B ----------------------> C (timeout)
2968 // B's commitment tx C's commitment tx
2970 // B's HTLC timeout tx B's timeout tx
2972 let chanmon_cfgs = create_chanmon_cfgs(3);
2973 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2974 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2975 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2976 *nodes[0].connect_style.borrow_mut() = connect_style;
2977 *nodes[1].connect_style.borrow_mut() = connect_style;
2978 *nodes[2].connect_style.borrow_mut() = connect_style;
2980 // Create some intial channels
2981 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2982 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
2984 // Rebalance the network a bit by relaying one payment thorugh all the channels...
2985 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
2986 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
2988 let (_payment_preimage, payment_hash, _payment_secret) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2990 // Broadcast legit commitment tx from C on B's chain
2991 let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
2992 check_spends!(commitment_tx[0], chan_2.3);
2993 nodes[2].node.fail_htlc_backwards(&payment_hash);
2994 check_added_monitors!(nodes[2], 0);
2995 expect_pending_htlcs_forwardable!(nodes[2]);
2996 check_added_monitors!(nodes[2], 1);
2998 let events = nodes[2].node.get_and_clear_pending_msg_events();
2999 assert_eq!(events.len(), 1);
3001 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, .. } } => {
3002 assert!(update_add_htlcs.is_empty());
3003 assert!(!update_fail_htlcs.is_empty());
3004 assert!(update_fulfill_htlcs.is_empty());
3005 assert!(update_fail_malformed_htlcs.is_empty());
3006 assert_eq!(nodes[1].node.get_our_node_id(), *node_id);
3008 _ => panic!("Unexpected event"),
3010 mine_transaction(&nodes[2], &commitment_tx[0]);
3011 check_closed_broadcast!(nodes[2], true);
3012 check_added_monitors!(nodes[2], 1);
3013 let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 1 (commitment tx)
3014 assert_eq!(node_txn.len(), 1);
3015 check_spends!(node_txn[0], chan_2.3);
3016 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), 71);
3018 // Broadcast timeout transaction by B on received output from C's commitment tx on B's chain
3019 // Verify that B's ChannelManager is able to detect that HTLC is timeout by its own tx and react backward in consequence
3020 connect_blocks(&nodes[1], 200 - nodes[2].best_block_info().1);
3021 mine_transaction(&nodes[1], &commitment_tx[0]);
3024 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
3025 assert_eq!(node_txn.len(), 5); // ChannelManager : 2 (commitment tx, HTLC-Timeout tx), ChannelMonitor : 2 (local commitment tx + HTLC-timeout), 1 timeout tx
3026 assert_eq!(node_txn[0], node_txn[3]);
3027 assert_eq!(node_txn[1], node_txn[4]);
3029 check_spends!(node_txn[2], commitment_tx[0]);
3030 assert_eq!(node_txn[2].clone().input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
3032 check_spends!(node_txn[0], chan_2.3);
3033 check_spends!(node_txn[1], node_txn[0]);
3034 assert_eq!(node_txn[0].clone().input[0].witness.last().unwrap().len(), 71);
3035 assert_eq!(node_txn[1].clone().input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
3037 timeout_tx = node_txn[2].clone();
3041 mine_transaction(&nodes[1], &timeout_tx);
3042 check_added_monitors!(nodes[1], 1);
3043 check_closed_broadcast!(nodes[1], true);
3045 // B will rebroadcast a fee-bumped timeout transaction here.
3046 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
3047 assert_eq!(node_txn.len(), 1);
3048 check_spends!(node_txn[0], commitment_tx[0]);
3051 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
3053 // B may rebroadcast its own holder commitment transaction here, as a safeguard against
3054 // some incredibly unlikely partial-eclipse-attack scenarios. That said, because the
3055 // original commitment_tx[0] (also spending chan_2.3) has reached ANTI_REORG_DELAY B really
3056 // shouldn't broadcast anything here, and in some connect style scenarios we do not.
3057 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
3058 if node_txn.len() == 1 {
3059 check_spends!(node_txn[0], chan_2.3);
3061 assert_eq!(node_txn.len(), 0);
3065 expect_pending_htlcs_forwardable!(nodes[1]);
3066 check_added_monitors!(nodes[1], 1);
3067 let events = nodes[1].node.get_and_clear_pending_msg_events();
3068 assert_eq!(events.len(), 1);
3070 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, .. } } => {
3071 assert!(update_add_htlcs.is_empty());
3072 assert!(!update_fail_htlcs.is_empty());
3073 assert!(update_fulfill_htlcs.is_empty());
3074 assert!(update_fail_malformed_htlcs.is_empty());
3075 assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
3077 _ => panic!("Unexpected event"),
3080 // Broadcast legit commitment tx from B on A's chain
3081 let commitment_tx = get_local_commitment_txn!(nodes[1], chan_1.2);
3082 check_spends!(commitment_tx[0], chan_1.3);
3084 mine_transaction(&nodes[0], &commitment_tx[0]);
3085 connect_blocks(&nodes[0], TEST_FINAL_CLTV + MIN_CLTV_EXPIRY_DELTA as u32 - 1); // Confirm blocks until the HTLC expires
3087 check_closed_broadcast!(nodes[0], true);
3088 check_added_monitors!(nodes[0], 1);
3089 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 1 commitment tx, ChannelMonitor : 1 timeout tx
3090 assert_eq!(node_txn.len(), 2);
3091 check_spends!(node_txn[0], chan_1.3);
3092 assert_eq!(node_txn[0].clone().input[0].witness.last().unwrap().len(), 71);
3093 check_spends!(node_txn[1], commitment_tx[0]);
3094 assert_eq!(node_txn[1].clone().input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
3098 fn test_htlc_on_chain_timeout() {
3099 do_test_htlc_on_chain_timeout(ConnectStyle::BestBlockFirstSkippingBlocks);
3100 do_test_htlc_on_chain_timeout(ConnectStyle::TransactionsFirstSkippingBlocks);
3101 do_test_htlc_on_chain_timeout(ConnectStyle::FullBlockViaListen);
3105 fn test_simple_commitment_revoked_fail_backward() {
3106 // Test that in case of a revoked commitment tx, we detect the resolution of output by justice tx
3107 // and fail backward accordingly.
3109 let chanmon_cfgs = create_chanmon_cfgs(3);
3110 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3111 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3112 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3114 // Create some initial channels
3115 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3116 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3118 let (payment_preimage, _payment_hash, _payment_secret) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3000000);
3119 // Get the will-be-revoked local txn from nodes[2]
3120 let revoked_local_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
3121 // Revoke the old state
3122 claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage);
3124 let (_, payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3000000);
3126 mine_transaction(&nodes[1], &revoked_local_txn[0]);
3127 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
3128 check_added_monitors!(nodes[1], 1);
3129 check_closed_broadcast!(nodes[1], true);
3131 expect_pending_htlcs_forwardable!(nodes[1]);
3132 check_added_monitors!(nodes[1], 1);
3133 let events = nodes[1].node.get_and_clear_pending_msg_events();
3134 assert_eq!(events.len(), 1);
3136 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, .. } } => {
3137 assert!(update_add_htlcs.is_empty());
3138 assert_eq!(update_fail_htlcs.len(), 1);
3139 assert!(update_fulfill_htlcs.is_empty());
3140 assert!(update_fail_malformed_htlcs.is_empty());
3141 assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
3143 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
3144 commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
3145 expect_payment_failure_chan_update!(nodes[0], chan_2.0.contents.short_channel_id, true);
3146 expect_payment_failed!(nodes[0], payment_hash, false);
3148 _ => panic!("Unexpected event"),
3152 fn do_test_commitment_revoked_fail_backward_exhaustive(deliver_bs_raa: bool, use_dust: bool, no_to_remote: bool) {
3153 // Test that if our counterparty broadcasts a revoked commitment transaction we fail all
3154 // pending HTLCs on that channel backwards even if the HTLCs aren't present in our latest
3155 // commitment transaction anymore.
3156 // To do this, we have the peer which will broadcast a revoked commitment transaction send
3157 // a number of update_fail/commitment_signed updates without ever sending the RAA in
3158 // response to our commitment_signed. This is somewhat misbehavior-y, though not
3159 // technically disallowed and we should probably handle it reasonably.
3160 // Note that this is pretty exhaustive as an outbound HTLC which we haven't yet
3161 // failed/fulfilled backwards must be in at least one of the latest two remote commitment
3163 // * Once we move it out of our holding cell/add it, we will immediately include it in a
3164 // commitment_signed (implying it will be in the latest remote commitment transaction).
3165 // * Once they remove it, we will send a (the first) commitment_signed without the HTLC,
3166 // and once they revoke the previous commitment transaction (allowing us to send a new
3167 // commitment_signed) we will be free to fail/fulfill the HTLC backwards.
3168 let chanmon_cfgs = create_chanmon_cfgs(3);
3169 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3170 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3171 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3173 // Create some initial channels
3174 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3175 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3177 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 });
3178 // Get the will-be-revoked local txn from nodes[2]
3179 let revoked_local_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
3180 assert_eq!(revoked_local_txn[0].output.len(), if no_to_remote { 1 } else { 2 });
3181 // Revoke the old state
3182 claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage);
3184 let value = if use_dust {
3185 // The dust limit applied to HTLC outputs considers the fee of the HTLC transaction as
3186 // well, so HTLCs at exactly the dust limit will not be included in commitment txn.
3187 nodes[2].node.channel_state.lock().unwrap().by_id.get(&chan_2.2).unwrap().holder_dust_limit_satoshis * 1000
3190 let (_, first_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
3191 let (_, second_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
3192 let (_, third_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
3194 assert!(nodes[2].node.fail_htlc_backwards(&first_payment_hash));
3195 expect_pending_htlcs_forwardable!(nodes[2]);
3196 check_added_monitors!(nodes[2], 1);
3197 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3198 assert!(updates.update_add_htlcs.is_empty());
3199 assert!(updates.update_fulfill_htlcs.is_empty());
3200 assert!(updates.update_fail_malformed_htlcs.is_empty());
3201 assert_eq!(updates.update_fail_htlcs.len(), 1);
3202 assert!(updates.update_fee.is_none());
3203 nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
3204 let bs_raa = commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false, true, false, true);
3205 // Drop the last RAA from 3 -> 2
3207 assert!(nodes[2].node.fail_htlc_backwards(&second_payment_hash));
3208 expect_pending_htlcs_forwardable!(nodes[2]);
3209 check_added_monitors!(nodes[2], 1);
3210 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3211 assert!(updates.update_add_htlcs.is_empty());
3212 assert!(updates.update_fulfill_htlcs.is_empty());
3213 assert!(updates.update_fail_malformed_htlcs.is_empty());
3214 assert_eq!(updates.update_fail_htlcs.len(), 1);
3215 assert!(updates.update_fee.is_none());
3216 nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
3217 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &updates.commitment_signed);
3218 check_added_monitors!(nodes[1], 1);
3219 // Note that nodes[1] is in AwaitingRAA, so won't send a CS
3220 let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
3221 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
3222 check_added_monitors!(nodes[2], 1);
3224 assert!(nodes[2].node.fail_htlc_backwards(&third_payment_hash));
3225 expect_pending_htlcs_forwardable!(nodes[2]);
3226 check_added_monitors!(nodes[2], 1);
3227 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3228 assert!(updates.update_add_htlcs.is_empty());
3229 assert!(updates.update_fulfill_htlcs.is_empty());
3230 assert!(updates.update_fail_malformed_htlcs.is_empty());
3231 assert_eq!(updates.update_fail_htlcs.len(), 1);
3232 assert!(updates.update_fee.is_none());
3233 nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
3234 // At this point first_payment_hash has dropped out of the latest two commitment
3235 // transactions that nodes[1] is tracking...
3236 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &updates.commitment_signed);
3237 check_added_monitors!(nodes[1], 1);
3238 // Note that nodes[1] is (still) in AwaitingRAA, so won't send a CS
3239 let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
3240 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
3241 check_added_monitors!(nodes[2], 1);
3243 // Add a fourth HTLC, this one will get sequestered away in nodes[1]'s holding cell waiting
3244 // on nodes[2]'s RAA.
3245 let (_, fourth_payment_hash, fourth_payment_secret) = get_payment_preimage_hash!(nodes[2]);
3246 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
3247 let logger = test_utils::TestLogger::new();
3248 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();
3249 nodes[1].node.send_payment(&route, fourth_payment_hash, &Some(fourth_payment_secret)).unwrap();
3250 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3251 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
3252 check_added_monitors!(nodes[1], 0);
3255 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_raa);
3256 // One monitor for the new revocation preimage, no second on as we won't generate a new
3257 // commitment transaction for nodes[0] until process_pending_htlc_forwards().
3258 check_added_monitors!(nodes[1], 1);
3259 let events = nodes[1].node.get_and_clear_pending_events();
3260 assert_eq!(events.len(), 1);
3262 Event::PendingHTLCsForwardable { .. } => { },
3263 _ => panic!("Unexpected event"),
3265 // Deliberately don't process the pending fail-back so they all fail back at once after
3266 // block connection just like the !deliver_bs_raa case
3269 let mut failed_htlcs = HashSet::new();
3270 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
3272 mine_transaction(&nodes[1], &revoked_local_txn[0]);
3273 check_added_monitors!(nodes[1], 1);
3274 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
3276 let events = nodes[1].node.get_and_clear_pending_events();
3277 assert_eq!(events.len(), if deliver_bs_raa { 1 } else { 2 });
3279 Event::PaymentFailed { ref payment_hash, .. } => {
3280 assert_eq!(*payment_hash, fourth_payment_hash);
3282 _ => panic!("Unexpected event"),
3284 if !deliver_bs_raa {
3286 Event::PendingHTLCsForwardable { .. } => { },
3287 _ => panic!("Unexpected event"),
3290 nodes[1].node.process_pending_htlc_forwards();
3291 check_added_monitors!(nodes[1], 1);
3293 let events = nodes[1].node.get_and_clear_pending_msg_events();
3294 assert_eq!(events.len(), if deliver_bs_raa { 4 } else { 3 });
3295 match events[if deliver_bs_raa { 1 } else { 0 }] {
3296 MessageSendEvent::BroadcastChannelUpdate { msg: msgs::ChannelUpdate { .. } } => {},
3297 _ => panic!("Unexpected event"),
3299 match events[if deliver_bs_raa { 2 } else { 1 }] {
3300 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { msg: msgs::ErrorMessage { channel_id, ref data } }, node_id: _ } => {
3301 assert_eq!(channel_id, chan_2.2);
3302 assert_eq!(data.as_str(), "Commitment or closing transaction was confirmed on chain.");
3304 _ => panic!("Unexpected event"),
3308 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, .. } } => {
3309 assert_eq!(nodes[2].node.get_our_node_id(), *node_id);
3310 assert_eq!(update_add_htlcs.len(), 1);
3311 assert!(update_fulfill_htlcs.is_empty());
3312 assert!(update_fail_htlcs.is_empty());
3313 assert!(update_fail_malformed_htlcs.is_empty());
3315 _ => panic!("Unexpected event"),
3318 match events[if deliver_bs_raa { 3 } else { 2 }] {
3319 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, .. } } => {
3320 assert!(update_add_htlcs.is_empty());
3321 assert_eq!(update_fail_htlcs.len(), 3);
3322 assert!(update_fulfill_htlcs.is_empty());
3323 assert!(update_fail_malformed_htlcs.is_empty());
3324 assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
3326 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
3327 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[1]);
3328 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[2]);
3330 commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
3332 let events = nodes[0].node.get_and_clear_pending_msg_events();
3333 // If we delivered B's RAA we got an unknown preimage error, not something
3334 // that we should update our routing table for.
3335 assert_eq!(events.len(), if deliver_bs_raa { 2 } else { 3 });
3336 for event in events {
3338 MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
3339 _ => panic!("Unexpected event"),
3342 let events = nodes[0].node.get_and_clear_pending_events();
3343 assert_eq!(events.len(), 3);
3345 Event::PaymentFailed { ref payment_hash, .. } => {
3346 assert!(failed_htlcs.insert(payment_hash.0));
3348 _ => panic!("Unexpected event"),
3351 Event::PaymentFailed { ref payment_hash, .. } => {
3352 assert!(failed_htlcs.insert(payment_hash.0));
3354 _ => panic!("Unexpected event"),
3357 Event::PaymentFailed { ref payment_hash, .. } => {
3358 assert!(failed_htlcs.insert(payment_hash.0));
3360 _ => panic!("Unexpected event"),
3363 _ => panic!("Unexpected event"),
3366 assert!(failed_htlcs.contains(&first_payment_hash.0));
3367 assert!(failed_htlcs.contains(&second_payment_hash.0));
3368 assert!(failed_htlcs.contains(&third_payment_hash.0));
3372 fn test_commitment_revoked_fail_backward_exhaustive_a() {
3373 do_test_commitment_revoked_fail_backward_exhaustive(false, true, false);
3374 do_test_commitment_revoked_fail_backward_exhaustive(true, true, false);
3375 do_test_commitment_revoked_fail_backward_exhaustive(false, false, false);
3376 do_test_commitment_revoked_fail_backward_exhaustive(true, false, false);
3380 fn test_commitment_revoked_fail_backward_exhaustive_b() {
3381 do_test_commitment_revoked_fail_backward_exhaustive(false, true, true);
3382 do_test_commitment_revoked_fail_backward_exhaustive(true, true, true);
3383 do_test_commitment_revoked_fail_backward_exhaustive(false, false, true);
3384 do_test_commitment_revoked_fail_backward_exhaustive(true, false, true);
3388 fn fail_backward_pending_htlc_upon_channel_failure() {
3389 let chanmon_cfgs = create_chanmon_cfgs(2);
3390 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3391 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3392 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3393 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1_000_000, 500_000_000, InitFeatures::known(), InitFeatures::known());
3394 let logger = test_utils::TestLogger::new();
3396 // Alice -> Bob: Route a payment but without Bob sending revoke_and_ack.
3398 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1]);
3399 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3400 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();
3401 nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
3402 check_added_monitors!(nodes[0], 1);
3404 let payment_event = {
3405 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3406 assert_eq!(events.len(), 1);
3407 SendEvent::from_event(events.remove(0))
3409 assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
3410 assert_eq!(payment_event.msgs.len(), 1);
3413 // Alice -> Bob: Route another payment but now Alice waits for Bob's earlier revoke_and_ack.
3414 let (_, failed_payment_hash, failed_payment_secret) = get_payment_preimage_hash!(nodes[1]);
3416 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3417 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();
3418 nodes[0].node.send_payment(&route, failed_payment_hash, &Some(failed_payment_secret)).unwrap();
3419 check_added_monitors!(nodes[0], 0);
3421 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3424 // Alice <- Bob: Send a malformed update_add_htlc so Alice fails the channel.
3426 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[0]);
3428 let secp_ctx = Secp256k1::new();
3429 let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
3430 let current_height = nodes[1].node.best_block.read().unwrap().height() + 1;
3431 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
3432 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();
3433 let (onion_payloads, _amount_msat, cltv_expiry) = onion_utils::build_onion_payloads(&route.paths[0], 50_000, &Some(payment_secret), current_height, &None).unwrap();
3434 let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route.paths[0], &session_priv).unwrap();
3435 let onion_routing_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
3437 // Send a 0-msat update_add_htlc to fail the channel.
3438 let update_add_htlc = msgs::UpdateAddHTLC {
3444 onion_routing_packet,
3446 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &update_add_htlc);
3449 // Check that Alice fails backward the pending HTLC from the second payment.
3450 expect_payment_failed!(nodes[0], failed_payment_hash, true);
3451 check_closed_broadcast!(nodes[0], true);
3452 check_added_monitors!(nodes[0], 1);
3456 fn test_htlc_ignore_latest_remote_commitment() {
3457 // Test that HTLC transactions spending the latest remote commitment transaction are simply
3458 // ignored if we cannot claim them. This originally tickled an invalid unwrap().
3459 let chanmon_cfgs = create_chanmon_cfgs(2);
3460 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3461 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3462 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3463 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3465 route_payment(&nodes[0], &[&nodes[1]], 10000000);
3466 nodes[0].node.force_close_channel(&nodes[0].node.list_channels()[0].channel_id).unwrap();
3467 connect_blocks(&nodes[0], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + 1);
3468 check_closed_broadcast!(nodes[0], true);
3469 check_added_monitors!(nodes[0], 1);
3471 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
3472 assert_eq!(node_txn.len(), 3);
3473 assert_eq!(node_txn[0], node_txn[1]);
3475 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3476 connect_block(&nodes[1], &Block { header, txdata: vec![node_txn[0].clone(), node_txn[1].clone()]});
3477 check_closed_broadcast!(nodes[1], true);
3478 check_added_monitors!(nodes[1], 1);
3480 // Duplicate the connect_block call since this may happen due to other listeners
3481 // registering new transactions
3482 header.prev_blockhash = header.block_hash();
3483 connect_block(&nodes[1], &Block { header, txdata: vec![node_txn[0].clone(), node_txn[2].clone()]});
3487 fn test_force_close_fail_back() {
3488 // Check which HTLCs are failed-backwards on channel force-closure
3489 let chanmon_cfgs = create_chanmon_cfgs(3);
3490 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3491 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3492 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3493 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3494 create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3495 let logger = test_utils::TestLogger::new();
3497 let (our_payment_preimage, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[2]);
3499 let mut payment_event = {
3500 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3501 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();
3502 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
3503 check_added_monitors!(nodes[0], 1);
3505 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3506 assert_eq!(events.len(), 1);
3507 SendEvent::from_event(events.remove(0))
3510 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
3511 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
3513 expect_pending_htlcs_forwardable!(nodes[1]);
3515 let mut events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3516 assert_eq!(events_2.len(), 1);
3517 payment_event = SendEvent::from_event(events_2.remove(0));
3518 assert_eq!(payment_event.msgs.len(), 1);
3520 check_added_monitors!(nodes[1], 1);
3521 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
3522 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg);
3523 check_added_monitors!(nodes[2], 1);
3524 let (_, _) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3526 // nodes[2] now has the latest commitment transaction, but hasn't revoked its previous
3527 // state or updated nodes[1]' state. Now force-close and broadcast that commitment/HTLC
3528 // transaction and ensure nodes[1] doesn't fail-backwards (this was originally a bug!).
3530 nodes[2].node.force_close_channel(&payment_event.commitment_msg.channel_id).unwrap();
3531 check_closed_broadcast!(nodes[2], true);
3532 check_added_monitors!(nodes[2], 1);
3534 let mut node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap();
3535 // Note that we don't bother broadcasting the HTLC-Success transaction here as we don't
3536 // have a use for it unless nodes[2] learns the preimage somehow, the funds will go
3537 // back to nodes[1] upon timeout otherwise.
3538 assert_eq!(node_txn.len(), 1);
3542 mine_transaction(&nodes[1], &tx);
3544 // Note no UpdateHTLCs event here from nodes[1] to nodes[0]!
3545 check_closed_broadcast!(nodes[1], true);
3546 check_added_monitors!(nodes[1], 1);
3548 // Now check that if we add the preimage to ChannelMonitor it broadcasts our HTLC-Success..
3550 let mut monitors = nodes[2].chain_monitor.chain_monitor.monitors.read().unwrap();
3551 monitors.get(&OutPoint{ txid: Txid::from_slice(&payment_event.commitment_msg.channel_id[..]).unwrap(), index: 0 }).unwrap()
3552 .provide_payment_preimage(&our_payment_hash, &our_payment_preimage, &node_cfgs[2].tx_broadcaster, &node_cfgs[2].fee_estimator, &&logger);
3554 mine_transaction(&nodes[2], &tx);
3555 let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap();
3556 assert_eq!(node_txn.len(), 1);
3557 assert_eq!(node_txn[0].input.len(), 1);
3558 assert_eq!(node_txn[0].input[0].previous_output.txid, tx.txid());
3559 assert_eq!(node_txn[0].lock_time, 0); // Must be an HTLC-Success
3560 assert_eq!(node_txn[0].input[0].witness.len(), 5); // Must be an HTLC-Success
3562 check_spends!(node_txn[0], tx);
3566 fn test_dup_events_on_peer_disconnect() {
3567 // Test that if we receive a duplicative update_fulfill_htlc message after a reconnect we do
3568 // not generate a corresponding duplicative PaymentSent event. This did not use to be the case
3569 // as we used to generate the event immediately upon receipt of the payment preimage in the
3570 // update_fulfill_htlc message.
3572 let chanmon_cfgs = create_chanmon_cfgs(2);
3573 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3574 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3575 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3576 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3578 let payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 1000000).0;
3580 assert!(nodes[1].node.claim_funds(payment_preimage));
3581 check_added_monitors!(nodes[1], 1);
3582 let claim_msgs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3583 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &claim_msgs.update_fulfill_htlcs[0]);
3584 expect_payment_sent!(nodes[0], payment_preimage);
3586 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3587 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3589 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (1, 0), (0, 0), (0, 0), (0, 0), (false, false));
3590 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
3594 fn test_simple_peer_disconnect() {
3595 // Test that we can reconnect when there are no lost messages
3596 let chanmon_cfgs = create_chanmon_cfgs(3);
3597 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3598 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3599 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3600 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3601 create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3603 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3604 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3605 reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3607 let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3608 let payment_hash_2 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3609 fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_hash_2);
3610 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_preimage_1);
3612 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3613 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3614 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3616 let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3617 let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3618 let payment_hash_5 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3619 let payment_hash_6 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3621 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3622 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3624 claim_payment_along_route(&nodes[0], &[&[&nodes[1], &nodes[2]]], true, payment_preimage_3);
3625 fail_payment_along_route(&nodes[0], &[&nodes[1], &nodes[2]], true, payment_hash_5);
3627 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (1, 0), (1, 0), (false, false));
3629 let events = nodes[0].node.get_and_clear_pending_events();
3630 assert_eq!(events.len(), 2);
3632 Event::PaymentSent { payment_preimage } => {
3633 assert_eq!(payment_preimage, payment_preimage_3);
3635 _ => panic!("Unexpected event"),
3638 Event::PaymentFailed { payment_hash, rejected_by_dest, .. } => {
3639 assert_eq!(payment_hash, payment_hash_5);
3640 assert!(rejected_by_dest);
3642 _ => panic!("Unexpected event"),
3646 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_preimage_4);
3647 fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_hash_6);
3650 fn do_test_drop_messages_peer_disconnect(messages_delivered: u8, simulate_broken_lnd: bool) {
3651 // Test that we can reconnect when in-flight HTLC updates get dropped
3652 let chanmon_cfgs = create_chanmon_cfgs(2);
3653 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3654 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3655 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3657 let mut as_funding_locked = None;
3658 if messages_delivered == 0 {
3659 let (funding_locked, _, _) = create_chan_between_nodes_with_value_a(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
3660 as_funding_locked = Some(funding_locked);
3661 // nodes[1] doesn't receive the funding_locked message (it'll be re-sent on reconnect)
3662 // Note that we store it so that if we're running with `simulate_broken_lnd` we can deliver
3663 // it before the channel_reestablish message.
3665 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3668 let (payment_preimage_1, payment_hash_1, payment_secret_1) = get_payment_preimage_hash!(nodes[1]);
3670 let logger = test_utils::TestLogger::new();
3671 let payment_event = {
3672 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3673 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(),
3674 &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), Some(&nodes[0].node.list_usable_channels().iter().collect::<Vec<_>>()),
3675 &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
3676 nodes[0].node.send_payment(&route, payment_hash_1, &Some(payment_secret_1)).unwrap();
3677 check_added_monitors!(nodes[0], 1);
3679 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3680 assert_eq!(events.len(), 1);
3681 SendEvent::from_event(events.remove(0))
3683 assert_eq!(nodes[1].node.get_our_node_id(), payment_event.node_id);
3685 if messages_delivered < 2 {
3686 // Drop the payment_event messages, and let them get re-generated in reconnect_nodes!
3688 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
3689 if messages_delivered >= 3 {
3690 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
3691 check_added_monitors!(nodes[1], 1);
3692 let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3694 if messages_delivered >= 4 {
3695 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3696 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3697 check_added_monitors!(nodes[0], 1);
3699 if messages_delivered >= 5 {
3700 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_commitment_signed);
3701 let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3702 // No commitment_signed so get_event_msg's assert(len == 1) passes
3703 check_added_monitors!(nodes[0], 1);
3705 if messages_delivered >= 6 {
3706 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3707 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3708 check_added_monitors!(nodes[1], 1);
3715 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3716 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3717 if messages_delivered < 3 {
3718 if simulate_broken_lnd {
3719 // lnd has a long-standing bug where they send a funding_locked prior to a
3720 // channel_reestablish if you reconnect prior to funding_locked time.
3722 // Here we simulate that behavior, delivering a funding_locked immediately on
3723 // reconnect. Note that we don't bother skipping the now-duplicate funding_locked sent
3724 // in `reconnect_nodes` but we currently don't fail based on that.
3726 // See-also <https://github.com/lightningnetwork/lnd/issues/4006>
3727 nodes[1].node.handle_funding_locked(&nodes[0].node.get_our_node_id(), &as_funding_locked.as_ref().unwrap().0);
3729 // Even if the funding_locked messages get exchanged, as long as nothing further was
3730 // received on either side, both sides will need to resend them.
3731 reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 1), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3732 } else if messages_delivered == 3 {
3733 // nodes[0] still wants its RAA + commitment_signed
3734 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (-1, 0), (0, 0), (0, 0), (0, 0), (0, 0), (true, false));
3735 } else if messages_delivered == 4 {
3736 // nodes[0] still wants its commitment_signed
3737 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (-1, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3738 } else if messages_delivered == 5 {
3739 // nodes[1] still wants its final RAA
3740 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, true));
3741 } else if messages_delivered == 6 {
3742 // Everything was delivered...
3743 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3746 let events_1 = nodes[1].node.get_and_clear_pending_events();
3747 assert_eq!(events_1.len(), 1);
3749 Event::PendingHTLCsForwardable { .. } => { },
3750 _ => panic!("Unexpected event"),
3753 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3754 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3755 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3757 nodes[1].node.process_pending_htlc_forwards();
3759 let events_2 = nodes[1].node.get_and_clear_pending_events();
3760 assert_eq!(events_2.len(), 1);
3762 Event::PaymentReceived { ref payment_hash, ref purpose, amt } => {
3763 assert_eq!(payment_hash_1, *payment_hash);
3764 assert_eq!(amt, 1000000);
3766 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
3767 assert!(payment_preimage.is_none());
3768 assert_eq!(payment_secret_1, *payment_secret);
3770 _ => panic!("expected PaymentPurpose::InvoicePayment")
3773 _ => panic!("Unexpected event"),
3776 nodes[1].node.claim_funds(payment_preimage_1);
3777 check_added_monitors!(nodes[1], 1);
3779 let events_3 = nodes[1].node.get_and_clear_pending_msg_events();
3780 assert_eq!(events_3.len(), 1);
3781 let (update_fulfill_htlc, commitment_signed) = match events_3[0] {
3782 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
3783 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3784 assert!(updates.update_add_htlcs.is_empty());
3785 assert!(updates.update_fail_htlcs.is_empty());
3786 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
3787 assert!(updates.update_fail_malformed_htlcs.is_empty());
3788 assert!(updates.update_fee.is_none());
3789 (updates.update_fulfill_htlcs[0].clone(), updates.commitment_signed.clone())
3791 _ => panic!("Unexpected event"),
3794 if messages_delivered >= 1 {
3795 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlc);
3797 let events_4 = nodes[0].node.get_and_clear_pending_events();
3798 assert_eq!(events_4.len(), 1);
3800 Event::PaymentSent { ref payment_preimage } => {
3801 assert_eq!(payment_preimage_1, *payment_preimage);
3803 _ => panic!("Unexpected event"),
3806 if messages_delivered >= 2 {
3807 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
3808 check_added_monitors!(nodes[0], 1);
3809 let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
3811 if messages_delivered >= 3 {
3812 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3813 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3814 check_added_monitors!(nodes[1], 1);
3816 if messages_delivered >= 4 {
3817 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed);
3818 let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3819 // No commitment_signed so get_event_msg's assert(len == 1) passes
3820 check_added_monitors!(nodes[1], 1);
3822 if messages_delivered >= 5 {
3823 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3824 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3825 check_added_monitors!(nodes[0], 1);
3832 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3833 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3834 if messages_delivered < 2 {
3835 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (1, 0), (0, 0), (0, 0), (0, 0), (false, false));
3836 if messages_delivered < 1 {
3837 let events_4 = nodes[0].node.get_and_clear_pending_events();
3838 assert_eq!(events_4.len(), 1);
3840 Event::PaymentSent { ref payment_preimage } => {
3841 assert_eq!(payment_preimage_1, *payment_preimage);
3843 _ => panic!("Unexpected event"),
3846 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3848 } else if messages_delivered == 2 {
3849 // nodes[0] still wants its RAA + commitment_signed
3850 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, -1), (0, 0), (0, 0), (0, 0), (0, 0), (false, true));
3851 } else if messages_delivered == 3 {
3852 // nodes[0] still wants its commitment_signed
3853 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, -1), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3854 } else if messages_delivered == 4 {
3855 // nodes[1] still wants its final RAA
3856 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (true, false));
3857 } else if messages_delivered == 5 {
3858 // Everything was delivered...
3859 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3862 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3863 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3864 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3866 // Channel should still work fine...
3867 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3868 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(),
3869 &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), Some(&nodes[0].node.list_usable_channels().iter().collect::<Vec<_>>()),
3870 &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
3871 let payment_preimage_2 = send_along_route(&nodes[0], route, &[&nodes[1]], 1000000).0;
3872 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
3876 fn test_drop_messages_peer_disconnect_a() {
3877 do_test_drop_messages_peer_disconnect(0, true);
3878 do_test_drop_messages_peer_disconnect(0, false);
3879 do_test_drop_messages_peer_disconnect(1, false);
3880 do_test_drop_messages_peer_disconnect(2, false);
3884 fn test_drop_messages_peer_disconnect_b() {
3885 do_test_drop_messages_peer_disconnect(3, false);
3886 do_test_drop_messages_peer_disconnect(4, false);
3887 do_test_drop_messages_peer_disconnect(5, false);
3888 do_test_drop_messages_peer_disconnect(6, false);
3892 fn test_funding_peer_disconnect() {
3893 // Test that we can lock in our funding tx while disconnected
3894 let chanmon_cfgs = create_chanmon_cfgs(2);
3895 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3896 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3897 let persister: test_utils::TestPersister;
3898 let new_chain_monitor: test_utils::TestChainMonitor;
3899 let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
3900 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3901 let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
3903 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3904 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3906 confirm_transaction(&nodes[0], &tx);
3907 let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
3908 assert_eq!(events_1.len(), 1);
3910 MessageSendEvent::SendFundingLocked { ref node_id, msg: _ } => {
3911 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
3913 _ => panic!("Unexpected event"),
3916 reconnect_nodes(&nodes[0], &nodes[1], (false, true), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3918 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3919 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3921 confirm_transaction(&nodes[1], &tx);
3922 let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3923 assert_eq!(events_2.len(), 2);
3924 let funding_locked = match events_2[0] {
3925 MessageSendEvent::SendFundingLocked { ref node_id, ref msg } => {
3926 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3929 _ => panic!("Unexpected event"),
3931 let bs_announcement_sigs = match events_2[1] {
3932 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
3933 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3936 _ => panic!("Unexpected event"),
3939 reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3941 nodes[0].node.handle_funding_locked(&nodes[1].node.get_our_node_id(), &funding_locked);
3942 nodes[0].node.handle_announcement_signatures(&nodes[1].node.get_our_node_id(), &bs_announcement_sigs);
3943 let events_3 = nodes[0].node.get_and_clear_pending_msg_events();
3944 assert_eq!(events_3.len(), 2);
3945 let as_announcement_sigs = match events_3[0] {
3946 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
3947 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
3950 _ => panic!("Unexpected event"),
3952 let (as_announcement, as_update) = match events_3[1] {
3953 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
3954 (msg.clone(), update_msg.clone())
3956 _ => panic!("Unexpected event"),
3959 nodes[1].node.handle_announcement_signatures(&nodes[0].node.get_our_node_id(), &as_announcement_sigs);
3960 let events_4 = nodes[1].node.get_and_clear_pending_msg_events();
3961 assert_eq!(events_4.len(), 1);
3962 let (_, bs_update) = match events_4[0] {
3963 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
3964 (msg.clone(), update_msg.clone())
3966 _ => panic!("Unexpected event"),
3969 nodes[0].net_graph_msg_handler.handle_channel_announcement(&as_announcement).unwrap();
3970 nodes[0].net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
3971 nodes[0].net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
3973 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3974 let logger = test_utils::TestLogger::new();
3975 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();
3976 let (payment_preimage, _, _) = send_along_route(&nodes[0], route, &[&nodes[1]], 1000000);
3977 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage);
3979 // Check that after deserialization and reconnection we can still generate an identical
3980 // channel_announcement from the cached signatures.
3981 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3983 let nodes_0_serialized = nodes[0].node.encode();
3984 let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
3985 nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
3987 persister = test_utils::TestPersister::new();
3988 let keys_manager = &chanmon_cfgs[0].keys_manager;
3989 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);
3990 nodes[0].chain_monitor = &new_chain_monitor;
3991 let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
3992 let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
3993 &mut chan_0_monitor_read, keys_manager).unwrap();
3994 assert!(chan_0_monitor_read.is_empty());
3996 let mut nodes_0_read = &nodes_0_serialized[..];
3997 let (_, nodes_0_deserialized_tmp) = {
3998 let mut channel_monitors = HashMap::new();
3999 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4000 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4001 default_config: UserConfig::default(),
4003 fee_estimator: node_cfgs[0].fee_estimator,
4004 chain_monitor: nodes[0].chain_monitor,
4005 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4006 logger: nodes[0].logger,
4010 nodes_0_deserialized = nodes_0_deserialized_tmp;
4011 assert!(nodes_0_read.is_empty());
4013 assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4014 nodes[0].node = &nodes_0_deserialized;
4015 check_added_monitors!(nodes[0], 1);
4017 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
4019 // as_announcement should be re-generated exactly by broadcast_node_announcement.
4020 nodes[0].node.broadcast_node_announcement([0, 0, 0], [0; 32], Vec::new());
4021 let msgs = nodes[0].node.get_and_clear_pending_msg_events();
4022 let mut found_announcement = false;
4023 for event in msgs.iter() {
4025 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, .. } => {
4026 if *msg == as_announcement { found_announcement = true; }
4028 MessageSendEvent::BroadcastNodeAnnouncement { .. } => {},
4029 _ => panic!("Unexpected event"),
4032 assert!(found_announcement);
4036 fn test_drop_messages_peer_disconnect_dual_htlc() {
4037 // Test that we can handle reconnecting when both sides of a channel have pending
4038 // commitment_updates when we disconnect.
4039 let chanmon_cfgs = create_chanmon_cfgs(2);
4040 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4041 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4042 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4043 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4044 let logger = test_utils::TestLogger::new();
4046 let (payment_preimage_1, _, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
4048 // Now try to send a second payment which will fail to send
4049 let (payment_preimage_2, payment_hash_2, payment_secret_2) = get_payment_preimage_hash!(nodes[1]);
4050 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
4051 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();
4052 nodes[0].node.send_payment(&route, payment_hash_2, &Some(payment_secret_2)).unwrap();
4053 check_added_monitors!(nodes[0], 1);
4055 let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
4056 assert_eq!(events_1.len(), 1);
4058 MessageSendEvent::UpdateHTLCs { .. } => {},
4059 _ => panic!("Unexpected event"),
4062 assert!(nodes[1].node.claim_funds(payment_preimage_1));
4063 check_added_monitors!(nodes[1], 1);
4065 let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
4066 assert_eq!(events_2.len(), 1);
4068 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 } } => {
4069 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
4070 assert!(update_add_htlcs.is_empty());
4071 assert_eq!(update_fulfill_htlcs.len(), 1);
4072 assert!(update_fail_htlcs.is_empty());
4073 assert!(update_fail_malformed_htlcs.is_empty());
4074 assert!(update_fee.is_none());
4076 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlcs[0]);
4077 let events_3 = nodes[0].node.get_and_clear_pending_events();
4078 assert_eq!(events_3.len(), 1);
4080 Event::PaymentSent { ref payment_preimage } => {
4081 assert_eq!(*payment_preimage, payment_preimage_1);
4083 _ => panic!("Unexpected event"),
4086 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), commitment_signed);
4087 let _ = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
4088 // No commitment_signed so get_event_msg's assert(len == 1) passes
4089 check_added_monitors!(nodes[0], 1);
4091 _ => panic!("Unexpected event"),
4094 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
4095 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4097 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4098 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
4099 assert_eq!(reestablish_1.len(), 1);
4100 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4101 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
4102 assert_eq!(reestablish_2.len(), 1);
4104 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
4105 let as_resp = handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
4106 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
4107 let bs_resp = handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
4109 assert!(as_resp.0.is_none());
4110 assert!(bs_resp.0.is_none());
4112 assert!(bs_resp.1.is_none());
4113 assert!(bs_resp.2.is_none());
4115 assert!(as_resp.3 == RAACommitmentOrder::CommitmentFirst);
4117 assert_eq!(as_resp.2.as_ref().unwrap().update_add_htlcs.len(), 1);
4118 assert!(as_resp.2.as_ref().unwrap().update_fulfill_htlcs.is_empty());
4119 assert!(as_resp.2.as_ref().unwrap().update_fail_htlcs.is_empty());
4120 assert!(as_resp.2.as_ref().unwrap().update_fail_malformed_htlcs.is_empty());
4121 assert!(as_resp.2.as_ref().unwrap().update_fee.is_none());
4122 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &as_resp.2.as_ref().unwrap().update_add_htlcs[0]);
4123 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_resp.2.as_ref().unwrap().commitment_signed);
4124 let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
4125 // No commitment_signed so get_event_msg's assert(len == 1) passes
4126 check_added_monitors!(nodes[1], 1);
4128 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), as_resp.1.as_ref().unwrap());
4129 let bs_second_commitment_signed = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4130 assert!(bs_second_commitment_signed.update_add_htlcs.is_empty());
4131 assert!(bs_second_commitment_signed.update_fulfill_htlcs.is_empty());
4132 assert!(bs_second_commitment_signed.update_fail_htlcs.is_empty());
4133 assert!(bs_second_commitment_signed.update_fail_malformed_htlcs.is_empty());
4134 assert!(bs_second_commitment_signed.update_fee.is_none());
4135 check_added_monitors!(nodes[1], 1);
4137 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
4138 let as_commitment_signed = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
4139 assert!(as_commitment_signed.update_add_htlcs.is_empty());
4140 assert!(as_commitment_signed.update_fulfill_htlcs.is_empty());
4141 assert!(as_commitment_signed.update_fail_htlcs.is_empty());
4142 assert!(as_commitment_signed.update_fail_malformed_htlcs.is_empty());
4143 assert!(as_commitment_signed.update_fee.is_none());
4144 check_added_monitors!(nodes[0], 1);
4146 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_commitment_signed.commitment_signed);
4147 let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
4148 // No commitment_signed so get_event_msg's assert(len == 1) passes
4149 check_added_monitors!(nodes[0], 1);
4151 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed.commitment_signed);
4152 let bs_second_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
4153 // No commitment_signed so get_event_msg's assert(len == 1) passes
4154 check_added_monitors!(nodes[1], 1);
4156 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
4157 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4158 check_added_monitors!(nodes[1], 1);
4160 expect_pending_htlcs_forwardable!(nodes[1]);
4162 let events_5 = nodes[1].node.get_and_clear_pending_events();
4163 assert_eq!(events_5.len(), 1);
4165 Event::PaymentReceived { ref payment_hash, ref purpose, .. } => {
4166 assert_eq!(payment_hash_2, *payment_hash);
4168 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
4169 assert!(payment_preimage.is_none());
4170 assert_eq!(payment_secret_2, *payment_secret);
4172 _ => panic!("expected PaymentPurpose::InvoicePayment")
4175 _ => panic!("Unexpected event"),
4178 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke_and_ack);
4179 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4180 check_added_monitors!(nodes[0], 1);
4182 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
4185 fn do_test_htlc_timeout(send_partial_mpp: bool) {
4186 // If the user fails to claim/fail an HTLC within the HTLC CLTV timeout we fail it for them
4187 // to avoid our counterparty failing the channel.
4188 let chanmon_cfgs = create_chanmon_cfgs(2);
4189 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4190 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4191 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4193 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4194 let logger = test_utils::TestLogger::new();
4196 let our_payment_hash = if send_partial_mpp {
4197 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
4198 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();
4199 let (_, our_payment_hash, payment_secret) = get_payment_preimage_hash!(&nodes[1]);
4200 // Use the utility function send_payment_along_path to send the payment with MPP data which
4201 // indicates there are more HTLCs coming.
4202 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.
4203 nodes[0].node.send_payment_along_path(&route.paths[0], &our_payment_hash, &Some(payment_secret), 200000, cur_height, &None).unwrap();
4204 check_added_monitors!(nodes[0], 1);
4205 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
4206 assert_eq!(events.len(), 1);
4207 // Now do the relevant commitment_signed/RAA dances along the path, noting that the final
4208 // hop should *not* yet generate any PaymentReceived event(s).
4209 pass_along_path(&nodes[0], &[&nodes[1]], 100000, our_payment_hash, Some(payment_secret), events.drain(..).next().unwrap(), false, None);
4212 route_payment(&nodes[0], &[&nodes[1]], 100000).1
4215 let mut block = Block {
4216 header: BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
4219 connect_block(&nodes[0], &block);
4220 connect_block(&nodes[1], &block);
4221 let block_count = TEST_FINAL_CLTV + CHAN_CONFIRM_DEPTH + 2 - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS;
4222 for _ in CHAN_CONFIRM_DEPTH + 2..block_count {
4223 block.header.prev_blockhash = block.block_hash();
4224 connect_block(&nodes[0], &block);
4225 connect_block(&nodes[1], &block);
4228 expect_pending_htlcs_forwardable!(nodes[1]);
4230 check_added_monitors!(nodes[1], 1);
4231 let htlc_timeout_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4232 assert!(htlc_timeout_updates.update_add_htlcs.is_empty());
4233 assert_eq!(htlc_timeout_updates.update_fail_htlcs.len(), 1);
4234 assert!(htlc_timeout_updates.update_fail_malformed_htlcs.is_empty());
4235 assert!(htlc_timeout_updates.update_fee.is_none());
4237 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_timeout_updates.update_fail_htlcs[0]);
4238 commitment_signed_dance!(nodes[0], nodes[1], htlc_timeout_updates.commitment_signed, false);
4239 // 100_000 msat as u64, followed by the height at which we failed back above
4240 let mut expected_failure_data = byte_utils::be64_to_array(100_000).to_vec();
4241 expected_failure_data.extend_from_slice(&byte_utils::be32_to_array(block_count - 1));
4242 expect_payment_failed!(nodes[0], our_payment_hash, true, 0x4000 | 15, &expected_failure_data[..]);
4246 fn test_htlc_timeout() {
4247 do_test_htlc_timeout(true);
4248 do_test_htlc_timeout(false);
4251 fn do_test_holding_cell_htlc_add_timeouts(forwarded_htlc: bool) {
4252 // Tests that HTLCs in the holding cell are timed out after the requisite number of blocks.
4253 let chanmon_cfgs = create_chanmon_cfgs(3);
4254 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
4255 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
4256 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
4257 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4258 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
4260 // Make sure all nodes are at the same starting height
4261 connect_blocks(&nodes[0], 2*CHAN_CONFIRM_DEPTH + 1 - nodes[0].best_block_info().1);
4262 connect_blocks(&nodes[1], 2*CHAN_CONFIRM_DEPTH + 1 - nodes[1].best_block_info().1);
4263 connect_blocks(&nodes[2], 2*CHAN_CONFIRM_DEPTH + 1 - nodes[2].best_block_info().1);
4265 let logger = test_utils::TestLogger::new();
4267 // Route a first payment to get the 1 -> 2 channel in awaiting_raa...
4268 let (_, first_payment_hash, first_payment_secret) = get_payment_preimage_hash!(nodes[2]);
4270 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
4271 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();
4272 nodes[1].node.send_payment(&route, first_payment_hash, &Some(first_payment_secret)).unwrap();
4274 assert_eq!(nodes[1].node.get_and_clear_pending_msg_events().len(), 1);
4275 check_added_monitors!(nodes[1], 1);
4277 // Now attempt to route a second payment, which should be placed in the holding cell
4278 let (_, second_payment_hash, second_payment_secret) = get_payment_preimage_hash!(nodes[2]);
4280 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
4281 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();
4282 nodes[0].node.send_payment(&route, second_payment_hash, &Some(first_payment_secret)).unwrap();
4283 check_added_monitors!(nodes[0], 1);
4284 let payment_event = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
4285 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
4286 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
4287 expect_pending_htlcs_forwardable!(nodes[1]);
4288 check_added_monitors!(nodes[1], 0);
4290 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
4291 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();
4292 nodes[1].node.send_payment(&route, second_payment_hash, &Some(second_payment_secret)).unwrap();
4293 check_added_monitors!(nodes[1], 0);
4296 connect_blocks(&nodes[1], TEST_FINAL_CLTV - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS);
4297 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4298 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
4299 connect_blocks(&nodes[1], 1);
4302 expect_pending_htlcs_forwardable!(nodes[1]);
4303 check_added_monitors!(nodes[1], 1);
4304 let fail_commit = nodes[1].node.get_and_clear_pending_msg_events();
4305 assert_eq!(fail_commit.len(), 1);
4306 match fail_commit[0] {
4307 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fail_htlcs, ref commitment_signed, .. }, .. } => {
4308 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
4309 commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, true, true);
4311 _ => unreachable!(),
4313 expect_payment_failed!(nodes[0], second_payment_hash, false);
4314 expect_payment_failure_chan_update!(nodes[0], chan_2.0.contents.short_channel_id, false);
4316 expect_payment_failed!(nodes[1], second_payment_hash, true);
4321 fn test_holding_cell_htlc_add_timeouts() {
4322 do_test_holding_cell_htlc_add_timeouts(false);
4323 do_test_holding_cell_htlc_add_timeouts(true);
4327 fn test_invalid_channel_announcement() {
4328 //Test BOLT 7 channel_announcement msg requirement for final node, gather data to build customed channel_announcement msgs
4329 let secp_ctx = Secp256k1::new();
4330 let chanmon_cfgs = create_chanmon_cfgs(2);
4331 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4332 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4333 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4335 let chan_announcement = create_chan_between_nodes(&nodes[0], &nodes[1], InitFeatures::known(), InitFeatures::known());
4337 let a_channel_lock = nodes[0].node.channel_state.lock().unwrap();
4338 let b_channel_lock = nodes[1].node.channel_state.lock().unwrap();
4339 let as_chan = a_channel_lock.by_id.get(&chan_announcement.3).unwrap();
4340 let bs_chan = b_channel_lock.by_id.get(&chan_announcement.3).unwrap();
4342 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 } );
4344 let as_bitcoin_key = as_chan.get_signer().inner.holder_channel_pubkeys.funding_pubkey;
4345 let bs_bitcoin_key = bs_chan.get_signer().inner.holder_channel_pubkeys.funding_pubkey;
4347 let as_network_key = nodes[0].node.get_our_node_id();
4348 let bs_network_key = nodes[1].node.get_our_node_id();
4350 let were_node_one = as_bitcoin_key.serialize()[..] < bs_bitcoin_key.serialize()[..];
4352 let mut chan_announcement;
4354 macro_rules! dummy_unsigned_msg {
4356 msgs::UnsignedChannelAnnouncement {
4357 features: ChannelFeatures::known(),
4358 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
4359 short_channel_id: as_chan.get_short_channel_id().unwrap(),
4360 node_id_1: if were_node_one { as_network_key } else { bs_network_key },
4361 node_id_2: if were_node_one { bs_network_key } else { as_network_key },
4362 bitcoin_key_1: if were_node_one { as_bitcoin_key } else { bs_bitcoin_key },
4363 bitcoin_key_2: if were_node_one { bs_bitcoin_key } else { as_bitcoin_key },
4364 excess_data: Vec::new(),
4369 macro_rules! sign_msg {
4370 ($unsigned_msg: expr) => {
4371 let msghash = Message::from_slice(&Sha256dHash::hash(&$unsigned_msg.encode()[..])[..]).unwrap();
4372 let as_bitcoin_sig = secp_ctx.sign(&msghash, &as_chan.get_signer().inner.funding_key);
4373 let bs_bitcoin_sig = secp_ctx.sign(&msghash, &bs_chan.get_signer().inner.funding_key);
4374 let as_node_sig = secp_ctx.sign(&msghash, &nodes[0].keys_manager.get_node_secret());
4375 let bs_node_sig = secp_ctx.sign(&msghash, &nodes[1].keys_manager.get_node_secret());
4376 chan_announcement = msgs::ChannelAnnouncement {
4377 node_signature_1 : if were_node_one { as_node_sig } else { bs_node_sig},
4378 node_signature_2 : if were_node_one { bs_node_sig } else { as_node_sig},
4379 bitcoin_signature_1: if were_node_one { as_bitcoin_sig } else { bs_bitcoin_sig },
4380 bitcoin_signature_2 : if were_node_one { bs_bitcoin_sig } else { as_bitcoin_sig },
4381 contents: $unsigned_msg
4386 let unsigned_msg = dummy_unsigned_msg!();
4387 sign_msg!(unsigned_msg);
4388 assert_eq!(nodes[0].net_graph_msg_handler.handle_channel_announcement(&chan_announcement).unwrap(), true);
4389 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 } );
4391 // Configured with Network::Testnet
4392 let mut unsigned_msg = dummy_unsigned_msg!();
4393 unsigned_msg.chain_hash = genesis_block(Network::Bitcoin).header.block_hash();
4394 sign_msg!(unsigned_msg);
4395 assert!(nodes[0].net_graph_msg_handler.handle_channel_announcement(&chan_announcement).is_err());
4397 let mut unsigned_msg = dummy_unsigned_msg!();
4398 unsigned_msg.chain_hash = BlockHash::hash(&[1,2,3,4,5,6,7,8,9]);
4399 sign_msg!(unsigned_msg);
4400 assert!(nodes[0].net_graph_msg_handler.handle_channel_announcement(&chan_announcement).is_err());
4404 fn test_no_txn_manager_serialize_deserialize() {
4405 let chanmon_cfgs = create_chanmon_cfgs(2);
4406 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4407 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4408 let logger: test_utils::TestLogger;
4409 let fee_estimator: test_utils::TestFeeEstimator;
4410 let persister: test_utils::TestPersister;
4411 let new_chain_monitor: test_utils::TestChainMonitor;
4412 let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4413 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4415 let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
4417 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4419 let nodes_0_serialized = nodes[0].node.encode();
4420 let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4421 nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
4423 logger = test_utils::TestLogger::new();
4424 fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
4425 persister = test_utils::TestPersister::new();
4426 let keys_manager = &chanmon_cfgs[0].keys_manager;
4427 new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator, &persister, keys_manager);
4428 nodes[0].chain_monitor = &new_chain_monitor;
4429 let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4430 let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
4431 &mut chan_0_monitor_read, keys_manager).unwrap();
4432 assert!(chan_0_monitor_read.is_empty());
4434 let mut nodes_0_read = &nodes_0_serialized[..];
4435 let config = UserConfig::default();
4436 let (_, nodes_0_deserialized_tmp) = {
4437 let mut channel_monitors = HashMap::new();
4438 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4439 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4440 default_config: config,
4442 fee_estimator: &fee_estimator,
4443 chain_monitor: nodes[0].chain_monitor,
4444 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4449 nodes_0_deserialized = nodes_0_deserialized_tmp;
4450 assert!(nodes_0_read.is_empty());
4452 assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4453 nodes[0].node = &nodes_0_deserialized;
4454 assert_eq!(nodes[0].node.list_channels().len(), 1);
4455 check_added_monitors!(nodes[0], 1);
4457 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4458 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
4459 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4460 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
4462 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
4463 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4464 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
4465 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4467 let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
4468 let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
4469 for node in nodes.iter() {
4470 assert!(node.net_graph_msg_handler.handle_channel_announcement(&announcement).unwrap());
4471 node.net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
4472 node.net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
4475 send_payment(&nodes[0], &[&nodes[1]], 1000000);
4479 fn test_dup_htlc_onchain_fails_on_reload() {
4480 // When a Channel is closed, any outbound HTLCs which were relayed through it are simply
4481 // dropped when the Channel is. From there, the ChannelManager relies on the ChannelMonitor
4482 // having a copy of the relevant fail-/claim-back data and processes the HTLC fail/claim when
4483 // the ChannelMonitor tells it to.
4485 // If, due to an on-chain event, an HTLC is failed/claimed, and then we serialize the
4486 // ChannelManager, we generally expect there not to be a duplicate HTLC fail/claim (eg via a
4487 // PaymentFailed event appearing). However, because we may not serialize the relevant
4488 // ChannelMonitor at the same time, this isn't strictly guaranteed. In order to provide this
4489 // consistency, the ChannelManager explicitly tracks pending-onchain-resolution outbound HTLCs
4490 // and de-duplicates ChannelMonitor events.
4492 // This tests that explicit tracking behavior.
4493 let chanmon_cfgs = create_chanmon_cfgs(2);
4494 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4495 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4496 let persister: test_utils::TestPersister;
4497 let new_chain_monitor: test_utils::TestChainMonitor;
4498 let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4499 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4501 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4503 // Route a payment, but force-close the channel before the HTLC fulfill message arrives at
4505 let (payment_preimage, _, _) = route_payment(&nodes[0], &[&nodes[1]], 10000000);
4506 nodes[0].node.force_close_channel(&nodes[0].node.list_channels()[0].channel_id).unwrap();
4507 check_closed_broadcast!(nodes[0], true);
4508 check_added_monitors!(nodes[0], 1);
4510 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
4511 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4513 // Connect blocks until the CLTV timeout is up so that we get an HTLC-Timeout transaction
4514 connect_blocks(&nodes[0], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + 1);
4515 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
4516 assert_eq!(node_txn.len(), 3);
4517 assert_eq!(node_txn[0], node_txn[1]);
4519 assert!(nodes[1].node.claim_funds(payment_preimage));
4520 check_added_monitors!(nodes[1], 1);
4522 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4523 connect_block(&nodes[1], &Block { header, txdata: vec![node_txn[1].clone(), node_txn[2].clone()]});
4524 check_closed_broadcast!(nodes[1], true);
4525 check_added_monitors!(nodes[1], 1);
4526 let claim_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
4528 header.prev_blockhash = nodes[0].best_block_hash();
4529 connect_block(&nodes[0], &Block { header, txdata: vec![node_txn[1].clone(), node_txn[2].clone()]});
4531 // Serialize out the ChannelMonitor before connecting the on-chain claim transactions. This is
4532 // fairly normal behavior as ChannelMonitor(s) are often not re-serialized when on-chain events
4533 // happen, unlike ChannelManager which tends to be re-serialized after any relevant event(s).
4534 let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4535 nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
4537 header.prev_blockhash = nodes[0].best_block_hash();
4538 let claim_block = Block { header, txdata: claim_txn};
4539 connect_block(&nodes[0], &claim_block);
4540 expect_payment_sent!(nodes[0], payment_preimage);
4542 // ChannelManagers generally get re-serialized after any relevant event(s). Since we just
4543 // connected a highly-relevant block, it likely gets serialized out now.
4544 let mut chan_manager_serialized = test_utils::TestVecWriter(Vec::new());
4545 nodes[0].node.write(&mut chan_manager_serialized).unwrap();
4547 // Now reload nodes[0]...
4548 persister = test_utils::TestPersister::new();
4549 let keys_manager = &chanmon_cfgs[0].keys_manager;
4550 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);
4551 nodes[0].chain_monitor = &new_chain_monitor;
4552 let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4553 let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
4554 &mut chan_0_monitor_read, keys_manager).unwrap();
4555 assert!(chan_0_monitor_read.is_empty());
4557 let (_, nodes_0_deserialized_tmp) = {
4558 let mut channel_monitors = HashMap::new();
4559 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4560 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>
4561 ::read(&mut io::Cursor::new(&chan_manager_serialized.0[..]), ChannelManagerReadArgs {
4562 default_config: Default::default(),
4564 fee_estimator: node_cfgs[0].fee_estimator,
4565 chain_monitor: nodes[0].chain_monitor,
4566 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4567 logger: nodes[0].logger,
4571 nodes_0_deserialized = nodes_0_deserialized_tmp;
4573 assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4574 check_added_monitors!(nodes[0], 1);
4575 nodes[0].node = &nodes_0_deserialized;
4577 // Note that if we re-connect the block which exposed nodes[0] to the payment preimage (but
4578 // which the current ChannelMonitor has not seen), the ChannelManager's de-duplication of
4579 // payment events should kick in, leaving us with no pending events here.
4580 let height = nodes[0].blocks.lock().unwrap().len() as u32 - 1;
4581 nodes[0].chain_monitor.chain_monitor.block_connected(&claim_block, height);
4582 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
4586 fn test_manager_serialize_deserialize_events() {
4587 // This test makes sure the events field in ChannelManager survives de/serialization
4588 let chanmon_cfgs = create_chanmon_cfgs(2);
4589 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4590 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4591 let fee_estimator: test_utils::TestFeeEstimator;
4592 let persister: test_utils::TestPersister;
4593 let logger: test_utils::TestLogger;
4594 let new_chain_monitor: test_utils::TestChainMonitor;
4595 let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4596 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4598 // Start creating a channel, but stop right before broadcasting the funding transaction
4599 let channel_value = 100000;
4600 let push_msat = 10001;
4601 let a_flags = InitFeatures::known();
4602 let b_flags = InitFeatures::known();
4603 let node_a = nodes.remove(0);
4604 let node_b = nodes.remove(0);
4605 node_a.node.create_channel(node_b.node.get_our_node_id(), channel_value, push_msat, 42, None).unwrap();
4606 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()));
4607 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()));
4609 let (temporary_channel_id, tx, funding_output) = create_funding_transaction(&node_a, channel_value, 42);
4611 node_a.node.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
4612 check_added_monitors!(node_a, 0);
4614 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()));
4616 let mut added_monitors = node_b.chain_monitor.added_monitors.lock().unwrap();
4617 assert_eq!(added_monitors.len(), 1);
4618 assert_eq!(added_monitors[0].0, funding_output);
4619 added_monitors.clear();
4622 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()));
4624 let mut added_monitors = node_a.chain_monitor.added_monitors.lock().unwrap();
4625 assert_eq!(added_monitors.len(), 1);
4626 assert_eq!(added_monitors[0].0, funding_output);
4627 added_monitors.clear();
4629 // Normally, this is where node_a would broadcast the funding transaction, but the test de/serializes first instead
4634 // Start the de/seriailization process mid-channel creation to check that the channel manager will hold onto events that are serialized
4635 let nodes_0_serialized = nodes[0].node.encode();
4636 let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4637 nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
4639 fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
4640 logger = test_utils::TestLogger::new();
4641 persister = test_utils::TestPersister::new();
4642 let keys_manager = &chanmon_cfgs[0].keys_manager;
4643 new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator, &persister, keys_manager);
4644 nodes[0].chain_monitor = &new_chain_monitor;
4645 let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4646 let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
4647 &mut chan_0_monitor_read, keys_manager).unwrap();
4648 assert!(chan_0_monitor_read.is_empty());
4650 let mut nodes_0_read = &nodes_0_serialized[..];
4651 let config = UserConfig::default();
4652 let (_, nodes_0_deserialized_tmp) = {
4653 let mut channel_monitors = HashMap::new();
4654 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4655 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4656 default_config: config,
4658 fee_estimator: &fee_estimator,
4659 chain_monitor: nodes[0].chain_monitor,
4660 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4665 nodes_0_deserialized = nodes_0_deserialized_tmp;
4666 assert!(nodes_0_read.is_empty());
4668 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4670 assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4671 nodes[0].node = &nodes_0_deserialized;
4673 // After deserializing, make sure the funding_transaction is still held by the channel manager
4674 let events_4 = nodes[0].node.get_and_clear_pending_events();
4675 assert_eq!(events_4.len(), 0);
4676 assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
4677 assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0].txid(), funding_output.txid);
4679 // Make sure the channel is functioning as though the de/serialization never happened
4680 assert_eq!(nodes[0].node.list_channels().len(), 1);
4681 check_added_monitors!(nodes[0], 1);
4683 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4684 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
4685 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4686 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
4688 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
4689 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4690 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
4691 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4693 let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
4694 let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
4695 for node in nodes.iter() {
4696 assert!(node.net_graph_msg_handler.handle_channel_announcement(&announcement).unwrap());
4697 node.net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
4698 node.net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
4701 send_payment(&nodes[0], &[&nodes[1]], 1000000);
4705 fn test_simple_manager_serialize_deserialize() {
4706 let chanmon_cfgs = create_chanmon_cfgs(2);
4707 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4708 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[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(2, &node_cfgs, &node_chanmgrs);
4715 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4717 let (our_payment_preimage, _, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
4718 let (_, our_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
4720 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4722 let nodes_0_serialized = nodes[0].node.encode();
4723 let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4724 nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
4726 logger = test_utils::TestLogger::new();
4727 fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
4728 persister = test_utils::TestPersister::new();
4729 let keys_manager = &chanmon_cfgs[0].keys_manager;
4730 new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator, &persister, keys_manager);
4731 nodes[0].chain_monitor = &new_chain_monitor;
4732 let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4733 let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
4734 &mut chan_0_monitor_read, keys_manager).unwrap();
4735 assert!(chan_0_monitor_read.is_empty());
4737 let mut nodes_0_read = &nodes_0_serialized[..];
4738 let (_, nodes_0_deserialized_tmp) = {
4739 let mut channel_monitors = HashMap::new();
4740 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4741 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4742 default_config: UserConfig::default(),
4744 fee_estimator: &fee_estimator,
4745 chain_monitor: nodes[0].chain_monitor,
4746 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4751 nodes_0_deserialized = nodes_0_deserialized_tmp;
4752 assert!(nodes_0_read.is_empty());
4754 assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4755 nodes[0].node = &nodes_0_deserialized;
4756 check_added_monitors!(nodes[0], 1);
4758 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
4760 fail_payment(&nodes[0], &[&nodes[1]], our_payment_hash);
4761 claim_payment(&nodes[0], &[&nodes[1]], our_payment_preimage);
4765 fn test_manager_serialize_deserialize_inconsistent_monitor() {
4766 // Test deserializing a ChannelManager with an out-of-date ChannelMonitor
4767 let chanmon_cfgs = create_chanmon_cfgs(4);
4768 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
4769 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
4770 let logger: test_utils::TestLogger;
4771 let fee_estimator: test_utils::TestFeeEstimator;
4772 let persister: test_utils::TestPersister;
4773 let new_chain_monitor: test_utils::TestChainMonitor;
4774 let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4775 let mut nodes = create_network(4, &node_cfgs, &node_chanmgrs);
4776 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4777 create_announced_chan_between_nodes(&nodes, 2, 0, InitFeatures::known(), InitFeatures::known());
4778 let (_, _, channel_id, funding_tx) = create_announced_chan_between_nodes(&nodes, 0, 3, InitFeatures::known(), InitFeatures::known());
4780 let mut node_0_stale_monitors_serialized = Vec::new();
4781 for monitor in nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter() {
4782 let mut writer = test_utils::TestVecWriter(Vec::new());
4783 monitor.1.write(&mut writer).unwrap();
4784 node_0_stale_monitors_serialized.push(writer.0);
4787 let (our_payment_preimage, _, _) = route_payment(&nodes[2], &[&nodes[0], &nodes[1]], 1000000);
4789 // Serialize the ChannelManager here, but the monitor we keep up-to-date
4790 let nodes_0_serialized = nodes[0].node.encode();
4792 route_payment(&nodes[0], &[&nodes[3]], 1000000);
4793 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4794 nodes[2].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4795 nodes[3].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4797 // Now the ChannelMonitor (which is now out-of-sync with ChannelManager for channel w/
4799 let mut node_0_monitors_serialized = Vec::new();
4800 for monitor in nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter() {
4801 let mut writer = test_utils::TestVecWriter(Vec::new());
4802 monitor.1.write(&mut writer).unwrap();
4803 node_0_monitors_serialized.push(writer.0);
4806 logger = test_utils::TestLogger::new();
4807 fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
4808 persister = test_utils::TestPersister::new();
4809 let keys_manager = &chanmon_cfgs[0].keys_manager;
4810 new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator, &persister, keys_manager);
4811 nodes[0].chain_monitor = &new_chain_monitor;
4814 let mut node_0_stale_monitors = Vec::new();
4815 for serialized in node_0_stale_monitors_serialized.iter() {
4816 let mut read = &serialized[..];
4817 let (_, monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(&mut read, keys_manager).unwrap();
4818 assert!(read.is_empty());
4819 node_0_stale_monitors.push(monitor);
4822 let mut node_0_monitors = Vec::new();
4823 for serialized in node_0_monitors_serialized.iter() {
4824 let mut read = &serialized[..];
4825 let (_, monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(&mut read, keys_manager).unwrap();
4826 assert!(read.is_empty());
4827 node_0_monitors.push(monitor);
4830 let mut nodes_0_read = &nodes_0_serialized[..];
4831 if let Err(msgs::DecodeError::InvalidValue) =
4832 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4833 default_config: UserConfig::default(),
4835 fee_estimator: &fee_estimator,
4836 chain_monitor: nodes[0].chain_monitor,
4837 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4839 channel_monitors: node_0_stale_monitors.iter_mut().map(|monitor| { (monitor.get_funding_txo().0, monitor) }).collect(),
4841 panic!("If the monitor(s) are stale, this indicates a bug and we should get an Err return");
4844 let mut nodes_0_read = &nodes_0_serialized[..];
4845 let (_, nodes_0_deserialized_tmp) =
4846 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4847 default_config: UserConfig::default(),
4849 fee_estimator: &fee_estimator,
4850 chain_monitor: nodes[0].chain_monitor,
4851 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4853 channel_monitors: node_0_monitors.iter_mut().map(|monitor| { (monitor.get_funding_txo().0, monitor) }).collect(),
4855 nodes_0_deserialized = nodes_0_deserialized_tmp;
4856 assert!(nodes_0_read.is_empty());
4858 { // Channel close should result in a commitment tx
4859 let txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4860 assert_eq!(txn.len(), 1);
4861 check_spends!(txn[0], funding_tx);
4862 assert_eq!(txn[0].input[0].previous_output.txid, funding_tx.txid());
4865 for monitor in node_0_monitors.drain(..) {
4866 assert!(nodes[0].chain_monitor.watch_channel(monitor.get_funding_txo().0, monitor).is_ok());
4867 check_added_monitors!(nodes[0], 1);
4869 nodes[0].node = &nodes_0_deserialized;
4871 // nodes[1] and nodes[2] have no lost state with nodes[0]...
4872 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
4873 reconnect_nodes(&nodes[0], &nodes[2], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
4874 //... and we can even still claim the payment!
4875 claim_payment(&nodes[2], &[&nodes[0], &nodes[1]], our_payment_preimage);
4877 nodes[3].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4878 let reestablish = get_event_msg!(nodes[3], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
4879 nodes[0].node.peer_connected(&nodes[3].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4880 nodes[0].node.handle_channel_reestablish(&nodes[3].node.get_our_node_id(), &reestablish);
4881 let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
4882 assert_eq!(msg_events.len(), 1);
4883 if let MessageSendEvent::HandleError { ref action, .. } = msg_events[0] {
4885 &ErrorAction::SendErrorMessage { ref msg } => {
4886 assert_eq!(msg.channel_id, channel_id);
4888 _ => panic!("Unexpected event!"),
4893 macro_rules! check_spendable_outputs {
4894 ($node: expr, $keysinterface: expr) => {
4896 let mut events = $node.chain_monitor.chain_monitor.get_and_clear_pending_events();
4897 let mut txn = Vec::new();
4898 let mut all_outputs = Vec::new();
4899 let secp_ctx = Secp256k1::new();
4900 for event in events.drain(..) {
4902 Event::SpendableOutputs { mut outputs } => {
4903 for outp in outputs.drain(..) {
4904 txn.push($keysinterface.backing.spend_spendable_outputs(&[&outp], Vec::new(), Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(), 253, &secp_ctx).unwrap());
4905 all_outputs.push(outp);
4908 _ => panic!("Unexpected event"),
4911 if all_outputs.len() > 1 {
4912 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) {
4922 fn test_claim_sizeable_push_msat() {
4923 // Incidentally test SpendableOutput event generation due to detection of to_local output on commitment tx
4924 let chanmon_cfgs = create_chanmon_cfgs(2);
4925 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4926 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4927 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4929 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 99000000, InitFeatures::known(), InitFeatures::known());
4930 nodes[1].node.force_close_channel(&chan.2).unwrap();
4931 check_closed_broadcast!(nodes[1], true);
4932 check_added_monitors!(nodes[1], 1);
4933 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4934 assert_eq!(node_txn.len(), 1);
4935 check_spends!(node_txn[0], chan.3);
4936 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
4938 mine_transaction(&nodes[1], &node_txn[0]);
4939 connect_blocks(&nodes[1], BREAKDOWN_TIMEOUT as u32 - 1);
4941 let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
4942 assert_eq!(spend_txn.len(), 1);
4943 assert_eq!(spend_txn[0].input.len(), 1);
4944 check_spends!(spend_txn[0], node_txn[0]);
4945 assert_eq!(spend_txn[0].input[0].sequence, BREAKDOWN_TIMEOUT as u32);
4949 fn test_claim_on_remote_sizeable_push_msat() {
4950 // Same test as previous, just test on remote commitment tx, as per_commitment_point registration changes following you're funder/fundee and
4951 // to_remote output is encumbered by a P2WPKH
4952 let chanmon_cfgs = create_chanmon_cfgs(2);
4953 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4954 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4955 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4957 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 99000000, InitFeatures::known(), InitFeatures::known());
4958 nodes[0].node.force_close_channel(&chan.2).unwrap();
4959 check_closed_broadcast!(nodes[0], true);
4960 check_added_monitors!(nodes[0], 1);
4962 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4963 assert_eq!(node_txn.len(), 1);
4964 check_spends!(node_txn[0], chan.3);
4965 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
4967 mine_transaction(&nodes[1], &node_txn[0]);
4968 check_closed_broadcast!(nodes[1], true);
4969 check_added_monitors!(nodes[1], 1);
4970 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4972 let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
4973 assert_eq!(spend_txn.len(), 1);
4974 check_spends!(spend_txn[0], node_txn[0]);
4978 fn test_claim_on_remote_revoked_sizeable_push_msat() {
4979 // Same test as previous, just test on remote revoked commitment tx, as per_commitment_point registration changes following you're funder/fundee and
4980 // to_remote output is encumbered by a P2WPKH
4982 let chanmon_cfgs = create_chanmon_cfgs(2);
4983 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4984 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4985 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4987 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 59000000, InitFeatures::known(), InitFeatures::known());
4988 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4989 let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan.2);
4990 assert_eq!(revoked_local_txn[0].input.len(), 1);
4991 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
4993 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
4994 mine_transaction(&nodes[1], &revoked_local_txn[0]);
4995 check_closed_broadcast!(nodes[1], true);
4996 check_added_monitors!(nodes[1], 1);
4998 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4999 mine_transaction(&nodes[1], &node_txn[0]);
5000 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
5002 let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
5003 assert_eq!(spend_txn.len(), 3);
5004 check_spends!(spend_txn[0], revoked_local_txn[0]); // to_remote output on revoked remote commitment_tx
5005 check_spends!(spend_txn[1], node_txn[0]);
5006 check_spends!(spend_txn[2], revoked_local_txn[0], node_txn[0]); // Both outputs
5010 fn test_static_spendable_outputs_preimage_tx() {
5011 let chanmon_cfgs = create_chanmon_cfgs(2);
5012 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5013 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5014 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5016 // Create some initial channels
5017 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5019 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
5021 let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
5022 assert_eq!(commitment_tx[0].input.len(), 1);
5023 assert_eq!(commitment_tx[0].input[0].previous_output.txid, chan_1.3.txid());
5025 // Settle A's commitment tx on B's chain
5026 assert!(nodes[1].node.claim_funds(payment_preimage));
5027 check_added_monitors!(nodes[1], 1);
5028 mine_transaction(&nodes[1], &commitment_tx[0]);
5029 check_added_monitors!(nodes[1], 1);
5030 let events = nodes[1].node.get_and_clear_pending_msg_events();
5032 MessageSendEvent::UpdateHTLCs { .. } => {},
5033 _ => panic!("Unexpected event"),
5036 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5037 _ => panic!("Unexepected event"),
5040 // Check B's monitor was able to send back output descriptor event for preimage tx on A's commitment tx
5041 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap(); // ChannelManager : 2 (local commitment tx + HTLC-Success), ChannelMonitor: preimage tx
5042 assert_eq!(node_txn.len(), 3);
5043 check_spends!(node_txn[0], commitment_tx[0]);
5044 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5045 check_spends!(node_txn[1], chan_1.3);
5046 check_spends!(node_txn[2], node_txn[1]);
5048 mine_transaction(&nodes[1], &node_txn[0]);
5049 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
5051 let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
5052 assert_eq!(spend_txn.len(), 1);
5053 check_spends!(spend_txn[0], node_txn[0]);
5057 fn test_static_spendable_outputs_timeout_tx() {
5058 let chanmon_cfgs = create_chanmon_cfgs(2);
5059 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5060 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5061 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5063 // Create some initial channels
5064 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5066 // Rebalance the network a bit by relaying one payment through all the channels ...
5067 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
5069 let (_, our_payment_hash, _) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3_000_000);
5071 let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
5072 assert_eq!(commitment_tx[0].input.len(), 1);
5073 assert_eq!(commitment_tx[0].input[0].previous_output.txid, chan_1.3.txid());
5075 // Settle A's commitment tx on B' chain
5076 mine_transaction(&nodes[1], &commitment_tx[0]);
5077 check_added_monitors!(nodes[1], 1);
5078 let events = nodes[1].node.get_and_clear_pending_msg_events();
5080 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5081 _ => panic!("Unexpected event"),
5083 connect_blocks(&nodes[1], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
5085 // Check B's monitor was able to send back output descriptor event for timeout tx on A's commitment tx
5086 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
5087 assert_eq!(node_txn.len(), 2); // ChannelManager : 1 local commitent tx, ChannelMonitor: timeout tx
5088 check_spends!(node_txn[0], chan_1.3.clone());
5089 check_spends!(node_txn[1], commitment_tx[0].clone());
5090 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5092 mine_transaction(&nodes[1], &node_txn[1]);
5093 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
5094 expect_payment_failed!(nodes[1], our_payment_hash, true);
5096 let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
5097 assert_eq!(spend_txn.len(), 3); // SpendableOutput: remote_commitment_tx.to_remote, timeout_tx.output
5098 check_spends!(spend_txn[0], commitment_tx[0]);
5099 check_spends!(spend_txn[1], node_txn[1]);
5100 check_spends!(spend_txn[2], node_txn[1], commitment_tx[0]); // All outputs
5104 fn test_static_spendable_outputs_justice_tx_revoked_commitment_tx() {
5105 let chanmon_cfgs = create_chanmon_cfgs(2);
5106 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5107 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5108 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5110 // Create some initial channels
5111 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5113 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
5114 let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
5115 assert_eq!(revoked_local_txn[0].input.len(), 1);
5116 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
5118 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
5120 mine_transaction(&nodes[1], &revoked_local_txn[0]);
5121 check_closed_broadcast!(nodes[1], true);
5122 check_added_monitors!(nodes[1], 1);
5124 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5125 assert_eq!(node_txn.len(), 2);
5126 assert_eq!(node_txn[0].input.len(), 2);
5127 check_spends!(node_txn[0], revoked_local_txn[0]);
5129 mine_transaction(&nodes[1], &node_txn[0]);
5130 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
5132 let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
5133 assert_eq!(spend_txn.len(), 1);
5134 check_spends!(spend_txn[0], node_txn[0]);
5138 fn test_static_spendable_outputs_justice_tx_revoked_htlc_timeout_tx() {
5139 let mut chanmon_cfgs = create_chanmon_cfgs(2);
5140 chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
5141 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5142 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5143 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5145 // Create some initial channels
5146 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5148 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
5149 let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
5150 assert_eq!(revoked_local_txn[0].input.len(), 1);
5151 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
5153 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
5155 // A will generate HTLC-Timeout from revoked commitment tx
5156 mine_transaction(&nodes[0], &revoked_local_txn[0]);
5157 check_closed_broadcast!(nodes[0], true);
5158 check_added_monitors!(nodes[0], 1);
5159 connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
5161 let revoked_htlc_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5162 assert_eq!(revoked_htlc_txn.len(), 2);
5163 check_spends!(revoked_htlc_txn[0], chan_1.3);
5164 assert_eq!(revoked_htlc_txn[1].input.len(), 1);
5165 assert_eq!(revoked_htlc_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5166 check_spends!(revoked_htlc_txn[1], revoked_local_txn[0]);
5167 assert_ne!(revoked_htlc_txn[1].lock_time, 0); // HTLC-Timeout
5169 // B will generate justice tx from A's revoked commitment/HTLC tx
5170 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5171 connect_block(&nodes[1], &Block { header, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[1].clone()] });
5172 check_closed_broadcast!(nodes[1], true);
5173 check_added_monitors!(nodes[1], 1);
5175 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5176 assert_eq!(node_txn.len(), 3); // ChannelMonitor: bogus justice tx, justice tx on revoked outputs, ChannelManager: local commitment tx
5177 // The first transaction generated is bogus - it spends both outputs of revoked_local_txn[0]
5178 // including the one already spent by revoked_htlc_txn[1]. That's OK, we'll spend with valid
5179 // transactions next...
5180 assert_eq!(node_txn[0].input.len(), 3);
5181 check_spends!(node_txn[0], revoked_local_txn[0], revoked_htlc_txn[1]);
5183 assert_eq!(node_txn[1].input.len(), 2);
5184 check_spends!(node_txn[1], revoked_local_txn[0], revoked_htlc_txn[1]);
5185 if node_txn[1].input[1].previous_output.txid == revoked_htlc_txn[1].txid() {
5186 assert_ne!(node_txn[1].input[0].previous_output, revoked_htlc_txn[1].input[0].previous_output);
5188 assert_eq!(node_txn[1].input[0].previous_output.txid, revoked_htlc_txn[1].txid());
5189 assert_ne!(node_txn[1].input[1].previous_output, revoked_htlc_txn[1].input[0].previous_output);
5192 assert_eq!(node_txn[2].input.len(), 1);
5193 check_spends!(node_txn[2], chan_1.3);
5195 mine_transaction(&nodes[1], &node_txn[1]);
5196 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
5198 // Check B's ChannelMonitor was able to generate the right spendable output descriptor
5199 let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
5200 assert_eq!(spend_txn.len(), 1);
5201 assert_eq!(spend_txn[0].input.len(), 1);
5202 check_spends!(spend_txn[0], node_txn[1]);
5206 fn test_static_spendable_outputs_justice_tx_revoked_htlc_success_tx() {
5207 let mut chanmon_cfgs = create_chanmon_cfgs(2);
5208 chanmon_cfgs[1].keys_manager.disable_revocation_policy_check = true;
5209 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5210 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5211 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5213 // Create some initial channels
5214 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5216 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
5217 let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan_1.2);
5218 assert_eq!(revoked_local_txn[0].input.len(), 1);
5219 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
5221 // The to-be-revoked commitment tx should have one HTLC and one to_remote output
5222 assert_eq!(revoked_local_txn[0].output.len(), 2);
5224 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
5226 // B will generate HTLC-Success from revoked commitment tx
5227 mine_transaction(&nodes[1], &revoked_local_txn[0]);
5228 check_closed_broadcast!(nodes[1], true);
5229 check_added_monitors!(nodes[1], 1);
5230 let revoked_htlc_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5232 assert_eq!(revoked_htlc_txn.len(), 2);
5233 assert_eq!(revoked_htlc_txn[0].input.len(), 1);
5234 assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5235 check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
5237 // Check that the unspent (of two) outputs on revoked_local_txn[0] is a P2WPKH:
5238 let unspent_local_txn_output = revoked_htlc_txn[0].input[0].previous_output.vout as usize ^ 1;
5239 assert_eq!(revoked_local_txn[0].output[unspent_local_txn_output].script_pubkey.len(), 2 + 20); // P2WPKH
5241 // A will generate justice tx from B's revoked commitment/HTLC tx
5242 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5243 connect_block(&nodes[0], &Block { header, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[0].clone()] });
5244 check_closed_broadcast!(nodes[0], true);
5245 check_added_monitors!(nodes[0], 1);
5247 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5248 assert_eq!(node_txn.len(), 3); // ChannelMonitor: justice tx on revoked commitment, justice tx on revoked HTLC-success, ChannelManager: local commitment tx
5250 // The first transaction generated is bogus - it spends both outputs of revoked_local_txn[0]
5251 // including the one already spent by revoked_htlc_txn[0]. That's OK, we'll spend with valid
5252 // transactions next...
5253 assert_eq!(node_txn[0].input.len(), 2);
5254 check_spends!(node_txn[0], revoked_local_txn[0], revoked_htlc_txn[0]);
5255 if node_txn[0].input[1].previous_output.txid == revoked_htlc_txn[0].txid() {
5256 assert_eq!(node_txn[0].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
5258 assert_eq!(node_txn[0].input[0].previous_output.txid, revoked_htlc_txn[0].txid());
5259 assert_eq!(node_txn[0].input[1].previous_output, revoked_htlc_txn[0].input[0].previous_output);
5262 assert_eq!(node_txn[1].input.len(), 1);
5263 check_spends!(node_txn[1], revoked_htlc_txn[0]);
5265 check_spends!(node_txn[2], chan_1.3);
5267 mine_transaction(&nodes[0], &node_txn[1]);
5268 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
5270 // Note that nodes[0]'s tx_broadcaster is still locked, so if we get here the channelmonitor
5271 // didn't try to generate any new transactions.
5273 // Check A's ChannelMonitor was able to generate the right spendable output descriptor
5274 let spend_txn = check_spendable_outputs!(nodes[0], node_cfgs[0].keys_manager);
5275 assert_eq!(spend_txn.len(), 3);
5276 assert_eq!(spend_txn[0].input.len(), 1);
5277 check_spends!(spend_txn[0], revoked_local_txn[0]); // spending to_remote output from revoked local tx
5278 assert_ne!(spend_txn[0].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
5279 check_spends!(spend_txn[1], node_txn[1]); // spending justice tx output on the htlc success tx
5280 check_spends!(spend_txn[2], revoked_local_txn[0], node_txn[1]); // Both outputs
5284 fn test_onchain_to_onchain_claim() {
5285 // Test that in case of channel closure, we detect the state of output and claim HTLC
5286 // on downstream peer's remote commitment tx.
5287 // First, have C claim an HTLC against its own latest commitment transaction.
5288 // Then, broadcast these to B, which should update the monitor downstream on the A<->B
5290 // Finally, check that B will claim the HTLC output if A's latest commitment transaction
5293 let chanmon_cfgs = create_chanmon_cfgs(3);
5294 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5295 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5296 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5298 // Create some initial channels
5299 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5300 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
5302 // Ensure all nodes are at the same height
5303 let node_max_height = nodes.iter().map(|node| node.blocks.lock().unwrap().len()).max().unwrap() as u32;
5304 connect_blocks(&nodes[0], node_max_height - nodes[0].best_block_info().1);
5305 connect_blocks(&nodes[1], node_max_height - nodes[1].best_block_info().1);
5306 connect_blocks(&nodes[2], node_max_height - nodes[2].best_block_info().1);
5308 // Rebalance the network a bit by relaying one payment through all the channels ...
5309 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
5310 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
5312 let (payment_preimage, _payment_hash, _payment_secret) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
5313 let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
5314 check_spends!(commitment_tx[0], chan_2.3);
5315 nodes[2].node.claim_funds(payment_preimage);
5316 check_added_monitors!(nodes[2], 1);
5317 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
5318 assert!(updates.update_add_htlcs.is_empty());
5319 assert!(updates.update_fail_htlcs.is_empty());
5320 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
5321 assert!(updates.update_fail_malformed_htlcs.is_empty());
5323 mine_transaction(&nodes[2], &commitment_tx[0]);
5324 check_closed_broadcast!(nodes[2], true);
5325 check_added_monitors!(nodes[2], 1);
5327 let c_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 2 (commitment tx, HTLC-Success tx), ChannelMonitor : 1 (HTLC-Success tx)
5328 assert_eq!(c_txn.len(), 3);
5329 assert_eq!(c_txn[0], c_txn[2]);
5330 assert_eq!(commitment_tx[0], c_txn[1]);
5331 check_spends!(c_txn[1], chan_2.3);
5332 check_spends!(c_txn[2], c_txn[1]);
5333 assert_eq!(c_txn[1].input[0].witness.clone().last().unwrap().len(), 71);
5334 assert_eq!(c_txn[2].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5335 assert!(c_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
5336 assert_eq!(c_txn[0].lock_time, 0); // Success tx
5338 // 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
5339 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
5340 connect_block(&nodes[1], &Block { header, txdata: vec![c_txn[1].clone(), c_txn[2].clone()]});
5341 check_added_monitors!(nodes[1], 1);
5342 expect_payment_forwarded!(nodes[1], Some(1000), true);
5344 let mut b_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5345 // ChannelMonitor: claim tx
5346 assert_eq!(b_txn.len(), 1);
5347 check_spends!(b_txn[0], chan_2.3); // B local commitment tx, issued by ChannelManager
5350 let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
5351 assert_eq!(msg_events.len(), 3);
5352 check_added_monitors!(nodes[1], 1);
5353 match msg_events[0] {
5354 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5355 _ => panic!("Unexpected event"),
5357 match msg_events[1] {
5358 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { .. }, node_id: _ } => {},
5359 _ => panic!("Unexpected event"),
5361 match msg_events[2] {
5362 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, .. } } => {
5363 assert!(update_add_htlcs.is_empty());
5364 assert!(update_fail_htlcs.is_empty());
5365 assert_eq!(update_fulfill_htlcs.len(), 1);
5366 assert!(update_fail_malformed_htlcs.is_empty());
5367 assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
5369 _ => panic!("Unexpected event"),
5371 // Broadcast A's commitment tx on B's chain to see if we are able to claim inbound HTLC with our HTLC-Success tx
5372 let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
5373 mine_transaction(&nodes[1], &commitment_tx[0]);
5374 let b_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5375 // ChannelMonitor: HTLC-Success tx, ChannelManager: local commitment tx + HTLC-Success tx
5376 assert_eq!(b_txn.len(), 3);
5377 check_spends!(b_txn[1], chan_1.3);
5378 check_spends!(b_txn[2], b_txn[1]);
5379 check_spends!(b_txn[0], commitment_tx[0]);
5380 assert_eq!(b_txn[0].input[0].witness.clone().last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5381 assert!(b_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
5382 assert_eq!(b_txn[0].lock_time, 0); // Success tx
5384 check_closed_broadcast!(nodes[1], true);
5385 check_added_monitors!(nodes[1], 1);
5389 fn test_duplicate_payment_hash_one_failure_one_success() {
5390 // Topology : A --> B --> C --> D
5391 // We route 2 payments with same hash between B and C, one will be timeout, the other successfully claim
5392 // Note that because C will refuse to generate two payment secrets for the same payment hash,
5393 // we forward one of the payments onwards to D.
5394 let chanmon_cfgs = create_chanmon_cfgs(4);
5395 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
5396 // When this test was written, the default base fee floated based on the HTLC count.
5397 // It is now fixed, so we simply set the fee to the expected value here.
5398 let mut config = test_default_channel_config();
5399 config.channel_options.forwarding_fee_base_msat = 196;
5400 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs,
5401 &[Some(config.clone()), Some(config.clone()), Some(config.clone()), Some(config.clone())]);
5402 let mut nodes = create_network(4, &node_cfgs, &node_chanmgrs);
5404 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5405 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
5406 create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
5408 let node_max_height = nodes.iter().map(|node| node.blocks.lock().unwrap().len()).max().unwrap() as u32;
5409 connect_blocks(&nodes[0], node_max_height - nodes[0].best_block_info().1);
5410 connect_blocks(&nodes[1], node_max_height - nodes[1].best_block_info().1);
5411 connect_blocks(&nodes[2], node_max_height - nodes[2].best_block_info().1);
5412 connect_blocks(&nodes[3], node_max_height - nodes[3].best_block_info().1);
5414 let (our_payment_preimage, duplicate_payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 900000);
5416 let payment_secret = nodes[3].node.create_inbound_payment_for_hash(duplicate_payment_hash, None, 7200, 0).unwrap();
5417 // We reduce the final CLTV here by a somewhat arbitrary constant to keep it under the one-byte
5418 // script push size limit so that the below script length checks match
5419 // ACCEPTED_HTLC_SCRIPT_WEIGHT.
5420 let route = get_route(&nodes[0].node.get_our_node_id(), &nodes[0].net_graph_msg_handler.network_graph.read().unwrap(),
5421 &nodes[3].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 900000, TEST_FINAL_CLTV - 40, nodes[0].logger).unwrap();
5422 send_along_route_with_secret(&nodes[0], route, &[&[&nodes[1], &nodes[2], &nodes[3]]], 900000, duplicate_payment_hash, payment_secret);
5424 let commitment_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
5425 assert_eq!(commitment_txn[0].input.len(), 1);
5426 check_spends!(commitment_txn[0], chan_2.3);
5428 mine_transaction(&nodes[1], &commitment_txn[0]);
5429 check_closed_broadcast!(nodes[1], true);
5430 check_added_monitors!(nodes[1], 1);
5431 connect_blocks(&nodes[1], TEST_FINAL_CLTV - 40 + MIN_CLTV_EXPIRY_DELTA as u32 - 1); // Confirm blocks until the HTLC expires
5433 let htlc_timeout_tx;
5434 { // Extract one of the two HTLC-Timeout transaction
5435 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5436 // ChannelMonitor: timeout tx * 3, ChannelManager: local commitment tx
5437 assert_eq!(node_txn.len(), 4);
5438 check_spends!(node_txn[0], chan_2.3);
5440 check_spends!(node_txn[1], commitment_txn[0]);
5441 assert_eq!(node_txn[1].input.len(), 1);
5442 check_spends!(node_txn[2], commitment_txn[0]);
5443 assert_eq!(node_txn[2].input.len(), 1);
5444 assert_eq!(node_txn[1].input[0].previous_output, node_txn[2].input[0].previous_output);
5445 check_spends!(node_txn[3], commitment_txn[0]);
5446 assert_ne!(node_txn[1].input[0].previous_output, node_txn[3].input[0].previous_output);
5448 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5449 assert_eq!(node_txn[2].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5450 assert_eq!(node_txn[3].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5451 htlc_timeout_tx = node_txn[1].clone();
5454 nodes[2].node.claim_funds(our_payment_preimage);
5455 mine_transaction(&nodes[2], &commitment_txn[0]);
5456 check_added_monitors!(nodes[2], 2);
5457 let events = nodes[2].node.get_and_clear_pending_msg_events();
5459 MessageSendEvent::UpdateHTLCs { .. } => {},
5460 _ => panic!("Unexpected event"),
5463 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5464 _ => panic!("Unexepected event"),
5466 let htlc_success_txn: Vec<_> = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
5467 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)
5468 check_spends!(htlc_success_txn[0], commitment_txn[0]);
5469 check_spends!(htlc_success_txn[1], commitment_txn[0]);
5470 assert_eq!(htlc_success_txn[0].input.len(), 1);
5471 assert_eq!(htlc_success_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5472 assert_eq!(htlc_success_txn[1].input.len(), 1);
5473 assert_eq!(htlc_success_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5474 assert_ne!(htlc_success_txn[0].input[0].previous_output, htlc_success_txn[1].input[0].previous_output);
5475 assert_eq!(htlc_success_txn[2], commitment_txn[0]);
5476 assert_eq!(htlc_success_txn[3], htlc_success_txn[0]);
5477 assert_eq!(htlc_success_txn[4], htlc_success_txn[1]);
5478 assert_ne!(htlc_success_txn[0].input[0].previous_output, htlc_timeout_tx.input[0].previous_output);
5480 mine_transaction(&nodes[1], &htlc_timeout_tx);
5481 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
5482 expect_pending_htlcs_forwardable!(nodes[1]);
5483 let htlc_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5484 assert!(htlc_updates.update_add_htlcs.is_empty());
5485 assert_eq!(htlc_updates.update_fail_htlcs.len(), 1);
5486 let first_htlc_id = htlc_updates.update_fail_htlcs[0].htlc_id;
5487 assert!(htlc_updates.update_fulfill_htlcs.is_empty());
5488 assert!(htlc_updates.update_fail_malformed_htlcs.is_empty());
5489 check_added_monitors!(nodes[1], 1);
5491 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_updates.update_fail_htlcs[0]);
5492 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
5494 commitment_signed_dance!(nodes[0], nodes[1], &htlc_updates.commitment_signed, false, true);
5495 expect_payment_failure_chan_update!(nodes[0], chan_2.0.contents.short_channel_id, true);
5497 expect_payment_failed!(nodes[0], duplicate_payment_hash, false);
5499 // Solve 2nd HTLC by broadcasting on B's chain HTLC-Success Tx from C
5500 // Note that the fee paid is effectively double as the HTLC value (including the nodes[1] fee
5501 // and nodes[2] fee) is rounded down and then claimed in full.
5502 mine_transaction(&nodes[1], &htlc_success_txn[0]);
5503 expect_payment_forwarded!(nodes[1], Some(196*2), true);
5504 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5505 assert!(updates.update_add_htlcs.is_empty());
5506 assert!(updates.update_fail_htlcs.is_empty());
5507 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
5508 assert_ne!(updates.update_fulfill_htlcs[0].htlc_id, first_htlc_id);
5509 assert!(updates.update_fail_malformed_htlcs.is_empty());
5510 check_added_monitors!(nodes[1], 1);
5512 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
5513 commitment_signed_dance!(nodes[0], nodes[1], &updates.commitment_signed, false);
5515 let events = nodes[0].node.get_and_clear_pending_events();
5517 Event::PaymentSent { ref payment_preimage } => {
5518 assert_eq!(*payment_preimage, our_payment_preimage);
5520 _ => panic!("Unexpected event"),
5525 fn test_dynamic_spendable_outputs_local_htlc_success_tx() {
5526 let chanmon_cfgs = create_chanmon_cfgs(2);
5527 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5528 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5529 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5531 // Create some initial channels
5532 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5534 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000).0;
5535 let local_txn = get_local_commitment_txn!(nodes[1], chan_1.2);
5536 assert_eq!(local_txn.len(), 1);
5537 assert_eq!(local_txn[0].input.len(), 1);
5538 check_spends!(local_txn[0], chan_1.3);
5540 // Give B knowledge of preimage to be able to generate a local HTLC-Success Tx
5541 nodes[1].node.claim_funds(payment_preimage);
5542 check_added_monitors!(nodes[1], 1);
5543 mine_transaction(&nodes[1], &local_txn[0]);
5544 check_added_monitors!(nodes[1], 1);
5545 let events = nodes[1].node.get_and_clear_pending_msg_events();
5547 MessageSendEvent::UpdateHTLCs { .. } => {},
5548 _ => panic!("Unexpected event"),
5551 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5552 _ => panic!("Unexepected event"),
5555 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5556 assert_eq!(node_txn.len(), 3);
5557 assert_eq!(node_txn[0], node_txn[2]);
5558 assert_eq!(node_txn[1], local_txn[0]);
5559 assert_eq!(node_txn[0].input.len(), 1);
5560 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5561 check_spends!(node_txn[0], local_txn[0]);
5565 mine_transaction(&nodes[1], &node_tx);
5566 connect_blocks(&nodes[1], BREAKDOWN_TIMEOUT as u32 - 1);
5568 // Verify that B is able to spend its own HTLC-Success tx thanks to spendable output event given back by its ChannelMonitor
5569 let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
5570 assert_eq!(spend_txn.len(), 1);
5571 assert_eq!(spend_txn[0].input.len(), 1);
5572 check_spends!(spend_txn[0], node_tx);
5573 assert_eq!(spend_txn[0].input[0].sequence, BREAKDOWN_TIMEOUT as u32);
5576 fn do_test_fail_backwards_unrevoked_remote_announce(deliver_last_raa: bool, announce_latest: bool) {
5577 // Test that we fail backwards the full set of HTLCs we need to when remote broadcasts an
5578 // unrevoked commitment transaction.
5579 // This includes HTLCs which were below the dust threshold as well as HTLCs which were awaiting
5580 // a remote RAA before they could be failed backwards (and combinations thereof).
5581 // We also test duplicate-hash HTLCs by adding two nodes on each side of the target nodes which
5582 // use the same payment hashes.
5583 // Thus, we use a six-node network:
5588 // And test where C fails back to A/B when D announces its latest commitment transaction
5589 let chanmon_cfgs = create_chanmon_cfgs(6);
5590 let node_cfgs = create_node_cfgs(6, &chanmon_cfgs);
5591 // When this test was written, the default base fee floated based on the HTLC count.
5592 // It is now fixed, so we simply set the fee to the expected value here.
5593 let mut config = test_default_channel_config();
5594 config.channel_options.forwarding_fee_base_msat = 196;
5595 let node_chanmgrs = create_node_chanmgrs(6, &node_cfgs,
5596 &[Some(config.clone()), Some(config.clone()), Some(config.clone()), Some(config.clone()), Some(config.clone()), Some(config.clone())]);
5597 let nodes = create_network(6, &node_cfgs, &node_chanmgrs);
5598 let logger = test_utils::TestLogger::new();
5600 create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known());
5601 create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
5602 let chan = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
5603 create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::known(), InitFeatures::known());
5604 create_announced_chan_between_nodes(&nodes, 3, 5, InitFeatures::known(), InitFeatures::known());
5606 // Rebalance and check output sanity...
5607 send_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 500000);
5608 send_payment(&nodes[1], &[&nodes[2], &nodes[3], &nodes[5]], 500000);
5609 assert_eq!(get_local_commitment_txn!(nodes[3], chan.2)[0].output.len(), 2);
5611 let ds_dust_limit = nodes[3].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().holder_dust_limit_satoshis;
5613 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
5615 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
5616 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
5617 let our_node_id = &nodes[1].node.get_our_node_id();
5618 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();
5620 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
5622 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
5624 let (_, payment_hash_3, _) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
5626 let (_, payment_hash_4, _) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
5627 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();
5629 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());
5631 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());
5634 let (_, payment_hash_5, _) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
5636 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();
5637 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
5640 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
5642 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();
5643 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());
5645 // Double-check that six of the new HTLC were added
5646 // We now have six HTLCs pending over the dust limit and six HTLCs under the dust limit (ie,
5647 // with to_local and to_remote outputs, 8 outputs and 6 HTLCs not included).
5648 assert_eq!(get_local_commitment_txn!(nodes[3], chan.2).len(), 1);
5649 assert_eq!(get_local_commitment_txn!(nodes[3], chan.2)[0].output.len(), 8);
5651 // Now fail back three of the over-dust-limit and three of the under-dust-limit payments in one go.
5652 // Fail 0th below-dust, 4th above-dust, 8th above-dust, 10th below-dust HTLCs
5653 assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_1));
5654 assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_3));
5655 assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_5));
5656 assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_6));
5657 check_added_monitors!(nodes[4], 0);
5658 expect_pending_htlcs_forwardable!(nodes[4]);
5659 check_added_monitors!(nodes[4], 1);
5661 let four_removes = get_htlc_update_msgs!(nodes[4], nodes[3].node.get_our_node_id());
5662 nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[0]);
5663 nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[1]);
5664 nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[2]);
5665 nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[3]);
5666 commitment_signed_dance!(nodes[3], nodes[4], four_removes.commitment_signed, false);
5668 // Fail 3rd below-dust and 7th above-dust HTLCs
5669 assert!(nodes[5].node.fail_htlc_backwards(&payment_hash_2));
5670 assert!(nodes[5].node.fail_htlc_backwards(&payment_hash_4));
5671 check_added_monitors!(nodes[5], 0);
5672 expect_pending_htlcs_forwardable!(nodes[5]);
5673 check_added_monitors!(nodes[5], 1);
5675 let two_removes = get_htlc_update_msgs!(nodes[5], nodes[3].node.get_our_node_id());
5676 nodes[3].node.handle_update_fail_htlc(&nodes[5].node.get_our_node_id(), &two_removes.update_fail_htlcs[0]);
5677 nodes[3].node.handle_update_fail_htlc(&nodes[5].node.get_our_node_id(), &two_removes.update_fail_htlcs[1]);
5678 commitment_signed_dance!(nodes[3], nodes[5], two_removes.commitment_signed, false);
5680 let ds_prev_commitment_tx = get_local_commitment_txn!(nodes[3], chan.2);
5682 expect_pending_htlcs_forwardable!(nodes[3]);
5683 check_added_monitors!(nodes[3], 1);
5684 let six_removes = get_htlc_update_msgs!(nodes[3], nodes[2].node.get_our_node_id());
5685 nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[0]);
5686 nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[1]);
5687 nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[2]);
5688 nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[3]);
5689 nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[4]);
5690 nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[5]);
5691 if deliver_last_raa {
5692 commitment_signed_dance!(nodes[2], nodes[3], six_removes.commitment_signed, false);
5694 let _cs_last_raa = commitment_signed_dance!(nodes[2], nodes[3], six_removes.commitment_signed, false, true, false, true);
5697 // D's latest commitment transaction now contains 1st + 2nd + 9th HTLCs (implicitly, they're
5698 // below the dust limit) and the 5th + 6th + 11th HTLCs. It has failed back the 0th, 3rd, 4th,
5699 // 7th, 8th, and 10th, but as we haven't yet delivered the final RAA to C, the fails haven't
5700 // propagated back to A/B yet (and D has two unrevoked commitment transactions).
5702 // We now broadcast the latest commitment transaction, which *should* result in failures for
5703 // the 0th, 1st, 2nd, 3rd, 4th, 7th, 8th, 9th, and 10th HTLCs, ie all the below-dust HTLCs and
5704 // the non-broadcast above-dust HTLCs.
5706 // Alternatively, we may broadcast the previous commitment transaction, which should only
5707 // result in failures for the below-dust HTLCs, ie the 0th, 1st, 2nd, 3rd, 9th, and 10th HTLCs.
5708 let ds_last_commitment_tx = get_local_commitment_txn!(nodes[3], chan.2);
5710 if announce_latest {
5711 mine_transaction(&nodes[2], &ds_last_commitment_tx[0]);
5713 mine_transaction(&nodes[2], &ds_prev_commitment_tx[0]);
5715 connect_blocks(&nodes[2], ANTI_REORG_DELAY - 1);
5716 check_closed_broadcast!(nodes[2], true);
5717 expect_pending_htlcs_forwardable!(nodes[2]);
5718 check_added_monitors!(nodes[2], 3);
5720 let cs_msgs = nodes[2].node.get_and_clear_pending_msg_events();
5721 assert_eq!(cs_msgs.len(), 2);
5722 let mut a_done = false;
5723 for msg in cs_msgs {
5725 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
5726 // Both under-dust HTLCs and the one above-dust HTLC that we had already failed
5727 // should be failed-backwards here.
5728 let target = if *node_id == nodes[0].node.get_our_node_id() {
5729 // If announce_latest, expect 0th, 1st, 4th, 8th, 10th HTLCs, else only 0th, 1st, 10th below-dust HTLCs
5730 for htlc in &updates.update_fail_htlcs {
5731 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 });
5733 assert_eq!(updates.update_fail_htlcs.len(), if announce_latest { 5 } else { 3 });
5738 // If announce_latest, expect 2nd, 3rd, 7th, 9th HTLCs, else only 2nd, 3rd, 9th below-dust HTLCs
5739 for htlc in &updates.update_fail_htlcs {
5740 assert!(htlc.htlc_id == 1 || htlc.htlc_id == 2 || htlc.htlc_id == 5 || if announce_latest { htlc.htlc_id == 4 } else { false });
5742 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
5743 assert_eq!(updates.update_fail_htlcs.len(), if announce_latest { 4 } else { 3 });
5746 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
5747 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[1]);
5748 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[2]);
5749 if announce_latest {
5750 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[3]);
5751 if *node_id == nodes[0].node.get_our_node_id() {
5752 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[4]);
5755 commitment_signed_dance!(target, nodes[2], updates.commitment_signed, false, true);
5757 _ => panic!("Unexpected event"),
5761 let as_events = nodes[0].node.get_and_clear_pending_events();
5762 assert_eq!(as_events.len(), if announce_latest { 5 } else { 3 });
5763 let mut as_failds = HashSet::new();
5764 for event in as_events.iter() {
5765 if let &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, .. } = event {
5766 assert!(as_failds.insert(*payment_hash));
5767 if *payment_hash != payment_hash_2 {
5768 assert_eq!(*rejected_by_dest, deliver_last_raa);
5770 assert!(!rejected_by_dest);
5772 } else { panic!("Unexpected event"); }
5774 assert!(as_failds.contains(&payment_hash_1));
5775 assert!(as_failds.contains(&payment_hash_2));
5776 if announce_latest {
5777 assert!(as_failds.contains(&payment_hash_3));
5778 assert!(as_failds.contains(&payment_hash_5));
5780 assert!(as_failds.contains(&payment_hash_6));
5782 let bs_events = nodes[1].node.get_and_clear_pending_events();
5783 assert_eq!(bs_events.len(), if announce_latest { 4 } else { 3 });
5784 let mut bs_failds = HashSet::new();
5785 for event in bs_events.iter() {
5786 if let &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, .. } = event {
5787 assert!(bs_failds.insert(*payment_hash));
5788 if *payment_hash != payment_hash_1 && *payment_hash != payment_hash_5 {
5789 assert_eq!(*rejected_by_dest, deliver_last_raa);
5791 assert!(!rejected_by_dest);
5793 } else { panic!("Unexpected event"); }
5795 assert!(bs_failds.contains(&payment_hash_1));
5796 assert!(bs_failds.contains(&payment_hash_2));
5797 if announce_latest {
5798 assert!(bs_failds.contains(&payment_hash_4));
5800 assert!(bs_failds.contains(&payment_hash_5));
5802 // For each HTLC which was not failed-back by normal process (ie deliver_last_raa), we should
5803 // get a PaymentFailureNetworkUpdate. A should have gotten 4 HTLCs which were failed-back due
5804 // to unknown-preimage-etc, B should have gotten 2. Thus, in the
5805 // announce_latest && deliver_last_raa case, we should have 5-4=1 and 4-2=2
5806 // PaymentFailureNetworkUpdates.
5807 let as_msg_events = nodes[0].node.get_and_clear_pending_msg_events();
5808 assert_eq!(as_msg_events.len(), if deliver_last_raa { 1 } else if !announce_latest { 3 } else { 5 });
5809 let bs_msg_events = nodes[1].node.get_and_clear_pending_msg_events();
5810 assert_eq!(bs_msg_events.len(), if deliver_last_raa { 2 } else if !announce_latest { 3 } else { 4 });
5811 for event in as_msg_events.iter().chain(bs_msg_events.iter()) {
5813 &MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
5814 _ => panic!("Unexpected event"),
5820 fn test_fail_backwards_latest_remote_announce_a() {
5821 do_test_fail_backwards_unrevoked_remote_announce(false, true);
5825 fn test_fail_backwards_latest_remote_announce_b() {
5826 do_test_fail_backwards_unrevoked_remote_announce(true, true);
5830 fn test_fail_backwards_previous_remote_announce() {
5831 do_test_fail_backwards_unrevoked_remote_announce(false, false);
5832 // Note that true, true doesn't make sense as it implies we announce a revoked state, which is
5833 // tested for in test_commitment_revoked_fail_backward_exhaustive()
5837 fn test_dynamic_spendable_outputs_local_htlc_timeout_tx() {
5838 let chanmon_cfgs = create_chanmon_cfgs(2);
5839 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5840 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5841 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5843 // Create some initial channels
5844 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5846 let (_, our_payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000);
5847 let local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
5848 assert_eq!(local_txn[0].input.len(), 1);
5849 check_spends!(local_txn[0], chan_1.3);
5851 // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
5852 mine_transaction(&nodes[0], &local_txn[0]);
5853 check_closed_broadcast!(nodes[0], true);
5854 check_added_monitors!(nodes[0], 1);
5855 connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
5857 let htlc_timeout = {
5858 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5859 assert_eq!(node_txn.len(), 2);
5860 check_spends!(node_txn[0], chan_1.3);
5861 assert_eq!(node_txn[1].input.len(), 1);
5862 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5863 check_spends!(node_txn[1], local_txn[0]);
5867 mine_transaction(&nodes[0], &htlc_timeout);
5868 connect_blocks(&nodes[0], BREAKDOWN_TIMEOUT as u32 - 1);
5869 expect_payment_failed!(nodes[0], our_payment_hash, true);
5871 // Verify that A is able to spend its own HTLC-Timeout tx thanks to spendable output event given back by its ChannelMonitor
5872 let spend_txn = check_spendable_outputs!(nodes[0], node_cfgs[0].keys_manager);
5873 assert_eq!(spend_txn.len(), 3);
5874 check_spends!(spend_txn[0], local_txn[0]);
5875 assert_eq!(spend_txn[1].input.len(), 1);
5876 check_spends!(spend_txn[1], htlc_timeout);
5877 assert_eq!(spend_txn[1].input[0].sequence, BREAKDOWN_TIMEOUT as u32);
5878 assert_eq!(spend_txn[2].input.len(), 2);
5879 check_spends!(spend_txn[2], local_txn[0], htlc_timeout);
5880 assert!(spend_txn[2].input[0].sequence == BREAKDOWN_TIMEOUT as u32 ||
5881 spend_txn[2].input[1].sequence == BREAKDOWN_TIMEOUT as u32);
5885 fn test_key_derivation_params() {
5886 // This test is a copy of test_dynamic_spendable_outputs_local_htlc_timeout_tx, with
5887 // a key manager rotation to test that key_derivation_params returned in DynamicOutputP2WSH
5888 // let us re-derive the channel key set to then derive a delayed_payment_key.
5890 let chanmon_cfgs = create_chanmon_cfgs(3);
5892 // We manually create the node configuration to backup the seed.
5893 let seed = [42; 32];
5894 let keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
5895 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);
5896 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, features: InitFeatures::known() };
5897 let mut node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5898 node_cfgs.remove(0);
5899 node_cfgs.insert(0, node);
5901 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5902 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5904 // Create some initial channels
5905 // Create a dummy channel to advance index by one and thus test re-derivation correctness
5907 let chan_0 = create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known());
5908 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5909 assert_ne!(chan_0.3.output[0].script_pubkey, chan_1.3.output[0].script_pubkey);
5911 // Ensure all nodes are at the same height
5912 let node_max_height = nodes.iter().map(|node| node.blocks.lock().unwrap().len()).max().unwrap() as u32;
5913 connect_blocks(&nodes[0], node_max_height - nodes[0].best_block_info().1);
5914 connect_blocks(&nodes[1], node_max_height - nodes[1].best_block_info().1);
5915 connect_blocks(&nodes[2], node_max_height - nodes[2].best_block_info().1);
5917 let (_, our_payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000);
5918 let local_txn_0 = get_local_commitment_txn!(nodes[0], chan_0.2);
5919 let local_txn_1 = get_local_commitment_txn!(nodes[0], chan_1.2);
5920 assert_eq!(local_txn_1[0].input.len(), 1);
5921 check_spends!(local_txn_1[0], chan_1.3);
5923 // We check funding pubkey are unique
5924 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]));
5925 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]));
5926 if from_0_funding_key_0 == from_1_funding_key_0
5927 || from_0_funding_key_0 == from_1_funding_key_1
5928 || from_0_funding_key_1 == from_1_funding_key_0
5929 || from_0_funding_key_1 == from_1_funding_key_1 {
5930 panic!("Funding pubkeys aren't unique");
5933 // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
5934 mine_transaction(&nodes[0], &local_txn_1[0]);
5935 connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
5936 check_closed_broadcast!(nodes[0], true);
5937 check_added_monitors!(nodes[0], 1);
5939 let htlc_timeout = {
5940 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5941 assert_eq!(node_txn[1].input.len(), 1);
5942 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5943 check_spends!(node_txn[1], local_txn_1[0]);
5947 mine_transaction(&nodes[0], &htlc_timeout);
5948 connect_blocks(&nodes[0], BREAKDOWN_TIMEOUT as u32 - 1);
5949 expect_payment_failed!(nodes[0], our_payment_hash, true);
5951 // Verify that A is able to spend its own HTLC-Timeout tx thanks to spendable output event given back by its ChannelMonitor
5952 let new_keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
5953 let spend_txn = check_spendable_outputs!(nodes[0], new_keys_manager);
5954 assert_eq!(spend_txn.len(), 3);
5955 check_spends!(spend_txn[0], local_txn_1[0]);
5956 assert_eq!(spend_txn[1].input.len(), 1);
5957 check_spends!(spend_txn[1], htlc_timeout);
5958 assert_eq!(spend_txn[1].input[0].sequence, BREAKDOWN_TIMEOUT as u32);
5959 assert_eq!(spend_txn[2].input.len(), 2);
5960 check_spends!(spend_txn[2], local_txn_1[0], htlc_timeout);
5961 assert!(spend_txn[2].input[0].sequence == BREAKDOWN_TIMEOUT as u32 ||
5962 spend_txn[2].input[1].sequence == BREAKDOWN_TIMEOUT as u32);
5966 fn test_static_output_closing_tx() {
5967 let chanmon_cfgs = create_chanmon_cfgs(2);
5968 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5969 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5970 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5972 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5974 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
5975 let closing_tx = close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true).2;
5977 mine_transaction(&nodes[0], &closing_tx);
5978 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
5980 let spend_txn = check_spendable_outputs!(nodes[0], node_cfgs[0].keys_manager);
5981 assert_eq!(spend_txn.len(), 1);
5982 check_spends!(spend_txn[0], closing_tx);
5984 mine_transaction(&nodes[1], &closing_tx);
5985 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
5987 let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
5988 assert_eq!(spend_txn.len(), 1);
5989 check_spends!(spend_txn[0], closing_tx);
5992 fn do_htlc_claim_local_commitment_only(use_dust: bool) {
5993 let chanmon_cfgs = create_chanmon_cfgs(2);
5994 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5995 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5996 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5997 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5999 let (our_payment_preimage, _, _) = route_payment(&nodes[0], &[&nodes[1]], if use_dust { 50000 } else { 3000000 });
6001 // Claim the payment, but don't deliver A's commitment_signed, resulting in the HTLC only being
6002 // present in B's local commitment transaction, but none of A's commitment transactions.
6003 assert!(nodes[1].node.claim_funds(our_payment_preimage));
6004 check_added_monitors!(nodes[1], 1);
6006 let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6007 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fulfill_htlcs[0]);
6008 let events = nodes[0].node.get_and_clear_pending_events();
6009 assert_eq!(events.len(), 1);
6011 Event::PaymentSent { payment_preimage } => {
6012 assert_eq!(payment_preimage, our_payment_preimage);
6014 _ => panic!("Unexpected event"),
6017 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_updates.commitment_signed);
6018 check_added_monitors!(nodes[0], 1);
6019 let as_updates = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6020 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_updates.0);
6021 check_added_monitors!(nodes[1], 1);
6023 let starting_block = nodes[1].best_block_info();
6024 let mut block = Block {
6025 header: BlockHeader { version: 0x20000000, prev_blockhash: starting_block.0, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
6028 for _ in starting_block.1 + 1..TEST_FINAL_CLTV - CLTV_CLAIM_BUFFER + starting_block.1 + 2 {
6029 connect_block(&nodes[1], &block);
6030 block.header.prev_blockhash = block.block_hash();
6032 test_txn_broadcast(&nodes[1], &chan, None, if use_dust { HTLCType::NONE } else { HTLCType::SUCCESS });
6033 check_closed_broadcast!(nodes[1], true);
6034 check_added_monitors!(nodes[1], 1);
6037 fn do_htlc_claim_current_remote_commitment_only(use_dust: bool) {
6038 let chanmon_cfgs = create_chanmon_cfgs(2);
6039 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6040 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6041 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6042 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6043 let logger = test_utils::TestLogger::new();
6045 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1]);
6046 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6047 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();
6048 nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
6049 check_added_monitors!(nodes[0], 1);
6051 let _as_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6053 // As far as A is concerned, the HTLC is now present only in the latest remote commitment
6054 // transaction, however it is not in A's latest local commitment, so we can just broadcast that
6055 // to "time out" the HTLC.
6057 let starting_block = nodes[1].best_block_info();
6058 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: starting_block.0, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6060 for _ in starting_block.1 + 1..TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + starting_block.1 + 2 {
6061 connect_block(&nodes[0], &Block { header, txdata: Vec::new()});
6062 header.prev_blockhash = header.block_hash();
6064 test_txn_broadcast(&nodes[0], &chan, None, HTLCType::NONE);
6065 check_closed_broadcast!(nodes[0], true);
6066 check_added_monitors!(nodes[0], 1);
6069 fn do_htlc_claim_previous_remote_commitment_only(use_dust: bool, check_revoke_no_close: bool) {
6070 let chanmon_cfgs = create_chanmon_cfgs(3);
6071 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
6072 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
6073 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
6074 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6076 // Fail the payment, but don't deliver A's final RAA, resulting in the HTLC only being present
6077 // in B's previous (unrevoked) commitment transaction, but none of A's commitment transactions.
6078 // Also optionally test that we *don't* fail the channel in case the commitment transaction was
6079 // actually revoked.
6080 let htlc_value = if use_dust { 50000 } else { 3000000 };
6081 let (_, our_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1]], htlc_value);
6082 assert!(nodes[1].node.fail_htlc_backwards(&our_payment_hash));
6083 expect_pending_htlcs_forwardable!(nodes[1]);
6084 check_added_monitors!(nodes[1], 1);
6086 let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6087 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fail_htlcs[0]);
6088 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_updates.commitment_signed);
6089 check_added_monitors!(nodes[0], 1);
6090 let as_updates = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6091 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_updates.0);
6092 check_added_monitors!(nodes[1], 1);
6093 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_updates.1);
6094 check_added_monitors!(nodes[1], 1);
6095 let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
6097 if check_revoke_no_close {
6098 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
6099 check_added_monitors!(nodes[0], 1);
6102 let starting_block = nodes[1].best_block_info();
6103 let mut block = Block {
6104 header: BlockHeader { version: 0x20000000, prev_blockhash: starting_block.0, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
6107 for _ in starting_block.1 + 1..TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + CHAN_CONFIRM_DEPTH + 2 {
6108 connect_block(&nodes[0], &block);
6109 block.header.prev_blockhash = block.block_hash();
6111 if !check_revoke_no_close {
6112 test_txn_broadcast(&nodes[0], &chan, None, HTLCType::NONE);
6113 check_closed_broadcast!(nodes[0], true);
6114 check_added_monitors!(nodes[0], 1);
6116 expect_payment_failed!(nodes[0], our_payment_hash, true);
6120 // Test that we close channels on-chain when broadcastable HTLCs reach their timeout window.
6121 // There are only a few cases to test here:
6122 // * its not really normative behavior, but we test that below-dust HTLCs "included" in
6123 // broadcastable commitment transactions result in channel closure,
6124 // * its included in an unrevoked-but-previous remote commitment transaction,
6125 // * its included in the latest remote or local commitment transactions.
6126 // We test each of the three possible commitment transactions individually and use both dust and
6128 // Note that we don't bother testing both outbound and inbound HTLC failures for each case, and we
6129 // assume they are handled the same across all six cases, as both outbound and inbound failures are
6130 // tested for at least one of the cases in other tests.
6132 fn htlc_claim_single_commitment_only_a() {
6133 do_htlc_claim_local_commitment_only(true);
6134 do_htlc_claim_local_commitment_only(false);
6136 do_htlc_claim_current_remote_commitment_only(true);
6137 do_htlc_claim_current_remote_commitment_only(false);
6141 fn htlc_claim_single_commitment_only_b() {
6142 do_htlc_claim_previous_remote_commitment_only(true, false);
6143 do_htlc_claim_previous_remote_commitment_only(false, false);
6144 do_htlc_claim_previous_remote_commitment_only(true, true);
6145 do_htlc_claim_previous_remote_commitment_only(false, true);
6150 fn bolt2_open_channel_sending_node_checks_part1() { //This test needs to be on its own as we are catching a panic
6151 let chanmon_cfgs = create_chanmon_cfgs(2);
6152 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6153 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6154 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6155 //Force duplicate channel ids
6156 for node in nodes.iter() {
6157 *node.keys_manager.override_channel_id_priv.lock().unwrap() = Some([0; 32]);
6160 // BOLT #2 spec: Sending node must ensure temporary_channel_id is unique from any other channel ID with the same peer.
6161 let channel_value_satoshis=10000;
6162 let push_msat=10001;
6163 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).unwrap();
6164 let node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
6165 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &node0_to_1_send_open_channel);
6167 //Create a second channel with a channel_id collision
6168 assert!(nodes[0].node.create_channel(nodes[0].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
6172 fn bolt2_open_channel_sending_node_checks_part2() {
6173 let chanmon_cfgs = create_chanmon_cfgs(2);
6174 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6175 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6176 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6178 // BOLT #2 spec: Sending node must set funding_satoshis to less than 2^24 satoshis
6179 let channel_value_satoshis=2^24;
6180 let push_msat=10001;
6181 assert!(nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
6183 // BOLT #2 spec: Sending node must set push_msat to equal or less than 1000 * funding_satoshis
6184 let channel_value_satoshis=10000;
6185 // Test when push_msat is equal to 1000 * funding_satoshis.
6186 let push_msat=1000*channel_value_satoshis+1;
6187 assert!(nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
6189 // BOLT #2 spec: Sending node must set set channel_reserve_satoshis greater than or equal to dust_limit_satoshis
6190 let channel_value_satoshis=10000;
6191 let push_msat=10001;
6192 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
6193 let node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
6194 assert!(node0_to_1_send_open_channel.channel_reserve_satoshis>=node0_to_1_send_open_channel.dust_limit_satoshis);
6196 // BOLT #2 spec: Sending node must set undefined bits in channel_flags to 0
6197 // 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
6198 assert!(node0_to_1_send_open_channel.channel_flags<=1);
6200 // 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.
6201 assert!(BREAKDOWN_TIMEOUT>0);
6202 assert!(node0_to_1_send_open_channel.to_self_delay==BREAKDOWN_TIMEOUT);
6204 // BOLT #2 spec: Sending node must ensure the chain_hash value identifies the chain it wishes to open the channel within.
6205 let chain_hash=genesis_block(Network::Testnet).header.block_hash();
6206 assert_eq!(node0_to_1_send_open_channel.chain_hash,chain_hash);
6208 // 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.
6209 assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.funding_pubkey.serialize()).is_ok());
6210 assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.revocation_basepoint.serialize()).is_ok());
6211 assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.htlc_basepoint.serialize()).is_ok());
6212 assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.payment_point.serialize()).is_ok());
6213 assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.delayed_payment_basepoint.serialize()).is_ok());
6217 fn bolt2_open_channel_sane_dust_limit() {
6218 let chanmon_cfgs = create_chanmon_cfgs(2);
6219 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6220 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6221 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6223 let channel_value_satoshis=1000000;
6224 let push_msat=10001;
6225 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).unwrap();
6226 let mut node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
6227 node0_to_1_send_open_channel.dust_limit_satoshis = 661;
6228 node0_to_1_send_open_channel.channel_reserve_satoshis = 100001;
6230 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &node0_to_1_send_open_channel);
6231 let events = nodes[1].node.get_and_clear_pending_msg_events();
6232 let err_msg = match events[0] {
6233 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id: _ } => {
6236 _ => panic!("Unexpected event"),
6238 assert_eq!(err_msg.data, "dust_limit_satoshis (661) is greater than the implementation limit (660)");
6241 // Test that if we fail to send an HTLC that is being freed from the holding cell, and the HTLC
6242 // originated from our node, its failure is surfaced to the user. We trigger this failure to
6243 // free the HTLC by increasing our fee while the HTLC is in the holding cell such that the HTLC
6244 // is no longer affordable once it's freed.
6246 fn test_fail_holding_cell_htlc_upon_free() {
6247 let chanmon_cfgs = create_chanmon_cfgs(2);
6248 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6249 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6250 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6251 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6252 let logger = test_utils::TestLogger::new();
6254 // First nodes[0] generates an update_fee, setting the channel's
6255 // pending_update_fee.
6256 nodes[0].node.update_fee(chan.2, get_feerate!(nodes[0], chan.2) + 20).unwrap();
6257 check_added_monitors!(nodes[0], 1);
6259 let events = nodes[0].node.get_and_clear_pending_msg_events();
6260 assert_eq!(events.len(), 1);
6261 let (update_msg, commitment_signed) = match events[0] {
6262 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
6263 (update_fee.as_ref(), commitment_signed)
6265 _ => panic!("Unexpected event"),
6268 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
6270 let mut chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6271 let channel_reserve = chan_stat.channel_reserve_msat;
6272 let feerate = get_feerate!(nodes[0], chan.2);
6274 // 2* and +1 HTLCs on the commit tx fee calculation for the fee spike reserve.
6275 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6276 let max_can_send = 5000000 - channel_reserve - 2*commit_tx_fee_msat(feerate, 1 + 1);
6277 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6278 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();
6280 // Send a payment which passes reserve checks but gets stuck in the holding cell.
6281 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6282 chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6283 assert_eq!(chan_stat.holding_cell_outbound_amount_msat, max_can_send);
6285 // Flush the pending fee update.
6286 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
6287 let (as_revoke_and_ack, _) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6288 check_added_monitors!(nodes[1], 1);
6289 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_revoke_and_ack);
6290 check_added_monitors!(nodes[0], 1);
6292 // Upon receipt of the RAA, there will be an attempt to resend the holding cell
6293 // HTLC, but now that the fee has been raised the payment will now fail, causing
6294 // us to surface its failure to the user.
6295 chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6296 assert_eq!(chan_stat.holding_cell_outbound_amount_msat, 0);
6297 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);
6298 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 {}",
6299 hex::encode(our_payment_hash.0), chan_stat.channel_reserve_msat, hex::encode(chan.2));
6300 nodes[0].logger.assert_log("lightning::ln::channel".to_string(), failure_log.to_string(), 1);
6302 // Check that the payment failed to be sent out.
6303 let events = nodes[0].node.get_and_clear_pending_events();
6304 assert_eq!(events.len(), 1);
6306 &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, ref error_code, ref error_data } => {
6307 assert_eq!(our_payment_hash.clone(), *payment_hash);
6308 assert_eq!(*rejected_by_dest, false);
6309 assert_eq!(*error_code, None);
6310 assert_eq!(*error_data, None);
6312 _ => panic!("Unexpected event"),
6316 // Test that if multiple HTLCs are released from the holding cell and one is
6317 // valid but the other is no longer valid upon release, the valid HTLC can be
6318 // successfully completed while the other one fails as expected.
6320 fn test_free_and_fail_holding_cell_htlcs() {
6321 let chanmon_cfgs = create_chanmon_cfgs(2);
6322 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6323 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6324 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6325 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6326 let logger = test_utils::TestLogger::new();
6328 // First nodes[0] generates an update_fee, setting the channel's
6329 // pending_update_fee.
6330 nodes[0].node.update_fee(chan.2, get_feerate!(nodes[0], chan.2) + 200).unwrap();
6331 check_added_monitors!(nodes[0], 1);
6333 let events = nodes[0].node.get_and_clear_pending_msg_events();
6334 assert_eq!(events.len(), 1);
6335 let (update_msg, commitment_signed) = match events[0] {
6336 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
6337 (update_fee.as_ref(), commitment_signed)
6339 _ => panic!("Unexpected event"),
6342 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
6344 let mut chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6345 let channel_reserve = chan_stat.channel_reserve_msat;
6346 let feerate = get_feerate!(nodes[0], chan.2);
6348 // 2* and +1 HTLCs on the commit tx fee calculation for the fee spike reserve.
6349 let (payment_preimage_1, payment_hash_1, payment_secret_1) = get_payment_preimage_hash!(nodes[1]);
6351 let (_, payment_hash_2, payment_secret_2) = get_payment_preimage_hash!(nodes[1]);
6352 let amt_2 = 5000000 - channel_reserve - 2*commit_tx_fee_msat(feerate, 2 + 1) - amt_1;
6353 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6354 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();
6355 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();
6357 // Send 2 payments which pass reserve checks but get stuck in the holding cell.
6358 nodes[0].node.send_payment(&route_1, payment_hash_1, &Some(payment_secret_1)).unwrap();
6359 chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6360 assert_eq!(chan_stat.holding_cell_outbound_amount_msat, amt_1);
6361 nodes[0].node.send_payment(&route_2, payment_hash_2, &Some(payment_secret_2)).unwrap();
6362 chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6363 assert_eq!(chan_stat.holding_cell_outbound_amount_msat, amt_1 + amt_2);
6365 // Flush the pending fee update.
6366 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
6367 let (revoke_and_ack, commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6368 check_added_monitors!(nodes[1], 1);
6369 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_and_ack);
6370 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
6371 check_added_monitors!(nodes[0], 2);
6373 // Upon receipt of the RAA, there will be an attempt to resend the holding cell HTLCs,
6374 // but now that the fee has been raised the second payment will now fail, causing us
6375 // to surface its failure to the user. The first payment should succeed.
6376 chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6377 assert_eq!(chan_stat.holding_cell_outbound_amount_msat, 0);
6378 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);
6379 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 {}",
6380 hex::encode(payment_hash_2.0), chan_stat.channel_reserve_msat, hex::encode(chan.2));
6381 nodes[0].logger.assert_log("lightning::ln::channel".to_string(), failure_log.to_string(), 1);
6383 // Check that the second payment failed to be sent out.
6384 let events = nodes[0].node.get_and_clear_pending_events();
6385 assert_eq!(events.len(), 1);
6387 &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, ref error_code, ref error_data } => {
6388 assert_eq!(payment_hash_2.clone(), *payment_hash);
6389 assert_eq!(*rejected_by_dest, false);
6390 assert_eq!(*error_code, None);
6391 assert_eq!(*error_data, None);
6393 _ => panic!("Unexpected event"),
6396 // Complete the first payment and the RAA from the fee update.
6397 let (payment_event, send_raa_event) = {
6398 let mut msgs = nodes[0].node.get_and_clear_pending_msg_events();
6399 assert_eq!(msgs.len(), 2);
6400 (SendEvent::from_event(msgs.remove(0)), msgs.remove(0))
6402 let raa = match send_raa_event {
6403 MessageSendEvent::SendRevokeAndACK { msg, .. } => msg,
6404 _ => panic!("Unexpected event"),
6406 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &raa);
6407 check_added_monitors!(nodes[1], 1);
6408 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6409 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6410 let events = nodes[1].node.get_and_clear_pending_events();
6411 assert_eq!(events.len(), 1);
6413 Event::PendingHTLCsForwardable { .. } => {},
6414 _ => panic!("Unexpected event"),
6416 nodes[1].node.process_pending_htlc_forwards();
6417 let events = nodes[1].node.get_and_clear_pending_events();
6418 assert_eq!(events.len(), 1);
6420 Event::PaymentReceived { .. } => {},
6421 _ => panic!("Unexpected event"),
6423 nodes[1].node.claim_funds(payment_preimage_1);
6424 check_added_monitors!(nodes[1], 1);
6425 let update_msgs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6426 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_msgs.update_fulfill_htlcs[0]);
6427 commitment_signed_dance!(nodes[0], nodes[1], update_msgs.commitment_signed, false, true);
6428 let events = nodes[0].node.get_and_clear_pending_events();
6429 assert_eq!(events.len(), 1);
6431 Event::PaymentSent { ref payment_preimage } => {
6432 assert_eq!(*payment_preimage, payment_preimage_1);
6434 _ => panic!("Unexpected event"),
6438 // Test that if we fail to forward an HTLC that is being freed from the holding cell that the
6439 // HTLC is failed backwards. We trigger this failure to forward the freed HTLC by increasing
6440 // our fee while the HTLC is in the holding cell such that the HTLC is no longer affordable
6443 fn test_fail_holding_cell_htlc_upon_free_multihop() {
6444 let chanmon_cfgs = create_chanmon_cfgs(3);
6445 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
6446 // When this test was written, the default base fee floated based on the HTLC count.
6447 // It is now fixed, so we simply set the fee to the expected value here.
6448 let mut config = test_default_channel_config();
6449 config.channel_options.forwarding_fee_base_msat = 196;
6450 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[Some(config.clone()), Some(config.clone()), Some(config.clone())]);
6451 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
6452 let chan_0_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6453 let chan_1_2 = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6454 let logger = test_utils::TestLogger::new();
6456 // First nodes[1] generates an update_fee, setting the channel's
6457 // pending_update_fee.
6458 nodes[1].node.update_fee(chan_1_2.2, get_feerate!(nodes[1], chan_1_2.2) + 20).unwrap();
6459 check_added_monitors!(nodes[1], 1);
6461 let events = nodes[1].node.get_and_clear_pending_msg_events();
6462 assert_eq!(events.len(), 1);
6463 let (update_msg, commitment_signed) = match events[0] {
6464 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
6465 (update_fee.as_ref(), commitment_signed)
6467 _ => panic!("Unexpected event"),
6470 nodes[2].node.handle_update_fee(&nodes[1].node.get_our_node_id(), update_msg.unwrap());
6472 let mut chan_stat = get_channel_value_stat!(nodes[0], chan_0_1.2);
6473 let channel_reserve = chan_stat.channel_reserve_msat;
6474 let feerate = get_feerate!(nodes[0], chan_0_1.2);
6476 // Send a payment which passes reserve checks but gets stuck in the holding cell.
6478 let total_routing_fee_msat = (nodes.len() - 2) as u64 * feemsat;
6479 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[2]);
6480 let max_can_send = 5000000 - channel_reserve - 2*commit_tx_fee_msat(feerate, 1 + 1) - total_routing_fee_msat;
6481 let payment_event = {
6482 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6483 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();
6484 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6485 check_added_monitors!(nodes[0], 1);
6487 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
6488 assert_eq!(events.len(), 1);
6490 SendEvent::from_event(events.remove(0))
6492 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6493 check_added_monitors!(nodes[1], 0);
6494 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6495 expect_pending_htlcs_forwardable!(nodes[1]);
6497 chan_stat = get_channel_value_stat!(nodes[1], chan_1_2.2);
6498 assert_eq!(chan_stat.holding_cell_outbound_amount_msat, max_can_send);
6500 // Flush the pending fee update.
6501 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), commitment_signed);
6502 let (raa, commitment_signed) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
6503 check_added_monitors!(nodes[2], 1);
6504 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &raa);
6505 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &commitment_signed);
6506 check_added_monitors!(nodes[1], 2);
6508 // A final RAA message is generated to finalize the fee update.
6509 let events = nodes[1].node.get_and_clear_pending_msg_events();
6510 assert_eq!(events.len(), 1);
6512 let raa_msg = match &events[0] {
6513 &MessageSendEvent::SendRevokeAndACK { ref msg, .. } => {
6516 _ => panic!("Unexpected event"),
6519 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &raa_msg);
6520 check_added_monitors!(nodes[2], 1);
6521 assert!(nodes[2].node.get_and_clear_pending_msg_events().is_empty());
6523 // nodes[1]'s ChannelManager will now signal that we have HTLC forwards to process.
6524 let process_htlc_forwards_event = nodes[1].node.get_and_clear_pending_events();
6525 assert_eq!(process_htlc_forwards_event.len(), 1);
6526 match &process_htlc_forwards_event[0] {
6527 &Event::PendingHTLCsForwardable { .. } => {},
6528 _ => panic!("Unexpected event"),
6531 // In response, we call ChannelManager's process_pending_htlc_forwards
6532 nodes[1].node.process_pending_htlc_forwards();
6533 check_added_monitors!(nodes[1], 1);
6535 // This causes the HTLC to be failed backwards.
6536 let fail_event = nodes[1].node.get_and_clear_pending_msg_events();
6537 assert_eq!(fail_event.len(), 1);
6538 let (fail_msg, commitment_signed) = match &fail_event[0] {
6539 &MessageSendEvent::UpdateHTLCs { ref updates, .. } => {
6540 assert_eq!(updates.update_add_htlcs.len(), 0);
6541 assert_eq!(updates.update_fulfill_htlcs.len(), 0);
6542 assert_eq!(updates.update_fail_malformed_htlcs.len(), 0);
6543 assert_eq!(updates.update_fail_htlcs.len(), 1);
6544 (updates.update_fail_htlcs[0].clone(), updates.commitment_signed.clone())
6546 _ => panic!("Unexpected event"),
6549 // Pass the failure messages back to nodes[0].
6550 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
6551 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
6553 // Complete the HTLC failure+removal process.
6554 let (raa, commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6555 check_added_monitors!(nodes[0], 1);
6556 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &raa);
6557 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commitment_signed);
6558 check_added_monitors!(nodes[1], 2);
6559 let final_raa_event = nodes[1].node.get_and_clear_pending_msg_events();
6560 assert_eq!(final_raa_event.len(), 1);
6561 let raa = match &final_raa_event[0] {
6562 &MessageSendEvent::SendRevokeAndACK { ref msg, .. } => msg.clone(),
6563 _ => panic!("Unexpected event"),
6565 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &raa);
6566 expect_payment_failure_chan_update!(nodes[0], chan_1_2.0.contents.short_channel_id, false);
6567 expect_payment_failed!(nodes[0], our_payment_hash, false);
6568 check_added_monitors!(nodes[0], 1);
6571 // BOLT 2 Requirements for the Sender when constructing and sending an update_add_htlc message.
6572 // 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.
6573 //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.
6576 fn test_update_add_htlc_bolt2_sender_value_below_minimum_msat() {
6577 //BOLT2 Requirement: MUST NOT offer amount_msat below the receiving node's htlc_minimum_msat (same validation check catches both of these)
6578 let chanmon_cfgs = create_chanmon_cfgs(2);
6579 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6580 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6581 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6582 let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6584 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6585 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6586 let logger = test_utils::TestLogger::new();
6587 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();
6588 route.paths[0][0].fee_msat = 100;
6590 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
6591 assert!(regex::Regex::new(r"Cannot send less than their minimum HTLC value \(\d+\)").unwrap().is_match(err)));
6592 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6593 nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot send less than their minimum HTLC value".to_string(), 1);
6597 fn test_update_add_htlc_bolt2_sender_zero_value_msat() {
6598 //BOLT2 Requirement: MUST offer amount_msat greater than 0.
6599 let chanmon_cfgs = create_chanmon_cfgs(2);
6600 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6601 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6602 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6603 let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6604 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6606 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6607 let logger = test_utils::TestLogger::new();
6608 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();
6609 route.paths[0][0].fee_msat = 0;
6610 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
6611 assert_eq!(err, "Cannot send 0-msat HTLC"));
6613 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6614 nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot send 0-msat HTLC".to_string(), 1);
6618 fn test_update_add_htlc_bolt2_receiver_zero_value_msat() {
6619 //BOLT2 Requirement: MUST offer amount_msat greater than 0.
6620 let chanmon_cfgs = create_chanmon_cfgs(2);
6621 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6622 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6623 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6624 let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6626 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6627 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6628 let logger = test_utils::TestLogger::new();
6629 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();
6630 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6631 check_added_monitors!(nodes[0], 1);
6632 let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6633 updates.update_add_htlcs[0].amount_msat = 0;
6635 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6636 nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Remote side tried to send a 0-msat HTLC".to_string(), 1);
6637 check_closed_broadcast!(nodes[1], true).unwrap();
6638 check_added_monitors!(nodes[1], 1);
6642 fn test_update_add_htlc_bolt2_sender_cltv_expiry_too_high() {
6643 //BOLT 2 Requirement: MUST set cltv_expiry less than 500000000.
6644 //It is enforced when constructing a route.
6645 let chanmon_cfgs = create_chanmon_cfgs(2);
6646 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6647 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6648 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6649 let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 0, InitFeatures::known(), InitFeatures::known());
6650 let logger = test_utils::TestLogger::new();
6652 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6654 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6655 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();
6656 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::RouteError { ref err },
6657 assert_eq!(err, &"Channel CLTV overflowed?"));
6661 fn test_update_add_htlc_bolt2_sender_exceed_max_htlc_num_and_htlc_id_increment() {
6662 //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.
6663 //BOLT 2 Requirement: for the first HTLC it offers MUST set id to 0.
6664 //BOLT 2 Requirement: MUST increase the value of id by 1 for each successive offer.
6665 let chanmon_cfgs = create_chanmon_cfgs(2);
6666 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6667 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6668 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6669 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 0, InitFeatures::known(), InitFeatures::known());
6670 let max_accepted_htlcs = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().counterparty_max_accepted_htlcs as u64;
6672 let logger = test_utils::TestLogger::new();
6673 for i in 0..max_accepted_htlcs {
6674 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6675 let payment_event = {
6676 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6677 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();
6678 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6679 check_added_monitors!(nodes[0], 1);
6681 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
6682 assert_eq!(events.len(), 1);
6683 if let MessageSendEvent::UpdateHTLCs { node_id: _, updates: msgs::CommitmentUpdate{ update_add_htlcs: ref htlcs, .. }, } = events[0] {
6684 assert_eq!(htlcs[0].htlc_id, i);
6688 SendEvent::from_event(events.remove(0))
6690 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6691 check_added_monitors!(nodes[1], 0);
6692 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6694 expect_pending_htlcs_forwardable!(nodes[1]);
6695 expect_payment_received!(nodes[1], our_payment_hash, our_payment_secret, 100000);
6697 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6698 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6699 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();
6700 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
6701 assert!(regex::Regex::new(r"Cannot push more than their max accepted HTLCs \(\d+\)").unwrap().is_match(err)));
6703 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6704 nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot push more than their max accepted HTLCs".to_string(), 1);
6708 fn test_update_add_htlc_bolt2_sender_exceed_max_htlc_value_in_flight() {
6709 //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.
6710 let chanmon_cfgs = create_chanmon_cfgs(2);
6711 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6712 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6713 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6714 let channel_value = 100000;
6715 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, channel_value, 0, InitFeatures::known(), InitFeatures::known());
6716 let max_in_flight = get_channel_value_stat!(nodes[0], chan.2).counterparty_max_htlc_value_in_flight_msat;
6718 send_payment(&nodes[0], &vec!(&nodes[1])[..], max_in_flight);
6720 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6721 // Manually create a route over our max in flight (which our router normally automatically
6723 let route = Route { paths: vec![vec![RouteHop {
6724 pubkey: nodes[1].node.get_our_node_id(), node_features: NodeFeatures::known(), channel_features: ChannelFeatures::known(),
6725 short_channel_id: nodes[1].node.list_usable_channels()[0].short_channel_id.unwrap(),
6726 fee_msat: max_in_flight + 1, cltv_expiry_delta: TEST_FINAL_CLTV
6728 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
6729 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)));
6731 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6732 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);
6734 send_payment(&nodes[0], &[&nodes[1]], max_in_flight);
6737 // BOLT 2 Requirements for the Receiver when handling an update_add_htlc message.
6739 fn test_update_add_htlc_bolt2_receiver_check_amount_received_more_than_min() {
6740 //BOLT2 Requirement: receiving an amount_msat equal to 0, OR less than its own htlc_minimum_msat -> SHOULD fail the channel.
6741 let chanmon_cfgs = create_chanmon_cfgs(2);
6742 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6743 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6744 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6745 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6746 let htlc_minimum_msat: u64;
6748 let chan_lock = nodes[0].node.channel_state.lock().unwrap();
6749 let channel = chan_lock.by_id.get(&chan.2).unwrap();
6750 htlc_minimum_msat = channel.get_holder_htlc_minimum_msat();
6753 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6754 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6755 let logger = test_utils::TestLogger::new();
6756 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();
6757 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6758 check_added_monitors!(nodes[0], 1);
6759 let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6760 updates.update_add_htlcs[0].amount_msat = htlc_minimum_msat-1;
6761 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6762 assert!(nodes[1].node.list_channels().is_empty());
6763 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6764 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()));
6765 check_added_monitors!(nodes[1], 1);
6769 fn test_update_add_htlc_bolt2_receiver_sender_can_afford_amount_sent() {
6770 //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
6771 let chanmon_cfgs = create_chanmon_cfgs(2);
6772 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6773 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6774 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6775 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6776 let logger = test_utils::TestLogger::new();
6778 let chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6779 let channel_reserve = chan_stat.channel_reserve_msat;
6780 let feerate = get_feerate!(nodes[0], chan.2);
6781 // The 2* and +1 are for the fee spike reserve.
6782 let commit_tx_fee_outbound = 2 * commit_tx_fee_msat(feerate, 1 + 1);
6784 let max_can_send = 5000000 - channel_reserve - commit_tx_fee_outbound;
6785 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6786 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6787 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();
6788 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6789 check_added_monitors!(nodes[0], 1);
6790 let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6792 // Even though channel-initiator senders are required to respect the fee_spike_reserve,
6793 // at this time channel-initiatee receivers are not required to enforce that senders
6794 // respect the fee_spike_reserve.
6795 updates.update_add_htlcs[0].amount_msat = max_can_send + commit_tx_fee_outbound + 1;
6796 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6798 assert!(nodes[1].node.list_channels().is_empty());
6799 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6800 assert_eq!(err_msg.data, "Remote HTLC add would put them under remote reserve value");
6801 check_added_monitors!(nodes[1], 1);
6805 fn test_update_add_htlc_bolt2_receiver_check_max_htlc_limit() {
6806 //BOLT 2 Requirement: if a sending node adds more than its max_accepted_htlcs HTLCs to its local commitment transaction: SHOULD fail the channel
6807 //BOLT 2 Requirement: MUST allow multiple HTLCs with the same payment_hash.
6808 let chanmon_cfgs = create_chanmon_cfgs(2);
6809 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6810 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6811 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6812 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6813 let logger = test_utils::TestLogger::new();
6815 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6816 let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
6818 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6819 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();
6821 let cur_height = nodes[0].node.best_block.read().unwrap().height() + 1;
6822 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::signing_only(), &route.paths[0], &session_priv).unwrap();
6823 let (onion_payloads, _htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 3999999, &Some(our_payment_secret), cur_height, &None).unwrap();
6824 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &our_payment_hash);
6826 let mut msg = msgs::UpdateAddHTLC {
6830 payment_hash: our_payment_hash,
6831 cltv_expiry: htlc_cltv,
6832 onion_routing_packet: onion_packet.clone(),
6835 for i in 0..super::channel::OUR_MAX_HTLCS {
6836 msg.htlc_id = i as u64;
6837 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
6839 msg.htlc_id = (super::channel::OUR_MAX_HTLCS) as u64;
6840 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
6842 assert!(nodes[1].node.list_channels().is_empty());
6843 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6844 assert!(regex::Regex::new(r"Remote tried to push more than our max accepted HTLCs \(\d+\)").unwrap().is_match(err_msg.data.as_str()));
6845 check_added_monitors!(nodes[1], 1);
6849 fn test_update_add_htlc_bolt2_receiver_check_max_in_flight_msat() {
6850 //OR adds more than its max_htlc_value_in_flight_msat worth of offered HTLCs to its local commitment transaction: SHOULD fail the channel
6851 let chanmon_cfgs = create_chanmon_cfgs(2);
6852 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6853 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6854 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6855 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
6856 let logger = test_utils::TestLogger::new();
6858 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6859 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6860 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();
6861 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6862 check_added_monitors!(nodes[0], 1);
6863 let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6864 updates.update_add_htlcs[0].amount_msat = get_channel_value_stat!(nodes[1], chan.2).counterparty_max_htlc_value_in_flight_msat + 1;
6865 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6867 assert!(nodes[1].node.list_channels().is_empty());
6868 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6869 assert!(regex::Regex::new("Remote HTLC add would put them over our max HTLC value").unwrap().is_match(err_msg.data.as_str()));
6870 check_added_monitors!(nodes[1], 1);
6874 fn test_update_add_htlc_bolt2_receiver_check_cltv_expiry() {
6875 //BOLT2 Requirement: if sending node sets cltv_expiry to greater or equal to 500000000: SHOULD fail the channel.
6876 let chanmon_cfgs = create_chanmon_cfgs(2);
6877 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6878 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6879 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6880 let logger = test_utils::TestLogger::new();
6882 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6883 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6884 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6885 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();
6886 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6887 check_added_monitors!(nodes[0], 1);
6888 let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6889 updates.update_add_htlcs[0].cltv_expiry = 500000000;
6890 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6892 assert!(nodes[1].node.list_channels().is_empty());
6893 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6894 assert_eq!(err_msg.data,"Remote provided CLTV expiry in seconds instead of block height");
6895 check_added_monitors!(nodes[1], 1);
6899 fn test_update_add_htlc_bolt2_receiver_check_repeated_id_ignore() {
6900 //BOLT 2 requirement: if the sender did not previously acknowledge the commitment of that HTLC: MUST ignore a repeated id value after a reconnection.
6901 // We test this by first testing that that repeated HTLCs pass commitment signature checks
6902 // after disconnect and that non-sequential htlc_ids result in a channel failure.
6903 let chanmon_cfgs = create_chanmon_cfgs(2);
6904 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6905 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6906 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6907 let logger = test_utils::TestLogger::new();
6909 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6910 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6911 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6912 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 1000000, TEST_FINAL_CLTV, &logger).unwrap();
6913 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6914 check_added_monitors!(nodes[0], 1);
6915 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6916 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6918 //Disconnect and Reconnect
6919 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
6920 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
6921 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
6922 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
6923 assert_eq!(reestablish_1.len(), 1);
6924 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
6925 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
6926 assert_eq!(reestablish_2.len(), 1);
6927 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
6928 handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
6929 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
6930 handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
6933 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6934 assert_eq!(updates.commitment_signed.htlc_signatures.len(), 1);
6935 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &updates.commitment_signed);
6936 check_added_monitors!(nodes[1], 1);
6937 let _bs_responses = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6939 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6941 assert!(nodes[1].node.list_channels().is_empty());
6942 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6943 assert!(regex::Regex::new(r"Remote skipped HTLC ID \(skipped ID: \d+\)").unwrap().is_match(err_msg.data.as_str()));
6944 check_added_monitors!(nodes[1], 1);
6948 fn test_update_fulfill_htlc_bolt2_update_fulfill_htlc_before_commitment() {
6949 //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.
6951 let chanmon_cfgs = create_chanmon_cfgs(2);
6952 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6953 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6954 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6955 let logger = test_utils::TestLogger::new();
6956 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6957 let (our_payment_preimage, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6958 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6959 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 1000000, TEST_FINAL_CLTV, &logger).unwrap();
6960 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6962 check_added_monitors!(nodes[0], 1);
6963 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6964 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6966 let update_msg = msgs::UpdateFulfillHTLC{
6969 payment_preimage: our_payment_preimage,
6972 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6974 assert!(nodes[0].node.list_channels().is_empty());
6975 let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6976 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()));
6977 check_added_monitors!(nodes[0], 1);
6981 fn test_update_fulfill_htlc_bolt2_update_fail_htlc_before_commitment() {
6982 //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.
6984 let chanmon_cfgs = create_chanmon_cfgs(2);
6985 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6986 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6987 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6988 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6989 let logger = test_utils::TestLogger::new();
6991 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6992 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6993 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();
6994 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6995 check_added_monitors!(nodes[0], 1);
6996 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6997 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6999 let update_msg = msgs::UpdateFailHTLC{
7002 reason: msgs::OnionErrorPacket { data: Vec::new()},
7005 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
7007 assert!(nodes[0].node.list_channels().is_empty());
7008 let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
7009 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()));
7010 check_added_monitors!(nodes[0], 1);
7014 fn test_update_fulfill_htlc_bolt2_update_fail_malformed_htlc_before_commitment() {
7015 //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.
7017 let chanmon_cfgs = create_chanmon_cfgs(2);
7018 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7019 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7020 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7021 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7022 let logger = test_utils::TestLogger::new();
7024 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
7025 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
7026 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();
7027 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
7028 check_added_monitors!(nodes[0], 1);
7029 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
7030 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
7031 let update_msg = msgs::UpdateFailMalformedHTLC{
7034 sha256_of_onion: [1; 32],
7035 failure_code: 0x8000,
7038 nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
7040 assert!(nodes[0].node.list_channels().is_empty());
7041 let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
7042 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()));
7043 check_added_monitors!(nodes[0], 1);
7047 fn test_update_fulfill_htlc_bolt2_incorrect_htlc_id() {
7048 //BOLT 2 Requirement: A receiving node: if the id does not correspond to an HTLC in its current commitment transaction MUST fail the channel.
7050 let chanmon_cfgs = create_chanmon_cfgs(2);
7051 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7052 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7053 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7054 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7056 let our_payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 100000).0;
7058 nodes[1].node.claim_funds(our_payment_preimage);
7059 check_added_monitors!(nodes[1], 1);
7061 let events = nodes[1].node.get_and_clear_pending_msg_events();
7062 assert_eq!(events.len(), 1);
7063 let mut update_fulfill_msg: msgs::UpdateFulfillHTLC = {
7065 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, .. } } => {
7066 assert!(update_add_htlcs.is_empty());
7067 assert_eq!(update_fulfill_htlcs.len(), 1);
7068 assert!(update_fail_htlcs.is_empty());
7069 assert!(update_fail_malformed_htlcs.is_empty());
7070 assert!(update_fee.is_none());
7071 update_fulfill_htlcs[0].clone()
7073 _ => panic!("Unexpected event"),
7077 update_fulfill_msg.htlc_id = 1;
7079 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_msg);
7081 assert!(nodes[0].node.list_channels().is_empty());
7082 let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
7083 assert_eq!(err_msg.data, "Remote tried to fulfill/fail an HTLC we couldn't find");
7084 check_added_monitors!(nodes[0], 1);
7088 fn test_update_fulfill_htlc_bolt2_wrong_preimage() {
7089 //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.
7091 let chanmon_cfgs = create_chanmon_cfgs(2);
7092 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7093 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7094 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7095 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7097 let our_payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 100000).0;
7099 nodes[1].node.claim_funds(our_payment_preimage);
7100 check_added_monitors!(nodes[1], 1);
7102 let events = nodes[1].node.get_and_clear_pending_msg_events();
7103 assert_eq!(events.len(), 1);
7104 let mut update_fulfill_msg: msgs::UpdateFulfillHTLC = {
7106 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, .. } } => {
7107 assert!(update_add_htlcs.is_empty());
7108 assert_eq!(update_fulfill_htlcs.len(), 1);
7109 assert!(update_fail_htlcs.is_empty());
7110 assert!(update_fail_malformed_htlcs.is_empty());
7111 assert!(update_fee.is_none());
7112 update_fulfill_htlcs[0].clone()
7114 _ => panic!("Unexpected event"),
7118 update_fulfill_msg.payment_preimage = PaymentPreimage([1; 32]);
7120 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_msg);
7122 assert!(nodes[0].node.list_channels().is_empty());
7123 let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
7124 assert!(regex::Regex::new(r"Remote tried to fulfill HTLC \(\d+\) with an incorrect preimage").unwrap().is_match(err_msg.data.as_str()));
7125 check_added_monitors!(nodes[0], 1);
7129 fn test_update_fulfill_htlc_bolt2_missing_badonion_bit_for_malformed_htlc_message() {
7130 //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.
7132 let chanmon_cfgs = create_chanmon_cfgs(2);
7133 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7134 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7135 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7136 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7137 let logger = test_utils::TestLogger::new();
7139 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
7140 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
7141 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();
7142 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
7143 check_added_monitors!(nodes[0], 1);
7145 let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
7146 updates.update_add_htlcs[0].onion_routing_packet.version = 1; //Produce a malformed HTLC message
7148 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
7149 check_added_monitors!(nodes[1], 0);
7150 commitment_signed_dance!(nodes[1], nodes[0], updates.commitment_signed, false, true);
7152 let events = nodes[1].node.get_and_clear_pending_msg_events();
7154 let mut update_msg: msgs::UpdateFailMalformedHTLC = {
7156 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, .. } } => {
7157 assert!(update_add_htlcs.is_empty());
7158 assert!(update_fulfill_htlcs.is_empty());
7159 assert!(update_fail_htlcs.is_empty());
7160 assert_eq!(update_fail_malformed_htlcs.len(), 1);
7161 assert!(update_fee.is_none());
7162 update_fail_malformed_htlcs[0].clone()
7164 _ => panic!("Unexpected event"),
7167 update_msg.failure_code &= !0x8000;
7168 nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
7170 assert!(nodes[0].node.list_channels().is_empty());
7171 let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
7172 assert_eq!(err_msg.data, "Got update_fail_malformed_htlc with BADONION not set");
7173 check_added_monitors!(nodes[0], 1);
7177 fn test_update_fulfill_htlc_bolt2_after_malformed_htlc_message_must_forward_update_fail_htlc() {
7178 //BOLT 2 Requirement: a receiving node which has an outgoing HTLC canceled by update_fail_malformed_htlc:
7179 // * 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.
7181 let chanmon_cfgs = create_chanmon_cfgs(3);
7182 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7183 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
7184 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7185 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7186 create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7187 let logger = test_utils::TestLogger::new();
7189 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[2]);
7192 let mut payment_event = {
7193 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
7194 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();
7195 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
7196 check_added_monitors!(nodes[0], 1);
7197 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
7198 assert_eq!(events.len(), 1);
7199 SendEvent::from_event(events.remove(0))
7201 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
7202 check_added_monitors!(nodes[1], 0);
7203 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
7204 expect_pending_htlcs_forwardable!(nodes[1]);
7205 let mut events_2 = nodes[1].node.get_and_clear_pending_msg_events();
7206 assert_eq!(events_2.len(), 1);
7207 check_added_monitors!(nodes[1], 1);
7208 payment_event = SendEvent::from_event(events_2.remove(0));
7209 assert_eq!(payment_event.msgs.len(), 1);
7212 payment_event.msgs[0].onion_routing_packet.version = 1; //Produce a malformed HTLC message
7213 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
7214 check_added_monitors!(nodes[2], 0);
7215 commitment_signed_dance!(nodes[2], nodes[1], payment_event.commitment_msg, false, true);
7217 let events_3 = nodes[2].node.get_and_clear_pending_msg_events();
7218 assert_eq!(events_3.len(), 1);
7219 let update_msg : (msgs::UpdateFailMalformedHTLC, msgs::CommitmentSigned) = {
7221 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 } } => {
7222 assert!(update_add_htlcs.is_empty());
7223 assert!(update_fulfill_htlcs.is_empty());
7224 assert!(update_fail_htlcs.is_empty());
7225 assert_eq!(update_fail_malformed_htlcs.len(), 1);
7226 assert!(update_fee.is_none());
7227 (update_fail_malformed_htlcs[0].clone(), commitment_signed.clone())
7229 _ => panic!("Unexpected event"),
7233 nodes[1].node.handle_update_fail_malformed_htlc(&nodes[2].node.get_our_node_id(), &update_msg.0);
7235 check_added_monitors!(nodes[1], 0);
7236 commitment_signed_dance!(nodes[1], nodes[2], update_msg.1, false, true);
7237 expect_pending_htlcs_forwardable!(nodes[1]);
7238 let events_4 = nodes[1].node.get_and_clear_pending_msg_events();
7239 assert_eq!(events_4.len(), 1);
7241 //Confirm that handlinge the update_malformed_htlc message produces an update_fail_htlc message to be forwarded back along the route
7243 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, .. } } => {
7244 assert!(update_add_htlcs.is_empty());
7245 assert!(update_fulfill_htlcs.is_empty());
7246 assert_eq!(update_fail_htlcs.len(), 1);
7247 assert!(update_fail_malformed_htlcs.is_empty());
7248 assert!(update_fee.is_none());
7250 _ => panic!("Unexpected event"),
7253 check_added_monitors!(nodes[1], 1);
7256 fn do_test_failure_delay_dust_htlc_local_commitment(announce_latest: bool) {
7257 // Dust-HTLC failure updates must be delayed until failure-trigger tx (in this case local commitment) reach ANTI_REORG_DELAY
7258 // 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
7259 // HTLC could have been removed from lastest local commitment tx but still valid until we get remote RAA
7261 let mut chanmon_cfgs = create_chanmon_cfgs(2);
7262 chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
7263 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7264 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7265 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7266 let chan =create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7268 let bs_dust_limit = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().holder_dust_limit_satoshis;
7270 // We route 2 dust-HTLCs between A and B
7271 let (_, payment_hash_1, _) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
7272 let (_, payment_hash_2, _) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
7273 route_payment(&nodes[0], &[&nodes[1]], 1000000);
7275 // Cache one local commitment tx as previous
7276 let as_prev_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
7278 // Fail one HTLC to prune it in the will-be-latest-local commitment tx
7279 assert!(nodes[1].node.fail_htlc_backwards(&payment_hash_2));
7280 check_added_monitors!(nodes[1], 0);
7281 expect_pending_htlcs_forwardable!(nodes[1]);
7282 check_added_monitors!(nodes[1], 1);
7284 let remove = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
7285 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &remove.update_fail_htlcs[0]);
7286 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &remove.commitment_signed);
7287 check_added_monitors!(nodes[0], 1);
7289 // Cache one local commitment tx as lastest
7290 let as_last_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
7292 let events = nodes[0].node.get_and_clear_pending_msg_events();
7294 MessageSendEvent::SendRevokeAndACK { node_id, .. } => {
7295 assert_eq!(node_id, nodes[1].node.get_our_node_id());
7297 _ => panic!("Unexpected event"),
7300 MessageSendEvent::UpdateHTLCs { node_id, .. } => {
7301 assert_eq!(node_id, nodes[1].node.get_our_node_id());
7303 _ => panic!("Unexpected event"),
7306 assert_ne!(as_prev_commitment_tx, as_last_commitment_tx);
7307 // Fail the 2 dust-HTLCs, move their failure in maturation buffer (htlc_updated_waiting_threshold_conf)
7308 if announce_latest {
7309 mine_transaction(&nodes[0], &as_last_commitment_tx[0]);
7311 mine_transaction(&nodes[0], &as_prev_commitment_tx[0]);
7314 check_closed_broadcast!(nodes[0], true);
7315 check_added_monitors!(nodes[0], 1);
7317 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7318 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7319 let events = nodes[0].node.get_and_clear_pending_events();
7320 // Only 2 PaymentFailed events should show up, over-dust HTLC has to be failed by timeout tx
7321 assert_eq!(events.len(), 2);
7322 let mut first_failed = false;
7323 for event in events {
7325 Event::PaymentFailed { payment_hash, .. } => {
7326 if payment_hash == payment_hash_1 {
7327 assert!(!first_failed);
7328 first_failed = true;
7330 assert_eq!(payment_hash, payment_hash_2);
7333 _ => panic!("Unexpected event"),
7339 fn test_failure_delay_dust_htlc_local_commitment() {
7340 do_test_failure_delay_dust_htlc_local_commitment(true);
7341 do_test_failure_delay_dust_htlc_local_commitment(false);
7344 fn do_test_sweep_outbound_htlc_failure_update(revoked: bool, local: bool) {
7345 // Outbound HTLC-failure updates must be cancelled if we get a reorg before we reach ANTI_REORG_DELAY.
7346 // Broadcast of revoked remote commitment tx, trigger failure-update of dust/non-dust HTLCs
7347 // Broadcast of remote commitment tx, trigger failure-update of dust-HTLCs
7348 // Broadcast of timeout tx on remote commitment tx, trigger failure-udate of non-dust HTLCs
7349 // Broadcast of local commitment tx, trigger failure-update of dust-HTLCs
7350 // Broadcast of HTLC-timeout tx on local commitment tx, trigger failure-update of non-dust HTLCs
7352 let chanmon_cfgs = create_chanmon_cfgs(3);
7353 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7354 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
7355 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7356 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7358 let bs_dust_limit = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().holder_dust_limit_satoshis;
7360 let (_payment_preimage_1, dust_hash, _payment_secret_1) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
7361 let (_payment_preimage_2, non_dust_hash, _payment_secret_2) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
7363 let as_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
7364 let bs_commitment_tx = get_local_commitment_txn!(nodes[1], chan.2);
7366 // We revoked bs_commitment_tx
7368 let (payment_preimage_3, _, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
7369 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_3);
7372 let mut timeout_tx = Vec::new();
7374 // We fail dust-HTLC 1 by broadcast of local commitment tx
7375 mine_transaction(&nodes[0], &as_commitment_tx[0]);
7376 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7377 expect_payment_failed!(nodes[0], dust_hash, true);
7379 connect_blocks(&nodes[0], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS - ANTI_REORG_DELAY);
7380 check_closed_broadcast!(nodes[0], true);
7381 check_added_monitors!(nodes[0], 1);
7382 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7383 timeout_tx.push(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[1].clone());
7384 assert_eq!(timeout_tx[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
7385 // We fail non-dust-HTLC 2 by broadcast of local HTLC-timeout tx on local commitment tx
7386 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7387 mine_transaction(&nodes[0], &timeout_tx[0]);
7388 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7389 expect_payment_failed!(nodes[0], non_dust_hash, true);
7391 // We fail dust-HTLC 1 by broadcast of remote commitment tx. If revoked, fail also non-dust HTLC
7392 mine_transaction(&nodes[0], &bs_commitment_tx[0]);
7393 check_closed_broadcast!(nodes[0], true);
7394 check_added_monitors!(nodes[0], 1);
7395 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7396 connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
7397 timeout_tx.push(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[1].clone());
7399 expect_payment_failed!(nodes[0], dust_hash, true);
7400 assert_eq!(timeout_tx[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
7401 // We fail non-dust-HTLC 2 by broadcast of local timeout tx on remote commitment tx
7402 mine_transaction(&nodes[0], &timeout_tx[0]);
7403 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7404 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7405 expect_payment_failed!(nodes[0], non_dust_hash, true);
7407 // If revoked, both dust & non-dust HTLCs should have been failed after ANTI_REORG_DELAY confs of revoked
7409 let events = nodes[0].node.get_and_clear_pending_events();
7410 assert_eq!(events.len(), 2);
7413 Event::PaymentFailed { payment_hash, .. } => {
7414 if payment_hash == dust_hash { first = true; }
7415 else { first = false; }
7417 _ => panic!("Unexpected event"),
7420 Event::PaymentFailed { payment_hash, .. } => {
7421 if first { assert_eq!(payment_hash, non_dust_hash); }
7422 else { assert_eq!(payment_hash, dust_hash); }
7424 _ => panic!("Unexpected event"),
7431 fn test_sweep_outbound_htlc_failure_update() {
7432 do_test_sweep_outbound_htlc_failure_update(false, true);
7433 do_test_sweep_outbound_htlc_failure_update(false, false);
7434 do_test_sweep_outbound_htlc_failure_update(true, false);
7438 fn test_upfront_shutdown_script() {
7439 // BOLT 2 : Option upfront shutdown script, if peer commit its closing_script at channel opening
7440 // enforce it at shutdown message
7442 let mut config = UserConfig::default();
7443 config.channel_options.announced_channel = true;
7444 config.peer_channel_config_limits.force_announced_channel_preference = false;
7445 config.channel_options.commit_upfront_shutdown_pubkey = false;
7446 let user_cfgs = [None, Some(config), None];
7447 let chanmon_cfgs = create_chanmon_cfgs(3);
7448 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7449 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
7450 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7452 // We test that in case of peer committing upfront to a script, if it changes at closing, we refuse to sign
7453 let flags = InitFeatures::known();
7454 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 1000000, 1000000, flags.clone(), flags.clone());
7455 nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7456 let mut node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[2].node.get_our_node_id());
7457 node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
7458 // Test we enforce upfront_scriptpbukey if by providing a diffrent one at closing that we disconnect peer
7459 nodes[2].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
7460 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()));
7461 check_added_monitors!(nodes[2], 1);
7463 // We test that in case of peer committing upfront to a script, if it doesn't change at closing, we sign
7464 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 1000000, 1000000, flags.clone(), flags.clone());
7465 nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7466 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[2].node.get_our_node_id());
7467 // We test that in case of peer committing upfront to a script, if it oesn't change at closing, we sign
7468 nodes[2].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
7469 let events = nodes[2].node.get_and_clear_pending_msg_events();
7470 assert_eq!(events.len(), 1);
7472 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[0].node.get_our_node_id()) }
7473 _ => panic!("Unexpected event"),
7476 // We test that if case of peer non-signaling we don't enforce committed script at channel opening
7477 let flags_no = InitFeatures::known().clear_upfront_shutdown_script();
7478 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, flags_no, flags.clone());
7479 nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7480 let mut node_1_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
7481 node_1_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
7482 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_1_shutdown);
7483 let events = nodes[1].node.get_and_clear_pending_msg_events();
7484 assert_eq!(events.len(), 1);
7486 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[0].node.get_our_node_id()) }
7487 _ => panic!("Unexpected event"),
7490 // We test that if user opt-out, we provide a zero-length script at channel opening and we are able to close
7491 // channel smoothly, opt-out is from channel initiator here
7492 let chan = create_announced_chan_between_nodes_with_value(&nodes, 1, 0, 1000000, 1000000, flags.clone(), flags.clone());
7493 nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7494 let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
7495 node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
7496 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
7497 let events = nodes[0].node.get_and_clear_pending_msg_events();
7498 assert_eq!(events.len(), 1);
7500 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7501 _ => panic!("Unexpected event"),
7504 //// We test that if user opt-out, we provide a zero-length script at channel opening and we are able to close
7505 //// channel smoothly
7506 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, flags.clone(), flags.clone());
7507 nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7508 let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
7509 node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
7510 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
7511 let events = nodes[0].node.get_and_clear_pending_msg_events();
7512 assert_eq!(events.len(), 2);
7514 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7515 _ => panic!("Unexpected event"),
7518 MessageSendEvent::SendClosingSigned { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7519 _ => panic!("Unexpected event"),
7524 fn test_unsupported_anysegwit_upfront_shutdown_script() {
7525 let chanmon_cfgs = create_chanmon_cfgs(2);
7526 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7527 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7528 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7530 // Use a non-v0 segwit script supported by option_shutdown_anysegwit
7531 let node_features = InitFeatures::known().clear_shutdown_anysegwit();
7532 let anysegwit_shutdown_script = Builder::new()
7534 .push_slice(&[0, 40])
7537 // Check script when handling an open_channel message
7538 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
7539 let mut open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
7540 open_channel.shutdown_scriptpubkey = Present(anysegwit_shutdown_script.clone());
7541 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), node_features.clone(), &open_channel);
7543 let events = nodes[1].node.get_and_clear_pending_msg_events();
7544 assert_eq!(events.len(), 1);
7546 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
7547 assert_eq!(node_id, nodes[0].node.get_our_node_id());
7548 assert!(regex::Regex::new(r"Peer is signaling upfront_shutdown but has provided an unacceptable scriptpubkey format. script: (\([A-Fa-f0-9]+\))").unwrap().is_match(&*msg.data));
7550 _ => panic!("Unexpected event"),
7553 // Check script when handling an accept_channel message
7554 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
7555 let open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
7556 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_channel);
7557 let mut accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
7558 accept_channel.shutdown_scriptpubkey = Present(anysegwit_shutdown_script.clone());
7559 nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), node_features, &accept_channel);
7561 let events = nodes[0].node.get_and_clear_pending_msg_events();
7562 assert_eq!(events.len(), 1);
7564 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
7565 assert_eq!(node_id, nodes[1].node.get_our_node_id());
7566 assert!(regex::Regex::new(r"Peer is signaling upfront_shutdown but has provided an unacceptable scriptpubkey format. script: (\([A-Fa-f0-9]+\))").unwrap().is_match(&*msg.data));
7568 _ => panic!("Unexpected event"),
7573 fn test_invalid_upfront_shutdown_script() {
7574 let chanmon_cfgs = create_chanmon_cfgs(2);
7575 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7576 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7577 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7579 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
7581 // Use a segwit v0 script with an unsupported witness program
7582 let mut open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
7583 open_channel.shutdown_scriptpubkey = Present(Builder::new().push_int(0)
7584 .push_slice(&[0, 0])
7586 nodes[0].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_channel);
7588 let events = nodes[0].node.get_and_clear_pending_msg_events();
7589 assert_eq!(events.len(), 1);
7591 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
7592 assert_eq!(node_id, nodes[0].node.get_our_node_id());
7593 assert!(regex::Regex::new(r"Peer is signaling upfront_shutdown but has provided an unacceptable scriptpubkey format. script: (\([A-Fa-f0-9]+\))").unwrap().is_match(&*msg.data));
7595 _ => panic!("Unexpected event"),
7600 fn test_segwit_v0_shutdown_script() {
7601 let mut config = UserConfig::default();
7602 config.channel_options.announced_channel = true;
7603 config.peer_channel_config_limits.force_announced_channel_preference = false;
7604 config.channel_options.commit_upfront_shutdown_pubkey = false;
7605 let user_cfgs = [None, Some(config), None];
7606 let chanmon_cfgs = create_chanmon_cfgs(3);
7607 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7608 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
7609 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7611 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7612 nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7614 // Use a segwit v0 script supported even without option_shutdown_anysegwit
7615 let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
7616 node_0_shutdown.scriptpubkey = Builder::new().push_int(0)
7617 .push_slice(&[0; 20])
7619 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
7621 let events = nodes[0].node.get_and_clear_pending_msg_events();
7622 assert_eq!(events.len(), 2);
7624 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7625 _ => panic!("Unexpected event"),
7628 MessageSendEvent::SendClosingSigned { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7629 _ => panic!("Unexpected event"),
7634 fn test_anysegwit_shutdown_script() {
7635 let mut config = UserConfig::default();
7636 config.channel_options.announced_channel = true;
7637 config.peer_channel_config_limits.force_announced_channel_preference = false;
7638 config.channel_options.commit_upfront_shutdown_pubkey = false;
7639 let user_cfgs = [None, Some(config), None];
7640 let chanmon_cfgs = create_chanmon_cfgs(3);
7641 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7642 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
7643 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7645 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7646 nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7648 // Use a non-v0 segwit script supported by option_shutdown_anysegwit
7649 let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
7650 node_0_shutdown.scriptpubkey = Builder::new().push_int(16)
7651 .push_slice(&[0, 0])
7653 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
7655 let events = nodes[0].node.get_and_clear_pending_msg_events();
7656 assert_eq!(events.len(), 2);
7658 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7659 _ => panic!("Unexpected event"),
7662 MessageSendEvent::SendClosingSigned { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7663 _ => panic!("Unexpected event"),
7668 fn test_unsupported_anysegwit_shutdown_script() {
7669 let mut config = UserConfig::default();
7670 config.channel_options.announced_channel = true;
7671 config.peer_channel_config_limits.force_announced_channel_preference = false;
7672 config.channel_options.commit_upfront_shutdown_pubkey = false;
7673 let user_cfgs = [None, Some(config), None];
7674 let chanmon_cfgs = create_chanmon_cfgs(3);
7675 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7676 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
7677 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7679 let node_features = InitFeatures::known().clear_shutdown_anysegwit();
7680 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), node_features.clone());
7681 nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7683 // Use a non-v0 segwit script supported by option_shutdown_anysegwit
7684 let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
7685 node_0_shutdown.scriptpubkey = Builder::new().push_int(16)
7686 .push_slice(&[0, 40])
7688 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_features, &node_0_shutdown);
7690 let events = nodes[0].node.get_and_clear_pending_msg_events();
7691 assert_eq!(events.len(), 2);
7693 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
7694 assert_eq!(node_id, nodes[1].node.get_our_node_id());
7695 assert_eq!(msg.data, "Got a nonstandard scriptpubkey (60020028) from remote peer".to_owned());
7697 _ => panic!("Unexpected event"),
7699 check_added_monitors!(nodes[0], 1);
7703 fn test_invalid_shutdown_script() {
7704 let mut config = UserConfig::default();
7705 config.channel_options.announced_channel = true;
7706 config.peer_channel_config_limits.force_announced_channel_preference = false;
7707 config.channel_options.commit_upfront_shutdown_pubkey = false;
7708 let user_cfgs = [None, Some(config), None];
7709 let chanmon_cfgs = create_chanmon_cfgs(3);
7710 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7711 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
7712 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7714 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7715 nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7717 // Use a segwit v0 script with an unsupported witness program
7718 let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
7719 node_0_shutdown.scriptpubkey = Builder::new().push_int(0)
7720 .push_slice(&[0, 0])
7722 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
7724 let events = nodes[0].node.get_and_clear_pending_msg_events();
7725 assert_eq!(events.len(), 2);
7727 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
7728 assert_eq!(node_id, nodes[1].node.get_our_node_id());
7729 assert_eq!(msg.data, "Got a nonstandard scriptpubkey (00020000) from remote peer".to_owned())
7731 _ => panic!("Unexpected event"),
7733 check_added_monitors!(nodes[0], 1);
7737 fn test_user_configurable_csv_delay() {
7738 // We test our channel constructors yield errors when we pass them absurd csv delay
7740 let mut low_our_to_self_config = UserConfig::default();
7741 low_our_to_self_config.own_channel_config.our_to_self_delay = 6;
7742 let mut high_their_to_self_config = UserConfig::default();
7743 high_their_to_self_config.peer_channel_config_limits.their_to_self_delay = 100;
7744 let user_cfgs = [Some(high_their_to_self_config.clone()), None];
7745 let chanmon_cfgs = create_chanmon_cfgs(2);
7746 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7747 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &user_cfgs);
7748 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7750 // We test config.our_to_self > BREAKDOWN_TIMEOUT is enforced in Channel::new_outbound()
7751 if let Err(error) = Channel::new_outbound(&&test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) }, &nodes[0].keys_manager, nodes[1].node.get_our_node_id(), 1000000, 1000000, 0, &low_our_to_self_config) {
7753 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())); },
7754 _ => panic!("Unexpected event"),
7756 } else { assert!(false) }
7758 // We test config.our_to_self > BREAKDOWN_TIMEOUT is enforced in Channel::new_from_req()
7759 nodes[1].node.create_channel(nodes[0].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
7760 let mut open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
7761 open_channel.to_self_delay = 200;
7762 if let Err(error) = Channel::new_from_req(&&test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) }, &nodes[0].keys_manager, nodes[1].node.get_our_node_id(), InitFeatures::known(), &open_channel, 0, &low_our_to_self_config) {
7764 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())); },
7765 _ => panic!("Unexpected event"),
7767 } else { assert!(false); }
7769 // We test msg.to_self_delay <= config.their_to_self_delay is enforced in Chanel::accept_channel()
7770 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
7771 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()));
7772 let mut accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
7773 accept_channel.to_self_delay = 200;
7774 nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &accept_channel);
7775 if let MessageSendEvent::HandleError { ref action, .. } = nodes[0].node.get_and_clear_pending_msg_events()[0] {
7777 &ErrorAction::SendErrorMessage { ref msg } => {
7778 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()));
7780 _ => { assert!(false); }
7782 } else { assert!(false); }
7784 // We test msg.to_self_delay <= config.their_to_self_delay is enforced in Channel::new_from_req()
7785 nodes[1].node.create_channel(nodes[0].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
7786 let mut open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
7787 open_channel.to_self_delay = 200;
7788 if let Err(error) = Channel::new_from_req(&&test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) }, &nodes[0].keys_manager, nodes[1].node.get_our_node_id(), InitFeatures::known(), &open_channel, 0, &high_their_to_self_config) {
7790 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())); },
7791 _ => panic!("Unexpected event"),
7793 } else { assert!(false); }
7797 fn test_data_loss_protect() {
7798 // We want to be sure that :
7799 // * we don't broadcast our Local Commitment Tx in case of fallen behind
7800 // (but this is not quite true - we broadcast during Drop because chanmon is out of sync with chanmgr)
7801 // * we close channel in case of detecting other being fallen behind
7802 // * we are able to claim our own outputs thanks to to_remote being static
7803 // TODO: this test is incomplete and the data_loss_protect implementation is incomplete - see issue #775
7809 let mut chanmon_cfgs = create_chanmon_cfgs(2);
7810 // We broadcast during Drop because chanmon is out of sync with chanmgr, which would cause a panic
7811 // during signing due to revoked tx
7812 chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
7813 let keys_manager = &chanmon_cfgs[0].keys_manager;
7816 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7817 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7818 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7820 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7822 // Cache node A state before any channel update
7823 let previous_node_state = nodes[0].node.encode();
7824 let mut previous_chain_monitor_state = test_utils::TestVecWriter(Vec::new());
7825 nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut previous_chain_monitor_state).unwrap();
7827 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
7828 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
7830 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
7831 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
7833 // Restore node A from previous state
7834 logger = test_utils::TestLogger::with_id(format!("node {}", 0));
7835 let mut chain_monitor = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(&mut io::Cursor::new(previous_chain_monitor_state.0), keys_manager).unwrap().1;
7836 chain_source = test_utils::TestChainSource::new(Network::Testnet);
7837 tx_broadcaster = test_utils::TestBroadcaster{txn_broadcasted: Mutex::new(Vec::new()), blocks: Arc::new(Mutex::new(Vec::new()))};
7838 fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
7839 persister = test_utils::TestPersister::new();
7840 monitor = test_utils::TestChainMonitor::new(Some(&chain_source), &tx_broadcaster, &logger, &fee_estimator, &persister, keys_manager);
7842 let mut channel_monitors = HashMap::new();
7843 channel_monitors.insert(OutPoint { txid: chan.3.txid(), index: 0 }, &mut chain_monitor);
7844 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut io::Cursor::new(previous_node_state), ChannelManagerReadArgs {
7845 keys_manager: keys_manager,
7846 fee_estimator: &fee_estimator,
7847 chain_monitor: &monitor,
7849 tx_broadcaster: &tx_broadcaster,
7850 default_config: UserConfig::default(),
7854 nodes[0].node = &node_state_0;
7855 assert!(monitor.watch_channel(OutPoint { txid: chan.3.txid(), index: 0 }, chain_monitor).is_ok());
7856 nodes[0].chain_monitor = &monitor;
7857 nodes[0].chain_source = &chain_source;
7859 check_added_monitors!(nodes[0], 1);
7861 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7862 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7864 let reestablish_0 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
7866 // Check we don't broadcast any transactions following learning of per_commitment_point from B
7867 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_0[0]);
7868 check_added_monitors!(nodes[0], 1);
7871 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
7872 assert_eq!(node_txn.len(), 0);
7875 let mut reestablish_1 = Vec::with_capacity(1);
7876 for msg in nodes[0].node.get_and_clear_pending_msg_events() {
7877 if let MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } = msg {
7878 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
7879 reestablish_1.push(msg.clone());
7880 } else if let MessageSendEvent::BroadcastChannelUpdate { .. } = msg {
7881 } else if let MessageSendEvent::HandleError { ref action, .. } = msg {
7883 &ErrorAction::SendErrorMessage { ref msg } => {
7884 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");
7886 _ => panic!("Unexpected event!"),
7889 panic!("Unexpected event")
7893 // Check we close channel detecting A is fallen-behind
7894 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
7895 assert_eq!(check_closed_broadcast!(nodes[1], true).unwrap().data, "Peer attempted to reestablish channel with a very old local commitment transaction");
7896 check_added_monitors!(nodes[1], 1);
7899 // Check A is able to claim to_remote output
7900 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
7901 assert_eq!(node_txn.len(), 1);
7902 check_spends!(node_txn[0], chan.3);
7903 assert_eq!(node_txn[0].output.len(), 2);
7904 mine_transaction(&nodes[0], &node_txn[0]);
7905 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7906 let spend_txn = check_spendable_outputs!(nodes[0], node_cfgs[0].keys_manager);
7907 assert_eq!(spend_txn.len(), 1);
7908 check_spends!(spend_txn[0], node_txn[0]);
7912 fn test_check_htlc_underpaying() {
7913 // Send payment through A -> B but A is maliciously
7914 // sending a probe payment (i.e less than expected value0
7915 // to B, B should refuse payment.
7917 let chanmon_cfgs = create_chanmon_cfgs(2);
7918 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7919 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7920 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7922 // Create some initial channels
7923 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7925 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();
7926 let (_, our_payment_hash, _) = get_payment_preimage_hash!(nodes[0]);
7927 let our_payment_secret = nodes[1].node.create_inbound_payment_for_hash(our_payment_hash, Some(100_000), 7200, 0).unwrap();
7928 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
7929 check_added_monitors!(nodes[0], 1);
7931 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
7932 assert_eq!(events.len(), 1);
7933 let mut payment_event = SendEvent::from_event(events.pop().unwrap());
7934 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
7935 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
7937 // Note that we first have to wait a random delay before processing the receipt of the HTLC,
7938 // and then will wait a second random delay before failing the HTLC back:
7939 expect_pending_htlcs_forwardable!(nodes[1]);
7940 expect_pending_htlcs_forwardable!(nodes[1]);
7942 // Node 3 is expecting payment of 100_000 but received 10_000,
7943 // it should fail htlc like we didn't know the preimage.
7944 nodes[1].node.process_pending_htlc_forwards();
7946 let events = nodes[1].node.get_and_clear_pending_msg_events();
7947 assert_eq!(events.len(), 1);
7948 let (update_fail_htlc, commitment_signed) = match events[0] {
7949 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 } } => {
7950 assert!(update_add_htlcs.is_empty());
7951 assert!(update_fulfill_htlcs.is_empty());
7952 assert_eq!(update_fail_htlcs.len(), 1);
7953 assert!(update_fail_malformed_htlcs.is_empty());
7954 assert!(update_fee.is_none());
7955 (update_fail_htlcs[0].clone(), commitment_signed)
7957 _ => panic!("Unexpected event"),
7959 check_added_monitors!(nodes[1], 1);
7961 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlc);
7962 commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
7964 // 10_000 msat as u64, followed by a height of CHAN_CONFIRM_DEPTH as u32
7965 let mut expected_failure_data = byte_utils::be64_to_array(10_000).to_vec();
7966 expected_failure_data.extend_from_slice(&byte_utils::be32_to_array(CHAN_CONFIRM_DEPTH));
7967 expect_payment_failed!(nodes[0], our_payment_hash, true, 0x4000|15, &expected_failure_data[..]);
7971 fn test_announce_disable_channels() {
7972 // Create 2 channels between A and B. Disconnect B. Call timer_tick_occurred and check for generated
7973 // ChannelUpdate. Reconnect B, reestablish and check there is non-generated ChannelUpdate.
7975 let chanmon_cfgs = create_chanmon_cfgs(2);
7976 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7977 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7978 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7980 let short_id_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
7981 let short_id_2 = create_announced_chan_between_nodes(&nodes, 1, 0, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
7982 let short_id_3 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
7985 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
7986 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
7988 nodes[0].node.timer_tick_occurred(); // Enabled -> DisabledStaged
7989 nodes[0].node.timer_tick_occurred(); // DisabledStaged -> Disabled
7990 let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
7991 assert_eq!(msg_events.len(), 3);
7992 let mut chans_disabled: HashSet<u64> = [short_id_1, short_id_2, short_id_3].iter().map(|a| *a).collect();
7993 for e in msg_events {
7995 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
7996 assert_eq!(msg.contents.flags & (1<<1), 1<<1); // The "channel disabled" bit should be set
7997 // Check that each channel gets updated exactly once
7998 if !chans_disabled.remove(&msg.contents.short_channel_id) {
7999 panic!("Generated ChannelUpdate for wrong chan!");
8002 _ => panic!("Unexpected event"),
8006 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
8007 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
8008 assert_eq!(reestablish_1.len(), 3);
8009 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
8010 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
8011 assert_eq!(reestablish_2.len(), 3);
8013 // Reestablish chan_1
8014 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
8015 handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
8016 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
8017 handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
8018 // Reestablish chan_2
8019 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[1]);
8020 handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
8021 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[1]);
8022 handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
8023 // Reestablish chan_3
8024 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[2]);
8025 handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
8026 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[2]);
8027 handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
8029 nodes[0].node.timer_tick_occurred();
8030 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
8031 nodes[0].node.timer_tick_occurred();
8032 let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
8033 assert_eq!(msg_events.len(), 3);
8034 chans_disabled = [short_id_1, short_id_2, short_id_3].iter().map(|a| *a).collect();
8035 for e in msg_events {
8037 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
8038 assert_eq!(msg.contents.flags & (1<<1), 0); // The "channel disabled" bit should be off
8039 // Check that each channel gets updated exactly once
8040 if !chans_disabled.remove(&msg.contents.short_channel_id) {
8041 panic!("Generated ChannelUpdate for wrong chan!");
8044 _ => panic!("Unexpected event"),
8050 fn test_priv_forwarding_rejection() {
8051 // If we have a private channel with outbound liquidity, and
8052 // UserConfig::accept_forwards_to_priv_channels is set to false, we should reject any attempts
8053 // to forward through that channel.
8054 let chanmon_cfgs = create_chanmon_cfgs(3);
8055 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
8056 let mut no_announce_cfg = test_default_channel_config();
8057 no_announce_cfg.channel_options.announced_channel = false;
8058 no_announce_cfg.accept_forwards_to_priv_channels = false;
8059 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, Some(no_announce_cfg), None]);
8060 let persister: test_utils::TestPersister;
8061 let new_chain_monitor: test_utils::TestChainMonitor;
8062 let nodes_1_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
8063 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
8065 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1_000_000, 500_000_000, InitFeatures::known(), InitFeatures::known());
8067 // Note that the create_*_chan functions in utils requires announcement_signatures, which we do
8068 // not send for private channels.
8069 nodes[1].node.create_channel(nodes[2].node.get_our_node_id(), 1_000_000, 500_000_000, 42, None).unwrap();
8070 let open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[2].node.get_our_node_id());
8071 nodes[2].node.handle_open_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &open_channel);
8072 let accept_channel = get_event_msg!(nodes[2], MessageSendEvent::SendAcceptChannel, nodes[1].node.get_our_node_id());
8073 nodes[1].node.handle_accept_channel(&nodes[2].node.get_our_node_id(), InitFeatures::known(), &accept_channel);
8075 let (temporary_channel_id, tx, _) = create_funding_transaction(&nodes[1], 1_000_000, 42);
8076 nodes[1].node.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
8077 nodes[2].node.handle_funding_created(&nodes[1].node.get_our_node_id(), &get_event_msg!(nodes[1], MessageSendEvent::SendFundingCreated, nodes[2].node.get_our_node_id()));
8078 check_added_monitors!(nodes[2], 1);
8080 nodes[1].node.handle_funding_signed(&nodes[2].node.get_our_node_id(), &get_event_msg!(nodes[2], MessageSendEvent::SendFundingSigned, nodes[1].node.get_our_node_id()));
8081 check_added_monitors!(nodes[1], 1);
8083 let conf_height = core::cmp::max(nodes[1].best_block_info().1 + 1, nodes[2].best_block_info().1 + 1);
8084 confirm_transaction_at(&nodes[1], &tx, conf_height);
8085 connect_blocks(&nodes[1], CHAN_CONFIRM_DEPTH - 1);
8086 confirm_transaction_at(&nodes[2], &tx, conf_height);
8087 connect_blocks(&nodes[2], CHAN_CONFIRM_DEPTH - 1);
8088 let as_funding_locked = get_event_msg!(nodes[1], MessageSendEvent::SendFundingLocked, nodes[2].node.get_our_node_id());
8089 nodes[1].node.handle_funding_locked(&nodes[2].node.get_our_node_id(), &get_event_msg!(nodes[2], MessageSendEvent::SendFundingLocked, nodes[1].node.get_our_node_id()));
8090 get_event_msg!(nodes[1], MessageSendEvent::SendChannelUpdate, nodes[2].node.get_our_node_id());
8091 nodes[2].node.handle_funding_locked(&nodes[1].node.get_our_node_id(), &as_funding_locked);
8092 get_event_msg!(nodes[2], MessageSendEvent::SendChannelUpdate, nodes[1].node.get_our_node_id());
8094 assert!(nodes[0].node.list_usable_channels()[0].is_public);
8095 assert_eq!(nodes[1].node.list_usable_channels().len(), 2);
8096 assert!(!nodes[2].node.list_usable_channels()[0].is_public);
8098 // We should always be able to forward through nodes[1] as long as its out through a public
8100 send_payment(&nodes[2], &[&nodes[1], &nodes[0]], 10_000);
8102 // ... however, if we send to nodes[2], we will have to pass the private channel from nodes[1]
8103 // to nodes[2], which should be rejected:
8104 let (our_payment_preimage, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[2]);
8105 let route = get_route(&nodes[0].node.get_our_node_id(),
8106 &nodes[0].net_graph_msg_handler.network_graph.read().unwrap(),
8107 &nodes[2].node.get_our_node_id(), Some(InvoiceFeatures::known()), None,
8108 &[&RouteHint(vec![RouteHintHop {
8109 src_node_id: nodes[1].node.get_our_node_id(),
8110 short_channel_id: nodes[2].node.list_channels()[0].short_channel_id.unwrap(),
8111 fees: RoutingFees { base_msat: 1000, proportional_millionths: 0 },
8112 cltv_expiry_delta: MIN_CLTV_EXPIRY_DELTA,
8113 htlc_minimum_msat: None,
8114 htlc_maximum_msat: None,
8115 }])], 10_000, TEST_FINAL_CLTV, nodes[0].logger).unwrap();
8117 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
8118 check_added_monitors!(nodes[0], 1);
8119 let payment_event = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
8120 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
8121 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false, true);
8123 let htlc_fail_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
8124 assert!(htlc_fail_updates.update_add_htlcs.is_empty());
8125 assert_eq!(htlc_fail_updates.update_fail_htlcs.len(), 1);
8126 assert!(htlc_fail_updates.update_fail_malformed_htlcs.is_empty());
8127 assert!(htlc_fail_updates.update_fee.is_none());
8129 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_fail_updates.update_fail_htlcs[0]);
8130 commitment_signed_dance!(nodes[0], nodes[1], htlc_fail_updates.commitment_signed, true, true);
8131 expect_payment_failed!(nodes[0], our_payment_hash, false);
8132 expect_payment_failure_chan_update!(nodes[0], nodes[2].node.list_channels()[0].short_channel_id.unwrap(), true);
8134 // Now disconnect nodes[1] from its peers and restart with accept_forwards_to_priv_channels set
8135 // to true. Sadly there is currently no way to change it at runtime.
8137 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
8138 nodes[2].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
8140 let nodes_1_serialized = nodes[1].node.encode();
8141 let mut monitor_a_serialized = test_utils::TestVecWriter(Vec::new());
8142 let mut monitor_b_serialized = test_utils::TestVecWriter(Vec::new());
8144 let mons = nodes[1].chain_monitor.chain_monitor.monitors.read().unwrap();
8145 let mut mon_iter = mons.iter();
8146 mon_iter.next().unwrap().1.write(&mut monitor_a_serialized).unwrap();
8147 mon_iter.next().unwrap().1.write(&mut monitor_b_serialized).unwrap();
8150 persister = test_utils::TestPersister::new();
8151 let keys_manager = &chanmon_cfgs[1].keys_manager;
8152 new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[1].chain_source), nodes[1].tx_broadcaster.clone(), nodes[1].logger, node_cfgs[1].fee_estimator, &persister, keys_manager);
8153 nodes[1].chain_monitor = &new_chain_monitor;
8155 let mut monitor_a_read = &monitor_a_serialized.0[..];
8156 let mut monitor_b_read = &monitor_b_serialized.0[..];
8157 let (_, mut monitor_a) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(&mut monitor_a_read, keys_manager).unwrap();
8158 let (_, mut monitor_b) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(&mut monitor_b_read, keys_manager).unwrap();
8159 assert!(monitor_a_read.is_empty());
8160 assert!(monitor_b_read.is_empty());
8162 no_announce_cfg.accept_forwards_to_priv_channels = true;
8164 let mut nodes_1_read = &nodes_1_serialized[..];
8165 let (_, nodes_1_deserialized_tmp) = {
8166 let mut channel_monitors = HashMap::new();
8167 channel_monitors.insert(monitor_a.get_funding_txo().0, &mut monitor_a);
8168 channel_monitors.insert(monitor_b.get_funding_txo().0, &mut monitor_b);
8169 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_1_read, ChannelManagerReadArgs {
8170 default_config: no_announce_cfg,
8172 fee_estimator: node_cfgs[1].fee_estimator,
8173 chain_monitor: nodes[1].chain_monitor,
8174 tx_broadcaster: nodes[1].tx_broadcaster.clone(),
8175 logger: nodes[1].logger,
8179 assert!(nodes_1_read.is_empty());
8180 nodes_1_deserialized = nodes_1_deserialized_tmp;
8182 assert!(nodes[1].chain_monitor.watch_channel(monitor_a.get_funding_txo().0, monitor_a).is_ok());
8183 assert!(nodes[1].chain_monitor.watch_channel(monitor_b.get_funding_txo().0, monitor_b).is_ok());
8184 check_added_monitors!(nodes[1], 2);
8185 nodes[1].node = &nodes_1_deserialized;
8187 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::known() });
8188 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
8189 let as_reestablish = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
8190 let bs_reestablish = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
8191 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &as_reestablish);
8192 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &bs_reestablish);
8193 get_event_msg!(nodes[0], MessageSendEvent::SendChannelUpdate, nodes[1].node.get_our_node_id());
8194 get_event_msg!(nodes[1], MessageSendEvent::SendChannelUpdate, nodes[0].node.get_our_node_id());
8196 nodes[1].node.peer_connected(&nodes[2].node.get_our_node_id(), &msgs::Init { features: InitFeatures::known() });
8197 nodes[2].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
8198 let bs_reestablish = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[2].node.get_our_node_id());
8199 let cs_reestablish = get_event_msg!(nodes[2], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
8200 nodes[2].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &bs_reestablish);
8201 nodes[1].node.handle_channel_reestablish(&nodes[2].node.get_our_node_id(), &cs_reestablish);
8202 get_event_msg!(nodes[1], MessageSendEvent::SendChannelUpdate, nodes[2].node.get_our_node_id());
8203 get_event_msg!(nodes[2], MessageSendEvent::SendChannelUpdate, nodes[1].node.get_our_node_id());
8205 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
8206 check_added_monitors!(nodes[0], 1);
8207 pass_along_route(&nodes[0], &[&[&nodes[1], &nodes[2]]], 10_000, our_payment_hash, our_payment_secret);
8208 claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], our_payment_preimage);
8212 fn test_bump_penalty_txn_on_revoked_commitment() {
8213 // In case of penalty txn with too low feerates for getting into mempools, RBF-bump them to be sure
8214 // we're able to claim outputs on revoked commitment transaction before timelocks expiration
8216 let chanmon_cfgs = create_chanmon_cfgs(2);
8217 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8218 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8219 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8221 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
8222 let logger = test_utils::TestLogger::new();
8224 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
8225 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
8226 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();
8227 send_along_route(&nodes[1], route, &vec!(&nodes[0])[..], 3000000);
8229 let revoked_txn = get_local_commitment_txn!(nodes[0], chan.2);
8230 // Revoked commitment txn with 4 outputs : to_local, to_remote, 1 outgoing HTLC, 1 incoming HTLC
8231 assert_eq!(revoked_txn[0].output.len(), 4);
8232 assert_eq!(revoked_txn[0].input.len(), 1);
8233 assert_eq!(revoked_txn[0].input[0].previous_output.txid, chan.3.txid());
8234 let revoked_txid = revoked_txn[0].txid();
8236 let mut penalty_sum = 0;
8237 for outp in revoked_txn[0].output.iter() {
8238 if outp.script_pubkey.is_v0_p2wsh() {
8239 penalty_sum += outp.value;
8243 // Connect blocks to change height_timer range to see if we use right soonest_timelock
8244 let header_114 = connect_blocks(&nodes[1], 14);
8246 // Actually revoke tx by claiming a HTLC
8247 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
8248 let header = BlockHeader { version: 0x20000000, prev_blockhash: header_114, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8249 connect_block(&nodes[1], &Block { header, txdata: vec![revoked_txn[0].clone()] });
8250 check_added_monitors!(nodes[1], 1);
8252 // One or more justice tx should have been broadcast, check it
8256 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8257 assert_eq!(node_txn.len(), 2); // justice tx (broadcasted from ChannelMonitor) + local commitment tx
8258 assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
8259 assert_eq!(node_txn[0].output.len(), 1);
8260 check_spends!(node_txn[0], revoked_txn[0]);
8261 let fee_1 = penalty_sum - node_txn[0].output[0].value;
8262 feerate_1 = fee_1 * 1000 / node_txn[0].get_weight() as u64;
8263 penalty_1 = node_txn[0].txid();
8267 // After exhaustion of height timer, a new bumped justice tx should have been broadcast, check it
8268 connect_blocks(&nodes[1], 15);
8269 let mut penalty_2 = penalty_1;
8270 let mut feerate_2 = 0;
8272 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8273 assert_eq!(node_txn.len(), 1);
8274 if node_txn[0].input[0].previous_output.txid == revoked_txid {
8275 assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
8276 assert_eq!(node_txn[0].output.len(), 1);
8277 check_spends!(node_txn[0], revoked_txn[0]);
8278 penalty_2 = node_txn[0].txid();
8279 // Verify new bumped tx is different from last claiming transaction, we don't want spurrious rebroadcast
8280 assert_ne!(penalty_2, penalty_1);
8281 let fee_2 = penalty_sum - node_txn[0].output[0].value;
8282 feerate_2 = fee_2 * 1000 / node_txn[0].get_weight() as u64;
8283 // Verify 25% bump heuristic
8284 assert!(feerate_2 * 100 >= feerate_1 * 125);
8288 assert_ne!(feerate_2, 0);
8290 // After exhaustion of height timer for a 2nd time, a new bumped justice tx should have been broadcast, check it
8291 connect_blocks(&nodes[1], 1);
8293 let mut feerate_3 = 0;
8295 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8296 assert_eq!(node_txn.len(), 1);
8297 if node_txn[0].input[0].previous_output.txid == revoked_txid {
8298 assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
8299 assert_eq!(node_txn[0].output.len(), 1);
8300 check_spends!(node_txn[0], revoked_txn[0]);
8301 penalty_3 = node_txn[0].txid();
8302 // Verify new bumped tx is different from last claiming transaction, we don't want spurrious rebroadcast
8303 assert_ne!(penalty_3, penalty_2);
8304 let fee_3 = penalty_sum - node_txn[0].output[0].value;
8305 feerate_3 = fee_3 * 1000 / node_txn[0].get_weight() as u64;
8306 // Verify 25% bump heuristic
8307 assert!(feerate_3 * 100 >= feerate_2 * 125);
8311 assert_ne!(feerate_3, 0);
8313 nodes[1].node.get_and_clear_pending_events();
8314 nodes[1].node.get_and_clear_pending_msg_events();
8318 fn test_bump_penalty_txn_on_revoked_htlcs() {
8319 // In case of penalty txn with too low feerates for getting into mempools, RBF-bump them to sure
8320 // we're able to claim outputs on revoked HTLC transactions before timelocks expiration
8322 let mut chanmon_cfgs = create_chanmon_cfgs(2);
8323 chanmon_cfgs[1].keys_manager.disable_revocation_policy_check = true;
8324 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8325 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8326 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8328 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
8329 // Lock HTLC in both directions (using a slightly lower CLTV delay to provide timely RBF bumps)
8330 let route = get_route(&nodes[0].node.get_our_node_id(), &nodes[0].net_graph_msg_handler.network_graph.read().unwrap(),
8331 &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 3_000_000, 50, nodes[0].logger).unwrap();
8332 let payment_preimage = send_along_route(&nodes[0], route, &[&nodes[1]], 3_000_000).0;
8333 let route = get_route(&nodes[1].node.get_our_node_id(), &nodes[1].net_graph_msg_handler.network_graph.read().unwrap(),
8334 &nodes[0].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 3_000_000, 50, nodes[0].logger).unwrap();
8335 send_along_route(&nodes[1], route, &[&nodes[0]], 3_000_000);
8337 let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan.2);
8338 assert_eq!(revoked_local_txn[0].input.len(), 1);
8339 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
8341 // Revoke local commitment tx
8342 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
8344 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8345 // B will generate both revoked HTLC-timeout/HTLC-preimage txn from revoked commitment tx
8346 connect_block(&nodes[1], &Block { header, txdata: vec![revoked_local_txn[0].clone()] });
8347 check_closed_broadcast!(nodes[1], true);
8348 check_added_monitors!(nodes[1], 1);
8349 connect_blocks(&nodes[1], 49); // Confirm blocks until the HTLC expires (note CLTV was explicitly 50 above)
8351 let revoked_htlc_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8352 assert_eq!(revoked_htlc_txn.len(), 3);
8353 check_spends!(revoked_htlc_txn[1], chan.3);
8355 assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
8356 assert_eq!(revoked_htlc_txn[0].input.len(), 1);
8357 check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
8359 assert_eq!(revoked_htlc_txn[2].input.len(), 1);
8360 assert_eq!(revoked_htlc_txn[2].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
8361 assert_eq!(revoked_htlc_txn[2].output.len(), 1);
8362 check_spends!(revoked_htlc_txn[2], revoked_local_txn[0]);
8364 // Broadcast set of revoked txn on A
8365 let hash_128 = connect_blocks(&nodes[0], 40);
8366 let header_11 = BlockHeader { version: 0x20000000, prev_blockhash: hash_128, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8367 connect_block(&nodes[0], &Block { header: header_11, txdata: vec![revoked_local_txn[0].clone()] });
8368 let header_129 = BlockHeader { version: 0x20000000, prev_blockhash: header_11.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8369 connect_block(&nodes[0], &Block { header: header_129, txdata: vec![revoked_htlc_txn[0].clone(), revoked_htlc_txn[2].clone()] });
8370 expect_pending_htlcs_forwardable_ignore!(nodes[0]);
8375 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8376 assert_eq!(node_txn.len(), 5); // 3 penalty txn on revoked commitment tx + A commitment tx + 1 penalty tnx on revoked HTLC txn
8377 // Verify claim tx are spending revoked HTLC txn
8379 // node_txn 0-2 each spend a separate revoked output from revoked_local_txn[0]
8380 // Note that node_txn[0] and node_txn[1] are bogus - they double spend the revoked_htlc_txn
8381 // which are included in the same block (they are broadcasted because we scan the
8382 // transactions linearly and generate claims as we go, they likely should be removed in the
8384 assert_eq!(node_txn[0].input.len(), 1);
8385 check_spends!(node_txn[0], revoked_local_txn[0]);
8386 assert_eq!(node_txn[1].input.len(), 1);
8387 check_spends!(node_txn[1], revoked_local_txn[0]);
8388 assert_eq!(node_txn[2].input.len(), 1);
8389 check_spends!(node_txn[2], revoked_local_txn[0]);
8391 // Each of the three justice transactions claim a separate (single) output of the three
8392 // available, which we check here:
8393 assert_ne!(node_txn[0].input[0].previous_output, node_txn[1].input[0].previous_output);
8394 assert_ne!(node_txn[0].input[0].previous_output, node_txn[2].input[0].previous_output);
8395 assert_ne!(node_txn[1].input[0].previous_output, node_txn[2].input[0].previous_output);
8397 assert_eq!(node_txn[0].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
8398 assert_eq!(node_txn[1].input[0].previous_output, revoked_htlc_txn[2].input[0].previous_output);
8400 // node_txn[3] is the local commitment tx broadcast just because (and somewhat in case of
8401 // reorgs, though its not clear its ever worth broadcasting conflicting txn like this when
8402 // a remote commitment tx has already been confirmed).
8403 check_spends!(node_txn[3], chan.3);
8405 // node_txn[4] spends the revoked outputs from the revoked_htlc_txn (which only have one
8406 // output, checked above).
8407 assert_eq!(node_txn[4].input.len(), 2);
8408 assert_eq!(node_txn[4].output.len(), 1);
8409 check_spends!(node_txn[4], revoked_htlc_txn[0], revoked_htlc_txn[2]);
8411 first = node_txn[4].txid();
8412 // Store both feerates for later comparison
8413 let fee_1 = revoked_htlc_txn[0].output[0].value + revoked_htlc_txn[2].output[0].value - node_txn[4].output[0].value;
8414 feerate_1 = fee_1 * 1000 / node_txn[4].get_weight() as u64;
8415 penalty_txn = vec![node_txn[2].clone()];
8419 // Connect one more block to see if bumped penalty are issued for HTLC txn
8420 let header_130 = BlockHeader { version: 0x20000000, prev_blockhash: header_129.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8421 connect_block(&nodes[0], &Block { header: header_130, txdata: penalty_txn });
8422 let header_131 = BlockHeader { version: 0x20000000, prev_blockhash: header_130.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8423 connect_block(&nodes[0], &Block { header: header_131, txdata: Vec::new() });
8425 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8426 assert_eq!(node_txn.len(), 2); // 2 bumped penalty txn on revoked commitment tx
8428 check_spends!(node_txn[0], revoked_local_txn[0]);
8429 check_spends!(node_txn[1], revoked_local_txn[0]);
8430 // Note that these are both bogus - they spend outputs already claimed in block 129:
8431 if node_txn[0].input[0].previous_output == revoked_htlc_txn[0].input[0].previous_output {
8432 assert_eq!(node_txn[1].input[0].previous_output, revoked_htlc_txn[2].input[0].previous_output);
8434 assert_eq!(node_txn[0].input[0].previous_output, revoked_htlc_txn[2].input[0].previous_output);
8435 assert_eq!(node_txn[1].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
8441 // Few more blocks to confirm penalty txn
8442 connect_blocks(&nodes[0], 4);
8443 assert!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
8444 let header_144 = connect_blocks(&nodes[0], 9);
8446 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8447 assert_eq!(node_txn.len(), 1);
8449 assert_eq!(node_txn[0].input.len(), 2);
8450 check_spends!(node_txn[0], revoked_htlc_txn[0], revoked_htlc_txn[2]);
8451 // Verify bumped tx is different and 25% bump heuristic
8452 assert_ne!(first, node_txn[0].txid());
8453 let fee_2 = revoked_htlc_txn[0].output[0].value + revoked_htlc_txn[2].output[0].value - node_txn[0].output[0].value;
8454 let feerate_2 = fee_2 * 1000 / node_txn[0].get_weight() as u64;
8455 assert!(feerate_2 * 100 > feerate_1 * 125);
8456 let txn = vec![node_txn[0].clone()];
8460 // Broadcast claim txn and confirm blocks to avoid further bumps on this outputs
8461 let header_145 = BlockHeader { version: 0x20000000, prev_blockhash: header_144, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8462 connect_block(&nodes[0], &Block { header: header_145, txdata: node_txn });
8463 connect_blocks(&nodes[0], 20);
8465 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8466 // We verify than no new transaction has been broadcast because previously
8467 // we were buggy on this exact behavior by not tracking for monitoring remote HTLC outputs (see #411)
8468 // which means we wouldn't see a spend of them by a justice tx and bumped justice tx
8469 // were generated forever instead of safe cleaning after confirmation and ANTI_REORG_SAFE_DELAY blocks.
8470 // Enforce spending of revoked htlc output by claiming transaction remove request as expected and dry
8471 // up bumped justice generation.
8472 assert_eq!(node_txn.len(), 0);
8475 check_closed_broadcast!(nodes[0], true);
8476 check_added_monitors!(nodes[0], 1);
8480 fn test_bump_penalty_txn_on_remote_commitment() {
8481 // In case of claim txn with too low feerates for getting into mempools, RBF-bump them to be sure
8482 // we're able to claim outputs on remote commitment transaction before timelocks expiration
8485 // Provide preimage for one
8486 // Check aggregation
8488 let chanmon_cfgs = create_chanmon_cfgs(2);
8489 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8490 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8491 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8493 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
8494 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
8495 route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000).0;
8497 // Remote commitment txn with 4 outputs : to_local, to_remote, 1 outgoing HTLC, 1 incoming HTLC
8498 let remote_txn = get_local_commitment_txn!(nodes[0], chan.2);
8499 assert_eq!(remote_txn[0].output.len(), 4);
8500 assert_eq!(remote_txn[0].input.len(), 1);
8501 assert_eq!(remote_txn[0].input[0].previous_output.txid, chan.3.txid());
8503 // Claim a HTLC without revocation (provide B monitor with preimage)
8504 nodes[1].node.claim_funds(payment_preimage);
8505 mine_transaction(&nodes[1], &remote_txn[0]);
8506 check_added_monitors!(nodes[1], 2);
8507 connect_blocks(&nodes[1], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
8509 // One or more claim tx should have been broadcast, check it
8513 let feerate_timeout;
8514 let feerate_preimage;
8516 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8517 // 9 transactions including:
8518 // 1*2 ChannelManager local broadcasts of commitment + HTLC-Success
8519 // 1*3 ChannelManager local broadcasts of commitment + HTLC-Success + HTLC-Timeout
8520 // 2 * HTLC-Success (one RBF bump we'll check later)
8522 assert_eq!(node_txn.len(), 8);
8523 assert_eq!(node_txn[0].input.len(), 1);
8524 assert_eq!(node_txn[6].input.len(), 1);
8525 check_spends!(node_txn[0], remote_txn[0]);
8526 check_spends!(node_txn[6], remote_txn[0]);
8527 assert_eq!(node_txn[0].input[0].previous_output, node_txn[3].input[0].previous_output);
8528 preimage_bump = node_txn[3].clone();
8530 check_spends!(node_txn[1], chan.3);
8531 check_spends!(node_txn[2], node_txn[1]);
8532 assert_eq!(node_txn[1], node_txn[4]);
8533 assert_eq!(node_txn[2], node_txn[5]);
8535 timeout = node_txn[6].txid();
8536 let index = node_txn[6].input[0].previous_output.vout;
8537 let fee = remote_txn[0].output[index as usize].value - node_txn[6].output[0].value;
8538 feerate_timeout = fee * 1000 / node_txn[6].get_weight() as u64;
8540 preimage = node_txn[0].txid();
8541 let index = node_txn[0].input[0].previous_output.vout;
8542 let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
8543 feerate_preimage = fee * 1000 / node_txn[0].get_weight() as u64;
8547 assert_ne!(feerate_timeout, 0);
8548 assert_ne!(feerate_preimage, 0);
8550 // After exhaustion of height timer, new bumped claim txn should have been broadcast, check it
8551 connect_blocks(&nodes[1], 15);
8553 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8554 assert_eq!(node_txn.len(), 1);
8555 assert_eq!(node_txn[0].input.len(), 1);
8556 assert_eq!(preimage_bump.input.len(), 1);
8557 check_spends!(node_txn[0], remote_txn[0]);
8558 check_spends!(preimage_bump, remote_txn[0]);
8560 let index = preimage_bump.input[0].previous_output.vout;
8561 let fee = remote_txn[0].output[index as usize].value - preimage_bump.output[0].value;
8562 let new_feerate = fee * 1000 / preimage_bump.get_weight() as u64;
8563 assert!(new_feerate * 100 > feerate_timeout * 125);
8564 assert_ne!(timeout, preimage_bump.txid());
8566 let index = node_txn[0].input[0].previous_output.vout;
8567 let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
8568 let new_feerate = fee * 1000 / node_txn[0].get_weight() as u64;
8569 assert!(new_feerate * 100 > feerate_preimage * 125);
8570 assert_ne!(preimage, node_txn[0].txid());
8575 nodes[1].node.get_and_clear_pending_events();
8576 nodes[1].node.get_and_clear_pending_msg_events();
8580 fn test_counterparty_raa_skip_no_crash() {
8581 // Previously, if our counterparty sent two RAAs in a row without us having provided a
8582 // commitment transaction, we would have happily carried on and provided them the next
8583 // commitment transaction based on one RAA forward. This would probably eventually have led to
8584 // channel closure, but it would not have resulted in funds loss. Still, our
8585 // EnforcingSigner would have paniced as it doesn't like jumps into the future. Here, we
8586 // check simply that the channel is closed in response to such an RAA, but don't check whether
8587 // we decide to punish our counterparty for revoking their funds (as we don't currently
8589 let chanmon_cfgs = create_chanmon_cfgs(2);
8590 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8591 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8592 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8593 let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).2;
8595 let mut guard = nodes[0].node.channel_state.lock().unwrap();
8596 let keys = &guard.by_id.get_mut(&channel_id).unwrap().get_signer();
8597 const INITIAL_COMMITMENT_NUMBER: u64 = (1 << 48) - 1;
8598 let per_commitment_secret = keys.release_commitment_secret(INITIAL_COMMITMENT_NUMBER);
8599 // Must revoke without gaps
8600 keys.release_commitment_secret(INITIAL_COMMITMENT_NUMBER - 1);
8601 let next_per_commitment_point = PublicKey::from_secret_key(&Secp256k1::new(),
8602 &SecretKey::from_slice(&keys.release_commitment_secret(INITIAL_COMMITMENT_NUMBER - 2)).unwrap());
8604 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(),
8605 &msgs::RevokeAndACK { channel_id, per_commitment_secret, next_per_commitment_point });
8606 assert_eq!(check_closed_broadcast!(nodes[1], true).unwrap().data, "Received an unexpected revoke_and_ack");
8607 check_added_monitors!(nodes[1], 1);
8611 fn test_bump_txn_sanitize_tracking_maps() {
8612 // Sanitizing pendning_claim_request and claimable_outpoints used to be buggy,
8613 // verify we clean then right after expiration of ANTI_REORG_DELAY.
8615 let chanmon_cfgs = create_chanmon_cfgs(2);
8616 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8617 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8618 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8620 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
8621 // Lock HTLC in both directions
8622 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000).0;
8623 route_payment(&nodes[1], &vec!(&nodes[0])[..], 9_000_000).0;
8625 let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan.2);
8626 assert_eq!(revoked_local_txn[0].input.len(), 1);
8627 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
8629 // Revoke local commitment tx
8630 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
8632 // Broadcast set of revoked txn on A
8633 connect_blocks(&nodes[0], TEST_FINAL_CLTV + 2 - CHAN_CONFIRM_DEPTH);
8634 expect_pending_htlcs_forwardable_ignore!(nodes[0]);
8635 assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 0);
8637 mine_transaction(&nodes[0], &revoked_local_txn[0]);
8638 check_closed_broadcast!(nodes[0], true);
8639 check_added_monitors!(nodes[0], 1);
8641 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8642 assert_eq!(node_txn.len(), 4); //ChannelMonitor: justice txn * 3, ChannelManager: local commitment tx
8643 check_spends!(node_txn[0], revoked_local_txn[0]);
8644 check_spends!(node_txn[1], revoked_local_txn[0]);
8645 check_spends!(node_txn[2], revoked_local_txn[0]);
8646 let penalty_txn = vec![node_txn[0].clone(), node_txn[1].clone(), node_txn[2].clone()];
8650 let header_130 = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8651 connect_block(&nodes[0], &Block { header: header_130, txdata: penalty_txn });
8652 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
8654 let monitors = nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap();
8655 if let Some(monitor) = monitors.get(&OutPoint { txid: chan.3.txid(), index: 0 }) {
8656 assert!(monitor.inner.lock().unwrap().onchain_tx_handler.pending_claim_requests.is_empty());
8657 assert!(monitor.inner.lock().unwrap().onchain_tx_handler.claimable_outpoints.is_empty());
8663 fn test_override_channel_config() {
8664 let chanmon_cfgs = create_chanmon_cfgs(2);
8665 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8666 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8667 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8669 // Node0 initiates a channel to node1 using the override config.
8670 let mut override_config = UserConfig::default();
8671 override_config.own_channel_config.our_to_self_delay = 200;
8673 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 16_000_000, 12_000_000, 42, Some(override_config)).unwrap();
8675 // Assert the channel created by node0 is using the override config.
8676 let res = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8677 assert_eq!(res.channel_flags, 0);
8678 assert_eq!(res.to_self_delay, 200);
8682 fn test_override_0msat_htlc_minimum() {
8683 let mut zero_config = UserConfig::default();
8684 zero_config.own_channel_config.our_htlc_minimum_msat = 0;
8685 let chanmon_cfgs = create_chanmon_cfgs(2);
8686 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8687 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, Some(zero_config.clone())]);
8688 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8690 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 16_000_000, 12_000_000, 42, Some(zero_config)).unwrap();
8691 let res = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8692 assert_eq!(res.htlc_minimum_msat, 1);
8694 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &res);
8695 let res = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
8696 assert_eq!(res.htlc_minimum_msat, 1);
8700 fn test_simple_mpp() {
8701 // Simple test of sending a multi-path payment.
8702 let chanmon_cfgs = create_chanmon_cfgs(4);
8703 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
8704 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
8705 let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
8707 let chan_1_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8708 let chan_2_id = create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8709 let chan_3_id = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8710 let chan_4_id = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8711 let logger = test_utils::TestLogger::new();
8713 let (payment_preimage, payment_hash, payment_secret) = get_payment_preimage_hash!(&nodes[3]);
8714 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
8715 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();
8716 let path = route.paths[0].clone();
8717 route.paths.push(path);
8718 route.paths[0][0].pubkey = nodes[1].node.get_our_node_id();
8719 route.paths[0][0].short_channel_id = chan_1_id;
8720 route.paths[0][1].short_channel_id = chan_3_id;
8721 route.paths[1][0].pubkey = nodes[2].node.get_our_node_id();
8722 route.paths[1][0].short_channel_id = chan_2_id;
8723 route.paths[1][1].short_channel_id = chan_4_id;
8724 send_along_route_with_secret(&nodes[0], route, &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], 200_000, payment_hash, payment_secret);
8725 claim_payment_along_route(&nodes[0], &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], false, payment_preimage);
8729 fn test_preimage_storage() {
8730 // Simple test of payment preimage storage allowing no client-side storage to claim payments
8731 let chanmon_cfgs = create_chanmon_cfgs(2);
8732 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8733 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8734 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8736 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8739 let (payment_hash, payment_secret) = nodes[1].node.create_inbound_payment(Some(100_000), 7200, 42);
8741 let logger = test_utils::TestLogger::new();
8742 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
8743 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();
8744 nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
8745 check_added_monitors!(nodes[0], 1);
8746 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
8747 let mut payment_event = SendEvent::from_event(events.pop().unwrap());
8748 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
8749 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
8751 // Note that after leaving the above scope we have no knowledge of any arguments or return
8752 // values from previous calls.
8753 expect_pending_htlcs_forwardable!(nodes[1]);
8754 let events = nodes[1].node.get_and_clear_pending_events();
8755 assert_eq!(events.len(), 1);
8757 Event::PaymentReceived { ref purpose, .. } => {
8759 PaymentPurpose::InvoicePayment { payment_preimage, user_payment_id, .. } => {
8760 assert_eq!(*user_payment_id, 42);
8761 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage.unwrap());
8763 _ => panic!("expected PaymentPurpose::InvoicePayment")
8766 _ => panic!("Unexpected event"),
8771 fn test_secret_timeout() {
8772 // Simple test of payment secret storage time outs
8773 let chanmon_cfgs = create_chanmon_cfgs(2);
8774 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8775 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8776 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8778 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8780 let (payment_hash, payment_secret_1) = nodes[1].node.create_inbound_payment(Some(100_000), 2, 0);
8782 // We should fail to register the same payment hash twice, at least until we've connected a
8783 // block with time 7200 + CHAN_CONFIRM_DEPTH + 1.
8784 if let Err(APIError::APIMisuseError { err }) = nodes[1].node.create_inbound_payment_for_hash(payment_hash, Some(100_000), 2, 0) {
8785 assert_eq!(err, "Duplicate payment hash");
8786 } else { panic!(); }
8788 let node_1_blocks = nodes[1].blocks.lock().unwrap();
8790 header: BlockHeader {
8792 prev_blockhash: node_1_blocks.last().unwrap().0.block_hash(),
8793 merkle_root: Default::default(),
8794 time: node_1_blocks.len() as u32 + 7200, bits: 42, nonce: 42 },
8798 connect_block(&nodes[1], &block);
8799 if let Err(APIError::APIMisuseError { err }) = nodes[1].node.create_inbound_payment_for_hash(payment_hash, Some(100_000), 2, 0) {
8800 assert_eq!(err, "Duplicate payment hash");
8801 } else { panic!(); }
8803 // If we then connect the second block, we should be able to register the same payment hash
8804 // again with a different user_payment_id (this time getting a new payment secret).
8805 block.header.prev_blockhash = block.header.block_hash();
8806 block.header.time += 1;
8807 connect_block(&nodes[1], &block);
8808 let our_payment_secret = nodes[1].node.create_inbound_payment_for_hash(payment_hash, Some(100_000), 2, 42).unwrap();
8809 assert_ne!(payment_secret_1, our_payment_secret);
8812 let logger = test_utils::TestLogger::new();
8813 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
8814 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();
8815 nodes[0].node.send_payment(&route, payment_hash, &Some(our_payment_secret)).unwrap();
8816 check_added_monitors!(nodes[0], 1);
8817 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
8818 let mut payment_event = SendEvent::from_event(events.pop().unwrap());
8819 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
8820 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
8822 // Note that after leaving the above scope we have no knowledge of any arguments or return
8823 // values from previous calls.
8824 expect_pending_htlcs_forwardable!(nodes[1]);
8825 let events = nodes[1].node.get_and_clear_pending_events();
8826 assert_eq!(events.len(), 1);
8828 Event::PaymentReceived { purpose: PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, user_payment_id }, .. } => {
8829 assert!(payment_preimage.is_none());
8830 assert_eq!(user_payment_id, 42);
8831 assert_eq!(payment_secret, our_payment_secret);
8832 // We don't actually have the payment preimage with which to claim this payment!
8834 _ => panic!("Unexpected event"),
8839 fn test_bad_secret_hash() {
8840 // Simple test of unregistered payment hash/invalid payment secret handling
8841 let chanmon_cfgs = create_chanmon_cfgs(2);
8842 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8843 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8844 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8846 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8848 let random_payment_hash = PaymentHash([42; 32]);
8849 let random_payment_secret = PaymentSecret([43; 32]);
8850 let (our_payment_hash, our_payment_secret) = nodes[1].node.create_inbound_payment(Some(100_000), 2, 0);
8852 let logger = test_utils::TestLogger::new();
8853 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
8854 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();
8856 // All the below cases should end up being handled exactly identically, so we macro the
8857 // resulting events.
8858 macro_rules! handle_unknown_invalid_payment_data {
8860 check_added_monitors!(nodes[0], 1);
8861 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
8862 let payment_event = SendEvent::from_event(events.pop().unwrap());
8863 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
8864 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
8866 // We have to forward pending HTLCs once to process the receipt of the HTLC and then
8867 // again to process the pending backwards-failure of the HTLC
8868 expect_pending_htlcs_forwardable!(nodes[1]);
8869 expect_pending_htlcs_forwardable!(nodes[1]);
8870 check_added_monitors!(nodes[1], 1);
8872 // We should fail the payment back
8873 let mut events = nodes[1].node.get_and_clear_pending_msg_events();
8874 match events.pop().unwrap() {
8875 MessageSendEvent::UpdateHTLCs { node_id: _, updates: msgs::CommitmentUpdate { update_fail_htlcs, commitment_signed, .. } } => {
8876 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
8877 commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false);
8879 _ => panic!("Unexpected event"),
8884 let expected_error_code = 0x4000|15; // incorrect_or_unknown_payment_details
8885 // Error data is the HTLC value (100,000) and current block height
8886 let expected_error_data = [0, 0, 0, 0, 0, 1, 0x86, 0xa0, 0, 0, 0, CHAN_CONFIRM_DEPTH as u8];
8888 // Send a payment with the right payment hash but the wrong payment secret
8889 nodes[0].node.send_payment(&route, our_payment_hash, &Some(random_payment_secret)).unwrap();
8890 handle_unknown_invalid_payment_data!();
8891 expect_payment_failed!(nodes[0], our_payment_hash, true, expected_error_code, expected_error_data);
8893 // Send a payment with a random payment hash, but the right payment secret
8894 nodes[0].node.send_payment(&route, random_payment_hash, &Some(our_payment_secret)).unwrap();
8895 handle_unknown_invalid_payment_data!();
8896 expect_payment_failed!(nodes[0], random_payment_hash, true, expected_error_code, expected_error_data);
8898 // Send a payment with a random payment hash and random payment secret
8899 nodes[0].node.send_payment(&route, random_payment_hash, &Some(random_payment_secret)).unwrap();
8900 handle_unknown_invalid_payment_data!();
8901 expect_payment_failed!(nodes[0], random_payment_hash, true, expected_error_code, expected_error_data);
8905 fn test_update_err_monitor_lockdown() {
8906 // Our monitor will lock update of local commitment transaction if a broadcastion condition
8907 // has been fulfilled (either force-close from Channel or block height requiring a HTLC-
8908 // timeout). Trying to update monitor after lockdown should return a ChannelMonitorUpdateErr.
8910 // This scenario may happen in a watchtower setup, where watchtower process a block height
8911 // triggering a timeout while a slow-block-processing ChannelManager receives a local signed
8912 // commitment at same time.
8914 let chanmon_cfgs = create_chanmon_cfgs(2);
8915 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8916 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8917 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8919 // Create some initial channel
8920 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
8921 let outpoint = OutPoint { txid: chan_1.3.txid(), index: 0 };
8923 // Rebalance the network to generate htlc in the two directions
8924 send_payment(&nodes[0], &vec!(&nodes[1])[..], 10_000_000);
8926 // Route a HTLC from node 0 to node 1 (but don't settle)
8927 let preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000).0;
8929 // Copy ChainMonitor to simulate a watchtower and update block height of node 0 until its ChannelMonitor timeout HTLC onchain
8930 let chain_source = test_utils::TestChainSource::new(Network::Testnet);
8931 let logger = test_utils::TestLogger::with_id(format!("node {}", 0));
8932 let persister = test_utils::TestPersister::new();
8934 let monitors = nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap();
8935 let monitor = monitors.get(&outpoint).unwrap();
8936 let mut w = test_utils::TestVecWriter(Vec::new());
8937 monitor.write(&mut w).unwrap();
8938 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingSigner>)>::read(
8939 &mut io::Cursor::new(&w.0), &test_utils::OnlyReadsKeysInterface {}).unwrap().1;
8940 assert!(new_monitor == *monitor);
8941 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);
8942 assert!(watchtower.watch_channel(outpoint, new_monitor).is_ok());
8945 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8946 // Make the tx_broadcaster aware of enough blocks that it doesn't think we're violating
8947 // transaction lock time requirements here.
8948 chanmon_cfgs[0].tx_broadcaster.blocks.lock().unwrap().resize(200, (header, 0));
8949 watchtower.chain_monitor.block_connected(&Block { header, txdata: vec![] }, 200);
8951 // Try to update ChannelMonitor
8952 assert!(nodes[1].node.claim_funds(preimage));
8953 check_added_monitors!(nodes[1], 1);
8954 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
8955 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
8956 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
8957 if let Some(ref mut channel) = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan_1.2) {
8958 if let Ok((_, _, _, update)) = channel.commitment_signed(&updates.commitment_signed, &node_cfgs[0].fee_estimator, &node_cfgs[0].logger) {
8959 if let Err(_) = watchtower.chain_monitor.update_channel(outpoint, update.clone()) {} else { assert!(false); }
8960 if let Ok(_) = nodes[0].chain_monitor.update_channel(outpoint, update) {} else { assert!(false); }
8961 } else { assert!(false); }
8962 } else { assert!(false); };
8963 // Our local monitor is in-sync and hasn't processed yet timeout
8964 check_added_monitors!(nodes[0], 1);
8965 let events = nodes[0].node.get_and_clear_pending_events();
8966 assert_eq!(events.len(), 1);
8970 fn test_concurrent_monitor_claim() {
8971 // Watchtower A receives block, broadcasts state N, then channel receives new state N+1,
8972 // sending it to both watchtowers, Bob accepts N+1, then receives block and broadcasts
8973 // the latest state N+1, Alice rejects state N+1, but Bob has already broadcast it,
8974 // state N+1 confirms. Alice claims output from state N+1.
8976 let chanmon_cfgs = create_chanmon_cfgs(2);
8977 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8978 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8979 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8981 // Create some initial channel
8982 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
8983 let outpoint = OutPoint { txid: chan_1.3.txid(), index: 0 };
8985 // Rebalance the network to generate htlc in the two directions
8986 send_payment(&nodes[0], &vec!(&nodes[1])[..], 10_000_000);
8988 // Route a HTLC from node 0 to node 1 (but don't settle)
8989 route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000).0;
8991 // Copy ChainMonitor to simulate watchtower Alice and update block height her ChannelMonitor timeout HTLC onchain
8992 let chain_source = test_utils::TestChainSource::new(Network::Testnet);
8993 let logger = test_utils::TestLogger::with_id(format!("node {}", "Alice"));
8994 let persister = test_utils::TestPersister::new();
8995 let watchtower_alice = {
8996 let monitors = nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap();
8997 let monitor = monitors.get(&outpoint).unwrap();
8998 let mut w = test_utils::TestVecWriter(Vec::new());
8999 monitor.write(&mut w).unwrap();
9000 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingSigner>)>::read(
9001 &mut io::Cursor::new(&w.0), &test_utils::OnlyReadsKeysInterface {}).unwrap().1;
9002 assert!(new_monitor == *monitor);
9003 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);
9004 assert!(watchtower.watch_channel(outpoint, new_monitor).is_ok());
9007 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
9008 // Make the tx_broadcaster aware of enough blocks that it doesn't think we're violating
9009 // transaction lock time requirements here.
9010 chanmon_cfgs[0].tx_broadcaster.blocks.lock().unwrap().resize((CHAN_CONFIRM_DEPTH + 1 + TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS) as usize, (header, 0));
9011 watchtower_alice.chain_monitor.block_connected(&Block { header, txdata: vec![] }, CHAN_CONFIRM_DEPTH + 1 + TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS);
9013 // Watchtower Alice should have broadcast a commitment/HTLC-timeout
9015 let mut txn = chanmon_cfgs[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
9016 assert_eq!(txn.len(), 2);
9020 // Copy ChainMonitor to simulate watchtower Bob and make it receive a commitment update first.
9021 let chain_source = test_utils::TestChainSource::new(Network::Testnet);
9022 let logger = test_utils::TestLogger::with_id(format!("node {}", "Bob"));
9023 let persister = test_utils::TestPersister::new();
9024 let watchtower_bob = {
9025 let monitors = nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap();
9026 let monitor = monitors.get(&outpoint).unwrap();
9027 let mut w = test_utils::TestVecWriter(Vec::new());
9028 monitor.write(&mut w).unwrap();
9029 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingSigner>)>::read(
9030 &mut io::Cursor::new(&w.0), &test_utils::OnlyReadsKeysInterface {}).unwrap().1;
9031 assert!(new_monitor == *monitor);
9032 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);
9033 assert!(watchtower.watch_channel(outpoint, new_monitor).is_ok());
9036 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
9037 watchtower_bob.chain_monitor.block_connected(&Block { header, txdata: vec![] }, CHAN_CONFIRM_DEPTH + TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS);
9039 // Route another payment to generate another update with still previous HTLC pending
9040 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[0]);
9042 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
9043 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();
9044 nodes[1].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
9046 check_added_monitors!(nodes[1], 1);
9048 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
9049 assert_eq!(updates.update_add_htlcs.len(), 1);
9050 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &updates.update_add_htlcs[0]);
9051 if let Some(ref mut channel) = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan_1.2) {
9052 if let Ok((_, _, _, update)) = channel.commitment_signed(&updates.commitment_signed, &node_cfgs[0].fee_estimator, &node_cfgs[0].logger) {
9053 // Watchtower Alice should already have seen the block and reject the update
9054 if let Err(_) = watchtower_alice.chain_monitor.update_channel(outpoint, update.clone()) {} else { assert!(false); }
9055 if let Ok(_) = watchtower_bob.chain_monitor.update_channel(outpoint, update.clone()) {} else { assert!(false); }
9056 if let Ok(_) = nodes[0].chain_monitor.update_channel(outpoint, update) {} else { assert!(false); }
9057 } else { assert!(false); }
9058 } else { assert!(false); };
9059 // Our local monitor is in-sync and hasn't processed yet timeout
9060 check_added_monitors!(nodes[0], 1);
9062 //// Provide one more block to watchtower Bob, expect broadcast of commitment and HTLC-Timeout
9063 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
9064 watchtower_bob.chain_monitor.block_connected(&Block { header, txdata: vec![] }, CHAN_CONFIRM_DEPTH + 1 + TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS);
9066 // Watchtower Bob should have broadcast a commitment/HTLC-timeout
9069 let mut txn = chanmon_cfgs[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
9070 assert_eq!(txn.len(), 2);
9071 bob_state_y = txn[0].clone();
9075 // We confirm Bob's state Y on Alice, she should broadcast a HTLC-timeout
9076 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
9077 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);
9079 let htlc_txn = chanmon_cfgs[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
9080 // We broadcast twice the transaction, once due to the HTLC-timeout, once due
9081 // the onchain detection of the HTLC output
9082 assert_eq!(htlc_txn.len(), 2);
9083 check_spends!(htlc_txn[0], bob_state_y);
9084 check_spends!(htlc_txn[1], bob_state_y);
9089 fn test_pre_lockin_no_chan_closed_update() {
9090 // Test that if a peer closes a channel in response to a funding_created message we don't
9091 // generate a channel update (as the channel cannot appear on chain without a funding_signed
9094 // Doing so would imply a channel monitor update before the initial channel monitor
9095 // registration, violating our API guarantees.
9097 // Previously, full_stack_target managed to hit this case by opening then closing a channel,
9098 // then opening a second channel with the same funding output as the first (which is not
9099 // rejected because the first channel does not exist in the ChannelManager) and closing it
9100 // before receiving funding_signed.
9101 let chanmon_cfgs = create_chanmon_cfgs(2);
9102 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
9103 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
9104 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
9106 // Create an initial channel
9107 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
9108 let mut open_chan_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
9109 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_msg);
9110 let accept_chan_msg = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
9111 nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &accept_chan_msg);
9113 // Move the first channel through the funding flow...
9114 let (temporary_channel_id, tx, _) = create_funding_transaction(&nodes[0], 100000, 42);
9116 nodes[0].node.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
9117 check_added_monitors!(nodes[0], 0);
9119 let funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
9120 let channel_id = ::chain::transaction::OutPoint { txid: funding_created_msg.funding_txid, index: funding_created_msg.funding_output_index }.to_channel_id();
9121 nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msgs::ErrorMessage { channel_id, data: "Hi".to_owned() });
9122 assert!(nodes[0].chain_monitor.added_monitors.lock().unwrap().is_empty());
9126 fn test_htlc_no_detection() {
9127 // This test is a mutation to underscore the detection logic bug we had
9128 // before #653. HTLC value routed is above the remaining balance, thus
9129 // inverting HTLC and `to_remote` output. HTLC will come second and
9130 // it wouldn't be seen by pre-#653 detection as we were enumerate()'ing
9131 // on a watched outputs vector (Vec<TxOut>) thus implicitly relying on
9132 // outputs order detection for correct spending children filtring.
9134 let chanmon_cfgs = create_chanmon_cfgs(2);
9135 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
9136 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
9137 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
9139 // Create some initial channels
9140 let chan_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
9142 send_payment(&nodes[0], &vec!(&nodes[1])[..], 1_000_000);
9143 let (_, our_payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 2_000_000);
9144 let local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
9145 assert_eq!(local_txn[0].input.len(), 1);
9146 assert_eq!(local_txn[0].output.len(), 3);
9147 check_spends!(local_txn[0], chan_1.3);
9149 // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
9150 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
9151 connect_block(&nodes[0], &Block { header, txdata: vec![local_txn[0].clone()] });
9152 // We deliberately connect the local tx twice as this should provoke a failure calling
9153 // this test before #653 fix.
9154 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);
9155 check_closed_broadcast!(nodes[0], true);
9156 check_added_monitors!(nodes[0], 1);
9157 connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1);
9159 let htlc_timeout = {
9160 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
9161 assert_eq!(node_txn[1].input.len(), 1);
9162 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
9163 check_spends!(node_txn[1], local_txn[0]);
9167 let header_201 = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
9168 connect_block(&nodes[0], &Block { header: header_201, txdata: vec![htlc_timeout.clone()] });
9169 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
9170 expect_payment_failed!(nodes[0], our_payment_hash, true);
9173 fn do_test_onchain_htlc_settlement_after_close(broadcast_alice: bool, go_onchain_before_fulfill: bool) {
9174 // If we route an HTLC, then learn the HTLC's preimage after the upstream channel has been
9175 // force-closed, we must claim that HTLC on-chain. (Given an HTLC forwarded from Alice --> Bob -->
9176 // Carol, Alice would be the upstream node, and Carol the downstream.)
9178 // Steps of the test:
9179 // 1) Alice sends a HTLC to Carol through Bob.
9180 // 2) Carol doesn't settle the HTLC.
9181 // 3) If broadcast_alice is true, Alice force-closes her channel with Bob. Else Bob force closes.
9182 // Steps 4 and 5 may be reordered depending on go_onchain_before_fulfill.
9183 // 4) Bob sees the Alice's commitment on his chain or vice versa. An offered output is present
9184 // but can't be claimed as Bob doesn't have yet knowledge of the preimage.
9185 // 5) Carol release the preimage to Bob off-chain.
9186 // 6) Bob claims the offered output on the broadcasted commitment.
9187 let chanmon_cfgs = create_chanmon_cfgs(3);
9188 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
9189 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
9190 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
9192 // Create some initial channels
9193 let chan_ab = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
9194 create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 100000, 10001, InitFeatures::known(), InitFeatures::known());
9196 // Steps (1) and (2):
9197 // Send an HTLC Alice --> Bob --> Carol, but Carol doesn't settle the HTLC back.
9198 let (payment_preimage, _payment_hash, _payment_secret) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3_000_000);
9200 // Check that Alice's commitment transaction now contains an output for this HTLC.
9201 let alice_txn = get_local_commitment_txn!(nodes[0], chan_ab.2);
9202 check_spends!(alice_txn[0], chan_ab.3);
9203 assert_eq!(alice_txn[0].output.len(), 2);
9204 check_spends!(alice_txn[1], alice_txn[0]); // 2nd transaction is a non-final HTLC-timeout
9205 assert_eq!(alice_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
9206 assert_eq!(alice_txn.len(), 2);
9208 // Steps (3) and (4):
9209 // If `go_onchain_before_fufill`, broadcast the relevant commitment transaction and check that Bob
9210 // responds by (1) broadcasting a channel update and (2) adding a new ChannelMonitor.
9211 let mut force_closing_node = 0; // Alice force-closes
9212 if !broadcast_alice { force_closing_node = 1; } // Bob force-closes
9213 nodes[force_closing_node].node.force_close_channel(&chan_ab.2).unwrap();
9214 check_closed_broadcast!(nodes[force_closing_node], true);
9215 check_added_monitors!(nodes[force_closing_node], 1);
9216 if go_onchain_before_fulfill {
9217 let txn_to_broadcast = match broadcast_alice {
9218 true => alice_txn.clone(),
9219 false => get_local_commitment_txn!(nodes[1], chan_ab.2)
9221 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
9222 connect_block(&nodes[1], &Block { header, txdata: vec![txn_to_broadcast[0].clone()]});
9223 let mut bob_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
9224 if broadcast_alice {
9225 check_closed_broadcast!(nodes[1], true);
9226 check_added_monitors!(nodes[1], 1);
9228 assert_eq!(bob_txn.len(), 1);
9229 check_spends!(bob_txn[0], chan_ab.3);
9233 // Carol then claims the funds and sends an update_fulfill message to Bob, and they go through the
9234 // process of removing the HTLC from their commitment transactions.
9235 assert!(nodes[2].node.claim_funds(payment_preimage));
9236 check_added_monitors!(nodes[2], 1);
9237 let carol_updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
9238 assert!(carol_updates.update_add_htlcs.is_empty());
9239 assert!(carol_updates.update_fail_htlcs.is_empty());
9240 assert!(carol_updates.update_fail_malformed_htlcs.is_empty());
9241 assert!(carol_updates.update_fee.is_none());
9242 assert_eq!(carol_updates.update_fulfill_htlcs.len(), 1);
9244 nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &carol_updates.update_fulfill_htlcs[0]);
9245 expect_payment_forwarded!(nodes[1], if go_onchain_before_fulfill || force_closing_node == 1 { None } else { Some(1000) }, false);
9246 // If Alice broadcasted but Bob doesn't know yet, here he prepares to tell her about the preimage.
9247 if !go_onchain_before_fulfill && broadcast_alice {
9248 let events = nodes[1].node.get_and_clear_pending_msg_events();
9249 assert_eq!(events.len(), 1);
9251 MessageSendEvent::UpdateHTLCs { ref node_id, .. } => {
9252 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
9254 _ => panic!("Unexpected event"),
9257 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &carol_updates.commitment_signed);
9258 // One monitor update for the preimage to update the Bob<->Alice channel, one monitor update
9259 // Carol<->Bob's updated commitment transaction info.
9260 check_added_monitors!(nodes[1], 2);
9262 let events = nodes[1].node.get_and_clear_pending_msg_events();
9263 assert_eq!(events.len(), 2);
9264 let bob_revocation = match events[0] {
9265 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
9266 assert_eq!(*node_id, nodes[2].node.get_our_node_id());
9269 _ => panic!("Unexpected event"),
9271 let bob_updates = match events[1] {
9272 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
9273 assert_eq!(*node_id, nodes[2].node.get_our_node_id());
9276 _ => panic!("Unexpected event"),
9279 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bob_revocation);
9280 check_added_monitors!(nodes[2], 1);
9281 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bob_updates.commitment_signed);
9282 check_added_monitors!(nodes[2], 1);
9284 let events = nodes[2].node.get_and_clear_pending_msg_events();
9285 assert_eq!(events.len(), 1);
9286 let carol_revocation = match events[0] {
9287 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
9288 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
9291 _ => panic!("Unexpected event"),
9293 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &carol_revocation);
9294 check_added_monitors!(nodes[1], 1);
9296 // If this test requires the force-closed channel to not be on-chain until after the fulfill,
9297 // here's where we put said channel's commitment tx on-chain.
9298 let mut txn_to_broadcast = alice_txn.clone();
9299 if !broadcast_alice { txn_to_broadcast = get_local_commitment_txn!(nodes[1], chan_ab.2); }
9300 if !go_onchain_before_fulfill {
9301 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
9302 connect_block(&nodes[1], &Block { header, txdata: vec![txn_to_broadcast[0].clone()]});
9303 // If Bob was the one to force-close, he will have already passed these checks earlier.
9304 if broadcast_alice {
9305 check_closed_broadcast!(nodes[1], true);
9306 check_added_monitors!(nodes[1], 1);
9308 let mut bob_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
9309 if broadcast_alice {
9310 // In `connect_block()`, the ChainMonitor and ChannelManager are separately notified about a
9311 // new block being connected. The ChannelManager being notified triggers a monitor update,
9312 // which triggers broadcasting our commitment tx and an HTLC-claiming tx. The ChainMonitor
9313 // being notified triggers the HTLC-claiming tx redundantly, resulting in 3 total txs being
9315 assert_eq!(bob_txn.len(), 3);
9316 check_spends!(bob_txn[1], chan_ab.3);
9318 assert_eq!(bob_txn.len(), 2);
9319 check_spends!(bob_txn[0], chan_ab.3);
9324 // Finally, check that Bob broadcasted a preimage-claiming transaction for the HTLC output on the
9325 // broadcasted commitment transaction.
9327 let bob_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
9328 if go_onchain_before_fulfill {
9329 // Bob should now have an extra broadcasted tx, for the preimage-claiming transaction.
9330 assert_eq!(bob_txn.len(), 2);
9332 let script_weight = match broadcast_alice {
9333 true => OFFERED_HTLC_SCRIPT_WEIGHT,
9334 false => ACCEPTED_HTLC_SCRIPT_WEIGHT
9336 // If Alice force-closed and Bob didn't receive her commitment transaction until after he
9337 // received Carol's fulfill, he broadcasts the HTLC-output-claiming transaction first. Else if
9338 // Bob force closed or if he found out about Alice's commitment tx before receiving Carol's
9339 // fulfill, then he broadcasts the HTLC-output-claiming transaction second.
9340 if broadcast_alice && !go_onchain_before_fulfill {
9341 check_spends!(bob_txn[0], txn_to_broadcast[0]);
9342 assert_eq!(bob_txn[0].input[0].witness.last().unwrap().len(), script_weight);
9344 check_spends!(bob_txn[1], txn_to_broadcast[0]);
9345 assert_eq!(bob_txn[1].input[0].witness.last().unwrap().len(), script_weight);
9351 fn test_onchain_htlc_settlement_after_close() {
9352 do_test_onchain_htlc_settlement_after_close(true, true);
9353 do_test_onchain_htlc_settlement_after_close(false, true); // Technically redundant, but may as well
9354 do_test_onchain_htlc_settlement_after_close(true, false);
9355 do_test_onchain_htlc_settlement_after_close(false, false);
9359 fn test_duplicate_chan_id() {
9360 // Test that if a given peer tries to open a channel with the same channel_id as one that is
9361 // already open we reject it and keep the old channel.
9363 // Previously, full_stack_target managed to figure out that if you tried to open two channels
9364 // with the same funding output (ie post-funding channel_id), we'd create a monitor update for
9365 // the existing channel when we detect the duplicate new channel, screwing up our monitor
9366 // updating logic for the existing channel.
9367 let chanmon_cfgs = create_chanmon_cfgs(2);
9368 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
9369 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
9370 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
9372 // Create an initial channel
9373 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
9374 let mut open_chan_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
9375 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_msg);
9376 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()));
9378 // Try to create a second channel with the same temporary_channel_id as the first and check
9379 // that it is rejected.
9380 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_msg);
9382 let events = nodes[1].node.get_and_clear_pending_msg_events();
9383 assert_eq!(events.len(), 1);
9385 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
9386 // Technically, at this point, nodes[1] would be justified in thinking both the
9387 // first (valid) and second (invalid) channels are closed, given they both have
9388 // the same non-temporary channel_id. However, currently we do not, so we just
9389 // move forward with it.
9390 assert_eq!(msg.channel_id, open_chan_msg.temporary_channel_id);
9391 assert_eq!(node_id, nodes[0].node.get_our_node_id());
9393 _ => panic!("Unexpected event"),
9397 // Move the first channel through the funding flow...
9398 let (temporary_channel_id, tx, funding_output) = create_funding_transaction(&nodes[0], 100000, 42);
9400 nodes[0].node.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
9401 check_added_monitors!(nodes[0], 0);
9403 let mut funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
9404 nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created_msg);
9406 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
9407 assert_eq!(added_monitors.len(), 1);
9408 assert_eq!(added_monitors[0].0, funding_output);
9409 added_monitors.clear();
9411 let funding_signed_msg = get_event_msg!(nodes[1], MessageSendEvent::SendFundingSigned, nodes[0].node.get_our_node_id());
9413 let funding_outpoint = ::chain::transaction::OutPoint { txid: funding_created_msg.funding_txid, index: funding_created_msg.funding_output_index };
9414 let channel_id = funding_outpoint.to_channel_id();
9416 // Now we have the first channel past funding_created (ie it has a txid-based channel_id, not a
9419 // First try to open a second channel with a temporary channel id equal to the txid-based one.
9420 // Technically this is allowed by the spec, but we don't support it and there's little reason
9421 // to. Still, it shouldn't cause any other issues.
9422 open_chan_msg.temporary_channel_id = channel_id;
9423 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_msg);
9425 let events = nodes[1].node.get_and_clear_pending_msg_events();
9426 assert_eq!(events.len(), 1);
9428 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
9429 // Technically, at this point, nodes[1] would be justified in thinking both
9430 // channels are closed, but currently we do not, so we just move forward with it.
9431 assert_eq!(msg.channel_id, open_chan_msg.temporary_channel_id);
9432 assert_eq!(node_id, nodes[0].node.get_our_node_id());
9434 _ => panic!("Unexpected event"),
9438 // Now try to create a second channel which has a duplicate funding output.
9439 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
9440 let open_chan_2_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
9441 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_2_msg);
9442 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()));
9443 create_funding_transaction(&nodes[0], 100000, 42); // Get and check the FundingGenerationReady event
9445 let funding_created = {
9446 let mut a_channel_lock = nodes[0].node.channel_state.lock().unwrap();
9447 let mut as_chan = a_channel_lock.by_id.get_mut(&open_chan_2_msg.temporary_channel_id).unwrap();
9448 let logger = test_utils::TestLogger::new();
9449 as_chan.get_outbound_funding_created(tx.clone(), funding_outpoint, &&logger).unwrap()
9451 check_added_monitors!(nodes[0], 0);
9452 nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created);
9453 // At this point we'll try to add a duplicate channel monitor, which will be rejected, but
9454 // still needs to be cleared here.
9455 check_added_monitors!(nodes[1], 1);
9457 // ...still, nodes[1] will reject the duplicate channel.
9459 let events = nodes[1].node.get_and_clear_pending_msg_events();
9460 assert_eq!(events.len(), 1);
9462 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
9463 // Technically, at this point, nodes[1] would be justified in thinking both
9464 // channels are closed, but currently we do not, so we just move forward with it.
9465 assert_eq!(msg.channel_id, channel_id);
9466 assert_eq!(node_id, nodes[0].node.get_our_node_id());
9468 _ => panic!("Unexpected event"),
9472 // finally, finish creating the original channel and send a payment over it to make sure
9473 // everything is functional.
9474 nodes[0].node.handle_funding_signed(&nodes[1].node.get_our_node_id(), &funding_signed_msg);
9476 let mut added_monitors = nodes[0].chain_monitor.added_monitors.lock().unwrap();
9477 assert_eq!(added_monitors.len(), 1);
9478 assert_eq!(added_monitors[0].0, funding_output);
9479 added_monitors.clear();
9482 let events_4 = nodes[0].node.get_and_clear_pending_events();
9483 assert_eq!(events_4.len(), 0);
9484 assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
9485 assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0].txid(), funding_output.txid);
9487 let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
9488 let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
9489 update_nodes_with_chan_announce(&nodes, 0, 1, &announcement, &as_update, &bs_update);
9490 send_payment(&nodes[0], &[&nodes[1]], 8000000);
9494 fn test_error_chans_closed() {
9495 // Test that we properly handle error messages, closing appropriate channels.
9497 // Prior to #787 we'd allow a peer to make us force-close a channel we had with a different
9498 // peer. The "real" fix for that is to index channels with peers_ids, however in the mean time
9499 // we can test various edge cases around it to ensure we don't regress.
9500 let chanmon_cfgs = create_chanmon_cfgs(3);
9501 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
9502 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
9503 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
9505 // Create some initial channels
9506 let chan_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
9507 let chan_2 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
9508 let chan_3 = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 100000, 10001, InitFeatures::known(), InitFeatures::known());
9510 assert_eq!(nodes[0].node.list_usable_channels().len(), 3);
9511 assert_eq!(nodes[1].node.list_usable_channels().len(), 2);
9512 assert_eq!(nodes[2].node.list_usable_channels().len(), 1);
9514 // Closing a channel from a different peer has no effect
9515 nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msgs::ErrorMessage { channel_id: chan_3.2, data: "ERR".to_owned() });
9516 assert_eq!(nodes[0].node.list_usable_channels().len(), 3);
9518 // Closing one channel doesn't impact others
9519 nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msgs::ErrorMessage { channel_id: chan_2.2, data: "ERR".to_owned() });
9520 check_added_monitors!(nodes[0], 1);
9521 check_closed_broadcast!(nodes[0], false);
9522 assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0).len(), 1);
9523 assert_eq!(nodes[0].node.list_usable_channels().len(), 2);
9524 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);
9525 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);
9527 // A null channel ID should close all channels
9528 let _chan_4 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
9529 nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msgs::ErrorMessage { channel_id: [0; 32], data: "ERR".to_owned() });
9530 check_added_monitors!(nodes[0], 2);
9531 let events = nodes[0].node.get_and_clear_pending_msg_events();
9532 assert_eq!(events.len(), 2);
9534 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
9535 assert_eq!(msg.contents.flags & 2, 2);
9537 _ => panic!("Unexpected event"),
9540 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
9541 assert_eq!(msg.contents.flags & 2, 2);
9543 _ => panic!("Unexpected event"),
9545 // Note that at this point users of a standard PeerHandler will end up calling
9546 // peer_disconnected with no_connection_possible set to false, duplicating the
9547 // close-all-channels logic. That's OK, we don't want to end up not force-closing channels for
9548 // users with their own peer handling logic. We duplicate the call here, however.
9549 assert_eq!(nodes[0].node.list_usable_channels().len(), 1);
9550 assert!(nodes[0].node.list_usable_channels()[0].channel_id == chan_3.2);
9552 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), true);
9553 assert_eq!(nodes[0].node.list_usable_channels().len(), 1);
9554 assert!(nodes[0].node.list_usable_channels()[0].channel_id == chan_3.2);
9558 fn test_invalid_funding_tx() {
9559 // Test that we properly handle invalid funding transactions sent to us from a peer.
9561 // Previously, all other major lightning implementations had failed to properly sanitize
9562 // funding transactions from their counterparties, leading to a multi-implementation critical
9563 // security vulnerability (though we always sanitized properly, we've previously had
9564 // un-released crashes in the sanitization process).
9565 let chanmon_cfgs = create_chanmon_cfgs(2);
9566 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
9567 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
9568 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
9570 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100_000, 10_000, 42, None).unwrap();
9571 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()));
9572 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()));
9574 let (temporary_channel_id, mut tx, _) = create_funding_transaction(&nodes[0], 100_000, 42);
9575 for output in tx.output.iter_mut() {
9576 // Make the confirmed funding transaction have a bogus script_pubkey
9577 output.script_pubkey = bitcoin::Script::new();
9580 nodes[0].node.funding_transaction_generated_unchecked(&temporary_channel_id, tx.clone(), 0).unwrap();
9581 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()));
9582 check_added_monitors!(nodes[1], 1);
9584 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()));
9585 check_added_monitors!(nodes[0], 1);
9587 let events_1 = nodes[0].node.get_and_clear_pending_events();
9588 assert_eq!(events_1.len(), 0);
9590 assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
9591 assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0], tx);
9592 nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
9594 confirm_transaction_at(&nodes[1], &tx, 1);
9595 check_added_monitors!(nodes[1], 1);
9596 let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
9597 assert_eq!(events_2.len(), 1);
9598 if let MessageSendEvent::HandleError { node_id, action } = &events_2[0] {
9599 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
9600 if let msgs::ErrorAction::SendErrorMessage { msg } = action {
9601 assert_eq!(msg.data, "funding tx had wrong script/value or output index");
9602 } else { panic!(); }
9603 } else { panic!(); }
9604 assert_eq!(nodes[1].node.list_channels().len(), 0);
9607 fn do_test_tx_confirmed_skipping_blocks_immediate_broadcast(test_height_before_timelock: bool) {
9608 // In the first version of the chain::Confirm interface, after a refactor was made to not
9609 // broadcast CSV-locked transactions until their CSV lock is up, we wouldn't reliably broadcast
9610 // transactions after a `transactions_confirmed` call. Specifically, if the chain, provided via
9611 // `best_block_updated` is at height N, and a transaction output which we wish to spend at
9612 // height N-1 (due to a CSV to height N-1) is provided at height N, we will not broadcast the
9613 // spending transaction until height N+1 (or greater). This was due to the way
9614 // `ChannelMonitor::transactions_confirmed` worked, only checking if we should broadcast a
9615 // spending transaction at the height the input transaction was confirmed at, not whether we
9616 // should broadcast a spending transaction at the current height.
9617 // A second, similar, issue involved failing HTLCs backwards - because we only provided the
9618 // height at which transactions were confirmed to `OnchainTx::update_claims_view`, it wasn't
9619 // aware that the anti-reorg-delay had, in fact, already expired, waiting to fail-backwards
9620 // until we learned about an additional block.
9622 // As an additional check, if `test_height_before_timelock` is set, we instead test that we
9623 // aren't broadcasting transactions too early (ie not broadcasting them at all).
9624 let chanmon_cfgs = create_chanmon_cfgs(3);
9625 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
9626 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
9627 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
9628 *nodes[0].connect_style.borrow_mut() = ConnectStyle::BestBlockFirstSkippingBlocks;
9630 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
9631 let (chan_announce, _, channel_id, _) = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
9632 let (_, payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1_000_000);
9633 nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id(), false);
9634 nodes[2].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
9636 nodes[1].node.force_close_channel(&channel_id).unwrap();
9637 check_closed_broadcast!(nodes[1], true);
9638 check_added_monitors!(nodes[1], 1);
9639 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
9640 assert_eq!(node_txn.len(), 1);
9642 let conf_height = nodes[1].best_block_info().1;
9643 if !test_height_before_timelock {
9644 connect_blocks(&nodes[1], 24 * 6);
9646 nodes[1].chain_monitor.chain_monitor.transactions_confirmed(
9647 &nodes[1].get_block_header(conf_height), &[(0, &node_txn[0])], conf_height);
9648 if test_height_before_timelock {
9649 // If we confirmed the close transaction, but timelocks have not yet expired, we should not
9650 // generate any events or broadcast any transactions
9651 assert!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
9652 assert!(nodes[1].chain_monitor.chain_monitor.get_and_clear_pending_events().is_empty());
9654 // We should broadcast an HTLC transaction spending our funding transaction first
9655 let spending_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
9656 assert_eq!(spending_txn.len(), 2);
9657 assert_eq!(spending_txn[0], node_txn[0]);
9658 check_spends!(spending_txn[1], node_txn[0]);
9659 // We should also generate a SpendableOutputs event with the to_self output (as its
9661 let descriptor_spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
9662 assert_eq!(descriptor_spend_txn.len(), 1);
9664 // If we also discover that the HTLC-Timeout transaction was confirmed some time ago, we
9665 // should immediately fail-backwards the HTLC to the previous hop, without waiting for an
9666 // additional block built on top of the current chain.
9667 nodes[1].chain_monitor.chain_monitor.transactions_confirmed(
9668 &nodes[1].get_block_header(conf_height + 1), &[(0, &spending_txn[1])], conf_height + 1);
9669 expect_pending_htlcs_forwardable!(nodes[1]);
9670 check_added_monitors!(nodes[1], 1);
9672 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
9673 assert!(updates.update_add_htlcs.is_empty());
9674 assert!(updates.update_fulfill_htlcs.is_empty());
9675 assert_eq!(updates.update_fail_htlcs.len(), 1);
9676 assert!(updates.update_fail_malformed_htlcs.is_empty());
9677 assert!(updates.update_fee.is_none());
9678 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
9679 commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, true, true);
9680 expect_payment_failed!(nodes[0], payment_hash, false);
9681 expect_payment_failure_chan_update!(nodes[0], chan_announce.contents.short_channel_id, true);
9686 fn test_tx_confirmed_skipping_blocks_immediate_broadcast() {
9687 do_test_tx_confirmed_skipping_blocks_immediate_broadcast(false);
9688 do_test_tx_confirmed_skipping_blocks_immediate_broadcast(true);
9692 fn test_keysend_payments_to_public_node() {
9693 let chanmon_cfgs = create_chanmon_cfgs(2);
9694 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
9695 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
9696 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
9698 let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
9699 let network_graph = nodes[0].net_graph_msg_handler.network_graph.read().unwrap();
9700 let payer_pubkey = nodes[0].node.get_our_node_id();
9701 let payee_pubkey = nodes[1].node.get_our_node_id();
9702 let route = get_route(&payer_pubkey, &network_graph, &payee_pubkey, None,
9703 None, &vec![], 10000, 40,
9704 nodes[0].logger).unwrap();
9706 let test_preimage = PaymentPreimage([42; 32]);
9707 let payment_hash = nodes[0].node.send_spontaneous_payment(&route, Some(test_preimage)).unwrap();
9708 check_added_monitors!(nodes[0], 1);
9709 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
9710 assert_eq!(events.len(), 1);
9711 let event = events.pop().unwrap();
9712 let path = vec![&nodes[1]];
9713 pass_along_path(&nodes[0], &path, 10000, payment_hash, None, event, true, Some(test_preimage));
9714 claim_payment(&nodes[0], &path, test_preimage);
9718 fn test_keysend_payments_to_private_node() {
9719 let chanmon_cfgs = create_chanmon_cfgs(2);
9720 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
9721 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
9722 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
9724 let payer_pubkey = nodes[0].node.get_our_node_id();
9725 let payee_pubkey = nodes[1].node.get_our_node_id();
9726 nodes[0].node.peer_connected(&payee_pubkey, &msgs::Init { features: InitFeatures::known() });
9727 nodes[1].node.peer_connected(&payer_pubkey, &msgs::Init { features: InitFeatures::known() });
9729 let _chan = create_chan_between_nodes(&nodes[0], &nodes[1], InitFeatures::known(), InitFeatures::known());
9730 let network_graph = nodes[0].net_graph_msg_handler.network_graph.read().unwrap();
9731 let first_hops = nodes[0].node.list_usable_channels();
9732 let route = get_keysend_route(&payer_pubkey, &network_graph, &payee_pubkey,
9733 Some(&first_hops.iter().collect::<Vec<_>>()), &vec![], 10000, 40,
9734 nodes[0].logger).unwrap();
9736 let test_preimage = PaymentPreimage([42; 32]);
9737 let payment_hash = nodes[0].node.send_spontaneous_payment(&route, Some(test_preimage)).unwrap();
9738 check_added_monitors!(nodes[0], 1);
9739 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
9740 assert_eq!(events.len(), 1);
9741 let event = events.pop().unwrap();
9742 let path = vec![&nodes[1]];
9743 pass_along_path(&nodes[0], &path, 10000, payment_hash, None, event, true, Some(test_preimage));
9744 claim_payment(&nodes[0], &path, test_preimage);