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;
64 fn test_insane_channel_opens() {
65 // Stand up a network of 2 nodes
66 let chanmon_cfgs = create_chanmon_cfgs(2);
67 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
68 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
69 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
71 // Instantiate channel parameters where we push the maximum msats given our
73 let channel_value_sat = 31337; // same as funding satoshis
74 let channel_reserve_satoshis = Channel::<EnforcingSigner>::get_holder_selected_channel_reserve_satoshis(channel_value_sat);
75 let push_msat = (channel_value_sat - channel_reserve_satoshis) * 1000;
77 // Have node0 initiate a channel to node1 with aforementioned parameters
78 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_sat, push_msat, 42, None).unwrap();
80 // Extract the channel open message from node0 to node1
81 let open_channel_message = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
83 // Test helper that asserts we get the correct error string given a mutator
84 // that supposedly makes the channel open message insane
85 let insane_open_helper = |expected_error_str: &str, message_mutator: fn(msgs::OpenChannel) -> msgs::OpenChannel| {
86 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &message_mutator(open_channel_message.clone()));
87 let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
88 assert_eq!(msg_events.len(), 1);
89 let expected_regex = regex::Regex::new(expected_error_str).unwrap();
90 if let MessageSendEvent::HandleError { ref action, .. } = msg_events[0] {
92 &ErrorAction::SendErrorMessage { .. } => {
93 nodes[1].logger.assert_log_regex("lightning::ln::channelmanager".to_string(), expected_regex, 1);
95 _ => panic!("unexpected event!"),
97 } else { assert!(false); }
100 use ln::channel::MAX_FUNDING_SATOSHIS;
101 use ln::channelmanager::MAX_LOCAL_BREAKDOWN_TIMEOUT;
103 // Test all mutations that would make the channel open message insane
104 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 });
106 insane_open_helper("Bogus channel_reserve_satoshis", |mut msg| { msg.channel_reserve_satoshis = msg.funding_satoshis + 1; msg });
108 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 });
110 insane_open_helper("Peer never wants payout outputs?", |mut msg| { msg.dust_limit_satoshis = msg.funding_satoshis + 1 ; msg });
112 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 });
114 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 });
116 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 });
118 insane_open_helper("0 max_accepted_htlcs makes for a useless channel", |mut msg| { msg.max_accepted_htlcs = 0; msg });
120 insane_open_helper("max_accepted_htlcs was 484. It must not be larger than 483", |mut msg| { msg.max_accepted_htlcs = 484; msg });
124 fn test_async_inbound_update_fee() {
125 let chanmon_cfgs = create_chanmon_cfgs(2);
126 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
127 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
128 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
129 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
130 let logger = test_utils::TestLogger::new();
133 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
137 // send (1) commitment_signed -.
138 // <- update_add_htlc/commitment_signed
139 // send (2) RAA (awaiting remote revoke) -.
140 // (1) commitment_signed is delivered ->
141 // .- send (3) RAA (awaiting remote revoke)
142 // (2) RAA is delivered ->
143 // .- send (4) commitment_signed
144 // <- (3) RAA is delivered
145 // send (5) commitment_signed -.
146 // <- (4) commitment_signed is delivered
148 // (5) commitment_signed is delivered ->
150 // (6) RAA is delivered ->
152 // First nodes[0] generates an update_fee
154 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
157 nodes[0].node.timer_tick_occurred();
158 check_added_monitors!(nodes[0], 1);
160 let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
161 assert_eq!(events_0.len(), 1);
162 let (update_msg, commitment_signed) = match events_0[0] { // (1)
163 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
164 (update_fee.as_ref(), commitment_signed)
166 _ => panic!("Unexpected event"),
169 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
171 // ...but before it's delivered, nodes[1] starts to send a payment back to nodes[0]...
172 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[0]);
173 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
174 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();
175 check_added_monitors!(nodes[1], 1);
177 let payment_event = {
178 let mut events_1 = nodes[1].node.get_and_clear_pending_msg_events();
179 assert_eq!(events_1.len(), 1);
180 SendEvent::from_event(events_1.remove(0))
182 assert_eq!(payment_event.node_id, nodes[0].node.get_our_node_id());
183 assert_eq!(payment_event.msgs.len(), 1);
185 // ...now when the messages get delivered everyone should be happy
186 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
187 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg); // (2)
188 let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
189 // nodes[0] is awaiting nodes[1] revoke_and_ack so get_event_msg's assert(len == 1) passes
190 check_added_monitors!(nodes[0], 1);
192 // deliver(1), generate (3):
193 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
194 let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
195 // nodes[1] is awaiting nodes[0] revoke_and_ack so get_event_msg's assert(len == 1) passes
196 check_added_monitors!(nodes[1], 1);
198 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack); // deliver (2)
199 let bs_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
200 assert!(bs_update.update_add_htlcs.is_empty()); // (4)
201 assert!(bs_update.update_fulfill_htlcs.is_empty()); // (4)
202 assert!(bs_update.update_fail_htlcs.is_empty()); // (4)
203 assert!(bs_update.update_fail_malformed_htlcs.is_empty()); // (4)
204 assert!(bs_update.update_fee.is_none()); // (4)
205 check_added_monitors!(nodes[1], 1);
207 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack); // deliver (3)
208 let as_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
209 assert!(as_update.update_add_htlcs.is_empty()); // (5)
210 assert!(as_update.update_fulfill_htlcs.is_empty()); // (5)
211 assert!(as_update.update_fail_htlcs.is_empty()); // (5)
212 assert!(as_update.update_fail_malformed_htlcs.is_empty()); // (5)
213 assert!(as_update.update_fee.is_none()); // (5)
214 check_added_monitors!(nodes[0], 1);
216 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_update.commitment_signed); // deliver (4)
217 let as_second_revoke = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
218 // only (6) so get_event_msg's assert(len == 1) passes
219 check_added_monitors!(nodes[0], 1);
221 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_update.commitment_signed); // deliver (5)
222 let bs_second_revoke = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
223 check_added_monitors!(nodes[1], 1);
225 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke);
226 check_added_monitors!(nodes[0], 1);
228 let events_2 = nodes[0].node.get_and_clear_pending_events();
229 assert_eq!(events_2.len(), 1);
231 Event::PendingHTLCsForwardable {..} => {}, // If we actually processed we'd receive the payment
232 _ => panic!("Unexpected event"),
235 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_revoke); // deliver (6)
236 check_added_monitors!(nodes[1], 1);
240 fn test_update_fee_unordered_raa() {
241 // Just the intro to the previous test followed by an out-of-order RAA (which caused a
242 // crash in an earlier version of the update_fee patch)
243 let chanmon_cfgs = create_chanmon_cfgs(2);
244 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
245 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
246 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
247 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
248 let logger = test_utils::TestLogger::new();
251 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
253 // First nodes[0] generates an update_fee
255 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
258 nodes[0].node.timer_tick_occurred();
259 check_added_monitors!(nodes[0], 1);
261 let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
262 assert_eq!(events_0.len(), 1);
263 let update_msg = match events_0[0] { // (1)
264 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, .. }, .. } => {
267 _ => panic!("Unexpected event"),
270 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
272 // ...but before it's delivered, nodes[1] starts to send a payment back to nodes[0]...
273 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[0]);
274 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
275 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();
276 check_added_monitors!(nodes[1], 1);
278 let payment_event = {
279 let mut events_1 = nodes[1].node.get_and_clear_pending_msg_events();
280 assert_eq!(events_1.len(), 1);
281 SendEvent::from_event(events_1.remove(0))
283 assert_eq!(payment_event.node_id, nodes[0].node.get_our_node_id());
284 assert_eq!(payment_event.msgs.len(), 1);
286 // ...now when the messages get delivered everyone should be happy
287 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
288 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg); // (2)
289 let as_revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
290 // nodes[0] is awaiting nodes[1] revoke_and_ack so get_event_msg's assert(len == 1) passes
291 check_added_monitors!(nodes[0], 1);
293 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_msg); // deliver (2)
294 check_added_monitors!(nodes[1], 1);
296 // We can't continue, sadly, because our (1) now has a bogus signature
300 fn test_multi_flight_update_fee() {
301 let chanmon_cfgs = create_chanmon_cfgs(2);
302 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
303 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
304 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
305 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
308 // update_fee/commitment_signed ->
309 // .- send (1) RAA and (2) commitment_signed
310 // update_fee (never committed) ->
312 // We have to manually generate the above update_fee, it is allowed by the protocol but we
313 // don't track which updates correspond to which revoke_and_ack responses so we're in
314 // AwaitingRAA mode and will not generate the update_fee yet.
315 // <- (1) RAA delivered
316 // (3) is generated and send (4) CS -.
317 // Note that A cannot generate (4) prior to (1) being delivered as it otherwise doesn't
318 // know the per_commitment_point to use for it.
319 // <- (2) commitment_signed delivered
321 // B should send no response here
322 // (4) commitment_signed delivered ->
323 // <- RAA/commitment_signed delivered
326 // First nodes[0] generates an update_fee
329 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
330 initial_feerate = *feerate_lock;
331 *feerate_lock = initial_feerate + 20;
333 nodes[0].node.timer_tick_occurred();
334 check_added_monitors!(nodes[0], 1);
336 let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
337 assert_eq!(events_0.len(), 1);
338 let (update_msg_1, commitment_signed_1) = match events_0[0] { // (1)
339 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
340 (update_fee.as_ref().unwrap(), commitment_signed)
342 _ => panic!("Unexpected event"),
345 // Deliver first update_fee/commitment_signed pair, generating (1) and (2):
346 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg_1);
347 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed_1);
348 let (bs_revoke_msg, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
349 check_added_monitors!(nodes[1], 1);
351 // nodes[0] is awaiting a revoke from nodes[1] before it will create a new commitment
354 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
355 *feerate_lock = initial_feerate + 40;
357 nodes[0].node.timer_tick_occurred();
358 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
359 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
361 // Create the (3) update_fee message that nodes[0] will generate before it does...
362 let mut update_msg_2 = msgs::UpdateFee {
363 channel_id: update_msg_1.channel_id.clone(),
364 feerate_per_kw: (initial_feerate + 30) as u32,
367 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg_2);
369 update_msg_2.feerate_per_kw = (initial_feerate + 40) as u32;
371 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg_2);
373 // Deliver (1), generating (3) and (4)
374 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_msg);
375 let as_second_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
376 check_added_monitors!(nodes[0], 1);
377 assert!(as_second_update.update_add_htlcs.is_empty());
378 assert!(as_second_update.update_fulfill_htlcs.is_empty());
379 assert!(as_second_update.update_fail_htlcs.is_empty());
380 assert!(as_second_update.update_fail_malformed_htlcs.is_empty());
381 // Check that the update_fee newly generated matches what we delivered:
382 assert_eq!(as_second_update.update_fee.as_ref().unwrap().channel_id, update_msg_2.channel_id);
383 assert_eq!(as_second_update.update_fee.as_ref().unwrap().feerate_per_kw, update_msg_2.feerate_per_kw);
385 // Deliver (2) commitment_signed
386 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_commitment_signed);
387 let as_revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
388 check_added_monitors!(nodes[0], 1);
389 // No commitment_signed so get_event_msg's assert(len == 1) passes
391 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_msg);
392 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
393 check_added_monitors!(nodes[1], 1);
396 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_second_update.commitment_signed);
397 let (bs_second_revoke, bs_second_commitment) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
398 check_added_monitors!(nodes[1], 1);
400 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke);
401 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
402 check_added_monitors!(nodes[0], 1);
404 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_commitment);
405 let as_second_revoke = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
406 // No commitment_signed so get_event_msg's assert(len == 1) passes
407 check_added_monitors!(nodes[0], 1);
409 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_revoke);
410 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
411 check_added_monitors!(nodes[1], 1);
414 fn do_test_1_conf_open(connect_style: ConnectStyle) {
415 // Previously, if the minium_depth config was set to 1, we'd never send a funding_locked. This
416 // tests that we properly send one in that case.
417 let mut alice_config = UserConfig::default();
418 alice_config.own_channel_config.minimum_depth = 1;
419 alice_config.channel_options.announced_channel = true;
420 alice_config.peer_channel_config_limits.force_announced_channel_preference = false;
421 let mut bob_config = UserConfig::default();
422 bob_config.own_channel_config.minimum_depth = 1;
423 bob_config.channel_options.announced_channel = true;
424 bob_config.peer_channel_config_limits.force_announced_channel_preference = false;
425 let chanmon_cfgs = create_chanmon_cfgs(2);
426 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
427 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[Some(alice_config), Some(bob_config)]);
428 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
429 *nodes[0].connect_style.borrow_mut() = connect_style;
431 let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
432 mine_transaction(&nodes[1], &tx);
433 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()));
435 mine_transaction(&nodes[0], &tx);
436 let (funding_locked, _) = create_chan_between_nodes_with_value_confirm_second(&nodes[1], &nodes[0]);
437 let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
440 assert!(node.net_graph_msg_handler.handle_channel_announcement(&announcement).unwrap());
441 node.net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
442 node.net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
446 fn test_1_conf_open() {
447 do_test_1_conf_open(ConnectStyle::BestBlockFirst);
448 do_test_1_conf_open(ConnectStyle::TransactionsFirst);
449 do_test_1_conf_open(ConnectStyle::FullBlockViaListen);
452 fn do_test_sanity_on_in_flight_opens(steps: u8) {
453 // Previously, we had issues deserializing channels when we hadn't connected the first block
454 // after creation. To catch that and similar issues, we lean on the Node::drop impl to test
455 // serialization round-trips and simply do steps towards opening a channel and then drop the
458 let chanmon_cfgs = create_chanmon_cfgs(2);
459 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
460 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
461 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
463 if steps & 0b1000_0000 != 0{
465 header: BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
468 connect_block(&nodes[0], &block);
469 connect_block(&nodes[1], &block);
472 if steps & 0x0f == 0 { return; }
473 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
474 let open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
476 if steps & 0x0f == 1 { return; }
477 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_channel);
478 let accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
480 if steps & 0x0f == 2 { return; }
481 nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &accept_channel);
483 let (temporary_channel_id, tx, funding_output) = create_funding_transaction(&nodes[0], 100000, 42);
485 if steps & 0x0f == 3 { return; }
486 nodes[0].node.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
487 check_added_monitors!(nodes[0], 0);
488 let funding_created = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
490 if steps & 0x0f == 4 { return; }
491 nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created);
493 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
494 assert_eq!(added_monitors.len(), 1);
495 assert_eq!(added_monitors[0].0, funding_output);
496 added_monitors.clear();
498 let funding_signed = get_event_msg!(nodes[1], MessageSendEvent::SendFundingSigned, nodes[0].node.get_our_node_id());
500 if steps & 0x0f == 5 { return; }
501 nodes[0].node.handle_funding_signed(&nodes[1].node.get_our_node_id(), &funding_signed);
503 let mut added_monitors = nodes[0].chain_monitor.added_monitors.lock().unwrap();
504 assert_eq!(added_monitors.len(), 1);
505 assert_eq!(added_monitors[0].0, funding_output);
506 added_monitors.clear();
509 let events_4 = nodes[0].node.get_and_clear_pending_events();
510 assert_eq!(events_4.len(), 0);
512 if steps & 0x0f == 6 { return; }
513 create_chan_between_nodes_with_value_confirm_first(&nodes[0], &nodes[1], &tx, 2);
515 if steps & 0x0f == 7 { return; }
516 confirm_transaction_at(&nodes[0], &tx, 2);
517 connect_blocks(&nodes[0], CHAN_CONFIRM_DEPTH);
518 create_chan_between_nodes_with_value_confirm_second(&nodes[1], &nodes[0]);
522 fn test_sanity_on_in_flight_opens() {
523 do_test_sanity_on_in_flight_opens(0);
524 do_test_sanity_on_in_flight_opens(0 | 0b1000_0000);
525 do_test_sanity_on_in_flight_opens(1);
526 do_test_sanity_on_in_flight_opens(1 | 0b1000_0000);
527 do_test_sanity_on_in_flight_opens(2);
528 do_test_sanity_on_in_flight_opens(2 | 0b1000_0000);
529 do_test_sanity_on_in_flight_opens(3);
530 do_test_sanity_on_in_flight_opens(3 | 0b1000_0000);
531 do_test_sanity_on_in_flight_opens(4);
532 do_test_sanity_on_in_flight_opens(4 | 0b1000_0000);
533 do_test_sanity_on_in_flight_opens(5);
534 do_test_sanity_on_in_flight_opens(5 | 0b1000_0000);
535 do_test_sanity_on_in_flight_opens(6);
536 do_test_sanity_on_in_flight_opens(6 | 0b1000_0000);
537 do_test_sanity_on_in_flight_opens(7);
538 do_test_sanity_on_in_flight_opens(7 | 0b1000_0000);
539 do_test_sanity_on_in_flight_opens(8);
540 do_test_sanity_on_in_flight_opens(8 | 0b1000_0000);
544 fn test_update_fee_vanilla() {
545 let chanmon_cfgs = create_chanmon_cfgs(2);
546 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
547 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
548 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
549 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
552 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
555 nodes[0].node.timer_tick_occurred();
556 check_added_monitors!(nodes[0], 1);
558 let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
559 assert_eq!(events_0.len(), 1);
560 let (update_msg, commitment_signed) = match events_0[0] {
561 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 } } => {
562 (update_fee.as_ref(), commitment_signed)
564 _ => panic!("Unexpected event"),
566 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
568 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
569 let (revoke_msg, commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
570 check_added_monitors!(nodes[1], 1);
572 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
573 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
574 check_added_monitors!(nodes[0], 1);
576 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
577 let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
578 // No commitment_signed so get_event_msg's assert(len == 1) passes
579 check_added_monitors!(nodes[0], 1);
581 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg);
582 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
583 check_added_monitors!(nodes[1], 1);
587 fn test_update_fee_that_funder_cannot_afford() {
588 let chanmon_cfgs = create_chanmon_cfgs(2);
589 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
590 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
591 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
592 let channel_value = 1888;
593 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, channel_value, 700000, InitFeatures::known(), InitFeatures::known());
594 let channel_id = chan.2;
598 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
599 *feerate_lock = feerate;
601 nodes[0].node.timer_tick_occurred();
602 check_added_monitors!(nodes[0], 1);
603 let update_msg = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
605 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg.update_fee.unwrap());
607 commitment_signed_dance!(nodes[1], nodes[0], update_msg.commitment_signed, false);
609 //Confirm that the new fee based on the last local commitment txn is what we expected based on the feerate of 260 set above.
610 //This value results in a fee that is exactly what the funder can afford (277 sat + 1000 sat channel reserve)
612 let commitment_tx = get_local_commitment_txn!(nodes[1], channel_id)[0].clone();
614 //We made sure neither party's funds are below the dust limit so -2 non-HTLC txns from number of outputs
615 let num_htlcs = commitment_tx.output.len() - 2;
616 let total_fee: u64 = feerate as u64 * (COMMITMENT_TX_BASE_WEIGHT + (num_htlcs as u64) * COMMITMENT_TX_WEIGHT_PER_HTLC) / 1000;
617 let mut actual_fee = commitment_tx.output.iter().fold(0, |acc, output| acc + output.value);
618 actual_fee = channel_value - actual_fee;
619 assert_eq!(total_fee, actual_fee);
622 //Add 2 to the previous fee rate to the final fee increases by 1 (with no HTLCs the fee is essentially
623 //fee_rate*(724/1000) so the increment of 1*0.724 is rounded back down)
625 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
626 *feerate_lock = feerate + 2;
628 nodes[0].node.timer_tick_occurred();
629 check_added_monitors!(nodes[0], 1);
631 let update2_msg = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
633 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update2_msg.update_fee.unwrap());
635 //While producing the commitment_signed response after handling a received update_fee request the
636 //check to see if the funder, who sent the update_fee request, can afford the new fee (funder_balance >= fee+channel_reserve)
637 //Should produce and error.
638 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &update2_msg.commitment_signed);
639 nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Funding remote cannot afford proposed new fee".to_string(), 1);
640 check_added_monitors!(nodes[1], 1);
641 check_closed_broadcast!(nodes[1], true);
645 fn test_update_fee_with_fundee_update_add_htlc() {
646 let chanmon_cfgs = create_chanmon_cfgs(2);
647 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
648 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
649 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
650 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
651 let logger = test_utils::TestLogger::new();
654 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
657 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
660 nodes[0].node.timer_tick_occurred();
661 check_added_monitors!(nodes[0], 1);
663 let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
664 assert_eq!(events_0.len(), 1);
665 let (update_msg, commitment_signed) = match events_0[0] {
666 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 } } => {
667 (update_fee.as_ref(), commitment_signed)
669 _ => panic!("Unexpected event"),
671 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
672 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
673 let (revoke_msg, commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
674 check_added_monitors!(nodes[1], 1);
676 let (our_payment_preimage, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[0]);
677 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
678 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();
680 // nothing happens since node[1] is in AwaitingRemoteRevoke
681 nodes[1].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
683 let mut added_monitors = nodes[0].chain_monitor.added_monitors.lock().unwrap();
684 assert_eq!(added_monitors.len(), 0);
685 added_monitors.clear();
687 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
688 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
689 // node[1] has nothing to do
691 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
692 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
693 check_added_monitors!(nodes[0], 1);
695 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
696 let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
697 // No commitment_signed so get_event_msg's assert(len == 1) passes
698 check_added_monitors!(nodes[0], 1);
699 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg);
700 check_added_monitors!(nodes[1], 1);
701 // AwaitingRemoteRevoke ends here
703 let commitment_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
704 assert_eq!(commitment_update.update_add_htlcs.len(), 1);
705 assert_eq!(commitment_update.update_fulfill_htlcs.len(), 0);
706 assert_eq!(commitment_update.update_fail_htlcs.len(), 0);
707 assert_eq!(commitment_update.update_fail_malformed_htlcs.len(), 0);
708 assert_eq!(commitment_update.update_fee.is_none(), true);
710 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &commitment_update.update_add_htlcs[0]);
711 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_update.commitment_signed);
712 check_added_monitors!(nodes[0], 1);
713 let (revoke, commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
715 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke);
716 check_added_monitors!(nodes[1], 1);
717 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
719 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commitment_signed);
720 check_added_monitors!(nodes[1], 1);
721 let revoke = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
722 // No commitment_signed so get_event_msg's assert(len == 1) passes
724 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke);
725 check_added_monitors!(nodes[0], 1);
726 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
728 expect_pending_htlcs_forwardable!(nodes[0]);
730 let events = nodes[0].node.get_and_clear_pending_events();
731 assert_eq!(events.len(), 1);
733 Event::PaymentReceived { .. } => { },
734 _ => panic!("Unexpected event"),
737 claim_payment(&nodes[1], &vec!(&nodes[0])[..], our_payment_preimage);
739 send_payment(&nodes[1], &vec!(&nodes[0])[..], 800000);
740 send_payment(&nodes[0], &vec!(&nodes[1])[..], 800000);
741 close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true);
745 fn test_update_fee() {
746 let chanmon_cfgs = create_chanmon_cfgs(2);
747 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
748 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
749 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
750 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
751 let channel_id = chan.2;
754 // (1) update_fee/commitment_signed ->
755 // <- (2) revoke_and_ack
756 // .- send (3) commitment_signed
757 // (4) update_fee/commitment_signed ->
758 // .- send (5) revoke_and_ack (no CS as we're awaiting a revoke)
759 // <- (3) commitment_signed delivered
760 // send (6) revoke_and_ack -.
761 // <- (5) deliver revoke_and_ack
762 // (6) deliver revoke_and_ack ->
763 // .- send (7) commitment_signed in response to (4)
764 // <- (7) deliver commitment_signed
767 // Create and deliver (1)...
770 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
771 feerate = *feerate_lock;
772 *feerate_lock = feerate + 20;
774 nodes[0].node.timer_tick_occurred();
775 check_added_monitors!(nodes[0], 1);
777 let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
778 assert_eq!(events_0.len(), 1);
779 let (update_msg, commitment_signed) = match events_0[0] {
780 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 } } => {
781 (update_fee.as_ref(), commitment_signed)
783 _ => panic!("Unexpected event"),
785 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
787 // Generate (2) and (3):
788 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
789 let (revoke_msg, commitment_signed_0) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
790 check_added_monitors!(nodes[1], 1);
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 // Create and deliver (4)...
799 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
800 *feerate_lock = feerate + 30;
802 nodes[0].node.timer_tick_occurred();
803 check_added_monitors!(nodes[0], 1);
804 let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
805 assert_eq!(events_0.len(), 1);
806 let (update_msg, commitment_signed) = match events_0[0] {
807 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 } } => {
808 (update_fee.as_ref(), commitment_signed)
810 _ => panic!("Unexpected event"),
813 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
814 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
815 check_added_monitors!(nodes[1], 1);
817 let revoke_msg = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
818 // No commitment_signed so get_event_msg's assert(len == 1) passes
820 // Handle (3), creating (6):
821 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed_0);
822 check_added_monitors!(nodes[0], 1);
823 let revoke_msg_0 = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
824 // No commitment_signed so get_event_msg's assert(len == 1) passes
827 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
828 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
829 check_added_monitors!(nodes[0], 1);
831 // Deliver (6), creating (7):
832 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg_0);
833 let commitment_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
834 assert!(commitment_update.update_add_htlcs.is_empty());
835 assert!(commitment_update.update_fulfill_htlcs.is_empty());
836 assert!(commitment_update.update_fail_htlcs.is_empty());
837 assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
838 assert!(commitment_update.update_fee.is_none());
839 check_added_monitors!(nodes[1], 1);
842 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_update.commitment_signed);
843 check_added_monitors!(nodes[0], 1);
844 let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
845 // No commitment_signed so get_event_msg's assert(len == 1) passes
847 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg);
848 check_added_monitors!(nodes[1], 1);
849 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
851 assert_eq!(get_feerate!(nodes[0], channel_id), feerate + 30);
852 assert_eq!(get_feerate!(nodes[1], channel_id), feerate + 30);
853 close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true);
857 fn fake_network_test() {
858 // Simple test which builds a network of ChannelManagers, connects them to each other, and
859 // tests that payments get routed and transactions broadcast in semi-reasonable ways.
860 let chanmon_cfgs = create_chanmon_cfgs(4);
861 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
862 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
863 let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
865 // Create some initial channels
866 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
867 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
868 let chan_3 = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
870 // Rebalance the network a bit by relaying one payment through all the channels...
871 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000);
872 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000);
873 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000);
874 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000);
876 // Send some more payments
877 send_payment(&nodes[1], &vec!(&nodes[2], &nodes[3])[..], 1000000);
878 send_payment(&nodes[3], &vec!(&nodes[2], &nodes[1], &nodes[0])[..], 1000000);
879 send_payment(&nodes[3], &vec!(&nodes[2], &nodes[1])[..], 1000000);
881 // Test failure packets
882 let payment_hash_1 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 1000000).1;
883 fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], payment_hash_1);
885 // Add a new channel that skips 3
886 let chan_4 = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known());
888 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 1000000);
889 send_payment(&nodes[2], &vec!(&nodes[3])[..], 1000000);
890 send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
891 send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
892 send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
893 send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
894 send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
896 // Do some rebalance loop payments, simultaneously
897 let mut hops = Vec::with_capacity(3);
899 pubkey: nodes[2].node.get_our_node_id(),
900 node_features: NodeFeatures::empty(),
901 short_channel_id: chan_2.0.contents.short_channel_id,
902 channel_features: ChannelFeatures::empty(),
904 cltv_expiry_delta: chan_3.0.contents.cltv_expiry_delta as u32
907 pubkey: nodes[3].node.get_our_node_id(),
908 node_features: NodeFeatures::empty(),
909 short_channel_id: chan_3.0.contents.short_channel_id,
910 channel_features: ChannelFeatures::empty(),
912 cltv_expiry_delta: chan_4.1.contents.cltv_expiry_delta as u32
915 pubkey: nodes[1].node.get_our_node_id(),
916 node_features: NodeFeatures::known(),
917 short_channel_id: chan_4.0.contents.short_channel_id,
918 channel_features: ChannelFeatures::known(),
920 cltv_expiry_delta: TEST_FINAL_CLTV,
922 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;
923 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;
924 let payment_preimage_1 = send_along_route(&nodes[1], Route { paths: vec![hops] }, &vec!(&nodes[2], &nodes[3], &nodes[1])[..], 1000000).0;
926 let mut hops = Vec::with_capacity(3);
928 pubkey: nodes[3].node.get_our_node_id(),
929 node_features: NodeFeatures::empty(),
930 short_channel_id: chan_4.0.contents.short_channel_id,
931 channel_features: ChannelFeatures::empty(),
933 cltv_expiry_delta: chan_3.1.contents.cltv_expiry_delta as u32
936 pubkey: nodes[2].node.get_our_node_id(),
937 node_features: NodeFeatures::empty(),
938 short_channel_id: chan_3.0.contents.short_channel_id,
939 channel_features: ChannelFeatures::empty(),
941 cltv_expiry_delta: chan_2.1.contents.cltv_expiry_delta as u32
944 pubkey: nodes[1].node.get_our_node_id(),
945 node_features: NodeFeatures::known(),
946 short_channel_id: chan_2.0.contents.short_channel_id,
947 channel_features: ChannelFeatures::known(),
949 cltv_expiry_delta: TEST_FINAL_CLTV,
951 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;
952 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;
953 let payment_hash_2 = send_along_route(&nodes[1], Route { paths: vec![hops] }, &vec!(&nodes[3], &nodes[2], &nodes[1])[..], 1000000).1;
955 // Claim the rebalances...
956 fail_payment(&nodes[1], &vec!(&nodes[3], &nodes[2], &nodes[1])[..], payment_hash_2);
957 claim_payment(&nodes[1], &vec!(&nodes[2], &nodes[3], &nodes[1])[..], payment_preimage_1);
959 // Add a duplicate new channel from 2 to 4
960 let chan_5 = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known());
962 // Send some payments across both channels
963 let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
964 let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
965 let payment_preimage_5 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
968 route_over_limit(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000);
969 let events = nodes[0].node.get_and_clear_pending_msg_events();
970 assert_eq!(events.len(), 0);
971 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);
973 //TODO: Test that routes work again here as we've been notified that the channel is full
975 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_3);
976 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_4);
977 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_5);
979 // Close down the channels...
980 close_channel(&nodes[0], &nodes[1], &chan_1.2, chan_1.3, true);
981 close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, false);
982 close_channel(&nodes[2], &nodes[3], &chan_3.2, chan_3.3, true);
983 close_channel(&nodes[1], &nodes[3], &chan_4.2, chan_4.3, false);
984 close_channel(&nodes[1], &nodes[3], &chan_5.2, chan_5.3, false);
988 fn holding_cell_htlc_counting() {
989 // Tests that HTLCs in the holding cell count towards the pending HTLC limits on outbound HTLCs
990 // to ensure we don't end up with HTLCs sitting around in our holding cell for several
991 // commitment dance rounds.
992 let chanmon_cfgs = create_chanmon_cfgs(3);
993 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
994 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
995 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
996 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
997 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
998 let logger = test_utils::TestLogger::new();
1000 let mut payments = Vec::new();
1001 for _ in 0..::ln::channel::OUR_MAX_HTLCS {
1002 let (payment_preimage, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[2]);
1003 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
1004 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();
1005 nodes[1].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
1006 payments.push((payment_preimage, payment_hash));
1008 check_added_monitors!(nodes[1], 1);
1010 let mut events = nodes[1].node.get_and_clear_pending_msg_events();
1011 assert_eq!(events.len(), 1);
1012 let initial_payment_event = SendEvent::from_event(events.pop().unwrap());
1013 assert_eq!(initial_payment_event.node_id, nodes[2].node.get_our_node_id());
1015 // There is now one HTLC in an outbound commitment transaction and (OUR_MAX_HTLCS - 1) HTLCs in
1016 // the holding cell waiting on B's RAA to send. At this point we should not be able to add
1018 let (_, payment_hash_1, payment_secret_1) = get_payment_preimage_hash!(nodes[2]);
1020 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
1021 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();
1022 unwrap_send_err!(nodes[1].node.send_payment(&route, payment_hash_1, &Some(payment_secret_1)), true, APIError::ChannelUnavailable { ref err },
1023 assert!(regex::Regex::new(r"Cannot push more than their max accepted HTLCs \(\d+\)").unwrap().is_match(err)));
1024 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1025 nodes[1].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot push more than their max accepted HTLCs".to_string(), 1);
1028 // This should also be true if we try to forward a payment.
1029 let (_, payment_hash_2, payment_secret_2) = get_payment_preimage_hash!(nodes[2]);
1031 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
1032 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();
1033 nodes[0].node.send_payment(&route, payment_hash_2, &Some(payment_secret_2)).unwrap();
1034 check_added_monitors!(nodes[0], 1);
1037 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1038 assert_eq!(events.len(), 1);
1039 let payment_event = SendEvent::from_event(events.pop().unwrap());
1040 assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
1042 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1043 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
1044 // We have to forward pending HTLCs twice - once tries to forward the payment forward (and
1045 // fails), the second will process the resulting failure and fail the HTLC backward.
1046 expect_pending_htlcs_forwardable!(nodes[1]);
1047 expect_pending_htlcs_forwardable!(nodes[1]);
1048 check_added_monitors!(nodes[1], 1);
1050 let bs_fail_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1051 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &bs_fail_updates.update_fail_htlcs[0]);
1052 commitment_signed_dance!(nodes[0], nodes[1], bs_fail_updates.commitment_signed, false, true);
1054 expect_payment_failure_chan_update!(nodes[0], chan_2.0.contents.short_channel_id, false);
1055 expect_payment_failed!(nodes[0], payment_hash_2, false);
1057 // Now forward all the pending HTLCs and claim them back
1058 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &initial_payment_event.msgs[0]);
1059 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &initial_payment_event.commitment_msg);
1060 check_added_monitors!(nodes[2], 1);
1062 let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1063 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_revoke_and_ack);
1064 check_added_monitors!(nodes[1], 1);
1065 let as_updates = get_htlc_update_msgs!(nodes[1], nodes[2].node.get_our_node_id());
1067 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &bs_commitment_signed);
1068 check_added_monitors!(nodes[1], 1);
1069 let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
1071 for ref update in as_updates.update_add_htlcs.iter() {
1072 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), update);
1074 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &as_updates.commitment_signed);
1075 check_added_monitors!(nodes[2], 1);
1076 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
1077 check_added_monitors!(nodes[2], 1);
1078 let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1080 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_revoke_and_ack);
1081 check_added_monitors!(nodes[1], 1);
1082 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &bs_commitment_signed);
1083 check_added_monitors!(nodes[1], 1);
1084 let as_final_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
1086 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_final_raa);
1087 check_added_monitors!(nodes[2], 1);
1089 expect_pending_htlcs_forwardable!(nodes[2]);
1091 let events = nodes[2].node.get_and_clear_pending_events();
1092 assert_eq!(events.len(), payments.len());
1093 for (event, &(_, ref hash)) in events.iter().zip(payments.iter()) {
1095 &Event::PaymentReceived { ref payment_hash, .. } => {
1096 assert_eq!(*payment_hash, *hash);
1098 _ => panic!("Unexpected event"),
1102 for (preimage, _) in payments.drain(..) {
1103 claim_payment(&nodes[1], &[&nodes[2]], preimage);
1106 send_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1000000);
1110 fn duplicate_htlc_test() {
1111 // Test that we accept duplicate payment_hash HTLCs across the network and that
1112 // claiming/failing them are all separate and don't affect each other
1113 let chanmon_cfgs = create_chanmon_cfgs(6);
1114 let node_cfgs = create_node_cfgs(6, &chanmon_cfgs);
1115 let node_chanmgrs = create_node_chanmgrs(6, &node_cfgs, &[None, None, None, None, None, None]);
1116 let mut nodes = create_network(6, &node_cfgs, &node_chanmgrs);
1118 // Create some initial channels to route via 3 to 4/5 from 0/1/2
1119 create_announced_chan_between_nodes(&nodes, 0, 3, InitFeatures::known(), InitFeatures::known());
1120 create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known());
1121 create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
1122 create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::known(), InitFeatures::known());
1123 create_announced_chan_between_nodes(&nodes, 3, 5, InitFeatures::known(), InitFeatures::known());
1125 let (payment_preimage, payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[3], &nodes[4])[..], 1000000);
1127 *nodes[0].network_payment_count.borrow_mut() -= 1;
1128 assert_eq!(route_payment(&nodes[1], &vec!(&nodes[3])[..], 1000000).0, payment_preimage);
1130 *nodes[0].network_payment_count.borrow_mut() -= 1;
1131 assert_eq!(route_payment(&nodes[2], &vec!(&nodes[3], &nodes[5])[..], 1000000).0, payment_preimage);
1133 claim_payment(&nodes[0], &vec!(&nodes[3], &nodes[4])[..], payment_preimage);
1134 fail_payment(&nodes[2], &vec!(&nodes[3], &nodes[5])[..], payment_hash);
1135 claim_payment(&nodes[1], &vec!(&nodes[3])[..], payment_preimage);
1139 fn test_duplicate_htlc_different_direction_onchain() {
1140 // Test that ChannelMonitor doesn't generate 2 preimage txn
1141 // when we have 2 HTLCs with same preimage that go across a node
1142 // in opposite directions, even with the same payment secret.
1143 let chanmon_cfgs = create_chanmon_cfgs(2);
1144 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1145 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1146 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1148 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
1149 let logger = test_utils::TestLogger::new();
1152 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
1154 let (payment_preimage, payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 900_000);
1156 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
1157 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();
1158 let node_a_payment_secret = nodes[0].node.create_inbound_payment_for_hash(payment_hash, None, 7200, 0).unwrap();
1159 send_along_route_with_secret(&nodes[1], route, &[&[&nodes[0]]], 800_000, payment_hash, node_a_payment_secret);
1161 // Provide preimage to node 0 by claiming payment
1162 nodes[0].node.claim_funds(payment_preimage);
1163 check_added_monitors!(nodes[0], 1);
1165 // Broadcast node 1 commitment txn
1166 let remote_txn = get_local_commitment_txn!(nodes[1], chan_1.2);
1168 assert_eq!(remote_txn[0].output.len(), 4); // 1 local, 1 remote, 1 htlc inbound, 1 htlc outbound
1169 let mut has_both_htlcs = 0; // check htlcs match ones committed
1170 for outp in remote_txn[0].output.iter() {
1171 if outp.value == 800_000 / 1000 {
1172 has_both_htlcs += 1;
1173 } else if outp.value == 900_000 / 1000 {
1174 has_both_htlcs += 1;
1177 assert_eq!(has_both_htlcs, 2);
1179 mine_transaction(&nodes[0], &remote_txn[0]);
1180 check_added_monitors!(nodes[0], 1);
1181 connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
1183 // Check we only broadcast 1 timeout tx
1184 let claim_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
1185 assert_eq!(claim_txn.len(), 8);
1186 assert_eq!(claim_txn[1], claim_txn[4]);
1187 assert_eq!(claim_txn[2], claim_txn[5]);
1188 check_spends!(claim_txn[1], chan_1.3);
1189 check_spends!(claim_txn[2], claim_txn[1]);
1190 check_spends!(claim_txn[7], claim_txn[1]);
1192 assert_eq!(claim_txn[0].input.len(), 1);
1193 assert_eq!(claim_txn[3].input.len(), 1);
1194 assert_eq!(claim_txn[0].input[0].previous_output, claim_txn[3].input[0].previous_output);
1196 assert_eq!(claim_txn[0].input.len(), 1);
1197 assert_eq!(claim_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC 1 <--> 0, preimage tx
1198 check_spends!(claim_txn[0], remote_txn[0]);
1199 assert_eq!(remote_txn[0].output[claim_txn[0].input[0].previous_output.vout as usize].value, 800);
1200 assert_eq!(claim_txn[6].input.len(), 1);
1201 assert_eq!(claim_txn[6].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // HTLC 0 <--> 1, timeout tx
1202 check_spends!(claim_txn[6], remote_txn[0]);
1203 assert_eq!(remote_txn[0].output[claim_txn[6].input[0].previous_output.vout as usize].value, 900);
1205 let events = nodes[0].node.get_and_clear_pending_msg_events();
1206 assert_eq!(events.len(), 3);
1209 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
1210 MessageSendEvent::HandleError { node_id, action: msgs::ErrorAction::SendErrorMessage { ref msg } } => {
1211 assert_eq!(node_id, nodes[1].node.get_our_node_id());
1212 assert_eq!(msg.data, "Commitment or closing transaction was confirmed on chain.");
1214 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, .. } } => {
1215 assert!(update_add_htlcs.is_empty());
1216 assert!(update_fail_htlcs.is_empty());
1217 assert_eq!(update_fulfill_htlcs.len(), 1);
1218 assert!(update_fail_malformed_htlcs.is_empty());
1219 assert_eq!(nodes[1].node.get_our_node_id(), *node_id);
1221 _ => panic!("Unexpected event"),
1227 fn test_basic_channel_reserve() {
1228 let chanmon_cfgs = create_chanmon_cfgs(2);
1229 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1230 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1231 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1232 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1233 let logger = test_utils::TestLogger::new();
1235 let chan_stat = get_channel_value_stat!(nodes[0], chan.2);
1236 let channel_reserve = chan_stat.channel_reserve_msat;
1238 // The 2* and +1 are for the fee spike reserve.
1239 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
1240 let commit_tx_fee = 2 * commit_tx_fee_msat(get_feerate!(nodes[0], chan.2), 1 + 1);
1241 let max_can_send = 5000000 - channel_reserve - commit_tx_fee;
1242 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
1243 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();
1244 let err = nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).err().unwrap();
1246 PaymentSendFailure::AllFailedRetrySafe(ref fails) => {
1248 &APIError::ChannelUnavailable{ref err} =>
1249 assert!(regex::Regex::new(r"Cannot send value that would put our balance under counterparty-announced channel reserve value \(\d+\)").unwrap().is_match(err)),
1250 _ => panic!("Unexpected error variant"),
1253 _ => panic!("Unexpected error variant"),
1255 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1256 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);
1258 send_payment(&nodes[0], &vec![&nodes[1]], max_can_send);
1262 fn test_fee_spike_violation_fails_htlc() {
1263 let chanmon_cfgs = create_chanmon_cfgs(2);
1264 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1265 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1266 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1267 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1269 let (route, payment_hash, _, payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], 3460001);
1270 // Need to manually create the update_add_htlc message to go around the channel reserve check in send_htlc()
1271 let secp_ctx = Secp256k1::new();
1272 let session_priv = SecretKey::from_slice(&[42; 32]).expect("RNG is bad!");
1274 let cur_height = nodes[1].node.best_block.read().unwrap().height() + 1;
1276 let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route.paths[0], &session_priv).unwrap();
1277 let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 3460001, &Some(payment_secret), cur_height, &None).unwrap();
1278 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
1279 let msg = msgs::UpdateAddHTLC {
1282 amount_msat: htlc_msat,
1283 payment_hash: payment_hash,
1284 cltv_expiry: htlc_cltv,
1285 onion_routing_packet: onion_packet,
1288 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
1290 // Now manually create the commitment_signed message corresponding to the update_add
1291 // nodes[0] just sent. In the code for construction of this message, "local" refers
1292 // to the sender of the message, and "remote" refers to the receiver.
1294 let feerate_per_kw = get_feerate!(nodes[0], chan.2);
1296 const INITIAL_COMMITMENT_NUMBER: u64 = (1 << 48) - 1;
1298 // Get the EnforcingSigner for each channel, which will be used to (1) get the keys
1299 // needed to sign the new commitment tx and (2) sign the new commitment tx.
1300 let (local_revocation_basepoint, local_htlc_basepoint, local_secret, next_local_point, local_funding) = {
1301 let chan_lock = nodes[0].node.channel_state.lock().unwrap();
1302 let local_chan = chan_lock.by_id.get(&chan.2).unwrap();
1303 let chan_signer = local_chan.get_signer();
1304 // Make the signer believe we validated another commitment, so we can release the secret
1305 chan_signer.get_enforcement_state().last_holder_commitment -= 1;
1307 let pubkeys = chan_signer.pubkeys();
1308 (pubkeys.revocation_basepoint, pubkeys.htlc_basepoint,
1309 chan_signer.release_commitment_secret(INITIAL_COMMITMENT_NUMBER),
1310 chan_signer.get_per_commitment_point(INITIAL_COMMITMENT_NUMBER - 2, &secp_ctx),
1311 chan_signer.pubkeys().funding_pubkey)
1313 let (remote_delayed_payment_basepoint, remote_htlc_basepoint, remote_point, remote_funding) = {
1314 let chan_lock = nodes[1].node.channel_state.lock().unwrap();
1315 let remote_chan = chan_lock.by_id.get(&chan.2).unwrap();
1316 let chan_signer = remote_chan.get_signer();
1317 let pubkeys = chan_signer.pubkeys();
1318 (pubkeys.delayed_payment_basepoint, pubkeys.htlc_basepoint,
1319 chan_signer.get_per_commitment_point(INITIAL_COMMITMENT_NUMBER - 1, &secp_ctx),
1320 chan_signer.pubkeys().funding_pubkey)
1323 // Assemble the set of keys we can use for signatures for our commitment_signed message.
1324 let commit_tx_keys = chan_utils::TxCreationKeys::derive_new(&secp_ctx, &remote_point, &remote_delayed_payment_basepoint,
1325 &remote_htlc_basepoint, &local_revocation_basepoint, &local_htlc_basepoint).unwrap();
1327 // Build the remote commitment transaction so we can sign it, and then later use the
1328 // signature for the commitment_signed message.
1329 let local_chan_balance = 1313;
1331 let accepted_htlc_info = chan_utils::HTLCOutputInCommitment {
1333 amount_msat: 3460001,
1334 cltv_expiry: htlc_cltv,
1336 transaction_output_index: Some(1),
1339 let commitment_number = INITIAL_COMMITMENT_NUMBER - 1;
1342 let local_chan_lock = nodes[0].node.channel_state.lock().unwrap();
1343 let local_chan = local_chan_lock.by_id.get(&chan.2).unwrap();
1344 let local_chan_signer = local_chan.get_signer();
1345 let commitment_tx = CommitmentTransaction::new_with_auxiliary_htlc_data(
1349 false, local_funding, remote_funding,
1350 commit_tx_keys.clone(),
1352 &mut vec![(accepted_htlc_info, ())],
1353 &local_chan.channel_transaction_parameters.as_counterparty_broadcastable()
1355 local_chan_signer.sign_counterparty_commitment(&commitment_tx, &secp_ctx).unwrap()
1358 let commit_signed_msg = msgs::CommitmentSigned {
1361 htlc_signatures: res.1
1364 // Send the commitment_signed message to the nodes[1].
1365 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commit_signed_msg);
1366 let _ = nodes[1].node.get_and_clear_pending_msg_events();
1368 // Send the RAA to nodes[1].
1369 let raa_msg = msgs::RevokeAndACK {
1371 per_commitment_secret: local_secret,
1372 next_per_commitment_point: next_local_point
1374 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &raa_msg);
1376 let events = nodes[1].node.get_and_clear_pending_msg_events();
1377 assert_eq!(events.len(), 1);
1378 // Make sure the HTLC failed in the way we expect.
1380 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fail_htlcs, .. }, .. } => {
1381 assert_eq!(update_fail_htlcs.len(), 1);
1382 update_fail_htlcs[0].clone()
1384 _ => panic!("Unexpected event"),
1386 nodes[1].logger.assert_log("lightning::ln::channel".to_string(),
1387 format!("Attempting to fail HTLC due to fee spike buffer violation in channel {}. Rebalancing is required.", ::hex::encode(raa_msg.channel_id)), 1);
1389 check_added_monitors!(nodes[1], 2);
1393 fn test_chan_reserve_violation_outbound_htlc_inbound_chan() {
1394 let mut chanmon_cfgs = create_chanmon_cfgs(2);
1395 // Set the fee rate for the channel very high, to the point where the fundee
1396 // sending any above-dust amount would result in a channel reserve violation.
1397 // In this test we check that we would be prevented from sending an HTLC in
1399 let feerate_per_kw = 253;
1400 chanmon_cfgs[0].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(feerate_per_kw) };
1401 chanmon_cfgs[1].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(feerate_per_kw) };
1402 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1403 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1404 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1406 let mut push_amt = 100_000_000;
1407 push_amt -= feerate_per_kw as u64 * (COMMITMENT_TX_BASE_WEIGHT + COMMITMENT_TX_WEIGHT_PER_HTLC) / 1000 * 1000;
1408 push_amt -= Channel::<EnforcingSigner>::get_holder_selected_channel_reserve_satoshis(100_000) * 1000;
1410 let _ = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100_000, push_amt, InitFeatures::known(), InitFeatures::known());
1412 // Sending exactly enough to hit the reserve amount should be accepted
1413 let (_, _, _) = route_payment(&nodes[1], &[&nodes[0]], 1_000_000);
1415 // However one more HTLC should be significantly over the reserve amount and fail.
1416 let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[1], nodes[0], 1_000_000);
1417 unwrap_send_err!(nodes[1].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
1418 assert_eq!(err, "Cannot send value that would put counterparty balance under holder-announced channel reserve value"));
1419 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1420 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);
1424 fn test_chan_reserve_violation_inbound_htlc_outbound_channel() {
1425 let mut chanmon_cfgs = create_chanmon_cfgs(2);
1426 // Set the fee rate for the channel very high, to the point where the funder
1427 // receiving 1 update_add_htlc would result in them closing the channel due
1428 // to channel reserve violation. This close could also happen if the fee went
1429 // up a more realistic amount, but many HTLCs were outstanding at the time of
1430 // the update_add_htlc.
1431 chanmon_cfgs[0].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(6000) };
1432 chanmon_cfgs[1].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(6000) };
1433 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1434 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1435 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1436 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1438 let (route, payment_hash, _, payment_secret) = get_route_and_payment_hash!(nodes[1], nodes[0], 1000);
1439 // Need to manually create the update_add_htlc message to go around the channel reserve check in send_htlc()
1440 let secp_ctx = Secp256k1::new();
1441 let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
1442 let cur_height = nodes[1].node.best_block.read().unwrap().height() + 1;
1443 let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route.paths[0], &session_priv).unwrap();
1444 let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 1000, &Some(payment_secret), cur_height, &None).unwrap();
1445 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
1446 let msg = msgs::UpdateAddHTLC {
1449 amount_msat: htlc_msat + 1,
1450 payment_hash: payment_hash,
1451 cltv_expiry: htlc_cltv,
1452 onion_routing_packet: onion_packet,
1455 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &msg);
1456 // Check that the payment failed and the channel is closed in response to the malicious UpdateAdd.
1457 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);
1458 assert_eq!(nodes[0].node.list_channels().len(), 0);
1459 let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
1460 assert_eq!(err_msg.data, "Cannot accept HTLC that would put our balance under counterparty-announced channel reserve value");
1461 check_added_monitors!(nodes[0], 1);
1465 fn test_chan_reserve_dust_inbound_htlcs_outbound_chan() {
1466 // Test that if we receive many dust HTLCs over an outbound channel, they don't count when
1467 // calculating our commitment transaction fee (this was previously broken).
1468 let mut chanmon_cfgs = create_chanmon_cfgs(2);
1469 let feerate_per_kw = 253;
1470 chanmon_cfgs[0].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(feerate_per_kw) };
1471 chanmon_cfgs[1].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(feerate_per_kw) };
1473 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1474 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None, None]);
1475 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1477 // Set nodes[0]'s balance such that they will consider any above-dust received HTLC to be a
1478 // channel reserve violation (so their balance is channel reserve (1000 sats) + commitment
1479 // transaction fee with 0 HTLCs (183 sats)).
1480 let mut push_amt = 100_000_000;
1481 push_amt -= feerate_per_kw as u64 * (COMMITMENT_TX_BASE_WEIGHT) / 1000 * 1000;
1482 push_amt -= Channel::<EnforcingSigner>::get_holder_selected_channel_reserve_satoshis(100_000) * 1000;
1483 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, push_amt, InitFeatures::known(), InitFeatures::known());
1485 let dust_amt = crate::ln::channel::MIN_DUST_LIMIT_SATOSHIS * 1000
1486 + feerate_per_kw as u64 * HTLC_SUCCESS_TX_WEIGHT / 1000 * 1000 - 1;
1487 // In the previous code, routing this dust payment would cause nodes[0] to perceive a channel
1488 // reserve violation even though it's a dust HTLC and therefore shouldn't count towards the
1489 // commitment transaction fee.
1490 let (_, _, _) = route_payment(&nodes[1], &[&nodes[0]], dust_amt);
1492 // One more than the dust amt should fail, however.
1493 let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[1], nodes[0], dust_amt + 1);
1494 unwrap_send_err!(nodes[1].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
1495 assert_eq!(err, "Cannot send value that would put counterparty balance under holder-announced channel reserve value"));
1499 fn test_chan_reserve_dust_inbound_htlcs_inbound_chan() {
1500 // Test that if we receive many dust HTLCs over an inbound channel, they don't count when
1501 // calculating our counterparty's commitment transaction fee (this was previously broken).
1502 let chanmon_cfgs = create_chanmon_cfgs(2);
1503 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1504 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None, None]);
1505 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1506 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 98000000, InitFeatures::known(), InitFeatures::known());
1508 let payment_amt = 46000; // Dust amount
1509 // In the previous code, these first four payments would succeed.
1510 let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1511 let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1512 let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1513 let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1515 // Then these next 5 would be interpreted by nodes[1] as violating the fee spike buffer.
1516 let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1517 let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1518 let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1519 let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1520 let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1522 // And this last payment previously resulted in nodes[1] closing on its inbound-channel
1523 // counterparty, because it counted all the previous dust HTLCs against nodes[0]'s commitment
1524 // transaction fee and therefore perceived this next payment as a channel reserve violation.
1525 let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1529 fn test_chan_reserve_violation_inbound_htlc_inbound_chan() {
1530 let chanmon_cfgs = create_chanmon_cfgs(3);
1531 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1532 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1533 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1534 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1535 let _ = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1538 let total_routing_fee_msat = (nodes.len() - 2) as u64 * feemsat;
1539 let chan_stat = get_channel_value_stat!(nodes[0], chan.2);
1540 let feerate = get_feerate!(nodes[0], chan.2);
1542 // Add a 2* and +1 for the fee spike reserve.
1543 let commit_tx_fee_2_htlc = 2*commit_tx_fee_msat(feerate, 2 + 1);
1544 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;
1545 let amt_msat_1 = recv_value_1 + total_routing_fee_msat;
1547 // Add a pending HTLC.
1548 let (route_1, our_payment_hash_1, _, our_payment_secret_1) = get_route_and_payment_hash!(nodes[0], nodes[2], amt_msat_1);
1549 let payment_event_1 = {
1550 nodes[0].node.send_payment(&route_1, our_payment_hash_1, &Some(our_payment_secret_1)).unwrap();
1551 check_added_monitors!(nodes[0], 1);
1553 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1554 assert_eq!(events.len(), 1);
1555 SendEvent::from_event(events.remove(0))
1557 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event_1.msgs[0]);
1559 // Attempt to trigger a channel reserve violation --> payment failure.
1560 let commit_tx_fee_2_htlcs = commit_tx_fee_msat(feerate, 2);
1561 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;
1562 let amt_msat_2 = recv_value_2 + total_routing_fee_msat;
1563 let (route_2, _, _, _) = get_route_and_payment_hash!(nodes[0], nodes[2], amt_msat_2);
1565 // Need to manually create the update_add_htlc message to go around the channel reserve check in send_htlc()
1566 let secp_ctx = Secp256k1::new();
1567 let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
1568 let cur_height = nodes[0].node.best_block.read().unwrap().height() + 1;
1569 let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route_2.paths[0], &session_priv).unwrap();
1570 let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route_2.paths[0], recv_value_2, &None, cur_height, &None).unwrap();
1571 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &our_payment_hash_1);
1572 let msg = msgs::UpdateAddHTLC {
1575 amount_msat: htlc_msat + 1,
1576 payment_hash: our_payment_hash_1,
1577 cltv_expiry: htlc_cltv,
1578 onion_routing_packet: onion_packet,
1581 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
1582 // Check that the payment failed and the channel is closed in response to the malicious UpdateAdd.
1583 nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Remote HTLC add would put them under remote reserve value".to_string(), 1);
1584 assert_eq!(nodes[1].node.list_channels().len(), 1);
1585 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
1586 assert_eq!(err_msg.data, "Remote HTLC add would put them under remote reserve value");
1587 check_added_monitors!(nodes[1], 1);
1591 fn test_inbound_outbound_capacity_is_not_zero() {
1592 let chanmon_cfgs = create_chanmon_cfgs(2);
1593 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1594 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1595 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1596 let _ = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1597 let channels0 = node_chanmgrs[0].list_channels();
1598 let channels1 = node_chanmgrs[1].list_channels();
1599 assert_eq!(channels0.len(), 1);
1600 assert_eq!(channels1.len(), 1);
1602 let reserve = Channel::<EnforcingSigner>::get_holder_selected_channel_reserve_satoshis(100000);
1603 assert_eq!(channels0[0].inbound_capacity_msat, 95000000 - reserve*1000);
1604 assert_eq!(channels1[0].outbound_capacity_msat, 95000000 - reserve*1000);
1606 assert_eq!(channels0[0].outbound_capacity_msat, 100000 * 1000 - 95000000 - reserve*1000);
1607 assert_eq!(channels1[0].inbound_capacity_msat, 100000 * 1000 - 95000000 - reserve*1000);
1610 fn commit_tx_fee_msat(feerate: u32, num_htlcs: u64) -> u64 {
1611 (COMMITMENT_TX_BASE_WEIGHT + num_htlcs * COMMITMENT_TX_WEIGHT_PER_HTLC) * feerate as u64 / 1000 * 1000
1615 fn test_channel_reserve_holding_cell_htlcs() {
1616 let chanmon_cfgs = create_chanmon_cfgs(3);
1617 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1618 // When this test was written, the default base fee floated based on the HTLC count.
1619 // It is now fixed, so we simply set the fee to the expected value here.
1620 let mut config = test_default_channel_config();
1621 config.channel_options.forwarding_fee_base_msat = 239;
1622 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[Some(config.clone()), Some(config.clone()), Some(config.clone())]);
1623 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1624 let chan_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 190000, 1001, InitFeatures::known(), InitFeatures::known());
1625 let chan_2 = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 190000, 1001, InitFeatures::known(), InitFeatures::known());
1627 let mut stat01 = get_channel_value_stat!(nodes[0], chan_1.2);
1628 let mut stat11 = get_channel_value_stat!(nodes[1], chan_1.2);
1630 let mut stat12 = get_channel_value_stat!(nodes[1], chan_2.2);
1631 let mut stat22 = get_channel_value_stat!(nodes[2], chan_2.2);
1633 macro_rules! expect_forward {
1635 let mut events = $node.node.get_and_clear_pending_msg_events();
1636 assert_eq!(events.len(), 1);
1637 check_added_monitors!($node, 1);
1638 let payment_event = SendEvent::from_event(events.remove(0));
1643 let feemsat = 239; // set above
1644 let total_fee_msat = (nodes.len() - 2) as u64 * feemsat;
1645 let feerate = get_feerate!(nodes[0], chan_1.2);
1647 let recv_value_0 = stat01.counterparty_max_htlc_value_in_flight_msat - total_fee_msat;
1649 // attempt to send amt_msat > their_max_htlc_value_in_flight_msat
1651 let (mut route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], recv_value_0);
1652 route.paths[0].last_mut().unwrap().fee_msat += 1;
1653 assert!(route.paths[0].iter().rev().skip(1).all(|h| h.fee_msat == feemsat));
1654 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
1655 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)));
1656 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1657 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);
1660 // channel reserve is bigger than their_max_htlc_value_in_flight_msat so loop to deplete
1661 // nodes[0]'s wealth
1663 let amt_msat = recv_value_0 + total_fee_msat;
1664 // 3 for the 3 HTLCs that will be sent, 2* and +1 for the fee spike reserve.
1665 // Also, ensure that each payment has enough to be over the dust limit to
1666 // ensure it'll be included in each commit tx fee calculation.
1667 let commit_tx_fee_all_htlcs = 2*commit_tx_fee_msat(feerate, 3 + 1);
1668 let ensure_htlc_amounts_above_dust_buffer = 3 * (stat01.counterparty_dust_limit_msat + 1000);
1669 if stat01.value_to_self_msat < stat01.channel_reserve_msat + commit_tx_fee_all_htlcs + ensure_htlc_amounts_above_dust_buffer + amt_msat {
1672 send_payment(&nodes[0], &vec![&nodes[1], &nodes[2]][..], recv_value_0);
1674 let (stat01_, stat11_, stat12_, stat22_) = (
1675 get_channel_value_stat!(nodes[0], chan_1.2),
1676 get_channel_value_stat!(nodes[1], chan_1.2),
1677 get_channel_value_stat!(nodes[1], chan_2.2),
1678 get_channel_value_stat!(nodes[2], chan_2.2),
1681 assert_eq!(stat01_.value_to_self_msat, stat01.value_to_self_msat - amt_msat);
1682 assert_eq!(stat11_.value_to_self_msat, stat11.value_to_self_msat + amt_msat);
1683 assert_eq!(stat12_.value_to_self_msat, stat12.value_to_self_msat - (amt_msat - feemsat));
1684 assert_eq!(stat22_.value_to_self_msat, stat22.value_to_self_msat + (amt_msat - feemsat));
1685 stat01 = stat01_; stat11 = stat11_; stat12 = stat12_; stat22 = stat22_;
1688 // adding pending output.
1689 // 2* and +1 HTLCs on the commit tx fee for the fee spike reserve.
1690 // The reason we're dividing by two here is as follows: the dividend is the total outbound liquidity
1691 // after fees, the channel reserve, and the fee spike buffer are removed. We eventually want to
1692 // divide this quantity into 3 portions, that will each be sent in an HTLC. This allows us
1693 // to test channel channel reserve policy at the edges of what amount is sendable, i.e.
1694 // cases where 1 msat over X amount will cause a payment failure, but anything less than
1695 // that can be sent successfully. So, dividing by two is a somewhat arbitrary way of getting
1696 // the amount of the first of these aforementioned 3 payments. The reason we split into 3 payments
1697 // is to test the behavior of the holding cell with respect to channel reserve and commit tx fee
1699 let commit_tx_fee_2_htlcs = 2*commit_tx_fee_msat(feerate, 2 + 1);
1700 let recv_value_1 = (stat01.value_to_self_msat - stat01.channel_reserve_msat - total_fee_msat - commit_tx_fee_2_htlcs)/2;
1701 let amt_msat_1 = recv_value_1 + total_fee_msat;
1703 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);
1704 let payment_event_1 = {
1705 nodes[0].node.send_payment(&route_1, our_payment_hash_1, &Some(our_payment_secret_1)).unwrap();
1706 check_added_monitors!(nodes[0], 1);
1708 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1709 assert_eq!(events.len(), 1);
1710 SendEvent::from_event(events.remove(0))
1712 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event_1.msgs[0]);
1714 // channel reserve test with htlc pending output > 0
1715 let recv_value_2 = stat01.value_to_self_msat - amt_msat_1 - stat01.channel_reserve_msat - total_fee_msat - commit_tx_fee_2_htlcs;
1717 let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], recv_value_2 + 1);
1718 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
1719 assert!(regex::Regex::new(r"Cannot send value that would put our balance under counterparty-announced channel reserve value \(\d+\)").unwrap().is_match(err)));
1720 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1723 // split the rest to test holding cell
1724 let commit_tx_fee_3_htlcs = 2*commit_tx_fee_msat(feerate, 3 + 1);
1725 let additional_htlc_cost_msat = commit_tx_fee_3_htlcs - commit_tx_fee_2_htlcs;
1726 let recv_value_21 = recv_value_2/2 - additional_htlc_cost_msat/2;
1727 let recv_value_22 = recv_value_2 - recv_value_21 - total_fee_msat - additional_htlc_cost_msat;
1729 let stat = get_channel_value_stat!(nodes[0], chan_1.2);
1730 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);
1733 // now see if they go through on both sides
1734 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);
1735 // but this will stuck in the holding cell
1736 nodes[0].node.send_payment(&route_21, our_payment_hash_21, &Some(our_payment_secret_21)).unwrap();
1737 check_added_monitors!(nodes[0], 0);
1738 let events = nodes[0].node.get_and_clear_pending_events();
1739 assert_eq!(events.len(), 0);
1741 // test with outbound holding cell amount > 0
1743 let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], recv_value_22+1);
1744 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
1745 assert!(regex::Regex::new(r"Cannot send value that would put our balance under counterparty-announced channel reserve value \(\d+\)").unwrap().is_match(err)));
1746 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1747 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);
1750 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);
1751 // this will also stuck in the holding cell
1752 nodes[0].node.send_payment(&route_22, our_payment_hash_22, &Some(our_payment_secret_22)).unwrap();
1753 check_added_monitors!(nodes[0], 0);
1754 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
1755 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1757 // flush the pending htlc
1758 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event_1.commitment_msg);
1759 let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1760 check_added_monitors!(nodes[1], 1);
1762 // the pending htlc should be promoted to committed
1763 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_revoke_and_ack);
1764 check_added_monitors!(nodes[0], 1);
1765 let commitment_update_2 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1767 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &as_commitment_signed);
1768 let bs_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1769 // No commitment_signed so get_event_msg's assert(len == 1) passes
1770 check_added_monitors!(nodes[0], 1);
1772 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &bs_revoke_and_ack);
1773 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1774 check_added_monitors!(nodes[1], 1);
1776 expect_pending_htlcs_forwardable!(nodes[1]);
1778 let ref payment_event_11 = expect_forward!(nodes[1]);
1779 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_11.msgs[0]);
1780 commitment_signed_dance!(nodes[2], nodes[1], payment_event_11.commitment_msg, false);
1782 expect_pending_htlcs_forwardable!(nodes[2]);
1783 expect_payment_received!(nodes[2], our_payment_hash_1, our_payment_secret_1, recv_value_1);
1785 // flush the htlcs in the holding cell
1786 assert_eq!(commitment_update_2.update_add_htlcs.len(), 2);
1787 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &commitment_update_2.update_add_htlcs[0]);
1788 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &commitment_update_2.update_add_htlcs[1]);
1789 commitment_signed_dance!(nodes[1], nodes[0], &commitment_update_2.commitment_signed, false);
1790 expect_pending_htlcs_forwardable!(nodes[1]);
1792 let ref payment_event_3 = expect_forward!(nodes[1]);
1793 assert_eq!(payment_event_3.msgs.len(), 2);
1794 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_3.msgs[0]);
1795 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_3.msgs[1]);
1797 commitment_signed_dance!(nodes[2], nodes[1], &payment_event_3.commitment_msg, false);
1798 expect_pending_htlcs_forwardable!(nodes[2]);
1800 let events = nodes[2].node.get_and_clear_pending_events();
1801 assert_eq!(events.len(), 2);
1803 Event::PaymentReceived { ref payment_hash, ref purpose, amt } => {
1804 assert_eq!(our_payment_hash_21, *payment_hash);
1805 assert_eq!(recv_value_21, amt);
1807 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
1808 assert!(payment_preimage.is_none());
1809 assert_eq!(our_payment_secret_21, *payment_secret);
1811 _ => panic!("expected PaymentPurpose::InvoicePayment")
1814 _ => panic!("Unexpected event"),
1817 Event::PaymentReceived { ref payment_hash, ref purpose, amt } => {
1818 assert_eq!(our_payment_hash_22, *payment_hash);
1819 assert_eq!(recv_value_22, amt);
1821 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
1822 assert!(payment_preimage.is_none());
1823 assert_eq!(our_payment_secret_22, *payment_secret);
1825 _ => panic!("expected PaymentPurpose::InvoicePayment")
1828 _ => panic!("Unexpected event"),
1831 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_1);
1832 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_21);
1833 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_22);
1835 let commit_tx_fee_0_htlcs = 2*commit_tx_fee_msat(feerate, 1);
1836 let recv_value_3 = commit_tx_fee_2_htlcs - commit_tx_fee_0_htlcs - total_fee_msat;
1837 send_payment(&nodes[0], &vec![&nodes[1], &nodes[2]][..], recv_value_3);
1839 let commit_tx_fee_1_htlc = 2*commit_tx_fee_msat(feerate, 1 + 1);
1840 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);
1841 let stat0 = get_channel_value_stat!(nodes[0], chan_1.2);
1842 assert_eq!(stat0.value_to_self_msat, expected_value_to_self);
1843 assert_eq!(stat0.value_to_self_msat, stat0.channel_reserve_msat + commit_tx_fee_1_htlc);
1845 let stat2 = get_channel_value_stat!(nodes[2], chan_2.2);
1846 assert_eq!(stat2.value_to_self_msat, stat22.value_to_self_msat + recv_value_1 + recv_value_21 + recv_value_22 + recv_value_3);
1850 fn channel_reserve_in_flight_removes() {
1851 // In cases where one side claims an HTLC, it thinks it has additional available funds that it
1852 // can send to its counterparty, but due to update ordering, the other side may not yet have
1853 // considered those HTLCs fully removed.
1854 // This tests that we don't count HTLCs which will not be included in the next remote
1855 // commitment transaction towards the reserve value (as it implies no commitment transaction
1856 // will be generated which violates the remote reserve value).
1857 // This was broken previously, and discovered by the chanmon_fail_consistency fuzz test.
1859 // * route two HTLCs from A to B (note that, at a high level, this test is checking that, when
1860 // you consider the values of both of these HTLCs, B may not send an HTLC back to A, but if
1861 // you only consider the value of the first HTLC, it may not),
1862 // * start routing a third HTLC from A to B,
1863 // * claim the first two HTLCs (though B will generate an update_fulfill for one, and put
1864 // the other claim in its holding cell, as it immediately goes into AwaitingRAA),
1865 // * deliver the first fulfill from B
1866 // * deliver the update_add and an RAA from A, resulting in B freeing the second holding cell
1868 // * deliver A's response CS and RAA.
1869 // This results in A having the second HTLC in AwaitingRemovedRemoteRevoke, but B having
1870 // removed it fully. B now has the push_msat plus the first two HTLCs in value.
1871 // * Now B happily sends another HTLC, potentially violating its reserve value from A's point
1872 // of view (if A counts the AwaitingRemovedRemoteRevoke HTLC).
1873 let chanmon_cfgs = create_chanmon_cfgs(2);
1874 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1875 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1876 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1877 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
1878 let logger = test_utils::TestLogger::new();
1880 let b_chan_values = get_channel_value_stat!(nodes[1], chan_1.2);
1881 // Route the first two HTLCs.
1882 let (payment_preimage_1, _, _) = route_payment(&nodes[0], &[&nodes[1]], b_chan_values.channel_reserve_msat - b_chan_values.value_to_self_msat - 10000);
1883 let (payment_preimage_2, _, _) = route_payment(&nodes[0], &[&nodes[1]], 20000);
1885 // Start routing the third HTLC (this is just used to get everyone in the right state).
1886 let (payment_preimage_3, payment_hash_3, payment_secret_3) = get_payment_preimage_hash!(nodes[1]);
1888 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
1889 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();
1890 nodes[0].node.send_payment(&route, payment_hash_3, &Some(payment_secret_3)).unwrap();
1891 check_added_monitors!(nodes[0], 1);
1892 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1893 assert_eq!(events.len(), 1);
1894 SendEvent::from_event(events.remove(0))
1897 // Now claim both of the first two HTLCs on B's end, putting B in AwaitingRAA and generating an
1898 // initial fulfill/CS.
1899 assert!(nodes[1].node.claim_funds(payment_preimage_1));
1900 check_added_monitors!(nodes[1], 1);
1901 let bs_removes = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1903 // This claim goes in B's holding cell, allowing us to have a pending B->A RAA which does not
1904 // remove the second HTLC when we send the HTLC back from B to A.
1905 assert!(nodes[1].node.claim_funds(payment_preimage_2));
1906 check_added_monitors!(nodes[1], 1);
1907 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1909 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_removes.update_fulfill_htlcs[0]);
1910 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_removes.commitment_signed);
1911 check_added_monitors!(nodes[0], 1);
1912 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1913 expect_payment_sent!(nodes[0], payment_preimage_1);
1915 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_1.msgs[0]);
1916 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &send_1.commitment_msg);
1917 check_added_monitors!(nodes[1], 1);
1918 // B is already AwaitingRAA, so cant generate a CS here
1919 let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
1921 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1922 check_added_monitors!(nodes[1], 1);
1923 let bs_cs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1925 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
1926 check_added_monitors!(nodes[0], 1);
1927 let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1929 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
1930 check_added_monitors!(nodes[1], 1);
1931 let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
1933 // The second HTLCis removed, but as A is in AwaitingRAA it can't generate a CS here, so the
1934 // RAA that B generated above doesn't fully resolve the second HTLC from A's point of view.
1935 // However, the RAA A generates here *does* fully resolve the HTLC from B's point of view (as A
1936 // can no longer broadcast a commitment transaction with it and B has the preimage so can go
1937 // on-chain as necessary).
1938 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_cs.update_fulfill_htlcs[0]);
1939 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_cs.commitment_signed);
1940 check_added_monitors!(nodes[0], 1);
1941 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1942 expect_payment_sent!(nodes[0], payment_preimage_2);
1944 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1945 check_added_monitors!(nodes[1], 1);
1946 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1948 expect_pending_htlcs_forwardable!(nodes[1]);
1949 expect_payment_received!(nodes[1], payment_hash_3, payment_secret_3, 100000);
1951 // Note that as this RAA was generated before the delivery of the update_fulfill it shouldn't
1952 // resolve the second HTLC from A's point of view.
1953 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
1954 check_added_monitors!(nodes[0], 1);
1955 let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1957 // Now that B doesn't have the second RAA anymore, but A still does, send a payment from B back
1958 // to A to ensure that A doesn't count the almost-removed HTLC in update_add processing.
1959 let (payment_preimage_4, payment_hash_4, payment_secret_4) = get_payment_preimage_hash!(nodes[0]);
1961 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
1962 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();
1963 nodes[1].node.send_payment(&route, payment_hash_4, &Some(payment_secret_4)).unwrap();
1964 check_added_monitors!(nodes[1], 1);
1965 let mut events = nodes[1].node.get_and_clear_pending_msg_events();
1966 assert_eq!(events.len(), 1);
1967 SendEvent::from_event(events.remove(0))
1970 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &send_2.msgs[0]);
1971 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &send_2.commitment_msg);
1972 check_added_monitors!(nodes[0], 1);
1973 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1975 // Now just resolve all the outstanding messages/HTLCs for completeness...
1977 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
1978 check_added_monitors!(nodes[1], 1);
1979 let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
1981 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1982 check_added_monitors!(nodes[1], 1);
1984 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
1985 check_added_monitors!(nodes[0], 1);
1986 let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1988 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
1989 check_added_monitors!(nodes[1], 1);
1990 let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
1992 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
1993 check_added_monitors!(nodes[0], 1);
1995 expect_pending_htlcs_forwardable!(nodes[0]);
1996 expect_payment_received!(nodes[0], payment_hash_4, payment_secret_4, 10000);
1998 claim_payment(&nodes[1], &[&nodes[0]], payment_preimage_4);
1999 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_3);
2003 fn channel_monitor_network_test() {
2004 // Simple test which builds a network of ChannelManagers, connects them to each other, and
2005 // tests that ChannelMonitor is able to recover from various states.
2006 let chanmon_cfgs = create_chanmon_cfgs(5);
2007 let node_cfgs = create_node_cfgs(5, &chanmon_cfgs);
2008 let node_chanmgrs = create_node_chanmgrs(5, &node_cfgs, &[None, None, None, None, None]);
2009 let nodes = create_network(5, &node_cfgs, &node_chanmgrs);
2011 // Create some initial channels
2012 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2013 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
2014 let chan_3 = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
2015 let chan_4 = create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::known(), InitFeatures::known());
2017 // Make sure all nodes are at the same starting height
2018 connect_blocks(&nodes[0], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[0].best_block_info().1);
2019 connect_blocks(&nodes[1], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[1].best_block_info().1);
2020 connect_blocks(&nodes[2], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[2].best_block_info().1);
2021 connect_blocks(&nodes[3], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[3].best_block_info().1);
2022 connect_blocks(&nodes[4], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[4].best_block_info().1);
2024 // Rebalance the network a bit by relaying one payment through all the channels...
2025 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
2026 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
2027 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
2028 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
2030 // Simple case with no pending HTLCs:
2031 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), true);
2032 check_added_monitors!(nodes[1], 1);
2033 check_closed_broadcast!(nodes[1], false);
2035 let mut node_txn = test_txn_broadcast(&nodes[1], &chan_1, None, HTLCType::NONE);
2036 assert_eq!(node_txn.len(), 1);
2037 mine_transaction(&nodes[0], &node_txn[0]);
2038 check_added_monitors!(nodes[0], 1);
2039 test_txn_broadcast(&nodes[0], &chan_1, None, HTLCType::NONE);
2041 check_closed_broadcast!(nodes[0], true);
2042 assert_eq!(nodes[0].node.list_channels().len(), 0);
2043 assert_eq!(nodes[1].node.list_channels().len(), 1);
2045 // One pending HTLC is discarded by the force-close:
2046 let payment_preimage_1 = route_payment(&nodes[1], &vec!(&nodes[2], &nodes[3])[..], 3000000).0;
2048 // Simple case of one pending HTLC to HTLC-Timeout (note that the HTLC-Timeout is not
2049 // broadcasted until we reach the timelock time).
2050 nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id(), true);
2051 check_closed_broadcast!(nodes[1], false);
2052 check_added_monitors!(nodes[1], 1);
2054 let mut node_txn = test_txn_broadcast(&nodes[1], &chan_2, None, HTLCType::NONE);
2055 connect_blocks(&nodes[1], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + MIN_CLTV_EXPIRY_DELTA as u32 + 1);
2056 test_txn_broadcast(&nodes[1], &chan_2, None, HTLCType::TIMEOUT);
2057 mine_transaction(&nodes[2], &node_txn[0]);
2058 check_added_monitors!(nodes[2], 1);
2059 test_txn_broadcast(&nodes[2], &chan_2, None, HTLCType::NONE);
2061 check_closed_broadcast!(nodes[2], true);
2062 assert_eq!(nodes[1].node.list_channels().len(), 0);
2063 assert_eq!(nodes[2].node.list_channels().len(), 1);
2065 macro_rules! claim_funds {
2066 ($node: expr, $prev_node: expr, $preimage: expr) => {
2068 assert!($node.node.claim_funds($preimage));
2069 check_added_monitors!($node, 1);
2071 let events = $node.node.get_and_clear_pending_msg_events();
2072 assert_eq!(events.len(), 1);
2074 MessageSendEvent::UpdateHTLCs { ref node_id, updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fail_htlcs, .. } } => {
2075 assert!(update_add_htlcs.is_empty());
2076 assert!(update_fail_htlcs.is_empty());
2077 assert_eq!(*node_id, $prev_node.node.get_our_node_id());
2079 _ => panic!("Unexpected event"),
2085 // nodes[3] gets the preimage, but nodes[2] already disconnected, resulting in a nodes[2]
2086 // HTLC-Timeout and a nodes[3] claim against it (+ its own announces)
2087 nodes[2].node.peer_disconnected(&nodes[3].node.get_our_node_id(), true);
2088 check_added_monitors!(nodes[2], 1);
2089 check_closed_broadcast!(nodes[2], false);
2090 let node2_commitment_txid;
2092 let node_txn = test_txn_broadcast(&nodes[2], &chan_3, None, HTLCType::NONE);
2093 connect_blocks(&nodes[2], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + MIN_CLTV_EXPIRY_DELTA as u32 + 1);
2094 test_txn_broadcast(&nodes[2], &chan_3, None, HTLCType::TIMEOUT);
2095 node2_commitment_txid = node_txn[0].txid();
2097 // Claim the payment on nodes[3], giving it knowledge of the preimage
2098 claim_funds!(nodes[3], nodes[2], payment_preimage_1);
2099 mine_transaction(&nodes[3], &node_txn[0]);
2100 check_added_monitors!(nodes[3], 1);
2101 check_preimage_claim(&nodes[3], &node_txn);
2103 check_closed_broadcast!(nodes[3], true);
2104 assert_eq!(nodes[2].node.list_channels().len(), 0);
2105 assert_eq!(nodes[3].node.list_channels().len(), 1);
2107 // Drop the ChannelMonitor for the previous channel to avoid it broadcasting transactions and
2108 // confusing us in the following tests.
2109 let chan_3_mon = nodes[3].chain_monitor.chain_monitor.monitors.write().unwrap().remove(&OutPoint { txid: chan_3.3.txid(), index: 0 }).unwrap();
2111 // One pending HTLC to time out:
2112 let payment_preimage_2 = route_payment(&nodes[3], &vec!(&nodes[4])[..], 3000000).0;
2113 // CLTV expires at TEST_FINAL_CLTV + 1 (current height) + 1 (added in send_payment for
2116 let (close_chan_update_1, close_chan_update_2) = {
2117 connect_blocks(&nodes[3], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + 1);
2118 let events = nodes[3].node.get_and_clear_pending_msg_events();
2119 assert_eq!(events.len(), 2);
2120 let close_chan_update_1 = match events[0] {
2121 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
2124 _ => panic!("Unexpected event"),
2127 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { .. }, node_id } => {
2128 assert_eq!(node_id, nodes[4].node.get_our_node_id());
2130 _ => panic!("Unexpected event"),
2132 check_added_monitors!(nodes[3], 1);
2134 // Clear bumped claiming txn spending node 2 commitment tx. Bumped txn are generated after reaching some height timer.
2136 let mut node_txn = nodes[3].tx_broadcaster.txn_broadcasted.lock().unwrap();
2137 node_txn.retain(|tx| {
2138 if tx.input[0].previous_output.txid == node2_commitment_txid {
2144 let node_txn = test_txn_broadcast(&nodes[3], &chan_4, None, HTLCType::TIMEOUT);
2146 // Claim the payment on nodes[4], giving it knowledge of the preimage
2147 claim_funds!(nodes[4], nodes[3], payment_preimage_2);
2149 connect_blocks(&nodes[4], TEST_FINAL_CLTV - CLTV_CLAIM_BUFFER + 2);
2150 let events = nodes[4].node.get_and_clear_pending_msg_events();
2151 assert_eq!(events.len(), 2);
2152 let close_chan_update_2 = match events[0] {
2153 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
2156 _ => panic!("Unexpected event"),
2159 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { .. }, node_id } => {
2160 assert_eq!(node_id, nodes[3].node.get_our_node_id());
2162 _ => panic!("Unexpected event"),
2164 check_added_monitors!(nodes[4], 1);
2165 test_txn_broadcast(&nodes[4], &chan_4, None, HTLCType::SUCCESS);
2167 mine_transaction(&nodes[4], &node_txn[0]);
2168 check_preimage_claim(&nodes[4], &node_txn);
2169 (close_chan_update_1, close_chan_update_2)
2171 nodes[3].net_graph_msg_handler.handle_channel_update(&close_chan_update_2).unwrap();
2172 nodes[4].net_graph_msg_handler.handle_channel_update(&close_chan_update_1).unwrap();
2173 assert_eq!(nodes[3].node.list_channels().len(), 0);
2174 assert_eq!(nodes[4].node.list_channels().len(), 0);
2176 nodes[3].chain_monitor.chain_monitor.monitors.write().unwrap().insert(OutPoint { txid: chan_3.3.txid(), index: 0 }, chan_3_mon);
2180 fn test_justice_tx() {
2181 // Test justice txn built on revoked HTLC-Success tx, against both sides
2182 let mut alice_config = UserConfig::default();
2183 alice_config.channel_options.announced_channel = true;
2184 alice_config.peer_channel_config_limits.force_announced_channel_preference = false;
2185 alice_config.own_channel_config.our_to_self_delay = 6 * 24 * 5;
2186 let mut bob_config = UserConfig::default();
2187 bob_config.channel_options.announced_channel = true;
2188 bob_config.peer_channel_config_limits.force_announced_channel_preference = false;
2189 bob_config.own_channel_config.our_to_self_delay = 6 * 24 * 3;
2190 let user_cfgs = [Some(alice_config), Some(bob_config)];
2191 let mut chanmon_cfgs = create_chanmon_cfgs(2);
2192 chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
2193 chanmon_cfgs[1].keys_manager.disable_revocation_policy_check = true;
2194 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2195 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &user_cfgs);
2196 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2197 // Create some new channels:
2198 let chan_5 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2200 // A pending HTLC which will be revoked:
2201 let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2202 // Get the will-be-revoked local txn from nodes[0]
2203 let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_5.2);
2204 assert_eq!(revoked_local_txn.len(), 2); // First commitment tx, then HTLC tx
2205 assert_eq!(revoked_local_txn[0].input.len(), 1);
2206 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_5.3.txid());
2207 assert_eq!(revoked_local_txn[0].output.len(), 2); // Only HTLC and output back to 0 are present
2208 assert_eq!(revoked_local_txn[1].input.len(), 1);
2209 assert_eq!(revoked_local_txn[1].input[0].previous_output.txid, revoked_local_txn[0].txid());
2210 assert_eq!(revoked_local_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC-Timeout
2211 // Revoke the old state
2212 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_3);
2215 mine_transaction(&nodes[1], &revoked_local_txn[0]);
2217 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2218 assert_eq!(node_txn.len(), 2); // ChannelMonitor: penalty tx, ChannelManager: local commitment tx
2219 assert_eq!(node_txn[0].input.len(), 2); // We should claim the revoked output and the HTLC output
2221 check_spends!(node_txn[0], revoked_local_txn[0]);
2222 node_txn.swap_remove(0);
2223 node_txn.truncate(1);
2225 check_added_monitors!(nodes[1], 1);
2226 test_txn_broadcast(&nodes[1], &chan_5, None, HTLCType::NONE);
2228 mine_transaction(&nodes[0], &revoked_local_txn[0]);
2229 connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
2230 // Verify broadcast of revoked HTLC-timeout
2231 let node_txn = test_txn_broadcast(&nodes[0], &chan_5, Some(revoked_local_txn[0].clone()), HTLCType::TIMEOUT);
2232 check_added_monitors!(nodes[0], 1);
2233 // Broadcast revoked HTLC-timeout on node 1
2234 mine_transaction(&nodes[1], &node_txn[1]);
2235 test_revoked_htlc_claim_txn_broadcast(&nodes[1], node_txn[1].clone(), revoked_local_txn[0].clone());
2237 get_announce_close_broadcast_events(&nodes, 0, 1);
2239 assert_eq!(nodes[0].node.list_channels().len(), 0);
2240 assert_eq!(nodes[1].node.list_channels().len(), 0);
2242 // We test justice_tx build by A on B's revoked HTLC-Success tx
2243 // Create some new channels:
2244 let chan_6 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2246 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2250 // A pending HTLC which will be revoked:
2251 let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2252 // Get the will-be-revoked local txn from B
2253 let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan_6.2);
2254 assert_eq!(revoked_local_txn.len(), 1); // Only commitment tx
2255 assert_eq!(revoked_local_txn[0].input.len(), 1);
2256 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_6.3.txid());
2257 assert_eq!(revoked_local_txn[0].output.len(), 2); // Only HTLC and output back to A are present
2258 // Revoke the old state
2259 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_4);
2261 mine_transaction(&nodes[0], &revoked_local_txn[0]);
2263 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
2264 assert_eq!(node_txn.len(), 2); //ChannelMonitor: penalty tx, ChannelManager: local commitment tx
2265 assert_eq!(node_txn[0].input.len(), 1); // We claim the received HTLC output
2267 check_spends!(node_txn[0], revoked_local_txn[0]);
2268 node_txn.swap_remove(0);
2270 check_added_monitors!(nodes[0], 1);
2271 test_txn_broadcast(&nodes[0], &chan_6, None, HTLCType::NONE);
2273 mine_transaction(&nodes[1], &revoked_local_txn[0]);
2274 let node_txn = test_txn_broadcast(&nodes[1], &chan_6, Some(revoked_local_txn[0].clone()), HTLCType::SUCCESS);
2275 check_added_monitors!(nodes[1], 1);
2276 mine_transaction(&nodes[0], &node_txn[1]);
2277 test_revoked_htlc_claim_txn_broadcast(&nodes[0], node_txn[1].clone(), revoked_local_txn[0].clone());
2279 get_announce_close_broadcast_events(&nodes, 0, 1);
2280 assert_eq!(nodes[0].node.list_channels().len(), 0);
2281 assert_eq!(nodes[1].node.list_channels().len(), 0);
2285 fn revoked_output_claim() {
2286 // Simple test to ensure a node will claim a revoked output when a stale remote commitment
2287 // transaction is broadcast by its counterparty
2288 let chanmon_cfgs = create_chanmon_cfgs(2);
2289 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2290 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2291 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2292 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2293 // node[0] is gonna to revoke an old state thus node[1] should be able to claim the revoked output
2294 let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2295 assert_eq!(revoked_local_txn.len(), 1);
2296 // Only output is the full channel value back to nodes[0]:
2297 assert_eq!(revoked_local_txn[0].output.len(), 1);
2298 // Send a payment through, updating everyone's latest commitment txn
2299 send_payment(&nodes[0], &vec!(&nodes[1])[..], 5000000);
2301 // Inform nodes[1] that nodes[0] broadcast a stale tx
2302 mine_transaction(&nodes[1], &revoked_local_txn[0]);
2303 check_added_monitors!(nodes[1], 1);
2304 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2305 assert_eq!(node_txn.len(), 2); // ChannelMonitor: justice tx against revoked to_local output, ChannelManager: local commitment tx
2307 check_spends!(node_txn[0], revoked_local_txn[0]);
2308 check_spends!(node_txn[1], chan_1.3);
2310 // Inform nodes[0] that a watchtower cheated on its behalf, so it will force-close the chan
2311 mine_transaction(&nodes[0], &revoked_local_txn[0]);
2312 get_announce_close_broadcast_events(&nodes, 0, 1);
2313 check_added_monitors!(nodes[0], 1)
2317 fn claim_htlc_outputs_shared_tx() {
2318 // Node revoked old state, htlcs haven't time out yet, claim them in shared justice tx
2319 let mut chanmon_cfgs = create_chanmon_cfgs(2);
2320 chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
2321 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2322 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2323 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2325 // Create some new channel:
2326 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2328 // Rebalance the network to generate htlc in the two directions
2329 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
2330 // 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
2331 let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2332 let (_payment_preimage_2, payment_hash_2, _) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000);
2334 // Get the will-be-revoked local txn from node[0]
2335 let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2336 assert_eq!(revoked_local_txn.len(), 2); // commitment tx + 1 HTLC-Timeout tx
2337 assert_eq!(revoked_local_txn[0].input.len(), 1);
2338 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
2339 assert_eq!(revoked_local_txn[1].input.len(), 1);
2340 assert_eq!(revoked_local_txn[1].input[0].previous_output.txid, revoked_local_txn[0].txid());
2341 assert_eq!(revoked_local_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC-Timeout
2342 check_spends!(revoked_local_txn[1], revoked_local_txn[0]);
2344 //Revoke the old state
2345 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_1);
2348 mine_transaction(&nodes[0], &revoked_local_txn[0]);
2349 check_added_monitors!(nodes[0], 1);
2350 mine_transaction(&nodes[1], &revoked_local_txn[0]);
2351 check_added_monitors!(nodes[1], 1);
2352 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
2353 expect_payment_failed!(nodes[1], payment_hash_2, true);
2355 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2356 assert_eq!(node_txn.len(), 2); // ChannelMonitor: penalty tx, ChannelManager: local commitment
2358 assert_eq!(node_txn[0].input.len(), 3); // Claim the revoked output + both revoked HTLC outputs
2359 check_spends!(node_txn[0], revoked_local_txn[0]);
2361 let mut witness_lens = BTreeSet::new();
2362 witness_lens.insert(node_txn[0].input[0].witness.last().unwrap().len());
2363 witness_lens.insert(node_txn[0].input[1].witness.last().unwrap().len());
2364 witness_lens.insert(node_txn[0].input[2].witness.last().unwrap().len());
2365 assert_eq!(witness_lens.len(), 3);
2366 assert_eq!(*witness_lens.iter().skip(0).next().unwrap(), 77); // revoked to_local
2367 assert_eq!(*witness_lens.iter().skip(1).next().unwrap(), OFFERED_HTLC_SCRIPT_WEIGHT); // revoked offered HTLC
2368 assert_eq!(*witness_lens.iter().skip(2).next().unwrap(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // revoked received HTLC
2370 // Next nodes[1] broadcasts its current local tx state:
2371 assert_eq!(node_txn[1].input.len(), 1);
2372 assert_eq!(node_txn[1].input[0].previous_output.txid, chan_1.3.txid()); //Spending funding tx unique txouput, tx broadcasted by ChannelManager
2374 get_announce_close_broadcast_events(&nodes, 0, 1);
2375 assert_eq!(nodes[0].node.list_channels().len(), 0);
2376 assert_eq!(nodes[1].node.list_channels().len(), 0);
2380 fn claim_htlc_outputs_single_tx() {
2381 // Node revoked old state, htlcs have timed out, claim each of them in separated justice tx
2382 let mut chanmon_cfgs = create_chanmon_cfgs(2);
2383 chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
2384 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2385 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2386 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2388 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2390 // Rebalance the network to generate htlc in the two directions
2391 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
2392 // 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
2393 // time as two different claim transactions as we're gonna to timeout htlc with given a high current height
2394 let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2395 let (_payment_preimage_2, payment_hash_2, _payment_secret_2) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000);
2397 // Get the will-be-revoked local txn from node[0]
2398 let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2400 //Revoke the old state
2401 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_1);
2404 confirm_transaction_at(&nodes[0], &revoked_local_txn[0], 100);
2405 check_added_monitors!(nodes[0], 1);
2406 confirm_transaction_at(&nodes[1], &revoked_local_txn[0], 100);
2407 check_added_monitors!(nodes[1], 1);
2408 expect_pending_htlcs_forwardable_ignore!(nodes[0]);
2410 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
2411 expect_payment_failed!(nodes[1], payment_hash_2, true);
2413 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2414 assert_eq!(node_txn.len(), 9);
2415 // ChannelMonitor: justice tx revoked offered htlc, justice tx revoked received htlc, justice tx revoked to_local (3)
2416 // ChannelManager: local commmitment + local HTLC-timeout (2)
2417 // 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)
2418 // ChannelMonitor: local commitment + local HTLC-timeout (2)
2420 // Check the pair local commitment and HTLC-timeout broadcast due to HTLC expiration
2421 assert_eq!(node_txn[0].input.len(), 1);
2422 check_spends!(node_txn[0], chan_1.3);
2423 assert_eq!(node_txn[1].input.len(), 1);
2424 let witness_script = node_txn[1].input[0].witness.last().unwrap();
2425 assert_eq!(witness_script.len(), OFFERED_HTLC_SCRIPT_WEIGHT); //Spending an offered htlc output
2426 check_spends!(node_txn[1], node_txn[0]);
2428 // Justice transactions are indices 1-2-4
2429 assert_eq!(node_txn[2].input.len(), 1);
2430 assert_eq!(node_txn[3].input.len(), 1);
2431 assert_eq!(node_txn[4].input.len(), 1);
2433 check_spends!(node_txn[2], revoked_local_txn[0]);
2434 check_spends!(node_txn[3], revoked_local_txn[0]);
2435 check_spends!(node_txn[4], revoked_local_txn[0]);
2437 let mut witness_lens = BTreeSet::new();
2438 witness_lens.insert(node_txn[2].input[0].witness.last().unwrap().len());
2439 witness_lens.insert(node_txn[3].input[0].witness.last().unwrap().len());
2440 witness_lens.insert(node_txn[4].input[0].witness.last().unwrap().len());
2441 assert_eq!(witness_lens.len(), 3);
2442 assert_eq!(*witness_lens.iter().skip(0).next().unwrap(), 77); // revoked to_local
2443 assert_eq!(*witness_lens.iter().skip(1).next().unwrap(), OFFERED_HTLC_SCRIPT_WEIGHT); // revoked offered HTLC
2444 assert_eq!(*witness_lens.iter().skip(2).next().unwrap(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // revoked received HTLC
2446 get_announce_close_broadcast_events(&nodes, 0, 1);
2447 assert_eq!(nodes[0].node.list_channels().len(), 0);
2448 assert_eq!(nodes[1].node.list_channels().len(), 0);
2452 fn test_htlc_on_chain_success() {
2453 // Test that in case of a unilateral close onchain, we detect the state of output and pass
2454 // the preimage backward accordingly. So here we test that ChannelManager is
2455 // broadcasting the right event to other nodes in payment path.
2456 // We test with two HTLCs simultaneously as that was not handled correctly in the past.
2457 // A --------------------> B ----------------------> C (preimage)
2458 // First, C should claim the HTLC outputs via HTLC-Success when its own latest local
2459 // commitment transaction was broadcast.
2460 // Then, B should learn the preimage from said transactions, attempting to claim backwards
2462 // B should be able to claim via preimage if A then broadcasts its local tx.
2463 // Finally, when A sees B's latest local commitment transaction it should be able to claim
2464 // the HTLC outputs via the preimage it learned (which, once confirmed should generate a
2465 // PaymentSent event).
2467 let chanmon_cfgs = create_chanmon_cfgs(3);
2468 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2469 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2470 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2472 // Create some initial channels
2473 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2474 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
2476 // Ensure all nodes are at the same height
2477 let node_max_height = nodes.iter().map(|node| node.blocks.lock().unwrap().len()).max().unwrap() as u32;
2478 connect_blocks(&nodes[0], node_max_height - nodes[0].best_block_info().1);
2479 connect_blocks(&nodes[1], node_max_height - nodes[1].best_block_info().1);
2480 connect_blocks(&nodes[2], node_max_height - nodes[2].best_block_info().1);
2482 // Rebalance the network a bit by relaying one payment through all the channels...
2483 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
2484 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
2486 let (our_payment_preimage, _payment_hash, _payment_secret) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2487 let (our_payment_preimage_2, _payment_hash_2, _payment_secret_2) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2489 // Broadcast legit commitment tx from C on B's chain
2490 // Broadcast HTLC Success transaction by C on received output from C's commitment tx on B's chain
2491 let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
2492 assert_eq!(commitment_tx.len(), 1);
2493 check_spends!(commitment_tx[0], chan_2.3);
2494 nodes[2].node.claim_funds(our_payment_preimage);
2495 nodes[2].node.claim_funds(our_payment_preimage_2);
2496 check_added_monitors!(nodes[2], 2);
2497 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2498 assert!(updates.update_add_htlcs.is_empty());
2499 assert!(updates.update_fail_htlcs.is_empty());
2500 assert!(updates.update_fail_malformed_htlcs.is_empty());
2501 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
2503 mine_transaction(&nodes[2], &commitment_tx[0]);
2504 check_closed_broadcast!(nodes[2], true);
2505 check_added_monitors!(nodes[2], 1);
2506 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)
2507 assert_eq!(node_txn.len(), 5);
2508 assert_eq!(node_txn[0], node_txn[3]);
2509 assert_eq!(node_txn[1], node_txn[4]);
2510 assert_eq!(node_txn[2], commitment_tx[0]);
2511 check_spends!(node_txn[0], commitment_tx[0]);
2512 check_spends!(node_txn[1], commitment_tx[0]);
2513 assert_eq!(node_txn[0].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2514 assert_eq!(node_txn[1].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2515 assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2516 assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2517 assert_eq!(node_txn[0].lock_time, 0);
2518 assert_eq!(node_txn[1].lock_time, 0);
2520 // Verify that B's ChannelManager is able to extract preimage from HTLC Success tx and pass it backward
2521 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2522 connect_block(&nodes[1], &Block { header, txdata: node_txn});
2523 connect_blocks(&nodes[1], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
2525 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
2526 assert_eq!(added_monitors.len(), 1);
2527 assert_eq!(added_monitors[0].0.txid, chan_2.3.txid());
2528 added_monitors.clear();
2530 let forwarded_events = nodes[1].node.get_and_clear_pending_events();
2531 assert_eq!(forwarded_events.len(), 2);
2532 if let Event::PaymentForwarded { fee_earned_msat: Some(1000), claim_from_onchain_tx: true } = forwarded_events[0] {
2533 } else { panic!(); }
2534 if let Event::PaymentForwarded { fee_earned_msat: Some(1000), claim_from_onchain_tx: true } = forwarded_events[1] {
2535 } else { panic!(); }
2536 let events = nodes[1].node.get_and_clear_pending_msg_events();
2538 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
2539 assert_eq!(added_monitors.len(), 2);
2540 assert_eq!(added_monitors[0].0.txid, chan_1.3.txid());
2541 assert_eq!(added_monitors[1].0.txid, chan_1.3.txid());
2542 added_monitors.clear();
2544 assert_eq!(events.len(), 3);
2546 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
2547 _ => panic!("Unexpected event"),
2550 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { .. }, node_id: _ } => {},
2551 _ => panic!("Unexpected event"),
2555 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, .. } } => {
2556 assert!(update_add_htlcs.is_empty());
2557 assert!(update_fail_htlcs.is_empty());
2558 assert_eq!(update_fulfill_htlcs.len(), 1);
2559 assert!(update_fail_malformed_htlcs.is_empty());
2560 assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
2562 _ => panic!("Unexpected event"),
2564 macro_rules! check_tx_local_broadcast {
2565 ($node: expr, $htlc_offered: expr, $commitment_tx: expr, $chan_tx: expr) => { {
2566 let mut node_txn = $node.tx_broadcaster.txn_broadcasted.lock().unwrap();
2567 assert_eq!(node_txn.len(), 3);
2568 // Node[1]: ChannelManager: 3 (commitment tx, 2*HTLC-Timeout tx), ChannelMonitor: 2 (timeout tx)
2569 // Node[0]: ChannelManager: 3 (commtiemtn tx, 2*HTLC-Timeout tx), ChannelMonitor: 2 HTLC-timeout
2570 check_spends!(node_txn[1], $commitment_tx);
2571 check_spends!(node_txn[2], $commitment_tx);
2572 assert_ne!(node_txn[1].lock_time, 0);
2573 assert_ne!(node_txn[2].lock_time, 0);
2575 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2576 assert_eq!(node_txn[2].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2577 assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2578 assert!(node_txn[2].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2580 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2581 assert_eq!(node_txn[2].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2582 assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2583 assert!(node_txn[2].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2585 check_spends!(node_txn[0], $chan_tx);
2586 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), 71);
2590 // nodes[1] now broadcasts its own local state as a fallback, suggesting an alternate
2591 // commitment transaction with a corresponding HTLC-Timeout transactions, as well as a
2592 // timeout-claim of the output that nodes[2] just claimed via success.
2593 check_tx_local_broadcast!(nodes[1], false, commitment_tx[0], chan_2.3);
2595 // Broadcast legit commitment tx from A on B's chain
2596 // Broadcast preimage tx by B on offered output from A commitment tx on A's chain
2597 let node_a_commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
2598 check_spends!(node_a_commitment_tx[0], chan_1.3);
2599 mine_transaction(&nodes[1], &node_a_commitment_tx[0]);
2600 check_closed_broadcast!(nodes[1], true);
2601 check_added_monitors!(nodes[1], 1);
2602 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
2603 assert_eq!(node_txn.len(), 6); // ChannelManager : 3 (commitment tx + HTLC-Sucess * 2), ChannelMonitor : 3 (HTLC-Success, 2* RBF bumps of above HTLC txn)
2604 let commitment_spend =
2605 if node_txn[0].input[0].previous_output.txid == node_a_commitment_tx[0].txid() {
2606 check_spends!(node_txn[1], commitment_tx[0]);
2607 check_spends!(node_txn[2], commitment_tx[0]);
2608 assert_ne!(node_txn[1].input[0].previous_output.vout, node_txn[2].input[0].previous_output.vout);
2611 check_spends!(node_txn[0], commitment_tx[0]);
2612 check_spends!(node_txn[1], commitment_tx[0]);
2613 assert_ne!(node_txn[0].input[0].previous_output.vout, node_txn[1].input[0].previous_output.vout);
2617 check_spends!(commitment_spend, node_a_commitment_tx[0]);
2618 assert_eq!(commitment_spend.input.len(), 2);
2619 assert_eq!(commitment_spend.input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2620 assert_eq!(commitment_spend.input[1].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2621 assert_eq!(commitment_spend.lock_time, 0);
2622 assert!(commitment_spend.output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2623 check_spends!(node_txn[3], chan_1.3);
2624 assert_eq!(node_txn[3].input[0].witness.clone().last().unwrap().len(), 71);
2625 check_spends!(node_txn[4], node_txn[3]);
2626 check_spends!(node_txn[5], node_txn[3]);
2627 // We don't bother to check that B can claim the HTLC output on its commitment tx here as
2628 // we already checked the same situation with A.
2630 // Verify that A's ChannelManager is able to extract preimage from preimage tx and generate PaymentSent
2631 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2632 connect_block(&nodes[0], &Block { header, txdata: vec![node_a_commitment_tx[0].clone(), commitment_spend.clone()] });
2633 connect_blocks(&nodes[0], TEST_FINAL_CLTV + MIN_CLTV_EXPIRY_DELTA as u32 - 1); // Confirm blocks until the HTLC expires
2634 check_closed_broadcast!(nodes[0], true);
2635 check_added_monitors!(nodes[0], 1);
2636 let events = nodes[0].node.get_and_clear_pending_events();
2637 assert_eq!(events.len(), 2);
2638 let mut first_claimed = false;
2639 for event in events {
2641 Event::PaymentSent { payment_preimage } => {
2642 if payment_preimage == our_payment_preimage {
2643 assert!(!first_claimed);
2644 first_claimed = true;
2646 assert_eq!(payment_preimage, our_payment_preimage_2);
2649 _ => panic!("Unexpected event"),
2652 check_tx_local_broadcast!(nodes[0], true, node_a_commitment_tx[0], chan_1.3);
2655 fn do_test_htlc_on_chain_timeout(connect_style: ConnectStyle) {
2656 // Test that in case of a unilateral close onchain, we detect the state of output and
2657 // timeout the HTLC backward accordingly. So here we test that ChannelManager is
2658 // broadcasting the right event to other nodes in payment path.
2659 // A ------------------> B ----------------------> C (timeout)
2660 // B's commitment tx C's commitment tx
2662 // B's HTLC timeout tx B's timeout tx
2664 let chanmon_cfgs = create_chanmon_cfgs(3);
2665 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2666 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2667 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2668 *nodes[0].connect_style.borrow_mut() = connect_style;
2669 *nodes[1].connect_style.borrow_mut() = connect_style;
2670 *nodes[2].connect_style.borrow_mut() = connect_style;
2672 // Create some intial channels
2673 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2674 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
2676 // Rebalance the network a bit by relaying one payment thorugh all the channels...
2677 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
2678 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
2680 let (_payment_preimage, payment_hash, _payment_secret) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2682 // Broadcast legit commitment tx from C on B's chain
2683 let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
2684 check_spends!(commitment_tx[0], chan_2.3);
2685 nodes[2].node.fail_htlc_backwards(&payment_hash);
2686 check_added_monitors!(nodes[2], 0);
2687 expect_pending_htlcs_forwardable!(nodes[2]);
2688 check_added_monitors!(nodes[2], 1);
2690 let events = nodes[2].node.get_and_clear_pending_msg_events();
2691 assert_eq!(events.len(), 1);
2693 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, .. } } => {
2694 assert!(update_add_htlcs.is_empty());
2695 assert!(!update_fail_htlcs.is_empty());
2696 assert!(update_fulfill_htlcs.is_empty());
2697 assert!(update_fail_malformed_htlcs.is_empty());
2698 assert_eq!(nodes[1].node.get_our_node_id(), *node_id);
2700 _ => panic!("Unexpected event"),
2702 mine_transaction(&nodes[2], &commitment_tx[0]);
2703 check_closed_broadcast!(nodes[2], true);
2704 check_added_monitors!(nodes[2], 1);
2705 let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 1 (commitment tx)
2706 assert_eq!(node_txn.len(), 1);
2707 check_spends!(node_txn[0], chan_2.3);
2708 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), 71);
2710 // Broadcast timeout transaction by B on received output from C's commitment tx on B's chain
2711 // Verify that B's ChannelManager is able to detect that HTLC is timeout by its own tx and react backward in consequence
2712 connect_blocks(&nodes[1], 200 - nodes[2].best_block_info().1);
2713 mine_transaction(&nodes[1], &commitment_tx[0]);
2716 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2717 assert_eq!(node_txn.len(), 5); // ChannelManager : 2 (commitment tx, HTLC-Timeout tx), ChannelMonitor : 2 (local commitment tx + HTLC-timeout), 1 timeout tx
2718 assert_eq!(node_txn[0], node_txn[3]);
2719 assert_eq!(node_txn[1], node_txn[4]);
2721 check_spends!(node_txn[2], commitment_tx[0]);
2722 assert_eq!(node_txn[2].clone().input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2724 check_spends!(node_txn[0], chan_2.3);
2725 check_spends!(node_txn[1], node_txn[0]);
2726 assert_eq!(node_txn[0].clone().input[0].witness.last().unwrap().len(), 71);
2727 assert_eq!(node_txn[1].clone().input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2729 timeout_tx = node_txn[2].clone();
2733 mine_transaction(&nodes[1], &timeout_tx);
2734 check_added_monitors!(nodes[1], 1);
2735 check_closed_broadcast!(nodes[1], true);
2737 // B will rebroadcast a fee-bumped timeout transaction here.
2738 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
2739 assert_eq!(node_txn.len(), 1);
2740 check_spends!(node_txn[0], commitment_tx[0]);
2743 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
2745 // B may rebroadcast its own holder commitment transaction here, as a safeguard against
2746 // some incredibly unlikely partial-eclipse-attack scenarios. That said, because the
2747 // original commitment_tx[0] (also spending chan_2.3) has reached ANTI_REORG_DELAY B really
2748 // shouldn't broadcast anything here, and in some connect style scenarios we do not.
2749 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
2750 if node_txn.len() == 1 {
2751 check_spends!(node_txn[0], chan_2.3);
2753 assert_eq!(node_txn.len(), 0);
2757 expect_pending_htlcs_forwardable!(nodes[1]);
2758 check_added_monitors!(nodes[1], 1);
2759 let events = nodes[1].node.get_and_clear_pending_msg_events();
2760 assert_eq!(events.len(), 1);
2762 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, .. } } => {
2763 assert!(update_add_htlcs.is_empty());
2764 assert!(!update_fail_htlcs.is_empty());
2765 assert!(update_fulfill_htlcs.is_empty());
2766 assert!(update_fail_malformed_htlcs.is_empty());
2767 assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
2769 _ => panic!("Unexpected event"),
2772 // Broadcast legit commitment tx from B on A's chain
2773 let commitment_tx = get_local_commitment_txn!(nodes[1], chan_1.2);
2774 check_spends!(commitment_tx[0], chan_1.3);
2776 mine_transaction(&nodes[0], &commitment_tx[0]);
2777 connect_blocks(&nodes[0], TEST_FINAL_CLTV + MIN_CLTV_EXPIRY_DELTA as u32 - 1); // Confirm blocks until the HTLC expires
2779 check_closed_broadcast!(nodes[0], true);
2780 check_added_monitors!(nodes[0], 1);
2781 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 1 commitment tx, ChannelMonitor : 1 timeout tx
2782 assert_eq!(node_txn.len(), 2);
2783 check_spends!(node_txn[0], chan_1.3);
2784 assert_eq!(node_txn[0].clone().input[0].witness.last().unwrap().len(), 71);
2785 check_spends!(node_txn[1], commitment_tx[0]);
2786 assert_eq!(node_txn[1].clone().input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2790 fn test_htlc_on_chain_timeout() {
2791 do_test_htlc_on_chain_timeout(ConnectStyle::BestBlockFirstSkippingBlocks);
2792 do_test_htlc_on_chain_timeout(ConnectStyle::TransactionsFirstSkippingBlocks);
2793 do_test_htlc_on_chain_timeout(ConnectStyle::FullBlockViaListen);
2797 fn test_simple_commitment_revoked_fail_backward() {
2798 // Test that in case of a revoked commitment tx, we detect the resolution of output by justice tx
2799 // and fail backward accordingly.
2801 let chanmon_cfgs = create_chanmon_cfgs(3);
2802 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2803 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2804 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2806 // Create some initial channels
2807 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2808 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
2810 let (payment_preimage, _payment_hash, _payment_secret) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3000000);
2811 // Get the will-be-revoked local txn from nodes[2]
2812 let revoked_local_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
2813 // Revoke the old state
2814 claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage);
2816 let (_, payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3000000);
2818 mine_transaction(&nodes[1], &revoked_local_txn[0]);
2819 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
2820 check_added_monitors!(nodes[1], 1);
2821 check_closed_broadcast!(nodes[1], true);
2823 expect_pending_htlcs_forwardable!(nodes[1]);
2824 check_added_monitors!(nodes[1], 1);
2825 let events = nodes[1].node.get_and_clear_pending_msg_events();
2826 assert_eq!(events.len(), 1);
2828 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, .. } } => {
2829 assert!(update_add_htlcs.is_empty());
2830 assert_eq!(update_fail_htlcs.len(), 1);
2831 assert!(update_fulfill_htlcs.is_empty());
2832 assert!(update_fail_malformed_htlcs.is_empty());
2833 assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
2835 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
2836 commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
2837 expect_payment_failure_chan_update!(nodes[0], chan_2.0.contents.short_channel_id, true);
2838 expect_payment_failed!(nodes[0], payment_hash, false);
2840 _ => panic!("Unexpected event"),
2844 fn do_test_commitment_revoked_fail_backward_exhaustive(deliver_bs_raa: bool, use_dust: bool, no_to_remote: bool) {
2845 // Test that if our counterparty broadcasts a revoked commitment transaction we fail all
2846 // pending HTLCs on that channel backwards even if the HTLCs aren't present in our latest
2847 // commitment transaction anymore.
2848 // To do this, we have the peer which will broadcast a revoked commitment transaction send
2849 // a number of update_fail/commitment_signed updates without ever sending the RAA in
2850 // response to our commitment_signed. This is somewhat misbehavior-y, though not
2851 // technically disallowed and we should probably handle it reasonably.
2852 // Note that this is pretty exhaustive as an outbound HTLC which we haven't yet
2853 // failed/fulfilled backwards must be in at least one of the latest two remote commitment
2855 // * Once we move it out of our holding cell/add it, we will immediately include it in a
2856 // commitment_signed (implying it will be in the latest remote commitment transaction).
2857 // * Once they remove it, we will send a (the first) commitment_signed without the HTLC,
2858 // and once they revoke the previous commitment transaction (allowing us to send a new
2859 // commitment_signed) we will be free to fail/fulfill the HTLC backwards.
2860 let chanmon_cfgs = create_chanmon_cfgs(3);
2861 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2862 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2863 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2865 // Create some initial channels
2866 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2867 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
2869 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 });
2870 // Get the will-be-revoked local txn from nodes[2]
2871 let revoked_local_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
2872 assert_eq!(revoked_local_txn[0].output.len(), if no_to_remote { 1 } else { 2 });
2873 // Revoke the old state
2874 claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage);
2876 let value = if use_dust {
2877 // The dust limit applied to HTLC outputs considers the fee of the HTLC transaction as
2878 // well, so HTLCs at exactly the dust limit will not be included in commitment txn.
2879 nodes[2].node.channel_state.lock().unwrap().by_id.get(&chan_2.2).unwrap().holder_dust_limit_satoshis * 1000
2882 let (_, first_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
2883 let (_, second_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
2884 let (_, third_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
2886 assert!(nodes[2].node.fail_htlc_backwards(&first_payment_hash));
2887 expect_pending_htlcs_forwardable!(nodes[2]);
2888 check_added_monitors!(nodes[2], 1);
2889 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2890 assert!(updates.update_add_htlcs.is_empty());
2891 assert!(updates.update_fulfill_htlcs.is_empty());
2892 assert!(updates.update_fail_malformed_htlcs.is_empty());
2893 assert_eq!(updates.update_fail_htlcs.len(), 1);
2894 assert!(updates.update_fee.is_none());
2895 nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
2896 let bs_raa = commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false, true, false, true);
2897 // Drop the last RAA from 3 -> 2
2899 assert!(nodes[2].node.fail_htlc_backwards(&second_payment_hash));
2900 expect_pending_htlcs_forwardable!(nodes[2]);
2901 check_added_monitors!(nodes[2], 1);
2902 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2903 assert!(updates.update_add_htlcs.is_empty());
2904 assert!(updates.update_fulfill_htlcs.is_empty());
2905 assert!(updates.update_fail_malformed_htlcs.is_empty());
2906 assert_eq!(updates.update_fail_htlcs.len(), 1);
2907 assert!(updates.update_fee.is_none());
2908 nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
2909 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &updates.commitment_signed);
2910 check_added_monitors!(nodes[1], 1);
2911 // Note that nodes[1] is in AwaitingRAA, so won't send a CS
2912 let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
2913 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
2914 check_added_monitors!(nodes[2], 1);
2916 assert!(nodes[2].node.fail_htlc_backwards(&third_payment_hash));
2917 expect_pending_htlcs_forwardable!(nodes[2]);
2918 check_added_monitors!(nodes[2], 1);
2919 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2920 assert!(updates.update_add_htlcs.is_empty());
2921 assert!(updates.update_fulfill_htlcs.is_empty());
2922 assert!(updates.update_fail_malformed_htlcs.is_empty());
2923 assert_eq!(updates.update_fail_htlcs.len(), 1);
2924 assert!(updates.update_fee.is_none());
2925 nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
2926 // At this point first_payment_hash has dropped out of the latest two commitment
2927 // transactions that nodes[1] is tracking...
2928 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &updates.commitment_signed);
2929 check_added_monitors!(nodes[1], 1);
2930 // Note that nodes[1] is (still) in AwaitingRAA, so won't send a CS
2931 let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
2932 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
2933 check_added_monitors!(nodes[2], 1);
2935 // Add a fourth HTLC, this one will get sequestered away in nodes[1]'s holding cell waiting
2936 // on nodes[2]'s RAA.
2937 let (_, fourth_payment_hash, fourth_payment_secret) = get_payment_preimage_hash!(nodes[2]);
2938 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
2939 let logger = test_utils::TestLogger::new();
2940 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();
2941 nodes[1].node.send_payment(&route, fourth_payment_hash, &Some(fourth_payment_secret)).unwrap();
2942 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2943 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
2944 check_added_monitors!(nodes[1], 0);
2947 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_raa);
2948 // One monitor for the new revocation preimage, no second on as we won't generate a new
2949 // commitment transaction for nodes[0] until process_pending_htlc_forwards().
2950 check_added_monitors!(nodes[1], 1);
2951 let events = nodes[1].node.get_and_clear_pending_events();
2952 assert_eq!(events.len(), 1);
2954 Event::PendingHTLCsForwardable { .. } => { },
2955 _ => panic!("Unexpected event"),
2957 // Deliberately don't process the pending fail-back so they all fail back at once after
2958 // block connection just like the !deliver_bs_raa case
2961 let mut failed_htlcs = HashSet::new();
2962 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
2964 mine_transaction(&nodes[1], &revoked_local_txn[0]);
2965 check_added_monitors!(nodes[1], 1);
2966 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
2968 let events = nodes[1].node.get_and_clear_pending_events();
2969 assert_eq!(events.len(), if deliver_bs_raa { 1 } else { 2 });
2971 Event::PaymentFailed { ref payment_hash, .. } => {
2972 assert_eq!(*payment_hash, fourth_payment_hash);
2974 _ => panic!("Unexpected event"),
2976 if !deliver_bs_raa {
2978 Event::PendingHTLCsForwardable { .. } => { },
2979 _ => panic!("Unexpected event"),
2982 nodes[1].node.process_pending_htlc_forwards();
2983 check_added_monitors!(nodes[1], 1);
2985 let events = nodes[1].node.get_and_clear_pending_msg_events();
2986 assert_eq!(events.len(), if deliver_bs_raa { 4 } else { 3 });
2987 match events[if deliver_bs_raa { 1 } else { 0 }] {
2988 MessageSendEvent::BroadcastChannelUpdate { msg: msgs::ChannelUpdate { .. } } => {},
2989 _ => panic!("Unexpected event"),
2991 match events[if deliver_bs_raa { 2 } else { 1 }] {
2992 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { msg: msgs::ErrorMessage { channel_id, ref data } }, node_id: _ } => {
2993 assert_eq!(channel_id, chan_2.2);
2994 assert_eq!(data.as_str(), "Commitment or closing transaction was confirmed on chain.");
2996 _ => panic!("Unexpected event"),
3000 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, .. } } => {
3001 assert_eq!(nodes[2].node.get_our_node_id(), *node_id);
3002 assert_eq!(update_add_htlcs.len(), 1);
3003 assert!(update_fulfill_htlcs.is_empty());
3004 assert!(update_fail_htlcs.is_empty());
3005 assert!(update_fail_malformed_htlcs.is_empty());
3007 _ => panic!("Unexpected event"),
3010 match events[if deliver_bs_raa { 3 } else { 2 }] {
3011 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, .. } } => {
3012 assert!(update_add_htlcs.is_empty());
3013 assert_eq!(update_fail_htlcs.len(), 3);
3014 assert!(update_fulfill_htlcs.is_empty());
3015 assert!(update_fail_malformed_htlcs.is_empty());
3016 assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
3018 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
3019 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[1]);
3020 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[2]);
3022 commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
3024 let events = nodes[0].node.get_and_clear_pending_msg_events();
3025 // If we delivered B's RAA we got an unknown preimage error, not something
3026 // that we should update our routing table for.
3027 assert_eq!(events.len(), if deliver_bs_raa { 2 } else { 3 });
3028 for event in events {
3030 MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
3031 _ => panic!("Unexpected event"),
3034 let events = nodes[0].node.get_and_clear_pending_events();
3035 assert_eq!(events.len(), 3);
3037 Event::PaymentFailed { ref payment_hash, .. } => {
3038 assert!(failed_htlcs.insert(payment_hash.0));
3040 _ => panic!("Unexpected event"),
3043 Event::PaymentFailed { ref payment_hash, .. } => {
3044 assert!(failed_htlcs.insert(payment_hash.0));
3046 _ => panic!("Unexpected event"),
3049 Event::PaymentFailed { ref payment_hash, .. } => {
3050 assert!(failed_htlcs.insert(payment_hash.0));
3052 _ => panic!("Unexpected event"),
3055 _ => panic!("Unexpected event"),
3058 assert!(failed_htlcs.contains(&first_payment_hash.0));
3059 assert!(failed_htlcs.contains(&second_payment_hash.0));
3060 assert!(failed_htlcs.contains(&third_payment_hash.0));
3064 fn test_commitment_revoked_fail_backward_exhaustive_a() {
3065 do_test_commitment_revoked_fail_backward_exhaustive(false, true, false);
3066 do_test_commitment_revoked_fail_backward_exhaustive(true, true, false);
3067 do_test_commitment_revoked_fail_backward_exhaustive(false, false, false);
3068 do_test_commitment_revoked_fail_backward_exhaustive(true, false, false);
3072 fn test_commitment_revoked_fail_backward_exhaustive_b() {
3073 do_test_commitment_revoked_fail_backward_exhaustive(false, true, true);
3074 do_test_commitment_revoked_fail_backward_exhaustive(true, true, true);
3075 do_test_commitment_revoked_fail_backward_exhaustive(false, false, true);
3076 do_test_commitment_revoked_fail_backward_exhaustive(true, false, true);
3080 fn fail_backward_pending_htlc_upon_channel_failure() {
3081 let chanmon_cfgs = create_chanmon_cfgs(2);
3082 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3083 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3084 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3085 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1_000_000, 500_000_000, InitFeatures::known(), InitFeatures::known());
3086 let logger = test_utils::TestLogger::new();
3088 // Alice -> Bob: Route a payment but without Bob sending revoke_and_ack.
3090 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1]);
3091 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3092 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();
3093 nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
3094 check_added_monitors!(nodes[0], 1);
3096 let payment_event = {
3097 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3098 assert_eq!(events.len(), 1);
3099 SendEvent::from_event(events.remove(0))
3101 assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
3102 assert_eq!(payment_event.msgs.len(), 1);
3105 // Alice -> Bob: Route another payment but now Alice waits for Bob's earlier revoke_and_ack.
3106 let (_, failed_payment_hash, failed_payment_secret) = get_payment_preimage_hash!(nodes[1]);
3108 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3109 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();
3110 nodes[0].node.send_payment(&route, failed_payment_hash, &Some(failed_payment_secret)).unwrap();
3111 check_added_monitors!(nodes[0], 0);
3113 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3116 // Alice <- Bob: Send a malformed update_add_htlc so Alice fails the channel.
3118 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[0]);
3120 let secp_ctx = Secp256k1::new();
3121 let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
3122 let current_height = nodes[1].node.best_block.read().unwrap().height() + 1;
3123 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
3124 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();
3125 let (onion_payloads, _amount_msat, cltv_expiry) = onion_utils::build_onion_payloads(&route.paths[0], 50_000, &Some(payment_secret), current_height, &None).unwrap();
3126 let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route.paths[0], &session_priv).unwrap();
3127 let onion_routing_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
3129 // Send a 0-msat update_add_htlc to fail the channel.
3130 let update_add_htlc = msgs::UpdateAddHTLC {
3136 onion_routing_packet,
3138 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &update_add_htlc);
3141 // Check that Alice fails backward the pending HTLC from the second payment.
3142 expect_payment_failed!(nodes[0], failed_payment_hash, true);
3143 check_closed_broadcast!(nodes[0], true);
3144 check_added_monitors!(nodes[0], 1);
3148 fn test_htlc_ignore_latest_remote_commitment() {
3149 // Test that HTLC transactions spending the latest remote commitment transaction are simply
3150 // ignored if we cannot claim them. This originally tickled an invalid unwrap().
3151 let chanmon_cfgs = create_chanmon_cfgs(2);
3152 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3153 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3154 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3155 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3157 route_payment(&nodes[0], &[&nodes[1]], 10000000);
3158 nodes[0].node.force_close_channel(&nodes[0].node.list_channels()[0].channel_id).unwrap();
3159 connect_blocks(&nodes[0], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + 1);
3160 check_closed_broadcast!(nodes[0], true);
3161 check_added_monitors!(nodes[0], 1);
3163 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
3164 assert_eq!(node_txn.len(), 3);
3165 assert_eq!(node_txn[0], node_txn[1]);
3167 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3168 connect_block(&nodes[1], &Block { header, txdata: vec![node_txn[0].clone(), node_txn[1].clone()]});
3169 check_closed_broadcast!(nodes[1], true);
3170 check_added_monitors!(nodes[1], 1);
3172 // Duplicate the connect_block call since this may happen due to other listeners
3173 // registering new transactions
3174 header.prev_blockhash = header.block_hash();
3175 connect_block(&nodes[1], &Block { header, txdata: vec![node_txn[0].clone(), node_txn[2].clone()]});
3179 fn test_force_close_fail_back() {
3180 // Check which HTLCs are failed-backwards on channel force-closure
3181 let chanmon_cfgs = create_chanmon_cfgs(3);
3182 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3183 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3184 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3185 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3186 create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3187 let logger = test_utils::TestLogger::new();
3189 let (our_payment_preimage, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[2]);
3191 let mut payment_event = {
3192 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3193 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();
3194 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
3195 check_added_monitors!(nodes[0], 1);
3197 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3198 assert_eq!(events.len(), 1);
3199 SendEvent::from_event(events.remove(0))
3202 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
3203 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
3205 expect_pending_htlcs_forwardable!(nodes[1]);
3207 let mut events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3208 assert_eq!(events_2.len(), 1);
3209 payment_event = SendEvent::from_event(events_2.remove(0));
3210 assert_eq!(payment_event.msgs.len(), 1);
3212 check_added_monitors!(nodes[1], 1);
3213 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
3214 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg);
3215 check_added_monitors!(nodes[2], 1);
3216 let (_, _) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3218 // nodes[2] now has the latest commitment transaction, but hasn't revoked its previous
3219 // state or updated nodes[1]' state. Now force-close and broadcast that commitment/HTLC
3220 // transaction and ensure nodes[1] doesn't fail-backwards (this was originally a bug!).
3222 nodes[2].node.force_close_channel(&payment_event.commitment_msg.channel_id).unwrap();
3223 check_closed_broadcast!(nodes[2], true);
3224 check_added_monitors!(nodes[2], 1);
3226 let mut node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap();
3227 // Note that we don't bother broadcasting the HTLC-Success transaction here as we don't
3228 // have a use for it unless nodes[2] learns the preimage somehow, the funds will go
3229 // back to nodes[1] upon timeout otherwise.
3230 assert_eq!(node_txn.len(), 1);
3234 mine_transaction(&nodes[1], &tx);
3236 // Note no UpdateHTLCs event here from nodes[1] to nodes[0]!
3237 check_closed_broadcast!(nodes[1], true);
3238 check_added_monitors!(nodes[1], 1);
3240 // Now check that if we add the preimage to ChannelMonitor it broadcasts our HTLC-Success..
3242 let mut monitors = nodes[2].chain_monitor.chain_monitor.monitors.read().unwrap();
3243 monitors.get(&OutPoint{ txid: Txid::from_slice(&payment_event.commitment_msg.channel_id[..]).unwrap(), index: 0 }).unwrap()
3244 .provide_payment_preimage(&our_payment_hash, &our_payment_preimage, &node_cfgs[2].tx_broadcaster, &node_cfgs[2].fee_estimator, &&logger);
3246 mine_transaction(&nodes[2], &tx);
3247 let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap();
3248 assert_eq!(node_txn.len(), 1);
3249 assert_eq!(node_txn[0].input.len(), 1);
3250 assert_eq!(node_txn[0].input[0].previous_output.txid, tx.txid());
3251 assert_eq!(node_txn[0].lock_time, 0); // Must be an HTLC-Success
3252 assert_eq!(node_txn[0].input[0].witness.len(), 5); // Must be an HTLC-Success
3254 check_spends!(node_txn[0], tx);
3258 fn test_dup_events_on_peer_disconnect() {
3259 // Test that if we receive a duplicative update_fulfill_htlc message after a reconnect we do
3260 // not generate a corresponding duplicative PaymentSent event. This did not use to be the case
3261 // as we used to generate the event immediately upon receipt of the payment preimage in the
3262 // update_fulfill_htlc message.
3264 let chanmon_cfgs = create_chanmon_cfgs(2);
3265 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3266 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3267 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3268 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3270 let payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 1000000).0;
3272 assert!(nodes[1].node.claim_funds(payment_preimage));
3273 check_added_monitors!(nodes[1], 1);
3274 let claim_msgs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3275 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &claim_msgs.update_fulfill_htlcs[0]);
3276 expect_payment_sent!(nodes[0], payment_preimage);
3278 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3279 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3281 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (1, 0), (0, 0), (0, 0), (0, 0), (false, false));
3282 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
3286 fn test_simple_peer_disconnect() {
3287 // Test that we can reconnect when there are no lost messages
3288 let chanmon_cfgs = create_chanmon_cfgs(3);
3289 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3290 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3291 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3292 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3293 create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3295 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3296 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3297 reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3299 let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3300 let payment_hash_2 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3301 fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_hash_2);
3302 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_preimage_1);
3304 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3305 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3306 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3308 let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3309 let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3310 let payment_hash_5 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3311 let payment_hash_6 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3313 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3314 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3316 claim_payment_along_route(&nodes[0], &[&[&nodes[1], &nodes[2]]], true, payment_preimage_3);
3317 fail_payment_along_route(&nodes[0], &[&nodes[1], &nodes[2]], true, payment_hash_5);
3319 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (1, 0), (1, 0), (false, false));
3321 let events = nodes[0].node.get_and_clear_pending_events();
3322 assert_eq!(events.len(), 2);
3324 Event::PaymentSent { payment_preimage } => {
3325 assert_eq!(payment_preimage, payment_preimage_3);
3327 _ => panic!("Unexpected event"),
3330 Event::PaymentFailed { payment_hash, rejected_by_dest, .. } => {
3331 assert_eq!(payment_hash, payment_hash_5);
3332 assert!(rejected_by_dest);
3334 _ => panic!("Unexpected event"),
3338 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_preimage_4);
3339 fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_hash_6);
3342 fn do_test_drop_messages_peer_disconnect(messages_delivered: u8, simulate_broken_lnd: bool) {
3343 // Test that we can reconnect when in-flight HTLC updates get dropped
3344 let chanmon_cfgs = create_chanmon_cfgs(2);
3345 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3346 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3347 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3349 let mut as_funding_locked = None;
3350 if messages_delivered == 0 {
3351 let (funding_locked, _, _) = create_chan_between_nodes_with_value_a(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
3352 as_funding_locked = Some(funding_locked);
3353 // nodes[1] doesn't receive the funding_locked message (it'll be re-sent on reconnect)
3354 // Note that we store it so that if we're running with `simulate_broken_lnd` we can deliver
3355 // it before the channel_reestablish message.
3357 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3360 let (payment_preimage_1, payment_hash_1, payment_secret_1) = get_payment_preimage_hash!(nodes[1]);
3362 let logger = test_utils::TestLogger::new();
3363 let payment_event = {
3364 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3365 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(),
3366 &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), Some(&nodes[0].node.list_usable_channels().iter().collect::<Vec<_>>()),
3367 &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
3368 nodes[0].node.send_payment(&route, payment_hash_1, &Some(payment_secret_1)).unwrap();
3369 check_added_monitors!(nodes[0], 1);
3371 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3372 assert_eq!(events.len(), 1);
3373 SendEvent::from_event(events.remove(0))
3375 assert_eq!(nodes[1].node.get_our_node_id(), payment_event.node_id);
3377 if messages_delivered < 2 {
3378 // Drop the payment_event messages, and let them get re-generated in reconnect_nodes!
3380 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
3381 if messages_delivered >= 3 {
3382 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
3383 check_added_monitors!(nodes[1], 1);
3384 let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3386 if messages_delivered >= 4 {
3387 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3388 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3389 check_added_monitors!(nodes[0], 1);
3391 if messages_delivered >= 5 {
3392 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_commitment_signed);
3393 let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3394 // No commitment_signed so get_event_msg's assert(len == 1) passes
3395 check_added_monitors!(nodes[0], 1);
3397 if messages_delivered >= 6 {
3398 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3399 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3400 check_added_monitors!(nodes[1], 1);
3407 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3408 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3409 if messages_delivered < 3 {
3410 if simulate_broken_lnd {
3411 // lnd has a long-standing bug where they send a funding_locked prior to a
3412 // channel_reestablish if you reconnect prior to funding_locked time.
3414 // Here we simulate that behavior, delivering a funding_locked immediately on
3415 // reconnect. Note that we don't bother skipping the now-duplicate funding_locked sent
3416 // in `reconnect_nodes` but we currently don't fail based on that.
3418 // See-also <https://github.com/lightningnetwork/lnd/issues/4006>
3419 nodes[1].node.handle_funding_locked(&nodes[0].node.get_our_node_id(), &as_funding_locked.as_ref().unwrap().0);
3421 // Even if the funding_locked messages get exchanged, as long as nothing further was
3422 // received on either side, both sides will need to resend them.
3423 reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 1), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3424 } else if messages_delivered == 3 {
3425 // nodes[0] still wants its RAA + commitment_signed
3426 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (-1, 0), (0, 0), (0, 0), (0, 0), (0, 0), (true, false));
3427 } else if messages_delivered == 4 {
3428 // nodes[0] still wants its commitment_signed
3429 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (-1, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3430 } else if messages_delivered == 5 {
3431 // nodes[1] still wants its final RAA
3432 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, true));
3433 } else if messages_delivered == 6 {
3434 // Everything was delivered...
3435 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3438 let events_1 = nodes[1].node.get_and_clear_pending_events();
3439 assert_eq!(events_1.len(), 1);
3441 Event::PendingHTLCsForwardable { .. } => { },
3442 _ => panic!("Unexpected event"),
3445 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3446 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3447 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3449 nodes[1].node.process_pending_htlc_forwards();
3451 let events_2 = nodes[1].node.get_and_clear_pending_events();
3452 assert_eq!(events_2.len(), 1);
3454 Event::PaymentReceived { ref payment_hash, ref purpose, amt } => {
3455 assert_eq!(payment_hash_1, *payment_hash);
3456 assert_eq!(amt, 1000000);
3458 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
3459 assert!(payment_preimage.is_none());
3460 assert_eq!(payment_secret_1, *payment_secret);
3462 _ => panic!("expected PaymentPurpose::InvoicePayment")
3465 _ => panic!("Unexpected event"),
3468 nodes[1].node.claim_funds(payment_preimage_1);
3469 check_added_monitors!(nodes[1], 1);
3471 let events_3 = nodes[1].node.get_and_clear_pending_msg_events();
3472 assert_eq!(events_3.len(), 1);
3473 let (update_fulfill_htlc, commitment_signed) = match events_3[0] {
3474 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
3475 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3476 assert!(updates.update_add_htlcs.is_empty());
3477 assert!(updates.update_fail_htlcs.is_empty());
3478 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
3479 assert!(updates.update_fail_malformed_htlcs.is_empty());
3480 assert!(updates.update_fee.is_none());
3481 (updates.update_fulfill_htlcs[0].clone(), updates.commitment_signed.clone())
3483 _ => panic!("Unexpected event"),
3486 if messages_delivered >= 1 {
3487 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlc);
3489 let events_4 = nodes[0].node.get_and_clear_pending_events();
3490 assert_eq!(events_4.len(), 1);
3492 Event::PaymentSent { ref payment_preimage } => {
3493 assert_eq!(payment_preimage_1, *payment_preimage);
3495 _ => panic!("Unexpected event"),
3498 if messages_delivered >= 2 {
3499 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
3500 check_added_monitors!(nodes[0], 1);
3501 let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
3503 if messages_delivered >= 3 {
3504 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3505 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3506 check_added_monitors!(nodes[1], 1);
3508 if messages_delivered >= 4 {
3509 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed);
3510 let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3511 // No commitment_signed so get_event_msg's assert(len == 1) passes
3512 check_added_monitors!(nodes[1], 1);
3514 if messages_delivered >= 5 {
3515 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3516 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3517 check_added_monitors!(nodes[0], 1);
3524 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3525 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3526 if messages_delivered < 2 {
3527 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (1, 0), (0, 0), (0, 0), (0, 0), (false, false));
3528 if messages_delivered < 1 {
3529 let events_4 = nodes[0].node.get_and_clear_pending_events();
3530 assert_eq!(events_4.len(), 1);
3532 Event::PaymentSent { ref payment_preimage } => {
3533 assert_eq!(payment_preimage_1, *payment_preimage);
3535 _ => panic!("Unexpected event"),
3538 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3540 } else if messages_delivered == 2 {
3541 // nodes[0] still wants its RAA + commitment_signed
3542 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, -1), (0, 0), (0, 0), (0, 0), (0, 0), (false, true));
3543 } else if messages_delivered == 3 {
3544 // nodes[0] still wants its commitment_signed
3545 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, -1), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3546 } else if messages_delivered == 4 {
3547 // nodes[1] still wants its final RAA
3548 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (true, false));
3549 } else if messages_delivered == 5 {
3550 // Everything was delivered...
3551 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3554 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3555 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3556 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3558 // Channel should still work fine...
3559 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3560 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(),
3561 &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), Some(&nodes[0].node.list_usable_channels().iter().collect::<Vec<_>>()),
3562 &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
3563 let payment_preimage_2 = send_along_route(&nodes[0], route, &[&nodes[1]], 1000000).0;
3564 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
3568 fn test_drop_messages_peer_disconnect_a() {
3569 do_test_drop_messages_peer_disconnect(0, true);
3570 do_test_drop_messages_peer_disconnect(0, false);
3571 do_test_drop_messages_peer_disconnect(1, false);
3572 do_test_drop_messages_peer_disconnect(2, false);
3576 fn test_drop_messages_peer_disconnect_b() {
3577 do_test_drop_messages_peer_disconnect(3, false);
3578 do_test_drop_messages_peer_disconnect(4, false);
3579 do_test_drop_messages_peer_disconnect(5, false);
3580 do_test_drop_messages_peer_disconnect(6, false);
3584 fn test_funding_peer_disconnect() {
3585 // Test that we can lock in our funding tx while disconnected
3586 let chanmon_cfgs = create_chanmon_cfgs(2);
3587 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3588 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3589 let persister: test_utils::TestPersister;
3590 let new_chain_monitor: test_utils::TestChainMonitor;
3591 let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
3592 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3593 let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
3595 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3596 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3598 confirm_transaction(&nodes[0], &tx);
3599 let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
3600 assert_eq!(events_1.len(), 1);
3602 MessageSendEvent::SendFundingLocked { ref node_id, msg: _ } => {
3603 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
3605 _ => panic!("Unexpected event"),
3608 reconnect_nodes(&nodes[0], &nodes[1], (false, true), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3610 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3611 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3613 confirm_transaction(&nodes[1], &tx);
3614 let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3615 assert_eq!(events_2.len(), 2);
3616 let funding_locked = match events_2[0] {
3617 MessageSendEvent::SendFundingLocked { ref node_id, ref msg } => {
3618 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3621 _ => panic!("Unexpected event"),
3623 let bs_announcement_sigs = match events_2[1] {
3624 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
3625 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3628 _ => panic!("Unexpected event"),
3631 reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3633 nodes[0].node.handle_funding_locked(&nodes[1].node.get_our_node_id(), &funding_locked);
3634 nodes[0].node.handle_announcement_signatures(&nodes[1].node.get_our_node_id(), &bs_announcement_sigs);
3635 let events_3 = nodes[0].node.get_and_clear_pending_msg_events();
3636 assert_eq!(events_3.len(), 2);
3637 let as_announcement_sigs = match events_3[0] {
3638 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
3639 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
3642 _ => panic!("Unexpected event"),
3644 let (as_announcement, as_update) = match events_3[1] {
3645 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
3646 (msg.clone(), update_msg.clone())
3648 _ => panic!("Unexpected event"),
3651 nodes[1].node.handle_announcement_signatures(&nodes[0].node.get_our_node_id(), &as_announcement_sigs);
3652 let events_4 = nodes[1].node.get_and_clear_pending_msg_events();
3653 assert_eq!(events_4.len(), 1);
3654 let (_, bs_update) = match events_4[0] {
3655 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
3656 (msg.clone(), update_msg.clone())
3658 _ => panic!("Unexpected event"),
3661 nodes[0].net_graph_msg_handler.handle_channel_announcement(&as_announcement).unwrap();
3662 nodes[0].net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
3663 nodes[0].net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
3665 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3666 let logger = test_utils::TestLogger::new();
3667 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();
3668 let (payment_preimage, _, _) = send_along_route(&nodes[0], route, &[&nodes[1]], 1000000);
3669 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage);
3671 // Check that after deserialization and reconnection we can still generate an identical
3672 // channel_announcement from the cached signatures.
3673 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3675 let nodes_0_serialized = nodes[0].node.encode();
3676 let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
3677 nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
3679 persister = test_utils::TestPersister::new();
3680 let keys_manager = &chanmon_cfgs[0].keys_manager;
3681 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);
3682 nodes[0].chain_monitor = &new_chain_monitor;
3683 let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
3684 let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
3685 &mut chan_0_monitor_read, keys_manager).unwrap();
3686 assert!(chan_0_monitor_read.is_empty());
3688 let mut nodes_0_read = &nodes_0_serialized[..];
3689 let (_, nodes_0_deserialized_tmp) = {
3690 let mut channel_monitors = HashMap::new();
3691 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
3692 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
3693 default_config: UserConfig::default(),
3695 fee_estimator: node_cfgs[0].fee_estimator,
3696 chain_monitor: nodes[0].chain_monitor,
3697 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
3698 logger: nodes[0].logger,
3702 nodes_0_deserialized = nodes_0_deserialized_tmp;
3703 assert!(nodes_0_read.is_empty());
3705 assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
3706 nodes[0].node = &nodes_0_deserialized;
3707 check_added_monitors!(nodes[0], 1);
3709 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3711 // as_announcement should be re-generated exactly by broadcast_node_announcement.
3712 nodes[0].node.broadcast_node_announcement([0, 0, 0], [0; 32], Vec::new());
3713 let msgs = nodes[0].node.get_and_clear_pending_msg_events();
3714 let mut found_announcement = false;
3715 for event in msgs.iter() {
3717 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, .. } => {
3718 if *msg == as_announcement { found_announcement = true; }
3720 MessageSendEvent::BroadcastNodeAnnouncement { .. } => {},
3721 _ => panic!("Unexpected event"),
3724 assert!(found_announcement);
3728 fn test_drop_messages_peer_disconnect_dual_htlc() {
3729 // Test that we can handle reconnecting when both sides of a channel have pending
3730 // commitment_updates when we disconnect.
3731 let chanmon_cfgs = create_chanmon_cfgs(2);
3732 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3733 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3734 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3735 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3736 let logger = test_utils::TestLogger::new();
3738 let (payment_preimage_1, _, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
3740 // Now try to send a second payment which will fail to send
3741 let (payment_preimage_2, payment_hash_2, payment_secret_2) = get_payment_preimage_hash!(nodes[1]);
3742 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3743 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();
3744 nodes[0].node.send_payment(&route, payment_hash_2, &Some(payment_secret_2)).unwrap();
3745 check_added_monitors!(nodes[0], 1);
3747 let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
3748 assert_eq!(events_1.len(), 1);
3750 MessageSendEvent::UpdateHTLCs { .. } => {},
3751 _ => panic!("Unexpected event"),
3754 assert!(nodes[1].node.claim_funds(payment_preimage_1));
3755 check_added_monitors!(nodes[1], 1);
3757 let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3758 assert_eq!(events_2.len(), 1);
3760 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 } } => {
3761 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3762 assert!(update_add_htlcs.is_empty());
3763 assert_eq!(update_fulfill_htlcs.len(), 1);
3764 assert!(update_fail_htlcs.is_empty());
3765 assert!(update_fail_malformed_htlcs.is_empty());
3766 assert!(update_fee.is_none());
3768 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlcs[0]);
3769 let events_3 = nodes[0].node.get_and_clear_pending_events();
3770 assert_eq!(events_3.len(), 1);
3772 Event::PaymentSent { ref payment_preimage } => {
3773 assert_eq!(*payment_preimage, payment_preimage_1);
3775 _ => panic!("Unexpected event"),
3778 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), commitment_signed);
3779 let _ = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3780 // No commitment_signed so get_event_msg's assert(len == 1) passes
3781 check_added_monitors!(nodes[0], 1);
3783 _ => panic!("Unexpected event"),
3786 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3787 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3789 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
3790 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
3791 assert_eq!(reestablish_1.len(), 1);
3792 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
3793 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
3794 assert_eq!(reestablish_2.len(), 1);
3796 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
3797 let as_resp = handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
3798 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
3799 let bs_resp = handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
3801 assert!(as_resp.0.is_none());
3802 assert!(bs_resp.0.is_none());
3804 assert!(bs_resp.1.is_none());
3805 assert!(bs_resp.2.is_none());
3807 assert!(as_resp.3 == RAACommitmentOrder::CommitmentFirst);
3809 assert_eq!(as_resp.2.as_ref().unwrap().update_add_htlcs.len(), 1);
3810 assert!(as_resp.2.as_ref().unwrap().update_fulfill_htlcs.is_empty());
3811 assert!(as_resp.2.as_ref().unwrap().update_fail_htlcs.is_empty());
3812 assert!(as_resp.2.as_ref().unwrap().update_fail_malformed_htlcs.is_empty());
3813 assert!(as_resp.2.as_ref().unwrap().update_fee.is_none());
3814 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &as_resp.2.as_ref().unwrap().update_add_htlcs[0]);
3815 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_resp.2.as_ref().unwrap().commitment_signed);
3816 let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3817 // No commitment_signed so get_event_msg's assert(len == 1) passes
3818 check_added_monitors!(nodes[1], 1);
3820 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), as_resp.1.as_ref().unwrap());
3821 let bs_second_commitment_signed = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3822 assert!(bs_second_commitment_signed.update_add_htlcs.is_empty());
3823 assert!(bs_second_commitment_signed.update_fulfill_htlcs.is_empty());
3824 assert!(bs_second_commitment_signed.update_fail_htlcs.is_empty());
3825 assert!(bs_second_commitment_signed.update_fail_malformed_htlcs.is_empty());
3826 assert!(bs_second_commitment_signed.update_fee.is_none());
3827 check_added_monitors!(nodes[1], 1);
3829 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3830 let as_commitment_signed = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
3831 assert!(as_commitment_signed.update_add_htlcs.is_empty());
3832 assert!(as_commitment_signed.update_fulfill_htlcs.is_empty());
3833 assert!(as_commitment_signed.update_fail_htlcs.is_empty());
3834 assert!(as_commitment_signed.update_fail_malformed_htlcs.is_empty());
3835 assert!(as_commitment_signed.update_fee.is_none());
3836 check_added_monitors!(nodes[0], 1);
3838 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_commitment_signed.commitment_signed);
3839 let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3840 // No commitment_signed so get_event_msg's assert(len == 1) passes
3841 check_added_monitors!(nodes[0], 1);
3843 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed.commitment_signed);
3844 let bs_second_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3845 // No commitment_signed so get_event_msg's assert(len == 1) passes
3846 check_added_monitors!(nodes[1], 1);
3848 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3849 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3850 check_added_monitors!(nodes[1], 1);
3852 expect_pending_htlcs_forwardable!(nodes[1]);
3854 let events_5 = nodes[1].node.get_and_clear_pending_events();
3855 assert_eq!(events_5.len(), 1);
3857 Event::PaymentReceived { ref payment_hash, ref purpose, .. } => {
3858 assert_eq!(payment_hash_2, *payment_hash);
3860 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
3861 assert!(payment_preimage.is_none());
3862 assert_eq!(payment_secret_2, *payment_secret);
3864 _ => panic!("expected PaymentPurpose::InvoicePayment")
3867 _ => panic!("Unexpected event"),
3870 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke_and_ack);
3871 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3872 check_added_monitors!(nodes[0], 1);
3874 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
3877 fn do_test_htlc_timeout(send_partial_mpp: bool) {
3878 // If the user fails to claim/fail an HTLC within the HTLC CLTV timeout we fail it for them
3879 // to avoid our counterparty failing the channel.
3880 let chanmon_cfgs = create_chanmon_cfgs(2);
3881 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3882 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3883 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3885 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3886 let logger = test_utils::TestLogger::new();
3888 let our_payment_hash = if send_partial_mpp {
3889 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3890 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();
3891 let (_, our_payment_hash, payment_secret) = get_payment_preimage_hash!(&nodes[1]);
3892 // Use the utility function send_payment_along_path to send the payment with MPP data which
3893 // indicates there are more HTLCs coming.
3894 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.
3895 nodes[0].node.send_payment_along_path(&route.paths[0], &our_payment_hash, &Some(payment_secret), 200000, cur_height, &None).unwrap();
3896 check_added_monitors!(nodes[0], 1);
3897 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3898 assert_eq!(events.len(), 1);
3899 // Now do the relevant commitment_signed/RAA dances along the path, noting that the final
3900 // hop should *not* yet generate any PaymentReceived event(s).
3901 pass_along_path(&nodes[0], &[&nodes[1]], 100000, our_payment_hash, Some(payment_secret), events.drain(..).next().unwrap(), false, None);
3904 route_payment(&nodes[0], &[&nodes[1]], 100000).1
3907 let mut block = Block {
3908 header: BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
3911 connect_block(&nodes[0], &block);
3912 connect_block(&nodes[1], &block);
3913 let block_count = TEST_FINAL_CLTV + CHAN_CONFIRM_DEPTH + 2 - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS;
3914 for _ in CHAN_CONFIRM_DEPTH + 2..block_count {
3915 block.header.prev_blockhash = block.block_hash();
3916 connect_block(&nodes[0], &block);
3917 connect_block(&nodes[1], &block);
3920 expect_pending_htlcs_forwardable!(nodes[1]);
3922 check_added_monitors!(nodes[1], 1);
3923 let htlc_timeout_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3924 assert!(htlc_timeout_updates.update_add_htlcs.is_empty());
3925 assert_eq!(htlc_timeout_updates.update_fail_htlcs.len(), 1);
3926 assert!(htlc_timeout_updates.update_fail_malformed_htlcs.is_empty());
3927 assert!(htlc_timeout_updates.update_fee.is_none());
3929 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_timeout_updates.update_fail_htlcs[0]);
3930 commitment_signed_dance!(nodes[0], nodes[1], htlc_timeout_updates.commitment_signed, false);
3931 // 100_000 msat as u64, followed by the height at which we failed back above
3932 let mut expected_failure_data = byte_utils::be64_to_array(100_000).to_vec();
3933 expected_failure_data.extend_from_slice(&byte_utils::be32_to_array(block_count - 1));
3934 expect_payment_failed!(nodes[0], our_payment_hash, true, 0x4000 | 15, &expected_failure_data[..]);
3938 fn test_htlc_timeout() {
3939 do_test_htlc_timeout(true);
3940 do_test_htlc_timeout(false);
3943 fn do_test_holding_cell_htlc_add_timeouts(forwarded_htlc: bool) {
3944 // Tests that HTLCs in the holding cell are timed out after the requisite number of blocks.
3945 let chanmon_cfgs = create_chanmon_cfgs(3);
3946 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3947 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3948 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3949 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3950 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3952 // Make sure all nodes are at the same starting height
3953 connect_blocks(&nodes[0], 2*CHAN_CONFIRM_DEPTH + 1 - nodes[0].best_block_info().1);
3954 connect_blocks(&nodes[1], 2*CHAN_CONFIRM_DEPTH + 1 - nodes[1].best_block_info().1);
3955 connect_blocks(&nodes[2], 2*CHAN_CONFIRM_DEPTH + 1 - nodes[2].best_block_info().1);
3957 let logger = test_utils::TestLogger::new();
3959 // Route a first payment to get the 1 -> 2 channel in awaiting_raa...
3960 let (_, first_payment_hash, first_payment_secret) = get_payment_preimage_hash!(nodes[2]);
3962 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
3963 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();
3964 nodes[1].node.send_payment(&route, first_payment_hash, &Some(first_payment_secret)).unwrap();
3966 assert_eq!(nodes[1].node.get_and_clear_pending_msg_events().len(), 1);
3967 check_added_monitors!(nodes[1], 1);
3969 // Now attempt to route a second payment, which should be placed in the holding cell
3970 let (_, second_payment_hash, second_payment_secret) = get_payment_preimage_hash!(nodes[2]);
3972 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3973 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();
3974 nodes[0].node.send_payment(&route, second_payment_hash, &Some(first_payment_secret)).unwrap();
3975 check_added_monitors!(nodes[0], 1);
3976 let payment_event = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
3977 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
3978 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
3979 expect_pending_htlcs_forwardable!(nodes[1]);
3980 check_added_monitors!(nodes[1], 0);
3982 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
3983 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();
3984 nodes[1].node.send_payment(&route, second_payment_hash, &Some(second_payment_secret)).unwrap();
3985 check_added_monitors!(nodes[1], 0);
3988 connect_blocks(&nodes[1], TEST_FINAL_CLTV - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS);
3989 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3990 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
3991 connect_blocks(&nodes[1], 1);
3994 expect_pending_htlcs_forwardable!(nodes[1]);
3995 check_added_monitors!(nodes[1], 1);
3996 let fail_commit = nodes[1].node.get_and_clear_pending_msg_events();
3997 assert_eq!(fail_commit.len(), 1);
3998 match fail_commit[0] {
3999 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fail_htlcs, ref commitment_signed, .. }, .. } => {
4000 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
4001 commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, true, true);
4003 _ => unreachable!(),
4005 expect_payment_failed!(nodes[0], second_payment_hash, false);
4006 expect_payment_failure_chan_update!(nodes[0], chan_2.0.contents.short_channel_id, false);
4008 expect_payment_failed!(nodes[1], second_payment_hash, true);
4013 fn test_holding_cell_htlc_add_timeouts() {
4014 do_test_holding_cell_htlc_add_timeouts(false);
4015 do_test_holding_cell_htlc_add_timeouts(true);
4019 fn test_invalid_channel_announcement() {
4020 //Test BOLT 7 channel_announcement msg requirement for final node, gather data to build customed channel_announcement msgs
4021 let secp_ctx = Secp256k1::new();
4022 let chanmon_cfgs = create_chanmon_cfgs(2);
4023 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4024 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4025 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4027 let chan_announcement = create_chan_between_nodes(&nodes[0], &nodes[1], InitFeatures::known(), InitFeatures::known());
4029 let a_channel_lock = nodes[0].node.channel_state.lock().unwrap();
4030 let b_channel_lock = nodes[1].node.channel_state.lock().unwrap();
4031 let as_chan = a_channel_lock.by_id.get(&chan_announcement.3).unwrap();
4032 let bs_chan = b_channel_lock.by_id.get(&chan_announcement.3).unwrap();
4034 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 } );
4036 let as_bitcoin_key = as_chan.get_signer().inner.holder_channel_pubkeys.funding_pubkey;
4037 let bs_bitcoin_key = bs_chan.get_signer().inner.holder_channel_pubkeys.funding_pubkey;
4039 let as_network_key = nodes[0].node.get_our_node_id();
4040 let bs_network_key = nodes[1].node.get_our_node_id();
4042 let were_node_one = as_bitcoin_key.serialize()[..] < bs_bitcoin_key.serialize()[..];
4044 let mut chan_announcement;
4046 macro_rules! dummy_unsigned_msg {
4048 msgs::UnsignedChannelAnnouncement {
4049 features: ChannelFeatures::known(),
4050 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
4051 short_channel_id: as_chan.get_short_channel_id().unwrap(),
4052 node_id_1: if were_node_one { as_network_key } else { bs_network_key },
4053 node_id_2: if were_node_one { bs_network_key } else { as_network_key },
4054 bitcoin_key_1: if were_node_one { as_bitcoin_key } else { bs_bitcoin_key },
4055 bitcoin_key_2: if were_node_one { bs_bitcoin_key } else { as_bitcoin_key },
4056 excess_data: Vec::new(),
4061 macro_rules! sign_msg {
4062 ($unsigned_msg: expr) => {
4063 let msghash = Message::from_slice(&Sha256dHash::hash(&$unsigned_msg.encode()[..])[..]).unwrap();
4064 let as_bitcoin_sig = secp_ctx.sign(&msghash, &as_chan.get_signer().inner.funding_key);
4065 let bs_bitcoin_sig = secp_ctx.sign(&msghash, &bs_chan.get_signer().inner.funding_key);
4066 let as_node_sig = secp_ctx.sign(&msghash, &nodes[0].keys_manager.get_node_secret());
4067 let bs_node_sig = secp_ctx.sign(&msghash, &nodes[1].keys_manager.get_node_secret());
4068 chan_announcement = msgs::ChannelAnnouncement {
4069 node_signature_1 : if were_node_one { as_node_sig } else { bs_node_sig},
4070 node_signature_2 : if were_node_one { bs_node_sig } else { as_node_sig},
4071 bitcoin_signature_1: if were_node_one { as_bitcoin_sig } else { bs_bitcoin_sig },
4072 bitcoin_signature_2 : if were_node_one { bs_bitcoin_sig } else { as_bitcoin_sig },
4073 contents: $unsigned_msg
4078 let unsigned_msg = dummy_unsigned_msg!();
4079 sign_msg!(unsigned_msg);
4080 assert_eq!(nodes[0].net_graph_msg_handler.handle_channel_announcement(&chan_announcement).unwrap(), true);
4081 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 } );
4083 // Configured with Network::Testnet
4084 let mut unsigned_msg = dummy_unsigned_msg!();
4085 unsigned_msg.chain_hash = genesis_block(Network::Bitcoin).header.block_hash();
4086 sign_msg!(unsigned_msg);
4087 assert!(nodes[0].net_graph_msg_handler.handle_channel_announcement(&chan_announcement).is_err());
4089 let mut unsigned_msg = dummy_unsigned_msg!();
4090 unsigned_msg.chain_hash = BlockHash::hash(&[1,2,3,4,5,6,7,8,9]);
4091 sign_msg!(unsigned_msg);
4092 assert!(nodes[0].net_graph_msg_handler.handle_channel_announcement(&chan_announcement).is_err());
4096 fn test_no_txn_manager_serialize_deserialize() {
4097 let chanmon_cfgs = create_chanmon_cfgs(2);
4098 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4099 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4100 let logger: test_utils::TestLogger;
4101 let fee_estimator: test_utils::TestFeeEstimator;
4102 let persister: test_utils::TestPersister;
4103 let new_chain_monitor: test_utils::TestChainMonitor;
4104 let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4105 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4107 let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
4109 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4111 let nodes_0_serialized = nodes[0].node.encode();
4112 let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4113 nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
4115 logger = test_utils::TestLogger::new();
4116 fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
4117 persister = test_utils::TestPersister::new();
4118 let keys_manager = &chanmon_cfgs[0].keys_manager;
4119 new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator, &persister, keys_manager);
4120 nodes[0].chain_monitor = &new_chain_monitor;
4121 let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4122 let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
4123 &mut chan_0_monitor_read, keys_manager).unwrap();
4124 assert!(chan_0_monitor_read.is_empty());
4126 let mut nodes_0_read = &nodes_0_serialized[..];
4127 let config = UserConfig::default();
4128 let (_, nodes_0_deserialized_tmp) = {
4129 let mut channel_monitors = HashMap::new();
4130 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4131 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4132 default_config: config,
4134 fee_estimator: &fee_estimator,
4135 chain_monitor: nodes[0].chain_monitor,
4136 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4141 nodes_0_deserialized = nodes_0_deserialized_tmp;
4142 assert!(nodes_0_read.is_empty());
4144 assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4145 nodes[0].node = &nodes_0_deserialized;
4146 assert_eq!(nodes[0].node.list_channels().len(), 1);
4147 check_added_monitors!(nodes[0], 1);
4149 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4150 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
4151 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4152 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
4154 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
4155 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4156 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
4157 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4159 let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
4160 let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
4161 for node in nodes.iter() {
4162 assert!(node.net_graph_msg_handler.handle_channel_announcement(&announcement).unwrap());
4163 node.net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
4164 node.net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
4167 send_payment(&nodes[0], &[&nodes[1]], 1000000);
4171 fn test_dup_htlc_onchain_fails_on_reload() {
4172 // When a Channel is closed, any outbound HTLCs which were relayed through it are simply
4173 // dropped when the Channel is. From there, the ChannelManager relies on the ChannelMonitor
4174 // having a copy of the relevant fail-/claim-back data and processes the HTLC fail/claim when
4175 // the ChannelMonitor tells it to.
4177 // If, due to an on-chain event, an HTLC is failed/claimed, and then we serialize the
4178 // ChannelManager, we generally expect there not to be a duplicate HTLC fail/claim (eg via a
4179 // PaymentFailed event appearing). However, because we may not serialize the relevant
4180 // ChannelMonitor at the same time, this isn't strictly guaranteed. In order to provide this
4181 // consistency, the ChannelManager explicitly tracks pending-onchain-resolution outbound HTLCs
4182 // and de-duplicates ChannelMonitor events.
4184 // This tests that explicit tracking behavior.
4185 let chanmon_cfgs = create_chanmon_cfgs(2);
4186 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4187 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4188 let persister: test_utils::TestPersister;
4189 let new_chain_monitor: test_utils::TestChainMonitor;
4190 let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4191 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4193 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4195 // Route a payment, but force-close the channel before the HTLC fulfill message arrives at
4197 let (payment_preimage, _, _) = route_payment(&nodes[0], &[&nodes[1]], 10000000);
4198 nodes[0].node.force_close_channel(&nodes[0].node.list_channels()[0].channel_id).unwrap();
4199 check_closed_broadcast!(nodes[0], true);
4200 check_added_monitors!(nodes[0], 1);
4202 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
4203 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4205 // Connect blocks until the CLTV timeout is up so that we get an HTLC-Timeout transaction
4206 connect_blocks(&nodes[0], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + 1);
4207 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
4208 assert_eq!(node_txn.len(), 3);
4209 assert_eq!(node_txn[0], node_txn[1]);
4211 assert!(nodes[1].node.claim_funds(payment_preimage));
4212 check_added_monitors!(nodes[1], 1);
4214 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4215 connect_block(&nodes[1], &Block { header, txdata: vec![node_txn[1].clone(), node_txn[2].clone()]});
4216 check_closed_broadcast!(nodes[1], true);
4217 check_added_monitors!(nodes[1], 1);
4218 let claim_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
4220 header.prev_blockhash = nodes[0].best_block_hash();
4221 connect_block(&nodes[0], &Block { header, txdata: vec![node_txn[1].clone(), node_txn[2].clone()]});
4223 // Serialize out the ChannelMonitor before connecting the on-chain claim transactions. This is
4224 // fairly normal behavior as ChannelMonitor(s) are often not re-serialized when on-chain events
4225 // happen, unlike ChannelManager which tends to be re-serialized after any relevant event(s).
4226 let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4227 nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
4229 header.prev_blockhash = nodes[0].best_block_hash();
4230 let claim_block = Block { header, txdata: claim_txn};
4231 connect_block(&nodes[0], &claim_block);
4232 expect_payment_sent!(nodes[0], payment_preimage);
4234 // ChannelManagers generally get re-serialized after any relevant event(s). Since we just
4235 // connected a highly-relevant block, it likely gets serialized out now.
4236 let mut chan_manager_serialized = test_utils::TestVecWriter(Vec::new());
4237 nodes[0].node.write(&mut chan_manager_serialized).unwrap();
4239 // Now reload nodes[0]...
4240 persister = test_utils::TestPersister::new();
4241 let keys_manager = &chanmon_cfgs[0].keys_manager;
4242 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);
4243 nodes[0].chain_monitor = &new_chain_monitor;
4244 let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4245 let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
4246 &mut chan_0_monitor_read, keys_manager).unwrap();
4247 assert!(chan_0_monitor_read.is_empty());
4249 let (_, nodes_0_deserialized_tmp) = {
4250 let mut channel_monitors = HashMap::new();
4251 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4252 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>
4253 ::read(&mut io::Cursor::new(&chan_manager_serialized.0[..]), ChannelManagerReadArgs {
4254 default_config: Default::default(),
4256 fee_estimator: node_cfgs[0].fee_estimator,
4257 chain_monitor: nodes[0].chain_monitor,
4258 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4259 logger: nodes[0].logger,
4263 nodes_0_deserialized = nodes_0_deserialized_tmp;
4265 assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4266 check_added_monitors!(nodes[0], 1);
4267 nodes[0].node = &nodes_0_deserialized;
4269 // Note that if we re-connect the block which exposed nodes[0] to the payment preimage (but
4270 // which the current ChannelMonitor has not seen), the ChannelManager's de-duplication of
4271 // payment events should kick in, leaving us with no pending events here.
4272 let height = nodes[0].blocks.lock().unwrap().len() as u32 - 1;
4273 nodes[0].chain_monitor.chain_monitor.block_connected(&claim_block, height);
4274 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
4278 fn test_manager_serialize_deserialize_events() {
4279 // This test makes sure the events field in ChannelManager survives de/serialization
4280 let chanmon_cfgs = create_chanmon_cfgs(2);
4281 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4282 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4283 let fee_estimator: test_utils::TestFeeEstimator;
4284 let persister: test_utils::TestPersister;
4285 let logger: test_utils::TestLogger;
4286 let new_chain_monitor: test_utils::TestChainMonitor;
4287 let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4288 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4290 // Start creating a channel, but stop right before broadcasting the funding transaction
4291 let channel_value = 100000;
4292 let push_msat = 10001;
4293 let a_flags = InitFeatures::known();
4294 let b_flags = InitFeatures::known();
4295 let node_a = nodes.remove(0);
4296 let node_b = nodes.remove(0);
4297 node_a.node.create_channel(node_b.node.get_our_node_id(), channel_value, push_msat, 42, None).unwrap();
4298 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()));
4299 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()));
4301 let (temporary_channel_id, tx, funding_output) = create_funding_transaction(&node_a, channel_value, 42);
4303 node_a.node.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
4304 check_added_monitors!(node_a, 0);
4306 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()));
4308 let mut added_monitors = node_b.chain_monitor.added_monitors.lock().unwrap();
4309 assert_eq!(added_monitors.len(), 1);
4310 assert_eq!(added_monitors[0].0, funding_output);
4311 added_monitors.clear();
4314 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()));
4316 let mut added_monitors = node_a.chain_monitor.added_monitors.lock().unwrap();
4317 assert_eq!(added_monitors.len(), 1);
4318 assert_eq!(added_monitors[0].0, funding_output);
4319 added_monitors.clear();
4321 // Normally, this is where node_a would broadcast the funding transaction, but the test de/serializes first instead
4326 // Start the de/seriailization process mid-channel creation to check that the channel manager will hold onto events that are serialized
4327 let nodes_0_serialized = nodes[0].node.encode();
4328 let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4329 nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
4331 fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
4332 logger = test_utils::TestLogger::new();
4333 persister = test_utils::TestPersister::new();
4334 let keys_manager = &chanmon_cfgs[0].keys_manager;
4335 new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator, &persister, keys_manager);
4336 nodes[0].chain_monitor = &new_chain_monitor;
4337 let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4338 let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
4339 &mut chan_0_monitor_read, keys_manager).unwrap();
4340 assert!(chan_0_monitor_read.is_empty());
4342 let mut nodes_0_read = &nodes_0_serialized[..];
4343 let config = UserConfig::default();
4344 let (_, nodes_0_deserialized_tmp) = {
4345 let mut channel_monitors = HashMap::new();
4346 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4347 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4348 default_config: config,
4350 fee_estimator: &fee_estimator,
4351 chain_monitor: nodes[0].chain_monitor,
4352 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4357 nodes_0_deserialized = nodes_0_deserialized_tmp;
4358 assert!(nodes_0_read.is_empty());
4360 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4362 assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4363 nodes[0].node = &nodes_0_deserialized;
4365 // After deserializing, make sure the funding_transaction is still held by the channel manager
4366 let events_4 = nodes[0].node.get_and_clear_pending_events();
4367 assert_eq!(events_4.len(), 0);
4368 assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
4369 assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0].txid(), funding_output.txid);
4371 // Make sure the channel is functioning as though the de/serialization never happened
4372 assert_eq!(nodes[0].node.list_channels().len(), 1);
4373 check_added_monitors!(nodes[0], 1);
4375 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4376 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
4377 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4378 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
4380 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
4381 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4382 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
4383 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4385 let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
4386 let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
4387 for node in nodes.iter() {
4388 assert!(node.net_graph_msg_handler.handle_channel_announcement(&announcement).unwrap());
4389 node.net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
4390 node.net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
4393 send_payment(&nodes[0], &[&nodes[1]], 1000000);
4397 fn test_simple_manager_serialize_deserialize() {
4398 let chanmon_cfgs = create_chanmon_cfgs(2);
4399 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4400 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4401 let logger: test_utils::TestLogger;
4402 let fee_estimator: test_utils::TestFeeEstimator;
4403 let persister: test_utils::TestPersister;
4404 let new_chain_monitor: test_utils::TestChainMonitor;
4405 let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4406 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4407 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4409 let (our_payment_preimage, _, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
4410 let (_, our_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
4412 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4414 let nodes_0_serialized = nodes[0].node.encode();
4415 let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4416 nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
4418 logger = test_utils::TestLogger::new();
4419 fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
4420 persister = test_utils::TestPersister::new();
4421 let keys_manager = &chanmon_cfgs[0].keys_manager;
4422 new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator, &persister, keys_manager);
4423 nodes[0].chain_monitor = &new_chain_monitor;
4424 let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4425 let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
4426 &mut chan_0_monitor_read, keys_manager).unwrap();
4427 assert!(chan_0_monitor_read.is_empty());
4429 let mut nodes_0_read = &nodes_0_serialized[..];
4430 let (_, nodes_0_deserialized_tmp) = {
4431 let mut channel_monitors = HashMap::new();
4432 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4433 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4434 default_config: UserConfig::default(),
4436 fee_estimator: &fee_estimator,
4437 chain_monitor: nodes[0].chain_monitor,
4438 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4443 nodes_0_deserialized = nodes_0_deserialized_tmp;
4444 assert!(nodes_0_read.is_empty());
4446 assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4447 nodes[0].node = &nodes_0_deserialized;
4448 check_added_monitors!(nodes[0], 1);
4450 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
4452 fail_payment(&nodes[0], &[&nodes[1]], our_payment_hash);
4453 claim_payment(&nodes[0], &[&nodes[1]], our_payment_preimage);
4457 fn test_manager_serialize_deserialize_inconsistent_monitor() {
4458 // Test deserializing a ChannelManager with an out-of-date ChannelMonitor
4459 let chanmon_cfgs = create_chanmon_cfgs(4);
4460 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
4461 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
4462 let logger: test_utils::TestLogger;
4463 let fee_estimator: test_utils::TestFeeEstimator;
4464 let persister: test_utils::TestPersister;
4465 let new_chain_monitor: test_utils::TestChainMonitor;
4466 let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4467 let mut nodes = create_network(4, &node_cfgs, &node_chanmgrs);
4468 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4469 create_announced_chan_between_nodes(&nodes, 2, 0, InitFeatures::known(), InitFeatures::known());
4470 let (_, _, channel_id, funding_tx) = create_announced_chan_between_nodes(&nodes, 0, 3, InitFeatures::known(), InitFeatures::known());
4472 let mut node_0_stale_monitors_serialized = Vec::new();
4473 for monitor in nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter() {
4474 let mut writer = test_utils::TestVecWriter(Vec::new());
4475 monitor.1.write(&mut writer).unwrap();
4476 node_0_stale_monitors_serialized.push(writer.0);
4479 let (our_payment_preimage, _, _) = route_payment(&nodes[2], &[&nodes[0], &nodes[1]], 1000000);
4481 // Serialize the ChannelManager here, but the monitor we keep up-to-date
4482 let nodes_0_serialized = nodes[0].node.encode();
4484 route_payment(&nodes[0], &[&nodes[3]], 1000000);
4485 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4486 nodes[2].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4487 nodes[3].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4489 // Now the ChannelMonitor (which is now out-of-sync with ChannelManager for channel w/
4491 let mut node_0_monitors_serialized = Vec::new();
4492 for monitor in nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter() {
4493 let mut writer = test_utils::TestVecWriter(Vec::new());
4494 monitor.1.write(&mut writer).unwrap();
4495 node_0_monitors_serialized.push(writer.0);
4498 logger = test_utils::TestLogger::new();
4499 fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
4500 persister = test_utils::TestPersister::new();
4501 let keys_manager = &chanmon_cfgs[0].keys_manager;
4502 new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator, &persister, keys_manager);
4503 nodes[0].chain_monitor = &new_chain_monitor;
4506 let mut node_0_stale_monitors = Vec::new();
4507 for serialized in node_0_stale_monitors_serialized.iter() {
4508 let mut read = &serialized[..];
4509 let (_, monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(&mut read, keys_manager).unwrap();
4510 assert!(read.is_empty());
4511 node_0_stale_monitors.push(monitor);
4514 let mut node_0_monitors = Vec::new();
4515 for serialized in node_0_monitors_serialized.iter() {
4516 let mut read = &serialized[..];
4517 let (_, monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(&mut read, keys_manager).unwrap();
4518 assert!(read.is_empty());
4519 node_0_monitors.push(monitor);
4522 let mut nodes_0_read = &nodes_0_serialized[..];
4523 if let Err(msgs::DecodeError::InvalidValue) =
4524 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4525 default_config: UserConfig::default(),
4527 fee_estimator: &fee_estimator,
4528 chain_monitor: nodes[0].chain_monitor,
4529 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4531 channel_monitors: node_0_stale_monitors.iter_mut().map(|monitor| { (monitor.get_funding_txo().0, monitor) }).collect(),
4533 panic!("If the monitor(s) are stale, this indicates a bug and we should get an Err return");
4536 let mut nodes_0_read = &nodes_0_serialized[..];
4537 let (_, nodes_0_deserialized_tmp) =
4538 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4539 default_config: UserConfig::default(),
4541 fee_estimator: &fee_estimator,
4542 chain_monitor: nodes[0].chain_monitor,
4543 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4545 channel_monitors: node_0_monitors.iter_mut().map(|monitor| { (monitor.get_funding_txo().0, monitor) }).collect(),
4547 nodes_0_deserialized = nodes_0_deserialized_tmp;
4548 assert!(nodes_0_read.is_empty());
4550 { // Channel close should result in a commitment tx
4551 let txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4552 assert_eq!(txn.len(), 1);
4553 check_spends!(txn[0], funding_tx);
4554 assert_eq!(txn[0].input[0].previous_output.txid, funding_tx.txid());
4557 for monitor in node_0_monitors.drain(..) {
4558 assert!(nodes[0].chain_monitor.watch_channel(monitor.get_funding_txo().0, monitor).is_ok());
4559 check_added_monitors!(nodes[0], 1);
4561 nodes[0].node = &nodes_0_deserialized;
4563 // nodes[1] and nodes[2] have no lost state with nodes[0]...
4564 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
4565 reconnect_nodes(&nodes[0], &nodes[2], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
4566 //... and we can even still claim the payment!
4567 claim_payment(&nodes[2], &[&nodes[0], &nodes[1]], our_payment_preimage);
4569 nodes[3].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4570 let reestablish = get_event_msg!(nodes[3], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
4571 nodes[0].node.peer_connected(&nodes[3].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4572 nodes[0].node.handle_channel_reestablish(&nodes[3].node.get_our_node_id(), &reestablish);
4573 let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
4574 assert_eq!(msg_events.len(), 1);
4575 if let MessageSendEvent::HandleError { ref action, .. } = msg_events[0] {
4577 &ErrorAction::SendErrorMessage { ref msg } => {
4578 assert_eq!(msg.channel_id, channel_id);
4580 _ => panic!("Unexpected event!"),
4585 macro_rules! check_spendable_outputs {
4586 ($node: expr, $keysinterface: expr) => {
4588 let mut events = $node.chain_monitor.chain_monitor.get_and_clear_pending_events();
4589 let mut txn = Vec::new();
4590 let mut all_outputs = Vec::new();
4591 let secp_ctx = Secp256k1::new();
4592 for event in events.drain(..) {
4594 Event::SpendableOutputs { mut outputs } => {
4595 for outp in outputs.drain(..) {
4596 txn.push($keysinterface.backing.spend_spendable_outputs(&[&outp], Vec::new(), Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(), 253, &secp_ctx).unwrap());
4597 all_outputs.push(outp);
4600 _ => panic!("Unexpected event"),
4603 if all_outputs.len() > 1 {
4604 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) {
4614 fn test_claim_sizeable_push_msat() {
4615 // Incidentally test SpendableOutput event generation due to detection of to_local output on commitment tx
4616 let chanmon_cfgs = create_chanmon_cfgs(2);
4617 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4618 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4619 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4621 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 99000000, InitFeatures::known(), InitFeatures::known());
4622 nodes[1].node.force_close_channel(&chan.2).unwrap();
4623 check_closed_broadcast!(nodes[1], true);
4624 check_added_monitors!(nodes[1], 1);
4625 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4626 assert_eq!(node_txn.len(), 1);
4627 check_spends!(node_txn[0], chan.3);
4628 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
4630 mine_transaction(&nodes[1], &node_txn[0]);
4631 connect_blocks(&nodes[1], BREAKDOWN_TIMEOUT as u32 - 1);
4633 let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
4634 assert_eq!(spend_txn.len(), 1);
4635 assert_eq!(spend_txn[0].input.len(), 1);
4636 check_spends!(spend_txn[0], node_txn[0]);
4637 assert_eq!(spend_txn[0].input[0].sequence, BREAKDOWN_TIMEOUT as u32);
4641 fn test_claim_on_remote_sizeable_push_msat() {
4642 // Same test as previous, just test on remote commitment tx, as per_commitment_point registration changes following you're funder/fundee and
4643 // to_remote output is encumbered by a P2WPKH
4644 let chanmon_cfgs = create_chanmon_cfgs(2);
4645 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4646 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4647 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4649 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 99000000, InitFeatures::known(), InitFeatures::known());
4650 nodes[0].node.force_close_channel(&chan.2).unwrap();
4651 check_closed_broadcast!(nodes[0], true);
4652 check_added_monitors!(nodes[0], 1);
4654 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4655 assert_eq!(node_txn.len(), 1);
4656 check_spends!(node_txn[0], chan.3);
4657 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
4659 mine_transaction(&nodes[1], &node_txn[0]);
4660 check_closed_broadcast!(nodes[1], true);
4661 check_added_monitors!(nodes[1], 1);
4662 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4664 let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
4665 assert_eq!(spend_txn.len(), 1);
4666 check_spends!(spend_txn[0], node_txn[0]);
4670 fn test_claim_on_remote_revoked_sizeable_push_msat() {
4671 // Same test as previous, just test on remote revoked commitment tx, as per_commitment_point registration changes following you're funder/fundee and
4672 // to_remote output is encumbered by a P2WPKH
4674 let chanmon_cfgs = create_chanmon_cfgs(2);
4675 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4676 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4677 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4679 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 59000000, InitFeatures::known(), InitFeatures::known());
4680 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4681 let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan.2);
4682 assert_eq!(revoked_local_txn[0].input.len(), 1);
4683 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
4685 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
4686 mine_transaction(&nodes[1], &revoked_local_txn[0]);
4687 check_closed_broadcast!(nodes[1], true);
4688 check_added_monitors!(nodes[1], 1);
4690 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4691 mine_transaction(&nodes[1], &node_txn[0]);
4692 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4694 let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
4695 assert_eq!(spend_txn.len(), 3);
4696 check_spends!(spend_txn[0], revoked_local_txn[0]); // to_remote output on revoked remote commitment_tx
4697 check_spends!(spend_txn[1], node_txn[0]);
4698 check_spends!(spend_txn[2], revoked_local_txn[0], node_txn[0]); // Both outputs
4702 fn test_static_spendable_outputs_preimage_tx() {
4703 let chanmon_cfgs = create_chanmon_cfgs(2);
4704 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4705 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4706 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4708 // Create some initial channels
4709 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4711 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4713 let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
4714 assert_eq!(commitment_tx[0].input.len(), 1);
4715 assert_eq!(commitment_tx[0].input[0].previous_output.txid, chan_1.3.txid());
4717 // Settle A's commitment tx on B's chain
4718 assert!(nodes[1].node.claim_funds(payment_preimage));
4719 check_added_monitors!(nodes[1], 1);
4720 mine_transaction(&nodes[1], &commitment_tx[0]);
4721 check_added_monitors!(nodes[1], 1);
4722 let events = nodes[1].node.get_and_clear_pending_msg_events();
4724 MessageSendEvent::UpdateHTLCs { .. } => {},
4725 _ => panic!("Unexpected event"),
4728 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
4729 _ => panic!("Unexepected event"),
4732 // Check B's monitor was able to send back output descriptor event for preimage tx on A's commitment tx
4733 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap(); // ChannelManager : 2 (local commitment tx + HTLC-Success), ChannelMonitor: preimage tx
4734 assert_eq!(node_txn.len(), 3);
4735 check_spends!(node_txn[0], commitment_tx[0]);
4736 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
4737 check_spends!(node_txn[1], chan_1.3);
4738 check_spends!(node_txn[2], node_txn[1]);
4740 mine_transaction(&nodes[1], &node_txn[0]);
4741 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4743 let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
4744 assert_eq!(spend_txn.len(), 1);
4745 check_spends!(spend_txn[0], node_txn[0]);
4749 fn test_static_spendable_outputs_timeout_tx() {
4750 let chanmon_cfgs = create_chanmon_cfgs(2);
4751 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4752 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4753 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4755 // Create some initial channels
4756 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4758 // Rebalance the network a bit by relaying one payment through all the channels ...
4759 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
4761 let (_, our_payment_hash, _) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3_000_000);
4763 let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
4764 assert_eq!(commitment_tx[0].input.len(), 1);
4765 assert_eq!(commitment_tx[0].input[0].previous_output.txid, chan_1.3.txid());
4767 // Settle A's commitment tx on B' chain
4768 mine_transaction(&nodes[1], &commitment_tx[0]);
4769 check_added_monitors!(nodes[1], 1);
4770 let events = nodes[1].node.get_and_clear_pending_msg_events();
4772 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
4773 _ => panic!("Unexpected event"),
4775 connect_blocks(&nodes[1], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
4777 // Check B's monitor was able to send back output descriptor event for timeout tx on A's commitment tx
4778 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
4779 assert_eq!(node_txn.len(), 2); // ChannelManager : 1 local commitent tx, ChannelMonitor: timeout tx
4780 check_spends!(node_txn[0], chan_1.3.clone());
4781 check_spends!(node_txn[1], commitment_tx[0].clone());
4782 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4784 mine_transaction(&nodes[1], &node_txn[1]);
4785 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4786 expect_payment_failed!(nodes[1], our_payment_hash, true);
4788 let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
4789 assert_eq!(spend_txn.len(), 3); // SpendableOutput: remote_commitment_tx.to_remote, timeout_tx.output
4790 check_spends!(spend_txn[0], commitment_tx[0]);
4791 check_spends!(spend_txn[1], node_txn[1]);
4792 check_spends!(spend_txn[2], node_txn[1], commitment_tx[0]); // All outputs
4796 fn test_static_spendable_outputs_justice_tx_revoked_commitment_tx() {
4797 let chanmon_cfgs = create_chanmon_cfgs(2);
4798 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4799 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4800 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4802 // Create some initial channels
4803 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4805 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4806 let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
4807 assert_eq!(revoked_local_txn[0].input.len(), 1);
4808 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
4810 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
4812 mine_transaction(&nodes[1], &revoked_local_txn[0]);
4813 check_closed_broadcast!(nodes[1], true);
4814 check_added_monitors!(nodes[1], 1);
4816 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4817 assert_eq!(node_txn.len(), 2);
4818 assert_eq!(node_txn[0].input.len(), 2);
4819 check_spends!(node_txn[0], revoked_local_txn[0]);
4821 mine_transaction(&nodes[1], &node_txn[0]);
4822 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4824 let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
4825 assert_eq!(spend_txn.len(), 1);
4826 check_spends!(spend_txn[0], node_txn[0]);
4830 fn test_static_spendable_outputs_justice_tx_revoked_htlc_timeout_tx() {
4831 let mut chanmon_cfgs = create_chanmon_cfgs(2);
4832 chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
4833 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4834 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4835 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4837 // Create some initial channels
4838 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4840 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4841 let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
4842 assert_eq!(revoked_local_txn[0].input.len(), 1);
4843 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
4845 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
4847 // A will generate HTLC-Timeout from revoked commitment tx
4848 mine_transaction(&nodes[0], &revoked_local_txn[0]);
4849 check_closed_broadcast!(nodes[0], true);
4850 check_added_monitors!(nodes[0], 1);
4851 connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
4853 let revoked_htlc_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4854 assert_eq!(revoked_htlc_txn.len(), 2);
4855 check_spends!(revoked_htlc_txn[0], chan_1.3);
4856 assert_eq!(revoked_htlc_txn[1].input.len(), 1);
4857 assert_eq!(revoked_htlc_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
4858 check_spends!(revoked_htlc_txn[1], revoked_local_txn[0]);
4859 assert_ne!(revoked_htlc_txn[1].lock_time, 0); // HTLC-Timeout
4861 // B will generate justice tx from A's revoked commitment/HTLC tx
4862 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4863 connect_block(&nodes[1], &Block { header, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[1].clone()] });
4864 check_closed_broadcast!(nodes[1], true);
4865 check_added_monitors!(nodes[1], 1);
4867 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4868 assert_eq!(node_txn.len(), 3); // ChannelMonitor: bogus justice tx, justice tx on revoked outputs, ChannelManager: local commitment tx
4869 // The first transaction generated is bogus - it spends both outputs of revoked_local_txn[0]
4870 // including the one already spent by revoked_htlc_txn[1]. That's OK, we'll spend with valid
4871 // transactions next...
4872 assert_eq!(node_txn[0].input.len(), 3);
4873 check_spends!(node_txn[0], revoked_local_txn[0], revoked_htlc_txn[1]);
4875 assert_eq!(node_txn[1].input.len(), 2);
4876 check_spends!(node_txn[1], revoked_local_txn[0], revoked_htlc_txn[1]);
4877 if node_txn[1].input[1].previous_output.txid == revoked_htlc_txn[1].txid() {
4878 assert_ne!(node_txn[1].input[0].previous_output, revoked_htlc_txn[1].input[0].previous_output);
4880 assert_eq!(node_txn[1].input[0].previous_output.txid, revoked_htlc_txn[1].txid());
4881 assert_ne!(node_txn[1].input[1].previous_output, revoked_htlc_txn[1].input[0].previous_output);
4884 assert_eq!(node_txn[2].input.len(), 1);
4885 check_spends!(node_txn[2], chan_1.3);
4887 mine_transaction(&nodes[1], &node_txn[1]);
4888 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4890 // Check B's ChannelMonitor was able to generate the right spendable output descriptor
4891 let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
4892 assert_eq!(spend_txn.len(), 1);
4893 assert_eq!(spend_txn[0].input.len(), 1);
4894 check_spends!(spend_txn[0], node_txn[1]);
4898 fn test_static_spendable_outputs_justice_tx_revoked_htlc_success_tx() {
4899 let mut chanmon_cfgs = create_chanmon_cfgs(2);
4900 chanmon_cfgs[1].keys_manager.disable_revocation_policy_check = true;
4901 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4902 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4903 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4905 // Create some initial channels
4906 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4908 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4909 let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan_1.2);
4910 assert_eq!(revoked_local_txn[0].input.len(), 1);
4911 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
4913 // The to-be-revoked commitment tx should have one HTLC and one to_remote output
4914 assert_eq!(revoked_local_txn[0].output.len(), 2);
4916 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
4918 // B will generate HTLC-Success from revoked commitment tx
4919 mine_transaction(&nodes[1], &revoked_local_txn[0]);
4920 check_closed_broadcast!(nodes[1], true);
4921 check_added_monitors!(nodes[1], 1);
4922 let revoked_htlc_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4924 assert_eq!(revoked_htlc_txn.len(), 2);
4925 assert_eq!(revoked_htlc_txn[0].input.len(), 1);
4926 assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4927 check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
4929 // Check that the unspent (of two) outputs on revoked_local_txn[0] is a P2WPKH:
4930 let unspent_local_txn_output = revoked_htlc_txn[0].input[0].previous_output.vout as usize ^ 1;
4931 assert_eq!(revoked_local_txn[0].output[unspent_local_txn_output].script_pubkey.len(), 2 + 20); // P2WPKH
4933 // A will generate justice tx from B's revoked commitment/HTLC tx
4934 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4935 connect_block(&nodes[0], &Block { header, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[0].clone()] });
4936 check_closed_broadcast!(nodes[0], true);
4937 check_added_monitors!(nodes[0], 1);
4939 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4940 assert_eq!(node_txn.len(), 3); // ChannelMonitor: justice tx on revoked commitment, justice tx on revoked HTLC-success, ChannelManager: local commitment tx
4942 // The first transaction generated is bogus - it spends both outputs of revoked_local_txn[0]
4943 // including the one already spent by revoked_htlc_txn[0]. That's OK, we'll spend with valid
4944 // transactions next...
4945 assert_eq!(node_txn[0].input.len(), 2);
4946 check_spends!(node_txn[0], revoked_local_txn[0], revoked_htlc_txn[0]);
4947 if node_txn[0].input[1].previous_output.txid == revoked_htlc_txn[0].txid() {
4948 assert_eq!(node_txn[0].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
4950 assert_eq!(node_txn[0].input[0].previous_output.txid, revoked_htlc_txn[0].txid());
4951 assert_eq!(node_txn[0].input[1].previous_output, revoked_htlc_txn[0].input[0].previous_output);
4954 assert_eq!(node_txn[1].input.len(), 1);
4955 check_spends!(node_txn[1], revoked_htlc_txn[0]);
4957 check_spends!(node_txn[2], chan_1.3);
4959 mine_transaction(&nodes[0], &node_txn[1]);
4960 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
4962 // Note that nodes[0]'s tx_broadcaster is still locked, so if we get here the channelmonitor
4963 // didn't try to generate any new transactions.
4965 // Check A's ChannelMonitor was able to generate the right spendable output descriptor
4966 let spend_txn = check_spendable_outputs!(nodes[0], node_cfgs[0].keys_manager);
4967 assert_eq!(spend_txn.len(), 3);
4968 assert_eq!(spend_txn[0].input.len(), 1);
4969 check_spends!(spend_txn[0], revoked_local_txn[0]); // spending to_remote output from revoked local tx
4970 assert_ne!(spend_txn[0].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
4971 check_spends!(spend_txn[1], node_txn[1]); // spending justice tx output on the htlc success tx
4972 check_spends!(spend_txn[2], revoked_local_txn[0], node_txn[1]); // Both outputs
4976 fn test_onchain_to_onchain_claim() {
4977 // Test that in case of channel closure, we detect the state of output and claim HTLC
4978 // on downstream peer's remote commitment tx.
4979 // First, have C claim an HTLC against its own latest commitment transaction.
4980 // Then, broadcast these to B, which should update the monitor downstream on the A<->B
4982 // Finally, check that B will claim the HTLC output if A's latest commitment transaction
4985 let chanmon_cfgs = create_chanmon_cfgs(3);
4986 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
4987 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
4988 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
4990 // Create some initial channels
4991 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4992 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
4994 // Ensure all nodes are at the same height
4995 let node_max_height = nodes.iter().map(|node| node.blocks.lock().unwrap().len()).max().unwrap() as u32;
4996 connect_blocks(&nodes[0], node_max_height - nodes[0].best_block_info().1);
4997 connect_blocks(&nodes[1], node_max_height - nodes[1].best_block_info().1);
4998 connect_blocks(&nodes[2], node_max_height - nodes[2].best_block_info().1);
5000 // Rebalance the network a bit by relaying one payment through all the channels ...
5001 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
5002 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
5004 let (payment_preimage, _payment_hash, _payment_secret) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
5005 let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
5006 check_spends!(commitment_tx[0], chan_2.3);
5007 nodes[2].node.claim_funds(payment_preimage);
5008 check_added_monitors!(nodes[2], 1);
5009 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
5010 assert!(updates.update_add_htlcs.is_empty());
5011 assert!(updates.update_fail_htlcs.is_empty());
5012 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
5013 assert!(updates.update_fail_malformed_htlcs.is_empty());
5015 mine_transaction(&nodes[2], &commitment_tx[0]);
5016 check_closed_broadcast!(nodes[2], true);
5017 check_added_monitors!(nodes[2], 1);
5019 let c_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 2 (commitment tx, HTLC-Success tx), ChannelMonitor : 1 (HTLC-Success tx)
5020 assert_eq!(c_txn.len(), 3);
5021 assert_eq!(c_txn[0], c_txn[2]);
5022 assert_eq!(commitment_tx[0], c_txn[1]);
5023 check_spends!(c_txn[1], chan_2.3);
5024 check_spends!(c_txn[2], c_txn[1]);
5025 assert_eq!(c_txn[1].input[0].witness.clone().last().unwrap().len(), 71);
5026 assert_eq!(c_txn[2].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5027 assert!(c_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
5028 assert_eq!(c_txn[0].lock_time, 0); // Success tx
5030 // 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
5031 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
5032 connect_block(&nodes[1], &Block { header, txdata: vec![c_txn[1].clone(), c_txn[2].clone()]});
5033 check_added_monitors!(nodes[1], 1);
5034 expect_payment_forwarded!(nodes[1], Some(1000), true);
5036 let mut b_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5037 // ChannelMonitor: claim tx
5038 assert_eq!(b_txn.len(), 1);
5039 check_spends!(b_txn[0], chan_2.3); // B local commitment tx, issued by ChannelManager
5042 let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
5043 assert_eq!(msg_events.len(), 3);
5044 check_added_monitors!(nodes[1], 1);
5045 match msg_events[0] {
5046 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5047 _ => panic!("Unexpected event"),
5049 match msg_events[1] {
5050 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { .. }, node_id: _ } => {},
5051 _ => panic!("Unexpected event"),
5053 match msg_events[2] {
5054 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, .. } } => {
5055 assert!(update_add_htlcs.is_empty());
5056 assert!(update_fail_htlcs.is_empty());
5057 assert_eq!(update_fulfill_htlcs.len(), 1);
5058 assert!(update_fail_malformed_htlcs.is_empty());
5059 assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
5061 _ => panic!("Unexpected event"),
5063 // Broadcast A's commitment tx on B's chain to see if we are able to claim inbound HTLC with our HTLC-Success tx
5064 let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
5065 mine_transaction(&nodes[1], &commitment_tx[0]);
5066 let b_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5067 // ChannelMonitor: HTLC-Success tx, ChannelManager: local commitment tx + HTLC-Success tx
5068 assert_eq!(b_txn.len(), 3);
5069 check_spends!(b_txn[1], chan_1.3);
5070 check_spends!(b_txn[2], b_txn[1]);
5071 check_spends!(b_txn[0], commitment_tx[0]);
5072 assert_eq!(b_txn[0].input[0].witness.clone().last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5073 assert!(b_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
5074 assert_eq!(b_txn[0].lock_time, 0); // Success tx
5076 check_closed_broadcast!(nodes[1], true);
5077 check_added_monitors!(nodes[1], 1);
5081 fn test_duplicate_payment_hash_one_failure_one_success() {
5082 // Topology : A --> B --> C --> D
5083 // We route 2 payments with same hash between B and C, one will be timeout, the other successfully claim
5084 // Note that because C will refuse to generate two payment secrets for the same payment hash,
5085 // we forward one of the payments onwards to D.
5086 let chanmon_cfgs = create_chanmon_cfgs(4);
5087 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
5088 // When this test was written, the default base fee floated based on the HTLC count.
5089 // It is now fixed, so we simply set the fee to the expected value here.
5090 let mut config = test_default_channel_config();
5091 config.channel_options.forwarding_fee_base_msat = 196;
5092 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs,
5093 &[Some(config.clone()), Some(config.clone()), Some(config.clone()), Some(config.clone())]);
5094 let mut nodes = create_network(4, &node_cfgs, &node_chanmgrs);
5096 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5097 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
5098 create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
5100 let node_max_height = nodes.iter().map(|node| node.blocks.lock().unwrap().len()).max().unwrap() as u32;
5101 connect_blocks(&nodes[0], node_max_height - nodes[0].best_block_info().1);
5102 connect_blocks(&nodes[1], node_max_height - nodes[1].best_block_info().1);
5103 connect_blocks(&nodes[2], node_max_height - nodes[2].best_block_info().1);
5104 connect_blocks(&nodes[3], node_max_height - nodes[3].best_block_info().1);
5106 let (our_payment_preimage, duplicate_payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 900000);
5108 let payment_secret = nodes[3].node.create_inbound_payment_for_hash(duplicate_payment_hash, None, 7200, 0).unwrap();
5109 // We reduce the final CLTV here by a somewhat arbitrary constant to keep it under the one-byte
5110 // script push size limit so that the below script length checks match
5111 // ACCEPTED_HTLC_SCRIPT_WEIGHT.
5112 let route = get_route(&nodes[0].node.get_our_node_id(), &nodes[0].net_graph_msg_handler.network_graph.read().unwrap(),
5113 &nodes[3].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 900000, TEST_FINAL_CLTV - 40, nodes[0].logger).unwrap();
5114 send_along_route_with_secret(&nodes[0], route, &[&[&nodes[1], &nodes[2], &nodes[3]]], 900000, duplicate_payment_hash, payment_secret);
5116 let commitment_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
5117 assert_eq!(commitment_txn[0].input.len(), 1);
5118 check_spends!(commitment_txn[0], chan_2.3);
5120 mine_transaction(&nodes[1], &commitment_txn[0]);
5121 check_closed_broadcast!(nodes[1], true);
5122 check_added_monitors!(nodes[1], 1);
5123 connect_blocks(&nodes[1], TEST_FINAL_CLTV - 40 + MIN_CLTV_EXPIRY_DELTA as u32 - 1); // Confirm blocks until the HTLC expires
5125 let htlc_timeout_tx;
5126 { // Extract one of the two HTLC-Timeout transaction
5127 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5128 // ChannelMonitor: timeout tx * 3, ChannelManager: local commitment tx
5129 assert_eq!(node_txn.len(), 4);
5130 check_spends!(node_txn[0], chan_2.3);
5132 check_spends!(node_txn[1], commitment_txn[0]);
5133 assert_eq!(node_txn[1].input.len(), 1);
5134 check_spends!(node_txn[2], commitment_txn[0]);
5135 assert_eq!(node_txn[2].input.len(), 1);
5136 assert_eq!(node_txn[1].input[0].previous_output, node_txn[2].input[0].previous_output);
5137 check_spends!(node_txn[3], commitment_txn[0]);
5138 assert_ne!(node_txn[1].input[0].previous_output, node_txn[3].input[0].previous_output);
5140 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5141 assert_eq!(node_txn[2].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5142 assert_eq!(node_txn[3].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5143 htlc_timeout_tx = node_txn[1].clone();
5146 nodes[2].node.claim_funds(our_payment_preimage);
5147 mine_transaction(&nodes[2], &commitment_txn[0]);
5148 check_added_monitors!(nodes[2], 2);
5149 let events = nodes[2].node.get_and_clear_pending_msg_events();
5151 MessageSendEvent::UpdateHTLCs { .. } => {},
5152 _ => panic!("Unexpected event"),
5155 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5156 _ => panic!("Unexepected event"),
5158 let htlc_success_txn: Vec<_> = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
5159 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)
5160 check_spends!(htlc_success_txn[0], commitment_txn[0]);
5161 check_spends!(htlc_success_txn[1], commitment_txn[0]);
5162 assert_eq!(htlc_success_txn[0].input.len(), 1);
5163 assert_eq!(htlc_success_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5164 assert_eq!(htlc_success_txn[1].input.len(), 1);
5165 assert_eq!(htlc_success_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5166 assert_ne!(htlc_success_txn[0].input[0].previous_output, htlc_success_txn[1].input[0].previous_output);
5167 assert_eq!(htlc_success_txn[2], commitment_txn[0]);
5168 assert_eq!(htlc_success_txn[3], htlc_success_txn[0]);
5169 assert_eq!(htlc_success_txn[4], htlc_success_txn[1]);
5170 assert_ne!(htlc_success_txn[0].input[0].previous_output, htlc_timeout_tx.input[0].previous_output);
5172 mine_transaction(&nodes[1], &htlc_timeout_tx);
5173 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
5174 expect_pending_htlcs_forwardable!(nodes[1]);
5175 let htlc_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5176 assert!(htlc_updates.update_add_htlcs.is_empty());
5177 assert_eq!(htlc_updates.update_fail_htlcs.len(), 1);
5178 let first_htlc_id = htlc_updates.update_fail_htlcs[0].htlc_id;
5179 assert!(htlc_updates.update_fulfill_htlcs.is_empty());
5180 assert!(htlc_updates.update_fail_malformed_htlcs.is_empty());
5181 check_added_monitors!(nodes[1], 1);
5183 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_updates.update_fail_htlcs[0]);
5184 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
5186 commitment_signed_dance!(nodes[0], nodes[1], &htlc_updates.commitment_signed, false, true);
5187 expect_payment_failure_chan_update!(nodes[0], chan_2.0.contents.short_channel_id, true);
5189 expect_payment_failed!(nodes[0], duplicate_payment_hash, false);
5191 // Solve 2nd HTLC by broadcasting on B's chain HTLC-Success Tx from C
5192 // Note that the fee paid is effectively double as the HTLC value (including the nodes[1] fee
5193 // and nodes[2] fee) is rounded down and then claimed in full.
5194 mine_transaction(&nodes[1], &htlc_success_txn[0]);
5195 expect_payment_forwarded!(nodes[1], Some(196*2), true);
5196 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5197 assert!(updates.update_add_htlcs.is_empty());
5198 assert!(updates.update_fail_htlcs.is_empty());
5199 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
5200 assert_ne!(updates.update_fulfill_htlcs[0].htlc_id, first_htlc_id);
5201 assert!(updates.update_fail_malformed_htlcs.is_empty());
5202 check_added_monitors!(nodes[1], 1);
5204 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
5205 commitment_signed_dance!(nodes[0], nodes[1], &updates.commitment_signed, false);
5207 let events = nodes[0].node.get_and_clear_pending_events();
5209 Event::PaymentSent { ref payment_preimage } => {
5210 assert_eq!(*payment_preimage, our_payment_preimage);
5212 _ => panic!("Unexpected event"),
5217 fn test_dynamic_spendable_outputs_local_htlc_success_tx() {
5218 let chanmon_cfgs = create_chanmon_cfgs(2);
5219 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5220 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5221 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5223 // Create some initial channels
5224 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5226 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000).0;
5227 let local_txn = get_local_commitment_txn!(nodes[1], chan_1.2);
5228 assert_eq!(local_txn.len(), 1);
5229 assert_eq!(local_txn[0].input.len(), 1);
5230 check_spends!(local_txn[0], chan_1.3);
5232 // Give B knowledge of preimage to be able to generate a local HTLC-Success Tx
5233 nodes[1].node.claim_funds(payment_preimage);
5234 check_added_monitors!(nodes[1], 1);
5235 mine_transaction(&nodes[1], &local_txn[0]);
5236 check_added_monitors!(nodes[1], 1);
5237 let events = nodes[1].node.get_and_clear_pending_msg_events();
5239 MessageSendEvent::UpdateHTLCs { .. } => {},
5240 _ => panic!("Unexpected event"),
5243 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5244 _ => panic!("Unexepected event"),
5247 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5248 assert_eq!(node_txn.len(), 3);
5249 assert_eq!(node_txn[0], node_txn[2]);
5250 assert_eq!(node_txn[1], local_txn[0]);
5251 assert_eq!(node_txn[0].input.len(), 1);
5252 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5253 check_spends!(node_txn[0], local_txn[0]);
5257 mine_transaction(&nodes[1], &node_tx);
5258 connect_blocks(&nodes[1], BREAKDOWN_TIMEOUT as u32 - 1);
5260 // Verify that B is able to spend its own HTLC-Success tx thanks to spendable output event given back by its ChannelMonitor
5261 let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
5262 assert_eq!(spend_txn.len(), 1);
5263 assert_eq!(spend_txn[0].input.len(), 1);
5264 check_spends!(spend_txn[0], node_tx);
5265 assert_eq!(spend_txn[0].input[0].sequence, BREAKDOWN_TIMEOUT as u32);
5268 fn do_test_fail_backwards_unrevoked_remote_announce(deliver_last_raa: bool, announce_latest: bool) {
5269 // Test that we fail backwards the full set of HTLCs we need to when remote broadcasts an
5270 // unrevoked commitment transaction.
5271 // This includes HTLCs which were below the dust threshold as well as HTLCs which were awaiting
5272 // a remote RAA before they could be failed backwards (and combinations thereof).
5273 // We also test duplicate-hash HTLCs by adding two nodes on each side of the target nodes which
5274 // use the same payment hashes.
5275 // Thus, we use a six-node network:
5280 // And test where C fails back to A/B when D announces its latest commitment transaction
5281 let chanmon_cfgs = create_chanmon_cfgs(6);
5282 let node_cfgs = create_node_cfgs(6, &chanmon_cfgs);
5283 // When this test was written, the default base fee floated based on the HTLC count.
5284 // It is now fixed, so we simply set the fee to the expected value here.
5285 let mut config = test_default_channel_config();
5286 config.channel_options.forwarding_fee_base_msat = 196;
5287 let node_chanmgrs = create_node_chanmgrs(6, &node_cfgs,
5288 &[Some(config.clone()), Some(config.clone()), Some(config.clone()), Some(config.clone()), Some(config.clone()), Some(config.clone())]);
5289 let nodes = create_network(6, &node_cfgs, &node_chanmgrs);
5290 let logger = test_utils::TestLogger::new();
5292 create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known());
5293 create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
5294 let chan = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
5295 create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::known(), InitFeatures::known());
5296 create_announced_chan_between_nodes(&nodes, 3, 5, InitFeatures::known(), InitFeatures::known());
5298 // Rebalance and check output sanity...
5299 send_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 500000);
5300 send_payment(&nodes[1], &[&nodes[2], &nodes[3], &nodes[5]], 500000);
5301 assert_eq!(get_local_commitment_txn!(nodes[3], chan.2)[0].output.len(), 2);
5303 let ds_dust_limit = nodes[3].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().holder_dust_limit_satoshis;
5305 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
5307 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
5308 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
5309 let our_node_id = &nodes[1].node.get_our_node_id();
5310 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();
5312 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
5314 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
5316 let (_, payment_hash_3, _) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
5318 let (_, payment_hash_4, _) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
5319 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();
5321 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());
5323 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());
5326 let (_, payment_hash_5, _) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
5328 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();
5329 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
5332 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
5334 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();
5335 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());
5337 // Double-check that six of the new HTLC were added
5338 // We now have six HTLCs pending over the dust limit and six HTLCs under the dust limit (ie,
5339 // with to_local and to_remote outputs, 8 outputs and 6 HTLCs not included).
5340 assert_eq!(get_local_commitment_txn!(nodes[3], chan.2).len(), 1);
5341 assert_eq!(get_local_commitment_txn!(nodes[3], chan.2)[0].output.len(), 8);
5343 // Now fail back three of the over-dust-limit and three of the under-dust-limit payments in one go.
5344 // Fail 0th below-dust, 4th above-dust, 8th above-dust, 10th below-dust HTLCs
5345 assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_1));
5346 assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_3));
5347 assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_5));
5348 assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_6));
5349 check_added_monitors!(nodes[4], 0);
5350 expect_pending_htlcs_forwardable!(nodes[4]);
5351 check_added_monitors!(nodes[4], 1);
5353 let four_removes = get_htlc_update_msgs!(nodes[4], nodes[3].node.get_our_node_id());
5354 nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[0]);
5355 nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[1]);
5356 nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[2]);
5357 nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[3]);
5358 commitment_signed_dance!(nodes[3], nodes[4], four_removes.commitment_signed, false);
5360 // Fail 3rd below-dust and 7th above-dust HTLCs
5361 assert!(nodes[5].node.fail_htlc_backwards(&payment_hash_2));
5362 assert!(nodes[5].node.fail_htlc_backwards(&payment_hash_4));
5363 check_added_monitors!(nodes[5], 0);
5364 expect_pending_htlcs_forwardable!(nodes[5]);
5365 check_added_monitors!(nodes[5], 1);
5367 let two_removes = get_htlc_update_msgs!(nodes[5], nodes[3].node.get_our_node_id());
5368 nodes[3].node.handle_update_fail_htlc(&nodes[5].node.get_our_node_id(), &two_removes.update_fail_htlcs[0]);
5369 nodes[3].node.handle_update_fail_htlc(&nodes[5].node.get_our_node_id(), &two_removes.update_fail_htlcs[1]);
5370 commitment_signed_dance!(nodes[3], nodes[5], two_removes.commitment_signed, false);
5372 let ds_prev_commitment_tx = get_local_commitment_txn!(nodes[3], chan.2);
5374 expect_pending_htlcs_forwardable!(nodes[3]);
5375 check_added_monitors!(nodes[3], 1);
5376 let six_removes = get_htlc_update_msgs!(nodes[3], nodes[2].node.get_our_node_id());
5377 nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[0]);
5378 nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[1]);
5379 nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[2]);
5380 nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[3]);
5381 nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[4]);
5382 nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[5]);
5383 if deliver_last_raa {
5384 commitment_signed_dance!(nodes[2], nodes[3], six_removes.commitment_signed, false);
5386 let _cs_last_raa = commitment_signed_dance!(nodes[2], nodes[3], six_removes.commitment_signed, false, true, false, true);
5389 // D's latest commitment transaction now contains 1st + 2nd + 9th HTLCs (implicitly, they're
5390 // below the dust limit) and the 5th + 6th + 11th HTLCs. It has failed back the 0th, 3rd, 4th,
5391 // 7th, 8th, and 10th, but as we haven't yet delivered the final RAA to C, the fails haven't
5392 // propagated back to A/B yet (and D has two unrevoked commitment transactions).
5394 // We now broadcast the latest commitment transaction, which *should* result in failures for
5395 // the 0th, 1st, 2nd, 3rd, 4th, 7th, 8th, 9th, and 10th HTLCs, ie all the below-dust HTLCs and
5396 // the non-broadcast above-dust HTLCs.
5398 // Alternatively, we may broadcast the previous commitment transaction, which should only
5399 // result in failures for the below-dust HTLCs, ie the 0th, 1st, 2nd, 3rd, 9th, and 10th HTLCs.
5400 let ds_last_commitment_tx = get_local_commitment_txn!(nodes[3], chan.2);
5402 if announce_latest {
5403 mine_transaction(&nodes[2], &ds_last_commitment_tx[0]);
5405 mine_transaction(&nodes[2], &ds_prev_commitment_tx[0]);
5407 connect_blocks(&nodes[2], ANTI_REORG_DELAY - 1);
5408 check_closed_broadcast!(nodes[2], true);
5409 expect_pending_htlcs_forwardable!(nodes[2]);
5410 check_added_monitors!(nodes[2], 3);
5412 let cs_msgs = nodes[2].node.get_and_clear_pending_msg_events();
5413 assert_eq!(cs_msgs.len(), 2);
5414 let mut a_done = false;
5415 for msg in cs_msgs {
5417 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
5418 // Both under-dust HTLCs and the one above-dust HTLC that we had already failed
5419 // should be failed-backwards here.
5420 let target = if *node_id == nodes[0].node.get_our_node_id() {
5421 // If announce_latest, expect 0th, 1st, 4th, 8th, 10th HTLCs, else only 0th, 1st, 10th below-dust HTLCs
5422 for htlc in &updates.update_fail_htlcs {
5423 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 });
5425 assert_eq!(updates.update_fail_htlcs.len(), if announce_latest { 5 } else { 3 });
5430 // If announce_latest, expect 2nd, 3rd, 7th, 9th HTLCs, else only 2nd, 3rd, 9th below-dust HTLCs
5431 for htlc in &updates.update_fail_htlcs {
5432 assert!(htlc.htlc_id == 1 || htlc.htlc_id == 2 || htlc.htlc_id == 5 || if announce_latest { htlc.htlc_id == 4 } else { false });
5434 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
5435 assert_eq!(updates.update_fail_htlcs.len(), if announce_latest { 4 } else { 3 });
5438 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
5439 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[1]);
5440 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[2]);
5441 if announce_latest {
5442 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[3]);
5443 if *node_id == nodes[0].node.get_our_node_id() {
5444 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[4]);
5447 commitment_signed_dance!(target, nodes[2], updates.commitment_signed, false, true);
5449 _ => panic!("Unexpected event"),
5453 let as_events = nodes[0].node.get_and_clear_pending_events();
5454 assert_eq!(as_events.len(), if announce_latest { 5 } else { 3 });
5455 let mut as_failds = HashSet::new();
5456 for event in as_events.iter() {
5457 if let &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, .. } = event {
5458 assert!(as_failds.insert(*payment_hash));
5459 if *payment_hash != payment_hash_2 {
5460 assert_eq!(*rejected_by_dest, deliver_last_raa);
5462 assert!(!rejected_by_dest);
5464 } else { panic!("Unexpected event"); }
5466 assert!(as_failds.contains(&payment_hash_1));
5467 assert!(as_failds.contains(&payment_hash_2));
5468 if announce_latest {
5469 assert!(as_failds.contains(&payment_hash_3));
5470 assert!(as_failds.contains(&payment_hash_5));
5472 assert!(as_failds.contains(&payment_hash_6));
5474 let bs_events = nodes[1].node.get_and_clear_pending_events();
5475 assert_eq!(bs_events.len(), if announce_latest { 4 } else { 3 });
5476 let mut bs_failds = HashSet::new();
5477 for event in bs_events.iter() {
5478 if let &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, .. } = event {
5479 assert!(bs_failds.insert(*payment_hash));
5480 if *payment_hash != payment_hash_1 && *payment_hash != payment_hash_5 {
5481 assert_eq!(*rejected_by_dest, deliver_last_raa);
5483 assert!(!rejected_by_dest);
5485 } else { panic!("Unexpected event"); }
5487 assert!(bs_failds.contains(&payment_hash_1));
5488 assert!(bs_failds.contains(&payment_hash_2));
5489 if announce_latest {
5490 assert!(bs_failds.contains(&payment_hash_4));
5492 assert!(bs_failds.contains(&payment_hash_5));
5494 // For each HTLC which was not failed-back by normal process (ie deliver_last_raa), we should
5495 // get a PaymentFailureNetworkUpdate. A should have gotten 4 HTLCs which were failed-back due
5496 // to unknown-preimage-etc, B should have gotten 2. Thus, in the
5497 // announce_latest && deliver_last_raa case, we should have 5-4=1 and 4-2=2
5498 // PaymentFailureNetworkUpdates.
5499 let as_msg_events = nodes[0].node.get_and_clear_pending_msg_events();
5500 assert_eq!(as_msg_events.len(), if deliver_last_raa { 1 } else if !announce_latest { 3 } else { 5 });
5501 let bs_msg_events = nodes[1].node.get_and_clear_pending_msg_events();
5502 assert_eq!(bs_msg_events.len(), if deliver_last_raa { 2 } else if !announce_latest { 3 } else { 4 });
5503 for event in as_msg_events.iter().chain(bs_msg_events.iter()) {
5505 &MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
5506 _ => panic!("Unexpected event"),
5512 fn test_fail_backwards_latest_remote_announce_a() {
5513 do_test_fail_backwards_unrevoked_remote_announce(false, true);
5517 fn test_fail_backwards_latest_remote_announce_b() {
5518 do_test_fail_backwards_unrevoked_remote_announce(true, true);
5522 fn test_fail_backwards_previous_remote_announce() {
5523 do_test_fail_backwards_unrevoked_remote_announce(false, false);
5524 // Note that true, true doesn't make sense as it implies we announce a revoked state, which is
5525 // tested for in test_commitment_revoked_fail_backward_exhaustive()
5529 fn test_dynamic_spendable_outputs_local_htlc_timeout_tx() {
5530 let chanmon_cfgs = create_chanmon_cfgs(2);
5531 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5532 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5533 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5535 // Create some initial channels
5536 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5538 let (_, our_payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000);
5539 let local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
5540 assert_eq!(local_txn[0].input.len(), 1);
5541 check_spends!(local_txn[0], chan_1.3);
5543 // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
5544 mine_transaction(&nodes[0], &local_txn[0]);
5545 check_closed_broadcast!(nodes[0], true);
5546 check_added_monitors!(nodes[0], 1);
5547 connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
5549 let htlc_timeout = {
5550 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5551 assert_eq!(node_txn.len(), 2);
5552 check_spends!(node_txn[0], chan_1.3);
5553 assert_eq!(node_txn[1].input.len(), 1);
5554 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5555 check_spends!(node_txn[1], local_txn[0]);
5559 mine_transaction(&nodes[0], &htlc_timeout);
5560 connect_blocks(&nodes[0], BREAKDOWN_TIMEOUT as u32 - 1);
5561 expect_payment_failed!(nodes[0], our_payment_hash, true);
5563 // Verify that A is able to spend its own HTLC-Timeout tx thanks to spendable output event given back by its ChannelMonitor
5564 let spend_txn = check_spendable_outputs!(nodes[0], node_cfgs[0].keys_manager);
5565 assert_eq!(spend_txn.len(), 3);
5566 check_spends!(spend_txn[0], local_txn[0]);
5567 assert_eq!(spend_txn[1].input.len(), 1);
5568 check_spends!(spend_txn[1], htlc_timeout);
5569 assert_eq!(spend_txn[1].input[0].sequence, BREAKDOWN_TIMEOUT as u32);
5570 assert_eq!(spend_txn[2].input.len(), 2);
5571 check_spends!(spend_txn[2], local_txn[0], htlc_timeout);
5572 assert!(spend_txn[2].input[0].sequence == BREAKDOWN_TIMEOUT as u32 ||
5573 spend_txn[2].input[1].sequence == BREAKDOWN_TIMEOUT as u32);
5577 fn test_key_derivation_params() {
5578 // This test is a copy of test_dynamic_spendable_outputs_local_htlc_timeout_tx, with
5579 // a key manager rotation to test that key_derivation_params returned in DynamicOutputP2WSH
5580 // let us re-derive the channel key set to then derive a delayed_payment_key.
5582 let chanmon_cfgs = create_chanmon_cfgs(3);
5584 // We manually create the node configuration to backup the seed.
5585 let seed = [42; 32];
5586 let keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
5587 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);
5588 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() };
5589 let mut node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5590 node_cfgs.remove(0);
5591 node_cfgs.insert(0, node);
5593 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5594 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5596 // Create some initial channels
5597 // Create a dummy channel to advance index by one and thus test re-derivation correctness
5599 let chan_0 = create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known());
5600 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5601 assert_ne!(chan_0.3.output[0].script_pubkey, chan_1.3.output[0].script_pubkey);
5603 // Ensure all nodes are at the same height
5604 let node_max_height = nodes.iter().map(|node| node.blocks.lock().unwrap().len()).max().unwrap() as u32;
5605 connect_blocks(&nodes[0], node_max_height - nodes[0].best_block_info().1);
5606 connect_blocks(&nodes[1], node_max_height - nodes[1].best_block_info().1);
5607 connect_blocks(&nodes[2], node_max_height - nodes[2].best_block_info().1);
5609 let (_, our_payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000);
5610 let local_txn_0 = get_local_commitment_txn!(nodes[0], chan_0.2);
5611 let local_txn_1 = get_local_commitment_txn!(nodes[0], chan_1.2);
5612 assert_eq!(local_txn_1[0].input.len(), 1);
5613 check_spends!(local_txn_1[0], chan_1.3);
5615 // We check funding pubkey are unique
5616 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]));
5617 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]));
5618 if from_0_funding_key_0 == from_1_funding_key_0
5619 || from_0_funding_key_0 == from_1_funding_key_1
5620 || from_0_funding_key_1 == from_1_funding_key_0
5621 || from_0_funding_key_1 == from_1_funding_key_1 {
5622 panic!("Funding pubkeys aren't unique");
5625 // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
5626 mine_transaction(&nodes[0], &local_txn_1[0]);
5627 connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
5628 check_closed_broadcast!(nodes[0], true);
5629 check_added_monitors!(nodes[0], 1);
5631 let htlc_timeout = {
5632 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5633 assert_eq!(node_txn[1].input.len(), 1);
5634 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5635 check_spends!(node_txn[1], local_txn_1[0]);
5639 mine_transaction(&nodes[0], &htlc_timeout);
5640 connect_blocks(&nodes[0], BREAKDOWN_TIMEOUT as u32 - 1);
5641 expect_payment_failed!(nodes[0], our_payment_hash, true);
5643 // Verify that A is able to spend its own HTLC-Timeout tx thanks to spendable output event given back by its ChannelMonitor
5644 let new_keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
5645 let spend_txn = check_spendable_outputs!(nodes[0], new_keys_manager);
5646 assert_eq!(spend_txn.len(), 3);
5647 check_spends!(spend_txn[0], local_txn_1[0]);
5648 assert_eq!(spend_txn[1].input.len(), 1);
5649 check_spends!(spend_txn[1], htlc_timeout);
5650 assert_eq!(spend_txn[1].input[0].sequence, BREAKDOWN_TIMEOUT as u32);
5651 assert_eq!(spend_txn[2].input.len(), 2);
5652 check_spends!(spend_txn[2], local_txn_1[0], htlc_timeout);
5653 assert!(spend_txn[2].input[0].sequence == BREAKDOWN_TIMEOUT as u32 ||
5654 spend_txn[2].input[1].sequence == BREAKDOWN_TIMEOUT as u32);
5658 fn test_static_output_closing_tx() {
5659 let chanmon_cfgs = create_chanmon_cfgs(2);
5660 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5661 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5662 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5664 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5666 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
5667 let closing_tx = close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true).2;
5669 mine_transaction(&nodes[0], &closing_tx);
5670 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
5672 let spend_txn = check_spendable_outputs!(nodes[0], node_cfgs[0].keys_manager);
5673 assert_eq!(spend_txn.len(), 1);
5674 check_spends!(spend_txn[0], closing_tx);
5676 mine_transaction(&nodes[1], &closing_tx);
5677 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
5679 let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
5680 assert_eq!(spend_txn.len(), 1);
5681 check_spends!(spend_txn[0], closing_tx);
5684 fn do_htlc_claim_local_commitment_only(use_dust: bool) {
5685 let chanmon_cfgs = create_chanmon_cfgs(2);
5686 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5687 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5688 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5689 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5691 let (our_payment_preimage, _, _) = route_payment(&nodes[0], &[&nodes[1]], if use_dust { 50000 } else { 3000000 });
5693 // Claim the payment, but don't deliver A's commitment_signed, resulting in the HTLC only being
5694 // present in B's local commitment transaction, but none of A's commitment transactions.
5695 assert!(nodes[1].node.claim_funds(our_payment_preimage));
5696 check_added_monitors!(nodes[1], 1);
5698 let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5699 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fulfill_htlcs[0]);
5700 let events = nodes[0].node.get_and_clear_pending_events();
5701 assert_eq!(events.len(), 1);
5703 Event::PaymentSent { payment_preimage } => {
5704 assert_eq!(payment_preimage, our_payment_preimage);
5706 _ => panic!("Unexpected event"),
5709 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_updates.commitment_signed);
5710 check_added_monitors!(nodes[0], 1);
5711 let as_updates = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5712 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_updates.0);
5713 check_added_monitors!(nodes[1], 1);
5715 let starting_block = nodes[1].best_block_info();
5716 let mut block = Block {
5717 header: BlockHeader { version: 0x20000000, prev_blockhash: starting_block.0, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
5720 for _ in starting_block.1 + 1..TEST_FINAL_CLTV - CLTV_CLAIM_BUFFER + starting_block.1 + 2 {
5721 connect_block(&nodes[1], &block);
5722 block.header.prev_blockhash = block.block_hash();
5724 test_txn_broadcast(&nodes[1], &chan, None, if use_dust { HTLCType::NONE } else { HTLCType::SUCCESS });
5725 check_closed_broadcast!(nodes[1], true);
5726 check_added_monitors!(nodes[1], 1);
5729 fn do_htlc_claim_current_remote_commitment_only(use_dust: bool) {
5730 let chanmon_cfgs = create_chanmon_cfgs(2);
5731 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5732 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5733 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5734 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5735 let logger = test_utils::TestLogger::new();
5737 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1]);
5738 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
5739 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();
5740 nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
5741 check_added_monitors!(nodes[0], 1);
5743 let _as_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5745 // As far as A is concerned, the HTLC is now present only in the latest remote commitment
5746 // transaction, however it is not in A's latest local commitment, so we can just broadcast that
5747 // to "time out" the HTLC.
5749 let starting_block = nodes[1].best_block_info();
5750 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: starting_block.0, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5752 for _ in starting_block.1 + 1..TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + starting_block.1 + 2 {
5753 connect_block(&nodes[0], &Block { header, txdata: Vec::new()});
5754 header.prev_blockhash = header.block_hash();
5756 test_txn_broadcast(&nodes[0], &chan, None, HTLCType::NONE);
5757 check_closed_broadcast!(nodes[0], true);
5758 check_added_monitors!(nodes[0], 1);
5761 fn do_htlc_claim_previous_remote_commitment_only(use_dust: bool, check_revoke_no_close: bool) {
5762 let chanmon_cfgs = create_chanmon_cfgs(3);
5763 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5764 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5765 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5766 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5768 // Fail the payment, but don't deliver A's final RAA, resulting in the HTLC only being present
5769 // in B's previous (unrevoked) commitment transaction, but none of A's commitment transactions.
5770 // Also optionally test that we *don't* fail the channel in case the commitment transaction was
5771 // actually revoked.
5772 let htlc_value = if use_dust { 50000 } else { 3000000 };
5773 let (_, our_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1]], htlc_value);
5774 assert!(nodes[1].node.fail_htlc_backwards(&our_payment_hash));
5775 expect_pending_htlcs_forwardable!(nodes[1]);
5776 check_added_monitors!(nodes[1], 1);
5778 let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5779 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fail_htlcs[0]);
5780 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_updates.commitment_signed);
5781 check_added_monitors!(nodes[0], 1);
5782 let as_updates = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5783 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_updates.0);
5784 check_added_monitors!(nodes[1], 1);
5785 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_updates.1);
5786 check_added_monitors!(nodes[1], 1);
5787 let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
5789 if check_revoke_no_close {
5790 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
5791 check_added_monitors!(nodes[0], 1);
5794 let starting_block = nodes[1].best_block_info();
5795 let mut block = Block {
5796 header: BlockHeader { version: 0x20000000, prev_blockhash: starting_block.0, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
5799 for _ in starting_block.1 + 1..TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + CHAN_CONFIRM_DEPTH + 2 {
5800 connect_block(&nodes[0], &block);
5801 block.header.prev_blockhash = block.block_hash();
5803 if !check_revoke_no_close {
5804 test_txn_broadcast(&nodes[0], &chan, None, HTLCType::NONE);
5805 check_closed_broadcast!(nodes[0], true);
5806 check_added_monitors!(nodes[0], 1);
5808 expect_payment_failed!(nodes[0], our_payment_hash, true);
5812 // Test that we close channels on-chain when broadcastable HTLCs reach their timeout window.
5813 // There are only a few cases to test here:
5814 // * its not really normative behavior, but we test that below-dust HTLCs "included" in
5815 // broadcastable commitment transactions result in channel closure,
5816 // * its included in an unrevoked-but-previous remote commitment transaction,
5817 // * its included in the latest remote or local commitment transactions.
5818 // We test each of the three possible commitment transactions individually and use both dust and
5820 // Note that we don't bother testing both outbound and inbound HTLC failures for each case, and we
5821 // assume they are handled the same across all six cases, as both outbound and inbound failures are
5822 // tested for at least one of the cases in other tests.
5824 fn htlc_claim_single_commitment_only_a() {
5825 do_htlc_claim_local_commitment_only(true);
5826 do_htlc_claim_local_commitment_only(false);
5828 do_htlc_claim_current_remote_commitment_only(true);
5829 do_htlc_claim_current_remote_commitment_only(false);
5833 fn htlc_claim_single_commitment_only_b() {
5834 do_htlc_claim_previous_remote_commitment_only(true, false);
5835 do_htlc_claim_previous_remote_commitment_only(false, false);
5836 do_htlc_claim_previous_remote_commitment_only(true, true);
5837 do_htlc_claim_previous_remote_commitment_only(false, true);
5842 fn bolt2_open_channel_sending_node_checks_part1() { //This test needs to be on its own as we are catching a panic
5843 let chanmon_cfgs = create_chanmon_cfgs(2);
5844 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5845 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5846 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5847 //Force duplicate channel ids
5848 for node in nodes.iter() {
5849 *node.keys_manager.override_channel_id_priv.lock().unwrap() = Some([0; 32]);
5852 // BOLT #2 spec: Sending node must ensure temporary_channel_id is unique from any other channel ID with the same peer.
5853 let channel_value_satoshis=10000;
5854 let push_msat=10001;
5855 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).unwrap();
5856 let node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
5857 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &node0_to_1_send_open_channel);
5859 //Create a second channel with a channel_id collision
5860 assert!(nodes[0].node.create_channel(nodes[0].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
5864 fn bolt2_open_channel_sending_node_checks_part2() {
5865 let chanmon_cfgs = create_chanmon_cfgs(2);
5866 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5867 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5868 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5870 // BOLT #2 spec: Sending node must set funding_satoshis to less than 2^24 satoshis
5871 let channel_value_satoshis=2^24;
5872 let push_msat=10001;
5873 assert!(nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
5875 // BOLT #2 spec: Sending node must set push_msat to equal or less than 1000 * funding_satoshis
5876 let channel_value_satoshis=10000;
5877 // Test when push_msat is equal to 1000 * funding_satoshis.
5878 let push_msat=1000*channel_value_satoshis+1;
5879 assert!(nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
5881 // BOLT #2 spec: Sending node must set set channel_reserve_satoshis greater than or equal to dust_limit_satoshis
5882 let channel_value_satoshis=10000;
5883 let push_msat=10001;
5884 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
5885 let node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
5886 assert!(node0_to_1_send_open_channel.channel_reserve_satoshis>=node0_to_1_send_open_channel.dust_limit_satoshis);
5888 // BOLT #2 spec: Sending node must set undefined bits in channel_flags to 0
5889 // 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
5890 assert!(node0_to_1_send_open_channel.channel_flags<=1);
5892 // 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.
5893 assert!(BREAKDOWN_TIMEOUT>0);
5894 assert!(node0_to_1_send_open_channel.to_self_delay==BREAKDOWN_TIMEOUT);
5896 // BOLT #2 spec: Sending node must ensure the chain_hash value identifies the chain it wishes to open the channel within.
5897 let chain_hash=genesis_block(Network::Testnet).header.block_hash();
5898 assert_eq!(node0_to_1_send_open_channel.chain_hash,chain_hash);
5900 // 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.
5901 assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.funding_pubkey.serialize()).is_ok());
5902 assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.revocation_basepoint.serialize()).is_ok());
5903 assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.htlc_basepoint.serialize()).is_ok());
5904 assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.payment_point.serialize()).is_ok());
5905 assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.delayed_payment_basepoint.serialize()).is_ok());
5909 fn bolt2_open_channel_sane_dust_limit() {
5910 let chanmon_cfgs = create_chanmon_cfgs(2);
5911 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5912 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5913 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5915 let channel_value_satoshis=1000000;
5916 let push_msat=10001;
5917 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).unwrap();
5918 let mut node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
5919 node0_to_1_send_open_channel.dust_limit_satoshis = 661;
5920 node0_to_1_send_open_channel.channel_reserve_satoshis = 100001;
5922 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &node0_to_1_send_open_channel);
5923 let events = nodes[1].node.get_and_clear_pending_msg_events();
5924 let err_msg = match events[0] {
5925 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id: _ } => {
5928 _ => panic!("Unexpected event"),
5930 assert_eq!(err_msg.data, "dust_limit_satoshis (661) is greater than the implementation limit (660)");
5933 // Test that if we fail to send an HTLC that is being freed from the holding cell, and the HTLC
5934 // originated from our node, its failure is surfaced to the user. We trigger this failure to
5935 // free the HTLC by increasing our fee while the HTLC is in the holding cell such that the HTLC
5936 // is no longer affordable once it's freed.
5938 fn test_fail_holding_cell_htlc_upon_free() {
5939 let chanmon_cfgs = create_chanmon_cfgs(2);
5940 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5941 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5942 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5943 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
5944 let logger = test_utils::TestLogger::new();
5946 // First nodes[0] generates an update_fee, setting the channel's
5947 // pending_update_fee.
5949 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
5950 *feerate_lock += 20;
5952 nodes[0].node.timer_tick_occurred();
5953 check_added_monitors!(nodes[0], 1);
5955 let events = nodes[0].node.get_and_clear_pending_msg_events();
5956 assert_eq!(events.len(), 1);
5957 let (update_msg, commitment_signed) = match events[0] {
5958 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
5959 (update_fee.as_ref(), commitment_signed)
5961 _ => panic!("Unexpected event"),
5964 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
5966 let mut chan_stat = get_channel_value_stat!(nodes[0], chan.2);
5967 let channel_reserve = chan_stat.channel_reserve_msat;
5968 let feerate = get_feerate!(nodes[0], chan.2);
5970 // 2* and +1 HTLCs on the commit tx fee calculation for the fee spike reserve.
5971 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
5972 let max_can_send = 5000000 - channel_reserve - 2*commit_tx_fee_msat(feerate, 1 + 1);
5973 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
5974 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();
5976 // Send a payment which passes reserve checks but gets stuck in the holding cell.
5977 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
5978 chan_stat = get_channel_value_stat!(nodes[0], chan.2);
5979 assert_eq!(chan_stat.holding_cell_outbound_amount_msat, max_can_send);
5981 // Flush the pending fee update.
5982 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
5983 let (as_revoke_and_ack, _) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5984 check_added_monitors!(nodes[1], 1);
5985 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_revoke_and_ack);
5986 check_added_monitors!(nodes[0], 1);
5988 // Upon receipt of the RAA, there will be an attempt to resend the holding cell
5989 // HTLC, but now that the fee has been raised the payment will now fail, causing
5990 // us to surface its failure to the user.
5991 chan_stat = get_channel_value_stat!(nodes[0], chan.2);
5992 assert_eq!(chan_stat.holding_cell_outbound_amount_msat, 0);
5993 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);
5994 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 {}",
5995 hex::encode(our_payment_hash.0), chan_stat.channel_reserve_msat, hex::encode(chan.2));
5996 nodes[0].logger.assert_log("lightning::ln::channel".to_string(), failure_log.to_string(), 1);
5998 // Check that the payment failed to be sent out.
5999 let events = nodes[0].node.get_and_clear_pending_events();
6000 assert_eq!(events.len(), 1);
6002 &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, ref error_code, ref error_data } => {
6003 assert_eq!(our_payment_hash.clone(), *payment_hash);
6004 assert_eq!(*rejected_by_dest, false);
6005 assert_eq!(*error_code, None);
6006 assert_eq!(*error_data, None);
6008 _ => panic!("Unexpected event"),
6012 // Test that if multiple HTLCs are released from the holding cell and one is
6013 // valid but the other is no longer valid upon release, the valid HTLC can be
6014 // successfully completed while the other one fails as expected.
6016 fn test_free_and_fail_holding_cell_htlcs() {
6017 let chanmon_cfgs = create_chanmon_cfgs(2);
6018 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6019 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6020 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6021 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6022 let logger = test_utils::TestLogger::new();
6024 // First nodes[0] generates an update_fee, setting the channel's
6025 // pending_update_fee.
6027 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
6028 *feerate_lock += 200;
6030 nodes[0].node.timer_tick_occurred();
6031 check_added_monitors!(nodes[0], 1);
6033 let events = nodes[0].node.get_and_clear_pending_msg_events();
6034 assert_eq!(events.len(), 1);
6035 let (update_msg, commitment_signed) = match events[0] {
6036 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
6037 (update_fee.as_ref(), commitment_signed)
6039 _ => panic!("Unexpected event"),
6042 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
6044 let mut chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6045 let channel_reserve = chan_stat.channel_reserve_msat;
6046 let feerate = get_feerate!(nodes[0], chan.2);
6048 // 2* and +1 HTLCs on the commit tx fee calculation for the fee spike reserve.
6049 let (payment_preimage_1, payment_hash_1, payment_secret_1) = get_payment_preimage_hash!(nodes[1]);
6051 let (_, payment_hash_2, payment_secret_2) = get_payment_preimage_hash!(nodes[1]);
6052 let amt_2 = 5000000 - channel_reserve - 2*commit_tx_fee_msat(feerate, 2 + 1) - amt_1;
6053 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6054 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();
6055 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();
6057 // Send 2 payments which pass reserve checks but get stuck in the holding cell.
6058 nodes[0].node.send_payment(&route_1, payment_hash_1, &Some(payment_secret_1)).unwrap();
6059 chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6060 assert_eq!(chan_stat.holding_cell_outbound_amount_msat, amt_1);
6061 nodes[0].node.send_payment(&route_2, payment_hash_2, &Some(payment_secret_2)).unwrap();
6062 chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6063 assert_eq!(chan_stat.holding_cell_outbound_amount_msat, amt_1 + amt_2);
6065 // Flush the pending fee update.
6066 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
6067 let (revoke_and_ack, commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6068 check_added_monitors!(nodes[1], 1);
6069 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_and_ack);
6070 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
6071 check_added_monitors!(nodes[0], 2);
6073 // Upon receipt of the RAA, there will be an attempt to resend the holding cell HTLCs,
6074 // but now that the fee has been raised the second payment will now fail, causing us
6075 // to surface its failure to the user. The first payment should succeed.
6076 chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6077 assert_eq!(chan_stat.holding_cell_outbound_amount_msat, 0);
6078 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);
6079 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 {}",
6080 hex::encode(payment_hash_2.0), chan_stat.channel_reserve_msat, hex::encode(chan.2));
6081 nodes[0].logger.assert_log("lightning::ln::channel".to_string(), failure_log.to_string(), 1);
6083 // Check that the second payment failed to be sent out.
6084 let events = nodes[0].node.get_and_clear_pending_events();
6085 assert_eq!(events.len(), 1);
6087 &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, ref error_code, ref error_data } => {
6088 assert_eq!(payment_hash_2.clone(), *payment_hash);
6089 assert_eq!(*rejected_by_dest, false);
6090 assert_eq!(*error_code, None);
6091 assert_eq!(*error_data, None);
6093 _ => panic!("Unexpected event"),
6096 // Complete the first payment and the RAA from the fee update.
6097 let (payment_event, send_raa_event) = {
6098 let mut msgs = nodes[0].node.get_and_clear_pending_msg_events();
6099 assert_eq!(msgs.len(), 2);
6100 (SendEvent::from_event(msgs.remove(0)), msgs.remove(0))
6102 let raa = match send_raa_event {
6103 MessageSendEvent::SendRevokeAndACK { msg, .. } => msg,
6104 _ => panic!("Unexpected event"),
6106 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &raa);
6107 check_added_monitors!(nodes[1], 1);
6108 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6109 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6110 let events = nodes[1].node.get_and_clear_pending_events();
6111 assert_eq!(events.len(), 1);
6113 Event::PendingHTLCsForwardable { .. } => {},
6114 _ => panic!("Unexpected event"),
6116 nodes[1].node.process_pending_htlc_forwards();
6117 let events = nodes[1].node.get_and_clear_pending_events();
6118 assert_eq!(events.len(), 1);
6120 Event::PaymentReceived { .. } => {},
6121 _ => panic!("Unexpected event"),
6123 nodes[1].node.claim_funds(payment_preimage_1);
6124 check_added_monitors!(nodes[1], 1);
6125 let update_msgs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6126 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_msgs.update_fulfill_htlcs[0]);
6127 commitment_signed_dance!(nodes[0], nodes[1], update_msgs.commitment_signed, false, true);
6128 let events = nodes[0].node.get_and_clear_pending_events();
6129 assert_eq!(events.len(), 1);
6131 Event::PaymentSent { ref payment_preimage } => {
6132 assert_eq!(*payment_preimage, payment_preimage_1);
6134 _ => panic!("Unexpected event"),
6138 // Test that if we fail to forward an HTLC that is being freed from the holding cell that the
6139 // HTLC is failed backwards. We trigger this failure to forward the freed HTLC by increasing
6140 // our fee while the HTLC is in the holding cell such that the HTLC is no longer affordable
6143 fn test_fail_holding_cell_htlc_upon_free_multihop() {
6144 let chanmon_cfgs = create_chanmon_cfgs(3);
6145 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
6146 // When this test was written, the default base fee floated based on the HTLC count.
6147 // It is now fixed, so we simply set the fee to the expected value here.
6148 let mut config = test_default_channel_config();
6149 config.channel_options.forwarding_fee_base_msat = 196;
6150 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[Some(config.clone()), Some(config.clone()), Some(config.clone())]);
6151 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
6152 let chan_0_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6153 let chan_1_2 = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6154 let logger = test_utils::TestLogger::new();
6156 // First nodes[1] generates an update_fee, setting the channel's
6157 // pending_update_fee.
6159 let mut feerate_lock = chanmon_cfgs[1].fee_estimator.sat_per_kw.lock().unwrap();
6160 *feerate_lock += 20;
6162 nodes[1].node.timer_tick_occurred();
6163 check_added_monitors!(nodes[1], 1);
6165 let events = nodes[1].node.get_and_clear_pending_msg_events();
6166 assert_eq!(events.len(), 1);
6167 let (update_msg, commitment_signed) = match events[0] {
6168 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
6169 (update_fee.as_ref(), commitment_signed)
6171 _ => panic!("Unexpected event"),
6174 nodes[2].node.handle_update_fee(&nodes[1].node.get_our_node_id(), update_msg.unwrap());
6176 let mut chan_stat = get_channel_value_stat!(nodes[0], chan_0_1.2);
6177 let channel_reserve = chan_stat.channel_reserve_msat;
6178 let feerate = get_feerate!(nodes[0], chan_0_1.2);
6180 // Send a payment which passes reserve checks but gets stuck in the holding cell.
6182 let total_routing_fee_msat = (nodes.len() - 2) as u64 * feemsat;
6183 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[2]);
6184 let max_can_send = 5000000 - channel_reserve - 2*commit_tx_fee_msat(feerate, 1 + 1) - total_routing_fee_msat;
6185 let payment_event = {
6186 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6187 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();
6188 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6189 check_added_monitors!(nodes[0], 1);
6191 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
6192 assert_eq!(events.len(), 1);
6194 SendEvent::from_event(events.remove(0))
6196 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6197 check_added_monitors!(nodes[1], 0);
6198 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6199 expect_pending_htlcs_forwardable!(nodes[1]);
6201 chan_stat = get_channel_value_stat!(nodes[1], chan_1_2.2);
6202 assert_eq!(chan_stat.holding_cell_outbound_amount_msat, max_can_send);
6204 // Flush the pending fee update.
6205 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), commitment_signed);
6206 let (raa, commitment_signed) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
6207 check_added_monitors!(nodes[2], 1);
6208 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &raa);
6209 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &commitment_signed);
6210 check_added_monitors!(nodes[1], 2);
6212 // A final RAA message is generated to finalize the fee update.
6213 let events = nodes[1].node.get_and_clear_pending_msg_events();
6214 assert_eq!(events.len(), 1);
6216 let raa_msg = match &events[0] {
6217 &MessageSendEvent::SendRevokeAndACK { ref msg, .. } => {
6220 _ => panic!("Unexpected event"),
6223 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &raa_msg);
6224 check_added_monitors!(nodes[2], 1);
6225 assert!(nodes[2].node.get_and_clear_pending_msg_events().is_empty());
6227 // nodes[1]'s ChannelManager will now signal that we have HTLC forwards to process.
6228 let process_htlc_forwards_event = nodes[1].node.get_and_clear_pending_events();
6229 assert_eq!(process_htlc_forwards_event.len(), 1);
6230 match &process_htlc_forwards_event[0] {
6231 &Event::PendingHTLCsForwardable { .. } => {},
6232 _ => panic!("Unexpected event"),
6235 // In response, we call ChannelManager's process_pending_htlc_forwards
6236 nodes[1].node.process_pending_htlc_forwards();
6237 check_added_monitors!(nodes[1], 1);
6239 // This causes the HTLC to be failed backwards.
6240 let fail_event = nodes[1].node.get_and_clear_pending_msg_events();
6241 assert_eq!(fail_event.len(), 1);
6242 let (fail_msg, commitment_signed) = match &fail_event[0] {
6243 &MessageSendEvent::UpdateHTLCs { ref updates, .. } => {
6244 assert_eq!(updates.update_add_htlcs.len(), 0);
6245 assert_eq!(updates.update_fulfill_htlcs.len(), 0);
6246 assert_eq!(updates.update_fail_malformed_htlcs.len(), 0);
6247 assert_eq!(updates.update_fail_htlcs.len(), 1);
6248 (updates.update_fail_htlcs[0].clone(), updates.commitment_signed.clone())
6250 _ => panic!("Unexpected event"),
6253 // Pass the failure messages back to nodes[0].
6254 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
6255 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
6257 // Complete the HTLC failure+removal process.
6258 let (raa, commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6259 check_added_monitors!(nodes[0], 1);
6260 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &raa);
6261 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commitment_signed);
6262 check_added_monitors!(nodes[1], 2);
6263 let final_raa_event = nodes[1].node.get_and_clear_pending_msg_events();
6264 assert_eq!(final_raa_event.len(), 1);
6265 let raa = match &final_raa_event[0] {
6266 &MessageSendEvent::SendRevokeAndACK { ref msg, .. } => msg.clone(),
6267 _ => panic!("Unexpected event"),
6269 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &raa);
6270 expect_payment_failure_chan_update!(nodes[0], chan_1_2.0.contents.short_channel_id, false);
6271 expect_payment_failed!(nodes[0], our_payment_hash, false);
6272 check_added_monitors!(nodes[0], 1);
6275 // BOLT 2 Requirements for the Sender when constructing and sending an update_add_htlc message.
6276 // 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.
6277 //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.
6280 fn test_update_add_htlc_bolt2_sender_value_below_minimum_msat() {
6281 //BOLT2 Requirement: MUST NOT offer amount_msat below the receiving node's htlc_minimum_msat (same validation check catches both of these)
6282 let chanmon_cfgs = create_chanmon_cfgs(2);
6283 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6284 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6285 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6286 let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6288 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6289 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6290 let logger = test_utils::TestLogger::new();
6291 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();
6292 route.paths[0][0].fee_msat = 100;
6294 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
6295 assert!(regex::Regex::new(r"Cannot send less than their minimum HTLC value \(\d+\)").unwrap().is_match(err)));
6296 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6297 nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot send less than their minimum HTLC value".to_string(), 1);
6301 fn test_update_add_htlc_bolt2_sender_zero_value_msat() {
6302 //BOLT2 Requirement: MUST offer amount_msat greater than 0.
6303 let chanmon_cfgs = create_chanmon_cfgs(2);
6304 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6305 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6306 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6307 let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6308 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6310 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6311 let logger = test_utils::TestLogger::new();
6312 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();
6313 route.paths[0][0].fee_msat = 0;
6314 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
6315 assert_eq!(err, "Cannot send 0-msat HTLC"));
6317 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6318 nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot send 0-msat HTLC".to_string(), 1);
6322 fn test_update_add_htlc_bolt2_receiver_zero_value_msat() {
6323 //BOLT2 Requirement: MUST offer amount_msat greater than 0.
6324 let chanmon_cfgs = create_chanmon_cfgs(2);
6325 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6326 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6327 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6328 let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6330 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6331 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6332 let logger = test_utils::TestLogger::new();
6333 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();
6334 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6335 check_added_monitors!(nodes[0], 1);
6336 let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6337 updates.update_add_htlcs[0].amount_msat = 0;
6339 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6340 nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Remote side tried to send a 0-msat HTLC".to_string(), 1);
6341 check_closed_broadcast!(nodes[1], true).unwrap();
6342 check_added_monitors!(nodes[1], 1);
6346 fn test_update_add_htlc_bolt2_sender_cltv_expiry_too_high() {
6347 //BOLT 2 Requirement: MUST set cltv_expiry less than 500000000.
6348 //It is enforced when constructing a route.
6349 let chanmon_cfgs = create_chanmon_cfgs(2);
6350 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6351 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6352 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6353 let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 0, InitFeatures::known(), InitFeatures::known());
6354 let logger = test_utils::TestLogger::new();
6356 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6358 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6359 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();
6360 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::RouteError { ref err },
6361 assert_eq!(err, &"Channel CLTV overflowed?"));
6365 fn test_update_add_htlc_bolt2_sender_exceed_max_htlc_num_and_htlc_id_increment() {
6366 //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.
6367 //BOLT 2 Requirement: for the first HTLC it offers MUST set id to 0.
6368 //BOLT 2 Requirement: MUST increase the value of id by 1 for each successive offer.
6369 let chanmon_cfgs = create_chanmon_cfgs(2);
6370 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6371 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6372 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6373 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 0, InitFeatures::known(), InitFeatures::known());
6374 let max_accepted_htlcs = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().counterparty_max_accepted_htlcs as u64;
6376 let logger = test_utils::TestLogger::new();
6377 for i in 0..max_accepted_htlcs {
6378 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6379 let payment_event = {
6380 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6381 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();
6382 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6383 check_added_monitors!(nodes[0], 1);
6385 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
6386 assert_eq!(events.len(), 1);
6387 if let MessageSendEvent::UpdateHTLCs { node_id: _, updates: msgs::CommitmentUpdate{ update_add_htlcs: ref htlcs, .. }, } = events[0] {
6388 assert_eq!(htlcs[0].htlc_id, i);
6392 SendEvent::from_event(events.remove(0))
6394 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6395 check_added_monitors!(nodes[1], 0);
6396 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6398 expect_pending_htlcs_forwardable!(nodes[1]);
6399 expect_payment_received!(nodes[1], our_payment_hash, our_payment_secret, 100000);
6401 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6402 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6403 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();
6404 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
6405 assert!(regex::Regex::new(r"Cannot push more than their max accepted HTLCs \(\d+\)").unwrap().is_match(err)));
6407 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6408 nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot push more than their max accepted HTLCs".to_string(), 1);
6412 fn test_update_add_htlc_bolt2_sender_exceed_max_htlc_value_in_flight() {
6413 //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.
6414 let chanmon_cfgs = create_chanmon_cfgs(2);
6415 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6416 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6417 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6418 let channel_value = 100000;
6419 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, channel_value, 0, InitFeatures::known(), InitFeatures::known());
6420 let max_in_flight = get_channel_value_stat!(nodes[0], chan.2).counterparty_max_htlc_value_in_flight_msat;
6422 send_payment(&nodes[0], &vec!(&nodes[1])[..], max_in_flight);
6424 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6425 // Manually create a route over our max in flight (which our router normally automatically
6427 let route = Route { paths: vec![vec![RouteHop {
6428 pubkey: nodes[1].node.get_our_node_id(), node_features: NodeFeatures::known(), channel_features: ChannelFeatures::known(),
6429 short_channel_id: nodes[1].node.list_usable_channels()[0].short_channel_id.unwrap(),
6430 fee_msat: max_in_flight + 1, cltv_expiry_delta: TEST_FINAL_CLTV
6432 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
6433 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)));
6435 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6436 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);
6438 send_payment(&nodes[0], &[&nodes[1]], max_in_flight);
6441 // BOLT 2 Requirements for the Receiver when handling an update_add_htlc message.
6443 fn test_update_add_htlc_bolt2_receiver_check_amount_received_more_than_min() {
6444 //BOLT2 Requirement: receiving an amount_msat equal to 0, OR less than its own htlc_minimum_msat -> SHOULD fail the channel.
6445 let chanmon_cfgs = create_chanmon_cfgs(2);
6446 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6447 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6448 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6449 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6450 let htlc_minimum_msat: u64;
6452 let chan_lock = nodes[0].node.channel_state.lock().unwrap();
6453 let channel = chan_lock.by_id.get(&chan.2).unwrap();
6454 htlc_minimum_msat = channel.get_holder_htlc_minimum_msat();
6457 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6458 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6459 let logger = test_utils::TestLogger::new();
6460 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();
6461 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6462 check_added_monitors!(nodes[0], 1);
6463 let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6464 updates.update_add_htlcs[0].amount_msat = htlc_minimum_msat-1;
6465 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6466 assert!(nodes[1].node.list_channels().is_empty());
6467 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6468 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()));
6469 check_added_monitors!(nodes[1], 1);
6473 fn test_update_add_htlc_bolt2_receiver_sender_can_afford_amount_sent() {
6474 //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
6475 let chanmon_cfgs = create_chanmon_cfgs(2);
6476 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6477 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6478 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6479 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6480 let logger = test_utils::TestLogger::new();
6482 let chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6483 let channel_reserve = chan_stat.channel_reserve_msat;
6484 let feerate = get_feerate!(nodes[0], chan.2);
6485 // The 2* and +1 are for the fee spike reserve.
6486 let commit_tx_fee_outbound = 2 * commit_tx_fee_msat(feerate, 1 + 1);
6488 let max_can_send = 5000000 - channel_reserve - commit_tx_fee_outbound;
6489 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6490 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6491 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();
6492 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6493 check_added_monitors!(nodes[0], 1);
6494 let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6496 // Even though channel-initiator senders are required to respect the fee_spike_reserve,
6497 // at this time channel-initiatee receivers are not required to enforce that senders
6498 // respect the fee_spike_reserve.
6499 updates.update_add_htlcs[0].amount_msat = max_can_send + commit_tx_fee_outbound + 1;
6500 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6502 assert!(nodes[1].node.list_channels().is_empty());
6503 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6504 assert_eq!(err_msg.data, "Remote HTLC add would put them under remote reserve value");
6505 check_added_monitors!(nodes[1], 1);
6509 fn test_update_add_htlc_bolt2_receiver_check_max_htlc_limit() {
6510 //BOLT 2 Requirement: if a sending node adds more than its max_accepted_htlcs HTLCs to its local commitment transaction: SHOULD fail the channel
6511 //BOLT 2 Requirement: MUST allow multiple HTLCs with the same payment_hash.
6512 let chanmon_cfgs = create_chanmon_cfgs(2);
6513 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6514 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6515 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6516 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6517 let logger = test_utils::TestLogger::new();
6519 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6520 let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
6522 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6523 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();
6525 let cur_height = nodes[0].node.best_block.read().unwrap().height() + 1;
6526 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::signing_only(), &route.paths[0], &session_priv).unwrap();
6527 let (onion_payloads, _htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 3999999, &Some(our_payment_secret), cur_height, &None).unwrap();
6528 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &our_payment_hash);
6530 let mut msg = msgs::UpdateAddHTLC {
6534 payment_hash: our_payment_hash,
6535 cltv_expiry: htlc_cltv,
6536 onion_routing_packet: onion_packet.clone(),
6539 for i in 0..super::channel::OUR_MAX_HTLCS {
6540 msg.htlc_id = i as u64;
6541 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
6543 msg.htlc_id = (super::channel::OUR_MAX_HTLCS) as u64;
6544 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
6546 assert!(nodes[1].node.list_channels().is_empty());
6547 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6548 assert!(regex::Regex::new(r"Remote tried to push more than our max accepted HTLCs \(\d+\)").unwrap().is_match(err_msg.data.as_str()));
6549 check_added_monitors!(nodes[1], 1);
6553 fn test_update_add_htlc_bolt2_receiver_check_max_in_flight_msat() {
6554 //OR adds more than its max_htlc_value_in_flight_msat worth of offered HTLCs to its local commitment transaction: SHOULD fail the channel
6555 let chanmon_cfgs = create_chanmon_cfgs(2);
6556 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6557 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6558 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6559 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
6560 let logger = test_utils::TestLogger::new();
6562 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6563 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6564 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();
6565 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6566 check_added_monitors!(nodes[0], 1);
6567 let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6568 updates.update_add_htlcs[0].amount_msat = get_channel_value_stat!(nodes[1], chan.2).counterparty_max_htlc_value_in_flight_msat + 1;
6569 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6571 assert!(nodes[1].node.list_channels().is_empty());
6572 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6573 assert!(regex::Regex::new("Remote HTLC add would put them over our max HTLC value").unwrap().is_match(err_msg.data.as_str()));
6574 check_added_monitors!(nodes[1], 1);
6578 fn test_update_add_htlc_bolt2_receiver_check_cltv_expiry() {
6579 //BOLT2 Requirement: if sending node sets cltv_expiry to greater or equal to 500000000: SHOULD fail the channel.
6580 let chanmon_cfgs = create_chanmon_cfgs(2);
6581 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6582 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6583 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6584 let logger = test_utils::TestLogger::new();
6586 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6587 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6588 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6589 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();
6590 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6591 check_added_monitors!(nodes[0], 1);
6592 let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6593 updates.update_add_htlcs[0].cltv_expiry = 500000000;
6594 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6596 assert!(nodes[1].node.list_channels().is_empty());
6597 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6598 assert_eq!(err_msg.data,"Remote provided CLTV expiry in seconds instead of block height");
6599 check_added_monitors!(nodes[1], 1);
6603 fn test_update_add_htlc_bolt2_receiver_check_repeated_id_ignore() {
6604 //BOLT 2 requirement: if the sender did not previously acknowledge the commitment of that HTLC: MUST ignore a repeated id value after a reconnection.
6605 // We test this by first testing that that repeated HTLCs pass commitment signature checks
6606 // after disconnect and that non-sequential htlc_ids result in a channel failure.
6607 let chanmon_cfgs = create_chanmon_cfgs(2);
6608 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6609 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6610 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6611 let logger = test_utils::TestLogger::new();
6613 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6614 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6615 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6616 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();
6617 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6618 check_added_monitors!(nodes[0], 1);
6619 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6620 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6622 //Disconnect and Reconnect
6623 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
6624 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
6625 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
6626 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
6627 assert_eq!(reestablish_1.len(), 1);
6628 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
6629 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
6630 assert_eq!(reestablish_2.len(), 1);
6631 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
6632 handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
6633 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
6634 handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
6637 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6638 assert_eq!(updates.commitment_signed.htlc_signatures.len(), 1);
6639 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &updates.commitment_signed);
6640 check_added_monitors!(nodes[1], 1);
6641 let _bs_responses = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6643 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6645 assert!(nodes[1].node.list_channels().is_empty());
6646 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6647 assert!(regex::Regex::new(r"Remote skipped HTLC ID \(skipped ID: \d+\)").unwrap().is_match(err_msg.data.as_str()));
6648 check_added_monitors!(nodes[1], 1);
6652 fn test_update_fulfill_htlc_bolt2_update_fulfill_htlc_before_commitment() {
6653 //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.
6655 let chanmon_cfgs = create_chanmon_cfgs(2);
6656 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6657 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6658 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6659 let logger = test_utils::TestLogger::new();
6660 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6661 let (our_payment_preimage, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6662 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6663 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();
6664 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6666 check_added_monitors!(nodes[0], 1);
6667 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6668 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6670 let update_msg = msgs::UpdateFulfillHTLC{
6673 payment_preimage: our_payment_preimage,
6676 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6678 assert!(nodes[0].node.list_channels().is_empty());
6679 let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6680 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()));
6681 check_added_monitors!(nodes[0], 1);
6685 fn test_update_fulfill_htlc_bolt2_update_fail_htlc_before_commitment() {
6686 //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.
6688 let chanmon_cfgs = create_chanmon_cfgs(2);
6689 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6690 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6691 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6692 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6693 let logger = test_utils::TestLogger::new();
6695 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6696 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6697 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();
6698 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6699 check_added_monitors!(nodes[0], 1);
6700 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6701 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6703 let update_msg = msgs::UpdateFailHTLC{
6706 reason: msgs::OnionErrorPacket { data: Vec::new()},
6709 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6711 assert!(nodes[0].node.list_channels().is_empty());
6712 let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6713 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()));
6714 check_added_monitors!(nodes[0], 1);
6718 fn test_update_fulfill_htlc_bolt2_update_fail_malformed_htlc_before_commitment() {
6719 //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.
6721 let chanmon_cfgs = create_chanmon_cfgs(2);
6722 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6723 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6724 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6725 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6726 let logger = test_utils::TestLogger::new();
6728 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6729 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6730 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();
6731 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6732 check_added_monitors!(nodes[0], 1);
6733 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6734 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6735 let update_msg = msgs::UpdateFailMalformedHTLC{
6738 sha256_of_onion: [1; 32],
6739 failure_code: 0x8000,
6742 nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6744 assert!(nodes[0].node.list_channels().is_empty());
6745 let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6746 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()));
6747 check_added_monitors!(nodes[0], 1);
6751 fn test_update_fulfill_htlc_bolt2_incorrect_htlc_id() {
6752 //BOLT 2 Requirement: A receiving node: if the id does not correspond to an HTLC in its current commitment transaction MUST fail the channel.
6754 let chanmon_cfgs = create_chanmon_cfgs(2);
6755 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6756 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6757 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6758 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6760 let our_payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 100000).0;
6762 nodes[1].node.claim_funds(our_payment_preimage);
6763 check_added_monitors!(nodes[1], 1);
6765 let events = nodes[1].node.get_and_clear_pending_msg_events();
6766 assert_eq!(events.len(), 1);
6767 let mut update_fulfill_msg: msgs::UpdateFulfillHTLC = {
6769 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, .. } } => {
6770 assert!(update_add_htlcs.is_empty());
6771 assert_eq!(update_fulfill_htlcs.len(), 1);
6772 assert!(update_fail_htlcs.is_empty());
6773 assert!(update_fail_malformed_htlcs.is_empty());
6774 assert!(update_fee.is_none());
6775 update_fulfill_htlcs[0].clone()
6777 _ => panic!("Unexpected event"),
6781 update_fulfill_msg.htlc_id = 1;
6783 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_msg);
6785 assert!(nodes[0].node.list_channels().is_empty());
6786 let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6787 assert_eq!(err_msg.data, "Remote tried to fulfill/fail an HTLC we couldn't find");
6788 check_added_monitors!(nodes[0], 1);
6792 fn test_update_fulfill_htlc_bolt2_wrong_preimage() {
6793 //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.
6795 let chanmon_cfgs = create_chanmon_cfgs(2);
6796 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6797 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6798 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6799 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6801 let our_payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 100000).0;
6803 nodes[1].node.claim_funds(our_payment_preimage);
6804 check_added_monitors!(nodes[1], 1);
6806 let events = nodes[1].node.get_and_clear_pending_msg_events();
6807 assert_eq!(events.len(), 1);
6808 let mut update_fulfill_msg: msgs::UpdateFulfillHTLC = {
6810 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, .. } } => {
6811 assert!(update_add_htlcs.is_empty());
6812 assert_eq!(update_fulfill_htlcs.len(), 1);
6813 assert!(update_fail_htlcs.is_empty());
6814 assert!(update_fail_malformed_htlcs.is_empty());
6815 assert!(update_fee.is_none());
6816 update_fulfill_htlcs[0].clone()
6818 _ => panic!("Unexpected event"),
6822 update_fulfill_msg.payment_preimage = PaymentPreimage([1; 32]);
6824 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_msg);
6826 assert!(nodes[0].node.list_channels().is_empty());
6827 let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6828 assert!(regex::Regex::new(r"Remote tried to fulfill HTLC \(\d+\) with an incorrect preimage").unwrap().is_match(err_msg.data.as_str()));
6829 check_added_monitors!(nodes[0], 1);
6833 fn test_update_fulfill_htlc_bolt2_missing_badonion_bit_for_malformed_htlc_message() {
6834 //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.
6836 let chanmon_cfgs = create_chanmon_cfgs(2);
6837 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6838 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6839 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6840 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
6841 let logger = test_utils::TestLogger::new();
6843 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6844 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6845 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 1000000, TEST_FINAL_CLTV, &logger).unwrap();
6846 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6847 check_added_monitors!(nodes[0], 1);
6849 let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6850 updates.update_add_htlcs[0].onion_routing_packet.version = 1; //Produce a malformed HTLC message
6852 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6853 check_added_monitors!(nodes[1], 0);
6854 commitment_signed_dance!(nodes[1], nodes[0], updates.commitment_signed, false, true);
6856 let events = nodes[1].node.get_and_clear_pending_msg_events();
6858 let mut update_msg: msgs::UpdateFailMalformedHTLC = {
6860 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, .. } } => {
6861 assert!(update_add_htlcs.is_empty());
6862 assert!(update_fulfill_htlcs.is_empty());
6863 assert!(update_fail_htlcs.is_empty());
6864 assert_eq!(update_fail_malformed_htlcs.len(), 1);
6865 assert!(update_fee.is_none());
6866 update_fail_malformed_htlcs[0].clone()
6868 _ => panic!("Unexpected event"),
6871 update_msg.failure_code &= !0x8000;
6872 nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6874 assert!(nodes[0].node.list_channels().is_empty());
6875 let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6876 assert_eq!(err_msg.data, "Got update_fail_malformed_htlc with BADONION not set");
6877 check_added_monitors!(nodes[0], 1);
6881 fn test_update_fulfill_htlc_bolt2_after_malformed_htlc_message_must_forward_update_fail_htlc() {
6882 //BOLT 2 Requirement: a receiving node which has an outgoing HTLC canceled by update_fail_malformed_htlc:
6883 // * 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.
6885 let chanmon_cfgs = create_chanmon_cfgs(3);
6886 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
6887 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
6888 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
6889 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
6890 create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
6891 let logger = test_utils::TestLogger::new();
6893 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[2]);
6896 let mut payment_event = {
6897 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6898 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();
6899 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6900 check_added_monitors!(nodes[0], 1);
6901 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
6902 assert_eq!(events.len(), 1);
6903 SendEvent::from_event(events.remove(0))
6905 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6906 check_added_monitors!(nodes[1], 0);
6907 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6908 expect_pending_htlcs_forwardable!(nodes[1]);
6909 let mut events_2 = nodes[1].node.get_and_clear_pending_msg_events();
6910 assert_eq!(events_2.len(), 1);
6911 check_added_monitors!(nodes[1], 1);
6912 payment_event = SendEvent::from_event(events_2.remove(0));
6913 assert_eq!(payment_event.msgs.len(), 1);
6916 payment_event.msgs[0].onion_routing_packet.version = 1; //Produce a malformed HTLC message
6917 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
6918 check_added_monitors!(nodes[2], 0);
6919 commitment_signed_dance!(nodes[2], nodes[1], payment_event.commitment_msg, false, true);
6921 let events_3 = nodes[2].node.get_and_clear_pending_msg_events();
6922 assert_eq!(events_3.len(), 1);
6923 let update_msg : (msgs::UpdateFailMalformedHTLC, msgs::CommitmentSigned) = {
6925 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 } } => {
6926 assert!(update_add_htlcs.is_empty());
6927 assert!(update_fulfill_htlcs.is_empty());
6928 assert!(update_fail_htlcs.is_empty());
6929 assert_eq!(update_fail_malformed_htlcs.len(), 1);
6930 assert!(update_fee.is_none());
6931 (update_fail_malformed_htlcs[0].clone(), commitment_signed.clone())
6933 _ => panic!("Unexpected event"),
6937 nodes[1].node.handle_update_fail_malformed_htlc(&nodes[2].node.get_our_node_id(), &update_msg.0);
6939 check_added_monitors!(nodes[1], 0);
6940 commitment_signed_dance!(nodes[1], nodes[2], update_msg.1, false, true);
6941 expect_pending_htlcs_forwardable!(nodes[1]);
6942 let events_4 = nodes[1].node.get_and_clear_pending_msg_events();
6943 assert_eq!(events_4.len(), 1);
6945 //Confirm that handlinge the update_malformed_htlc message produces an update_fail_htlc message to be forwarded back along the route
6947 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, .. } } => {
6948 assert!(update_add_htlcs.is_empty());
6949 assert!(update_fulfill_htlcs.is_empty());
6950 assert_eq!(update_fail_htlcs.len(), 1);
6951 assert!(update_fail_malformed_htlcs.is_empty());
6952 assert!(update_fee.is_none());
6954 _ => panic!("Unexpected event"),
6957 check_added_monitors!(nodes[1], 1);
6960 fn do_test_failure_delay_dust_htlc_local_commitment(announce_latest: bool) {
6961 // Dust-HTLC failure updates must be delayed until failure-trigger tx (in this case local commitment) reach ANTI_REORG_DELAY
6962 // 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
6963 // HTLC could have been removed from lastest local commitment tx but still valid until we get remote RAA
6965 let mut chanmon_cfgs = create_chanmon_cfgs(2);
6966 chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
6967 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6968 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6969 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6970 let chan =create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6972 let bs_dust_limit = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().holder_dust_limit_satoshis;
6974 // We route 2 dust-HTLCs between A and B
6975 let (_, payment_hash_1, _) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
6976 let (_, payment_hash_2, _) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
6977 route_payment(&nodes[0], &[&nodes[1]], 1000000);
6979 // Cache one local commitment tx as previous
6980 let as_prev_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
6982 // Fail one HTLC to prune it in the will-be-latest-local commitment tx
6983 assert!(nodes[1].node.fail_htlc_backwards(&payment_hash_2));
6984 check_added_monitors!(nodes[1], 0);
6985 expect_pending_htlcs_forwardable!(nodes[1]);
6986 check_added_monitors!(nodes[1], 1);
6988 let remove = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6989 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &remove.update_fail_htlcs[0]);
6990 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &remove.commitment_signed);
6991 check_added_monitors!(nodes[0], 1);
6993 // Cache one local commitment tx as lastest
6994 let as_last_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
6996 let events = nodes[0].node.get_and_clear_pending_msg_events();
6998 MessageSendEvent::SendRevokeAndACK { node_id, .. } => {
6999 assert_eq!(node_id, nodes[1].node.get_our_node_id());
7001 _ => panic!("Unexpected event"),
7004 MessageSendEvent::UpdateHTLCs { node_id, .. } => {
7005 assert_eq!(node_id, nodes[1].node.get_our_node_id());
7007 _ => panic!("Unexpected event"),
7010 assert_ne!(as_prev_commitment_tx, as_last_commitment_tx);
7011 // Fail the 2 dust-HTLCs, move their failure in maturation buffer (htlc_updated_waiting_threshold_conf)
7012 if announce_latest {
7013 mine_transaction(&nodes[0], &as_last_commitment_tx[0]);
7015 mine_transaction(&nodes[0], &as_prev_commitment_tx[0]);
7018 check_closed_broadcast!(nodes[0], true);
7019 check_added_monitors!(nodes[0], 1);
7021 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7022 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7023 let events = nodes[0].node.get_and_clear_pending_events();
7024 // Only 2 PaymentFailed events should show up, over-dust HTLC has to be failed by timeout tx
7025 assert_eq!(events.len(), 2);
7026 let mut first_failed = false;
7027 for event in events {
7029 Event::PaymentFailed { payment_hash, .. } => {
7030 if payment_hash == payment_hash_1 {
7031 assert!(!first_failed);
7032 first_failed = true;
7034 assert_eq!(payment_hash, payment_hash_2);
7037 _ => panic!("Unexpected event"),
7043 fn test_failure_delay_dust_htlc_local_commitment() {
7044 do_test_failure_delay_dust_htlc_local_commitment(true);
7045 do_test_failure_delay_dust_htlc_local_commitment(false);
7048 fn do_test_sweep_outbound_htlc_failure_update(revoked: bool, local: bool) {
7049 // Outbound HTLC-failure updates must be cancelled if we get a reorg before we reach ANTI_REORG_DELAY.
7050 // Broadcast of revoked remote commitment tx, trigger failure-update of dust/non-dust HTLCs
7051 // Broadcast of remote commitment tx, trigger failure-update of dust-HTLCs
7052 // Broadcast of timeout tx on remote commitment tx, trigger failure-udate of non-dust HTLCs
7053 // Broadcast of local commitment tx, trigger failure-update of dust-HTLCs
7054 // Broadcast of HTLC-timeout tx on local commitment tx, trigger failure-update of non-dust HTLCs
7056 let chanmon_cfgs = create_chanmon_cfgs(3);
7057 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7058 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
7059 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7060 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7062 let bs_dust_limit = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().holder_dust_limit_satoshis;
7064 let (_payment_preimage_1, dust_hash, _payment_secret_1) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
7065 let (_payment_preimage_2, non_dust_hash, _payment_secret_2) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
7067 let as_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
7068 let bs_commitment_tx = get_local_commitment_txn!(nodes[1], chan.2);
7070 // We revoked bs_commitment_tx
7072 let (payment_preimage_3, _, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
7073 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_3);
7076 let mut timeout_tx = Vec::new();
7078 // We fail dust-HTLC 1 by broadcast of local commitment tx
7079 mine_transaction(&nodes[0], &as_commitment_tx[0]);
7080 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7081 expect_payment_failed!(nodes[0], dust_hash, true);
7083 connect_blocks(&nodes[0], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS - ANTI_REORG_DELAY);
7084 check_closed_broadcast!(nodes[0], true);
7085 check_added_monitors!(nodes[0], 1);
7086 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7087 timeout_tx.push(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[1].clone());
7088 assert_eq!(timeout_tx[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
7089 // We fail non-dust-HTLC 2 by broadcast of local HTLC-timeout tx on local commitment tx
7090 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7091 mine_transaction(&nodes[0], &timeout_tx[0]);
7092 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7093 expect_payment_failed!(nodes[0], non_dust_hash, true);
7095 // We fail dust-HTLC 1 by broadcast of remote commitment tx. If revoked, fail also non-dust HTLC
7096 mine_transaction(&nodes[0], &bs_commitment_tx[0]);
7097 check_closed_broadcast!(nodes[0], true);
7098 check_added_monitors!(nodes[0], 1);
7099 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7100 connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
7101 timeout_tx.push(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[1].clone());
7103 expect_payment_failed!(nodes[0], dust_hash, true);
7104 assert_eq!(timeout_tx[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
7105 // We fail non-dust-HTLC 2 by broadcast of local timeout tx on remote commitment tx
7106 mine_transaction(&nodes[0], &timeout_tx[0]);
7107 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7108 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7109 expect_payment_failed!(nodes[0], non_dust_hash, true);
7111 // If revoked, both dust & non-dust HTLCs should have been failed after ANTI_REORG_DELAY confs of revoked
7113 let events = nodes[0].node.get_and_clear_pending_events();
7114 assert_eq!(events.len(), 2);
7117 Event::PaymentFailed { payment_hash, .. } => {
7118 if payment_hash == dust_hash { first = true; }
7119 else { first = false; }
7121 _ => panic!("Unexpected event"),
7124 Event::PaymentFailed { payment_hash, .. } => {
7125 if first { assert_eq!(payment_hash, non_dust_hash); }
7126 else { assert_eq!(payment_hash, dust_hash); }
7128 _ => panic!("Unexpected event"),
7135 fn test_sweep_outbound_htlc_failure_update() {
7136 do_test_sweep_outbound_htlc_failure_update(false, true);
7137 do_test_sweep_outbound_htlc_failure_update(false, false);
7138 do_test_sweep_outbound_htlc_failure_update(true, false);
7142 fn test_user_configurable_csv_delay() {
7143 // We test our channel constructors yield errors when we pass them absurd csv delay
7145 let mut low_our_to_self_config = UserConfig::default();
7146 low_our_to_self_config.own_channel_config.our_to_self_delay = 6;
7147 let mut high_their_to_self_config = UserConfig::default();
7148 high_their_to_self_config.peer_channel_config_limits.their_to_self_delay = 100;
7149 let user_cfgs = [Some(high_their_to_self_config.clone()), None];
7150 let chanmon_cfgs = create_chanmon_cfgs(2);
7151 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7152 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &user_cfgs);
7153 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7155 // We test config.our_to_self > BREAKDOWN_TIMEOUT is enforced in Channel::new_outbound()
7156 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(), &InitFeatures::known(), 1000000, 1000000, 0, &low_our_to_self_config) {
7158 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())); },
7159 _ => panic!("Unexpected event"),
7161 } else { assert!(false) }
7163 // We test config.our_to_self > BREAKDOWN_TIMEOUT is enforced in Channel::new_from_req()
7164 nodes[1].node.create_channel(nodes[0].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
7165 let mut open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
7166 open_channel.to_self_delay = 200;
7167 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) {
7169 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())); },
7170 _ => panic!("Unexpected event"),
7172 } else { assert!(false); }
7174 // We test msg.to_self_delay <= config.their_to_self_delay is enforced in Chanel::accept_channel()
7175 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
7176 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()));
7177 let mut accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
7178 accept_channel.to_self_delay = 200;
7179 nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &accept_channel);
7180 if let MessageSendEvent::HandleError { ref action, .. } = nodes[0].node.get_and_clear_pending_msg_events()[0] {
7182 &ErrorAction::SendErrorMessage { ref msg } => {
7183 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()));
7185 _ => { assert!(false); }
7187 } else { assert!(false); }
7189 // We test msg.to_self_delay <= config.their_to_self_delay is enforced in Channel::new_from_req()
7190 nodes[1].node.create_channel(nodes[0].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
7191 let mut open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
7192 open_channel.to_self_delay = 200;
7193 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) {
7195 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())); },
7196 _ => panic!("Unexpected event"),
7198 } else { assert!(false); }
7202 fn test_data_loss_protect() {
7203 // We want to be sure that :
7204 // * we don't broadcast our Local Commitment Tx in case of fallen behind
7205 // (but this is not quite true - we broadcast during Drop because chanmon is out of sync with chanmgr)
7206 // * we close channel in case of detecting other being fallen behind
7207 // * we are able to claim our own outputs thanks to to_remote being static
7208 // TODO: this test is incomplete and the data_loss_protect implementation is incomplete - see issue #775
7214 let mut chanmon_cfgs = create_chanmon_cfgs(2);
7215 // We broadcast during Drop because chanmon is out of sync with chanmgr, which would cause a panic
7216 // during signing due to revoked tx
7217 chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
7218 let keys_manager = &chanmon_cfgs[0].keys_manager;
7221 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7222 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7223 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7225 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7227 // Cache node A state before any channel update
7228 let previous_node_state = nodes[0].node.encode();
7229 let mut previous_chain_monitor_state = test_utils::TestVecWriter(Vec::new());
7230 nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut previous_chain_monitor_state).unwrap();
7232 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
7233 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
7235 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
7236 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
7238 // Restore node A from previous state
7239 logger = test_utils::TestLogger::with_id(format!("node {}", 0));
7240 let mut chain_monitor = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(&mut io::Cursor::new(previous_chain_monitor_state.0), keys_manager).unwrap().1;
7241 chain_source = test_utils::TestChainSource::new(Network::Testnet);
7242 tx_broadcaster = test_utils::TestBroadcaster{txn_broadcasted: Mutex::new(Vec::new()), blocks: Arc::new(Mutex::new(Vec::new()))};
7243 fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
7244 persister = test_utils::TestPersister::new();
7245 monitor = test_utils::TestChainMonitor::new(Some(&chain_source), &tx_broadcaster, &logger, &fee_estimator, &persister, keys_manager);
7247 let mut channel_monitors = HashMap::new();
7248 channel_monitors.insert(OutPoint { txid: chan.3.txid(), index: 0 }, &mut chain_monitor);
7249 <(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 {
7250 keys_manager: keys_manager,
7251 fee_estimator: &fee_estimator,
7252 chain_monitor: &monitor,
7254 tx_broadcaster: &tx_broadcaster,
7255 default_config: UserConfig::default(),
7259 nodes[0].node = &node_state_0;
7260 assert!(monitor.watch_channel(OutPoint { txid: chan.3.txid(), index: 0 }, chain_monitor).is_ok());
7261 nodes[0].chain_monitor = &monitor;
7262 nodes[0].chain_source = &chain_source;
7264 check_added_monitors!(nodes[0], 1);
7266 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7267 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7269 let reestablish_0 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
7271 // Check we don't broadcast any transactions following learning of per_commitment_point from B
7272 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_0[0]);
7273 check_added_monitors!(nodes[0], 1);
7276 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
7277 assert_eq!(node_txn.len(), 0);
7280 let mut reestablish_1 = Vec::with_capacity(1);
7281 for msg in nodes[0].node.get_and_clear_pending_msg_events() {
7282 if let MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } = msg {
7283 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
7284 reestablish_1.push(msg.clone());
7285 } else if let MessageSendEvent::BroadcastChannelUpdate { .. } = msg {
7286 } else if let MessageSendEvent::HandleError { ref action, .. } = msg {
7288 &ErrorAction::SendErrorMessage { ref msg } => {
7289 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");
7291 _ => panic!("Unexpected event!"),
7294 panic!("Unexpected event")
7298 // Check we close channel detecting A is fallen-behind
7299 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
7300 assert_eq!(check_closed_broadcast!(nodes[1], true).unwrap().data, "Peer attempted to reestablish channel with a very old local commitment transaction");
7301 check_added_monitors!(nodes[1], 1);
7304 // Check A is able to claim to_remote output
7305 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
7306 assert_eq!(node_txn.len(), 1);
7307 check_spends!(node_txn[0], chan.3);
7308 assert_eq!(node_txn[0].output.len(), 2);
7309 mine_transaction(&nodes[0], &node_txn[0]);
7310 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7311 let spend_txn = check_spendable_outputs!(nodes[0], node_cfgs[0].keys_manager);
7312 assert_eq!(spend_txn.len(), 1);
7313 check_spends!(spend_txn[0], node_txn[0]);
7317 fn test_check_htlc_underpaying() {
7318 // Send payment through A -> B but A is maliciously
7319 // sending a probe payment (i.e less than expected value0
7320 // to B, B should refuse payment.
7322 let chanmon_cfgs = create_chanmon_cfgs(2);
7323 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7324 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7325 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7327 // Create some initial channels
7328 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7330 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();
7331 let (_, our_payment_hash, _) = get_payment_preimage_hash!(nodes[0]);
7332 let our_payment_secret = nodes[1].node.create_inbound_payment_for_hash(our_payment_hash, Some(100_000), 7200, 0).unwrap();
7333 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
7334 check_added_monitors!(nodes[0], 1);
7336 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
7337 assert_eq!(events.len(), 1);
7338 let mut payment_event = SendEvent::from_event(events.pop().unwrap());
7339 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
7340 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
7342 // Note that we first have to wait a random delay before processing the receipt of the HTLC,
7343 // and then will wait a second random delay before failing the HTLC back:
7344 expect_pending_htlcs_forwardable!(nodes[1]);
7345 expect_pending_htlcs_forwardable!(nodes[1]);
7347 // Node 3 is expecting payment of 100_000 but received 10_000,
7348 // it should fail htlc like we didn't know the preimage.
7349 nodes[1].node.process_pending_htlc_forwards();
7351 let events = nodes[1].node.get_and_clear_pending_msg_events();
7352 assert_eq!(events.len(), 1);
7353 let (update_fail_htlc, commitment_signed) = match events[0] {
7354 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 } } => {
7355 assert!(update_add_htlcs.is_empty());
7356 assert!(update_fulfill_htlcs.is_empty());
7357 assert_eq!(update_fail_htlcs.len(), 1);
7358 assert!(update_fail_malformed_htlcs.is_empty());
7359 assert!(update_fee.is_none());
7360 (update_fail_htlcs[0].clone(), commitment_signed)
7362 _ => panic!("Unexpected event"),
7364 check_added_monitors!(nodes[1], 1);
7366 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlc);
7367 commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
7369 // 10_000 msat as u64, followed by a height of CHAN_CONFIRM_DEPTH as u32
7370 let mut expected_failure_data = byte_utils::be64_to_array(10_000).to_vec();
7371 expected_failure_data.extend_from_slice(&byte_utils::be32_to_array(CHAN_CONFIRM_DEPTH));
7372 expect_payment_failed!(nodes[0], our_payment_hash, true, 0x4000|15, &expected_failure_data[..]);
7376 fn test_announce_disable_channels() {
7377 // Create 2 channels between A and B. Disconnect B. Call timer_tick_occurred and check for generated
7378 // ChannelUpdate. Reconnect B, reestablish and check there is non-generated ChannelUpdate.
7380 let chanmon_cfgs = create_chanmon_cfgs(2);
7381 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7382 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7383 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7385 let short_id_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
7386 let short_id_2 = create_announced_chan_between_nodes(&nodes, 1, 0, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
7387 let short_id_3 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
7390 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
7391 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
7393 nodes[0].node.timer_tick_occurred(); // Enabled -> DisabledStaged
7394 nodes[0].node.timer_tick_occurred(); // DisabledStaged -> Disabled
7395 let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
7396 assert_eq!(msg_events.len(), 3);
7397 let mut chans_disabled: HashSet<u64> = [short_id_1, short_id_2, short_id_3].iter().map(|a| *a).collect();
7398 for e in msg_events {
7400 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
7401 assert_eq!(msg.contents.flags & (1<<1), 1<<1); // The "channel disabled" bit should be set
7402 // Check that each channel gets updated exactly once
7403 if !chans_disabled.remove(&msg.contents.short_channel_id) {
7404 panic!("Generated ChannelUpdate for wrong chan!");
7407 _ => panic!("Unexpected event"),
7411 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7412 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
7413 assert_eq!(reestablish_1.len(), 3);
7414 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7415 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
7416 assert_eq!(reestablish_2.len(), 3);
7418 // Reestablish chan_1
7419 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
7420 handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
7421 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
7422 handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
7423 // Reestablish chan_2
7424 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[1]);
7425 handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
7426 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[1]);
7427 handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
7428 // Reestablish chan_3
7429 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[2]);
7430 handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
7431 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[2]);
7432 handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
7434 nodes[0].node.timer_tick_occurred();
7435 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
7436 nodes[0].node.timer_tick_occurred();
7437 let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
7438 assert_eq!(msg_events.len(), 3);
7439 chans_disabled = [short_id_1, short_id_2, short_id_3].iter().map(|a| *a).collect();
7440 for e in msg_events {
7442 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
7443 assert_eq!(msg.contents.flags & (1<<1), 0); // The "channel disabled" bit should be off
7444 // Check that each channel gets updated exactly once
7445 if !chans_disabled.remove(&msg.contents.short_channel_id) {
7446 panic!("Generated ChannelUpdate for wrong chan!");
7449 _ => panic!("Unexpected event"),
7455 fn test_priv_forwarding_rejection() {
7456 // If we have a private channel with outbound liquidity, and
7457 // UserConfig::accept_forwards_to_priv_channels is set to false, we should reject any attempts
7458 // to forward through that channel.
7459 let chanmon_cfgs = create_chanmon_cfgs(3);
7460 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7461 let mut no_announce_cfg = test_default_channel_config();
7462 no_announce_cfg.channel_options.announced_channel = false;
7463 no_announce_cfg.accept_forwards_to_priv_channels = false;
7464 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, Some(no_announce_cfg), None]);
7465 let persister: test_utils::TestPersister;
7466 let new_chain_monitor: test_utils::TestChainMonitor;
7467 let nodes_1_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
7468 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7470 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1_000_000, 500_000_000, InitFeatures::known(), InitFeatures::known());
7472 // Note that the create_*_chan functions in utils requires announcement_signatures, which we do
7473 // not send for private channels.
7474 nodes[1].node.create_channel(nodes[2].node.get_our_node_id(), 1_000_000, 500_000_000, 42, None).unwrap();
7475 let open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[2].node.get_our_node_id());
7476 nodes[2].node.handle_open_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &open_channel);
7477 let accept_channel = get_event_msg!(nodes[2], MessageSendEvent::SendAcceptChannel, nodes[1].node.get_our_node_id());
7478 nodes[1].node.handle_accept_channel(&nodes[2].node.get_our_node_id(), InitFeatures::known(), &accept_channel);
7480 let (temporary_channel_id, tx, _) = create_funding_transaction(&nodes[1], 1_000_000, 42);
7481 nodes[1].node.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
7482 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()));
7483 check_added_monitors!(nodes[2], 1);
7485 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()));
7486 check_added_monitors!(nodes[1], 1);
7488 let conf_height = core::cmp::max(nodes[1].best_block_info().1 + 1, nodes[2].best_block_info().1 + 1);
7489 confirm_transaction_at(&nodes[1], &tx, conf_height);
7490 connect_blocks(&nodes[1], CHAN_CONFIRM_DEPTH - 1);
7491 confirm_transaction_at(&nodes[2], &tx, conf_height);
7492 connect_blocks(&nodes[2], CHAN_CONFIRM_DEPTH - 1);
7493 let as_funding_locked = get_event_msg!(nodes[1], MessageSendEvent::SendFundingLocked, nodes[2].node.get_our_node_id());
7494 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()));
7495 get_event_msg!(nodes[1], MessageSendEvent::SendChannelUpdate, nodes[2].node.get_our_node_id());
7496 nodes[2].node.handle_funding_locked(&nodes[1].node.get_our_node_id(), &as_funding_locked);
7497 get_event_msg!(nodes[2], MessageSendEvent::SendChannelUpdate, nodes[1].node.get_our_node_id());
7499 assert!(nodes[0].node.list_usable_channels()[0].is_public);
7500 assert_eq!(nodes[1].node.list_usable_channels().len(), 2);
7501 assert!(!nodes[2].node.list_usable_channels()[0].is_public);
7503 // We should always be able to forward through nodes[1] as long as its out through a public
7505 send_payment(&nodes[2], &[&nodes[1], &nodes[0]], 10_000);
7507 // ... however, if we send to nodes[2], we will have to pass the private channel from nodes[1]
7508 // to nodes[2], which should be rejected:
7509 let (our_payment_preimage, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[2]);
7510 let route = get_route(&nodes[0].node.get_our_node_id(),
7511 &nodes[0].net_graph_msg_handler.network_graph.read().unwrap(),
7512 &nodes[2].node.get_our_node_id(), Some(InvoiceFeatures::known()), None,
7513 &[&RouteHint(vec![RouteHintHop {
7514 src_node_id: nodes[1].node.get_our_node_id(),
7515 short_channel_id: nodes[2].node.list_channels()[0].short_channel_id.unwrap(),
7516 fees: RoutingFees { base_msat: 1000, proportional_millionths: 0 },
7517 cltv_expiry_delta: MIN_CLTV_EXPIRY_DELTA,
7518 htlc_minimum_msat: None,
7519 htlc_maximum_msat: None,
7520 }])], 10_000, TEST_FINAL_CLTV, nodes[0].logger).unwrap();
7522 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
7523 check_added_monitors!(nodes[0], 1);
7524 let payment_event = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
7525 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
7526 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false, true);
7528 let htlc_fail_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
7529 assert!(htlc_fail_updates.update_add_htlcs.is_empty());
7530 assert_eq!(htlc_fail_updates.update_fail_htlcs.len(), 1);
7531 assert!(htlc_fail_updates.update_fail_malformed_htlcs.is_empty());
7532 assert!(htlc_fail_updates.update_fee.is_none());
7534 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_fail_updates.update_fail_htlcs[0]);
7535 commitment_signed_dance!(nodes[0], nodes[1], htlc_fail_updates.commitment_signed, true, true);
7536 expect_payment_failed!(nodes[0], our_payment_hash, false);
7537 expect_payment_failure_chan_update!(nodes[0], nodes[2].node.list_channels()[0].short_channel_id.unwrap(), true);
7539 // Now disconnect nodes[1] from its peers and restart with accept_forwards_to_priv_channels set
7540 // to true. Sadly there is currently no way to change it at runtime.
7542 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
7543 nodes[2].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
7545 let nodes_1_serialized = nodes[1].node.encode();
7546 let mut monitor_a_serialized = test_utils::TestVecWriter(Vec::new());
7547 let mut monitor_b_serialized = test_utils::TestVecWriter(Vec::new());
7549 let mons = nodes[1].chain_monitor.chain_monitor.monitors.read().unwrap();
7550 let mut mon_iter = mons.iter();
7551 mon_iter.next().unwrap().1.write(&mut monitor_a_serialized).unwrap();
7552 mon_iter.next().unwrap().1.write(&mut monitor_b_serialized).unwrap();
7555 persister = test_utils::TestPersister::new();
7556 let keys_manager = &chanmon_cfgs[1].keys_manager;
7557 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);
7558 nodes[1].chain_monitor = &new_chain_monitor;
7560 let mut monitor_a_read = &monitor_a_serialized.0[..];
7561 let mut monitor_b_read = &monitor_b_serialized.0[..];
7562 let (_, mut monitor_a) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(&mut monitor_a_read, keys_manager).unwrap();
7563 let (_, mut monitor_b) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(&mut monitor_b_read, keys_manager).unwrap();
7564 assert!(monitor_a_read.is_empty());
7565 assert!(monitor_b_read.is_empty());
7567 no_announce_cfg.accept_forwards_to_priv_channels = true;
7569 let mut nodes_1_read = &nodes_1_serialized[..];
7570 let (_, nodes_1_deserialized_tmp) = {
7571 let mut channel_monitors = HashMap::new();
7572 channel_monitors.insert(monitor_a.get_funding_txo().0, &mut monitor_a);
7573 channel_monitors.insert(monitor_b.get_funding_txo().0, &mut monitor_b);
7574 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_1_read, ChannelManagerReadArgs {
7575 default_config: no_announce_cfg,
7577 fee_estimator: node_cfgs[1].fee_estimator,
7578 chain_monitor: nodes[1].chain_monitor,
7579 tx_broadcaster: nodes[1].tx_broadcaster.clone(),
7580 logger: nodes[1].logger,
7584 assert!(nodes_1_read.is_empty());
7585 nodes_1_deserialized = nodes_1_deserialized_tmp;
7587 assert!(nodes[1].chain_monitor.watch_channel(monitor_a.get_funding_txo().0, monitor_a).is_ok());
7588 assert!(nodes[1].chain_monitor.watch_channel(monitor_b.get_funding_txo().0, monitor_b).is_ok());
7589 check_added_monitors!(nodes[1], 2);
7590 nodes[1].node = &nodes_1_deserialized;
7592 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::known() });
7593 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7594 let as_reestablish = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
7595 let bs_reestablish = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
7596 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &as_reestablish);
7597 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &bs_reestablish);
7598 get_event_msg!(nodes[0], MessageSendEvent::SendChannelUpdate, nodes[1].node.get_our_node_id());
7599 get_event_msg!(nodes[1], MessageSendEvent::SendChannelUpdate, nodes[0].node.get_our_node_id());
7601 nodes[1].node.peer_connected(&nodes[2].node.get_our_node_id(), &msgs::Init { features: InitFeatures::known() });
7602 nodes[2].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7603 let bs_reestablish = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[2].node.get_our_node_id());
7604 let cs_reestablish = get_event_msg!(nodes[2], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
7605 nodes[2].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &bs_reestablish);
7606 nodes[1].node.handle_channel_reestablish(&nodes[2].node.get_our_node_id(), &cs_reestablish);
7607 get_event_msg!(nodes[1], MessageSendEvent::SendChannelUpdate, nodes[2].node.get_our_node_id());
7608 get_event_msg!(nodes[2], MessageSendEvent::SendChannelUpdate, nodes[1].node.get_our_node_id());
7610 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
7611 check_added_monitors!(nodes[0], 1);
7612 pass_along_route(&nodes[0], &[&[&nodes[1], &nodes[2]]], 10_000, our_payment_hash, our_payment_secret);
7613 claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], our_payment_preimage);
7617 fn test_bump_penalty_txn_on_revoked_commitment() {
7618 // In case of penalty txn with too low feerates for getting into mempools, RBF-bump them to be sure
7619 // we're able to claim outputs on revoked commitment transaction before timelocks expiration
7621 let chanmon_cfgs = create_chanmon_cfgs(2);
7622 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7623 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7624 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7626 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
7627 let logger = test_utils::TestLogger::new();
7629 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
7630 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
7631 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();
7632 send_along_route(&nodes[1], route, &vec!(&nodes[0])[..], 3000000);
7634 let revoked_txn = get_local_commitment_txn!(nodes[0], chan.2);
7635 // Revoked commitment txn with 4 outputs : to_local, to_remote, 1 outgoing HTLC, 1 incoming HTLC
7636 assert_eq!(revoked_txn[0].output.len(), 4);
7637 assert_eq!(revoked_txn[0].input.len(), 1);
7638 assert_eq!(revoked_txn[0].input[0].previous_output.txid, chan.3.txid());
7639 let revoked_txid = revoked_txn[0].txid();
7641 let mut penalty_sum = 0;
7642 for outp in revoked_txn[0].output.iter() {
7643 if outp.script_pubkey.is_v0_p2wsh() {
7644 penalty_sum += outp.value;
7648 // Connect blocks to change height_timer range to see if we use right soonest_timelock
7649 let header_114 = connect_blocks(&nodes[1], 14);
7651 // Actually revoke tx by claiming a HTLC
7652 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
7653 let header = BlockHeader { version: 0x20000000, prev_blockhash: header_114, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7654 connect_block(&nodes[1], &Block { header, txdata: vec![revoked_txn[0].clone()] });
7655 check_added_monitors!(nodes[1], 1);
7657 // One or more justice tx should have been broadcast, check it
7661 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7662 assert_eq!(node_txn.len(), 2); // justice tx (broadcasted from ChannelMonitor) + local commitment tx
7663 assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
7664 assert_eq!(node_txn[0].output.len(), 1);
7665 check_spends!(node_txn[0], revoked_txn[0]);
7666 let fee_1 = penalty_sum - node_txn[0].output[0].value;
7667 feerate_1 = fee_1 * 1000 / node_txn[0].get_weight() as u64;
7668 penalty_1 = node_txn[0].txid();
7672 // After exhaustion of height timer, a new bumped justice tx should have been broadcast, check it
7673 connect_blocks(&nodes[1], 15);
7674 let mut penalty_2 = penalty_1;
7675 let mut feerate_2 = 0;
7677 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7678 assert_eq!(node_txn.len(), 1);
7679 if node_txn[0].input[0].previous_output.txid == revoked_txid {
7680 assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
7681 assert_eq!(node_txn[0].output.len(), 1);
7682 check_spends!(node_txn[0], revoked_txn[0]);
7683 penalty_2 = node_txn[0].txid();
7684 // Verify new bumped tx is different from last claiming transaction, we don't want spurrious rebroadcast
7685 assert_ne!(penalty_2, penalty_1);
7686 let fee_2 = penalty_sum - node_txn[0].output[0].value;
7687 feerate_2 = fee_2 * 1000 / node_txn[0].get_weight() as u64;
7688 // Verify 25% bump heuristic
7689 assert!(feerate_2 * 100 >= feerate_1 * 125);
7693 assert_ne!(feerate_2, 0);
7695 // After exhaustion of height timer for a 2nd time, a new bumped justice tx should have been broadcast, check it
7696 connect_blocks(&nodes[1], 1);
7698 let mut feerate_3 = 0;
7700 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7701 assert_eq!(node_txn.len(), 1);
7702 if node_txn[0].input[0].previous_output.txid == revoked_txid {
7703 assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
7704 assert_eq!(node_txn[0].output.len(), 1);
7705 check_spends!(node_txn[0], revoked_txn[0]);
7706 penalty_3 = node_txn[0].txid();
7707 // Verify new bumped tx is different from last claiming transaction, we don't want spurrious rebroadcast
7708 assert_ne!(penalty_3, penalty_2);
7709 let fee_3 = penalty_sum - node_txn[0].output[0].value;
7710 feerate_3 = fee_3 * 1000 / node_txn[0].get_weight() as u64;
7711 // Verify 25% bump heuristic
7712 assert!(feerate_3 * 100 >= feerate_2 * 125);
7716 assert_ne!(feerate_3, 0);
7718 nodes[1].node.get_and_clear_pending_events();
7719 nodes[1].node.get_and_clear_pending_msg_events();
7723 fn test_bump_penalty_txn_on_revoked_htlcs() {
7724 // In case of penalty txn with too low feerates for getting into mempools, RBF-bump them to sure
7725 // we're able to claim outputs on revoked HTLC transactions before timelocks expiration
7727 let mut chanmon_cfgs = create_chanmon_cfgs(2);
7728 chanmon_cfgs[1].keys_manager.disable_revocation_policy_check = true;
7729 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7730 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7731 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7733 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
7734 // Lock HTLC in both directions (using a slightly lower CLTV delay to provide timely RBF bumps)
7735 let route = get_route(&nodes[0].node.get_our_node_id(), &nodes[0].net_graph_msg_handler.network_graph.read().unwrap(),
7736 &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 3_000_000, 50, nodes[0].logger).unwrap();
7737 let payment_preimage = send_along_route(&nodes[0], route, &[&nodes[1]], 3_000_000).0;
7738 let route = get_route(&nodes[1].node.get_our_node_id(), &nodes[1].net_graph_msg_handler.network_graph.read().unwrap(),
7739 &nodes[0].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 3_000_000, 50, nodes[0].logger).unwrap();
7740 send_along_route(&nodes[1], route, &[&nodes[0]], 3_000_000);
7742 let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan.2);
7743 assert_eq!(revoked_local_txn[0].input.len(), 1);
7744 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
7746 // Revoke local commitment tx
7747 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
7749 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7750 // B will generate both revoked HTLC-timeout/HTLC-preimage txn from revoked commitment tx
7751 connect_block(&nodes[1], &Block { header, txdata: vec![revoked_local_txn[0].clone()] });
7752 check_closed_broadcast!(nodes[1], true);
7753 check_added_monitors!(nodes[1], 1);
7754 connect_blocks(&nodes[1], 49); // Confirm blocks until the HTLC expires (note CLTV was explicitly 50 above)
7756 let revoked_htlc_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7757 assert_eq!(revoked_htlc_txn.len(), 3);
7758 check_spends!(revoked_htlc_txn[1], chan.3);
7760 assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
7761 assert_eq!(revoked_htlc_txn[0].input.len(), 1);
7762 check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
7764 assert_eq!(revoked_htlc_txn[2].input.len(), 1);
7765 assert_eq!(revoked_htlc_txn[2].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
7766 assert_eq!(revoked_htlc_txn[2].output.len(), 1);
7767 check_spends!(revoked_htlc_txn[2], revoked_local_txn[0]);
7769 // Broadcast set of revoked txn on A
7770 let hash_128 = connect_blocks(&nodes[0], 40);
7771 let header_11 = BlockHeader { version: 0x20000000, prev_blockhash: hash_128, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7772 connect_block(&nodes[0], &Block { header: header_11, txdata: vec![revoked_local_txn[0].clone()] });
7773 let header_129 = BlockHeader { version: 0x20000000, prev_blockhash: header_11.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7774 connect_block(&nodes[0], &Block { header: header_129, txdata: vec![revoked_htlc_txn[0].clone(), revoked_htlc_txn[2].clone()] });
7775 expect_pending_htlcs_forwardable_ignore!(nodes[0]);
7780 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7781 assert_eq!(node_txn.len(), 5); // 3 penalty txn on revoked commitment tx + A commitment tx + 1 penalty tnx on revoked HTLC txn
7782 // Verify claim tx are spending revoked HTLC txn
7784 // node_txn 0-2 each spend a separate revoked output from revoked_local_txn[0]
7785 // Note that node_txn[0] and node_txn[1] are bogus - they double spend the revoked_htlc_txn
7786 // which are included in the same block (they are broadcasted because we scan the
7787 // transactions linearly and generate claims as we go, they likely should be removed in the
7789 assert_eq!(node_txn[0].input.len(), 1);
7790 check_spends!(node_txn[0], revoked_local_txn[0]);
7791 assert_eq!(node_txn[1].input.len(), 1);
7792 check_spends!(node_txn[1], revoked_local_txn[0]);
7793 assert_eq!(node_txn[2].input.len(), 1);
7794 check_spends!(node_txn[2], revoked_local_txn[0]);
7796 // Each of the three justice transactions claim a separate (single) output of the three
7797 // available, which we check here:
7798 assert_ne!(node_txn[0].input[0].previous_output, node_txn[1].input[0].previous_output);
7799 assert_ne!(node_txn[0].input[0].previous_output, node_txn[2].input[0].previous_output);
7800 assert_ne!(node_txn[1].input[0].previous_output, node_txn[2].input[0].previous_output);
7802 assert_eq!(node_txn[0].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
7803 assert_eq!(node_txn[1].input[0].previous_output, revoked_htlc_txn[2].input[0].previous_output);
7805 // node_txn[3] is the local commitment tx broadcast just because (and somewhat in case of
7806 // reorgs, though its not clear its ever worth broadcasting conflicting txn like this when
7807 // a remote commitment tx has already been confirmed).
7808 check_spends!(node_txn[3], chan.3);
7810 // node_txn[4] spends the revoked outputs from the revoked_htlc_txn (which only have one
7811 // output, checked above).
7812 assert_eq!(node_txn[4].input.len(), 2);
7813 assert_eq!(node_txn[4].output.len(), 1);
7814 check_spends!(node_txn[4], revoked_htlc_txn[0], revoked_htlc_txn[2]);
7816 first = node_txn[4].txid();
7817 // Store both feerates for later comparison
7818 let fee_1 = revoked_htlc_txn[0].output[0].value + revoked_htlc_txn[2].output[0].value - node_txn[4].output[0].value;
7819 feerate_1 = fee_1 * 1000 / node_txn[4].get_weight() as u64;
7820 penalty_txn = vec![node_txn[2].clone()];
7824 // Connect one more block to see if bumped penalty are issued for HTLC txn
7825 let header_130 = BlockHeader { version: 0x20000000, prev_blockhash: header_129.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7826 connect_block(&nodes[0], &Block { header: header_130, txdata: penalty_txn });
7827 let header_131 = BlockHeader { version: 0x20000000, prev_blockhash: header_130.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7828 connect_block(&nodes[0], &Block { header: header_131, txdata: Vec::new() });
7830 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7831 assert_eq!(node_txn.len(), 2); // 2 bumped penalty txn on revoked commitment tx
7833 check_spends!(node_txn[0], revoked_local_txn[0]);
7834 check_spends!(node_txn[1], revoked_local_txn[0]);
7835 // Note that these are both bogus - they spend outputs already claimed in block 129:
7836 if node_txn[0].input[0].previous_output == revoked_htlc_txn[0].input[0].previous_output {
7837 assert_eq!(node_txn[1].input[0].previous_output, revoked_htlc_txn[2].input[0].previous_output);
7839 assert_eq!(node_txn[0].input[0].previous_output, revoked_htlc_txn[2].input[0].previous_output);
7840 assert_eq!(node_txn[1].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
7846 // Few more blocks to confirm penalty txn
7847 connect_blocks(&nodes[0], 4);
7848 assert!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
7849 let header_144 = connect_blocks(&nodes[0], 9);
7851 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7852 assert_eq!(node_txn.len(), 1);
7854 assert_eq!(node_txn[0].input.len(), 2);
7855 check_spends!(node_txn[0], revoked_htlc_txn[0], revoked_htlc_txn[2]);
7856 // Verify bumped tx is different and 25% bump heuristic
7857 assert_ne!(first, node_txn[0].txid());
7858 let fee_2 = revoked_htlc_txn[0].output[0].value + revoked_htlc_txn[2].output[0].value - node_txn[0].output[0].value;
7859 let feerate_2 = fee_2 * 1000 / node_txn[0].get_weight() as u64;
7860 assert!(feerate_2 * 100 > feerate_1 * 125);
7861 let txn = vec![node_txn[0].clone()];
7865 // Broadcast claim txn and confirm blocks to avoid further bumps on this outputs
7866 let header_145 = BlockHeader { version: 0x20000000, prev_blockhash: header_144, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7867 connect_block(&nodes[0], &Block { header: header_145, txdata: node_txn });
7868 connect_blocks(&nodes[0], 20);
7870 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7871 // We verify than no new transaction has been broadcast because previously
7872 // we were buggy on this exact behavior by not tracking for monitoring remote HTLC outputs (see #411)
7873 // which means we wouldn't see a spend of them by a justice tx and bumped justice tx
7874 // were generated forever instead of safe cleaning after confirmation and ANTI_REORG_SAFE_DELAY blocks.
7875 // Enforce spending of revoked htlc output by claiming transaction remove request as expected and dry
7876 // up bumped justice generation.
7877 assert_eq!(node_txn.len(), 0);
7880 check_closed_broadcast!(nodes[0], true);
7881 check_added_monitors!(nodes[0], 1);
7885 fn test_bump_penalty_txn_on_remote_commitment() {
7886 // In case of claim txn with too low feerates for getting into mempools, RBF-bump them to be sure
7887 // we're able to claim outputs on remote commitment transaction before timelocks expiration
7890 // Provide preimage for one
7891 // Check aggregation
7893 let chanmon_cfgs = create_chanmon_cfgs(2);
7894 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7895 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7896 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7898 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
7899 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
7900 route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000).0;
7902 // Remote commitment txn with 4 outputs : to_local, to_remote, 1 outgoing HTLC, 1 incoming HTLC
7903 let remote_txn = get_local_commitment_txn!(nodes[0], chan.2);
7904 assert_eq!(remote_txn[0].output.len(), 4);
7905 assert_eq!(remote_txn[0].input.len(), 1);
7906 assert_eq!(remote_txn[0].input[0].previous_output.txid, chan.3.txid());
7908 // Claim a HTLC without revocation (provide B monitor with preimage)
7909 nodes[1].node.claim_funds(payment_preimage);
7910 mine_transaction(&nodes[1], &remote_txn[0]);
7911 check_added_monitors!(nodes[1], 2);
7912 connect_blocks(&nodes[1], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
7914 // One or more claim tx should have been broadcast, check it
7918 let feerate_timeout;
7919 let feerate_preimage;
7921 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7922 // 9 transactions including:
7923 // 1*2 ChannelManager local broadcasts of commitment + HTLC-Success
7924 // 1*3 ChannelManager local broadcasts of commitment + HTLC-Success + HTLC-Timeout
7925 // 2 * HTLC-Success (one RBF bump we'll check later)
7927 assert_eq!(node_txn.len(), 8);
7928 assert_eq!(node_txn[0].input.len(), 1);
7929 assert_eq!(node_txn[6].input.len(), 1);
7930 check_spends!(node_txn[0], remote_txn[0]);
7931 check_spends!(node_txn[6], remote_txn[0]);
7932 assert_eq!(node_txn[0].input[0].previous_output, node_txn[3].input[0].previous_output);
7933 preimage_bump = node_txn[3].clone();
7935 check_spends!(node_txn[1], chan.3);
7936 check_spends!(node_txn[2], node_txn[1]);
7937 assert_eq!(node_txn[1], node_txn[4]);
7938 assert_eq!(node_txn[2], node_txn[5]);
7940 timeout = node_txn[6].txid();
7941 let index = node_txn[6].input[0].previous_output.vout;
7942 let fee = remote_txn[0].output[index as usize].value - node_txn[6].output[0].value;
7943 feerate_timeout = fee * 1000 / node_txn[6].get_weight() as u64;
7945 preimage = node_txn[0].txid();
7946 let index = node_txn[0].input[0].previous_output.vout;
7947 let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
7948 feerate_preimage = fee * 1000 / node_txn[0].get_weight() as u64;
7952 assert_ne!(feerate_timeout, 0);
7953 assert_ne!(feerate_preimage, 0);
7955 // After exhaustion of height timer, new bumped claim txn should have been broadcast, check it
7956 connect_blocks(&nodes[1], 15);
7958 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7959 assert_eq!(node_txn.len(), 1);
7960 assert_eq!(node_txn[0].input.len(), 1);
7961 assert_eq!(preimage_bump.input.len(), 1);
7962 check_spends!(node_txn[0], remote_txn[0]);
7963 check_spends!(preimage_bump, remote_txn[0]);
7965 let index = preimage_bump.input[0].previous_output.vout;
7966 let fee = remote_txn[0].output[index as usize].value - preimage_bump.output[0].value;
7967 let new_feerate = fee * 1000 / preimage_bump.get_weight() as u64;
7968 assert!(new_feerate * 100 > feerate_timeout * 125);
7969 assert_ne!(timeout, preimage_bump.txid());
7971 let index = node_txn[0].input[0].previous_output.vout;
7972 let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
7973 let new_feerate = fee * 1000 / node_txn[0].get_weight() as u64;
7974 assert!(new_feerate * 100 > feerate_preimage * 125);
7975 assert_ne!(preimage, node_txn[0].txid());
7980 nodes[1].node.get_and_clear_pending_events();
7981 nodes[1].node.get_and_clear_pending_msg_events();
7985 fn test_counterparty_raa_skip_no_crash() {
7986 // Previously, if our counterparty sent two RAAs in a row without us having provided a
7987 // commitment transaction, we would have happily carried on and provided them the next
7988 // commitment transaction based on one RAA forward. This would probably eventually have led to
7989 // channel closure, but it would not have resulted in funds loss. Still, our
7990 // EnforcingSigner would have panicked as it doesn't like jumps into the future. Here, we
7991 // check simply that the channel is closed in response to such an RAA, but don't check whether
7992 // we decide to punish our counterparty for revoking their funds (as we don't currently
7994 let chanmon_cfgs = create_chanmon_cfgs(2);
7995 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7996 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7997 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7998 let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).2;
8000 let mut guard = nodes[0].node.channel_state.lock().unwrap();
8001 let keys = guard.by_id.get_mut(&channel_id).unwrap().get_signer();
8003 const INITIAL_COMMITMENT_NUMBER: u64 = (1 << 48) - 1;
8005 // Make signer believe we got a counterparty signature, so that it allows the revocation
8006 keys.get_enforcement_state().last_holder_commitment -= 1;
8007 let per_commitment_secret = keys.release_commitment_secret(INITIAL_COMMITMENT_NUMBER);
8009 // Must revoke without gaps
8010 keys.get_enforcement_state().last_holder_commitment -= 1;
8011 keys.release_commitment_secret(INITIAL_COMMITMENT_NUMBER - 1);
8013 keys.get_enforcement_state().last_holder_commitment -= 1;
8014 let next_per_commitment_point = PublicKey::from_secret_key(&Secp256k1::new(),
8015 &SecretKey::from_slice(&keys.release_commitment_secret(INITIAL_COMMITMENT_NUMBER - 2)).unwrap());
8017 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(),
8018 &msgs::RevokeAndACK { channel_id, per_commitment_secret, next_per_commitment_point });
8019 assert_eq!(check_closed_broadcast!(nodes[1], true).unwrap().data, "Received an unexpected revoke_and_ack");
8020 check_added_monitors!(nodes[1], 1);
8024 fn test_bump_txn_sanitize_tracking_maps() {
8025 // Sanitizing pendning_claim_request and claimable_outpoints used to be buggy,
8026 // verify we clean then right after expiration of ANTI_REORG_DELAY.
8028 let chanmon_cfgs = create_chanmon_cfgs(2);
8029 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8030 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8031 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8033 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
8034 // Lock HTLC in both directions
8035 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000).0;
8036 route_payment(&nodes[1], &vec!(&nodes[0])[..], 9_000_000).0;
8038 let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan.2);
8039 assert_eq!(revoked_local_txn[0].input.len(), 1);
8040 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
8042 // Revoke local commitment tx
8043 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
8045 // Broadcast set of revoked txn on A
8046 connect_blocks(&nodes[0], TEST_FINAL_CLTV + 2 - CHAN_CONFIRM_DEPTH);
8047 expect_pending_htlcs_forwardable_ignore!(nodes[0]);
8048 assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 0);
8050 mine_transaction(&nodes[0], &revoked_local_txn[0]);
8051 check_closed_broadcast!(nodes[0], true);
8052 check_added_monitors!(nodes[0], 1);
8054 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8055 assert_eq!(node_txn.len(), 4); //ChannelMonitor: justice txn * 3, ChannelManager: local commitment tx
8056 check_spends!(node_txn[0], revoked_local_txn[0]);
8057 check_spends!(node_txn[1], revoked_local_txn[0]);
8058 check_spends!(node_txn[2], revoked_local_txn[0]);
8059 let penalty_txn = vec![node_txn[0].clone(), node_txn[1].clone(), node_txn[2].clone()];
8063 let header_130 = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8064 connect_block(&nodes[0], &Block { header: header_130, txdata: penalty_txn });
8065 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
8067 let monitors = nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap();
8068 if let Some(monitor) = monitors.get(&OutPoint { txid: chan.3.txid(), index: 0 }) {
8069 assert!(monitor.inner.lock().unwrap().onchain_tx_handler.pending_claim_requests.is_empty());
8070 assert!(monitor.inner.lock().unwrap().onchain_tx_handler.claimable_outpoints.is_empty());
8076 fn test_override_channel_config() {
8077 let chanmon_cfgs = create_chanmon_cfgs(2);
8078 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8079 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8080 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8082 // Node0 initiates a channel to node1 using the override config.
8083 let mut override_config = UserConfig::default();
8084 override_config.own_channel_config.our_to_self_delay = 200;
8086 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 16_000_000, 12_000_000, 42, Some(override_config)).unwrap();
8088 // Assert the channel created by node0 is using the override config.
8089 let res = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8090 assert_eq!(res.channel_flags, 0);
8091 assert_eq!(res.to_self_delay, 200);
8095 fn test_override_0msat_htlc_minimum() {
8096 let mut zero_config = UserConfig::default();
8097 zero_config.own_channel_config.our_htlc_minimum_msat = 0;
8098 let chanmon_cfgs = create_chanmon_cfgs(2);
8099 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8100 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, Some(zero_config.clone())]);
8101 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8103 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 16_000_000, 12_000_000, 42, Some(zero_config)).unwrap();
8104 let res = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8105 assert_eq!(res.htlc_minimum_msat, 1);
8107 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &res);
8108 let res = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
8109 assert_eq!(res.htlc_minimum_msat, 1);
8113 fn test_simple_mpp() {
8114 // Simple test of sending a multi-path payment.
8115 let chanmon_cfgs = create_chanmon_cfgs(4);
8116 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
8117 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
8118 let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
8120 let chan_1_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8121 let chan_2_id = create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8122 let chan_3_id = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8123 let chan_4_id = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8124 let logger = test_utils::TestLogger::new();
8126 let (payment_preimage, payment_hash, payment_secret) = get_payment_preimage_hash!(&nodes[3]);
8127 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
8128 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();
8129 let path = route.paths[0].clone();
8130 route.paths.push(path);
8131 route.paths[0][0].pubkey = nodes[1].node.get_our_node_id();
8132 route.paths[0][0].short_channel_id = chan_1_id;
8133 route.paths[0][1].short_channel_id = chan_3_id;
8134 route.paths[1][0].pubkey = nodes[2].node.get_our_node_id();
8135 route.paths[1][0].short_channel_id = chan_2_id;
8136 route.paths[1][1].short_channel_id = chan_4_id;
8137 send_along_route_with_secret(&nodes[0], route, &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], 200_000, payment_hash, payment_secret);
8138 claim_payment_along_route(&nodes[0], &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], false, payment_preimage);
8142 fn test_preimage_storage() {
8143 // Simple test of payment preimage storage allowing no client-side storage to claim payments
8144 let chanmon_cfgs = create_chanmon_cfgs(2);
8145 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8146 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8147 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8149 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8152 let (payment_hash, payment_secret) = nodes[1].node.create_inbound_payment(Some(100_000), 7200, 42);
8154 let logger = test_utils::TestLogger::new();
8155 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
8156 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();
8157 nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
8158 check_added_monitors!(nodes[0], 1);
8159 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
8160 let mut payment_event = SendEvent::from_event(events.pop().unwrap());
8161 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
8162 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
8164 // Note that after leaving the above scope we have no knowledge of any arguments or return
8165 // values from previous calls.
8166 expect_pending_htlcs_forwardable!(nodes[1]);
8167 let events = nodes[1].node.get_and_clear_pending_events();
8168 assert_eq!(events.len(), 1);
8170 Event::PaymentReceived { ref purpose, .. } => {
8172 PaymentPurpose::InvoicePayment { payment_preimage, user_payment_id, .. } => {
8173 assert_eq!(*user_payment_id, 42);
8174 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage.unwrap());
8176 _ => panic!("expected PaymentPurpose::InvoicePayment")
8179 _ => panic!("Unexpected event"),
8184 fn test_secret_timeout() {
8185 // Simple test of payment secret storage time outs
8186 let chanmon_cfgs = create_chanmon_cfgs(2);
8187 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8188 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8189 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8191 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8193 let (payment_hash, payment_secret_1) = nodes[1].node.create_inbound_payment(Some(100_000), 2, 0);
8195 // We should fail to register the same payment hash twice, at least until we've connected a
8196 // block with time 7200 + CHAN_CONFIRM_DEPTH + 1.
8197 if let Err(APIError::APIMisuseError { err }) = nodes[1].node.create_inbound_payment_for_hash(payment_hash, Some(100_000), 2, 0) {
8198 assert_eq!(err, "Duplicate payment hash");
8199 } else { panic!(); }
8201 let node_1_blocks = nodes[1].blocks.lock().unwrap();
8203 header: BlockHeader {
8205 prev_blockhash: node_1_blocks.last().unwrap().0.block_hash(),
8206 merkle_root: Default::default(),
8207 time: node_1_blocks.len() as u32 + 7200, bits: 42, nonce: 42 },
8211 connect_block(&nodes[1], &block);
8212 if let Err(APIError::APIMisuseError { err }) = nodes[1].node.create_inbound_payment_for_hash(payment_hash, Some(100_000), 2, 0) {
8213 assert_eq!(err, "Duplicate payment hash");
8214 } else { panic!(); }
8216 // If we then connect the second block, we should be able to register the same payment hash
8217 // again with a different user_payment_id (this time getting a new payment secret).
8218 block.header.prev_blockhash = block.header.block_hash();
8219 block.header.time += 1;
8220 connect_block(&nodes[1], &block);
8221 let our_payment_secret = nodes[1].node.create_inbound_payment_for_hash(payment_hash, Some(100_000), 2, 42).unwrap();
8222 assert_ne!(payment_secret_1, our_payment_secret);
8225 let logger = test_utils::TestLogger::new();
8226 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
8227 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();
8228 nodes[0].node.send_payment(&route, payment_hash, &Some(our_payment_secret)).unwrap();
8229 check_added_monitors!(nodes[0], 1);
8230 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
8231 let mut payment_event = SendEvent::from_event(events.pop().unwrap());
8232 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
8233 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
8235 // Note that after leaving the above scope we have no knowledge of any arguments or return
8236 // values from previous calls.
8237 expect_pending_htlcs_forwardable!(nodes[1]);
8238 let events = nodes[1].node.get_and_clear_pending_events();
8239 assert_eq!(events.len(), 1);
8241 Event::PaymentReceived { purpose: PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, user_payment_id }, .. } => {
8242 assert!(payment_preimage.is_none());
8243 assert_eq!(user_payment_id, 42);
8244 assert_eq!(payment_secret, our_payment_secret);
8245 // We don't actually have the payment preimage with which to claim this payment!
8247 _ => panic!("Unexpected event"),
8252 fn test_bad_secret_hash() {
8253 // Simple test of unregistered payment hash/invalid payment secret handling
8254 let chanmon_cfgs = create_chanmon_cfgs(2);
8255 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8256 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8257 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8259 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8261 let random_payment_hash = PaymentHash([42; 32]);
8262 let random_payment_secret = PaymentSecret([43; 32]);
8263 let (our_payment_hash, our_payment_secret) = nodes[1].node.create_inbound_payment(Some(100_000), 2, 0);
8265 let logger = test_utils::TestLogger::new();
8266 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
8267 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();
8269 // All the below cases should end up being handled exactly identically, so we macro the
8270 // resulting events.
8271 macro_rules! handle_unknown_invalid_payment_data {
8273 check_added_monitors!(nodes[0], 1);
8274 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
8275 let payment_event = SendEvent::from_event(events.pop().unwrap());
8276 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
8277 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
8279 // We have to forward pending HTLCs once to process the receipt of the HTLC and then
8280 // again to process the pending backwards-failure of the HTLC
8281 expect_pending_htlcs_forwardable!(nodes[1]);
8282 expect_pending_htlcs_forwardable!(nodes[1]);
8283 check_added_monitors!(nodes[1], 1);
8285 // We should fail the payment back
8286 let mut events = nodes[1].node.get_and_clear_pending_msg_events();
8287 match events.pop().unwrap() {
8288 MessageSendEvent::UpdateHTLCs { node_id: _, updates: msgs::CommitmentUpdate { update_fail_htlcs, commitment_signed, .. } } => {
8289 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
8290 commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false);
8292 _ => panic!("Unexpected event"),
8297 let expected_error_code = 0x4000|15; // incorrect_or_unknown_payment_details
8298 // Error data is the HTLC value (100,000) and current block height
8299 let expected_error_data = [0, 0, 0, 0, 0, 1, 0x86, 0xa0, 0, 0, 0, CHAN_CONFIRM_DEPTH as u8];
8301 // Send a payment with the right payment hash but the wrong payment secret
8302 nodes[0].node.send_payment(&route, our_payment_hash, &Some(random_payment_secret)).unwrap();
8303 handle_unknown_invalid_payment_data!();
8304 expect_payment_failed!(nodes[0], our_payment_hash, true, expected_error_code, expected_error_data);
8306 // Send a payment with a random payment hash, but the right payment secret
8307 nodes[0].node.send_payment(&route, random_payment_hash, &Some(our_payment_secret)).unwrap();
8308 handle_unknown_invalid_payment_data!();
8309 expect_payment_failed!(nodes[0], random_payment_hash, true, expected_error_code, expected_error_data);
8311 // Send a payment with a random payment hash and random payment secret
8312 nodes[0].node.send_payment(&route, random_payment_hash, &Some(random_payment_secret)).unwrap();
8313 handle_unknown_invalid_payment_data!();
8314 expect_payment_failed!(nodes[0], random_payment_hash, true, expected_error_code, expected_error_data);
8318 fn test_update_err_monitor_lockdown() {
8319 // Our monitor will lock update of local commitment transaction if a broadcastion condition
8320 // has been fulfilled (either force-close from Channel or block height requiring a HTLC-
8321 // timeout). Trying to update monitor after lockdown should return a ChannelMonitorUpdateErr.
8323 // This scenario may happen in a watchtower setup, where watchtower process a block height
8324 // triggering a timeout while a slow-block-processing ChannelManager receives a local signed
8325 // commitment at same time.
8327 let chanmon_cfgs = create_chanmon_cfgs(2);
8328 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8329 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8330 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8332 // Create some initial channel
8333 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
8334 let outpoint = OutPoint { txid: chan_1.3.txid(), index: 0 };
8336 // Rebalance the network to generate htlc in the two directions
8337 send_payment(&nodes[0], &vec!(&nodes[1])[..], 10_000_000);
8339 // Route a HTLC from node 0 to node 1 (but don't settle)
8340 let preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000).0;
8342 // Copy ChainMonitor to simulate a watchtower and update block height of node 0 until its ChannelMonitor timeout HTLC onchain
8343 let chain_source = test_utils::TestChainSource::new(Network::Testnet);
8344 let logger = test_utils::TestLogger::with_id(format!("node {}", 0));
8345 let persister = test_utils::TestPersister::new();
8347 let monitors = nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap();
8348 let monitor = monitors.get(&outpoint).unwrap();
8349 let mut w = test_utils::TestVecWriter(Vec::new());
8350 monitor.write(&mut w).unwrap();
8351 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingSigner>)>::read(
8352 &mut io::Cursor::new(&w.0), &test_utils::OnlyReadsKeysInterface {}).unwrap().1;
8353 assert!(new_monitor == *monitor);
8354 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);
8355 assert!(watchtower.watch_channel(outpoint, new_monitor).is_ok());
8358 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8359 // Make the tx_broadcaster aware of enough blocks that it doesn't think we're violating
8360 // transaction lock time requirements here.
8361 chanmon_cfgs[0].tx_broadcaster.blocks.lock().unwrap().resize(200, (header, 0));
8362 watchtower.chain_monitor.block_connected(&Block { header, txdata: vec![] }, 200);
8364 // Try to update ChannelMonitor
8365 assert!(nodes[1].node.claim_funds(preimage));
8366 check_added_monitors!(nodes[1], 1);
8367 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
8368 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
8369 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
8370 if let Some(ref mut channel) = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan_1.2) {
8371 if let Ok((_, _, update)) = channel.commitment_signed(&updates.commitment_signed, &node_cfgs[0].logger) {
8372 if let Err(_) = watchtower.chain_monitor.update_channel(outpoint, update.clone()) {} else { assert!(false); }
8373 if let Ok(_) = nodes[0].chain_monitor.update_channel(outpoint, update) {} else { assert!(false); }
8374 } else { assert!(false); }
8375 } else { assert!(false); };
8376 // Our local monitor is in-sync and hasn't processed yet timeout
8377 check_added_monitors!(nodes[0], 1);
8378 let events = nodes[0].node.get_and_clear_pending_events();
8379 assert_eq!(events.len(), 1);
8383 fn test_concurrent_monitor_claim() {
8384 // Watchtower A receives block, broadcasts state N, then channel receives new state N+1,
8385 // sending it to both watchtowers, Bob accepts N+1, then receives block and broadcasts
8386 // the latest state N+1, Alice rejects state N+1, but Bob has already broadcast it,
8387 // state N+1 confirms. Alice claims output from state N+1.
8389 let chanmon_cfgs = create_chanmon_cfgs(2);
8390 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8391 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8392 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8394 // Create some initial channel
8395 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
8396 let outpoint = OutPoint { txid: chan_1.3.txid(), index: 0 };
8398 // Rebalance the network to generate htlc in the two directions
8399 send_payment(&nodes[0], &vec!(&nodes[1])[..], 10_000_000);
8401 // Route a HTLC from node 0 to node 1 (but don't settle)
8402 route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000).0;
8404 // Copy ChainMonitor to simulate watchtower Alice and update block height her ChannelMonitor timeout HTLC onchain
8405 let chain_source = test_utils::TestChainSource::new(Network::Testnet);
8406 let logger = test_utils::TestLogger::with_id(format!("node {}", "Alice"));
8407 let persister = test_utils::TestPersister::new();
8408 let watchtower_alice = {
8409 let monitors = nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap();
8410 let monitor = monitors.get(&outpoint).unwrap();
8411 let mut w = test_utils::TestVecWriter(Vec::new());
8412 monitor.write(&mut w).unwrap();
8413 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingSigner>)>::read(
8414 &mut io::Cursor::new(&w.0), &test_utils::OnlyReadsKeysInterface {}).unwrap().1;
8415 assert!(new_monitor == *monitor);
8416 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);
8417 assert!(watchtower.watch_channel(outpoint, new_monitor).is_ok());
8420 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8421 // Make the tx_broadcaster aware of enough blocks that it doesn't think we're violating
8422 // transaction lock time requirements here.
8423 chanmon_cfgs[0].tx_broadcaster.blocks.lock().unwrap().resize((CHAN_CONFIRM_DEPTH + 1 + TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS) as usize, (header, 0));
8424 watchtower_alice.chain_monitor.block_connected(&Block { header, txdata: vec![] }, CHAN_CONFIRM_DEPTH + 1 + TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS);
8426 // Watchtower Alice should have broadcast a commitment/HTLC-timeout
8428 let mut txn = chanmon_cfgs[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8429 assert_eq!(txn.len(), 2);
8433 // Copy ChainMonitor to simulate watchtower Bob and make it receive a commitment update first.
8434 let chain_source = test_utils::TestChainSource::new(Network::Testnet);
8435 let logger = test_utils::TestLogger::with_id(format!("node {}", "Bob"));
8436 let persister = test_utils::TestPersister::new();
8437 let watchtower_bob = {
8438 let monitors = nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap();
8439 let monitor = monitors.get(&outpoint).unwrap();
8440 let mut w = test_utils::TestVecWriter(Vec::new());
8441 monitor.write(&mut w).unwrap();
8442 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingSigner>)>::read(
8443 &mut io::Cursor::new(&w.0), &test_utils::OnlyReadsKeysInterface {}).unwrap().1;
8444 assert!(new_monitor == *monitor);
8445 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);
8446 assert!(watchtower.watch_channel(outpoint, new_monitor).is_ok());
8449 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8450 watchtower_bob.chain_monitor.block_connected(&Block { header, txdata: vec![] }, CHAN_CONFIRM_DEPTH + TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS);
8452 // Route another payment to generate another update with still previous HTLC pending
8453 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[0]);
8455 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
8456 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();
8457 nodes[1].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
8459 check_added_monitors!(nodes[1], 1);
8461 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
8462 assert_eq!(updates.update_add_htlcs.len(), 1);
8463 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &updates.update_add_htlcs[0]);
8464 if let Some(ref mut channel) = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan_1.2) {
8465 if let Ok((_, _, update)) = channel.commitment_signed(&updates.commitment_signed, &node_cfgs[0].logger) {
8466 // Watchtower Alice should already have seen the block and reject the update
8467 if let Err(_) = watchtower_alice.chain_monitor.update_channel(outpoint, update.clone()) {} else { assert!(false); }
8468 if let Ok(_) = watchtower_bob.chain_monitor.update_channel(outpoint, update.clone()) {} else { assert!(false); }
8469 if let Ok(_) = nodes[0].chain_monitor.update_channel(outpoint, update) {} else { assert!(false); }
8470 } else { assert!(false); }
8471 } else { assert!(false); };
8472 // Our local monitor is in-sync and hasn't processed yet timeout
8473 check_added_monitors!(nodes[0], 1);
8475 //// Provide one more block to watchtower Bob, expect broadcast of commitment and HTLC-Timeout
8476 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8477 watchtower_bob.chain_monitor.block_connected(&Block { header, txdata: vec![] }, CHAN_CONFIRM_DEPTH + 1 + TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS);
8479 // Watchtower Bob should have broadcast a commitment/HTLC-timeout
8482 let mut txn = chanmon_cfgs[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8483 assert_eq!(txn.len(), 2);
8484 bob_state_y = txn[0].clone();
8488 // We confirm Bob's state Y on Alice, she should broadcast a HTLC-timeout
8489 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8490 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);
8492 let htlc_txn = chanmon_cfgs[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8493 // We broadcast twice the transaction, once due to the HTLC-timeout, once due
8494 // the onchain detection of the HTLC output
8495 assert_eq!(htlc_txn.len(), 2);
8496 check_spends!(htlc_txn[0], bob_state_y);
8497 check_spends!(htlc_txn[1], bob_state_y);
8502 fn test_pre_lockin_no_chan_closed_update() {
8503 // Test that if a peer closes a channel in response to a funding_created message we don't
8504 // generate a channel update (as the channel cannot appear on chain without a funding_signed
8507 // Doing so would imply a channel monitor update before the initial channel monitor
8508 // registration, violating our API guarantees.
8510 // Previously, full_stack_target managed to hit this case by opening then closing a channel,
8511 // then opening a second channel with the same funding output as the first (which is not
8512 // rejected because the first channel does not exist in the ChannelManager) and closing it
8513 // before receiving funding_signed.
8514 let chanmon_cfgs = create_chanmon_cfgs(2);
8515 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8516 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8517 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8519 // Create an initial channel
8520 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
8521 let mut open_chan_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8522 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_msg);
8523 let accept_chan_msg = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
8524 nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &accept_chan_msg);
8526 // Move the first channel through the funding flow...
8527 let (temporary_channel_id, tx, _) = create_funding_transaction(&nodes[0], 100000, 42);
8529 nodes[0].node.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
8530 check_added_monitors!(nodes[0], 0);
8532 let funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
8533 let channel_id = ::chain::transaction::OutPoint { txid: funding_created_msg.funding_txid, index: funding_created_msg.funding_output_index }.to_channel_id();
8534 nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msgs::ErrorMessage { channel_id, data: "Hi".to_owned() });
8535 assert!(nodes[0].chain_monitor.added_monitors.lock().unwrap().is_empty());
8539 fn test_htlc_no_detection() {
8540 // This test is a mutation to underscore the detection logic bug we had
8541 // before #653. HTLC value routed is above the remaining balance, thus
8542 // inverting HTLC and `to_remote` output. HTLC will come second and
8543 // it wouldn't be seen by pre-#653 detection as we were enumerate()'ing
8544 // on a watched outputs vector (Vec<TxOut>) thus implicitly relying on
8545 // outputs order detection for correct spending children filtring.
8547 let chanmon_cfgs = create_chanmon_cfgs(2);
8548 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8549 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8550 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8552 // Create some initial channels
8553 let chan_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
8555 send_payment(&nodes[0], &vec!(&nodes[1])[..], 1_000_000);
8556 let (_, our_payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 2_000_000);
8557 let local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
8558 assert_eq!(local_txn[0].input.len(), 1);
8559 assert_eq!(local_txn[0].output.len(), 3);
8560 check_spends!(local_txn[0], chan_1.3);
8562 // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
8563 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8564 connect_block(&nodes[0], &Block { header, txdata: vec![local_txn[0].clone()] });
8565 // We deliberately connect the local tx twice as this should provoke a failure calling
8566 // this test before #653 fix.
8567 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);
8568 check_closed_broadcast!(nodes[0], true);
8569 check_added_monitors!(nodes[0], 1);
8570 connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1);
8572 let htlc_timeout = {
8573 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8574 assert_eq!(node_txn[1].input.len(), 1);
8575 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
8576 check_spends!(node_txn[1], local_txn[0]);
8580 let header_201 = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8581 connect_block(&nodes[0], &Block { header: header_201, txdata: vec![htlc_timeout.clone()] });
8582 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
8583 expect_payment_failed!(nodes[0], our_payment_hash, true);
8586 fn do_test_onchain_htlc_settlement_after_close(broadcast_alice: bool, go_onchain_before_fulfill: bool) {
8587 // If we route an HTLC, then learn the HTLC's preimage after the upstream channel has been
8588 // force-closed, we must claim that HTLC on-chain. (Given an HTLC forwarded from Alice --> Bob -->
8589 // Carol, Alice would be the upstream node, and Carol the downstream.)
8591 // Steps of the test:
8592 // 1) Alice sends a HTLC to Carol through Bob.
8593 // 2) Carol doesn't settle the HTLC.
8594 // 3) If broadcast_alice is true, Alice force-closes her channel with Bob. Else Bob force closes.
8595 // Steps 4 and 5 may be reordered depending on go_onchain_before_fulfill.
8596 // 4) Bob sees the Alice's commitment on his chain or vice versa. An offered output is present
8597 // but can't be claimed as Bob doesn't have yet knowledge of the preimage.
8598 // 5) Carol release the preimage to Bob off-chain.
8599 // 6) Bob claims the offered output on the broadcasted commitment.
8600 let chanmon_cfgs = create_chanmon_cfgs(3);
8601 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
8602 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
8603 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
8605 // Create some initial channels
8606 let chan_ab = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
8607 create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 100000, 10001, InitFeatures::known(), InitFeatures::known());
8609 // Steps (1) and (2):
8610 // Send an HTLC Alice --> Bob --> Carol, but Carol doesn't settle the HTLC back.
8611 let (payment_preimage, _payment_hash, _payment_secret) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3_000_000);
8613 // Check that Alice's commitment transaction now contains an output for this HTLC.
8614 let alice_txn = get_local_commitment_txn!(nodes[0], chan_ab.2);
8615 check_spends!(alice_txn[0], chan_ab.3);
8616 assert_eq!(alice_txn[0].output.len(), 2);
8617 check_spends!(alice_txn[1], alice_txn[0]); // 2nd transaction is a non-final HTLC-timeout
8618 assert_eq!(alice_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
8619 assert_eq!(alice_txn.len(), 2);
8621 // Steps (3) and (4):
8622 // If `go_onchain_before_fufill`, broadcast the relevant commitment transaction and check that Bob
8623 // responds by (1) broadcasting a channel update and (2) adding a new ChannelMonitor.
8624 let mut force_closing_node = 0; // Alice force-closes
8625 if !broadcast_alice { force_closing_node = 1; } // Bob force-closes
8626 nodes[force_closing_node].node.force_close_channel(&chan_ab.2).unwrap();
8627 check_closed_broadcast!(nodes[force_closing_node], true);
8628 check_added_monitors!(nodes[force_closing_node], 1);
8629 if go_onchain_before_fulfill {
8630 let txn_to_broadcast = match broadcast_alice {
8631 true => alice_txn.clone(),
8632 false => get_local_commitment_txn!(nodes[1], chan_ab.2)
8634 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
8635 connect_block(&nodes[1], &Block { header, txdata: vec![txn_to_broadcast[0].clone()]});
8636 let mut bob_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8637 if broadcast_alice {
8638 check_closed_broadcast!(nodes[1], true);
8639 check_added_monitors!(nodes[1], 1);
8641 assert_eq!(bob_txn.len(), 1);
8642 check_spends!(bob_txn[0], chan_ab.3);
8646 // Carol then claims the funds and sends an update_fulfill message to Bob, and they go through the
8647 // process of removing the HTLC from their commitment transactions.
8648 assert!(nodes[2].node.claim_funds(payment_preimage));
8649 check_added_monitors!(nodes[2], 1);
8650 let carol_updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
8651 assert!(carol_updates.update_add_htlcs.is_empty());
8652 assert!(carol_updates.update_fail_htlcs.is_empty());
8653 assert!(carol_updates.update_fail_malformed_htlcs.is_empty());
8654 assert!(carol_updates.update_fee.is_none());
8655 assert_eq!(carol_updates.update_fulfill_htlcs.len(), 1);
8657 nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &carol_updates.update_fulfill_htlcs[0]);
8658 expect_payment_forwarded!(nodes[1], if go_onchain_before_fulfill || force_closing_node == 1 { None } else { Some(1000) }, false);
8659 // If Alice broadcasted but Bob doesn't know yet, here he prepares to tell her about the preimage.
8660 if !go_onchain_before_fulfill && broadcast_alice {
8661 let events = nodes[1].node.get_and_clear_pending_msg_events();
8662 assert_eq!(events.len(), 1);
8664 MessageSendEvent::UpdateHTLCs { ref node_id, .. } => {
8665 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
8667 _ => panic!("Unexpected event"),
8670 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &carol_updates.commitment_signed);
8671 // One monitor update for the preimage to update the Bob<->Alice channel, one monitor update
8672 // Carol<->Bob's updated commitment transaction info.
8673 check_added_monitors!(nodes[1], 2);
8675 let events = nodes[1].node.get_and_clear_pending_msg_events();
8676 assert_eq!(events.len(), 2);
8677 let bob_revocation = match events[0] {
8678 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
8679 assert_eq!(*node_id, nodes[2].node.get_our_node_id());
8682 _ => panic!("Unexpected event"),
8684 let bob_updates = match events[1] {
8685 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
8686 assert_eq!(*node_id, nodes[2].node.get_our_node_id());
8689 _ => panic!("Unexpected event"),
8692 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bob_revocation);
8693 check_added_monitors!(nodes[2], 1);
8694 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bob_updates.commitment_signed);
8695 check_added_monitors!(nodes[2], 1);
8697 let events = nodes[2].node.get_and_clear_pending_msg_events();
8698 assert_eq!(events.len(), 1);
8699 let carol_revocation = match events[0] {
8700 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
8701 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
8704 _ => panic!("Unexpected event"),
8706 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &carol_revocation);
8707 check_added_monitors!(nodes[1], 1);
8709 // If this test requires the force-closed channel to not be on-chain until after the fulfill,
8710 // here's where we put said channel's commitment tx on-chain.
8711 let mut txn_to_broadcast = alice_txn.clone();
8712 if !broadcast_alice { txn_to_broadcast = get_local_commitment_txn!(nodes[1], chan_ab.2); }
8713 if !go_onchain_before_fulfill {
8714 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
8715 connect_block(&nodes[1], &Block { header, txdata: vec![txn_to_broadcast[0].clone()]});
8716 // If Bob was the one to force-close, he will have already passed these checks earlier.
8717 if broadcast_alice {
8718 check_closed_broadcast!(nodes[1], true);
8719 check_added_monitors!(nodes[1], 1);
8721 let mut bob_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8722 if broadcast_alice {
8723 // In `connect_block()`, the ChainMonitor and ChannelManager are separately notified about a
8724 // new block being connected. The ChannelManager being notified triggers a monitor update,
8725 // which triggers broadcasting our commitment tx and an HTLC-claiming tx. The ChainMonitor
8726 // being notified triggers the HTLC-claiming tx redundantly, resulting in 3 total txs being
8728 assert_eq!(bob_txn.len(), 3);
8729 check_spends!(bob_txn[1], chan_ab.3);
8731 assert_eq!(bob_txn.len(), 2);
8732 check_spends!(bob_txn[0], chan_ab.3);
8737 // Finally, check that Bob broadcasted a preimage-claiming transaction for the HTLC output on the
8738 // broadcasted commitment transaction.
8740 let bob_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
8741 if go_onchain_before_fulfill {
8742 // Bob should now have an extra broadcasted tx, for the preimage-claiming transaction.
8743 assert_eq!(bob_txn.len(), 2);
8745 let script_weight = match broadcast_alice {
8746 true => OFFERED_HTLC_SCRIPT_WEIGHT,
8747 false => ACCEPTED_HTLC_SCRIPT_WEIGHT
8749 // If Alice force-closed and Bob didn't receive her commitment transaction until after he
8750 // received Carol's fulfill, he broadcasts the HTLC-output-claiming transaction first. Else if
8751 // Bob force closed or if he found out about Alice's commitment tx before receiving Carol's
8752 // fulfill, then he broadcasts the HTLC-output-claiming transaction second.
8753 if broadcast_alice && !go_onchain_before_fulfill {
8754 check_spends!(bob_txn[0], txn_to_broadcast[0]);
8755 assert_eq!(bob_txn[0].input[0].witness.last().unwrap().len(), script_weight);
8757 check_spends!(bob_txn[1], txn_to_broadcast[0]);
8758 assert_eq!(bob_txn[1].input[0].witness.last().unwrap().len(), script_weight);
8764 fn test_onchain_htlc_settlement_after_close() {
8765 do_test_onchain_htlc_settlement_after_close(true, true);
8766 do_test_onchain_htlc_settlement_after_close(false, true); // Technically redundant, but may as well
8767 do_test_onchain_htlc_settlement_after_close(true, false);
8768 do_test_onchain_htlc_settlement_after_close(false, false);
8772 fn test_duplicate_chan_id() {
8773 // Test that if a given peer tries to open a channel with the same channel_id as one that is
8774 // already open we reject it and keep the old channel.
8776 // Previously, full_stack_target managed to figure out that if you tried to open two channels
8777 // with the same funding output (ie post-funding channel_id), we'd create a monitor update for
8778 // the existing channel when we detect the duplicate new channel, screwing up our monitor
8779 // updating logic for the existing channel.
8780 let chanmon_cfgs = create_chanmon_cfgs(2);
8781 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8782 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8783 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8785 // Create an initial channel
8786 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
8787 let mut open_chan_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8788 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_msg);
8789 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()));
8791 // Try to create a second channel with the same temporary_channel_id as the first and check
8792 // that it is rejected.
8793 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_msg);
8795 let events = nodes[1].node.get_and_clear_pending_msg_events();
8796 assert_eq!(events.len(), 1);
8798 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
8799 // Technically, at this point, nodes[1] would be justified in thinking both the
8800 // first (valid) and second (invalid) channels are closed, given they both have
8801 // the same non-temporary channel_id. However, currently we do not, so we just
8802 // move forward with it.
8803 assert_eq!(msg.channel_id, open_chan_msg.temporary_channel_id);
8804 assert_eq!(node_id, nodes[0].node.get_our_node_id());
8806 _ => panic!("Unexpected event"),
8810 // Move the first channel through the funding flow...
8811 let (temporary_channel_id, tx, funding_output) = create_funding_transaction(&nodes[0], 100000, 42);
8813 nodes[0].node.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
8814 check_added_monitors!(nodes[0], 0);
8816 let mut funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
8817 nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created_msg);
8819 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
8820 assert_eq!(added_monitors.len(), 1);
8821 assert_eq!(added_monitors[0].0, funding_output);
8822 added_monitors.clear();
8824 let funding_signed_msg = get_event_msg!(nodes[1], MessageSendEvent::SendFundingSigned, nodes[0].node.get_our_node_id());
8826 let funding_outpoint = ::chain::transaction::OutPoint { txid: funding_created_msg.funding_txid, index: funding_created_msg.funding_output_index };
8827 let channel_id = funding_outpoint.to_channel_id();
8829 // Now we have the first channel past funding_created (ie it has a txid-based channel_id, not a
8832 // First try to open a second channel with a temporary channel id equal to the txid-based one.
8833 // Technically this is allowed by the spec, but we don't support it and there's little reason
8834 // to. Still, it shouldn't cause any other issues.
8835 open_chan_msg.temporary_channel_id = channel_id;
8836 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_msg);
8838 let events = nodes[1].node.get_and_clear_pending_msg_events();
8839 assert_eq!(events.len(), 1);
8841 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
8842 // Technically, at this point, nodes[1] would be justified in thinking both
8843 // channels are closed, but currently we do not, so we just move forward with it.
8844 assert_eq!(msg.channel_id, open_chan_msg.temporary_channel_id);
8845 assert_eq!(node_id, nodes[0].node.get_our_node_id());
8847 _ => panic!("Unexpected event"),
8851 // Now try to create a second channel which has a duplicate funding output.
8852 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
8853 let open_chan_2_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8854 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_2_msg);
8855 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()));
8856 create_funding_transaction(&nodes[0], 100000, 42); // Get and check the FundingGenerationReady event
8858 let funding_created = {
8859 let mut a_channel_lock = nodes[0].node.channel_state.lock().unwrap();
8860 let mut as_chan = a_channel_lock.by_id.get_mut(&open_chan_2_msg.temporary_channel_id).unwrap();
8861 let logger = test_utils::TestLogger::new();
8862 as_chan.get_outbound_funding_created(tx.clone(), funding_outpoint, &&logger).unwrap()
8864 check_added_monitors!(nodes[0], 0);
8865 nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created);
8866 // At this point we'll try to add a duplicate channel monitor, which will be rejected, but
8867 // still needs to be cleared here.
8868 check_added_monitors!(nodes[1], 1);
8870 // ...still, nodes[1] will reject the duplicate channel.
8872 let events = nodes[1].node.get_and_clear_pending_msg_events();
8873 assert_eq!(events.len(), 1);
8875 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
8876 // Technically, at this point, nodes[1] would be justified in thinking both
8877 // channels are closed, but currently we do not, so we just move forward with it.
8878 assert_eq!(msg.channel_id, channel_id);
8879 assert_eq!(node_id, nodes[0].node.get_our_node_id());
8881 _ => panic!("Unexpected event"),
8885 // finally, finish creating the original channel and send a payment over it to make sure
8886 // everything is functional.
8887 nodes[0].node.handle_funding_signed(&nodes[1].node.get_our_node_id(), &funding_signed_msg);
8889 let mut added_monitors = nodes[0].chain_monitor.added_monitors.lock().unwrap();
8890 assert_eq!(added_monitors.len(), 1);
8891 assert_eq!(added_monitors[0].0, funding_output);
8892 added_monitors.clear();
8895 let events_4 = nodes[0].node.get_and_clear_pending_events();
8896 assert_eq!(events_4.len(), 0);
8897 assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
8898 assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0].txid(), funding_output.txid);
8900 let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
8901 let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
8902 update_nodes_with_chan_announce(&nodes, 0, 1, &announcement, &as_update, &bs_update);
8903 send_payment(&nodes[0], &[&nodes[1]], 8000000);
8907 fn test_error_chans_closed() {
8908 // Test that we properly handle error messages, closing appropriate channels.
8910 // Prior to #787 we'd allow a peer to make us force-close a channel we had with a different
8911 // peer. The "real" fix for that is to index channels with peers_ids, however in the mean time
8912 // we can test various edge cases around it to ensure we don't regress.
8913 let chanmon_cfgs = create_chanmon_cfgs(3);
8914 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
8915 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
8916 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
8918 // Create some initial channels
8919 let chan_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
8920 let chan_2 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
8921 let chan_3 = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 100000, 10001, InitFeatures::known(), InitFeatures::known());
8923 assert_eq!(nodes[0].node.list_usable_channels().len(), 3);
8924 assert_eq!(nodes[1].node.list_usable_channels().len(), 2);
8925 assert_eq!(nodes[2].node.list_usable_channels().len(), 1);
8927 // Closing a channel from a different peer has no effect
8928 nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msgs::ErrorMessage { channel_id: chan_3.2, data: "ERR".to_owned() });
8929 assert_eq!(nodes[0].node.list_usable_channels().len(), 3);
8931 // Closing one channel doesn't impact others
8932 nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msgs::ErrorMessage { channel_id: chan_2.2, data: "ERR".to_owned() });
8933 check_added_monitors!(nodes[0], 1);
8934 check_closed_broadcast!(nodes[0], false);
8935 assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0).len(), 1);
8936 assert_eq!(nodes[0].node.list_usable_channels().len(), 2);
8937 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);
8938 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);
8940 // A null channel ID should close all channels
8941 let _chan_4 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
8942 nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msgs::ErrorMessage { channel_id: [0; 32], data: "ERR".to_owned() });
8943 check_added_monitors!(nodes[0], 2);
8944 let events = nodes[0].node.get_and_clear_pending_msg_events();
8945 assert_eq!(events.len(), 2);
8947 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
8948 assert_eq!(msg.contents.flags & 2, 2);
8950 _ => panic!("Unexpected event"),
8953 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
8954 assert_eq!(msg.contents.flags & 2, 2);
8956 _ => panic!("Unexpected event"),
8958 // Note that at this point users of a standard PeerHandler will end up calling
8959 // peer_disconnected with no_connection_possible set to false, duplicating the
8960 // close-all-channels logic. That's OK, we don't want to end up not force-closing channels for
8961 // users with their own peer handling logic. We duplicate the call here, however.
8962 assert_eq!(nodes[0].node.list_usable_channels().len(), 1);
8963 assert!(nodes[0].node.list_usable_channels()[0].channel_id == chan_3.2);
8965 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), true);
8966 assert_eq!(nodes[0].node.list_usable_channels().len(), 1);
8967 assert!(nodes[0].node.list_usable_channels()[0].channel_id == chan_3.2);
8971 fn test_invalid_funding_tx() {
8972 // Test that we properly handle invalid funding transactions sent to us from a peer.
8974 // Previously, all other major lightning implementations had failed to properly sanitize
8975 // funding transactions from their counterparties, leading to a multi-implementation critical
8976 // security vulnerability (though we always sanitized properly, we've previously had
8977 // un-released crashes in the sanitization process).
8978 let chanmon_cfgs = create_chanmon_cfgs(2);
8979 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8980 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8981 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8983 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100_000, 10_000, 42, None).unwrap();
8984 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()));
8985 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()));
8987 let (temporary_channel_id, mut tx, _) = create_funding_transaction(&nodes[0], 100_000, 42);
8988 for output in tx.output.iter_mut() {
8989 // Make the confirmed funding transaction have a bogus script_pubkey
8990 output.script_pubkey = bitcoin::Script::new();
8993 nodes[0].node.funding_transaction_generated_unchecked(&temporary_channel_id, tx.clone(), 0).unwrap();
8994 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()));
8995 check_added_monitors!(nodes[1], 1);
8997 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()));
8998 check_added_monitors!(nodes[0], 1);
9000 let events_1 = nodes[0].node.get_and_clear_pending_events();
9001 assert_eq!(events_1.len(), 0);
9003 assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
9004 assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0], tx);
9005 nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
9007 confirm_transaction_at(&nodes[1], &tx, 1);
9008 check_added_monitors!(nodes[1], 1);
9009 let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
9010 assert_eq!(events_2.len(), 1);
9011 if let MessageSendEvent::HandleError { node_id, action } = &events_2[0] {
9012 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
9013 if let msgs::ErrorAction::SendErrorMessage { msg } = action {
9014 assert_eq!(msg.data, "funding tx had wrong script/value or output index");
9015 } else { panic!(); }
9016 } else { panic!(); }
9017 assert_eq!(nodes[1].node.list_channels().len(), 0);
9020 fn do_test_tx_confirmed_skipping_blocks_immediate_broadcast(test_height_before_timelock: bool) {
9021 // In the first version of the chain::Confirm interface, after a refactor was made to not
9022 // broadcast CSV-locked transactions until their CSV lock is up, we wouldn't reliably broadcast
9023 // transactions after a `transactions_confirmed` call. Specifically, if the chain, provided via
9024 // `best_block_updated` is at height N, and a transaction output which we wish to spend at
9025 // height N-1 (due to a CSV to height N-1) is provided at height N, we will not broadcast the
9026 // spending transaction until height N+1 (or greater). This was due to the way
9027 // `ChannelMonitor::transactions_confirmed` worked, only checking if we should broadcast a
9028 // spending transaction at the height the input transaction was confirmed at, not whether we
9029 // should broadcast a spending transaction at the current height.
9030 // A second, similar, issue involved failing HTLCs backwards - because we only provided the
9031 // height at which transactions were confirmed to `OnchainTx::update_claims_view`, it wasn't
9032 // aware that the anti-reorg-delay had, in fact, already expired, waiting to fail-backwards
9033 // until we learned about an additional block.
9035 // As an additional check, if `test_height_before_timelock` is set, we instead test that we
9036 // aren't broadcasting transactions too early (ie not broadcasting them at all).
9037 let chanmon_cfgs = create_chanmon_cfgs(3);
9038 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
9039 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
9040 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
9041 *nodes[0].connect_style.borrow_mut() = ConnectStyle::BestBlockFirstSkippingBlocks;
9043 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
9044 let (chan_announce, _, channel_id, _) = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
9045 let (_, payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1_000_000);
9046 nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id(), false);
9047 nodes[2].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
9049 nodes[1].node.force_close_channel(&channel_id).unwrap();
9050 check_closed_broadcast!(nodes[1], true);
9051 check_added_monitors!(nodes[1], 1);
9052 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
9053 assert_eq!(node_txn.len(), 1);
9055 let conf_height = nodes[1].best_block_info().1;
9056 if !test_height_before_timelock {
9057 connect_blocks(&nodes[1], 24 * 6);
9059 nodes[1].chain_monitor.chain_monitor.transactions_confirmed(
9060 &nodes[1].get_block_header(conf_height), &[(0, &node_txn[0])], conf_height);
9061 if test_height_before_timelock {
9062 // If we confirmed the close transaction, but timelocks have not yet expired, we should not
9063 // generate any events or broadcast any transactions
9064 assert!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
9065 assert!(nodes[1].chain_monitor.chain_monitor.get_and_clear_pending_events().is_empty());
9067 // We should broadcast an HTLC transaction spending our funding transaction first
9068 let spending_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
9069 assert_eq!(spending_txn.len(), 2);
9070 assert_eq!(spending_txn[0], node_txn[0]);
9071 check_spends!(spending_txn[1], node_txn[0]);
9072 // We should also generate a SpendableOutputs event with the to_self output (as its
9074 let descriptor_spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
9075 assert_eq!(descriptor_spend_txn.len(), 1);
9077 // If we also discover that the HTLC-Timeout transaction was confirmed some time ago, we
9078 // should immediately fail-backwards the HTLC to the previous hop, without waiting for an
9079 // additional block built on top of the current chain.
9080 nodes[1].chain_monitor.chain_monitor.transactions_confirmed(
9081 &nodes[1].get_block_header(conf_height + 1), &[(0, &spending_txn[1])], conf_height + 1);
9082 expect_pending_htlcs_forwardable!(nodes[1]);
9083 check_added_monitors!(nodes[1], 1);
9085 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
9086 assert!(updates.update_add_htlcs.is_empty());
9087 assert!(updates.update_fulfill_htlcs.is_empty());
9088 assert_eq!(updates.update_fail_htlcs.len(), 1);
9089 assert!(updates.update_fail_malformed_htlcs.is_empty());
9090 assert!(updates.update_fee.is_none());
9091 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
9092 commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, true, true);
9093 expect_payment_failed!(nodes[0], payment_hash, false);
9094 expect_payment_failure_chan_update!(nodes[0], chan_announce.contents.short_channel_id, true);
9099 fn test_tx_confirmed_skipping_blocks_immediate_broadcast() {
9100 do_test_tx_confirmed_skipping_blocks_immediate_broadcast(false);
9101 do_test_tx_confirmed_skipping_blocks_immediate_broadcast(true);
9105 fn test_keysend_payments_to_public_node() {
9106 let chanmon_cfgs = create_chanmon_cfgs(2);
9107 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
9108 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
9109 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
9111 let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
9112 let network_graph = nodes[0].net_graph_msg_handler.network_graph.read().unwrap();
9113 let payer_pubkey = nodes[0].node.get_our_node_id();
9114 let payee_pubkey = nodes[1].node.get_our_node_id();
9115 let route = get_route(&payer_pubkey, &network_graph, &payee_pubkey, None,
9116 None, &vec![], 10000, 40,
9117 nodes[0].logger).unwrap();
9119 let test_preimage = PaymentPreimage([42; 32]);
9120 let payment_hash = nodes[0].node.send_spontaneous_payment(&route, Some(test_preimage)).unwrap();
9121 check_added_monitors!(nodes[0], 1);
9122 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
9123 assert_eq!(events.len(), 1);
9124 let event = events.pop().unwrap();
9125 let path = vec![&nodes[1]];
9126 pass_along_path(&nodes[0], &path, 10000, payment_hash, None, event, true, Some(test_preimage));
9127 claim_payment(&nodes[0], &path, test_preimage);
9131 fn test_keysend_payments_to_private_node() {
9132 let chanmon_cfgs = create_chanmon_cfgs(2);
9133 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
9134 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
9135 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
9137 let payer_pubkey = nodes[0].node.get_our_node_id();
9138 let payee_pubkey = nodes[1].node.get_our_node_id();
9139 nodes[0].node.peer_connected(&payee_pubkey, &msgs::Init { features: InitFeatures::known() });
9140 nodes[1].node.peer_connected(&payer_pubkey, &msgs::Init { features: InitFeatures::known() });
9142 let _chan = create_chan_between_nodes(&nodes[0], &nodes[1], InitFeatures::known(), InitFeatures::known());
9143 let network_graph = nodes[0].net_graph_msg_handler.network_graph.read().unwrap();
9144 let first_hops = nodes[0].node.list_usable_channels();
9145 let route = get_keysend_route(&payer_pubkey, &network_graph, &payee_pubkey,
9146 Some(&first_hops.iter().collect::<Vec<_>>()), &vec![], 10000, 40,
9147 nodes[0].logger).unwrap();
9149 let test_preimage = PaymentPreimage([42; 32]);
9150 let payment_hash = nodes[0].node.send_spontaneous_payment(&route, Some(test_preimage)).unwrap();
9151 check_added_monitors!(nodes[0], 1);
9152 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
9153 assert_eq!(events.len(), 1);
9154 let event = events.pop().unwrap();
9155 let path = vec![&nodes[1]];
9156 pass_along_path(&nodes[0], &path, 10000, payment_hash, None, event, true, Some(test_preimage));
9157 claim_payment(&nodes[0], &path, test_preimage);
9160 fn do_test_max_dust_htlc_exposure(dust_outbound_balance: bool, at_forward: bool, on_holder_tx: bool) {
9161 // Test that we properly reject dust HTLC violating our `max_dust_htlc_exposure_msat` policy.
9163 // At HTLC forward (`send_payment()`), if the sum of the trimmed-to-dust HTLC inbound and
9164 // trimmed-to-dust HTLC outbound balance and this new payment as included on next counterparty
9165 // commitment are above our `max_dust_htlc_exposure_msat`, we'll reject the update.
9166 // At HTLC reception (`update_add_htlc()`), if the sum of the trimmed-to-dust HTLC inbound
9167 // and trimmed-to-dust HTLC outbound balance and this new received HTLC as included on next
9168 // counterparty commitment are above our `max_dust_htlc_exposure_msat`, we'll fail the update.
9169 // Note, we return a `temporary_channel_failure` (0x1000 | 7), as the channel might be
9170 // available again for HTLC processing once the dust bandwidth has cleared up.
9172 let chanmon_cfgs = create_chanmon_cfgs(2);
9173 let mut config = test_default_channel_config();
9174 config.channel_options.max_dust_htlc_exposure_msat = 5_000_000; // default setting value
9175 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
9176 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, Some(config)]);
9177 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
9179 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 1_000_000, 500_000_000, 42, None).unwrap();
9180 let mut open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
9181 open_channel.max_htlc_value_in_flight_msat = 50_000_000;
9182 open_channel.max_accepted_htlcs = 60;
9183 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_channel);
9184 let mut accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
9186 accept_channel.dust_limit_satoshis = 660;
9188 nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &accept_channel);
9190 let (temporary_channel_id, tx, _) = create_funding_transaction(&nodes[0], 1_000_000, 42);
9193 if let Some(mut chan) = nodes[1].node.channel_state.lock().unwrap().by_id.get_mut(&temporary_channel_id) {
9194 chan.holder_dust_limit_satoshis = 660;
9198 nodes[0].node.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
9199 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()));
9200 check_added_monitors!(nodes[1], 1);
9202 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()));
9203 check_added_monitors!(nodes[0], 1);
9205 let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
9206 let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
9207 update_nodes_with_chan_announce(&nodes, 0, 1, &announcement, &as_update, &bs_update);
9210 if dust_outbound_balance {
9212 let (route, payment_hash, _, payment_secret) = get_route_and_payment_hash!(nodes[1], nodes[0], 2_300_000);
9213 if let Err(_) = nodes[1].node.send_payment(&route, payment_hash, &Some(payment_secret)) { panic!("Unexpected event at dust HTLC {}", i); }
9217 route_payment(&nodes[0], &[&nodes[1]], 2_300_000);
9221 if dust_outbound_balance {
9223 let (route, payment_hash, _, payment_secret) = get_route_and_payment_hash!(nodes[1], nodes[0], 200_000); // + 177_000 msat of HTLC-success tx at 253 sats/kWU
9224 if let Err(_) = nodes[1].node.send_payment(&route, payment_hash, &Some(payment_secret)) { panic!("Unexpected event at dust HTLC {}", i); }
9228 route_payment(&nodes[0], &[&nodes[1]], 200_000); // + 167_000 msat of HTLC-timeout tx at 253 sats/kWU
9234 let (route, payment_hash, _, payment_secret) = get_route_and_payment_hash!(nodes[1], nodes[0], if on_holder_tx { 2_300_000 } else { 200_000 });
9235 let mut config = UserConfig::default();
9237 unwrap_send_err!(nodes[1].node.send_payment(&route, payment_hash, &Some(payment_secret)), true, APIError::ChannelUnavailable { ref err }, assert_eq!(err, &format!("Cannot send value that would put our exposure to dust HTLCs at {} over the limit {} on holder commitment tx", 6_900_000, config.channel_options.max_dust_htlc_exposure_msat)));
9239 unwrap_send_err!(nodes[1].node.send_payment(&route, payment_hash, &Some(payment_secret)), true, APIError::ChannelUnavailable { ref err }, assert_eq!(err, &format!("Cannot send value that would put our exposure to dust HTLCs at {} over the limit {} on counterparty commitment tx", 5_200_000, config.channel_options.max_dust_htlc_exposure_msat)));
9242 let (route, payment_hash, _, payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1 ], if on_holder_tx { 2_300_000 } else { 200_000 });
9243 nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
9244 check_added_monitors!(nodes[0], 1);
9245 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
9246 assert_eq!(events.len(), 1);
9247 let payment_event = SendEvent::from_event(events.remove(0));
9248 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
9250 nodes[1].logger.assert_log("lightning::ln::channel".to_string(), format!("Cannot accept value that would put our exposure to dust HTLCs at {} over the limit {} on holder commitment tx", 6_900_000, config.channel_options.max_dust_htlc_exposure_msat), 1);
9252 nodes[1].logger.assert_log("lightning::ln::channel".to_string(), format!("Cannot accept value that would put our exposure to dust HTLCs at {} over the limit {} on counterparty commitment tx", 5_200_000, config.channel_options.max_dust_htlc_exposure_msat), 1);
9256 let _ = nodes[1].node.get_and_clear_pending_msg_events();
9257 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
9258 added_monitors.clear();
9262 fn test_max_dust_htlc_exposure() {
9263 do_test_max_dust_htlc_exposure(true, true, true);
9264 do_test_max_dust_htlc_exposure(false, true, true);
9265 do_test_max_dust_htlc_exposure(false, false, true);
9266 do_test_max_dust_htlc_exposure(false, false, false);
9267 do_test_max_dust_htlc_exposure(true, true, false);
9268 do_test_max_dust_htlc_exposure(true, false, false);
9269 do_test_max_dust_htlc_exposure(true, false, true);
9270 do_test_max_dust_htlc_exposure(false, true, false);