1 // This file is Copyright its original authors, visible in version control
4 // This file is licensed under the Apache License, Version 2.0 <LICENSE-APACHE
5 // or http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
6 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your option.
7 // You may not use this file except in accordance with one or both of these
10 //! Tests that test standing up a network of ChannelManagers, creating channels, sending
11 //! payments/messages between them, and often checking the resulting ChannelMonitors are able to
12 //! claim outputs on-chain.
15 use chain::{Confirm, Listen, Watch};
16 use chain::channelmonitor;
17 use chain::channelmonitor::{ChannelMonitor, CLTV_CLAIM_BUFFER, LATENCY_GRACE_PERIOD_BLOCKS, ANTI_REORG_DELAY};
18 use chain::transaction::OutPoint;
19 use chain::keysinterface::{KeysInterface, BaseSign};
20 use ln::{PaymentPreimage, PaymentSecret, PaymentHash};
21 use ln::channel::{COMMITMENT_TX_BASE_WEIGHT, COMMITMENT_TX_WEIGHT_PER_HTLC};
22 use ln::channelmanager::{ChannelManager, ChannelManagerReadArgs, RAACommitmentOrder, PaymentSendFailure, BREAKDOWN_TIMEOUT, MIN_CLTV_EXPIRY_DELTA};
23 use ln::channel::{Channel, ChannelError};
24 use ln::{chan_utils, onion_utils};
25 use ln::chan_utils::HTLC_SUCCESS_TX_WEIGHT;
26 use routing::router::{Route, RouteHop, RouteHint, RouteHintHop, get_route, get_keysend_route};
27 use routing::network_graph::RoutingFees;
28 use ln::features::{ChannelFeatures, InitFeatures, InvoiceFeatures, NodeFeatures};
30 use ln::msgs::{ChannelMessageHandler,RoutingMessageHandler,HTLCFailChannelUpdate, ErrorAction};
31 use ln::script::ShutdownScript;
32 use util::enforcing_trait_impls::EnforcingSigner;
33 use util::{byte_utils, test_utils};
34 use util::test_utils::OnGetShutdownScriptpubkey;
35 use util::events::{Event, MessageSendEvent, MessageSendEventsProvider, PaymentPurpose};
36 use util::errors::APIError;
37 use util::ser::{Writeable, ReadableArgs};
38 use util::config::UserConfig;
40 use bitcoin::hashes::sha256d::Hash as Sha256dHash;
41 use bitcoin::hash_types::{Txid, BlockHash};
42 use bitcoin::blockdata::block::{Block, BlockHeader};
43 use bitcoin::blockdata::script::Builder;
44 use bitcoin::blockdata::opcodes;
45 use bitcoin::blockdata::constants::genesis_block;
46 use bitcoin::network::constants::Network;
48 use bitcoin::hashes::sha256::Hash as Sha256;
49 use bitcoin::hashes::Hash;
51 use bitcoin::secp256k1::{Secp256k1, Message};
52 use bitcoin::secp256k1::key::{PublicKey,SecretKey};
58 use alloc::collections::BTreeSet;
59 use core::default::Default;
60 use core::num::NonZeroU8;
61 use sync::{Arc, Mutex};
63 use ln::functional_test_utils::*;
64 use ln::chan_utils::CommitmentTransaction;
65 use ln::msgs::OptionalField::Present;
68 fn test_insane_channel_opens() {
69 // Stand up a network of 2 nodes
70 let chanmon_cfgs = create_chanmon_cfgs(2);
71 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
72 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
73 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
75 // Instantiate channel parameters where we push the maximum msats given our
77 let channel_value_sat = 31337; // same as funding satoshis
78 let channel_reserve_satoshis = Channel::<EnforcingSigner>::get_holder_selected_channel_reserve_satoshis(channel_value_sat);
79 let push_msat = (channel_value_sat - channel_reserve_satoshis) * 1000;
81 // Have node0 initiate a channel to node1 with aforementioned parameters
82 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_sat, push_msat, 42, None).unwrap();
84 // Extract the channel open message from node0 to node1
85 let open_channel_message = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
87 // Test helper that asserts we get the correct error string given a mutator
88 // that supposedly makes the channel open message insane
89 let insane_open_helper = |expected_error_str: &str, message_mutator: fn(msgs::OpenChannel) -> msgs::OpenChannel| {
90 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &message_mutator(open_channel_message.clone()));
91 let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
92 assert_eq!(msg_events.len(), 1);
93 let expected_regex = regex::Regex::new(expected_error_str).unwrap();
94 if let MessageSendEvent::HandleError { ref action, .. } = msg_events[0] {
96 &ErrorAction::SendErrorMessage { .. } => {
97 nodes[1].logger.assert_log_regex("lightning::ln::channelmanager".to_string(), expected_regex, 1);
99 _ => panic!("unexpected event!"),
101 } else { assert!(false); }
104 use ln::channel::MAX_FUNDING_SATOSHIS;
105 use ln::channelmanager::MAX_LOCAL_BREAKDOWN_TIMEOUT;
107 // Test all mutations that would make the channel open message insane
108 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 });
110 insane_open_helper("Bogus channel_reserve_satoshis", |mut msg| { msg.channel_reserve_satoshis = msg.funding_satoshis + 1; msg });
112 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 });
114 insane_open_helper("Peer never wants payout outputs?", |mut msg| { msg.dust_limit_satoshis = msg.funding_satoshis + 1 ; msg });
116 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 });
118 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 });
120 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 });
122 insane_open_helper("0 max_accepted_htlcs makes for a useless channel", |mut msg| { msg.max_accepted_htlcs = 0; msg });
124 insane_open_helper("max_accepted_htlcs was 484. It must not be larger than 483", |mut msg| { msg.max_accepted_htlcs = 484; msg });
128 fn test_async_inbound_update_fee() {
129 let chanmon_cfgs = create_chanmon_cfgs(2);
130 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
131 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
132 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
133 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
134 let logger = test_utils::TestLogger::new();
137 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
141 // send (1) commitment_signed -.
142 // <- update_add_htlc/commitment_signed
143 // send (2) RAA (awaiting remote revoke) -.
144 // (1) commitment_signed is delivered ->
145 // .- send (3) RAA (awaiting remote revoke)
146 // (2) RAA is delivered ->
147 // .- send (4) commitment_signed
148 // <- (3) RAA is delivered
149 // send (5) commitment_signed -.
150 // <- (4) commitment_signed is delivered
152 // (5) commitment_signed is delivered ->
154 // (6) RAA is delivered ->
156 // First nodes[0] generates an update_fee
158 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
161 nodes[0].node.timer_tick_occurred();
162 check_added_monitors!(nodes[0], 1);
164 let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
165 assert_eq!(events_0.len(), 1);
166 let (update_msg, commitment_signed) = match events_0[0] { // (1)
167 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
168 (update_fee.as_ref(), commitment_signed)
170 _ => panic!("Unexpected event"),
173 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
175 // ...but before it's delivered, nodes[1] starts to send a payment back to nodes[0]...
176 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[0]);
177 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
178 nodes[1].node.send_payment(&get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[0].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 40000, TEST_FINAL_CLTV, &logger).unwrap(), our_payment_hash, &Some(our_payment_secret)).unwrap();
179 check_added_monitors!(nodes[1], 1);
181 let payment_event = {
182 let mut events_1 = nodes[1].node.get_and_clear_pending_msg_events();
183 assert_eq!(events_1.len(), 1);
184 SendEvent::from_event(events_1.remove(0))
186 assert_eq!(payment_event.node_id, nodes[0].node.get_our_node_id());
187 assert_eq!(payment_event.msgs.len(), 1);
189 // ...now when the messages get delivered everyone should be happy
190 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
191 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg); // (2)
192 let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
193 // nodes[0] is awaiting nodes[1] revoke_and_ack so get_event_msg's assert(len == 1) passes
194 check_added_monitors!(nodes[0], 1);
196 // deliver(1), generate (3):
197 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
198 let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
199 // nodes[1] is awaiting nodes[0] revoke_and_ack so get_event_msg's assert(len == 1) passes
200 check_added_monitors!(nodes[1], 1);
202 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack); // deliver (2)
203 let bs_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
204 assert!(bs_update.update_add_htlcs.is_empty()); // (4)
205 assert!(bs_update.update_fulfill_htlcs.is_empty()); // (4)
206 assert!(bs_update.update_fail_htlcs.is_empty()); // (4)
207 assert!(bs_update.update_fail_malformed_htlcs.is_empty()); // (4)
208 assert!(bs_update.update_fee.is_none()); // (4)
209 check_added_monitors!(nodes[1], 1);
211 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack); // deliver (3)
212 let as_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
213 assert!(as_update.update_add_htlcs.is_empty()); // (5)
214 assert!(as_update.update_fulfill_htlcs.is_empty()); // (5)
215 assert!(as_update.update_fail_htlcs.is_empty()); // (5)
216 assert!(as_update.update_fail_malformed_htlcs.is_empty()); // (5)
217 assert!(as_update.update_fee.is_none()); // (5)
218 check_added_monitors!(nodes[0], 1);
220 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_update.commitment_signed); // deliver (4)
221 let as_second_revoke = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
222 // only (6) so get_event_msg's assert(len == 1) passes
223 check_added_monitors!(nodes[0], 1);
225 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_update.commitment_signed); // deliver (5)
226 let bs_second_revoke = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
227 check_added_monitors!(nodes[1], 1);
229 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke);
230 check_added_monitors!(nodes[0], 1);
232 let events_2 = nodes[0].node.get_and_clear_pending_events();
233 assert_eq!(events_2.len(), 1);
235 Event::PendingHTLCsForwardable {..} => {}, // If we actually processed we'd receive the payment
236 _ => panic!("Unexpected event"),
239 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_revoke); // deliver (6)
240 check_added_monitors!(nodes[1], 1);
244 fn test_update_fee_unordered_raa() {
245 // Just the intro to the previous test followed by an out-of-order RAA (which caused a
246 // crash in an earlier version of the update_fee patch)
247 let chanmon_cfgs = create_chanmon_cfgs(2);
248 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
249 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
250 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
251 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
252 let logger = test_utils::TestLogger::new();
255 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
257 // First nodes[0] generates an update_fee
259 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
262 nodes[0].node.timer_tick_occurred();
263 check_added_monitors!(nodes[0], 1);
265 let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
266 assert_eq!(events_0.len(), 1);
267 let update_msg = match events_0[0] { // (1)
268 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, .. }, .. } => {
271 _ => panic!("Unexpected event"),
274 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
276 // ...but before it's delivered, nodes[1] starts to send a payment back to nodes[0]...
277 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[0]);
278 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
279 nodes[1].node.send_payment(&get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[0].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 40000, TEST_FINAL_CLTV, &logger).unwrap(), our_payment_hash, &Some(our_payment_secret)).unwrap();
280 check_added_monitors!(nodes[1], 1);
282 let payment_event = {
283 let mut events_1 = nodes[1].node.get_and_clear_pending_msg_events();
284 assert_eq!(events_1.len(), 1);
285 SendEvent::from_event(events_1.remove(0))
287 assert_eq!(payment_event.node_id, nodes[0].node.get_our_node_id());
288 assert_eq!(payment_event.msgs.len(), 1);
290 // ...now when the messages get delivered everyone should be happy
291 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
292 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg); // (2)
293 let as_revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
294 // nodes[0] is awaiting nodes[1] revoke_and_ack so get_event_msg's assert(len == 1) passes
295 check_added_monitors!(nodes[0], 1);
297 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_msg); // deliver (2)
298 check_added_monitors!(nodes[1], 1);
300 // We can't continue, sadly, because our (1) now has a bogus signature
304 fn test_multi_flight_update_fee() {
305 let chanmon_cfgs = create_chanmon_cfgs(2);
306 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
307 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
308 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
309 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
312 // update_fee/commitment_signed ->
313 // .- send (1) RAA and (2) commitment_signed
314 // update_fee (never committed) ->
316 // We have to manually generate the above update_fee, it is allowed by the protocol but we
317 // don't track which updates correspond to which revoke_and_ack responses so we're in
318 // AwaitingRAA mode and will not generate the update_fee yet.
319 // <- (1) RAA delivered
320 // (3) is generated and send (4) CS -.
321 // Note that A cannot generate (4) prior to (1) being delivered as it otherwise doesn't
322 // know the per_commitment_point to use for it.
323 // <- (2) commitment_signed delivered
325 // B should send no response here
326 // (4) commitment_signed delivered ->
327 // <- RAA/commitment_signed delivered
330 // First nodes[0] generates an update_fee
333 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
334 initial_feerate = *feerate_lock;
335 *feerate_lock = initial_feerate + 20;
337 nodes[0].node.timer_tick_occurred();
338 check_added_monitors!(nodes[0], 1);
340 let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
341 assert_eq!(events_0.len(), 1);
342 let (update_msg_1, commitment_signed_1) = match events_0[0] { // (1)
343 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
344 (update_fee.as_ref().unwrap(), commitment_signed)
346 _ => panic!("Unexpected event"),
349 // Deliver first update_fee/commitment_signed pair, generating (1) and (2):
350 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg_1);
351 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed_1);
352 let (bs_revoke_msg, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
353 check_added_monitors!(nodes[1], 1);
355 // nodes[0] is awaiting a revoke from nodes[1] before it will create a new commitment
358 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
359 *feerate_lock = initial_feerate + 40;
361 nodes[0].node.timer_tick_occurred();
362 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
363 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
365 // Create the (3) update_fee message that nodes[0] will generate before it does...
366 let mut update_msg_2 = msgs::UpdateFee {
367 channel_id: update_msg_1.channel_id.clone(),
368 feerate_per_kw: (initial_feerate + 30) as u32,
371 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg_2);
373 update_msg_2.feerate_per_kw = (initial_feerate + 40) as u32;
375 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg_2);
377 // Deliver (1), generating (3) and (4)
378 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_msg);
379 let as_second_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
380 check_added_monitors!(nodes[0], 1);
381 assert!(as_second_update.update_add_htlcs.is_empty());
382 assert!(as_second_update.update_fulfill_htlcs.is_empty());
383 assert!(as_second_update.update_fail_htlcs.is_empty());
384 assert!(as_second_update.update_fail_malformed_htlcs.is_empty());
385 // Check that the update_fee newly generated matches what we delivered:
386 assert_eq!(as_second_update.update_fee.as_ref().unwrap().channel_id, update_msg_2.channel_id);
387 assert_eq!(as_second_update.update_fee.as_ref().unwrap().feerate_per_kw, update_msg_2.feerate_per_kw);
389 // Deliver (2) commitment_signed
390 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_commitment_signed);
391 let as_revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
392 check_added_monitors!(nodes[0], 1);
393 // No commitment_signed so get_event_msg's assert(len == 1) passes
395 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_msg);
396 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
397 check_added_monitors!(nodes[1], 1);
400 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_second_update.commitment_signed);
401 let (bs_second_revoke, bs_second_commitment) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
402 check_added_monitors!(nodes[1], 1);
404 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke);
405 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
406 check_added_monitors!(nodes[0], 1);
408 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_commitment);
409 let as_second_revoke = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
410 // No commitment_signed so get_event_msg's assert(len == 1) passes
411 check_added_monitors!(nodes[0], 1);
413 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_revoke);
414 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
415 check_added_monitors!(nodes[1], 1);
418 fn do_test_1_conf_open(connect_style: ConnectStyle) {
419 // Previously, if the minium_depth config was set to 1, we'd never send a funding_locked. This
420 // tests that we properly send one in that case.
421 let mut alice_config = UserConfig::default();
422 alice_config.own_channel_config.minimum_depth = 1;
423 alice_config.channel_options.announced_channel = true;
424 alice_config.peer_channel_config_limits.force_announced_channel_preference = false;
425 let mut bob_config = UserConfig::default();
426 bob_config.own_channel_config.minimum_depth = 1;
427 bob_config.channel_options.announced_channel = true;
428 bob_config.peer_channel_config_limits.force_announced_channel_preference = false;
429 let chanmon_cfgs = create_chanmon_cfgs(2);
430 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
431 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[Some(alice_config), Some(bob_config)]);
432 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
433 *nodes[0].connect_style.borrow_mut() = connect_style;
435 let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
436 mine_transaction(&nodes[1], &tx);
437 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()));
439 mine_transaction(&nodes[0], &tx);
440 let (funding_locked, _) = create_chan_between_nodes_with_value_confirm_second(&nodes[1], &nodes[0]);
441 let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
444 assert!(node.net_graph_msg_handler.handle_channel_announcement(&announcement).unwrap());
445 node.net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
446 node.net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
450 fn test_1_conf_open() {
451 do_test_1_conf_open(ConnectStyle::BestBlockFirst);
452 do_test_1_conf_open(ConnectStyle::TransactionsFirst);
453 do_test_1_conf_open(ConnectStyle::FullBlockViaListen);
456 fn do_test_sanity_on_in_flight_opens(steps: u8) {
457 // Previously, we had issues deserializing channels when we hadn't connected the first block
458 // after creation. To catch that and similar issues, we lean on the Node::drop impl to test
459 // serialization round-trips and simply do steps towards opening a channel and then drop the
462 let chanmon_cfgs = create_chanmon_cfgs(2);
463 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
464 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
465 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
467 if steps & 0b1000_0000 != 0{
469 header: BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
472 connect_block(&nodes[0], &block);
473 connect_block(&nodes[1], &block);
476 if steps & 0x0f == 0 { return; }
477 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
478 let open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
480 if steps & 0x0f == 1 { return; }
481 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_channel);
482 let accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
484 if steps & 0x0f == 2 { return; }
485 nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &accept_channel);
487 let (temporary_channel_id, tx, funding_output) = create_funding_transaction(&nodes[0], 100000, 42);
489 if steps & 0x0f == 3 { return; }
490 nodes[0].node.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
491 check_added_monitors!(nodes[0], 0);
492 let funding_created = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
494 if steps & 0x0f == 4 { return; }
495 nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created);
497 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
498 assert_eq!(added_monitors.len(), 1);
499 assert_eq!(added_monitors[0].0, funding_output);
500 added_monitors.clear();
502 let funding_signed = get_event_msg!(nodes[1], MessageSendEvent::SendFundingSigned, nodes[0].node.get_our_node_id());
504 if steps & 0x0f == 5 { return; }
505 nodes[0].node.handle_funding_signed(&nodes[1].node.get_our_node_id(), &funding_signed);
507 let mut added_monitors = nodes[0].chain_monitor.added_monitors.lock().unwrap();
508 assert_eq!(added_monitors.len(), 1);
509 assert_eq!(added_monitors[0].0, funding_output);
510 added_monitors.clear();
513 let events_4 = nodes[0].node.get_and_clear_pending_events();
514 assert_eq!(events_4.len(), 0);
516 if steps & 0x0f == 6 { return; }
517 create_chan_between_nodes_with_value_confirm_first(&nodes[0], &nodes[1], &tx, 2);
519 if steps & 0x0f == 7 { return; }
520 confirm_transaction_at(&nodes[0], &tx, 2);
521 connect_blocks(&nodes[0], CHAN_CONFIRM_DEPTH);
522 create_chan_between_nodes_with_value_confirm_second(&nodes[1], &nodes[0]);
526 fn test_sanity_on_in_flight_opens() {
527 do_test_sanity_on_in_flight_opens(0);
528 do_test_sanity_on_in_flight_opens(0 | 0b1000_0000);
529 do_test_sanity_on_in_flight_opens(1);
530 do_test_sanity_on_in_flight_opens(1 | 0b1000_0000);
531 do_test_sanity_on_in_flight_opens(2);
532 do_test_sanity_on_in_flight_opens(2 | 0b1000_0000);
533 do_test_sanity_on_in_flight_opens(3);
534 do_test_sanity_on_in_flight_opens(3 | 0b1000_0000);
535 do_test_sanity_on_in_flight_opens(4);
536 do_test_sanity_on_in_flight_opens(4 | 0b1000_0000);
537 do_test_sanity_on_in_flight_opens(5);
538 do_test_sanity_on_in_flight_opens(5 | 0b1000_0000);
539 do_test_sanity_on_in_flight_opens(6);
540 do_test_sanity_on_in_flight_opens(6 | 0b1000_0000);
541 do_test_sanity_on_in_flight_opens(7);
542 do_test_sanity_on_in_flight_opens(7 | 0b1000_0000);
543 do_test_sanity_on_in_flight_opens(8);
544 do_test_sanity_on_in_flight_opens(8 | 0b1000_0000);
548 fn test_update_fee_vanilla() {
549 let chanmon_cfgs = create_chanmon_cfgs(2);
550 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
551 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
552 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
553 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
556 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
559 nodes[0].node.timer_tick_occurred();
560 check_added_monitors!(nodes[0], 1);
562 let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
563 assert_eq!(events_0.len(), 1);
564 let (update_msg, commitment_signed) = match events_0[0] {
565 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 } } => {
566 (update_fee.as_ref(), commitment_signed)
568 _ => panic!("Unexpected event"),
570 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
572 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
573 let (revoke_msg, commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
574 check_added_monitors!(nodes[1], 1);
576 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
577 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
578 check_added_monitors!(nodes[0], 1);
580 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
581 let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
582 // No commitment_signed so get_event_msg's assert(len == 1) passes
583 check_added_monitors!(nodes[0], 1);
585 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg);
586 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
587 check_added_monitors!(nodes[1], 1);
591 fn test_update_fee_that_funder_cannot_afford() {
592 let chanmon_cfgs = create_chanmon_cfgs(2);
593 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
594 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
595 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
596 let channel_value = 1888;
597 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, channel_value, 700000, InitFeatures::known(), InitFeatures::known());
598 let channel_id = chan.2;
602 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
603 *feerate_lock = feerate;
605 nodes[0].node.timer_tick_occurred();
606 check_added_monitors!(nodes[0], 1);
607 let update_msg = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
609 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg.update_fee.unwrap());
611 commitment_signed_dance!(nodes[1], nodes[0], update_msg.commitment_signed, false);
613 //Confirm that the new fee based on the last local commitment txn is what we expected based on the feerate of 260 set above.
614 //This value results in a fee that is exactly what the funder can afford (277 sat + 1000 sat channel reserve)
616 let commitment_tx = get_local_commitment_txn!(nodes[1], channel_id)[0].clone();
618 //We made sure neither party's funds are below the dust limit so -2 non-HTLC txns from number of outputs
619 let num_htlcs = commitment_tx.output.len() - 2;
620 let total_fee: u64 = feerate as u64 * (COMMITMENT_TX_BASE_WEIGHT + (num_htlcs as u64) * COMMITMENT_TX_WEIGHT_PER_HTLC) / 1000;
621 let mut actual_fee = commitment_tx.output.iter().fold(0, |acc, output| acc + output.value);
622 actual_fee = channel_value - actual_fee;
623 assert_eq!(total_fee, actual_fee);
626 //Add 2 to the previous fee rate to the final fee increases by 1 (with no HTLCs the fee is essentially
627 //fee_rate*(724/1000) so the increment of 1*0.724 is rounded back down)
629 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
630 *feerate_lock = feerate + 2;
632 nodes[0].node.timer_tick_occurred();
633 check_added_monitors!(nodes[0], 1);
635 let update2_msg = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
637 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update2_msg.update_fee.unwrap());
639 //While producing the commitment_signed response after handling a received update_fee request the
640 //check to see if the funder, who sent the update_fee request, can afford the new fee (funder_balance >= fee+channel_reserve)
641 //Should produce and error.
642 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &update2_msg.commitment_signed);
643 nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Funding remote cannot afford proposed new fee".to_string(), 1);
644 check_added_monitors!(nodes[1], 1);
645 check_closed_broadcast!(nodes[1], true);
649 fn test_update_fee_with_fundee_update_add_htlc() {
650 let chanmon_cfgs = create_chanmon_cfgs(2);
651 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
652 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
653 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
654 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
655 let logger = test_utils::TestLogger::new();
658 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
661 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
664 nodes[0].node.timer_tick_occurred();
665 check_added_monitors!(nodes[0], 1);
667 let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
668 assert_eq!(events_0.len(), 1);
669 let (update_msg, commitment_signed) = match events_0[0] {
670 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 } } => {
671 (update_fee.as_ref(), commitment_signed)
673 _ => panic!("Unexpected event"),
675 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
676 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
677 let (revoke_msg, commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
678 check_added_monitors!(nodes[1], 1);
680 let (our_payment_preimage, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[0]);
681 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
682 let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[0].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 800000, TEST_FINAL_CLTV, &logger).unwrap();
684 // nothing happens since node[1] is in AwaitingRemoteRevoke
685 nodes[1].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
687 let mut added_monitors = nodes[0].chain_monitor.added_monitors.lock().unwrap();
688 assert_eq!(added_monitors.len(), 0);
689 added_monitors.clear();
691 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
692 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
693 // node[1] has nothing to do
695 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
696 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
697 check_added_monitors!(nodes[0], 1);
699 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
700 let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
701 // No commitment_signed so get_event_msg's assert(len == 1) passes
702 check_added_monitors!(nodes[0], 1);
703 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg);
704 check_added_monitors!(nodes[1], 1);
705 // AwaitingRemoteRevoke ends here
707 let commitment_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
708 assert_eq!(commitment_update.update_add_htlcs.len(), 1);
709 assert_eq!(commitment_update.update_fulfill_htlcs.len(), 0);
710 assert_eq!(commitment_update.update_fail_htlcs.len(), 0);
711 assert_eq!(commitment_update.update_fail_malformed_htlcs.len(), 0);
712 assert_eq!(commitment_update.update_fee.is_none(), true);
714 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &commitment_update.update_add_htlcs[0]);
715 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_update.commitment_signed);
716 check_added_monitors!(nodes[0], 1);
717 let (revoke, commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
719 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke);
720 check_added_monitors!(nodes[1], 1);
721 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
723 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commitment_signed);
724 check_added_monitors!(nodes[1], 1);
725 let revoke = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
726 // No commitment_signed so get_event_msg's assert(len == 1) passes
728 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke);
729 check_added_monitors!(nodes[0], 1);
730 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
732 expect_pending_htlcs_forwardable!(nodes[0]);
734 let events = nodes[0].node.get_and_clear_pending_events();
735 assert_eq!(events.len(), 1);
737 Event::PaymentReceived { .. } => { },
738 _ => panic!("Unexpected event"),
741 claim_payment(&nodes[1], &vec!(&nodes[0])[..], our_payment_preimage);
743 send_payment(&nodes[1], &vec!(&nodes[0])[..], 800000);
744 send_payment(&nodes[0], &vec!(&nodes[1])[..], 800000);
745 close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true);
749 fn test_update_fee() {
750 let chanmon_cfgs = create_chanmon_cfgs(2);
751 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
752 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
753 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
754 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
755 let channel_id = chan.2;
758 // (1) update_fee/commitment_signed ->
759 // <- (2) revoke_and_ack
760 // .- send (3) commitment_signed
761 // (4) update_fee/commitment_signed ->
762 // .- send (5) revoke_and_ack (no CS as we're awaiting a revoke)
763 // <- (3) commitment_signed delivered
764 // send (6) revoke_and_ack -.
765 // <- (5) deliver revoke_and_ack
766 // (6) deliver revoke_and_ack ->
767 // .- send (7) commitment_signed in response to (4)
768 // <- (7) deliver commitment_signed
771 // Create and deliver (1)...
774 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
775 feerate = *feerate_lock;
776 *feerate_lock = feerate + 20;
778 nodes[0].node.timer_tick_occurred();
779 check_added_monitors!(nodes[0], 1);
781 let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
782 assert_eq!(events_0.len(), 1);
783 let (update_msg, commitment_signed) = match events_0[0] {
784 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 } } => {
785 (update_fee.as_ref(), commitment_signed)
787 _ => panic!("Unexpected event"),
789 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
791 // Generate (2) and (3):
792 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
793 let (revoke_msg, commitment_signed_0) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
794 check_added_monitors!(nodes[1], 1);
797 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
798 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
799 check_added_monitors!(nodes[0], 1);
801 // Create and deliver (4)...
803 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
804 *feerate_lock = feerate + 30;
806 nodes[0].node.timer_tick_occurred();
807 check_added_monitors!(nodes[0], 1);
808 let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
809 assert_eq!(events_0.len(), 1);
810 let (update_msg, commitment_signed) = match events_0[0] {
811 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 } } => {
812 (update_fee.as_ref(), commitment_signed)
814 _ => panic!("Unexpected event"),
817 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
818 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
819 check_added_monitors!(nodes[1], 1);
821 let revoke_msg = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
822 // No commitment_signed so get_event_msg's assert(len == 1) passes
824 // Handle (3), creating (6):
825 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed_0);
826 check_added_monitors!(nodes[0], 1);
827 let revoke_msg_0 = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
828 // No commitment_signed so get_event_msg's assert(len == 1) passes
831 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
832 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
833 check_added_monitors!(nodes[0], 1);
835 // Deliver (6), creating (7):
836 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg_0);
837 let commitment_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
838 assert!(commitment_update.update_add_htlcs.is_empty());
839 assert!(commitment_update.update_fulfill_htlcs.is_empty());
840 assert!(commitment_update.update_fail_htlcs.is_empty());
841 assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
842 assert!(commitment_update.update_fee.is_none());
843 check_added_monitors!(nodes[1], 1);
846 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_update.commitment_signed);
847 check_added_monitors!(nodes[0], 1);
848 let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
849 // No commitment_signed so get_event_msg's assert(len == 1) passes
851 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg);
852 check_added_monitors!(nodes[1], 1);
853 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
855 assert_eq!(get_feerate!(nodes[0], channel_id), feerate + 30);
856 assert_eq!(get_feerate!(nodes[1], channel_id), feerate + 30);
857 close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true);
861 fn pre_funding_lock_shutdown_test() {
862 // Test sending a shutdown prior to funding_locked after funding generation
863 let chanmon_cfgs = create_chanmon_cfgs(2);
864 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
865 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
866 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
867 let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 8000000, 0, InitFeatures::known(), InitFeatures::known());
868 mine_transaction(&nodes[0], &tx);
869 mine_transaction(&nodes[1], &tx);
871 nodes[0].node.close_channel(&OutPoint { txid: tx.txid(), index: 0 }.to_channel_id()).unwrap();
872 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
873 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
874 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
875 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_shutdown);
877 let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
878 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
879 let node_1_closing_signed = get_event_msg!(nodes[1], MessageSendEvent::SendClosingSigned, nodes[0].node.get_our_node_id());
880 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed);
881 let (_, node_0_2nd_closing_signed) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
882 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed.unwrap());
883 let (_, node_1_none) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
884 assert!(node_1_none.is_none());
886 assert!(nodes[0].node.list_channels().is_empty());
887 assert!(nodes[1].node.list_channels().is_empty());
891 fn updates_shutdown_wait() {
892 // Test sending a shutdown with outstanding updates pending
893 let chanmon_cfgs = create_chanmon_cfgs(3);
894 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
895 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
896 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
897 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
898 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
899 let logger = test_utils::TestLogger::new();
901 let (our_payment_preimage, _, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100000);
903 nodes[0].node.close_channel(&chan_1.2).unwrap();
904 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
905 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
906 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
907 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_shutdown);
909 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
910 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
912 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[0]);
914 let net_graph_msg_handler0 = &nodes[0].net_graph_msg_handler;
915 let net_graph_msg_handler1 = &nodes[1].net_graph_msg_handler;
916 let route_1 = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler0.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
917 let route_2 = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler1.network_graph.read().unwrap(), &nodes[0].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
918 unwrap_send_err!(nodes[0].node.send_payment(&route_1, payment_hash, &Some(payment_secret)), true, APIError::ChannelUnavailable {..}, {});
919 unwrap_send_err!(nodes[1].node.send_payment(&route_2, payment_hash, &Some(payment_secret)), true, APIError::ChannelUnavailable {..}, {});
921 assert!(nodes[2].node.claim_funds(our_payment_preimage));
922 check_added_monitors!(nodes[2], 1);
923 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
924 assert!(updates.update_add_htlcs.is_empty());
925 assert!(updates.update_fail_htlcs.is_empty());
926 assert!(updates.update_fail_malformed_htlcs.is_empty());
927 assert!(updates.update_fee.is_none());
928 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
929 nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
930 expect_payment_forwarded!(nodes[1], Some(1000), false);
931 check_added_monitors!(nodes[1], 1);
932 let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
933 commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
935 assert!(updates_2.update_add_htlcs.is_empty());
936 assert!(updates_2.update_fail_htlcs.is_empty());
937 assert!(updates_2.update_fail_malformed_htlcs.is_empty());
938 assert!(updates_2.update_fee.is_none());
939 assert_eq!(updates_2.update_fulfill_htlcs.len(), 1);
940 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fulfill_htlcs[0]);
941 commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
943 let events = nodes[0].node.get_and_clear_pending_events();
944 assert_eq!(events.len(), 1);
946 Event::PaymentSent { ref payment_preimage } => {
947 assert_eq!(our_payment_preimage, *payment_preimage);
949 _ => panic!("Unexpected event"),
952 let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
953 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
954 let node_1_closing_signed = get_event_msg!(nodes[1], MessageSendEvent::SendClosingSigned, nodes[0].node.get_our_node_id());
955 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed);
956 let (_, node_0_2nd_closing_signed) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
957 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed.unwrap());
958 let (_, node_1_none) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
959 assert!(node_1_none.is_none());
961 assert!(nodes[0].node.list_channels().is_empty());
963 assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
964 nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
965 close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
966 assert!(nodes[1].node.list_channels().is_empty());
967 assert!(nodes[2].node.list_channels().is_empty());
971 fn htlc_fail_async_shutdown() {
972 // Test HTLCs fail if shutdown starts even if messages are delivered out-of-order
973 let chanmon_cfgs = create_chanmon_cfgs(3);
974 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
975 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
976 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
977 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
978 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
979 let logger = test_utils::TestLogger::new();
981 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[2]);
982 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
983 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[2].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
984 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
985 check_added_monitors!(nodes[0], 1);
986 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
987 assert_eq!(updates.update_add_htlcs.len(), 1);
988 assert!(updates.update_fulfill_htlcs.is_empty());
989 assert!(updates.update_fail_htlcs.is_empty());
990 assert!(updates.update_fail_malformed_htlcs.is_empty());
991 assert!(updates.update_fee.is_none());
993 nodes[1].node.close_channel(&chan_1.2).unwrap();
994 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
995 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_shutdown);
996 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
998 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
999 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &updates.commitment_signed);
1000 check_added_monitors!(nodes[1], 1);
1001 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
1002 commitment_signed_dance!(nodes[1], nodes[0], (), false, true, false);
1004 let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1005 assert!(updates_2.update_add_htlcs.is_empty());
1006 assert!(updates_2.update_fulfill_htlcs.is_empty());
1007 assert_eq!(updates_2.update_fail_htlcs.len(), 1);
1008 assert!(updates_2.update_fail_malformed_htlcs.is_empty());
1009 assert!(updates_2.update_fee.is_none());
1011 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fail_htlcs[0]);
1012 commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
1014 expect_payment_failed!(nodes[0], our_payment_hash, false);
1016 let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
1017 assert_eq!(msg_events.len(), 2);
1018 match msg_events[0] {
1019 MessageSendEvent::PaymentFailureNetworkUpdate { update: msgs::HTLCFailChannelUpdate::ChannelUpdateMessage { ref msg }} => {
1020 assert_eq!(msg.contents.short_channel_id, chan_1.0.contents.short_channel_id);
1022 _ => panic!("Unexpected event"),
1024 let node_0_closing_signed = match msg_events[1] {
1025 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
1026 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
1029 _ => panic!("Unexpected event"),
1032 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1033 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
1034 let node_1_closing_signed = get_event_msg!(nodes[1], MessageSendEvent::SendClosingSigned, nodes[0].node.get_our_node_id());
1035 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed);
1036 let (_, node_0_2nd_closing_signed) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
1037 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed.unwrap());
1038 let (_, node_1_none) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
1039 assert!(node_1_none.is_none());
1041 assert!(nodes[0].node.list_channels().is_empty());
1043 assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
1044 nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
1045 close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
1046 assert!(nodes[1].node.list_channels().is_empty());
1047 assert!(nodes[2].node.list_channels().is_empty());
1050 fn do_test_shutdown_rebroadcast(recv_count: u8) {
1051 // Test that shutdown/closing_signed is re-sent on reconnect with a variable number of
1052 // messages delivered prior to disconnect
1053 let chanmon_cfgs = create_chanmon_cfgs(3);
1054 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1055 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1056 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1057 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
1058 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
1060 let (our_payment_preimage, _, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100000);
1062 nodes[1].node.close_channel(&chan_1.2).unwrap();
1063 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
1065 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_shutdown);
1066 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
1068 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
1072 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
1073 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
1075 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1076 let node_0_reestablish = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
1077 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1078 let node_1_reestablish = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
1080 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_reestablish);
1081 let node_1_2nd_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
1082 assert!(node_1_shutdown == node_1_2nd_shutdown);
1084 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &node_1_reestablish);
1085 let node_0_2nd_shutdown = if recv_count > 0 {
1086 let node_0_2nd_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
1087 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_2nd_shutdown);
1090 let node_0_chan_update = get_event_msg!(nodes[0], MessageSendEvent::SendChannelUpdate, nodes[1].node.get_our_node_id());
1091 assert_eq!(node_0_chan_update.contents.flags & 2, 0); // "disabled" flag must not be set as we just reconnected.
1092 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_2nd_shutdown);
1093 get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id())
1095 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_2nd_shutdown);
1097 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1098 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1100 assert!(nodes[2].node.claim_funds(our_payment_preimage));
1101 check_added_monitors!(nodes[2], 1);
1102 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1103 assert!(updates.update_add_htlcs.is_empty());
1104 assert!(updates.update_fail_htlcs.is_empty());
1105 assert!(updates.update_fail_malformed_htlcs.is_empty());
1106 assert!(updates.update_fee.is_none());
1107 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
1108 nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
1109 expect_payment_forwarded!(nodes[1], Some(1000), false);
1110 check_added_monitors!(nodes[1], 1);
1111 let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1112 commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
1114 assert!(updates_2.update_add_htlcs.is_empty());
1115 assert!(updates_2.update_fail_htlcs.is_empty());
1116 assert!(updates_2.update_fail_malformed_htlcs.is_empty());
1117 assert!(updates_2.update_fee.is_none());
1118 assert_eq!(updates_2.update_fulfill_htlcs.len(), 1);
1119 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fulfill_htlcs[0]);
1120 commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
1122 let events = nodes[0].node.get_and_clear_pending_events();
1123 assert_eq!(events.len(), 1);
1125 Event::PaymentSent { ref payment_preimage } => {
1126 assert_eq!(our_payment_preimage, *payment_preimage);
1128 _ => panic!("Unexpected event"),
1131 let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
1133 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
1134 let node_1_closing_signed = get_event_msg!(nodes[1], MessageSendEvent::SendClosingSigned, nodes[0].node.get_our_node_id());
1135 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed);
1136 let (_, node_0_2nd_closing_signed) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
1137 assert!(node_0_2nd_closing_signed.is_some());
1140 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
1141 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
1143 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1144 let node_1_2nd_reestablish = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
1145 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1146 if recv_count == 0 {
1147 // If all closing_signeds weren't delivered we can just resume where we left off...
1148 let node_0_2nd_reestablish = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
1150 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &node_1_2nd_reestablish);
1151 let node_0_msgs = nodes[0].node.get_and_clear_pending_msg_events();
1152 assert_eq!(node_0_msgs.len(), 2);
1153 let node_0_2nd_closing_signed = match node_0_msgs[1] {
1154 MessageSendEvent::SendClosingSigned { ref msg, .. } => {
1155 assert_eq!(node_0_closing_signed, *msg);
1161 let node_0_3rd_shutdown = match node_0_msgs[0] {
1162 MessageSendEvent::SendShutdown { ref msg, .. } => {
1163 assert_eq!(node_0_2nd_shutdown, *msg);
1168 assert!(node_0_2nd_shutdown == node_0_3rd_shutdown);
1170 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_2nd_reestablish);
1171 let node_1_3rd_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
1172 assert!(node_1_3rd_shutdown == node_1_2nd_shutdown);
1174 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_3rd_shutdown);
1175 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1177 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_3rd_shutdown);
1179 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed);
1180 let node_1_closing_signed = get_event_msg!(nodes[1], MessageSendEvent::SendClosingSigned, nodes[0].node.get_our_node_id());
1181 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed);
1182 let (_, node_0_2nd_closing_signed) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
1183 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed.unwrap());
1184 let (_, node_1_none) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
1185 assert!(node_1_none.is_none());
1187 // If one node, however, received + responded with an identical closing_signed we end
1188 // up erroring and node[0] will try to broadcast its own latest commitment transaction.
1189 // There isn't really anything better we can do simply, but in the future we might
1190 // explore storing a set of recently-closed channels that got disconnected during
1191 // closing_signed and avoiding broadcasting local commitment txn for some timeout to
1192 // give our counterparty enough time to (potentially) broadcast a cooperative closing
1194 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1196 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &node_1_2nd_reestablish);
1197 let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
1198 assert_eq!(msg_events.len(), 1);
1199 if let MessageSendEvent::HandleError { ref action, .. } = msg_events[0] {
1201 &ErrorAction::SendErrorMessage { ref msg } => {
1202 nodes[1].node.handle_error(&nodes[0].node.get_our_node_id(), &msg);
1203 assert_eq!(msg.channel_id, chan_1.2);
1205 _ => panic!("Unexpected event!"),
1207 } else { panic!("Needed SendErrorMessage close"); }
1209 // get_closing_signed_broadcast usually eats the BroadcastChannelUpdate for us and
1210 // checks it, but in this case nodes[1] didn't ever get a chance to receive a
1211 // closing_signed so we do it ourselves
1212 check_closed_broadcast!(nodes[1], false);
1213 check_added_monitors!(nodes[1], 1);
1216 assert!(nodes[0].node.list_channels().is_empty());
1218 assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
1219 nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
1220 close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
1221 assert!(nodes[1].node.list_channels().is_empty());
1222 assert!(nodes[2].node.list_channels().is_empty());
1226 fn test_shutdown_rebroadcast() {
1227 do_test_shutdown_rebroadcast(0);
1228 do_test_shutdown_rebroadcast(1);
1229 do_test_shutdown_rebroadcast(2);
1233 fn fake_network_test() {
1234 // Simple test which builds a network of ChannelManagers, connects them to each other, and
1235 // tests that payments get routed and transactions broadcast in semi-reasonable ways.
1236 let chanmon_cfgs = create_chanmon_cfgs(4);
1237 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
1238 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
1239 let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
1241 // Create some initial channels
1242 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
1243 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
1244 let chan_3 = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
1246 // Rebalance the network a bit by relaying one payment through all the channels...
1247 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000);
1248 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000);
1249 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000);
1250 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000);
1252 // Send some more payments
1253 send_payment(&nodes[1], &vec!(&nodes[2], &nodes[3])[..], 1000000);
1254 send_payment(&nodes[3], &vec!(&nodes[2], &nodes[1], &nodes[0])[..], 1000000);
1255 send_payment(&nodes[3], &vec!(&nodes[2], &nodes[1])[..], 1000000);
1257 // Test failure packets
1258 let payment_hash_1 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 1000000).1;
1259 fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], payment_hash_1);
1261 // Add a new channel that skips 3
1262 let chan_4 = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known());
1264 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 1000000);
1265 send_payment(&nodes[2], &vec!(&nodes[3])[..], 1000000);
1266 send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
1267 send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
1268 send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
1269 send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
1270 send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
1272 // Do some rebalance loop payments, simultaneously
1273 let mut hops = Vec::with_capacity(3);
1274 hops.push(RouteHop {
1275 pubkey: nodes[2].node.get_our_node_id(),
1276 node_features: NodeFeatures::empty(),
1277 short_channel_id: chan_2.0.contents.short_channel_id,
1278 channel_features: ChannelFeatures::empty(),
1280 cltv_expiry_delta: chan_3.0.contents.cltv_expiry_delta as u32
1282 hops.push(RouteHop {
1283 pubkey: nodes[3].node.get_our_node_id(),
1284 node_features: NodeFeatures::empty(),
1285 short_channel_id: chan_3.0.contents.short_channel_id,
1286 channel_features: ChannelFeatures::empty(),
1288 cltv_expiry_delta: chan_4.1.contents.cltv_expiry_delta as u32
1290 hops.push(RouteHop {
1291 pubkey: nodes[1].node.get_our_node_id(),
1292 node_features: NodeFeatures::known(),
1293 short_channel_id: chan_4.0.contents.short_channel_id,
1294 channel_features: ChannelFeatures::known(),
1296 cltv_expiry_delta: TEST_FINAL_CLTV,
1298 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;
1299 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;
1300 let payment_preimage_1 = send_along_route(&nodes[1], Route { paths: vec![hops] }, &vec!(&nodes[2], &nodes[3], &nodes[1])[..], 1000000).0;
1302 let mut hops = Vec::with_capacity(3);
1303 hops.push(RouteHop {
1304 pubkey: nodes[3].node.get_our_node_id(),
1305 node_features: NodeFeatures::empty(),
1306 short_channel_id: chan_4.0.contents.short_channel_id,
1307 channel_features: ChannelFeatures::empty(),
1309 cltv_expiry_delta: chan_3.1.contents.cltv_expiry_delta as u32
1311 hops.push(RouteHop {
1312 pubkey: nodes[2].node.get_our_node_id(),
1313 node_features: NodeFeatures::empty(),
1314 short_channel_id: chan_3.0.contents.short_channel_id,
1315 channel_features: ChannelFeatures::empty(),
1317 cltv_expiry_delta: chan_2.1.contents.cltv_expiry_delta as u32
1319 hops.push(RouteHop {
1320 pubkey: nodes[1].node.get_our_node_id(),
1321 node_features: NodeFeatures::known(),
1322 short_channel_id: chan_2.0.contents.short_channel_id,
1323 channel_features: ChannelFeatures::known(),
1325 cltv_expiry_delta: TEST_FINAL_CLTV,
1327 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;
1328 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;
1329 let payment_hash_2 = send_along_route(&nodes[1], Route { paths: vec![hops] }, &vec!(&nodes[3], &nodes[2], &nodes[1])[..], 1000000).1;
1331 // Claim the rebalances...
1332 fail_payment(&nodes[1], &vec!(&nodes[3], &nodes[2], &nodes[1])[..], payment_hash_2);
1333 claim_payment(&nodes[1], &vec!(&nodes[2], &nodes[3], &nodes[1])[..], payment_preimage_1);
1335 // Add a duplicate new channel from 2 to 4
1336 let chan_5 = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known());
1338 // Send some payments across both channels
1339 let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
1340 let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
1341 let payment_preimage_5 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
1344 route_over_limit(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000);
1345 let events = nodes[0].node.get_and_clear_pending_msg_events();
1346 assert_eq!(events.len(), 0);
1347 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);
1349 //TODO: Test that routes work again here as we've been notified that the channel is full
1351 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_3);
1352 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_4);
1353 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_5);
1355 // Close down the channels...
1356 close_channel(&nodes[0], &nodes[1], &chan_1.2, chan_1.3, true);
1357 close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, false);
1358 close_channel(&nodes[2], &nodes[3], &chan_3.2, chan_3.3, true);
1359 close_channel(&nodes[1], &nodes[3], &chan_4.2, chan_4.3, false);
1360 close_channel(&nodes[1], &nodes[3], &chan_5.2, chan_5.3, false);
1364 fn holding_cell_htlc_counting() {
1365 // Tests that HTLCs in the holding cell count towards the pending HTLC limits on outbound HTLCs
1366 // to ensure we don't end up with HTLCs sitting around in our holding cell for several
1367 // commitment dance rounds.
1368 let chanmon_cfgs = create_chanmon_cfgs(3);
1369 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1370 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1371 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1372 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
1373 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
1374 let logger = test_utils::TestLogger::new();
1376 let mut payments = Vec::new();
1377 for _ in 0..::ln::channel::OUR_MAX_HTLCS {
1378 let (payment_preimage, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[2]);
1379 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
1380 let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[2].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
1381 nodes[1].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
1382 payments.push((payment_preimage, payment_hash));
1384 check_added_monitors!(nodes[1], 1);
1386 let mut events = nodes[1].node.get_and_clear_pending_msg_events();
1387 assert_eq!(events.len(), 1);
1388 let initial_payment_event = SendEvent::from_event(events.pop().unwrap());
1389 assert_eq!(initial_payment_event.node_id, nodes[2].node.get_our_node_id());
1391 // There is now one HTLC in an outbound commitment transaction and (OUR_MAX_HTLCS - 1) HTLCs in
1392 // the holding cell waiting on B's RAA to send. At this point we should not be able to add
1394 let (_, payment_hash_1, payment_secret_1) = get_payment_preimage_hash!(nodes[2]);
1396 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
1397 let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[2].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
1398 unwrap_send_err!(nodes[1].node.send_payment(&route, payment_hash_1, &Some(payment_secret_1)), true, APIError::ChannelUnavailable { ref err },
1399 assert!(regex::Regex::new(r"Cannot push more than their max accepted HTLCs \(\d+\)").unwrap().is_match(err)));
1400 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1401 nodes[1].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot push more than their max accepted HTLCs".to_string(), 1);
1404 // This should also be true if we try to forward a payment.
1405 let (_, payment_hash_2, payment_secret_2) = get_payment_preimage_hash!(nodes[2]);
1407 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
1408 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[2].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
1409 nodes[0].node.send_payment(&route, payment_hash_2, &Some(payment_secret_2)).unwrap();
1410 check_added_monitors!(nodes[0], 1);
1413 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1414 assert_eq!(events.len(), 1);
1415 let payment_event = SendEvent::from_event(events.pop().unwrap());
1416 assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
1418 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1419 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
1420 // We have to forward pending HTLCs twice - once tries to forward the payment forward (and
1421 // fails), the second will process the resulting failure and fail the HTLC backward.
1422 expect_pending_htlcs_forwardable!(nodes[1]);
1423 expect_pending_htlcs_forwardable!(nodes[1]);
1424 check_added_monitors!(nodes[1], 1);
1426 let bs_fail_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1427 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &bs_fail_updates.update_fail_htlcs[0]);
1428 commitment_signed_dance!(nodes[0], nodes[1], bs_fail_updates.commitment_signed, false, true);
1430 expect_payment_failure_chan_update!(nodes[0], chan_2.0.contents.short_channel_id, false);
1431 expect_payment_failed!(nodes[0], payment_hash_2, false);
1433 // Now forward all the pending HTLCs and claim them back
1434 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &initial_payment_event.msgs[0]);
1435 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &initial_payment_event.commitment_msg);
1436 check_added_monitors!(nodes[2], 1);
1438 let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1439 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_revoke_and_ack);
1440 check_added_monitors!(nodes[1], 1);
1441 let as_updates = get_htlc_update_msgs!(nodes[1], nodes[2].node.get_our_node_id());
1443 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &bs_commitment_signed);
1444 check_added_monitors!(nodes[1], 1);
1445 let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
1447 for ref update in as_updates.update_add_htlcs.iter() {
1448 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), update);
1450 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &as_updates.commitment_signed);
1451 check_added_monitors!(nodes[2], 1);
1452 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
1453 check_added_monitors!(nodes[2], 1);
1454 let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1456 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_revoke_and_ack);
1457 check_added_monitors!(nodes[1], 1);
1458 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &bs_commitment_signed);
1459 check_added_monitors!(nodes[1], 1);
1460 let as_final_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
1462 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_final_raa);
1463 check_added_monitors!(nodes[2], 1);
1465 expect_pending_htlcs_forwardable!(nodes[2]);
1467 let events = nodes[2].node.get_and_clear_pending_events();
1468 assert_eq!(events.len(), payments.len());
1469 for (event, &(_, ref hash)) in events.iter().zip(payments.iter()) {
1471 &Event::PaymentReceived { ref payment_hash, .. } => {
1472 assert_eq!(*payment_hash, *hash);
1474 _ => panic!("Unexpected event"),
1478 for (preimage, _) in payments.drain(..) {
1479 claim_payment(&nodes[1], &[&nodes[2]], preimage);
1482 send_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1000000);
1486 fn duplicate_htlc_test() {
1487 // Test that we accept duplicate payment_hash HTLCs across the network and that
1488 // claiming/failing them are all separate and don't affect each other
1489 let chanmon_cfgs = create_chanmon_cfgs(6);
1490 let node_cfgs = create_node_cfgs(6, &chanmon_cfgs);
1491 let node_chanmgrs = create_node_chanmgrs(6, &node_cfgs, &[None, None, None, None, None, None]);
1492 let mut nodes = create_network(6, &node_cfgs, &node_chanmgrs);
1494 // Create some initial channels to route via 3 to 4/5 from 0/1/2
1495 create_announced_chan_between_nodes(&nodes, 0, 3, InitFeatures::known(), InitFeatures::known());
1496 create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known());
1497 create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
1498 create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::known(), InitFeatures::known());
1499 create_announced_chan_between_nodes(&nodes, 3, 5, InitFeatures::known(), InitFeatures::known());
1501 let (payment_preimage, payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[3], &nodes[4])[..], 1000000);
1503 *nodes[0].network_payment_count.borrow_mut() -= 1;
1504 assert_eq!(route_payment(&nodes[1], &vec!(&nodes[3])[..], 1000000).0, payment_preimage);
1506 *nodes[0].network_payment_count.borrow_mut() -= 1;
1507 assert_eq!(route_payment(&nodes[2], &vec!(&nodes[3], &nodes[5])[..], 1000000).0, payment_preimage);
1509 claim_payment(&nodes[0], &vec!(&nodes[3], &nodes[4])[..], payment_preimage);
1510 fail_payment(&nodes[2], &vec!(&nodes[3], &nodes[5])[..], payment_hash);
1511 claim_payment(&nodes[1], &vec!(&nodes[3])[..], payment_preimage);
1515 fn test_duplicate_htlc_different_direction_onchain() {
1516 // Test that ChannelMonitor doesn't generate 2 preimage txn
1517 // when we have 2 HTLCs with same preimage that go across a node
1518 // in opposite directions, even with the same payment secret.
1519 let chanmon_cfgs = create_chanmon_cfgs(2);
1520 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1521 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1522 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1524 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
1525 let logger = test_utils::TestLogger::new();
1528 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
1530 let (payment_preimage, payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 900_000);
1532 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
1533 let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[0].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 800_000, TEST_FINAL_CLTV, &logger).unwrap();
1534 let node_a_payment_secret = nodes[0].node.create_inbound_payment_for_hash(payment_hash, None, 7200, 0).unwrap();
1535 send_along_route_with_secret(&nodes[1], route, &[&[&nodes[0]]], 800_000, payment_hash, node_a_payment_secret);
1537 // Provide preimage to node 0 by claiming payment
1538 nodes[0].node.claim_funds(payment_preimage);
1539 check_added_monitors!(nodes[0], 1);
1541 // Broadcast node 1 commitment txn
1542 let remote_txn = get_local_commitment_txn!(nodes[1], chan_1.2);
1544 assert_eq!(remote_txn[0].output.len(), 4); // 1 local, 1 remote, 1 htlc inbound, 1 htlc outbound
1545 let mut has_both_htlcs = 0; // check htlcs match ones committed
1546 for outp in remote_txn[0].output.iter() {
1547 if outp.value == 800_000 / 1000 {
1548 has_both_htlcs += 1;
1549 } else if outp.value == 900_000 / 1000 {
1550 has_both_htlcs += 1;
1553 assert_eq!(has_both_htlcs, 2);
1555 mine_transaction(&nodes[0], &remote_txn[0]);
1556 check_added_monitors!(nodes[0], 1);
1557 connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
1559 // Check we only broadcast 1 timeout tx
1560 let claim_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
1561 assert_eq!(claim_txn.len(), 8);
1562 assert_eq!(claim_txn[1], claim_txn[4]);
1563 assert_eq!(claim_txn[2], claim_txn[5]);
1564 check_spends!(claim_txn[1], chan_1.3);
1565 check_spends!(claim_txn[2], claim_txn[1]);
1566 check_spends!(claim_txn[7], claim_txn[1]);
1568 assert_eq!(claim_txn[0].input.len(), 1);
1569 assert_eq!(claim_txn[3].input.len(), 1);
1570 assert_eq!(claim_txn[0].input[0].previous_output, claim_txn[3].input[0].previous_output);
1572 assert_eq!(claim_txn[0].input.len(), 1);
1573 assert_eq!(claim_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC 1 <--> 0, preimage tx
1574 check_spends!(claim_txn[0], remote_txn[0]);
1575 assert_eq!(remote_txn[0].output[claim_txn[0].input[0].previous_output.vout as usize].value, 800);
1576 assert_eq!(claim_txn[6].input.len(), 1);
1577 assert_eq!(claim_txn[6].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // HTLC 0 <--> 1, timeout tx
1578 check_spends!(claim_txn[6], remote_txn[0]);
1579 assert_eq!(remote_txn[0].output[claim_txn[6].input[0].previous_output.vout as usize].value, 900);
1581 let events = nodes[0].node.get_and_clear_pending_msg_events();
1582 assert_eq!(events.len(), 3);
1585 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
1586 MessageSendEvent::HandleError { node_id, action: msgs::ErrorAction::SendErrorMessage { ref msg } } => {
1587 assert_eq!(node_id, nodes[1].node.get_our_node_id());
1588 assert_eq!(msg.data, "Commitment or closing transaction was confirmed on chain.");
1590 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, .. } } => {
1591 assert!(update_add_htlcs.is_empty());
1592 assert!(update_fail_htlcs.is_empty());
1593 assert_eq!(update_fulfill_htlcs.len(), 1);
1594 assert!(update_fail_malformed_htlcs.is_empty());
1595 assert_eq!(nodes[1].node.get_our_node_id(), *node_id);
1597 _ => panic!("Unexpected event"),
1603 fn test_basic_channel_reserve() {
1604 let chanmon_cfgs = create_chanmon_cfgs(2);
1605 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1606 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1607 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1608 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1609 let logger = test_utils::TestLogger::new();
1611 let chan_stat = get_channel_value_stat!(nodes[0], chan.2);
1612 let channel_reserve = chan_stat.channel_reserve_msat;
1614 // The 2* and +1 are for the fee spike reserve.
1615 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
1616 let commit_tx_fee = 2 * commit_tx_fee_msat(get_feerate!(nodes[0], chan.2), 1 + 1);
1617 let max_can_send = 5000000 - channel_reserve - commit_tx_fee;
1618 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
1619 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes.last().unwrap().node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), max_can_send + 1, TEST_FINAL_CLTV, &logger).unwrap();
1620 let err = nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).err().unwrap();
1622 PaymentSendFailure::AllFailedRetrySafe(ref fails) => {
1624 &APIError::ChannelUnavailable{ref err} =>
1625 assert!(regex::Regex::new(r"Cannot send value that would put our balance under counterparty-announced channel reserve value \(\d+\)").unwrap().is_match(err)),
1626 _ => panic!("Unexpected error variant"),
1629 _ => panic!("Unexpected error variant"),
1631 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1632 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);
1634 send_payment(&nodes[0], &vec![&nodes[1]], max_can_send);
1638 fn test_fee_spike_violation_fails_htlc() {
1639 let chanmon_cfgs = create_chanmon_cfgs(2);
1640 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1641 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1642 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1643 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1645 let (route, payment_hash, _, payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], 3460001);
1646 // Need to manually create the update_add_htlc message to go around the channel reserve check in send_htlc()
1647 let secp_ctx = Secp256k1::new();
1648 let session_priv = SecretKey::from_slice(&[42; 32]).expect("RNG is bad!");
1650 let cur_height = nodes[1].node.best_block.read().unwrap().height() + 1;
1652 let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route.paths[0], &session_priv).unwrap();
1653 let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 3460001, &Some(payment_secret), cur_height, &None).unwrap();
1654 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
1655 let msg = msgs::UpdateAddHTLC {
1658 amount_msat: htlc_msat,
1659 payment_hash: payment_hash,
1660 cltv_expiry: htlc_cltv,
1661 onion_routing_packet: onion_packet,
1664 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
1666 // Now manually create the commitment_signed message corresponding to the update_add
1667 // nodes[0] just sent. In the code for construction of this message, "local" refers
1668 // to the sender of the message, and "remote" refers to the receiver.
1670 let feerate_per_kw = get_feerate!(nodes[0], chan.2);
1672 const INITIAL_COMMITMENT_NUMBER: u64 = (1 << 48) - 1;
1674 // Get the EnforcingSigner for each channel, which will be used to (1) get the keys
1675 // needed to sign the new commitment tx and (2) sign the new commitment tx.
1676 let (local_revocation_basepoint, local_htlc_basepoint, local_secret, next_local_point) = {
1677 let chan_lock = nodes[0].node.channel_state.lock().unwrap();
1678 let local_chan = chan_lock.by_id.get(&chan.2).unwrap();
1679 let chan_signer = local_chan.get_signer();
1680 let pubkeys = chan_signer.pubkeys();
1681 (pubkeys.revocation_basepoint, pubkeys.htlc_basepoint,
1682 chan_signer.release_commitment_secret(INITIAL_COMMITMENT_NUMBER),
1683 chan_signer.get_per_commitment_point(INITIAL_COMMITMENT_NUMBER - 2, &secp_ctx))
1685 let (remote_delayed_payment_basepoint, remote_htlc_basepoint,remote_point) = {
1686 let chan_lock = nodes[1].node.channel_state.lock().unwrap();
1687 let remote_chan = chan_lock.by_id.get(&chan.2).unwrap();
1688 let chan_signer = remote_chan.get_signer();
1689 let pubkeys = chan_signer.pubkeys();
1690 (pubkeys.delayed_payment_basepoint, pubkeys.htlc_basepoint,
1691 chan_signer.get_per_commitment_point(INITIAL_COMMITMENT_NUMBER - 1, &secp_ctx))
1694 // Assemble the set of keys we can use for signatures for our commitment_signed message.
1695 let commit_tx_keys = chan_utils::TxCreationKeys::derive_new(&secp_ctx, &remote_point, &remote_delayed_payment_basepoint,
1696 &remote_htlc_basepoint, &local_revocation_basepoint, &local_htlc_basepoint).unwrap();
1698 // Build the remote commitment transaction so we can sign it, and then later use the
1699 // signature for the commitment_signed message.
1700 let local_chan_balance = 1313;
1702 let accepted_htlc_info = chan_utils::HTLCOutputInCommitment {
1704 amount_msat: 3460001,
1705 cltv_expiry: htlc_cltv,
1707 transaction_output_index: Some(1),
1710 let commitment_number = INITIAL_COMMITMENT_NUMBER - 1;
1713 let local_chan_lock = nodes[0].node.channel_state.lock().unwrap();
1714 let local_chan = local_chan_lock.by_id.get(&chan.2).unwrap();
1715 let local_chan_signer = local_chan.get_signer();
1716 let commitment_tx = CommitmentTransaction::new_with_auxiliary_htlc_data(
1720 commit_tx_keys.clone(),
1722 &mut vec![(accepted_htlc_info, ())],
1723 &local_chan.channel_transaction_parameters.as_counterparty_broadcastable()
1725 local_chan_signer.sign_counterparty_commitment(&commitment_tx, &secp_ctx).unwrap()
1728 let commit_signed_msg = msgs::CommitmentSigned {
1731 htlc_signatures: res.1
1734 // Send the commitment_signed message to the nodes[1].
1735 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commit_signed_msg);
1736 let _ = nodes[1].node.get_and_clear_pending_msg_events();
1738 // Send the RAA to nodes[1].
1739 let raa_msg = msgs::RevokeAndACK {
1741 per_commitment_secret: local_secret,
1742 next_per_commitment_point: next_local_point
1744 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &raa_msg);
1746 let events = nodes[1].node.get_and_clear_pending_msg_events();
1747 assert_eq!(events.len(), 1);
1748 // Make sure the HTLC failed in the way we expect.
1750 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fail_htlcs, .. }, .. } => {
1751 assert_eq!(update_fail_htlcs.len(), 1);
1752 update_fail_htlcs[0].clone()
1754 _ => panic!("Unexpected event"),
1756 nodes[1].logger.assert_log("lightning::ln::channel".to_string(),
1757 format!("Attempting to fail HTLC due to fee spike buffer violation in channel {}. Rebalancing is required.", ::hex::encode(raa_msg.channel_id)), 1);
1759 check_added_monitors!(nodes[1], 2);
1763 fn test_chan_reserve_violation_outbound_htlc_inbound_chan() {
1764 let mut chanmon_cfgs = create_chanmon_cfgs(2);
1765 // Set the fee rate for the channel very high, to the point where the fundee
1766 // sending any above-dust amount would result in a channel reserve violation.
1767 // In this test we check that we would be prevented from sending an HTLC in
1769 let feerate_per_kw = 253;
1770 chanmon_cfgs[0].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(feerate_per_kw) };
1771 chanmon_cfgs[1].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(feerate_per_kw) };
1772 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1773 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1774 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1776 let mut push_amt = 100_000_000;
1777 push_amt -= feerate_per_kw as u64 * (COMMITMENT_TX_BASE_WEIGHT + COMMITMENT_TX_WEIGHT_PER_HTLC) / 1000 * 1000;
1778 push_amt -= Channel::<EnforcingSigner>::get_holder_selected_channel_reserve_satoshis(100_000) * 1000;
1780 let _ = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100_000, push_amt, InitFeatures::known(), InitFeatures::known());
1782 // Sending exactly enough to hit the reserve amount should be accepted
1783 let (_, _, _) = route_payment(&nodes[1], &[&nodes[0]], 1_000_000);
1785 // However one more HTLC should be significantly over the reserve amount and fail.
1786 let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[1], nodes[0], 1_000_000);
1787 unwrap_send_err!(nodes[1].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
1788 assert_eq!(err, "Cannot send value that would put counterparty balance under holder-announced channel reserve value"));
1789 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1790 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);
1794 fn test_chan_reserve_violation_inbound_htlc_outbound_channel() {
1795 let mut chanmon_cfgs = create_chanmon_cfgs(2);
1796 // Set the fee rate for the channel very high, to the point where the funder
1797 // receiving 1 update_add_htlc would result in them closing the channel due
1798 // to channel reserve violation. This close could also happen if the fee went
1799 // up a more realistic amount, but many HTLCs were outstanding at the time of
1800 // the update_add_htlc.
1801 chanmon_cfgs[0].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(6000) };
1802 chanmon_cfgs[1].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(6000) };
1803 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1804 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1805 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1806 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1808 let (route, payment_hash, _, payment_secret) = get_route_and_payment_hash!(nodes[1], nodes[0], 1000);
1809 // Need to manually create the update_add_htlc message to go around the channel reserve check in send_htlc()
1810 let secp_ctx = Secp256k1::new();
1811 let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
1812 let cur_height = nodes[1].node.best_block.read().unwrap().height() + 1;
1813 let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route.paths[0], &session_priv).unwrap();
1814 let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 1000, &Some(payment_secret), cur_height, &None).unwrap();
1815 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
1816 let msg = msgs::UpdateAddHTLC {
1819 amount_msat: htlc_msat + 1,
1820 payment_hash: payment_hash,
1821 cltv_expiry: htlc_cltv,
1822 onion_routing_packet: onion_packet,
1825 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &msg);
1826 // Check that the payment failed and the channel is closed in response to the malicious UpdateAdd.
1827 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);
1828 assert_eq!(nodes[0].node.list_channels().len(), 0);
1829 let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
1830 assert_eq!(err_msg.data, "Cannot accept HTLC that would put our balance under counterparty-announced channel reserve value");
1831 check_added_monitors!(nodes[0], 1);
1835 fn test_chan_reserve_dust_inbound_htlcs_outbound_chan() {
1836 // Test that if we receive many dust HTLCs over an outbound channel, they don't count when
1837 // calculating our commitment transaction fee (this was previously broken).
1838 let mut chanmon_cfgs = create_chanmon_cfgs(2);
1839 let feerate_per_kw = 253;
1840 chanmon_cfgs[0].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(feerate_per_kw) };
1841 chanmon_cfgs[1].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(feerate_per_kw) };
1843 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1844 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None, None]);
1845 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1847 // Set nodes[0]'s balance such that they will consider any above-dust received HTLC to be a
1848 // channel reserve violation (so their balance is channel reserve (1000 sats) + commitment
1849 // transaction fee with 0 HTLCs (183 sats)).
1850 let mut push_amt = 100_000_000;
1851 push_amt -= feerate_per_kw as u64 * (COMMITMENT_TX_BASE_WEIGHT) / 1000 * 1000;
1852 push_amt -= Channel::<EnforcingSigner>::get_holder_selected_channel_reserve_satoshis(100_000) * 1000;
1853 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, push_amt, InitFeatures::known(), InitFeatures::known());
1855 let dust_amt = crate::ln::channel::MIN_DUST_LIMIT_SATOSHIS * 1000
1856 + feerate_per_kw as u64 * HTLC_SUCCESS_TX_WEIGHT / 1000 * 1000 - 1;
1857 // In the previous code, routing this dust payment would cause nodes[0] to perceive a channel
1858 // reserve violation even though it's a dust HTLC and therefore shouldn't count towards the
1859 // commitment transaction fee.
1860 let (_, _, _) = route_payment(&nodes[1], &[&nodes[0]], dust_amt);
1862 // One more than the dust amt should fail, however.
1863 let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[1], nodes[0], dust_amt + 1);
1864 unwrap_send_err!(nodes[1].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
1865 assert_eq!(err, "Cannot send value that would put counterparty balance under holder-announced channel reserve value"));
1869 fn test_chan_reserve_dust_inbound_htlcs_inbound_chan() {
1870 // Test that if we receive many dust HTLCs over an inbound channel, they don't count when
1871 // calculating our counterparty's commitment transaction fee (this was previously broken).
1872 let chanmon_cfgs = create_chanmon_cfgs(2);
1873 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1874 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None, None]);
1875 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1876 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 98000000, InitFeatures::known(), InitFeatures::known());
1878 let payment_amt = 46000; // Dust amount
1879 // In the previous code, these first four payments would succeed.
1880 let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1881 let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1882 let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1883 let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1885 // Then these next 5 would be interpreted by nodes[1] as violating the fee spike buffer.
1886 let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1887 let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1888 let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1889 let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1890 let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1892 // And this last payment previously resulted in nodes[1] closing on its inbound-channel
1893 // counterparty, because it counted all the previous dust HTLCs against nodes[0]'s commitment
1894 // transaction fee and therefore perceived this next payment as a channel reserve violation.
1895 let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1899 fn test_chan_reserve_violation_inbound_htlc_inbound_chan() {
1900 let chanmon_cfgs = create_chanmon_cfgs(3);
1901 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1902 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1903 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1904 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1905 let _ = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1908 let total_routing_fee_msat = (nodes.len() - 2) as u64 * feemsat;
1909 let chan_stat = get_channel_value_stat!(nodes[0], chan.2);
1910 let feerate = get_feerate!(nodes[0], chan.2);
1912 // Add a 2* and +1 for the fee spike reserve.
1913 let commit_tx_fee_2_htlc = 2*commit_tx_fee_msat(feerate, 2 + 1);
1914 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;
1915 let amt_msat_1 = recv_value_1 + total_routing_fee_msat;
1917 // Add a pending HTLC.
1918 let (route_1, our_payment_hash_1, _, our_payment_secret_1) = get_route_and_payment_hash!(nodes[0], nodes[2], amt_msat_1);
1919 let payment_event_1 = {
1920 nodes[0].node.send_payment(&route_1, our_payment_hash_1, &Some(our_payment_secret_1)).unwrap();
1921 check_added_monitors!(nodes[0], 1);
1923 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1924 assert_eq!(events.len(), 1);
1925 SendEvent::from_event(events.remove(0))
1927 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event_1.msgs[0]);
1929 // Attempt to trigger a channel reserve violation --> payment failure.
1930 let commit_tx_fee_2_htlcs = commit_tx_fee_msat(feerate, 2);
1931 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;
1932 let amt_msat_2 = recv_value_2 + total_routing_fee_msat;
1933 let (route_2, _, _, _) = get_route_and_payment_hash!(nodes[0], nodes[2], amt_msat_2);
1935 // Need to manually create the update_add_htlc message to go around the channel reserve check in send_htlc()
1936 let secp_ctx = Secp256k1::new();
1937 let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
1938 let cur_height = nodes[0].node.best_block.read().unwrap().height() + 1;
1939 let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route_2.paths[0], &session_priv).unwrap();
1940 let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route_2.paths[0], recv_value_2, &None, cur_height, &None).unwrap();
1941 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &our_payment_hash_1);
1942 let msg = msgs::UpdateAddHTLC {
1945 amount_msat: htlc_msat + 1,
1946 payment_hash: our_payment_hash_1,
1947 cltv_expiry: htlc_cltv,
1948 onion_routing_packet: onion_packet,
1951 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
1952 // Check that the payment failed and the channel is closed in response to the malicious UpdateAdd.
1953 nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Remote HTLC add would put them under remote reserve value".to_string(), 1);
1954 assert_eq!(nodes[1].node.list_channels().len(), 1);
1955 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
1956 assert_eq!(err_msg.data, "Remote HTLC add would put them under remote reserve value");
1957 check_added_monitors!(nodes[1], 1);
1961 fn test_inbound_outbound_capacity_is_not_zero() {
1962 let chanmon_cfgs = create_chanmon_cfgs(2);
1963 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1964 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1965 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1966 let _ = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1967 let channels0 = node_chanmgrs[0].list_channels();
1968 let channels1 = node_chanmgrs[1].list_channels();
1969 assert_eq!(channels0.len(), 1);
1970 assert_eq!(channels1.len(), 1);
1972 let reserve = Channel::<EnforcingSigner>::get_holder_selected_channel_reserve_satoshis(100000);
1973 assert_eq!(channels0[0].inbound_capacity_msat, 95000000 - reserve*1000);
1974 assert_eq!(channels1[0].outbound_capacity_msat, 95000000 - reserve*1000);
1976 assert_eq!(channels0[0].outbound_capacity_msat, 100000 * 1000 - 95000000 - reserve*1000);
1977 assert_eq!(channels1[0].inbound_capacity_msat, 100000 * 1000 - 95000000 - reserve*1000);
1980 fn commit_tx_fee_msat(feerate: u32, num_htlcs: u64) -> u64 {
1981 (COMMITMENT_TX_BASE_WEIGHT + num_htlcs * COMMITMENT_TX_WEIGHT_PER_HTLC) * feerate as u64 / 1000 * 1000
1985 fn test_channel_reserve_holding_cell_htlcs() {
1986 let chanmon_cfgs = create_chanmon_cfgs(3);
1987 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1988 // When this test was written, the default base fee floated based on the HTLC count.
1989 // It is now fixed, so we simply set the fee to the expected value here.
1990 let mut config = test_default_channel_config();
1991 config.channel_options.forwarding_fee_base_msat = 239;
1992 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[Some(config.clone()), Some(config.clone()), Some(config.clone())]);
1993 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1994 let chan_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 190000, 1001, InitFeatures::known(), InitFeatures::known());
1995 let chan_2 = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 190000, 1001, InitFeatures::known(), InitFeatures::known());
1997 let mut stat01 = get_channel_value_stat!(nodes[0], chan_1.2);
1998 let mut stat11 = get_channel_value_stat!(nodes[1], chan_1.2);
2000 let mut stat12 = get_channel_value_stat!(nodes[1], chan_2.2);
2001 let mut stat22 = get_channel_value_stat!(nodes[2], chan_2.2);
2003 macro_rules! expect_forward {
2005 let mut events = $node.node.get_and_clear_pending_msg_events();
2006 assert_eq!(events.len(), 1);
2007 check_added_monitors!($node, 1);
2008 let payment_event = SendEvent::from_event(events.remove(0));
2013 let feemsat = 239; // set above
2014 let total_fee_msat = (nodes.len() - 2) as u64 * feemsat;
2015 let feerate = get_feerate!(nodes[0], chan_1.2);
2017 let recv_value_0 = stat01.counterparty_max_htlc_value_in_flight_msat - total_fee_msat;
2019 // attempt to send amt_msat > their_max_htlc_value_in_flight_msat
2021 let (mut route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], recv_value_0);
2022 route.paths[0].last_mut().unwrap().fee_msat += 1;
2023 assert!(route.paths[0].iter().rev().skip(1).all(|h| h.fee_msat == feemsat));
2024 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
2025 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)));
2026 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
2027 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);
2030 // channel reserve is bigger than their_max_htlc_value_in_flight_msat so loop to deplete
2031 // nodes[0]'s wealth
2033 let amt_msat = recv_value_0 + total_fee_msat;
2034 // 3 for the 3 HTLCs that will be sent, 2* and +1 for the fee spike reserve.
2035 // Also, ensure that each payment has enough to be over the dust limit to
2036 // ensure it'll be included in each commit tx fee calculation.
2037 let commit_tx_fee_all_htlcs = 2*commit_tx_fee_msat(feerate, 3 + 1);
2038 let ensure_htlc_amounts_above_dust_buffer = 3 * (stat01.counterparty_dust_limit_msat + 1000);
2039 if stat01.value_to_self_msat < stat01.channel_reserve_msat + commit_tx_fee_all_htlcs + ensure_htlc_amounts_above_dust_buffer + amt_msat {
2042 send_payment(&nodes[0], &vec![&nodes[1], &nodes[2]][..], recv_value_0);
2044 let (stat01_, stat11_, stat12_, stat22_) = (
2045 get_channel_value_stat!(nodes[0], chan_1.2),
2046 get_channel_value_stat!(nodes[1], chan_1.2),
2047 get_channel_value_stat!(nodes[1], chan_2.2),
2048 get_channel_value_stat!(nodes[2], chan_2.2),
2051 assert_eq!(stat01_.value_to_self_msat, stat01.value_to_self_msat - amt_msat);
2052 assert_eq!(stat11_.value_to_self_msat, stat11.value_to_self_msat + amt_msat);
2053 assert_eq!(stat12_.value_to_self_msat, stat12.value_to_self_msat - (amt_msat - feemsat));
2054 assert_eq!(stat22_.value_to_self_msat, stat22.value_to_self_msat + (amt_msat - feemsat));
2055 stat01 = stat01_; stat11 = stat11_; stat12 = stat12_; stat22 = stat22_;
2058 // adding pending output.
2059 // 2* and +1 HTLCs on the commit tx fee for the fee spike reserve.
2060 // The reason we're dividing by two here is as follows: the dividend is the total outbound liquidity
2061 // after fees, the channel reserve, and the fee spike buffer are removed. We eventually want to
2062 // divide this quantity into 3 portions, that will each be sent in an HTLC. This allows us
2063 // to test channel channel reserve policy at the edges of what amount is sendable, i.e.
2064 // cases where 1 msat over X amount will cause a payment failure, but anything less than
2065 // that can be sent successfully. So, dividing by two is a somewhat arbitrary way of getting
2066 // the amount of the first of these aforementioned 3 payments. The reason we split into 3 payments
2067 // is to test the behavior of the holding cell with respect to channel reserve and commit tx fee
2069 let commit_tx_fee_2_htlcs = 2*commit_tx_fee_msat(feerate, 2 + 1);
2070 let recv_value_1 = (stat01.value_to_self_msat - stat01.channel_reserve_msat - total_fee_msat - commit_tx_fee_2_htlcs)/2;
2071 let amt_msat_1 = recv_value_1 + total_fee_msat;
2073 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);
2074 let payment_event_1 = {
2075 nodes[0].node.send_payment(&route_1, our_payment_hash_1, &Some(our_payment_secret_1)).unwrap();
2076 check_added_monitors!(nodes[0], 1);
2078 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
2079 assert_eq!(events.len(), 1);
2080 SendEvent::from_event(events.remove(0))
2082 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event_1.msgs[0]);
2084 // channel reserve test with htlc pending output > 0
2085 let recv_value_2 = stat01.value_to_self_msat - amt_msat_1 - stat01.channel_reserve_msat - total_fee_msat - commit_tx_fee_2_htlcs;
2087 let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], recv_value_2 + 1);
2088 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
2089 assert!(regex::Regex::new(r"Cannot send value that would put our balance under counterparty-announced channel reserve value \(\d+\)").unwrap().is_match(err)));
2090 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
2093 // split the rest to test holding cell
2094 let commit_tx_fee_3_htlcs = 2*commit_tx_fee_msat(feerate, 3 + 1);
2095 let additional_htlc_cost_msat = commit_tx_fee_3_htlcs - commit_tx_fee_2_htlcs;
2096 let recv_value_21 = recv_value_2/2 - additional_htlc_cost_msat/2;
2097 let recv_value_22 = recv_value_2 - recv_value_21 - total_fee_msat - additional_htlc_cost_msat;
2099 let stat = get_channel_value_stat!(nodes[0], chan_1.2);
2100 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);
2103 // now see if they go through on both sides
2104 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);
2105 // but this will stuck in the holding cell
2106 nodes[0].node.send_payment(&route_21, our_payment_hash_21, &Some(our_payment_secret_21)).unwrap();
2107 check_added_monitors!(nodes[0], 0);
2108 let events = nodes[0].node.get_and_clear_pending_events();
2109 assert_eq!(events.len(), 0);
2111 // test with outbound holding cell amount > 0
2113 let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], recv_value_22+1);
2114 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
2115 assert!(regex::Regex::new(r"Cannot send value that would put our balance under counterparty-announced channel reserve value \(\d+\)").unwrap().is_match(err)));
2116 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
2117 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);
2120 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);
2121 // this will also stuck in the holding cell
2122 nodes[0].node.send_payment(&route_22, our_payment_hash_22, &Some(our_payment_secret_22)).unwrap();
2123 check_added_monitors!(nodes[0], 0);
2124 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
2125 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
2127 // flush the pending htlc
2128 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event_1.commitment_msg);
2129 let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2130 check_added_monitors!(nodes[1], 1);
2132 // the pending htlc should be promoted to committed
2133 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_revoke_and_ack);
2134 check_added_monitors!(nodes[0], 1);
2135 let commitment_update_2 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2137 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &as_commitment_signed);
2138 let bs_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2139 // No commitment_signed so get_event_msg's assert(len == 1) passes
2140 check_added_monitors!(nodes[0], 1);
2142 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &bs_revoke_and_ack);
2143 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2144 check_added_monitors!(nodes[1], 1);
2146 expect_pending_htlcs_forwardable!(nodes[1]);
2148 let ref payment_event_11 = expect_forward!(nodes[1]);
2149 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_11.msgs[0]);
2150 commitment_signed_dance!(nodes[2], nodes[1], payment_event_11.commitment_msg, false);
2152 expect_pending_htlcs_forwardable!(nodes[2]);
2153 expect_payment_received!(nodes[2], our_payment_hash_1, our_payment_secret_1, recv_value_1);
2155 // flush the htlcs in the holding cell
2156 assert_eq!(commitment_update_2.update_add_htlcs.len(), 2);
2157 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &commitment_update_2.update_add_htlcs[0]);
2158 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &commitment_update_2.update_add_htlcs[1]);
2159 commitment_signed_dance!(nodes[1], nodes[0], &commitment_update_2.commitment_signed, false);
2160 expect_pending_htlcs_forwardable!(nodes[1]);
2162 let ref payment_event_3 = expect_forward!(nodes[1]);
2163 assert_eq!(payment_event_3.msgs.len(), 2);
2164 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_3.msgs[0]);
2165 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_3.msgs[1]);
2167 commitment_signed_dance!(nodes[2], nodes[1], &payment_event_3.commitment_msg, false);
2168 expect_pending_htlcs_forwardable!(nodes[2]);
2170 let events = nodes[2].node.get_and_clear_pending_events();
2171 assert_eq!(events.len(), 2);
2173 Event::PaymentReceived { ref payment_hash, ref purpose, amt } => {
2174 assert_eq!(our_payment_hash_21, *payment_hash);
2175 assert_eq!(recv_value_21, amt);
2177 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
2178 assert!(payment_preimage.is_none());
2179 assert_eq!(our_payment_secret_21, *payment_secret);
2181 _ => panic!("expected PaymentPurpose::InvoicePayment")
2184 _ => panic!("Unexpected event"),
2187 Event::PaymentReceived { ref payment_hash, ref purpose, amt } => {
2188 assert_eq!(our_payment_hash_22, *payment_hash);
2189 assert_eq!(recv_value_22, amt);
2191 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
2192 assert!(payment_preimage.is_none());
2193 assert_eq!(our_payment_secret_22, *payment_secret);
2195 _ => panic!("expected PaymentPurpose::InvoicePayment")
2198 _ => panic!("Unexpected event"),
2201 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_1);
2202 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_21);
2203 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_22);
2205 let commit_tx_fee_0_htlcs = 2*commit_tx_fee_msat(feerate, 1);
2206 let recv_value_3 = commit_tx_fee_2_htlcs - commit_tx_fee_0_htlcs - total_fee_msat;
2207 send_payment(&nodes[0], &vec![&nodes[1], &nodes[2]][..], recv_value_3);
2209 let commit_tx_fee_1_htlc = 2*commit_tx_fee_msat(feerate, 1 + 1);
2210 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);
2211 let stat0 = get_channel_value_stat!(nodes[0], chan_1.2);
2212 assert_eq!(stat0.value_to_self_msat, expected_value_to_self);
2213 assert_eq!(stat0.value_to_self_msat, stat0.channel_reserve_msat + commit_tx_fee_1_htlc);
2215 let stat2 = get_channel_value_stat!(nodes[2], chan_2.2);
2216 assert_eq!(stat2.value_to_self_msat, stat22.value_to_self_msat + recv_value_1 + recv_value_21 + recv_value_22 + recv_value_3);
2220 fn channel_reserve_in_flight_removes() {
2221 // In cases where one side claims an HTLC, it thinks it has additional available funds that it
2222 // can send to its counterparty, but due to update ordering, the other side may not yet have
2223 // considered those HTLCs fully removed.
2224 // This tests that we don't count HTLCs which will not be included in the next remote
2225 // commitment transaction towards the reserve value (as it implies no commitment transaction
2226 // will be generated which violates the remote reserve value).
2227 // This was broken previously, and discovered by the chanmon_fail_consistency fuzz test.
2229 // * route two HTLCs from A to B (note that, at a high level, this test is checking that, when
2230 // you consider the values of both of these HTLCs, B may not send an HTLC back to A, but if
2231 // you only consider the value of the first HTLC, it may not),
2232 // * start routing a third HTLC from A to B,
2233 // * claim the first two HTLCs (though B will generate an update_fulfill for one, and put
2234 // the other claim in its holding cell, as it immediately goes into AwaitingRAA),
2235 // * deliver the first fulfill from B
2236 // * deliver the update_add and an RAA from A, resulting in B freeing the second holding cell
2238 // * deliver A's response CS and RAA.
2239 // This results in A having the second HTLC in AwaitingRemovedRemoteRevoke, but B having
2240 // removed it fully. B now has the push_msat plus the first two HTLCs in value.
2241 // * Now B happily sends another HTLC, potentially violating its reserve value from A's point
2242 // of view (if A counts the AwaitingRemovedRemoteRevoke HTLC).
2243 let chanmon_cfgs = create_chanmon_cfgs(2);
2244 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2245 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2246 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2247 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2248 let logger = test_utils::TestLogger::new();
2250 let b_chan_values = get_channel_value_stat!(nodes[1], chan_1.2);
2251 // Route the first two HTLCs.
2252 let (payment_preimage_1, _, _) = route_payment(&nodes[0], &[&nodes[1]], b_chan_values.channel_reserve_msat - b_chan_values.value_to_self_msat - 10000);
2253 let (payment_preimage_2, _, _) = route_payment(&nodes[0], &[&nodes[1]], 20000);
2255 // Start routing the third HTLC (this is just used to get everyone in the right state).
2256 let (payment_preimage_3, payment_hash_3, payment_secret_3) = get_payment_preimage_hash!(nodes[1]);
2258 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
2259 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
2260 nodes[0].node.send_payment(&route, payment_hash_3, &Some(payment_secret_3)).unwrap();
2261 check_added_monitors!(nodes[0], 1);
2262 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
2263 assert_eq!(events.len(), 1);
2264 SendEvent::from_event(events.remove(0))
2267 // Now claim both of the first two HTLCs on B's end, putting B in AwaitingRAA and generating an
2268 // initial fulfill/CS.
2269 assert!(nodes[1].node.claim_funds(payment_preimage_1));
2270 check_added_monitors!(nodes[1], 1);
2271 let bs_removes = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2273 // This claim goes in B's holding cell, allowing us to have a pending B->A RAA which does not
2274 // remove the second HTLC when we send the HTLC back from B to A.
2275 assert!(nodes[1].node.claim_funds(payment_preimage_2));
2276 check_added_monitors!(nodes[1], 1);
2277 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2279 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_removes.update_fulfill_htlcs[0]);
2280 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_removes.commitment_signed);
2281 check_added_monitors!(nodes[0], 1);
2282 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2283 expect_payment_sent!(nodes[0], payment_preimage_1);
2285 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_1.msgs[0]);
2286 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &send_1.commitment_msg);
2287 check_added_monitors!(nodes[1], 1);
2288 // B is already AwaitingRAA, so cant generate a CS here
2289 let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2291 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
2292 check_added_monitors!(nodes[1], 1);
2293 let bs_cs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2295 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2296 check_added_monitors!(nodes[0], 1);
2297 let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2299 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
2300 check_added_monitors!(nodes[1], 1);
2301 let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2303 // The second HTLCis removed, but as A is in AwaitingRAA it can't generate a CS here, so the
2304 // RAA that B generated above doesn't fully resolve the second HTLC from A's point of view.
2305 // However, the RAA A generates here *does* fully resolve the HTLC from B's point of view (as A
2306 // can no longer broadcast a commitment transaction with it and B has the preimage so can go
2307 // on-chain as necessary).
2308 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_cs.update_fulfill_htlcs[0]);
2309 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_cs.commitment_signed);
2310 check_added_monitors!(nodes[0], 1);
2311 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2312 expect_payment_sent!(nodes[0], payment_preimage_2);
2314 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
2315 check_added_monitors!(nodes[1], 1);
2316 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2318 expect_pending_htlcs_forwardable!(nodes[1]);
2319 expect_payment_received!(nodes[1], payment_hash_3, payment_secret_3, 100000);
2321 // Note that as this RAA was generated before the delivery of the update_fulfill it shouldn't
2322 // resolve the second HTLC from A's point of view.
2323 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2324 check_added_monitors!(nodes[0], 1);
2325 let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2327 // Now that B doesn't have the second RAA anymore, but A still does, send a payment from B back
2328 // to A to ensure that A doesn't count the almost-removed HTLC in update_add processing.
2329 let (payment_preimage_4, payment_hash_4, payment_secret_4) = get_payment_preimage_hash!(nodes[0]);
2331 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
2332 let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[0].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 10000, TEST_FINAL_CLTV, &logger).unwrap();
2333 nodes[1].node.send_payment(&route, payment_hash_4, &Some(payment_secret_4)).unwrap();
2334 check_added_monitors!(nodes[1], 1);
2335 let mut events = nodes[1].node.get_and_clear_pending_msg_events();
2336 assert_eq!(events.len(), 1);
2337 SendEvent::from_event(events.remove(0))
2340 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &send_2.msgs[0]);
2341 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &send_2.commitment_msg);
2342 check_added_monitors!(nodes[0], 1);
2343 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2345 // Now just resolve all the outstanding messages/HTLCs for completeness...
2347 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
2348 check_added_monitors!(nodes[1], 1);
2349 let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2351 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
2352 check_added_monitors!(nodes[1], 1);
2354 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2355 check_added_monitors!(nodes[0], 1);
2356 let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2358 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
2359 check_added_monitors!(nodes[1], 1);
2360 let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2362 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2363 check_added_monitors!(nodes[0], 1);
2365 expect_pending_htlcs_forwardable!(nodes[0]);
2366 expect_payment_received!(nodes[0], payment_hash_4, payment_secret_4, 10000);
2368 claim_payment(&nodes[1], &[&nodes[0]], payment_preimage_4);
2369 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_3);
2373 fn channel_monitor_network_test() {
2374 // Simple test which builds a network of ChannelManagers, connects them to each other, and
2375 // tests that ChannelMonitor is able to recover from various states.
2376 let chanmon_cfgs = create_chanmon_cfgs(5);
2377 let node_cfgs = create_node_cfgs(5, &chanmon_cfgs);
2378 let node_chanmgrs = create_node_chanmgrs(5, &node_cfgs, &[None, None, None, None, None]);
2379 let nodes = create_network(5, &node_cfgs, &node_chanmgrs);
2381 // Create some initial channels
2382 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2383 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
2384 let chan_3 = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
2385 let chan_4 = create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::known(), InitFeatures::known());
2387 // Make sure all nodes are at the same starting height
2388 connect_blocks(&nodes[0], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[0].best_block_info().1);
2389 connect_blocks(&nodes[1], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[1].best_block_info().1);
2390 connect_blocks(&nodes[2], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[2].best_block_info().1);
2391 connect_blocks(&nodes[3], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[3].best_block_info().1);
2392 connect_blocks(&nodes[4], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[4].best_block_info().1);
2394 // Rebalance the network a bit by relaying one payment through all the channels...
2395 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
2396 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
2397 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
2398 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
2400 // Simple case with no pending HTLCs:
2401 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), true);
2402 check_added_monitors!(nodes[1], 1);
2403 check_closed_broadcast!(nodes[1], false);
2405 let mut node_txn = test_txn_broadcast(&nodes[1], &chan_1, None, HTLCType::NONE);
2406 assert_eq!(node_txn.len(), 1);
2407 mine_transaction(&nodes[0], &node_txn[0]);
2408 check_added_monitors!(nodes[0], 1);
2409 test_txn_broadcast(&nodes[0], &chan_1, None, HTLCType::NONE);
2411 check_closed_broadcast!(nodes[0], true);
2412 assert_eq!(nodes[0].node.list_channels().len(), 0);
2413 assert_eq!(nodes[1].node.list_channels().len(), 1);
2415 // One pending HTLC is discarded by the force-close:
2416 let payment_preimage_1 = route_payment(&nodes[1], &vec!(&nodes[2], &nodes[3])[..], 3000000).0;
2418 // Simple case of one pending HTLC to HTLC-Timeout (note that the HTLC-Timeout is not
2419 // broadcasted until we reach the timelock time).
2420 nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id(), true);
2421 check_closed_broadcast!(nodes[1], false);
2422 check_added_monitors!(nodes[1], 1);
2424 let mut node_txn = test_txn_broadcast(&nodes[1], &chan_2, None, HTLCType::NONE);
2425 connect_blocks(&nodes[1], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + MIN_CLTV_EXPIRY_DELTA as u32 + 1);
2426 test_txn_broadcast(&nodes[1], &chan_2, None, HTLCType::TIMEOUT);
2427 mine_transaction(&nodes[2], &node_txn[0]);
2428 check_added_monitors!(nodes[2], 1);
2429 test_txn_broadcast(&nodes[2], &chan_2, None, HTLCType::NONE);
2431 check_closed_broadcast!(nodes[2], true);
2432 assert_eq!(nodes[1].node.list_channels().len(), 0);
2433 assert_eq!(nodes[2].node.list_channels().len(), 1);
2435 macro_rules! claim_funds {
2436 ($node: expr, $prev_node: expr, $preimage: expr) => {
2438 assert!($node.node.claim_funds($preimage));
2439 check_added_monitors!($node, 1);
2441 let events = $node.node.get_and_clear_pending_msg_events();
2442 assert_eq!(events.len(), 1);
2444 MessageSendEvent::UpdateHTLCs { ref node_id, updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fail_htlcs, .. } } => {
2445 assert!(update_add_htlcs.is_empty());
2446 assert!(update_fail_htlcs.is_empty());
2447 assert_eq!(*node_id, $prev_node.node.get_our_node_id());
2449 _ => panic!("Unexpected event"),
2455 // nodes[3] gets the preimage, but nodes[2] already disconnected, resulting in a nodes[2]
2456 // HTLC-Timeout and a nodes[3] claim against it (+ its own announces)
2457 nodes[2].node.peer_disconnected(&nodes[3].node.get_our_node_id(), true);
2458 check_added_monitors!(nodes[2], 1);
2459 check_closed_broadcast!(nodes[2], false);
2460 let node2_commitment_txid;
2462 let node_txn = test_txn_broadcast(&nodes[2], &chan_3, None, HTLCType::NONE);
2463 connect_blocks(&nodes[2], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + MIN_CLTV_EXPIRY_DELTA as u32 + 1);
2464 test_txn_broadcast(&nodes[2], &chan_3, None, HTLCType::TIMEOUT);
2465 node2_commitment_txid = node_txn[0].txid();
2467 // Claim the payment on nodes[3], giving it knowledge of the preimage
2468 claim_funds!(nodes[3], nodes[2], payment_preimage_1);
2469 mine_transaction(&nodes[3], &node_txn[0]);
2470 check_added_monitors!(nodes[3], 1);
2471 check_preimage_claim(&nodes[3], &node_txn);
2473 check_closed_broadcast!(nodes[3], true);
2474 assert_eq!(nodes[2].node.list_channels().len(), 0);
2475 assert_eq!(nodes[3].node.list_channels().len(), 1);
2477 // Drop the ChannelMonitor for the previous channel to avoid it broadcasting transactions and
2478 // confusing us in the following tests.
2479 let chan_3_mon = nodes[3].chain_monitor.chain_monitor.monitors.write().unwrap().remove(&OutPoint { txid: chan_3.3.txid(), index: 0 }).unwrap();
2481 // One pending HTLC to time out:
2482 let payment_preimage_2 = route_payment(&nodes[3], &vec!(&nodes[4])[..], 3000000).0;
2483 // CLTV expires at TEST_FINAL_CLTV + 1 (current height) + 1 (added in send_payment for
2486 let (close_chan_update_1, close_chan_update_2) = {
2487 connect_blocks(&nodes[3], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + 1);
2488 let events = nodes[3].node.get_and_clear_pending_msg_events();
2489 assert_eq!(events.len(), 2);
2490 let close_chan_update_1 = match events[0] {
2491 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
2494 _ => panic!("Unexpected event"),
2497 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { .. }, node_id } => {
2498 assert_eq!(node_id, nodes[4].node.get_our_node_id());
2500 _ => panic!("Unexpected event"),
2502 check_added_monitors!(nodes[3], 1);
2504 // Clear bumped claiming txn spending node 2 commitment tx. Bumped txn are generated after reaching some height timer.
2506 let mut node_txn = nodes[3].tx_broadcaster.txn_broadcasted.lock().unwrap();
2507 node_txn.retain(|tx| {
2508 if tx.input[0].previous_output.txid == node2_commitment_txid {
2514 let node_txn = test_txn_broadcast(&nodes[3], &chan_4, None, HTLCType::TIMEOUT);
2516 // Claim the payment on nodes[4], giving it knowledge of the preimage
2517 claim_funds!(nodes[4], nodes[3], payment_preimage_2);
2519 connect_blocks(&nodes[4], TEST_FINAL_CLTV - CLTV_CLAIM_BUFFER + 2);
2520 let events = nodes[4].node.get_and_clear_pending_msg_events();
2521 assert_eq!(events.len(), 2);
2522 let close_chan_update_2 = match events[0] {
2523 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
2526 _ => panic!("Unexpected event"),
2529 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { .. }, node_id } => {
2530 assert_eq!(node_id, nodes[3].node.get_our_node_id());
2532 _ => panic!("Unexpected event"),
2534 check_added_monitors!(nodes[4], 1);
2535 test_txn_broadcast(&nodes[4], &chan_4, None, HTLCType::SUCCESS);
2537 mine_transaction(&nodes[4], &node_txn[0]);
2538 check_preimage_claim(&nodes[4], &node_txn);
2539 (close_chan_update_1, close_chan_update_2)
2541 nodes[3].net_graph_msg_handler.handle_channel_update(&close_chan_update_2).unwrap();
2542 nodes[4].net_graph_msg_handler.handle_channel_update(&close_chan_update_1).unwrap();
2543 assert_eq!(nodes[3].node.list_channels().len(), 0);
2544 assert_eq!(nodes[4].node.list_channels().len(), 0);
2546 nodes[3].chain_monitor.chain_monitor.monitors.write().unwrap().insert(OutPoint { txid: chan_3.3.txid(), index: 0 }, chan_3_mon);
2550 fn test_justice_tx() {
2551 // Test justice txn built on revoked HTLC-Success tx, against both sides
2552 let mut alice_config = UserConfig::default();
2553 alice_config.channel_options.announced_channel = true;
2554 alice_config.peer_channel_config_limits.force_announced_channel_preference = false;
2555 alice_config.own_channel_config.our_to_self_delay = 6 * 24 * 5;
2556 let mut bob_config = UserConfig::default();
2557 bob_config.channel_options.announced_channel = true;
2558 bob_config.peer_channel_config_limits.force_announced_channel_preference = false;
2559 bob_config.own_channel_config.our_to_self_delay = 6 * 24 * 3;
2560 let user_cfgs = [Some(alice_config), Some(bob_config)];
2561 let mut chanmon_cfgs = create_chanmon_cfgs(2);
2562 chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
2563 chanmon_cfgs[1].keys_manager.disable_revocation_policy_check = true;
2564 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2565 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &user_cfgs);
2566 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2567 // Create some new channels:
2568 let chan_5 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2570 // A pending HTLC which will be revoked:
2571 let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2572 // Get the will-be-revoked local txn from nodes[0]
2573 let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_5.2);
2574 assert_eq!(revoked_local_txn.len(), 2); // First commitment tx, then HTLC tx
2575 assert_eq!(revoked_local_txn[0].input.len(), 1);
2576 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_5.3.txid());
2577 assert_eq!(revoked_local_txn[0].output.len(), 2); // Only HTLC and output back to 0 are present
2578 assert_eq!(revoked_local_txn[1].input.len(), 1);
2579 assert_eq!(revoked_local_txn[1].input[0].previous_output.txid, revoked_local_txn[0].txid());
2580 assert_eq!(revoked_local_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC-Timeout
2581 // Revoke the old state
2582 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_3);
2585 mine_transaction(&nodes[1], &revoked_local_txn[0]);
2587 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2588 assert_eq!(node_txn.len(), 2); // ChannelMonitor: penalty tx, ChannelManager: local commitment tx
2589 assert_eq!(node_txn[0].input.len(), 2); // We should claim the revoked output and the HTLC output
2591 check_spends!(node_txn[0], revoked_local_txn[0]);
2592 node_txn.swap_remove(0);
2593 node_txn.truncate(1);
2595 check_added_monitors!(nodes[1], 1);
2596 test_txn_broadcast(&nodes[1], &chan_5, None, HTLCType::NONE);
2598 mine_transaction(&nodes[0], &revoked_local_txn[0]);
2599 connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
2600 // Verify broadcast of revoked HTLC-timeout
2601 let node_txn = test_txn_broadcast(&nodes[0], &chan_5, Some(revoked_local_txn[0].clone()), HTLCType::TIMEOUT);
2602 check_added_monitors!(nodes[0], 1);
2603 // Broadcast revoked HTLC-timeout on node 1
2604 mine_transaction(&nodes[1], &node_txn[1]);
2605 test_revoked_htlc_claim_txn_broadcast(&nodes[1], node_txn[1].clone(), revoked_local_txn[0].clone());
2607 get_announce_close_broadcast_events(&nodes, 0, 1);
2609 assert_eq!(nodes[0].node.list_channels().len(), 0);
2610 assert_eq!(nodes[1].node.list_channels().len(), 0);
2612 // We test justice_tx build by A on B's revoked HTLC-Success tx
2613 // Create some new channels:
2614 let chan_6 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2616 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2620 // A pending HTLC which will be revoked:
2621 let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2622 // Get the will-be-revoked local txn from B
2623 let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan_6.2);
2624 assert_eq!(revoked_local_txn.len(), 1); // Only commitment tx
2625 assert_eq!(revoked_local_txn[0].input.len(), 1);
2626 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_6.3.txid());
2627 assert_eq!(revoked_local_txn[0].output.len(), 2); // Only HTLC and output back to A are present
2628 // Revoke the old state
2629 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_4);
2631 mine_transaction(&nodes[0], &revoked_local_txn[0]);
2633 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
2634 assert_eq!(node_txn.len(), 2); //ChannelMonitor: penalty tx, ChannelManager: local commitment tx
2635 assert_eq!(node_txn[0].input.len(), 1); // We claim the received HTLC output
2637 check_spends!(node_txn[0], revoked_local_txn[0]);
2638 node_txn.swap_remove(0);
2640 check_added_monitors!(nodes[0], 1);
2641 test_txn_broadcast(&nodes[0], &chan_6, None, HTLCType::NONE);
2643 mine_transaction(&nodes[1], &revoked_local_txn[0]);
2644 let node_txn = test_txn_broadcast(&nodes[1], &chan_6, Some(revoked_local_txn[0].clone()), HTLCType::SUCCESS);
2645 check_added_monitors!(nodes[1], 1);
2646 mine_transaction(&nodes[0], &node_txn[1]);
2647 test_revoked_htlc_claim_txn_broadcast(&nodes[0], node_txn[1].clone(), revoked_local_txn[0].clone());
2649 get_announce_close_broadcast_events(&nodes, 0, 1);
2650 assert_eq!(nodes[0].node.list_channels().len(), 0);
2651 assert_eq!(nodes[1].node.list_channels().len(), 0);
2655 fn revoked_output_claim() {
2656 // Simple test to ensure a node will claim a revoked output when a stale remote commitment
2657 // transaction is broadcast by its counterparty
2658 let chanmon_cfgs = create_chanmon_cfgs(2);
2659 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2660 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2661 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2662 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2663 // node[0] is gonna to revoke an old state thus node[1] should be able to claim the revoked output
2664 let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2665 assert_eq!(revoked_local_txn.len(), 1);
2666 // Only output is the full channel value back to nodes[0]:
2667 assert_eq!(revoked_local_txn[0].output.len(), 1);
2668 // Send a payment through, updating everyone's latest commitment txn
2669 send_payment(&nodes[0], &vec!(&nodes[1])[..], 5000000);
2671 // Inform nodes[1] that nodes[0] broadcast a stale tx
2672 mine_transaction(&nodes[1], &revoked_local_txn[0]);
2673 check_added_monitors!(nodes[1], 1);
2674 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2675 assert_eq!(node_txn.len(), 2); // ChannelMonitor: justice tx against revoked to_local output, ChannelManager: local commitment tx
2677 check_spends!(node_txn[0], revoked_local_txn[0]);
2678 check_spends!(node_txn[1], chan_1.3);
2680 // Inform nodes[0] that a watchtower cheated on its behalf, so it will force-close the chan
2681 mine_transaction(&nodes[0], &revoked_local_txn[0]);
2682 get_announce_close_broadcast_events(&nodes, 0, 1);
2683 check_added_monitors!(nodes[0], 1)
2687 fn claim_htlc_outputs_shared_tx() {
2688 // Node revoked old state, htlcs haven't time out yet, claim them in shared justice tx
2689 let mut chanmon_cfgs = create_chanmon_cfgs(2);
2690 chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
2691 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2692 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2693 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2695 // Create some new channel:
2696 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2698 // Rebalance the network to generate htlc in the two directions
2699 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
2700 // node[0] is gonna to revoke an old state thus node[1] should be able to claim both offered/received HTLC outputs on top of commitment tx
2701 let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2702 let (_payment_preimage_2, payment_hash_2, _) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000);
2704 // Get the will-be-revoked local txn from node[0]
2705 let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2706 assert_eq!(revoked_local_txn.len(), 2); // commitment tx + 1 HTLC-Timeout tx
2707 assert_eq!(revoked_local_txn[0].input.len(), 1);
2708 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
2709 assert_eq!(revoked_local_txn[1].input.len(), 1);
2710 assert_eq!(revoked_local_txn[1].input[0].previous_output.txid, revoked_local_txn[0].txid());
2711 assert_eq!(revoked_local_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC-Timeout
2712 check_spends!(revoked_local_txn[1], revoked_local_txn[0]);
2714 //Revoke the old state
2715 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_1);
2718 mine_transaction(&nodes[0], &revoked_local_txn[0]);
2719 check_added_monitors!(nodes[0], 1);
2720 mine_transaction(&nodes[1], &revoked_local_txn[0]);
2721 check_added_monitors!(nodes[1], 1);
2722 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
2723 expect_payment_failed!(nodes[1], payment_hash_2, true);
2725 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2726 assert_eq!(node_txn.len(), 2); // ChannelMonitor: penalty tx, ChannelManager: local commitment
2728 assert_eq!(node_txn[0].input.len(), 3); // Claim the revoked output + both revoked HTLC outputs
2729 check_spends!(node_txn[0], revoked_local_txn[0]);
2731 let mut witness_lens = BTreeSet::new();
2732 witness_lens.insert(node_txn[0].input[0].witness.last().unwrap().len());
2733 witness_lens.insert(node_txn[0].input[1].witness.last().unwrap().len());
2734 witness_lens.insert(node_txn[0].input[2].witness.last().unwrap().len());
2735 assert_eq!(witness_lens.len(), 3);
2736 assert_eq!(*witness_lens.iter().skip(0).next().unwrap(), 77); // revoked to_local
2737 assert_eq!(*witness_lens.iter().skip(1).next().unwrap(), OFFERED_HTLC_SCRIPT_WEIGHT); // revoked offered HTLC
2738 assert_eq!(*witness_lens.iter().skip(2).next().unwrap(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // revoked received HTLC
2740 // Next nodes[1] broadcasts its current local tx state:
2741 assert_eq!(node_txn[1].input.len(), 1);
2742 assert_eq!(node_txn[1].input[0].previous_output.txid, chan_1.3.txid()); //Spending funding tx unique txouput, tx broadcasted by ChannelManager
2744 get_announce_close_broadcast_events(&nodes, 0, 1);
2745 assert_eq!(nodes[0].node.list_channels().len(), 0);
2746 assert_eq!(nodes[1].node.list_channels().len(), 0);
2750 fn claim_htlc_outputs_single_tx() {
2751 // Node revoked old state, htlcs have timed out, claim each of them in separated justice tx
2752 let mut chanmon_cfgs = create_chanmon_cfgs(2);
2753 chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
2754 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2755 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2756 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2758 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2760 // Rebalance the network to generate htlc in the two directions
2761 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
2762 // 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
2763 // time as two different claim transactions as we're gonna to timeout htlc with given a high current height
2764 let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2765 let (_payment_preimage_2, payment_hash_2, _payment_secret_2) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000);
2767 // Get the will-be-revoked local txn from node[0]
2768 let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2770 //Revoke the old state
2771 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_1);
2774 confirm_transaction_at(&nodes[0], &revoked_local_txn[0], 100);
2775 check_added_monitors!(nodes[0], 1);
2776 confirm_transaction_at(&nodes[1], &revoked_local_txn[0], 100);
2777 check_added_monitors!(nodes[1], 1);
2778 expect_pending_htlcs_forwardable_ignore!(nodes[0]);
2780 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
2781 expect_payment_failed!(nodes[1], payment_hash_2, true);
2783 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2784 assert_eq!(node_txn.len(), 9);
2785 // ChannelMonitor: justice tx revoked offered htlc, justice tx revoked received htlc, justice tx revoked to_local (3)
2786 // ChannelManager: local commmitment + local HTLC-timeout (2)
2787 // 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)
2788 // ChannelMonitor: local commitment + local HTLC-timeout (2)
2790 // Check the pair local commitment and HTLC-timeout broadcast due to HTLC expiration
2791 assert_eq!(node_txn[0].input.len(), 1);
2792 check_spends!(node_txn[0], chan_1.3);
2793 assert_eq!(node_txn[1].input.len(), 1);
2794 let witness_script = node_txn[1].input[0].witness.last().unwrap();
2795 assert_eq!(witness_script.len(), OFFERED_HTLC_SCRIPT_WEIGHT); //Spending an offered htlc output
2796 check_spends!(node_txn[1], node_txn[0]);
2798 // Justice transactions are indices 1-2-4
2799 assert_eq!(node_txn[2].input.len(), 1);
2800 assert_eq!(node_txn[3].input.len(), 1);
2801 assert_eq!(node_txn[4].input.len(), 1);
2803 check_spends!(node_txn[2], revoked_local_txn[0]);
2804 check_spends!(node_txn[3], revoked_local_txn[0]);
2805 check_spends!(node_txn[4], revoked_local_txn[0]);
2807 let mut witness_lens = BTreeSet::new();
2808 witness_lens.insert(node_txn[2].input[0].witness.last().unwrap().len());
2809 witness_lens.insert(node_txn[3].input[0].witness.last().unwrap().len());
2810 witness_lens.insert(node_txn[4].input[0].witness.last().unwrap().len());
2811 assert_eq!(witness_lens.len(), 3);
2812 assert_eq!(*witness_lens.iter().skip(0).next().unwrap(), 77); // revoked to_local
2813 assert_eq!(*witness_lens.iter().skip(1).next().unwrap(), OFFERED_HTLC_SCRIPT_WEIGHT); // revoked offered HTLC
2814 assert_eq!(*witness_lens.iter().skip(2).next().unwrap(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // revoked received HTLC
2816 get_announce_close_broadcast_events(&nodes, 0, 1);
2817 assert_eq!(nodes[0].node.list_channels().len(), 0);
2818 assert_eq!(nodes[1].node.list_channels().len(), 0);
2822 fn test_htlc_on_chain_success() {
2823 // Test that in case of a unilateral close onchain, we detect the state of output and pass
2824 // the preimage backward accordingly. So here we test that ChannelManager is
2825 // broadcasting the right event to other nodes in payment path.
2826 // We test with two HTLCs simultaneously as that was not handled correctly in the past.
2827 // A --------------------> B ----------------------> C (preimage)
2828 // First, C should claim the HTLC outputs via HTLC-Success when its own latest local
2829 // commitment transaction was broadcast.
2830 // Then, B should learn the preimage from said transactions, attempting to claim backwards
2832 // B should be able to claim via preimage if A then broadcasts its local tx.
2833 // Finally, when A sees B's latest local commitment transaction it should be able to claim
2834 // the HTLC outputs via the preimage it learned (which, once confirmed should generate a
2835 // PaymentSent event).
2837 let chanmon_cfgs = create_chanmon_cfgs(3);
2838 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2839 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2840 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2842 // Create some initial channels
2843 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2844 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
2846 // Ensure all nodes are at the same height
2847 let node_max_height = nodes.iter().map(|node| node.blocks.lock().unwrap().len()).max().unwrap() as u32;
2848 connect_blocks(&nodes[0], node_max_height - nodes[0].best_block_info().1);
2849 connect_blocks(&nodes[1], node_max_height - nodes[1].best_block_info().1);
2850 connect_blocks(&nodes[2], node_max_height - nodes[2].best_block_info().1);
2852 // Rebalance the network a bit by relaying one payment through all the channels...
2853 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
2854 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
2856 let (our_payment_preimage, _payment_hash, _payment_secret) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2857 let (our_payment_preimage_2, _payment_hash_2, _payment_secret_2) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2859 // Broadcast legit commitment tx from C on B's chain
2860 // Broadcast HTLC Success transaction by C on received output from C's commitment tx on B's chain
2861 let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
2862 assert_eq!(commitment_tx.len(), 1);
2863 check_spends!(commitment_tx[0], chan_2.3);
2864 nodes[2].node.claim_funds(our_payment_preimage);
2865 nodes[2].node.claim_funds(our_payment_preimage_2);
2866 check_added_monitors!(nodes[2], 2);
2867 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2868 assert!(updates.update_add_htlcs.is_empty());
2869 assert!(updates.update_fail_htlcs.is_empty());
2870 assert!(updates.update_fail_malformed_htlcs.is_empty());
2871 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
2873 mine_transaction(&nodes[2], &commitment_tx[0]);
2874 check_closed_broadcast!(nodes[2], true);
2875 check_added_monitors!(nodes[2], 1);
2876 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)
2877 assert_eq!(node_txn.len(), 5);
2878 assert_eq!(node_txn[0], node_txn[3]);
2879 assert_eq!(node_txn[1], node_txn[4]);
2880 assert_eq!(node_txn[2], commitment_tx[0]);
2881 check_spends!(node_txn[0], commitment_tx[0]);
2882 check_spends!(node_txn[1], commitment_tx[0]);
2883 assert_eq!(node_txn[0].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2884 assert_eq!(node_txn[1].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2885 assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2886 assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2887 assert_eq!(node_txn[0].lock_time, 0);
2888 assert_eq!(node_txn[1].lock_time, 0);
2890 // Verify that B's ChannelManager is able to extract preimage from HTLC Success tx and pass it backward
2891 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2892 connect_block(&nodes[1], &Block { header, txdata: node_txn});
2893 connect_blocks(&nodes[1], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
2895 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
2896 assert_eq!(added_monitors.len(), 1);
2897 assert_eq!(added_monitors[0].0.txid, chan_2.3.txid());
2898 added_monitors.clear();
2900 let forwarded_events = nodes[1].node.get_and_clear_pending_events();
2901 assert_eq!(forwarded_events.len(), 2);
2902 if let Event::PaymentForwarded { fee_earned_msat: Some(1000), claim_from_onchain_tx: true } = forwarded_events[0] {
2903 } else { panic!(); }
2904 if let Event::PaymentForwarded { fee_earned_msat: Some(1000), claim_from_onchain_tx: true } = forwarded_events[1] {
2905 } else { panic!(); }
2906 let events = nodes[1].node.get_and_clear_pending_msg_events();
2908 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
2909 assert_eq!(added_monitors.len(), 2);
2910 assert_eq!(added_monitors[0].0.txid, chan_1.3.txid());
2911 assert_eq!(added_monitors[1].0.txid, chan_1.3.txid());
2912 added_monitors.clear();
2914 assert_eq!(events.len(), 3);
2916 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
2917 _ => panic!("Unexpected event"),
2920 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { .. }, node_id: _ } => {},
2921 _ => panic!("Unexpected event"),
2925 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, .. } } => {
2926 assert!(update_add_htlcs.is_empty());
2927 assert!(update_fail_htlcs.is_empty());
2928 assert_eq!(update_fulfill_htlcs.len(), 1);
2929 assert!(update_fail_malformed_htlcs.is_empty());
2930 assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
2932 _ => panic!("Unexpected event"),
2934 macro_rules! check_tx_local_broadcast {
2935 ($node: expr, $htlc_offered: expr, $commitment_tx: expr, $chan_tx: expr) => { {
2936 let mut node_txn = $node.tx_broadcaster.txn_broadcasted.lock().unwrap();
2937 assert_eq!(node_txn.len(), 3);
2938 // Node[1]: ChannelManager: 3 (commitment tx, 2*HTLC-Timeout tx), ChannelMonitor: 2 (timeout tx)
2939 // Node[0]: ChannelManager: 3 (commtiemtn tx, 2*HTLC-Timeout tx), ChannelMonitor: 2 HTLC-timeout
2940 check_spends!(node_txn[1], $commitment_tx);
2941 check_spends!(node_txn[2], $commitment_tx);
2942 assert_ne!(node_txn[1].lock_time, 0);
2943 assert_ne!(node_txn[2].lock_time, 0);
2945 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2946 assert_eq!(node_txn[2].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2947 assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2948 assert!(node_txn[2].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2950 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2951 assert_eq!(node_txn[2].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2952 assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2953 assert!(node_txn[2].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2955 check_spends!(node_txn[0], $chan_tx);
2956 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), 71);
2960 // nodes[1] now broadcasts its own local state as a fallback, suggesting an alternate
2961 // commitment transaction with a corresponding HTLC-Timeout transactions, as well as a
2962 // timeout-claim of the output that nodes[2] just claimed via success.
2963 check_tx_local_broadcast!(nodes[1], false, commitment_tx[0], chan_2.3);
2965 // Broadcast legit commitment tx from A on B's chain
2966 // Broadcast preimage tx by B on offered output from A commitment tx on A's chain
2967 let node_a_commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
2968 check_spends!(node_a_commitment_tx[0], chan_1.3);
2969 mine_transaction(&nodes[1], &node_a_commitment_tx[0]);
2970 check_closed_broadcast!(nodes[1], true);
2971 check_added_monitors!(nodes[1], 1);
2972 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
2973 assert_eq!(node_txn.len(), 6); // ChannelManager : 3 (commitment tx + HTLC-Sucess * 2), ChannelMonitor : 3 (HTLC-Success, 2* RBF bumps of above HTLC txn)
2974 let commitment_spend =
2975 if node_txn[0].input[0].previous_output.txid == node_a_commitment_tx[0].txid() {
2976 check_spends!(node_txn[1], commitment_tx[0]);
2977 check_spends!(node_txn[2], commitment_tx[0]);
2978 assert_ne!(node_txn[1].input[0].previous_output.vout, node_txn[2].input[0].previous_output.vout);
2981 check_spends!(node_txn[0], commitment_tx[0]);
2982 check_spends!(node_txn[1], commitment_tx[0]);
2983 assert_ne!(node_txn[0].input[0].previous_output.vout, node_txn[1].input[0].previous_output.vout);
2987 check_spends!(commitment_spend, node_a_commitment_tx[0]);
2988 assert_eq!(commitment_spend.input.len(), 2);
2989 assert_eq!(commitment_spend.input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2990 assert_eq!(commitment_spend.input[1].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2991 assert_eq!(commitment_spend.lock_time, 0);
2992 assert!(commitment_spend.output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2993 check_spends!(node_txn[3], chan_1.3);
2994 assert_eq!(node_txn[3].input[0].witness.clone().last().unwrap().len(), 71);
2995 check_spends!(node_txn[4], node_txn[3]);
2996 check_spends!(node_txn[5], node_txn[3]);
2997 // We don't bother to check that B can claim the HTLC output on its commitment tx here as
2998 // we already checked the same situation with A.
3000 // Verify that A's ChannelManager is able to extract preimage from preimage tx and generate PaymentSent
3001 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
3002 connect_block(&nodes[0], &Block { header, txdata: vec![node_a_commitment_tx[0].clone(), commitment_spend.clone()] });
3003 connect_blocks(&nodes[0], TEST_FINAL_CLTV + MIN_CLTV_EXPIRY_DELTA as u32 - 1); // Confirm blocks until the HTLC expires
3004 check_closed_broadcast!(nodes[0], true);
3005 check_added_monitors!(nodes[0], 1);
3006 let events = nodes[0].node.get_and_clear_pending_events();
3007 assert_eq!(events.len(), 2);
3008 let mut first_claimed = false;
3009 for event in events {
3011 Event::PaymentSent { payment_preimage } => {
3012 if payment_preimage == our_payment_preimage {
3013 assert!(!first_claimed);
3014 first_claimed = true;
3016 assert_eq!(payment_preimage, our_payment_preimage_2);
3019 _ => panic!("Unexpected event"),
3022 check_tx_local_broadcast!(nodes[0], true, node_a_commitment_tx[0], chan_1.3);
3025 fn do_test_htlc_on_chain_timeout(connect_style: ConnectStyle) {
3026 // Test that in case of a unilateral close onchain, we detect the state of output and
3027 // timeout the HTLC backward accordingly. So here we test that ChannelManager is
3028 // broadcasting the right event to other nodes in payment path.
3029 // A ------------------> B ----------------------> C (timeout)
3030 // B's commitment tx C's commitment tx
3032 // B's HTLC timeout tx B's timeout tx
3034 let chanmon_cfgs = create_chanmon_cfgs(3);
3035 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3036 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3037 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3038 *nodes[0].connect_style.borrow_mut() = connect_style;
3039 *nodes[1].connect_style.borrow_mut() = connect_style;
3040 *nodes[2].connect_style.borrow_mut() = connect_style;
3042 // Create some intial channels
3043 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3044 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3046 // Rebalance the network a bit by relaying one payment thorugh all the channels...
3047 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
3048 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
3050 let (_payment_preimage, payment_hash, _payment_secret) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
3052 // Broadcast legit commitment tx from C on B's chain
3053 let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
3054 check_spends!(commitment_tx[0], chan_2.3);
3055 nodes[2].node.fail_htlc_backwards(&payment_hash);
3056 check_added_monitors!(nodes[2], 0);
3057 expect_pending_htlcs_forwardable!(nodes[2]);
3058 check_added_monitors!(nodes[2], 1);
3060 let events = nodes[2].node.get_and_clear_pending_msg_events();
3061 assert_eq!(events.len(), 1);
3063 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, .. } } => {
3064 assert!(update_add_htlcs.is_empty());
3065 assert!(!update_fail_htlcs.is_empty());
3066 assert!(update_fulfill_htlcs.is_empty());
3067 assert!(update_fail_malformed_htlcs.is_empty());
3068 assert_eq!(nodes[1].node.get_our_node_id(), *node_id);
3070 _ => panic!("Unexpected event"),
3072 mine_transaction(&nodes[2], &commitment_tx[0]);
3073 check_closed_broadcast!(nodes[2], true);
3074 check_added_monitors!(nodes[2], 1);
3075 let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 1 (commitment tx)
3076 assert_eq!(node_txn.len(), 1);
3077 check_spends!(node_txn[0], chan_2.3);
3078 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), 71);
3080 // Broadcast timeout transaction by B on received output from C's commitment tx on B's chain
3081 // Verify that B's ChannelManager is able to detect that HTLC is timeout by its own tx and react backward in consequence
3082 connect_blocks(&nodes[1], 200 - nodes[2].best_block_info().1);
3083 mine_transaction(&nodes[1], &commitment_tx[0]);
3086 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
3087 assert_eq!(node_txn.len(), 5); // ChannelManager : 2 (commitment tx, HTLC-Timeout tx), ChannelMonitor : 2 (local commitment tx + HTLC-timeout), 1 timeout tx
3088 assert_eq!(node_txn[0], node_txn[3]);
3089 assert_eq!(node_txn[1], node_txn[4]);
3091 check_spends!(node_txn[2], commitment_tx[0]);
3092 assert_eq!(node_txn[2].clone().input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
3094 check_spends!(node_txn[0], chan_2.3);
3095 check_spends!(node_txn[1], node_txn[0]);
3096 assert_eq!(node_txn[0].clone().input[0].witness.last().unwrap().len(), 71);
3097 assert_eq!(node_txn[1].clone().input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
3099 timeout_tx = node_txn[2].clone();
3103 mine_transaction(&nodes[1], &timeout_tx);
3104 check_added_monitors!(nodes[1], 1);
3105 check_closed_broadcast!(nodes[1], true);
3107 // B will rebroadcast a fee-bumped timeout transaction here.
3108 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
3109 assert_eq!(node_txn.len(), 1);
3110 check_spends!(node_txn[0], commitment_tx[0]);
3113 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
3115 // B may rebroadcast its own holder commitment transaction here, as a safeguard against
3116 // some incredibly unlikely partial-eclipse-attack scenarios. That said, because the
3117 // original commitment_tx[0] (also spending chan_2.3) has reached ANTI_REORG_DELAY B really
3118 // shouldn't broadcast anything here, and in some connect style scenarios we do not.
3119 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
3120 if node_txn.len() == 1 {
3121 check_spends!(node_txn[0], chan_2.3);
3123 assert_eq!(node_txn.len(), 0);
3127 expect_pending_htlcs_forwardable!(nodes[1]);
3128 check_added_monitors!(nodes[1], 1);
3129 let events = nodes[1].node.get_and_clear_pending_msg_events();
3130 assert_eq!(events.len(), 1);
3132 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, .. } } => {
3133 assert!(update_add_htlcs.is_empty());
3134 assert!(!update_fail_htlcs.is_empty());
3135 assert!(update_fulfill_htlcs.is_empty());
3136 assert!(update_fail_malformed_htlcs.is_empty());
3137 assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
3139 _ => panic!("Unexpected event"),
3142 // Broadcast legit commitment tx from B on A's chain
3143 let commitment_tx = get_local_commitment_txn!(nodes[1], chan_1.2);
3144 check_spends!(commitment_tx[0], chan_1.3);
3146 mine_transaction(&nodes[0], &commitment_tx[0]);
3147 connect_blocks(&nodes[0], TEST_FINAL_CLTV + MIN_CLTV_EXPIRY_DELTA as u32 - 1); // Confirm blocks until the HTLC expires
3149 check_closed_broadcast!(nodes[0], true);
3150 check_added_monitors!(nodes[0], 1);
3151 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 1 commitment tx, ChannelMonitor : 1 timeout tx
3152 assert_eq!(node_txn.len(), 2);
3153 check_spends!(node_txn[0], chan_1.3);
3154 assert_eq!(node_txn[0].clone().input[0].witness.last().unwrap().len(), 71);
3155 check_spends!(node_txn[1], commitment_tx[0]);
3156 assert_eq!(node_txn[1].clone().input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
3160 fn test_htlc_on_chain_timeout() {
3161 do_test_htlc_on_chain_timeout(ConnectStyle::BestBlockFirstSkippingBlocks);
3162 do_test_htlc_on_chain_timeout(ConnectStyle::TransactionsFirstSkippingBlocks);
3163 do_test_htlc_on_chain_timeout(ConnectStyle::FullBlockViaListen);
3167 fn test_simple_commitment_revoked_fail_backward() {
3168 // Test that in case of a revoked commitment tx, we detect the resolution of output by justice tx
3169 // and fail backward accordingly.
3171 let chanmon_cfgs = create_chanmon_cfgs(3);
3172 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3173 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3174 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3176 // Create some initial channels
3177 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3178 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3180 let (payment_preimage, _payment_hash, _payment_secret) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3000000);
3181 // Get the will-be-revoked local txn from nodes[2]
3182 let revoked_local_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
3183 // Revoke the old state
3184 claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage);
3186 let (_, payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3000000);
3188 mine_transaction(&nodes[1], &revoked_local_txn[0]);
3189 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
3190 check_added_monitors!(nodes[1], 1);
3191 check_closed_broadcast!(nodes[1], true);
3193 expect_pending_htlcs_forwardable!(nodes[1]);
3194 check_added_monitors!(nodes[1], 1);
3195 let events = nodes[1].node.get_and_clear_pending_msg_events();
3196 assert_eq!(events.len(), 1);
3198 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, .. } } => {
3199 assert!(update_add_htlcs.is_empty());
3200 assert_eq!(update_fail_htlcs.len(), 1);
3201 assert!(update_fulfill_htlcs.is_empty());
3202 assert!(update_fail_malformed_htlcs.is_empty());
3203 assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
3205 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
3206 commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
3207 expect_payment_failure_chan_update!(nodes[0], chan_2.0.contents.short_channel_id, true);
3208 expect_payment_failed!(nodes[0], payment_hash, false);
3210 _ => panic!("Unexpected event"),
3214 fn do_test_commitment_revoked_fail_backward_exhaustive(deliver_bs_raa: bool, use_dust: bool, no_to_remote: bool) {
3215 // Test that if our counterparty broadcasts a revoked commitment transaction we fail all
3216 // pending HTLCs on that channel backwards even if the HTLCs aren't present in our latest
3217 // commitment transaction anymore.
3218 // To do this, we have the peer which will broadcast a revoked commitment transaction send
3219 // a number of update_fail/commitment_signed updates without ever sending the RAA in
3220 // response to our commitment_signed. This is somewhat misbehavior-y, though not
3221 // technically disallowed and we should probably handle it reasonably.
3222 // Note that this is pretty exhaustive as an outbound HTLC which we haven't yet
3223 // failed/fulfilled backwards must be in at least one of the latest two remote commitment
3225 // * Once we move it out of our holding cell/add it, we will immediately include it in a
3226 // commitment_signed (implying it will be in the latest remote commitment transaction).
3227 // * Once they remove it, we will send a (the first) commitment_signed without the HTLC,
3228 // and once they revoke the previous commitment transaction (allowing us to send a new
3229 // commitment_signed) we will be free to fail/fulfill the HTLC backwards.
3230 let chanmon_cfgs = create_chanmon_cfgs(3);
3231 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3232 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3233 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3235 // Create some initial channels
3236 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3237 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3239 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 });
3240 // Get the will-be-revoked local txn from nodes[2]
3241 let revoked_local_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
3242 assert_eq!(revoked_local_txn[0].output.len(), if no_to_remote { 1 } else { 2 });
3243 // Revoke the old state
3244 claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage);
3246 let value = if use_dust {
3247 // The dust limit applied to HTLC outputs considers the fee of the HTLC transaction as
3248 // well, so HTLCs at exactly the dust limit will not be included in commitment txn.
3249 nodes[2].node.channel_state.lock().unwrap().by_id.get(&chan_2.2).unwrap().holder_dust_limit_satoshis * 1000
3252 let (_, first_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
3253 let (_, second_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
3254 let (_, third_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
3256 assert!(nodes[2].node.fail_htlc_backwards(&first_payment_hash));
3257 expect_pending_htlcs_forwardable!(nodes[2]);
3258 check_added_monitors!(nodes[2], 1);
3259 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3260 assert!(updates.update_add_htlcs.is_empty());
3261 assert!(updates.update_fulfill_htlcs.is_empty());
3262 assert!(updates.update_fail_malformed_htlcs.is_empty());
3263 assert_eq!(updates.update_fail_htlcs.len(), 1);
3264 assert!(updates.update_fee.is_none());
3265 nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
3266 let bs_raa = commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false, true, false, true);
3267 // Drop the last RAA from 3 -> 2
3269 assert!(nodes[2].node.fail_htlc_backwards(&second_payment_hash));
3270 expect_pending_htlcs_forwardable!(nodes[2]);
3271 check_added_monitors!(nodes[2], 1);
3272 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3273 assert!(updates.update_add_htlcs.is_empty());
3274 assert!(updates.update_fulfill_htlcs.is_empty());
3275 assert!(updates.update_fail_malformed_htlcs.is_empty());
3276 assert_eq!(updates.update_fail_htlcs.len(), 1);
3277 assert!(updates.update_fee.is_none());
3278 nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
3279 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &updates.commitment_signed);
3280 check_added_monitors!(nodes[1], 1);
3281 // Note that nodes[1] is in AwaitingRAA, so won't send a CS
3282 let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
3283 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
3284 check_added_monitors!(nodes[2], 1);
3286 assert!(nodes[2].node.fail_htlc_backwards(&third_payment_hash));
3287 expect_pending_htlcs_forwardable!(nodes[2]);
3288 check_added_monitors!(nodes[2], 1);
3289 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3290 assert!(updates.update_add_htlcs.is_empty());
3291 assert!(updates.update_fulfill_htlcs.is_empty());
3292 assert!(updates.update_fail_malformed_htlcs.is_empty());
3293 assert_eq!(updates.update_fail_htlcs.len(), 1);
3294 assert!(updates.update_fee.is_none());
3295 nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
3296 // At this point first_payment_hash has dropped out of the latest two commitment
3297 // transactions that nodes[1] is tracking...
3298 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &updates.commitment_signed);
3299 check_added_monitors!(nodes[1], 1);
3300 // Note that nodes[1] is (still) in AwaitingRAA, so won't send a CS
3301 let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
3302 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
3303 check_added_monitors!(nodes[2], 1);
3305 // Add a fourth HTLC, this one will get sequestered away in nodes[1]'s holding cell waiting
3306 // on nodes[2]'s RAA.
3307 let (_, fourth_payment_hash, fourth_payment_secret) = get_payment_preimage_hash!(nodes[2]);
3308 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
3309 let logger = test_utils::TestLogger::new();
3310 let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[2].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
3311 nodes[1].node.send_payment(&route, fourth_payment_hash, &Some(fourth_payment_secret)).unwrap();
3312 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3313 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
3314 check_added_monitors!(nodes[1], 0);
3317 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_raa);
3318 // One monitor for the new revocation preimage, no second on as we won't generate a new
3319 // commitment transaction for nodes[0] until process_pending_htlc_forwards().
3320 check_added_monitors!(nodes[1], 1);
3321 let events = nodes[1].node.get_and_clear_pending_events();
3322 assert_eq!(events.len(), 1);
3324 Event::PendingHTLCsForwardable { .. } => { },
3325 _ => panic!("Unexpected event"),
3327 // Deliberately don't process the pending fail-back so they all fail back at once after
3328 // block connection just like the !deliver_bs_raa case
3331 let mut failed_htlcs = HashSet::new();
3332 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
3334 mine_transaction(&nodes[1], &revoked_local_txn[0]);
3335 check_added_monitors!(nodes[1], 1);
3336 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
3338 let events = nodes[1].node.get_and_clear_pending_events();
3339 assert_eq!(events.len(), if deliver_bs_raa { 1 } else { 2 });
3341 Event::PaymentFailed { ref payment_hash, .. } => {
3342 assert_eq!(*payment_hash, fourth_payment_hash);
3344 _ => panic!("Unexpected event"),
3346 if !deliver_bs_raa {
3348 Event::PendingHTLCsForwardable { .. } => { },
3349 _ => panic!("Unexpected event"),
3352 nodes[1].node.process_pending_htlc_forwards();
3353 check_added_monitors!(nodes[1], 1);
3355 let events = nodes[1].node.get_and_clear_pending_msg_events();
3356 assert_eq!(events.len(), if deliver_bs_raa { 4 } else { 3 });
3357 match events[if deliver_bs_raa { 1 } else { 0 }] {
3358 MessageSendEvent::BroadcastChannelUpdate { msg: msgs::ChannelUpdate { .. } } => {},
3359 _ => panic!("Unexpected event"),
3361 match events[if deliver_bs_raa { 2 } else { 1 }] {
3362 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { msg: msgs::ErrorMessage { channel_id, ref data } }, node_id: _ } => {
3363 assert_eq!(channel_id, chan_2.2);
3364 assert_eq!(data.as_str(), "Commitment or closing transaction was confirmed on chain.");
3366 _ => panic!("Unexpected event"),
3370 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, .. } } => {
3371 assert_eq!(nodes[2].node.get_our_node_id(), *node_id);
3372 assert_eq!(update_add_htlcs.len(), 1);
3373 assert!(update_fulfill_htlcs.is_empty());
3374 assert!(update_fail_htlcs.is_empty());
3375 assert!(update_fail_malformed_htlcs.is_empty());
3377 _ => panic!("Unexpected event"),
3380 match events[if deliver_bs_raa { 3 } else { 2 }] {
3381 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, .. } } => {
3382 assert!(update_add_htlcs.is_empty());
3383 assert_eq!(update_fail_htlcs.len(), 3);
3384 assert!(update_fulfill_htlcs.is_empty());
3385 assert!(update_fail_malformed_htlcs.is_empty());
3386 assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
3388 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
3389 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[1]);
3390 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[2]);
3392 commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
3394 let events = nodes[0].node.get_and_clear_pending_msg_events();
3395 // If we delivered B's RAA we got an unknown preimage error, not something
3396 // that we should update our routing table for.
3397 assert_eq!(events.len(), if deliver_bs_raa { 2 } else { 3 });
3398 for event in events {
3400 MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
3401 _ => panic!("Unexpected event"),
3404 let events = nodes[0].node.get_and_clear_pending_events();
3405 assert_eq!(events.len(), 3);
3407 Event::PaymentFailed { ref payment_hash, .. } => {
3408 assert!(failed_htlcs.insert(payment_hash.0));
3410 _ => panic!("Unexpected event"),
3413 Event::PaymentFailed { ref payment_hash, .. } => {
3414 assert!(failed_htlcs.insert(payment_hash.0));
3416 _ => panic!("Unexpected event"),
3419 Event::PaymentFailed { ref payment_hash, .. } => {
3420 assert!(failed_htlcs.insert(payment_hash.0));
3422 _ => panic!("Unexpected event"),
3425 _ => panic!("Unexpected event"),
3428 assert!(failed_htlcs.contains(&first_payment_hash.0));
3429 assert!(failed_htlcs.contains(&second_payment_hash.0));
3430 assert!(failed_htlcs.contains(&third_payment_hash.0));
3434 fn test_commitment_revoked_fail_backward_exhaustive_a() {
3435 do_test_commitment_revoked_fail_backward_exhaustive(false, true, false);
3436 do_test_commitment_revoked_fail_backward_exhaustive(true, true, false);
3437 do_test_commitment_revoked_fail_backward_exhaustive(false, false, false);
3438 do_test_commitment_revoked_fail_backward_exhaustive(true, false, false);
3442 fn test_commitment_revoked_fail_backward_exhaustive_b() {
3443 do_test_commitment_revoked_fail_backward_exhaustive(false, true, true);
3444 do_test_commitment_revoked_fail_backward_exhaustive(true, true, true);
3445 do_test_commitment_revoked_fail_backward_exhaustive(false, false, true);
3446 do_test_commitment_revoked_fail_backward_exhaustive(true, false, true);
3450 fn fail_backward_pending_htlc_upon_channel_failure() {
3451 let chanmon_cfgs = create_chanmon_cfgs(2);
3452 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3453 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3454 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3455 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1_000_000, 500_000_000, InitFeatures::known(), InitFeatures::known());
3456 let logger = test_utils::TestLogger::new();
3458 // Alice -> Bob: Route a payment but without Bob sending revoke_and_ack.
3460 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1]);
3461 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3462 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 50_000, TEST_FINAL_CLTV, &logger).unwrap();
3463 nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
3464 check_added_monitors!(nodes[0], 1);
3466 let payment_event = {
3467 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3468 assert_eq!(events.len(), 1);
3469 SendEvent::from_event(events.remove(0))
3471 assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
3472 assert_eq!(payment_event.msgs.len(), 1);
3475 // Alice -> Bob: Route another payment but now Alice waits for Bob's earlier revoke_and_ack.
3476 let (_, failed_payment_hash, failed_payment_secret) = get_payment_preimage_hash!(nodes[1]);
3478 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3479 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 50_000, TEST_FINAL_CLTV, &logger).unwrap();
3480 nodes[0].node.send_payment(&route, failed_payment_hash, &Some(failed_payment_secret)).unwrap();
3481 check_added_monitors!(nodes[0], 0);
3483 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3486 // Alice <- Bob: Send a malformed update_add_htlc so Alice fails the channel.
3488 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[0]);
3490 let secp_ctx = Secp256k1::new();
3491 let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
3492 let current_height = nodes[1].node.best_block.read().unwrap().height() + 1;
3493 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
3494 let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[0].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 50_000, TEST_FINAL_CLTV, &logger).unwrap();
3495 let (onion_payloads, _amount_msat, cltv_expiry) = onion_utils::build_onion_payloads(&route.paths[0], 50_000, &Some(payment_secret), current_height, &None).unwrap();
3496 let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route.paths[0], &session_priv).unwrap();
3497 let onion_routing_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
3499 // Send a 0-msat update_add_htlc to fail the channel.
3500 let update_add_htlc = msgs::UpdateAddHTLC {
3506 onion_routing_packet,
3508 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &update_add_htlc);
3511 // Check that Alice fails backward the pending HTLC from the second payment.
3512 expect_payment_failed!(nodes[0], failed_payment_hash, true);
3513 check_closed_broadcast!(nodes[0], true);
3514 check_added_monitors!(nodes[0], 1);
3518 fn test_htlc_ignore_latest_remote_commitment() {
3519 // Test that HTLC transactions spending the latest remote commitment transaction are simply
3520 // ignored if we cannot claim them. This originally tickled an invalid unwrap().
3521 let chanmon_cfgs = create_chanmon_cfgs(2);
3522 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3523 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3524 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3525 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3527 route_payment(&nodes[0], &[&nodes[1]], 10000000);
3528 nodes[0].node.force_close_channel(&nodes[0].node.list_channels()[0].channel_id).unwrap();
3529 connect_blocks(&nodes[0], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + 1);
3530 check_closed_broadcast!(nodes[0], true);
3531 check_added_monitors!(nodes[0], 1);
3533 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
3534 assert_eq!(node_txn.len(), 3);
3535 assert_eq!(node_txn[0], node_txn[1]);
3537 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3538 connect_block(&nodes[1], &Block { header, txdata: vec![node_txn[0].clone(), node_txn[1].clone()]});
3539 check_closed_broadcast!(nodes[1], true);
3540 check_added_monitors!(nodes[1], 1);
3542 // Duplicate the connect_block call since this may happen due to other listeners
3543 // registering new transactions
3544 header.prev_blockhash = header.block_hash();
3545 connect_block(&nodes[1], &Block { header, txdata: vec![node_txn[0].clone(), node_txn[2].clone()]});
3549 fn test_force_close_fail_back() {
3550 // Check which HTLCs are failed-backwards on channel force-closure
3551 let chanmon_cfgs = create_chanmon_cfgs(3);
3552 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3553 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3554 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3555 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3556 create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3557 let logger = test_utils::TestLogger::new();
3559 let (our_payment_preimage, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[2]);
3561 let mut payment_event = {
3562 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3563 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[2].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 1000000, 42, &logger).unwrap();
3564 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
3565 check_added_monitors!(nodes[0], 1);
3567 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3568 assert_eq!(events.len(), 1);
3569 SendEvent::from_event(events.remove(0))
3572 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
3573 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
3575 expect_pending_htlcs_forwardable!(nodes[1]);
3577 let mut events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3578 assert_eq!(events_2.len(), 1);
3579 payment_event = SendEvent::from_event(events_2.remove(0));
3580 assert_eq!(payment_event.msgs.len(), 1);
3582 check_added_monitors!(nodes[1], 1);
3583 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
3584 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg);
3585 check_added_monitors!(nodes[2], 1);
3586 let (_, _) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3588 // nodes[2] now has the latest commitment transaction, but hasn't revoked its previous
3589 // state or updated nodes[1]' state. Now force-close and broadcast that commitment/HTLC
3590 // transaction and ensure nodes[1] doesn't fail-backwards (this was originally a bug!).
3592 nodes[2].node.force_close_channel(&payment_event.commitment_msg.channel_id).unwrap();
3593 check_closed_broadcast!(nodes[2], true);
3594 check_added_monitors!(nodes[2], 1);
3596 let mut node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap();
3597 // Note that we don't bother broadcasting the HTLC-Success transaction here as we don't
3598 // have a use for it unless nodes[2] learns the preimage somehow, the funds will go
3599 // back to nodes[1] upon timeout otherwise.
3600 assert_eq!(node_txn.len(), 1);
3604 mine_transaction(&nodes[1], &tx);
3606 // Note no UpdateHTLCs event here from nodes[1] to nodes[0]!
3607 check_closed_broadcast!(nodes[1], true);
3608 check_added_monitors!(nodes[1], 1);
3610 // Now check that if we add the preimage to ChannelMonitor it broadcasts our HTLC-Success..
3612 let mut monitors = nodes[2].chain_monitor.chain_monitor.monitors.read().unwrap();
3613 monitors.get(&OutPoint{ txid: Txid::from_slice(&payment_event.commitment_msg.channel_id[..]).unwrap(), index: 0 }).unwrap()
3614 .provide_payment_preimage(&our_payment_hash, &our_payment_preimage, &node_cfgs[2].tx_broadcaster, &node_cfgs[2].fee_estimator, &&logger);
3616 mine_transaction(&nodes[2], &tx);
3617 let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap();
3618 assert_eq!(node_txn.len(), 1);
3619 assert_eq!(node_txn[0].input.len(), 1);
3620 assert_eq!(node_txn[0].input[0].previous_output.txid, tx.txid());
3621 assert_eq!(node_txn[0].lock_time, 0); // Must be an HTLC-Success
3622 assert_eq!(node_txn[0].input[0].witness.len(), 5); // Must be an HTLC-Success
3624 check_spends!(node_txn[0], tx);
3628 fn test_dup_events_on_peer_disconnect() {
3629 // Test that if we receive a duplicative update_fulfill_htlc message after a reconnect we do
3630 // not generate a corresponding duplicative PaymentSent event. This did not use to be the case
3631 // as we used to generate the event immediately upon receipt of the payment preimage in the
3632 // update_fulfill_htlc message.
3634 let chanmon_cfgs = create_chanmon_cfgs(2);
3635 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3636 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3637 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3638 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3640 let payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 1000000).0;
3642 assert!(nodes[1].node.claim_funds(payment_preimage));
3643 check_added_monitors!(nodes[1], 1);
3644 let claim_msgs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3645 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &claim_msgs.update_fulfill_htlcs[0]);
3646 expect_payment_sent!(nodes[0], payment_preimage);
3648 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3649 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3651 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (1, 0), (0, 0), (0, 0), (0, 0), (false, false));
3652 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
3656 fn test_simple_peer_disconnect() {
3657 // Test that we can reconnect when there are no lost messages
3658 let chanmon_cfgs = create_chanmon_cfgs(3);
3659 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3660 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3661 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3662 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3663 create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3665 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3666 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3667 reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3669 let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3670 let payment_hash_2 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3671 fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_hash_2);
3672 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_preimage_1);
3674 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3675 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3676 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3678 let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3679 let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3680 let payment_hash_5 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3681 let payment_hash_6 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3683 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3684 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3686 claim_payment_along_route(&nodes[0], &[&[&nodes[1], &nodes[2]]], true, payment_preimage_3);
3687 fail_payment_along_route(&nodes[0], &[&nodes[1], &nodes[2]], true, payment_hash_5);
3689 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (1, 0), (1, 0), (false, false));
3691 let events = nodes[0].node.get_and_clear_pending_events();
3692 assert_eq!(events.len(), 2);
3694 Event::PaymentSent { payment_preimage } => {
3695 assert_eq!(payment_preimage, payment_preimage_3);
3697 _ => panic!("Unexpected event"),
3700 Event::PaymentFailed { payment_hash, rejected_by_dest, .. } => {
3701 assert_eq!(payment_hash, payment_hash_5);
3702 assert!(rejected_by_dest);
3704 _ => panic!("Unexpected event"),
3708 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_preimage_4);
3709 fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_hash_6);
3712 fn do_test_drop_messages_peer_disconnect(messages_delivered: u8, simulate_broken_lnd: bool) {
3713 // Test that we can reconnect when in-flight HTLC updates get dropped
3714 let chanmon_cfgs = create_chanmon_cfgs(2);
3715 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3716 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3717 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3719 let mut as_funding_locked = None;
3720 if messages_delivered == 0 {
3721 let (funding_locked, _, _) = create_chan_between_nodes_with_value_a(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
3722 as_funding_locked = Some(funding_locked);
3723 // nodes[1] doesn't receive the funding_locked message (it'll be re-sent on reconnect)
3724 // Note that we store it so that if we're running with `simulate_broken_lnd` we can deliver
3725 // it before the channel_reestablish message.
3727 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3730 let (payment_preimage_1, payment_hash_1, payment_secret_1) = get_payment_preimage_hash!(nodes[1]);
3732 let logger = test_utils::TestLogger::new();
3733 let payment_event = {
3734 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3735 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(),
3736 &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), Some(&nodes[0].node.list_usable_channels().iter().collect::<Vec<_>>()),
3737 &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
3738 nodes[0].node.send_payment(&route, payment_hash_1, &Some(payment_secret_1)).unwrap();
3739 check_added_monitors!(nodes[0], 1);
3741 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3742 assert_eq!(events.len(), 1);
3743 SendEvent::from_event(events.remove(0))
3745 assert_eq!(nodes[1].node.get_our_node_id(), payment_event.node_id);
3747 if messages_delivered < 2 {
3748 // Drop the payment_event messages, and let them get re-generated in reconnect_nodes!
3750 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
3751 if messages_delivered >= 3 {
3752 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
3753 check_added_monitors!(nodes[1], 1);
3754 let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3756 if messages_delivered >= 4 {
3757 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3758 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3759 check_added_monitors!(nodes[0], 1);
3761 if messages_delivered >= 5 {
3762 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_commitment_signed);
3763 let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3764 // No commitment_signed so get_event_msg's assert(len == 1) passes
3765 check_added_monitors!(nodes[0], 1);
3767 if messages_delivered >= 6 {
3768 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3769 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3770 check_added_monitors!(nodes[1], 1);
3777 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3778 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3779 if messages_delivered < 3 {
3780 if simulate_broken_lnd {
3781 // lnd has a long-standing bug where they send a funding_locked prior to a
3782 // channel_reestablish if you reconnect prior to funding_locked time.
3784 // Here we simulate that behavior, delivering a funding_locked immediately on
3785 // reconnect. Note that we don't bother skipping the now-duplicate funding_locked sent
3786 // in `reconnect_nodes` but we currently don't fail based on that.
3788 // See-also <https://github.com/lightningnetwork/lnd/issues/4006>
3789 nodes[1].node.handle_funding_locked(&nodes[0].node.get_our_node_id(), &as_funding_locked.as_ref().unwrap().0);
3791 // Even if the funding_locked messages get exchanged, as long as nothing further was
3792 // received on either side, both sides will need to resend them.
3793 reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 1), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3794 } else if messages_delivered == 3 {
3795 // nodes[0] still wants its RAA + commitment_signed
3796 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (-1, 0), (0, 0), (0, 0), (0, 0), (0, 0), (true, false));
3797 } else if messages_delivered == 4 {
3798 // nodes[0] still wants its commitment_signed
3799 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (-1, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3800 } else if messages_delivered == 5 {
3801 // nodes[1] still wants its final RAA
3802 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, true));
3803 } else if messages_delivered == 6 {
3804 // Everything was delivered...
3805 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3808 let events_1 = nodes[1].node.get_and_clear_pending_events();
3809 assert_eq!(events_1.len(), 1);
3811 Event::PendingHTLCsForwardable { .. } => { },
3812 _ => panic!("Unexpected event"),
3815 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3816 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3817 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3819 nodes[1].node.process_pending_htlc_forwards();
3821 let events_2 = nodes[1].node.get_and_clear_pending_events();
3822 assert_eq!(events_2.len(), 1);
3824 Event::PaymentReceived { ref payment_hash, ref purpose, amt } => {
3825 assert_eq!(payment_hash_1, *payment_hash);
3826 assert_eq!(amt, 1000000);
3828 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
3829 assert!(payment_preimage.is_none());
3830 assert_eq!(payment_secret_1, *payment_secret);
3832 _ => panic!("expected PaymentPurpose::InvoicePayment")
3835 _ => panic!("Unexpected event"),
3838 nodes[1].node.claim_funds(payment_preimage_1);
3839 check_added_monitors!(nodes[1], 1);
3841 let events_3 = nodes[1].node.get_and_clear_pending_msg_events();
3842 assert_eq!(events_3.len(), 1);
3843 let (update_fulfill_htlc, commitment_signed) = match events_3[0] {
3844 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
3845 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3846 assert!(updates.update_add_htlcs.is_empty());
3847 assert!(updates.update_fail_htlcs.is_empty());
3848 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
3849 assert!(updates.update_fail_malformed_htlcs.is_empty());
3850 assert!(updates.update_fee.is_none());
3851 (updates.update_fulfill_htlcs[0].clone(), updates.commitment_signed.clone())
3853 _ => panic!("Unexpected event"),
3856 if messages_delivered >= 1 {
3857 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlc);
3859 let events_4 = nodes[0].node.get_and_clear_pending_events();
3860 assert_eq!(events_4.len(), 1);
3862 Event::PaymentSent { ref payment_preimage } => {
3863 assert_eq!(payment_preimage_1, *payment_preimage);
3865 _ => panic!("Unexpected event"),
3868 if messages_delivered >= 2 {
3869 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
3870 check_added_monitors!(nodes[0], 1);
3871 let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
3873 if messages_delivered >= 3 {
3874 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3875 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3876 check_added_monitors!(nodes[1], 1);
3878 if messages_delivered >= 4 {
3879 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed);
3880 let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3881 // No commitment_signed so get_event_msg's assert(len == 1) passes
3882 check_added_monitors!(nodes[1], 1);
3884 if messages_delivered >= 5 {
3885 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3886 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3887 check_added_monitors!(nodes[0], 1);
3894 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3895 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3896 if messages_delivered < 2 {
3897 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (1, 0), (0, 0), (0, 0), (0, 0), (false, false));
3898 if messages_delivered < 1 {
3899 let events_4 = nodes[0].node.get_and_clear_pending_events();
3900 assert_eq!(events_4.len(), 1);
3902 Event::PaymentSent { ref payment_preimage } => {
3903 assert_eq!(payment_preimage_1, *payment_preimage);
3905 _ => panic!("Unexpected event"),
3908 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3910 } else if messages_delivered == 2 {
3911 // nodes[0] still wants its RAA + commitment_signed
3912 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, -1), (0, 0), (0, 0), (0, 0), (0, 0), (false, true));
3913 } else if messages_delivered == 3 {
3914 // nodes[0] still wants its commitment_signed
3915 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, -1), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3916 } else if messages_delivered == 4 {
3917 // nodes[1] still wants its final RAA
3918 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (true, false));
3919 } else if messages_delivered == 5 {
3920 // Everything was delivered...
3921 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3924 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3925 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3926 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3928 // Channel should still work fine...
3929 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3930 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(),
3931 &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), Some(&nodes[0].node.list_usable_channels().iter().collect::<Vec<_>>()),
3932 &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
3933 let payment_preimage_2 = send_along_route(&nodes[0], route, &[&nodes[1]], 1000000).0;
3934 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
3938 fn test_drop_messages_peer_disconnect_a() {
3939 do_test_drop_messages_peer_disconnect(0, true);
3940 do_test_drop_messages_peer_disconnect(0, false);
3941 do_test_drop_messages_peer_disconnect(1, false);
3942 do_test_drop_messages_peer_disconnect(2, false);
3946 fn test_drop_messages_peer_disconnect_b() {
3947 do_test_drop_messages_peer_disconnect(3, false);
3948 do_test_drop_messages_peer_disconnect(4, false);
3949 do_test_drop_messages_peer_disconnect(5, false);
3950 do_test_drop_messages_peer_disconnect(6, false);
3954 fn test_funding_peer_disconnect() {
3955 // Test that we can lock in our funding tx while disconnected
3956 let chanmon_cfgs = create_chanmon_cfgs(2);
3957 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3958 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3959 let persister: test_utils::TestPersister;
3960 let new_chain_monitor: test_utils::TestChainMonitor;
3961 let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
3962 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3963 let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
3965 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3966 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3968 confirm_transaction(&nodes[0], &tx);
3969 let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
3970 assert_eq!(events_1.len(), 1);
3972 MessageSendEvent::SendFundingLocked { ref node_id, msg: _ } => {
3973 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
3975 _ => panic!("Unexpected event"),
3978 reconnect_nodes(&nodes[0], &nodes[1], (false, true), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3980 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3981 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3983 confirm_transaction(&nodes[1], &tx);
3984 let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3985 assert_eq!(events_2.len(), 2);
3986 let funding_locked = match events_2[0] {
3987 MessageSendEvent::SendFundingLocked { ref node_id, ref msg } => {
3988 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3991 _ => panic!("Unexpected event"),
3993 let bs_announcement_sigs = match events_2[1] {
3994 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
3995 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3998 _ => panic!("Unexpected event"),
4001 reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
4003 nodes[0].node.handle_funding_locked(&nodes[1].node.get_our_node_id(), &funding_locked);
4004 nodes[0].node.handle_announcement_signatures(&nodes[1].node.get_our_node_id(), &bs_announcement_sigs);
4005 let events_3 = nodes[0].node.get_and_clear_pending_msg_events();
4006 assert_eq!(events_3.len(), 2);
4007 let as_announcement_sigs = match events_3[0] {
4008 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
4009 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
4012 _ => panic!("Unexpected event"),
4014 let (as_announcement, as_update) = match events_3[1] {
4015 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
4016 (msg.clone(), update_msg.clone())
4018 _ => panic!("Unexpected event"),
4021 nodes[1].node.handle_announcement_signatures(&nodes[0].node.get_our_node_id(), &as_announcement_sigs);
4022 let events_4 = nodes[1].node.get_and_clear_pending_msg_events();
4023 assert_eq!(events_4.len(), 1);
4024 let (_, bs_update) = match events_4[0] {
4025 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
4026 (msg.clone(), update_msg.clone())
4028 _ => panic!("Unexpected event"),
4031 nodes[0].net_graph_msg_handler.handle_channel_announcement(&as_announcement).unwrap();
4032 nodes[0].net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
4033 nodes[0].net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
4035 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
4036 let logger = test_utils::TestLogger::new();
4037 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
4038 let (payment_preimage, _, _) = send_along_route(&nodes[0], route, &[&nodes[1]], 1000000);
4039 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage);
4041 // Check that after deserialization and reconnection we can still generate an identical
4042 // channel_announcement from the cached signatures.
4043 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4045 let nodes_0_serialized = nodes[0].node.encode();
4046 let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4047 nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
4049 persister = test_utils::TestPersister::new();
4050 let keys_manager = &chanmon_cfgs[0].keys_manager;
4051 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);
4052 nodes[0].chain_monitor = &new_chain_monitor;
4053 let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4054 let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
4055 &mut chan_0_monitor_read, keys_manager).unwrap();
4056 assert!(chan_0_monitor_read.is_empty());
4058 let mut nodes_0_read = &nodes_0_serialized[..];
4059 let (_, nodes_0_deserialized_tmp) = {
4060 let mut channel_monitors = HashMap::new();
4061 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4062 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4063 default_config: UserConfig::default(),
4065 fee_estimator: node_cfgs[0].fee_estimator,
4066 chain_monitor: nodes[0].chain_monitor,
4067 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4068 logger: nodes[0].logger,
4072 nodes_0_deserialized = nodes_0_deserialized_tmp;
4073 assert!(nodes_0_read.is_empty());
4075 assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4076 nodes[0].node = &nodes_0_deserialized;
4077 check_added_monitors!(nodes[0], 1);
4079 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
4081 // as_announcement should be re-generated exactly by broadcast_node_announcement.
4082 nodes[0].node.broadcast_node_announcement([0, 0, 0], [0; 32], Vec::new());
4083 let msgs = nodes[0].node.get_and_clear_pending_msg_events();
4084 let mut found_announcement = false;
4085 for event in msgs.iter() {
4087 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, .. } => {
4088 if *msg == as_announcement { found_announcement = true; }
4090 MessageSendEvent::BroadcastNodeAnnouncement { .. } => {},
4091 _ => panic!("Unexpected event"),
4094 assert!(found_announcement);
4098 fn test_drop_messages_peer_disconnect_dual_htlc() {
4099 // Test that we can handle reconnecting when both sides of a channel have pending
4100 // commitment_updates when we disconnect.
4101 let chanmon_cfgs = create_chanmon_cfgs(2);
4102 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4103 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4104 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4105 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4106 let logger = test_utils::TestLogger::new();
4108 let (payment_preimage_1, _, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
4110 // Now try to send a second payment which will fail to send
4111 let (payment_preimage_2, payment_hash_2, payment_secret_2) = get_payment_preimage_hash!(nodes[1]);
4112 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
4113 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
4114 nodes[0].node.send_payment(&route, payment_hash_2, &Some(payment_secret_2)).unwrap();
4115 check_added_monitors!(nodes[0], 1);
4117 let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
4118 assert_eq!(events_1.len(), 1);
4120 MessageSendEvent::UpdateHTLCs { .. } => {},
4121 _ => panic!("Unexpected event"),
4124 assert!(nodes[1].node.claim_funds(payment_preimage_1));
4125 check_added_monitors!(nodes[1], 1);
4127 let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
4128 assert_eq!(events_2.len(), 1);
4130 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 } } => {
4131 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
4132 assert!(update_add_htlcs.is_empty());
4133 assert_eq!(update_fulfill_htlcs.len(), 1);
4134 assert!(update_fail_htlcs.is_empty());
4135 assert!(update_fail_malformed_htlcs.is_empty());
4136 assert!(update_fee.is_none());
4138 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlcs[0]);
4139 let events_3 = nodes[0].node.get_and_clear_pending_events();
4140 assert_eq!(events_3.len(), 1);
4142 Event::PaymentSent { ref payment_preimage } => {
4143 assert_eq!(*payment_preimage, payment_preimage_1);
4145 _ => panic!("Unexpected event"),
4148 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), commitment_signed);
4149 let _ = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
4150 // No commitment_signed so get_event_msg's assert(len == 1) passes
4151 check_added_monitors!(nodes[0], 1);
4153 _ => panic!("Unexpected event"),
4156 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
4157 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4159 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4160 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
4161 assert_eq!(reestablish_1.len(), 1);
4162 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4163 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
4164 assert_eq!(reestablish_2.len(), 1);
4166 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
4167 let as_resp = handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
4168 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
4169 let bs_resp = handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
4171 assert!(as_resp.0.is_none());
4172 assert!(bs_resp.0.is_none());
4174 assert!(bs_resp.1.is_none());
4175 assert!(bs_resp.2.is_none());
4177 assert!(as_resp.3 == RAACommitmentOrder::CommitmentFirst);
4179 assert_eq!(as_resp.2.as_ref().unwrap().update_add_htlcs.len(), 1);
4180 assert!(as_resp.2.as_ref().unwrap().update_fulfill_htlcs.is_empty());
4181 assert!(as_resp.2.as_ref().unwrap().update_fail_htlcs.is_empty());
4182 assert!(as_resp.2.as_ref().unwrap().update_fail_malformed_htlcs.is_empty());
4183 assert!(as_resp.2.as_ref().unwrap().update_fee.is_none());
4184 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &as_resp.2.as_ref().unwrap().update_add_htlcs[0]);
4185 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_resp.2.as_ref().unwrap().commitment_signed);
4186 let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
4187 // No commitment_signed so get_event_msg's assert(len == 1) passes
4188 check_added_monitors!(nodes[1], 1);
4190 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), as_resp.1.as_ref().unwrap());
4191 let bs_second_commitment_signed = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4192 assert!(bs_second_commitment_signed.update_add_htlcs.is_empty());
4193 assert!(bs_second_commitment_signed.update_fulfill_htlcs.is_empty());
4194 assert!(bs_second_commitment_signed.update_fail_htlcs.is_empty());
4195 assert!(bs_second_commitment_signed.update_fail_malformed_htlcs.is_empty());
4196 assert!(bs_second_commitment_signed.update_fee.is_none());
4197 check_added_monitors!(nodes[1], 1);
4199 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
4200 let as_commitment_signed = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
4201 assert!(as_commitment_signed.update_add_htlcs.is_empty());
4202 assert!(as_commitment_signed.update_fulfill_htlcs.is_empty());
4203 assert!(as_commitment_signed.update_fail_htlcs.is_empty());
4204 assert!(as_commitment_signed.update_fail_malformed_htlcs.is_empty());
4205 assert!(as_commitment_signed.update_fee.is_none());
4206 check_added_monitors!(nodes[0], 1);
4208 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_commitment_signed.commitment_signed);
4209 let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
4210 // No commitment_signed so get_event_msg's assert(len == 1) passes
4211 check_added_monitors!(nodes[0], 1);
4213 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed.commitment_signed);
4214 let bs_second_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
4215 // No commitment_signed so get_event_msg's assert(len == 1) passes
4216 check_added_monitors!(nodes[1], 1);
4218 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
4219 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4220 check_added_monitors!(nodes[1], 1);
4222 expect_pending_htlcs_forwardable!(nodes[1]);
4224 let events_5 = nodes[1].node.get_and_clear_pending_events();
4225 assert_eq!(events_5.len(), 1);
4227 Event::PaymentReceived { ref payment_hash, ref purpose, .. } => {
4228 assert_eq!(payment_hash_2, *payment_hash);
4230 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
4231 assert!(payment_preimage.is_none());
4232 assert_eq!(payment_secret_2, *payment_secret);
4234 _ => panic!("expected PaymentPurpose::InvoicePayment")
4237 _ => panic!("Unexpected event"),
4240 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke_and_ack);
4241 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4242 check_added_monitors!(nodes[0], 1);
4244 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
4247 fn do_test_htlc_timeout(send_partial_mpp: bool) {
4248 // If the user fails to claim/fail an HTLC within the HTLC CLTV timeout we fail it for them
4249 // to avoid our counterparty failing the channel.
4250 let chanmon_cfgs = create_chanmon_cfgs(2);
4251 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4252 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4253 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4255 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4256 let logger = test_utils::TestLogger::new();
4258 let our_payment_hash = if send_partial_mpp {
4259 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
4260 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
4261 let (_, our_payment_hash, payment_secret) = get_payment_preimage_hash!(&nodes[1]);
4262 // Use the utility function send_payment_along_path to send the payment with MPP data which
4263 // indicates there are more HTLCs coming.
4264 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.
4265 nodes[0].node.send_payment_along_path(&route.paths[0], &our_payment_hash, &Some(payment_secret), 200000, cur_height, &None).unwrap();
4266 check_added_monitors!(nodes[0], 1);
4267 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
4268 assert_eq!(events.len(), 1);
4269 // Now do the relevant commitment_signed/RAA dances along the path, noting that the final
4270 // hop should *not* yet generate any PaymentReceived event(s).
4271 pass_along_path(&nodes[0], &[&nodes[1]], 100000, our_payment_hash, Some(payment_secret), events.drain(..).next().unwrap(), false, None);
4274 route_payment(&nodes[0], &[&nodes[1]], 100000).1
4277 let mut block = Block {
4278 header: BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
4281 connect_block(&nodes[0], &block);
4282 connect_block(&nodes[1], &block);
4283 let block_count = TEST_FINAL_CLTV + CHAN_CONFIRM_DEPTH + 2 - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS;
4284 for _ in CHAN_CONFIRM_DEPTH + 2..block_count {
4285 block.header.prev_blockhash = block.block_hash();
4286 connect_block(&nodes[0], &block);
4287 connect_block(&nodes[1], &block);
4290 expect_pending_htlcs_forwardable!(nodes[1]);
4292 check_added_monitors!(nodes[1], 1);
4293 let htlc_timeout_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4294 assert!(htlc_timeout_updates.update_add_htlcs.is_empty());
4295 assert_eq!(htlc_timeout_updates.update_fail_htlcs.len(), 1);
4296 assert!(htlc_timeout_updates.update_fail_malformed_htlcs.is_empty());
4297 assert!(htlc_timeout_updates.update_fee.is_none());
4299 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_timeout_updates.update_fail_htlcs[0]);
4300 commitment_signed_dance!(nodes[0], nodes[1], htlc_timeout_updates.commitment_signed, false);
4301 // 100_000 msat as u64, followed by the height at which we failed back above
4302 let mut expected_failure_data = byte_utils::be64_to_array(100_000).to_vec();
4303 expected_failure_data.extend_from_slice(&byte_utils::be32_to_array(block_count - 1));
4304 expect_payment_failed!(nodes[0], our_payment_hash, true, 0x4000 | 15, &expected_failure_data[..]);
4308 fn test_htlc_timeout() {
4309 do_test_htlc_timeout(true);
4310 do_test_htlc_timeout(false);
4313 fn do_test_holding_cell_htlc_add_timeouts(forwarded_htlc: bool) {
4314 // Tests that HTLCs in the holding cell are timed out after the requisite number of blocks.
4315 let chanmon_cfgs = create_chanmon_cfgs(3);
4316 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
4317 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
4318 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
4319 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4320 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
4322 // Make sure all nodes are at the same starting height
4323 connect_blocks(&nodes[0], 2*CHAN_CONFIRM_DEPTH + 1 - nodes[0].best_block_info().1);
4324 connect_blocks(&nodes[1], 2*CHAN_CONFIRM_DEPTH + 1 - nodes[1].best_block_info().1);
4325 connect_blocks(&nodes[2], 2*CHAN_CONFIRM_DEPTH + 1 - nodes[2].best_block_info().1);
4327 let logger = test_utils::TestLogger::new();
4329 // Route a first payment to get the 1 -> 2 channel in awaiting_raa...
4330 let (_, first_payment_hash, first_payment_secret) = get_payment_preimage_hash!(nodes[2]);
4332 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
4333 let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[2].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
4334 nodes[1].node.send_payment(&route, first_payment_hash, &Some(first_payment_secret)).unwrap();
4336 assert_eq!(nodes[1].node.get_and_clear_pending_msg_events().len(), 1);
4337 check_added_monitors!(nodes[1], 1);
4339 // Now attempt to route a second payment, which should be placed in the holding cell
4340 let (_, second_payment_hash, second_payment_secret) = get_payment_preimage_hash!(nodes[2]);
4342 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
4343 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[2].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
4344 nodes[0].node.send_payment(&route, second_payment_hash, &Some(first_payment_secret)).unwrap();
4345 check_added_monitors!(nodes[0], 1);
4346 let payment_event = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
4347 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
4348 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
4349 expect_pending_htlcs_forwardable!(nodes[1]);
4350 check_added_monitors!(nodes[1], 0);
4352 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
4353 let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[2].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
4354 nodes[1].node.send_payment(&route, second_payment_hash, &Some(second_payment_secret)).unwrap();
4355 check_added_monitors!(nodes[1], 0);
4358 connect_blocks(&nodes[1], TEST_FINAL_CLTV - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS);
4359 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4360 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
4361 connect_blocks(&nodes[1], 1);
4364 expect_pending_htlcs_forwardable!(nodes[1]);
4365 check_added_monitors!(nodes[1], 1);
4366 let fail_commit = nodes[1].node.get_and_clear_pending_msg_events();
4367 assert_eq!(fail_commit.len(), 1);
4368 match fail_commit[0] {
4369 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fail_htlcs, ref commitment_signed, .. }, .. } => {
4370 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
4371 commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, true, true);
4373 _ => unreachable!(),
4375 expect_payment_failed!(nodes[0], second_payment_hash, false);
4376 expect_payment_failure_chan_update!(nodes[0], chan_2.0.contents.short_channel_id, false);
4378 expect_payment_failed!(nodes[1], second_payment_hash, true);
4383 fn test_holding_cell_htlc_add_timeouts() {
4384 do_test_holding_cell_htlc_add_timeouts(false);
4385 do_test_holding_cell_htlc_add_timeouts(true);
4389 fn test_invalid_channel_announcement() {
4390 //Test BOLT 7 channel_announcement msg requirement for final node, gather data to build customed channel_announcement msgs
4391 let secp_ctx = Secp256k1::new();
4392 let chanmon_cfgs = create_chanmon_cfgs(2);
4393 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4394 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4395 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4397 let chan_announcement = create_chan_between_nodes(&nodes[0], &nodes[1], InitFeatures::known(), InitFeatures::known());
4399 let a_channel_lock = nodes[0].node.channel_state.lock().unwrap();
4400 let b_channel_lock = nodes[1].node.channel_state.lock().unwrap();
4401 let as_chan = a_channel_lock.by_id.get(&chan_announcement.3).unwrap();
4402 let bs_chan = b_channel_lock.by_id.get(&chan_announcement.3).unwrap();
4404 nodes[0].net_graph_msg_handler.handle_htlc_fail_channel_update(&msgs::HTLCFailChannelUpdate::ChannelClosed { short_channel_id : as_chan.get_short_channel_id().unwrap(), is_permanent: false } );
4406 let as_bitcoin_key = as_chan.get_signer().inner.holder_channel_pubkeys.funding_pubkey;
4407 let bs_bitcoin_key = bs_chan.get_signer().inner.holder_channel_pubkeys.funding_pubkey;
4409 let as_network_key = nodes[0].node.get_our_node_id();
4410 let bs_network_key = nodes[1].node.get_our_node_id();
4412 let were_node_one = as_bitcoin_key.serialize()[..] < bs_bitcoin_key.serialize()[..];
4414 let mut chan_announcement;
4416 macro_rules! dummy_unsigned_msg {
4418 msgs::UnsignedChannelAnnouncement {
4419 features: ChannelFeatures::known(),
4420 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
4421 short_channel_id: as_chan.get_short_channel_id().unwrap(),
4422 node_id_1: if were_node_one { as_network_key } else { bs_network_key },
4423 node_id_2: if were_node_one { bs_network_key } else { as_network_key },
4424 bitcoin_key_1: if were_node_one { as_bitcoin_key } else { bs_bitcoin_key },
4425 bitcoin_key_2: if were_node_one { bs_bitcoin_key } else { as_bitcoin_key },
4426 excess_data: Vec::new(),
4431 macro_rules! sign_msg {
4432 ($unsigned_msg: expr) => {
4433 let msghash = Message::from_slice(&Sha256dHash::hash(&$unsigned_msg.encode()[..])[..]).unwrap();
4434 let as_bitcoin_sig = secp_ctx.sign(&msghash, &as_chan.get_signer().inner.funding_key);
4435 let bs_bitcoin_sig = secp_ctx.sign(&msghash, &bs_chan.get_signer().inner.funding_key);
4436 let as_node_sig = secp_ctx.sign(&msghash, &nodes[0].keys_manager.get_node_secret());
4437 let bs_node_sig = secp_ctx.sign(&msghash, &nodes[1].keys_manager.get_node_secret());
4438 chan_announcement = msgs::ChannelAnnouncement {
4439 node_signature_1 : if were_node_one { as_node_sig } else { bs_node_sig},
4440 node_signature_2 : if were_node_one { bs_node_sig } else { as_node_sig},
4441 bitcoin_signature_1: if were_node_one { as_bitcoin_sig } else { bs_bitcoin_sig },
4442 bitcoin_signature_2 : if were_node_one { bs_bitcoin_sig } else { as_bitcoin_sig },
4443 contents: $unsigned_msg
4448 let unsigned_msg = dummy_unsigned_msg!();
4449 sign_msg!(unsigned_msg);
4450 assert_eq!(nodes[0].net_graph_msg_handler.handle_channel_announcement(&chan_announcement).unwrap(), true);
4451 let _ = nodes[0].net_graph_msg_handler.handle_htlc_fail_channel_update(&msgs::HTLCFailChannelUpdate::ChannelClosed { short_channel_id : as_chan.get_short_channel_id().unwrap(), is_permanent: false } );
4453 // Configured with Network::Testnet
4454 let mut unsigned_msg = dummy_unsigned_msg!();
4455 unsigned_msg.chain_hash = genesis_block(Network::Bitcoin).header.block_hash();
4456 sign_msg!(unsigned_msg);
4457 assert!(nodes[0].net_graph_msg_handler.handle_channel_announcement(&chan_announcement).is_err());
4459 let mut unsigned_msg = dummy_unsigned_msg!();
4460 unsigned_msg.chain_hash = BlockHash::hash(&[1,2,3,4,5,6,7,8,9]);
4461 sign_msg!(unsigned_msg);
4462 assert!(nodes[0].net_graph_msg_handler.handle_channel_announcement(&chan_announcement).is_err());
4466 fn test_no_txn_manager_serialize_deserialize() {
4467 let chanmon_cfgs = create_chanmon_cfgs(2);
4468 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4469 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4470 let logger: test_utils::TestLogger;
4471 let fee_estimator: test_utils::TestFeeEstimator;
4472 let persister: test_utils::TestPersister;
4473 let new_chain_monitor: test_utils::TestChainMonitor;
4474 let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4475 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4477 let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
4479 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4481 let nodes_0_serialized = nodes[0].node.encode();
4482 let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4483 nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
4485 logger = test_utils::TestLogger::new();
4486 fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
4487 persister = test_utils::TestPersister::new();
4488 let keys_manager = &chanmon_cfgs[0].keys_manager;
4489 new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator, &persister, keys_manager);
4490 nodes[0].chain_monitor = &new_chain_monitor;
4491 let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4492 let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
4493 &mut chan_0_monitor_read, keys_manager).unwrap();
4494 assert!(chan_0_monitor_read.is_empty());
4496 let mut nodes_0_read = &nodes_0_serialized[..];
4497 let config = UserConfig::default();
4498 let (_, nodes_0_deserialized_tmp) = {
4499 let mut channel_monitors = HashMap::new();
4500 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4501 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4502 default_config: config,
4504 fee_estimator: &fee_estimator,
4505 chain_monitor: nodes[0].chain_monitor,
4506 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4511 nodes_0_deserialized = nodes_0_deserialized_tmp;
4512 assert!(nodes_0_read.is_empty());
4514 assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4515 nodes[0].node = &nodes_0_deserialized;
4516 assert_eq!(nodes[0].node.list_channels().len(), 1);
4517 check_added_monitors!(nodes[0], 1);
4519 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4520 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
4521 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4522 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
4524 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
4525 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4526 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
4527 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4529 let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
4530 let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
4531 for node in nodes.iter() {
4532 assert!(node.net_graph_msg_handler.handle_channel_announcement(&announcement).unwrap());
4533 node.net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
4534 node.net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
4537 send_payment(&nodes[0], &[&nodes[1]], 1000000);
4541 fn test_dup_htlc_onchain_fails_on_reload() {
4542 // When a Channel is closed, any outbound HTLCs which were relayed through it are simply
4543 // dropped when the Channel is. From there, the ChannelManager relies on the ChannelMonitor
4544 // having a copy of the relevant fail-/claim-back data and processes the HTLC fail/claim when
4545 // the ChannelMonitor tells it to.
4547 // If, due to an on-chain event, an HTLC is failed/claimed, and then we serialize the
4548 // ChannelManager, we generally expect there not to be a duplicate HTLC fail/claim (eg via a
4549 // PaymentFailed event appearing). However, because we may not serialize the relevant
4550 // ChannelMonitor at the same time, this isn't strictly guaranteed. In order to provide this
4551 // consistency, the ChannelManager explicitly tracks pending-onchain-resolution outbound HTLCs
4552 // and de-duplicates ChannelMonitor events.
4554 // This tests that explicit tracking behavior.
4555 let chanmon_cfgs = create_chanmon_cfgs(2);
4556 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4557 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4558 let persister: test_utils::TestPersister;
4559 let new_chain_monitor: test_utils::TestChainMonitor;
4560 let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4561 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4563 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4565 // Route a payment, but force-close the channel before the HTLC fulfill message arrives at
4567 let (payment_preimage, _, _) = route_payment(&nodes[0], &[&nodes[1]], 10000000);
4568 nodes[0].node.force_close_channel(&nodes[0].node.list_channels()[0].channel_id).unwrap();
4569 check_closed_broadcast!(nodes[0], true);
4570 check_added_monitors!(nodes[0], 1);
4572 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
4573 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4575 // Connect blocks until the CLTV timeout is up so that we get an HTLC-Timeout transaction
4576 connect_blocks(&nodes[0], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + 1);
4577 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
4578 assert_eq!(node_txn.len(), 3);
4579 assert_eq!(node_txn[0], node_txn[1]);
4581 assert!(nodes[1].node.claim_funds(payment_preimage));
4582 check_added_monitors!(nodes[1], 1);
4584 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4585 connect_block(&nodes[1], &Block { header, txdata: vec![node_txn[1].clone(), node_txn[2].clone()]});
4586 check_closed_broadcast!(nodes[1], true);
4587 check_added_monitors!(nodes[1], 1);
4588 let claim_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
4590 header.prev_blockhash = nodes[0].best_block_hash();
4591 connect_block(&nodes[0], &Block { header, txdata: vec![node_txn[1].clone(), node_txn[2].clone()]});
4593 // Serialize out the ChannelMonitor before connecting the on-chain claim transactions. This is
4594 // fairly normal behavior as ChannelMonitor(s) are often not re-serialized when on-chain events
4595 // happen, unlike ChannelManager which tends to be re-serialized after any relevant event(s).
4596 let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4597 nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
4599 header.prev_blockhash = nodes[0].best_block_hash();
4600 let claim_block = Block { header, txdata: claim_txn};
4601 connect_block(&nodes[0], &claim_block);
4602 expect_payment_sent!(nodes[0], payment_preimage);
4604 // ChannelManagers generally get re-serialized after any relevant event(s). Since we just
4605 // connected a highly-relevant block, it likely gets serialized out now.
4606 let mut chan_manager_serialized = test_utils::TestVecWriter(Vec::new());
4607 nodes[0].node.write(&mut chan_manager_serialized).unwrap();
4609 // Now reload nodes[0]...
4610 persister = test_utils::TestPersister::new();
4611 let keys_manager = &chanmon_cfgs[0].keys_manager;
4612 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);
4613 nodes[0].chain_monitor = &new_chain_monitor;
4614 let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4615 let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
4616 &mut chan_0_monitor_read, keys_manager).unwrap();
4617 assert!(chan_0_monitor_read.is_empty());
4619 let (_, nodes_0_deserialized_tmp) = {
4620 let mut channel_monitors = HashMap::new();
4621 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4622 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>
4623 ::read(&mut io::Cursor::new(&chan_manager_serialized.0[..]), ChannelManagerReadArgs {
4624 default_config: Default::default(),
4626 fee_estimator: node_cfgs[0].fee_estimator,
4627 chain_monitor: nodes[0].chain_monitor,
4628 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4629 logger: nodes[0].logger,
4633 nodes_0_deserialized = nodes_0_deserialized_tmp;
4635 assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4636 check_added_monitors!(nodes[0], 1);
4637 nodes[0].node = &nodes_0_deserialized;
4639 // Note that if we re-connect the block which exposed nodes[0] to the payment preimage (but
4640 // which the current ChannelMonitor has not seen), the ChannelManager's de-duplication of
4641 // payment events should kick in, leaving us with no pending events here.
4642 let height = nodes[0].blocks.lock().unwrap().len() as u32 - 1;
4643 nodes[0].chain_monitor.chain_monitor.block_connected(&claim_block, height);
4644 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
4648 fn test_manager_serialize_deserialize_events() {
4649 // This test makes sure the events field in ChannelManager survives de/serialization
4650 let chanmon_cfgs = create_chanmon_cfgs(2);
4651 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4652 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4653 let fee_estimator: test_utils::TestFeeEstimator;
4654 let persister: test_utils::TestPersister;
4655 let logger: test_utils::TestLogger;
4656 let new_chain_monitor: test_utils::TestChainMonitor;
4657 let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4658 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4660 // Start creating a channel, but stop right before broadcasting the funding transaction
4661 let channel_value = 100000;
4662 let push_msat = 10001;
4663 let a_flags = InitFeatures::known();
4664 let b_flags = InitFeatures::known();
4665 let node_a = nodes.remove(0);
4666 let node_b = nodes.remove(0);
4667 node_a.node.create_channel(node_b.node.get_our_node_id(), channel_value, push_msat, 42, None).unwrap();
4668 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()));
4669 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()));
4671 let (temporary_channel_id, tx, funding_output) = create_funding_transaction(&node_a, channel_value, 42);
4673 node_a.node.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
4674 check_added_monitors!(node_a, 0);
4676 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()));
4678 let mut added_monitors = node_b.chain_monitor.added_monitors.lock().unwrap();
4679 assert_eq!(added_monitors.len(), 1);
4680 assert_eq!(added_monitors[0].0, funding_output);
4681 added_monitors.clear();
4684 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()));
4686 let mut added_monitors = node_a.chain_monitor.added_monitors.lock().unwrap();
4687 assert_eq!(added_monitors.len(), 1);
4688 assert_eq!(added_monitors[0].0, funding_output);
4689 added_monitors.clear();
4691 // Normally, this is where node_a would broadcast the funding transaction, but the test de/serializes first instead
4696 // Start the de/seriailization process mid-channel creation to check that the channel manager will hold onto events that are serialized
4697 let nodes_0_serialized = nodes[0].node.encode();
4698 let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4699 nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
4701 fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
4702 logger = test_utils::TestLogger::new();
4703 persister = test_utils::TestPersister::new();
4704 let keys_manager = &chanmon_cfgs[0].keys_manager;
4705 new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator, &persister, keys_manager);
4706 nodes[0].chain_monitor = &new_chain_monitor;
4707 let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4708 let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
4709 &mut chan_0_monitor_read, keys_manager).unwrap();
4710 assert!(chan_0_monitor_read.is_empty());
4712 let mut nodes_0_read = &nodes_0_serialized[..];
4713 let config = UserConfig::default();
4714 let (_, nodes_0_deserialized_tmp) = {
4715 let mut channel_monitors = HashMap::new();
4716 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4717 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4718 default_config: config,
4720 fee_estimator: &fee_estimator,
4721 chain_monitor: nodes[0].chain_monitor,
4722 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4727 nodes_0_deserialized = nodes_0_deserialized_tmp;
4728 assert!(nodes_0_read.is_empty());
4730 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4732 assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4733 nodes[0].node = &nodes_0_deserialized;
4735 // After deserializing, make sure the funding_transaction is still held by the channel manager
4736 let events_4 = nodes[0].node.get_and_clear_pending_events();
4737 assert_eq!(events_4.len(), 0);
4738 assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
4739 assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0].txid(), funding_output.txid);
4741 // Make sure the channel is functioning as though the de/serialization never happened
4742 assert_eq!(nodes[0].node.list_channels().len(), 1);
4743 check_added_monitors!(nodes[0], 1);
4745 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4746 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
4747 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4748 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
4750 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
4751 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4752 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
4753 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4755 let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
4756 let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
4757 for node in nodes.iter() {
4758 assert!(node.net_graph_msg_handler.handle_channel_announcement(&announcement).unwrap());
4759 node.net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
4760 node.net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
4763 send_payment(&nodes[0], &[&nodes[1]], 1000000);
4767 fn test_simple_manager_serialize_deserialize() {
4768 let chanmon_cfgs = create_chanmon_cfgs(2);
4769 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4770 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4771 let logger: test_utils::TestLogger;
4772 let fee_estimator: test_utils::TestFeeEstimator;
4773 let persister: test_utils::TestPersister;
4774 let new_chain_monitor: test_utils::TestChainMonitor;
4775 let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4776 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4777 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4779 let (our_payment_preimage, _, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
4780 let (_, our_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
4782 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4784 let nodes_0_serialized = nodes[0].node.encode();
4785 let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4786 nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
4788 logger = test_utils::TestLogger::new();
4789 fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
4790 persister = test_utils::TestPersister::new();
4791 let keys_manager = &chanmon_cfgs[0].keys_manager;
4792 new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator, &persister, keys_manager);
4793 nodes[0].chain_monitor = &new_chain_monitor;
4794 let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4795 let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
4796 &mut chan_0_monitor_read, keys_manager).unwrap();
4797 assert!(chan_0_monitor_read.is_empty());
4799 let mut nodes_0_read = &nodes_0_serialized[..];
4800 let (_, nodes_0_deserialized_tmp) = {
4801 let mut channel_monitors = HashMap::new();
4802 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4803 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4804 default_config: UserConfig::default(),
4806 fee_estimator: &fee_estimator,
4807 chain_monitor: nodes[0].chain_monitor,
4808 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4813 nodes_0_deserialized = nodes_0_deserialized_tmp;
4814 assert!(nodes_0_read.is_empty());
4816 assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4817 nodes[0].node = &nodes_0_deserialized;
4818 check_added_monitors!(nodes[0], 1);
4820 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
4822 fail_payment(&nodes[0], &[&nodes[1]], our_payment_hash);
4823 claim_payment(&nodes[0], &[&nodes[1]], our_payment_preimage);
4827 fn test_manager_serialize_deserialize_inconsistent_monitor() {
4828 // Test deserializing a ChannelManager with an out-of-date ChannelMonitor
4829 let chanmon_cfgs = create_chanmon_cfgs(4);
4830 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
4831 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
4832 let logger: test_utils::TestLogger;
4833 let fee_estimator: test_utils::TestFeeEstimator;
4834 let persister: test_utils::TestPersister;
4835 let new_chain_monitor: test_utils::TestChainMonitor;
4836 let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4837 let mut nodes = create_network(4, &node_cfgs, &node_chanmgrs);
4838 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4839 create_announced_chan_between_nodes(&nodes, 2, 0, InitFeatures::known(), InitFeatures::known());
4840 let (_, _, channel_id, funding_tx) = create_announced_chan_between_nodes(&nodes, 0, 3, InitFeatures::known(), InitFeatures::known());
4842 let mut node_0_stale_monitors_serialized = Vec::new();
4843 for monitor in nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter() {
4844 let mut writer = test_utils::TestVecWriter(Vec::new());
4845 monitor.1.write(&mut writer).unwrap();
4846 node_0_stale_monitors_serialized.push(writer.0);
4849 let (our_payment_preimage, _, _) = route_payment(&nodes[2], &[&nodes[0], &nodes[1]], 1000000);
4851 // Serialize the ChannelManager here, but the monitor we keep up-to-date
4852 let nodes_0_serialized = nodes[0].node.encode();
4854 route_payment(&nodes[0], &[&nodes[3]], 1000000);
4855 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4856 nodes[2].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4857 nodes[3].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4859 // Now the ChannelMonitor (which is now out-of-sync with ChannelManager for channel w/
4861 let mut node_0_monitors_serialized = Vec::new();
4862 for monitor in nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter() {
4863 let mut writer = test_utils::TestVecWriter(Vec::new());
4864 monitor.1.write(&mut writer).unwrap();
4865 node_0_monitors_serialized.push(writer.0);
4868 logger = test_utils::TestLogger::new();
4869 fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
4870 persister = test_utils::TestPersister::new();
4871 let keys_manager = &chanmon_cfgs[0].keys_manager;
4872 new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator, &persister, keys_manager);
4873 nodes[0].chain_monitor = &new_chain_monitor;
4876 let mut node_0_stale_monitors = Vec::new();
4877 for serialized in node_0_stale_monitors_serialized.iter() {
4878 let mut read = &serialized[..];
4879 let (_, monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(&mut read, keys_manager).unwrap();
4880 assert!(read.is_empty());
4881 node_0_stale_monitors.push(monitor);
4884 let mut node_0_monitors = Vec::new();
4885 for serialized in node_0_monitors_serialized.iter() {
4886 let mut read = &serialized[..];
4887 let (_, monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(&mut read, keys_manager).unwrap();
4888 assert!(read.is_empty());
4889 node_0_monitors.push(monitor);
4892 let mut nodes_0_read = &nodes_0_serialized[..];
4893 if let Err(msgs::DecodeError::InvalidValue) =
4894 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4895 default_config: UserConfig::default(),
4897 fee_estimator: &fee_estimator,
4898 chain_monitor: nodes[0].chain_monitor,
4899 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4901 channel_monitors: node_0_stale_monitors.iter_mut().map(|monitor| { (monitor.get_funding_txo().0, monitor) }).collect(),
4903 panic!("If the monitor(s) are stale, this indicates a bug and we should get an Err return");
4906 let mut nodes_0_read = &nodes_0_serialized[..];
4907 let (_, nodes_0_deserialized_tmp) =
4908 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4909 default_config: UserConfig::default(),
4911 fee_estimator: &fee_estimator,
4912 chain_monitor: nodes[0].chain_monitor,
4913 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4915 channel_monitors: node_0_monitors.iter_mut().map(|monitor| { (monitor.get_funding_txo().0, monitor) }).collect(),
4917 nodes_0_deserialized = nodes_0_deserialized_tmp;
4918 assert!(nodes_0_read.is_empty());
4920 { // Channel close should result in a commitment tx
4921 let txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4922 assert_eq!(txn.len(), 1);
4923 check_spends!(txn[0], funding_tx);
4924 assert_eq!(txn[0].input[0].previous_output.txid, funding_tx.txid());
4927 for monitor in node_0_monitors.drain(..) {
4928 assert!(nodes[0].chain_monitor.watch_channel(monitor.get_funding_txo().0, monitor).is_ok());
4929 check_added_monitors!(nodes[0], 1);
4931 nodes[0].node = &nodes_0_deserialized;
4933 // nodes[1] and nodes[2] have no lost state with nodes[0]...
4934 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
4935 reconnect_nodes(&nodes[0], &nodes[2], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
4936 //... and we can even still claim the payment!
4937 claim_payment(&nodes[2], &[&nodes[0], &nodes[1]], our_payment_preimage);
4939 nodes[3].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4940 let reestablish = get_event_msg!(nodes[3], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
4941 nodes[0].node.peer_connected(&nodes[3].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4942 nodes[0].node.handle_channel_reestablish(&nodes[3].node.get_our_node_id(), &reestablish);
4943 let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
4944 assert_eq!(msg_events.len(), 1);
4945 if let MessageSendEvent::HandleError { ref action, .. } = msg_events[0] {
4947 &ErrorAction::SendErrorMessage { ref msg } => {
4948 assert_eq!(msg.channel_id, channel_id);
4950 _ => panic!("Unexpected event!"),
4955 macro_rules! check_spendable_outputs {
4956 ($node: expr, $keysinterface: expr) => {
4958 let mut events = $node.chain_monitor.chain_monitor.get_and_clear_pending_events();
4959 let mut txn = Vec::new();
4960 let mut all_outputs = Vec::new();
4961 let secp_ctx = Secp256k1::new();
4962 for event in events.drain(..) {
4964 Event::SpendableOutputs { mut outputs } => {
4965 for outp in outputs.drain(..) {
4966 txn.push($keysinterface.backing.spend_spendable_outputs(&[&outp], Vec::new(), Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(), 253, &secp_ctx).unwrap());
4967 all_outputs.push(outp);
4970 _ => panic!("Unexpected event"),
4973 if all_outputs.len() > 1 {
4974 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) {
4984 fn test_claim_sizeable_push_msat() {
4985 // Incidentally test SpendableOutput event generation due to detection of to_local output on commitment tx
4986 let chanmon_cfgs = create_chanmon_cfgs(2);
4987 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4988 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4989 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4991 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 99000000, InitFeatures::known(), InitFeatures::known());
4992 nodes[1].node.force_close_channel(&chan.2).unwrap();
4993 check_closed_broadcast!(nodes[1], true);
4994 check_added_monitors!(nodes[1], 1);
4995 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4996 assert_eq!(node_txn.len(), 1);
4997 check_spends!(node_txn[0], chan.3);
4998 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
5000 mine_transaction(&nodes[1], &node_txn[0]);
5001 connect_blocks(&nodes[1], BREAKDOWN_TIMEOUT as u32 - 1);
5003 let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
5004 assert_eq!(spend_txn.len(), 1);
5005 assert_eq!(spend_txn[0].input.len(), 1);
5006 check_spends!(spend_txn[0], node_txn[0]);
5007 assert_eq!(spend_txn[0].input[0].sequence, BREAKDOWN_TIMEOUT as u32);
5011 fn test_claim_on_remote_sizeable_push_msat() {
5012 // Same test as previous, just test on remote commitment tx, as per_commitment_point registration changes following you're funder/fundee and
5013 // to_remote output is encumbered by a P2WPKH
5014 let chanmon_cfgs = create_chanmon_cfgs(2);
5015 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5016 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5017 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5019 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 99000000, InitFeatures::known(), InitFeatures::known());
5020 nodes[0].node.force_close_channel(&chan.2).unwrap();
5021 check_closed_broadcast!(nodes[0], true);
5022 check_added_monitors!(nodes[0], 1);
5024 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5025 assert_eq!(node_txn.len(), 1);
5026 check_spends!(node_txn[0], chan.3);
5027 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
5029 mine_transaction(&nodes[1], &node_txn[0]);
5030 check_closed_broadcast!(nodes[1], true);
5031 check_added_monitors!(nodes[1], 1);
5032 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
5034 let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
5035 assert_eq!(spend_txn.len(), 1);
5036 check_spends!(spend_txn[0], node_txn[0]);
5040 fn test_claim_on_remote_revoked_sizeable_push_msat() {
5041 // Same test as previous, just test on remote revoked commitment tx, as per_commitment_point registration changes following you're funder/fundee and
5042 // to_remote output is encumbered by a P2WPKH
5044 let chanmon_cfgs = create_chanmon_cfgs(2);
5045 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5046 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5047 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5049 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 59000000, InitFeatures::known(), InitFeatures::known());
5050 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
5051 let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan.2);
5052 assert_eq!(revoked_local_txn[0].input.len(), 1);
5053 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
5055 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
5056 mine_transaction(&nodes[1], &revoked_local_txn[0]);
5057 check_closed_broadcast!(nodes[1], true);
5058 check_added_monitors!(nodes[1], 1);
5060 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5061 mine_transaction(&nodes[1], &node_txn[0]);
5062 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
5064 let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
5065 assert_eq!(spend_txn.len(), 3);
5066 check_spends!(spend_txn[0], revoked_local_txn[0]); // to_remote output on revoked remote commitment_tx
5067 check_spends!(spend_txn[1], node_txn[0]);
5068 check_spends!(spend_txn[2], revoked_local_txn[0], node_txn[0]); // Both outputs
5072 fn test_static_spendable_outputs_preimage_tx() {
5073 let chanmon_cfgs = create_chanmon_cfgs(2);
5074 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5075 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5076 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5078 // Create some initial channels
5079 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5081 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
5083 let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
5084 assert_eq!(commitment_tx[0].input.len(), 1);
5085 assert_eq!(commitment_tx[0].input[0].previous_output.txid, chan_1.3.txid());
5087 // Settle A's commitment tx on B's chain
5088 assert!(nodes[1].node.claim_funds(payment_preimage));
5089 check_added_monitors!(nodes[1], 1);
5090 mine_transaction(&nodes[1], &commitment_tx[0]);
5091 check_added_monitors!(nodes[1], 1);
5092 let events = nodes[1].node.get_and_clear_pending_msg_events();
5094 MessageSendEvent::UpdateHTLCs { .. } => {},
5095 _ => panic!("Unexpected event"),
5098 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5099 _ => panic!("Unexepected event"),
5102 // Check B's monitor was able to send back output descriptor event for preimage tx on A's commitment tx
5103 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap(); // ChannelManager : 2 (local commitment tx + HTLC-Success), ChannelMonitor: preimage tx
5104 assert_eq!(node_txn.len(), 3);
5105 check_spends!(node_txn[0], commitment_tx[0]);
5106 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5107 check_spends!(node_txn[1], chan_1.3);
5108 check_spends!(node_txn[2], node_txn[1]);
5110 mine_transaction(&nodes[1], &node_txn[0]);
5111 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
5113 let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
5114 assert_eq!(spend_txn.len(), 1);
5115 check_spends!(spend_txn[0], node_txn[0]);
5119 fn test_static_spendable_outputs_timeout_tx() {
5120 let chanmon_cfgs = create_chanmon_cfgs(2);
5121 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5122 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5123 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5125 // Create some initial channels
5126 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5128 // Rebalance the network a bit by relaying one payment through all the channels ...
5129 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
5131 let (_, our_payment_hash, _) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3_000_000);
5133 let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
5134 assert_eq!(commitment_tx[0].input.len(), 1);
5135 assert_eq!(commitment_tx[0].input[0].previous_output.txid, chan_1.3.txid());
5137 // Settle A's commitment tx on B' chain
5138 mine_transaction(&nodes[1], &commitment_tx[0]);
5139 check_added_monitors!(nodes[1], 1);
5140 let events = nodes[1].node.get_and_clear_pending_msg_events();
5142 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5143 _ => panic!("Unexpected event"),
5145 connect_blocks(&nodes[1], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
5147 // Check B's monitor was able to send back output descriptor event for timeout tx on A's commitment tx
5148 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
5149 assert_eq!(node_txn.len(), 2); // ChannelManager : 1 local commitent tx, ChannelMonitor: timeout tx
5150 check_spends!(node_txn[0], chan_1.3.clone());
5151 check_spends!(node_txn[1], commitment_tx[0].clone());
5152 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5154 mine_transaction(&nodes[1], &node_txn[1]);
5155 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
5156 expect_payment_failed!(nodes[1], our_payment_hash, true);
5158 let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
5159 assert_eq!(spend_txn.len(), 3); // SpendableOutput: remote_commitment_tx.to_remote, timeout_tx.output
5160 check_spends!(spend_txn[0], commitment_tx[0]);
5161 check_spends!(spend_txn[1], node_txn[1]);
5162 check_spends!(spend_txn[2], node_txn[1], commitment_tx[0]); // All outputs
5166 fn test_static_spendable_outputs_justice_tx_revoked_commitment_tx() {
5167 let chanmon_cfgs = create_chanmon_cfgs(2);
5168 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5169 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5170 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5172 // Create some initial channels
5173 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5175 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
5176 let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
5177 assert_eq!(revoked_local_txn[0].input.len(), 1);
5178 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
5180 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
5182 mine_transaction(&nodes[1], &revoked_local_txn[0]);
5183 check_closed_broadcast!(nodes[1], true);
5184 check_added_monitors!(nodes[1], 1);
5186 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5187 assert_eq!(node_txn.len(), 2);
5188 assert_eq!(node_txn[0].input.len(), 2);
5189 check_spends!(node_txn[0], revoked_local_txn[0]);
5191 mine_transaction(&nodes[1], &node_txn[0]);
5192 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
5194 let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
5195 assert_eq!(spend_txn.len(), 1);
5196 check_spends!(spend_txn[0], node_txn[0]);
5200 fn test_static_spendable_outputs_justice_tx_revoked_htlc_timeout_tx() {
5201 let mut chanmon_cfgs = create_chanmon_cfgs(2);
5202 chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
5203 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5204 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5205 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5207 // Create some initial channels
5208 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5210 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
5211 let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
5212 assert_eq!(revoked_local_txn[0].input.len(), 1);
5213 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
5215 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
5217 // A will generate HTLC-Timeout from revoked commitment tx
5218 mine_transaction(&nodes[0], &revoked_local_txn[0]);
5219 check_closed_broadcast!(nodes[0], true);
5220 check_added_monitors!(nodes[0], 1);
5221 connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
5223 let revoked_htlc_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5224 assert_eq!(revoked_htlc_txn.len(), 2);
5225 check_spends!(revoked_htlc_txn[0], chan_1.3);
5226 assert_eq!(revoked_htlc_txn[1].input.len(), 1);
5227 assert_eq!(revoked_htlc_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5228 check_spends!(revoked_htlc_txn[1], revoked_local_txn[0]);
5229 assert_ne!(revoked_htlc_txn[1].lock_time, 0); // HTLC-Timeout
5231 // B will generate justice tx from A's revoked commitment/HTLC tx
5232 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5233 connect_block(&nodes[1], &Block { header, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[1].clone()] });
5234 check_closed_broadcast!(nodes[1], true);
5235 check_added_monitors!(nodes[1], 1);
5237 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5238 assert_eq!(node_txn.len(), 3); // ChannelMonitor: bogus justice tx, justice tx on revoked outputs, ChannelManager: local commitment tx
5239 // The first transaction generated is bogus - it spends both outputs of revoked_local_txn[0]
5240 // including the one already spent by revoked_htlc_txn[1]. That's OK, we'll spend with valid
5241 // transactions next...
5242 assert_eq!(node_txn[0].input.len(), 3);
5243 check_spends!(node_txn[0], revoked_local_txn[0], revoked_htlc_txn[1]);
5245 assert_eq!(node_txn[1].input.len(), 2);
5246 check_spends!(node_txn[1], revoked_local_txn[0], revoked_htlc_txn[1]);
5247 if node_txn[1].input[1].previous_output.txid == revoked_htlc_txn[1].txid() {
5248 assert_ne!(node_txn[1].input[0].previous_output, revoked_htlc_txn[1].input[0].previous_output);
5250 assert_eq!(node_txn[1].input[0].previous_output.txid, revoked_htlc_txn[1].txid());
5251 assert_ne!(node_txn[1].input[1].previous_output, revoked_htlc_txn[1].input[0].previous_output);
5254 assert_eq!(node_txn[2].input.len(), 1);
5255 check_spends!(node_txn[2], chan_1.3);
5257 mine_transaction(&nodes[1], &node_txn[1]);
5258 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
5260 // Check B's ChannelMonitor was able to generate the right spendable output descriptor
5261 let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
5262 assert_eq!(spend_txn.len(), 1);
5263 assert_eq!(spend_txn[0].input.len(), 1);
5264 check_spends!(spend_txn[0], node_txn[1]);
5268 fn test_static_spendable_outputs_justice_tx_revoked_htlc_success_tx() {
5269 let mut chanmon_cfgs = create_chanmon_cfgs(2);
5270 chanmon_cfgs[1].keys_manager.disable_revocation_policy_check = true;
5271 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5272 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5273 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5275 // Create some initial channels
5276 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5278 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
5279 let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan_1.2);
5280 assert_eq!(revoked_local_txn[0].input.len(), 1);
5281 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
5283 // The to-be-revoked commitment tx should have one HTLC and one to_remote output
5284 assert_eq!(revoked_local_txn[0].output.len(), 2);
5286 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
5288 // B will generate HTLC-Success from revoked commitment tx
5289 mine_transaction(&nodes[1], &revoked_local_txn[0]);
5290 check_closed_broadcast!(nodes[1], true);
5291 check_added_monitors!(nodes[1], 1);
5292 let revoked_htlc_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5294 assert_eq!(revoked_htlc_txn.len(), 2);
5295 assert_eq!(revoked_htlc_txn[0].input.len(), 1);
5296 assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5297 check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
5299 // Check that the unspent (of two) outputs on revoked_local_txn[0] is a P2WPKH:
5300 let unspent_local_txn_output = revoked_htlc_txn[0].input[0].previous_output.vout as usize ^ 1;
5301 assert_eq!(revoked_local_txn[0].output[unspent_local_txn_output].script_pubkey.len(), 2 + 20); // P2WPKH
5303 // A will generate justice tx from B's revoked commitment/HTLC tx
5304 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5305 connect_block(&nodes[0], &Block { header, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[0].clone()] });
5306 check_closed_broadcast!(nodes[0], true);
5307 check_added_monitors!(nodes[0], 1);
5309 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5310 assert_eq!(node_txn.len(), 3); // ChannelMonitor: justice tx on revoked commitment, justice tx on revoked HTLC-success, ChannelManager: local commitment tx
5312 // The first transaction generated is bogus - it spends both outputs of revoked_local_txn[0]
5313 // including the one already spent by revoked_htlc_txn[0]. That's OK, we'll spend with valid
5314 // transactions next...
5315 assert_eq!(node_txn[0].input.len(), 2);
5316 check_spends!(node_txn[0], revoked_local_txn[0], revoked_htlc_txn[0]);
5317 if node_txn[0].input[1].previous_output.txid == revoked_htlc_txn[0].txid() {
5318 assert_eq!(node_txn[0].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
5320 assert_eq!(node_txn[0].input[0].previous_output.txid, revoked_htlc_txn[0].txid());
5321 assert_eq!(node_txn[0].input[1].previous_output, revoked_htlc_txn[0].input[0].previous_output);
5324 assert_eq!(node_txn[1].input.len(), 1);
5325 check_spends!(node_txn[1], revoked_htlc_txn[0]);
5327 check_spends!(node_txn[2], chan_1.3);
5329 mine_transaction(&nodes[0], &node_txn[1]);
5330 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
5332 // Note that nodes[0]'s tx_broadcaster is still locked, so if we get here the channelmonitor
5333 // didn't try to generate any new transactions.
5335 // Check A's ChannelMonitor was able to generate the right spendable output descriptor
5336 let spend_txn = check_spendable_outputs!(nodes[0], node_cfgs[0].keys_manager);
5337 assert_eq!(spend_txn.len(), 3);
5338 assert_eq!(spend_txn[0].input.len(), 1);
5339 check_spends!(spend_txn[0], revoked_local_txn[0]); // spending to_remote output from revoked local tx
5340 assert_ne!(spend_txn[0].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
5341 check_spends!(spend_txn[1], node_txn[1]); // spending justice tx output on the htlc success tx
5342 check_spends!(spend_txn[2], revoked_local_txn[0], node_txn[1]); // Both outputs
5346 fn test_onchain_to_onchain_claim() {
5347 // Test that in case of channel closure, we detect the state of output and claim HTLC
5348 // on downstream peer's remote commitment tx.
5349 // First, have C claim an HTLC against its own latest commitment transaction.
5350 // Then, broadcast these to B, which should update the monitor downstream on the A<->B
5352 // Finally, check that B will claim the HTLC output if A's latest commitment transaction
5355 let chanmon_cfgs = create_chanmon_cfgs(3);
5356 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5357 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5358 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5360 // Create some initial channels
5361 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5362 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
5364 // Ensure all nodes are at the same height
5365 let node_max_height = nodes.iter().map(|node| node.blocks.lock().unwrap().len()).max().unwrap() as u32;
5366 connect_blocks(&nodes[0], node_max_height - nodes[0].best_block_info().1);
5367 connect_blocks(&nodes[1], node_max_height - nodes[1].best_block_info().1);
5368 connect_blocks(&nodes[2], node_max_height - nodes[2].best_block_info().1);
5370 // Rebalance the network a bit by relaying one payment through all the channels ...
5371 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
5372 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
5374 let (payment_preimage, _payment_hash, _payment_secret) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
5375 let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
5376 check_spends!(commitment_tx[0], chan_2.3);
5377 nodes[2].node.claim_funds(payment_preimage);
5378 check_added_monitors!(nodes[2], 1);
5379 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
5380 assert!(updates.update_add_htlcs.is_empty());
5381 assert!(updates.update_fail_htlcs.is_empty());
5382 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
5383 assert!(updates.update_fail_malformed_htlcs.is_empty());
5385 mine_transaction(&nodes[2], &commitment_tx[0]);
5386 check_closed_broadcast!(nodes[2], true);
5387 check_added_monitors!(nodes[2], 1);
5389 let c_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 2 (commitment tx, HTLC-Success tx), ChannelMonitor : 1 (HTLC-Success tx)
5390 assert_eq!(c_txn.len(), 3);
5391 assert_eq!(c_txn[0], c_txn[2]);
5392 assert_eq!(commitment_tx[0], c_txn[1]);
5393 check_spends!(c_txn[1], chan_2.3);
5394 check_spends!(c_txn[2], c_txn[1]);
5395 assert_eq!(c_txn[1].input[0].witness.clone().last().unwrap().len(), 71);
5396 assert_eq!(c_txn[2].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5397 assert!(c_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
5398 assert_eq!(c_txn[0].lock_time, 0); // Success tx
5400 // 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
5401 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
5402 connect_block(&nodes[1], &Block { header, txdata: vec![c_txn[1].clone(), c_txn[2].clone()]});
5403 check_added_monitors!(nodes[1], 1);
5404 expect_payment_forwarded!(nodes[1], Some(1000), true);
5406 let mut b_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5407 // ChannelMonitor: claim tx
5408 assert_eq!(b_txn.len(), 1);
5409 check_spends!(b_txn[0], chan_2.3); // B local commitment tx, issued by ChannelManager
5412 let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
5413 assert_eq!(msg_events.len(), 3);
5414 check_added_monitors!(nodes[1], 1);
5415 match msg_events[0] {
5416 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5417 _ => panic!("Unexpected event"),
5419 match msg_events[1] {
5420 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { .. }, node_id: _ } => {},
5421 _ => panic!("Unexpected event"),
5423 match msg_events[2] {
5424 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, .. } } => {
5425 assert!(update_add_htlcs.is_empty());
5426 assert!(update_fail_htlcs.is_empty());
5427 assert_eq!(update_fulfill_htlcs.len(), 1);
5428 assert!(update_fail_malformed_htlcs.is_empty());
5429 assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
5431 _ => panic!("Unexpected event"),
5433 // Broadcast A's commitment tx on B's chain to see if we are able to claim inbound HTLC with our HTLC-Success tx
5434 let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
5435 mine_transaction(&nodes[1], &commitment_tx[0]);
5436 let b_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5437 // ChannelMonitor: HTLC-Success tx, ChannelManager: local commitment tx + HTLC-Success tx
5438 assert_eq!(b_txn.len(), 3);
5439 check_spends!(b_txn[1], chan_1.3);
5440 check_spends!(b_txn[2], b_txn[1]);
5441 check_spends!(b_txn[0], commitment_tx[0]);
5442 assert_eq!(b_txn[0].input[0].witness.clone().last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5443 assert!(b_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
5444 assert_eq!(b_txn[0].lock_time, 0); // Success tx
5446 check_closed_broadcast!(nodes[1], true);
5447 check_added_monitors!(nodes[1], 1);
5451 fn test_duplicate_payment_hash_one_failure_one_success() {
5452 // Topology : A --> B --> C --> D
5453 // We route 2 payments with same hash between B and C, one will be timeout, the other successfully claim
5454 // Note that because C will refuse to generate two payment secrets for the same payment hash,
5455 // we forward one of the payments onwards to D.
5456 let chanmon_cfgs = create_chanmon_cfgs(4);
5457 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
5458 // When this test was written, the default base fee floated based on the HTLC count.
5459 // It is now fixed, so we simply set the fee to the expected value here.
5460 let mut config = test_default_channel_config();
5461 config.channel_options.forwarding_fee_base_msat = 196;
5462 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs,
5463 &[Some(config.clone()), Some(config.clone()), Some(config.clone()), Some(config.clone())]);
5464 let mut nodes = create_network(4, &node_cfgs, &node_chanmgrs);
5466 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5467 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
5468 create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
5470 let node_max_height = nodes.iter().map(|node| node.blocks.lock().unwrap().len()).max().unwrap() as u32;
5471 connect_blocks(&nodes[0], node_max_height - nodes[0].best_block_info().1);
5472 connect_blocks(&nodes[1], node_max_height - nodes[1].best_block_info().1);
5473 connect_blocks(&nodes[2], node_max_height - nodes[2].best_block_info().1);
5474 connect_blocks(&nodes[3], node_max_height - nodes[3].best_block_info().1);
5476 let (our_payment_preimage, duplicate_payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 900000);
5478 let payment_secret = nodes[3].node.create_inbound_payment_for_hash(duplicate_payment_hash, None, 7200, 0).unwrap();
5479 // We reduce the final CLTV here by a somewhat arbitrary constant to keep it under the one-byte
5480 // script push size limit so that the below script length checks match
5481 // ACCEPTED_HTLC_SCRIPT_WEIGHT.
5482 let route = get_route(&nodes[0].node.get_our_node_id(), &nodes[0].net_graph_msg_handler.network_graph.read().unwrap(),
5483 &nodes[3].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 900000, TEST_FINAL_CLTV - 40, nodes[0].logger).unwrap();
5484 send_along_route_with_secret(&nodes[0], route, &[&[&nodes[1], &nodes[2], &nodes[3]]], 900000, duplicate_payment_hash, payment_secret);
5486 let commitment_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
5487 assert_eq!(commitment_txn[0].input.len(), 1);
5488 check_spends!(commitment_txn[0], chan_2.3);
5490 mine_transaction(&nodes[1], &commitment_txn[0]);
5491 check_closed_broadcast!(nodes[1], true);
5492 check_added_monitors!(nodes[1], 1);
5493 connect_blocks(&nodes[1], TEST_FINAL_CLTV - 40 + MIN_CLTV_EXPIRY_DELTA as u32 - 1); // Confirm blocks until the HTLC expires
5495 let htlc_timeout_tx;
5496 { // Extract one of the two HTLC-Timeout transaction
5497 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5498 // ChannelMonitor: timeout tx * 3, ChannelManager: local commitment tx
5499 assert_eq!(node_txn.len(), 4);
5500 check_spends!(node_txn[0], chan_2.3);
5502 check_spends!(node_txn[1], commitment_txn[0]);
5503 assert_eq!(node_txn[1].input.len(), 1);
5504 check_spends!(node_txn[2], commitment_txn[0]);
5505 assert_eq!(node_txn[2].input.len(), 1);
5506 assert_eq!(node_txn[1].input[0].previous_output, node_txn[2].input[0].previous_output);
5507 check_spends!(node_txn[3], commitment_txn[0]);
5508 assert_ne!(node_txn[1].input[0].previous_output, node_txn[3].input[0].previous_output);
5510 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5511 assert_eq!(node_txn[2].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5512 assert_eq!(node_txn[3].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5513 htlc_timeout_tx = node_txn[1].clone();
5516 nodes[2].node.claim_funds(our_payment_preimage);
5517 mine_transaction(&nodes[2], &commitment_txn[0]);
5518 check_added_monitors!(nodes[2], 2);
5519 let events = nodes[2].node.get_and_clear_pending_msg_events();
5521 MessageSendEvent::UpdateHTLCs { .. } => {},
5522 _ => panic!("Unexpected event"),
5525 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5526 _ => panic!("Unexepected event"),
5528 let htlc_success_txn: Vec<_> = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
5529 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)
5530 check_spends!(htlc_success_txn[0], commitment_txn[0]);
5531 check_spends!(htlc_success_txn[1], commitment_txn[0]);
5532 assert_eq!(htlc_success_txn[0].input.len(), 1);
5533 assert_eq!(htlc_success_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5534 assert_eq!(htlc_success_txn[1].input.len(), 1);
5535 assert_eq!(htlc_success_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5536 assert_ne!(htlc_success_txn[0].input[0].previous_output, htlc_success_txn[1].input[0].previous_output);
5537 assert_eq!(htlc_success_txn[2], commitment_txn[0]);
5538 assert_eq!(htlc_success_txn[3], htlc_success_txn[0]);
5539 assert_eq!(htlc_success_txn[4], htlc_success_txn[1]);
5540 assert_ne!(htlc_success_txn[0].input[0].previous_output, htlc_timeout_tx.input[0].previous_output);
5542 mine_transaction(&nodes[1], &htlc_timeout_tx);
5543 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
5544 expect_pending_htlcs_forwardable!(nodes[1]);
5545 let htlc_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5546 assert!(htlc_updates.update_add_htlcs.is_empty());
5547 assert_eq!(htlc_updates.update_fail_htlcs.len(), 1);
5548 let first_htlc_id = htlc_updates.update_fail_htlcs[0].htlc_id;
5549 assert!(htlc_updates.update_fulfill_htlcs.is_empty());
5550 assert!(htlc_updates.update_fail_malformed_htlcs.is_empty());
5551 check_added_monitors!(nodes[1], 1);
5553 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_updates.update_fail_htlcs[0]);
5554 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
5556 commitment_signed_dance!(nodes[0], nodes[1], &htlc_updates.commitment_signed, false, true);
5557 expect_payment_failure_chan_update!(nodes[0], chan_2.0.contents.short_channel_id, true);
5559 expect_payment_failed!(nodes[0], duplicate_payment_hash, false);
5561 // Solve 2nd HTLC by broadcasting on B's chain HTLC-Success Tx from C
5562 // Note that the fee paid is effectively double as the HTLC value (including the nodes[1] fee
5563 // and nodes[2] fee) is rounded down and then claimed in full.
5564 mine_transaction(&nodes[1], &htlc_success_txn[0]);
5565 expect_payment_forwarded!(nodes[1], Some(196*2), true);
5566 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5567 assert!(updates.update_add_htlcs.is_empty());
5568 assert!(updates.update_fail_htlcs.is_empty());
5569 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
5570 assert_ne!(updates.update_fulfill_htlcs[0].htlc_id, first_htlc_id);
5571 assert!(updates.update_fail_malformed_htlcs.is_empty());
5572 check_added_monitors!(nodes[1], 1);
5574 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
5575 commitment_signed_dance!(nodes[0], nodes[1], &updates.commitment_signed, false);
5577 let events = nodes[0].node.get_and_clear_pending_events();
5579 Event::PaymentSent { ref payment_preimage } => {
5580 assert_eq!(*payment_preimage, our_payment_preimage);
5582 _ => panic!("Unexpected event"),
5587 fn test_dynamic_spendable_outputs_local_htlc_success_tx() {
5588 let chanmon_cfgs = create_chanmon_cfgs(2);
5589 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5590 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5591 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5593 // Create some initial channels
5594 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5596 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000).0;
5597 let local_txn = get_local_commitment_txn!(nodes[1], chan_1.2);
5598 assert_eq!(local_txn.len(), 1);
5599 assert_eq!(local_txn[0].input.len(), 1);
5600 check_spends!(local_txn[0], chan_1.3);
5602 // Give B knowledge of preimage to be able to generate a local HTLC-Success Tx
5603 nodes[1].node.claim_funds(payment_preimage);
5604 check_added_monitors!(nodes[1], 1);
5605 mine_transaction(&nodes[1], &local_txn[0]);
5606 check_added_monitors!(nodes[1], 1);
5607 let events = nodes[1].node.get_and_clear_pending_msg_events();
5609 MessageSendEvent::UpdateHTLCs { .. } => {},
5610 _ => panic!("Unexpected event"),
5613 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5614 _ => panic!("Unexepected event"),
5617 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5618 assert_eq!(node_txn.len(), 3);
5619 assert_eq!(node_txn[0], node_txn[2]);
5620 assert_eq!(node_txn[1], local_txn[0]);
5621 assert_eq!(node_txn[0].input.len(), 1);
5622 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5623 check_spends!(node_txn[0], local_txn[0]);
5627 mine_transaction(&nodes[1], &node_tx);
5628 connect_blocks(&nodes[1], BREAKDOWN_TIMEOUT as u32 - 1);
5630 // Verify that B is able to spend its own HTLC-Success tx thanks to spendable output event given back by its ChannelMonitor
5631 let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
5632 assert_eq!(spend_txn.len(), 1);
5633 assert_eq!(spend_txn[0].input.len(), 1);
5634 check_spends!(spend_txn[0], node_tx);
5635 assert_eq!(spend_txn[0].input[0].sequence, BREAKDOWN_TIMEOUT as u32);
5638 fn do_test_fail_backwards_unrevoked_remote_announce(deliver_last_raa: bool, announce_latest: bool) {
5639 // Test that we fail backwards the full set of HTLCs we need to when remote broadcasts an
5640 // unrevoked commitment transaction.
5641 // This includes HTLCs which were below the dust threshold as well as HTLCs which were awaiting
5642 // a remote RAA before they could be failed backwards (and combinations thereof).
5643 // We also test duplicate-hash HTLCs by adding two nodes on each side of the target nodes which
5644 // use the same payment hashes.
5645 // Thus, we use a six-node network:
5650 // And test where C fails back to A/B when D announces its latest commitment transaction
5651 let chanmon_cfgs = create_chanmon_cfgs(6);
5652 let node_cfgs = create_node_cfgs(6, &chanmon_cfgs);
5653 // When this test was written, the default base fee floated based on the HTLC count.
5654 // It is now fixed, so we simply set the fee to the expected value here.
5655 let mut config = test_default_channel_config();
5656 config.channel_options.forwarding_fee_base_msat = 196;
5657 let node_chanmgrs = create_node_chanmgrs(6, &node_cfgs,
5658 &[Some(config.clone()), Some(config.clone()), Some(config.clone()), Some(config.clone()), Some(config.clone()), Some(config.clone())]);
5659 let nodes = create_network(6, &node_cfgs, &node_chanmgrs);
5660 let logger = test_utils::TestLogger::new();
5662 create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known());
5663 create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
5664 let chan = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
5665 create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::known(), InitFeatures::known());
5666 create_announced_chan_between_nodes(&nodes, 3, 5, InitFeatures::known(), InitFeatures::known());
5668 // Rebalance and check output sanity...
5669 send_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 500000);
5670 send_payment(&nodes[1], &[&nodes[2], &nodes[3], &nodes[5]], 500000);
5671 assert_eq!(get_local_commitment_txn!(nodes[3], chan.2)[0].output.len(), 2);
5673 let ds_dust_limit = nodes[3].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().holder_dust_limit_satoshis;
5675 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
5677 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
5678 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
5679 let our_node_id = &nodes[1].node.get_our_node_id();
5680 let route = get_route(our_node_id, &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[5].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), ds_dust_limit*1000, TEST_FINAL_CLTV, &logger).unwrap();
5682 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
5684 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
5686 let (_, payment_hash_3, _) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
5688 let (_, payment_hash_4, _) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
5689 let route = get_route(our_node_id, &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[5].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
5691 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());
5693 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());
5696 let (_, payment_hash_5, _) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
5698 let route = get_route(our_node_id, &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[5].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), ds_dust_limit*1000, TEST_FINAL_CLTV, &logger).unwrap();
5699 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
5702 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
5704 let route = get_route(our_node_id, &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[5].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
5705 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());
5707 // Double-check that six of the new HTLC were added
5708 // We now have six HTLCs pending over the dust limit and six HTLCs under the dust limit (ie,
5709 // with to_local and to_remote outputs, 8 outputs and 6 HTLCs not included).
5710 assert_eq!(get_local_commitment_txn!(nodes[3], chan.2).len(), 1);
5711 assert_eq!(get_local_commitment_txn!(nodes[3], chan.2)[0].output.len(), 8);
5713 // Now fail back three of the over-dust-limit and three of the under-dust-limit payments in one go.
5714 // Fail 0th below-dust, 4th above-dust, 8th above-dust, 10th below-dust HTLCs
5715 assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_1));
5716 assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_3));
5717 assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_5));
5718 assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_6));
5719 check_added_monitors!(nodes[4], 0);
5720 expect_pending_htlcs_forwardable!(nodes[4]);
5721 check_added_monitors!(nodes[4], 1);
5723 let four_removes = get_htlc_update_msgs!(nodes[4], nodes[3].node.get_our_node_id());
5724 nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[0]);
5725 nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[1]);
5726 nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[2]);
5727 nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[3]);
5728 commitment_signed_dance!(nodes[3], nodes[4], four_removes.commitment_signed, false);
5730 // Fail 3rd below-dust and 7th above-dust HTLCs
5731 assert!(nodes[5].node.fail_htlc_backwards(&payment_hash_2));
5732 assert!(nodes[5].node.fail_htlc_backwards(&payment_hash_4));
5733 check_added_monitors!(nodes[5], 0);
5734 expect_pending_htlcs_forwardable!(nodes[5]);
5735 check_added_monitors!(nodes[5], 1);
5737 let two_removes = get_htlc_update_msgs!(nodes[5], nodes[3].node.get_our_node_id());
5738 nodes[3].node.handle_update_fail_htlc(&nodes[5].node.get_our_node_id(), &two_removes.update_fail_htlcs[0]);
5739 nodes[3].node.handle_update_fail_htlc(&nodes[5].node.get_our_node_id(), &two_removes.update_fail_htlcs[1]);
5740 commitment_signed_dance!(nodes[3], nodes[5], two_removes.commitment_signed, false);
5742 let ds_prev_commitment_tx = get_local_commitment_txn!(nodes[3], chan.2);
5744 expect_pending_htlcs_forwardable!(nodes[3]);
5745 check_added_monitors!(nodes[3], 1);
5746 let six_removes = get_htlc_update_msgs!(nodes[3], nodes[2].node.get_our_node_id());
5747 nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[0]);
5748 nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[1]);
5749 nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[2]);
5750 nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[3]);
5751 nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[4]);
5752 nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[5]);
5753 if deliver_last_raa {
5754 commitment_signed_dance!(nodes[2], nodes[3], six_removes.commitment_signed, false);
5756 let _cs_last_raa = commitment_signed_dance!(nodes[2], nodes[3], six_removes.commitment_signed, false, true, false, true);
5759 // D's latest commitment transaction now contains 1st + 2nd + 9th HTLCs (implicitly, they're
5760 // below the dust limit) and the 5th + 6th + 11th HTLCs. It has failed back the 0th, 3rd, 4th,
5761 // 7th, 8th, and 10th, but as we haven't yet delivered the final RAA to C, the fails haven't
5762 // propagated back to A/B yet (and D has two unrevoked commitment transactions).
5764 // We now broadcast the latest commitment transaction, which *should* result in failures for
5765 // the 0th, 1st, 2nd, 3rd, 4th, 7th, 8th, 9th, and 10th HTLCs, ie all the below-dust HTLCs and
5766 // the non-broadcast above-dust HTLCs.
5768 // Alternatively, we may broadcast the previous commitment transaction, which should only
5769 // result in failures for the below-dust HTLCs, ie the 0th, 1st, 2nd, 3rd, 9th, and 10th HTLCs.
5770 let ds_last_commitment_tx = get_local_commitment_txn!(nodes[3], chan.2);
5772 if announce_latest {
5773 mine_transaction(&nodes[2], &ds_last_commitment_tx[0]);
5775 mine_transaction(&nodes[2], &ds_prev_commitment_tx[0]);
5777 connect_blocks(&nodes[2], ANTI_REORG_DELAY - 1);
5778 check_closed_broadcast!(nodes[2], true);
5779 expect_pending_htlcs_forwardable!(nodes[2]);
5780 check_added_monitors!(nodes[2], 3);
5782 let cs_msgs = nodes[2].node.get_and_clear_pending_msg_events();
5783 assert_eq!(cs_msgs.len(), 2);
5784 let mut a_done = false;
5785 for msg in cs_msgs {
5787 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
5788 // Both under-dust HTLCs and the one above-dust HTLC that we had already failed
5789 // should be failed-backwards here.
5790 let target = if *node_id == nodes[0].node.get_our_node_id() {
5791 // If announce_latest, expect 0th, 1st, 4th, 8th, 10th HTLCs, else only 0th, 1st, 10th below-dust HTLCs
5792 for htlc in &updates.update_fail_htlcs {
5793 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 });
5795 assert_eq!(updates.update_fail_htlcs.len(), if announce_latest { 5 } else { 3 });
5800 // If announce_latest, expect 2nd, 3rd, 7th, 9th HTLCs, else only 2nd, 3rd, 9th below-dust HTLCs
5801 for htlc in &updates.update_fail_htlcs {
5802 assert!(htlc.htlc_id == 1 || htlc.htlc_id == 2 || htlc.htlc_id == 5 || if announce_latest { htlc.htlc_id == 4 } else { false });
5804 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
5805 assert_eq!(updates.update_fail_htlcs.len(), if announce_latest { 4 } else { 3 });
5808 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
5809 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[1]);
5810 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[2]);
5811 if announce_latest {
5812 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[3]);
5813 if *node_id == nodes[0].node.get_our_node_id() {
5814 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[4]);
5817 commitment_signed_dance!(target, nodes[2], updates.commitment_signed, false, true);
5819 _ => panic!("Unexpected event"),
5823 let as_events = nodes[0].node.get_and_clear_pending_events();
5824 assert_eq!(as_events.len(), if announce_latest { 5 } else { 3 });
5825 let mut as_failds = HashSet::new();
5826 for event in as_events.iter() {
5827 if let &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, .. } = event {
5828 assert!(as_failds.insert(*payment_hash));
5829 if *payment_hash != payment_hash_2 {
5830 assert_eq!(*rejected_by_dest, deliver_last_raa);
5832 assert!(!rejected_by_dest);
5834 } else { panic!("Unexpected event"); }
5836 assert!(as_failds.contains(&payment_hash_1));
5837 assert!(as_failds.contains(&payment_hash_2));
5838 if announce_latest {
5839 assert!(as_failds.contains(&payment_hash_3));
5840 assert!(as_failds.contains(&payment_hash_5));
5842 assert!(as_failds.contains(&payment_hash_6));
5844 let bs_events = nodes[1].node.get_and_clear_pending_events();
5845 assert_eq!(bs_events.len(), if announce_latest { 4 } else { 3 });
5846 let mut bs_failds = HashSet::new();
5847 for event in bs_events.iter() {
5848 if let &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, .. } = event {
5849 assert!(bs_failds.insert(*payment_hash));
5850 if *payment_hash != payment_hash_1 && *payment_hash != payment_hash_5 {
5851 assert_eq!(*rejected_by_dest, deliver_last_raa);
5853 assert!(!rejected_by_dest);
5855 } else { panic!("Unexpected event"); }
5857 assert!(bs_failds.contains(&payment_hash_1));
5858 assert!(bs_failds.contains(&payment_hash_2));
5859 if announce_latest {
5860 assert!(bs_failds.contains(&payment_hash_4));
5862 assert!(bs_failds.contains(&payment_hash_5));
5864 // For each HTLC which was not failed-back by normal process (ie deliver_last_raa), we should
5865 // get a PaymentFailureNetworkUpdate. A should have gotten 4 HTLCs which were failed-back due
5866 // to unknown-preimage-etc, B should have gotten 2. Thus, in the
5867 // announce_latest && deliver_last_raa case, we should have 5-4=1 and 4-2=2
5868 // PaymentFailureNetworkUpdates.
5869 let as_msg_events = nodes[0].node.get_and_clear_pending_msg_events();
5870 assert_eq!(as_msg_events.len(), if deliver_last_raa { 1 } else if !announce_latest { 3 } else { 5 });
5871 let bs_msg_events = nodes[1].node.get_and_clear_pending_msg_events();
5872 assert_eq!(bs_msg_events.len(), if deliver_last_raa { 2 } else if !announce_latest { 3 } else { 4 });
5873 for event in as_msg_events.iter().chain(bs_msg_events.iter()) {
5875 &MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
5876 _ => panic!("Unexpected event"),
5882 fn test_fail_backwards_latest_remote_announce_a() {
5883 do_test_fail_backwards_unrevoked_remote_announce(false, true);
5887 fn test_fail_backwards_latest_remote_announce_b() {
5888 do_test_fail_backwards_unrevoked_remote_announce(true, true);
5892 fn test_fail_backwards_previous_remote_announce() {
5893 do_test_fail_backwards_unrevoked_remote_announce(false, false);
5894 // Note that true, true doesn't make sense as it implies we announce a revoked state, which is
5895 // tested for in test_commitment_revoked_fail_backward_exhaustive()
5899 fn test_dynamic_spendable_outputs_local_htlc_timeout_tx() {
5900 let chanmon_cfgs = create_chanmon_cfgs(2);
5901 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5902 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5903 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5905 // Create some initial channels
5906 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5908 let (_, our_payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000);
5909 let local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
5910 assert_eq!(local_txn[0].input.len(), 1);
5911 check_spends!(local_txn[0], chan_1.3);
5913 // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
5914 mine_transaction(&nodes[0], &local_txn[0]);
5915 check_closed_broadcast!(nodes[0], true);
5916 check_added_monitors!(nodes[0], 1);
5917 connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
5919 let htlc_timeout = {
5920 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5921 assert_eq!(node_txn.len(), 2);
5922 check_spends!(node_txn[0], chan_1.3);
5923 assert_eq!(node_txn[1].input.len(), 1);
5924 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5925 check_spends!(node_txn[1], local_txn[0]);
5929 mine_transaction(&nodes[0], &htlc_timeout);
5930 connect_blocks(&nodes[0], BREAKDOWN_TIMEOUT as u32 - 1);
5931 expect_payment_failed!(nodes[0], our_payment_hash, true);
5933 // Verify that A is able to spend its own HTLC-Timeout tx thanks to spendable output event given back by its ChannelMonitor
5934 let spend_txn = check_spendable_outputs!(nodes[0], node_cfgs[0].keys_manager);
5935 assert_eq!(spend_txn.len(), 3);
5936 check_spends!(spend_txn[0], local_txn[0]);
5937 assert_eq!(spend_txn[1].input.len(), 1);
5938 check_spends!(spend_txn[1], htlc_timeout);
5939 assert_eq!(spend_txn[1].input[0].sequence, BREAKDOWN_TIMEOUT as u32);
5940 assert_eq!(spend_txn[2].input.len(), 2);
5941 check_spends!(spend_txn[2], local_txn[0], htlc_timeout);
5942 assert!(spend_txn[2].input[0].sequence == BREAKDOWN_TIMEOUT as u32 ||
5943 spend_txn[2].input[1].sequence == BREAKDOWN_TIMEOUT as u32);
5947 fn test_key_derivation_params() {
5948 // This test is a copy of test_dynamic_spendable_outputs_local_htlc_timeout_tx, with
5949 // a key manager rotation to test that key_derivation_params returned in DynamicOutputP2WSH
5950 // let us re-derive the channel key set to then derive a delayed_payment_key.
5952 let chanmon_cfgs = create_chanmon_cfgs(3);
5954 // We manually create the node configuration to backup the seed.
5955 let seed = [42; 32];
5956 let keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
5957 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);
5958 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() };
5959 let mut node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5960 node_cfgs.remove(0);
5961 node_cfgs.insert(0, node);
5963 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5964 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5966 // Create some initial channels
5967 // Create a dummy channel to advance index by one and thus test re-derivation correctness
5969 let chan_0 = create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known());
5970 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5971 assert_ne!(chan_0.3.output[0].script_pubkey, chan_1.3.output[0].script_pubkey);
5973 // Ensure all nodes are at the same height
5974 let node_max_height = nodes.iter().map(|node| node.blocks.lock().unwrap().len()).max().unwrap() as u32;
5975 connect_blocks(&nodes[0], node_max_height - nodes[0].best_block_info().1);
5976 connect_blocks(&nodes[1], node_max_height - nodes[1].best_block_info().1);
5977 connect_blocks(&nodes[2], node_max_height - nodes[2].best_block_info().1);
5979 let (_, our_payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000);
5980 let local_txn_0 = get_local_commitment_txn!(nodes[0], chan_0.2);
5981 let local_txn_1 = get_local_commitment_txn!(nodes[0], chan_1.2);
5982 assert_eq!(local_txn_1[0].input.len(), 1);
5983 check_spends!(local_txn_1[0], chan_1.3);
5985 // We check funding pubkey are unique
5986 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]));
5987 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]));
5988 if from_0_funding_key_0 == from_1_funding_key_0
5989 || from_0_funding_key_0 == from_1_funding_key_1
5990 || from_0_funding_key_1 == from_1_funding_key_0
5991 || from_0_funding_key_1 == from_1_funding_key_1 {
5992 panic!("Funding pubkeys aren't unique");
5995 // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
5996 mine_transaction(&nodes[0], &local_txn_1[0]);
5997 connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
5998 check_closed_broadcast!(nodes[0], true);
5999 check_added_monitors!(nodes[0], 1);
6001 let htlc_timeout = {
6002 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
6003 assert_eq!(node_txn[1].input.len(), 1);
6004 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
6005 check_spends!(node_txn[1], local_txn_1[0]);
6009 mine_transaction(&nodes[0], &htlc_timeout);
6010 connect_blocks(&nodes[0], BREAKDOWN_TIMEOUT as u32 - 1);
6011 expect_payment_failed!(nodes[0], our_payment_hash, true);
6013 // Verify that A is able to spend its own HTLC-Timeout tx thanks to spendable output event given back by its ChannelMonitor
6014 let new_keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
6015 let spend_txn = check_spendable_outputs!(nodes[0], new_keys_manager);
6016 assert_eq!(spend_txn.len(), 3);
6017 check_spends!(spend_txn[0], local_txn_1[0]);
6018 assert_eq!(spend_txn[1].input.len(), 1);
6019 check_spends!(spend_txn[1], htlc_timeout);
6020 assert_eq!(spend_txn[1].input[0].sequence, BREAKDOWN_TIMEOUT as u32);
6021 assert_eq!(spend_txn[2].input.len(), 2);
6022 check_spends!(spend_txn[2], local_txn_1[0], htlc_timeout);
6023 assert!(spend_txn[2].input[0].sequence == BREAKDOWN_TIMEOUT as u32 ||
6024 spend_txn[2].input[1].sequence == BREAKDOWN_TIMEOUT as u32);
6028 fn test_static_output_closing_tx() {
6029 let chanmon_cfgs = create_chanmon_cfgs(2);
6030 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6031 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6032 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6034 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6036 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
6037 let closing_tx = close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true).2;
6039 mine_transaction(&nodes[0], &closing_tx);
6040 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
6042 let spend_txn = check_spendable_outputs!(nodes[0], node_cfgs[0].keys_manager);
6043 assert_eq!(spend_txn.len(), 1);
6044 check_spends!(spend_txn[0], closing_tx);
6046 mine_transaction(&nodes[1], &closing_tx);
6047 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
6049 let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
6050 assert_eq!(spend_txn.len(), 1);
6051 check_spends!(spend_txn[0], closing_tx);
6054 fn do_htlc_claim_local_commitment_only(use_dust: bool) {
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 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6061 let (our_payment_preimage, _, _) = route_payment(&nodes[0], &[&nodes[1]], if use_dust { 50000 } else { 3000000 });
6063 // Claim the payment, but don't deliver A's commitment_signed, resulting in the HTLC only being
6064 // present in B's local commitment transaction, but none of A's commitment transactions.
6065 assert!(nodes[1].node.claim_funds(our_payment_preimage));
6066 check_added_monitors!(nodes[1], 1);
6068 let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6069 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fulfill_htlcs[0]);
6070 let events = nodes[0].node.get_and_clear_pending_events();
6071 assert_eq!(events.len(), 1);
6073 Event::PaymentSent { payment_preimage } => {
6074 assert_eq!(payment_preimage, our_payment_preimage);
6076 _ => panic!("Unexpected event"),
6079 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_updates.commitment_signed);
6080 check_added_monitors!(nodes[0], 1);
6081 let as_updates = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6082 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_updates.0);
6083 check_added_monitors!(nodes[1], 1);
6085 let starting_block = nodes[1].best_block_info();
6086 let mut block = Block {
6087 header: BlockHeader { version: 0x20000000, prev_blockhash: starting_block.0, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
6090 for _ in starting_block.1 + 1..TEST_FINAL_CLTV - CLTV_CLAIM_BUFFER + starting_block.1 + 2 {
6091 connect_block(&nodes[1], &block);
6092 block.header.prev_blockhash = block.block_hash();
6094 test_txn_broadcast(&nodes[1], &chan, None, if use_dust { HTLCType::NONE } else { HTLCType::SUCCESS });
6095 check_closed_broadcast!(nodes[1], true);
6096 check_added_monitors!(nodes[1], 1);
6099 fn do_htlc_claim_current_remote_commitment_only(use_dust: bool) {
6100 let chanmon_cfgs = create_chanmon_cfgs(2);
6101 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6102 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6103 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6104 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6105 let logger = test_utils::TestLogger::new();
6107 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1]);
6108 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6109 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), if use_dust { 50000 } else { 3000000 }, TEST_FINAL_CLTV, &logger).unwrap();
6110 nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
6111 check_added_monitors!(nodes[0], 1);
6113 let _as_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6115 // As far as A is concerned, the HTLC is now present only in the latest remote commitment
6116 // transaction, however it is not in A's latest local commitment, so we can just broadcast that
6117 // to "time out" the HTLC.
6119 let starting_block = nodes[1].best_block_info();
6120 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: starting_block.0, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6122 for _ in starting_block.1 + 1..TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + starting_block.1 + 2 {
6123 connect_block(&nodes[0], &Block { header, txdata: Vec::new()});
6124 header.prev_blockhash = header.block_hash();
6126 test_txn_broadcast(&nodes[0], &chan, None, HTLCType::NONE);
6127 check_closed_broadcast!(nodes[0], true);
6128 check_added_monitors!(nodes[0], 1);
6131 fn do_htlc_claim_previous_remote_commitment_only(use_dust: bool, check_revoke_no_close: bool) {
6132 let chanmon_cfgs = create_chanmon_cfgs(3);
6133 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
6134 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
6135 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
6136 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6138 // Fail the payment, but don't deliver A's final RAA, resulting in the HTLC only being present
6139 // in B's previous (unrevoked) commitment transaction, but none of A's commitment transactions.
6140 // Also optionally test that we *don't* fail the channel in case the commitment transaction was
6141 // actually revoked.
6142 let htlc_value = if use_dust { 50000 } else { 3000000 };
6143 let (_, our_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1]], htlc_value);
6144 assert!(nodes[1].node.fail_htlc_backwards(&our_payment_hash));
6145 expect_pending_htlcs_forwardable!(nodes[1]);
6146 check_added_monitors!(nodes[1], 1);
6148 let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6149 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fail_htlcs[0]);
6150 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_updates.commitment_signed);
6151 check_added_monitors!(nodes[0], 1);
6152 let as_updates = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6153 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_updates.0);
6154 check_added_monitors!(nodes[1], 1);
6155 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_updates.1);
6156 check_added_monitors!(nodes[1], 1);
6157 let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
6159 if check_revoke_no_close {
6160 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
6161 check_added_monitors!(nodes[0], 1);
6164 let starting_block = nodes[1].best_block_info();
6165 let mut block = Block {
6166 header: BlockHeader { version: 0x20000000, prev_blockhash: starting_block.0, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
6169 for _ in starting_block.1 + 1..TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + CHAN_CONFIRM_DEPTH + 2 {
6170 connect_block(&nodes[0], &block);
6171 block.header.prev_blockhash = block.block_hash();
6173 if !check_revoke_no_close {
6174 test_txn_broadcast(&nodes[0], &chan, None, HTLCType::NONE);
6175 check_closed_broadcast!(nodes[0], true);
6176 check_added_monitors!(nodes[0], 1);
6178 expect_payment_failed!(nodes[0], our_payment_hash, true);
6182 // Test that we close channels on-chain when broadcastable HTLCs reach their timeout window.
6183 // There are only a few cases to test here:
6184 // * its not really normative behavior, but we test that below-dust HTLCs "included" in
6185 // broadcastable commitment transactions result in channel closure,
6186 // * its included in an unrevoked-but-previous remote commitment transaction,
6187 // * its included in the latest remote or local commitment transactions.
6188 // We test each of the three possible commitment transactions individually and use both dust and
6190 // Note that we don't bother testing both outbound and inbound HTLC failures for each case, and we
6191 // assume they are handled the same across all six cases, as both outbound and inbound failures are
6192 // tested for at least one of the cases in other tests.
6194 fn htlc_claim_single_commitment_only_a() {
6195 do_htlc_claim_local_commitment_only(true);
6196 do_htlc_claim_local_commitment_only(false);
6198 do_htlc_claim_current_remote_commitment_only(true);
6199 do_htlc_claim_current_remote_commitment_only(false);
6203 fn htlc_claim_single_commitment_only_b() {
6204 do_htlc_claim_previous_remote_commitment_only(true, false);
6205 do_htlc_claim_previous_remote_commitment_only(false, false);
6206 do_htlc_claim_previous_remote_commitment_only(true, true);
6207 do_htlc_claim_previous_remote_commitment_only(false, true);
6212 fn bolt2_open_channel_sending_node_checks_part1() { //This test needs to be on its own as we are catching a panic
6213 let chanmon_cfgs = create_chanmon_cfgs(2);
6214 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6215 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6216 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6217 //Force duplicate channel ids
6218 for node in nodes.iter() {
6219 *node.keys_manager.override_channel_id_priv.lock().unwrap() = Some([0; 32]);
6222 // BOLT #2 spec: Sending node must ensure temporary_channel_id is unique from any other channel ID with the same peer.
6223 let channel_value_satoshis=10000;
6224 let push_msat=10001;
6225 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).unwrap();
6226 let node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
6227 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &node0_to_1_send_open_channel);
6229 //Create a second channel with a channel_id collision
6230 assert!(nodes[0].node.create_channel(nodes[0].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
6234 fn bolt2_open_channel_sending_node_checks_part2() {
6235 let chanmon_cfgs = create_chanmon_cfgs(2);
6236 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6237 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6238 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6240 // BOLT #2 spec: Sending node must set funding_satoshis to less than 2^24 satoshis
6241 let channel_value_satoshis=2^24;
6242 let push_msat=10001;
6243 assert!(nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
6245 // BOLT #2 spec: Sending node must set push_msat to equal or less than 1000 * funding_satoshis
6246 let channel_value_satoshis=10000;
6247 // Test when push_msat is equal to 1000 * funding_satoshis.
6248 let push_msat=1000*channel_value_satoshis+1;
6249 assert!(nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
6251 // BOLT #2 spec: Sending node must set set channel_reserve_satoshis greater than or equal to dust_limit_satoshis
6252 let channel_value_satoshis=10000;
6253 let push_msat=10001;
6254 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
6255 let node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
6256 assert!(node0_to_1_send_open_channel.channel_reserve_satoshis>=node0_to_1_send_open_channel.dust_limit_satoshis);
6258 // BOLT #2 spec: Sending node must set undefined bits in channel_flags to 0
6259 // 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
6260 assert!(node0_to_1_send_open_channel.channel_flags<=1);
6262 // 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.
6263 assert!(BREAKDOWN_TIMEOUT>0);
6264 assert!(node0_to_1_send_open_channel.to_self_delay==BREAKDOWN_TIMEOUT);
6266 // BOLT #2 spec: Sending node must ensure the chain_hash value identifies the chain it wishes to open the channel within.
6267 let chain_hash=genesis_block(Network::Testnet).header.block_hash();
6268 assert_eq!(node0_to_1_send_open_channel.chain_hash,chain_hash);
6270 // 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.
6271 assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.funding_pubkey.serialize()).is_ok());
6272 assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.revocation_basepoint.serialize()).is_ok());
6273 assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.htlc_basepoint.serialize()).is_ok());
6274 assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.payment_point.serialize()).is_ok());
6275 assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.delayed_payment_basepoint.serialize()).is_ok());
6279 fn bolt2_open_channel_sane_dust_limit() {
6280 let chanmon_cfgs = create_chanmon_cfgs(2);
6281 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6282 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6283 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6285 let channel_value_satoshis=1000000;
6286 let push_msat=10001;
6287 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).unwrap();
6288 let mut node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
6289 node0_to_1_send_open_channel.dust_limit_satoshis = 661;
6290 node0_to_1_send_open_channel.channel_reserve_satoshis = 100001;
6292 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &node0_to_1_send_open_channel);
6293 let events = nodes[1].node.get_and_clear_pending_msg_events();
6294 let err_msg = match events[0] {
6295 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id: _ } => {
6298 _ => panic!("Unexpected event"),
6300 assert_eq!(err_msg.data, "dust_limit_satoshis (661) is greater than the implementation limit (660)");
6303 // Test that if we fail to send an HTLC that is being freed from the holding cell, and the HTLC
6304 // originated from our node, its failure is surfaced to the user. We trigger this failure to
6305 // free the HTLC by increasing our fee while the HTLC is in the holding cell such that the HTLC
6306 // is no longer affordable once it's freed.
6308 fn test_fail_holding_cell_htlc_upon_free() {
6309 let chanmon_cfgs = create_chanmon_cfgs(2);
6310 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6311 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6312 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6313 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6314 let logger = test_utils::TestLogger::new();
6316 // First nodes[0] generates an update_fee, setting the channel's
6317 // pending_update_fee.
6319 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
6320 *feerate_lock += 20;
6322 nodes[0].node.timer_tick_occurred();
6323 check_added_monitors!(nodes[0], 1);
6325 let events = nodes[0].node.get_and_clear_pending_msg_events();
6326 assert_eq!(events.len(), 1);
6327 let (update_msg, commitment_signed) = match events[0] {
6328 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
6329 (update_fee.as_ref(), commitment_signed)
6331 _ => panic!("Unexpected event"),
6334 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
6336 let mut chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6337 let channel_reserve = chan_stat.channel_reserve_msat;
6338 let feerate = get_feerate!(nodes[0], chan.2);
6340 // 2* and +1 HTLCs on the commit tx fee calculation for the fee spike reserve.
6341 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6342 let max_can_send = 5000000 - channel_reserve - 2*commit_tx_fee_msat(feerate, 1 + 1);
6343 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6344 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], max_can_send, TEST_FINAL_CLTV, &logger).unwrap();
6346 // Send a payment which passes reserve checks but gets stuck in the holding cell.
6347 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6348 chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6349 assert_eq!(chan_stat.holding_cell_outbound_amount_msat, max_can_send);
6351 // Flush the pending fee update.
6352 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
6353 let (as_revoke_and_ack, _) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6354 check_added_monitors!(nodes[1], 1);
6355 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_revoke_and_ack);
6356 check_added_monitors!(nodes[0], 1);
6358 // Upon receipt of the RAA, there will be an attempt to resend the holding cell
6359 // HTLC, but now that the fee has been raised the payment will now fail, causing
6360 // us to surface its failure to the user.
6361 chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6362 assert_eq!(chan_stat.holding_cell_outbound_amount_msat, 0);
6363 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);
6364 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 {}",
6365 hex::encode(our_payment_hash.0), chan_stat.channel_reserve_msat, hex::encode(chan.2));
6366 nodes[0].logger.assert_log("lightning::ln::channel".to_string(), failure_log.to_string(), 1);
6368 // Check that the payment failed to be sent out.
6369 let events = nodes[0].node.get_and_clear_pending_events();
6370 assert_eq!(events.len(), 1);
6372 &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, ref error_code, ref error_data } => {
6373 assert_eq!(our_payment_hash.clone(), *payment_hash);
6374 assert_eq!(*rejected_by_dest, false);
6375 assert_eq!(*error_code, None);
6376 assert_eq!(*error_data, None);
6378 _ => panic!("Unexpected event"),
6382 // Test that if multiple HTLCs are released from the holding cell and one is
6383 // valid but the other is no longer valid upon release, the valid HTLC can be
6384 // successfully completed while the other one fails as expected.
6386 fn test_free_and_fail_holding_cell_htlcs() {
6387 let chanmon_cfgs = create_chanmon_cfgs(2);
6388 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6389 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6390 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6391 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6392 let logger = test_utils::TestLogger::new();
6394 // First nodes[0] generates an update_fee, setting the channel's
6395 // pending_update_fee.
6397 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
6398 *feerate_lock += 200;
6400 nodes[0].node.timer_tick_occurred();
6401 check_added_monitors!(nodes[0], 1);
6403 let events = nodes[0].node.get_and_clear_pending_msg_events();
6404 assert_eq!(events.len(), 1);
6405 let (update_msg, commitment_signed) = match events[0] {
6406 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
6407 (update_fee.as_ref(), commitment_signed)
6409 _ => panic!("Unexpected event"),
6412 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
6414 let mut chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6415 let channel_reserve = chan_stat.channel_reserve_msat;
6416 let feerate = get_feerate!(nodes[0], chan.2);
6418 // 2* and +1 HTLCs on the commit tx fee calculation for the fee spike reserve.
6419 let (payment_preimage_1, payment_hash_1, payment_secret_1) = get_payment_preimage_hash!(nodes[1]);
6421 let (_, payment_hash_2, payment_secret_2) = get_payment_preimage_hash!(nodes[1]);
6422 let amt_2 = 5000000 - channel_reserve - 2*commit_tx_fee_msat(feerate, 2 + 1) - amt_1;
6423 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6424 let route_1 = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], amt_1, TEST_FINAL_CLTV, &logger).unwrap();
6425 let route_2 = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], amt_2, TEST_FINAL_CLTV, &logger).unwrap();
6427 // Send 2 payments which pass reserve checks but get stuck in the holding cell.
6428 nodes[0].node.send_payment(&route_1, payment_hash_1, &Some(payment_secret_1)).unwrap();
6429 chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6430 assert_eq!(chan_stat.holding_cell_outbound_amount_msat, amt_1);
6431 nodes[0].node.send_payment(&route_2, payment_hash_2, &Some(payment_secret_2)).unwrap();
6432 chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6433 assert_eq!(chan_stat.holding_cell_outbound_amount_msat, amt_1 + amt_2);
6435 // Flush the pending fee update.
6436 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
6437 let (revoke_and_ack, commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6438 check_added_monitors!(nodes[1], 1);
6439 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_and_ack);
6440 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
6441 check_added_monitors!(nodes[0], 2);
6443 // Upon receipt of the RAA, there will be an attempt to resend the holding cell HTLCs,
6444 // but now that the fee has been raised the second payment will now fail, causing us
6445 // to surface its failure to the user. The first payment should succeed.
6446 chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6447 assert_eq!(chan_stat.holding_cell_outbound_amount_msat, 0);
6448 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);
6449 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 {}",
6450 hex::encode(payment_hash_2.0), chan_stat.channel_reserve_msat, hex::encode(chan.2));
6451 nodes[0].logger.assert_log("lightning::ln::channel".to_string(), failure_log.to_string(), 1);
6453 // Check that the second payment failed to be sent out.
6454 let events = nodes[0].node.get_and_clear_pending_events();
6455 assert_eq!(events.len(), 1);
6457 &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, ref error_code, ref error_data } => {
6458 assert_eq!(payment_hash_2.clone(), *payment_hash);
6459 assert_eq!(*rejected_by_dest, false);
6460 assert_eq!(*error_code, None);
6461 assert_eq!(*error_data, None);
6463 _ => panic!("Unexpected event"),
6466 // Complete the first payment and the RAA from the fee update.
6467 let (payment_event, send_raa_event) = {
6468 let mut msgs = nodes[0].node.get_and_clear_pending_msg_events();
6469 assert_eq!(msgs.len(), 2);
6470 (SendEvent::from_event(msgs.remove(0)), msgs.remove(0))
6472 let raa = match send_raa_event {
6473 MessageSendEvent::SendRevokeAndACK { msg, .. } => msg,
6474 _ => panic!("Unexpected event"),
6476 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &raa);
6477 check_added_monitors!(nodes[1], 1);
6478 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6479 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6480 let events = nodes[1].node.get_and_clear_pending_events();
6481 assert_eq!(events.len(), 1);
6483 Event::PendingHTLCsForwardable { .. } => {},
6484 _ => panic!("Unexpected event"),
6486 nodes[1].node.process_pending_htlc_forwards();
6487 let events = nodes[1].node.get_and_clear_pending_events();
6488 assert_eq!(events.len(), 1);
6490 Event::PaymentReceived { .. } => {},
6491 _ => panic!("Unexpected event"),
6493 nodes[1].node.claim_funds(payment_preimage_1);
6494 check_added_monitors!(nodes[1], 1);
6495 let update_msgs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6496 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_msgs.update_fulfill_htlcs[0]);
6497 commitment_signed_dance!(nodes[0], nodes[1], update_msgs.commitment_signed, false, true);
6498 let events = nodes[0].node.get_and_clear_pending_events();
6499 assert_eq!(events.len(), 1);
6501 Event::PaymentSent { ref payment_preimage } => {
6502 assert_eq!(*payment_preimage, payment_preimage_1);
6504 _ => panic!("Unexpected event"),
6508 // Test that if we fail to forward an HTLC that is being freed from the holding cell that the
6509 // HTLC is failed backwards. We trigger this failure to forward the freed HTLC by increasing
6510 // our fee while the HTLC is in the holding cell such that the HTLC is no longer affordable
6513 fn test_fail_holding_cell_htlc_upon_free_multihop() {
6514 let chanmon_cfgs = create_chanmon_cfgs(3);
6515 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
6516 // When this test was written, the default base fee floated based on the HTLC count.
6517 // It is now fixed, so we simply set the fee to the expected value here.
6518 let mut config = test_default_channel_config();
6519 config.channel_options.forwarding_fee_base_msat = 196;
6520 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[Some(config.clone()), Some(config.clone()), Some(config.clone())]);
6521 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
6522 let chan_0_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6523 let chan_1_2 = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6524 let logger = test_utils::TestLogger::new();
6526 // First nodes[1] generates an update_fee, setting the channel's
6527 // pending_update_fee.
6529 let mut feerate_lock = chanmon_cfgs[1].fee_estimator.sat_per_kw.lock().unwrap();
6530 *feerate_lock += 20;
6532 nodes[1].node.timer_tick_occurred();
6533 check_added_monitors!(nodes[1], 1);
6535 let events = nodes[1].node.get_and_clear_pending_msg_events();
6536 assert_eq!(events.len(), 1);
6537 let (update_msg, commitment_signed) = match events[0] {
6538 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
6539 (update_fee.as_ref(), commitment_signed)
6541 _ => panic!("Unexpected event"),
6544 nodes[2].node.handle_update_fee(&nodes[1].node.get_our_node_id(), update_msg.unwrap());
6546 let mut chan_stat = get_channel_value_stat!(nodes[0], chan_0_1.2);
6547 let channel_reserve = chan_stat.channel_reserve_msat;
6548 let feerate = get_feerate!(nodes[0], chan_0_1.2);
6550 // Send a payment which passes reserve checks but gets stuck in the holding cell.
6552 let total_routing_fee_msat = (nodes.len() - 2) as u64 * feemsat;
6553 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[2]);
6554 let max_can_send = 5000000 - channel_reserve - 2*commit_tx_fee_msat(feerate, 1 + 1) - total_routing_fee_msat;
6555 let payment_event = {
6556 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6557 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[2].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], max_can_send, TEST_FINAL_CLTV, &logger).unwrap();
6558 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6559 check_added_monitors!(nodes[0], 1);
6561 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
6562 assert_eq!(events.len(), 1);
6564 SendEvent::from_event(events.remove(0))
6566 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6567 check_added_monitors!(nodes[1], 0);
6568 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6569 expect_pending_htlcs_forwardable!(nodes[1]);
6571 chan_stat = get_channel_value_stat!(nodes[1], chan_1_2.2);
6572 assert_eq!(chan_stat.holding_cell_outbound_amount_msat, max_can_send);
6574 // Flush the pending fee update.
6575 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), commitment_signed);
6576 let (raa, commitment_signed) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
6577 check_added_monitors!(nodes[2], 1);
6578 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &raa);
6579 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &commitment_signed);
6580 check_added_monitors!(nodes[1], 2);
6582 // A final RAA message is generated to finalize the fee update.
6583 let events = nodes[1].node.get_and_clear_pending_msg_events();
6584 assert_eq!(events.len(), 1);
6586 let raa_msg = match &events[0] {
6587 &MessageSendEvent::SendRevokeAndACK { ref msg, .. } => {
6590 _ => panic!("Unexpected event"),
6593 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &raa_msg);
6594 check_added_monitors!(nodes[2], 1);
6595 assert!(nodes[2].node.get_and_clear_pending_msg_events().is_empty());
6597 // nodes[1]'s ChannelManager will now signal that we have HTLC forwards to process.
6598 let process_htlc_forwards_event = nodes[1].node.get_and_clear_pending_events();
6599 assert_eq!(process_htlc_forwards_event.len(), 1);
6600 match &process_htlc_forwards_event[0] {
6601 &Event::PendingHTLCsForwardable { .. } => {},
6602 _ => panic!("Unexpected event"),
6605 // In response, we call ChannelManager's process_pending_htlc_forwards
6606 nodes[1].node.process_pending_htlc_forwards();
6607 check_added_monitors!(nodes[1], 1);
6609 // This causes the HTLC to be failed backwards.
6610 let fail_event = nodes[1].node.get_and_clear_pending_msg_events();
6611 assert_eq!(fail_event.len(), 1);
6612 let (fail_msg, commitment_signed) = match &fail_event[0] {
6613 &MessageSendEvent::UpdateHTLCs { ref updates, .. } => {
6614 assert_eq!(updates.update_add_htlcs.len(), 0);
6615 assert_eq!(updates.update_fulfill_htlcs.len(), 0);
6616 assert_eq!(updates.update_fail_malformed_htlcs.len(), 0);
6617 assert_eq!(updates.update_fail_htlcs.len(), 1);
6618 (updates.update_fail_htlcs[0].clone(), updates.commitment_signed.clone())
6620 _ => panic!("Unexpected event"),
6623 // Pass the failure messages back to nodes[0].
6624 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
6625 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
6627 // Complete the HTLC failure+removal process.
6628 let (raa, commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6629 check_added_monitors!(nodes[0], 1);
6630 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &raa);
6631 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commitment_signed);
6632 check_added_monitors!(nodes[1], 2);
6633 let final_raa_event = nodes[1].node.get_and_clear_pending_msg_events();
6634 assert_eq!(final_raa_event.len(), 1);
6635 let raa = match &final_raa_event[0] {
6636 &MessageSendEvent::SendRevokeAndACK { ref msg, .. } => msg.clone(),
6637 _ => panic!("Unexpected event"),
6639 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &raa);
6640 expect_payment_failure_chan_update!(nodes[0], chan_1_2.0.contents.short_channel_id, false);
6641 expect_payment_failed!(nodes[0], our_payment_hash, false);
6642 check_added_monitors!(nodes[0], 1);
6645 // BOLT 2 Requirements for the Sender when constructing and sending an update_add_htlc message.
6646 // 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.
6647 //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.
6650 fn test_update_add_htlc_bolt2_sender_value_below_minimum_msat() {
6651 //BOLT2 Requirement: MUST NOT offer amount_msat below the receiving node's htlc_minimum_msat (same validation check catches both of these)
6652 let chanmon_cfgs = create_chanmon_cfgs(2);
6653 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6654 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6655 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6656 let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6658 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6659 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6660 let logger = test_utils::TestLogger::new();
6661 let mut route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
6662 route.paths[0][0].fee_msat = 100;
6664 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
6665 assert!(regex::Regex::new(r"Cannot send less than their minimum HTLC value \(\d+\)").unwrap().is_match(err)));
6666 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6667 nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot send less than their minimum HTLC value".to_string(), 1);
6671 fn test_update_add_htlc_bolt2_sender_zero_value_msat() {
6672 //BOLT2 Requirement: MUST offer amount_msat greater than 0.
6673 let chanmon_cfgs = create_chanmon_cfgs(2);
6674 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6675 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6676 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6677 let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6678 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6680 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6681 let logger = test_utils::TestLogger::new();
6682 let mut route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
6683 route.paths[0][0].fee_msat = 0;
6684 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
6685 assert_eq!(err, "Cannot send 0-msat HTLC"));
6687 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6688 nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot send 0-msat HTLC".to_string(), 1);
6692 fn test_update_add_htlc_bolt2_receiver_zero_value_msat() {
6693 //BOLT2 Requirement: MUST offer amount_msat greater than 0.
6694 let chanmon_cfgs = create_chanmon_cfgs(2);
6695 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6696 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6697 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6698 let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6700 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6701 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6702 let logger = test_utils::TestLogger::new();
6703 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
6704 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6705 check_added_monitors!(nodes[0], 1);
6706 let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6707 updates.update_add_htlcs[0].amount_msat = 0;
6709 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6710 nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Remote side tried to send a 0-msat HTLC".to_string(), 1);
6711 check_closed_broadcast!(nodes[1], true).unwrap();
6712 check_added_monitors!(nodes[1], 1);
6716 fn test_update_add_htlc_bolt2_sender_cltv_expiry_too_high() {
6717 //BOLT 2 Requirement: MUST set cltv_expiry less than 500000000.
6718 //It is enforced when constructing a route.
6719 let chanmon_cfgs = create_chanmon_cfgs(2);
6720 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6721 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6722 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6723 let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 0, InitFeatures::known(), InitFeatures::known());
6724 let logger = test_utils::TestLogger::new();
6726 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6728 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6729 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100000000, 500000001, &logger).unwrap();
6730 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::RouteError { ref err },
6731 assert_eq!(err, &"Channel CLTV overflowed?"));
6735 fn test_update_add_htlc_bolt2_sender_exceed_max_htlc_num_and_htlc_id_increment() {
6736 //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.
6737 //BOLT 2 Requirement: for the first HTLC it offers MUST set id to 0.
6738 //BOLT 2 Requirement: MUST increase the value of id by 1 for each successive offer.
6739 let chanmon_cfgs = create_chanmon_cfgs(2);
6740 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6741 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6742 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6743 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 0, InitFeatures::known(), InitFeatures::known());
6744 let max_accepted_htlcs = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().counterparty_max_accepted_htlcs as u64;
6746 let logger = test_utils::TestLogger::new();
6747 for i in 0..max_accepted_htlcs {
6748 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6749 let payment_event = {
6750 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6751 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
6752 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6753 check_added_monitors!(nodes[0], 1);
6755 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
6756 assert_eq!(events.len(), 1);
6757 if let MessageSendEvent::UpdateHTLCs { node_id: _, updates: msgs::CommitmentUpdate{ update_add_htlcs: ref htlcs, .. }, } = events[0] {
6758 assert_eq!(htlcs[0].htlc_id, i);
6762 SendEvent::from_event(events.remove(0))
6764 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6765 check_added_monitors!(nodes[1], 0);
6766 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6768 expect_pending_htlcs_forwardable!(nodes[1]);
6769 expect_payment_received!(nodes[1], our_payment_hash, our_payment_secret, 100000);
6771 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6772 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6773 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
6774 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
6775 assert!(regex::Regex::new(r"Cannot push more than their max accepted HTLCs \(\d+\)").unwrap().is_match(err)));
6777 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6778 nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot push more than their max accepted HTLCs".to_string(), 1);
6782 fn test_update_add_htlc_bolt2_sender_exceed_max_htlc_value_in_flight() {
6783 //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.
6784 let chanmon_cfgs = create_chanmon_cfgs(2);
6785 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6786 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6787 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6788 let channel_value = 100000;
6789 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, channel_value, 0, InitFeatures::known(), InitFeatures::known());
6790 let max_in_flight = get_channel_value_stat!(nodes[0], chan.2).counterparty_max_htlc_value_in_flight_msat;
6792 send_payment(&nodes[0], &vec!(&nodes[1])[..], max_in_flight);
6794 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6795 // Manually create a route over our max in flight (which our router normally automatically
6797 let route = Route { paths: vec![vec![RouteHop {
6798 pubkey: nodes[1].node.get_our_node_id(), node_features: NodeFeatures::known(), channel_features: ChannelFeatures::known(),
6799 short_channel_id: nodes[1].node.list_usable_channels()[0].short_channel_id.unwrap(),
6800 fee_msat: max_in_flight + 1, cltv_expiry_delta: TEST_FINAL_CLTV
6802 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
6803 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)));
6805 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6806 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);
6808 send_payment(&nodes[0], &[&nodes[1]], max_in_flight);
6811 // BOLT 2 Requirements for the Receiver when handling an update_add_htlc message.
6813 fn test_update_add_htlc_bolt2_receiver_check_amount_received_more_than_min() {
6814 //BOLT2 Requirement: receiving an amount_msat equal to 0, OR less than its own htlc_minimum_msat -> SHOULD fail the channel.
6815 let chanmon_cfgs = create_chanmon_cfgs(2);
6816 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6817 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6818 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6819 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6820 let htlc_minimum_msat: u64;
6822 let chan_lock = nodes[0].node.channel_state.lock().unwrap();
6823 let channel = chan_lock.by_id.get(&chan.2).unwrap();
6824 htlc_minimum_msat = channel.get_holder_htlc_minimum_msat();
6827 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6828 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6829 let logger = test_utils::TestLogger::new();
6830 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], htlc_minimum_msat, TEST_FINAL_CLTV, &logger).unwrap();
6831 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6832 check_added_monitors!(nodes[0], 1);
6833 let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6834 updates.update_add_htlcs[0].amount_msat = htlc_minimum_msat-1;
6835 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6836 assert!(nodes[1].node.list_channels().is_empty());
6837 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6838 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()));
6839 check_added_monitors!(nodes[1], 1);
6843 fn test_update_add_htlc_bolt2_receiver_sender_can_afford_amount_sent() {
6844 //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
6845 let chanmon_cfgs = create_chanmon_cfgs(2);
6846 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6847 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6848 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6849 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6850 let logger = test_utils::TestLogger::new();
6852 let chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6853 let channel_reserve = chan_stat.channel_reserve_msat;
6854 let feerate = get_feerate!(nodes[0], chan.2);
6855 // The 2* and +1 are for the fee spike reserve.
6856 let commit_tx_fee_outbound = 2 * commit_tx_fee_msat(feerate, 1 + 1);
6858 let max_can_send = 5000000 - channel_reserve - commit_tx_fee_outbound;
6859 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6860 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6861 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], max_can_send, TEST_FINAL_CLTV, &logger).unwrap();
6862 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6863 check_added_monitors!(nodes[0], 1);
6864 let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6866 // Even though channel-initiator senders are required to respect the fee_spike_reserve,
6867 // at this time channel-initiatee receivers are not required to enforce that senders
6868 // respect the fee_spike_reserve.
6869 updates.update_add_htlcs[0].amount_msat = max_can_send + commit_tx_fee_outbound + 1;
6870 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6872 assert!(nodes[1].node.list_channels().is_empty());
6873 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6874 assert_eq!(err_msg.data, "Remote HTLC add would put them under remote reserve value");
6875 check_added_monitors!(nodes[1], 1);
6879 fn test_update_add_htlc_bolt2_receiver_check_max_htlc_limit() {
6880 //BOLT 2 Requirement: if a sending node adds more than its max_accepted_htlcs HTLCs to its local commitment transaction: SHOULD fail the channel
6881 //BOLT 2 Requirement: MUST allow multiple HTLCs with the same payment_hash.
6882 let chanmon_cfgs = create_chanmon_cfgs(2);
6883 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6884 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6885 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6886 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6887 let logger = test_utils::TestLogger::new();
6889 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6890 let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
6892 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6893 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 3999999, TEST_FINAL_CLTV, &logger).unwrap();
6895 let cur_height = nodes[0].node.best_block.read().unwrap().height() + 1;
6896 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::signing_only(), &route.paths[0], &session_priv).unwrap();
6897 let (onion_payloads, _htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 3999999, &Some(our_payment_secret), cur_height, &None).unwrap();
6898 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &our_payment_hash);
6900 let mut msg = msgs::UpdateAddHTLC {
6904 payment_hash: our_payment_hash,
6905 cltv_expiry: htlc_cltv,
6906 onion_routing_packet: onion_packet.clone(),
6909 for i in 0..super::channel::OUR_MAX_HTLCS {
6910 msg.htlc_id = i as u64;
6911 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
6913 msg.htlc_id = (super::channel::OUR_MAX_HTLCS) as u64;
6914 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
6916 assert!(nodes[1].node.list_channels().is_empty());
6917 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6918 assert!(regex::Regex::new(r"Remote tried to push more than our max accepted HTLCs \(\d+\)").unwrap().is_match(err_msg.data.as_str()));
6919 check_added_monitors!(nodes[1], 1);
6923 fn test_update_add_htlc_bolt2_receiver_check_max_in_flight_msat() {
6924 //OR adds more than its max_htlc_value_in_flight_msat worth of offered HTLCs to its local commitment transaction: SHOULD fail the channel
6925 let chanmon_cfgs = create_chanmon_cfgs(2);
6926 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6927 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6928 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6929 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
6930 let logger = test_utils::TestLogger::new();
6932 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6933 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6934 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 1000000, TEST_FINAL_CLTV, &logger).unwrap();
6935 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6936 check_added_monitors!(nodes[0], 1);
6937 let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6938 updates.update_add_htlcs[0].amount_msat = get_channel_value_stat!(nodes[1], chan.2).counterparty_max_htlc_value_in_flight_msat + 1;
6939 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6941 assert!(nodes[1].node.list_channels().is_empty());
6942 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6943 assert!(regex::Regex::new("Remote HTLC add would put them over our max HTLC value").unwrap().is_match(err_msg.data.as_str()));
6944 check_added_monitors!(nodes[1], 1);
6948 fn test_update_add_htlc_bolt2_receiver_check_cltv_expiry() {
6949 //BOLT2 Requirement: if sending node sets cltv_expiry to greater or equal to 500000000: SHOULD fail the channel.
6950 let chanmon_cfgs = create_chanmon_cfgs(2);
6951 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6952 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6953 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6954 let logger = test_utils::TestLogger::new();
6956 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6957 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6958 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6959 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 1000000, TEST_FINAL_CLTV, &logger).unwrap();
6960 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6961 check_added_monitors!(nodes[0], 1);
6962 let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6963 updates.update_add_htlcs[0].cltv_expiry = 500000000;
6964 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6966 assert!(nodes[1].node.list_channels().is_empty());
6967 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6968 assert_eq!(err_msg.data,"Remote provided CLTV expiry in seconds instead of block height");
6969 check_added_monitors!(nodes[1], 1);
6973 fn test_update_add_htlc_bolt2_receiver_check_repeated_id_ignore() {
6974 //BOLT 2 requirement: if the sender did not previously acknowledge the commitment of that HTLC: MUST ignore a repeated id value after a reconnection.
6975 // We test this by first testing that that repeated HTLCs pass commitment signature checks
6976 // after disconnect and that non-sequential htlc_ids result in a channel failure.
6977 let chanmon_cfgs = create_chanmon_cfgs(2);
6978 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6979 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6980 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6981 let logger = test_utils::TestLogger::new();
6983 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6984 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6985 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6986 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 1000000, TEST_FINAL_CLTV, &logger).unwrap();
6987 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6988 check_added_monitors!(nodes[0], 1);
6989 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6990 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6992 //Disconnect and Reconnect
6993 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
6994 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
6995 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
6996 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
6997 assert_eq!(reestablish_1.len(), 1);
6998 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
6999 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
7000 assert_eq!(reestablish_2.len(), 1);
7001 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
7002 handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
7003 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
7004 handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
7007 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
7008 assert_eq!(updates.commitment_signed.htlc_signatures.len(), 1);
7009 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &updates.commitment_signed);
7010 check_added_monitors!(nodes[1], 1);
7011 let _bs_responses = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
7013 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
7015 assert!(nodes[1].node.list_channels().is_empty());
7016 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
7017 assert!(regex::Regex::new(r"Remote skipped HTLC ID \(skipped ID: \d+\)").unwrap().is_match(err_msg.data.as_str()));
7018 check_added_monitors!(nodes[1], 1);
7022 fn test_update_fulfill_htlc_bolt2_update_fulfill_htlc_before_commitment() {
7023 //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.
7025 let chanmon_cfgs = create_chanmon_cfgs(2);
7026 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7027 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7028 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7029 let logger = test_utils::TestLogger::new();
7030 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7031 let (our_payment_preimage, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
7032 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
7033 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 1000000, TEST_FINAL_CLTV, &logger).unwrap();
7034 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
7036 check_added_monitors!(nodes[0], 1);
7037 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
7038 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
7040 let update_msg = msgs::UpdateFulfillHTLC{
7043 payment_preimage: our_payment_preimage,
7046 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
7048 assert!(nodes[0].node.list_channels().is_empty());
7049 let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
7050 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()));
7051 check_added_monitors!(nodes[0], 1);
7055 fn test_update_fulfill_htlc_bolt2_update_fail_htlc_before_commitment() {
7056 //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.
7058 let chanmon_cfgs = create_chanmon_cfgs(2);
7059 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7060 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7061 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7062 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7063 let logger = test_utils::TestLogger::new();
7065 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
7066 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
7067 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 1000000, TEST_FINAL_CLTV, &logger).unwrap();
7068 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
7069 check_added_monitors!(nodes[0], 1);
7070 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
7071 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
7073 let update_msg = msgs::UpdateFailHTLC{
7076 reason: msgs::OnionErrorPacket { data: Vec::new()},
7079 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
7081 assert!(nodes[0].node.list_channels().is_empty());
7082 let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
7083 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()));
7084 check_added_monitors!(nodes[0], 1);
7088 fn test_update_fulfill_htlc_bolt2_update_fail_malformed_htlc_before_commitment() {
7089 //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.
7091 let chanmon_cfgs = create_chanmon_cfgs(2);
7092 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7093 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7094 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7095 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7096 let logger = test_utils::TestLogger::new();
7098 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
7099 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
7100 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 1000000, TEST_FINAL_CLTV, &logger).unwrap();
7101 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
7102 check_added_monitors!(nodes[0], 1);
7103 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
7104 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
7105 let update_msg = msgs::UpdateFailMalformedHTLC{
7108 sha256_of_onion: [1; 32],
7109 failure_code: 0x8000,
7112 nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
7114 assert!(nodes[0].node.list_channels().is_empty());
7115 let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
7116 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()));
7117 check_added_monitors!(nodes[0], 1);
7121 fn test_update_fulfill_htlc_bolt2_incorrect_htlc_id() {
7122 //BOLT 2 Requirement: A receiving node: if the id does not correspond to an HTLC in its current commitment transaction MUST fail the channel.
7124 let chanmon_cfgs = create_chanmon_cfgs(2);
7125 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7126 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7127 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7128 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7130 let our_payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 100000).0;
7132 nodes[1].node.claim_funds(our_payment_preimage);
7133 check_added_monitors!(nodes[1], 1);
7135 let events = nodes[1].node.get_and_clear_pending_msg_events();
7136 assert_eq!(events.len(), 1);
7137 let mut update_fulfill_msg: msgs::UpdateFulfillHTLC = {
7139 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, .. } } => {
7140 assert!(update_add_htlcs.is_empty());
7141 assert_eq!(update_fulfill_htlcs.len(), 1);
7142 assert!(update_fail_htlcs.is_empty());
7143 assert!(update_fail_malformed_htlcs.is_empty());
7144 assert!(update_fee.is_none());
7145 update_fulfill_htlcs[0].clone()
7147 _ => panic!("Unexpected event"),
7151 update_fulfill_msg.htlc_id = 1;
7153 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_msg);
7155 assert!(nodes[0].node.list_channels().is_empty());
7156 let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
7157 assert_eq!(err_msg.data, "Remote tried to fulfill/fail an HTLC we couldn't find");
7158 check_added_monitors!(nodes[0], 1);
7162 fn test_update_fulfill_htlc_bolt2_wrong_preimage() {
7163 //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.
7165 let chanmon_cfgs = create_chanmon_cfgs(2);
7166 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7167 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7168 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7169 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7171 let our_payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 100000).0;
7173 nodes[1].node.claim_funds(our_payment_preimage);
7174 check_added_monitors!(nodes[1], 1);
7176 let events = nodes[1].node.get_and_clear_pending_msg_events();
7177 assert_eq!(events.len(), 1);
7178 let mut update_fulfill_msg: msgs::UpdateFulfillHTLC = {
7180 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, .. } } => {
7181 assert!(update_add_htlcs.is_empty());
7182 assert_eq!(update_fulfill_htlcs.len(), 1);
7183 assert!(update_fail_htlcs.is_empty());
7184 assert!(update_fail_malformed_htlcs.is_empty());
7185 assert!(update_fee.is_none());
7186 update_fulfill_htlcs[0].clone()
7188 _ => panic!("Unexpected event"),
7192 update_fulfill_msg.payment_preimage = PaymentPreimage([1; 32]);
7194 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_msg);
7196 assert!(nodes[0].node.list_channels().is_empty());
7197 let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
7198 assert!(regex::Regex::new(r"Remote tried to fulfill HTLC \(\d+\) with an incorrect preimage").unwrap().is_match(err_msg.data.as_str()));
7199 check_added_monitors!(nodes[0], 1);
7203 fn test_update_fulfill_htlc_bolt2_missing_badonion_bit_for_malformed_htlc_message() {
7204 //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.
7206 let chanmon_cfgs = create_chanmon_cfgs(2);
7207 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7208 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7209 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7210 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7211 let logger = test_utils::TestLogger::new();
7213 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
7214 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
7215 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 1000000, TEST_FINAL_CLTV, &logger).unwrap();
7216 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
7217 check_added_monitors!(nodes[0], 1);
7219 let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
7220 updates.update_add_htlcs[0].onion_routing_packet.version = 1; //Produce a malformed HTLC message
7222 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
7223 check_added_monitors!(nodes[1], 0);
7224 commitment_signed_dance!(nodes[1], nodes[0], updates.commitment_signed, false, true);
7226 let events = nodes[1].node.get_and_clear_pending_msg_events();
7228 let mut update_msg: msgs::UpdateFailMalformedHTLC = {
7230 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, .. } } => {
7231 assert!(update_add_htlcs.is_empty());
7232 assert!(update_fulfill_htlcs.is_empty());
7233 assert!(update_fail_htlcs.is_empty());
7234 assert_eq!(update_fail_malformed_htlcs.len(), 1);
7235 assert!(update_fee.is_none());
7236 update_fail_malformed_htlcs[0].clone()
7238 _ => panic!("Unexpected event"),
7241 update_msg.failure_code &= !0x8000;
7242 nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
7244 assert!(nodes[0].node.list_channels().is_empty());
7245 let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
7246 assert_eq!(err_msg.data, "Got update_fail_malformed_htlc with BADONION not set");
7247 check_added_monitors!(nodes[0], 1);
7251 fn test_update_fulfill_htlc_bolt2_after_malformed_htlc_message_must_forward_update_fail_htlc() {
7252 //BOLT 2 Requirement: a receiving node which has an outgoing HTLC canceled by update_fail_malformed_htlc:
7253 // * 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.
7255 let chanmon_cfgs = create_chanmon_cfgs(3);
7256 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7257 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
7258 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7259 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7260 create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7261 let logger = test_utils::TestLogger::new();
7263 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[2]);
7266 let mut payment_event = {
7267 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
7268 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[2].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
7269 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
7270 check_added_monitors!(nodes[0], 1);
7271 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
7272 assert_eq!(events.len(), 1);
7273 SendEvent::from_event(events.remove(0))
7275 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
7276 check_added_monitors!(nodes[1], 0);
7277 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
7278 expect_pending_htlcs_forwardable!(nodes[1]);
7279 let mut events_2 = nodes[1].node.get_and_clear_pending_msg_events();
7280 assert_eq!(events_2.len(), 1);
7281 check_added_monitors!(nodes[1], 1);
7282 payment_event = SendEvent::from_event(events_2.remove(0));
7283 assert_eq!(payment_event.msgs.len(), 1);
7286 payment_event.msgs[0].onion_routing_packet.version = 1; //Produce a malformed HTLC message
7287 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
7288 check_added_monitors!(nodes[2], 0);
7289 commitment_signed_dance!(nodes[2], nodes[1], payment_event.commitment_msg, false, true);
7291 let events_3 = nodes[2].node.get_and_clear_pending_msg_events();
7292 assert_eq!(events_3.len(), 1);
7293 let update_msg : (msgs::UpdateFailMalformedHTLC, msgs::CommitmentSigned) = {
7295 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 } } => {
7296 assert!(update_add_htlcs.is_empty());
7297 assert!(update_fulfill_htlcs.is_empty());
7298 assert!(update_fail_htlcs.is_empty());
7299 assert_eq!(update_fail_malformed_htlcs.len(), 1);
7300 assert!(update_fee.is_none());
7301 (update_fail_malformed_htlcs[0].clone(), commitment_signed.clone())
7303 _ => panic!("Unexpected event"),
7307 nodes[1].node.handle_update_fail_malformed_htlc(&nodes[2].node.get_our_node_id(), &update_msg.0);
7309 check_added_monitors!(nodes[1], 0);
7310 commitment_signed_dance!(nodes[1], nodes[2], update_msg.1, false, true);
7311 expect_pending_htlcs_forwardable!(nodes[1]);
7312 let events_4 = nodes[1].node.get_and_clear_pending_msg_events();
7313 assert_eq!(events_4.len(), 1);
7315 //Confirm that handlinge the update_malformed_htlc message produces an update_fail_htlc message to be forwarded back along the route
7317 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, .. } } => {
7318 assert!(update_add_htlcs.is_empty());
7319 assert!(update_fulfill_htlcs.is_empty());
7320 assert_eq!(update_fail_htlcs.len(), 1);
7321 assert!(update_fail_malformed_htlcs.is_empty());
7322 assert!(update_fee.is_none());
7324 _ => panic!("Unexpected event"),
7327 check_added_monitors!(nodes[1], 1);
7330 fn do_test_failure_delay_dust_htlc_local_commitment(announce_latest: bool) {
7331 // Dust-HTLC failure updates must be delayed until failure-trigger tx (in this case local commitment) reach ANTI_REORG_DELAY
7332 // 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
7333 // HTLC could have been removed from lastest local commitment tx but still valid until we get remote RAA
7335 let mut chanmon_cfgs = create_chanmon_cfgs(2);
7336 chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
7337 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7338 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7339 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7340 let chan =create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7342 let bs_dust_limit = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().holder_dust_limit_satoshis;
7344 // We route 2 dust-HTLCs between A and B
7345 let (_, payment_hash_1, _) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
7346 let (_, payment_hash_2, _) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
7347 route_payment(&nodes[0], &[&nodes[1]], 1000000);
7349 // Cache one local commitment tx as previous
7350 let as_prev_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
7352 // Fail one HTLC to prune it in the will-be-latest-local commitment tx
7353 assert!(nodes[1].node.fail_htlc_backwards(&payment_hash_2));
7354 check_added_monitors!(nodes[1], 0);
7355 expect_pending_htlcs_forwardable!(nodes[1]);
7356 check_added_monitors!(nodes[1], 1);
7358 let remove = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
7359 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &remove.update_fail_htlcs[0]);
7360 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &remove.commitment_signed);
7361 check_added_monitors!(nodes[0], 1);
7363 // Cache one local commitment tx as lastest
7364 let as_last_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
7366 let events = nodes[0].node.get_and_clear_pending_msg_events();
7368 MessageSendEvent::SendRevokeAndACK { node_id, .. } => {
7369 assert_eq!(node_id, nodes[1].node.get_our_node_id());
7371 _ => panic!("Unexpected event"),
7374 MessageSendEvent::UpdateHTLCs { node_id, .. } => {
7375 assert_eq!(node_id, nodes[1].node.get_our_node_id());
7377 _ => panic!("Unexpected event"),
7380 assert_ne!(as_prev_commitment_tx, as_last_commitment_tx);
7381 // Fail the 2 dust-HTLCs, move their failure in maturation buffer (htlc_updated_waiting_threshold_conf)
7382 if announce_latest {
7383 mine_transaction(&nodes[0], &as_last_commitment_tx[0]);
7385 mine_transaction(&nodes[0], &as_prev_commitment_tx[0]);
7388 check_closed_broadcast!(nodes[0], true);
7389 check_added_monitors!(nodes[0], 1);
7391 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7392 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7393 let events = nodes[0].node.get_and_clear_pending_events();
7394 // Only 2 PaymentFailed events should show up, over-dust HTLC has to be failed by timeout tx
7395 assert_eq!(events.len(), 2);
7396 let mut first_failed = false;
7397 for event in events {
7399 Event::PaymentFailed { payment_hash, .. } => {
7400 if payment_hash == payment_hash_1 {
7401 assert!(!first_failed);
7402 first_failed = true;
7404 assert_eq!(payment_hash, payment_hash_2);
7407 _ => panic!("Unexpected event"),
7413 fn test_failure_delay_dust_htlc_local_commitment() {
7414 do_test_failure_delay_dust_htlc_local_commitment(true);
7415 do_test_failure_delay_dust_htlc_local_commitment(false);
7418 fn do_test_sweep_outbound_htlc_failure_update(revoked: bool, local: bool) {
7419 // Outbound HTLC-failure updates must be cancelled if we get a reorg before we reach ANTI_REORG_DELAY.
7420 // Broadcast of revoked remote commitment tx, trigger failure-update of dust/non-dust HTLCs
7421 // Broadcast of remote commitment tx, trigger failure-update of dust-HTLCs
7422 // Broadcast of timeout tx on remote commitment tx, trigger failure-udate of non-dust HTLCs
7423 // Broadcast of local commitment tx, trigger failure-update of dust-HTLCs
7424 // Broadcast of HTLC-timeout tx on local commitment tx, trigger failure-update of non-dust HTLCs
7426 let chanmon_cfgs = create_chanmon_cfgs(3);
7427 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7428 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
7429 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7430 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7432 let bs_dust_limit = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().holder_dust_limit_satoshis;
7434 let (_payment_preimage_1, dust_hash, _payment_secret_1) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
7435 let (_payment_preimage_2, non_dust_hash, _payment_secret_2) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
7437 let as_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
7438 let bs_commitment_tx = get_local_commitment_txn!(nodes[1], chan.2);
7440 // We revoked bs_commitment_tx
7442 let (payment_preimage_3, _, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
7443 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_3);
7446 let mut timeout_tx = Vec::new();
7448 // We fail dust-HTLC 1 by broadcast of local commitment tx
7449 mine_transaction(&nodes[0], &as_commitment_tx[0]);
7450 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7451 expect_payment_failed!(nodes[0], dust_hash, true);
7453 connect_blocks(&nodes[0], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS - ANTI_REORG_DELAY);
7454 check_closed_broadcast!(nodes[0], true);
7455 check_added_monitors!(nodes[0], 1);
7456 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7457 timeout_tx.push(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[1].clone());
7458 assert_eq!(timeout_tx[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
7459 // We fail non-dust-HTLC 2 by broadcast of local HTLC-timeout tx on local commitment tx
7460 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7461 mine_transaction(&nodes[0], &timeout_tx[0]);
7462 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7463 expect_payment_failed!(nodes[0], non_dust_hash, true);
7465 // We fail dust-HTLC 1 by broadcast of remote commitment tx. If revoked, fail also non-dust HTLC
7466 mine_transaction(&nodes[0], &bs_commitment_tx[0]);
7467 check_closed_broadcast!(nodes[0], true);
7468 check_added_monitors!(nodes[0], 1);
7469 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7470 connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
7471 timeout_tx.push(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[1].clone());
7473 expect_payment_failed!(nodes[0], dust_hash, true);
7474 assert_eq!(timeout_tx[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
7475 // We fail non-dust-HTLC 2 by broadcast of local timeout tx on remote commitment tx
7476 mine_transaction(&nodes[0], &timeout_tx[0]);
7477 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7478 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7479 expect_payment_failed!(nodes[0], non_dust_hash, true);
7481 // If revoked, both dust & non-dust HTLCs should have been failed after ANTI_REORG_DELAY confs of revoked
7483 let events = nodes[0].node.get_and_clear_pending_events();
7484 assert_eq!(events.len(), 2);
7487 Event::PaymentFailed { payment_hash, .. } => {
7488 if payment_hash == dust_hash { first = true; }
7489 else { first = false; }
7491 _ => panic!("Unexpected event"),
7494 Event::PaymentFailed { payment_hash, .. } => {
7495 if first { assert_eq!(payment_hash, non_dust_hash); }
7496 else { assert_eq!(payment_hash, dust_hash); }
7498 _ => panic!("Unexpected event"),
7505 fn test_sweep_outbound_htlc_failure_update() {
7506 do_test_sweep_outbound_htlc_failure_update(false, true);
7507 do_test_sweep_outbound_htlc_failure_update(false, false);
7508 do_test_sweep_outbound_htlc_failure_update(true, false);
7512 fn test_upfront_shutdown_script() {
7513 // BOLT 2 : Option upfront shutdown script, if peer commit its closing_script at channel opening
7514 // enforce it at shutdown message
7516 let mut config = UserConfig::default();
7517 config.channel_options.announced_channel = true;
7518 config.peer_channel_config_limits.force_announced_channel_preference = false;
7519 config.channel_options.commit_upfront_shutdown_pubkey = false;
7520 let user_cfgs = [None, Some(config), None];
7521 let chanmon_cfgs = create_chanmon_cfgs(3);
7522 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7523 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
7524 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7526 // We test that in case of peer committing upfront to a script, if it changes at closing, we refuse to sign
7527 let flags = InitFeatures::known();
7528 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 1000000, 1000000, flags.clone(), flags.clone());
7529 nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7530 let mut node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[2].node.get_our_node_id());
7531 node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
7532 // Test we enforce upfront_scriptpbukey if by providing a diffrent one at closing that we disconnect peer
7533 nodes[2].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
7534 assert!(regex::Regex::new(r"Got shutdown request with a scriptpubkey \([A-Fa-f0-9]+\) which did not match their previous scriptpubkey.").unwrap().is_match(check_closed_broadcast!(nodes[2], true).unwrap().data.as_str()));
7535 check_added_monitors!(nodes[2], 1);
7537 // We test that in case of peer committing upfront to a script, if it doesn't change at closing, we sign
7538 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 1000000, 1000000, flags.clone(), flags.clone());
7539 nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7540 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[2].node.get_our_node_id());
7541 // We test that in case of peer committing upfront to a script, if it oesn't change at closing, we sign
7542 nodes[2].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
7543 let events = nodes[2].node.get_and_clear_pending_msg_events();
7544 assert_eq!(events.len(), 1);
7546 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[0].node.get_our_node_id()) }
7547 _ => panic!("Unexpected event"),
7550 // We test that if case of peer non-signaling we don't enforce committed script at channel opening
7551 let flags_no = InitFeatures::known().clear_upfront_shutdown_script();
7552 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, flags_no, flags.clone());
7553 nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7554 let node_1_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
7555 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_1_shutdown);
7556 check_added_monitors!(nodes[1], 1);
7557 let events = nodes[1].node.get_and_clear_pending_msg_events();
7558 assert_eq!(events.len(), 1);
7560 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[0].node.get_our_node_id()) }
7561 _ => panic!("Unexpected event"),
7564 // We test that if user opt-out, we provide a zero-length script at channel opening and we are able to close
7565 // channel smoothly, opt-out is from channel initiator here
7566 let chan = create_announced_chan_between_nodes_with_value(&nodes, 1, 0, 1000000, 1000000, flags.clone(), flags.clone());
7567 nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7568 check_added_monitors!(nodes[1], 1);
7569 let node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
7570 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
7571 let events = nodes[0].node.get_and_clear_pending_msg_events();
7572 assert_eq!(events.len(), 1);
7574 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7575 _ => panic!("Unexpected event"),
7578 //// We test that if user opt-out, we provide a zero-length script at channel opening and we are able to close
7579 //// channel smoothly
7580 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, flags.clone(), flags.clone());
7581 nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7582 check_added_monitors!(nodes[1], 1);
7583 let node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
7584 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
7585 let events = nodes[0].node.get_and_clear_pending_msg_events();
7586 assert_eq!(events.len(), 2);
7588 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7589 _ => panic!("Unexpected event"),
7592 MessageSendEvent::SendClosingSigned { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7593 _ => panic!("Unexpected event"),
7598 fn test_unsupported_anysegwit_upfront_shutdown_script() {
7599 let chanmon_cfgs = create_chanmon_cfgs(2);
7600 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7601 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7602 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7604 // Use a non-v0 segwit script supported by option_shutdown_anysegwit
7605 let node_features = InitFeatures::known().clear_shutdown_anysegwit();
7606 let anysegwit_shutdown_script = Builder::new()
7608 .push_slice(&[0, 40])
7611 // Check script when handling an open_channel message
7612 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
7613 let mut open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
7614 open_channel.shutdown_scriptpubkey = Present(anysegwit_shutdown_script.clone());
7615 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), node_features.clone(), &open_channel);
7617 let events = nodes[1].node.get_and_clear_pending_msg_events();
7618 assert_eq!(events.len(), 1);
7620 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
7621 assert_eq!(node_id, nodes[0].node.get_our_node_id());
7622 assert_eq!(msg.data, "Peer is signaling upfront_shutdown but has provided an unacceptable scriptpubkey format: Script(OP_PUSHNUM_16 OP_PUSHBYTES_2 0028)");
7624 _ => panic!("Unexpected event"),
7627 // Check script when handling an accept_channel message
7628 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
7629 let open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
7630 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_channel);
7631 let mut accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
7632 accept_channel.shutdown_scriptpubkey = Present(anysegwit_shutdown_script.clone());
7633 nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), node_features, &accept_channel);
7635 let events = nodes[0].node.get_and_clear_pending_msg_events();
7636 assert_eq!(events.len(), 1);
7638 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
7639 assert_eq!(node_id, nodes[1].node.get_our_node_id());
7640 assert_eq!(msg.data, "Peer is signaling upfront_shutdown but has provided an unacceptable scriptpubkey format: Script(OP_PUSHNUM_16 OP_PUSHBYTES_2 0028)");
7642 _ => panic!("Unexpected event"),
7647 fn test_invalid_upfront_shutdown_script() {
7648 let chanmon_cfgs = create_chanmon_cfgs(2);
7649 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7650 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7651 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7653 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
7655 // Use a segwit v0 script with an unsupported witness program
7656 let mut open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
7657 open_channel.shutdown_scriptpubkey = Present(Builder::new().push_int(0)
7658 .push_slice(&[0, 0])
7660 nodes[0].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_channel);
7662 let events = nodes[0].node.get_and_clear_pending_msg_events();
7663 assert_eq!(events.len(), 1);
7665 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
7666 assert_eq!(node_id, nodes[0].node.get_our_node_id());
7667 assert_eq!(msg.data, "Peer is signaling upfront_shutdown but has provided an unacceptable scriptpubkey format: Script(OP_0 OP_PUSHBYTES_2 0000)");
7669 _ => panic!("Unexpected event"),
7674 fn test_segwit_v0_shutdown_script() {
7675 let mut config = UserConfig::default();
7676 config.channel_options.announced_channel = true;
7677 config.peer_channel_config_limits.force_announced_channel_preference = false;
7678 config.channel_options.commit_upfront_shutdown_pubkey = false;
7679 let user_cfgs = [None, Some(config), None];
7680 let chanmon_cfgs = create_chanmon_cfgs(3);
7681 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7682 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
7683 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7685 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7686 nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7687 check_added_monitors!(nodes[1], 1);
7689 // Use a segwit v0 script supported even without option_shutdown_anysegwit
7690 let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
7691 node_0_shutdown.scriptpubkey = Builder::new().push_int(0)
7692 .push_slice(&[0; 20])
7694 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
7696 let events = nodes[0].node.get_and_clear_pending_msg_events();
7697 assert_eq!(events.len(), 2);
7699 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7700 _ => panic!("Unexpected event"),
7703 MessageSendEvent::SendClosingSigned { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7704 _ => panic!("Unexpected event"),
7709 fn test_anysegwit_shutdown_script() {
7710 let mut config = UserConfig::default();
7711 config.channel_options.announced_channel = true;
7712 config.peer_channel_config_limits.force_announced_channel_preference = false;
7713 config.channel_options.commit_upfront_shutdown_pubkey = false;
7714 let user_cfgs = [None, Some(config), None];
7715 let chanmon_cfgs = create_chanmon_cfgs(3);
7716 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7717 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
7718 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7720 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7721 nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7722 check_added_monitors!(nodes[1], 1);
7724 // Use a non-v0 segwit script supported by option_shutdown_anysegwit
7725 let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
7726 node_0_shutdown.scriptpubkey = Builder::new().push_int(16)
7727 .push_slice(&[0, 0])
7729 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
7731 let events = nodes[0].node.get_and_clear_pending_msg_events();
7732 assert_eq!(events.len(), 2);
7734 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7735 _ => panic!("Unexpected event"),
7738 MessageSendEvent::SendClosingSigned { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7739 _ => panic!("Unexpected event"),
7744 fn test_unsupported_anysegwit_shutdown_script() {
7745 let mut config = UserConfig::default();
7746 config.channel_options.announced_channel = true;
7747 config.peer_channel_config_limits.force_announced_channel_preference = false;
7748 config.channel_options.commit_upfront_shutdown_pubkey = false;
7749 let user_cfgs = [None, Some(config), None];
7750 let chanmon_cfgs = create_chanmon_cfgs(3);
7751 let mut node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7752 node_cfgs[0].features = InitFeatures::known().clear_shutdown_anysegwit();
7753 node_cfgs[1].features = InitFeatures::known().clear_shutdown_anysegwit();
7754 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
7755 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7757 // Check that using an unsupported shutdown script fails and a supported one succeeds.
7758 let supported_shutdown_script = chanmon_cfgs[1].keys_manager.get_shutdown_scriptpubkey();
7759 let unsupported_shutdown_script =
7760 ShutdownScript::new_witness_program(NonZeroU8::new(16).unwrap(), &[0, 40]).unwrap();
7761 chanmon_cfgs[1].keys_manager
7762 .expect(OnGetShutdownScriptpubkey { returns: unsupported_shutdown_script.clone() })
7763 .expect(OnGetShutdownScriptpubkey { returns: supported_shutdown_script });
7765 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, node_cfgs[0].features.clone(), node_cfgs[1].features.clone());
7766 match nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()) {
7767 Err(APIError::IncompatibleShutdownScript { script }) => {
7768 assert_eq!(script.into_inner(), unsupported_shutdown_script.clone().into_inner());
7770 Err(e) => panic!("Unexpected error: {:?}", e),
7771 Ok(_) => panic!("Expected error"),
7773 nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7774 check_added_monitors!(nodes[1], 1);
7776 // Use a non-v0 segwit script unsupported without option_shutdown_anysegwit
7777 let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
7778 node_0_shutdown.scriptpubkey = unsupported_shutdown_script.into_inner();
7779 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_cfgs[1].features, &node_0_shutdown);
7781 let events = nodes[0].node.get_and_clear_pending_msg_events();
7782 assert_eq!(events.len(), 2);
7784 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
7785 assert_eq!(node_id, nodes[1].node.get_our_node_id());
7786 assert_eq!(msg.data, "Got a nonstandard scriptpubkey (60020028) from remote peer".to_owned());
7788 _ => panic!("Unexpected event"),
7790 check_added_monitors!(nodes[0], 1);
7794 fn test_invalid_shutdown_script() {
7795 let mut config = UserConfig::default();
7796 config.channel_options.announced_channel = true;
7797 config.peer_channel_config_limits.force_announced_channel_preference = false;
7798 config.channel_options.commit_upfront_shutdown_pubkey = false;
7799 let user_cfgs = [None, Some(config), None];
7800 let chanmon_cfgs = create_chanmon_cfgs(3);
7801 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7802 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
7803 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7805 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7806 nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7807 check_added_monitors!(nodes[1], 1);
7809 // Use a segwit v0 script with an unsupported witness program
7810 let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
7811 node_0_shutdown.scriptpubkey = Builder::new().push_int(0)
7812 .push_slice(&[0, 0])
7814 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
7816 let events = nodes[0].node.get_and_clear_pending_msg_events();
7817 assert_eq!(events.len(), 2);
7819 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
7820 assert_eq!(node_id, nodes[1].node.get_our_node_id());
7821 assert_eq!(msg.data, "Got a nonstandard scriptpubkey (00020000) from remote peer".to_owned())
7823 _ => panic!("Unexpected event"),
7825 check_added_monitors!(nodes[0], 1);
7829 fn test_user_configurable_csv_delay() {
7830 // We test our channel constructors yield errors when we pass them absurd csv delay
7832 let mut low_our_to_self_config = UserConfig::default();
7833 low_our_to_self_config.own_channel_config.our_to_self_delay = 6;
7834 let mut high_their_to_self_config = UserConfig::default();
7835 high_their_to_self_config.peer_channel_config_limits.their_to_self_delay = 100;
7836 let user_cfgs = [Some(high_their_to_self_config.clone()), None];
7837 let chanmon_cfgs = create_chanmon_cfgs(2);
7838 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7839 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &user_cfgs);
7840 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7842 // We test config.our_to_self > BREAKDOWN_TIMEOUT is enforced in Channel::new_outbound()
7843 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) {
7845 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())); },
7846 _ => panic!("Unexpected event"),
7848 } else { assert!(false) }
7850 // We test config.our_to_self > BREAKDOWN_TIMEOUT is enforced in Channel::new_from_req()
7851 nodes[1].node.create_channel(nodes[0].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
7852 let mut open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
7853 open_channel.to_self_delay = 200;
7854 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) {
7856 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())); },
7857 _ => panic!("Unexpected event"),
7859 } else { assert!(false); }
7861 // We test msg.to_self_delay <= config.their_to_self_delay is enforced in Chanel::accept_channel()
7862 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
7863 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()));
7864 let mut accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
7865 accept_channel.to_self_delay = 200;
7866 nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &accept_channel);
7867 if let MessageSendEvent::HandleError { ref action, .. } = nodes[0].node.get_and_clear_pending_msg_events()[0] {
7869 &ErrorAction::SendErrorMessage { ref msg } => {
7870 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()));
7872 _ => { assert!(false); }
7874 } else { assert!(false); }
7876 // We test msg.to_self_delay <= config.their_to_self_delay is enforced in Channel::new_from_req()
7877 nodes[1].node.create_channel(nodes[0].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
7878 let mut open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
7879 open_channel.to_self_delay = 200;
7880 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) {
7882 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())); },
7883 _ => panic!("Unexpected event"),
7885 } else { assert!(false); }
7889 fn test_data_loss_protect() {
7890 // We want to be sure that :
7891 // * we don't broadcast our Local Commitment Tx in case of fallen behind
7892 // (but this is not quite true - we broadcast during Drop because chanmon is out of sync with chanmgr)
7893 // * we close channel in case of detecting other being fallen behind
7894 // * we are able to claim our own outputs thanks to to_remote being static
7895 // TODO: this test is incomplete and the data_loss_protect implementation is incomplete - see issue #775
7901 let mut chanmon_cfgs = create_chanmon_cfgs(2);
7902 // We broadcast during Drop because chanmon is out of sync with chanmgr, which would cause a panic
7903 // during signing due to revoked tx
7904 chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
7905 let keys_manager = &chanmon_cfgs[0].keys_manager;
7908 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7909 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7910 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7912 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7914 // Cache node A state before any channel update
7915 let previous_node_state = nodes[0].node.encode();
7916 let mut previous_chain_monitor_state = test_utils::TestVecWriter(Vec::new());
7917 nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut previous_chain_monitor_state).unwrap();
7919 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
7920 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
7922 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
7923 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
7925 // Restore node A from previous state
7926 logger = test_utils::TestLogger::with_id(format!("node {}", 0));
7927 let mut chain_monitor = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(&mut io::Cursor::new(previous_chain_monitor_state.0), keys_manager).unwrap().1;
7928 chain_source = test_utils::TestChainSource::new(Network::Testnet);
7929 tx_broadcaster = test_utils::TestBroadcaster{txn_broadcasted: Mutex::new(Vec::new()), blocks: Arc::new(Mutex::new(Vec::new()))};
7930 fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
7931 persister = test_utils::TestPersister::new();
7932 monitor = test_utils::TestChainMonitor::new(Some(&chain_source), &tx_broadcaster, &logger, &fee_estimator, &persister, keys_manager);
7934 let mut channel_monitors = HashMap::new();
7935 channel_monitors.insert(OutPoint { txid: chan.3.txid(), index: 0 }, &mut chain_monitor);
7936 <(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 {
7937 keys_manager: keys_manager,
7938 fee_estimator: &fee_estimator,
7939 chain_monitor: &monitor,
7941 tx_broadcaster: &tx_broadcaster,
7942 default_config: UserConfig::default(),
7946 nodes[0].node = &node_state_0;
7947 assert!(monitor.watch_channel(OutPoint { txid: chan.3.txid(), index: 0 }, chain_monitor).is_ok());
7948 nodes[0].chain_monitor = &monitor;
7949 nodes[0].chain_source = &chain_source;
7951 check_added_monitors!(nodes[0], 1);
7953 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7954 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7956 let reestablish_0 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
7958 // Check we don't broadcast any transactions following learning of per_commitment_point from B
7959 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_0[0]);
7960 check_added_monitors!(nodes[0], 1);
7963 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
7964 assert_eq!(node_txn.len(), 0);
7967 let mut reestablish_1 = Vec::with_capacity(1);
7968 for msg in nodes[0].node.get_and_clear_pending_msg_events() {
7969 if let MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } = msg {
7970 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
7971 reestablish_1.push(msg.clone());
7972 } else if let MessageSendEvent::BroadcastChannelUpdate { .. } = msg {
7973 } else if let MessageSendEvent::HandleError { ref action, .. } = msg {
7975 &ErrorAction::SendErrorMessage { ref msg } => {
7976 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");
7978 _ => panic!("Unexpected event!"),
7981 panic!("Unexpected event")
7985 // Check we close channel detecting A is fallen-behind
7986 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
7987 assert_eq!(check_closed_broadcast!(nodes[1], true).unwrap().data, "Peer attempted to reestablish channel with a very old local commitment transaction");
7988 check_added_monitors!(nodes[1], 1);
7991 // Check A is able to claim to_remote output
7992 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
7993 assert_eq!(node_txn.len(), 1);
7994 check_spends!(node_txn[0], chan.3);
7995 assert_eq!(node_txn[0].output.len(), 2);
7996 mine_transaction(&nodes[0], &node_txn[0]);
7997 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7998 let spend_txn = check_spendable_outputs!(nodes[0], node_cfgs[0].keys_manager);
7999 assert_eq!(spend_txn.len(), 1);
8000 check_spends!(spend_txn[0], node_txn[0]);
8004 fn test_check_htlc_underpaying() {
8005 // Send payment through A -> B but A is maliciously
8006 // sending a probe payment (i.e less than expected value0
8007 // to B, B should refuse payment.
8009 let chanmon_cfgs = create_chanmon_cfgs(2);
8010 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8011 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8012 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8014 // Create some initial channels
8015 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
8017 let route = get_route(&nodes[0].node.get_our_node_id(), &nodes[0].net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 10_000, TEST_FINAL_CLTV, nodes[0].logger).unwrap();
8018 let (_, our_payment_hash, _) = get_payment_preimage_hash!(nodes[0]);
8019 let our_payment_secret = nodes[1].node.create_inbound_payment_for_hash(our_payment_hash, Some(100_000), 7200, 0).unwrap();
8020 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
8021 check_added_monitors!(nodes[0], 1);
8023 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
8024 assert_eq!(events.len(), 1);
8025 let mut payment_event = SendEvent::from_event(events.pop().unwrap());
8026 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
8027 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
8029 // Note that we first have to wait a random delay before processing the receipt of the HTLC,
8030 // and then will wait a second random delay before failing the HTLC back:
8031 expect_pending_htlcs_forwardable!(nodes[1]);
8032 expect_pending_htlcs_forwardable!(nodes[1]);
8034 // Node 3 is expecting payment of 100_000 but received 10_000,
8035 // it should fail htlc like we didn't know the preimage.
8036 nodes[1].node.process_pending_htlc_forwards();
8038 let events = nodes[1].node.get_and_clear_pending_msg_events();
8039 assert_eq!(events.len(), 1);
8040 let (update_fail_htlc, commitment_signed) = match events[0] {
8041 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 } } => {
8042 assert!(update_add_htlcs.is_empty());
8043 assert!(update_fulfill_htlcs.is_empty());
8044 assert_eq!(update_fail_htlcs.len(), 1);
8045 assert!(update_fail_malformed_htlcs.is_empty());
8046 assert!(update_fee.is_none());
8047 (update_fail_htlcs[0].clone(), commitment_signed)
8049 _ => panic!("Unexpected event"),
8051 check_added_monitors!(nodes[1], 1);
8053 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlc);
8054 commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
8056 // 10_000 msat as u64, followed by a height of CHAN_CONFIRM_DEPTH as u32
8057 let mut expected_failure_data = byte_utils::be64_to_array(10_000).to_vec();
8058 expected_failure_data.extend_from_slice(&byte_utils::be32_to_array(CHAN_CONFIRM_DEPTH));
8059 expect_payment_failed!(nodes[0], our_payment_hash, true, 0x4000|15, &expected_failure_data[..]);
8063 fn test_announce_disable_channels() {
8064 // Create 2 channels between A and B. Disconnect B. Call timer_tick_occurred and check for generated
8065 // ChannelUpdate. Reconnect B, reestablish and check there is non-generated ChannelUpdate.
8067 let chanmon_cfgs = create_chanmon_cfgs(2);
8068 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8069 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8070 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8072 let short_id_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8073 let short_id_2 = create_announced_chan_between_nodes(&nodes, 1, 0, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8074 let short_id_3 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8077 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
8078 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
8080 nodes[0].node.timer_tick_occurred(); // Enabled -> DisabledStaged
8081 nodes[0].node.timer_tick_occurred(); // DisabledStaged -> Disabled
8082 let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
8083 assert_eq!(msg_events.len(), 3);
8084 let mut chans_disabled: HashSet<u64> = [short_id_1, short_id_2, short_id_3].iter().map(|a| *a).collect();
8085 for e in msg_events {
8087 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
8088 assert_eq!(msg.contents.flags & (1<<1), 1<<1); // The "channel disabled" bit should be set
8089 // Check that each channel gets updated exactly once
8090 if !chans_disabled.remove(&msg.contents.short_channel_id) {
8091 panic!("Generated ChannelUpdate for wrong chan!");
8094 _ => panic!("Unexpected event"),
8098 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
8099 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
8100 assert_eq!(reestablish_1.len(), 3);
8101 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
8102 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
8103 assert_eq!(reestablish_2.len(), 3);
8105 // Reestablish chan_1
8106 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
8107 handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
8108 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
8109 handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
8110 // Reestablish chan_2
8111 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[1]);
8112 handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
8113 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[1]);
8114 handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
8115 // Reestablish chan_3
8116 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[2]);
8117 handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
8118 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[2]);
8119 handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
8121 nodes[0].node.timer_tick_occurred();
8122 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
8123 nodes[0].node.timer_tick_occurred();
8124 let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
8125 assert_eq!(msg_events.len(), 3);
8126 chans_disabled = [short_id_1, short_id_2, short_id_3].iter().map(|a| *a).collect();
8127 for e in msg_events {
8129 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
8130 assert_eq!(msg.contents.flags & (1<<1), 0); // The "channel disabled" bit should be off
8131 // Check that each channel gets updated exactly once
8132 if !chans_disabled.remove(&msg.contents.short_channel_id) {
8133 panic!("Generated ChannelUpdate for wrong chan!");
8136 _ => panic!("Unexpected event"),
8142 fn test_priv_forwarding_rejection() {
8143 // If we have a private channel with outbound liquidity, and
8144 // UserConfig::accept_forwards_to_priv_channels is set to false, we should reject any attempts
8145 // to forward through that channel.
8146 let chanmon_cfgs = create_chanmon_cfgs(3);
8147 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
8148 let mut no_announce_cfg = test_default_channel_config();
8149 no_announce_cfg.channel_options.announced_channel = false;
8150 no_announce_cfg.accept_forwards_to_priv_channels = false;
8151 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, Some(no_announce_cfg), None]);
8152 let persister: test_utils::TestPersister;
8153 let new_chain_monitor: test_utils::TestChainMonitor;
8154 let nodes_1_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
8155 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
8157 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1_000_000, 500_000_000, InitFeatures::known(), InitFeatures::known());
8159 // Note that the create_*_chan functions in utils requires announcement_signatures, which we do
8160 // not send for private channels.
8161 nodes[1].node.create_channel(nodes[2].node.get_our_node_id(), 1_000_000, 500_000_000, 42, None).unwrap();
8162 let open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[2].node.get_our_node_id());
8163 nodes[2].node.handle_open_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &open_channel);
8164 let accept_channel = get_event_msg!(nodes[2], MessageSendEvent::SendAcceptChannel, nodes[1].node.get_our_node_id());
8165 nodes[1].node.handle_accept_channel(&nodes[2].node.get_our_node_id(), InitFeatures::known(), &accept_channel);
8167 let (temporary_channel_id, tx, _) = create_funding_transaction(&nodes[1], 1_000_000, 42);
8168 nodes[1].node.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
8169 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()));
8170 check_added_monitors!(nodes[2], 1);
8172 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()));
8173 check_added_monitors!(nodes[1], 1);
8175 let conf_height = core::cmp::max(nodes[1].best_block_info().1 + 1, nodes[2].best_block_info().1 + 1);
8176 confirm_transaction_at(&nodes[1], &tx, conf_height);
8177 connect_blocks(&nodes[1], CHAN_CONFIRM_DEPTH - 1);
8178 confirm_transaction_at(&nodes[2], &tx, conf_height);
8179 connect_blocks(&nodes[2], CHAN_CONFIRM_DEPTH - 1);
8180 let as_funding_locked = get_event_msg!(nodes[1], MessageSendEvent::SendFundingLocked, nodes[2].node.get_our_node_id());
8181 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()));
8182 get_event_msg!(nodes[1], MessageSendEvent::SendChannelUpdate, nodes[2].node.get_our_node_id());
8183 nodes[2].node.handle_funding_locked(&nodes[1].node.get_our_node_id(), &as_funding_locked);
8184 get_event_msg!(nodes[2], MessageSendEvent::SendChannelUpdate, nodes[1].node.get_our_node_id());
8186 assert!(nodes[0].node.list_usable_channels()[0].is_public);
8187 assert_eq!(nodes[1].node.list_usable_channels().len(), 2);
8188 assert!(!nodes[2].node.list_usable_channels()[0].is_public);
8190 // We should always be able to forward through nodes[1] as long as its out through a public
8192 send_payment(&nodes[2], &[&nodes[1], &nodes[0]], 10_000);
8194 // ... however, if we send to nodes[2], we will have to pass the private channel from nodes[1]
8195 // to nodes[2], which should be rejected:
8196 let (our_payment_preimage, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[2]);
8197 let route = get_route(&nodes[0].node.get_our_node_id(),
8198 &nodes[0].net_graph_msg_handler.network_graph.read().unwrap(),
8199 &nodes[2].node.get_our_node_id(), Some(InvoiceFeatures::known()), None,
8200 &[&RouteHint(vec![RouteHintHop {
8201 src_node_id: nodes[1].node.get_our_node_id(),
8202 short_channel_id: nodes[2].node.list_channels()[0].short_channel_id.unwrap(),
8203 fees: RoutingFees { base_msat: 1000, proportional_millionths: 0 },
8204 cltv_expiry_delta: MIN_CLTV_EXPIRY_DELTA,
8205 htlc_minimum_msat: None,
8206 htlc_maximum_msat: None,
8207 }])], 10_000, TEST_FINAL_CLTV, nodes[0].logger).unwrap();
8209 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
8210 check_added_monitors!(nodes[0], 1);
8211 let payment_event = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
8212 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
8213 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false, true);
8215 let htlc_fail_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
8216 assert!(htlc_fail_updates.update_add_htlcs.is_empty());
8217 assert_eq!(htlc_fail_updates.update_fail_htlcs.len(), 1);
8218 assert!(htlc_fail_updates.update_fail_malformed_htlcs.is_empty());
8219 assert!(htlc_fail_updates.update_fee.is_none());
8221 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_fail_updates.update_fail_htlcs[0]);
8222 commitment_signed_dance!(nodes[0], nodes[1], htlc_fail_updates.commitment_signed, true, true);
8223 expect_payment_failed!(nodes[0], our_payment_hash, false);
8224 expect_payment_failure_chan_update!(nodes[0], nodes[2].node.list_channels()[0].short_channel_id.unwrap(), true);
8226 // Now disconnect nodes[1] from its peers and restart with accept_forwards_to_priv_channels set
8227 // to true. Sadly there is currently no way to change it at runtime.
8229 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
8230 nodes[2].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
8232 let nodes_1_serialized = nodes[1].node.encode();
8233 let mut monitor_a_serialized = test_utils::TestVecWriter(Vec::new());
8234 let mut monitor_b_serialized = test_utils::TestVecWriter(Vec::new());
8236 let mons = nodes[1].chain_monitor.chain_monitor.monitors.read().unwrap();
8237 let mut mon_iter = mons.iter();
8238 mon_iter.next().unwrap().1.write(&mut monitor_a_serialized).unwrap();
8239 mon_iter.next().unwrap().1.write(&mut monitor_b_serialized).unwrap();
8242 persister = test_utils::TestPersister::new();
8243 let keys_manager = &chanmon_cfgs[1].keys_manager;
8244 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);
8245 nodes[1].chain_monitor = &new_chain_monitor;
8247 let mut monitor_a_read = &monitor_a_serialized.0[..];
8248 let mut monitor_b_read = &monitor_b_serialized.0[..];
8249 let (_, mut monitor_a) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(&mut monitor_a_read, keys_manager).unwrap();
8250 let (_, mut monitor_b) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(&mut monitor_b_read, keys_manager).unwrap();
8251 assert!(monitor_a_read.is_empty());
8252 assert!(monitor_b_read.is_empty());
8254 no_announce_cfg.accept_forwards_to_priv_channels = true;
8256 let mut nodes_1_read = &nodes_1_serialized[..];
8257 let (_, nodes_1_deserialized_tmp) = {
8258 let mut channel_monitors = HashMap::new();
8259 channel_monitors.insert(monitor_a.get_funding_txo().0, &mut monitor_a);
8260 channel_monitors.insert(monitor_b.get_funding_txo().0, &mut monitor_b);
8261 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_1_read, ChannelManagerReadArgs {
8262 default_config: no_announce_cfg,
8264 fee_estimator: node_cfgs[1].fee_estimator,
8265 chain_monitor: nodes[1].chain_monitor,
8266 tx_broadcaster: nodes[1].tx_broadcaster.clone(),
8267 logger: nodes[1].logger,
8271 assert!(nodes_1_read.is_empty());
8272 nodes_1_deserialized = nodes_1_deserialized_tmp;
8274 assert!(nodes[1].chain_monitor.watch_channel(monitor_a.get_funding_txo().0, monitor_a).is_ok());
8275 assert!(nodes[1].chain_monitor.watch_channel(monitor_b.get_funding_txo().0, monitor_b).is_ok());
8276 check_added_monitors!(nodes[1], 2);
8277 nodes[1].node = &nodes_1_deserialized;
8279 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::known() });
8280 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
8281 let as_reestablish = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
8282 let bs_reestablish = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
8283 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &as_reestablish);
8284 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &bs_reestablish);
8285 get_event_msg!(nodes[0], MessageSendEvent::SendChannelUpdate, nodes[1].node.get_our_node_id());
8286 get_event_msg!(nodes[1], MessageSendEvent::SendChannelUpdate, nodes[0].node.get_our_node_id());
8288 nodes[1].node.peer_connected(&nodes[2].node.get_our_node_id(), &msgs::Init { features: InitFeatures::known() });
8289 nodes[2].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
8290 let bs_reestablish = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[2].node.get_our_node_id());
8291 let cs_reestablish = get_event_msg!(nodes[2], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
8292 nodes[2].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &bs_reestablish);
8293 nodes[1].node.handle_channel_reestablish(&nodes[2].node.get_our_node_id(), &cs_reestablish);
8294 get_event_msg!(nodes[1], MessageSendEvent::SendChannelUpdate, nodes[2].node.get_our_node_id());
8295 get_event_msg!(nodes[2], MessageSendEvent::SendChannelUpdate, nodes[1].node.get_our_node_id());
8297 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
8298 check_added_monitors!(nodes[0], 1);
8299 pass_along_route(&nodes[0], &[&[&nodes[1], &nodes[2]]], 10_000, our_payment_hash, our_payment_secret);
8300 claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], our_payment_preimage);
8304 fn test_bump_penalty_txn_on_revoked_commitment() {
8305 // In case of penalty txn with too low feerates for getting into mempools, RBF-bump them to be sure
8306 // we're able to claim outputs on revoked commitment transaction before timelocks expiration
8308 let chanmon_cfgs = create_chanmon_cfgs(2);
8309 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8310 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8311 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8313 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
8314 let logger = test_utils::TestLogger::new();
8316 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
8317 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
8318 let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[0].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 3000000, 30, &logger).unwrap();
8319 send_along_route(&nodes[1], route, &vec!(&nodes[0])[..], 3000000);
8321 let revoked_txn = get_local_commitment_txn!(nodes[0], chan.2);
8322 // Revoked commitment txn with 4 outputs : to_local, to_remote, 1 outgoing HTLC, 1 incoming HTLC
8323 assert_eq!(revoked_txn[0].output.len(), 4);
8324 assert_eq!(revoked_txn[0].input.len(), 1);
8325 assert_eq!(revoked_txn[0].input[0].previous_output.txid, chan.3.txid());
8326 let revoked_txid = revoked_txn[0].txid();
8328 let mut penalty_sum = 0;
8329 for outp in revoked_txn[0].output.iter() {
8330 if outp.script_pubkey.is_v0_p2wsh() {
8331 penalty_sum += outp.value;
8335 // Connect blocks to change height_timer range to see if we use right soonest_timelock
8336 let header_114 = connect_blocks(&nodes[1], 14);
8338 // Actually revoke tx by claiming a HTLC
8339 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
8340 let header = BlockHeader { version: 0x20000000, prev_blockhash: header_114, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8341 connect_block(&nodes[1], &Block { header, txdata: vec![revoked_txn[0].clone()] });
8342 check_added_monitors!(nodes[1], 1);
8344 // One or more justice tx should have been broadcast, check it
8348 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8349 assert_eq!(node_txn.len(), 2); // justice tx (broadcasted from ChannelMonitor) + local commitment tx
8350 assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
8351 assert_eq!(node_txn[0].output.len(), 1);
8352 check_spends!(node_txn[0], revoked_txn[0]);
8353 let fee_1 = penalty_sum - node_txn[0].output[0].value;
8354 feerate_1 = fee_1 * 1000 / node_txn[0].get_weight() as u64;
8355 penalty_1 = node_txn[0].txid();
8359 // After exhaustion of height timer, a new bumped justice tx should have been broadcast, check it
8360 connect_blocks(&nodes[1], 15);
8361 let mut penalty_2 = penalty_1;
8362 let mut feerate_2 = 0;
8364 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8365 assert_eq!(node_txn.len(), 1);
8366 if node_txn[0].input[0].previous_output.txid == revoked_txid {
8367 assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
8368 assert_eq!(node_txn[0].output.len(), 1);
8369 check_spends!(node_txn[0], revoked_txn[0]);
8370 penalty_2 = node_txn[0].txid();
8371 // Verify new bumped tx is different from last claiming transaction, we don't want spurrious rebroadcast
8372 assert_ne!(penalty_2, penalty_1);
8373 let fee_2 = penalty_sum - node_txn[0].output[0].value;
8374 feerate_2 = fee_2 * 1000 / node_txn[0].get_weight() as u64;
8375 // Verify 25% bump heuristic
8376 assert!(feerate_2 * 100 >= feerate_1 * 125);
8380 assert_ne!(feerate_2, 0);
8382 // After exhaustion of height timer for a 2nd time, a new bumped justice tx should have been broadcast, check it
8383 connect_blocks(&nodes[1], 1);
8385 let mut feerate_3 = 0;
8387 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8388 assert_eq!(node_txn.len(), 1);
8389 if node_txn[0].input[0].previous_output.txid == revoked_txid {
8390 assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
8391 assert_eq!(node_txn[0].output.len(), 1);
8392 check_spends!(node_txn[0], revoked_txn[0]);
8393 penalty_3 = node_txn[0].txid();
8394 // Verify new bumped tx is different from last claiming transaction, we don't want spurrious rebroadcast
8395 assert_ne!(penalty_3, penalty_2);
8396 let fee_3 = penalty_sum - node_txn[0].output[0].value;
8397 feerate_3 = fee_3 * 1000 / node_txn[0].get_weight() as u64;
8398 // Verify 25% bump heuristic
8399 assert!(feerate_3 * 100 >= feerate_2 * 125);
8403 assert_ne!(feerate_3, 0);
8405 nodes[1].node.get_and_clear_pending_events();
8406 nodes[1].node.get_and_clear_pending_msg_events();
8410 fn test_bump_penalty_txn_on_revoked_htlcs() {
8411 // In case of penalty txn with too low feerates for getting into mempools, RBF-bump them to sure
8412 // we're able to claim outputs on revoked HTLC transactions before timelocks expiration
8414 let mut chanmon_cfgs = create_chanmon_cfgs(2);
8415 chanmon_cfgs[1].keys_manager.disable_revocation_policy_check = true;
8416 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8417 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8418 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8420 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
8421 // Lock HTLC in both directions (using a slightly lower CLTV delay to provide timely RBF bumps)
8422 let route = get_route(&nodes[0].node.get_our_node_id(), &nodes[0].net_graph_msg_handler.network_graph.read().unwrap(),
8423 &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 3_000_000, 50, nodes[0].logger).unwrap();
8424 let payment_preimage = send_along_route(&nodes[0], route, &[&nodes[1]], 3_000_000).0;
8425 let route = get_route(&nodes[1].node.get_our_node_id(), &nodes[1].net_graph_msg_handler.network_graph.read().unwrap(),
8426 &nodes[0].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 3_000_000, 50, nodes[0].logger).unwrap();
8427 send_along_route(&nodes[1], route, &[&nodes[0]], 3_000_000);
8429 let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan.2);
8430 assert_eq!(revoked_local_txn[0].input.len(), 1);
8431 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
8433 // Revoke local commitment tx
8434 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
8436 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8437 // B will generate both revoked HTLC-timeout/HTLC-preimage txn from revoked commitment tx
8438 connect_block(&nodes[1], &Block { header, txdata: vec![revoked_local_txn[0].clone()] });
8439 check_closed_broadcast!(nodes[1], true);
8440 check_added_monitors!(nodes[1], 1);
8441 connect_blocks(&nodes[1], 49); // Confirm blocks until the HTLC expires (note CLTV was explicitly 50 above)
8443 let revoked_htlc_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8444 assert_eq!(revoked_htlc_txn.len(), 3);
8445 check_spends!(revoked_htlc_txn[1], chan.3);
8447 assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
8448 assert_eq!(revoked_htlc_txn[0].input.len(), 1);
8449 check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
8451 assert_eq!(revoked_htlc_txn[2].input.len(), 1);
8452 assert_eq!(revoked_htlc_txn[2].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
8453 assert_eq!(revoked_htlc_txn[2].output.len(), 1);
8454 check_spends!(revoked_htlc_txn[2], revoked_local_txn[0]);
8456 // Broadcast set of revoked txn on A
8457 let hash_128 = connect_blocks(&nodes[0], 40);
8458 let header_11 = BlockHeader { version: 0x20000000, prev_blockhash: hash_128, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8459 connect_block(&nodes[0], &Block { header: header_11, txdata: vec![revoked_local_txn[0].clone()] });
8460 let header_129 = BlockHeader { version: 0x20000000, prev_blockhash: header_11.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8461 connect_block(&nodes[0], &Block { header: header_129, txdata: vec![revoked_htlc_txn[0].clone(), revoked_htlc_txn[2].clone()] });
8462 expect_pending_htlcs_forwardable_ignore!(nodes[0]);
8467 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8468 assert_eq!(node_txn.len(), 5); // 3 penalty txn on revoked commitment tx + A commitment tx + 1 penalty tnx on revoked HTLC txn
8469 // Verify claim tx are spending revoked HTLC txn
8471 // node_txn 0-2 each spend a separate revoked output from revoked_local_txn[0]
8472 // Note that node_txn[0] and node_txn[1] are bogus - they double spend the revoked_htlc_txn
8473 // which are included in the same block (they are broadcasted because we scan the
8474 // transactions linearly and generate claims as we go, they likely should be removed in the
8476 assert_eq!(node_txn[0].input.len(), 1);
8477 check_spends!(node_txn[0], revoked_local_txn[0]);
8478 assert_eq!(node_txn[1].input.len(), 1);
8479 check_spends!(node_txn[1], revoked_local_txn[0]);
8480 assert_eq!(node_txn[2].input.len(), 1);
8481 check_spends!(node_txn[2], revoked_local_txn[0]);
8483 // Each of the three justice transactions claim a separate (single) output of the three
8484 // available, which we check here:
8485 assert_ne!(node_txn[0].input[0].previous_output, node_txn[1].input[0].previous_output);
8486 assert_ne!(node_txn[0].input[0].previous_output, node_txn[2].input[0].previous_output);
8487 assert_ne!(node_txn[1].input[0].previous_output, node_txn[2].input[0].previous_output);
8489 assert_eq!(node_txn[0].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
8490 assert_eq!(node_txn[1].input[0].previous_output, revoked_htlc_txn[2].input[0].previous_output);
8492 // node_txn[3] is the local commitment tx broadcast just because (and somewhat in case of
8493 // reorgs, though its not clear its ever worth broadcasting conflicting txn like this when
8494 // a remote commitment tx has already been confirmed).
8495 check_spends!(node_txn[3], chan.3);
8497 // node_txn[4] spends the revoked outputs from the revoked_htlc_txn (which only have one
8498 // output, checked above).
8499 assert_eq!(node_txn[4].input.len(), 2);
8500 assert_eq!(node_txn[4].output.len(), 1);
8501 check_spends!(node_txn[4], revoked_htlc_txn[0], revoked_htlc_txn[2]);
8503 first = node_txn[4].txid();
8504 // Store both feerates for later comparison
8505 let fee_1 = revoked_htlc_txn[0].output[0].value + revoked_htlc_txn[2].output[0].value - node_txn[4].output[0].value;
8506 feerate_1 = fee_1 * 1000 / node_txn[4].get_weight() as u64;
8507 penalty_txn = vec![node_txn[2].clone()];
8511 // Connect one more block to see if bumped penalty are issued for HTLC txn
8512 let header_130 = BlockHeader { version: 0x20000000, prev_blockhash: header_129.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8513 connect_block(&nodes[0], &Block { header: header_130, txdata: penalty_txn });
8514 let header_131 = BlockHeader { version: 0x20000000, prev_blockhash: header_130.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8515 connect_block(&nodes[0], &Block { header: header_131, txdata: Vec::new() });
8517 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8518 assert_eq!(node_txn.len(), 2); // 2 bumped penalty txn on revoked commitment tx
8520 check_spends!(node_txn[0], revoked_local_txn[0]);
8521 check_spends!(node_txn[1], revoked_local_txn[0]);
8522 // Note that these are both bogus - they spend outputs already claimed in block 129:
8523 if node_txn[0].input[0].previous_output == revoked_htlc_txn[0].input[0].previous_output {
8524 assert_eq!(node_txn[1].input[0].previous_output, revoked_htlc_txn[2].input[0].previous_output);
8526 assert_eq!(node_txn[0].input[0].previous_output, revoked_htlc_txn[2].input[0].previous_output);
8527 assert_eq!(node_txn[1].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
8533 // Few more blocks to confirm penalty txn
8534 connect_blocks(&nodes[0], 4);
8535 assert!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
8536 let header_144 = connect_blocks(&nodes[0], 9);
8538 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8539 assert_eq!(node_txn.len(), 1);
8541 assert_eq!(node_txn[0].input.len(), 2);
8542 check_spends!(node_txn[0], revoked_htlc_txn[0], revoked_htlc_txn[2]);
8543 // Verify bumped tx is different and 25% bump heuristic
8544 assert_ne!(first, node_txn[0].txid());
8545 let fee_2 = revoked_htlc_txn[0].output[0].value + revoked_htlc_txn[2].output[0].value - node_txn[0].output[0].value;
8546 let feerate_2 = fee_2 * 1000 / node_txn[0].get_weight() as u64;
8547 assert!(feerate_2 * 100 > feerate_1 * 125);
8548 let txn = vec![node_txn[0].clone()];
8552 // Broadcast claim txn and confirm blocks to avoid further bumps on this outputs
8553 let header_145 = BlockHeader { version: 0x20000000, prev_blockhash: header_144, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8554 connect_block(&nodes[0], &Block { header: header_145, txdata: node_txn });
8555 connect_blocks(&nodes[0], 20);
8557 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8558 // We verify than no new transaction has been broadcast because previously
8559 // we were buggy on this exact behavior by not tracking for monitoring remote HTLC outputs (see #411)
8560 // which means we wouldn't see a spend of them by a justice tx and bumped justice tx
8561 // were generated forever instead of safe cleaning after confirmation and ANTI_REORG_SAFE_DELAY blocks.
8562 // Enforce spending of revoked htlc output by claiming transaction remove request as expected and dry
8563 // up bumped justice generation.
8564 assert_eq!(node_txn.len(), 0);
8567 check_closed_broadcast!(nodes[0], true);
8568 check_added_monitors!(nodes[0], 1);
8572 fn test_bump_penalty_txn_on_remote_commitment() {
8573 // In case of claim txn with too low feerates for getting into mempools, RBF-bump them to be sure
8574 // we're able to claim outputs on remote commitment transaction before timelocks expiration
8577 // Provide preimage for one
8578 // Check aggregation
8580 let chanmon_cfgs = create_chanmon_cfgs(2);
8581 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8582 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8583 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8585 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
8586 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
8587 route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000).0;
8589 // Remote commitment txn with 4 outputs : to_local, to_remote, 1 outgoing HTLC, 1 incoming HTLC
8590 let remote_txn = get_local_commitment_txn!(nodes[0], chan.2);
8591 assert_eq!(remote_txn[0].output.len(), 4);
8592 assert_eq!(remote_txn[0].input.len(), 1);
8593 assert_eq!(remote_txn[0].input[0].previous_output.txid, chan.3.txid());
8595 // Claim a HTLC without revocation (provide B monitor with preimage)
8596 nodes[1].node.claim_funds(payment_preimage);
8597 mine_transaction(&nodes[1], &remote_txn[0]);
8598 check_added_monitors!(nodes[1], 2);
8599 connect_blocks(&nodes[1], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
8601 // One or more claim tx should have been broadcast, check it
8605 let feerate_timeout;
8606 let feerate_preimage;
8608 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8609 // 9 transactions including:
8610 // 1*2 ChannelManager local broadcasts of commitment + HTLC-Success
8611 // 1*3 ChannelManager local broadcasts of commitment + HTLC-Success + HTLC-Timeout
8612 // 2 * HTLC-Success (one RBF bump we'll check later)
8614 assert_eq!(node_txn.len(), 8);
8615 assert_eq!(node_txn[0].input.len(), 1);
8616 assert_eq!(node_txn[6].input.len(), 1);
8617 check_spends!(node_txn[0], remote_txn[0]);
8618 check_spends!(node_txn[6], remote_txn[0]);
8619 assert_eq!(node_txn[0].input[0].previous_output, node_txn[3].input[0].previous_output);
8620 preimage_bump = node_txn[3].clone();
8622 check_spends!(node_txn[1], chan.3);
8623 check_spends!(node_txn[2], node_txn[1]);
8624 assert_eq!(node_txn[1], node_txn[4]);
8625 assert_eq!(node_txn[2], node_txn[5]);
8627 timeout = node_txn[6].txid();
8628 let index = node_txn[6].input[0].previous_output.vout;
8629 let fee = remote_txn[0].output[index as usize].value - node_txn[6].output[0].value;
8630 feerate_timeout = fee * 1000 / node_txn[6].get_weight() as u64;
8632 preimage = node_txn[0].txid();
8633 let index = node_txn[0].input[0].previous_output.vout;
8634 let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
8635 feerate_preimage = fee * 1000 / node_txn[0].get_weight() as u64;
8639 assert_ne!(feerate_timeout, 0);
8640 assert_ne!(feerate_preimage, 0);
8642 // After exhaustion of height timer, new bumped claim txn should have been broadcast, check it
8643 connect_blocks(&nodes[1], 15);
8645 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8646 assert_eq!(node_txn.len(), 1);
8647 assert_eq!(node_txn[0].input.len(), 1);
8648 assert_eq!(preimage_bump.input.len(), 1);
8649 check_spends!(node_txn[0], remote_txn[0]);
8650 check_spends!(preimage_bump, remote_txn[0]);
8652 let index = preimage_bump.input[0].previous_output.vout;
8653 let fee = remote_txn[0].output[index as usize].value - preimage_bump.output[0].value;
8654 let new_feerate = fee * 1000 / preimage_bump.get_weight() as u64;
8655 assert!(new_feerate * 100 > feerate_timeout * 125);
8656 assert_ne!(timeout, preimage_bump.txid());
8658 let index = node_txn[0].input[0].previous_output.vout;
8659 let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
8660 let new_feerate = fee * 1000 / node_txn[0].get_weight() as u64;
8661 assert!(new_feerate * 100 > feerate_preimage * 125);
8662 assert_ne!(preimage, node_txn[0].txid());
8667 nodes[1].node.get_and_clear_pending_events();
8668 nodes[1].node.get_and_clear_pending_msg_events();
8672 fn test_counterparty_raa_skip_no_crash() {
8673 // Previously, if our counterparty sent two RAAs in a row without us having provided a
8674 // commitment transaction, we would have happily carried on and provided them the next
8675 // commitment transaction based on one RAA forward. This would probably eventually have led to
8676 // channel closure, but it would not have resulted in funds loss. Still, our
8677 // EnforcingSigner would have paniced as it doesn't like jumps into the future. Here, we
8678 // check simply that the channel is closed in response to such an RAA, but don't check whether
8679 // we decide to punish our counterparty for revoking their funds (as we don't currently
8681 let chanmon_cfgs = create_chanmon_cfgs(2);
8682 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8683 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8684 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8685 let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).2;
8687 let mut guard = nodes[0].node.channel_state.lock().unwrap();
8688 let keys = &guard.by_id.get_mut(&channel_id).unwrap().get_signer();
8689 const INITIAL_COMMITMENT_NUMBER: u64 = (1 << 48) - 1;
8690 let per_commitment_secret = keys.release_commitment_secret(INITIAL_COMMITMENT_NUMBER);
8691 // Must revoke without gaps
8692 keys.release_commitment_secret(INITIAL_COMMITMENT_NUMBER - 1);
8693 let next_per_commitment_point = PublicKey::from_secret_key(&Secp256k1::new(),
8694 &SecretKey::from_slice(&keys.release_commitment_secret(INITIAL_COMMITMENT_NUMBER - 2)).unwrap());
8696 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(),
8697 &msgs::RevokeAndACK { channel_id, per_commitment_secret, next_per_commitment_point });
8698 assert_eq!(check_closed_broadcast!(nodes[1], true).unwrap().data, "Received an unexpected revoke_and_ack");
8699 check_added_monitors!(nodes[1], 1);
8703 fn test_bump_txn_sanitize_tracking_maps() {
8704 // Sanitizing pendning_claim_request and claimable_outpoints used to be buggy,
8705 // verify we clean then right after expiration of ANTI_REORG_DELAY.
8707 let chanmon_cfgs = create_chanmon_cfgs(2);
8708 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8709 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8710 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8712 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
8713 // Lock HTLC in both directions
8714 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000).0;
8715 route_payment(&nodes[1], &vec!(&nodes[0])[..], 9_000_000).0;
8717 let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan.2);
8718 assert_eq!(revoked_local_txn[0].input.len(), 1);
8719 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
8721 // Revoke local commitment tx
8722 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
8724 // Broadcast set of revoked txn on A
8725 connect_blocks(&nodes[0], TEST_FINAL_CLTV + 2 - CHAN_CONFIRM_DEPTH);
8726 expect_pending_htlcs_forwardable_ignore!(nodes[0]);
8727 assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 0);
8729 mine_transaction(&nodes[0], &revoked_local_txn[0]);
8730 check_closed_broadcast!(nodes[0], true);
8731 check_added_monitors!(nodes[0], 1);
8733 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8734 assert_eq!(node_txn.len(), 4); //ChannelMonitor: justice txn * 3, ChannelManager: local commitment tx
8735 check_spends!(node_txn[0], revoked_local_txn[0]);
8736 check_spends!(node_txn[1], revoked_local_txn[0]);
8737 check_spends!(node_txn[2], revoked_local_txn[0]);
8738 let penalty_txn = vec![node_txn[0].clone(), node_txn[1].clone(), node_txn[2].clone()];
8742 let header_130 = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8743 connect_block(&nodes[0], &Block { header: header_130, txdata: penalty_txn });
8744 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
8746 let monitors = nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap();
8747 if let Some(monitor) = monitors.get(&OutPoint { txid: chan.3.txid(), index: 0 }) {
8748 assert!(monitor.inner.lock().unwrap().onchain_tx_handler.pending_claim_requests.is_empty());
8749 assert!(monitor.inner.lock().unwrap().onchain_tx_handler.claimable_outpoints.is_empty());
8755 fn test_override_channel_config() {
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 // Node0 initiates a channel to node1 using the override config.
8762 let mut override_config = UserConfig::default();
8763 override_config.own_channel_config.our_to_self_delay = 200;
8765 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 16_000_000, 12_000_000, 42, Some(override_config)).unwrap();
8767 // Assert the channel created by node0 is using the override config.
8768 let res = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8769 assert_eq!(res.channel_flags, 0);
8770 assert_eq!(res.to_self_delay, 200);
8774 fn test_override_0msat_htlc_minimum() {
8775 let mut zero_config = UserConfig::default();
8776 zero_config.own_channel_config.our_htlc_minimum_msat = 0;
8777 let chanmon_cfgs = create_chanmon_cfgs(2);
8778 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8779 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, Some(zero_config.clone())]);
8780 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8782 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 16_000_000, 12_000_000, 42, Some(zero_config)).unwrap();
8783 let res = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8784 assert_eq!(res.htlc_minimum_msat, 1);
8786 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &res);
8787 let res = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
8788 assert_eq!(res.htlc_minimum_msat, 1);
8792 fn test_simple_mpp() {
8793 // Simple test of sending a multi-path payment.
8794 let chanmon_cfgs = create_chanmon_cfgs(4);
8795 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
8796 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
8797 let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
8799 let chan_1_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8800 let chan_2_id = create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8801 let chan_3_id = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8802 let chan_4_id = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8803 let logger = test_utils::TestLogger::new();
8805 let (payment_preimage, payment_hash, payment_secret) = get_payment_preimage_hash!(&nodes[3]);
8806 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
8807 let mut route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[3].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
8808 let path = route.paths[0].clone();
8809 route.paths.push(path);
8810 route.paths[0][0].pubkey = nodes[1].node.get_our_node_id();
8811 route.paths[0][0].short_channel_id = chan_1_id;
8812 route.paths[0][1].short_channel_id = chan_3_id;
8813 route.paths[1][0].pubkey = nodes[2].node.get_our_node_id();
8814 route.paths[1][0].short_channel_id = chan_2_id;
8815 route.paths[1][1].short_channel_id = chan_4_id;
8816 send_along_route_with_secret(&nodes[0], route, &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], 200_000, payment_hash, payment_secret);
8817 claim_payment_along_route(&nodes[0], &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], false, payment_preimage);
8821 fn test_preimage_storage() {
8822 // Simple test of payment preimage storage allowing no client-side storage to claim payments
8823 let chanmon_cfgs = create_chanmon_cfgs(2);
8824 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8825 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8826 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8828 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8831 let (payment_hash, payment_secret) = nodes[1].node.create_inbound_payment(Some(100_000), 7200, 42);
8833 let logger = test_utils::TestLogger::new();
8834 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
8835 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100_000, TEST_FINAL_CLTV, &logger).unwrap();
8836 nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
8837 check_added_monitors!(nodes[0], 1);
8838 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
8839 let mut payment_event = SendEvent::from_event(events.pop().unwrap());
8840 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
8841 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
8843 // Note that after leaving the above scope we have no knowledge of any arguments or return
8844 // values from previous calls.
8845 expect_pending_htlcs_forwardable!(nodes[1]);
8846 let events = nodes[1].node.get_and_clear_pending_events();
8847 assert_eq!(events.len(), 1);
8849 Event::PaymentReceived { ref purpose, .. } => {
8851 PaymentPurpose::InvoicePayment { payment_preimage, user_payment_id, .. } => {
8852 assert_eq!(*user_payment_id, 42);
8853 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage.unwrap());
8855 _ => panic!("expected PaymentPurpose::InvoicePayment")
8858 _ => panic!("Unexpected event"),
8863 fn test_secret_timeout() {
8864 // Simple test of payment secret storage time outs
8865 let chanmon_cfgs = create_chanmon_cfgs(2);
8866 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8867 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8868 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8870 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8872 let (payment_hash, payment_secret_1) = nodes[1].node.create_inbound_payment(Some(100_000), 2, 0);
8874 // We should fail to register the same payment hash twice, at least until we've connected a
8875 // block with time 7200 + CHAN_CONFIRM_DEPTH + 1.
8876 if let Err(APIError::APIMisuseError { err }) = nodes[1].node.create_inbound_payment_for_hash(payment_hash, Some(100_000), 2, 0) {
8877 assert_eq!(err, "Duplicate payment hash");
8878 } else { panic!(); }
8880 let node_1_blocks = nodes[1].blocks.lock().unwrap();
8882 header: BlockHeader {
8884 prev_blockhash: node_1_blocks.last().unwrap().0.block_hash(),
8885 merkle_root: Default::default(),
8886 time: node_1_blocks.len() as u32 + 7200, bits: 42, nonce: 42 },
8890 connect_block(&nodes[1], &block);
8891 if let Err(APIError::APIMisuseError { err }) = nodes[1].node.create_inbound_payment_for_hash(payment_hash, Some(100_000), 2, 0) {
8892 assert_eq!(err, "Duplicate payment hash");
8893 } else { panic!(); }
8895 // If we then connect the second block, we should be able to register the same payment hash
8896 // again with a different user_payment_id (this time getting a new payment secret).
8897 block.header.prev_blockhash = block.header.block_hash();
8898 block.header.time += 1;
8899 connect_block(&nodes[1], &block);
8900 let our_payment_secret = nodes[1].node.create_inbound_payment_for_hash(payment_hash, Some(100_000), 2, 42).unwrap();
8901 assert_ne!(payment_secret_1, our_payment_secret);
8904 let logger = test_utils::TestLogger::new();
8905 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
8906 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100_000, TEST_FINAL_CLTV, &logger).unwrap();
8907 nodes[0].node.send_payment(&route, payment_hash, &Some(our_payment_secret)).unwrap();
8908 check_added_monitors!(nodes[0], 1);
8909 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
8910 let mut payment_event = SendEvent::from_event(events.pop().unwrap());
8911 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
8912 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
8914 // Note that after leaving the above scope we have no knowledge of any arguments or return
8915 // values from previous calls.
8916 expect_pending_htlcs_forwardable!(nodes[1]);
8917 let events = nodes[1].node.get_and_clear_pending_events();
8918 assert_eq!(events.len(), 1);
8920 Event::PaymentReceived { purpose: PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, user_payment_id }, .. } => {
8921 assert!(payment_preimage.is_none());
8922 assert_eq!(user_payment_id, 42);
8923 assert_eq!(payment_secret, our_payment_secret);
8924 // We don't actually have the payment preimage with which to claim this payment!
8926 _ => panic!("Unexpected event"),
8931 fn test_bad_secret_hash() {
8932 // Simple test of unregistered payment hash/invalid payment secret handling
8933 let chanmon_cfgs = create_chanmon_cfgs(2);
8934 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8935 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8936 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8938 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8940 let random_payment_hash = PaymentHash([42; 32]);
8941 let random_payment_secret = PaymentSecret([43; 32]);
8942 let (our_payment_hash, our_payment_secret) = nodes[1].node.create_inbound_payment(Some(100_000), 2, 0);
8944 let logger = test_utils::TestLogger::new();
8945 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
8946 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100_000, TEST_FINAL_CLTV, &logger).unwrap();
8948 // All the below cases should end up being handled exactly identically, so we macro the
8949 // resulting events.
8950 macro_rules! handle_unknown_invalid_payment_data {
8952 check_added_monitors!(nodes[0], 1);
8953 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
8954 let payment_event = SendEvent::from_event(events.pop().unwrap());
8955 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
8956 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
8958 // We have to forward pending HTLCs once to process the receipt of the HTLC and then
8959 // again to process the pending backwards-failure of the HTLC
8960 expect_pending_htlcs_forwardable!(nodes[1]);
8961 expect_pending_htlcs_forwardable!(nodes[1]);
8962 check_added_monitors!(nodes[1], 1);
8964 // We should fail the payment back
8965 let mut events = nodes[1].node.get_and_clear_pending_msg_events();
8966 match events.pop().unwrap() {
8967 MessageSendEvent::UpdateHTLCs { node_id: _, updates: msgs::CommitmentUpdate { update_fail_htlcs, commitment_signed, .. } } => {
8968 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
8969 commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false);
8971 _ => panic!("Unexpected event"),
8976 let expected_error_code = 0x4000|15; // incorrect_or_unknown_payment_details
8977 // Error data is the HTLC value (100,000) and current block height
8978 let expected_error_data = [0, 0, 0, 0, 0, 1, 0x86, 0xa0, 0, 0, 0, CHAN_CONFIRM_DEPTH as u8];
8980 // Send a payment with the right payment hash but the wrong payment secret
8981 nodes[0].node.send_payment(&route, our_payment_hash, &Some(random_payment_secret)).unwrap();
8982 handle_unknown_invalid_payment_data!();
8983 expect_payment_failed!(nodes[0], our_payment_hash, true, expected_error_code, expected_error_data);
8985 // Send a payment with a random payment hash, but the right payment secret
8986 nodes[0].node.send_payment(&route, random_payment_hash, &Some(our_payment_secret)).unwrap();
8987 handle_unknown_invalid_payment_data!();
8988 expect_payment_failed!(nodes[0], random_payment_hash, true, expected_error_code, expected_error_data);
8990 // Send a payment with a random payment hash and random payment secret
8991 nodes[0].node.send_payment(&route, random_payment_hash, &Some(random_payment_secret)).unwrap();
8992 handle_unknown_invalid_payment_data!();
8993 expect_payment_failed!(nodes[0], random_payment_hash, true, expected_error_code, expected_error_data);
8997 fn test_update_err_monitor_lockdown() {
8998 // Our monitor will lock update of local commitment transaction if a broadcastion condition
8999 // has been fulfilled (either force-close from Channel or block height requiring a HTLC-
9000 // timeout). Trying to update monitor after lockdown should return a ChannelMonitorUpdateErr.
9002 // This scenario may happen in a watchtower setup, where watchtower process a block height
9003 // triggering a timeout while a slow-block-processing ChannelManager receives a local signed
9004 // commitment at same time.
9006 let chanmon_cfgs = create_chanmon_cfgs(2);
9007 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
9008 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
9009 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
9011 // Create some initial channel
9012 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
9013 let outpoint = OutPoint { txid: chan_1.3.txid(), index: 0 };
9015 // Rebalance the network to generate htlc in the two directions
9016 send_payment(&nodes[0], &vec!(&nodes[1])[..], 10_000_000);
9018 // Route a HTLC from node 0 to node 1 (but don't settle)
9019 let preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000).0;
9021 // Copy ChainMonitor to simulate a watchtower and update block height of node 0 until its ChannelMonitor timeout HTLC onchain
9022 let chain_source = test_utils::TestChainSource::new(Network::Testnet);
9023 let logger = test_utils::TestLogger::with_id(format!("node {}", 0));
9024 let persister = test_utils::TestPersister::new();
9026 let monitors = nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap();
9027 let monitor = monitors.get(&outpoint).unwrap();
9028 let mut w = test_utils::TestVecWriter(Vec::new());
9029 monitor.write(&mut w).unwrap();
9030 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingSigner>)>::read(
9031 &mut io::Cursor::new(&w.0), &test_utils::OnlyReadsKeysInterface {}).unwrap().1;
9032 assert!(new_monitor == *monitor);
9033 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);
9034 assert!(watchtower.watch_channel(outpoint, new_monitor).is_ok());
9037 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
9038 // Make the tx_broadcaster aware of enough blocks that it doesn't think we're violating
9039 // transaction lock time requirements here.
9040 chanmon_cfgs[0].tx_broadcaster.blocks.lock().unwrap().resize(200, (header, 0));
9041 watchtower.chain_monitor.block_connected(&Block { header, txdata: vec![] }, 200);
9043 // Try to update ChannelMonitor
9044 assert!(nodes[1].node.claim_funds(preimage));
9045 check_added_monitors!(nodes[1], 1);
9046 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
9047 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
9048 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
9049 if let Some(ref mut channel) = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan_1.2) {
9050 if let Ok((_, _, update)) = channel.commitment_signed(&updates.commitment_signed, &node_cfgs[0].logger) {
9051 if let Err(_) = watchtower.chain_monitor.update_channel(outpoint, update.clone()) {} else { assert!(false); }
9052 if let Ok(_) = nodes[0].chain_monitor.update_channel(outpoint, update) {} else { assert!(false); }
9053 } else { assert!(false); }
9054 } else { assert!(false); };
9055 // Our local monitor is in-sync and hasn't processed yet timeout
9056 check_added_monitors!(nodes[0], 1);
9057 let events = nodes[0].node.get_and_clear_pending_events();
9058 assert_eq!(events.len(), 1);
9062 fn test_concurrent_monitor_claim() {
9063 // Watchtower A receives block, broadcasts state N, then channel receives new state N+1,
9064 // sending it to both watchtowers, Bob accepts N+1, then receives block and broadcasts
9065 // the latest state N+1, Alice rejects state N+1, but Bob has already broadcast it,
9066 // state N+1 confirms. Alice claims output from state N+1.
9068 let chanmon_cfgs = create_chanmon_cfgs(2);
9069 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
9070 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
9071 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
9073 // Create some initial channel
9074 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
9075 let outpoint = OutPoint { txid: chan_1.3.txid(), index: 0 };
9077 // Rebalance the network to generate htlc in the two directions
9078 send_payment(&nodes[0], &vec!(&nodes[1])[..], 10_000_000);
9080 // Route a HTLC from node 0 to node 1 (but don't settle)
9081 route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000).0;
9083 // Copy ChainMonitor to simulate watchtower Alice and update block height her ChannelMonitor timeout HTLC onchain
9084 let chain_source = test_utils::TestChainSource::new(Network::Testnet);
9085 let logger = test_utils::TestLogger::with_id(format!("node {}", "Alice"));
9086 let persister = test_utils::TestPersister::new();
9087 let watchtower_alice = {
9088 let monitors = nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap();
9089 let monitor = monitors.get(&outpoint).unwrap();
9090 let mut w = test_utils::TestVecWriter(Vec::new());
9091 monitor.write(&mut w).unwrap();
9092 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingSigner>)>::read(
9093 &mut io::Cursor::new(&w.0), &test_utils::OnlyReadsKeysInterface {}).unwrap().1;
9094 assert!(new_monitor == *monitor);
9095 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);
9096 assert!(watchtower.watch_channel(outpoint, new_monitor).is_ok());
9099 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
9100 // Make the tx_broadcaster aware of enough blocks that it doesn't think we're violating
9101 // transaction lock time requirements here.
9102 chanmon_cfgs[0].tx_broadcaster.blocks.lock().unwrap().resize((CHAN_CONFIRM_DEPTH + 1 + TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS) as usize, (header, 0));
9103 watchtower_alice.chain_monitor.block_connected(&Block { header, txdata: vec![] }, CHAN_CONFIRM_DEPTH + 1 + TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS);
9105 // Watchtower Alice should have broadcast a commitment/HTLC-timeout
9107 let mut txn = chanmon_cfgs[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
9108 assert_eq!(txn.len(), 2);
9112 // Copy ChainMonitor to simulate watchtower Bob and make it receive a commitment update first.
9113 let chain_source = test_utils::TestChainSource::new(Network::Testnet);
9114 let logger = test_utils::TestLogger::with_id(format!("node {}", "Bob"));
9115 let persister = test_utils::TestPersister::new();
9116 let watchtower_bob = {
9117 let monitors = nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap();
9118 let monitor = monitors.get(&outpoint).unwrap();
9119 let mut w = test_utils::TestVecWriter(Vec::new());
9120 monitor.write(&mut w).unwrap();
9121 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingSigner>)>::read(
9122 &mut io::Cursor::new(&w.0), &test_utils::OnlyReadsKeysInterface {}).unwrap().1;
9123 assert!(new_monitor == *monitor);
9124 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);
9125 assert!(watchtower.watch_channel(outpoint, new_monitor).is_ok());
9128 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
9129 watchtower_bob.chain_monitor.block_connected(&Block { header, txdata: vec![] }, CHAN_CONFIRM_DEPTH + TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS);
9131 // Route another payment to generate another update with still previous HTLC pending
9132 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[0]);
9134 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
9135 let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[0].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 3000000 , TEST_FINAL_CLTV, &logger).unwrap();
9136 nodes[1].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
9138 check_added_monitors!(nodes[1], 1);
9140 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
9141 assert_eq!(updates.update_add_htlcs.len(), 1);
9142 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &updates.update_add_htlcs[0]);
9143 if let Some(ref mut channel) = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan_1.2) {
9144 if let Ok((_, _, update)) = channel.commitment_signed(&updates.commitment_signed, &node_cfgs[0].logger) {
9145 // Watchtower Alice should already have seen the block and reject the update
9146 if let Err(_) = watchtower_alice.chain_monitor.update_channel(outpoint, update.clone()) {} else { assert!(false); }
9147 if let Ok(_) = watchtower_bob.chain_monitor.update_channel(outpoint, update.clone()) {} else { assert!(false); }
9148 if let Ok(_) = nodes[0].chain_monitor.update_channel(outpoint, update) {} else { assert!(false); }
9149 } else { assert!(false); }
9150 } else { assert!(false); };
9151 // Our local monitor is in-sync and hasn't processed yet timeout
9152 check_added_monitors!(nodes[0], 1);
9154 //// Provide one more block to watchtower Bob, expect broadcast of commitment and HTLC-Timeout
9155 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
9156 watchtower_bob.chain_monitor.block_connected(&Block { header, txdata: vec![] }, CHAN_CONFIRM_DEPTH + 1 + TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS);
9158 // Watchtower Bob should have broadcast a commitment/HTLC-timeout
9161 let mut txn = chanmon_cfgs[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
9162 assert_eq!(txn.len(), 2);
9163 bob_state_y = txn[0].clone();
9167 // We confirm Bob's state Y on Alice, she should broadcast a HTLC-timeout
9168 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
9169 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);
9171 let htlc_txn = chanmon_cfgs[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
9172 // We broadcast twice the transaction, once due to the HTLC-timeout, once due
9173 // the onchain detection of the HTLC output
9174 assert_eq!(htlc_txn.len(), 2);
9175 check_spends!(htlc_txn[0], bob_state_y);
9176 check_spends!(htlc_txn[1], bob_state_y);
9181 fn test_pre_lockin_no_chan_closed_update() {
9182 // Test that if a peer closes a channel in response to a funding_created message we don't
9183 // generate a channel update (as the channel cannot appear on chain without a funding_signed
9186 // Doing so would imply a channel monitor update before the initial channel monitor
9187 // registration, violating our API guarantees.
9189 // Previously, full_stack_target managed to hit this case by opening then closing a channel,
9190 // then opening a second channel with the same funding output as the first (which is not
9191 // rejected because the first channel does not exist in the ChannelManager) and closing it
9192 // before receiving funding_signed.
9193 let chanmon_cfgs = create_chanmon_cfgs(2);
9194 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
9195 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
9196 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
9198 // Create an initial channel
9199 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
9200 let mut open_chan_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
9201 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_msg);
9202 let accept_chan_msg = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
9203 nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &accept_chan_msg);
9205 // Move the first channel through the funding flow...
9206 let (temporary_channel_id, tx, _) = create_funding_transaction(&nodes[0], 100000, 42);
9208 nodes[0].node.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
9209 check_added_monitors!(nodes[0], 0);
9211 let funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
9212 let channel_id = ::chain::transaction::OutPoint { txid: funding_created_msg.funding_txid, index: funding_created_msg.funding_output_index }.to_channel_id();
9213 nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msgs::ErrorMessage { channel_id, data: "Hi".to_owned() });
9214 assert!(nodes[0].chain_monitor.added_monitors.lock().unwrap().is_empty());
9218 fn test_htlc_no_detection() {
9219 // This test is a mutation to underscore the detection logic bug we had
9220 // before #653. HTLC value routed is above the remaining balance, thus
9221 // inverting HTLC and `to_remote` output. HTLC will come second and
9222 // it wouldn't be seen by pre-#653 detection as we were enumerate()'ing
9223 // on a watched outputs vector (Vec<TxOut>) thus implicitly relying on
9224 // outputs order detection for correct spending children filtring.
9226 let chanmon_cfgs = create_chanmon_cfgs(2);
9227 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
9228 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
9229 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
9231 // Create some initial channels
9232 let chan_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
9234 send_payment(&nodes[0], &vec!(&nodes[1])[..], 1_000_000);
9235 let (_, our_payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 2_000_000);
9236 let local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
9237 assert_eq!(local_txn[0].input.len(), 1);
9238 assert_eq!(local_txn[0].output.len(), 3);
9239 check_spends!(local_txn[0], chan_1.3);
9241 // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
9242 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
9243 connect_block(&nodes[0], &Block { header, txdata: vec![local_txn[0].clone()] });
9244 // We deliberately connect the local tx twice as this should provoke a failure calling
9245 // this test before #653 fix.
9246 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);
9247 check_closed_broadcast!(nodes[0], true);
9248 check_added_monitors!(nodes[0], 1);
9249 connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1);
9251 let htlc_timeout = {
9252 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
9253 assert_eq!(node_txn[1].input.len(), 1);
9254 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
9255 check_spends!(node_txn[1], local_txn[0]);
9259 let header_201 = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
9260 connect_block(&nodes[0], &Block { header: header_201, txdata: vec![htlc_timeout.clone()] });
9261 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
9262 expect_payment_failed!(nodes[0], our_payment_hash, true);
9265 fn do_test_onchain_htlc_settlement_after_close(broadcast_alice: bool, go_onchain_before_fulfill: bool) {
9266 // If we route an HTLC, then learn the HTLC's preimage after the upstream channel has been
9267 // force-closed, we must claim that HTLC on-chain. (Given an HTLC forwarded from Alice --> Bob -->
9268 // Carol, Alice would be the upstream node, and Carol the downstream.)
9270 // Steps of the test:
9271 // 1) Alice sends a HTLC to Carol through Bob.
9272 // 2) Carol doesn't settle the HTLC.
9273 // 3) If broadcast_alice is true, Alice force-closes her channel with Bob. Else Bob force closes.
9274 // Steps 4 and 5 may be reordered depending on go_onchain_before_fulfill.
9275 // 4) Bob sees the Alice's commitment on his chain or vice versa. An offered output is present
9276 // but can't be claimed as Bob doesn't have yet knowledge of the preimage.
9277 // 5) Carol release the preimage to Bob off-chain.
9278 // 6) Bob claims the offered output on the broadcasted commitment.
9279 let chanmon_cfgs = create_chanmon_cfgs(3);
9280 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
9281 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
9282 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
9284 // Create some initial channels
9285 let chan_ab = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
9286 create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 100000, 10001, InitFeatures::known(), InitFeatures::known());
9288 // Steps (1) and (2):
9289 // Send an HTLC Alice --> Bob --> Carol, but Carol doesn't settle the HTLC back.
9290 let (payment_preimage, _payment_hash, _payment_secret) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3_000_000);
9292 // Check that Alice's commitment transaction now contains an output for this HTLC.
9293 let alice_txn = get_local_commitment_txn!(nodes[0], chan_ab.2);
9294 check_spends!(alice_txn[0], chan_ab.3);
9295 assert_eq!(alice_txn[0].output.len(), 2);
9296 check_spends!(alice_txn[1], alice_txn[0]); // 2nd transaction is a non-final HTLC-timeout
9297 assert_eq!(alice_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
9298 assert_eq!(alice_txn.len(), 2);
9300 // Steps (3) and (4):
9301 // If `go_onchain_before_fufill`, broadcast the relevant commitment transaction and check that Bob
9302 // responds by (1) broadcasting a channel update and (2) adding a new ChannelMonitor.
9303 let mut force_closing_node = 0; // Alice force-closes
9304 if !broadcast_alice { force_closing_node = 1; } // Bob force-closes
9305 nodes[force_closing_node].node.force_close_channel(&chan_ab.2).unwrap();
9306 check_closed_broadcast!(nodes[force_closing_node], true);
9307 check_added_monitors!(nodes[force_closing_node], 1);
9308 if go_onchain_before_fulfill {
9309 let txn_to_broadcast = match broadcast_alice {
9310 true => alice_txn.clone(),
9311 false => get_local_commitment_txn!(nodes[1], chan_ab.2)
9313 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
9314 connect_block(&nodes[1], &Block { header, txdata: vec![txn_to_broadcast[0].clone()]});
9315 let mut bob_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
9316 if broadcast_alice {
9317 check_closed_broadcast!(nodes[1], true);
9318 check_added_monitors!(nodes[1], 1);
9320 assert_eq!(bob_txn.len(), 1);
9321 check_spends!(bob_txn[0], chan_ab.3);
9325 // Carol then claims the funds and sends an update_fulfill message to Bob, and they go through the
9326 // process of removing the HTLC from their commitment transactions.
9327 assert!(nodes[2].node.claim_funds(payment_preimage));
9328 check_added_monitors!(nodes[2], 1);
9329 let carol_updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
9330 assert!(carol_updates.update_add_htlcs.is_empty());
9331 assert!(carol_updates.update_fail_htlcs.is_empty());
9332 assert!(carol_updates.update_fail_malformed_htlcs.is_empty());
9333 assert!(carol_updates.update_fee.is_none());
9334 assert_eq!(carol_updates.update_fulfill_htlcs.len(), 1);
9336 nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &carol_updates.update_fulfill_htlcs[0]);
9337 expect_payment_forwarded!(nodes[1], if go_onchain_before_fulfill || force_closing_node == 1 { None } else { Some(1000) }, false);
9338 // If Alice broadcasted but Bob doesn't know yet, here he prepares to tell her about the preimage.
9339 if !go_onchain_before_fulfill && broadcast_alice {
9340 let events = nodes[1].node.get_and_clear_pending_msg_events();
9341 assert_eq!(events.len(), 1);
9343 MessageSendEvent::UpdateHTLCs { ref node_id, .. } => {
9344 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
9346 _ => panic!("Unexpected event"),
9349 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &carol_updates.commitment_signed);
9350 // One monitor update for the preimage to update the Bob<->Alice channel, one monitor update
9351 // Carol<->Bob's updated commitment transaction info.
9352 check_added_monitors!(nodes[1], 2);
9354 let events = nodes[1].node.get_and_clear_pending_msg_events();
9355 assert_eq!(events.len(), 2);
9356 let bob_revocation = match events[0] {
9357 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
9358 assert_eq!(*node_id, nodes[2].node.get_our_node_id());
9361 _ => panic!("Unexpected event"),
9363 let bob_updates = match events[1] {
9364 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
9365 assert_eq!(*node_id, nodes[2].node.get_our_node_id());
9368 _ => panic!("Unexpected event"),
9371 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bob_revocation);
9372 check_added_monitors!(nodes[2], 1);
9373 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bob_updates.commitment_signed);
9374 check_added_monitors!(nodes[2], 1);
9376 let events = nodes[2].node.get_and_clear_pending_msg_events();
9377 assert_eq!(events.len(), 1);
9378 let carol_revocation = match events[0] {
9379 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
9380 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
9383 _ => panic!("Unexpected event"),
9385 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &carol_revocation);
9386 check_added_monitors!(nodes[1], 1);
9388 // If this test requires the force-closed channel to not be on-chain until after the fulfill,
9389 // here's where we put said channel's commitment tx on-chain.
9390 let mut txn_to_broadcast = alice_txn.clone();
9391 if !broadcast_alice { txn_to_broadcast = get_local_commitment_txn!(nodes[1], chan_ab.2); }
9392 if !go_onchain_before_fulfill {
9393 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
9394 connect_block(&nodes[1], &Block { header, txdata: vec![txn_to_broadcast[0].clone()]});
9395 // If Bob was the one to force-close, he will have already passed these checks earlier.
9396 if broadcast_alice {
9397 check_closed_broadcast!(nodes[1], true);
9398 check_added_monitors!(nodes[1], 1);
9400 let mut bob_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
9401 if broadcast_alice {
9402 // In `connect_block()`, the ChainMonitor and ChannelManager are separately notified about a
9403 // new block being connected. The ChannelManager being notified triggers a monitor update,
9404 // which triggers broadcasting our commitment tx and an HTLC-claiming tx. The ChainMonitor
9405 // being notified triggers the HTLC-claiming tx redundantly, resulting in 3 total txs being
9407 assert_eq!(bob_txn.len(), 3);
9408 check_spends!(bob_txn[1], chan_ab.3);
9410 assert_eq!(bob_txn.len(), 2);
9411 check_spends!(bob_txn[0], chan_ab.3);
9416 // Finally, check that Bob broadcasted a preimage-claiming transaction for the HTLC output on the
9417 // broadcasted commitment transaction.
9419 let bob_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
9420 if go_onchain_before_fulfill {
9421 // Bob should now have an extra broadcasted tx, for the preimage-claiming transaction.
9422 assert_eq!(bob_txn.len(), 2);
9424 let script_weight = match broadcast_alice {
9425 true => OFFERED_HTLC_SCRIPT_WEIGHT,
9426 false => ACCEPTED_HTLC_SCRIPT_WEIGHT
9428 // If Alice force-closed and Bob didn't receive her commitment transaction until after he
9429 // received Carol's fulfill, he broadcasts the HTLC-output-claiming transaction first. Else if
9430 // Bob force closed or if he found out about Alice's commitment tx before receiving Carol's
9431 // fulfill, then he broadcasts the HTLC-output-claiming transaction second.
9432 if broadcast_alice && !go_onchain_before_fulfill {
9433 check_spends!(bob_txn[0], txn_to_broadcast[0]);
9434 assert_eq!(bob_txn[0].input[0].witness.last().unwrap().len(), script_weight);
9436 check_spends!(bob_txn[1], txn_to_broadcast[0]);
9437 assert_eq!(bob_txn[1].input[0].witness.last().unwrap().len(), script_weight);
9443 fn test_onchain_htlc_settlement_after_close() {
9444 do_test_onchain_htlc_settlement_after_close(true, true);
9445 do_test_onchain_htlc_settlement_after_close(false, true); // Technically redundant, but may as well
9446 do_test_onchain_htlc_settlement_after_close(true, false);
9447 do_test_onchain_htlc_settlement_after_close(false, false);
9451 fn test_duplicate_chan_id() {
9452 // Test that if a given peer tries to open a channel with the same channel_id as one that is
9453 // already open we reject it and keep the old channel.
9455 // Previously, full_stack_target managed to figure out that if you tried to open two channels
9456 // with the same funding output (ie post-funding channel_id), we'd create a monitor update for
9457 // the existing channel when we detect the duplicate new channel, screwing up our monitor
9458 // updating logic for the existing channel.
9459 let chanmon_cfgs = create_chanmon_cfgs(2);
9460 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
9461 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
9462 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
9464 // Create an initial channel
9465 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
9466 let mut open_chan_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
9467 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_msg);
9468 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()));
9470 // Try to create a second channel with the same temporary_channel_id as the first and check
9471 // that it is rejected.
9472 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_msg);
9474 let events = nodes[1].node.get_and_clear_pending_msg_events();
9475 assert_eq!(events.len(), 1);
9477 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
9478 // Technically, at this point, nodes[1] would be justified in thinking both the
9479 // first (valid) and second (invalid) channels are closed, given they both have
9480 // the same non-temporary channel_id. However, currently we do not, so we just
9481 // move forward with it.
9482 assert_eq!(msg.channel_id, open_chan_msg.temporary_channel_id);
9483 assert_eq!(node_id, nodes[0].node.get_our_node_id());
9485 _ => panic!("Unexpected event"),
9489 // Move the first channel through the funding flow...
9490 let (temporary_channel_id, tx, funding_output) = create_funding_transaction(&nodes[0], 100000, 42);
9492 nodes[0].node.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
9493 check_added_monitors!(nodes[0], 0);
9495 let mut funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
9496 nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created_msg);
9498 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
9499 assert_eq!(added_monitors.len(), 1);
9500 assert_eq!(added_monitors[0].0, funding_output);
9501 added_monitors.clear();
9503 let funding_signed_msg = get_event_msg!(nodes[1], MessageSendEvent::SendFundingSigned, nodes[0].node.get_our_node_id());
9505 let funding_outpoint = ::chain::transaction::OutPoint { txid: funding_created_msg.funding_txid, index: funding_created_msg.funding_output_index };
9506 let channel_id = funding_outpoint.to_channel_id();
9508 // Now we have the first channel past funding_created (ie it has a txid-based channel_id, not a
9511 // First try to open a second channel with a temporary channel id equal to the txid-based one.
9512 // Technically this is allowed by the spec, but we don't support it and there's little reason
9513 // to. Still, it shouldn't cause any other issues.
9514 open_chan_msg.temporary_channel_id = channel_id;
9515 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_msg);
9517 let events = nodes[1].node.get_and_clear_pending_msg_events();
9518 assert_eq!(events.len(), 1);
9520 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
9521 // Technically, at this point, nodes[1] would be justified in thinking both
9522 // channels are closed, but currently we do not, so we just move forward with it.
9523 assert_eq!(msg.channel_id, open_chan_msg.temporary_channel_id);
9524 assert_eq!(node_id, nodes[0].node.get_our_node_id());
9526 _ => panic!("Unexpected event"),
9530 // Now try to create a second channel which has a duplicate funding output.
9531 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
9532 let open_chan_2_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
9533 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_2_msg);
9534 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()));
9535 create_funding_transaction(&nodes[0], 100000, 42); // Get and check the FundingGenerationReady event
9537 let funding_created = {
9538 let mut a_channel_lock = nodes[0].node.channel_state.lock().unwrap();
9539 let mut as_chan = a_channel_lock.by_id.get_mut(&open_chan_2_msg.temporary_channel_id).unwrap();
9540 let logger = test_utils::TestLogger::new();
9541 as_chan.get_outbound_funding_created(tx.clone(), funding_outpoint, &&logger).unwrap()
9543 check_added_monitors!(nodes[0], 0);
9544 nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created);
9545 // At this point we'll try to add a duplicate channel monitor, which will be rejected, but
9546 // still needs to be cleared here.
9547 check_added_monitors!(nodes[1], 1);
9549 // ...still, nodes[1] will reject the duplicate channel.
9551 let events = nodes[1].node.get_and_clear_pending_msg_events();
9552 assert_eq!(events.len(), 1);
9554 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
9555 // Technically, at this point, nodes[1] would be justified in thinking both
9556 // channels are closed, but currently we do not, so we just move forward with it.
9557 assert_eq!(msg.channel_id, channel_id);
9558 assert_eq!(node_id, nodes[0].node.get_our_node_id());
9560 _ => panic!("Unexpected event"),
9564 // finally, finish creating the original channel and send a payment over it to make sure
9565 // everything is functional.
9566 nodes[0].node.handle_funding_signed(&nodes[1].node.get_our_node_id(), &funding_signed_msg);
9568 let mut added_monitors = nodes[0].chain_monitor.added_monitors.lock().unwrap();
9569 assert_eq!(added_monitors.len(), 1);
9570 assert_eq!(added_monitors[0].0, funding_output);
9571 added_monitors.clear();
9574 let events_4 = nodes[0].node.get_and_clear_pending_events();
9575 assert_eq!(events_4.len(), 0);
9576 assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
9577 assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0].txid(), funding_output.txid);
9579 let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
9580 let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
9581 update_nodes_with_chan_announce(&nodes, 0, 1, &announcement, &as_update, &bs_update);
9582 send_payment(&nodes[0], &[&nodes[1]], 8000000);
9586 fn test_error_chans_closed() {
9587 // Test that we properly handle error messages, closing appropriate channels.
9589 // Prior to #787 we'd allow a peer to make us force-close a channel we had with a different
9590 // peer. The "real" fix for that is to index channels with peers_ids, however in the mean time
9591 // we can test various edge cases around it to ensure we don't regress.
9592 let chanmon_cfgs = create_chanmon_cfgs(3);
9593 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
9594 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
9595 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
9597 // Create some initial channels
9598 let chan_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
9599 let chan_2 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
9600 let chan_3 = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 100000, 10001, InitFeatures::known(), InitFeatures::known());
9602 assert_eq!(nodes[0].node.list_usable_channels().len(), 3);
9603 assert_eq!(nodes[1].node.list_usable_channels().len(), 2);
9604 assert_eq!(nodes[2].node.list_usable_channels().len(), 1);
9606 // Closing a channel from a different peer has no effect
9607 nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msgs::ErrorMessage { channel_id: chan_3.2, data: "ERR".to_owned() });
9608 assert_eq!(nodes[0].node.list_usable_channels().len(), 3);
9610 // Closing one channel doesn't impact others
9611 nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msgs::ErrorMessage { channel_id: chan_2.2, data: "ERR".to_owned() });
9612 check_added_monitors!(nodes[0], 1);
9613 check_closed_broadcast!(nodes[0], false);
9614 assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0).len(), 1);
9615 assert_eq!(nodes[0].node.list_usable_channels().len(), 2);
9616 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);
9617 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);
9619 // A null channel ID should close all channels
9620 let _chan_4 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
9621 nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msgs::ErrorMessage { channel_id: [0; 32], data: "ERR".to_owned() });
9622 check_added_monitors!(nodes[0], 2);
9623 let events = nodes[0].node.get_and_clear_pending_msg_events();
9624 assert_eq!(events.len(), 2);
9626 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
9627 assert_eq!(msg.contents.flags & 2, 2);
9629 _ => panic!("Unexpected event"),
9632 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
9633 assert_eq!(msg.contents.flags & 2, 2);
9635 _ => panic!("Unexpected event"),
9637 // Note that at this point users of a standard PeerHandler will end up calling
9638 // peer_disconnected with no_connection_possible set to false, duplicating the
9639 // close-all-channels logic. That's OK, we don't want to end up not force-closing channels for
9640 // users with their own peer handling logic. We duplicate the call here, however.
9641 assert_eq!(nodes[0].node.list_usable_channels().len(), 1);
9642 assert!(nodes[0].node.list_usable_channels()[0].channel_id == chan_3.2);
9644 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), true);
9645 assert_eq!(nodes[0].node.list_usable_channels().len(), 1);
9646 assert!(nodes[0].node.list_usable_channels()[0].channel_id == chan_3.2);
9650 fn test_invalid_funding_tx() {
9651 // Test that we properly handle invalid funding transactions sent to us from a peer.
9653 // Previously, all other major lightning implementations had failed to properly sanitize
9654 // funding transactions from their counterparties, leading to a multi-implementation critical
9655 // security vulnerability (though we always sanitized properly, we've previously had
9656 // un-released crashes in the sanitization process).
9657 let chanmon_cfgs = create_chanmon_cfgs(2);
9658 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
9659 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
9660 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
9662 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100_000, 10_000, 42, None).unwrap();
9663 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()));
9664 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()));
9666 let (temporary_channel_id, mut tx, _) = create_funding_transaction(&nodes[0], 100_000, 42);
9667 for output in tx.output.iter_mut() {
9668 // Make the confirmed funding transaction have a bogus script_pubkey
9669 output.script_pubkey = bitcoin::Script::new();
9672 nodes[0].node.funding_transaction_generated_unchecked(&temporary_channel_id, tx.clone(), 0).unwrap();
9673 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()));
9674 check_added_monitors!(nodes[1], 1);
9676 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()));
9677 check_added_monitors!(nodes[0], 1);
9679 let events_1 = nodes[0].node.get_and_clear_pending_events();
9680 assert_eq!(events_1.len(), 0);
9682 assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
9683 assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0], tx);
9684 nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
9686 confirm_transaction_at(&nodes[1], &tx, 1);
9687 check_added_monitors!(nodes[1], 1);
9688 let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
9689 assert_eq!(events_2.len(), 1);
9690 if let MessageSendEvent::HandleError { node_id, action } = &events_2[0] {
9691 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
9692 if let msgs::ErrorAction::SendErrorMessage { msg } = action {
9693 assert_eq!(msg.data, "funding tx had wrong script/value or output index");
9694 } else { panic!(); }
9695 } else { panic!(); }
9696 assert_eq!(nodes[1].node.list_channels().len(), 0);
9699 fn do_test_tx_confirmed_skipping_blocks_immediate_broadcast(test_height_before_timelock: bool) {
9700 // In the first version of the chain::Confirm interface, after a refactor was made to not
9701 // broadcast CSV-locked transactions until their CSV lock is up, we wouldn't reliably broadcast
9702 // transactions after a `transactions_confirmed` call. Specifically, if the chain, provided via
9703 // `best_block_updated` is at height N, and a transaction output which we wish to spend at
9704 // height N-1 (due to a CSV to height N-1) is provided at height N, we will not broadcast the
9705 // spending transaction until height N+1 (or greater). This was due to the way
9706 // `ChannelMonitor::transactions_confirmed` worked, only checking if we should broadcast a
9707 // spending transaction at the height the input transaction was confirmed at, not whether we
9708 // should broadcast a spending transaction at the current height.
9709 // A second, similar, issue involved failing HTLCs backwards - because we only provided the
9710 // height at which transactions were confirmed to `OnchainTx::update_claims_view`, it wasn't
9711 // aware that the anti-reorg-delay had, in fact, already expired, waiting to fail-backwards
9712 // until we learned about an additional block.
9714 // As an additional check, if `test_height_before_timelock` is set, we instead test that we
9715 // aren't broadcasting transactions too early (ie not broadcasting them at all).
9716 let chanmon_cfgs = create_chanmon_cfgs(3);
9717 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
9718 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
9719 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
9720 *nodes[0].connect_style.borrow_mut() = ConnectStyle::BestBlockFirstSkippingBlocks;
9722 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
9723 let (chan_announce, _, channel_id, _) = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
9724 let (_, payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1_000_000);
9725 nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id(), false);
9726 nodes[2].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
9728 nodes[1].node.force_close_channel(&channel_id).unwrap();
9729 check_closed_broadcast!(nodes[1], true);
9730 check_added_monitors!(nodes[1], 1);
9731 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
9732 assert_eq!(node_txn.len(), 1);
9734 let conf_height = nodes[1].best_block_info().1;
9735 if !test_height_before_timelock {
9736 connect_blocks(&nodes[1], 24 * 6);
9738 nodes[1].chain_monitor.chain_monitor.transactions_confirmed(
9739 &nodes[1].get_block_header(conf_height), &[(0, &node_txn[0])], conf_height);
9740 if test_height_before_timelock {
9741 // If we confirmed the close transaction, but timelocks have not yet expired, we should not
9742 // generate any events or broadcast any transactions
9743 assert!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
9744 assert!(nodes[1].chain_monitor.chain_monitor.get_and_clear_pending_events().is_empty());
9746 // We should broadcast an HTLC transaction spending our funding transaction first
9747 let spending_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
9748 assert_eq!(spending_txn.len(), 2);
9749 assert_eq!(spending_txn[0], node_txn[0]);
9750 check_spends!(spending_txn[1], node_txn[0]);
9751 // We should also generate a SpendableOutputs event with the to_self output (as its
9753 let descriptor_spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
9754 assert_eq!(descriptor_spend_txn.len(), 1);
9756 // If we also discover that the HTLC-Timeout transaction was confirmed some time ago, we
9757 // should immediately fail-backwards the HTLC to the previous hop, without waiting for an
9758 // additional block built on top of the current chain.
9759 nodes[1].chain_monitor.chain_monitor.transactions_confirmed(
9760 &nodes[1].get_block_header(conf_height + 1), &[(0, &spending_txn[1])], conf_height + 1);
9761 expect_pending_htlcs_forwardable!(nodes[1]);
9762 check_added_monitors!(nodes[1], 1);
9764 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
9765 assert!(updates.update_add_htlcs.is_empty());
9766 assert!(updates.update_fulfill_htlcs.is_empty());
9767 assert_eq!(updates.update_fail_htlcs.len(), 1);
9768 assert!(updates.update_fail_malformed_htlcs.is_empty());
9769 assert!(updates.update_fee.is_none());
9770 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
9771 commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, true, true);
9772 expect_payment_failed!(nodes[0], payment_hash, false);
9773 expect_payment_failure_chan_update!(nodes[0], chan_announce.contents.short_channel_id, true);
9778 fn test_tx_confirmed_skipping_blocks_immediate_broadcast() {
9779 do_test_tx_confirmed_skipping_blocks_immediate_broadcast(false);
9780 do_test_tx_confirmed_skipping_blocks_immediate_broadcast(true);
9784 fn test_keysend_payments_to_public_node() {
9785 let chanmon_cfgs = create_chanmon_cfgs(2);
9786 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
9787 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
9788 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
9790 let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
9791 let network_graph = nodes[0].net_graph_msg_handler.network_graph.read().unwrap();
9792 let payer_pubkey = nodes[0].node.get_our_node_id();
9793 let payee_pubkey = nodes[1].node.get_our_node_id();
9794 let route = get_route(&payer_pubkey, &network_graph, &payee_pubkey, None,
9795 None, &vec![], 10000, 40,
9796 nodes[0].logger).unwrap();
9798 let test_preimage = PaymentPreimage([42; 32]);
9799 let payment_hash = nodes[0].node.send_spontaneous_payment(&route, Some(test_preimage)).unwrap();
9800 check_added_monitors!(nodes[0], 1);
9801 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
9802 assert_eq!(events.len(), 1);
9803 let event = events.pop().unwrap();
9804 let path = vec![&nodes[1]];
9805 pass_along_path(&nodes[0], &path, 10000, payment_hash, None, event, true, Some(test_preimage));
9806 claim_payment(&nodes[0], &path, test_preimage);
9810 fn test_keysend_payments_to_private_node() {
9811 let chanmon_cfgs = create_chanmon_cfgs(2);
9812 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
9813 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
9814 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
9816 let payer_pubkey = nodes[0].node.get_our_node_id();
9817 let payee_pubkey = nodes[1].node.get_our_node_id();
9818 nodes[0].node.peer_connected(&payee_pubkey, &msgs::Init { features: InitFeatures::known() });
9819 nodes[1].node.peer_connected(&payer_pubkey, &msgs::Init { features: InitFeatures::known() });
9821 let _chan = create_chan_between_nodes(&nodes[0], &nodes[1], InitFeatures::known(), InitFeatures::known());
9822 let network_graph = nodes[0].net_graph_msg_handler.network_graph.read().unwrap();
9823 let first_hops = nodes[0].node.list_usable_channels();
9824 let route = get_keysend_route(&payer_pubkey, &network_graph, &payee_pubkey,
9825 Some(&first_hops.iter().collect::<Vec<_>>()), &vec![], 10000, 40,
9826 nodes[0].logger).unwrap();
9828 let test_preimage = PaymentPreimage([42; 32]);
9829 let payment_hash = nodes[0].node.send_spontaneous_payment(&route, Some(test_preimage)).unwrap();
9830 check_added_monitors!(nodes[0], 1);
9831 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
9832 assert_eq!(events.len(), 1);
9833 let event = events.pop().unwrap();
9834 let path = vec![&nodes[1]];
9835 pass_along_path(&nodes[0], &path, 10000, payment_hash, None, event, true, Some(test_preimage));
9836 claim_payment(&nodes[0], &path, test_preimage);
9839 fn do_test_max_dust_htlc_exposure(dust_outbound_balance: bool, at_forward: bool, on_holder_tx: bool) {
9840 // Test that we properly reject dust HTLC violating our `max_dust_htlc_exposure_msat` policy.
9842 // At HTLC forward (`send_payment()`), if the sum of the trimmed-to-dust HTLC inbound and
9843 // trimmed-to-dust HTLC outbound balance and this new payment as included on next counterparty
9844 // commitment are above our `max_dust_htlc_exposure_msat`, we'll reject the update.
9845 // At HTLC reception (`update_add_htlc()`), if the sum of the trimmed-to-dust HTLC inbound
9846 // and trimmed-to-dust HTLC outbound balance and this new received HTLC as included on next
9847 // counterparty commitment are above our `max_dust_htlc_exposure_msat`, we'll fail the update.
9848 // Note, we return a `temporary_channel_failure` (0x1000 | 7), as the channel might be
9849 // available again for HTLC processing once the dust bandwidth has cleared up.
9851 let chanmon_cfgs = create_chanmon_cfgs(2);
9852 let mut config = test_default_channel_config();
9853 config.channel_options.max_dust_htlc_exposure_msat = 5_000_000; // default setting value
9854 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
9855 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, Some(config)]);
9856 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
9858 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 1_000_000, 500_000_000, 42, None).unwrap();
9859 let mut open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
9860 open_channel.max_htlc_value_in_flight_msat = 50_000_000;
9861 open_channel.max_accepted_htlcs = 60;
9862 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_channel);
9863 let mut accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
9865 accept_channel.dust_limit_satoshis = 660;
9867 nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &accept_channel);
9869 let (temporary_channel_id, tx, _) = create_funding_transaction(&nodes[0], 1_000_000, 42);
9872 if let Some(mut chan) = nodes[1].node.channel_state.lock().unwrap().by_id.get_mut(&temporary_channel_id) {
9873 chan.holder_dust_limit_satoshis = 660;
9877 nodes[0].node.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
9878 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()));
9879 check_added_monitors!(nodes[1], 1);
9881 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()));
9882 check_added_monitors!(nodes[0], 1);
9884 let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
9885 let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
9886 update_nodes_with_chan_announce(&nodes, 0, 1, &announcement, &as_update, &bs_update);
9889 if dust_outbound_balance {
9891 let (route, payment_hash, _, payment_secret) = get_route_and_payment_hash!(nodes[1], nodes[0], 2_300_000);
9892 if let Err(_) = nodes[1].node.send_payment(&route, payment_hash, &Some(payment_secret)) { panic!("Unexpected event at dust HTLC {}", i); }
9896 route_payment(&nodes[0], &[&nodes[1]], 2_300_000);
9900 if dust_outbound_balance {
9902 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
9903 if let Err(_) = nodes[1].node.send_payment(&route, payment_hash, &Some(payment_secret)) { panic!("Unexpected event at dust HTLC {}", i); }
9907 route_payment(&nodes[0], &[&nodes[1]], 200_000); // + 167_000 msat of HTLC-timeout tx at 253 sats/kWU
9913 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 });
9914 let mut config = UserConfig::default();
9916 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)));
9918 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)));
9921 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 });
9922 nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
9923 check_added_monitors!(nodes[0], 1);
9924 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
9925 assert_eq!(events.len(), 1);
9926 let payment_event = SendEvent::from_event(events.remove(0));
9927 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
9929 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);
9931 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);
9935 let _ = nodes[1].node.get_and_clear_pending_msg_events();
9936 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
9937 added_monitors.clear();
9941 fn test_max_dust_htlc_exposure() {
9942 do_test_max_dust_htlc_exposure(true, true, true);
9943 do_test_max_dust_htlc_exposure(false, true, true);
9944 do_test_max_dust_htlc_exposure(false, false, true);
9945 do_test_max_dust_htlc_exposure(false, false, false);
9946 do_test_max_dust_htlc_exposure(true, true, false);
9947 do_test_max_dust_htlc_exposure(true, false, false);
9948 do_test_max_dust_htlc_exposure(true, false, true);
9949 do_test_max_dust_htlc_exposure(false, true, false);