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::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, PaymentId, 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::{NetworkUpdate, RoutingFees};
28 use ln::features::{ChannelFeatures, InitFeatures, InvoiceFeatures, NodeFeatures};
30 use ln::msgs::{ChannelMessageHandler, RoutingMessageHandler, ErrorAction};
31 use util::enforcing_trait_impls::EnforcingSigner;
32 use util::{byte_utils, test_utils};
33 use util::events::{Event, MessageSendEvent, MessageSendEventsProvider, PaymentPurpose, ClosureReason};
34 use util::errors::APIError;
35 use util::ser::{Writeable, ReadableArgs};
36 use util::config::UserConfig;
38 use bitcoin::hash_types::{Txid, BlockHash};
39 use bitcoin::blockdata::block::{Block, BlockHeader};
40 use bitcoin::blockdata::script::Builder;
41 use bitcoin::blockdata::opcodes;
42 use bitcoin::blockdata::constants::genesis_block;
43 use bitcoin::network::constants::Network;
45 use bitcoin::hashes::sha256::Hash as Sha256;
46 use bitcoin::hashes::Hash;
48 use bitcoin::secp256k1::Secp256k1;
49 use bitcoin::secp256k1::key::{PublicKey,SecretKey};
55 use alloc::collections::BTreeSet;
56 use core::default::Default;
57 use sync::{Arc, Mutex};
59 use ln::functional_test_utils::*;
60 use ln::chan_utils::CommitmentTransaction;
63 fn test_insane_channel_opens() {
64 // Stand up a network of 2 nodes
65 let chanmon_cfgs = create_chanmon_cfgs(2);
66 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
67 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
68 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
70 // Instantiate channel parameters where we push the maximum msats given our
72 let channel_value_sat = 31337; // same as funding satoshis
73 let channel_reserve_satoshis = Channel::<EnforcingSigner>::get_holder_selected_channel_reserve_satoshis(channel_value_sat);
74 let push_msat = (channel_value_sat - channel_reserve_satoshis) * 1000;
76 // Have node0 initiate a channel to node1 with aforementioned parameters
77 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_sat, push_msat, 42, None).unwrap();
79 // Extract the channel open message from node0 to node1
80 let open_channel_message = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
82 // Test helper that asserts we get the correct error string given a mutator
83 // that supposedly makes the channel open message insane
84 let insane_open_helper = |expected_error_str: &str, message_mutator: fn(msgs::OpenChannel) -> msgs::OpenChannel| {
85 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &message_mutator(open_channel_message.clone()));
86 let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
87 assert_eq!(msg_events.len(), 1);
88 let expected_regex = regex::Regex::new(expected_error_str).unwrap();
89 if let MessageSendEvent::HandleError { ref action, .. } = msg_events[0] {
91 &ErrorAction::SendErrorMessage { .. } => {
92 nodes[1].logger.assert_log_regex("lightning::ln::channelmanager".to_string(), expected_regex, 1);
94 _ => panic!("unexpected event!"),
96 } else { assert!(false); }
99 use ln::channel::MAX_FUNDING_SATOSHIS;
100 use ln::channelmanager::MAX_LOCAL_BREAKDOWN_TIMEOUT;
102 // Test all mutations that would make the channel open message insane
103 insane_open_helper(format!("Funding must be smaller than {}. It was {}", MAX_FUNDING_SATOSHIS, MAX_FUNDING_SATOSHIS).as_str(), |mut msg| { msg.funding_satoshis = MAX_FUNDING_SATOSHIS; msg });
105 insane_open_helper("Bogus channel_reserve_satoshis", |mut msg| { msg.channel_reserve_satoshis = msg.funding_satoshis + 1; msg });
107 insane_open_helper(r"push_msat \d+ was larger than funding value \d+", |mut msg| { msg.push_msat = (msg.funding_satoshis - msg.channel_reserve_satoshis) * 1000 + 1; msg });
109 insane_open_helper("Peer never wants payout outputs?", |mut msg| { msg.dust_limit_satoshis = msg.funding_satoshis + 1 ; msg });
111 insane_open_helper(r"Bogus; channel reserve \(\d+\) is less than dust limit \(\d+\)", |mut msg| { msg.dust_limit_satoshis = msg.channel_reserve_satoshis + 1; msg });
113 insane_open_helper(r"Minimum htlc value \(\d+\) was larger than full channel value \(\d+\)", |mut msg| { msg.htlc_minimum_msat = (msg.funding_satoshis - msg.channel_reserve_satoshis) * 1000; msg });
115 insane_open_helper("They wanted our payments to be delayed by a needlessly long period", |mut msg| { msg.to_self_delay = MAX_LOCAL_BREAKDOWN_TIMEOUT + 1; msg });
117 insane_open_helper("0 max_accepted_htlcs makes for a useless channel", |mut msg| { msg.max_accepted_htlcs = 0; msg });
119 insane_open_helper("max_accepted_htlcs was 484. It must not be larger than 483", |mut msg| { msg.max_accepted_htlcs = 484; msg });
123 fn test_async_inbound_update_fee() {
124 let chanmon_cfgs = create_chanmon_cfgs(2);
125 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
126 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
127 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
128 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
129 let logger = test_utils::TestLogger::new();
132 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
136 // send (1) commitment_signed -.
137 // <- update_add_htlc/commitment_signed
138 // send (2) RAA (awaiting remote revoke) -.
139 // (1) commitment_signed is delivered ->
140 // .- send (3) RAA (awaiting remote revoke)
141 // (2) RAA is delivered ->
142 // .- send (4) commitment_signed
143 // <- (3) RAA is delivered
144 // send (5) commitment_signed -.
145 // <- (4) commitment_signed is delivered
147 // (5) commitment_signed is delivered ->
149 // (6) RAA is delivered ->
151 // First nodes[0] generates an update_fee
153 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
156 nodes[0].node.timer_tick_occurred();
157 check_added_monitors!(nodes[0], 1);
159 let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
160 assert_eq!(events_0.len(), 1);
161 let (update_msg, commitment_signed) = match events_0[0] { // (1)
162 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
163 (update_fee.as_ref(), commitment_signed)
165 _ => panic!("Unexpected event"),
168 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
170 // ...but before it's delivered, nodes[1] starts to send a payment back to nodes[0]...
171 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[0]);
172 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
173 nodes[1].node.send_payment(&get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &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();
174 check_added_monitors!(nodes[1], 1);
176 let payment_event = {
177 let mut events_1 = nodes[1].node.get_and_clear_pending_msg_events();
178 assert_eq!(events_1.len(), 1);
179 SendEvent::from_event(events_1.remove(0))
181 assert_eq!(payment_event.node_id, nodes[0].node.get_our_node_id());
182 assert_eq!(payment_event.msgs.len(), 1);
184 // ...now when the messages get delivered everyone should be happy
185 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
186 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg); // (2)
187 let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
188 // nodes[0] is awaiting nodes[1] revoke_and_ack so get_event_msg's assert(len == 1) passes
189 check_added_monitors!(nodes[0], 1);
191 // deliver(1), generate (3):
192 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
193 let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
194 // nodes[1] is awaiting nodes[0] revoke_and_ack so get_event_msg's assert(len == 1) passes
195 check_added_monitors!(nodes[1], 1);
197 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack); // deliver (2)
198 let bs_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
199 assert!(bs_update.update_add_htlcs.is_empty()); // (4)
200 assert!(bs_update.update_fulfill_htlcs.is_empty()); // (4)
201 assert!(bs_update.update_fail_htlcs.is_empty()); // (4)
202 assert!(bs_update.update_fail_malformed_htlcs.is_empty()); // (4)
203 assert!(bs_update.update_fee.is_none()); // (4)
204 check_added_monitors!(nodes[1], 1);
206 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack); // deliver (3)
207 let as_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
208 assert!(as_update.update_add_htlcs.is_empty()); // (5)
209 assert!(as_update.update_fulfill_htlcs.is_empty()); // (5)
210 assert!(as_update.update_fail_htlcs.is_empty()); // (5)
211 assert!(as_update.update_fail_malformed_htlcs.is_empty()); // (5)
212 assert!(as_update.update_fee.is_none()); // (5)
213 check_added_monitors!(nodes[0], 1);
215 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_update.commitment_signed); // deliver (4)
216 let as_second_revoke = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
217 // only (6) so get_event_msg's assert(len == 1) passes
218 check_added_monitors!(nodes[0], 1);
220 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_update.commitment_signed); // deliver (5)
221 let bs_second_revoke = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
222 check_added_monitors!(nodes[1], 1);
224 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke);
225 check_added_monitors!(nodes[0], 1);
227 let events_2 = nodes[0].node.get_and_clear_pending_events();
228 assert_eq!(events_2.len(), 1);
230 Event::PendingHTLCsForwardable {..} => {}, // If we actually processed we'd receive the payment
231 _ => panic!("Unexpected event"),
234 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_revoke); // deliver (6)
235 check_added_monitors!(nodes[1], 1);
239 fn test_update_fee_unordered_raa() {
240 // Just the intro to the previous test followed by an out-of-order RAA (which caused a
241 // crash in an earlier version of the update_fee patch)
242 let chanmon_cfgs = create_chanmon_cfgs(2);
243 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
244 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
245 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
246 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
247 let logger = test_utils::TestLogger::new();
250 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
252 // First nodes[0] generates an update_fee
254 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
257 nodes[0].node.timer_tick_occurred();
258 check_added_monitors!(nodes[0], 1);
260 let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
261 assert_eq!(events_0.len(), 1);
262 let update_msg = match events_0[0] { // (1)
263 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, .. }, .. } => {
266 _ => panic!("Unexpected event"),
269 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
271 // ...but before it's delivered, nodes[1] starts to send a payment back to nodes[0]...
272 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[0]);
273 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
274 nodes[1].node.send_payment(&get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &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();
275 check_added_monitors!(nodes[1], 1);
277 let payment_event = {
278 let mut events_1 = nodes[1].node.get_and_clear_pending_msg_events();
279 assert_eq!(events_1.len(), 1);
280 SendEvent::from_event(events_1.remove(0))
282 assert_eq!(payment_event.node_id, nodes[0].node.get_our_node_id());
283 assert_eq!(payment_event.msgs.len(), 1);
285 // ...now when the messages get delivered everyone should be happy
286 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
287 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg); // (2)
288 let as_revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
289 // nodes[0] is awaiting nodes[1] revoke_and_ack so get_event_msg's assert(len == 1) passes
290 check_added_monitors!(nodes[0], 1);
292 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_msg); // deliver (2)
293 check_added_monitors!(nodes[1], 1);
295 // We can't continue, sadly, because our (1) now has a bogus signature
299 fn test_multi_flight_update_fee() {
300 let chanmon_cfgs = create_chanmon_cfgs(2);
301 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
302 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
303 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
304 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
307 // update_fee/commitment_signed ->
308 // .- send (1) RAA and (2) commitment_signed
309 // update_fee (never committed) ->
311 // We have to manually generate the above update_fee, it is allowed by the protocol but we
312 // don't track which updates correspond to which revoke_and_ack responses so we're in
313 // AwaitingRAA mode and will not generate the update_fee yet.
314 // <- (1) RAA delivered
315 // (3) is generated and send (4) CS -.
316 // Note that A cannot generate (4) prior to (1) being delivered as it otherwise doesn't
317 // know the per_commitment_point to use for it.
318 // <- (2) commitment_signed delivered
320 // B should send no response here
321 // (4) commitment_signed delivered ->
322 // <- RAA/commitment_signed delivered
325 // First nodes[0] generates an update_fee
328 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
329 initial_feerate = *feerate_lock;
330 *feerate_lock = initial_feerate + 20;
332 nodes[0].node.timer_tick_occurred();
333 check_added_monitors!(nodes[0], 1);
335 let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
336 assert_eq!(events_0.len(), 1);
337 let (update_msg_1, commitment_signed_1) = match events_0[0] { // (1)
338 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
339 (update_fee.as_ref().unwrap(), commitment_signed)
341 _ => panic!("Unexpected event"),
344 // Deliver first update_fee/commitment_signed pair, generating (1) and (2):
345 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg_1);
346 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed_1);
347 let (bs_revoke_msg, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
348 check_added_monitors!(nodes[1], 1);
350 // nodes[0] is awaiting a revoke from nodes[1] before it will create a new commitment
353 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
354 *feerate_lock = initial_feerate + 40;
356 nodes[0].node.timer_tick_occurred();
357 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
358 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
360 // Create the (3) update_fee message that nodes[0] will generate before it does...
361 let mut update_msg_2 = msgs::UpdateFee {
362 channel_id: update_msg_1.channel_id.clone(),
363 feerate_per_kw: (initial_feerate + 30) as u32,
366 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg_2);
368 update_msg_2.feerate_per_kw = (initial_feerate + 40) as u32;
370 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg_2);
372 // Deliver (1), generating (3) and (4)
373 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_msg);
374 let as_second_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
375 check_added_monitors!(nodes[0], 1);
376 assert!(as_second_update.update_add_htlcs.is_empty());
377 assert!(as_second_update.update_fulfill_htlcs.is_empty());
378 assert!(as_second_update.update_fail_htlcs.is_empty());
379 assert!(as_second_update.update_fail_malformed_htlcs.is_empty());
380 // Check that the update_fee newly generated matches what we delivered:
381 assert_eq!(as_second_update.update_fee.as_ref().unwrap().channel_id, update_msg_2.channel_id);
382 assert_eq!(as_second_update.update_fee.as_ref().unwrap().feerate_per_kw, update_msg_2.feerate_per_kw);
384 // Deliver (2) commitment_signed
385 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_commitment_signed);
386 let as_revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
387 check_added_monitors!(nodes[0], 1);
388 // No commitment_signed so get_event_msg's assert(len == 1) passes
390 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_msg);
391 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
392 check_added_monitors!(nodes[1], 1);
395 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_second_update.commitment_signed);
396 let (bs_second_revoke, bs_second_commitment) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
397 check_added_monitors!(nodes[1], 1);
399 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke);
400 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
401 check_added_monitors!(nodes[0], 1);
403 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_commitment);
404 let as_second_revoke = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
405 // No commitment_signed so get_event_msg's assert(len == 1) passes
406 check_added_monitors!(nodes[0], 1);
408 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_revoke);
409 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
410 check_added_monitors!(nodes[1], 1);
413 fn do_test_1_conf_open(connect_style: ConnectStyle) {
414 // Previously, if the minium_depth config was set to 1, we'd never send a funding_locked. This
415 // tests that we properly send one in that case.
416 let mut alice_config = UserConfig::default();
417 alice_config.own_channel_config.minimum_depth = 1;
418 alice_config.channel_options.announced_channel = true;
419 alice_config.peer_channel_config_limits.force_announced_channel_preference = false;
420 let mut bob_config = UserConfig::default();
421 bob_config.own_channel_config.minimum_depth = 1;
422 bob_config.channel_options.announced_channel = true;
423 bob_config.peer_channel_config_limits.force_announced_channel_preference = false;
424 let chanmon_cfgs = create_chanmon_cfgs(2);
425 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
426 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[Some(alice_config), Some(bob_config)]);
427 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
428 *nodes[0].connect_style.borrow_mut() = connect_style;
430 let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
431 mine_transaction(&nodes[1], &tx);
432 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()));
434 mine_transaction(&nodes[0], &tx);
435 let (funding_locked, _) = create_chan_between_nodes_with_value_confirm_second(&nodes[1], &nodes[0]);
436 let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
439 assert!(node.net_graph_msg_handler.handle_channel_announcement(&announcement).unwrap());
440 node.net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
441 node.net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
445 fn test_1_conf_open() {
446 do_test_1_conf_open(ConnectStyle::BestBlockFirst);
447 do_test_1_conf_open(ConnectStyle::TransactionsFirst);
448 do_test_1_conf_open(ConnectStyle::FullBlockViaListen);
451 fn do_test_sanity_on_in_flight_opens(steps: u8) {
452 // Previously, we had issues deserializing channels when we hadn't connected the first block
453 // after creation. To catch that and similar issues, we lean on the Node::drop impl to test
454 // serialization round-trips and simply do steps towards opening a channel and then drop the
457 let chanmon_cfgs = create_chanmon_cfgs(2);
458 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
459 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
460 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
462 if steps & 0b1000_0000 != 0{
464 header: BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
467 connect_block(&nodes[0], &block);
468 connect_block(&nodes[1], &block);
471 if steps & 0x0f == 0 { return; }
472 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
473 let open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
475 if steps & 0x0f == 1 { return; }
476 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_channel);
477 let accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
479 if steps & 0x0f == 2 { return; }
480 nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &accept_channel);
482 let (temporary_channel_id, tx, funding_output) = create_funding_transaction(&nodes[0], 100000, 42);
484 if steps & 0x0f == 3 { return; }
485 nodes[0].node.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
486 check_added_monitors!(nodes[0], 0);
487 let funding_created = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
489 if steps & 0x0f == 4 { return; }
490 nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created);
492 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
493 assert_eq!(added_monitors.len(), 1);
494 assert_eq!(added_monitors[0].0, funding_output);
495 added_monitors.clear();
497 let funding_signed = get_event_msg!(nodes[1], MessageSendEvent::SendFundingSigned, nodes[0].node.get_our_node_id());
499 if steps & 0x0f == 5 { return; }
500 nodes[0].node.handle_funding_signed(&nodes[1].node.get_our_node_id(), &funding_signed);
502 let mut added_monitors = nodes[0].chain_monitor.added_monitors.lock().unwrap();
503 assert_eq!(added_monitors.len(), 1);
504 assert_eq!(added_monitors[0].0, funding_output);
505 added_monitors.clear();
508 let events_4 = nodes[0].node.get_and_clear_pending_events();
509 assert_eq!(events_4.len(), 0);
511 if steps & 0x0f == 6 { return; }
512 create_chan_between_nodes_with_value_confirm_first(&nodes[0], &nodes[1], &tx, 2);
514 if steps & 0x0f == 7 { return; }
515 confirm_transaction_at(&nodes[0], &tx, 2);
516 connect_blocks(&nodes[0], CHAN_CONFIRM_DEPTH);
517 create_chan_between_nodes_with_value_confirm_second(&nodes[1], &nodes[0]);
521 fn test_sanity_on_in_flight_opens() {
522 do_test_sanity_on_in_flight_opens(0);
523 do_test_sanity_on_in_flight_opens(0 | 0b1000_0000);
524 do_test_sanity_on_in_flight_opens(1);
525 do_test_sanity_on_in_flight_opens(1 | 0b1000_0000);
526 do_test_sanity_on_in_flight_opens(2);
527 do_test_sanity_on_in_flight_opens(2 | 0b1000_0000);
528 do_test_sanity_on_in_flight_opens(3);
529 do_test_sanity_on_in_flight_opens(3 | 0b1000_0000);
530 do_test_sanity_on_in_flight_opens(4);
531 do_test_sanity_on_in_flight_opens(4 | 0b1000_0000);
532 do_test_sanity_on_in_flight_opens(5);
533 do_test_sanity_on_in_flight_opens(5 | 0b1000_0000);
534 do_test_sanity_on_in_flight_opens(6);
535 do_test_sanity_on_in_flight_opens(6 | 0b1000_0000);
536 do_test_sanity_on_in_flight_opens(7);
537 do_test_sanity_on_in_flight_opens(7 | 0b1000_0000);
538 do_test_sanity_on_in_flight_opens(8);
539 do_test_sanity_on_in_flight_opens(8 | 0b1000_0000);
543 fn test_update_fee_vanilla() {
544 let chanmon_cfgs = create_chanmon_cfgs(2);
545 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
546 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
547 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
548 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
551 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
554 nodes[0].node.timer_tick_occurred();
555 check_added_monitors!(nodes[0], 1);
557 let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
558 assert_eq!(events_0.len(), 1);
559 let (update_msg, commitment_signed) = match events_0[0] {
560 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 } } => {
561 (update_fee.as_ref(), commitment_signed)
563 _ => panic!("Unexpected event"),
565 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
567 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
568 let (revoke_msg, commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
569 check_added_monitors!(nodes[1], 1);
571 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
572 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
573 check_added_monitors!(nodes[0], 1);
575 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
576 let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
577 // No commitment_signed so get_event_msg's assert(len == 1) passes
578 check_added_monitors!(nodes[0], 1);
580 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg);
581 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
582 check_added_monitors!(nodes[1], 1);
586 fn test_update_fee_that_funder_cannot_afford() {
587 let chanmon_cfgs = create_chanmon_cfgs(2);
588 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
589 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
590 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
591 let channel_value = 1888;
592 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, channel_value, 700000, InitFeatures::known(), InitFeatures::known());
593 let channel_id = chan.2;
597 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
598 *feerate_lock = feerate;
600 nodes[0].node.timer_tick_occurred();
601 check_added_monitors!(nodes[0], 1);
602 let update_msg = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
604 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg.update_fee.unwrap());
606 commitment_signed_dance!(nodes[1], nodes[0], update_msg.commitment_signed, false);
608 //Confirm that the new fee based on the last local commitment txn is what we expected based on the feerate of 260 set above.
609 //This value results in a fee that is exactly what the funder can afford (277 sat + 1000 sat channel reserve)
611 let commitment_tx = get_local_commitment_txn!(nodes[1], channel_id)[0].clone();
613 //We made sure neither party's funds are below the dust limit so -2 non-HTLC txns from number of outputs
614 let num_htlcs = commitment_tx.output.len() - 2;
615 let total_fee: u64 = feerate as u64 * (COMMITMENT_TX_BASE_WEIGHT + (num_htlcs as u64) * COMMITMENT_TX_WEIGHT_PER_HTLC) / 1000;
616 let mut actual_fee = commitment_tx.output.iter().fold(0, |acc, output| acc + output.value);
617 actual_fee = channel_value - actual_fee;
618 assert_eq!(total_fee, actual_fee);
621 //Add 2 to the previous fee rate to the final fee increases by 1 (with no HTLCs the fee is essentially
622 //fee_rate*(724/1000) so the increment of 1*0.724 is rounded back down)
624 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
625 *feerate_lock = feerate + 2;
627 nodes[0].node.timer_tick_occurred();
628 check_added_monitors!(nodes[0], 1);
630 let update2_msg = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
632 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update2_msg.update_fee.unwrap());
634 //While producing the commitment_signed response after handling a received update_fee request the
635 //check to see if the funder, who sent the update_fee request, can afford the new fee (funder_balance >= fee+channel_reserve)
636 //Should produce and error.
637 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &update2_msg.commitment_signed);
638 nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Funding remote cannot afford proposed new fee".to_string(), 1);
639 check_added_monitors!(nodes[1], 1);
640 check_closed_broadcast!(nodes[1], true);
641 check_closed_event!(nodes[1], 1, ClosureReason::ProcessingError { err: String::from("Funding remote cannot afford proposed new fee") });
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, &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);
742 check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure);
743 check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure);
747 fn test_update_fee() {
748 let chanmon_cfgs = create_chanmon_cfgs(2);
749 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
750 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
751 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
752 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
753 let channel_id = chan.2;
756 // (1) update_fee/commitment_signed ->
757 // <- (2) revoke_and_ack
758 // .- send (3) commitment_signed
759 // (4) update_fee/commitment_signed ->
760 // .- send (5) revoke_and_ack (no CS as we're awaiting a revoke)
761 // <- (3) commitment_signed delivered
762 // send (6) revoke_and_ack -.
763 // <- (5) deliver revoke_and_ack
764 // (6) deliver revoke_and_ack ->
765 // .- send (7) commitment_signed in response to (4)
766 // <- (7) deliver commitment_signed
769 // Create and deliver (1)...
772 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
773 feerate = *feerate_lock;
774 *feerate_lock = feerate + 20;
776 nodes[0].node.timer_tick_occurred();
777 check_added_monitors!(nodes[0], 1);
779 let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
780 assert_eq!(events_0.len(), 1);
781 let (update_msg, commitment_signed) = match events_0[0] {
782 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 } } => {
783 (update_fee.as_ref(), commitment_signed)
785 _ => panic!("Unexpected event"),
787 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
789 // Generate (2) and (3):
790 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
791 let (revoke_msg, commitment_signed_0) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
792 check_added_monitors!(nodes[1], 1);
795 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
796 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
797 check_added_monitors!(nodes[0], 1);
799 // Create and deliver (4)...
801 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
802 *feerate_lock = feerate + 30;
804 nodes[0].node.timer_tick_occurred();
805 check_added_monitors!(nodes[0], 1);
806 let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
807 assert_eq!(events_0.len(), 1);
808 let (update_msg, commitment_signed) = match events_0[0] {
809 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 } } => {
810 (update_fee.as_ref(), commitment_signed)
812 _ => panic!("Unexpected event"),
815 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
816 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
817 check_added_monitors!(nodes[1], 1);
819 let revoke_msg = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
820 // No commitment_signed so get_event_msg's assert(len == 1) passes
822 // Handle (3), creating (6):
823 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed_0);
824 check_added_monitors!(nodes[0], 1);
825 let revoke_msg_0 = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
826 // No commitment_signed so get_event_msg's assert(len == 1) passes
829 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
830 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
831 check_added_monitors!(nodes[0], 1);
833 // Deliver (6), creating (7):
834 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg_0);
835 let commitment_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
836 assert!(commitment_update.update_add_htlcs.is_empty());
837 assert!(commitment_update.update_fulfill_htlcs.is_empty());
838 assert!(commitment_update.update_fail_htlcs.is_empty());
839 assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
840 assert!(commitment_update.update_fee.is_none());
841 check_added_monitors!(nodes[1], 1);
844 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_update.commitment_signed);
845 check_added_monitors!(nodes[0], 1);
846 let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
847 // No commitment_signed so get_event_msg's assert(len == 1) passes
849 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg);
850 check_added_monitors!(nodes[1], 1);
851 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
853 assert_eq!(get_feerate!(nodes[0], channel_id), feerate + 30);
854 assert_eq!(get_feerate!(nodes[1], channel_id), feerate + 30);
855 close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true);
856 check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure);
857 check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure);
861 fn fake_network_test() {
862 // Simple test which builds a network of ChannelManagers, connects them to each other, and
863 // tests that payments get routed and transactions broadcast in semi-reasonable ways.
864 let chanmon_cfgs = create_chanmon_cfgs(4);
865 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
866 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
867 let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
869 // Create some initial channels
870 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
871 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
872 let chan_3 = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
874 // Rebalance the network a bit by relaying one payment through all the channels...
875 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000);
876 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000);
877 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000);
878 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000);
880 // Send some more payments
881 send_payment(&nodes[1], &vec!(&nodes[2], &nodes[3])[..], 1000000);
882 send_payment(&nodes[3], &vec!(&nodes[2], &nodes[1], &nodes[0])[..], 1000000);
883 send_payment(&nodes[3], &vec!(&nodes[2], &nodes[1])[..], 1000000);
885 // Test failure packets
886 let payment_hash_1 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 1000000).1;
887 fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], payment_hash_1);
889 // Add a new channel that skips 3
890 let chan_4 = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known());
892 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 1000000);
893 send_payment(&nodes[2], &vec!(&nodes[3])[..], 1000000);
894 send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
895 send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
896 send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
897 send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
898 send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
900 // Do some rebalance loop payments, simultaneously
901 let mut hops = Vec::with_capacity(3);
903 pubkey: nodes[2].node.get_our_node_id(),
904 node_features: NodeFeatures::empty(),
905 short_channel_id: chan_2.0.contents.short_channel_id,
906 channel_features: ChannelFeatures::empty(),
908 cltv_expiry_delta: chan_3.0.contents.cltv_expiry_delta as u32
911 pubkey: nodes[3].node.get_our_node_id(),
912 node_features: NodeFeatures::empty(),
913 short_channel_id: chan_3.0.contents.short_channel_id,
914 channel_features: ChannelFeatures::empty(),
916 cltv_expiry_delta: chan_4.1.contents.cltv_expiry_delta as u32
919 pubkey: nodes[1].node.get_our_node_id(),
920 node_features: NodeFeatures::known(),
921 short_channel_id: chan_4.0.contents.short_channel_id,
922 channel_features: ChannelFeatures::known(),
924 cltv_expiry_delta: TEST_FINAL_CLTV,
926 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;
927 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;
928 let payment_preimage_1 = send_along_route(&nodes[1], Route { paths: vec![hops] }, &vec!(&nodes[2], &nodes[3], &nodes[1])[..], 1000000).0;
930 let mut hops = Vec::with_capacity(3);
932 pubkey: nodes[3].node.get_our_node_id(),
933 node_features: NodeFeatures::empty(),
934 short_channel_id: chan_4.0.contents.short_channel_id,
935 channel_features: ChannelFeatures::empty(),
937 cltv_expiry_delta: chan_3.1.contents.cltv_expiry_delta as u32
940 pubkey: nodes[2].node.get_our_node_id(),
941 node_features: NodeFeatures::empty(),
942 short_channel_id: chan_3.0.contents.short_channel_id,
943 channel_features: ChannelFeatures::empty(),
945 cltv_expiry_delta: chan_2.1.contents.cltv_expiry_delta as u32
948 pubkey: nodes[1].node.get_our_node_id(),
949 node_features: NodeFeatures::known(),
950 short_channel_id: chan_2.0.contents.short_channel_id,
951 channel_features: ChannelFeatures::known(),
953 cltv_expiry_delta: TEST_FINAL_CLTV,
955 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;
956 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;
957 let payment_hash_2 = send_along_route(&nodes[1], Route { paths: vec![hops] }, &vec!(&nodes[3], &nodes[2], &nodes[1])[..], 1000000).1;
959 // Claim the rebalances...
960 fail_payment(&nodes[1], &vec!(&nodes[3], &nodes[2], &nodes[1])[..], payment_hash_2);
961 claim_payment(&nodes[1], &vec!(&nodes[2], &nodes[3], &nodes[1])[..], payment_preimage_1);
963 // Add a duplicate new channel from 2 to 4
964 let chan_5 = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known());
966 // Send some payments across both channels
967 let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
968 let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
969 let payment_preimage_5 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
972 route_over_limit(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000);
973 let events = nodes[0].node.get_and_clear_pending_msg_events();
974 assert_eq!(events.len(), 0);
975 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);
977 //TODO: Test that routes work again here as we've been notified that the channel is full
979 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_3);
980 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_4);
981 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_5);
983 // Close down the channels...
984 close_channel(&nodes[0], &nodes[1], &chan_1.2, chan_1.3, true);
985 check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure);
986 check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure);
987 close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, false);
988 check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure);
989 check_closed_event!(nodes[2], 1, ClosureReason::CooperativeClosure);
990 close_channel(&nodes[2], &nodes[3], &chan_3.2, chan_3.3, true);
991 check_closed_event!(nodes[2], 1, ClosureReason::CooperativeClosure);
992 check_closed_event!(nodes[3], 1, ClosureReason::CooperativeClosure);
993 close_channel(&nodes[1], &nodes[3], &chan_4.2, chan_4.3, false);
994 check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure);
995 check_closed_event!(nodes[3], 1, ClosureReason::CooperativeClosure);
996 close_channel(&nodes[1], &nodes[3], &chan_5.2, chan_5.3, false);
997 check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure);
998 check_closed_event!(nodes[3], 1, ClosureReason::CooperativeClosure);
1002 fn holding_cell_htlc_counting() {
1003 // Tests that HTLCs in the holding cell count towards the pending HTLC limits on outbound HTLCs
1004 // to ensure we don't end up with HTLCs sitting around in our holding cell for several
1005 // commitment dance rounds.
1006 let chanmon_cfgs = create_chanmon_cfgs(3);
1007 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1008 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1009 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1010 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
1011 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
1012 let logger = test_utils::TestLogger::new();
1014 let mut payments = Vec::new();
1015 for _ in 0..::ln::channel::OUR_MAX_HTLCS {
1016 let (payment_preimage, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[2]);
1017 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
1018 let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[2].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
1019 nodes[1].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
1020 payments.push((payment_preimage, payment_hash));
1022 check_added_monitors!(nodes[1], 1);
1024 let mut events = nodes[1].node.get_and_clear_pending_msg_events();
1025 assert_eq!(events.len(), 1);
1026 let initial_payment_event = SendEvent::from_event(events.pop().unwrap());
1027 assert_eq!(initial_payment_event.node_id, nodes[2].node.get_our_node_id());
1029 // There is now one HTLC in an outbound commitment transaction and (OUR_MAX_HTLCS - 1) HTLCs in
1030 // the holding cell waiting on B's RAA to send. At this point we should not be able to add
1032 let (_, payment_hash_1, payment_secret_1) = get_payment_preimage_hash!(nodes[2]);
1034 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
1035 let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[2].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
1036 unwrap_send_err!(nodes[1].node.send_payment(&route, payment_hash_1, &Some(payment_secret_1)), true, APIError::ChannelUnavailable { ref err },
1037 assert!(regex::Regex::new(r"Cannot push more than their max accepted HTLCs \(\d+\)").unwrap().is_match(err)));
1038 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1039 nodes[1].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot push more than their max accepted HTLCs".to_string(), 1);
1042 // This should also be true if we try to forward a payment.
1043 let (_, payment_hash_2, payment_secret_2) = get_payment_preimage_hash!(nodes[2]);
1045 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
1046 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[2].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
1047 nodes[0].node.send_payment(&route, payment_hash_2, &Some(payment_secret_2)).unwrap();
1048 check_added_monitors!(nodes[0], 1);
1051 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1052 assert_eq!(events.len(), 1);
1053 let payment_event = SendEvent::from_event(events.pop().unwrap());
1054 assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
1056 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1057 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
1058 // We have to forward pending HTLCs twice - once tries to forward the payment forward (and
1059 // fails), the second will process the resulting failure and fail the HTLC backward.
1060 expect_pending_htlcs_forwardable!(nodes[1]);
1061 expect_pending_htlcs_forwardable!(nodes[1]);
1062 check_added_monitors!(nodes[1], 1);
1064 let bs_fail_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1065 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &bs_fail_updates.update_fail_htlcs[0]);
1066 commitment_signed_dance!(nodes[0], nodes[1], bs_fail_updates.commitment_signed, false, true);
1068 expect_payment_failed_with_update!(nodes[0], payment_hash_2, false, chan_2.0.contents.short_channel_id, false);
1070 // Now forward all the pending HTLCs and claim them back
1071 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &initial_payment_event.msgs[0]);
1072 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &initial_payment_event.commitment_msg);
1073 check_added_monitors!(nodes[2], 1);
1075 let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1076 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_revoke_and_ack);
1077 check_added_monitors!(nodes[1], 1);
1078 let as_updates = get_htlc_update_msgs!(nodes[1], nodes[2].node.get_our_node_id());
1080 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &bs_commitment_signed);
1081 check_added_monitors!(nodes[1], 1);
1082 let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
1084 for ref update in as_updates.update_add_htlcs.iter() {
1085 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), update);
1087 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &as_updates.commitment_signed);
1088 check_added_monitors!(nodes[2], 1);
1089 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
1090 check_added_monitors!(nodes[2], 1);
1091 let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1093 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_revoke_and_ack);
1094 check_added_monitors!(nodes[1], 1);
1095 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &bs_commitment_signed);
1096 check_added_monitors!(nodes[1], 1);
1097 let as_final_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
1099 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_final_raa);
1100 check_added_monitors!(nodes[2], 1);
1102 expect_pending_htlcs_forwardable!(nodes[2]);
1104 let events = nodes[2].node.get_and_clear_pending_events();
1105 assert_eq!(events.len(), payments.len());
1106 for (event, &(_, ref hash)) in events.iter().zip(payments.iter()) {
1108 &Event::PaymentReceived { ref payment_hash, .. } => {
1109 assert_eq!(*payment_hash, *hash);
1111 _ => panic!("Unexpected event"),
1115 for (preimage, _) in payments.drain(..) {
1116 claim_payment(&nodes[1], &[&nodes[2]], preimage);
1119 send_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1000000);
1123 fn duplicate_htlc_test() {
1124 // Test that we accept duplicate payment_hash HTLCs across the network and that
1125 // claiming/failing them are all separate and don't affect each other
1126 let chanmon_cfgs = create_chanmon_cfgs(6);
1127 let node_cfgs = create_node_cfgs(6, &chanmon_cfgs);
1128 let node_chanmgrs = create_node_chanmgrs(6, &node_cfgs, &[None, None, None, None, None, None]);
1129 let mut nodes = create_network(6, &node_cfgs, &node_chanmgrs);
1131 // Create some initial channels to route via 3 to 4/5 from 0/1/2
1132 create_announced_chan_between_nodes(&nodes, 0, 3, InitFeatures::known(), InitFeatures::known());
1133 create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known());
1134 create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
1135 create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::known(), InitFeatures::known());
1136 create_announced_chan_between_nodes(&nodes, 3, 5, InitFeatures::known(), InitFeatures::known());
1138 let (payment_preimage, payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[3], &nodes[4])[..], 1000000);
1140 *nodes[0].network_payment_count.borrow_mut() -= 1;
1141 assert_eq!(route_payment(&nodes[1], &vec!(&nodes[3])[..], 1000000).0, payment_preimage);
1143 *nodes[0].network_payment_count.borrow_mut() -= 1;
1144 assert_eq!(route_payment(&nodes[2], &vec!(&nodes[3], &nodes[5])[..], 1000000).0, payment_preimage);
1146 claim_payment(&nodes[0], &vec!(&nodes[3], &nodes[4])[..], payment_preimage);
1147 fail_payment(&nodes[2], &vec!(&nodes[3], &nodes[5])[..], payment_hash);
1148 claim_payment(&nodes[1], &vec!(&nodes[3])[..], payment_preimage);
1152 fn test_duplicate_htlc_different_direction_onchain() {
1153 // Test that ChannelMonitor doesn't generate 2 preimage txn
1154 // when we have 2 HTLCs with same preimage that go across a node
1155 // in opposite directions, even with the same payment secret.
1156 let chanmon_cfgs = create_chanmon_cfgs(2);
1157 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1158 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1159 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1161 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
1162 let logger = test_utils::TestLogger::new();
1165 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
1167 let (payment_preimage, payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 900_000);
1169 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
1170 let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[0].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 800_000, TEST_FINAL_CLTV, &logger).unwrap();
1171 let node_a_payment_secret = nodes[0].node.create_inbound_payment_for_hash(payment_hash, None, 7200, 0).unwrap();
1172 send_along_route_with_secret(&nodes[1], route, &[&[&nodes[0]]], 800_000, payment_hash, node_a_payment_secret);
1174 // Provide preimage to node 0 by claiming payment
1175 nodes[0].node.claim_funds(payment_preimage);
1176 check_added_monitors!(nodes[0], 1);
1178 // Broadcast node 1 commitment txn
1179 let remote_txn = get_local_commitment_txn!(nodes[1], chan_1.2);
1181 assert_eq!(remote_txn[0].output.len(), 4); // 1 local, 1 remote, 1 htlc inbound, 1 htlc outbound
1182 let mut has_both_htlcs = 0; // check htlcs match ones committed
1183 for outp in remote_txn[0].output.iter() {
1184 if outp.value == 800_000 / 1000 {
1185 has_both_htlcs += 1;
1186 } else if outp.value == 900_000 / 1000 {
1187 has_both_htlcs += 1;
1190 assert_eq!(has_both_htlcs, 2);
1192 mine_transaction(&nodes[0], &remote_txn[0]);
1193 check_added_monitors!(nodes[0], 1);
1194 check_closed_event!(nodes[0], 1, ClosureReason::CommitmentTxConfirmed);
1195 connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
1197 // Check we only broadcast 1 timeout tx
1198 let claim_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
1199 assert_eq!(claim_txn.len(), 8);
1200 assert_eq!(claim_txn[1], claim_txn[4]);
1201 assert_eq!(claim_txn[2], claim_txn[5]);
1202 check_spends!(claim_txn[1], chan_1.3);
1203 check_spends!(claim_txn[2], claim_txn[1]);
1204 check_spends!(claim_txn[7], claim_txn[1]);
1206 assert_eq!(claim_txn[0].input.len(), 1);
1207 assert_eq!(claim_txn[3].input.len(), 1);
1208 assert_eq!(claim_txn[0].input[0].previous_output, claim_txn[3].input[0].previous_output);
1210 assert_eq!(claim_txn[0].input.len(), 1);
1211 assert_eq!(claim_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC 1 <--> 0, preimage tx
1212 check_spends!(claim_txn[0], remote_txn[0]);
1213 assert_eq!(remote_txn[0].output[claim_txn[0].input[0].previous_output.vout as usize].value, 800);
1214 assert_eq!(claim_txn[6].input.len(), 1);
1215 assert_eq!(claim_txn[6].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // HTLC 0 <--> 1, timeout tx
1216 check_spends!(claim_txn[6], remote_txn[0]);
1217 assert_eq!(remote_txn[0].output[claim_txn[6].input[0].previous_output.vout as usize].value, 900);
1219 let events = nodes[0].node.get_and_clear_pending_msg_events();
1220 assert_eq!(events.len(), 3);
1223 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
1224 MessageSendEvent::HandleError { node_id, action: msgs::ErrorAction::SendErrorMessage { ref msg } } => {
1225 assert_eq!(node_id, nodes[1].node.get_our_node_id());
1226 assert_eq!(msg.data, "Commitment or closing transaction was confirmed on chain.");
1228 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, .. } } => {
1229 assert!(update_add_htlcs.is_empty());
1230 assert!(update_fail_htlcs.is_empty());
1231 assert_eq!(update_fulfill_htlcs.len(), 1);
1232 assert!(update_fail_malformed_htlcs.is_empty());
1233 assert_eq!(nodes[1].node.get_our_node_id(), *node_id);
1235 _ => panic!("Unexpected event"),
1241 fn test_basic_channel_reserve() {
1242 let chanmon_cfgs = create_chanmon_cfgs(2);
1243 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1244 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1245 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1246 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1247 let logger = test_utils::TestLogger::new();
1249 let chan_stat = get_channel_value_stat!(nodes[0], chan.2);
1250 let channel_reserve = chan_stat.channel_reserve_msat;
1252 // The 2* and +1 are for the fee spike reserve.
1253 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
1254 let commit_tx_fee = 2 * commit_tx_fee_msat(get_feerate!(nodes[0], chan.2), 1 + 1);
1255 let max_can_send = 5000000 - channel_reserve - commit_tx_fee;
1256 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
1257 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes.last().unwrap().node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), max_can_send + 1, TEST_FINAL_CLTV, &logger).unwrap();
1258 let err = nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).err().unwrap();
1260 PaymentSendFailure::AllFailedRetrySafe(ref fails) => {
1262 &APIError::ChannelUnavailable{ref err} =>
1263 assert!(regex::Regex::new(r"Cannot send value that would put our balance under counterparty-announced channel reserve value \(\d+\)").unwrap().is_match(err)),
1264 _ => panic!("Unexpected error variant"),
1267 _ => panic!("Unexpected error variant"),
1269 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1270 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);
1272 send_payment(&nodes[0], &vec![&nodes[1]], max_can_send);
1276 fn test_fee_spike_violation_fails_htlc() {
1277 let chanmon_cfgs = create_chanmon_cfgs(2);
1278 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1279 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1280 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1281 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1283 let (route, payment_hash, _, payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], 3460001);
1284 // Need to manually create the update_add_htlc message to go around the channel reserve check in send_htlc()
1285 let secp_ctx = Secp256k1::new();
1286 let session_priv = SecretKey::from_slice(&[42; 32]).expect("RNG is bad!");
1288 let cur_height = nodes[1].node.best_block.read().unwrap().height() + 1;
1290 let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route.paths[0], &session_priv).unwrap();
1291 let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 3460001, &Some(payment_secret), cur_height, &None).unwrap();
1292 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
1293 let msg = msgs::UpdateAddHTLC {
1296 amount_msat: htlc_msat,
1297 payment_hash: payment_hash,
1298 cltv_expiry: htlc_cltv,
1299 onion_routing_packet: onion_packet,
1302 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
1304 // Now manually create the commitment_signed message corresponding to the update_add
1305 // nodes[0] just sent. In the code for construction of this message, "local" refers
1306 // to the sender of the message, and "remote" refers to the receiver.
1308 let feerate_per_kw = get_feerate!(nodes[0], chan.2);
1310 const INITIAL_COMMITMENT_NUMBER: u64 = (1 << 48) - 1;
1312 // Get the EnforcingSigner for each channel, which will be used to (1) get the keys
1313 // needed to sign the new commitment tx and (2) sign the new commitment tx.
1314 let (local_revocation_basepoint, local_htlc_basepoint, local_secret, next_local_point, local_funding) = {
1315 let chan_lock = nodes[0].node.channel_state.lock().unwrap();
1316 let local_chan = chan_lock.by_id.get(&chan.2).unwrap();
1317 let chan_signer = local_chan.get_signer();
1318 // Make the signer believe we validated another commitment, so we can release the secret
1319 chan_signer.get_enforcement_state().last_holder_commitment -= 1;
1321 let pubkeys = chan_signer.pubkeys();
1322 (pubkeys.revocation_basepoint, pubkeys.htlc_basepoint,
1323 chan_signer.release_commitment_secret(INITIAL_COMMITMENT_NUMBER),
1324 chan_signer.get_per_commitment_point(INITIAL_COMMITMENT_NUMBER - 2, &secp_ctx),
1325 chan_signer.pubkeys().funding_pubkey)
1327 let (remote_delayed_payment_basepoint, remote_htlc_basepoint, remote_point, remote_funding) = {
1328 let chan_lock = nodes[1].node.channel_state.lock().unwrap();
1329 let remote_chan = chan_lock.by_id.get(&chan.2).unwrap();
1330 let chan_signer = remote_chan.get_signer();
1331 let pubkeys = chan_signer.pubkeys();
1332 (pubkeys.delayed_payment_basepoint, pubkeys.htlc_basepoint,
1333 chan_signer.get_per_commitment_point(INITIAL_COMMITMENT_NUMBER - 1, &secp_ctx),
1334 chan_signer.pubkeys().funding_pubkey)
1337 // Assemble the set of keys we can use for signatures for our commitment_signed message.
1338 let commit_tx_keys = chan_utils::TxCreationKeys::derive_new(&secp_ctx, &remote_point, &remote_delayed_payment_basepoint,
1339 &remote_htlc_basepoint, &local_revocation_basepoint, &local_htlc_basepoint).unwrap();
1341 // Build the remote commitment transaction so we can sign it, and then later use the
1342 // signature for the commitment_signed message.
1343 let local_chan_balance = 1313;
1345 let accepted_htlc_info = chan_utils::HTLCOutputInCommitment {
1347 amount_msat: 3460001,
1348 cltv_expiry: htlc_cltv,
1350 transaction_output_index: Some(1),
1353 let commitment_number = INITIAL_COMMITMENT_NUMBER - 1;
1356 let local_chan_lock = nodes[0].node.channel_state.lock().unwrap();
1357 let local_chan = local_chan_lock.by_id.get(&chan.2).unwrap();
1358 let local_chan_signer = local_chan.get_signer();
1359 let commitment_tx = CommitmentTransaction::new_with_auxiliary_htlc_data(
1363 false, local_funding, remote_funding,
1364 commit_tx_keys.clone(),
1366 &mut vec![(accepted_htlc_info, ())],
1367 &local_chan.channel_transaction_parameters.as_counterparty_broadcastable()
1369 local_chan_signer.sign_counterparty_commitment(&commitment_tx, &secp_ctx).unwrap()
1372 let commit_signed_msg = msgs::CommitmentSigned {
1375 htlc_signatures: res.1
1378 // Send the commitment_signed message to the nodes[1].
1379 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commit_signed_msg);
1380 let _ = nodes[1].node.get_and_clear_pending_msg_events();
1382 // Send the RAA to nodes[1].
1383 let raa_msg = msgs::RevokeAndACK {
1385 per_commitment_secret: local_secret,
1386 next_per_commitment_point: next_local_point
1388 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &raa_msg);
1390 let events = nodes[1].node.get_and_clear_pending_msg_events();
1391 assert_eq!(events.len(), 1);
1392 // Make sure the HTLC failed in the way we expect.
1394 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fail_htlcs, .. }, .. } => {
1395 assert_eq!(update_fail_htlcs.len(), 1);
1396 update_fail_htlcs[0].clone()
1398 _ => panic!("Unexpected event"),
1400 nodes[1].logger.assert_log("lightning::ln::channel".to_string(),
1401 format!("Attempting to fail HTLC due to fee spike buffer violation in channel {}. Rebalancing is required.", ::hex::encode(raa_msg.channel_id)), 1);
1403 check_added_monitors!(nodes[1], 2);
1407 fn test_chan_reserve_violation_outbound_htlc_inbound_chan() {
1408 let mut chanmon_cfgs = create_chanmon_cfgs(2);
1409 // Set the fee rate for the channel very high, to the point where the fundee
1410 // sending any above-dust amount would result in a channel reserve violation.
1411 // In this test we check that we would be prevented from sending an HTLC in
1413 let feerate_per_kw = 253;
1414 chanmon_cfgs[0].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(feerate_per_kw) };
1415 chanmon_cfgs[1].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(feerate_per_kw) };
1416 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1417 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1418 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1420 let mut push_amt = 100_000_000;
1421 push_amt -= feerate_per_kw as u64 * (COMMITMENT_TX_BASE_WEIGHT + COMMITMENT_TX_WEIGHT_PER_HTLC) / 1000 * 1000;
1422 push_amt -= Channel::<EnforcingSigner>::get_holder_selected_channel_reserve_satoshis(100_000) * 1000;
1424 let _ = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100_000, push_amt, InitFeatures::known(), InitFeatures::known());
1426 // Sending exactly enough to hit the reserve amount should be accepted
1427 let (_, _, _) = route_payment(&nodes[1], &[&nodes[0]], 1_000_000);
1429 // However one more HTLC should be significantly over the reserve amount and fail.
1430 let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[1], nodes[0], 1_000_000);
1431 unwrap_send_err!(nodes[1].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
1432 assert_eq!(err, "Cannot send value that would put counterparty balance under holder-announced channel reserve value"));
1433 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1434 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);
1438 fn test_chan_reserve_violation_inbound_htlc_outbound_channel() {
1439 let mut chanmon_cfgs = create_chanmon_cfgs(2);
1440 // Set the fee rate for the channel very high, to the point where the funder
1441 // receiving 1 update_add_htlc would result in them closing the channel due
1442 // to channel reserve violation. This close could also happen if the fee went
1443 // up a more realistic amount, but many HTLCs were outstanding at the time of
1444 // the update_add_htlc.
1445 chanmon_cfgs[0].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(6000) };
1446 chanmon_cfgs[1].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(6000) };
1447 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1448 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1449 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1450 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1452 let (route, payment_hash, _, payment_secret) = get_route_and_payment_hash!(nodes[1], nodes[0], 1000);
1453 // Need to manually create the update_add_htlc message to go around the channel reserve check in send_htlc()
1454 let secp_ctx = Secp256k1::new();
1455 let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
1456 let cur_height = nodes[1].node.best_block.read().unwrap().height() + 1;
1457 let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route.paths[0], &session_priv).unwrap();
1458 let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 1000, &Some(payment_secret), cur_height, &None).unwrap();
1459 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
1460 let msg = msgs::UpdateAddHTLC {
1463 amount_msat: htlc_msat + 1,
1464 payment_hash: payment_hash,
1465 cltv_expiry: htlc_cltv,
1466 onion_routing_packet: onion_packet,
1469 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &msg);
1470 // Check that the payment failed and the channel is closed in response to the malicious UpdateAdd.
1471 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);
1472 assert_eq!(nodes[0].node.list_channels().len(), 0);
1473 let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
1474 assert_eq!(err_msg.data, "Cannot accept HTLC that would put our balance under counterparty-announced channel reserve value");
1475 check_added_monitors!(nodes[0], 1);
1476 check_closed_event!(nodes[0], 1, ClosureReason::ProcessingError { err: "Cannot accept HTLC that would put our balance under counterparty-announced channel reserve value".to_string() });
1480 fn test_chan_reserve_dust_inbound_htlcs_outbound_chan() {
1481 // Test that if we receive many dust HTLCs over an outbound channel, they don't count when
1482 // calculating our commitment transaction fee (this was previously broken).
1483 let mut chanmon_cfgs = create_chanmon_cfgs(2);
1484 let feerate_per_kw = 253;
1485 chanmon_cfgs[0].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(feerate_per_kw) };
1486 chanmon_cfgs[1].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(feerate_per_kw) };
1488 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1489 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None, None]);
1490 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1492 // Set nodes[0]'s balance such that they will consider any above-dust received HTLC to be a
1493 // channel reserve violation (so their balance is channel reserve (1000 sats) + commitment
1494 // transaction fee with 0 HTLCs (183 sats)).
1495 let mut push_amt = 100_000_000;
1496 push_amt -= feerate_per_kw as u64 * (COMMITMENT_TX_BASE_WEIGHT) / 1000 * 1000;
1497 push_amt -= Channel::<EnforcingSigner>::get_holder_selected_channel_reserve_satoshis(100_000) * 1000;
1498 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, push_amt, InitFeatures::known(), InitFeatures::known());
1500 let dust_amt = crate::ln::channel::MIN_DUST_LIMIT_SATOSHIS * 1000
1501 + feerate_per_kw as u64 * HTLC_SUCCESS_TX_WEIGHT / 1000 * 1000 - 1;
1502 // In the previous code, routing this dust payment would cause nodes[0] to perceive a channel
1503 // reserve violation even though it's a dust HTLC and therefore shouldn't count towards the
1504 // commitment transaction fee.
1505 let (_, _, _) = route_payment(&nodes[1], &[&nodes[0]], dust_amt);
1507 // One more than the dust amt should fail, however.
1508 let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[1], nodes[0], dust_amt + 1);
1509 unwrap_send_err!(nodes[1].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
1510 assert_eq!(err, "Cannot send value that would put counterparty balance under holder-announced channel reserve value"));
1514 fn test_chan_reserve_dust_inbound_htlcs_inbound_chan() {
1515 // Test that if we receive many dust HTLCs over an inbound channel, they don't count when
1516 // calculating our counterparty's commitment transaction fee (this was previously broken).
1517 let chanmon_cfgs = create_chanmon_cfgs(2);
1518 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1519 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None, None]);
1520 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1521 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 98000000, InitFeatures::known(), InitFeatures::known());
1523 let payment_amt = 46000; // Dust amount
1524 // In the previous code, these first four payments would succeed.
1525 let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1526 let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1527 let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1528 let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1530 // Then these next 5 would be interpreted by nodes[1] as violating the fee spike buffer.
1531 let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1532 let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1533 let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1534 let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1535 let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1537 // And this last payment previously resulted in nodes[1] closing on its inbound-channel
1538 // counterparty, because it counted all the previous dust HTLCs against nodes[0]'s commitment
1539 // transaction fee and therefore perceived this next payment as a channel reserve violation.
1540 let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1544 fn test_chan_reserve_violation_inbound_htlc_inbound_chan() {
1545 let chanmon_cfgs = create_chanmon_cfgs(3);
1546 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1547 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1548 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1549 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1550 let _ = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1553 let total_routing_fee_msat = (nodes.len() - 2) as u64 * feemsat;
1554 let chan_stat = get_channel_value_stat!(nodes[0], chan.2);
1555 let feerate = get_feerate!(nodes[0], chan.2);
1557 // Add a 2* and +1 for the fee spike reserve.
1558 let commit_tx_fee_2_htlc = 2*commit_tx_fee_msat(feerate, 2 + 1);
1559 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;
1560 let amt_msat_1 = recv_value_1 + total_routing_fee_msat;
1562 // Add a pending HTLC.
1563 let (route_1, our_payment_hash_1, _, our_payment_secret_1) = get_route_and_payment_hash!(nodes[0], nodes[2], amt_msat_1);
1564 let payment_event_1 = {
1565 nodes[0].node.send_payment(&route_1, our_payment_hash_1, &Some(our_payment_secret_1)).unwrap();
1566 check_added_monitors!(nodes[0], 1);
1568 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1569 assert_eq!(events.len(), 1);
1570 SendEvent::from_event(events.remove(0))
1572 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event_1.msgs[0]);
1574 // Attempt to trigger a channel reserve violation --> payment failure.
1575 let commit_tx_fee_2_htlcs = commit_tx_fee_msat(feerate, 2);
1576 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;
1577 let amt_msat_2 = recv_value_2 + total_routing_fee_msat;
1578 let (route_2, _, _, _) = get_route_and_payment_hash!(nodes[0], nodes[2], amt_msat_2);
1580 // Need to manually create the update_add_htlc message to go around the channel reserve check in send_htlc()
1581 let secp_ctx = Secp256k1::new();
1582 let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
1583 let cur_height = nodes[0].node.best_block.read().unwrap().height() + 1;
1584 let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route_2.paths[0], &session_priv).unwrap();
1585 let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route_2.paths[0], recv_value_2, &None, cur_height, &None).unwrap();
1586 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &our_payment_hash_1);
1587 let msg = msgs::UpdateAddHTLC {
1590 amount_msat: htlc_msat + 1,
1591 payment_hash: our_payment_hash_1,
1592 cltv_expiry: htlc_cltv,
1593 onion_routing_packet: onion_packet,
1596 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
1597 // Check that the payment failed and the channel is closed in response to the malicious UpdateAdd.
1598 nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Remote HTLC add would put them under remote reserve value".to_string(), 1);
1599 assert_eq!(nodes[1].node.list_channels().len(), 1);
1600 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
1601 assert_eq!(err_msg.data, "Remote HTLC add would put them under remote reserve value");
1602 check_added_monitors!(nodes[1], 1);
1603 check_closed_event!(nodes[1], 1, ClosureReason::ProcessingError { err: "Remote HTLC add would put them under remote reserve value".to_string() });
1607 fn test_inbound_outbound_capacity_is_not_zero() {
1608 let chanmon_cfgs = create_chanmon_cfgs(2);
1609 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1610 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1611 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1612 let _ = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1613 let channels0 = node_chanmgrs[0].list_channels();
1614 let channels1 = node_chanmgrs[1].list_channels();
1615 assert_eq!(channels0.len(), 1);
1616 assert_eq!(channels1.len(), 1);
1618 let reserve = Channel::<EnforcingSigner>::get_holder_selected_channel_reserve_satoshis(100000);
1619 assert_eq!(channels0[0].inbound_capacity_msat, 95000000 - reserve*1000);
1620 assert_eq!(channels1[0].outbound_capacity_msat, 95000000 - reserve*1000);
1622 assert_eq!(channels0[0].outbound_capacity_msat, 100000 * 1000 - 95000000 - reserve*1000);
1623 assert_eq!(channels1[0].inbound_capacity_msat, 100000 * 1000 - 95000000 - reserve*1000);
1626 fn commit_tx_fee_msat(feerate: u32, num_htlcs: u64) -> u64 {
1627 (COMMITMENT_TX_BASE_WEIGHT + num_htlcs * COMMITMENT_TX_WEIGHT_PER_HTLC) * feerate as u64 / 1000 * 1000
1631 fn test_channel_reserve_holding_cell_htlcs() {
1632 let chanmon_cfgs = create_chanmon_cfgs(3);
1633 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1634 // When this test was written, the default base fee floated based on the HTLC count.
1635 // It is now fixed, so we simply set the fee to the expected value here.
1636 let mut config = test_default_channel_config();
1637 config.channel_options.forwarding_fee_base_msat = 239;
1638 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[Some(config.clone()), Some(config.clone()), Some(config.clone())]);
1639 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1640 let chan_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 190000, 1001, InitFeatures::known(), InitFeatures::known());
1641 let chan_2 = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 190000, 1001, InitFeatures::known(), InitFeatures::known());
1643 let mut stat01 = get_channel_value_stat!(nodes[0], chan_1.2);
1644 let mut stat11 = get_channel_value_stat!(nodes[1], chan_1.2);
1646 let mut stat12 = get_channel_value_stat!(nodes[1], chan_2.2);
1647 let mut stat22 = get_channel_value_stat!(nodes[2], chan_2.2);
1649 macro_rules! expect_forward {
1651 let mut events = $node.node.get_and_clear_pending_msg_events();
1652 assert_eq!(events.len(), 1);
1653 check_added_monitors!($node, 1);
1654 let payment_event = SendEvent::from_event(events.remove(0));
1659 let feemsat = 239; // set above
1660 let total_fee_msat = (nodes.len() - 2) as u64 * feemsat;
1661 let feerate = get_feerate!(nodes[0], chan_1.2);
1663 let recv_value_0 = stat01.counterparty_max_htlc_value_in_flight_msat - total_fee_msat;
1665 // attempt to send amt_msat > their_max_htlc_value_in_flight_msat
1667 let (mut route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], recv_value_0);
1668 route.paths[0].last_mut().unwrap().fee_msat += 1;
1669 assert!(route.paths[0].iter().rev().skip(1).all(|h| h.fee_msat == feemsat));
1670 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
1671 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)));
1672 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1673 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);
1676 // channel reserve is bigger than their_max_htlc_value_in_flight_msat so loop to deplete
1677 // nodes[0]'s wealth
1679 let amt_msat = recv_value_0 + total_fee_msat;
1680 // 3 for the 3 HTLCs that will be sent, 2* and +1 for the fee spike reserve.
1681 // Also, ensure that each payment has enough to be over the dust limit to
1682 // ensure it'll be included in each commit tx fee calculation.
1683 let commit_tx_fee_all_htlcs = 2*commit_tx_fee_msat(feerate, 3 + 1);
1684 let ensure_htlc_amounts_above_dust_buffer = 3 * (stat01.counterparty_dust_limit_msat + 1000);
1685 if stat01.value_to_self_msat < stat01.channel_reserve_msat + commit_tx_fee_all_htlcs + ensure_htlc_amounts_above_dust_buffer + amt_msat {
1688 send_payment(&nodes[0], &vec![&nodes[1], &nodes[2]][..], recv_value_0);
1690 let (stat01_, stat11_, stat12_, stat22_) = (
1691 get_channel_value_stat!(nodes[0], chan_1.2),
1692 get_channel_value_stat!(nodes[1], chan_1.2),
1693 get_channel_value_stat!(nodes[1], chan_2.2),
1694 get_channel_value_stat!(nodes[2], chan_2.2),
1697 assert_eq!(stat01_.value_to_self_msat, stat01.value_to_self_msat - amt_msat);
1698 assert_eq!(stat11_.value_to_self_msat, stat11.value_to_self_msat + amt_msat);
1699 assert_eq!(stat12_.value_to_self_msat, stat12.value_to_self_msat - (amt_msat - feemsat));
1700 assert_eq!(stat22_.value_to_self_msat, stat22.value_to_self_msat + (amt_msat - feemsat));
1701 stat01 = stat01_; stat11 = stat11_; stat12 = stat12_; stat22 = stat22_;
1704 // adding pending output.
1705 // 2* and +1 HTLCs on the commit tx fee for the fee spike reserve.
1706 // The reason we're dividing by two here is as follows: the dividend is the total outbound liquidity
1707 // after fees, the channel reserve, and the fee spike buffer are removed. We eventually want to
1708 // divide this quantity into 3 portions, that will each be sent in an HTLC. This allows us
1709 // to test channel channel reserve policy at the edges of what amount is sendable, i.e.
1710 // cases where 1 msat over X amount will cause a payment failure, but anything less than
1711 // that can be sent successfully. So, dividing by two is a somewhat arbitrary way of getting
1712 // the amount of the first of these aforementioned 3 payments. The reason we split into 3 payments
1713 // is to test the behavior of the holding cell with respect to channel reserve and commit tx fee
1715 let commit_tx_fee_2_htlcs = 2*commit_tx_fee_msat(feerate, 2 + 1);
1716 let recv_value_1 = (stat01.value_to_self_msat - stat01.channel_reserve_msat - total_fee_msat - commit_tx_fee_2_htlcs)/2;
1717 let amt_msat_1 = recv_value_1 + total_fee_msat;
1719 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);
1720 let payment_event_1 = {
1721 nodes[0].node.send_payment(&route_1, our_payment_hash_1, &Some(our_payment_secret_1)).unwrap();
1722 check_added_monitors!(nodes[0], 1);
1724 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1725 assert_eq!(events.len(), 1);
1726 SendEvent::from_event(events.remove(0))
1728 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event_1.msgs[0]);
1730 // channel reserve test with htlc pending output > 0
1731 let recv_value_2 = stat01.value_to_self_msat - amt_msat_1 - stat01.channel_reserve_msat - total_fee_msat - commit_tx_fee_2_htlcs;
1733 let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], recv_value_2 + 1);
1734 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
1735 assert!(regex::Regex::new(r"Cannot send value that would put our balance under counterparty-announced channel reserve value \(\d+\)").unwrap().is_match(err)));
1736 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1739 // split the rest to test holding cell
1740 let commit_tx_fee_3_htlcs = 2*commit_tx_fee_msat(feerate, 3 + 1);
1741 let additional_htlc_cost_msat = commit_tx_fee_3_htlcs - commit_tx_fee_2_htlcs;
1742 let recv_value_21 = recv_value_2/2 - additional_htlc_cost_msat/2;
1743 let recv_value_22 = recv_value_2 - recv_value_21 - total_fee_msat - additional_htlc_cost_msat;
1745 let stat = get_channel_value_stat!(nodes[0], chan_1.2);
1746 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);
1749 // now see if they go through on both sides
1750 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);
1751 // but this will stuck in the holding cell
1752 nodes[0].node.send_payment(&route_21, our_payment_hash_21, &Some(our_payment_secret_21)).unwrap();
1753 check_added_monitors!(nodes[0], 0);
1754 let events = nodes[0].node.get_and_clear_pending_events();
1755 assert_eq!(events.len(), 0);
1757 // test with outbound holding cell amount > 0
1759 let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], recv_value_22+1);
1760 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
1761 assert!(regex::Regex::new(r"Cannot send value that would put our balance under counterparty-announced channel reserve value \(\d+\)").unwrap().is_match(err)));
1762 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1763 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);
1766 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);
1767 // this will also stuck in the holding cell
1768 nodes[0].node.send_payment(&route_22, our_payment_hash_22, &Some(our_payment_secret_22)).unwrap();
1769 check_added_monitors!(nodes[0], 0);
1770 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
1771 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1773 // flush the pending htlc
1774 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event_1.commitment_msg);
1775 let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1776 check_added_monitors!(nodes[1], 1);
1778 // the pending htlc should be promoted to committed
1779 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_revoke_and_ack);
1780 check_added_monitors!(nodes[0], 1);
1781 let commitment_update_2 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1783 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &as_commitment_signed);
1784 let bs_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1785 // No commitment_signed so get_event_msg's assert(len == 1) passes
1786 check_added_monitors!(nodes[0], 1);
1788 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &bs_revoke_and_ack);
1789 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1790 check_added_monitors!(nodes[1], 1);
1792 expect_pending_htlcs_forwardable!(nodes[1]);
1794 let ref payment_event_11 = expect_forward!(nodes[1]);
1795 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_11.msgs[0]);
1796 commitment_signed_dance!(nodes[2], nodes[1], payment_event_11.commitment_msg, false);
1798 expect_pending_htlcs_forwardable!(nodes[2]);
1799 expect_payment_received!(nodes[2], our_payment_hash_1, our_payment_secret_1, recv_value_1);
1801 // flush the htlcs in the holding cell
1802 assert_eq!(commitment_update_2.update_add_htlcs.len(), 2);
1803 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &commitment_update_2.update_add_htlcs[0]);
1804 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &commitment_update_2.update_add_htlcs[1]);
1805 commitment_signed_dance!(nodes[1], nodes[0], &commitment_update_2.commitment_signed, false);
1806 expect_pending_htlcs_forwardable!(nodes[1]);
1808 let ref payment_event_3 = expect_forward!(nodes[1]);
1809 assert_eq!(payment_event_3.msgs.len(), 2);
1810 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_3.msgs[0]);
1811 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_3.msgs[1]);
1813 commitment_signed_dance!(nodes[2], nodes[1], &payment_event_3.commitment_msg, false);
1814 expect_pending_htlcs_forwardable!(nodes[2]);
1816 let events = nodes[2].node.get_and_clear_pending_events();
1817 assert_eq!(events.len(), 2);
1819 Event::PaymentReceived { ref payment_hash, ref purpose, amt } => {
1820 assert_eq!(our_payment_hash_21, *payment_hash);
1821 assert_eq!(recv_value_21, amt);
1823 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
1824 assert!(payment_preimage.is_none());
1825 assert_eq!(our_payment_secret_21, *payment_secret);
1827 _ => panic!("expected PaymentPurpose::InvoicePayment")
1830 _ => panic!("Unexpected event"),
1833 Event::PaymentReceived { ref payment_hash, ref purpose, amt } => {
1834 assert_eq!(our_payment_hash_22, *payment_hash);
1835 assert_eq!(recv_value_22, amt);
1837 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
1838 assert!(payment_preimage.is_none());
1839 assert_eq!(our_payment_secret_22, *payment_secret);
1841 _ => panic!("expected PaymentPurpose::InvoicePayment")
1844 _ => panic!("Unexpected event"),
1847 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_1);
1848 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_21);
1849 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_22);
1851 let commit_tx_fee_0_htlcs = 2*commit_tx_fee_msat(feerate, 1);
1852 let recv_value_3 = commit_tx_fee_2_htlcs - commit_tx_fee_0_htlcs - total_fee_msat;
1853 send_payment(&nodes[0], &vec![&nodes[1], &nodes[2]][..], recv_value_3);
1855 let commit_tx_fee_1_htlc = 2*commit_tx_fee_msat(feerate, 1 + 1);
1856 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);
1857 let stat0 = get_channel_value_stat!(nodes[0], chan_1.2);
1858 assert_eq!(stat0.value_to_self_msat, expected_value_to_self);
1859 assert_eq!(stat0.value_to_self_msat, stat0.channel_reserve_msat + commit_tx_fee_1_htlc);
1861 let stat2 = get_channel_value_stat!(nodes[2], chan_2.2);
1862 assert_eq!(stat2.value_to_self_msat, stat22.value_to_self_msat + recv_value_1 + recv_value_21 + recv_value_22 + recv_value_3);
1866 fn channel_reserve_in_flight_removes() {
1867 // In cases where one side claims an HTLC, it thinks it has additional available funds that it
1868 // can send to its counterparty, but due to update ordering, the other side may not yet have
1869 // considered those HTLCs fully removed.
1870 // This tests that we don't count HTLCs which will not be included in the next remote
1871 // commitment transaction towards the reserve value (as it implies no commitment transaction
1872 // will be generated which violates the remote reserve value).
1873 // This was broken previously, and discovered by the chanmon_fail_consistency fuzz test.
1875 // * route two HTLCs from A to B (note that, at a high level, this test is checking that, when
1876 // you consider the values of both of these HTLCs, B may not send an HTLC back to A, but if
1877 // you only consider the value of the first HTLC, it may not),
1878 // * start routing a third HTLC from A to B,
1879 // * claim the first two HTLCs (though B will generate an update_fulfill for one, and put
1880 // the other claim in its holding cell, as it immediately goes into AwaitingRAA),
1881 // * deliver the first fulfill from B
1882 // * deliver the update_add and an RAA from A, resulting in B freeing the second holding cell
1884 // * deliver A's response CS and RAA.
1885 // This results in A having the second HTLC in AwaitingRemovedRemoteRevoke, but B having
1886 // removed it fully. B now has the push_msat plus the first two HTLCs in value.
1887 // * Now B happily sends another HTLC, potentially violating its reserve value from A's point
1888 // of view (if A counts the AwaitingRemovedRemoteRevoke HTLC).
1889 let chanmon_cfgs = create_chanmon_cfgs(2);
1890 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1891 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1892 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1893 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
1894 let logger = test_utils::TestLogger::new();
1896 let b_chan_values = get_channel_value_stat!(nodes[1], chan_1.2);
1897 // Route the first two HTLCs.
1898 let (payment_preimage_1, _, _) = route_payment(&nodes[0], &[&nodes[1]], b_chan_values.channel_reserve_msat - b_chan_values.value_to_self_msat - 10000);
1899 let (payment_preimage_2, _, _) = route_payment(&nodes[0], &[&nodes[1]], 20000);
1901 // Start routing the third HTLC (this is just used to get everyone in the right state).
1902 let (payment_preimage_3, payment_hash_3, payment_secret_3) = get_payment_preimage_hash!(nodes[1]);
1904 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
1905 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
1906 nodes[0].node.send_payment(&route, payment_hash_3, &Some(payment_secret_3)).unwrap();
1907 check_added_monitors!(nodes[0], 1);
1908 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1909 assert_eq!(events.len(), 1);
1910 SendEvent::from_event(events.remove(0))
1913 // Now claim both of the first two HTLCs on B's end, putting B in AwaitingRAA and generating an
1914 // initial fulfill/CS.
1915 assert!(nodes[1].node.claim_funds(payment_preimage_1));
1916 check_added_monitors!(nodes[1], 1);
1917 let bs_removes = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1919 // This claim goes in B's holding cell, allowing us to have a pending B->A RAA which does not
1920 // remove the second HTLC when we send the HTLC back from B to A.
1921 assert!(nodes[1].node.claim_funds(payment_preimage_2));
1922 check_added_monitors!(nodes[1], 1);
1923 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1925 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_removes.update_fulfill_htlcs[0]);
1926 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_removes.commitment_signed);
1927 check_added_monitors!(nodes[0], 1);
1928 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1929 expect_payment_sent!(nodes[0], payment_preimage_1);
1931 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_1.msgs[0]);
1932 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &send_1.commitment_msg);
1933 check_added_monitors!(nodes[1], 1);
1934 // B is already AwaitingRAA, so cant generate a CS here
1935 let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
1937 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1938 check_added_monitors!(nodes[1], 1);
1939 let bs_cs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1941 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
1942 check_added_monitors!(nodes[0], 1);
1943 let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1945 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
1946 check_added_monitors!(nodes[1], 1);
1947 let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
1949 // The second HTLCis removed, but as A is in AwaitingRAA it can't generate a CS here, so the
1950 // RAA that B generated above doesn't fully resolve the second HTLC from A's point of view.
1951 // However, the RAA A generates here *does* fully resolve the HTLC from B's point of view (as A
1952 // can no longer broadcast a commitment transaction with it and B has the preimage so can go
1953 // on-chain as necessary).
1954 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_cs.update_fulfill_htlcs[0]);
1955 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_cs.commitment_signed);
1956 check_added_monitors!(nodes[0], 1);
1957 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1958 expect_payment_sent!(nodes[0], payment_preimage_2);
1960 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1961 check_added_monitors!(nodes[1], 1);
1962 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1964 expect_pending_htlcs_forwardable!(nodes[1]);
1965 expect_payment_received!(nodes[1], payment_hash_3, payment_secret_3, 100000);
1967 // Note that as this RAA was generated before the delivery of the update_fulfill it shouldn't
1968 // resolve the second HTLC from A's point of view.
1969 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
1970 check_added_monitors!(nodes[0], 1);
1971 let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1973 // Now that B doesn't have the second RAA anymore, but A still does, send a payment from B back
1974 // to A to ensure that A doesn't count the almost-removed HTLC in update_add processing.
1975 let (payment_preimage_4, payment_hash_4, payment_secret_4) = get_payment_preimage_hash!(nodes[0]);
1977 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
1978 let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[0].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 10000, TEST_FINAL_CLTV, &logger).unwrap();
1979 nodes[1].node.send_payment(&route, payment_hash_4, &Some(payment_secret_4)).unwrap();
1980 check_added_monitors!(nodes[1], 1);
1981 let mut events = nodes[1].node.get_and_clear_pending_msg_events();
1982 assert_eq!(events.len(), 1);
1983 SendEvent::from_event(events.remove(0))
1986 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &send_2.msgs[0]);
1987 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &send_2.commitment_msg);
1988 check_added_monitors!(nodes[0], 1);
1989 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1991 // Now just resolve all the outstanding messages/HTLCs for completeness...
1993 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
1994 check_added_monitors!(nodes[1], 1);
1995 let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
1997 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1998 check_added_monitors!(nodes[1], 1);
2000 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2001 check_added_monitors!(nodes[0], 1);
2002 let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2004 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
2005 check_added_monitors!(nodes[1], 1);
2006 let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2008 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2009 check_added_monitors!(nodes[0], 1);
2011 expect_pending_htlcs_forwardable!(nodes[0]);
2012 expect_payment_received!(nodes[0], payment_hash_4, payment_secret_4, 10000);
2014 claim_payment(&nodes[1], &[&nodes[0]], payment_preimage_4);
2015 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_3);
2019 fn channel_monitor_network_test() {
2020 // Simple test which builds a network of ChannelManagers, connects them to each other, and
2021 // tests that ChannelMonitor is able to recover from various states.
2022 let chanmon_cfgs = create_chanmon_cfgs(5);
2023 let node_cfgs = create_node_cfgs(5, &chanmon_cfgs);
2024 let node_chanmgrs = create_node_chanmgrs(5, &node_cfgs, &[None, None, None, None, None]);
2025 let nodes = create_network(5, &node_cfgs, &node_chanmgrs);
2027 // Create some initial channels
2028 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2029 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
2030 let chan_3 = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
2031 let chan_4 = create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::known(), InitFeatures::known());
2033 // Make sure all nodes are at the same starting height
2034 connect_blocks(&nodes[0], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[0].best_block_info().1);
2035 connect_blocks(&nodes[1], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[1].best_block_info().1);
2036 connect_blocks(&nodes[2], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[2].best_block_info().1);
2037 connect_blocks(&nodes[3], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[3].best_block_info().1);
2038 connect_blocks(&nodes[4], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[4].best_block_info().1);
2040 // Rebalance the network a bit by relaying one payment through all the channels...
2041 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
2042 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
2043 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
2044 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
2046 // Simple case with no pending HTLCs:
2047 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), true);
2048 check_added_monitors!(nodes[1], 1);
2049 check_closed_broadcast!(nodes[1], false);
2051 let mut node_txn = test_txn_broadcast(&nodes[1], &chan_1, None, HTLCType::NONE);
2052 assert_eq!(node_txn.len(), 1);
2053 mine_transaction(&nodes[0], &node_txn[0]);
2054 check_added_monitors!(nodes[0], 1);
2055 test_txn_broadcast(&nodes[0], &chan_1, None, HTLCType::NONE);
2057 check_closed_broadcast!(nodes[0], true);
2058 assert_eq!(nodes[0].node.list_channels().len(), 0);
2059 assert_eq!(nodes[1].node.list_channels().len(), 1);
2060 check_closed_event!(nodes[0], 1, ClosureReason::CommitmentTxConfirmed);
2061 check_closed_event!(nodes[1], 1, ClosureReason::DisconnectedPeer);
2063 // One pending HTLC is discarded by the force-close:
2064 let payment_preimage_1 = route_payment(&nodes[1], &vec!(&nodes[2], &nodes[3])[..], 3000000).0;
2066 // Simple case of one pending HTLC to HTLC-Timeout (note that the HTLC-Timeout is not
2067 // broadcasted until we reach the timelock time).
2068 nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id(), true);
2069 check_closed_broadcast!(nodes[1], false);
2070 check_added_monitors!(nodes[1], 1);
2072 let mut node_txn = test_txn_broadcast(&nodes[1], &chan_2, None, HTLCType::NONE);
2073 connect_blocks(&nodes[1], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + MIN_CLTV_EXPIRY_DELTA as u32 + 1);
2074 test_txn_broadcast(&nodes[1], &chan_2, None, HTLCType::TIMEOUT);
2075 mine_transaction(&nodes[2], &node_txn[0]);
2076 check_added_monitors!(nodes[2], 1);
2077 test_txn_broadcast(&nodes[2], &chan_2, None, HTLCType::NONE);
2079 check_closed_broadcast!(nodes[2], true);
2080 assert_eq!(nodes[1].node.list_channels().len(), 0);
2081 assert_eq!(nodes[2].node.list_channels().len(), 1);
2082 check_closed_event!(nodes[1], 1, ClosureReason::DisconnectedPeer);
2083 check_closed_event!(nodes[2], 1, ClosureReason::CommitmentTxConfirmed);
2085 macro_rules! claim_funds {
2086 ($node: expr, $prev_node: expr, $preimage: expr) => {
2088 assert!($node.node.claim_funds($preimage));
2089 check_added_monitors!($node, 1);
2091 let events = $node.node.get_and_clear_pending_msg_events();
2092 assert_eq!(events.len(), 1);
2094 MessageSendEvent::UpdateHTLCs { ref node_id, updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fail_htlcs, .. } } => {
2095 assert!(update_add_htlcs.is_empty());
2096 assert!(update_fail_htlcs.is_empty());
2097 assert_eq!(*node_id, $prev_node.node.get_our_node_id());
2099 _ => panic!("Unexpected event"),
2105 // nodes[3] gets the preimage, but nodes[2] already disconnected, resulting in a nodes[2]
2106 // HTLC-Timeout and a nodes[3] claim against it (+ its own announces)
2107 nodes[2].node.peer_disconnected(&nodes[3].node.get_our_node_id(), true);
2108 check_added_monitors!(nodes[2], 1);
2109 check_closed_broadcast!(nodes[2], false);
2110 let node2_commitment_txid;
2112 let node_txn = test_txn_broadcast(&nodes[2], &chan_3, None, HTLCType::NONE);
2113 connect_blocks(&nodes[2], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + MIN_CLTV_EXPIRY_DELTA as u32 + 1);
2114 test_txn_broadcast(&nodes[2], &chan_3, None, HTLCType::TIMEOUT);
2115 node2_commitment_txid = node_txn[0].txid();
2117 // Claim the payment on nodes[3], giving it knowledge of the preimage
2118 claim_funds!(nodes[3], nodes[2], payment_preimage_1);
2119 mine_transaction(&nodes[3], &node_txn[0]);
2120 check_added_monitors!(nodes[3], 1);
2121 check_preimage_claim(&nodes[3], &node_txn);
2123 check_closed_broadcast!(nodes[3], true);
2124 assert_eq!(nodes[2].node.list_channels().len(), 0);
2125 assert_eq!(nodes[3].node.list_channels().len(), 1);
2126 check_closed_event!(nodes[2], 1, ClosureReason::DisconnectedPeer);
2127 check_closed_event!(nodes[3], 1, ClosureReason::CommitmentTxConfirmed);
2129 // Drop the ChannelMonitor for the previous channel to avoid it broadcasting transactions and
2130 // confusing us in the following tests.
2131 let chan_3_mon = nodes[3].chain_monitor.chain_monitor.monitors.write().unwrap().remove(&OutPoint { txid: chan_3.3.txid(), index: 0 }).unwrap();
2133 // One pending HTLC to time out:
2134 let payment_preimage_2 = route_payment(&nodes[3], &vec!(&nodes[4])[..], 3000000).0;
2135 // CLTV expires at TEST_FINAL_CLTV + 1 (current height) + 1 (added in send_payment for
2138 let (close_chan_update_1, close_chan_update_2) = {
2139 connect_blocks(&nodes[3], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + 1);
2140 let events = nodes[3].node.get_and_clear_pending_msg_events();
2141 assert_eq!(events.len(), 2);
2142 let close_chan_update_1 = match events[0] {
2143 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
2146 _ => panic!("Unexpected event"),
2149 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { .. }, node_id } => {
2150 assert_eq!(node_id, nodes[4].node.get_our_node_id());
2152 _ => panic!("Unexpected event"),
2154 check_added_monitors!(nodes[3], 1);
2156 // Clear bumped claiming txn spending node 2 commitment tx. Bumped txn are generated after reaching some height timer.
2158 let mut node_txn = nodes[3].tx_broadcaster.txn_broadcasted.lock().unwrap();
2159 node_txn.retain(|tx| {
2160 if tx.input[0].previous_output.txid == node2_commitment_txid {
2166 let node_txn = test_txn_broadcast(&nodes[3], &chan_4, None, HTLCType::TIMEOUT);
2168 // Claim the payment on nodes[4], giving it knowledge of the preimage
2169 claim_funds!(nodes[4], nodes[3], payment_preimage_2);
2171 connect_blocks(&nodes[4], TEST_FINAL_CLTV - CLTV_CLAIM_BUFFER + 2);
2172 let events = nodes[4].node.get_and_clear_pending_msg_events();
2173 assert_eq!(events.len(), 2);
2174 let close_chan_update_2 = match events[0] {
2175 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
2178 _ => panic!("Unexpected event"),
2181 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { .. }, node_id } => {
2182 assert_eq!(node_id, nodes[3].node.get_our_node_id());
2184 _ => panic!("Unexpected event"),
2186 check_added_monitors!(nodes[4], 1);
2187 test_txn_broadcast(&nodes[4], &chan_4, None, HTLCType::SUCCESS);
2189 mine_transaction(&nodes[4], &node_txn[0]);
2190 check_preimage_claim(&nodes[4], &node_txn);
2191 (close_chan_update_1, close_chan_update_2)
2193 nodes[3].net_graph_msg_handler.handle_channel_update(&close_chan_update_2).unwrap();
2194 nodes[4].net_graph_msg_handler.handle_channel_update(&close_chan_update_1).unwrap();
2195 assert_eq!(nodes[3].node.list_channels().len(), 0);
2196 assert_eq!(nodes[4].node.list_channels().len(), 0);
2198 nodes[3].chain_monitor.chain_monitor.monitors.write().unwrap().insert(OutPoint { txid: chan_3.3.txid(), index: 0 }, chan_3_mon);
2199 check_closed_event!(nodes[3], 1, ClosureReason::CommitmentTxConfirmed);
2200 check_closed_event!(nodes[4], 1, ClosureReason::CommitmentTxConfirmed);
2204 fn test_justice_tx() {
2205 // Test justice txn built on revoked HTLC-Success tx, against both sides
2206 let mut alice_config = UserConfig::default();
2207 alice_config.channel_options.announced_channel = true;
2208 alice_config.peer_channel_config_limits.force_announced_channel_preference = false;
2209 alice_config.own_channel_config.our_to_self_delay = 6 * 24 * 5;
2210 let mut bob_config = UserConfig::default();
2211 bob_config.channel_options.announced_channel = true;
2212 bob_config.peer_channel_config_limits.force_announced_channel_preference = false;
2213 bob_config.own_channel_config.our_to_self_delay = 6 * 24 * 3;
2214 let user_cfgs = [Some(alice_config), Some(bob_config)];
2215 let mut chanmon_cfgs = create_chanmon_cfgs(2);
2216 chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
2217 chanmon_cfgs[1].keys_manager.disable_revocation_policy_check = true;
2218 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2219 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &user_cfgs);
2220 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2221 // Create some new channels:
2222 let chan_5 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2224 // A pending HTLC which will be revoked:
2225 let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2226 // Get the will-be-revoked local txn from nodes[0]
2227 let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_5.2);
2228 assert_eq!(revoked_local_txn.len(), 2); // First commitment tx, then HTLC tx
2229 assert_eq!(revoked_local_txn[0].input.len(), 1);
2230 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_5.3.txid());
2231 assert_eq!(revoked_local_txn[0].output.len(), 2); // Only HTLC and output back to 0 are present
2232 assert_eq!(revoked_local_txn[1].input.len(), 1);
2233 assert_eq!(revoked_local_txn[1].input[0].previous_output.txid, revoked_local_txn[0].txid());
2234 assert_eq!(revoked_local_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC-Timeout
2235 // Revoke the old state
2236 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_3);
2239 mine_transaction(&nodes[1], &revoked_local_txn[0]);
2241 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2242 assert_eq!(node_txn.len(), 2); // ChannelMonitor: penalty tx, ChannelManager: local commitment tx
2243 assert_eq!(node_txn[0].input.len(), 2); // We should claim the revoked output and the HTLC output
2245 check_spends!(node_txn[0], revoked_local_txn[0]);
2246 node_txn.swap_remove(0);
2247 node_txn.truncate(1);
2249 check_added_monitors!(nodes[1], 1);
2250 check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
2251 test_txn_broadcast(&nodes[1], &chan_5, None, HTLCType::NONE);
2253 mine_transaction(&nodes[0], &revoked_local_txn[0]);
2254 connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
2255 // Verify broadcast of revoked HTLC-timeout
2256 let node_txn = test_txn_broadcast(&nodes[0], &chan_5, Some(revoked_local_txn[0].clone()), HTLCType::TIMEOUT);
2257 check_added_monitors!(nodes[0], 1);
2258 check_closed_event!(nodes[0], 1, ClosureReason::CommitmentTxConfirmed);
2259 // Broadcast revoked HTLC-timeout on node 1
2260 mine_transaction(&nodes[1], &node_txn[1]);
2261 test_revoked_htlc_claim_txn_broadcast(&nodes[1], node_txn[1].clone(), revoked_local_txn[0].clone());
2263 get_announce_close_broadcast_events(&nodes, 0, 1);
2265 assert_eq!(nodes[0].node.list_channels().len(), 0);
2266 assert_eq!(nodes[1].node.list_channels().len(), 0);
2268 // We test justice_tx build by A on B's revoked HTLC-Success tx
2269 // Create some new channels:
2270 let chan_6 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2272 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2276 // A pending HTLC which will be revoked:
2277 let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2278 // Get the will-be-revoked local txn from B
2279 let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan_6.2);
2280 assert_eq!(revoked_local_txn.len(), 1); // Only commitment tx
2281 assert_eq!(revoked_local_txn[0].input.len(), 1);
2282 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_6.3.txid());
2283 assert_eq!(revoked_local_txn[0].output.len(), 2); // Only HTLC and output back to A are present
2284 // Revoke the old state
2285 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_4);
2287 mine_transaction(&nodes[0], &revoked_local_txn[0]);
2289 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
2290 assert_eq!(node_txn.len(), 2); //ChannelMonitor: penalty tx, ChannelManager: local commitment tx
2291 assert_eq!(node_txn[0].input.len(), 1); // We claim the received HTLC output
2293 check_spends!(node_txn[0], revoked_local_txn[0]);
2294 node_txn.swap_remove(0);
2296 check_added_monitors!(nodes[0], 1);
2297 test_txn_broadcast(&nodes[0], &chan_6, None, HTLCType::NONE);
2299 mine_transaction(&nodes[1], &revoked_local_txn[0]);
2300 check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
2301 let node_txn = test_txn_broadcast(&nodes[1], &chan_6, Some(revoked_local_txn[0].clone()), HTLCType::SUCCESS);
2302 check_added_monitors!(nodes[1], 1);
2303 mine_transaction(&nodes[0], &node_txn[1]);
2304 check_closed_event!(nodes[0], 1, ClosureReason::CommitmentTxConfirmed);
2305 test_revoked_htlc_claim_txn_broadcast(&nodes[0], node_txn[1].clone(), revoked_local_txn[0].clone());
2307 get_announce_close_broadcast_events(&nodes, 0, 1);
2308 assert_eq!(nodes[0].node.list_channels().len(), 0);
2309 assert_eq!(nodes[1].node.list_channels().len(), 0);
2313 fn revoked_output_claim() {
2314 // Simple test to ensure a node will claim a revoked output when a stale remote commitment
2315 // transaction is broadcast by its counterparty
2316 let chanmon_cfgs = create_chanmon_cfgs(2);
2317 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2318 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2319 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2320 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2321 // node[0] is gonna to revoke an old state thus node[1] should be able to claim the revoked output
2322 let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2323 assert_eq!(revoked_local_txn.len(), 1);
2324 // Only output is the full channel value back to nodes[0]:
2325 assert_eq!(revoked_local_txn[0].output.len(), 1);
2326 // Send a payment through, updating everyone's latest commitment txn
2327 send_payment(&nodes[0], &vec!(&nodes[1])[..], 5000000);
2329 // Inform nodes[1] that nodes[0] broadcast a stale tx
2330 mine_transaction(&nodes[1], &revoked_local_txn[0]);
2331 check_added_monitors!(nodes[1], 1);
2332 check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
2333 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2334 assert_eq!(node_txn.len(), 2); // ChannelMonitor: justice tx against revoked to_local output, ChannelManager: local commitment tx
2336 check_spends!(node_txn[0], revoked_local_txn[0]);
2337 check_spends!(node_txn[1], chan_1.3);
2339 // Inform nodes[0] that a watchtower cheated on its behalf, so it will force-close the chan
2340 mine_transaction(&nodes[0], &revoked_local_txn[0]);
2341 get_announce_close_broadcast_events(&nodes, 0, 1);
2342 check_added_monitors!(nodes[0], 1);
2343 check_closed_event!(nodes[0], 1, ClosureReason::CommitmentTxConfirmed);
2347 fn claim_htlc_outputs_shared_tx() {
2348 // Node revoked old state, htlcs haven't time out yet, claim them in shared justice tx
2349 let mut chanmon_cfgs = create_chanmon_cfgs(2);
2350 chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
2351 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2352 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2353 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2355 // Create some new channel:
2356 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2358 // Rebalance the network to generate htlc in the two directions
2359 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
2360 // 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
2361 let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2362 let (_payment_preimage_2, payment_hash_2, _) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000);
2364 // Get the will-be-revoked local txn from node[0]
2365 let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2366 assert_eq!(revoked_local_txn.len(), 2); // commitment tx + 1 HTLC-Timeout tx
2367 assert_eq!(revoked_local_txn[0].input.len(), 1);
2368 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
2369 assert_eq!(revoked_local_txn[1].input.len(), 1);
2370 assert_eq!(revoked_local_txn[1].input[0].previous_output.txid, revoked_local_txn[0].txid());
2371 assert_eq!(revoked_local_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC-Timeout
2372 check_spends!(revoked_local_txn[1], revoked_local_txn[0]);
2374 //Revoke the old state
2375 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_1);
2378 mine_transaction(&nodes[0], &revoked_local_txn[0]);
2379 check_added_monitors!(nodes[0], 1);
2380 check_closed_event!(nodes[0], 1, ClosureReason::CommitmentTxConfirmed);
2381 mine_transaction(&nodes[1], &revoked_local_txn[0]);
2382 check_added_monitors!(nodes[1], 1);
2383 check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
2384 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
2385 expect_payment_failed!(nodes[1], payment_hash_2, true);
2387 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2388 assert_eq!(node_txn.len(), 2); // ChannelMonitor: penalty tx, ChannelManager: local commitment
2390 assert_eq!(node_txn[0].input.len(), 3); // Claim the revoked output + both revoked HTLC outputs
2391 check_spends!(node_txn[0], revoked_local_txn[0]);
2393 let mut witness_lens = BTreeSet::new();
2394 witness_lens.insert(node_txn[0].input[0].witness.last().unwrap().len());
2395 witness_lens.insert(node_txn[0].input[1].witness.last().unwrap().len());
2396 witness_lens.insert(node_txn[0].input[2].witness.last().unwrap().len());
2397 assert_eq!(witness_lens.len(), 3);
2398 assert_eq!(*witness_lens.iter().skip(0).next().unwrap(), 77); // revoked to_local
2399 assert_eq!(*witness_lens.iter().skip(1).next().unwrap(), OFFERED_HTLC_SCRIPT_WEIGHT); // revoked offered HTLC
2400 assert_eq!(*witness_lens.iter().skip(2).next().unwrap(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // revoked received HTLC
2402 // Next nodes[1] broadcasts its current local tx state:
2403 assert_eq!(node_txn[1].input.len(), 1);
2404 assert_eq!(node_txn[1].input[0].previous_output.txid, chan_1.3.txid()); //Spending funding tx unique txouput, tx broadcasted by ChannelManager
2406 get_announce_close_broadcast_events(&nodes, 0, 1);
2407 assert_eq!(nodes[0].node.list_channels().len(), 0);
2408 assert_eq!(nodes[1].node.list_channels().len(), 0);
2412 fn claim_htlc_outputs_single_tx() {
2413 // Node revoked old state, htlcs have timed out, claim each of them in separated justice tx
2414 let mut chanmon_cfgs = create_chanmon_cfgs(2);
2415 chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
2416 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2417 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2418 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2420 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2422 // Rebalance the network to generate htlc in the two directions
2423 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
2424 // 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
2425 // time as two different claim transactions as we're gonna to timeout htlc with given a high current height
2426 let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2427 let (_payment_preimage_2, payment_hash_2, _payment_secret_2) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000);
2429 // Get the will-be-revoked local txn from node[0]
2430 let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2432 //Revoke the old state
2433 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_1);
2436 confirm_transaction_at(&nodes[0], &revoked_local_txn[0], 100);
2437 check_added_monitors!(nodes[0], 1);
2438 confirm_transaction_at(&nodes[1], &revoked_local_txn[0], 100);
2439 check_added_monitors!(nodes[1], 1);
2440 check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
2441 let mut events = nodes[0].node.get_and_clear_pending_events();
2442 expect_pending_htlcs_forwardable_from_events!(nodes[0], events[0..1], true);
2444 Event::ChannelClosed { reason: ClosureReason::CommitmentTxConfirmed, .. } => {}
2445 _ => panic!("Unexpected event"),
2448 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
2449 expect_payment_failed!(nodes[1], payment_hash_2, true);
2451 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2452 assert_eq!(node_txn.len(), 9);
2453 // ChannelMonitor: justice tx revoked offered htlc, justice tx revoked received htlc, justice tx revoked to_local (3)
2454 // ChannelManager: local commmitment + local HTLC-timeout (2)
2455 // 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)
2456 // ChannelMonitor: local commitment + local HTLC-timeout (2)
2458 // Check the pair local commitment and HTLC-timeout broadcast due to HTLC expiration
2459 assert_eq!(node_txn[0].input.len(), 1);
2460 check_spends!(node_txn[0], chan_1.3);
2461 assert_eq!(node_txn[1].input.len(), 1);
2462 let witness_script = node_txn[1].input[0].witness.last().unwrap();
2463 assert_eq!(witness_script.len(), OFFERED_HTLC_SCRIPT_WEIGHT); //Spending an offered htlc output
2464 check_spends!(node_txn[1], node_txn[0]);
2466 // Justice transactions are indices 1-2-4
2467 assert_eq!(node_txn[2].input.len(), 1);
2468 assert_eq!(node_txn[3].input.len(), 1);
2469 assert_eq!(node_txn[4].input.len(), 1);
2471 check_spends!(node_txn[2], revoked_local_txn[0]);
2472 check_spends!(node_txn[3], revoked_local_txn[0]);
2473 check_spends!(node_txn[4], revoked_local_txn[0]);
2475 let mut witness_lens = BTreeSet::new();
2476 witness_lens.insert(node_txn[2].input[0].witness.last().unwrap().len());
2477 witness_lens.insert(node_txn[3].input[0].witness.last().unwrap().len());
2478 witness_lens.insert(node_txn[4].input[0].witness.last().unwrap().len());
2479 assert_eq!(witness_lens.len(), 3);
2480 assert_eq!(*witness_lens.iter().skip(0).next().unwrap(), 77); // revoked to_local
2481 assert_eq!(*witness_lens.iter().skip(1).next().unwrap(), OFFERED_HTLC_SCRIPT_WEIGHT); // revoked offered HTLC
2482 assert_eq!(*witness_lens.iter().skip(2).next().unwrap(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // revoked received HTLC
2484 get_announce_close_broadcast_events(&nodes, 0, 1);
2485 assert_eq!(nodes[0].node.list_channels().len(), 0);
2486 assert_eq!(nodes[1].node.list_channels().len(), 0);
2490 fn test_htlc_on_chain_success() {
2491 // Test that in case of a unilateral close onchain, we detect the state of output and pass
2492 // the preimage backward accordingly. So here we test that ChannelManager is
2493 // broadcasting the right event to other nodes in payment path.
2494 // We test with two HTLCs simultaneously as that was not handled correctly in the past.
2495 // A --------------------> B ----------------------> C (preimage)
2496 // First, C should claim the HTLC outputs via HTLC-Success when its own latest local
2497 // commitment transaction was broadcast.
2498 // Then, B should learn the preimage from said transactions, attempting to claim backwards
2500 // B should be able to claim via preimage if A then broadcasts its local tx.
2501 // Finally, when A sees B's latest local commitment transaction it should be able to claim
2502 // the HTLC outputs via the preimage it learned (which, once confirmed should generate a
2503 // PaymentSent event).
2505 let chanmon_cfgs = create_chanmon_cfgs(3);
2506 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2507 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2508 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2510 // Create some initial channels
2511 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2512 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
2514 // Ensure all nodes are at the same height
2515 let node_max_height = nodes.iter().map(|node| node.blocks.lock().unwrap().len()).max().unwrap() as u32;
2516 connect_blocks(&nodes[0], node_max_height - nodes[0].best_block_info().1);
2517 connect_blocks(&nodes[1], node_max_height - nodes[1].best_block_info().1);
2518 connect_blocks(&nodes[2], node_max_height - nodes[2].best_block_info().1);
2520 // Rebalance the network a bit by relaying one payment through all the channels...
2521 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
2522 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
2524 let (our_payment_preimage, _payment_hash, _payment_secret) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2525 let (our_payment_preimage_2, _payment_hash_2, _payment_secret_2) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2527 // Broadcast legit commitment tx from C on B's chain
2528 // Broadcast HTLC Success transaction by C on received output from C's commitment tx on B's chain
2529 let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
2530 assert_eq!(commitment_tx.len(), 1);
2531 check_spends!(commitment_tx[0], chan_2.3);
2532 nodes[2].node.claim_funds(our_payment_preimage);
2533 nodes[2].node.claim_funds(our_payment_preimage_2);
2534 check_added_monitors!(nodes[2], 2);
2535 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2536 assert!(updates.update_add_htlcs.is_empty());
2537 assert!(updates.update_fail_htlcs.is_empty());
2538 assert!(updates.update_fail_malformed_htlcs.is_empty());
2539 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
2541 mine_transaction(&nodes[2], &commitment_tx[0]);
2542 check_closed_broadcast!(nodes[2], true);
2543 check_added_monitors!(nodes[2], 1);
2544 check_closed_event!(nodes[2], 1, ClosureReason::CommitmentTxConfirmed);
2545 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)
2546 assert_eq!(node_txn.len(), 5);
2547 assert_eq!(node_txn[0], node_txn[3]);
2548 assert_eq!(node_txn[1], node_txn[4]);
2549 assert_eq!(node_txn[2], commitment_tx[0]);
2550 check_spends!(node_txn[0], commitment_tx[0]);
2551 check_spends!(node_txn[1], commitment_tx[0]);
2552 assert_eq!(node_txn[0].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2553 assert_eq!(node_txn[1].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2554 assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2555 assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2556 assert_eq!(node_txn[0].lock_time, 0);
2557 assert_eq!(node_txn[1].lock_time, 0);
2559 // Verify that B's ChannelManager is able to extract preimage from HTLC Success tx and pass it backward
2560 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2561 connect_block(&nodes[1], &Block { header, txdata: node_txn});
2562 connect_blocks(&nodes[1], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
2564 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
2565 assert_eq!(added_monitors.len(), 1);
2566 assert_eq!(added_monitors[0].0.txid, chan_2.3.txid());
2567 added_monitors.clear();
2569 let forwarded_events = nodes[1].node.get_and_clear_pending_events();
2570 assert_eq!(forwarded_events.len(), 3);
2571 match forwarded_events[0] {
2572 Event::ChannelClosed { reason: ClosureReason::CommitmentTxConfirmed, .. } => {}
2573 _ => panic!("Unexpected event"),
2575 if let Event::PaymentForwarded { fee_earned_msat: Some(1000), claim_from_onchain_tx: true } = forwarded_events[1] {
2576 } else { panic!(); }
2577 if let Event::PaymentForwarded { fee_earned_msat: Some(1000), claim_from_onchain_tx: true } = forwarded_events[2] {
2578 } else { panic!(); }
2579 let events = nodes[1].node.get_and_clear_pending_msg_events();
2581 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
2582 assert_eq!(added_monitors.len(), 2);
2583 assert_eq!(added_monitors[0].0.txid, chan_1.3.txid());
2584 assert_eq!(added_monitors[1].0.txid, chan_1.3.txid());
2585 added_monitors.clear();
2587 assert_eq!(events.len(), 3);
2589 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
2590 _ => panic!("Unexpected event"),
2593 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { .. }, node_id: _ } => {},
2594 _ => panic!("Unexpected event"),
2598 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, .. } } => {
2599 assert!(update_add_htlcs.is_empty());
2600 assert!(update_fail_htlcs.is_empty());
2601 assert_eq!(update_fulfill_htlcs.len(), 1);
2602 assert!(update_fail_malformed_htlcs.is_empty());
2603 assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
2605 _ => panic!("Unexpected event"),
2607 macro_rules! check_tx_local_broadcast {
2608 ($node: expr, $htlc_offered: expr, $commitment_tx: expr, $chan_tx: expr) => { {
2609 let mut node_txn = $node.tx_broadcaster.txn_broadcasted.lock().unwrap();
2610 assert_eq!(node_txn.len(), 3);
2611 // Node[1]: ChannelManager: 3 (commitment tx, 2*HTLC-Timeout tx), ChannelMonitor: 2 (timeout tx)
2612 // Node[0]: ChannelManager: 3 (commtiemtn tx, 2*HTLC-Timeout tx), ChannelMonitor: 2 HTLC-timeout
2613 check_spends!(node_txn[1], $commitment_tx);
2614 check_spends!(node_txn[2], $commitment_tx);
2615 assert_ne!(node_txn[1].lock_time, 0);
2616 assert_ne!(node_txn[2].lock_time, 0);
2618 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2619 assert_eq!(node_txn[2].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2620 assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2621 assert!(node_txn[2].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2623 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2624 assert_eq!(node_txn[2].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2625 assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2626 assert!(node_txn[2].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2628 check_spends!(node_txn[0], $chan_tx);
2629 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), 71);
2633 // nodes[1] now broadcasts its own local state as a fallback, suggesting an alternate
2634 // commitment transaction with a corresponding HTLC-Timeout transactions, as well as a
2635 // timeout-claim of the output that nodes[2] just claimed via success.
2636 check_tx_local_broadcast!(nodes[1], false, commitment_tx[0], chan_2.3);
2638 // Broadcast legit commitment tx from A on B's chain
2639 // Broadcast preimage tx by B on offered output from A commitment tx on A's chain
2640 let node_a_commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
2641 check_spends!(node_a_commitment_tx[0], chan_1.3);
2642 mine_transaction(&nodes[1], &node_a_commitment_tx[0]);
2643 check_closed_broadcast!(nodes[1], true);
2644 check_added_monitors!(nodes[1], 1);
2645 check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
2646 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
2647 assert_eq!(node_txn.len(), 6); // ChannelManager : 3 (commitment tx + HTLC-Sucess * 2), ChannelMonitor : 3 (HTLC-Success, 2* RBF bumps of above HTLC txn)
2648 let commitment_spend =
2649 if node_txn[0].input[0].previous_output.txid == node_a_commitment_tx[0].txid() {
2650 check_spends!(node_txn[1], commitment_tx[0]);
2651 check_spends!(node_txn[2], commitment_tx[0]);
2652 assert_ne!(node_txn[1].input[0].previous_output.vout, node_txn[2].input[0].previous_output.vout);
2655 check_spends!(node_txn[0], commitment_tx[0]);
2656 check_spends!(node_txn[1], commitment_tx[0]);
2657 assert_ne!(node_txn[0].input[0].previous_output.vout, node_txn[1].input[0].previous_output.vout);
2661 check_spends!(commitment_spend, node_a_commitment_tx[0]);
2662 assert_eq!(commitment_spend.input.len(), 2);
2663 assert_eq!(commitment_spend.input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2664 assert_eq!(commitment_spend.input[1].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2665 assert_eq!(commitment_spend.lock_time, 0);
2666 assert!(commitment_spend.output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2667 check_spends!(node_txn[3], chan_1.3);
2668 assert_eq!(node_txn[3].input[0].witness.clone().last().unwrap().len(), 71);
2669 check_spends!(node_txn[4], node_txn[3]);
2670 check_spends!(node_txn[5], node_txn[3]);
2671 // We don't bother to check that B can claim the HTLC output on its commitment tx here as
2672 // we already checked the same situation with A.
2674 // Verify that A's ChannelManager is able to extract preimage from preimage tx and generate PaymentSent
2675 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2676 connect_block(&nodes[0], &Block { header, txdata: vec![node_a_commitment_tx[0].clone(), commitment_spend.clone()] });
2677 connect_blocks(&nodes[0], TEST_FINAL_CLTV + MIN_CLTV_EXPIRY_DELTA as u32 - 1); // Confirm blocks until the HTLC expires
2678 check_closed_broadcast!(nodes[0], true);
2679 check_added_monitors!(nodes[0], 1);
2680 let events = nodes[0].node.get_and_clear_pending_events();
2681 assert_eq!(events.len(), 3);
2682 let mut first_claimed = false;
2683 for event in events {
2685 Event::PaymentSent { payment_preimage } => {
2686 if payment_preimage == our_payment_preimage {
2687 assert!(!first_claimed);
2688 first_claimed = true;
2690 assert_eq!(payment_preimage, our_payment_preimage_2);
2693 Event::ChannelClosed { reason: ClosureReason::CommitmentTxConfirmed, .. } => {},
2694 _ => panic!("Unexpected event"),
2697 check_tx_local_broadcast!(nodes[0], true, node_a_commitment_tx[0], chan_1.3);
2700 fn do_test_htlc_on_chain_timeout(connect_style: ConnectStyle) {
2701 // Test that in case of a unilateral close onchain, we detect the state of output and
2702 // timeout the HTLC backward accordingly. So here we test that ChannelManager is
2703 // broadcasting the right event to other nodes in payment path.
2704 // A ------------------> B ----------------------> C (timeout)
2705 // B's commitment tx C's commitment tx
2707 // B's HTLC timeout tx B's timeout tx
2709 let chanmon_cfgs = create_chanmon_cfgs(3);
2710 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2711 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2712 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2713 *nodes[0].connect_style.borrow_mut() = connect_style;
2714 *nodes[1].connect_style.borrow_mut() = connect_style;
2715 *nodes[2].connect_style.borrow_mut() = connect_style;
2717 // Create some intial channels
2718 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2719 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
2721 // Rebalance the network a bit by relaying one payment thorugh all the channels...
2722 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
2723 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
2725 let (_payment_preimage, payment_hash, _payment_secret) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2727 // Broadcast legit commitment tx from C on B's chain
2728 let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
2729 check_spends!(commitment_tx[0], chan_2.3);
2730 nodes[2].node.fail_htlc_backwards(&payment_hash);
2731 check_added_monitors!(nodes[2], 0);
2732 expect_pending_htlcs_forwardable!(nodes[2]);
2733 check_added_monitors!(nodes[2], 1);
2735 let events = nodes[2].node.get_and_clear_pending_msg_events();
2736 assert_eq!(events.len(), 1);
2738 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, .. } } => {
2739 assert!(update_add_htlcs.is_empty());
2740 assert!(!update_fail_htlcs.is_empty());
2741 assert!(update_fulfill_htlcs.is_empty());
2742 assert!(update_fail_malformed_htlcs.is_empty());
2743 assert_eq!(nodes[1].node.get_our_node_id(), *node_id);
2745 _ => panic!("Unexpected event"),
2747 mine_transaction(&nodes[2], &commitment_tx[0]);
2748 check_closed_broadcast!(nodes[2], true);
2749 check_added_monitors!(nodes[2], 1);
2750 check_closed_event!(nodes[2], 1, ClosureReason::CommitmentTxConfirmed);
2751 let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 1 (commitment tx)
2752 assert_eq!(node_txn.len(), 1);
2753 check_spends!(node_txn[0], chan_2.3);
2754 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), 71);
2756 // Broadcast timeout transaction by B on received output from C's commitment tx on B's chain
2757 // Verify that B's ChannelManager is able to detect that HTLC is timeout by its own tx and react backward in consequence
2758 connect_blocks(&nodes[1], 200 - nodes[2].best_block_info().1);
2759 mine_transaction(&nodes[1], &commitment_tx[0]);
2760 check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
2763 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2764 assert_eq!(node_txn.len(), 5); // ChannelManager : 2 (commitment tx, HTLC-Timeout tx), ChannelMonitor : 2 (local commitment tx + HTLC-timeout), 1 timeout tx
2765 assert_eq!(node_txn[0], node_txn[3]);
2766 assert_eq!(node_txn[1], node_txn[4]);
2768 check_spends!(node_txn[2], commitment_tx[0]);
2769 assert_eq!(node_txn[2].clone().input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2771 check_spends!(node_txn[0], chan_2.3);
2772 check_spends!(node_txn[1], node_txn[0]);
2773 assert_eq!(node_txn[0].clone().input[0].witness.last().unwrap().len(), 71);
2774 assert_eq!(node_txn[1].clone().input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2776 timeout_tx = node_txn[2].clone();
2780 mine_transaction(&nodes[1], &timeout_tx);
2781 check_added_monitors!(nodes[1], 1);
2782 check_closed_broadcast!(nodes[1], true);
2784 // B will rebroadcast a fee-bumped timeout transaction here.
2785 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
2786 assert_eq!(node_txn.len(), 1);
2787 check_spends!(node_txn[0], commitment_tx[0]);
2790 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
2792 // B may rebroadcast its own holder commitment transaction here, as a safeguard against
2793 // some incredibly unlikely partial-eclipse-attack scenarios. That said, because the
2794 // original commitment_tx[0] (also spending chan_2.3) has reached ANTI_REORG_DELAY B really
2795 // shouldn't broadcast anything here, and in some connect style scenarios we do not.
2796 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
2797 if node_txn.len() == 1 {
2798 check_spends!(node_txn[0], chan_2.3);
2800 assert_eq!(node_txn.len(), 0);
2804 expect_pending_htlcs_forwardable!(nodes[1]);
2805 check_added_monitors!(nodes[1], 1);
2806 let events = nodes[1].node.get_and_clear_pending_msg_events();
2807 assert_eq!(events.len(), 1);
2809 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, .. } } => {
2810 assert!(update_add_htlcs.is_empty());
2811 assert!(!update_fail_htlcs.is_empty());
2812 assert!(update_fulfill_htlcs.is_empty());
2813 assert!(update_fail_malformed_htlcs.is_empty());
2814 assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
2816 _ => panic!("Unexpected event"),
2819 // Broadcast legit commitment tx from B on A's chain
2820 let commitment_tx = get_local_commitment_txn!(nodes[1], chan_1.2);
2821 check_spends!(commitment_tx[0], chan_1.3);
2823 mine_transaction(&nodes[0], &commitment_tx[0]);
2824 connect_blocks(&nodes[0], TEST_FINAL_CLTV + MIN_CLTV_EXPIRY_DELTA as u32 - 1); // Confirm blocks until the HTLC expires
2826 check_closed_broadcast!(nodes[0], true);
2827 check_added_monitors!(nodes[0], 1);
2828 check_closed_event!(nodes[0], 1, ClosureReason::CommitmentTxConfirmed);
2829 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 1 commitment tx, ChannelMonitor : 1 timeout tx
2830 assert_eq!(node_txn.len(), 2);
2831 check_spends!(node_txn[0], chan_1.3);
2832 assert_eq!(node_txn[0].clone().input[0].witness.last().unwrap().len(), 71);
2833 check_spends!(node_txn[1], commitment_tx[0]);
2834 assert_eq!(node_txn[1].clone().input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2838 fn test_htlc_on_chain_timeout() {
2839 do_test_htlc_on_chain_timeout(ConnectStyle::BestBlockFirstSkippingBlocks);
2840 do_test_htlc_on_chain_timeout(ConnectStyle::TransactionsFirstSkippingBlocks);
2841 do_test_htlc_on_chain_timeout(ConnectStyle::FullBlockViaListen);
2845 fn test_simple_commitment_revoked_fail_backward() {
2846 // Test that in case of a revoked commitment tx, we detect the resolution of output by justice tx
2847 // and fail backward accordingly.
2849 let chanmon_cfgs = create_chanmon_cfgs(3);
2850 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2851 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2852 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2854 // Create some initial channels
2855 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2856 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
2858 let (payment_preimage, _payment_hash, _payment_secret) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3000000);
2859 // Get the will-be-revoked local txn from nodes[2]
2860 let revoked_local_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
2861 // Revoke the old state
2862 claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage);
2864 let (_, payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3000000);
2866 mine_transaction(&nodes[1], &revoked_local_txn[0]);
2867 check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
2868 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
2869 check_added_monitors!(nodes[1], 1);
2870 check_closed_broadcast!(nodes[1], true);
2872 expect_pending_htlcs_forwardable!(nodes[1]);
2873 check_added_monitors!(nodes[1], 1);
2874 let events = nodes[1].node.get_and_clear_pending_msg_events();
2875 assert_eq!(events.len(), 1);
2877 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, .. } } => {
2878 assert!(update_add_htlcs.is_empty());
2879 assert_eq!(update_fail_htlcs.len(), 1);
2880 assert!(update_fulfill_htlcs.is_empty());
2881 assert!(update_fail_malformed_htlcs.is_empty());
2882 assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
2884 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
2885 commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
2886 expect_payment_failed_with_update!(nodes[0], payment_hash, false, chan_2.0.contents.short_channel_id, true);
2888 _ => panic!("Unexpected event"),
2892 fn do_test_commitment_revoked_fail_backward_exhaustive(deliver_bs_raa: bool, use_dust: bool, no_to_remote: bool) {
2893 // Test that if our counterparty broadcasts a revoked commitment transaction we fail all
2894 // pending HTLCs on that channel backwards even if the HTLCs aren't present in our latest
2895 // commitment transaction anymore.
2896 // To do this, we have the peer which will broadcast a revoked commitment transaction send
2897 // a number of update_fail/commitment_signed updates without ever sending the RAA in
2898 // response to our commitment_signed. This is somewhat misbehavior-y, though not
2899 // technically disallowed and we should probably handle it reasonably.
2900 // Note that this is pretty exhaustive as an outbound HTLC which we haven't yet
2901 // failed/fulfilled backwards must be in at least one of the latest two remote commitment
2903 // * Once we move it out of our holding cell/add it, we will immediately include it in a
2904 // commitment_signed (implying it will be in the latest remote commitment transaction).
2905 // * Once they remove it, we will send a (the first) commitment_signed without the HTLC,
2906 // and once they revoke the previous commitment transaction (allowing us to send a new
2907 // commitment_signed) we will be free to fail/fulfill the HTLC backwards.
2908 let chanmon_cfgs = create_chanmon_cfgs(3);
2909 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2910 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2911 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2913 // Create some initial channels
2914 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2915 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
2917 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 });
2918 // Get the will-be-revoked local txn from nodes[2]
2919 let revoked_local_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
2920 assert_eq!(revoked_local_txn[0].output.len(), if no_to_remote { 1 } else { 2 });
2921 // Revoke the old state
2922 claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage);
2924 let value = if use_dust {
2925 // The dust limit applied to HTLC outputs considers the fee of the HTLC transaction as
2926 // well, so HTLCs at exactly the dust limit will not be included in commitment txn.
2927 nodes[2].node.channel_state.lock().unwrap().by_id.get(&chan_2.2).unwrap().holder_dust_limit_satoshis * 1000
2930 let (_, first_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
2931 let (_, second_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
2932 let (_, third_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
2934 assert!(nodes[2].node.fail_htlc_backwards(&first_payment_hash));
2935 expect_pending_htlcs_forwardable!(nodes[2]);
2936 check_added_monitors!(nodes[2], 1);
2937 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2938 assert!(updates.update_add_htlcs.is_empty());
2939 assert!(updates.update_fulfill_htlcs.is_empty());
2940 assert!(updates.update_fail_malformed_htlcs.is_empty());
2941 assert_eq!(updates.update_fail_htlcs.len(), 1);
2942 assert!(updates.update_fee.is_none());
2943 nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
2944 let bs_raa = commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false, true, false, true);
2945 // Drop the last RAA from 3 -> 2
2947 assert!(nodes[2].node.fail_htlc_backwards(&second_payment_hash));
2948 expect_pending_htlcs_forwardable!(nodes[2]);
2949 check_added_monitors!(nodes[2], 1);
2950 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2951 assert!(updates.update_add_htlcs.is_empty());
2952 assert!(updates.update_fulfill_htlcs.is_empty());
2953 assert!(updates.update_fail_malformed_htlcs.is_empty());
2954 assert_eq!(updates.update_fail_htlcs.len(), 1);
2955 assert!(updates.update_fee.is_none());
2956 nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
2957 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &updates.commitment_signed);
2958 check_added_monitors!(nodes[1], 1);
2959 // Note that nodes[1] is in AwaitingRAA, so won't send a CS
2960 let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
2961 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
2962 check_added_monitors!(nodes[2], 1);
2964 assert!(nodes[2].node.fail_htlc_backwards(&third_payment_hash));
2965 expect_pending_htlcs_forwardable!(nodes[2]);
2966 check_added_monitors!(nodes[2], 1);
2967 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2968 assert!(updates.update_add_htlcs.is_empty());
2969 assert!(updates.update_fulfill_htlcs.is_empty());
2970 assert!(updates.update_fail_malformed_htlcs.is_empty());
2971 assert_eq!(updates.update_fail_htlcs.len(), 1);
2972 assert!(updates.update_fee.is_none());
2973 nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
2974 // At this point first_payment_hash has dropped out of the latest two commitment
2975 // transactions that nodes[1] is tracking...
2976 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &updates.commitment_signed);
2977 check_added_monitors!(nodes[1], 1);
2978 // Note that nodes[1] is (still) in AwaitingRAA, so won't send a CS
2979 let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
2980 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
2981 check_added_monitors!(nodes[2], 1);
2983 // Add a fourth HTLC, this one will get sequestered away in nodes[1]'s holding cell waiting
2984 // on nodes[2]'s RAA.
2985 let (_, fourth_payment_hash, fourth_payment_secret) = get_payment_preimage_hash!(nodes[2]);
2986 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
2987 let logger = test_utils::TestLogger::new();
2988 let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[2].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
2989 nodes[1].node.send_payment(&route, fourth_payment_hash, &Some(fourth_payment_secret)).unwrap();
2990 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2991 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
2992 check_added_monitors!(nodes[1], 0);
2995 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_raa);
2996 // One monitor for the new revocation preimage, no second on as we won't generate a new
2997 // commitment transaction for nodes[0] until process_pending_htlc_forwards().
2998 check_added_monitors!(nodes[1], 1);
2999 let events = nodes[1].node.get_and_clear_pending_events();
3000 assert_eq!(events.len(), 1);
3002 Event::PendingHTLCsForwardable { .. } => { },
3003 _ => panic!("Unexpected event"),
3005 // Deliberately don't process the pending fail-back so they all fail back at once after
3006 // block connection just like the !deliver_bs_raa case
3009 let mut failed_htlcs = HashSet::new();
3010 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
3012 mine_transaction(&nodes[1], &revoked_local_txn[0]);
3013 check_added_monitors!(nodes[1], 1);
3014 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
3016 let events = nodes[1].node.get_and_clear_pending_events();
3017 assert_eq!(events.len(), if deliver_bs_raa { 2 } else { 3 });
3019 Event::ChannelClosed { reason: ClosureReason::CommitmentTxConfirmed, .. } => { },
3020 _ => panic!("Unexepected event"),
3023 Event::PaymentPathFailed { ref payment_hash, .. } => {
3024 assert_eq!(*payment_hash, fourth_payment_hash);
3026 _ => panic!("Unexpected event"),
3028 if !deliver_bs_raa {
3030 Event::PendingHTLCsForwardable { .. } => { },
3031 _ => panic!("Unexpected event"),
3034 nodes[1].node.process_pending_htlc_forwards();
3035 check_added_monitors!(nodes[1], 1);
3037 let events = nodes[1].node.get_and_clear_pending_msg_events();
3038 assert_eq!(events.len(), if deliver_bs_raa { 4 } else { 3 });
3039 match events[if deliver_bs_raa { 1 } else { 0 }] {
3040 MessageSendEvent::BroadcastChannelUpdate { msg: msgs::ChannelUpdate { .. } } => {},
3041 _ => panic!("Unexpected event"),
3043 match events[if deliver_bs_raa { 2 } else { 1 }] {
3044 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { msg: msgs::ErrorMessage { channel_id, ref data } }, node_id: _ } => {
3045 assert_eq!(channel_id, chan_2.2);
3046 assert_eq!(data.as_str(), "Commitment or closing transaction was confirmed on chain.");
3048 _ => panic!("Unexpected event"),
3052 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, .. } } => {
3053 assert_eq!(nodes[2].node.get_our_node_id(), *node_id);
3054 assert_eq!(update_add_htlcs.len(), 1);
3055 assert!(update_fulfill_htlcs.is_empty());
3056 assert!(update_fail_htlcs.is_empty());
3057 assert!(update_fail_malformed_htlcs.is_empty());
3059 _ => panic!("Unexpected event"),
3062 match events[if deliver_bs_raa { 3 } else { 2 }] {
3063 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, .. } } => {
3064 assert!(update_add_htlcs.is_empty());
3065 assert_eq!(update_fail_htlcs.len(), 3);
3066 assert!(update_fulfill_htlcs.is_empty());
3067 assert!(update_fail_malformed_htlcs.is_empty());
3068 assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
3070 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
3071 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[1]);
3072 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[2]);
3074 commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
3076 let events = nodes[0].node.get_and_clear_pending_events();
3077 assert_eq!(events.len(), 3);
3079 Event::PaymentPathFailed { ref payment_hash, rejected_by_dest: _, ref network_update, .. } => {
3080 assert!(failed_htlcs.insert(payment_hash.0));
3081 // If we delivered B's RAA we got an unknown preimage error, not something
3082 // that we should update our routing table for.
3083 if !deliver_bs_raa {
3084 assert!(network_update.is_some());
3087 _ => panic!("Unexpected event"),
3090 Event::PaymentPathFailed { ref payment_hash, rejected_by_dest: _, ref network_update, .. } => {
3091 assert!(failed_htlcs.insert(payment_hash.0));
3092 assert!(network_update.is_some());
3094 _ => panic!("Unexpected event"),
3097 Event::PaymentPathFailed { ref payment_hash, rejected_by_dest: _, ref network_update, .. } => {
3098 assert!(failed_htlcs.insert(payment_hash.0));
3099 assert!(network_update.is_some());
3101 _ => panic!("Unexpected event"),
3104 _ => panic!("Unexpected event"),
3107 assert!(failed_htlcs.contains(&first_payment_hash.0));
3108 assert!(failed_htlcs.contains(&second_payment_hash.0));
3109 assert!(failed_htlcs.contains(&third_payment_hash.0));
3113 fn test_commitment_revoked_fail_backward_exhaustive_a() {
3114 do_test_commitment_revoked_fail_backward_exhaustive(false, true, false);
3115 do_test_commitment_revoked_fail_backward_exhaustive(true, true, false);
3116 do_test_commitment_revoked_fail_backward_exhaustive(false, false, false);
3117 do_test_commitment_revoked_fail_backward_exhaustive(true, false, false);
3121 fn test_commitment_revoked_fail_backward_exhaustive_b() {
3122 do_test_commitment_revoked_fail_backward_exhaustive(false, true, true);
3123 do_test_commitment_revoked_fail_backward_exhaustive(true, true, true);
3124 do_test_commitment_revoked_fail_backward_exhaustive(false, false, true);
3125 do_test_commitment_revoked_fail_backward_exhaustive(true, false, true);
3129 fn fail_backward_pending_htlc_upon_channel_failure() {
3130 let chanmon_cfgs = create_chanmon_cfgs(2);
3131 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3132 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3133 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3134 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1_000_000, 500_000_000, InitFeatures::known(), InitFeatures::known());
3135 let logger = test_utils::TestLogger::new();
3137 // Alice -> Bob: Route a payment but without Bob sending revoke_and_ack.
3139 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1]);
3140 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3141 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 50_000, TEST_FINAL_CLTV, &logger).unwrap();
3142 nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
3143 check_added_monitors!(nodes[0], 1);
3145 let payment_event = {
3146 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3147 assert_eq!(events.len(), 1);
3148 SendEvent::from_event(events.remove(0))
3150 assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
3151 assert_eq!(payment_event.msgs.len(), 1);
3154 // Alice -> Bob: Route another payment but now Alice waits for Bob's earlier revoke_and_ack.
3155 let (_, failed_payment_hash, failed_payment_secret) = get_payment_preimage_hash!(nodes[1]);
3157 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3158 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 50_000, TEST_FINAL_CLTV, &logger).unwrap();
3159 nodes[0].node.send_payment(&route, failed_payment_hash, &Some(failed_payment_secret)).unwrap();
3160 check_added_monitors!(nodes[0], 0);
3162 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3165 // Alice <- Bob: Send a malformed update_add_htlc so Alice fails the channel.
3167 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[0]);
3169 let secp_ctx = Secp256k1::new();
3170 let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
3171 let current_height = nodes[1].node.best_block.read().unwrap().height() + 1;
3172 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
3173 let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[0].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 50_000, TEST_FINAL_CLTV, &logger).unwrap();
3174 let (onion_payloads, _amount_msat, cltv_expiry) = onion_utils::build_onion_payloads(&route.paths[0], 50_000, &Some(payment_secret), current_height, &None).unwrap();
3175 let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route.paths[0], &session_priv).unwrap();
3176 let onion_routing_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
3178 // Send a 0-msat update_add_htlc to fail the channel.
3179 let update_add_htlc = msgs::UpdateAddHTLC {
3185 onion_routing_packet,
3187 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &update_add_htlc);
3189 let events = nodes[0].node.get_and_clear_pending_events();
3190 assert_eq!(events.len(), 2);
3191 // Check that Alice fails backward the pending HTLC from the second payment.
3193 Event::PaymentPathFailed { payment_hash, .. } => {
3194 assert_eq!(payment_hash, failed_payment_hash);
3196 _ => panic!("Unexpected event"),
3199 Event::ChannelClosed { reason: ClosureReason::ProcessingError { ref err }, .. } => {
3200 assert_eq!(err, "Remote side tried to send a 0-msat HTLC");
3202 _ => panic!("Unexpected event {:?}", events[1]),
3204 check_closed_broadcast!(nodes[0], true);
3205 check_added_monitors!(nodes[0], 1);
3209 fn test_htlc_ignore_latest_remote_commitment() {
3210 // Test that HTLC transactions spending the latest remote commitment transaction are simply
3211 // ignored if we cannot claim them. This originally tickled an invalid unwrap().
3212 let chanmon_cfgs = create_chanmon_cfgs(2);
3213 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3214 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3215 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3216 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3218 route_payment(&nodes[0], &[&nodes[1]], 10000000);
3219 nodes[0].node.force_close_channel(&nodes[0].node.list_channels()[0].channel_id).unwrap();
3220 connect_blocks(&nodes[0], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + 1);
3221 check_closed_broadcast!(nodes[0], true);
3222 check_added_monitors!(nodes[0], 1);
3223 check_closed_event!(nodes[0], 1, ClosureReason::HolderForceClosed);
3225 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
3226 assert_eq!(node_txn.len(), 3);
3227 assert_eq!(node_txn[0], node_txn[1]);
3229 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3230 connect_block(&nodes[1], &Block { header, txdata: vec![node_txn[0].clone(), node_txn[1].clone()]});
3231 check_closed_broadcast!(nodes[1], true);
3232 check_added_monitors!(nodes[1], 1);
3233 check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
3235 // Duplicate the connect_block call since this may happen due to other listeners
3236 // registering new transactions
3237 header.prev_blockhash = header.block_hash();
3238 connect_block(&nodes[1], &Block { header, txdata: vec![node_txn[0].clone(), node_txn[2].clone()]});
3242 fn test_force_close_fail_back() {
3243 // Check which HTLCs are failed-backwards on channel force-closure
3244 let chanmon_cfgs = create_chanmon_cfgs(3);
3245 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3246 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3247 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3248 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3249 create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3250 let logger = test_utils::TestLogger::new();
3252 let (our_payment_preimage, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[2]);
3254 let mut payment_event = {
3255 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3256 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[2].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 1000000, 42, &logger).unwrap();
3257 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
3258 check_added_monitors!(nodes[0], 1);
3260 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3261 assert_eq!(events.len(), 1);
3262 SendEvent::from_event(events.remove(0))
3265 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
3266 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
3268 expect_pending_htlcs_forwardable!(nodes[1]);
3270 let mut events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3271 assert_eq!(events_2.len(), 1);
3272 payment_event = SendEvent::from_event(events_2.remove(0));
3273 assert_eq!(payment_event.msgs.len(), 1);
3275 check_added_monitors!(nodes[1], 1);
3276 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
3277 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg);
3278 check_added_monitors!(nodes[2], 1);
3279 let (_, _) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3281 // nodes[2] now has the latest commitment transaction, but hasn't revoked its previous
3282 // state or updated nodes[1]' state. Now force-close and broadcast that commitment/HTLC
3283 // transaction and ensure nodes[1] doesn't fail-backwards (this was originally a bug!).
3285 nodes[2].node.force_close_channel(&payment_event.commitment_msg.channel_id).unwrap();
3286 check_closed_broadcast!(nodes[2], true);
3287 check_added_monitors!(nodes[2], 1);
3288 check_closed_event!(nodes[2], 1, ClosureReason::HolderForceClosed);
3290 let mut node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap();
3291 // Note that we don't bother broadcasting the HTLC-Success transaction here as we don't
3292 // have a use for it unless nodes[2] learns the preimage somehow, the funds will go
3293 // back to nodes[1] upon timeout otherwise.
3294 assert_eq!(node_txn.len(), 1);
3298 mine_transaction(&nodes[1], &tx);
3300 // Note no UpdateHTLCs event here from nodes[1] to nodes[0]!
3301 check_closed_broadcast!(nodes[1], true);
3302 check_added_monitors!(nodes[1], 1);
3303 check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
3305 // Now check that if we add the preimage to ChannelMonitor it broadcasts our HTLC-Success..
3307 let mut monitors = nodes[2].chain_monitor.chain_monitor.monitors.read().unwrap();
3308 monitors.get(&OutPoint{ txid: Txid::from_slice(&payment_event.commitment_msg.channel_id[..]).unwrap(), index: 0 }).unwrap()
3309 .provide_payment_preimage(&our_payment_hash, &our_payment_preimage, &node_cfgs[2].tx_broadcaster, &node_cfgs[2].fee_estimator, &&logger);
3311 mine_transaction(&nodes[2], &tx);
3312 let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap();
3313 assert_eq!(node_txn.len(), 1);
3314 assert_eq!(node_txn[0].input.len(), 1);
3315 assert_eq!(node_txn[0].input[0].previous_output.txid, tx.txid());
3316 assert_eq!(node_txn[0].lock_time, 0); // Must be an HTLC-Success
3317 assert_eq!(node_txn[0].input[0].witness.len(), 5); // Must be an HTLC-Success
3319 check_spends!(node_txn[0], tx);
3323 fn test_dup_events_on_peer_disconnect() {
3324 // Test that if we receive a duplicative update_fulfill_htlc message after a reconnect we do
3325 // not generate a corresponding duplicative PaymentSent event. This did not use to be the case
3326 // as we used to generate the event immediately upon receipt of the payment preimage in the
3327 // update_fulfill_htlc message.
3329 let chanmon_cfgs = create_chanmon_cfgs(2);
3330 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3331 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3332 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3333 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3335 let payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 1000000).0;
3337 assert!(nodes[1].node.claim_funds(payment_preimage));
3338 check_added_monitors!(nodes[1], 1);
3339 let claim_msgs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3340 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &claim_msgs.update_fulfill_htlcs[0]);
3341 expect_payment_sent!(nodes[0], payment_preimage);
3343 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3344 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3346 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (1, 0), (0, 0), (0, 0), (0, 0), (false, false));
3347 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
3351 fn test_simple_peer_disconnect() {
3352 // Test that we can reconnect when there are no lost messages
3353 let chanmon_cfgs = create_chanmon_cfgs(3);
3354 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3355 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3356 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3357 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3358 create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3360 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3361 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3362 reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3364 let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3365 let payment_hash_2 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3366 fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_hash_2);
3367 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_preimage_1);
3369 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3370 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3371 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3373 let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3374 let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3375 let payment_hash_5 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3376 let payment_hash_6 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3378 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3379 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3381 claim_payment_along_route(&nodes[0], &[&[&nodes[1], &nodes[2]]], true, payment_preimage_3);
3382 fail_payment_along_route(&nodes[0], &[&[&nodes[1], &nodes[2]]], true, payment_hash_5);
3384 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (1, 0), (1, 0), (false, false));
3386 let events = nodes[0].node.get_and_clear_pending_events();
3387 assert_eq!(events.len(), 2);
3389 Event::PaymentSent { payment_preimage } => {
3390 assert_eq!(payment_preimage, payment_preimage_3);
3392 _ => panic!("Unexpected event"),
3395 Event::PaymentPathFailed { payment_hash, rejected_by_dest, .. } => {
3396 assert_eq!(payment_hash, payment_hash_5);
3397 assert!(rejected_by_dest);
3399 _ => panic!("Unexpected event"),
3403 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_preimage_4);
3404 fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_hash_6);
3407 fn do_test_drop_messages_peer_disconnect(messages_delivered: u8, simulate_broken_lnd: bool) {
3408 // Test that we can reconnect when in-flight HTLC updates get dropped
3409 let chanmon_cfgs = create_chanmon_cfgs(2);
3410 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3411 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3412 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3414 let mut as_funding_locked = None;
3415 if messages_delivered == 0 {
3416 let (funding_locked, _, _) = create_chan_between_nodes_with_value_a(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
3417 as_funding_locked = Some(funding_locked);
3418 // nodes[1] doesn't receive the funding_locked message (it'll be re-sent on reconnect)
3419 // Note that we store it so that if we're running with `simulate_broken_lnd` we can deliver
3420 // it before the channel_reestablish message.
3422 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3425 let (payment_preimage_1, payment_hash_1, payment_secret_1) = get_payment_preimage_hash!(nodes[1]);
3427 let logger = test_utils::TestLogger::new();
3428 let payment_event = {
3429 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3430 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph,
3431 &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), Some(&nodes[0].node.list_usable_channels().iter().collect::<Vec<_>>()),
3432 &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
3433 nodes[0].node.send_payment(&route, payment_hash_1, &Some(payment_secret_1)).unwrap();
3434 check_added_monitors!(nodes[0], 1);
3436 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3437 assert_eq!(events.len(), 1);
3438 SendEvent::from_event(events.remove(0))
3440 assert_eq!(nodes[1].node.get_our_node_id(), payment_event.node_id);
3442 if messages_delivered < 2 {
3443 // Drop the payment_event messages, and let them get re-generated in reconnect_nodes!
3445 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
3446 if messages_delivered >= 3 {
3447 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
3448 check_added_monitors!(nodes[1], 1);
3449 let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3451 if messages_delivered >= 4 {
3452 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3453 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3454 check_added_monitors!(nodes[0], 1);
3456 if messages_delivered >= 5 {
3457 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_commitment_signed);
3458 let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3459 // No commitment_signed so get_event_msg's assert(len == 1) passes
3460 check_added_monitors!(nodes[0], 1);
3462 if messages_delivered >= 6 {
3463 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3464 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3465 check_added_monitors!(nodes[1], 1);
3472 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3473 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3474 if messages_delivered < 3 {
3475 if simulate_broken_lnd {
3476 // lnd has a long-standing bug where they send a funding_locked prior to a
3477 // channel_reestablish if you reconnect prior to funding_locked time.
3479 // Here we simulate that behavior, delivering a funding_locked immediately on
3480 // reconnect. Note that we don't bother skipping the now-duplicate funding_locked sent
3481 // in `reconnect_nodes` but we currently don't fail based on that.
3483 // See-also <https://github.com/lightningnetwork/lnd/issues/4006>
3484 nodes[1].node.handle_funding_locked(&nodes[0].node.get_our_node_id(), &as_funding_locked.as_ref().unwrap().0);
3486 // Even if the funding_locked messages get exchanged, as long as nothing further was
3487 // received on either side, both sides will need to resend them.
3488 reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 1), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3489 } else if messages_delivered == 3 {
3490 // nodes[0] still wants its RAA + commitment_signed
3491 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (-1, 0), (0, 0), (0, 0), (0, 0), (0, 0), (true, false));
3492 } else if messages_delivered == 4 {
3493 // nodes[0] still wants its commitment_signed
3494 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (-1, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3495 } else if messages_delivered == 5 {
3496 // nodes[1] still wants its final RAA
3497 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, true));
3498 } else if messages_delivered == 6 {
3499 // Everything was delivered...
3500 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3503 let events_1 = nodes[1].node.get_and_clear_pending_events();
3504 assert_eq!(events_1.len(), 1);
3506 Event::PendingHTLCsForwardable { .. } => { },
3507 _ => panic!("Unexpected event"),
3510 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3511 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3512 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3514 nodes[1].node.process_pending_htlc_forwards();
3516 let events_2 = nodes[1].node.get_and_clear_pending_events();
3517 assert_eq!(events_2.len(), 1);
3519 Event::PaymentReceived { ref payment_hash, ref purpose, amt } => {
3520 assert_eq!(payment_hash_1, *payment_hash);
3521 assert_eq!(amt, 1000000);
3523 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
3524 assert!(payment_preimage.is_none());
3525 assert_eq!(payment_secret_1, *payment_secret);
3527 _ => panic!("expected PaymentPurpose::InvoicePayment")
3530 _ => panic!("Unexpected event"),
3533 nodes[1].node.claim_funds(payment_preimage_1);
3534 check_added_monitors!(nodes[1], 1);
3536 let events_3 = nodes[1].node.get_and_clear_pending_msg_events();
3537 assert_eq!(events_3.len(), 1);
3538 let (update_fulfill_htlc, commitment_signed) = match events_3[0] {
3539 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
3540 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3541 assert!(updates.update_add_htlcs.is_empty());
3542 assert!(updates.update_fail_htlcs.is_empty());
3543 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
3544 assert!(updates.update_fail_malformed_htlcs.is_empty());
3545 assert!(updates.update_fee.is_none());
3546 (updates.update_fulfill_htlcs[0].clone(), updates.commitment_signed.clone())
3548 _ => panic!("Unexpected event"),
3551 if messages_delivered >= 1 {
3552 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlc);
3554 let events_4 = nodes[0].node.get_and_clear_pending_events();
3555 assert_eq!(events_4.len(), 1);
3557 Event::PaymentSent { ref payment_preimage } => {
3558 assert_eq!(payment_preimage_1, *payment_preimage);
3560 _ => panic!("Unexpected event"),
3563 if messages_delivered >= 2 {
3564 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
3565 check_added_monitors!(nodes[0], 1);
3566 let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
3568 if messages_delivered >= 3 {
3569 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3570 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3571 check_added_monitors!(nodes[1], 1);
3573 if messages_delivered >= 4 {
3574 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed);
3575 let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3576 // No commitment_signed so get_event_msg's assert(len == 1) passes
3577 check_added_monitors!(nodes[1], 1);
3579 if messages_delivered >= 5 {
3580 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3581 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3582 check_added_monitors!(nodes[0], 1);
3589 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3590 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3591 if messages_delivered < 2 {
3592 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (1, 0), (0, 0), (0, 0), (0, 0), (false, false));
3593 if messages_delivered < 1 {
3594 let events_4 = nodes[0].node.get_and_clear_pending_events();
3595 assert_eq!(events_4.len(), 1);
3597 Event::PaymentSent { ref payment_preimage } => {
3598 assert_eq!(payment_preimage_1, *payment_preimage);
3600 _ => panic!("Unexpected event"),
3603 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3605 } else if messages_delivered == 2 {
3606 // nodes[0] still wants its RAA + commitment_signed
3607 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, -1), (0, 0), (0, 0), (0, 0), (0, 0), (false, true));
3608 } else if messages_delivered == 3 {
3609 // nodes[0] still wants its commitment_signed
3610 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, -1), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3611 } else if messages_delivered == 4 {
3612 // nodes[1] still wants its final RAA
3613 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (true, false));
3614 } else if messages_delivered == 5 {
3615 // Everything was delivered...
3616 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3619 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3620 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3621 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3623 // Channel should still work fine...
3624 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3625 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph,
3626 &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), Some(&nodes[0].node.list_usable_channels().iter().collect::<Vec<_>>()),
3627 &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
3628 let payment_preimage_2 = send_along_route(&nodes[0], route, &[&nodes[1]], 1000000).0;
3629 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
3633 fn test_drop_messages_peer_disconnect_a() {
3634 do_test_drop_messages_peer_disconnect(0, true);
3635 do_test_drop_messages_peer_disconnect(0, false);
3636 do_test_drop_messages_peer_disconnect(1, false);
3637 do_test_drop_messages_peer_disconnect(2, false);
3641 fn test_drop_messages_peer_disconnect_b() {
3642 do_test_drop_messages_peer_disconnect(3, false);
3643 do_test_drop_messages_peer_disconnect(4, false);
3644 do_test_drop_messages_peer_disconnect(5, false);
3645 do_test_drop_messages_peer_disconnect(6, false);
3649 fn test_funding_peer_disconnect() {
3650 // Test that we can lock in our funding tx while disconnected
3651 let chanmon_cfgs = create_chanmon_cfgs(2);
3652 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3653 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3654 let persister: test_utils::TestPersister;
3655 let new_chain_monitor: test_utils::TestChainMonitor;
3656 let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
3657 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3658 let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
3660 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3661 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3663 confirm_transaction(&nodes[0], &tx);
3664 let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
3665 assert_eq!(events_1.len(), 1);
3667 MessageSendEvent::SendFundingLocked { ref node_id, msg: _ } => {
3668 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
3670 _ => panic!("Unexpected event"),
3673 reconnect_nodes(&nodes[0], &nodes[1], (false, true), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3675 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3676 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3678 confirm_transaction(&nodes[1], &tx);
3679 let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3680 assert_eq!(events_2.len(), 2);
3681 let funding_locked = match events_2[0] {
3682 MessageSendEvent::SendFundingLocked { ref node_id, ref msg } => {
3683 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3686 _ => panic!("Unexpected event"),
3688 let bs_announcement_sigs = match events_2[1] {
3689 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
3690 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3693 _ => panic!("Unexpected event"),
3696 reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3698 nodes[0].node.handle_funding_locked(&nodes[1].node.get_our_node_id(), &funding_locked);
3699 nodes[0].node.handle_announcement_signatures(&nodes[1].node.get_our_node_id(), &bs_announcement_sigs);
3700 let events_3 = nodes[0].node.get_and_clear_pending_msg_events();
3701 assert_eq!(events_3.len(), 2);
3702 let as_announcement_sigs = match events_3[0] {
3703 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
3704 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
3707 _ => panic!("Unexpected event"),
3709 let (as_announcement, as_update) = match events_3[1] {
3710 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
3711 (msg.clone(), update_msg.clone())
3713 _ => panic!("Unexpected event"),
3716 nodes[1].node.handle_announcement_signatures(&nodes[0].node.get_our_node_id(), &as_announcement_sigs);
3717 let events_4 = nodes[1].node.get_and_clear_pending_msg_events();
3718 assert_eq!(events_4.len(), 1);
3719 let (_, bs_update) = match events_4[0] {
3720 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
3721 (msg.clone(), update_msg.clone())
3723 _ => panic!("Unexpected event"),
3726 nodes[0].net_graph_msg_handler.handle_channel_announcement(&as_announcement).unwrap();
3727 nodes[0].net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
3728 nodes[0].net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
3730 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3731 let logger = test_utils::TestLogger::new();
3732 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
3733 let (payment_preimage, _, _) = send_along_route(&nodes[0], route, &[&nodes[1]], 1000000);
3734 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage);
3736 // Check that after deserialization and reconnection we can still generate an identical
3737 // channel_announcement from the cached signatures.
3738 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3740 let nodes_0_serialized = nodes[0].node.encode();
3741 let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
3742 nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
3744 persister = test_utils::TestPersister::new();
3745 let keys_manager = &chanmon_cfgs[0].keys_manager;
3746 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);
3747 nodes[0].chain_monitor = &new_chain_monitor;
3748 let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
3749 let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
3750 &mut chan_0_monitor_read, keys_manager).unwrap();
3751 assert!(chan_0_monitor_read.is_empty());
3753 let mut nodes_0_read = &nodes_0_serialized[..];
3754 let (_, nodes_0_deserialized_tmp) = {
3755 let mut channel_monitors = HashMap::new();
3756 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
3757 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
3758 default_config: UserConfig::default(),
3760 fee_estimator: node_cfgs[0].fee_estimator,
3761 chain_monitor: nodes[0].chain_monitor,
3762 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
3763 logger: nodes[0].logger,
3767 nodes_0_deserialized = nodes_0_deserialized_tmp;
3768 assert!(nodes_0_read.is_empty());
3770 assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
3771 nodes[0].node = &nodes_0_deserialized;
3772 check_added_monitors!(nodes[0], 1);
3774 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3776 // as_announcement should be re-generated exactly by broadcast_node_announcement.
3777 nodes[0].node.broadcast_node_announcement([0, 0, 0], [0; 32], Vec::new());
3778 let msgs = nodes[0].node.get_and_clear_pending_msg_events();
3779 let mut found_announcement = false;
3780 for event in msgs.iter() {
3782 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, .. } => {
3783 if *msg == as_announcement { found_announcement = true; }
3785 MessageSendEvent::BroadcastNodeAnnouncement { .. } => {},
3786 _ => panic!("Unexpected event"),
3789 assert!(found_announcement);
3793 fn test_drop_messages_peer_disconnect_dual_htlc() {
3794 // Test that we can handle reconnecting when both sides of a channel have pending
3795 // commitment_updates when we disconnect.
3796 let chanmon_cfgs = create_chanmon_cfgs(2);
3797 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3798 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3799 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3800 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3801 let logger = test_utils::TestLogger::new();
3803 let (payment_preimage_1, _, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
3805 // Now try to send a second payment which will fail to send
3806 let (payment_preimage_2, payment_hash_2, payment_secret_2) = get_payment_preimage_hash!(nodes[1]);
3807 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3808 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
3809 nodes[0].node.send_payment(&route, payment_hash_2, &Some(payment_secret_2)).unwrap();
3810 check_added_monitors!(nodes[0], 1);
3812 let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
3813 assert_eq!(events_1.len(), 1);
3815 MessageSendEvent::UpdateHTLCs { .. } => {},
3816 _ => panic!("Unexpected event"),
3819 assert!(nodes[1].node.claim_funds(payment_preimage_1));
3820 check_added_monitors!(nodes[1], 1);
3822 let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3823 assert_eq!(events_2.len(), 1);
3825 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 } } => {
3826 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3827 assert!(update_add_htlcs.is_empty());
3828 assert_eq!(update_fulfill_htlcs.len(), 1);
3829 assert!(update_fail_htlcs.is_empty());
3830 assert!(update_fail_malformed_htlcs.is_empty());
3831 assert!(update_fee.is_none());
3833 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlcs[0]);
3834 let events_3 = nodes[0].node.get_and_clear_pending_events();
3835 assert_eq!(events_3.len(), 1);
3837 Event::PaymentSent { ref payment_preimage } => {
3838 assert_eq!(*payment_preimage, payment_preimage_1);
3840 _ => panic!("Unexpected event"),
3843 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), commitment_signed);
3844 let _ = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3845 // No commitment_signed so get_event_msg's assert(len == 1) passes
3846 check_added_monitors!(nodes[0], 1);
3848 _ => panic!("Unexpected event"),
3851 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3852 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3854 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
3855 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
3856 assert_eq!(reestablish_1.len(), 1);
3857 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
3858 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
3859 assert_eq!(reestablish_2.len(), 1);
3861 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
3862 let as_resp = handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
3863 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
3864 let bs_resp = handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
3866 assert!(as_resp.0.is_none());
3867 assert!(bs_resp.0.is_none());
3869 assert!(bs_resp.1.is_none());
3870 assert!(bs_resp.2.is_none());
3872 assert!(as_resp.3 == RAACommitmentOrder::CommitmentFirst);
3874 assert_eq!(as_resp.2.as_ref().unwrap().update_add_htlcs.len(), 1);
3875 assert!(as_resp.2.as_ref().unwrap().update_fulfill_htlcs.is_empty());
3876 assert!(as_resp.2.as_ref().unwrap().update_fail_htlcs.is_empty());
3877 assert!(as_resp.2.as_ref().unwrap().update_fail_malformed_htlcs.is_empty());
3878 assert!(as_resp.2.as_ref().unwrap().update_fee.is_none());
3879 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &as_resp.2.as_ref().unwrap().update_add_htlcs[0]);
3880 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_resp.2.as_ref().unwrap().commitment_signed);
3881 let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3882 // No commitment_signed so get_event_msg's assert(len == 1) passes
3883 check_added_monitors!(nodes[1], 1);
3885 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), as_resp.1.as_ref().unwrap());
3886 let bs_second_commitment_signed = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3887 assert!(bs_second_commitment_signed.update_add_htlcs.is_empty());
3888 assert!(bs_second_commitment_signed.update_fulfill_htlcs.is_empty());
3889 assert!(bs_second_commitment_signed.update_fail_htlcs.is_empty());
3890 assert!(bs_second_commitment_signed.update_fail_malformed_htlcs.is_empty());
3891 assert!(bs_second_commitment_signed.update_fee.is_none());
3892 check_added_monitors!(nodes[1], 1);
3894 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3895 let as_commitment_signed = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
3896 assert!(as_commitment_signed.update_add_htlcs.is_empty());
3897 assert!(as_commitment_signed.update_fulfill_htlcs.is_empty());
3898 assert!(as_commitment_signed.update_fail_htlcs.is_empty());
3899 assert!(as_commitment_signed.update_fail_malformed_htlcs.is_empty());
3900 assert!(as_commitment_signed.update_fee.is_none());
3901 check_added_monitors!(nodes[0], 1);
3903 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_commitment_signed.commitment_signed);
3904 let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3905 // No commitment_signed so get_event_msg's assert(len == 1) passes
3906 check_added_monitors!(nodes[0], 1);
3908 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed.commitment_signed);
3909 let bs_second_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3910 // No commitment_signed so get_event_msg's assert(len == 1) passes
3911 check_added_monitors!(nodes[1], 1);
3913 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3914 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3915 check_added_monitors!(nodes[1], 1);
3917 expect_pending_htlcs_forwardable!(nodes[1]);
3919 let events_5 = nodes[1].node.get_and_clear_pending_events();
3920 assert_eq!(events_5.len(), 1);
3922 Event::PaymentReceived { ref payment_hash, ref purpose, .. } => {
3923 assert_eq!(payment_hash_2, *payment_hash);
3925 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
3926 assert!(payment_preimage.is_none());
3927 assert_eq!(payment_secret_2, *payment_secret);
3929 _ => panic!("expected PaymentPurpose::InvoicePayment")
3932 _ => panic!("Unexpected event"),
3935 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke_and_ack);
3936 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3937 check_added_monitors!(nodes[0], 1);
3939 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
3942 fn do_test_htlc_timeout(send_partial_mpp: bool) {
3943 // If the user fails to claim/fail an HTLC within the HTLC CLTV timeout we fail it for them
3944 // to avoid our counterparty failing the channel.
3945 let chanmon_cfgs = create_chanmon_cfgs(2);
3946 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3947 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3948 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3950 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3951 let logger = test_utils::TestLogger::new();
3953 let our_payment_hash = if send_partial_mpp {
3954 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3955 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
3956 let (_, our_payment_hash, payment_secret) = get_payment_preimage_hash!(&nodes[1]);
3957 // Use the utility function send_payment_along_path to send the payment with MPP data which
3958 // indicates there are more HTLCs coming.
3959 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.
3960 let payment_id = PaymentId([42; 32]);
3961 nodes[0].node.send_payment_along_path(&route.paths[0], &our_payment_hash, &Some(payment_secret), 200000, cur_height, payment_id, &None).unwrap();
3962 check_added_monitors!(nodes[0], 1);
3963 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3964 assert_eq!(events.len(), 1);
3965 // Now do the relevant commitment_signed/RAA dances along the path, noting that the final
3966 // hop should *not* yet generate any PaymentReceived event(s).
3967 pass_along_path(&nodes[0], &[&nodes[1]], 100000, our_payment_hash, Some(payment_secret), events.drain(..).next().unwrap(), false, None);
3970 route_payment(&nodes[0], &[&nodes[1]], 100000).1
3973 let mut block = Block {
3974 header: BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
3977 connect_block(&nodes[0], &block);
3978 connect_block(&nodes[1], &block);
3979 let block_count = TEST_FINAL_CLTV + CHAN_CONFIRM_DEPTH + 2 - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS;
3980 for _ in CHAN_CONFIRM_DEPTH + 2..block_count {
3981 block.header.prev_blockhash = block.block_hash();
3982 connect_block(&nodes[0], &block);
3983 connect_block(&nodes[1], &block);
3986 expect_pending_htlcs_forwardable!(nodes[1]);
3988 check_added_monitors!(nodes[1], 1);
3989 let htlc_timeout_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3990 assert!(htlc_timeout_updates.update_add_htlcs.is_empty());
3991 assert_eq!(htlc_timeout_updates.update_fail_htlcs.len(), 1);
3992 assert!(htlc_timeout_updates.update_fail_malformed_htlcs.is_empty());
3993 assert!(htlc_timeout_updates.update_fee.is_none());
3995 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_timeout_updates.update_fail_htlcs[0]);
3996 commitment_signed_dance!(nodes[0], nodes[1], htlc_timeout_updates.commitment_signed, false);
3997 // 100_000 msat as u64, followed by the height at which we failed back above
3998 let mut expected_failure_data = byte_utils::be64_to_array(100_000).to_vec();
3999 expected_failure_data.extend_from_slice(&byte_utils::be32_to_array(block_count - 1));
4000 expect_payment_failed!(nodes[0], our_payment_hash, true, 0x4000 | 15, &expected_failure_data[..]);
4004 fn test_htlc_timeout() {
4005 do_test_htlc_timeout(true);
4006 do_test_htlc_timeout(false);
4009 fn do_test_holding_cell_htlc_add_timeouts(forwarded_htlc: bool) {
4010 // Tests that HTLCs in the holding cell are timed out after the requisite number of blocks.
4011 let chanmon_cfgs = create_chanmon_cfgs(3);
4012 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
4013 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
4014 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
4015 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4016 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
4018 // Make sure all nodes are at the same starting height
4019 connect_blocks(&nodes[0], 2*CHAN_CONFIRM_DEPTH + 1 - nodes[0].best_block_info().1);
4020 connect_blocks(&nodes[1], 2*CHAN_CONFIRM_DEPTH + 1 - nodes[1].best_block_info().1);
4021 connect_blocks(&nodes[2], 2*CHAN_CONFIRM_DEPTH + 1 - nodes[2].best_block_info().1);
4023 let logger = test_utils::TestLogger::new();
4025 // Route a first payment to get the 1 -> 2 channel in awaiting_raa...
4026 let (_, first_payment_hash, first_payment_secret) = get_payment_preimage_hash!(nodes[2]);
4028 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
4029 let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[2].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
4030 nodes[1].node.send_payment(&route, first_payment_hash, &Some(first_payment_secret)).unwrap();
4032 assert_eq!(nodes[1].node.get_and_clear_pending_msg_events().len(), 1);
4033 check_added_monitors!(nodes[1], 1);
4035 // Now attempt to route a second payment, which should be placed in the holding cell
4036 let (_, second_payment_hash, second_payment_secret) = get_payment_preimage_hash!(nodes[2]);
4038 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
4039 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[2].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
4040 nodes[0].node.send_payment(&route, second_payment_hash, &Some(first_payment_secret)).unwrap();
4041 check_added_monitors!(nodes[0], 1);
4042 let payment_event = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
4043 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
4044 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
4045 expect_pending_htlcs_forwardable!(nodes[1]);
4046 check_added_monitors!(nodes[1], 0);
4048 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
4049 let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[2].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
4050 nodes[1].node.send_payment(&route, second_payment_hash, &Some(second_payment_secret)).unwrap();
4051 check_added_monitors!(nodes[1], 0);
4054 connect_blocks(&nodes[1], TEST_FINAL_CLTV - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS);
4055 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4056 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
4057 connect_blocks(&nodes[1], 1);
4060 expect_pending_htlcs_forwardable!(nodes[1]);
4061 check_added_monitors!(nodes[1], 1);
4062 let fail_commit = nodes[1].node.get_and_clear_pending_msg_events();
4063 assert_eq!(fail_commit.len(), 1);
4064 match fail_commit[0] {
4065 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fail_htlcs, ref commitment_signed, .. }, .. } => {
4066 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
4067 commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, true, true);
4069 _ => unreachable!(),
4071 expect_payment_failed_with_update!(nodes[0], second_payment_hash, false, chan_2.0.contents.short_channel_id, false);
4073 expect_payment_failed!(nodes[1], second_payment_hash, true);
4078 fn test_holding_cell_htlc_add_timeouts() {
4079 do_test_holding_cell_htlc_add_timeouts(false);
4080 do_test_holding_cell_htlc_add_timeouts(true);
4084 fn test_no_txn_manager_serialize_deserialize() {
4085 let chanmon_cfgs = create_chanmon_cfgs(2);
4086 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4087 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4088 let logger: test_utils::TestLogger;
4089 let fee_estimator: test_utils::TestFeeEstimator;
4090 let persister: test_utils::TestPersister;
4091 let new_chain_monitor: test_utils::TestChainMonitor;
4092 let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4093 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4095 let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
4097 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4099 let nodes_0_serialized = nodes[0].node.encode();
4100 let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4101 nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
4103 logger = test_utils::TestLogger::new();
4104 fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
4105 persister = test_utils::TestPersister::new();
4106 let keys_manager = &chanmon_cfgs[0].keys_manager;
4107 new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator, &persister, keys_manager);
4108 nodes[0].chain_monitor = &new_chain_monitor;
4109 let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4110 let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
4111 &mut chan_0_monitor_read, keys_manager).unwrap();
4112 assert!(chan_0_monitor_read.is_empty());
4114 let mut nodes_0_read = &nodes_0_serialized[..];
4115 let config = UserConfig::default();
4116 let (_, nodes_0_deserialized_tmp) = {
4117 let mut channel_monitors = HashMap::new();
4118 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4119 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4120 default_config: config,
4122 fee_estimator: &fee_estimator,
4123 chain_monitor: nodes[0].chain_monitor,
4124 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4129 nodes_0_deserialized = nodes_0_deserialized_tmp;
4130 assert!(nodes_0_read.is_empty());
4132 assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4133 nodes[0].node = &nodes_0_deserialized;
4134 assert_eq!(nodes[0].node.list_channels().len(), 1);
4135 check_added_monitors!(nodes[0], 1);
4137 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4138 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
4139 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4140 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
4142 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
4143 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4144 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
4145 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4147 let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
4148 let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
4149 for node in nodes.iter() {
4150 assert!(node.net_graph_msg_handler.handle_channel_announcement(&announcement).unwrap());
4151 node.net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
4152 node.net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
4155 send_payment(&nodes[0], &[&nodes[1]], 1000000);
4160 let chanmon_cfgs = create_chanmon_cfgs(4);
4161 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
4162 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
4163 let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
4165 let chan_1_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
4166 let chan_2_id = create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
4167 let chan_3_id = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
4168 let chan_4_id = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
4169 let logger = test_utils::TestLogger::new();
4171 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(&nodes[3]);
4172 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
4173 let mut route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[3].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
4174 let path = route.paths[0].clone();
4175 route.paths.push(path);
4176 route.paths[0][0].pubkey = nodes[1].node.get_our_node_id();
4177 route.paths[0][0].short_channel_id = chan_1_id;
4178 route.paths[0][1].short_channel_id = chan_3_id;
4179 route.paths[1][0].pubkey = nodes[2].node.get_our_node_id();
4180 route.paths[1][0].short_channel_id = chan_2_id;
4181 route.paths[1][1].short_channel_id = chan_4_id;
4182 send_along_route_with_secret(&nodes[0], route, &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], 200_000, payment_hash, payment_secret);
4183 fail_payment_along_route(&nodes[0], &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], false, payment_hash);
4188 let chanmon_cfgs = create_chanmon_cfgs(4);
4189 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
4190 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
4191 let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
4193 let chan_1_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
4194 let chan_2_id = create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
4195 let chan_3_id = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
4196 let chan_4_id = create_announced_chan_between_nodes(&nodes, 3, 2, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
4197 let logger = test_utils::TestLogger::new();
4199 send_payment(&nodes[3], &vec!(&nodes[2])[..], 1_500_000);
4201 let (payment_preimage, payment_hash, payment_secret) = get_payment_preimage_hash!(&nodes[3]);
4202 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
4203 let mut route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[3].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 1_000_000, TEST_FINAL_CLTV, &logger).unwrap();
4204 let path = route.paths[0].clone();
4205 route.paths.push(path);
4206 route.paths[0][0].pubkey = nodes[1].node.get_our_node_id();
4207 route.paths[0][0].short_channel_id = chan_1_id;
4208 route.paths[0][1].short_channel_id = chan_3_id;
4209 route.paths[1][0].pubkey = nodes[2].node.get_our_node_id();
4210 route.paths[1][0].short_channel_id = chan_2_id;
4211 route.paths[1][1].short_channel_id = chan_4_id;
4213 // Initiate the MPP payment.
4214 let payment_id = nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
4215 check_added_monitors!(nodes[0], 2); // one monitor per path
4216 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
4217 assert_eq!(events.len(), 2);
4219 // Pass half of the payment along the success path.
4220 let success_path_msgs = events.remove(0);
4221 pass_along_path(&nodes[0], &[&nodes[1], &nodes[3]], 2_000_000, payment_hash, Some(payment_secret), success_path_msgs, false, None);
4223 // Add the HTLC along the first hop.
4224 let fail_path_msgs_1 = events.remove(0);
4225 let (update_add, commitment_signed) = match fail_path_msgs_1 {
4226 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 } } => {
4227 assert_eq!(update_add_htlcs.len(), 1);
4228 assert!(update_fail_htlcs.is_empty());
4229 assert!(update_fulfill_htlcs.is_empty());
4230 assert!(update_fail_malformed_htlcs.is_empty());
4231 assert!(update_fee.is_none());
4232 (update_add_htlcs[0].clone(), commitment_signed.clone())
4234 _ => panic!("Unexpected event"),
4236 nodes[2].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add);
4237 commitment_signed_dance!(nodes[2], nodes[0], commitment_signed, false);
4239 // Attempt to forward the payment and complete the 2nd path's failure.
4240 expect_pending_htlcs_forwardable!(&nodes[2]);
4241 expect_pending_htlcs_forwardable!(&nodes[2]);
4242 let htlc_updates = get_htlc_update_msgs!(nodes[2], nodes[0].node.get_our_node_id());
4243 assert!(htlc_updates.update_add_htlcs.is_empty());
4244 assert_eq!(htlc_updates.update_fail_htlcs.len(), 1);
4245 assert!(htlc_updates.update_fulfill_htlcs.is_empty());
4246 assert!(htlc_updates.update_fail_malformed_htlcs.is_empty());
4247 check_added_monitors!(nodes[2], 1);
4248 nodes[0].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &htlc_updates.update_fail_htlcs[0]);
4249 commitment_signed_dance!(nodes[0], nodes[2], htlc_updates.commitment_signed, false);
4250 expect_payment_failed!(nodes[0], payment_hash, false);
4252 // Rebalance the channel so the second half of the payment can succeed.
4253 send_payment(&nodes[3], &vec!(&nodes[2])[..], 1_500_000);
4255 // Make sure it errors as expected given a too-large amount.
4256 if let Err(PaymentSendFailure::ParameterError(APIError::APIMisuseError { err })) = nodes[0].node.retry_payment(&route, payment_id) {
4257 assert!(err.contains("over total_payment_amt_msat"));
4258 } else { panic!("Unexpected error"); }
4260 // Make sure it errors as expected given the wrong payment_id.
4261 if let Err(PaymentSendFailure::ParameterError(APIError::APIMisuseError { err })) = nodes[0].node.retry_payment(&route, PaymentId([0; 32])) {
4262 assert!(err.contains("not found"));
4263 } else { panic!("Unexpected error"); }
4265 // Retry the second half of the payment and make sure it succeeds.
4266 let mut path = route.clone();
4267 path.paths.remove(0);
4268 nodes[0].node.retry_payment(&path, payment_id).unwrap();
4269 check_added_monitors!(nodes[0], 1);
4270 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
4271 assert_eq!(events.len(), 1);
4272 pass_along_path(&nodes[0], &[&nodes[2], &nodes[3]], 2_000_000, payment_hash, Some(payment_secret), events.pop().unwrap(), true, None);
4273 claim_payment_along_route(&nodes[0], &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], false, payment_preimage);
4277 fn retry_single_path_payment() {
4278 let chanmon_cfgs = create_chanmon_cfgs(3);
4279 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
4280 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
4281 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
4283 let _chan_0 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4284 let _chan_1 = create_announced_chan_between_nodes(&nodes, 2, 1, InitFeatures::known(), InitFeatures::known());
4285 // Rebalance to find a route
4286 send_payment(&nodes[2], &vec!(&nodes[1])[..], 3_000_000);
4288 let logger = test_utils::TestLogger::new();
4289 let (payment_preimage, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[2]);
4290 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
4291 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[2].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 100_000, TEST_FINAL_CLTV, &logger).unwrap();
4293 // Rebalance so that the first hop fails.
4294 send_payment(&nodes[1], &vec!(&nodes[2])[..], 2_000_000);
4296 // Make sure the payment fails on the first hop.
4297 let payment_id = nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
4298 check_added_monitors!(nodes[0], 1);
4299 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
4300 assert_eq!(events.len(), 1);
4301 let mut payment_event = SendEvent::from_event(events.pop().unwrap());
4302 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
4303 check_added_monitors!(nodes[1], 0);
4304 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
4305 expect_pending_htlcs_forwardable!(nodes[1]);
4306 expect_pending_htlcs_forwardable!(&nodes[1]);
4307 let htlc_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4308 assert!(htlc_updates.update_add_htlcs.is_empty());
4309 assert_eq!(htlc_updates.update_fail_htlcs.len(), 1);
4310 assert!(htlc_updates.update_fulfill_htlcs.is_empty());
4311 assert!(htlc_updates.update_fail_malformed_htlcs.is_empty());
4312 check_added_monitors!(nodes[1], 1);
4313 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_updates.update_fail_htlcs[0]);
4314 commitment_signed_dance!(nodes[0], nodes[1], htlc_updates.commitment_signed, false);
4315 expect_payment_failed!(nodes[0], payment_hash, false);
4317 // Rebalance the channel so the retry succeeds.
4318 send_payment(&nodes[2], &vec!(&nodes[1])[..], 3_000_000);
4320 // Retry the payment and make sure it succeeds.
4321 nodes[0].node.retry_payment(&route, payment_id).unwrap();
4322 check_added_monitors!(nodes[0], 1);
4323 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
4324 assert_eq!(events.len(), 1);
4325 pass_along_path(&nodes[0], &[&nodes[1], &nodes[2]], 100_000, payment_hash, Some(payment_secret), events.pop().unwrap(), true, None);
4326 claim_payment_along_route(&nodes[0], &[&[&nodes[1], &nodes[2]]], false, payment_preimage);
4330 fn test_dup_htlc_onchain_fails_on_reload() {
4331 // When a Channel is closed, any outbound HTLCs which were relayed through it are simply
4332 // dropped when the Channel is. From there, the ChannelManager relies on the ChannelMonitor
4333 // having a copy of the relevant fail-/claim-back data and processes the HTLC fail/claim when
4334 // the ChannelMonitor tells it to.
4336 // If, due to an on-chain event, an HTLC is failed/claimed, and then we serialize the
4337 // ChannelManager, we generally expect there not to be a duplicate HTLC fail/claim (eg via a
4338 // PaymentPathFailed event appearing). However, because we may not serialize the relevant
4339 // ChannelMonitor at the same time, this isn't strictly guaranteed. In order to provide this
4340 // consistency, the ChannelManager explicitly tracks pending-onchain-resolution outbound HTLCs
4341 // and de-duplicates ChannelMonitor events.
4343 // This tests that explicit tracking behavior.
4344 let chanmon_cfgs = create_chanmon_cfgs(2);
4345 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4346 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4347 let persister: test_utils::TestPersister;
4348 let new_chain_monitor: test_utils::TestChainMonitor;
4349 let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4350 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4352 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4354 // Route a payment, but force-close the channel before the HTLC fulfill message arrives at
4356 let (payment_preimage, _, _) = route_payment(&nodes[0], &[&nodes[1]], 10000000);
4357 nodes[0].node.force_close_channel(&nodes[0].node.list_channels()[0].channel_id).unwrap();
4358 check_closed_broadcast!(nodes[0], true);
4359 check_added_monitors!(nodes[0], 1);
4360 check_closed_event!(nodes[0], 1, ClosureReason::HolderForceClosed);
4362 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
4363 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4365 // Connect blocks until the CLTV timeout is up so that we get an HTLC-Timeout transaction
4366 connect_blocks(&nodes[0], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + 1);
4367 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
4368 assert_eq!(node_txn.len(), 3);
4369 assert_eq!(node_txn[0], node_txn[1]);
4371 assert!(nodes[1].node.claim_funds(payment_preimage));
4372 check_added_monitors!(nodes[1], 1);
4374 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4375 connect_block(&nodes[1], &Block { header, txdata: vec![node_txn[1].clone(), node_txn[2].clone()]});
4376 check_closed_broadcast!(nodes[1], true);
4377 check_added_monitors!(nodes[1], 1);
4378 check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
4379 let claim_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
4381 header.prev_blockhash = nodes[0].best_block_hash();
4382 connect_block(&nodes[0], &Block { header, txdata: vec![node_txn[1].clone(), node_txn[2].clone()]});
4384 // Serialize out the ChannelMonitor before connecting the on-chain claim transactions. This is
4385 // fairly normal behavior as ChannelMonitor(s) are often not re-serialized when on-chain events
4386 // happen, unlike ChannelManager which tends to be re-serialized after any relevant event(s).
4387 let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4388 nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
4390 header.prev_blockhash = nodes[0].best_block_hash();
4391 let claim_block = Block { header, txdata: claim_txn};
4392 connect_block(&nodes[0], &claim_block);
4393 expect_payment_sent!(nodes[0], payment_preimage);
4395 // ChannelManagers generally get re-serialized after any relevant event(s). Since we just
4396 // connected a highly-relevant block, it likely gets serialized out now.
4397 let mut chan_manager_serialized = test_utils::TestVecWriter(Vec::new());
4398 nodes[0].node.write(&mut chan_manager_serialized).unwrap();
4400 // Now reload nodes[0]...
4401 persister = test_utils::TestPersister::new();
4402 let keys_manager = &chanmon_cfgs[0].keys_manager;
4403 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);
4404 nodes[0].chain_monitor = &new_chain_monitor;
4405 let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4406 let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
4407 &mut chan_0_monitor_read, keys_manager).unwrap();
4408 assert!(chan_0_monitor_read.is_empty());
4410 let (_, nodes_0_deserialized_tmp) = {
4411 let mut channel_monitors = HashMap::new();
4412 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4413 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>
4414 ::read(&mut io::Cursor::new(&chan_manager_serialized.0[..]), ChannelManagerReadArgs {
4415 default_config: Default::default(),
4417 fee_estimator: node_cfgs[0].fee_estimator,
4418 chain_monitor: nodes[0].chain_monitor,
4419 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4420 logger: nodes[0].logger,
4424 nodes_0_deserialized = nodes_0_deserialized_tmp;
4426 assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4427 check_added_monitors!(nodes[0], 1);
4428 nodes[0].node = &nodes_0_deserialized;
4430 // Note that if we re-connect the block which exposed nodes[0] to the payment preimage (but
4431 // which the current ChannelMonitor has not seen), the ChannelManager's de-duplication of
4432 // payment events should kick in, leaving us with no pending events here.
4433 let height = nodes[0].blocks.lock().unwrap().len() as u32 - 1;
4434 nodes[0].chain_monitor.chain_monitor.block_connected(&claim_block, height);
4435 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
4439 fn test_manager_serialize_deserialize_events() {
4440 // This test makes sure the events field in ChannelManager survives de/serialization
4441 let chanmon_cfgs = create_chanmon_cfgs(2);
4442 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4443 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4444 let fee_estimator: test_utils::TestFeeEstimator;
4445 let persister: test_utils::TestPersister;
4446 let logger: test_utils::TestLogger;
4447 let new_chain_monitor: test_utils::TestChainMonitor;
4448 let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4449 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4451 // Start creating a channel, but stop right before broadcasting the funding transaction
4452 let channel_value = 100000;
4453 let push_msat = 10001;
4454 let a_flags = InitFeatures::known();
4455 let b_flags = InitFeatures::known();
4456 let node_a = nodes.remove(0);
4457 let node_b = nodes.remove(0);
4458 node_a.node.create_channel(node_b.node.get_our_node_id(), channel_value, push_msat, 42, None).unwrap();
4459 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()));
4460 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()));
4462 let (temporary_channel_id, tx, funding_output) = create_funding_transaction(&node_a, channel_value, 42);
4464 node_a.node.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
4465 check_added_monitors!(node_a, 0);
4467 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()));
4469 let mut added_monitors = node_b.chain_monitor.added_monitors.lock().unwrap();
4470 assert_eq!(added_monitors.len(), 1);
4471 assert_eq!(added_monitors[0].0, funding_output);
4472 added_monitors.clear();
4475 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()));
4477 let mut added_monitors = node_a.chain_monitor.added_monitors.lock().unwrap();
4478 assert_eq!(added_monitors.len(), 1);
4479 assert_eq!(added_monitors[0].0, funding_output);
4480 added_monitors.clear();
4482 // Normally, this is where node_a would broadcast the funding transaction, but the test de/serializes first instead
4487 // Start the de/seriailization process mid-channel creation to check that the channel manager will hold onto events that are serialized
4488 let nodes_0_serialized = nodes[0].node.encode();
4489 let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4490 nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
4492 fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
4493 logger = test_utils::TestLogger::new();
4494 persister = test_utils::TestPersister::new();
4495 let keys_manager = &chanmon_cfgs[0].keys_manager;
4496 new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator, &persister, keys_manager);
4497 nodes[0].chain_monitor = &new_chain_monitor;
4498 let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4499 let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
4500 &mut chan_0_monitor_read, keys_manager).unwrap();
4501 assert!(chan_0_monitor_read.is_empty());
4503 let mut nodes_0_read = &nodes_0_serialized[..];
4504 let config = UserConfig::default();
4505 let (_, nodes_0_deserialized_tmp) = {
4506 let mut channel_monitors = HashMap::new();
4507 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4508 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4509 default_config: config,
4511 fee_estimator: &fee_estimator,
4512 chain_monitor: nodes[0].chain_monitor,
4513 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4518 nodes_0_deserialized = nodes_0_deserialized_tmp;
4519 assert!(nodes_0_read.is_empty());
4521 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4523 assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4524 nodes[0].node = &nodes_0_deserialized;
4526 // After deserializing, make sure the funding_transaction is still held by the channel manager
4527 let events_4 = nodes[0].node.get_and_clear_pending_events();
4528 assert_eq!(events_4.len(), 0);
4529 assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
4530 assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0].txid(), funding_output.txid);
4532 // Make sure the channel is functioning as though the de/serialization never happened
4533 assert_eq!(nodes[0].node.list_channels().len(), 1);
4534 check_added_monitors!(nodes[0], 1);
4536 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4537 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
4538 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4539 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
4541 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
4542 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4543 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
4544 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4546 let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
4547 let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
4548 for node in nodes.iter() {
4549 assert!(node.net_graph_msg_handler.handle_channel_announcement(&announcement).unwrap());
4550 node.net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
4551 node.net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
4554 send_payment(&nodes[0], &[&nodes[1]], 1000000);
4558 fn test_simple_manager_serialize_deserialize() {
4559 let chanmon_cfgs = create_chanmon_cfgs(2);
4560 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4561 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4562 let logger: test_utils::TestLogger;
4563 let fee_estimator: test_utils::TestFeeEstimator;
4564 let persister: test_utils::TestPersister;
4565 let new_chain_monitor: test_utils::TestChainMonitor;
4566 let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4567 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4568 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4570 let (our_payment_preimage, _, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
4571 let (_, our_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
4573 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4575 let nodes_0_serialized = nodes[0].node.encode();
4576 let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4577 nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
4579 logger = test_utils::TestLogger::new();
4580 fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
4581 persister = test_utils::TestPersister::new();
4582 let keys_manager = &chanmon_cfgs[0].keys_manager;
4583 new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator, &persister, keys_manager);
4584 nodes[0].chain_monitor = &new_chain_monitor;
4585 let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4586 let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
4587 &mut chan_0_monitor_read, keys_manager).unwrap();
4588 assert!(chan_0_monitor_read.is_empty());
4590 let mut nodes_0_read = &nodes_0_serialized[..];
4591 let (_, nodes_0_deserialized_tmp) = {
4592 let mut channel_monitors = HashMap::new();
4593 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4594 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4595 default_config: UserConfig::default(),
4597 fee_estimator: &fee_estimator,
4598 chain_monitor: nodes[0].chain_monitor,
4599 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4604 nodes_0_deserialized = nodes_0_deserialized_tmp;
4605 assert!(nodes_0_read.is_empty());
4607 assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4608 nodes[0].node = &nodes_0_deserialized;
4609 check_added_monitors!(nodes[0], 1);
4611 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
4613 fail_payment(&nodes[0], &[&nodes[1]], our_payment_hash);
4614 claim_payment(&nodes[0], &[&nodes[1]], our_payment_preimage);
4618 fn test_manager_serialize_deserialize_inconsistent_monitor() {
4619 // Test deserializing a ChannelManager with an out-of-date ChannelMonitor
4620 let chanmon_cfgs = create_chanmon_cfgs(4);
4621 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
4622 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
4623 let logger: test_utils::TestLogger;
4624 let fee_estimator: test_utils::TestFeeEstimator;
4625 let persister: test_utils::TestPersister;
4626 let new_chain_monitor: test_utils::TestChainMonitor;
4627 let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4628 let mut nodes = create_network(4, &node_cfgs, &node_chanmgrs);
4629 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4630 create_announced_chan_between_nodes(&nodes, 2, 0, InitFeatures::known(), InitFeatures::known());
4631 let (_, _, channel_id, funding_tx) = create_announced_chan_between_nodes(&nodes, 0, 3, InitFeatures::known(), InitFeatures::known());
4633 let mut node_0_stale_monitors_serialized = Vec::new();
4634 for monitor in nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter() {
4635 let mut writer = test_utils::TestVecWriter(Vec::new());
4636 monitor.1.write(&mut writer).unwrap();
4637 node_0_stale_monitors_serialized.push(writer.0);
4640 let (our_payment_preimage, _, _) = route_payment(&nodes[2], &[&nodes[0], &nodes[1]], 1000000);
4642 // Serialize the ChannelManager here, but the monitor we keep up-to-date
4643 let nodes_0_serialized = nodes[0].node.encode();
4645 route_payment(&nodes[0], &[&nodes[3]], 1000000);
4646 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4647 nodes[2].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4648 nodes[3].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4650 // Now the ChannelMonitor (which is now out-of-sync with ChannelManager for channel w/
4652 let mut node_0_monitors_serialized = Vec::new();
4653 for monitor in nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter() {
4654 let mut writer = test_utils::TestVecWriter(Vec::new());
4655 monitor.1.write(&mut writer).unwrap();
4656 node_0_monitors_serialized.push(writer.0);
4659 logger = test_utils::TestLogger::new();
4660 fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
4661 persister = test_utils::TestPersister::new();
4662 let keys_manager = &chanmon_cfgs[0].keys_manager;
4663 new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator, &persister, keys_manager);
4664 nodes[0].chain_monitor = &new_chain_monitor;
4667 let mut node_0_stale_monitors = Vec::new();
4668 for serialized in node_0_stale_monitors_serialized.iter() {
4669 let mut read = &serialized[..];
4670 let (_, monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(&mut read, keys_manager).unwrap();
4671 assert!(read.is_empty());
4672 node_0_stale_monitors.push(monitor);
4675 let mut node_0_monitors = Vec::new();
4676 for serialized in node_0_monitors_serialized.iter() {
4677 let mut read = &serialized[..];
4678 let (_, monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(&mut read, keys_manager).unwrap();
4679 assert!(read.is_empty());
4680 node_0_monitors.push(monitor);
4683 let mut nodes_0_read = &nodes_0_serialized[..];
4684 if let Err(msgs::DecodeError::InvalidValue) =
4685 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4686 default_config: UserConfig::default(),
4688 fee_estimator: &fee_estimator,
4689 chain_monitor: nodes[0].chain_monitor,
4690 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4692 channel_monitors: node_0_stale_monitors.iter_mut().map(|monitor| { (monitor.get_funding_txo().0, monitor) }).collect(),
4694 panic!("If the monitor(s) are stale, this indicates a bug and we should get an Err return");
4697 let mut nodes_0_read = &nodes_0_serialized[..];
4698 let (_, nodes_0_deserialized_tmp) =
4699 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4700 default_config: UserConfig::default(),
4702 fee_estimator: &fee_estimator,
4703 chain_monitor: nodes[0].chain_monitor,
4704 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4706 channel_monitors: node_0_monitors.iter_mut().map(|monitor| { (monitor.get_funding_txo().0, monitor) }).collect(),
4708 nodes_0_deserialized = nodes_0_deserialized_tmp;
4709 assert!(nodes_0_read.is_empty());
4711 { // Channel close should result in a commitment tx
4712 let txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4713 assert_eq!(txn.len(), 1);
4714 check_spends!(txn[0], funding_tx);
4715 assert_eq!(txn[0].input[0].previous_output.txid, funding_tx.txid());
4718 for monitor in node_0_monitors.drain(..) {
4719 assert!(nodes[0].chain_monitor.watch_channel(monitor.get_funding_txo().0, monitor).is_ok());
4720 check_added_monitors!(nodes[0], 1);
4722 nodes[0].node = &nodes_0_deserialized;
4723 check_closed_event!(nodes[0], 1, ClosureReason::OutdatedChannelManager);
4725 // nodes[1] and nodes[2] have no lost state with nodes[0]...
4726 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
4727 reconnect_nodes(&nodes[0], &nodes[2], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
4728 //... and we can even still claim the payment!
4729 claim_payment(&nodes[2], &[&nodes[0], &nodes[1]], our_payment_preimage);
4731 nodes[3].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4732 let reestablish = get_event_msg!(nodes[3], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
4733 nodes[0].node.peer_connected(&nodes[3].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4734 nodes[0].node.handle_channel_reestablish(&nodes[3].node.get_our_node_id(), &reestablish);
4735 let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
4736 assert_eq!(msg_events.len(), 1);
4737 if let MessageSendEvent::HandleError { ref action, .. } = msg_events[0] {
4739 &ErrorAction::SendErrorMessage { ref msg } => {
4740 assert_eq!(msg.channel_id, channel_id);
4742 _ => panic!("Unexpected event!"),
4747 macro_rules! check_spendable_outputs {
4748 ($node: expr, $keysinterface: expr) => {
4750 let mut events = $node.chain_monitor.chain_monitor.get_and_clear_pending_events();
4751 let mut txn = Vec::new();
4752 let mut all_outputs = Vec::new();
4753 let secp_ctx = Secp256k1::new();
4754 for event in events.drain(..) {
4756 Event::SpendableOutputs { mut outputs } => {
4757 for outp in outputs.drain(..) {
4758 txn.push($keysinterface.backing.spend_spendable_outputs(&[&outp], Vec::new(), Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(), 253, &secp_ctx).unwrap());
4759 all_outputs.push(outp);
4762 _ => panic!("Unexpected event"),
4765 if all_outputs.len() > 1 {
4766 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) {
4776 fn test_claim_sizeable_push_msat() {
4777 // Incidentally test SpendableOutput event generation due to detection of to_local output on commitment tx
4778 let chanmon_cfgs = create_chanmon_cfgs(2);
4779 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4780 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4781 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4783 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 99000000, InitFeatures::known(), InitFeatures::known());
4784 nodes[1].node.force_close_channel(&chan.2).unwrap();
4785 check_closed_broadcast!(nodes[1], true);
4786 check_added_monitors!(nodes[1], 1);
4787 check_closed_event!(nodes[1], 1, ClosureReason::HolderForceClosed);
4788 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4789 assert_eq!(node_txn.len(), 1);
4790 check_spends!(node_txn[0], chan.3);
4791 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
4793 mine_transaction(&nodes[1], &node_txn[0]);
4794 connect_blocks(&nodes[1], BREAKDOWN_TIMEOUT as u32 - 1);
4796 let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
4797 assert_eq!(spend_txn.len(), 1);
4798 assert_eq!(spend_txn[0].input.len(), 1);
4799 check_spends!(spend_txn[0], node_txn[0]);
4800 assert_eq!(spend_txn[0].input[0].sequence, BREAKDOWN_TIMEOUT as u32);
4804 fn test_claim_on_remote_sizeable_push_msat() {
4805 // Same test as previous, just test on remote commitment tx, as per_commitment_point registration changes following you're funder/fundee and
4806 // to_remote output is encumbered by a P2WPKH
4807 let chanmon_cfgs = create_chanmon_cfgs(2);
4808 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4809 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4810 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4812 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 99000000, InitFeatures::known(), InitFeatures::known());
4813 nodes[0].node.force_close_channel(&chan.2).unwrap();
4814 check_closed_broadcast!(nodes[0], true);
4815 check_added_monitors!(nodes[0], 1);
4816 check_closed_event!(nodes[0], 1, ClosureReason::HolderForceClosed);
4818 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4819 assert_eq!(node_txn.len(), 1);
4820 check_spends!(node_txn[0], chan.3);
4821 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
4823 mine_transaction(&nodes[1], &node_txn[0]);
4824 check_closed_broadcast!(nodes[1], true);
4825 check_added_monitors!(nodes[1], 1);
4826 check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
4827 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4829 let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
4830 assert_eq!(spend_txn.len(), 1);
4831 check_spends!(spend_txn[0], node_txn[0]);
4835 fn test_claim_on_remote_revoked_sizeable_push_msat() {
4836 // Same test as previous, just test on remote revoked commitment tx, as per_commitment_point registration changes following you're funder/fundee and
4837 // to_remote output is encumbered by a P2WPKH
4839 let chanmon_cfgs = create_chanmon_cfgs(2);
4840 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4841 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4842 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4844 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 59000000, InitFeatures::known(), InitFeatures::known());
4845 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4846 let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan.2);
4847 assert_eq!(revoked_local_txn[0].input.len(), 1);
4848 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
4850 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
4851 mine_transaction(&nodes[1], &revoked_local_txn[0]);
4852 check_closed_broadcast!(nodes[1], true);
4853 check_added_monitors!(nodes[1], 1);
4854 check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
4856 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4857 mine_transaction(&nodes[1], &node_txn[0]);
4858 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4860 let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
4861 assert_eq!(spend_txn.len(), 3);
4862 check_spends!(spend_txn[0], revoked_local_txn[0]); // to_remote output on revoked remote commitment_tx
4863 check_spends!(spend_txn[1], node_txn[0]);
4864 check_spends!(spend_txn[2], revoked_local_txn[0], node_txn[0]); // Both outputs
4868 fn test_static_spendable_outputs_preimage_tx() {
4869 let chanmon_cfgs = create_chanmon_cfgs(2);
4870 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4871 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4872 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4874 // Create some initial channels
4875 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4877 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4879 let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
4880 assert_eq!(commitment_tx[0].input.len(), 1);
4881 assert_eq!(commitment_tx[0].input[0].previous_output.txid, chan_1.3.txid());
4883 // Settle A's commitment tx on B's chain
4884 assert!(nodes[1].node.claim_funds(payment_preimage));
4885 check_added_monitors!(nodes[1], 1);
4886 mine_transaction(&nodes[1], &commitment_tx[0]);
4887 check_added_monitors!(nodes[1], 1);
4888 let events = nodes[1].node.get_and_clear_pending_msg_events();
4890 MessageSendEvent::UpdateHTLCs { .. } => {},
4891 _ => panic!("Unexpected event"),
4894 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
4895 _ => panic!("Unexepected event"),
4898 // Check B's monitor was able to send back output descriptor event for preimage tx on A's commitment tx
4899 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap(); // ChannelManager : 2 (local commitment tx + HTLC-Success), ChannelMonitor: preimage tx
4900 assert_eq!(node_txn.len(), 3);
4901 check_spends!(node_txn[0], commitment_tx[0]);
4902 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
4903 check_spends!(node_txn[1], chan_1.3);
4904 check_spends!(node_txn[2], node_txn[1]);
4906 mine_transaction(&nodes[1], &node_txn[0]);
4907 check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
4908 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4910 let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
4911 assert_eq!(spend_txn.len(), 1);
4912 check_spends!(spend_txn[0], node_txn[0]);
4916 fn test_static_spendable_outputs_timeout_tx() {
4917 let chanmon_cfgs = create_chanmon_cfgs(2);
4918 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4919 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4920 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4922 // Create some initial channels
4923 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4925 // Rebalance the network a bit by relaying one payment through all the channels ...
4926 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
4928 let (_, our_payment_hash, _) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3_000_000);
4930 let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
4931 assert_eq!(commitment_tx[0].input.len(), 1);
4932 assert_eq!(commitment_tx[0].input[0].previous_output.txid, chan_1.3.txid());
4934 // Settle A's commitment tx on B' chain
4935 mine_transaction(&nodes[1], &commitment_tx[0]);
4936 check_added_monitors!(nodes[1], 1);
4937 let events = nodes[1].node.get_and_clear_pending_msg_events();
4939 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
4940 _ => panic!("Unexpected event"),
4942 connect_blocks(&nodes[1], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
4944 // Check B's monitor was able to send back output descriptor event for timeout tx on A's commitment tx
4945 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
4946 assert_eq!(node_txn.len(), 2); // ChannelManager : 1 local commitent tx, ChannelMonitor: timeout tx
4947 check_spends!(node_txn[0], chan_1.3.clone());
4948 check_spends!(node_txn[1], commitment_tx[0].clone());
4949 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4951 mine_transaction(&nodes[1], &node_txn[1]);
4952 check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
4953 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4954 expect_payment_failed!(nodes[1], our_payment_hash, true);
4956 let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
4957 assert_eq!(spend_txn.len(), 3); // SpendableOutput: remote_commitment_tx.to_remote, timeout_tx.output
4958 check_spends!(spend_txn[0], commitment_tx[0]);
4959 check_spends!(spend_txn[1], node_txn[1]);
4960 check_spends!(spend_txn[2], node_txn[1], commitment_tx[0]); // All outputs
4964 fn test_static_spendable_outputs_justice_tx_revoked_commitment_tx() {
4965 let chanmon_cfgs = create_chanmon_cfgs(2);
4966 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4967 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4968 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4970 // Create some initial channels
4971 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4973 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4974 let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
4975 assert_eq!(revoked_local_txn[0].input.len(), 1);
4976 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
4978 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
4980 mine_transaction(&nodes[1], &revoked_local_txn[0]);
4981 check_closed_broadcast!(nodes[1], true);
4982 check_added_monitors!(nodes[1], 1);
4983 check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
4985 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4986 assert_eq!(node_txn.len(), 2);
4987 assert_eq!(node_txn[0].input.len(), 2);
4988 check_spends!(node_txn[0], revoked_local_txn[0]);
4990 mine_transaction(&nodes[1], &node_txn[0]);
4991 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4993 let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
4994 assert_eq!(spend_txn.len(), 1);
4995 check_spends!(spend_txn[0], node_txn[0]);
4999 fn test_static_spendable_outputs_justice_tx_revoked_htlc_timeout_tx() {
5000 let mut chanmon_cfgs = create_chanmon_cfgs(2);
5001 chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
5002 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5003 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5004 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5006 // Create some initial channels
5007 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5009 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
5010 let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
5011 assert_eq!(revoked_local_txn[0].input.len(), 1);
5012 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
5014 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
5016 // A will generate HTLC-Timeout from revoked commitment tx
5017 mine_transaction(&nodes[0], &revoked_local_txn[0]);
5018 check_closed_broadcast!(nodes[0], true);
5019 check_added_monitors!(nodes[0], 1);
5020 check_closed_event!(nodes[0], 1, ClosureReason::CommitmentTxConfirmed);
5021 connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
5023 let revoked_htlc_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5024 assert_eq!(revoked_htlc_txn.len(), 2);
5025 check_spends!(revoked_htlc_txn[0], chan_1.3);
5026 assert_eq!(revoked_htlc_txn[1].input.len(), 1);
5027 assert_eq!(revoked_htlc_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5028 check_spends!(revoked_htlc_txn[1], revoked_local_txn[0]);
5029 assert_ne!(revoked_htlc_txn[1].lock_time, 0); // HTLC-Timeout
5031 // B will generate justice tx from A's revoked commitment/HTLC tx
5032 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5033 connect_block(&nodes[1], &Block { header, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[1].clone()] });
5034 check_closed_broadcast!(nodes[1], true);
5035 check_added_monitors!(nodes[1], 1);
5036 check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
5038 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5039 assert_eq!(node_txn.len(), 3); // ChannelMonitor: bogus justice tx, justice tx on revoked outputs, ChannelManager: local commitment tx
5040 // The first transaction generated is bogus - it spends both outputs of revoked_local_txn[0]
5041 // including the one already spent by revoked_htlc_txn[1]. That's OK, we'll spend with valid
5042 // transactions next...
5043 assert_eq!(node_txn[0].input.len(), 3);
5044 check_spends!(node_txn[0], revoked_local_txn[0], revoked_htlc_txn[1]);
5046 assert_eq!(node_txn[1].input.len(), 2);
5047 check_spends!(node_txn[1], revoked_local_txn[0], revoked_htlc_txn[1]);
5048 if node_txn[1].input[1].previous_output.txid == revoked_htlc_txn[1].txid() {
5049 assert_ne!(node_txn[1].input[0].previous_output, revoked_htlc_txn[1].input[0].previous_output);
5051 assert_eq!(node_txn[1].input[0].previous_output.txid, revoked_htlc_txn[1].txid());
5052 assert_ne!(node_txn[1].input[1].previous_output, revoked_htlc_txn[1].input[0].previous_output);
5055 assert_eq!(node_txn[2].input.len(), 1);
5056 check_spends!(node_txn[2], chan_1.3);
5058 mine_transaction(&nodes[1], &node_txn[1]);
5059 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
5061 // Check B's ChannelMonitor was able to generate the right spendable output descriptor
5062 let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
5063 assert_eq!(spend_txn.len(), 1);
5064 assert_eq!(spend_txn[0].input.len(), 1);
5065 check_spends!(spend_txn[0], node_txn[1]);
5069 fn test_static_spendable_outputs_justice_tx_revoked_htlc_success_tx() {
5070 let mut chanmon_cfgs = create_chanmon_cfgs(2);
5071 chanmon_cfgs[1].keys_manager.disable_revocation_policy_check = true;
5072 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5073 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5074 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5076 // Create some initial channels
5077 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5079 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
5080 let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan_1.2);
5081 assert_eq!(revoked_local_txn[0].input.len(), 1);
5082 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
5084 // The to-be-revoked commitment tx should have one HTLC and one to_remote output
5085 assert_eq!(revoked_local_txn[0].output.len(), 2);
5087 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
5089 // B will generate HTLC-Success from revoked commitment tx
5090 mine_transaction(&nodes[1], &revoked_local_txn[0]);
5091 check_closed_broadcast!(nodes[1], true);
5092 check_added_monitors!(nodes[1], 1);
5093 check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
5094 let revoked_htlc_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5096 assert_eq!(revoked_htlc_txn.len(), 2);
5097 assert_eq!(revoked_htlc_txn[0].input.len(), 1);
5098 assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5099 check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
5101 // Check that the unspent (of two) outputs on revoked_local_txn[0] is a P2WPKH:
5102 let unspent_local_txn_output = revoked_htlc_txn[0].input[0].previous_output.vout as usize ^ 1;
5103 assert_eq!(revoked_local_txn[0].output[unspent_local_txn_output].script_pubkey.len(), 2 + 20); // P2WPKH
5105 // A will generate justice tx from B's revoked commitment/HTLC tx
5106 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5107 connect_block(&nodes[0], &Block { header, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[0].clone()] });
5108 check_closed_broadcast!(nodes[0], true);
5109 check_added_monitors!(nodes[0], 1);
5110 check_closed_event!(nodes[0], 1, ClosureReason::CommitmentTxConfirmed);
5112 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5113 assert_eq!(node_txn.len(), 3); // ChannelMonitor: justice tx on revoked commitment, justice tx on revoked HTLC-success, ChannelManager: local commitment tx
5115 // The first transaction generated is bogus - it spends both outputs of revoked_local_txn[0]
5116 // including the one already spent by revoked_htlc_txn[0]. That's OK, we'll spend with valid
5117 // transactions next...
5118 assert_eq!(node_txn[0].input.len(), 2);
5119 check_spends!(node_txn[0], revoked_local_txn[0], revoked_htlc_txn[0]);
5120 if node_txn[0].input[1].previous_output.txid == revoked_htlc_txn[0].txid() {
5121 assert_eq!(node_txn[0].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
5123 assert_eq!(node_txn[0].input[0].previous_output.txid, revoked_htlc_txn[0].txid());
5124 assert_eq!(node_txn[0].input[1].previous_output, revoked_htlc_txn[0].input[0].previous_output);
5127 assert_eq!(node_txn[1].input.len(), 1);
5128 check_spends!(node_txn[1], revoked_htlc_txn[0]);
5130 check_spends!(node_txn[2], chan_1.3);
5132 mine_transaction(&nodes[0], &node_txn[1]);
5133 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
5135 // Note that nodes[0]'s tx_broadcaster is still locked, so if we get here the channelmonitor
5136 // didn't try to generate any new transactions.
5138 // Check A's ChannelMonitor was able to generate the right spendable output descriptor
5139 let spend_txn = check_spendable_outputs!(nodes[0], node_cfgs[0].keys_manager);
5140 assert_eq!(spend_txn.len(), 3);
5141 assert_eq!(spend_txn[0].input.len(), 1);
5142 check_spends!(spend_txn[0], revoked_local_txn[0]); // spending to_remote output from revoked local tx
5143 assert_ne!(spend_txn[0].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
5144 check_spends!(spend_txn[1], node_txn[1]); // spending justice tx output on the htlc success tx
5145 check_spends!(spend_txn[2], revoked_local_txn[0], node_txn[1]); // Both outputs
5149 fn test_onchain_to_onchain_claim() {
5150 // Test that in case of channel closure, we detect the state of output and claim HTLC
5151 // on downstream peer's remote commitment tx.
5152 // First, have C claim an HTLC against its own latest commitment transaction.
5153 // Then, broadcast these to B, which should update the monitor downstream on the A<->B
5155 // Finally, check that B will claim the HTLC output if A's latest commitment transaction
5158 let chanmon_cfgs = create_chanmon_cfgs(3);
5159 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5160 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5161 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5163 // Create some initial channels
5164 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5165 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
5167 // Ensure all nodes are at the same height
5168 let node_max_height = nodes.iter().map(|node| node.blocks.lock().unwrap().len()).max().unwrap() as u32;
5169 connect_blocks(&nodes[0], node_max_height - nodes[0].best_block_info().1);
5170 connect_blocks(&nodes[1], node_max_height - nodes[1].best_block_info().1);
5171 connect_blocks(&nodes[2], node_max_height - nodes[2].best_block_info().1);
5173 // Rebalance the network a bit by relaying one payment through all the channels ...
5174 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
5175 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
5177 let (payment_preimage, _payment_hash, _payment_secret) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
5178 let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
5179 check_spends!(commitment_tx[0], chan_2.3);
5180 nodes[2].node.claim_funds(payment_preimage);
5181 check_added_monitors!(nodes[2], 1);
5182 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
5183 assert!(updates.update_add_htlcs.is_empty());
5184 assert!(updates.update_fail_htlcs.is_empty());
5185 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
5186 assert!(updates.update_fail_malformed_htlcs.is_empty());
5188 mine_transaction(&nodes[2], &commitment_tx[0]);
5189 check_closed_broadcast!(nodes[2], true);
5190 check_added_monitors!(nodes[2], 1);
5191 check_closed_event!(nodes[2], 1, ClosureReason::CommitmentTxConfirmed);
5193 let c_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 2 (commitment tx, HTLC-Success tx), ChannelMonitor : 1 (HTLC-Success tx)
5194 assert_eq!(c_txn.len(), 3);
5195 assert_eq!(c_txn[0], c_txn[2]);
5196 assert_eq!(commitment_tx[0], c_txn[1]);
5197 check_spends!(c_txn[1], chan_2.3);
5198 check_spends!(c_txn[2], c_txn[1]);
5199 assert_eq!(c_txn[1].input[0].witness.clone().last().unwrap().len(), 71);
5200 assert_eq!(c_txn[2].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5201 assert!(c_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
5202 assert_eq!(c_txn[0].lock_time, 0); // Success tx
5204 // 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
5205 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
5206 connect_block(&nodes[1], &Block { header, txdata: vec![c_txn[1].clone(), c_txn[2].clone()]});
5207 check_added_monitors!(nodes[1], 1);
5208 let events = nodes[1].node.get_and_clear_pending_events();
5209 assert_eq!(events.len(), 2);
5211 Event::ChannelClosed { reason: ClosureReason::CommitmentTxConfirmed, .. } => {}
5212 _ => panic!("Unexpected event"),
5215 Event::PaymentForwarded { fee_earned_msat, claim_from_onchain_tx } => {
5216 assert_eq!(fee_earned_msat, Some(1000));
5217 assert_eq!(claim_from_onchain_tx, true);
5219 _ => panic!("Unexpected event"),
5222 let mut b_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5223 // ChannelMonitor: claim tx
5224 assert_eq!(b_txn.len(), 1);
5225 check_spends!(b_txn[0], chan_2.3); // B local commitment tx, issued by ChannelManager
5228 check_added_monitors!(nodes[1], 1);
5229 let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
5230 assert_eq!(msg_events.len(), 3);
5231 match msg_events[0] {
5232 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5233 _ => panic!("Unexpected event"),
5235 match msg_events[1] {
5236 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { .. }, node_id: _ } => {},
5237 _ => panic!("Unexpected event"),
5239 match msg_events[2] {
5240 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, .. } } => {
5241 assert!(update_add_htlcs.is_empty());
5242 assert!(update_fail_htlcs.is_empty());
5243 assert_eq!(update_fulfill_htlcs.len(), 1);
5244 assert!(update_fail_malformed_htlcs.is_empty());
5245 assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
5247 _ => panic!("Unexpected event"),
5249 // Broadcast A's commitment tx on B's chain to see if we are able to claim inbound HTLC with our HTLC-Success tx
5250 let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
5251 mine_transaction(&nodes[1], &commitment_tx[0]);
5252 check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
5253 let b_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5254 // ChannelMonitor: HTLC-Success tx, ChannelManager: local commitment tx + HTLC-Success tx
5255 assert_eq!(b_txn.len(), 3);
5256 check_spends!(b_txn[1], chan_1.3);
5257 check_spends!(b_txn[2], b_txn[1]);
5258 check_spends!(b_txn[0], commitment_tx[0]);
5259 assert_eq!(b_txn[0].input[0].witness.clone().last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5260 assert!(b_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
5261 assert_eq!(b_txn[0].lock_time, 0); // Success tx
5263 check_closed_broadcast!(nodes[1], true);
5264 check_added_monitors!(nodes[1], 1);
5268 fn test_duplicate_payment_hash_one_failure_one_success() {
5269 // Topology : A --> B --> C --> D
5270 // We route 2 payments with same hash between B and C, one will be timeout, the other successfully claim
5271 // Note that because C will refuse to generate two payment secrets for the same payment hash,
5272 // we forward one of the payments onwards to D.
5273 let chanmon_cfgs = create_chanmon_cfgs(4);
5274 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
5275 // When this test was written, the default base fee floated based on the HTLC count.
5276 // It is now fixed, so we simply set the fee to the expected value here.
5277 let mut config = test_default_channel_config();
5278 config.channel_options.forwarding_fee_base_msat = 196;
5279 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs,
5280 &[Some(config.clone()), Some(config.clone()), Some(config.clone()), Some(config.clone())]);
5281 let mut nodes = create_network(4, &node_cfgs, &node_chanmgrs);
5283 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5284 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
5285 create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
5287 let node_max_height = nodes.iter().map(|node| node.blocks.lock().unwrap().len()).max().unwrap() as u32;
5288 connect_blocks(&nodes[0], node_max_height - nodes[0].best_block_info().1);
5289 connect_blocks(&nodes[1], node_max_height - nodes[1].best_block_info().1);
5290 connect_blocks(&nodes[2], node_max_height - nodes[2].best_block_info().1);
5291 connect_blocks(&nodes[3], node_max_height - nodes[3].best_block_info().1);
5293 let (our_payment_preimage, duplicate_payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 900000);
5295 let payment_secret = nodes[3].node.create_inbound_payment_for_hash(duplicate_payment_hash, None, 7200, 0).unwrap();
5296 // We reduce the final CLTV here by a somewhat arbitrary constant to keep it under the one-byte
5297 // script push size limit so that the below script length checks match
5298 // ACCEPTED_HTLC_SCRIPT_WEIGHT.
5299 let route = get_route(&nodes[0].node.get_our_node_id(), &nodes[0].net_graph_msg_handler.network_graph,
5300 &nodes[3].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 900000, TEST_FINAL_CLTV - 40, nodes[0].logger).unwrap();
5301 send_along_route_with_secret(&nodes[0], route, &[&[&nodes[1], &nodes[2], &nodes[3]]], 900000, duplicate_payment_hash, payment_secret);
5303 let commitment_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
5304 assert_eq!(commitment_txn[0].input.len(), 1);
5305 check_spends!(commitment_txn[0], chan_2.3);
5307 mine_transaction(&nodes[1], &commitment_txn[0]);
5308 check_closed_broadcast!(nodes[1], true);
5309 check_added_monitors!(nodes[1], 1);
5310 check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
5311 connect_blocks(&nodes[1], TEST_FINAL_CLTV - 40 + MIN_CLTV_EXPIRY_DELTA as u32 - 1); // Confirm blocks until the HTLC expires
5313 let htlc_timeout_tx;
5314 { // Extract one of the two HTLC-Timeout transaction
5315 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5316 // ChannelMonitor: timeout tx * 3, ChannelManager: local commitment tx
5317 assert_eq!(node_txn.len(), 4);
5318 check_spends!(node_txn[0], chan_2.3);
5320 check_spends!(node_txn[1], commitment_txn[0]);
5321 assert_eq!(node_txn[1].input.len(), 1);
5322 check_spends!(node_txn[2], commitment_txn[0]);
5323 assert_eq!(node_txn[2].input.len(), 1);
5324 assert_eq!(node_txn[1].input[0].previous_output, node_txn[2].input[0].previous_output);
5325 check_spends!(node_txn[3], commitment_txn[0]);
5326 assert_ne!(node_txn[1].input[0].previous_output, node_txn[3].input[0].previous_output);
5328 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5329 assert_eq!(node_txn[2].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5330 assert_eq!(node_txn[3].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5331 htlc_timeout_tx = node_txn[1].clone();
5334 nodes[2].node.claim_funds(our_payment_preimage);
5335 mine_transaction(&nodes[2], &commitment_txn[0]);
5336 check_added_monitors!(nodes[2], 2);
5337 check_closed_event!(nodes[2], 1, ClosureReason::CommitmentTxConfirmed);
5338 let events = nodes[2].node.get_and_clear_pending_msg_events();
5340 MessageSendEvent::UpdateHTLCs { .. } => {},
5341 _ => panic!("Unexpected event"),
5344 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5345 _ => panic!("Unexepected event"),
5347 let htlc_success_txn: Vec<_> = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
5348 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)
5349 check_spends!(htlc_success_txn[0], commitment_txn[0]);
5350 check_spends!(htlc_success_txn[1], commitment_txn[0]);
5351 assert_eq!(htlc_success_txn[0].input.len(), 1);
5352 assert_eq!(htlc_success_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5353 assert_eq!(htlc_success_txn[1].input.len(), 1);
5354 assert_eq!(htlc_success_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5355 assert_ne!(htlc_success_txn[0].input[0].previous_output, htlc_success_txn[1].input[0].previous_output);
5356 assert_eq!(htlc_success_txn[2], commitment_txn[0]);
5357 assert_eq!(htlc_success_txn[3], htlc_success_txn[0]);
5358 assert_eq!(htlc_success_txn[4], htlc_success_txn[1]);
5359 assert_ne!(htlc_success_txn[0].input[0].previous_output, htlc_timeout_tx.input[0].previous_output);
5361 mine_transaction(&nodes[1], &htlc_timeout_tx);
5362 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
5363 expect_pending_htlcs_forwardable!(nodes[1]);
5364 let htlc_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5365 assert!(htlc_updates.update_add_htlcs.is_empty());
5366 assert_eq!(htlc_updates.update_fail_htlcs.len(), 1);
5367 let first_htlc_id = htlc_updates.update_fail_htlcs[0].htlc_id;
5368 assert!(htlc_updates.update_fulfill_htlcs.is_empty());
5369 assert!(htlc_updates.update_fail_malformed_htlcs.is_empty());
5370 check_added_monitors!(nodes[1], 1);
5372 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_updates.update_fail_htlcs[0]);
5373 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
5375 commitment_signed_dance!(nodes[0], nodes[1], &htlc_updates.commitment_signed, false, true);
5377 expect_payment_failed_with_update!(nodes[0], duplicate_payment_hash, false, chan_2.0.contents.short_channel_id, true);
5379 // Solve 2nd HTLC by broadcasting on B's chain HTLC-Success Tx from C
5380 // Note that the fee paid is effectively double as the HTLC value (including the nodes[1] fee
5381 // and nodes[2] fee) is rounded down and then claimed in full.
5382 mine_transaction(&nodes[1], &htlc_success_txn[0]);
5383 expect_payment_forwarded!(nodes[1], Some(196*2), true);
5384 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5385 assert!(updates.update_add_htlcs.is_empty());
5386 assert!(updates.update_fail_htlcs.is_empty());
5387 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
5388 assert_ne!(updates.update_fulfill_htlcs[0].htlc_id, first_htlc_id);
5389 assert!(updates.update_fail_malformed_htlcs.is_empty());
5390 check_added_monitors!(nodes[1], 1);
5392 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
5393 commitment_signed_dance!(nodes[0], nodes[1], &updates.commitment_signed, false);
5395 let events = nodes[0].node.get_and_clear_pending_events();
5397 Event::PaymentSent { ref payment_preimage } => {
5398 assert_eq!(*payment_preimage, our_payment_preimage);
5400 _ => panic!("Unexpected event"),
5405 fn test_dynamic_spendable_outputs_local_htlc_success_tx() {
5406 let chanmon_cfgs = create_chanmon_cfgs(2);
5407 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5408 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5409 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5411 // Create some initial channels
5412 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5414 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000).0;
5415 let local_txn = get_local_commitment_txn!(nodes[1], chan_1.2);
5416 assert_eq!(local_txn.len(), 1);
5417 assert_eq!(local_txn[0].input.len(), 1);
5418 check_spends!(local_txn[0], chan_1.3);
5420 // Give B knowledge of preimage to be able to generate a local HTLC-Success Tx
5421 nodes[1].node.claim_funds(payment_preimage);
5422 check_added_monitors!(nodes[1], 1);
5423 mine_transaction(&nodes[1], &local_txn[0]);
5424 check_added_monitors!(nodes[1], 1);
5425 check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
5426 let events = nodes[1].node.get_and_clear_pending_msg_events();
5428 MessageSendEvent::UpdateHTLCs { .. } => {},
5429 _ => panic!("Unexpected event"),
5432 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5433 _ => panic!("Unexepected event"),
5436 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5437 assert_eq!(node_txn.len(), 3);
5438 assert_eq!(node_txn[0], node_txn[2]);
5439 assert_eq!(node_txn[1], local_txn[0]);
5440 assert_eq!(node_txn[0].input.len(), 1);
5441 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5442 check_spends!(node_txn[0], local_txn[0]);
5446 mine_transaction(&nodes[1], &node_tx);
5447 connect_blocks(&nodes[1], BREAKDOWN_TIMEOUT as u32 - 1);
5449 // Verify that B is able to spend its own HTLC-Success tx thanks to spendable output event given back by its ChannelMonitor
5450 let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
5451 assert_eq!(spend_txn.len(), 1);
5452 assert_eq!(spend_txn[0].input.len(), 1);
5453 check_spends!(spend_txn[0], node_tx);
5454 assert_eq!(spend_txn[0].input[0].sequence, BREAKDOWN_TIMEOUT as u32);
5457 fn do_test_fail_backwards_unrevoked_remote_announce(deliver_last_raa: bool, announce_latest: bool) {
5458 // Test that we fail backwards the full set of HTLCs we need to when remote broadcasts an
5459 // unrevoked commitment transaction.
5460 // This includes HTLCs which were below the dust threshold as well as HTLCs which were awaiting
5461 // a remote RAA before they could be failed backwards (and combinations thereof).
5462 // We also test duplicate-hash HTLCs by adding two nodes on each side of the target nodes which
5463 // use the same payment hashes.
5464 // Thus, we use a six-node network:
5469 // And test where C fails back to A/B when D announces its latest commitment transaction
5470 let chanmon_cfgs = create_chanmon_cfgs(6);
5471 let node_cfgs = create_node_cfgs(6, &chanmon_cfgs);
5472 // When this test was written, the default base fee floated based on the HTLC count.
5473 // It is now fixed, so we simply set the fee to the expected value here.
5474 let mut config = test_default_channel_config();
5475 config.channel_options.forwarding_fee_base_msat = 196;
5476 let node_chanmgrs = create_node_chanmgrs(6, &node_cfgs,
5477 &[Some(config.clone()), Some(config.clone()), Some(config.clone()), Some(config.clone()), Some(config.clone()), Some(config.clone())]);
5478 let nodes = create_network(6, &node_cfgs, &node_chanmgrs);
5479 let logger = test_utils::TestLogger::new();
5481 create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known());
5482 create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
5483 let chan = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
5484 create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::known(), InitFeatures::known());
5485 create_announced_chan_between_nodes(&nodes, 3, 5, InitFeatures::known(), InitFeatures::known());
5487 // Rebalance and check output sanity...
5488 send_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 500000);
5489 send_payment(&nodes[1], &[&nodes[2], &nodes[3], &nodes[5]], 500000);
5490 assert_eq!(get_local_commitment_txn!(nodes[3], chan.2)[0].output.len(), 2);
5492 let ds_dust_limit = nodes[3].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().holder_dust_limit_satoshis;
5494 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
5496 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
5497 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
5498 let our_node_id = &nodes[1].node.get_our_node_id();
5499 let route = get_route(our_node_id, &net_graph_msg_handler.network_graph, &nodes[5].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), ds_dust_limit*1000, TEST_FINAL_CLTV, &logger).unwrap();
5501 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
5503 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
5505 let (_, payment_hash_3, _) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
5507 let (_, payment_hash_4, _) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
5508 let route = get_route(our_node_id, &net_graph_msg_handler.network_graph, &nodes[5].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
5510 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());
5512 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());
5515 let (_, payment_hash_5, _) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
5517 let route = get_route(our_node_id, &net_graph_msg_handler.network_graph, &nodes[5].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), ds_dust_limit*1000, TEST_FINAL_CLTV, &logger).unwrap();
5518 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
5521 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
5523 let route = get_route(our_node_id, &net_graph_msg_handler.network_graph, &nodes[5].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
5524 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());
5526 // Double-check that six of the new HTLC were added
5527 // We now have six HTLCs pending over the dust limit and six HTLCs under the dust limit (ie,
5528 // with to_local and to_remote outputs, 8 outputs and 6 HTLCs not included).
5529 assert_eq!(get_local_commitment_txn!(nodes[3], chan.2).len(), 1);
5530 assert_eq!(get_local_commitment_txn!(nodes[3], chan.2)[0].output.len(), 8);
5532 // Now fail back three of the over-dust-limit and three of the under-dust-limit payments in one go.
5533 // Fail 0th below-dust, 4th above-dust, 8th above-dust, 10th below-dust HTLCs
5534 assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_1));
5535 assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_3));
5536 assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_5));
5537 assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_6));
5538 check_added_monitors!(nodes[4], 0);
5539 expect_pending_htlcs_forwardable!(nodes[4]);
5540 check_added_monitors!(nodes[4], 1);
5542 let four_removes = get_htlc_update_msgs!(nodes[4], nodes[3].node.get_our_node_id());
5543 nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[0]);
5544 nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[1]);
5545 nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[2]);
5546 nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[3]);
5547 commitment_signed_dance!(nodes[3], nodes[4], four_removes.commitment_signed, false);
5549 // Fail 3rd below-dust and 7th above-dust HTLCs
5550 assert!(nodes[5].node.fail_htlc_backwards(&payment_hash_2));
5551 assert!(nodes[5].node.fail_htlc_backwards(&payment_hash_4));
5552 check_added_monitors!(nodes[5], 0);
5553 expect_pending_htlcs_forwardable!(nodes[5]);
5554 check_added_monitors!(nodes[5], 1);
5556 let two_removes = get_htlc_update_msgs!(nodes[5], nodes[3].node.get_our_node_id());
5557 nodes[3].node.handle_update_fail_htlc(&nodes[5].node.get_our_node_id(), &two_removes.update_fail_htlcs[0]);
5558 nodes[3].node.handle_update_fail_htlc(&nodes[5].node.get_our_node_id(), &two_removes.update_fail_htlcs[1]);
5559 commitment_signed_dance!(nodes[3], nodes[5], two_removes.commitment_signed, false);
5561 let ds_prev_commitment_tx = get_local_commitment_txn!(nodes[3], chan.2);
5563 expect_pending_htlcs_forwardable!(nodes[3]);
5564 check_added_monitors!(nodes[3], 1);
5565 let six_removes = get_htlc_update_msgs!(nodes[3], nodes[2].node.get_our_node_id());
5566 nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[0]);
5567 nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[1]);
5568 nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[2]);
5569 nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[3]);
5570 nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[4]);
5571 nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[5]);
5572 if deliver_last_raa {
5573 commitment_signed_dance!(nodes[2], nodes[3], six_removes.commitment_signed, false);
5575 let _cs_last_raa = commitment_signed_dance!(nodes[2], nodes[3], six_removes.commitment_signed, false, true, false, true);
5578 // D's latest commitment transaction now contains 1st + 2nd + 9th HTLCs (implicitly, they're
5579 // below the dust limit) and the 5th + 6th + 11th HTLCs. It has failed back the 0th, 3rd, 4th,
5580 // 7th, 8th, and 10th, but as we haven't yet delivered the final RAA to C, the fails haven't
5581 // propagated back to A/B yet (and D has two unrevoked commitment transactions).
5583 // We now broadcast the latest commitment transaction, which *should* result in failures for
5584 // the 0th, 1st, 2nd, 3rd, 4th, 7th, 8th, 9th, and 10th HTLCs, ie all the below-dust HTLCs and
5585 // the non-broadcast above-dust HTLCs.
5587 // Alternatively, we may broadcast the previous commitment transaction, which should only
5588 // result in failures for the below-dust HTLCs, ie the 0th, 1st, 2nd, 3rd, 9th, and 10th HTLCs.
5589 let ds_last_commitment_tx = get_local_commitment_txn!(nodes[3], chan.2);
5591 if announce_latest {
5592 mine_transaction(&nodes[2], &ds_last_commitment_tx[0]);
5594 mine_transaction(&nodes[2], &ds_prev_commitment_tx[0]);
5596 let events = nodes[2].node.get_and_clear_pending_events();
5597 let close_event = if deliver_last_raa {
5598 assert_eq!(events.len(), 2);
5601 assert_eq!(events.len(), 1);
5605 Event::ChannelClosed { reason: ClosureReason::CommitmentTxConfirmed, .. } => {}
5606 _ => panic!("Unexpected event"),
5609 connect_blocks(&nodes[2], ANTI_REORG_DELAY - 1);
5610 check_closed_broadcast!(nodes[2], true);
5611 if deliver_last_raa {
5612 expect_pending_htlcs_forwardable_from_events!(nodes[2], events[0..1], true);
5614 expect_pending_htlcs_forwardable!(nodes[2]);
5616 check_added_monitors!(nodes[2], 3);
5618 let cs_msgs = nodes[2].node.get_and_clear_pending_msg_events();
5619 assert_eq!(cs_msgs.len(), 2);
5620 let mut a_done = false;
5621 for msg in cs_msgs {
5623 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
5624 // Both under-dust HTLCs and the one above-dust HTLC that we had already failed
5625 // should be failed-backwards here.
5626 let target = if *node_id == nodes[0].node.get_our_node_id() {
5627 // If announce_latest, expect 0th, 1st, 4th, 8th, 10th HTLCs, else only 0th, 1st, 10th below-dust HTLCs
5628 for htlc in &updates.update_fail_htlcs {
5629 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 });
5631 assert_eq!(updates.update_fail_htlcs.len(), if announce_latest { 5 } else { 3 });
5636 // If announce_latest, expect 2nd, 3rd, 7th, 9th HTLCs, else only 2nd, 3rd, 9th below-dust HTLCs
5637 for htlc in &updates.update_fail_htlcs {
5638 assert!(htlc.htlc_id == 1 || htlc.htlc_id == 2 || htlc.htlc_id == 5 || if announce_latest { htlc.htlc_id == 4 } else { false });
5640 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
5641 assert_eq!(updates.update_fail_htlcs.len(), if announce_latest { 4 } else { 3 });
5644 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
5645 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[1]);
5646 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[2]);
5647 if announce_latest {
5648 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[3]);
5649 if *node_id == nodes[0].node.get_our_node_id() {
5650 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[4]);
5653 commitment_signed_dance!(target, nodes[2], updates.commitment_signed, false, true);
5655 _ => panic!("Unexpected event"),
5659 let as_events = nodes[0].node.get_and_clear_pending_events();
5660 assert_eq!(as_events.len(), if announce_latest { 5 } else { 3 });
5661 let mut as_failds = HashSet::new();
5662 let mut as_updates = 0;
5663 for event in as_events.iter() {
5664 if let &Event::PaymentPathFailed { ref payment_hash, ref rejected_by_dest, ref network_update, .. } = event {
5665 assert!(as_failds.insert(*payment_hash));
5666 if *payment_hash != payment_hash_2 {
5667 assert_eq!(*rejected_by_dest, deliver_last_raa);
5669 assert!(!rejected_by_dest);
5671 if network_update.is_some() {
5674 } else { panic!("Unexpected event"); }
5676 assert!(as_failds.contains(&payment_hash_1));
5677 assert!(as_failds.contains(&payment_hash_2));
5678 if announce_latest {
5679 assert!(as_failds.contains(&payment_hash_3));
5680 assert!(as_failds.contains(&payment_hash_5));
5682 assert!(as_failds.contains(&payment_hash_6));
5684 let bs_events = nodes[1].node.get_and_clear_pending_events();
5685 assert_eq!(bs_events.len(), if announce_latest { 4 } else { 3 });
5686 let mut bs_failds = HashSet::new();
5687 let mut bs_updates = 0;
5688 for event in bs_events.iter() {
5689 if let &Event::PaymentPathFailed { ref payment_hash, ref rejected_by_dest, ref network_update, .. } = event {
5690 assert!(bs_failds.insert(*payment_hash));
5691 if *payment_hash != payment_hash_1 && *payment_hash != payment_hash_5 {
5692 assert_eq!(*rejected_by_dest, deliver_last_raa);
5694 assert!(!rejected_by_dest);
5696 if network_update.is_some() {
5699 } else { panic!("Unexpected event"); }
5701 assert!(bs_failds.contains(&payment_hash_1));
5702 assert!(bs_failds.contains(&payment_hash_2));
5703 if announce_latest {
5704 assert!(bs_failds.contains(&payment_hash_4));
5706 assert!(bs_failds.contains(&payment_hash_5));
5708 // For each HTLC which was not failed-back by normal process (ie deliver_last_raa), we should
5709 // get a NetworkUpdate. A should have gotten 4 HTLCs which were failed-back due to
5710 // unknown-preimage-etc, B should have gotten 2. Thus, in the
5711 // announce_latest && deliver_last_raa case, we should have 5-4=1 and 4-2=2 NetworkUpdates.
5712 assert_eq!(as_updates, if deliver_last_raa { 1 } else if !announce_latest { 3 } else { 5 });
5713 assert_eq!(bs_updates, if deliver_last_raa { 2 } else if !announce_latest { 3 } else { 4 });
5717 fn test_fail_backwards_latest_remote_announce_a() {
5718 do_test_fail_backwards_unrevoked_remote_announce(false, true);
5722 fn test_fail_backwards_latest_remote_announce_b() {
5723 do_test_fail_backwards_unrevoked_remote_announce(true, true);
5727 fn test_fail_backwards_previous_remote_announce() {
5728 do_test_fail_backwards_unrevoked_remote_announce(false, false);
5729 // Note that true, true doesn't make sense as it implies we announce a revoked state, which is
5730 // tested for in test_commitment_revoked_fail_backward_exhaustive()
5734 fn test_dynamic_spendable_outputs_local_htlc_timeout_tx() {
5735 let chanmon_cfgs = create_chanmon_cfgs(2);
5736 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5737 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5738 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5740 // Create some initial channels
5741 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5743 let (_, our_payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000);
5744 let local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
5745 assert_eq!(local_txn[0].input.len(), 1);
5746 check_spends!(local_txn[0], chan_1.3);
5748 // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
5749 mine_transaction(&nodes[0], &local_txn[0]);
5750 check_closed_broadcast!(nodes[0], true);
5751 check_added_monitors!(nodes[0], 1);
5752 check_closed_event!(nodes[0], 1, ClosureReason::CommitmentTxConfirmed);
5753 connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
5755 let htlc_timeout = {
5756 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5757 assert_eq!(node_txn.len(), 2);
5758 check_spends!(node_txn[0], chan_1.3);
5759 assert_eq!(node_txn[1].input.len(), 1);
5760 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5761 check_spends!(node_txn[1], local_txn[0]);
5765 mine_transaction(&nodes[0], &htlc_timeout);
5766 connect_blocks(&nodes[0], BREAKDOWN_TIMEOUT as u32 - 1);
5767 expect_payment_failed!(nodes[0], our_payment_hash, true);
5769 // Verify that A is able to spend its own HTLC-Timeout tx thanks to spendable output event given back by its ChannelMonitor
5770 let spend_txn = check_spendable_outputs!(nodes[0], node_cfgs[0].keys_manager);
5771 assert_eq!(spend_txn.len(), 3);
5772 check_spends!(spend_txn[0], local_txn[0]);
5773 assert_eq!(spend_txn[1].input.len(), 1);
5774 check_spends!(spend_txn[1], htlc_timeout);
5775 assert_eq!(spend_txn[1].input[0].sequence, BREAKDOWN_TIMEOUT as u32);
5776 assert_eq!(spend_txn[2].input.len(), 2);
5777 check_spends!(spend_txn[2], local_txn[0], htlc_timeout);
5778 assert!(spend_txn[2].input[0].sequence == BREAKDOWN_TIMEOUT as u32 ||
5779 spend_txn[2].input[1].sequence == BREAKDOWN_TIMEOUT as u32);
5783 fn test_key_derivation_params() {
5784 // This test is a copy of test_dynamic_spendable_outputs_local_htlc_timeout_tx, with
5785 // a key manager rotation to test that key_derivation_params returned in DynamicOutputP2WSH
5786 // let us re-derive the channel key set to then derive a delayed_payment_key.
5788 let chanmon_cfgs = create_chanmon_cfgs(3);
5790 // We manually create the node configuration to backup the seed.
5791 let seed = [42; 32];
5792 let keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
5793 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);
5794 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() };
5795 let mut node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5796 node_cfgs.remove(0);
5797 node_cfgs.insert(0, node);
5799 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5800 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5802 // Create some initial channels
5803 // Create a dummy channel to advance index by one and thus test re-derivation correctness
5805 let chan_0 = create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known());
5806 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5807 assert_ne!(chan_0.3.output[0].script_pubkey, chan_1.3.output[0].script_pubkey);
5809 // Ensure all nodes are at the same height
5810 let node_max_height = nodes.iter().map(|node| node.blocks.lock().unwrap().len()).max().unwrap() as u32;
5811 connect_blocks(&nodes[0], node_max_height - nodes[0].best_block_info().1);
5812 connect_blocks(&nodes[1], node_max_height - nodes[1].best_block_info().1);
5813 connect_blocks(&nodes[2], node_max_height - nodes[2].best_block_info().1);
5815 let (_, our_payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000);
5816 let local_txn_0 = get_local_commitment_txn!(nodes[0], chan_0.2);
5817 let local_txn_1 = get_local_commitment_txn!(nodes[0], chan_1.2);
5818 assert_eq!(local_txn_1[0].input.len(), 1);
5819 check_spends!(local_txn_1[0], chan_1.3);
5821 // We check funding pubkey are unique
5822 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]));
5823 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]));
5824 if from_0_funding_key_0 == from_1_funding_key_0
5825 || from_0_funding_key_0 == from_1_funding_key_1
5826 || from_0_funding_key_1 == from_1_funding_key_0
5827 || from_0_funding_key_1 == from_1_funding_key_1 {
5828 panic!("Funding pubkeys aren't unique");
5831 // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
5832 mine_transaction(&nodes[0], &local_txn_1[0]);
5833 connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
5834 check_closed_broadcast!(nodes[0], true);
5835 check_added_monitors!(nodes[0], 1);
5836 check_closed_event!(nodes[0], 1, ClosureReason::CommitmentTxConfirmed);
5838 let htlc_timeout = {
5839 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5840 assert_eq!(node_txn[1].input.len(), 1);
5841 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5842 check_spends!(node_txn[1], local_txn_1[0]);
5846 mine_transaction(&nodes[0], &htlc_timeout);
5847 connect_blocks(&nodes[0], BREAKDOWN_TIMEOUT as u32 - 1);
5848 expect_payment_failed!(nodes[0], our_payment_hash, true);
5850 // Verify that A is able to spend its own HTLC-Timeout tx thanks to spendable output event given back by its ChannelMonitor
5851 let new_keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
5852 let spend_txn = check_spendable_outputs!(nodes[0], new_keys_manager);
5853 assert_eq!(spend_txn.len(), 3);
5854 check_spends!(spend_txn[0], local_txn_1[0]);
5855 assert_eq!(spend_txn[1].input.len(), 1);
5856 check_spends!(spend_txn[1], htlc_timeout);
5857 assert_eq!(spend_txn[1].input[0].sequence, BREAKDOWN_TIMEOUT as u32);
5858 assert_eq!(spend_txn[2].input.len(), 2);
5859 check_spends!(spend_txn[2], local_txn_1[0], htlc_timeout);
5860 assert!(spend_txn[2].input[0].sequence == BREAKDOWN_TIMEOUT as u32 ||
5861 spend_txn[2].input[1].sequence == BREAKDOWN_TIMEOUT as u32);
5865 fn test_static_output_closing_tx() {
5866 let chanmon_cfgs = create_chanmon_cfgs(2);
5867 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5868 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5869 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5871 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5873 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
5874 let closing_tx = close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true).2;
5876 mine_transaction(&nodes[0], &closing_tx);
5877 check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure);
5878 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
5880 let spend_txn = check_spendable_outputs!(nodes[0], node_cfgs[0].keys_manager);
5881 assert_eq!(spend_txn.len(), 1);
5882 check_spends!(spend_txn[0], closing_tx);
5884 mine_transaction(&nodes[1], &closing_tx);
5885 check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure);
5886 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
5888 let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
5889 assert_eq!(spend_txn.len(), 1);
5890 check_spends!(spend_txn[0], closing_tx);
5893 fn do_htlc_claim_local_commitment_only(use_dust: bool) {
5894 let chanmon_cfgs = create_chanmon_cfgs(2);
5895 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5896 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5897 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5898 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5900 let (our_payment_preimage, _, _) = route_payment(&nodes[0], &[&nodes[1]], if use_dust { 50000 } else { 3000000 });
5902 // Claim the payment, but don't deliver A's commitment_signed, resulting in the HTLC only being
5903 // present in B's local commitment transaction, but none of A's commitment transactions.
5904 assert!(nodes[1].node.claim_funds(our_payment_preimage));
5905 check_added_monitors!(nodes[1], 1);
5907 let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5908 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fulfill_htlcs[0]);
5909 let events = nodes[0].node.get_and_clear_pending_events();
5910 assert_eq!(events.len(), 1);
5912 Event::PaymentSent { payment_preimage } => {
5913 assert_eq!(payment_preimage, our_payment_preimage);
5915 _ => panic!("Unexpected event"),
5918 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_updates.commitment_signed);
5919 check_added_monitors!(nodes[0], 1);
5920 let as_updates = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5921 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_updates.0);
5922 check_added_monitors!(nodes[1], 1);
5924 let starting_block = nodes[1].best_block_info();
5925 let mut block = Block {
5926 header: BlockHeader { version: 0x20000000, prev_blockhash: starting_block.0, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
5929 for _ in starting_block.1 + 1..TEST_FINAL_CLTV - CLTV_CLAIM_BUFFER + starting_block.1 + 2 {
5930 connect_block(&nodes[1], &block);
5931 block.header.prev_blockhash = block.block_hash();
5933 test_txn_broadcast(&nodes[1], &chan, None, if use_dust { HTLCType::NONE } else { HTLCType::SUCCESS });
5934 check_closed_broadcast!(nodes[1], true);
5935 check_added_monitors!(nodes[1], 1);
5936 check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
5939 fn do_htlc_claim_current_remote_commitment_only(use_dust: bool) {
5940 let chanmon_cfgs = create_chanmon_cfgs(2);
5941 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5942 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5943 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5944 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5945 let logger = test_utils::TestLogger::new();
5947 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1]);
5948 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
5949 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), if use_dust { 50000 } else { 3000000 }, TEST_FINAL_CLTV, &logger).unwrap();
5950 nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
5951 check_added_monitors!(nodes[0], 1);
5953 let _as_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5955 // As far as A is concerned, the HTLC is now present only in the latest remote commitment
5956 // transaction, however it is not in A's latest local commitment, so we can just broadcast that
5957 // to "time out" the HTLC.
5959 let starting_block = nodes[1].best_block_info();
5960 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: starting_block.0, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5962 for _ in starting_block.1 + 1..TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + starting_block.1 + 2 {
5963 connect_block(&nodes[0], &Block { header, txdata: Vec::new()});
5964 header.prev_blockhash = header.block_hash();
5966 test_txn_broadcast(&nodes[0], &chan, None, HTLCType::NONE);
5967 check_closed_broadcast!(nodes[0], true);
5968 check_added_monitors!(nodes[0], 1);
5969 check_closed_event!(nodes[0], 1, ClosureReason::CommitmentTxConfirmed);
5972 fn do_htlc_claim_previous_remote_commitment_only(use_dust: bool, check_revoke_no_close: bool) {
5973 let chanmon_cfgs = create_chanmon_cfgs(3);
5974 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5975 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5976 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5977 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5979 // Fail the payment, but don't deliver A's final RAA, resulting in the HTLC only being present
5980 // in B's previous (unrevoked) commitment transaction, but none of A's commitment transactions.
5981 // Also optionally test that we *don't* fail the channel in case the commitment transaction was
5982 // actually revoked.
5983 let htlc_value = if use_dust { 50000 } else { 3000000 };
5984 let (_, our_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1]], htlc_value);
5985 assert!(nodes[1].node.fail_htlc_backwards(&our_payment_hash));
5986 expect_pending_htlcs_forwardable!(nodes[1]);
5987 check_added_monitors!(nodes[1], 1);
5989 let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5990 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fail_htlcs[0]);
5991 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_updates.commitment_signed);
5992 check_added_monitors!(nodes[0], 1);
5993 let as_updates = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5994 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_updates.0);
5995 check_added_monitors!(nodes[1], 1);
5996 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_updates.1);
5997 check_added_monitors!(nodes[1], 1);
5998 let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
6000 if check_revoke_no_close {
6001 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
6002 check_added_monitors!(nodes[0], 1);
6005 let starting_block = nodes[1].best_block_info();
6006 let mut block = Block {
6007 header: BlockHeader { version: 0x20000000, prev_blockhash: starting_block.0, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
6010 for _ in starting_block.1 + 1..TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + CHAN_CONFIRM_DEPTH + 2 {
6011 connect_block(&nodes[0], &block);
6012 block.header.prev_blockhash = block.block_hash();
6014 if !check_revoke_no_close {
6015 test_txn_broadcast(&nodes[0], &chan, None, HTLCType::NONE);
6016 check_closed_broadcast!(nodes[0], true);
6017 check_added_monitors!(nodes[0], 1);
6018 check_closed_event!(nodes[0], 1, ClosureReason::CommitmentTxConfirmed);
6020 expect_payment_failed!(nodes[0], our_payment_hash, true);
6024 // Test that we close channels on-chain when broadcastable HTLCs reach their timeout window.
6025 // There are only a few cases to test here:
6026 // * its not really normative behavior, but we test that below-dust HTLCs "included" in
6027 // broadcastable commitment transactions result in channel closure,
6028 // * its included in an unrevoked-but-previous remote commitment transaction,
6029 // * its included in the latest remote or local commitment transactions.
6030 // We test each of the three possible commitment transactions individually and use both dust and
6032 // Note that we don't bother testing both outbound and inbound HTLC failures for each case, and we
6033 // assume they are handled the same across all six cases, as both outbound and inbound failures are
6034 // tested for at least one of the cases in other tests.
6036 fn htlc_claim_single_commitment_only_a() {
6037 do_htlc_claim_local_commitment_only(true);
6038 do_htlc_claim_local_commitment_only(false);
6040 do_htlc_claim_current_remote_commitment_only(true);
6041 do_htlc_claim_current_remote_commitment_only(false);
6045 fn htlc_claim_single_commitment_only_b() {
6046 do_htlc_claim_previous_remote_commitment_only(true, false);
6047 do_htlc_claim_previous_remote_commitment_only(false, false);
6048 do_htlc_claim_previous_remote_commitment_only(true, true);
6049 do_htlc_claim_previous_remote_commitment_only(false, true);
6054 fn bolt2_open_channel_sending_node_checks_part1() { //This test needs to be on its own as we are catching a panic
6055 let chanmon_cfgs = create_chanmon_cfgs(2);
6056 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6057 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6058 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6059 //Force duplicate channel ids
6060 for node in nodes.iter() {
6061 *node.keys_manager.override_channel_id_priv.lock().unwrap() = Some([0; 32]);
6064 // BOLT #2 spec: Sending node must ensure temporary_channel_id is unique from any other channel ID with the same peer.
6065 let channel_value_satoshis=10000;
6066 let push_msat=10001;
6067 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).unwrap();
6068 let node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
6069 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &node0_to_1_send_open_channel);
6071 //Create a second channel with a channel_id collision
6072 assert!(nodes[0].node.create_channel(nodes[0].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
6076 fn bolt2_open_channel_sending_node_checks_part2() {
6077 let chanmon_cfgs = create_chanmon_cfgs(2);
6078 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6079 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6080 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6082 // BOLT #2 spec: Sending node must set funding_satoshis to less than 2^24 satoshis
6083 let channel_value_satoshis=2^24;
6084 let push_msat=10001;
6085 assert!(nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
6087 // BOLT #2 spec: Sending node must set push_msat to equal or less than 1000 * funding_satoshis
6088 let channel_value_satoshis=10000;
6089 // Test when push_msat is equal to 1000 * funding_satoshis.
6090 let push_msat=1000*channel_value_satoshis+1;
6091 assert!(nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
6093 // BOLT #2 spec: Sending node must set set channel_reserve_satoshis greater than or equal to dust_limit_satoshis
6094 let channel_value_satoshis=10000;
6095 let push_msat=10001;
6096 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
6097 let node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
6098 assert!(node0_to_1_send_open_channel.channel_reserve_satoshis>=node0_to_1_send_open_channel.dust_limit_satoshis);
6100 // BOLT #2 spec: Sending node must set undefined bits in channel_flags to 0
6101 // 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
6102 assert!(node0_to_1_send_open_channel.channel_flags<=1);
6104 // 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.
6105 assert!(BREAKDOWN_TIMEOUT>0);
6106 assert!(node0_to_1_send_open_channel.to_self_delay==BREAKDOWN_TIMEOUT);
6108 // BOLT #2 spec: Sending node must ensure the chain_hash value identifies the chain it wishes to open the channel within.
6109 let chain_hash=genesis_block(Network::Testnet).header.block_hash();
6110 assert_eq!(node0_to_1_send_open_channel.chain_hash,chain_hash);
6112 // 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.
6113 assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.funding_pubkey.serialize()).is_ok());
6114 assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.revocation_basepoint.serialize()).is_ok());
6115 assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.htlc_basepoint.serialize()).is_ok());
6116 assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.payment_point.serialize()).is_ok());
6117 assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.delayed_payment_basepoint.serialize()).is_ok());
6121 fn bolt2_open_channel_sane_dust_limit() {
6122 let chanmon_cfgs = create_chanmon_cfgs(2);
6123 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6124 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6125 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6127 let channel_value_satoshis=1000000;
6128 let push_msat=10001;
6129 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).unwrap();
6130 let mut node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
6131 node0_to_1_send_open_channel.dust_limit_satoshis = 661;
6132 node0_to_1_send_open_channel.channel_reserve_satoshis = 100001;
6134 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &node0_to_1_send_open_channel);
6135 let events = nodes[1].node.get_and_clear_pending_msg_events();
6136 let err_msg = match events[0] {
6137 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id: _ } => {
6140 _ => panic!("Unexpected event"),
6142 assert_eq!(err_msg.data, "dust_limit_satoshis (661) is greater than the implementation limit (660)");
6145 // Test that if we fail to send an HTLC that is being freed from the holding cell, and the HTLC
6146 // originated from our node, its failure is surfaced to the user. We trigger this failure to
6147 // free the HTLC by increasing our fee while the HTLC is in the holding cell such that the HTLC
6148 // is no longer affordable once it's freed.
6150 fn test_fail_holding_cell_htlc_upon_free() {
6151 let chanmon_cfgs = create_chanmon_cfgs(2);
6152 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6153 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6154 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6155 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6156 let logger = test_utils::TestLogger::new();
6158 // First nodes[0] generates an update_fee, setting the channel's
6159 // pending_update_fee.
6161 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
6162 *feerate_lock += 20;
6164 nodes[0].node.timer_tick_occurred();
6165 check_added_monitors!(nodes[0], 1);
6167 let events = nodes[0].node.get_and_clear_pending_msg_events();
6168 assert_eq!(events.len(), 1);
6169 let (update_msg, commitment_signed) = match events[0] {
6170 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
6171 (update_fee.as_ref(), commitment_signed)
6173 _ => panic!("Unexpected event"),
6176 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
6178 let mut chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6179 let channel_reserve = chan_stat.channel_reserve_msat;
6180 let feerate = get_feerate!(nodes[0], chan.2);
6182 // 2* and +1 HTLCs on the commit tx fee calculation for the fee spike reserve.
6183 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6184 let max_can_send = 5000000 - channel_reserve - 2*commit_tx_fee_msat(feerate, 1 + 1);
6185 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6186 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], max_can_send, TEST_FINAL_CLTV, &logger).unwrap();
6188 // Send a payment which passes reserve checks but gets stuck in the holding cell.
6189 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6190 chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6191 assert_eq!(chan_stat.holding_cell_outbound_amount_msat, max_can_send);
6193 // Flush the pending fee update.
6194 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
6195 let (as_revoke_and_ack, _) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6196 check_added_monitors!(nodes[1], 1);
6197 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_revoke_and_ack);
6198 check_added_monitors!(nodes[0], 1);
6200 // Upon receipt of the RAA, there will be an attempt to resend the holding cell
6201 // HTLC, but now that the fee has been raised the payment will now fail, causing
6202 // us to surface its failure to the user.
6203 chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6204 assert_eq!(chan_stat.holding_cell_outbound_amount_msat, 0);
6205 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);
6206 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 {}",
6207 hex::encode(our_payment_hash.0), chan_stat.channel_reserve_msat, hex::encode(chan.2));
6208 nodes[0].logger.assert_log("lightning::ln::channel".to_string(), failure_log.to_string(), 1);
6210 // Check that the payment failed to be sent out.
6211 let events = nodes[0].node.get_and_clear_pending_events();
6212 assert_eq!(events.len(), 1);
6214 &Event::PaymentPathFailed { ref payment_hash, ref rejected_by_dest, ref network_update, ref error_code, ref error_data, ref all_paths_failed, path: _ } => {
6215 assert_eq!(our_payment_hash.clone(), *payment_hash);
6216 assert_eq!(*rejected_by_dest, false);
6217 assert_eq!(*all_paths_failed, true);
6218 assert_eq!(*network_update, None);
6219 assert_eq!(*error_code, None);
6220 assert_eq!(*error_data, None);
6222 _ => panic!("Unexpected event"),
6226 // Test that if multiple HTLCs are released from the holding cell and one is
6227 // valid but the other is no longer valid upon release, the valid HTLC can be
6228 // successfully completed while the other one fails as expected.
6230 fn test_free_and_fail_holding_cell_htlcs() {
6231 let chanmon_cfgs = create_chanmon_cfgs(2);
6232 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6233 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6234 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6235 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6236 let logger = test_utils::TestLogger::new();
6238 // First nodes[0] generates an update_fee, setting the channel's
6239 // pending_update_fee.
6241 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
6242 *feerate_lock += 200;
6244 nodes[0].node.timer_tick_occurred();
6245 check_added_monitors!(nodes[0], 1);
6247 let events = nodes[0].node.get_and_clear_pending_msg_events();
6248 assert_eq!(events.len(), 1);
6249 let (update_msg, commitment_signed) = match events[0] {
6250 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
6251 (update_fee.as_ref(), commitment_signed)
6253 _ => panic!("Unexpected event"),
6256 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
6258 let mut chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6259 let channel_reserve = chan_stat.channel_reserve_msat;
6260 let feerate = get_feerate!(nodes[0], chan.2);
6262 // 2* and +1 HTLCs on the commit tx fee calculation for the fee spike reserve.
6263 let (payment_preimage_1, payment_hash_1, payment_secret_1) = get_payment_preimage_hash!(nodes[1]);
6265 let (_, payment_hash_2, payment_secret_2) = get_payment_preimage_hash!(nodes[1]);
6266 let amt_2 = 5000000 - channel_reserve - 2*commit_tx_fee_msat(feerate, 2 + 1) - amt_1;
6267 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6268 let route_1 = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], amt_1, TEST_FINAL_CLTV, &logger).unwrap();
6269 let route_2 = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], amt_2, TEST_FINAL_CLTV, &logger).unwrap();
6271 // Send 2 payments which pass reserve checks but get stuck in the holding cell.
6272 nodes[0].node.send_payment(&route_1, payment_hash_1, &Some(payment_secret_1)).unwrap();
6273 chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6274 assert_eq!(chan_stat.holding_cell_outbound_amount_msat, amt_1);
6275 nodes[0].node.send_payment(&route_2, payment_hash_2, &Some(payment_secret_2)).unwrap();
6276 chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6277 assert_eq!(chan_stat.holding_cell_outbound_amount_msat, amt_1 + amt_2);
6279 // Flush the pending fee update.
6280 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
6281 let (revoke_and_ack, commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6282 check_added_monitors!(nodes[1], 1);
6283 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_and_ack);
6284 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
6285 check_added_monitors!(nodes[0], 2);
6287 // Upon receipt of the RAA, there will be an attempt to resend the holding cell HTLCs,
6288 // but now that the fee has been raised the second payment will now fail, causing us
6289 // to surface its failure to the user. The first payment should succeed.
6290 chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6291 assert_eq!(chan_stat.holding_cell_outbound_amount_msat, 0);
6292 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);
6293 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 {}",
6294 hex::encode(payment_hash_2.0), chan_stat.channel_reserve_msat, hex::encode(chan.2));
6295 nodes[0].logger.assert_log("lightning::ln::channel".to_string(), failure_log.to_string(), 1);
6297 // Check that the second payment failed to be sent out.
6298 let events = nodes[0].node.get_and_clear_pending_events();
6299 assert_eq!(events.len(), 1);
6301 &Event::PaymentPathFailed { ref payment_hash, ref rejected_by_dest, ref network_update, ref error_code, ref error_data, ref all_paths_failed, path: _ } => {
6302 assert_eq!(payment_hash_2.clone(), *payment_hash);
6303 assert_eq!(*rejected_by_dest, false);
6304 assert_eq!(*all_paths_failed, true);
6305 assert_eq!(*network_update, None);
6306 assert_eq!(*error_code, None);
6307 assert_eq!(*error_data, None);
6309 _ => panic!("Unexpected event"),
6312 // Complete the first payment and the RAA from the fee update.
6313 let (payment_event, send_raa_event) = {
6314 let mut msgs = nodes[0].node.get_and_clear_pending_msg_events();
6315 assert_eq!(msgs.len(), 2);
6316 (SendEvent::from_event(msgs.remove(0)), msgs.remove(0))
6318 let raa = match send_raa_event {
6319 MessageSendEvent::SendRevokeAndACK { msg, .. } => msg,
6320 _ => panic!("Unexpected event"),
6322 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &raa);
6323 check_added_monitors!(nodes[1], 1);
6324 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6325 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6326 let events = nodes[1].node.get_and_clear_pending_events();
6327 assert_eq!(events.len(), 1);
6329 Event::PendingHTLCsForwardable { .. } => {},
6330 _ => panic!("Unexpected event"),
6332 nodes[1].node.process_pending_htlc_forwards();
6333 let events = nodes[1].node.get_and_clear_pending_events();
6334 assert_eq!(events.len(), 1);
6336 Event::PaymentReceived { .. } => {},
6337 _ => panic!("Unexpected event"),
6339 nodes[1].node.claim_funds(payment_preimage_1);
6340 check_added_monitors!(nodes[1], 1);
6341 let update_msgs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6342 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_msgs.update_fulfill_htlcs[0]);
6343 commitment_signed_dance!(nodes[0], nodes[1], update_msgs.commitment_signed, false, true);
6344 let events = nodes[0].node.get_and_clear_pending_events();
6345 assert_eq!(events.len(), 1);
6347 Event::PaymentSent { ref payment_preimage } => {
6348 assert_eq!(*payment_preimage, payment_preimage_1);
6350 _ => panic!("Unexpected event"),
6354 // Test that if we fail to forward an HTLC that is being freed from the holding cell that the
6355 // HTLC is failed backwards. We trigger this failure to forward the freed HTLC by increasing
6356 // our fee while the HTLC is in the holding cell such that the HTLC is no longer affordable
6359 fn test_fail_holding_cell_htlc_upon_free_multihop() {
6360 let chanmon_cfgs = create_chanmon_cfgs(3);
6361 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
6362 // When this test was written, the default base fee floated based on the HTLC count.
6363 // It is now fixed, so we simply set the fee to the expected value here.
6364 let mut config = test_default_channel_config();
6365 config.channel_options.forwarding_fee_base_msat = 196;
6366 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[Some(config.clone()), Some(config.clone()), Some(config.clone())]);
6367 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
6368 let chan_0_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6369 let chan_1_2 = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6370 let logger = test_utils::TestLogger::new();
6372 // First nodes[1] generates an update_fee, setting the channel's
6373 // pending_update_fee.
6375 let mut feerate_lock = chanmon_cfgs[1].fee_estimator.sat_per_kw.lock().unwrap();
6376 *feerate_lock += 20;
6378 nodes[1].node.timer_tick_occurred();
6379 check_added_monitors!(nodes[1], 1);
6381 let events = nodes[1].node.get_and_clear_pending_msg_events();
6382 assert_eq!(events.len(), 1);
6383 let (update_msg, commitment_signed) = match events[0] {
6384 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
6385 (update_fee.as_ref(), commitment_signed)
6387 _ => panic!("Unexpected event"),
6390 nodes[2].node.handle_update_fee(&nodes[1].node.get_our_node_id(), update_msg.unwrap());
6392 let mut chan_stat = get_channel_value_stat!(nodes[0], chan_0_1.2);
6393 let channel_reserve = chan_stat.channel_reserve_msat;
6394 let feerate = get_feerate!(nodes[0], chan_0_1.2);
6396 // Send a payment which passes reserve checks but gets stuck in the holding cell.
6398 let total_routing_fee_msat = (nodes.len() - 2) as u64 * feemsat;
6399 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[2]);
6400 let max_can_send = 5000000 - channel_reserve - 2*commit_tx_fee_msat(feerate, 1 + 1) - total_routing_fee_msat;
6401 let payment_event = {
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, &nodes[2].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], max_can_send, TEST_FINAL_CLTV, &logger).unwrap();
6404 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6405 check_added_monitors!(nodes[0], 1);
6407 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
6408 assert_eq!(events.len(), 1);
6410 SendEvent::from_event(events.remove(0))
6412 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6413 check_added_monitors!(nodes[1], 0);
6414 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6415 expect_pending_htlcs_forwardable!(nodes[1]);
6417 chan_stat = get_channel_value_stat!(nodes[1], chan_1_2.2);
6418 assert_eq!(chan_stat.holding_cell_outbound_amount_msat, max_can_send);
6420 // Flush the pending fee update.
6421 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), commitment_signed);
6422 let (raa, commitment_signed) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
6423 check_added_monitors!(nodes[2], 1);
6424 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &raa);
6425 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &commitment_signed);
6426 check_added_monitors!(nodes[1], 2);
6428 // A final RAA message is generated to finalize the fee update.
6429 let events = nodes[1].node.get_and_clear_pending_msg_events();
6430 assert_eq!(events.len(), 1);
6432 let raa_msg = match &events[0] {
6433 &MessageSendEvent::SendRevokeAndACK { ref msg, .. } => {
6436 _ => panic!("Unexpected event"),
6439 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &raa_msg);
6440 check_added_monitors!(nodes[2], 1);
6441 assert!(nodes[2].node.get_and_clear_pending_msg_events().is_empty());
6443 // nodes[1]'s ChannelManager will now signal that we have HTLC forwards to process.
6444 let process_htlc_forwards_event = nodes[1].node.get_and_clear_pending_events();
6445 assert_eq!(process_htlc_forwards_event.len(), 1);
6446 match &process_htlc_forwards_event[0] {
6447 &Event::PendingHTLCsForwardable { .. } => {},
6448 _ => panic!("Unexpected event"),
6451 // In response, we call ChannelManager's process_pending_htlc_forwards
6452 nodes[1].node.process_pending_htlc_forwards();
6453 check_added_monitors!(nodes[1], 1);
6455 // This causes the HTLC to be failed backwards.
6456 let fail_event = nodes[1].node.get_and_clear_pending_msg_events();
6457 assert_eq!(fail_event.len(), 1);
6458 let (fail_msg, commitment_signed) = match &fail_event[0] {
6459 &MessageSendEvent::UpdateHTLCs { ref updates, .. } => {
6460 assert_eq!(updates.update_add_htlcs.len(), 0);
6461 assert_eq!(updates.update_fulfill_htlcs.len(), 0);
6462 assert_eq!(updates.update_fail_malformed_htlcs.len(), 0);
6463 assert_eq!(updates.update_fail_htlcs.len(), 1);
6464 (updates.update_fail_htlcs[0].clone(), updates.commitment_signed.clone())
6466 _ => panic!("Unexpected event"),
6469 // Pass the failure messages back to nodes[0].
6470 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
6471 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
6473 // Complete the HTLC failure+removal process.
6474 let (raa, commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6475 check_added_monitors!(nodes[0], 1);
6476 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &raa);
6477 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commitment_signed);
6478 check_added_monitors!(nodes[1], 2);
6479 let final_raa_event = nodes[1].node.get_and_clear_pending_msg_events();
6480 assert_eq!(final_raa_event.len(), 1);
6481 let raa = match &final_raa_event[0] {
6482 &MessageSendEvent::SendRevokeAndACK { ref msg, .. } => msg.clone(),
6483 _ => panic!("Unexpected event"),
6485 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &raa);
6486 expect_payment_failed_with_update!(nodes[0], our_payment_hash, false, chan_1_2.0.contents.short_channel_id, false);
6487 check_added_monitors!(nodes[0], 1);
6490 // BOLT 2 Requirements for the Sender when constructing and sending an update_add_htlc message.
6491 // 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.
6492 //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.
6495 fn test_update_add_htlc_bolt2_sender_value_below_minimum_msat() {
6496 //BOLT2 Requirement: MUST NOT offer amount_msat below the receiving node's htlc_minimum_msat (same validation check catches both of these)
6497 let chanmon_cfgs = create_chanmon_cfgs(2);
6498 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6499 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6500 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6501 let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6503 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6504 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6505 let logger = test_utils::TestLogger::new();
6506 let mut route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
6507 route.paths[0][0].fee_msat = 100;
6509 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
6510 assert!(regex::Regex::new(r"Cannot send less than their minimum HTLC value \(\d+\)").unwrap().is_match(err)));
6511 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6512 nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot send less than their minimum HTLC value".to_string(), 1);
6516 fn test_update_add_htlc_bolt2_sender_zero_value_msat() {
6517 //BOLT2 Requirement: MUST offer amount_msat greater than 0.
6518 let chanmon_cfgs = create_chanmon_cfgs(2);
6519 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6520 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6521 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6522 let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6523 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6525 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6526 let logger = test_utils::TestLogger::new();
6527 let mut route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
6528 route.paths[0][0].fee_msat = 0;
6529 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
6530 assert_eq!(err, "Cannot send 0-msat HTLC"));
6532 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6533 nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot send 0-msat HTLC".to_string(), 1);
6537 fn test_update_add_htlc_bolt2_receiver_zero_value_msat() {
6538 //BOLT2 Requirement: MUST offer amount_msat greater than 0.
6539 let chanmon_cfgs = create_chanmon_cfgs(2);
6540 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6541 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6542 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6543 let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6545 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6546 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6547 let logger = test_utils::TestLogger::new();
6548 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
6549 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6550 check_added_monitors!(nodes[0], 1);
6551 let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6552 updates.update_add_htlcs[0].amount_msat = 0;
6554 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6555 nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Remote side tried to send a 0-msat HTLC".to_string(), 1);
6556 check_closed_broadcast!(nodes[1], true).unwrap();
6557 check_added_monitors!(nodes[1], 1);
6558 check_closed_event!(nodes[1], 1, ClosureReason::ProcessingError { err: "Remote side tried to send a 0-msat HTLC".to_string() });
6562 fn test_update_add_htlc_bolt2_sender_cltv_expiry_too_high() {
6563 //BOLT 2 Requirement: MUST set cltv_expiry less than 500000000.
6564 //It is enforced when constructing a route.
6565 let chanmon_cfgs = create_chanmon_cfgs(2);
6566 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6567 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6568 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6569 let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 0, InitFeatures::known(), InitFeatures::known());
6570 let logger = test_utils::TestLogger::new();
6572 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6574 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6575 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100000000, 500000001, &logger).unwrap();
6576 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::RouteError { ref err },
6577 assert_eq!(err, &"Channel CLTV overflowed?"));
6581 fn test_update_add_htlc_bolt2_sender_exceed_max_htlc_num_and_htlc_id_increment() {
6582 //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.
6583 //BOLT 2 Requirement: for the first HTLC it offers MUST set id to 0.
6584 //BOLT 2 Requirement: MUST increase the value of id by 1 for each successive offer.
6585 let chanmon_cfgs = create_chanmon_cfgs(2);
6586 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6587 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6588 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6589 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 0, InitFeatures::known(), InitFeatures::known());
6590 let max_accepted_htlcs = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().counterparty_max_accepted_htlcs as u64;
6592 let logger = test_utils::TestLogger::new();
6593 for i in 0..max_accepted_htlcs {
6594 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6595 let payment_event = {
6596 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6597 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
6598 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6599 check_added_monitors!(nodes[0], 1);
6601 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
6602 assert_eq!(events.len(), 1);
6603 if let MessageSendEvent::UpdateHTLCs { node_id: _, updates: msgs::CommitmentUpdate{ update_add_htlcs: ref htlcs, .. }, } = events[0] {
6604 assert_eq!(htlcs[0].htlc_id, i);
6608 SendEvent::from_event(events.remove(0))
6610 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6611 check_added_monitors!(nodes[1], 0);
6612 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6614 expect_pending_htlcs_forwardable!(nodes[1]);
6615 expect_payment_received!(nodes[1], our_payment_hash, our_payment_secret, 100000);
6617 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6618 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6619 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
6620 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
6621 assert!(regex::Regex::new(r"Cannot push more than their max accepted HTLCs \(\d+\)").unwrap().is_match(err)));
6623 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6624 nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot push more than their max accepted HTLCs".to_string(), 1);
6628 fn test_update_add_htlc_bolt2_sender_exceed_max_htlc_value_in_flight() {
6629 //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.
6630 let chanmon_cfgs = create_chanmon_cfgs(2);
6631 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6632 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6633 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6634 let channel_value = 100000;
6635 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, channel_value, 0, InitFeatures::known(), InitFeatures::known());
6636 let max_in_flight = get_channel_value_stat!(nodes[0], chan.2).counterparty_max_htlc_value_in_flight_msat;
6638 send_payment(&nodes[0], &vec!(&nodes[1])[..], max_in_flight);
6640 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6641 // Manually create a route over our max in flight (which our router normally automatically
6643 let route = Route { paths: vec![vec![RouteHop {
6644 pubkey: nodes[1].node.get_our_node_id(), node_features: NodeFeatures::known(), channel_features: ChannelFeatures::known(),
6645 short_channel_id: nodes[1].node.list_usable_channels()[0].short_channel_id.unwrap(),
6646 fee_msat: max_in_flight + 1, cltv_expiry_delta: TEST_FINAL_CLTV
6648 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
6649 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)));
6651 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6652 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);
6654 send_payment(&nodes[0], &[&nodes[1]], max_in_flight);
6657 // BOLT 2 Requirements for the Receiver when handling an update_add_htlc message.
6659 fn test_update_add_htlc_bolt2_receiver_check_amount_received_more_than_min() {
6660 //BOLT2 Requirement: receiving an amount_msat equal to 0, OR less than its own htlc_minimum_msat -> SHOULD fail the channel.
6661 let chanmon_cfgs = create_chanmon_cfgs(2);
6662 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6663 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6664 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6665 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6666 let htlc_minimum_msat: u64;
6668 let chan_lock = nodes[0].node.channel_state.lock().unwrap();
6669 let channel = chan_lock.by_id.get(&chan.2).unwrap();
6670 htlc_minimum_msat = channel.get_holder_htlc_minimum_msat();
6673 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6674 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6675 let logger = test_utils::TestLogger::new();
6676 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], htlc_minimum_msat, TEST_FINAL_CLTV, &logger).unwrap();
6677 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6678 check_added_monitors!(nodes[0], 1);
6679 let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6680 updates.update_add_htlcs[0].amount_msat = htlc_minimum_msat-1;
6681 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6682 assert!(nodes[1].node.list_channels().is_empty());
6683 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6684 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()));
6685 check_added_monitors!(nodes[1], 1);
6686 check_closed_event!(nodes[1], 1, ClosureReason::ProcessingError { err: err_msg.data });
6690 fn test_update_add_htlc_bolt2_receiver_sender_can_afford_amount_sent() {
6691 //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
6692 let chanmon_cfgs = create_chanmon_cfgs(2);
6693 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6694 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6695 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6696 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6697 let logger = test_utils::TestLogger::new();
6699 let chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6700 let channel_reserve = chan_stat.channel_reserve_msat;
6701 let feerate = get_feerate!(nodes[0], chan.2);
6702 // The 2* and +1 are for the fee spike reserve.
6703 let commit_tx_fee_outbound = 2 * commit_tx_fee_msat(feerate, 1 + 1);
6705 let max_can_send = 5000000 - channel_reserve - commit_tx_fee_outbound;
6706 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6707 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6708 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], max_can_send, TEST_FINAL_CLTV, &logger).unwrap();
6709 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6710 check_added_monitors!(nodes[0], 1);
6711 let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6713 // Even though channel-initiator senders are required to respect the fee_spike_reserve,
6714 // at this time channel-initiatee receivers are not required to enforce that senders
6715 // respect the fee_spike_reserve.
6716 updates.update_add_htlcs[0].amount_msat = max_can_send + commit_tx_fee_outbound + 1;
6717 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6719 assert!(nodes[1].node.list_channels().is_empty());
6720 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6721 assert_eq!(err_msg.data, "Remote HTLC add would put them under remote reserve value");
6722 check_added_monitors!(nodes[1], 1);
6723 check_closed_event!(nodes[1], 1, ClosureReason::ProcessingError { err: err_msg.data });
6727 fn test_update_add_htlc_bolt2_receiver_check_max_htlc_limit() {
6728 //BOLT 2 Requirement: if a sending node adds more than its max_accepted_htlcs HTLCs to its local commitment transaction: SHOULD fail the channel
6729 //BOLT 2 Requirement: MUST allow multiple HTLCs with the same payment_hash.
6730 let chanmon_cfgs = create_chanmon_cfgs(2);
6731 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6732 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6733 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6734 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6735 let logger = test_utils::TestLogger::new();
6737 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6738 let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
6740 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6741 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 3999999, TEST_FINAL_CLTV, &logger).unwrap();
6743 let cur_height = nodes[0].node.best_block.read().unwrap().height() + 1;
6744 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::signing_only(), &route.paths[0], &session_priv).unwrap();
6745 let (onion_payloads, _htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 3999999, &Some(our_payment_secret), cur_height, &None).unwrap();
6746 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &our_payment_hash);
6748 let mut msg = msgs::UpdateAddHTLC {
6752 payment_hash: our_payment_hash,
6753 cltv_expiry: htlc_cltv,
6754 onion_routing_packet: onion_packet.clone(),
6757 for i in 0..super::channel::OUR_MAX_HTLCS {
6758 msg.htlc_id = i as u64;
6759 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
6761 msg.htlc_id = (super::channel::OUR_MAX_HTLCS) as u64;
6762 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
6764 assert!(nodes[1].node.list_channels().is_empty());
6765 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6766 assert!(regex::Regex::new(r"Remote tried to push more than our max accepted HTLCs \(\d+\)").unwrap().is_match(err_msg.data.as_str()));
6767 check_added_monitors!(nodes[1], 1);
6768 check_closed_event!(nodes[1], 1, ClosureReason::ProcessingError { err: err_msg.data });
6772 fn test_update_add_htlc_bolt2_receiver_check_max_in_flight_msat() {
6773 //OR adds more than its max_htlc_value_in_flight_msat worth of offered HTLCs to its local commitment transaction: SHOULD fail the channel
6774 let chanmon_cfgs = create_chanmon_cfgs(2);
6775 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6776 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6777 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6778 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
6779 let logger = test_utils::TestLogger::new();
6781 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6782 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6783 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 1000000, TEST_FINAL_CLTV, &logger).unwrap();
6784 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6785 check_added_monitors!(nodes[0], 1);
6786 let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6787 updates.update_add_htlcs[0].amount_msat = get_channel_value_stat!(nodes[1], chan.2).counterparty_max_htlc_value_in_flight_msat + 1;
6788 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6790 assert!(nodes[1].node.list_channels().is_empty());
6791 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6792 assert!(regex::Regex::new("Remote HTLC add would put them over our max HTLC value").unwrap().is_match(err_msg.data.as_str()));
6793 check_added_monitors!(nodes[1], 1);
6794 check_closed_event!(nodes[1], 1, ClosureReason::ProcessingError { err: err_msg.data });
6798 fn test_update_add_htlc_bolt2_receiver_check_cltv_expiry() {
6799 //BOLT2 Requirement: if sending node sets cltv_expiry to greater or equal to 500000000: SHOULD fail the channel.
6800 let chanmon_cfgs = create_chanmon_cfgs(2);
6801 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6802 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6803 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6804 let logger = test_utils::TestLogger::new();
6806 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6807 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6808 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6809 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 1000000, TEST_FINAL_CLTV, &logger).unwrap();
6810 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6811 check_added_monitors!(nodes[0], 1);
6812 let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6813 updates.update_add_htlcs[0].cltv_expiry = 500000000;
6814 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6816 assert!(nodes[1].node.list_channels().is_empty());
6817 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6818 assert_eq!(err_msg.data,"Remote provided CLTV expiry in seconds instead of block height");
6819 check_added_monitors!(nodes[1], 1);
6820 check_closed_event!(nodes[1], 1, ClosureReason::ProcessingError { err: err_msg.data });
6824 fn test_update_add_htlc_bolt2_receiver_check_repeated_id_ignore() {
6825 //BOLT 2 requirement: if the sender did not previously acknowledge the commitment of that HTLC: MUST ignore a repeated id value after a reconnection.
6826 // We test this by first testing that that repeated HTLCs pass commitment signature checks
6827 // after disconnect and that non-sequential htlc_ids result in a channel failure.
6828 let chanmon_cfgs = create_chanmon_cfgs(2);
6829 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6830 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6831 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6832 let logger = test_utils::TestLogger::new();
6834 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6835 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6836 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6837 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 1000000, TEST_FINAL_CLTV, &logger).unwrap();
6838 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6839 check_added_monitors!(nodes[0], 1);
6840 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6841 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6843 //Disconnect and Reconnect
6844 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
6845 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
6846 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
6847 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
6848 assert_eq!(reestablish_1.len(), 1);
6849 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
6850 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
6851 assert_eq!(reestablish_2.len(), 1);
6852 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
6853 handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
6854 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
6855 handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
6858 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6859 assert_eq!(updates.commitment_signed.htlc_signatures.len(), 1);
6860 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &updates.commitment_signed);
6861 check_added_monitors!(nodes[1], 1);
6862 let _bs_responses = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6864 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6866 assert!(nodes[1].node.list_channels().is_empty());
6867 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6868 assert!(regex::Regex::new(r"Remote skipped HTLC ID \(skipped ID: \d+\)").unwrap().is_match(err_msg.data.as_str()));
6869 check_added_monitors!(nodes[1], 1);
6870 check_closed_event!(nodes[1], 1, ClosureReason::ProcessingError { err: err_msg.data });
6874 fn test_update_fulfill_htlc_bolt2_update_fulfill_htlc_before_commitment() {
6875 //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.
6877 let chanmon_cfgs = create_chanmon_cfgs(2);
6878 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6879 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6880 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6881 let logger = test_utils::TestLogger::new();
6882 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6883 let (our_payment_preimage, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6884 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6885 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 1000000, TEST_FINAL_CLTV, &logger).unwrap();
6886 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6888 check_added_monitors!(nodes[0], 1);
6889 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6890 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6892 let update_msg = msgs::UpdateFulfillHTLC{
6895 payment_preimage: our_payment_preimage,
6898 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6900 assert!(nodes[0].node.list_channels().is_empty());
6901 let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6902 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()));
6903 check_added_monitors!(nodes[0], 1);
6904 check_closed_event!(nodes[0], 1, ClosureReason::ProcessingError { err: err_msg.data });
6908 fn test_update_fulfill_htlc_bolt2_update_fail_htlc_before_commitment() {
6909 //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.
6911 let chanmon_cfgs = create_chanmon_cfgs(2);
6912 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6913 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6914 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6915 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6916 let logger = test_utils::TestLogger::new();
6918 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6919 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6920 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 1000000, TEST_FINAL_CLTV, &logger).unwrap();
6921 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6922 check_added_monitors!(nodes[0], 1);
6923 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6924 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6926 let update_msg = msgs::UpdateFailHTLC{
6929 reason: msgs::OnionErrorPacket { data: Vec::new()},
6932 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6934 assert!(nodes[0].node.list_channels().is_empty());
6935 let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6936 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()));
6937 check_added_monitors!(nodes[0], 1);
6938 check_closed_event!(nodes[0], 1, ClosureReason::ProcessingError { err: err_msg.data });
6942 fn test_update_fulfill_htlc_bolt2_update_fail_malformed_htlc_before_commitment() {
6943 //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.
6945 let chanmon_cfgs = create_chanmon_cfgs(2);
6946 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6947 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6948 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6949 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6950 let logger = test_utils::TestLogger::new();
6952 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6953 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6954 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 1000000, TEST_FINAL_CLTV, &logger).unwrap();
6955 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6956 check_added_monitors!(nodes[0], 1);
6957 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6958 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6959 let update_msg = msgs::UpdateFailMalformedHTLC{
6962 sha256_of_onion: [1; 32],
6963 failure_code: 0x8000,
6966 nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6968 assert!(nodes[0].node.list_channels().is_empty());
6969 let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6970 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()));
6971 check_added_monitors!(nodes[0], 1);
6972 check_closed_event!(nodes[0], 1, ClosureReason::ProcessingError { err: err_msg.data });
6976 fn test_update_fulfill_htlc_bolt2_incorrect_htlc_id() {
6977 //BOLT 2 Requirement: A receiving node: if the id does not correspond to an HTLC in its current commitment transaction MUST fail the channel.
6979 let chanmon_cfgs = create_chanmon_cfgs(2);
6980 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6981 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6982 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6983 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6985 let our_payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 100000).0;
6987 nodes[1].node.claim_funds(our_payment_preimage);
6988 check_added_monitors!(nodes[1], 1);
6990 let events = nodes[1].node.get_and_clear_pending_msg_events();
6991 assert_eq!(events.len(), 1);
6992 let mut update_fulfill_msg: msgs::UpdateFulfillHTLC = {
6994 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, .. } } => {
6995 assert!(update_add_htlcs.is_empty());
6996 assert_eq!(update_fulfill_htlcs.len(), 1);
6997 assert!(update_fail_htlcs.is_empty());
6998 assert!(update_fail_malformed_htlcs.is_empty());
6999 assert!(update_fee.is_none());
7000 update_fulfill_htlcs[0].clone()
7002 _ => panic!("Unexpected event"),
7006 update_fulfill_msg.htlc_id = 1;
7008 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_msg);
7010 assert!(nodes[0].node.list_channels().is_empty());
7011 let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
7012 assert_eq!(err_msg.data, "Remote tried to fulfill/fail an HTLC we couldn't find");
7013 check_added_monitors!(nodes[0], 1);
7014 check_closed_event!(nodes[0], 1, ClosureReason::ProcessingError { err: err_msg.data });
7018 fn test_update_fulfill_htlc_bolt2_wrong_preimage() {
7019 //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.
7021 let chanmon_cfgs = create_chanmon_cfgs(2);
7022 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7023 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7024 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7025 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7027 let our_payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 100000).0;
7029 nodes[1].node.claim_funds(our_payment_preimage);
7030 check_added_monitors!(nodes[1], 1);
7032 let events = nodes[1].node.get_and_clear_pending_msg_events();
7033 assert_eq!(events.len(), 1);
7034 let mut update_fulfill_msg: msgs::UpdateFulfillHTLC = {
7036 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, .. } } => {
7037 assert!(update_add_htlcs.is_empty());
7038 assert_eq!(update_fulfill_htlcs.len(), 1);
7039 assert!(update_fail_htlcs.is_empty());
7040 assert!(update_fail_malformed_htlcs.is_empty());
7041 assert!(update_fee.is_none());
7042 update_fulfill_htlcs[0].clone()
7044 _ => panic!("Unexpected event"),
7048 update_fulfill_msg.payment_preimage = PaymentPreimage([1; 32]);
7050 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_msg);
7052 assert!(nodes[0].node.list_channels().is_empty());
7053 let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
7054 assert!(regex::Regex::new(r"Remote tried to fulfill HTLC \(\d+\) with an incorrect preimage").unwrap().is_match(err_msg.data.as_str()));
7055 check_added_monitors!(nodes[0], 1);
7056 check_closed_event!(nodes[0], 1, ClosureReason::ProcessingError { err: err_msg.data });
7060 fn test_update_fulfill_htlc_bolt2_missing_badonion_bit_for_malformed_htlc_message() {
7061 //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.
7063 let chanmon_cfgs = create_chanmon_cfgs(2);
7064 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7065 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7066 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7067 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7068 let logger = test_utils::TestLogger::new();
7070 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
7071 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
7072 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 1000000, TEST_FINAL_CLTV, &logger).unwrap();
7073 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
7074 check_added_monitors!(nodes[0], 1);
7076 let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
7077 updates.update_add_htlcs[0].onion_routing_packet.version = 1; //Produce a malformed HTLC message
7079 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
7080 check_added_monitors!(nodes[1], 0);
7081 commitment_signed_dance!(nodes[1], nodes[0], updates.commitment_signed, false, true);
7083 let events = nodes[1].node.get_and_clear_pending_msg_events();
7085 let mut update_msg: msgs::UpdateFailMalformedHTLC = {
7087 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, .. } } => {
7088 assert!(update_add_htlcs.is_empty());
7089 assert!(update_fulfill_htlcs.is_empty());
7090 assert!(update_fail_htlcs.is_empty());
7091 assert_eq!(update_fail_malformed_htlcs.len(), 1);
7092 assert!(update_fee.is_none());
7093 update_fail_malformed_htlcs[0].clone()
7095 _ => panic!("Unexpected event"),
7098 update_msg.failure_code &= !0x8000;
7099 nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
7101 assert!(nodes[0].node.list_channels().is_empty());
7102 let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
7103 assert_eq!(err_msg.data, "Got update_fail_malformed_htlc with BADONION not set");
7104 check_added_monitors!(nodes[0], 1);
7105 check_closed_event!(nodes[0], 1, ClosureReason::ProcessingError { err: err_msg.data });
7109 fn test_update_fulfill_htlc_bolt2_after_malformed_htlc_message_must_forward_update_fail_htlc() {
7110 //BOLT 2 Requirement: a receiving node which has an outgoing HTLC canceled by update_fail_malformed_htlc:
7111 // * 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.
7113 let chanmon_cfgs = create_chanmon_cfgs(3);
7114 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7115 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
7116 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7117 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7118 create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7119 let logger = test_utils::TestLogger::new();
7121 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[2]);
7124 let mut payment_event = {
7125 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
7126 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[2].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
7127 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
7128 check_added_monitors!(nodes[0], 1);
7129 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
7130 assert_eq!(events.len(), 1);
7131 SendEvent::from_event(events.remove(0))
7133 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
7134 check_added_monitors!(nodes[1], 0);
7135 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
7136 expect_pending_htlcs_forwardable!(nodes[1]);
7137 let mut events_2 = nodes[1].node.get_and_clear_pending_msg_events();
7138 assert_eq!(events_2.len(), 1);
7139 check_added_monitors!(nodes[1], 1);
7140 payment_event = SendEvent::from_event(events_2.remove(0));
7141 assert_eq!(payment_event.msgs.len(), 1);
7144 payment_event.msgs[0].onion_routing_packet.version = 1; //Produce a malformed HTLC message
7145 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
7146 check_added_monitors!(nodes[2], 0);
7147 commitment_signed_dance!(nodes[2], nodes[1], payment_event.commitment_msg, false, true);
7149 let events_3 = nodes[2].node.get_and_clear_pending_msg_events();
7150 assert_eq!(events_3.len(), 1);
7151 let update_msg : (msgs::UpdateFailMalformedHTLC, msgs::CommitmentSigned) = {
7153 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 } } => {
7154 assert!(update_add_htlcs.is_empty());
7155 assert!(update_fulfill_htlcs.is_empty());
7156 assert!(update_fail_htlcs.is_empty());
7157 assert_eq!(update_fail_malformed_htlcs.len(), 1);
7158 assert!(update_fee.is_none());
7159 (update_fail_malformed_htlcs[0].clone(), commitment_signed.clone())
7161 _ => panic!("Unexpected event"),
7165 nodes[1].node.handle_update_fail_malformed_htlc(&nodes[2].node.get_our_node_id(), &update_msg.0);
7167 check_added_monitors!(nodes[1], 0);
7168 commitment_signed_dance!(nodes[1], nodes[2], update_msg.1, false, true);
7169 expect_pending_htlcs_forwardable!(nodes[1]);
7170 let events_4 = nodes[1].node.get_and_clear_pending_msg_events();
7171 assert_eq!(events_4.len(), 1);
7173 //Confirm that handlinge the update_malformed_htlc message produces an update_fail_htlc message to be forwarded back along the route
7175 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, .. } } => {
7176 assert!(update_add_htlcs.is_empty());
7177 assert!(update_fulfill_htlcs.is_empty());
7178 assert_eq!(update_fail_htlcs.len(), 1);
7179 assert!(update_fail_malformed_htlcs.is_empty());
7180 assert!(update_fee.is_none());
7182 _ => panic!("Unexpected event"),
7185 check_added_monitors!(nodes[1], 1);
7188 fn do_test_failure_delay_dust_htlc_local_commitment(announce_latest: bool) {
7189 // Dust-HTLC failure updates must be delayed until failure-trigger tx (in this case local commitment) reach ANTI_REORG_DELAY
7190 // 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
7191 // HTLC could have been removed from lastest local commitment tx but still valid until we get remote RAA
7193 let mut chanmon_cfgs = create_chanmon_cfgs(2);
7194 chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
7195 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7196 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7197 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7198 let chan =create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7200 let bs_dust_limit = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().holder_dust_limit_satoshis;
7202 // We route 2 dust-HTLCs between A and B
7203 let (_, payment_hash_1, _) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
7204 let (_, payment_hash_2, _) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
7205 route_payment(&nodes[0], &[&nodes[1]], 1000000);
7207 // Cache one local commitment tx as previous
7208 let as_prev_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
7210 // Fail one HTLC to prune it in the will-be-latest-local commitment tx
7211 assert!(nodes[1].node.fail_htlc_backwards(&payment_hash_2));
7212 check_added_monitors!(nodes[1], 0);
7213 expect_pending_htlcs_forwardable!(nodes[1]);
7214 check_added_monitors!(nodes[1], 1);
7216 let remove = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
7217 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &remove.update_fail_htlcs[0]);
7218 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &remove.commitment_signed);
7219 check_added_monitors!(nodes[0], 1);
7221 // Cache one local commitment tx as lastest
7222 let as_last_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
7224 let events = nodes[0].node.get_and_clear_pending_msg_events();
7226 MessageSendEvent::SendRevokeAndACK { node_id, .. } => {
7227 assert_eq!(node_id, nodes[1].node.get_our_node_id());
7229 _ => panic!("Unexpected event"),
7232 MessageSendEvent::UpdateHTLCs { node_id, .. } => {
7233 assert_eq!(node_id, nodes[1].node.get_our_node_id());
7235 _ => panic!("Unexpected event"),
7238 assert_ne!(as_prev_commitment_tx, as_last_commitment_tx);
7239 // Fail the 2 dust-HTLCs, move their failure in maturation buffer (htlc_updated_waiting_threshold_conf)
7240 if announce_latest {
7241 mine_transaction(&nodes[0], &as_last_commitment_tx[0]);
7243 mine_transaction(&nodes[0], &as_prev_commitment_tx[0]);
7246 check_closed_broadcast!(nodes[0], true);
7247 check_added_monitors!(nodes[0], 1);
7248 check_closed_event!(nodes[0], 1, ClosureReason::CommitmentTxConfirmed);
7250 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7251 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7252 let events = nodes[0].node.get_and_clear_pending_events();
7253 // Only 2 PaymentPathFailed events should show up, over-dust HTLC has to be failed by timeout tx
7254 assert_eq!(events.len(), 2);
7255 let mut first_failed = false;
7256 for event in events {
7258 Event::PaymentPathFailed { payment_hash, .. } => {
7259 if payment_hash == payment_hash_1 {
7260 assert!(!first_failed);
7261 first_failed = true;
7263 assert_eq!(payment_hash, payment_hash_2);
7266 _ => panic!("Unexpected event"),
7272 fn test_failure_delay_dust_htlc_local_commitment() {
7273 do_test_failure_delay_dust_htlc_local_commitment(true);
7274 do_test_failure_delay_dust_htlc_local_commitment(false);
7277 fn do_test_sweep_outbound_htlc_failure_update(revoked: bool, local: bool) {
7278 // Outbound HTLC-failure updates must be cancelled if we get a reorg before we reach ANTI_REORG_DELAY.
7279 // Broadcast of revoked remote commitment tx, trigger failure-update of dust/non-dust HTLCs
7280 // Broadcast of remote commitment tx, trigger failure-update of dust-HTLCs
7281 // Broadcast of timeout tx on remote commitment tx, trigger failure-udate of non-dust HTLCs
7282 // Broadcast of local commitment tx, trigger failure-update of dust-HTLCs
7283 // Broadcast of HTLC-timeout tx on local commitment tx, trigger failure-update of non-dust HTLCs
7285 let chanmon_cfgs = create_chanmon_cfgs(3);
7286 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7287 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
7288 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7289 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7291 let bs_dust_limit = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().holder_dust_limit_satoshis;
7293 let (_payment_preimage_1, dust_hash, _payment_secret_1) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
7294 let (_payment_preimage_2, non_dust_hash, _payment_secret_2) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
7296 let as_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
7297 let bs_commitment_tx = get_local_commitment_txn!(nodes[1], chan.2);
7299 // We revoked bs_commitment_tx
7301 let (payment_preimage_3, _, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
7302 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_3);
7305 let mut timeout_tx = Vec::new();
7307 // We fail dust-HTLC 1 by broadcast of local commitment tx
7308 mine_transaction(&nodes[0], &as_commitment_tx[0]);
7309 check_closed_event!(nodes[0], 1, ClosureReason::CommitmentTxConfirmed);
7310 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7311 expect_payment_failed!(nodes[0], dust_hash, true);
7313 connect_blocks(&nodes[0], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS - ANTI_REORG_DELAY);
7314 check_closed_broadcast!(nodes[0], true);
7315 check_added_monitors!(nodes[0], 1);
7316 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7317 timeout_tx.push(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[1].clone());
7318 assert_eq!(timeout_tx[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
7319 // We fail non-dust-HTLC 2 by broadcast of local HTLC-timeout tx on local commitment tx
7320 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7321 mine_transaction(&nodes[0], &timeout_tx[0]);
7322 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7323 expect_payment_failed!(nodes[0], non_dust_hash, true);
7325 // We fail dust-HTLC 1 by broadcast of remote commitment tx. If revoked, fail also non-dust HTLC
7326 mine_transaction(&nodes[0], &bs_commitment_tx[0]);
7327 check_closed_broadcast!(nodes[0], true);
7328 check_added_monitors!(nodes[0], 1);
7329 check_closed_event!(nodes[0], 1, ClosureReason::CommitmentTxConfirmed);
7330 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7331 connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
7332 timeout_tx.push(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[1].clone());
7334 expect_payment_failed!(nodes[0], dust_hash, true);
7335 assert_eq!(timeout_tx[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
7336 // We fail non-dust-HTLC 2 by broadcast of local timeout tx on remote commitment tx
7337 mine_transaction(&nodes[0], &timeout_tx[0]);
7338 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7339 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7340 expect_payment_failed!(nodes[0], non_dust_hash, true);
7342 // If revoked, both dust & non-dust HTLCs should have been failed after ANTI_REORG_DELAY confs of revoked
7344 let events = nodes[0].node.get_and_clear_pending_events();
7345 assert_eq!(events.len(), 2);
7348 Event::PaymentPathFailed { payment_hash, .. } => {
7349 if payment_hash == dust_hash { first = true; }
7350 else { first = false; }
7352 _ => panic!("Unexpected event"),
7355 Event::PaymentPathFailed { payment_hash, .. } => {
7356 if first { assert_eq!(payment_hash, non_dust_hash); }
7357 else { assert_eq!(payment_hash, dust_hash); }
7359 _ => panic!("Unexpected event"),
7366 fn test_sweep_outbound_htlc_failure_update() {
7367 do_test_sweep_outbound_htlc_failure_update(false, true);
7368 do_test_sweep_outbound_htlc_failure_update(false, false);
7369 do_test_sweep_outbound_htlc_failure_update(true, false);
7373 fn test_user_configurable_csv_delay() {
7374 // We test our channel constructors yield errors when we pass them absurd csv delay
7376 let mut low_our_to_self_config = UserConfig::default();
7377 low_our_to_self_config.own_channel_config.our_to_self_delay = 6;
7378 let mut high_their_to_self_config = UserConfig::default();
7379 high_their_to_self_config.peer_channel_config_limits.their_to_self_delay = 100;
7380 let user_cfgs = [Some(high_their_to_self_config.clone()), None];
7381 let chanmon_cfgs = create_chanmon_cfgs(2);
7382 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7383 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &user_cfgs);
7384 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7386 // We test config.our_to_self > BREAKDOWN_TIMEOUT is enforced in Channel::new_outbound()
7387 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) {
7389 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())); },
7390 _ => panic!("Unexpected event"),
7392 } else { assert!(false) }
7394 // We test config.our_to_self > BREAKDOWN_TIMEOUT is enforced in Channel::new_from_req()
7395 nodes[1].node.create_channel(nodes[0].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
7396 let mut open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
7397 open_channel.to_self_delay = 200;
7398 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) {
7400 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())); },
7401 _ => panic!("Unexpected event"),
7403 } else { assert!(false); }
7405 // We test msg.to_self_delay <= config.their_to_self_delay is enforced in Chanel::accept_channel()
7406 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
7407 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()));
7408 let mut accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
7409 accept_channel.to_self_delay = 200;
7410 nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &accept_channel);
7412 if let MessageSendEvent::HandleError { ref action, .. } = nodes[0].node.get_and_clear_pending_msg_events()[0] {
7414 &ErrorAction::SendErrorMessage { ref msg } => {
7415 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()));
7416 reason_msg = msg.data.clone();
7420 } else { panic!(); }
7421 check_closed_event!(nodes[0], 1, ClosureReason::ProcessingError { err: reason_msg });
7423 // We test msg.to_self_delay <= config.their_to_self_delay is enforced in Channel::new_from_req()
7424 nodes[1].node.create_channel(nodes[0].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
7425 let mut open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
7426 open_channel.to_self_delay = 200;
7427 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) {
7429 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())); },
7430 _ => panic!("Unexpected event"),
7432 } else { assert!(false); }
7436 fn test_data_loss_protect() {
7437 // We want to be sure that :
7438 // * we don't broadcast our Local Commitment Tx in case of fallen behind
7439 // (but this is not quite true - we broadcast during Drop because chanmon is out of sync with chanmgr)
7440 // * we close channel in case of detecting other being fallen behind
7441 // * we are able to claim our own outputs thanks to to_remote being static
7442 // TODO: this test is incomplete and the data_loss_protect implementation is incomplete - see issue #775
7448 let mut chanmon_cfgs = create_chanmon_cfgs(2);
7449 // We broadcast during Drop because chanmon is out of sync with chanmgr, which would cause a panic
7450 // during signing due to revoked tx
7451 chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
7452 let keys_manager = &chanmon_cfgs[0].keys_manager;
7455 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7456 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7457 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7459 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7461 // Cache node A state before any channel update
7462 let previous_node_state = nodes[0].node.encode();
7463 let mut previous_chain_monitor_state = test_utils::TestVecWriter(Vec::new());
7464 nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut previous_chain_monitor_state).unwrap();
7466 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
7467 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
7469 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
7470 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
7472 // Restore node A from previous state
7473 logger = test_utils::TestLogger::with_id(format!("node {}", 0));
7474 let mut chain_monitor = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(&mut io::Cursor::new(previous_chain_monitor_state.0), keys_manager).unwrap().1;
7475 chain_source = test_utils::TestChainSource::new(Network::Testnet);
7476 tx_broadcaster = test_utils::TestBroadcaster{txn_broadcasted: Mutex::new(Vec::new()), blocks: Arc::new(Mutex::new(Vec::new()))};
7477 fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
7478 persister = test_utils::TestPersister::new();
7479 monitor = test_utils::TestChainMonitor::new(Some(&chain_source), &tx_broadcaster, &logger, &fee_estimator, &persister, keys_manager);
7481 let mut channel_monitors = HashMap::new();
7482 channel_monitors.insert(OutPoint { txid: chan.3.txid(), index: 0 }, &mut chain_monitor);
7483 <(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 {
7484 keys_manager: keys_manager,
7485 fee_estimator: &fee_estimator,
7486 chain_monitor: &monitor,
7488 tx_broadcaster: &tx_broadcaster,
7489 default_config: UserConfig::default(),
7493 nodes[0].node = &node_state_0;
7494 assert!(monitor.watch_channel(OutPoint { txid: chan.3.txid(), index: 0 }, chain_monitor).is_ok());
7495 nodes[0].chain_monitor = &monitor;
7496 nodes[0].chain_source = &chain_source;
7498 check_added_monitors!(nodes[0], 1);
7500 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7501 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7503 let reestablish_0 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
7505 // Check we don't broadcast any transactions following learning of per_commitment_point from B
7506 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_0[0]);
7507 check_added_monitors!(nodes[0], 1);
7510 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
7511 assert_eq!(node_txn.len(), 0);
7514 let mut reestablish_1 = Vec::with_capacity(1);
7515 for msg in nodes[0].node.get_and_clear_pending_msg_events() {
7516 if let MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } = msg {
7517 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
7518 reestablish_1.push(msg.clone());
7519 } else if let MessageSendEvent::BroadcastChannelUpdate { .. } = msg {
7520 } else if let MessageSendEvent::HandleError { ref action, .. } = msg {
7522 &ErrorAction::SendErrorMessage { ref msg } => {
7523 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");
7525 _ => panic!("Unexpected event!"),
7528 panic!("Unexpected event")
7532 // Check we close channel detecting A is fallen-behind
7533 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
7534 check_closed_event!(nodes[1], 1, ClosureReason::ProcessingError { err: "Peer attempted to reestablish channel with a very old local commitment transaction".to_string() });
7535 assert_eq!(check_closed_broadcast!(nodes[1], true).unwrap().data, "Peer attempted to reestablish channel with a very old local commitment transaction");
7536 check_added_monitors!(nodes[1], 1);
7538 // Check A is able to claim to_remote output
7539 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
7540 assert_eq!(node_txn.len(), 1);
7541 check_spends!(node_txn[0], chan.3);
7542 assert_eq!(node_txn[0].output.len(), 2);
7543 mine_transaction(&nodes[0], &node_txn[0]);
7544 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7545 check_closed_event!(nodes[0], 1, ClosureReason::ProcessingError { err: "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".to_string() });
7546 let spend_txn = check_spendable_outputs!(nodes[0], node_cfgs[0].keys_manager);
7547 assert_eq!(spend_txn.len(), 1);
7548 check_spends!(spend_txn[0], node_txn[0]);
7552 fn test_check_htlc_underpaying() {
7553 // Send payment through A -> B but A is maliciously
7554 // sending a probe payment (i.e less than expected value0
7555 // to B, B should refuse payment.
7557 let chanmon_cfgs = create_chanmon_cfgs(2);
7558 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7559 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7560 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7562 // Create some initial channels
7563 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7565 let route = get_route(&nodes[0].node.get_our_node_id(), &nodes[0].net_graph_msg_handler.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 10_000, TEST_FINAL_CLTV, nodes[0].logger).unwrap();
7566 let (_, our_payment_hash, _) = get_payment_preimage_hash!(nodes[0]);
7567 let our_payment_secret = nodes[1].node.create_inbound_payment_for_hash(our_payment_hash, Some(100_000), 7200, 0).unwrap();
7568 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
7569 check_added_monitors!(nodes[0], 1);
7571 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
7572 assert_eq!(events.len(), 1);
7573 let mut payment_event = SendEvent::from_event(events.pop().unwrap());
7574 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
7575 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
7577 // Note that we first have to wait a random delay before processing the receipt of the HTLC,
7578 // and then will wait a second random delay before failing the HTLC back:
7579 expect_pending_htlcs_forwardable!(nodes[1]);
7580 expect_pending_htlcs_forwardable!(nodes[1]);
7582 // Node 3 is expecting payment of 100_000 but received 10_000,
7583 // it should fail htlc like we didn't know the preimage.
7584 nodes[1].node.process_pending_htlc_forwards();
7586 let events = nodes[1].node.get_and_clear_pending_msg_events();
7587 assert_eq!(events.len(), 1);
7588 let (update_fail_htlc, commitment_signed) = match events[0] {
7589 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 } } => {
7590 assert!(update_add_htlcs.is_empty());
7591 assert!(update_fulfill_htlcs.is_empty());
7592 assert_eq!(update_fail_htlcs.len(), 1);
7593 assert!(update_fail_malformed_htlcs.is_empty());
7594 assert!(update_fee.is_none());
7595 (update_fail_htlcs[0].clone(), commitment_signed)
7597 _ => panic!("Unexpected event"),
7599 check_added_monitors!(nodes[1], 1);
7601 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlc);
7602 commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
7604 // 10_000 msat as u64, followed by a height of CHAN_CONFIRM_DEPTH as u32
7605 let mut expected_failure_data = byte_utils::be64_to_array(10_000).to_vec();
7606 expected_failure_data.extend_from_slice(&byte_utils::be32_to_array(CHAN_CONFIRM_DEPTH));
7607 expect_payment_failed!(nodes[0], our_payment_hash, true, 0x4000|15, &expected_failure_data[..]);
7611 fn test_announce_disable_channels() {
7612 // Create 2 channels between A and B. Disconnect B. Call timer_tick_occurred and check for generated
7613 // ChannelUpdate. Reconnect B, reestablish and check there is non-generated ChannelUpdate.
7615 let chanmon_cfgs = create_chanmon_cfgs(2);
7616 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7617 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7618 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7620 let short_id_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
7621 let short_id_2 = create_announced_chan_between_nodes(&nodes, 1, 0, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
7622 let short_id_3 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
7625 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
7626 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
7628 nodes[0].node.timer_tick_occurred(); // Enabled -> DisabledStaged
7629 nodes[0].node.timer_tick_occurred(); // DisabledStaged -> Disabled
7630 let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
7631 assert_eq!(msg_events.len(), 3);
7632 let mut chans_disabled: HashSet<u64> = [short_id_1, short_id_2, short_id_3].iter().map(|a| *a).collect();
7633 for e in msg_events {
7635 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
7636 assert_eq!(msg.contents.flags & (1<<1), 1<<1); // The "channel disabled" bit should be set
7637 // Check that each channel gets updated exactly once
7638 if !chans_disabled.remove(&msg.contents.short_channel_id) {
7639 panic!("Generated ChannelUpdate for wrong chan!");
7642 _ => panic!("Unexpected event"),
7646 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7647 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
7648 assert_eq!(reestablish_1.len(), 3);
7649 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7650 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
7651 assert_eq!(reestablish_2.len(), 3);
7653 // Reestablish chan_1
7654 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
7655 handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
7656 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
7657 handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
7658 // Reestablish chan_2
7659 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[1]);
7660 handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
7661 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[1]);
7662 handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
7663 // Reestablish chan_3
7664 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[2]);
7665 handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
7666 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[2]);
7667 handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
7669 nodes[0].node.timer_tick_occurred();
7670 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
7671 nodes[0].node.timer_tick_occurred();
7672 let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
7673 assert_eq!(msg_events.len(), 3);
7674 chans_disabled = [short_id_1, short_id_2, short_id_3].iter().map(|a| *a).collect();
7675 for e in msg_events {
7677 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
7678 assert_eq!(msg.contents.flags & (1<<1), 0); // The "channel disabled" bit should be off
7679 // Check that each channel gets updated exactly once
7680 if !chans_disabled.remove(&msg.contents.short_channel_id) {
7681 panic!("Generated ChannelUpdate for wrong chan!");
7684 _ => panic!("Unexpected event"),
7690 fn test_priv_forwarding_rejection() {
7691 // If we have a private channel with outbound liquidity, and
7692 // UserConfig::accept_forwards_to_priv_channels is set to false, we should reject any attempts
7693 // to forward through that channel.
7694 let chanmon_cfgs = create_chanmon_cfgs(3);
7695 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7696 let mut no_announce_cfg = test_default_channel_config();
7697 no_announce_cfg.channel_options.announced_channel = false;
7698 no_announce_cfg.accept_forwards_to_priv_channels = false;
7699 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, Some(no_announce_cfg), None]);
7700 let persister: test_utils::TestPersister;
7701 let new_chain_monitor: test_utils::TestChainMonitor;
7702 let nodes_1_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
7703 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7705 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1_000_000, 500_000_000, InitFeatures::known(), InitFeatures::known());
7707 // Note that the create_*_chan functions in utils requires announcement_signatures, which we do
7708 // not send for private channels.
7709 nodes[1].node.create_channel(nodes[2].node.get_our_node_id(), 1_000_000, 500_000_000, 42, None).unwrap();
7710 let open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[2].node.get_our_node_id());
7711 nodes[2].node.handle_open_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &open_channel);
7712 let accept_channel = get_event_msg!(nodes[2], MessageSendEvent::SendAcceptChannel, nodes[1].node.get_our_node_id());
7713 nodes[1].node.handle_accept_channel(&nodes[2].node.get_our_node_id(), InitFeatures::known(), &accept_channel);
7715 let (temporary_channel_id, tx, _) = create_funding_transaction(&nodes[1], 1_000_000, 42);
7716 nodes[1].node.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
7717 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()));
7718 check_added_monitors!(nodes[2], 1);
7720 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()));
7721 check_added_monitors!(nodes[1], 1);
7723 let conf_height = core::cmp::max(nodes[1].best_block_info().1 + 1, nodes[2].best_block_info().1 + 1);
7724 confirm_transaction_at(&nodes[1], &tx, conf_height);
7725 connect_blocks(&nodes[1], CHAN_CONFIRM_DEPTH - 1);
7726 confirm_transaction_at(&nodes[2], &tx, conf_height);
7727 connect_blocks(&nodes[2], CHAN_CONFIRM_DEPTH - 1);
7728 let as_funding_locked = get_event_msg!(nodes[1], MessageSendEvent::SendFundingLocked, nodes[2].node.get_our_node_id());
7729 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()));
7730 get_event_msg!(nodes[1], MessageSendEvent::SendChannelUpdate, nodes[2].node.get_our_node_id());
7731 nodes[2].node.handle_funding_locked(&nodes[1].node.get_our_node_id(), &as_funding_locked);
7732 get_event_msg!(nodes[2], MessageSendEvent::SendChannelUpdate, nodes[1].node.get_our_node_id());
7734 assert!(nodes[0].node.list_usable_channels()[0].is_public);
7735 assert_eq!(nodes[1].node.list_usable_channels().len(), 2);
7736 assert!(!nodes[2].node.list_usable_channels()[0].is_public);
7738 // We should always be able to forward through nodes[1] as long as its out through a public
7740 send_payment(&nodes[2], &[&nodes[1], &nodes[0]], 10_000);
7742 // ... however, if we send to nodes[2], we will have to pass the private channel from nodes[1]
7743 // to nodes[2], which should be rejected:
7744 let (our_payment_preimage, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[2]);
7745 let route = get_route(&nodes[0].node.get_our_node_id(),
7746 &nodes[0].net_graph_msg_handler.network_graph,
7747 &nodes[2].node.get_our_node_id(), Some(InvoiceFeatures::known()), None,
7748 &[&RouteHint(vec![RouteHintHop {
7749 src_node_id: nodes[1].node.get_our_node_id(),
7750 short_channel_id: nodes[2].node.list_channels()[0].short_channel_id.unwrap(),
7751 fees: RoutingFees { base_msat: 1000, proportional_millionths: 0 },
7752 cltv_expiry_delta: MIN_CLTV_EXPIRY_DELTA,
7753 htlc_minimum_msat: None,
7754 htlc_maximum_msat: None,
7755 }])], 10_000, TEST_FINAL_CLTV, nodes[0].logger).unwrap();
7757 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
7758 check_added_monitors!(nodes[0], 1);
7759 let payment_event = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
7760 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
7761 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false, true);
7763 let htlc_fail_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
7764 assert!(htlc_fail_updates.update_add_htlcs.is_empty());
7765 assert_eq!(htlc_fail_updates.update_fail_htlcs.len(), 1);
7766 assert!(htlc_fail_updates.update_fail_malformed_htlcs.is_empty());
7767 assert!(htlc_fail_updates.update_fee.is_none());
7769 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_fail_updates.update_fail_htlcs[0]);
7770 commitment_signed_dance!(nodes[0], nodes[1], htlc_fail_updates.commitment_signed, true, true);
7771 expect_payment_failed_with_update!(nodes[0], our_payment_hash, false, nodes[2].node.list_channels()[0].short_channel_id.unwrap(), true);
7773 // Now disconnect nodes[1] from its peers and restart with accept_forwards_to_priv_channels set
7774 // to true. Sadly there is currently no way to change it at runtime.
7776 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
7777 nodes[2].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
7779 let nodes_1_serialized = nodes[1].node.encode();
7780 let mut monitor_a_serialized = test_utils::TestVecWriter(Vec::new());
7781 let mut monitor_b_serialized = test_utils::TestVecWriter(Vec::new());
7783 let mons = nodes[1].chain_monitor.chain_monitor.monitors.read().unwrap();
7784 let mut mon_iter = mons.iter();
7785 mon_iter.next().unwrap().1.write(&mut monitor_a_serialized).unwrap();
7786 mon_iter.next().unwrap().1.write(&mut monitor_b_serialized).unwrap();
7789 persister = test_utils::TestPersister::new();
7790 let keys_manager = &chanmon_cfgs[1].keys_manager;
7791 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);
7792 nodes[1].chain_monitor = &new_chain_monitor;
7794 let mut monitor_a_read = &monitor_a_serialized.0[..];
7795 let mut monitor_b_read = &monitor_b_serialized.0[..];
7796 let (_, mut monitor_a) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(&mut monitor_a_read, keys_manager).unwrap();
7797 let (_, mut monitor_b) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(&mut monitor_b_read, keys_manager).unwrap();
7798 assert!(monitor_a_read.is_empty());
7799 assert!(monitor_b_read.is_empty());
7801 no_announce_cfg.accept_forwards_to_priv_channels = true;
7803 let mut nodes_1_read = &nodes_1_serialized[..];
7804 let (_, nodes_1_deserialized_tmp) = {
7805 let mut channel_monitors = HashMap::new();
7806 channel_monitors.insert(monitor_a.get_funding_txo().0, &mut monitor_a);
7807 channel_monitors.insert(monitor_b.get_funding_txo().0, &mut monitor_b);
7808 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_1_read, ChannelManagerReadArgs {
7809 default_config: no_announce_cfg,
7811 fee_estimator: node_cfgs[1].fee_estimator,
7812 chain_monitor: nodes[1].chain_monitor,
7813 tx_broadcaster: nodes[1].tx_broadcaster.clone(),
7814 logger: nodes[1].logger,
7818 assert!(nodes_1_read.is_empty());
7819 nodes_1_deserialized = nodes_1_deserialized_tmp;
7821 assert!(nodes[1].chain_monitor.watch_channel(monitor_a.get_funding_txo().0, monitor_a).is_ok());
7822 assert!(nodes[1].chain_monitor.watch_channel(monitor_b.get_funding_txo().0, monitor_b).is_ok());
7823 check_added_monitors!(nodes[1], 2);
7824 nodes[1].node = &nodes_1_deserialized;
7826 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::known() });
7827 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7828 let as_reestablish = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
7829 let bs_reestablish = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
7830 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &as_reestablish);
7831 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &bs_reestablish);
7832 get_event_msg!(nodes[0], MessageSendEvent::SendChannelUpdate, nodes[1].node.get_our_node_id());
7833 get_event_msg!(nodes[1], MessageSendEvent::SendChannelUpdate, nodes[0].node.get_our_node_id());
7835 nodes[1].node.peer_connected(&nodes[2].node.get_our_node_id(), &msgs::Init { features: InitFeatures::known() });
7836 nodes[2].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7837 let bs_reestablish = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[2].node.get_our_node_id());
7838 let cs_reestablish = get_event_msg!(nodes[2], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
7839 nodes[2].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &bs_reestablish);
7840 nodes[1].node.handle_channel_reestablish(&nodes[2].node.get_our_node_id(), &cs_reestablish);
7841 get_event_msg!(nodes[1], MessageSendEvent::SendChannelUpdate, nodes[2].node.get_our_node_id());
7842 get_event_msg!(nodes[2], MessageSendEvent::SendChannelUpdate, nodes[1].node.get_our_node_id());
7844 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
7845 check_added_monitors!(nodes[0], 1);
7846 pass_along_route(&nodes[0], &[&[&nodes[1], &nodes[2]]], 10_000, our_payment_hash, our_payment_secret);
7847 claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], our_payment_preimage);
7851 fn test_bump_penalty_txn_on_revoked_commitment() {
7852 // In case of penalty txn with too low feerates for getting into mempools, RBF-bump them to be sure
7853 // we're able to claim outputs on revoked commitment transaction before timelocks expiration
7855 let chanmon_cfgs = create_chanmon_cfgs(2);
7856 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7857 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7858 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7860 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
7861 let logger = test_utils::TestLogger::new();
7863 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
7864 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
7865 let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[0].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 3000000, 30, &logger).unwrap();
7866 send_along_route(&nodes[1], route, &vec!(&nodes[0])[..], 3000000);
7868 let revoked_txn = get_local_commitment_txn!(nodes[0], chan.2);
7869 // Revoked commitment txn with 4 outputs : to_local, to_remote, 1 outgoing HTLC, 1 incoming HTLC
7870 assert_eq!(revoked_txn[0].output.len(), 4);
7871 assert_eq!(revoked_txn[0].input.len(), 1);
7872 assert_eq!(revoked_txn[0].input[0].previous_output.txid, chan.3.txid());
7873 let revoked_txid = revoked_txn[0].txid();
7875 let mut penalty_sum = 0;
7876 for outp in revoked_txn[0].output.iter() {
7877 if outp.script_pubkey.is_v0_p2wsh() {
7878 penalty_sum += outp.value;
7882 // Connect blocks to change height_timer range to see if we use right soonest_timelock
7883 let header_114 = connect_blocks(&nodes[1], 14);
7885 // Actually revoke tx by claiming a HTLC
7886 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
7887 let header = BlockHeader { version: 0x20000000, prev_blockhash: header_114, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7888 connect_block(&nodes[1], &Block { header, txdata: vec![revoked_txn[0].clone()] });
7889 check_added_monitors!(nodes[1], 1);
7891 // One or more justice tx should have been broadcast, check it
7895 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7896 assert_eq!(node_txn.len(), 2); // justice tx (broadcasted from ChannelMonitor) + local commitment tx
7897 assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
7898 assert_eq!(node_txn[0].output.len(), 1);
7899 check_spends!(node_txn[0], revoked_txn[0]);
7900 let fee_1 = penalty_sum - node_txn[0].output[0].value;
7901 feerate_1 = fee_1 * 1000 / node_txn[0].get_weight() as u64;
7902 penalty_1 = node_txn[0].txid();
7906 // After exhaustion of height timer, a new bumped justice tx should have been broadcast, check it
7907 connect_blocks(&nodes[1], 15);
7908 let mut penalty_2 = penalty_1;
7909 let mut feerate_2 = 0;
7911 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7912 assert_eq!(node_txn.len(), 1);
7913 if node_txn[0].input[0].previous_output.txid == revoked_txid {
7914 assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
7915 assert_eq!(node_txn[0].output.len(), 1);
7916 check_spends!(node_txn[0], revoked_txn[0]);
7917 penalty_2 = node_txn[0].txid();
7918 // Verify new bumped tx is different from last claiming transaction, we don't want spurrious rebroadcast
7919 assert_ne!(penalty_2, penalty_1);
7920 let fee_2 = penalty_sum - node_txn[0].output[0].value;
7921 feerate_2 = fee_2 * 1000 / node_txn[0].get_weight() as u64;
7922 // Verify 25% bump heuristic
7923 assert!(feerate_2 * 100 >= feerate_1 * 125);
7927 assert_ne!(feerate_2, 0);
7929 // After exhaustion of height timer for a 2nd time, a new bumped justice tx should have been broadcast, check it
7930 connect_blocks(&nodes[1], 1);
7932 let mut feerate_3 = 0;
7934 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7935 assert_eq!(node_txn.len(), 1);
7936 if node_txn[0].input[0].previous_output.txid == revoked_txid {
7937 assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
7938 assert_eq!(node_txn[0].output.len(), 1);
7939 check_spends!(node_txn[0], revoked_txn[0]);
7940 penalty_3 = node_txn[0].txid();
7941 // Verify new bumped tx is different from last claiming transaction, we don't want spurrious rebroadcast
7942 assert_ne!(penalty_3, penalty_2);
7943 let fee_3 = penalty_sum - node_txn[0].output[0].value;
7944 feerate_3 = fee_3 * 1000 / node_txn[0].get_weight() as u64;
7945 // Verify 25% bump heuristic
7946 assert!(feerate_3 * 100 >= feerate_2 * 125);
7950 assert_ne!(feerate_3, 0);
7952 nodes[1].node.get_and_clear_pending_events();
7953 nodes[1].node.get_and_clear_pending_msg_events();
7957 fn test_bump_penalty_txn_on_revoked_htlcs() {
7958 // In case of penalty txn with too low feerates for getting into mempools, RBF-bump them to sure
7959 // we're able to claim outputs on revoked HTLC transactions before timelocks expiration
7961 let mut chanmon_cfgs = create_chanmon_cfgs(2);
7962 chanmon_cfgs[1].keys_manager.disable_revocation_policy_check = true;
7963 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7964 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7965 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7967 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
7968 // Lock HTLC in both directions (using a slightly lower CLTV delay to provide timely RBF bumps)
7969 let route = get_route(&nodes[0].node.get_our_node_id(), &nodes[0].net_graph_msg_handler.network_graph,
7970 &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 3_000_000, 50, nodes[0].logger).unwrap();
7971 let payment_preimage = send_along_route(&nodes[0], route, &[&nodes[1]], 3_000_000).0;
7972 let route = get_route(&nodes[1].node.get_our_node_id(), &nodes[1].net_graph_msg_handler.network_graph,
7973 &nodes[0].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 3_000_000, 50, nodes[0].logger).unwrap();
7974 send_along_route(&nodes[1], route, &[&nodes[0]], 3_000_000);
7976 let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan.2);
7977 assert_eq!(revoked_local_txn[0].input.len(), 1);
7978 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
7980 // Revoke local commitment tx
7981 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
7983 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7984 // B will generate both revoked HTLC-timeout/HTLC-preimage txn from revoked commitment tx
7985 connect_block(&nodes[1], &Block { header, txdata: vec![revoked_local_txn[0].clone()] });
7986 check_closed_broadcast!(nodes[1], true);
7987 check_added_monitors!(nodes[1], 1);
7988 check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
7989 connect_blocks(&nodes[1], 49); // Confirm blocks until the HTLC expires (note CLTV was explicitly 50 above)
7991 let revoked_htlc_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7992 assert_eq!(revoked_htlc_txn.len(), 3);
7993 check_spends!(revoked_htlc_txn[1], chan.3);
7995 assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
7996 assert_eq!(revoked_htlc_txn[0].input.len(), 1);
7997 check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
7999 assert_eq!(revoked_htlc_txn[2].input.len(), 1);
8000 assert_eq!(revoked_htlc_txn[2].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
8001 assert_eq!(revoked_htlc_txn[2].output.len(), 1);
8002 check_spends!(revoked_htlc_txn[2], revoked_local_txn[0]);
8004 // Broadcast set of revoked txn on A
8005 let hash_128 = connect_blocks(&nodes[0], 40);
8006 let header_11 = BlockHeader { version: 0x20000000, prev_blockhash: hash_128, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8007 connect_block(&nodes[0], &Block { header: header_11, txdata: vec![revoked_local_txn[0].clone()] });
8008 let header_129 = BlockHeader { version: 0x20000000, prev_blockhash: header_11.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8009 connect_block(&nodes[0], &Block { header: header_129, txdata: vec![revoked_htlc_txn[0].clone(), revoked_htlc_txn[2].clone()] });
8010 let events = nodes[0].node.get_and_clear_pending_events();
8011 expect_pending_htlcs_forwardable_from_events!(nodes[0], events[0..1], true);
8013 Event::ChannelClosed { reason: ClosureReason::CommitmentTxConfirmed, .. } => {}
8014 _ => panic!("Unexpected event"),
8020 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8021 assert_eq!(node_txn.len(), 5); // 3 penalty txn on revoked commitment tx + A commitment tx + 1 penalty tnx on revoked HTLC txn
8022 // Verify claim tx are spending revoked HTLC txn
8024 // node_txn 0-2 each spend a separate revoked output from revoked_local_txn[0]
8025 // Note that node_txn[0] and node_txn[1] are bogus - they double spend the revoked_htlc_txn
8026 // which are included in the same block (they are broadcasted because we scan the
8027 // transactions linearly and generate claims as we go, they likely should be removed in the
8029 assert_eq!(node_txn[0].input.len(), 1);
8030 check_spends!(node_txn[0], revoked_local_txn[0]);
8031 assert_eq!(node_txn[1].input.len(), 1);
8032 check_spends!(node_txn[1], revoked_local_txn[0]);
8033 assert_eq!(node_txn[2].input.len(), 1);
8034 check_spends!(node_txn[2], revoked_local_txn[0]);
8036 // Each of the three justice transactions claim a separate (single) output of the three
8037 // available, which we check here:
8038 assert_ne!(node_txn[0].input[0].previous_output, node_txn[1].input[0].previous_output);
8039 assert_ne!(node_txn[0].input[0].previous_output, node_txn[2].input[0].previous_output);
8040 assert_ne!(node_txn[1].input[0].previous_output, node_txn[2].input[0].previous_output);
8042 assert_eq!(node_txn[0].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
8043 assert_eq!(node_txn[1].input[0].previous_output, revoked_htlc_txn[2].input[0].previous_output);
8045 // node_txn[3] is the local commitment tx broadcast just because (and somewhat in case of
8046 // reorgs, though its not clear its ever worth broadcasting conflicting txn like this when
8047 // a remote commitment tx has already been confirmed).
8048 check_spends!(node_txn[3], chan.3);
8050 // node_txn[4] spends the revoked outputs from the revoked_htlc_txn (which only have one
8051 // output, checked above).
8052 assert_eq!(node_txn[4].input.len(), 2);
8053 assert_eq!(node_txn[4].output.len(), 1);
8054 check_spends!(node_txn[4], revoked_htlc_txn[0], revoked_htlc_txn[2]);
8056 first = node_txn[4].txid();
8057 // Store both feerates for later comparison
8058 let fee_1 = revoked_htlc_txn[0].output[0].value + revoked_htlc_txn[2].output[0].value - node_txn[4].output[0].value;
8059 feerate_1 = fee_1 * 1000 / node_txn[4].get_weight() as u64;
8060 penalty_txn = vec![node_txn[2].clone()];
8064 // Connect one more block to see if bumped penalty are issued for HTLC txn
8065 let header_130 = BlockHeader { version: 0x20000000, prev_blockhash: header_129.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8066 connect_block(&nodes[0], &Block { header: header_130, txdata: penalty_txn });
8067 let header_131 = BlockHeader { version: 0x20000000, prev_blockhash: header_130.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8068 connect_block(&nodes[0], &Block { header: header_131, txdata: Vec::new() });
8070 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8071 assert_eq!(node_txn.len(), 2); // 2 bumped penalty txn on revoked commitment tx
8073 check_spends!(node_txn[0], revoked_local_txn[0]);
8074 check_spends!(node_txn[1], revoked_local_txn[0]);
8075 // Note that these are both bogus - they spend outputs already claimed in block 129:
8076 if node_txn[0].input[0].previous_output == revoked_htlc_txn[0].input[0].previous_output {
8077 assert_eq!(node_txn[1].input[0].previous_output, revoked_htlc_txn[2].input[0].previous_output);
8079 assert_eq!(node_txn[0].input[0].previous_output, revoked_htlc_txn[2].input[0].previous_output);
8080 assert_eq!(node_txn[1].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
8086 // Few more blocks to confirm penalty txn
8087 connect_blocks(&nodes[0], 4);
8088 assert!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
8089 let header_144 = connect_blocks(&nodes[0], 9);
8091 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8092 assert_eq!(node_txn.len(), 1);
8094 assert_eq!(node_txn[0].input.len(), 2);
8095 check_spends!(node_txn[0], revoked_htlc_txn[0], revoked_htlc_txn[2]);
8096 // Verify bumped tx is different and 25% bump heuristic
8097 assert_ne!(first, node_txn[0].txid());
8098 let fee_2 = revoked_htlc_txn[0].output[0].value + revoked_htlc_txn[2].output[0].value - node_txn[0].output[0].value;
8099 let feerate_2 = fee_2 * 1000 / node_txn[0].get_weight() as u64;
8100 assert!(feerate_2 * 100 > feerate_1 * 125);
8101 let txn = vec![node_txn[0].clone()];
8105 // Broadcast claim txn and confirm blocks to avoid further bumps on this outputs
8106 let header_145 = BlockHeader { version: 0x20000000, prev_blockhash: header_144, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8107 connect_block(&nodes[0], &Block { header: header_145, txdata: node_txn });
8108 connect_blocks(&nodes[0], 20);
8110 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8111 // We verify than no new transaction has been broadcast because previously
8112 // we were buggy on this exact behavior by not tracking for monitoring remote HTLC outputs (see #411)
8113 // which means we wouldn't see a spend of them by a justice tx and bumped justice tx
8114 // were generated forever instead of safe cleaning after confirmation and ANTI_REORG_SAFE_DELAY blocks.
8115 // Enforce spending of revoked htlc output by claiming transaction remove request as expected and dry
8116 // up bumped justice generation.
8117 assert_eq!(node_txn.len(), 0);
8120 check_closed_broadcast!(nodes[0], true);
8121 check_added_monitors!(nodes[0], 1);
8125 fn test_bump_penalty_txn_on_remote_commitment() {
8126 // In case of claim txn with too low feerates for getting into mempools, RBF-bump them to be sure
8127 // we're able to claim outputs on remote commitment transaction before timelocks expiration
8130 // Provide preimage for one
8131 // Check aggregation
8133 let chanmon_cfgs = create_chanmon_cfgs(2);
8134 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8135 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8136 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8138 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
8139 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
8140 route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000).0;
8142 // Remote commitment txn with 4 outputs : to_local, to_remote, 1 outgoing HTLC, 1 incoming HTLC
8143 let remote_txn = get_local_commitment_txn!(nodes[0], chan.2);
8144 assert_eq!(remote_txn[0].output.len(), 4);
8145 assert_eq!(remote_txn[0].input.len(), 1);
8146 assert_eq!(remote_txn[0].input[0].previous_output.txid, chan.3.txid());
8148 // Claim a HTLC without revocation (provide B monitor with preimage)
8149 nodes[1].node.claim_funds(payment_preimage);
8150 mine_transaction(&nodes[1], &remote_txn[0]);
8151 check_added_monitors!(nodes[1], 2);
8152 connect_blocks(&nodes[1], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
8154 // One or more claim tx should have been broadcast, check it
8158 let feerate_timeout;
8159 let feerate_preimage;
8161 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8162 // 9 transactions including:
8163 // 1*2 ChannelManager local broadcasts of commitment + HTLC-Success
8164 // 1*3 ChannelManager local broadcasts of commitment + HTLC-Success + HTLC-Timeout
8165 // 2 * HTLC-Success (one RBF bump we'll check later)
8167 assert_eq!(node_txn.len(), 8);
8168 assert_eq!(node_txn[0].input.len(), 1);
8169 assert_eq!(node_txn[6].input.len(), 1);
8170 check_spends!(node_txn[0], remote_txn[0]);
8171 check_spends!(node_txn[6], remote_txn[0]);
8172 assert_eq!(node_txn[0].input[0].previous_output, node_txn[3].input[0].previous_output);
8173 preimage_bump = node_txn[3].clone();
8175 check_spends!(node_txn[1], chan.3);
8176 check_spends!(node_txn[2], node_txn[1]);
8177 assert_eq!(node_txn[1], node_txn[4]);
8178 assert_eq!(node_txn[2], node_txn[5]);
8180 timeout = node_txn[6].txid();
8181 let index = node_txn[6].input[0].previous_output.vout;
8182 let fee = remote_txn[0].output[index as usize].value - node_txn[6].output[0].value;
8183 feerate_timeout = fee * 1000 / node_txn[6].get_weight() as u64;
8185 preimage = node_txn[0].txid();
8186 let index = node_txn[0].input[0].previous_output.vout;
8187 let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
8188 feerate_preimage = fee * 1000 / node_txn[0].get_weight() as u64;
8192 assert_ne!(feerate_timeout, 0);
8193 assert_ne!(feerate_preimage, 0);
8195 // After exhaustion of height timer, new bumped claim txn should have been broadcast, check it
8196 connect_blocks(&nodes[1], 15);
8198 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8199 assert_eq!(node_txn.len(), 1);
8200 assert_eq!(node_txn[0].input.len(), 1);
8201 assert_eq!(preimage_bump.input.len(), 1);
8202 check_spends!(node_txn[0], remote_txn[0]);
8203 check_spends!(preimage_bump, remote_txn[0]);
8205 let index = preimage_bump.input[0].previous_output.vout;
8206 let fee = remote_txn[0].output[index as usize].value - preimage_bump.output[0].value;
8207 let new_feerate = fee * 1000 / preimage_bump.get_weight() as u64;
8208 assert!(new_feerate * 100 > feerate_timeout * 125);
8209 assert_ne!(timeout, preimage_bump.txid());
8211 let index = node_txn[0].input[0].previous_output.vout;
8212 let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
8213 let new_feerate = fee * 1000 / node_txn[0].get_weight() as u64;
8214 assert!(new_feerate * 100 > feerate_preimage * 125);
8215 assert_ne!(preimage, node_txn[0].txid());
8220 nodes[1].node.get_and_clear_pending_events();
8221 nodes[1].node.get_and_clear_pending_msg_events();
8225 fn test_counterparty_raa_skip_no_crash() {
8226 // Previously, if our counterparty sent two RAAs in a row without us having provided a
8227 // commitment transaction, we would have happily carried on and provided them the next
8228 // commitment transaction based on one RAA forward. This would probably eventually have led to
8229 // channel closure, but it would not have resulted in funds loss. Still, our
8230 // EnforcingSigner would have panicked as it doesn't like jumps into the future. Here, we
8231 // check simply that the channel is closed in response to such an RAA, but don't check whether
8232 // we decide to punish our counterparty for revoking their funds (as we don't currently
8234 let chanmon_cfgs = create_chanmon_cfgs(2);
8235 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8236 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8237 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8238 let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).2;
8240 let mut guard = nodes[0].node.channel_state.lock().unwrap();
8241 let keys = guard.by_id.get_mut(&channel_id).unwrap().get_signer();
8243 const INITIAL_COMMITMENT_NUMBER: u64 = (1 << 48) - 1;
8245 // Make signer believe we got a counterparty signature, so that it allows the revocation
8246 keys.get_enforcement_state().last_holder_commitment -= 1;
8247 let per_commitment_secret = keys.release_commitment_secret(INITIAL_COMMITMENT_NUMBER);
8249 // Must revoke without gaps
8250 keys.get_enforcement_state().last_holder_commitment -= 1;
8251 keys.release_commitment_secret(INITIAL_COMMITMENT_NUMBER - 1);
8253 keys.get_enforcement_state().last_holder_commitment -= 1;
8254 let next_per_commitment_point = PublicKey::from_secret_key(&Secp256k1::new(),
8255 &SecretKey::from_slice(&keys.release_commitment_secret(INITIAL_COMMITMENT_NUMBER - 2)).unwrap());
8257 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(),
8258 &msgs::RevokeAndACK { channel_id, per_commitment_secret, next_per_commitment_point });
8259 assert_eq!(check_closed_broadcast!(nodes[1], true).unwrap().data, "Received an unexpected revoke_and_ack");
8260 check_added_monitors!(nodes[1], 1);
8261 check_closed_event!(nodes[1], 1, ClosureReason::ProcessingError { err: "Received an unexpected revoke_and_ack".to_string() });
8265 fn test_bump_txn_sanitize_tracking_maps() {
8266 // Sanitizing pendning_claim_request and claimable_outpoints used to be buggy,
8267 // verify we clean then right after expiration of ANTI_REORG_DELAY.
8269 let chanmon_cfgs = create_chanmon_cfgs(2);
8270 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8271 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8272 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8274 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
8275 // Lock HTLC in both directions
8276 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000).0;
8277 route_payment(&nodes[1], &vec!(&nodes[0])[..], 9_000_000).0;
8279 let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan.2);
8280 assert_eq!(revoked_local_txn[0].input.len(), 1);
8281 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
8283 // Revoke local commitment tx
8284 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
8286 // Broadcast set of revoked txn on A
8287 connect_blocks(&nodes[0], TEST_FINAL_CLTV + 2 - CHAN_CONFIRM_DEPTH);
8288 expect_pending_htlcs_forwardable_ignore!(nodes[0]);
8289 assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 0);
8291 mine_transaction(&nodes[0], &revoked_local_txn[0]);
8292 check_closed_broadcast!(nodes[0], true);
8293 check_added_monitors!(nodes[0], 1);
8294 check_closed_event!(nodes[0], 1, ClosureReason::CommitmentTxConfirmed);
8296 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8297 assert_eq!(node_txn.len(), 4); //ChannelMonitor: justice txn * 3, ChannelManager: local commitment tx
8298 check_spends!(node_txn[0], revoked_local_txn[0]);
8299 check_spends!(node_txn[1], revoked_local_txn[0]);
8300 check_spends!(node_txn[2], revoked_local_txn[0]);
8301 let penalty_txn = vec![node_txn[0].clone(), node_txn[1].clone(), node_txn[2].clone()];
8305 let header_130 = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8306 connect_block(&nodes[0], &Block { header: header_130, txdata: penalty_txn });
8307 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
8309 let monitors = nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap();
8310 if let Some(monitor) = monitors.get(&OutPoint { txid: chan.3.txid(), index: 0 }) {
8311 assert!(monitor.inner.lock().unwrap().onchain_tx_handler.pending_claim_requests.is_empty());
8312 assert!(monitor.inner.lock().unwrap().onchain_tx_handler.claimable_outpoints.is_empty());
8318 fn test_override_channel_config() {
8319 let chanmon_cfgs = create_chanmon_cfgs(2);
8320 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8321 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8322 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8324 // Node0 initiates a channel to node1 using the override config.
8325 let mut override_config = UserConfig::default();
8326 override_config.own_channel_config.our_to_self_delay = 200;
8328 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 16_000_000, 12_000_000, 42, Some(override_config)).unwrap();
8330 // Assert the channel created by node0 is using the override config.
8331 let res = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8332 assert_eq!(res.channel_flags, 0);
8333 assert_eq!(res.to_self_delay, 200);
8337 fn test_override_0msat_htlc_minimum() {
8338 let mut zero_config = UserConfig::default();
8339 zero_config.own_channel_config.our_htlc_minimum_msat = 0;
8340 let chanmon_cfgs = create_chanmon_cfgs(2);
8341 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8342 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, Some(zero_config.clone())]);
8343 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8345 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 16_000_000, 12_000_000, 42, Some(zero_config)).unwrap();
8346 let res = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8347 assert_eq!(res.htlc_minimum_msat, 1);
8349 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &res);
8350 let res = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
8351 assert_eq!(res.htlc_minimum_msat, 1);
8355 fn test_simple_mpp() {
8356 // Simple test of sending a multi-path payment.
8357 let chanmon_cfgs = create_chanmon_cfgs(4);
8358 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
8359 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
8360 let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
8362 let chan_1_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8363 let chan_2_id = create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8364 let chan_3_id = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8365 let chan_4_id = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8366 let logger = test_utils::TestLogger::new();
8368 let (payment_preimage, payment_hash, payment_secret) = get_payment_preimage_hash!(&nodes[3]);
8369 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
8370 let mut route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[3].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
8371 let path = route.paths[0].clone();
8372 route.paths.push(path);
8373 route.paths[0][0].pubkey = nodes[1].node.get_our_node_id();
8374 route.paths[0][0].short_channel_id = chan_1_id;
8375 route.paths[0][1].short_channel_id = chan_3_id;
8376 route.paths[1][0].pubkey = nodes[2].node.get_our_node_id();
8377 route.paths[1][0].short_channel_id = chan_2_id;
8378 route.paths[1][1].short_channel_id = chan_4_id;
8379 send_along_route_with_secret(&nodes[0], route, &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], 200_000, payment_hash, payment_secret);
8380 claim_payment_along_route(&nodes[0], &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], false, payment_preimage);
8384 fn test_preimage_storage() {
8385 // Simple test of payment preimage storage allowing no client-side storage to claim payments
8386 let chanmon_cfgs = create_chanmon_cfgs(2);
8387 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8388 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8389 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8391 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8394 let (payment_hash, payment_secret) = nodes[1].node.create_inbound_payment(Some(100_000), 7200, 42);
8396 let logger = test_utils::TestLogger::new();
8397 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
8398 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100_000, TEST_FINAL_CLTV, &logger).unwrap();
8399 nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
8400 check_added_monitors!(nodes[0], 1);
8401 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
8402 let mut payment_event = SendEvent::from_event(events.pop().unwrap());
8403 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
8404 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
8406 // Note that after leaving the above scope we have no knowledge of any arguments or return
8407 // values from previous calls.
8408 expect_pending_htlcs_forwardable!(nodes[1]);
8409 let events = nodes[1].node.get_and_clear_pending_events();
8410 assert_eq!(events.len(), 1);
8412 Event::PaymentReceived { ref purpose, .. } => {
8414 PaymentPurpose::InvoicePayment { payment_preimage, user_payment_id, .. } => {
8415 assert_eq!(*user_payment_id, 42);
8416 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage.unwrap());
8418 _ => panic!("expected PaymentPurpose::InvoicePayment")
8421 _ => panic!("Unexpected event"),
8426 fn test_secret_timeout() {
8427 // Simple test of payment secret storage time outs
8428 let chanmon_cfgs = create_chanmon_cfgs(2);
8429 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8430 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8431 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8433 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8435 let (payment_hash, payment_secret_1) = nodes[1].node.create_inbound_payment(Some(100_000), 2, 0);
8437 // We should fail to register the same payment hash twice, at least until we've connected a
8438 // block with time 7200 + CHAN_CONFIRM_DEPTH + 1.
8439 if let Err(APIError::APIMisuseError { err }) = nodes[1].node.create_inbound_payment_for_hash(payment_hash, Some(100_000), 2, 0) {
8440 assert_eq!(err, "Duplicate payment hash");
8441 } else { panic!(); }
8443 let node_1_blocks = nodes[1].blocks.lock().unwrap();
8445 header: BlockHeader {
8447 prev_blockhash: node_1_blocks.last().unwrap().0.block_hash(),
8448 merkle_root: Default::default(),
8449 time: node_1_blocks.len() as u32 + 7200, bits: 42, nonce: 42 },
8453 connect_block(&nodes[1], &block);
8454 if let Err(APIError::APIMisuseError { err }) = nodes[1].node.create_inbound_payment_for_hash(payment_hash, Some(100_000), 2, 0) {
8455 assert_eq!(err, "Duplicate payment hash");
8456 } else { panic!(); }
8458 // If we then connect the second block, we should be able to register the same payment hash
8459 // again with a different user_payment_id (this time getting a new payment secret).
8460 block.header.prev_blockhash = block.header.block_hash();
8461 block.header.time += 1;
8462 connect_block(&nodes[1], &block);
8463 let our_payment_secret = nodes[1].node.create_inbound_payment_for_hash(payment_hash, Some(100_000), 2, 42).unwrap();
8464 assert_ne!(payment_secret_1, our_payment_secret);
8467 let logger = test_utils::TestLogger::new();
8468 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
8469 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100_000, TEST_FINAL_CLTV, &logger).unwrap();
8470 nodes[0].node.send_payment(&route, payment_hash, &Some(our_payment_secret)).unwrap();
8471 check_added_monitors!(nodes[0], 1);
8472 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
8473 let mut payment_event = SendEvent::from_event(events.pop().unwrap());
8474 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
8475 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
8477 // Note that after leaving the above scope we have no knowledge of any arguments or return
8478 // values from previous calls.
8479 expect_pending_htlcs_forwardable!(nodes[1]);
8480 let events = nodes[1].node.get_and_clear_pending_events();
8481 assert_eq!(events.len(), 1);
8483 Event::PaymentReceived { purpose: PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, user_payment_id }, .. } => {
8484 assert!(payment_preimage.is_none());
8485 assert_eq!(user_payment_id, 42);
8486 assert_eq!(payment_secret, our_payment_secret);
8487 // We don't actually have the payment preimage with which to claim this payment!
8489 _ => panic!("Unexpected event"),
8494 fn test_bad_secret_hash() {
8495 // Simple test of unregistered payment hash/invalid payment secret handling
8496 let chanmon_cfgs = create_chanmon_cfgs(2);
8497 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8498 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8499 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8501 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8503 let random_payment_hash = PaymentHash([42; 32]);
8504 let random_payment_secret = PaymentSecret([43; 32]);
8505 let (our_payment_hash, our_payment_secret) = nodes[1].node.create_inbound_payment(Some(100_000), 2, 0);
8507 let logger = test_utils::TestLogger::new();
8508 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
8509 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100_000, TEST_FINAL_CLTV, &logger).unwrap();
8511 // All the below cases should end up being handled exactly identically, so we macro the
8512 // resulting events.
8513 macro_rules! handle_unknown_invalid_payment_data {
8515 check_added_monitors!(nodes[0], 1);
8516 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
8517 let payment_event = SendEvent::from_event(events.pop().unwrap());
8518 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
8519 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
8521 // We have to forward pending HTLCs once to process the receipt of the HTLC and then
8522 // again to process the pending backwards-failure of the HTLC
8523 expect_pending_htlcs_forwardable!(nodes[1]);
8524 expect_pending_htlcs_forwardable!(nodes[1]);
8525 check_added_monitors!(nodes[1], 1);
8527 // We should fail the payment back
8528 let mut events = nodes[1].node.get_and_clear_pending_msg_events();
8529 match events.pop().unwrap() {
8530 MessageSendEvent::UpdateHTLCs { node_id: _, updates: msgs::CommitmentUpdate { update_fail_htlcs, commitment_signed, .. } } => {
8531 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
8532 commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false);
8534 _ => panic!("Unexpected event"),
8539 let expected_error_code = 0x4000|15; // incorrect_or_unknown_payment_details
8540 // Error data is the HTLC value (100,000) and current block height
8541 let expected_error_data = [0, 0, 0, 0, 0, 1, 0x86, 0xa0, 0, 0, 0, CHAN_CONFIRM_DEPTH as u8];
8543 // Send a payment with the right payment hash but the wrong payment secret
8544 nodes[0].node.send_payment(&route, our_payment_hash, &Some(random_payment_secret)).unwrap();
8545 handle_unknown_invalid_payment_data!();
8546 expect_payment_failed!(nodes[0], our_payment_hash, true, expected_error_code, expected_error_data);
8548 // Send a payment with a random payment hash, but the right payment secret
8549 nodes[0].node.send_payment(&route, random_payment_hash, &Some(our_payment_secret)).unwrap();
8550 handle_unknown_invalid_payment_data!();
8551 expect_payment_failed!(nodes[0], random_payment_hash, true, expected_error_code, expected_error_data);
8553 // Send a payment with a random payment hash and random payment secret
8554 nodes[0].node.send_payment(&route, random_payment_hash, &Some(random_payment_secret)).unwrap();
8555 handle_unknown_invalid_payment_data!();
8556 expect_payment_failed!(nodes[0], random_payment_hash, true, expected_error_code, expected_error_data);
8560 fn test_update_err_monitor_lockdown() {
8561 // Our monitor will lock update of local commitment transaction if a broadcastion condition
8562 // has been fulfilled (either force-close from Channel or block height requiring a HTLC-
8563 // timeout). Trying to update monitor after lockdown should return a ChannelMonitorUpdateErr.
8565 // This scenario may happen in a watchtower setup, where watchtower process a block height
8566 // triggering a timeout while a slow-block-processing ChannelManager receives a local signed
8567 // commitment at same time.
8569 let chanmon_cfgs = create_chanmon_cfgs(2);
8570 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8571 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8572 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8574 // Create some initial channel
8575 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
8576 let outpoint = OutPoint { txid: chan_1.3.txid(), index: 0 };
8578 // Rebalance the network to generate htlc in the two directions
8579 send_payment(&nodes[0], &vec!(&nodes[1])[..], 10_000_000);
8581 // Route a HTLC from node 0 to node 1 (but don't settle)
8582 let preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000).0;
8584 // Copy ChainMonitor to simulate a watchtower and update block height of node 0 until its ChannelMonitor timeout HTLC onchain
8585 let chain_source = test_utils::TestChainSource::new(Network::Testnet);
8586 let logger = test_utils::TestLogger::with_id(format!("node {}", 0));
8587 let persister = test_utils::TestPersister::new();
8589 let monitors = nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap();
8590 let monitor = monitors.get(&outpoint).unwrap();
8591 let mut w = test_utils::TestVecWriter(Vec::new());
8592 monitor.write(&mut w).unwrap();
8593 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingSigner>)>::read(
8594 &mut io::Cursor::new(&w.0), &test_utils::OnlyReadsKeysInterface {}).unwrap().1;
8595 assert!(new_monitor == *monitor);
8596 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);
8597 assert!(watchtower.watch_channel(outpoint, new_monitor).is_ok());
8600 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8601 // Make the tx_broadcaster aware of enough blocks that it doesn't think we're violating
8602 // transaction lock time requirements here.
8603 chanmon_cfgs[0].tx_broadcaster.blocks.lock().unwrap().resize(200, (header, 0));
8604 watchtower.chain_monitor.block_connected(&Block { header, txdata: vec![] }, 200);
8606 // Try to update ChannelMonitor
8607 assert!(nodes[1].node.claim_funds(preimage));
8608 check_added_monitors!(nodes[1], 1);
8609 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
8610 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
8611 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
8612 if let Some(ref mut channel) = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan_1.2) {
8613 if let Ok((_, _, update)) = channel.commitment_signed(&updates.commitment_signed, &node_cfgs[0].logger) {
8614 if let Err(_) = watchtower.chain_monitor.update_channel(outpoint, update.clone()) {} else { assert!(false); }
8615 if let Ok(_) = nodes[0].chain_monitor.update_channel(outpoint, update) {} else { assert!(false); }
8616 } else { assert!(false); }
8617 } else { assert!(false); };
8618 // Our local monitor is in-sync and hasn't processed yet timeout
8619 check_added_monitors!(nodes[0], 1);
8620 let events = nodes[0].node.get_and_clear_pending_events();
8621 assert_eq!(events.len(), 1);
8625 fn test_concurrent_monitor_claim() {
8626 // Watchtower A receives block, broadcasts state N, then channel receives new state N+1,
8627 // sending it to both watchtowers, Bob accepts N+1, then receives block and broadcasts
8628 // the latest state N+1, Alice rejects state N+1, but Bob has already broadcast it,
8629 // state N+1 confirms. Alice claims output from state N+1.
8631 let chanmon_cfgs = create_chanmon_cfgs(2);
8632 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8633 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8634 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8636 // Create some initial channel
8637 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
8638 let outpoint = OutPoint { txid: chan_1.3.txid(), index: 0 };
8640 // Rebalance the network to generate htlc in the two directions
8641 send_payment(&nodes[0], &vec!(&nodes[1])[..], 10_000_000);
8643 // Route a HTLC from node 0 to node 1 (but don't settle)
8644 route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000).0;
8646 // Copy ChainMonitor to simulate watchtower Alice and update block height her ChannelMonitor timeout HTLC onchain
8647 let chain_source = test_utils::TestChainSource::new(Network::Testnet);
8648 let logger = test_utils::TestLogger::with_id(format!("node {}", "Alice"));
8649 let persister = test_utils::TestPersister::new();
8650 let watchtower_alice = {
8651 let monitors = nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap();
8652 let monitor = monitors.get(&outpoint).unwrap();
8653 let mut w = test_utils::TestVecWriter(Vec::new());
8654 monitor.write(&mut w).unwrap();
8655 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingSigner>)>::read(
8656 &mut io::Cursor::new(&w.0), &test_utils::OnlyReadsKeysInterface {}).unwrap().1;
8657 assert!(new_monitor == *monitor);
8658 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);
8659 assert!(watchtower.watch_channel(outpoint, new_monitor).is_ok());
8662 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8663 // Make the tx_broadcaster aware of enough blocks that it doesn't think we're violating
8664 // transaction lock time requirements here.
8665 chanmon_cfgs[0].tx_broadcaster.blocks.lock().unwrap().resize((CHAN_CONFIRM_DEPTH + 1 + TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS) as usize, (header, 0));
8666 watchtower_alice.chain_monitor.block_connected(&Block { header, txdata: vec![] }, CHAN_CONFIRM_DEPTH + 1 + TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS);
8668 // Watchtower Alice should have broadcast a commitment/HTLC-timeout
8670 let mut txn = chanmon_cfgs[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8671 assert_eq!(txn.len(), 2);
8675 // Copy ChainMonitor to simulate watchtower Bob and make it receive a commitment update first.
8676 let chain_source = test_utils::TestChainSource::new(Network::Testnet);
8677 let logger = test_utils::TestLogger::with_id(format!("node {}", "Bob"));
8678 let persister = test_utils::TestPersister::new();
8679 let watchtower_bob = {
8680 let monitors = nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap();
8681 let monitor = monitors.get(&outpoint).unwrap();
8682 let mut w = test_utils::TestVecWriter(Vec::new());
8683 monitor.write(&mut w).unwrap();
8684 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingSigner>)>::read(
8685 &mut io::Cursor::new(&w.0), &test_utils::OnlyReadsKeysInterface {}).unwrap().1;
8686 assert!(new_monitor == *monitor);
8687 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);
8688 assert!(watchtower.watch_channel(outpoint, new_monitor).is_ok());
8691 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8692 watchtower_bob.chain_monitor.block_connected(&Block { header, txdata: vec![] }, CHAN_CONFIRM_DEPTH + TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS);
8694 // Route another payment to generate another update with still previous HTLC pending
8695 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[0]);
8697 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
8698 let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[0].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 3000000 , TEST_FINAL_CLTV, &logger).unwrap();
8699 nodes[1].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
8701 check_added_monitors!(nodes[1], 1);
8703 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
8704 assert_eq!(updates.update_add_htlcs.len(), 1);
8705 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &updates.update_add_htlcs[0]);
8706 if let Some(ref mut channel) = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan_1.2) {
8707 if let Ok((_, _, update)) = channel.commitment_signed(&updates.commitment_signed, &node_cfgs[0].logger) {
8708 // Watchtower Alice should already have seen the block and reject the update
8709 if let Err(_) = watchtower_alice.chain_monitor.update_channel(outpoint, update.clone()) {} else { assert!(false); }
8710 if let Ok(_) = watchtower_bob.chain_monitor.update_channel(outpoint, update.clone()) {} else { assert!(false); }
8711 if let Ok(_) = nodes[0].chain_monitor.update_channel(outpoint, update) {} else { assert!(false); }
8712 } else { assert!(false); }
8713 } else { assert!(false); };
8714 // Our local monitor is in-sync and hasn't processed yet timeout
8715 check_added_monitors!(nodes[0], 1);
8717 //// Provide one more block to watchtower Bob, expect broadcast of commitment and HTLC-Timeout
8718 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8719 watchtower_bob.chain_monitor.block_connected(&Block { header, txdata: vec![] }, CHAN_CONFIRM_DEPTH + 1 + TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS);
8721 // Watchtower Bob should have broadcast a commitment/HTLC-timeout
8724 let mut txn = chanmon_cfgs[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8725 assert_eq!(txn.len(), 2);
8726 bob_state_y = txn[0].clone();
8730 // We confirm Bob's state Y on Alice, she should broadcast a HTLC-timeout
8731 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8732 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);
8734 let htlc_txn = chanmon_cfgs[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8735 // We broadcast twice the transaction, once due to the HTLC-timeout, once due
8736 // the onchain detection of the HTLC output
8737 assert_eq!(htlc_txn.len(), 2);
8738 check_spends!(htlc_txn[0], bob_state_y);
8739 check_spends!(htlc_txn[1], bob_state_y);
8744 fn test_pre_lockin_no_chan_closed_update() {
8745 // Test that if a peer closes a channel in response to a funding_created message we don't
8746 // generate a channel update (as the channel cannot appear on chain without a funding_signed
8749 // Doing so would imply a channel monitor update before the initial channel monitor
8750 // registration, violating our API guarantees.
8752 // Previously, full_stack_target managed to hit this case by opening then closing a channel,
8753 // then opening a second channel with the same funding output as the first (which is not
8754 // rejected because the first channel does not exist in the ChannelManager) and closing it
8755 // before receiving funding_signed.
8756 let chanmon_cfgs = create_chanmon_cfgs(2);
8757 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8758 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8759 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8761 // Create an initial channel
8762 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
8763 let mut open_chan_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8764 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_msg);
8765 let accept_chan_msg = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
8766 nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &accept_chan_msg);
8768 // Move the first channel through the funding flow...
8769 let (temporary_channel_id, tx, _) = create_funding_transaction(&nodes[0], 100000, 42);
8771 nodes[0].node.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
8772 check_added_monitors!(nodes[0], 0);
8774 let funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
8775 let channel_id = ::chain::transaction::OutPoint { txid: funding_created_msg.funding_txid, index: funding_created_msg.funding_output_index }.to_channel_id();
8776 nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msgs::ErrorMessage { channel_id, data: "Hi".to_owned() });
8777 assert!(nodes[0].chain_monitor.added_monitors.lock().unwrap().is_empty());
8778 check_closed_event!(nodes[0], 1, ClosureReason::CounterpartyForceClosed { peer_msg: "Hi".to_string() });
8782 fn test_htlc_no_detection() {
8783 // This test is a mutation to underscore the detection logic bug we had
8784 // before #653. HTLC value routed is above the remaining balance, thus
8785 // inverting HTLC and `to_remote` output. HTLC will come second and
8786 // it wouldn't be seen by pre-#653 detection as we were enumerate()'ing
8787 // on a watched outputs vector (Vec<TxOut>) thus implicitly relying on
8788 // outputs order detection for correct spending children filtring.
8790 let chanmon_cfgs = create_chanmon_cfgs(2);
8791 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8792 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8793 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8795 // Create some initial channels
8796 let chan_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
8798 send_payment(&nodes[0], &vec!(&nodes[1])[..], 1_000_000);
8799 let (_, our_payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 2_000_000);
8800 let local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
8801 assert_eq!(local_txn[0].input.len(), 1);
8802 assert_eq!(local_txn[0].output.len(), 3);
8803 check_spends!(local_txn[0], chan_1.3);
8805 // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
8806 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8807 connect_block(&nodes[0], &Block { header, txdata: vec![local_txn[0].clone()] });
8808 // We deliberately connect the local tx twice as this should provoke a failure calling
8809 // this test before #653 fix.
8810 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);
8811 check_closed_broadcast!(nodes[0], true);
8812 check_added_monitors!(nodes[0], 1);
8813 check_closed_event!(nodes[0], 1, ClosureReason::CommitmentTxConfirmed);
8814 connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1);
8816 let htlc_timeout = {
8817 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8818 assert_eq!(node_txn[1].input.len(), 1);
8819 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
8820 check_spends!(node_txn[1], local_txn[0]);
8824 let header_201 = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8825 connect_block(&nodes[0], &Block { header: header_201, txdata: vec![htlc_timeout.clone()] });
8826 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
8827 expect_payment_failed!(nodes[0], our_payment_hash, true);
8830 fn do_test_onchain_htlc_settlement_after_close(broadcast_alice: bool, go_onchain_before_fulfill: bool) {
8831 // If we route an HTLC, then learn the HTLC's preimage after the upstream channel has been
8832 // force-closed, we must claim that HTLC on-chain. (Given an HTLC forwarded from Alice --> Bob -->
8833 // Carol, Alice would be the upstream node, and Carol the downstream.)
8835 // Steps of the test:
8836 // 1) Alice sends a HTLC to Carol through Bob.
8837 // 2) Carol doesn't settle the HTLC.
8838 // 3) If broadcast_alice is true, Alice force-closes her channel with Bob. Else Bob force closes.
8839 // Steps 4 and 5 may be reordered depending on go_onchain_before_fulfill.
8840 // 4) Bob sees the Alice's commitment on his chain or vice versa. An offered output is present
8841 // but can't be claimed as Bob doesn't have yet knowledge of the preimage.
8842 // 5) Carol release the preimage to Bob off-chain.
8843 // 6) Bob claims the offered output on the broadcasted commitment.
8844 let chanmon_cfgs = create_chanmon_cfgs(3);
8845 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
8846 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
8847 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
8849 // Create some initial channels
8850 let chan_ab = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
8851 create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 100000, 10001, InitFeatures::known(), InitFeatures::known());
8853 // Steps (1) and (2):
8854 // Send an HTLC Alice --> Bob --> Carol, but Carol doesn't settle the HTLC back.
8855 let (payment_preimage, _payment_hash, _payment_secret) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3_000_000);
8857 // Check that Alice's commitment transaction now contains an output for this HTLC.
8858 let alice_txn = get_local_commitment_txn!(nodes[0], chan_ab.2);
8859 check_spends!(alice_txn[0], chan_ab.3);
8860 assert_eq!(alice_txn[0].output.len(), 2);
8861 check_spends!(alice_txn[1], alice_txn[0]); // 2nd transaction is a non-final HTLC-timeout
8862 assert_eq!(alice_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
8863 assert_eq!(alice_txn.len(), 2);
8865 // Steps (3) and (4):
8866 // If `go_onchain_before_fufill`, broadcast the relevant commitment transaction and check that Bob
8867 // responds by (1) broadcasting a channel update and (2) adding a new ChannelMonitor.
8868 let mut force_closing_node = 0; // Alice force-closes
8869 if !broadcast_alice { force_closing_node = 1; } // Bob force-closes
8870 nodes[force_closing_node].node.force_close_channel(&chan_ab.2).unwrap();
8871 check_closed_broadcast!(nodes[force_closing_node], true);
8872 check_added_monitors!(nodes[force_closing_node], 1);
8873 check_closed_event!(nodes[force_closing_node], 1, ClosureReason::HolderForceClosed);
8874 if go_onchain_before_fulfill {
8875 let txn_to_broadcast = match broadcast_alice {
8876 true => alice_txn.clone(),
8877 false => get_local_commitment_txn!(nodes[1], chan_ab.2)
8879 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
8880 connect_block(&nodes[1], &Block { header, txdata: vec![txn_to_broadcast[0].clone()]});
8881 let mut bob_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8882 if broadcast_alice {
8883 check_closed_broadcast!(nodes[1], true);
8884 check_added_monitors!(nodes[1], 1);
8885 check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
8887 assert_eq!(bob_txn.len(), 1);
8888 check_spends!(bob_txn[0], chan_ab.3);
8892 // Carol then claims the funds and sends an update_fulfill message to Bob, and they go through the
8893 // process of removing the HTLC from their commitment transactions.
8894 assert!(nodes[2].node.claim_funds(payment_preimage));
8895 check_added_monitors!(nodes[2], 1);
8896 let carol_updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
8897 assert!(carol_updates.update_add_htlcs.is_empty());
8898 assert!(carol_updates.update_fail_htlcs.is_empty());
8899 assert!(carol_updates.update_fail_malformed_htlcs.is_empty());
8900 assert!(carol_updates.update_fee.is_none());
8901 assert_eq!(carol_updates.update_fulfill_htlcs.len(), 1);
8903 nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &carol_updates.update_fulfill_htlcs[0]);
8904 expect_payment_forwarded!(nodes[1], if go_onchain_before_fulfill || force_closing_node == 1 { None } else { Some(1000) }, false);
8905 // If Alice broadcasted but Bob doesn't know yet, here he prepares to tell her about the preimage.
8906 if !go_onchain_before_fulfill && broadcast_alice {
8907 let events = nodes[1].node.get_and_clear_pending_msg_events();
8908 assert_eq!(events.len(), 1);
8910 MessageSendEvent::UpdateHTLCs { ref node_id, .. } => {
8911 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
8913 _ => panic!("Unexpected event"),
8916 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &carol_updates.commitment_signed);
8917 // One monitor update for the preimage to update the Bob<->Alice channel, one monitor update
8918 // Carol<->Bob's updated commitment transaction info.
8919 check_added_monitors!(nodes[1], 2);
8921 let events = nodes[1].node.get_and_clear_pending_msg_events();
8922 assert_eq!(events.len(), 2);
8923 let bob_revocation = match events[0] {
8924 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
8925 assert_eq!(*node_id, nodes[2].node.get_our_node_id());
8928 _ => panic!("Unexpected event"),
8930 let bob_updates = match events[1] {
8931 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
8932 assert_eq!(*node_id, nodes[2].node.get_our_node_id());
8935 _ => panic!("Unexpected event"),
8938 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bob_revocation);
8939 check_added_monitors!(nodes[2], 1);
8940 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bob_updates.commitment_signed);
8941 check_added_monitors!(nodes[2], 1);
8943 let events = nodes[2].node.get_and_clear_pending_msg_events();
8944 assert_eq!(events.len(), 1);
8945 let carol_revocation = match events[0] {
8946 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
8947 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
8950 _ => panic!("Unexpected event"),
8952 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &carol_revocation);
8953 check_added_monitors!(nodes[1], 1);
8955 // If this test requires the force-closed channel to not be on-chain until after the fulfill,
8956 // here's where we put said channel's commitment tx on-chain.
8957 let mut txn_to_broadcast = alice_txn.clone();
8958 if !broadcast_alice { txn_to_broadcast = get_local_commitment_txn!(nodes[1], chan_ab.2); }
8959 if !go_onchain_before_fulfill {
8960 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
8961 connect_block(&nodes[1], &Block { header, txdata: vec![txn_to_broadcast[0].clone()]});
8962 // If Bob was the one to force-close, he will have already passed these checks earlier.
8963 if broadcast_alice {
8964 check_closed_broadcast!(nodes[1], true);
8965 check_added_monitors!(nodes[1], 1);
8966 check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
8968 let mut bob_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8969 if broadcast_alice {
8970 // In `connect_block()`, the ChainMonitor and ChannelManager are separately notified about a
8971 // new block being connected. The ChannelManager being notified triggers a monitor update,
8972 // which triggers broadcasting our commitment tx and an HTLC-claiming tx. The ChainMonitor
8973 // being notified triggers the HTLC-claiming tx redundantly, resulting in 3 total txs being
8975 assert_eq!(bob_txn.len(), 3);
8976 check_spends!(bob_txn[1], chan_ab.3);
8978 assert_eq!(bob_txn.len(), 2);
8979 check_spends!(bob_txn[0], chan_ab.3);
8984 // Finally, check that Bob broadcasted a preimage-claiming transaction for the HTLC output on the
8985 // broadcasted commitment transaction.
8987 let bob_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
8988 if go_onchain_before_fulfill {
8989 // Bob should now have an extra broadcasted tx, for the preimage-claiming transaction.
8990 assert_eq!(bob_txn.len(), 2);
8992 let script_weight = match broadcast_alice {
8993 true => OFFERED_HTLC_SCRIPT_WEIGHT,
8994 false => ACCEPTED_HTLC_SCRIPT_WEIGHT
8996 // If Alice force-closed and Bob didn't receive her commitment transaction until after he
8997 // received Carol's fulfill, he broadcasts the HTLC-output-claiming transaction first. Else if
8998 // Bob force closed or if he found out about Alice's commitment tx before receiving Carol's
8999 // fulfill, then he broadcasts the HTLC-output-claiming transaction second.
9000 if broadcast_alice && !go_onchain_before_fulfill {
9001 check_spends!(bob_txn[0], txn_to_broadcast[0]);
9002 assert_eq!(bob_txn[0].input[0].witness.last().unwrap().len(), script_weight);
9004 check_spends!(bob_txn[1], txn_to_broadcast[0]);
9005 assert_eq!(bob_txn[1].input[0].witness.last().unwrap().len(), script_weight);
9011 fn test_onchain_htlc_settlement_after_close() {
9012 do_test_onchain_htlc_settlement_after_close(true, true);
9013 do_test_onchain_htlc_settlement_after_close(false, true); // Technically redundant, but may as well
9014 do_test_onchain_htlc_settlement_after_close(true, false);
9015 do_test_onchain_htlc_settlement_after_close(false, false);
9019 fn test_duplicate_chan_id() {
9020 // Test that if a given peer tries to open a channel with the same channel_id as one that is
9021 // already open we reject it and keep the old channel.
9023 // Previously, full_stack_target managed to figure out that if you tried to open two channels
9024 // with the same funding output (ie post-funding channel_id), we'd create a monitor update for
9025 // the existing channel when we detect the duplicate new channel, screwing up our monitor
9026 // updating logic for the existing channel.
9027 let chanmon_cfgs = create_chanmon_cfgs(2);
9028 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
9029 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
9030 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
9032 // Create an initial channel
9033 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
9034 let mut open_chan_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
9035 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_msg);
9036 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()));
9038 // Try to create a second channel with the same temporary_channel_id as the first and check
9039 // that it is rejected.
9040 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_msg);
9042 let events = nodes[1].node.get_and_clear_pending_msg_events();
9043 assert_eq!(events.len(), 1);
9045 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
9046 // Technically, at this point, nodes[1] would be justified in thinking both the
9047 // first (valid) and second (invalid) channels are closed, given they both have
9048 // the same non-temporary channel_id. However, currently we do not, so we just
9049 // move forward with it.
9050 assert_eq!(msg.channel_id, open_chan_msg.temporary_channel_id);
9051 assert_eq!(node_id, nodes[0].node.get_our_node_id());
9053 _ => panic!("Unexpected event"),
9057 // Move the first channel through the funding flow...
9058 let (temporary_channel_id, tx, funding_output) = create_funding_transaction(&nodes[0], 100000, 42);
9060 nodes[0].node.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
9061 check_added_monitors!(nodes[0], 0);
9063 let mut funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
9064 nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created_msg);
9066 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
9067 assert_eq!(added_monitors.len(), 1);
9068 assert_eq!(added_monitors[0].0, funding_output);
9069 added_monitors.clear();
9071 let funding_signed_msg = get_event_msg!(nodes[1], MessageSendEvent::SendFundingSigned, nodes[0].node.get_our_node_id());
9073 let funding_outpoint = ::chain::transaction::OutPoint { txid: funding_created_msg.funding_txid, index: funding_created_msg.funding_output_index };
9074 let channel_id = funding_outpoint.to_channel_id();
9076 // Now we have the first channel past funding_created (ie it has a txid-based channel_id, not a
9079 // First try to open a second channel with a temporary channel id equal to the txid-based one.
9080 // Technically this is allowed by the spec, but we don't support it and there's little reason
9081 // to. Still, it shouldn't cause any other issues.
9082 open_chan_msg.temporary_channel_id = channel_id;
9083 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_msg);
9085 let events = nodes[1].node.get_and_clear_pending_msg_events();
9086 assert_eq!(events.len(), 1);
9088 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
9089 // Technically, at this point, nodes[1] would be justified in thinking both
9090 // channels are closed, but currently we do not, so we just move forward with it.
9091 assert_eq!(msg.channel_id, open_chan_msg.temporary_channel_id);
9092 assert_eq!(node_id, nodes[0].node.get_our_node_id());
9094 _ => panic!("Unexpected event"),
9098 // Now try to create a second channel which has a duplicate funding output.
9099 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
9100 let open_chan_2_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
9101 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_2_msg);
9102 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()));
9103 create_funding_transaction(&nodes[0], 100000, 42); // Get and check the FundingGenerationReady event
9105 let funding_created = {
9106 let mut a_channel_lock = nodes[0].node.channel_state.lock().unwrap();
9107 let mut as_chan = a_channel_lock.by_id.get_mut(&open_chan_2_msg.temporary_channel_id).unwrap();
9108 let logger = test_utils::TestLogger::new();
9109 as_chan.get_outbound_funding_created(tx.clone(), funding_outpoint, &&logger).unwrap()
9111 check_added_monitors!(nodes[0], 0);
9112 nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created);
9113 // At this point we'll try to add a duplicate channel monitor, which will be rejected, but
9114 // still needs to be cleared here.
9115 check_added_monitors!(nodes[1], 1);
9117 // ...still, nodes[1] will reject the duplicate channel.
9119 let events = nodes[1].node.get_and_clear_pending_msg_events();
9120 assert_eq!(events.len(), 1);
9122 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
9123 // Technically, at this point, nodes[1] would be justified in thinking both
9124 // channels are closed, but currently we do not, so we just move forward with it.
9125 assert_eq!(msg.channel_id, channel_id);
9126 assert_eq!(node_id, nodes[0].node.get_our_node_id());
9128 _ => panic!("Unexpected event"),
9132 // finally, finish creating the original channel and send a payment over it to make sure
9133 // everything is functional.
9134 nodes[0].node.handle_funding_signed(&nodes[1].node.get_our_node_id(), &funding_signed_msg);
9136 let mut added_monitors = nodes[0].chain_monitor.added_monitors.lock().unwrap();
9137 assert_eq!(added_monitors.len(), 1);
9138 assert_eq!(added_monitors[0].0, funding_output);
9139 added_monitors.clear();
9142 let events_4 = nodes[0].node.get_and_clear_pending_events();
9143 assert_eq!(events_4.len(), 0);
9144 assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
9145 assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0].txid(), funding_output.txid);
9147 let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
9148 let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
9149 update_nodes_with_chan_announce(&nodes, 0, 1, &announcement, &as_update, &bs_update);
9150 send_payment(&nodes[0], &[&nodes[1]], 8000000);
9154 fn test_error_chans_closed() {
9155 // Test that we properly handle error messages, closing appropriate channels.
9157 // Prior to #787 we'd allow a peer to make us force-close a channel we had with a different
9158 // peer. The "real" fix for that is to index channels with peers_ids, however in the mean time
9159 // we can test various edge cases around it to ensure we don't regress.
9160 let chanmon_cfgs = create_chanmon_cfgs(3);
9161 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
9162 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
9163 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
9165 // Create some initial channels
9166 let chan_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
9167 let chan_2 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
9168 let chan_3 = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 100000, 10001, InitFeatures::known(), InitFeatures::known());
9170 assert_eq!(nodes[0].node.list_usable_channels().len(), 3);
9171 assert_eq!(nodes[1].node.list_usable_channels().len(), 2);
9172 assert_eq!(nodes[2].node.list_usable_channels().len(), 1);
9174 // Closing a channel from a different peer has no effect
9175 nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msgs::ErrorMessage { channel_id: chan_3.2, data: "ERR".to_owned() });
9176 assert_eq!(nodes[0].node.list_usable_channels().len(), 3);
9178 // Closing one channel doesn't impact others
9179 nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msgs::ErrorMessage { channel_id: chan_2.2, data: "ERR".to_owned() });
9180 check_added_monitors!(nodes[0], 1);
9181 check_closed_broadcast!(nodes[0], false);
9182 check_closed_event!(nodes[0], 1, ClosureReason::CounterpartyForceClosed { peer_msg: "ERR".to_string() });
9183 assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0).len(), 1);
9184 assert_eq!(nodes[0].node.list_usable_channels().len(), 2);
9185 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);
9186 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);
9188 // A null channel ID should close all channels
9189 let _chan_4 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
9190 nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msgs::ErrorMessage { channel_id: [0; 32], data: "ERR".to_owned() });
9191 check_added_monitors!(nodes[0], 2);
9192 check_closed_event!(nodes[0], 2, ClosureReason::CounterpartyForceClosed { peer_msg: "ERR".to_string() });
9193 let events = nodes[0].node.get_and_clear_pending_msg_events();
9194 assert_eq!(events.len(), 2);
9196 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
9197 assert_eq!(msg.contents.flags & 2, 2);
9199 _ => panic!("Unexpected event"),
9202 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
9203 assert_eq!(msg.contents.flags & 2, 2);
9205 _ => panic!("Unexpected event"),
9207 // Note that at this point users of a standard PeerHandler will end up calling
9208 // peer_disconnected with no_connection_possible set to false, duplicating the
9209 // close-all-channels logic. That's OK, we don't want to end up not force-closing channels for
9210 // users with their own peer handling logic. We duplicate the call here, however.
9211 assert_eq!(nodes[0].node.list_usable_channels().len(), 1);
9212 assert!(nodes[0].node.list_usable_channels()[0].channel_id == chan_3.2);
9214 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), true);
9215 assert_eq!(nodes[0].node.list_usable_channels().len(), 1);
9216 assert!(nodes[0].node.list_usable_channels()[0].channel_id == chan_3.2);
9220 fn test_invalid_funding_tx() {
9221 // Test that we properly handle invalid funding transactions sent to us from a peer.
9223 // Previously, all other major lightning implementations had failed to properly sanitize
9224 // funding transactions from their counterparties, leading to a multi-implementation critical
9225 // security vulnerability (though we always sanitized properly, we've previously had
9226 // un-released crashes in the sanitization process).
9227 let chanmon_cfgs = create_chanmon_cfgs(2);
9228 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
9229 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
9230 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
9232 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100_000, 10_000, 42, None).unwrap();
9233 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()));
9234 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()));
9236 let (temporary_channel_id, mut tx, _) = create_funding_transaction(&nodes[0], 100_000, 42);
9237 for output in tx.output.iter_mut() {
9238 // Make the confirmed funding transaction have a bogus script_pubkey
9239 output.script_pubkey = bitcoin::Script::new();
9242 nodes[0].node.funding_transaction_generated_unchecked(&temporary_channel_id, tx.clone(), 0).unwrap();
9243 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()));
9244 check_added_monitors!(nodes[1], 1);
9246 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()));
9247 check_added_monitors!(nodes[0], 1);
9249 let events_1 = nodes[0].node.get_and_clear_pending_events();
9250 assert_eq!(events_1.len(), 0);
9252 assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
9253 assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0], tx);
9254 nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
9256 confirm_transaction_at(&nodes[1], &tx, 1);
9257 check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
9258 check_added_monitors!(nodes[1], 1);
9259 let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
9260 assert_eq!(events_2.len(), 1);
9261 if let MessageSendEvent::HandleError { node_id, action } = &events_2[0] {
9262 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
9263 if let msgs::ErrorAction::SendErrorMessage { msg } = action {
9264 assert_eq!(msg.data, "funding tx had wrong script/value or output index");
9265 } else { panic!(); }
9266 } else { panic!(); }
9267 assert_eq!(nodes[1].node.list_channels().len(), 0);
9270 fn do_test_tx_confirmed_skipping_blocks_immediate_broadcast(test_height_before_timelock: bool) {
9271 // In the first version of the chain::Confirm interface, after a refactor was made to not
9272 // broadcast CSV-locked transactions until their CSV lock is up, we wouldn't reliably broadcast
9273 // transactions after a `transactions_confirmed` call. Specifically, if the chain, provided via
9274 // `best_block_updated` is at height N, and a transaction output which we wish to spend at
9275 // height N-1 (due to a CSV to height N-1) is provided at height N, we will not broadcast the
9276 // spending transaction until height N+1 (or greater). This was due to the way
9277 // `ChannelMonitor::transactions_confirmed` worked, only checking if we should broadcast a
9278 // spending transaction at the height the input transaction was confirmed at, not whether we
9279 // should broadcast a spending transaction at the current height.
9280 // A second, similar, issue involved failing HTLCs backwards - because we only provided the
9281 // height at which transactions were confirmed to `OnchainTx::update_claims_view`, it wasn't
9282 // aware that the anti-reorg-delay had, in fact, already expired, waiting to fail-backwards
9283 // until we learned about an additional block.
9285 // As an additional check, if `test_height_before_timelock` is set, we instead test that we
9286 // aren't broadcasting transactions too early (ie not broadcasting them at all).
9287 let chanmon_cfgs = create_chanmon_cfgs(3);
9288 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
9289 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
9290 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
9291 *nodes[0].connect_style.borrow_mut() = ConnectStyle::BestBlockFirstSkippingBlocks;
9293 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
9294 let (chan_announce, _, channel_id, _) = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
9295 let (_, payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1_000_000);
9296 nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id(), false);
9297 nodes[2].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
9299 nodes[1].node.force_close_channel(&channel_id).unwrap();
9300 check_closed_broadcast!(nodes[1], true);
9301 check_closed_event!(nodes[1], 1, ClosureReason::HolderForceClosed);
9302 check_added_monitors!(nodes[1], 1);
9303 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
9304 assert_eq!(node_txn.len(), 1);
9306 let conf_height = nodes[1].best_block_info().1;
9307 if !test_height_before_timelock {
9308 connect_blocks(&nodes[1], 24 * 6);
9310 nodes[1].chain_monitor.chain_monitor.transactions_confirmed(
9311 &nodes[1].get_block_header(conf_height), &[(0, &node_txn[0])], conf_height);
9312 if test_height_before_timelock {
9313 // If we confirmed the close transaction, but timelocks have not yet expired, we should not
9314 // generate any events or broadcast any transactions
9315 assert!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
9316 assert!(nodes[1].chain_monitor.chain_monitor.get_and_clear_pending_events().is_empty());
9318 // We should broadcast an HTLC transaction spending our funding transaction first
9319 let spending_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
9320 assert_eq!(spending_txn.len(), 2);
9321 assert_eq!(spending_txn[0], node_txn[0]);
9322 check_spends!(spending_txn[1], node_txn[0]);
9323 // We should also generate a SpendableOutputs event with the to_self output (as its
9325 let descriptor_spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
9326 assert_eq!(descriptor_spend_txn.len(), 1);
9328 // If we also discover that the HTLC-Timeout transaction was confirmed some time ago, we
9329 // should immediately fail-backwards the HTLC to the previous hop, without waiting for an
9330 // additional block built on top of the current chain.
9331 nodes[1].chain_monitor.chain_monitor.transactions_confirmed(
9332 &nodes[1].get_block_header(conf_height + 1), &[(0, &spending_txn[1])], conf_height + 1);
9333 expect_pending_htlcs_forwardable!(nodes[1]);
9334 check_added_monitors!(nodes[1], 1);
9336 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
9337 assert!(updates.update_add_htlcs.is_empty());
9338 assert!(updates.update_fulfill_htlcs.is_empty());
9339 assert_eq!(updates.update_fail_htlcs.len(), 1);
9340 assert!(updates.update_fail_malformed_htlcs.is_empty());
9341 assert!(updates.update_fee.is_none());
9342 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
9343 commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, true, true);
9344 expect_payment_failed_with_update!(nodes[0], payment_hash, false, chan_announce.contents.short_channel_id, true);
9349 fn test_tx_confirmed_skipping_blocks_immediate_broadcast() {
9350 do_test_tx_confirmed_skipping_blocks_immediate_broadcast(false);
9351 do_test_tx_confirmed_skipping_blocks_immediate_broadcast(true);
9355 fn test_keysend_payments_to_public_node() {
9356 let chanmon_cfgs = create_chanmon_cfgs(2);
9357 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
9358 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
9359 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
9361 let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
9362 let network_graph = &nodes[0].net_graph_msg_handler.network_graph;
9363 let payer_pubkey = nodes[0].node.get_our_node_id();
9364 let payee_pubkey = nodes[1].node.get_our_node_id();
9365 let route = get_route(&payer_pubkey, network_graph, &payee_pubkey, None,
9366 None, &vec![], 10000, 40,
9367 nodes[0].logger).unwrap();
9369 let test_preimage = PaymentPreimage([42; 32]);
9370 let (payment_hash, _) = nodes[0].node.send_spontaneous_payment(&route, Some(test_preimage)).unwrap();
9371 check_added_monitors!(nodes[0], 1);
9372 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
9373 assert_eq!(events.len(), 1);
9374 let event = events.pop().unwrap();
9375 let path = vec![&nodes[1]];
9376 pass_along_path(&nodes[0], &path, 10000, payment_hash, None, event, true, Some(test_preimage));
9377 claim_payment(&nodes[0], &path, test_preimage);
9381 fn test_keysend_payments_to_private_node() {
9382 let chanmon_cfgs = create_chanmon_cfgs(2);
9383 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
9384 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
9385 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
9387 let payer_pubkey = nodes[0].node.get_our_node_id();
9388 let payee_pubkey = nodes[1].node.get_our_node_id();
9389 nodes[0].node.peer_connected(&payee_pubkey, &msgs::Init { features: InitFeatures::known() });
9390 nodes[1].node.peer_connected(&payer_pubkey, &msgs::Init { features: InitFeatures::known() });
9392 let _chan = create_chan_between_nodes(&nodes[0], &nodes[1], InitFeatures::known(), InitFeatures::known());
9393 let network_graph = &nodes[0].net_graph_msg_handler.network_graph;
9394 let first_hops = nodes[0].node.list_usable_channels();
9395 let route = get_keysend_route(&payer_pubkey, &network_graph, &payee_pubkey,
9396 Some(&first_hops.iter().collect::<Vec<_>>()), &vec![], 10000, 40,
9397 nodes[0].logger).unwrap();
9399 let test_preimage = PaymentPreimage([42; 32]);
9400 let (payment_hash, _) = nodes[0].node.send_spontaneous_payment(&route, Some(test_preimage)).unwrap();
9401 check_added_monitors!(nodes[0], 1);
9402 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
9403 assert_eq!(events.len(), 1);
9404 let event = events.pop().unwrap();
9405 let path = vec![&nodes[1]];
9406 pass_along_path(&nodes[0], &path, 10000, payment_hash, None, event, true, Some(test_preimage));
9407 claim_payment(&nodes[0], &path, test_preimage);
9410 fn do_test_max_dust_htlc_exposure(dust_outbound_balance: bool, at_forward: bool, on_holder_tx: bool) {
9411 // Test that we properly reject dust HTLC violating our `max_dust_htlc_exposure_msat` policy.
9413 // At HTLC forward (`send_payment()`), if the sum of the trimmed-to-dust HTLC inbound and
9414 // trimmed-to-dust HTLC outbound balance and this new payment as included on next counterparty
9415 // commitment are above our `max_dust_htlc_exposure_msat`, we'll reject the update.
9416 // At HTLC reception (`update_add_htlc()`), if the sum of the trimmed-to-dust HTLC inbound
9417 // and trimmed-to-dust HTLC outbound balance and this new received HTLC as included on next
9418 // counterparty commitment are above our `max_dust_htlc_exposure_msat`, we'll fail the update.
9419 // Note, we return a `temporary_channel_failure` (0x1000 | 7), as the channel might be
9420 // available again for HTLC processing once the dust bandwidth has cleared up.
9422 let chanmon_cfgs = create_chanmon_cfgs(2);
9423 let mut config = test_default_channel_config();
9424 config.channel_options.max_dust_htlc_exposure_msat = 5_000_000; // default setting value
9425 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
9426 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, Some(config)]);
9427 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
9429 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 1_000_000, 500_000_000, 42, None).unwrap();
9430 let mut open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
9431 open_channel.max_htlc_value_in_flight_msat = 50_000_000;
9432 open_channel.max_accepted_htlcs = 60;
9433 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_channel);
9434 let mut accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
9436 accept_channel.dust_limit_satoshis = 660;
9438 nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &accept_channel);
9440 let (temporary_channel_id, tx, _) = create_funding_transaction(&nodes[0], 1_000_000, 42);
9443 if let Some(mut chan) = nodes[1].node.channel_state.lock().unwrap().by_id.get_mut(&temporary_channel_id) {
9444 chan.holder_dust_limit_satoshis = 660;
9448 nodes[0].node.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
9449 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()));
9450 check_added_monitors!(nodes[1], 1);
9452 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()));
9453 check_added_monitors!(nodes[0], 1);
9455 let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
9456 let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
9457 update_nodes_with_chan_announce(&nodes, 0, 1, &announcement, &as_update, &bs_update);
9460 if dust_outbound_balance {
9462 let (route, payment_hash, _, payment_secret) = get_route_and_payment_hash!(nodes[1], nodes[0], 2_300_000);
9463 if let Err(_) = nodes[1].node.send_payment(&route, payment_hash, &Some(payment_secret)) { panic!("Unexpected event at dust HTLC {}", i); }
9467 route_payment(&nodes[0], &[&nodes[1]], 2_300_000);
9471 if dust_outbound_balance {
9473 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
9474 if let Err(_) = nodes[1].node.send_payment(&route, payment_hash, &Some(payment_secret)) { panic!("Unexpected event at dust HTLC {}", i); }
9478 route_payment(&nodes[0], &[&nodes[1]], 200_000); // + 167_000 msat of HTLC-timeout tx at 253 sats/kWU
9484 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 });
9485 let mut config = UserConfig::default();
9487 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)));
9489 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)));
9492 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 });
9493 nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
9494 check_added_monitors!(nodes[0], 1);
9495 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
9496 assert_eq!(events.len(), 1);
9497 let payment_event = SendEvent::from_event(events.remove(0));
9498 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
9500 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);
9502 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);
9506 let _ = nodes[1].node.get_and_clear_pending_msg_events();
9507 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
9508 added_monitors.clear();
9512 fn test_max_dust_htlc_exposure() {
9513 do_test_max_dust_htlc_exposure(true, true, true);
9514 do_test_max_dust_htlc_exposure(false, true, true);
9515 do_test_max_dust_htlc_exposure(false, false, true);
9516 do_test_max_dust_htlc_exposure(false, false, false);
9517 do_test_max_dust_htlc_exposure(true, true, false);
9518 do_test_max_dust_htlc_exposure(true, false, false);
9519 do_test_max_dust_htlc_exposure(true, false, true);
9520 do_test_max_dust_htlc_exposure(false, true, false);