1 // This file is Copyright its original authors, visible in version control
4 // This file is licensed under the Apache License, Version 2.0 <LICENSE-APACHE
5 // or http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
6 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your option.
7 // You may not use this file except in accordance with one or both of these
10 //! Tests that test standing up a network of ChannelManagers, creating channels, sending
11 //! payments/messages between them, and often checking the resulting ChannelMonitors are able to
12 //! claim outputs on-chain.
15 use chain::{Confirm, Listen, Watch};
16 use chain::channelmonitor;
17 use chain::channelmonitor::{ChannelMonitor, CLTV_CLAIM_BUFFER, LATENCY_GRACE_PERIOD_BLOCKS, ANTI_REORG_DELAY};
18 use chain::transaction::OutPoint;
19 use chain::keysinterface::BaseSign;
20 use ln::{PaymentPreimage, PaymentSecret, PaymentHash};
21 use ln::channel::{COMMITMENT_TX_BASE_WEIGHT, COMMITMENT_TX_WEIGHT_PER_HTLC};
22 use ln::channelmanager::{ChannelManager, ChannelManagerReadArgs, MppId, RAACommitmentOrder, PaymentSendFailure, BREAKDOWN_TIMEOUT, MIN_CLTV_EXPIRY_DELTA};
23 use ln::channel::{Channel, ChannelError};
24 use ln::{chan_utils, onion_utils};
25 use ln::chan_utils::HTLC_SUCCESS_TX_WEIGHT;
26 use routing::router::{Route, RouteHop, RouteHint, RouteHintHop, get_route, get_keysend_route};
27 use routing::network_graph::{NetworkUpdate, RoutingFees};
28 use ln::features::{ChannelFeatures, InitFeatures, InvoiceFeatures, NodeFeatures};
30 use ln::msgs::{ChannelMessageHandler, RoutingMessageHandler, ErrorAction};
31 use util::enforcing_trait_impls::EnforcingSigner;
32 use util::{byte_utils, test_utils};
33 use util::events::{Event, MessageSendEvent, MessageSendEventsProvider, PaymentPurpose};
34 use util::errors::APIError;
35 use util::ser::{Writeable, ReadableArgs};
36 use util::config::UserConfig;
38 use bitcoin::hash_types::{Txid, BlockHash};
39 use bitcoin::blockdata::block::{Block, BlockHeader};
40 use bitcoin::blockdata::script::Builder;
41 use bitcoin::blockdata::opcodes;
42 use bitcoin::blockdata::constants::genesis_block;
43 use bitcoin::network::constants::Network;
45 use bitcoin::hashes::sha256::Hash as Sha256;
46 use bitcoin::hashes::Hash;
48 use bitcoin::secp256k1::Secp256k1;
49 use bitcoin::secp256k1::key::{PublicKey,SecretKey};
55 use alloc::collections::BTreeSet;
56 use core::default::Default;
57 use sync::{Arc, Mutex};
59 use ln::functional_test_utils::*;
60 use ln::chan_utils::CommitmentTransaction;
63 fn test_insane_channel_opens() {
64 // Stand up a network of 2 nodes
65 let chanmon_cfgs = create_chanmon_cfgs(2);
66 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
67 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
68 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
70 // Instantiate channel parameters where we push the maximum msats given our
72 let channel_value_sat = 31337; // same as funding satoshis
73 let channel_reserve_satoshis = Channel::<EnforcingSigner>::get_holder_selected_channel_reserve_satoshis(channel_value_sat);
74 let push_msat = (channel_value_sat - channel_reserve_satoshis) * 1000;
76 // Have node0 initiate a channel to node1 with aforementioned parameters
77 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_sat, push_msat, 42, None).unwrap();
79 // Extract the channel open message from node0 to node1
80 let open_channel_message = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
82 // Test helper that asserts we get the correct error string given a mutator
83 // that supposedly makes the channel open message insane
84 let insane_open_helper = |expected_error_str: &str, message_mutator: fn(msgs::OpenChannel) -> msgs::OpenChannel| {
85 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &message_mutator(open_channel_message.clone()));
86 let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
87 assert_eq!(msg_events.len(), 1);
88 let expected_regex = regex::Regex::new(expected_error_str).unwrap();
89 if let MessageSendEvent::HandleError { ref action, .. } = msg_events[0] {
91 &ErrorAction::SendErrorMessage { .. } => {
92 nodes[1].logger.assert_log_regex("lightning::ln::channelmanager".to_string(), expected_regex, 1);
94 _ => panic!("unexpected event!"),
96 } else { assert!(false); }
99 use ln::channel::MAX_FUNDING_SATOSHIS;
100 use ln::channelmanager::MAX_LOCAL_BREAKDOWN_TIMEOUT;
102 // Test all mutations that would make the channel open message insane
103 insane_open_helper(format!("Funding must be smaller than {}. It was {}", MAX_FUNDING_SATOSHIS, MAX_FUNDING_SATOSHIS).as_str(), |mut msg| { msg.funding_satoshis = MAX_FUNDING_SATOSHIS; msg });
105 insane_open_helper("Bogus channel_reserve_satoshis", |mut msg| { msg.channel_reserve_satoshis = msg.funding_satoshis + 1; msg });
107 insane_open_helper(r"push_msat \d+ was larger than funding value \d+", |mut msg| { msg.push_msat = (msg.funding_satoshis - msg.channel_reserve_satoshis) * 1000 + 1; msg });
109 insane_open_helper("Peer never wants payout outputs?", |mut msg| { msg.dust_limit_satoshis = msg.funding_satoshis + 1 ; msg });
111 insane_open_helper(r"Bogus; channel reserve \(\d+\) is less than dust limit \(\d+\)", |mut msg| { msg.dust_limit_satoshis = msg.channel_reserve_satoshis + 1; msg });
113 insane_open_helper(r"Minimum htlc value \(\d+\) was larger than full channel value \(\d+\)", |mut msg| { msg.htlc_minimum_msat = (msg.funding_satoshis - msg.channel_reserve_satoshis) * 1000; msg });
115 insane_open_helper("They wanted our payments to be delayed by a needlessly long period", |mut msg| { msg.to_self_delay = MAX_LOCAL_BREAKDOWN_TIMEOUT + 1; msg });
117 insane_open_helper("0 max_accepted_htlcs makes for a useless channel", |mut msg| { msg.max_accepted_htlcs = 0; msg });
119 insane_open_helper("max_accepted_htlcs was 484. It must not be larger than 483", |mut msg| { msg.max_accepted_htlcs = 484; msg });
123 fn test_async_inbound_update_fee() {
124 let chanmon_cfgs = create_chanmon_cfgs(2);
125 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
126 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
127 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
128 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
129 let logger = test_utils::TestLogger::new();
132 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
136 // send (1) commitment_signed -.
137 // <- update_add_htlc/commitment_signed
138 // send (2) RAA (awaiting remote revoke) -.
139 // (1) commitment_signed is delivered ->
140 // .- send (3) RAA (awaiting remote revoke)
141 // (2) RAA is delivered ->
142 // .- send (4) commitment_signed
143 // <- (3) RAA is delivered
144 // send (5) commitment_signed -.
145 // <- (4) commitment_signed is delivered
147 // (5) commitment_signed is delivered ->
149 // (6) RAA is delivered ->
151 // First nodes[0] generates an update_fee
153 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
156 nodes[0].node.timer_tick_occurred();
157 check_added_monitors!(nodes[0], 1);
159 let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
160 assert_eq!(events_0.len(), 1);
161 let (update_msg, commitment_signed) = match events_0[0] { // (1)
162 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
163 (update_fee.as_ref(), commitment_signed)
165 _ => panic!("Unexpected event"),
168 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
170 // ...but before it's delivered, nodes[1] starts to send a payment back to nodes[0]...
171 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[0]);
172 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
173 nodes[1].node.send_payment(&get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[0].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 40000, TEST_FINAL_CLTV, &logger).unwrap(), our_payment_hash, &Some(our_payment_secret)).unwrap();
174 check_added_monitors!(nodes[1], 1);
176 let payment_event = {
177 let mut events_1 = nodes[1].node.get_and_clear_pending_msg_events();
178 assert_eq!(events_1.len(), 1);
179 SendEvent::from_event(events_1.remove(0))
181 assert_eq!(payment_event.node_id, nodes[0].node.get_our_node_id());
182 assert_eq!(payment_event.msgs.len(), 1);
184 // ...now when the messages get delivered everyone should be happy
185 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
186 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg); // (2)
187 let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
188 // nodes[0] is awaiting nodes[1] revoke_and_ack so get_event_msg's assert(len == 1) passes
189 check_added_monitors!(nodes[0], 1);
191 // deliver(1), generate (3):
192 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
193 let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
194 // nodes[1] is awaiting nodes[0] revoke_and_ack so get_event_msg's assert(len == 1) passes
195 check_added_monitors!(nodes[1], 1);
197 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack); // deliver (2)
198 let bs_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
199 assert!(bs_update.update_add_htlcs.is_empty()); // (4)
200 assert!(bs_update.update_fulfill_htlcs.is_empty()); // (4)
201 assert!(bs_update.update_fail_htlcs.is_empty()); // (4)
202 assert!(bs_update.update_fail_malformed_htlcs.is_empty()); // (4)
203 assert!(bs_update.update_fee.is_none()); // (4)
204 check_added_monitors!(nodes[1], 1);
206 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack); // deliver (3)
207 let as_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
208 assert!(as_update.update_add_htlcs.is_empty()); // (5)
209 assert!(as_update.update_fulfill_htlcs.is_empty()); // (5)
210 assert!(as_update.update_fail_htlcs.is_empty()); // (5)
211 assert!(as_update.update_fail_malformed_htlcs.is_empty()); // (5)
212 assert!(as_update.update_fee.is_none()); // (5)
213 check_added_monitors!(nodes[0], 1);
215 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_update.commitment_signed); // deliver (4)
216 let as_second_revoke = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
217 // only (6) so get_event_msg's assert(len == 1) passes
218 check_added_monitors!(nodes[0], 1);
220 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_update.commitment_signed); // deliver (5)
221 let bs_second_revoke = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
222 check_added_monitors!(nodes[1], 1);
224 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke);
225 check_added_monitors!(nodes[0], 1);
227 let events_2 = nodes[0].node.get_and_clear_pending_events();
228 assert_eq!(events_2.len(), 1);
230 Event::PendingHTLCsForwardable {..} => {}, // If we actually processed we'd receive the payment
231 _ => panic!("Unexpected event"),
234 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_revoke); // deliver (6)
235 check_added_monitors!(nodes[1], 1);
239 fn test_update_fee_unordered_raa() {
240 // Just the intro to the previous test followed by an out-of-order RAA (which caused a
241 // crash in an earlier version of the update_fee patch)
242 let chanmon_cfgs = create_chanmon_cfgs(2);
243 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
244 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
245 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
246 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
247 let logger = test_utils::TestLogger::new();
250 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
252 // First nodes[0] generates an update_fee
254 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
257 nodes[0].node.timer_tick_occurred();
258 check_added_monitors!(nodes[0], 1);
260 let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
261 assert_eq!(events_0.len(), 1);
262 let update_msg = match events_0[0] { // (1)
263 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, .. }, .. } => {
266 _ => panic!("Unexpected event"),
269 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
271 // ...but before it's delivered, nodes[1] starts to send a payment back to nodes[0]...
272 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[0]);
273 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
274 nodes[1].node.send_payment(&get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[0].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 40000, TEST_FINAL_CLTV, &logger).unwrap(), our_payment_hash, &Some(our_payment_secret)).unwrap();
275 check_added_monitors!(nodes[1], 1);
277 let payment_event = {
278 let mut events_1 = nodes[1].node.get_and_clear_pending_msg_events();
279 assert_eq!(events_1.len(), 1);
280 SendEvent::from_event(events_1.remove(0))
282 assert_eq!(payment_event.node_id, nodes[0].node.get_our_node_id());
283 assert_eq!(payment_event.msgs.len(), 1);
285 // ...now when the messages get delivered everyone should be happy
286 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
287 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg); // (2)
288 let as_revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
289 // nodes[0] is awaiting nodes[1] revoke_and_ack so get_event_msg's assert(len == 1) passes
290 check_added_monitors!(nodes[0], 1);
292 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_msg); // deliver (2)
293 check_added_monitors!(nodes[1], 1);
295 // We can't continue, sadly, because our (1) now has a bogus signature
299 fn test_multi_flight_update_fee() {
300 let chanmon_cfgs = create_chanmon_cfgs(2);
301 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
302 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
303 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
304 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
307 // update_fee/commitment_signed ->
308 // .- send (1) RAA and (2) commitment_signed
309 // update_fee (never committed) ->
311 // We have to manually generate the above update_fee, it is allowed by the protocol but we
312 // don't track which updates correspond to which revoke_and_ack responses so we're in
313 // AwaitingRAA mode and will not generate the update_fee yet.
314 // <- (1) RAA delivered
315 // (3) is generated and send (4) CS -.
316 // Note that A cannot generate (4) prior to (1) being delivered as it otherwise doesn't
317 // know the per_commitment_point to use for it.
318 // <- (2) commitment_signed delivered
320 // B should send no response here
321 // (4) commitment_signed delivered ->
322 // <- RAA/commitment_signed delivered
325 // First nodes[0] generates an update_fee
328 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
329 initial_feerate = *feerate_lock;
330 *feerate_lock = initial_feerate + 20;
332 nodes[0].node.timer_tick_occurred();
333 check_added_monitors!(nodes[0], 1);
335 let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
336 assert_eq!(events_0.len(), 1);
337 let (update_msg_1, commitment_signed_1) = match events_0[0] { // (1)
338 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
339 (update_fee.as_ref().unwrap(), commitment_signed)
341 _ => panic!("Unexpected event"),
344 // Deliver first update_fee/commitment_signed pair, generating (1) and (2):
345 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg_1);
346 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed_1);
347 let (bs_revoke_msg, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
348 check_added_monitors!(nodes[1], 1);
350 // nodes[0] is awaiting a revoke from nodes[1] before it will create a new commitment
353 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
354 *feerate_lock = initial_feerate + 40;
356 nodes[0].node.timer_tick_occurred();
357 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
358 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
360 // Create the (3) update_fee message that nodes[0] will generate before it does...
361 let mut update_msg_2 = msgs::UpdateFee {
362 channel_id: update_msg_1.channel_id.clone(),
363 feerate_per_kw: (initial_feerate + 30) as u32,
366 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg_2);
368 update_msg_2.feerate_per_kw = (initial_feerate + 40) as u32;
370 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg_2);
372 // Deliver (1), generating (3) and (4)
373 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_msg);
374 let as_second_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
375 check_added_monitors!(nodes[0], 1);
376 assert!(as_second_update.update_add_htlcs.is_empty());
377 assert!(as_second_update.update_fulfill_htlcs.is_empty());
378 assert!(as_second_update.update_fail_htlcs.is_empty());
379 assert!(as_second_update.update_fail_malformed_htlcs.is_empty());
380 // Check that the update_fee newly generated matches what we delivered:
381 assert_eq!(as_second_update.update_fee.as_ref().unwrap().channel_id, update_msg_2.channel_id);
382 assert_eq!(as_second_update.update_fee.as_ref().unwrap().feerate_per_kw, update_msg_2.feerate_per_kw);
384 // Deliver (2) commitment_signed
385 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_commitment_signed);
386 let as_revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
387 check_added_monitors!(nodes[0], 1);
388 // No commitment_signed so get_event_msg's assert(len == 1) passes
390 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_msg);
391 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
392 check_added_monitors!(nodes[1], 1);
395 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_second_update.commitment_signed);
396 let (bs_second_revoke, bs_second_commitment) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
397 check_added_monitors!(nodes[1], 1);
399 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke);
400 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
401 check_added_monitors!(nodes[0], 1);
403 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_commitment);
404 let as_second_revoke = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
405 // No commitment_signed so get_event_msg's assert(len == 1) passes
406 check_added_monitors!(nodes[0], 1);
408 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_revoke);
409 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
410 check_added_monitors!(nodes[1], 1);
413 fn do_test_1_conf_open(connect_style: ConnectStyle) {
414 // Previously, if the minium_depth config was set to 1, we'd never send a funding_locked. This
415 // tests that we properly send one in that case.
416 let mut alice_config = UserConfig::default();
417 alice_config.own_channel_config.minimum_depth = 1;
418 alice_config.channel_options.announced_channel = true;
419 alice_config.peer_channel_config_limits.force_announced_channel_preference = false;
420 let mut bob_config = UserConfig::default();
421 bob_config.own_channel_config.minimum_depth = 1;
422 bob_config.channel_options.announced_channel = true;
423 bob_config.peer_channel_config_limits.force_announced_channel_preference = false;
424 let chanmon_cfgs = create_chanmon_cfgs(2);
425 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
426 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[Some(alice_config), Some(bob_config)]);
427 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
428 *nodes[0].connect_style.borrow_mut() = connect_style;
430 let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
431 mine_transaction(&nodes[1], &tx);
432 nodes[0].node.handle_funding_locked(&nodes[1].node.get_our_node_id(), &get_event_msg!(nodes[1], MessageSendEvent::SendFundingLocked, nodes[0].node.get_our_node_id()));
434 mine_transaction(&nodes[0], &tx);
435 let (funding_locked, _) = create_chan_between_nodes_with_value_confirm_second(&nodes[1], &nodes[0]);
436 let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
439 assert!(node.net_graph_msg_handler.handle_channel_announcement(&announcement).unwrap());
440 node.net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
441 node.net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
445 fn test_1_conf_open() {
446 do_test_1_conf_open(ConnectStyle::BestBlockFirst);
447 do_test_1_conf_open(ConnectStyle::TransactionsFirst);
448 do_test_1_conf_open(ConnectStyle::FullBlockViaListen);
451 fn do_test_sanity_on_in_flight_opens(steps: u8) {
452 // Previously, we had issues deserializing channels when we hadn't connected the first block
453 // after creation. To catch that and similar issues, we lean on the Node::drop impl to test
454 // serialization round-trips and simply do steps towards opening a channel and then drop the
457 let chanmon_cfgs = create_chanmon_cfgs(2);
458 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
459 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
460 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
462 if steps & 0b1000_0000 != 0{
464 header: BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
467 connect_block(&nodes[0], &block);
468 connect_block(&nodes[1], &block);
471 if steps & 0x0f == 0 { return; }
472 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
473 let open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
475 if steps & 0x0f == 1 { return; }
476 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_channel);
477 let accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
479 if steps & 0x0f == 2 { return; }
480 nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &accept_channel);
482 let (temporary_channel_id, tx, funding_output) = create_funding_transaction(&nodes[0], 100000, 42);
484 if steps & 0x0f == 3 { return; }
485 nodes[0].node.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
486 check_added_monitors!(nodes[0], 0);
487 let funding_created = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
489 if steps & 0x0f == 4 { return; }
490 nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created);
492 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
493 assert_eq!(added_monitors.len(), 1);
494 assert_eq!(added_monitors[0].0, funding_output);
495 added_monitors.clear();
497 let funding_signed = get_event_msg!(nodes[1], MessageSendEvent::SendFundingSigned, nodes[0].node.get_our_node_id());
499 if steps & 0x0f == 5 { return; }
500 nodes[0].node.handle_funding_signed(&nodes[1].node.get_our_node_id(), &funding_signed);
502 let mut added_monitors = nodes[0].chain_monitor.added_monitors.lock().unwrap();
503 assert_eq!(added_monitors.len(), 1);
504 assert_eq!(added_monitors[0].0, funding_output);
505 added_monitors.clear();
508 let events_4 = nodes[0].node.get_and_clear_pending_events();
509 assert_eq!(events_4.len(), 0);
511 if steps & 0x0f == 6 { return; }
512 create_chan_between_nodes_with_value_confirm_first(&nodes[0], &nodes[1], &tx, 2);
514 if steps & 0x0f == 7 { return; }
515 confirm_transaction_at(&nodes[0], &tx, 2);
516 connect_blocks(&nodes[0], CHAN_CONFIRM_DEPTH);
517 create_chan_between_nodes_with_value_confirm_second(&nodes[1], &nodes[0]);
521 fn test_sanity_on_in_flight_opens() {
522 do_test_sanity_on_in_flight_opens(0);
523 do_test_sanity_on_in_flight_opens(0 | 0b1000_0000);
524 do_test_sanity_on_in_flight_opens(1);
525 do_test_sanity_on_in_flight_opens(1 | 0b1000_0000);
526 do_test_sanity_on_in_flight_opens(2);
527 do_test_sanity_on_in_flight_opens(2 | 0b1000_0000);
528 do_test_sanity_on_in_flight_opens(3);
529 do_test_sanity_on_in_flight_opens(3 | 0b1000_0000);
530 do_test_sanity_on_in_flight_opens(4);
531 do_test_sanity_on_in_flight_opens(4 | 0b1000_0000);
532 do_test_sanity_on_in_flight_opens(5);
533 do_test_sanity_on_in_flight_opens(5 | 0b1000_0000);
534 do_test_sanity_on_in_flight_opens(6);
535 do_test_sanity_on_in_flight_opens(6 | 0b1000_0000);
536 do_test_sanity_on_in_flight_opens(7);
537 do_test_sanity_on_in_flight_opens(7 | 0b1000_0000);
538 do_test_sanity_on_in_flight_opens(8);
539 do_test_sanity_on_in_flight_opens(8 | 0b1000_0000);
543 fn test_update_fee_vanilla() {
544 let chanmon_cfgs = create_chanmon_cfgs(2);
545 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
546 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
547 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
548 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
551 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
554 nodes[0].node.timer_tick_occurred();
555 check_added_monitors!(nodes[0], 1);
557 let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
558 assert_eq!(events_0.len(), 1);
559 let (update_msg, commitment_signed) = match events_0[0] {
560 MessageSendEvent::UpdateHTLCs { node_id:_, updates: msgs::CommitmentUpdate { update_add_htlcs:_, update_fulfill_htlcs:_, update_fail_htlcs:_, update_fail_malformed_htlcs:_, ref update_fee, ref commitment_signed } } => {
561 (update_fee.as_ref(), commitment_signed)
563 _ => panic!("Unexpected event"),
565 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
567 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
568 let (revoke_msg, commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
569 check_added_monitors!(nodes[1], 1);
571 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
572 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
573 check_added_monitors!(nodes[0], 1);
575 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
576 let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
577 // No commitment_signed so get_event_msg's assert(len == 1) passes
578 check_added_monitors!(nodes[0], 1);
580 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg);
581 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
582 check_added_monitors!(nodes[1], 1);
586 fn test_update_fee_that_funder_cannot_afford() {
587 let chanmon_cfgs = create_chanmon_cfgs(2);
588 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
589 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
590 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
591 let channel_value = 1888;
592 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, channel_value, 700000, InitFeatures::known(), InitFeatures::known());
593 let channel_id = chan.2;
597 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
598 *feerate_lock = feerate;
600 nodes[0].node.timer_tick_occurred();
601 check_added_monitors!(nodes[0], 1);
602 let update_msg = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
604 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg.update_fee.unwrap());
606 commitment_signed_dance!(nodes[1], nodes[0], update_msg.commitment_signed, false);
608 //Confirm that the new fee based on the last local commitment txn is what we expected based on the feerate of 260 set above.
609 //This value results in a fee that is exactly what the funder can afford (277 sat + 1000 sat channel reserve)
611 let commitment_tx = get_local_commitment_txn!(nodes[1], channel_id)[0].clone();
613 //We made sure neither party's funds are below the dust limit so -2 non-HTLC txns from number of outputs
614 let num_htlcs = commitment_tx.output.len() - 2;
615 let total_fee: u64 = feerate as u64 * (COMMITMENT_TX_BASE_WEIGHT + (num_htlcs as u64) * COMMITMENT_TX_WEIGHT_PER_HTLC) / 1000;
616 let mut actual_fee = commitment_tx.output.iter().fold(0, |acc, output| acc + output.value);
617 actual_fee = channel_value - actual_fee;
618 assert_eq!(total_fee, actual_fee);
621 //Add 2 to the previous fee rate to the final fee increases by 1 (with no HTLCs the fee is essentially
622 //fee_rate*(724/1000) so the increment of 1*0.724 is rounded back down)
624 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
625 *feerate_lock = feerate + 2;
627 nodes[0].node.timer_tick_occurred();
628 check_added_monitors!(nodes[0], 1);
630 let update2_msg = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
632 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update2_msg.update_fee.unwrap());
634 //While producing the commitment_signed response after handling a received update_fee request the
635 //check to see if the funder, who sent the update_fee request, can afford the new fee (funder_balance >= fee+channel_reserve)
636 //Should produce and error.
637 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &update2_msg.commitment_signed);
638 nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Funding remote cannot afford proposed new fee".to_string(), 1);
639 check_added_monitors!(nodes[1], 1);
640 check_closed_broadcast!(nodes[1], true);
644 fn test_update_fee_with_fundee_update_add_htlc() {
645 let chanmon_cfgs = create_chanmon_cfgs(2);
646 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
647 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
648 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
649 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
650 let logger = test_utils::TestLogger::new();
653 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
656 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
659 nodes[0].node.timer_tick_occurred();
660 check_added_monitors!(nodes[0], 1);
662 let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
663 assert_eq!(events_0.len(), 1);
664 let (update_msg, commitment_signed) = match events_0[0] {
665 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 } } => {
666 (update_fee.as_ref(), commitment_signed)
668 _ => panic!("Unexpected event"),
670 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
671 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
672 let (revoke_msg, commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
673 check_added_monitors!(nodes[1], 1);
675 let (our_payment_preimage, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[0]);
676 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
677 let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[0].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 800000, TEST_FINAL_CLTV, &logger).unwrap();
679 // nothing happens since node[1] is in AwaitingRemoteRevoke
680 nodes[1].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
682 let mut added_monitors = nodes[0].chain_monitor.added_monitors.lock().unwrap();
683 assert_eq!(added_monitors.len(), 0);
684 added_monitors.clear();
686 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
687 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
688 // node[1] has nothing to do
690 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
691 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
692 check_added_monitors!(nodes[0], 1);
694 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
695 let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
696 // No commitment_signed so get_event_msg's assert(len == 1) passes
697 check_added_monitors!(nodes[0], 1);
698 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg);
699 check_added_monitors!(nodes[1], 1);
700 // AwaitingRemoteRevoke ends here
702 let commitment_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
703 assert_eq!(commitment_update.update_add_htlcs.len(), 1);
704 assert_eq!(commitment_update.update_fulfill_htlcs.len(), 0);
705 assert_eq!(commitment_update.update_fail_htlcs.len(), 0);
706 assert_eq!(commitment_update.update_fail_malformed_htlcs.len(), 0);
707 assert_eq!(commitment_update.update_fee.is_none(), true);
709 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &commitment_update.update_add_htlcs[0]);
710 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_update.commitment_signed);
711 check_added_monitors!(nodes[0], 1);
712 let (revoke, commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
714 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke);
715 check_added_monitors!(nodes[1], 1);
716 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
718 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commitment_signed);
719 check_added_monitors!(nodes[1], 1);
720 let revoke = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
721 // No commitment_signed so get_event_msg's assert(len == 1) passes
723 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke);
724 check_added_monitors!(nodes[0], 1);
725 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
727 expect_pending_htlcs_forwardable!(nodes[0]);
729 let events = nodes[0].node.get_and_clear_pending_events();
730 assert_eq!(events.len(), 1);
732 Event::PaymentReceived { .. } => { },
733 _ => panic!("Unexpected event"),
736 claim_payment(&nodes[1], &vec!(&nodes[0])[..], our_payment_preimage);
738 send_payment(&nodes[1], &vec!(&nodes[0])[..], 800000);
739 send_payment(&nodes[0], &vec!(&nodes[1])[..], 800000);
740 close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true);
744 fn test_update_fee() {
745 let chanmon_cfgs = create_chanmon_cfgs(2);
746 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
747 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
748 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
749 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
750 let channel_id = chan.2;
753 // (1) update_fee/commitment_signed ->
754 // <- (2) revoke_and_ack
755 // .- send (3) commitment_signed
756 // (4) update_fee/commitment_signed ->
757 // .- send (5) revoke_and_ack (no CS as we're awaiting a revoke)
758 // <- (3) commitment_signed delivered
759 // send (6) revoke_and_ack -.
760 // <- (5) deliver revoke_and_ack
761 // (6) deliver revoke_and_ack ->
762 // .- send (7) commitment_signed in response to (4)
763 // <- (7) deliver commitment_signed
766 // Create and deliver (1)...
769 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
770 feerate = *feerate_lock;
771 *feerate_lock = feerate + 20;
773 nodes[0].node.timer_tick_occurred();
774 check_added_monitors!(nodes[0], 1);
776 let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
777 assert_eq!(events_0.len(), 1);
778 let (update_msg, commitment_signed) = match events_0[0] {
779 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 } } => {
780 (update_fee.as_ref(), commitment_signed)
782 _ => panic!("Unexpected event"),
784 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
786 // Generate (2) and (3):
787 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
788 let (revoke_msg, commitment_signed_0) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
789 check_added_monitors!(nodes[1], 1);
792 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
793 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
794 check_added_monitors!(nodes[0], 1);
796 // Create and deliver (4)...
798 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
799 *feerate_lock = feerate + 30;
801 nodes[0].node.timer_tick_occurred();
802 check_added_monitors!(nodes[0], 1);
803 let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
804 assert_eq!(events_0.len(), 1);
805 let (update_msg, commitment_signed) = match events_0[0] {
806 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 } } => {
807 (update_fee.as_ref(), commitment_signed)
809 _ => panic!("Unexpected event"),
812 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
813 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
814 check_added_monitors!(nodes[1], 1);
816 let revoke_msg = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
817 // No commitment_signed so get_event_msg's assert(len == 1) passes
819 // Handle (3), creating (6):
820 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed_0);
821 check_added_monitors!(nodes[0], 1);
822 let revoke_msg_0 = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
823 // No commitment_signed so get_event_msg's assert(len == 1) passes
826 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
827 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
828 check_added_monitors!(nodes[0], 1);
830 // Deliver (6), creating (7):
831 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg_0);
832 let commitment_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
833 assert!(commitment_update.update_add_htlcs.is_empty());
834 assert!(commitment_update.update_fulfill_htlcs.is_empty());
835 assert!(commitment_update.update_fail_htlcs.is_empty());
836 assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
837 assert!(commitment_update.update_fee.is_none());
838 check_added_monitors!(nodes[1], 1);
841 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_update.commitment_signed);
842 check_added_monitors!(nodes[0], 1);
843 let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
844 // No commitment_signed so get_event_msg's assert(len == 1) passes
846 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg);
847 check_added_monitors!(nodes[1], 1);
848 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
850 assert_eq!(get_feerate!(nodes[0], channel_id), feerate + 30);
851 assert_eq!(get_feerate!(nodes[1], channel_id), feerate + 30);
852 close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true);
856 fn fake_network_test() {
857 // Simple test which builds a network of ChannelManagers, connects them to each other, and
858 // tests that payments get routed and transactions broadcast in semi-reasonable ways.
859 let chanmon_cfgs = create_chanmon_cfgs(4);
860 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
861 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
862 let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
864 // Create some initial channels
865 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
866 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
867 let chan_3 = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
869 // Rebalance the network a bit by relaying one payment through all the channels...
870 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000);
871 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000);
872 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000);
873 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000);
875 // Send some more payments
876 send_payment(&nodes[1], &vec!(&nodes[2], &nodes[3])[..], 1000000);
877 send_payment(&nodes[3], &vec!(&nodes[2], &nodes[1], &nodes[0])[..], 1000000);
878 send_payment(&nodes[3], &vec!(&nodes[2], &nodes[1])[..], 1000000);
880 // Test failure packets
881 let payment_hash_1 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 1000000).1;
882 fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], payment_hash_1);
884 // Add a new channel that skips 3
885 let chan_4 = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known());
887 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 1000000);
888 send_payment(&nodes[2], &vec!(&nodes[3])[..], 1000000);
889 send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
890 send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
891 send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
892 send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
893 send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
895 // Do some rebalance loop payments, simultaneously
896 let mut hops = Vec::with_capacity(3);
898 pubkey: nodes[2].node.get_our_node_id(),
899 node_features: NodeFeatures::empty(),
900 short_channel_id: chan_2.0.contents.short_channel_id,
901 channel_features: ChannelFeatures::empty(),
903 cltv_expiry_delta: chan_3.0.contents.cltv_expiry_delta as u32
906 pubkey: nodes[3].node.get_our_node_id(),
907 node_features: NodeFeatures::empty(),
908 short_channel_id: chan_3.0.contents.short_channel_id,
909 channel_features: ChannelFeatures::empty(),
911 cltv_expiry_delta: chan_4.1.contents.cltv_expiry_delta as u32
914 pubkey: nodes[1].node.get_our_node_id(),
915 node_features: NodeFeatures::known(),
916 short_channel_id: chan_4.0.contents.short_channel_id,
917 channel_features: ChannelFeatures::known(),
919 cltv_expiry_delta: TEST_FINAL_CLTV,
921 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;
922 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;
923 let payment_preimage_1 = send_along_route(&nodes[1], Route { paths: vec![hops] }, &vec!(&nodes[2], &nodes[3], &nodes[1])[..], 1000000).0;
925 let mut hops = Vec::with_capacity(3);
927 pubkey: nodes[3].node.get_our_node_id(),
928 node_features: NodeFeatures::empty(),
929 short_channel_id: chan_4.0.contents.short_channel_id,
930 channel_features: ChannelFeatures::empty(),
932 cltv_expiry_delta: chan_3.1.contents.cltv_expiry_delta as u32
935 pubkey: nodes[2].node.get_our_node_id(),
936 node_features: NodeFeatures::empty(),
937 short_channel_id: chan_3.0.contents.short_channel_id,
938 channel_features: ChannelFeatures::empty(),
940 cltv_expiry_delta: chan_2.1.contents.cltv_expiry_delta as u32
943 pubkey: nodes[1].node.get_our_node_id(),
944 node_features: NodeFeatures::known(),
945 short_channel_id: chan_2.0.contents.short_channel_id,
946 channel_features: ChannelFeatures::known(),
948 cltv_expiry_delta: TEST_FINAL_CLTV,
950 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;
951 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;
952 let payment_hash_2 = send_along_route(&nodes[1], Route { paths: vec![hops] }, &vec!(&nodes[3], &nodes[2], &nodes[1])[..], 1000000).1;
954 // Claim the rebalances...
955 fail_payment(&nodes[1], &vec!(&nodes[3], &nodes[2], &nodes[1])[..], payment_hash_2);
956 claim_payment(&nodes[1], &vec!(&nodes[2], &nodes[3], &nodes[1])[..], payment_preimage_1);
958 // Add a duplicate new channel from 2 to 4
959 let chan_5 = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known());
961 // Send some payments across both channels
962 let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
963 let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
964 let payment_preimage_5 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
967 route_over_limit(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000);
968 let events = nodes[0].node.get_and_clear_pending_msg_events();
969 assert_eq!(events.len(), 0);
970 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);
972 //TODO: Test that routes work again here as we've been notified that the channel is full
974 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_3);
975 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_4);
976 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_5);
978 // Close down the channels...
979 close_channel(&nodes[0], &nodes[1], &chan_1.2, chan_1.3, true);
980 close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, false);
981 close_channel(&nodes[2], &nodes[3], &chan_3.2, chan_3.3, true);
982 close_channel(&nodes[1], &nodes[3], &chan_4.2, chan_4.3, false);
983 close_channel(&nodes[1], &nodes[3], &chan_5.2, chan_5.3, false);
987 fn holding_cell_htlc_counting() {
988 // Tests that HTLCs in the holding cell count towards the pending HTLC limits on outbound HTLCs
989 // to ensure we don't end up with HTLCs sitting around in our holding cell for several
990 // commitment dance rounds.
991 let chanmon_cfgs = create_chanmon_cfgs(3);
992 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
993 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
994 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
995 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
996 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
997 let logger = test_utils::TestLogger::new();
999 let mut payments = Vec::new();
1000 for _ in 0..::ln::channel::OUR_MAX_HTLCS {
1001 let (payment_preimage, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[2]);
1002 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
1003 let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[2].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
1004 nodes[1].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
1005 payments.push((payment_preimage, payment_hash));
1007 check_added_monitors!(nodes[1], 1);
1009 let mut events = nodes[1].node.get_and_clear_pending_msg_events();
1010 assert_eq!(events.len(), 1);
1011 let initial_payment_event = SendEvent::from_event(events.pop().unwrap());
1012 assert_eq!(initial_payment_event.node_id, nodes[2].node.get_our_node_id());
1014 // There is now one HTLC in an outbound commitment transaction and (OUR_MAX_HTLCS - 1) HTLCs in
1015 // the holding cell waiting on B's RAA to send. At this point we should not be able to add
1017 let (_, payment_hash_1, payment_secret_1) = get_payment_preimage_hash!(nodes[2]);
1019 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
1020 let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[2].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
1021 unwrap_send_err!(nodes[1].node.send_payment(&route, payment_hash_1, &Some(payment_secret_1)), true, APIError::ChannelUnavailable { ref err },
1022 assert!(regex::Regex::new(r"Cannot push more than their max accepted HTLCs \(\d+\)").unwrap().is_match(err)));
1023 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1024 nodes[1].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot push more than their max accepted HTLCs".to_string(), 1);
1027 // This should also be true if we try to forward a payment.
1028 let (_, payment_hash_2, payment_secret_2) = get_payment_preimage_hash!(nodes[2]);
1030 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
1031 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[2].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
1032 nodes[0].node.send_payment(&route, payment_hash_2, &Some(payment_secret_2)).unwrap();
1033 check_added_monitors!(nodes[0], 1);
1036 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1037 assert_eq!(events.len(), 1);
1038 let payment_event = SendEvent::from_event(events.pop().unwrap());
1039 assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
1041 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1042 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
1043 // We have to forward pending HTLCs twice - once tries to forward the payment forward (and
1044 // fails), the second will process the resulting failure and fail the HTLC backward.
1045 expect_pending_htlcs_forwardable!(nodes[1]);
1046 expect_pending_htlcs_forwardable!(nodes[1]);
1047 check_added_monitors!(nodes[1], 1);
1049 let bs_fail_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1050 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &bs_fail_updates.update_fail_htlcs[0]);
1051 commitment_signed_dance!(nodes[0], nodes[1], bs_fail_updates.commitment_signed, false, true);
1053 expect_payment_failed_with_update!(nodes[0], payment_hash_2, false, chan_2.0.contents.short_channel_id, false);
1055 // Now forward all the pending HTLCs and claim them back
1056 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &initial_payment_event.msgs[0]);
1057 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &initial_payment_event.commitment_msg);
1058 check_added_monitors!(nodes[2], 1);
1060 let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1061 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_revoke_and_ack);
1062 check_added_monitors!(nodes[1], 1);
1063 let as_updates = get_htlc_update_msgs!(nodes[1], nodes[2].node.get_our_node_id());
1065 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &bs_commitment_signed);
1066 check_added_monitors!(nodes[1], 1);
1067 let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
1069 for ref update in as_updates.update_add_htlcs.iter() {
1070 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), update);
1072 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &as_updates.commitment_signed);
1073 check_added_monitors!(nodes[2], 1);
1074 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
1075 check_added_monitors!(nodes[2], 1);
1076 let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1078 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_revoke_and_ack);
1079 check_added_monitors!(nodes[1], 1);
1080 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &bs_commitment_signed);
1081 check_added_monitors!(nodes[1], 1);
1082 let as_final_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
1084 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_final_raa);
1085 check_added_monitors!(nodes[2], 1);
1087 expect_pending_htlcs_forwardable!(nodes[2]);
1089 let events = nodes[2].node.get_and_clear_pending_events();
1090 assert_eq!(events.len(), payments.len());
1091 for (event, &(_, ref hash)) in events.iter().zip(payments.iter()) {
1093 &Event::PaymentReceived { ref payment_hash, .. } => {
1094 assert_eq!(*payment_hash, *hash);
1096 _ => panic!("Unexpected event"),
1100 for (preimage, _) in payments.drain(..) {
1101 claim_payment(&nodes[1], &[&nodes[2]], preimage);
1104 send_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1000000);
1108 fn duplicate_htlc_test() {
1109 // Test that we accept duplicate payment_hash HTLCs across the network and that
1110 // claiming/failing them are all separate and don't affect each other
1111 let chanmon_cfgs = create_chanmon_cfgs(6);
1112 let node_cfgs = create_node_cfgs(6, &chanmon_cfgs);
1113 let node_chanmgrs = create_node_chanmgrs(6, &node_cfgs, &[None, None, None, None, None, None]);
1114 let mut nodes = create_network(6, &node_cfgs, &node_chanmgrs);
1116 // Create some initial channels to route via 3 to 4/5 from 0/1/2
1117 create_announced_chan_between_nodes(&nodes, 0, 3, InitFeatures::known(), InitFeatures::known());
1118 create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known());
1119 create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
1120 create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::known(), InitFeatures::known());
1121 create_announced_chan_between_nodes(&nodes, 3, 5, InitFeatures::known(), InitFeatures::known());
1123 let (payment_preimage, payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[3], &nodes[4])[..], 1000000);
1125 *nodes[0].network_payment_count.borrow_mut() -= 1;
1126 assert_eq!(route_payment(&nodes[1], &vec!(&nodes[3])[..], 1000000).0, payment_preimage);
1128 *nodes[0].network_payment_count.borrow_mut() -= 1;
1129 assert_eq!(route_payment(&nodes[2], &vec!(&nodes[3], &nodes[5])[..], 1000000).0, payment_preimage);
1131 claim_payment(&nodes[0], &vec!(&nodes[3], &nodes[4])[..], payment_preimage);
1132 fail_payment(&nodes[2], &vec!(&nodes[3], &nodes[5])[..], payment_hash);
1133 claim_payment(&nodes[1], &vec!(&nodes[3])[..], payment_preimage);
1137 fn test_duplicate_htlc_different_direction_onchain() {
1138 // Test that ChannelMonitor doesn't generate 2 preimage txn
1139 // when we have 2 HTLCs with same preimage that go across a node
1140 // in opposite directions, even with the same payment secret.
1141 let chanmon_cfgs = create_chanmon_cfgs(2);
1142 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1143 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1144 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1146 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
1147 let logger = test_utils::TestLogger::new();
1150 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
1152 let (payment_preimage, payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 900_000);
1154 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
1155 let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[0].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 800_000, TEST_FINAL_CLTV, &logger).unwrap();
1156 let node_a_payment_secret = nodes[0].node.create_inbound_payment_for_hash(payment_hash, None, 7200, 0).unwrap();
1157 send_along_route_with_secret(&nodes[1], route, &[&[&nodes[0]]], 800_000, payment_hash, node_a_payment_secret);
1159 // Provide preimage to node 0 by claiming payment
1160 nodes[0].node.claim_funds(payment_preimage);
1161 check_added_monitors!(nodes[0], 1);
1163 // Broadcast node 1 commitment txn
1164 let remote_txn = get_local_commitment_txn!(nodes[1], chan_1.2);
1166 assert_eq!(remote_txn[0].output.len(), 4); // 1 local, 1 remote, 1 htlc inbound, 1 htlc outbound
1167 let mut has_both_htlcs = 0; // check htlcs match ones committed
1168 for outp in remote_txn[0].output.iter() {
1169 if outp.value == 800_000 / 1000 {
1170 has_both_htlcs += 1;
1171 } else if outp.value == 900_000 / 1000 {
1172 has_both_htlcs += 1;
1175 assert_eq!(has_both_htlcs, 2);
1177 mine_transaction(&nodes[0], &remote_txn[0]);
1178 check_added_monitors!(nodes[0], 1);
1179 connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
1181 // Check we only broadcast 1 timeout tx
1182 let claim_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
1183 assert_eq!(claim_txn.len(), 8);
1184 assert_eq!(claim_txn[1], claim_txn[4]);
1185 assert_eq!(claim_txn[2], claim_txn[5]);
1186 check_spends!(claim_txn[1], chan_1.3);
1187 check_spends!(claim_txn[2], claim_txn[1]);
1188 check_spends!(claim_txn[7], claim_txn[1]);
1190 assert_eq!(claim_txn[0].input.len(), 1);
1191 assert_eq!(claim_txn[3].input.len(), 1);
1192 assert_eq!(claim_txn[0].input[0].previous_output, claim_txn[3].input[0].previous_output);
1194 assert_eq!(claim_txn[0].input.len(), 1);
1195 assert_eq!(claim_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC 1 <--> 0, preimage tx
1196 check_spends!(claim_txn[0], remote_txn[0]);
1197 assert_eq!(remote_txn[0].output[claim_txn[0].input[0].previous_output.vout as usize].value, 800);
1198 assert_eq!(claim_txn[6].input.len(), 1);
1199 assert_eq!(claim_txn[6].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // HTLC 0 <--> 1, timeout tx
1200 check_spends!(claim_txn[6], remote_txn[0]);
1201 assert_eq!(remote_txn[0].output[claim_txn[6].input[0].previous_output.vout as usize].value, 900);
1203 let events = nodes[0].node.get_and_clear_pending_msg_events();
1204 assert_eq!(events.len(), 3);
1207 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
1208 MessageSendEvent::HandleError { node_id, action: msgs::ErrorAction::SendErrorMessage { ref msg } } => {
1209 assert_eq!(node_id, nodes[1].node.get_our_node_id());
1210 assert_eq!(msg.data, "Commitment or closing transaction was confirmed on chain.");
1212 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, .. } } => {
1213 assert!(update_add_htlcs.is_empty());
1214 assert!(update_fail_htlcs.is_empty());
1215 assert_eq!(update_fulfill_htlcs.len(), 1);
1216 assert!(update_fail_malformed_htlcs.is_empty());
1217 assert_eq!(nodes[1].node.get_our_node_id(), *node_id);
1219 _ => panic!("Unexpected event"),
1225 fn test_basic_channel_reserve() {
1226 let chanmon_cfgs = create_chanmon_cfgs(2);
1227 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1228 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1229 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1230 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1231 let logger = test_utils::TestLogger::new();
1233 let chan_stat = get_channel_value_stat!(nodes[0], chan.2);
1234 let channel_reserve = chan_stat.channel_reserve_msat;
1236 // The 2* and +1 are for the fee spike reserve.
1237 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
1238 let commit_tx_fee = 2 * commit_tx_fee_msat(get_feerate!(nodes[0], chan.2), 1 + 1);
1239 let max_can_send = 5000000 - channel_reserve - commit_tx_fee;
1240 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
1241 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes.last().unwrap().node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), max_can_send + 1, TEST_FINAL_CLTV, &logger).unwrap();
1242 let err = nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).err().unwrap();
1244 PaymentSendFailure::AllFailedRetrySafe(ref fails) => {
1246 &APIError::ChannelUnavailable{ref err} =>
1247 assert!(regex::Regex::new(r"Cannot send value that would put our balance under counterparty-announced channel reserve value \(\d+\)").unwrap().is_match(err)),
1248 _ => panic!("Unexpected error variant"),
1251 _ => panic!("Unexpected error variant"),
1253 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1254 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);
1256 send_payment(&nodes[0], &vec![&nodes[1]], max_can_send);
1260 fn test_fee_spike_violation_fails_htlc() {
1261 let chanmon_cfgs = create_chanmon_cfgs(2);
1262 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1263 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1264 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1265 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1267 let (route, payment_hash, _, payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], 3460001);
1268 // Need to manually create the update_add_htlc message to go around the channel reserve check in send_htlc()
1269 let secp_ctx = Secp256k1::new();
1270 let session_priv = SecretKey::from_slice(&[42; 32]).expect("RNG is bad!");
1272 let cur_height = nodes[1].node.best_block.read().unwrap().height() + 1;
1274 let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route.paths[0], &session_priv).unwrap();
1275 let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 3460001, &Some(payment_secret), cur_height, &None).unwrap();
1276 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
1277 let msg = msgs::UpdateAddHTLC {
1280 amount_msat: htlc_msat,
1281 payment_hash: payment_hash,
1282 cltv_expiry: htlc_cltv,
1283 onion_routing_packet: onion_packet,
1286 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
1288 // Now manually create the commitment_signed message corresponding to the update_add
1289 // nodes[0] just sent. In the code for construction of this message, "local" refers
1290 // to the sender of the message, and "remote" refers to the receiver.
1292 let feerate_per_kw = get_feerate!(nodes[0], chan.2);
1294 const INITIAL_COMMITMENT_NUMBER: u64 = (1 << 48) - 1;
1296 // Get the EnforcingSigner for each channel, which will be used to (1) get the keys
1297 // needed to sign the new commitment tx and (2) sign the new commitment tx.
1298 let (local_revocation_basepoint, local_htlc_basepoint, local_secret, next_local_point, local_funding) = {
1299 let chan_lock = nodes[0].node.channel_state.lock().unwrap();
1300 let local_chan = chan_lock.by_id.get(&chan.2).unwrap();
1301 let chan_signer = local_chan.get_signer();
1302 // Make the signer believe we validated another commitment, so we can release the secret
1303 chan_signer.get_enforcement_state().last_holder_commitment -= 1;
1305 let pubkeys = chan_signer.pubkeys();
1306 (pubkeys.revocation_basepoint, pubkeys.htlc_basepoint,
1307 chan_signer.release_commitment_secret(INITIAL_COMMITMENT_NUMBER),
1308 chan_signer.get_per_commitment_point(INITIAL_COMMITMENT_NUMBER - 2, &secp_ctx),
1309 chan_signer.pubkeys().funding_pubkey)
1311 let (remote_delayed_payment_basepoint, remote_htlc_basepoint, remote_point, remote_funding) = {
1312 let chan_lock = nodes[1].node.channel_state.lock().unwrap();
1313 let remote_chan = chan_lock.by_id.get(&chan.2).unwrap();
1314 let chan_signer = remote_chan.get_signer();
1315 let pubkeys = chan_signer.pubkeys();
1316 (pubkeys.delayed_payment_basepoint, pubkeys.htlc_basepoint,
1317 chan_signer.get_per_commitment_point(INITIAL_COMMITMENT_NUMBER - 1, &secp_ctx),
1318 chan_signer.pubkeys().funding_pubkey)
1321 // Assemble the set of keys we can use for signatures for our commitment_signed message.
1322 let commit_tx_keys = chan_utils::TxCreationKeys::derive_new(&secp_ctx, &remote_point, &remote_delayed_payment_basepoint,
1323 &remote_htlc_basepoint, &local_revocation_basepoint, &local_htlc_basepoint).unwrap();
1325 // Build the remote commitment transaction so we can sign it, and then later use the
1326 // signature for the commitment_signed message.
1327 let local_chan_balance = 1313;
1329 let accepted_htlc_info = chan_utils::HTLCOutputInCommitment {
1331 amount_msat: 3460001,
1332 cltv_expiry: htlc_cltv,
1334 transaction_output_index: Some(1),
1337 let commitment_number = INITIAL_COMMITMENT_NUMBER - 1;
1340 let local_chan_lock = nodes[0].node.channel_state.lock().unwrap();
1341 let local_chan = local_chan_lock.by_id.get(&chan.2).unwrap();
1342 let local_chan_signer = local_chan.get_signer();
1343 let commitment_tx = CommitmentTransaction::new_with_auxiliary_htlc_data(
1347 false, local_funding, remote_funding,
1348 commit_tx_keys.clone(),
1350 &mut vec![(accepted_htlc_info, ())],
1351 &local_chan.channel_transaction_parameters.as_counterparty_broadcastable()
1353 local_chan_signer.sign_counterparty_commitment(&commitment_tx, &secp_ctx).unwrap()
1356 let commit_signed_msg = msgs::CommitmentSigned {
1359 htlc_signatures: res.1
1362 // Send the commitment_signed message to the nodes[1].
1363 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commit_signed_msg);
1364 let _ = nodes[1].node.get_and_clear_pending_msg_events();
1366 // Send the RAA to nodes[1].
1367 let raa_msg = msgs::RevokeAndACK {
1369 per_commitment_secret: local_secret,
1370 next_per_commitment_point: next_local_point
1372 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &raa_msg);
1374 let events = nodes[1].node.get_and_clear_pending_msg_events();
1375 assert_eq!(events.len(), 1);
1376 // Make sure the HTLC failed in the way we expect.
1378 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fail_htlcs, .. }, .. } => {
1379 assert_eq!(update_fail_htlcs.len(), 1);
1380 update_fail_htlcs[0].clone()
1382 _ => panic!("Unexpected event"),
1384 nodes[1].logger.assert_log("lightning::ln::channel".to_string(),
1385 format!("Attempting to fail HTLC due to fee spike buffer violation in channel {}. Rebalancing is required.", ::hex::encode(raa_msg.channel_id)), 1);
1387 check_added_monitors!(nodes[1], 2);
1391 fn test_chan_reserve_violation_outbound_htlc_inbound_chan() {
1392 let mut chanmon_cfgs = create_chanmon_cfgs(2);
1393 // Set the fee rate for the channel very high, to the point where the fundee
1394 // sending any above-dust amount would result in a channel reserve violation.
1395 // In this test we check that we would be prevented from sending an HTLC in
1397 let feerate_per_kw = 253;
1398 chanmon_cfgs[0].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(feerate_per_kw) };
1399 chanmon_cfgs[1].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(feerate_per_kw) };
1400 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1401 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1402 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1404 let mut push_amt = 100_000_000;
1405 push_amt -= feerate_per_kw as u64 * (COMMITMENT_TX_BASE_WEIGHT + COMMITMENT_TX_WEIGHT_PER_HTLC) / 1000 * 1000;
1406 push_amt -= Channel::<EnforcingSigner>::get_holder_selected_channel_reserve_satoshis(100_000) * 1000;
1408 let _ = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100_000, push_amt, InitFeatures::known(), InitFeatures::known());
1410 // Sending exactly enough to hit the reserve amount should be accepted
1411 let (_, _, _) = route_payment(&nodes[1], &[&nodes[0]], 1_000_000);
1413 // However one more HTLC should be significantly over the reserve amount and fail.
1414 let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[1], nodes[0], 1_000_000);
1415 unwrap_send_err!(nodes[1].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
1416 assert_eq!(err, "Cannot send value that would put counterparty balance under holder-announced channel reserve value"));
1417 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1418 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);
1422 fn test_chan_reserve_violation_inbound_htlc_outbound_channel() {
1423 let mut chanmon_cfgs = create_chanmon_cfgs(2);
1424 // Set the fee rate for the channel very high, to the point where the funder
1425 // receiving 1 update_add_htlc would result in them closing the channel due
1426 // to channel reserve violation. This close could also happen if the fee went
1427 // up a more realistic amount, but many HTLCs were outstanding at the time of
1428 // the update_add_htlc.
1429 chanmon_cfgs[0].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(6000) };
1430 chanmon_cfgs[1].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(6000) };
1431 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1432 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1433 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1434 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1436 let (route, payment_hash, _, payment_secret) = get_route_and_payment_hash!(nodes[1], nodes[0], 1000);
1437 // Need to manually create the update_add_htlc message to go around the channel reserve check in send_htlc()
1438 let secp_ctx = Secp256k1::new();
1439 let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
1440 let cur_height = nodes[1].node.best_block.read().unwrap().height() + 1;
1441 let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route.paths[0], &session_priv).unwrap();
1442 let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 1000, &Some(payment_secret), cur_height, &None).unwrap();
1443 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
1444 let msg = msgs::UpdateAddHTLC {
1447 amount_msat: htlc_msat + 1,
1448 payment_hash: payment_hash,
1449 cltv_expiry: htlc_cltv,
1450 onion_routing_packet: onion_packet,
1453 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &msg);
1454 // Check that the payment failed and the channel is closed in response to the malicious UpdateAdd.
1455 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);
1456 assert_eq!(nodes[0].node.list_channels().len(), 0);
1457 let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
1458 assert_eq!(err_msg.data, "Cannot accept HTLC that would put our balance under counterparty-announced channel reserve value");
1459 check_added_monitors!(nodes[0], 1);
1463 fn test_chan_reserve_dust_inbound_htlcs_outbound_chan() {
1464 // Test that if we receive many dust HTLCs over an outbound channel, they don't count when
1465 // calculating our commitment transaction fee (this was previously broken).
1466 let mut chanmon_cfgs = create_chanmon_cfgs(2);
1467 let feerate_per_kw = 253;
1468 chanmon_cfgs[0].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(feerate_per_kw) };
1469 chanmon_cfgs[1].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(feerate_per_kw) };
1471 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1472 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None, None]);
1473 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1475 // Set nodes[0]'s balance such that they will consider any above-dust received HTLC to be a
1476 // channel reserve violation (so their balance is channel reserve (1000 sats) + commitment
1477 // transaction fee with 0 HTLCs (183 sats)).
1478 let mut push_amt = 100_000_000;
1479 push_amt -= feerate_per_kw as u64 * (COMMITMENT_TX_BASE_WEIGHT) / 1000 * 1000;
1480 push_amt -= Channel::<EnforcingSigner>::get_holder_selected_channel_reserve_satoshis(100_000) * 1000;
1481 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, push_amt, InitFeatures::known(), InitFeatures::known());
1483 let dust_amt = crate::ln::channel::MIN_DUST_LIMIT_SATOSHIS * 1000
1484 + feerate_per_kw as u64 * HTLC_SUCCESS_TX_WEIGHT / 1000 * 1000 - 1;
1485 // In the previous code, routing this dust payment would cause nodes[0] to perceive a channel
1486 // reserve violation even though it's a dust HTLC and therefore shouldn't count towards the
1487 // commitment transaction fee.
1488 let (_, _, _) = route_payment(&nodes[1], &[&nodes[0]], dust_amt);
1490 // One more than the dust amt should fail, however.
1491 let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[1], nodes[0], dust_amt + 1);
1492 unwrap_send_err!(nodes[1].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
1493 assert_eq!(err, "Cannot send value that would put counterparty balance under holder-announced channel reserve value"));
1497 fn test_chan_reserve_dust_inbound_htlcs_inbound_chan() {
1498 // Test that if we receive many dust HTLCs over an inbound channel, they don't count when
1499 // calculating our counterparty's commitment transaction fee (this was previously broken).
1500 let chanmon_cfgs = create_chanmon_cfgs(2);
1501 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1502 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None, None]);
1503 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1504 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 98000000, InitFeatures::known(), InitFeatures::known());
1506 let payment_amt = 46000; // Dust amount
1507 // In the previous code, these first four payments would succeed.
1508 let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1509 let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1510 let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1511 let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1513 // Then these next 5 would be interpreted by nodes[1] as violating the fee spike buffer.
1514 let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1515 let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1516 let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1517 let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1518 let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1520 // And this last payment previously resulted in nodes[1] closing on its inbound-channel
1521 // counterparty, because it counted all the previous dust HTLCs against nodes[0]'s commitment
1522 // transaction fee and therefore perceived this next payment as a channel reserve violation.
1523 let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1527 fn test_chan_reserve_violation_inbound_htlc_inbound_chan() {
1528 let chanmon_cfgs = create_chanmon_cfgs(3);
1529 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1530 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1531 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1532 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1533 let _ = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1536 let total_routing_fee_msat = (nodes.len() - 2) as u64 * feemsat;
1537 let chan_stat = get_channel_value_stat!(nodes[0], chan.2);
1538 let feerate = get_feerate!(nodes[0], chan.2);
1540 // Add a 2* and +1 for the fee spike reserve.
1541 let commit_tx_fee_2_htlc = 2*commit_tx_fee_msat(feerate, 2 + 1);
1542 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;
1543 let amt_msat_1 = recv_value_1 + total_routing_fee_msat;
1545 // Add a pending HTLC.
1546 let (route_1, our_payment_hash_1, _, our_payment_secret_1) = get_route_and_payment_hash!(nodes[0], nodes[2], amt_msat_1);
1547 let payment_event_1 = {
1548 nodes[0].node.send_payment(&route_1, our_payment_hash_1, &Some(our_payment_secret_1)).unwrap();
1549 check_added_monitors!(nodes[0], 1);
1551 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1552 assert_eq!(events.len(), 1);
1553 SendEvent::from_event(events.remove(0))
1555 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event_1.msgs[0]);
1557 // Attempt to trigger a channel reserve violation --> payment failure.
1558 let commit_tx_fee_2_htlcs = commit_tx_fee_msat(feerate, 2);
1559 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;
1560 let amt_msat_2 = recv_value_2 + total_routing_fee_msat;
1561 let (route_2, _, _, _) = get_route_and_payment_hash!(nodes[0], nodes[2], amt_msat_2);
1563 // Need to manually create the update_add_htlc message to go around the channel reserve check in send_htlc()
1564 let secp_ctx = Secp256k1::new();
1565 let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
1566 let cur_height = nodes[0].node.best_block.read().unwrap().height() + 1;
1567 let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route_2.paths[0], &session_priv).unwrap();
1568 let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route_2.paths[0], recv_value_2, &None, cur_height, &None).unwrap();
1569 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &our_payment_hash_1);
1570 let msg = msgs::UpdateAddHTLC {
1573 amount_msat: htlc_msat + 1,
1574 payment_hash: our_payment_hash_1,
1575 cltv_expiry: htlc_cltv,
1576 onion_routing_packet: onion_packet,
1579 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
1580 // Check that the payment failed and the channel is closed in response to the malicious UpdateAdd.
1581 nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Remote HTLC add would put them under remote reserve value".to_string(), 1);
1582 assert_eq!(nodes[1].node.list_channels().len(), 1);
1583 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
1584 assert_eq!(err_msg.data, "Remote HTLC add would put them under remote reserve value");
1585 check_added_monitors!(nodes[1], 1);
1589 fn test_inbound_outbound_capacity_is_not_zero() {
1590 let chanmon_cfgs = create_chanmon_cfgs(2);
1591 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1592 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1593 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1594 let _ = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1595 let channels0 = node_chanmgrs[0].list_channels();
1596 let channels1 = node_chanmgrs[1].list_channels();
1597 assert_eq!(channels0.len(), 1);
1598 assert_eq!(channels1.len(), 1);
1600 let reserve = Channel::<EnforcingSigner>::get_holder_selected_channel_reserve_satoshis(100000);
1601 assert_eq!(channels0[0].inbound_capacity_msat, 95000000 - reserve*1000);
1602 assert_eq!(channels1[0].outbound_capacity_msat, 95000000 - reserve*1000);
1604 assert_eq!(channels0[0].outbound_capacity_msat, 100000 * 1000 - 95000000 - reserve*1000);
1605 assert_eq!(channels1[0].inbound_capacity_msat, 100000 * 1000 - 95000000 - reserve*1000);
1608 fn commit_tx_fee_msat(feerate: u32, num_htlcs: u64) -> u64 {
1609 (COMMITMENT_TX_BASE_WEIGHT + num_htlcs * COMMITMENT_TX_WEIGHT_PER_HTLC) * feerate as u64 / 1000 * 1000
1613 fn test_channel_reserve_holding_cell_htlcs() {
1614 let chanmon_cfgs = create_chanmon_cfgs(3);
1615 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1616 // When this test was written, the default base fee floated based on the HTLC count.
1617 // It is now fixed, so we simply set the fee to the expected value here.
1618 let mut config = test_default_channel_config();
1619 config.channel_options.forwarding_fee_base_msat = 239;
1620 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[Some(config.clone()), Some(config.clone()), Some(config.clone())]);
1621 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1622 let chan_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 190000, 1001, InitFeatures::known(), InitFeatures::known());
1623 let chan_2 = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 190000, 1001, InitFeatures::known(), InitFeatures::known());
1625 let mut stat01 = get_channel_value_stat!(nodes[0], chan_1.2);
1626 let mut stat11 = get_channel_value_stat!(nodes[1], chan_1.2);
1628 let mut stat12 = get_channel_value_stat!(nodes[1], chan_2.2);
1629 let mut stat22 = get_channel_value_stat!(nodes[2], chan_2.2);
1631 macro_rules! expect_forward {
1633 let mut events = $node.node.get_and_clear_pending_msg_events();
1634 assert_eq!(events.len(), 1);
1635 check_added_monitors!($node, 1);
1636 let payment_event = SendEvent::from_event(events.remove(0));
1641 let feemsat = 239; // set above
1642 let total_fee_msat = (nodes.len() - 2) as u64 * feemsat;
1643 let feerate = get_feerate!(nodes[0], chan_1.2);
1645 let recv_value_0 = stat01.counterparty_max_htlc_value_in_flight_msat - total_fee_msat;
1647 // attempt to send amt_msat > their_max_htlc_value_in_flight_msat
1649 let (mut route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], recv_value_0);
1650 route.paths[0].last_mut().unwrap().fee_msat += 1;
1651 assert!(route.paths[0].iter().rev().skip(1).all(|h| h.fee_msat == feemsat));
1652 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
1653 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)));
1654 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1655 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);
1658 // channel reserve is bigger than their_max_htlc_value_in_flight_msat so loop to deplete
1659 // nodes[0]'s wealth
1661 let amt_msat = recv_value_0 + total_fee_msat;
1662 // 3 for the 3 HTLCs that will be sent, 2* and +1 for the fee spike reserve.
1663 // Also, ensure that each payment has enough to be over the dust limit to
1664 // ensure it'll be included in each commit tx fee calculation.
1665 let commit_tx_fee_all_htlcs = 2*commit_tx_fee_msat(feerate, 3 + 1);
1666 let ensure_htlc_amounts_above_dust_buffer = 3 * (stat01.counterparty_dust_limit_msat + 1000);
1667 if stat01.value_to_self_msat < stat01.channel_reserve_msat + commit_tx_fee_all_htlcs + ensure_htlc_amounts_above_dust_buffer + amt_msat {
1670 send_payment(&nodes[0], &vec![&nodes[1], &nodes[2]][..], recv_value_0);
1672 let (stat01_, stat11_, stat12_, stat22_) = (
1673 get_channel_value_stat!(nodes[0], chan_1.2),
1674 get_channel_value_stat!(nodes[1], chan_1.2),
1675 get_channel_value_stat!(nodes[1], chan_2.2),
1676 get_channel_value_stat!(nodes[2], chan_2.2),
1679 assert_eq!(stat01_.value_to_self_msat, stat01.value_to_self_msat - amt_msat);
1680 assert_eq!(stat11_.value_to_self_msat, stat11.value_to_self_msat + amt_msat);
1681 assert_eq!(stat12_.value_to_self_msat, stat12.value_to_self_msat - (amt_msat - feemsat));
1682 assert_eq!(stat22_.value_to_self_msat, stat22.value_to_self_msat + (amt_msat - feemsat));
1683 stat01 = stat01_; stat11 = stat11_; stat12 = stat12_; stat22 = stat22_;
1686 // adding pending output.
1687 // 2* and +1 HTLCs on the commit tx fee for the fee spike reserve.
1688 // The reason we're dividing by two here is as follows: the dividend is the total outbound liquidity
1689 // after fees, the channel reserve, and the fee spike buffer are removed. We eventually want to
1690 // divide this quantity into 3 portions, that will each be sent in an HTLC. This allows us
1691 // to test channel channel reserve policy at the edges of what amount is sendable, i.e.
1692 // cases where 1 msat over X amount will cause a payment failure, but anything less than
1693 // that can be sent successfully. So, dividing by two is a somewhat arbitrary way of getting
1694 // the amount of the first of these aforementioned 3 payments. The reason we split into 3 payments
1695 // is to test the behavior of the holding cell with respect to channel reserve and commit tx fee
1697 let commit_tx_fee_2_htlcs = 2*commit_tx_fee_msat(feerate, 2 + 1);
1698 let recv_value_1 = (stat01.value_to_self_msat - stat01.channel_reserve_msat - total_fee_msat - commit_tx_fee_2_htlcs)/2;
1699 let amt_msat_1 = recv_value_1 + total_fee_msat;
1701 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);
1702 let payment_event_1 = {
1703 nodes[0].node.send_payment(&route_1, our_payment_hash_1, &Some(our_payment_secret_1)).unwrap();
1704 check_added_monitors!(nodes[0], 1);
1706 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1707 assert_eq!(events.len(), 1);
1708 SendEvent::from_event(events.remove(0))
1710 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event_1.msgs[0]);
1712 // channel reserve test with htlc pending output > 0
1713 let recv_value_2 = stat01.value_to_self_msat - amt_msat_1 - stat01.channel_reserve_msat - total_fee_msat - commit_tx_fee_2_htlcs;
1715 let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], recv_value_2 + 1);
1716 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
1717 assert!(regex::Regex::new(r"Cannot send value that would put our balance under counterparty-announced channel reserve value \(\d+\)").unwrap().is_match(err)));
1718 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1721 // split the rest to test holding cell
1722 let commit_tx_fee_3_htlcs = 2*commit_tx_fee_msat(feerate, 3 + 1);
1723 let additional_htlc_cost_msat = commit_tx_fee_3_htlcs - commit_tx_fee_2_htlcs;
1724 let recv_value_21 = recv_value_2/2 - additional_htlc_cost_msat/2;
1725 let recv_value_22 = recv_value_2 - recv_value_21 - total_fee_msat - additional_htlc_cost_msat;
1727 let stat = get_channel_value_stat!(nodes[0], chan_1.2);
1728 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);
1731 // now see if they go through on both sides
1732 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);
1733 // but this will stuck in the holding cell
1734 nodes[0].node.send_payment(&route_21, our_payment_hash_21, &Some(our_payment_secret_21)).unwrap();
1735 check_added_monitors!(nodes[0], 0);
1736 let events = nodes[0].node.get_and_clear_pending_events();
1737 assert_eq!(events.len(), 0);
1739 // test with outbound holding cell amount > 0
1741 let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], recv_value_22+1);
1742 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
1743 assert!(regex::Regex::new(r"Cannot send value that would put our balance under counterparty-announced channel reserve value \(\d+\)").unwrap().is_match(err)));
1744 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1745 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);
1748 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);
1749 // this will also stuck in the holding cell
1750 nodes[0].node.send_payment(&route_22, our_payment_hash_22, &Some(our_payment_secret_22)).unwrap();
1751 check_added_monitors!(nodes[0], 0);
1752 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
1753 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1755 // flush the pending htlc
1756 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event_1.commitment_msg);
1757 let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1758 check_added_monitors!(nodes[1], 1);
1760 // the pending htlc should be promoted to committed
1761 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_revoke_and_ack);
1762 check_added_monitors!(nodes[0], 1);
1763 let commitment_update_2 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1765 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &as_commitment_signed);
1766 let bs_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1767 // No commitment_signed so get_event_msg's assert(len == 1) passes
1768 check_added_monitors!(nodes[0], 1);
1770 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &bs_revoke_and_ack);
1771 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1772 check_added_monitors!(nodes[1], 1);
1774 expect_pending_htlcs_forwardable!(nodes[1]);
1776 let ref payment_event_11 = expect_forward!(nodes[1]);
1777 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_11.msgs[0]);
1778 commitment_signed_dance!(nodes[2], nodes[1], payment_event_11.commitment_msg, false);
1780 expect_pending_htlcs_forwardable!(nodes[2]);
1781 expect_payment_received!(nodes[2], our_payment_hash_1, our_payment_secret_1, recv_value_1);
1783 // flush the htlcs in the holding cell
1784 assert_eq!(commitment_update_2.update_add_htlcs.len(), 2);
1785 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &commitment_update_2.update_add_htlcs[0]);
1786 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &commitment_update_2.update_add_htlcs[1]);
1787 commitment_signed_dance!(nodes[1], nodes[0], &commitment_update_2.commitment_signed, false);
1788 expect_pending_htlcs_forwardable!(nodes[1]);
1790 let ref payment_event_3 = expect_forward!(nodes[1]);
1791 assert_eq!(payment_event_3.msgs.len(), 2);
1792 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_3.msgs[0]);
1793 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_3.msgs[1]);
1795 commitment_signed_dance!(nodes[2], nodes[1], &payment_event_3.commitment_msg, false);
1796 expect_pending_htlcs_forwardable!(nodes[2]);
1798 let events = nodes[2].node.get_and_clear_pending_events();
1799 assert_eq!(events.len(), 2);
1801 Event::PaymentReceived { ref payment_hash, ref purpose, amt } => {
1802 assert_eq!(our_payment_hash_21, *payment_hash);
1803 assert_eq!(recv_value_21, amt);
1805 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
1806 assert!(payment_preimage.is_none());
1807 assert_eq!(our_payment_secret_21, *payment_secret);
1809 _ => panic!("expected PaymentPurpose::InvoicePayment")
1812 _ => panic!("Unexpected event"),
1815 Event::PaymentReceived { ref payment_hash, ref purpose, amt } => {
1816 assert_eq!(our_payment_hash_22, *payment_hash);
1817 assert_eq!(recv_value_22, amt);
1819 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
1820 assert!(payment_preimage.is_none());
1821 assert_eq!(our_payment_secret_22, *payment_secret);
1823 _ => panic!("expected PaymentPurpose::InvoicePayment")
1826 _ => panic!("Unexpected event"),
1829 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_1);
1830 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_21);
1831 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_22);
1833 let commit_tx_fee_0_htlcs = 2*commit_tx_fee_msat(feerate, 1);
1834 let recv_value_3 = commit_tx_fee_2_htlcs - commit_tx_fee_0_htlcs - total_fee_msat;
1835 send_payment(&nodes[0], &vec![&nodes[1], &nodes[2]][..], recv_value_3);
1837 let commit_tx_fee_1_htlc = 2*commit_tx_fee_msat(feerate, 1 + 1);
1838 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);
1839 let stat0 = get_channel_value_stat!(nodes[0], chan_1.2);
1840 assert_eq!(stat0.value_to_self_msat, expected_value_to_self);
1841 assert_eq!(stat0.value_to_self_msat, stat0.channel_reserve_msat + commit_tx_fee_1_htlc);
1843 let stat2 = get_channel_value_stat!(nodes[2], chan_2.2);
1844 assert_eq!(stat2.value_to_self_msat, stat22.value_to_self_msat + recv_value_1 + recv_value_21 + recv_value_22 + recv_value_3);
1848 fn channel_reserve_in_flight_removes() {
1849 // In cases where one side claims an HTLC, it thinks it has additional available funds that it
1850 // can send to its counterparty, but due to update ordering, the other side may not yet have
1851 // considered those HTLCs fully removed.
1852 // This tests that we don't count HTLCs which will not be included in the next remote
1853 // commitment transaction towards the reserve value (as it implies no commitment transaction
1854 // will be generated which violates the remote reserve value).
1855 // This was broken previously, and discovered by the chanmon_fail_consistency fuzz test.
1857 // * route two HTLCs from A to B (note that, at a high level, this test is checking that, when
1858 // you consider the values of both of these HTLCs, B may not send an HTLC back to A, but if
1859 // you only consider the value of the first HTLC, it may not),
1860 // * start routing a third HTLC from A to B,
1861 // * claim the first two HTLCs (though B will generate an update_fulfill for one, and put
1862 // the other claim in its holding cell, as it immediately goes into AwaitingRAA),
1863 // * deliver the first fulfill from B
1864 // * deliver the update_add and an RAA from A, resulting in B freeing the second holding cell
1866 // * deliver A's response CS and RAA.
1867 // This results in A having the second HTLC in AwaitingRemovedRemoteRevoke, but B having
1868 // removed it fully. B now has the push_msat plus the first two HTLCs in value.
1869 // * Now B happily sends another HTLC, potentially violating its reserve value from A's point
1870 // of view (if A counts the AwaitingRemovedRemoteRevoke HTLC).
1871 let chanmon_cfgs = create_chanmon_cfgs(2);
1872 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1873 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1874 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1875 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
1876 let logger = test_utils::TestLogger::new();
1878 let b_chan_values = get_channel_value_stat!(nodes[1], chan_1.2);
1879 // Route the first two HTLCs.
1880 let (payment_preimage_1, _, _) = route_payment(&nodes[0], &[&nodes[1]], b_chan_values.channel_reserve_msat - b_chan_values.value_to_self_msat - 10000);
1881 let (payment_preimage_2, _, _) = route_payment(&nodes[0], &[&nodes[1]], 20000);
1883 // Start routing the third HTLC (this is just used to get everyone in the right state).
1884 let (payment_preimage_3, payment_hash_3, payment_secret_3) = get_payment_preimage_hash!(nodes[1]);
1886 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
1887 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
1888 nodes[0].node.send_payment(&route, payment_hash_3, &Some(payment_secret_3)).unwrap();
1889 check_added_monitors!(nodes[0], 1);
1890 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1891 assert_eq!(events.len(), 1);
1892 SendEvent::from_event(events.remove(0))
1895 // Now claim both of the first two HTLCs on B's end, putting B in AwaitingRAA and generating an
1896 // initial fulfill/CS.
1897 assert!(nodes[1].node.claim_funds(payment_preimage_1));
1898 check_added_monitors!(nodes[1], 1);
1899 let bs_removes = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1901 // This claim goes in B's holding cell, allowing us to have a pending B->A RAA which does not
1902 // remove the second HTLC when we send the HTLC back from B to A.
1903 assert!(nodes[1].node.claim_funds(payment_preimage_2));
1904 check_added_monitors!(nodes[1], 1);
1905 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1907 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_removes.update_fulfill_htlcs[0]);
1908 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_removes.commitment_signed);
1909 check_added_monitors!(nodes[0], 1);
1910 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1911 expect_payment_sent!(nodes[0], payment_preimage_1);
1913 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_1.msgs[0]);
1914 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &send_1.commitment_msg);
1915 check_added_monitors!(nodes[1], 1);
1916 // B is already AwaitingRAA, so cant generate a CS here
1917 let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
1919 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1920 check_added_monitors!(nodes[1], 1);
1921 let bs_cs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1923 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
1924 check_added_monitors!(nodes[0], 1);
1925 let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1927 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
1928 check_added_monitors!(nodes[1], 1);
1929 let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
1931 // The second HTLCis removed, but as A is in AwaitingRAA it can't generate a CS here, so the
1932 // RAA that B generated above doesn't fully resolve the second HTLC from A's point of view.
1933 // However, the RAA A generates here *does* fully resolve the HTLC from B's point of view (as A
1934 // can no longer broadcast a commitment transaction with it and B has the preimage so can go
1935 // on-chain as necessary).
1936 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_cs.update_fulfill_htlcs[0]);
1937 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_cs.commitment_signed);
1938 check_added_monitors!(nodes[0], 1);
1939 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1940 expect_payment_sent!(nodes[0], payment_preimage_2);
1942 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1943 check_added_monitors!(nodes[1], 1);
1944 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1946 expect_pending_htlcs_forwardable!(nodes[1]);
1947 expect_payment_received!(nodes[1], payment_hash_3, payment_secret_3, 100000);
1949 // Note that as this RAA was generated before the delivery of the update_fulfill it shouldn't
1950 // resolve the second HTLC from A's point of view.
1951 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
1952 check_added_monitors!(nodes[0], 1);
1953 let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1955 // Now that B doesn't have the second RAA anymore, but A still does, send a payment from B back
1956 // to A to ensure that A doesn't count the almost-removed HTLC in update_add processing.
1957 let (payment_preimage_4, payment_hash_4, payment_secret_4) = get_payment_preimage_hash!(nodes[0]);
1959 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
1960 let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[0].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 10000, TEST_FINAL_CLTV, &logger).unwrap();
1961 nodes[1].node.send_payment(&route, payment_hash_4, &Some(payment_secret_4)).unwrap();
1962 check_added_monitors!(nodes[1], 1);
1963 let mut events = nodes[1].node.get_and_clear_pending_msg_events();
1964 assert_eq!(events.len(), 1);
1965 SendEvent::from_event(events.remove(0))
1968 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &send_2.msgs[0]);
1969 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &send_2.commitment_msg);
1970 check_added_monitors!(nodes[0], 1);
1971 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1973 // Now just resolve all the outstanding messages/HTLCs for completeness...
1975 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
1976 check_added_monitors!(nodes[1], 1);
1977 let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
1979 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1980 check_added_monitors!(nodes[1], 1);
1982 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
1983 check_added_monitors!(nodes[0], 1);
1984 let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1986 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
1987 check_added_monitors!(nodes[1], 1);
1988 let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
1990 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
1991 check_added_monitors!(nodes[0], 1);
1993 expect_pending_htlcs_forwardable!(nodes[0]);
1994 expect_payment_received!(nodes[0], payment_hash_4, payment_secret_4, 10000);
1996 claim_payment(&nodes[1], &[&nodes[0]], payment_preimage_4);
1997 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_3);
2001 fn channel_monitor_network_test() {
2002 // Simple test which builds a network of ChannelManagers, connects them to each other, and
2003 // tests that ChannelMonitor is able to recover from various states.
2004 let chanmon_cfgs = create_chanmon_cfgs(5);
2005 let node_cfgs = create_node_cfgs(5, &chanmon_cfgs);
2006 let node_chanmgrs = create_node_chanmgrs(5, &node_cfgs, &[None, None, None, None, None]);
2007 let nodes = create_network(5, &node_cfgs, &node_chanmgrs);
2009 // Create some initial channels
2010 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2011 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
2012 let chan_3 = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
2013 let chan_4 = create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::known(), InitFeatures::known());
2015 // Make sure all nodes are at the same starting height
2016 connect_blocks(&nodes[0], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[0].best_block_info().1);
2017 connect_blocks(&nodes[1], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[1].best_block_info().1);
2018 connect_blocks(&nodes[2], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[2].best_block_info().1);
2019 connect_blocks(&nodes[3], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[3].best_block_info().1);
2020 connect_blocks(&nodes[4], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[4].best_block_info().1);
2022 // Rebalance the network a bit by relaying one payment through all the channels...
2023 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
2024 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
2025 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
2026 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
2028 // Simple case with no pending HTLCs:
2029 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), true);
2030 check_added_monitors!(nodes[1], 1);
2031 check_closed_broadcast!(nodes[1], false);
2033 let mut node_txn = test_txn_broadcast(&nodes[1], &chan_1, None, HTLCType::NONE);
2034 assert_eq!(node_txn.len(), 1);
2035 mine_transaction(&nodes[0], &node_txn[0]);
2036 check_added_monitors!(nodes[0], 1);
2037 test_txn_broadcast(&nodes[0], &chan_1, None, HTLCType::NONE);
2039 check_closed_broadcast!(nodes[0], true);
2040 assert_eq!(nodes[0].node.list_channels().len(), 0);
2041 assert_eq!(nodes[1].node.list_channels().len(), 1);
2043 // One pending HTLC is discarded by the force-close:
2044 let payment_preimage_1 = route_payment(&nodes[1], &vec!(&nodes[2], &nodes[3])[..], 3000000).0;
2046 // Simple case of one pending HTLC to HTLC-Timeout (note that the HTLC-Timeout is not
2047 // broadcasted until we reach the timelock time).
2048 nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id(), true);
2049 check_closed_broadcast!(nodes[1], false);
2050 check_added_monitors!(nodes[1], 1);
2052 let mut node_txn = test_txn_broadcast(&nodes[1], &chan_2, None, HTLCType::NONE);
2053 connect_blocks(&nodes[1], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + MIN_CLTV_EXPIRY_DELTA as u32 + 1);
2054 test_txn_broadcast(&nodes[1], &chan_2, None, HTLCType::TIMEOUT);
2055 mine_transaction(&nodes[2], &node_txn[0]);
2056 check_added_monitors!(nodes[2], 1);
2057 test_txn_broadcast(&nodes[2], &chan_2, None, HTLCType::NONE);
2059 check_closed_broadcast!(nodes[2], true);
2060 assert_eq!(nodes[1].node.list_channels().len(), 0);
2061 assert_eq!(nodes[2].node.list_channels().len(), 1);
2063 macro_rules! claim_funds {
2064 ($node: expr, $prev_node: expr, $preimage: expr) => {
2066 assert!($node.node.claim_funds($preimage));
2067 check_added_monitors!($node, 1);
2069 let events = $node.node.get_and_clear_pending_msg_events();
2070 assert_eq!(events.len(), 1);
2072 MessageSendEvent::UpdateHTLCs { ref node_id, updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fail_htlcs, .. } } => {
2073 assert!(update_add_htlcs.is_empty());
2074 assert!(update_fail_htlcs.is_empty());
2075 assert_eq!(*node_id, $prev_node.node.get_our_node_id());
2077 _ => panic!("Unexpected event"),
2083 // nodes[3] gets the preimage, but nodes[2] already disconnected, resulting in a nodes[2]
2084 // HTLC-Timeout and a nodes[3] claim against it (+ its own announces)
2085 nodes[2].node.peer_disconnected(&nodes[3].node.get_our_node_id(), true);
2086 check_added_monitors!(nodes[2], 1);
2087 check_closed_broadcast!(nodes[2], false);
2088 let node2_commitment_txid;
2090 let node_txn = test_txn_broadcast(&nodes[2], &chan_3, None, HTLCType::NONE);
2091 connect_blocks(&nodes[2], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + MIN_CLTV_EXPIRY_DELTA as u32 + 1);
2092 test_txn_broadcast(&nodes[2], &chan_3, None, HTLCType::TIMEOUT);
2093 node2_commitment_txid = node_txn[0].txid();
2095 // Claim the payment on nodes[3], giving it knowledge of the preimage
2096 claim_funds!(nodes[3], nodes[2], payment_preimage_1);
2097 mine_transaction(&nodes[3], &node_txn[0]);
2098 check_added_monitors!(nodes[3], 1);
2099 check_preimage_claim(&nodes[3], &node_txn);
2101 check_closed_broadcast!(nodes[3], true);
2102 assert_eq!(nodes[2].node.list_channels().len(), 0);
2103 assert_eq!(nodes[3].node.list_channels().len(), 1);
2105 // Drop the ChannelMonitor for the previous channel to avoid it broadcasting transactions and
2106 // confusing us in the following tests.
2107 let chan_3_mon = nodes[3].chain_monitor.chain_monitor.monitors.write().unwrap().remove(&OutPoint { txid: chan_3.3.txid(), index: 0 }).unwrap();
2109 // One pending HTLC to time out:
2110 let payment_preimage_2 = route_payment(&nodes[3], &vec!(&nodes[4])[..], 3000000).0;
2111 // CLTV expires at TEST_FINAL_CLTV + 1 (current height) + 1 (added in send_payment for
2114 let (close_chan_update_1, close_chan_update_2) = {
2115 connect_blocks(&nodes[3], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + 1);
2116 let events = nodes[3].node.get_and_clear_pending_msg_events();
2117 assert_eq!(events.len(), 2);
2118 let close_chan_update_1 = match events[0] {
2119 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
2122 _ => panic!("Unexpected event"),
2125 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { .. }, node_id } => {
2126 assert_eq!(node_id, nodes[4].node.get_our_node_id());
2128 _ => panic!("Unexpected event"),
2130 check_added_monitors!(nodes[3], 1);
2132 // Clear bumped claiming txn spending node 2 commitment tx. Bumped txn are generated after reaching some height timer.
2134 let mut node_txn = nodes[3].tx_broadcaster.txn_broadcasted.lock().unwrap();
2135 node_txn.retain(|tx| {
2136 if tx.input[0].previous_output.txid == node2_commitment_txid {
2142 let node_txn = test_txn_broadcast(&nodes[3], &chan_4, None, HTLCType::TIMEOUT);
2144 // Claim the payment on nodes[4], giving it knowledge of the preimage
2145 claim_funds!(nodes[4], nodes[3], payment_preimage_2);
2147 connect_blocks(&nodes[4], TEST_FINAL_CLTV - CLTV_CLAIM_BUFFER + 2);
2148 let events = nodes[4].node.get_and_clear_pending_msg_events();
2149 assert_eq!(events.len(), 2);
2150 let close_chan_update_2 = match events[0] {
2151 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
2154 _ => panic!("Unexpected event"),
2157 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { .. }, node_id } => {
2158 assert_eq!(node_id, nodes[3].node.get_our_node_id());
2160 _ => panic!("Unexpected event"),
2162 check_added_monitors!(nodes[4], 1);
2163 test_txn_broadcast(&nodes[4], &chan_4, None, HTLCType::SUCCESS);
2165 mine_transaction(&nodes[4], &node_txn[0]);
2166 check_preimage_claim(&nodes[4], &node_txn);
2167 (close_chan_update_1, close_chan_update_2)
2169 nodes[3].net_graph_msg_handler.handle_channel_update(&close_chan_update_2).unwrap();
2170 nodes[4].net_graph_msg_handler.handle_channel_update(&close_chan_update_1).unwrap();
2171 assert_eq!(nodes[3].node.list_channels().len(), 0);
2172 assert_eq!(nodes[4].node.list_channels().len(), 0);
2174 nodes[3].chain_monitor.chain_monitor.monitors.write().unwrap().insert(OutPoint { txid: chan_3.3.txid(), index: 0 }, chan_3_mon);
2178 fn test_justice_tx() {
2179 // Test justice txn built on revoked HTLC-Success tx, against both sides
2180 let mut alice_config = UserConfig::default();
2181 alice_config.channel_options.announced_channel = true;
2182 alice_config.peer_channel_config_limits.force_announced_channel_preference = false;
2183 alice_config.own_channel_config.our_to_self_delay = 6 * 24 * 5;
2184 let mut bob_config = UserConfig::default();
2185 bob_config.channel_options.announced_channel = true;
2186 bob_config.peer_channel_config_limits.force_announced_channel_preference = false;
2187 bob_config.own_channel_config.our_to_self_delay = 6 * 24 * 3;
2188 let user_cfgs = [Some(alice_config), Some(bob_config)];
2189 let mut chanmon_cfgs = create_chanmon_cfgs(2);
2190 chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
2191 chanmon_cfgs[1].keys_manager.disable_revocation_policy_check = true;
2192 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2193 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &user_cfgs);
2194 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2195 // Create some new channels:
2196 let chan_5 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2198 // A pending HTLC which will be revoked:
2199 let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2200 // Get the will-be-revoked local txn from nodes[0]
2201 let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_5.2);
2202 assert_eq!(revoked_local_txn.len(), 2); // First commitment tx, then HTLC tx
2203 assert_eq!(revoked_local_txn[0].input.len(), 1);
2204 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_5.3.txid());
2205 assert_eq!(revoked_local_txn[0].output.len(), 2); // Only HTLC and output back to 0 are present
2206 assert_eq!(revoked_local_txn[1].input.len(), 1);
2207 assert_eq!(revoked_local_txn[1].input[0].previous_output.txid, revoked_local_txn[0].txid());
2208 assert_eq!(revoked_local_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC-Timeout
2209 // Revoke the old state
2210 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_3);
2213 mine_transaction(&nodes[1], &revoked_local_txn[0]);
2215 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2216 assert_eq!(node_txn.len(), 2); // ChannelMonitor: penalty tx, ChannelManager: local commitment tx
2217 assert_eq!(node_txn[0].input.len(), 2); // We should claim the revoked output and the HTLC output
2219 check_spends!(node_txn[0], revoked_local_txn[0]);
2220 node_txn.swap_remove(0);
2221 node_txn.truncate(1);
2223 check_added_monitors!(nodes[1], 1);
2224 test_txn_broadcast(&nodes[1], &chan_5, None, HTLCType::NONE);
2226 mine_transaction(&nodes[0], &revoked_local_txn[0]);
2227 connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
2228 // Verify broadcast of revoked HTLC-timeout
2229 let node_txn = test_txn_broadcast(&nodes[0], &chan_5, Some(revoked_local_txn[0].clone()), HTLCType::TIMEOUT);
2230 check_added_monitors!(nodes[0], 1);
2231 // Broadcast revoked HTLC-timeout on node 1
2232 mine_transaction(&nodes[1], &node_txn[1]);
2233 test_revoked_htlc_claim_txn_broadcast(&nodes[1], node_txn[1].clone(), revoked_local_txn[0].clone());
2235 get_announce_close_broadcast_events(&nodes, 0, 1);
2237 assert_eq!(nodes[0].node.list_channels().len(), 0);
2238 assert_eq!(nodes[1].node.list_channels().len(), 0);
2240 // We test justice_tx build by A on B's revoked HTLC-Success tx
2241 // Create some new channels:
2242 let chan_6 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2244 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2248 // A pending HTLC which will be revoked:
2249 let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2250 // Get the will-be-revoked local txn from B
2251 let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan_6.2);
2252 assert_eq!(revoked_local_txn.len(), 1); // Only commitment tx
2253 assert_eq!(revoked_local_txn[0].input.len(), 1);
2254 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_6.3.txid());
2255 assert_eq!(revoked_local_txn[0].output.len(), 2); // Only HTLC and output back to A are present
2256 // Revoke the old state
2257 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_4);
2259 mine_transaction(&nodes[0], &revoked_local_txn[0]);
2261 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
2262 assert_eq!(node_txn.len(), 2); //ChannelMonitor: penalty tx, ChannelManager: local commitment tx
2263 assert_eq!(node_txn[0].input.len(), 1); // We claim the received HTLC output
2265 check_spends!(node_txn[0], revoked_local_txn[0]);
2266 node_txn.swap_remove(0);
2268 check_added_monitors!(nodes[0], 1);
2269 test_txn_broadcast(&nodes[0], &chan_6, None, HTLCType::NONE);
2271 mine_transaction(&nodes[1], &revoked_local_txn[0]);
2272 let node_txn = test_txn_broadcast(&nodes[1], &chan_6, Some(revoked_local_txn[0].clone()), HTLCType::SUCCESS);
2273 check_added_monitors!(nodes[1], 1);
2274 mine_transaction(&nodes[0], &node_txn[1]);
2275 test_revoked_htlc_claim_txn_broadcast(&nodes[0], node_txn[1].clone(), revoked_local_txn[0].clone());
2277 get_announce_close_broadcast_events(&nodes, 0, 1);
2278 assert_eq!(nodes[0].node.list_channels().len(), 0);
2279 assert_eq!(nodes[1].node.list_channels().len(), 0);
2283 fn revoked_output_claim() {
2284 // Simple test to ensure a node will claim a revoked output when a stale remote commitment
2285 // transaction is broadcast by its counterparty
2286 let chanmon_cfgs = create_chanmon_cfgs(2);
2287 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2288 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2289 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2290 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2291 // node[0] is gonna to revoke an old state thus node[1] should be able to claim the revoked output
2292 let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2293 assert_eq!(revoked_local_txn.len(), 1);
2294 // Only output is the full channel value back to nodes[0]:
2295 assert_eq!(revoked_local_txn[0].output.len(), 1);
2296 // Send a payment through, updating everyone's latest commitment txn
2297 send_payment(&nodes[0], &vec!(&nodes[1])[..], 5000000);
2299 // Inform nodes[1] that nodes[0] broadcast a stale tx
2300 mine_transaction(&nodes[1], &revoked_local_txn[0]);
2301 check_added_monitors!(nodes[1], 1);
2302 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2303 assert_eq!(node_txn.len(), 2); // ChannelMonitor: justice tx against revoked to_local output, ChannelManager: local commitment tx
2305 check_spends!(node_txn[0], revoked_local_txn[0]);
2306 check_spends!(node_txn[1], chan_1.3);
2308 // Inform nodes[0] that a watchtower cheated on its behalf, so it will force-close the chan
2309 mine_transaction(&nodes[0], &revoked_local_txn[0]);
2310 get_announce_close_broadcast_events(&nodes, 0, 1);
2311 check_added_monitors!(nodes[0], 1)
2315 fn claim_htlc_outputs_shared_tx() {
2316 // Node revoked old state, htlcs haven't time out yet, claim them in shared justice tx
2317 let mut chanmon_cfgs = create_chanmon_cfgs(2);
2318 chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
2319 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2320 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2321 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2323 // Create some new channel:
2324 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2326 // Rebalance the network to generate htlc in the two directions
2327 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
2328 // 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
2329 let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2330 let (_payment_preimage_2, payment_hash_2, _) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000);
2332 // Get the will-be-revoked local txn from node[0]
2333 let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2334 assert_eq!(revoked_local_txn.len(), 2); // commitment tx + 1 HTLC-Timeout tx
2335 assert_eq!(revoked_local_txn[0].input.len(), 1);
2336 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
2337 assert_eq!(revoked_local_txn[1].input.len(), 1);
2338 assert_eq!(revoked_local_txn[1].input[0].previous_output.txid, revoked_local_txn[0].txid());
2339 assert_eq!(revoked_local_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC-Timeout
2340 check_spends!(revoked_local_txn[1], revoked_local_txn[0]);
2342 //Revoke the old state
2343 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_1);
2346 mine_transaction(&nodes[0], &revoked_local_txn[0]);
2347 check_added_monitors!(nodes[0], 1);
2348 mine_transaction(&nodes[1], &revoked_local_txn[0]);
2349 check_added_monitors!(nodes[1], 1);
2350 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
2351 expect_payment_failed!(nodes[1], payment_hash_2, true);
2353 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2354 assert_eq!(node_txn.len(), 2); // ChannelMonitor: penalty tx, ChannelManager: local commitment
2356 assert_eq!(node_txn[0].input.len(), 3); // Claim the revoked output + both revoked HTLC outputs
2357 check_spends!(node_txn[0], revoked_local_txn[0]);
2359 let mut witness_lens = BTreeSet::new();
2360 witness_lens.insert(node_txn[0].input[0].witness.last().unwrap().len());
2361 witness_lens.insert(node_txn[0].input[1].witness.last().unwrap().len());
2362 witness_lens.insert(node_txn[0].input[2].witness.last().unwrap().len());
2363 assert_eq!(witness_lens.len(), 3);
2364 assert_eq!(*witness_lens.iter().skip(0).next().unwrap(), 77); // revoked to_local
2365 assert_eq!(*witness_lens.iter().skip(1).next().unwrap(), OFFERED_HTLC_SCRIPT_WEIGHT); // revoked offered HTLC
2366 assert_eq!(*witness_lens.iter().skip(2).next().unwrap(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // revoked received HTLC
2368 // Next nodes[1] broadcasts its current local tx state:
2369 assert_eq!(node_txn[1].input.len(), 1);
2370 assert_eq!(node_txn[1].input[0].previous_output.txid, chan_1.3.txid()); //Spending funding tx unique txouput, tx broadcasted by ChannelManager
2372 get_announce_close_broadcast_events(&nodes, 0, 1);
2373 assert_eq!(nodes[0].node.list_channels().len(), 0);
2374 assert_eq!(nodes[1].node.list_channels().len(), 0);
2378 fn claim_htlc_outputs_single_tx() {
2379 // Node revoked old state, htlcs have timed out, claim each of them in separated justice tx
2380 let mut chanmon_cfgs = create_chanmon_cfgs(2);
2381 chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
2382 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2383 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2384 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2386 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2388 // Rebalance the network to generate htlc in the two directions
2389 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
2390 // 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
2391 // time as two different claim transactions as we're gonna to timeout htlc with given a high current height
2392 let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2393 let (_payment_preimage_2, payment_hash_2, _payment_secret_2) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000);
2395 // Get the will-be-revoked local txn from node[0]
2396 let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2398 //Revoke the old state
2399 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_1);
2402 confirm_transaction_at(&nodes[0], &revoked_local_txn[0], 100);
2403 check_added_monitors!(nodes[0], 1);
2404 confirm_transaction_at(&nodes[1], &revoked_local_txn[0], 100);
2405 check_added_monitors!(nodes[1], 1);
2406 expect_pending_htlcs_forwardable_ignore!(nodes[0]);
2408 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
2409 expect_payment_failed!(nodes[1], payment_hash_2, true);
2411 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2412 assert_eq!(node_txn.len(), 9);
2413 // ChannelMonitor: justice tx revoked offered htlc, justice tx revoked received htlc, justice tx revoked to_local (3)
2414 // ChannelManager: local commmitment + local HTLC-timeout (2)
2415 // 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)
2416 // ChannelMonitor: local commitment + local HTLC-timeout (2)
2418 // Check the pair local commitment and HTLC-timeout broadcast due to HTLC expiration
2419 assert_eq!(node_txn[0].input.len(), 1);
2420 check_spends!(node_txn[0], chan_1.3);
2421 assert_eq!(node_txn[1].input.len(), 1);
2422 let witness_script = node_txn[1].input[0].witness.last().unwrap();
2423 assert_eq!(witness_script.len(), OFFERED_HTLC_SCRIPT_WEIGHT); //Spending an offered htlc output
2424 check_spends!(node_txn[1], node_txn[0]);
2426 // Justice transactions are indices 1-2-4
2427 assert_eq!(node_txn[2].input.len(), 1);
2428 assert_eq!(node_txn[3].input.len(), 1);
2429 assert_eq!(node_txn[4].input.len(), 1);
2431 check_spends!(node_txn[2], revoked_local_txn[0]);
2432 check_spends!(node_txn[3], revoked_local_txn[0]);
2433 check_spends!(node_txn[4], revoked_local_txn[0]);
2435 let mut witness_lens = BTreeSet::new();
2436 witness_lens.insert(node_txn[2].input[0].witness.last().unwrap().len());
2437 witness_lens.insert(node_txn[3].input[0].witness.last().unwrap().len());
2438 witness_lens.insert(node_txn[4].input[0].witness.last().unwrap().len());
2439 assert_eq!(witness_lens.len(), 3);
2440 assert_eq!(*witness_lens.iter().skip(0).next().unwrap(), 77); // revoked to_local
2441 assert_eq!(*witness_lens.iter().skip(1).next().unwrap(), OFFERED_HTLC_SCRIPT_WEIGHT); // revoked offered HTLC
2442 assert_eq!(*witness_lens.iter().skip(2).next().unwrap(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // revoked received HTLC
2444 get_announce_close_broadcast_events(&nodes, 0, 1);
2445 assert_eq!(nodes[0].node.list_channels().len(), 0);
2446 assert_eq!(nodes[1].node.list_channels().len(), 0);
2450 fn test_htlc_on_chain_success() {
2451 // Test that in case of a unilateral close onchain, we detect the state of output and pass
2452 // the preimage backward accordingly. So here we test that ChannelManager is
2453 // broadcasting the right event to other nodes in payment path.
2454 // We test with two HTLCs simultaneously as that was not handled correctly in the past.
2455 // A --------------------> B ----------------------> C (preimage)
2456 // First, C should claim the HTLC outputs via HTLC-Success when its own latest local
2457 // commitment transaction was broadcast.
2458 // Then, B should learn the preimage from said transactions, attempting to claim backwards
2460 // B should be able to claim via preimage if A then broadcasts its local tx.
2461 // Finally, when A sees B's latest local commitment transaction it should be able to claim
2462 // the HTLC outputs via the preimage it learned (which, once confirmed should generate a
2463 // PaymentSent event).
2465 let chanmon_cfgs = create_chanmon_cfgs(3);
2466 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2467 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2468 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2470 // Create some initial channels
2471 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2472 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
2474 // Ensure all nodes are at the same height
2475 let node_max_height = nodes.iter().map(|node| node.blocks.lock().unwrap().len()).max().unwrap() as u32;
2476 connect_blocks(&nodes[0], node_max_height - nodes[0].best_block_info().1);
2477 connect_blocks(&nodes[1], node_max_height - nodes[1].best_block_info().1);
2478 connect_blocks(&nodes[2], node_max_height - nodes[2].best_block_info().1);
2480 // Rebalance the network a bit by relaying one payment through all the channels...
2481 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
2482 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
2484 let (our_payment_preimage, payment_hash_1, _payment_secret) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2485 let (our_payment_preimage_2, payment_hash_2, _payment_secret_2) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2487 // Broadcast legit commitment tx from C on B's chain
2488 // Broadcast HTLC Success transaction by C on received output from C's commitment tx on B's chain
2489 let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
2490 assert_eq!(commitment_tx.len(), 1);
2491 check_spends!(commitment_tx[0], chan_2.3);
2492 nodes[2].node.claim_funds(our_payment_preimage);
2493 nodes[2].node.claim_funds(our_payment_preimage_2);
2494 check_added_monitors!(nodes[2], 2);
2495 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2496 assert!(updates.update_add_htlcs.is_empty());
2497 assert!(updates.update_fail_htlcs.is_empty());
2498 assert!(updates.update_fail_malformed_htlcs.is_empty());
2499 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
2501 mine_transaction(&nodes[2], &commitment_tx[0]);
2502 check_closed_broadcast!(nodes[2], true);
2503 check_added_monitors!(nodes[2], 1);
2504 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)
2505 assert_eq!(node_txn.len(), 5);
2506 assert_eq!(node_txn[0], node_txn[3]);
2507 assert_eq!(node_txn[1], node_txn[4]);
2508 assert_eq!(node_txn[2], commitment_tx[0]);
2509 check_spends!(node_txn[0], commitment_tx[0]);
2510 check_spends!(node_txn[1], commitment_tx[0]);
2511 assert_eq!(node_txn[0].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2512 assert_eq!(node_txn[1].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2513 assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2514 assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2515 assert_eq!(node_txn[0].lock_time, 0);
2516 assert_eq!(node_txn[1].lock_time, 0);
2518 // Verify that B's ChannelManager is able to extract preimage from HTLC Success tx and pass it backward
2519 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2520 connect_block(&nodes[1], &Block { header, txdata: node_txn});
2521 connect_blocks(&nodes[1], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
2523 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
2524 assert_eq!(added_monitors.len(), 1);
2525 assert_eq!(added_monitors[0].0.txid, chan_2.3.txid());
2526 added_monitors.clear();
2528 let forwarded_events = nodes[1].node.get_and_clear_pending_events();
2529 assert_eq!(forwarded_events.len(), 2);
2530 if let Event::PaymentForwarded { fee_earned_msat: Some(1000), claim_from_onchain_tx: true } = forwarded_events[0] {
2531 } else { panic!(); }
2532 if let Event::PaymentForwarded { fee_earned_msat: Some(1000), claim_from_onchain_tx: true } = forwarded_events[1] {
2533 } else { panic!(); }
2534 let events = nodes[1].node.get_and_clear_pending_msg_events();
2536 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
2537 assert_eq!(added_monitors.len(), 2);
2538 assert_eq!(added_monitors[0].0.txid, chan_1.3.txid());
2539 assert_eq!(added_monitors[1].0.txid, chan_1.3.txid());
2540 added_monitors.clear();
2542 assert_eq!(events.len(), 3);
2544 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
2545 _ => panic!("Unexpected event"),
2548 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { .. }, node_id: _ } => {},
2549 _ => panic!("Unexpected event"),
2553 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, .. } } => {
2554 assert!(update_add_htlcs.is_empty());
2555 assert!(update_fail_htlcs.is_empty());
2556 assert_eq!(update_fulfill_htlcs.len(), 1);
2557 assert!(update_fail_malformed_htlcs.is_empty());
2558 assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
2560 _ => panic!("Unexpected event"),
2562 macro_rules! check_tx_local_broadcast {
2563 ($node: expr, $htlc_offered: expr, $commitment_tx: expr, $chan_tx: expr) => { {
2564 let mut node_txn = $node.tx_broadcaster.txn_broadcasted.lock().unwrap();
2565 assert_eq!(node_txn.len(), 3);
2566 // Node[1]: ChannelManager: 3 (commitment tx, 2*HTLC-Timeout tx), ChannelMonitor: 2 (timeout tx)
2567 // Node[0]: ChannelManager: 3 (commtiemtn tx, 2*HTLC-Timeout tx), ChannelMonitor: 2 HTLC-timeout
2568 check_spends!(node_txn[1], $commitment_tx);
2569 check_spends!(node_txn[2], $commitment_tx);
2570 assert_ne!(node_txn[1].lock_time, 0);
2571 assert_ne!(node_txn[2].lock_time, 0);
2573 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2574 assert_eq!(node_txn[2].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2575 assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2576 assert!(node_txn[2].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2578 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2579 assert_eq!(node_txn[2].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2580 assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2581 assert!(node_txn[2].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2583 check_spends!(node_txn[0], $chan_tx);
2584 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), 71);
2588 // nodes[1] now broadcasts its own local state as a fallback, suggesting an alternate
2589 // commitment transaction with a corresponding HTLC-Timeout transactions, as well as a
2590 // timeout-claim of the output that nodes[2] just claimed via success.
2591 check_tx_local_broadcast!(nodes[1], false, commitment_tx[0], chan_2.3);
2593 // Broadcast legit commitment tx from A on B's chain
2594 // Broadcast preimage tx by B on offered output from A commitment tx on A's chain
2595 let node_a_commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
2596 check_spends!(node_a_commitment_tx[0], chan_1.3);
2597 mine_transaction(&nodes[1], &node_a_commitment_tx[0]);
2598 check_closed_broadcast!(nodes[1], true);
2599 check_added_monitors!(nodes[1], 1);
2600 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
2601 assert_eq!(node_txn.len(), 6); // ChannelManager : 3 (commitment tx + HTLC-Sucess * 2), ChannelMonitor : 3 (HTLC-Success, 2* RBF bumps of above HTLC txn)
2602 let commitment_spend =
2603 if node_txn[0].input[0].previous_output.txid == node_a_commitment_tx[0].txid() {
2604 check_spends!(node_txn[1], commitment_tx[0]);
2605 check_spends!(node_txn[2], commitment_tx[0]);
2606 assert_ne!(node_txn[1].input[0].previous_output.vout, node_txn[2].input[0].previous_output.vout);
2609 check_spends!(node_txn[0], commitment_tx[0]);
2610 check_spends!(node_txn[1], commitment_tx[0]);
2611 assert_ne!(node_txn[0].input[0].previous_output.vout, node_txn[1].input[0].previous_output.vout);
2615 check_spends!(commitment_spend, node_a_commitment_tx[0]);
2616 assert_eq!(commitment_spend.input.len(), 2);
2617 assert_eq!(commitment_spend.input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2618 assert_eq!(commitment_spend.input[1].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2619 assert_eq!(commitment_spend.lock_time, 0);
2620 assert!(commitment_spend.output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2621 check_spends!(node_txn[3], chan_1.3);
2622 assert_eq!(node_txn[3].input[0].witness.clone().last().unwrap().len(), 71);
2623 check_spends!(node_txn[4], node_txn[3]);
2624 check_spends!(node_txn[5], node_txn[3]);
2625 // We don't bother to check that B can claim the HTLC output on its commitment tx here as
2626 // we already checked the same situation with A.
2628 // Verify that A's ChannelManager is able to extract preimage from preimage tx and generate PaymentSent
2629 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2630 connect_block(&nodes[0], &Block { header, txdata: vec![node_a_commitment_tx[0].clone(), commitment_spend.clone()] });
2631 connect_blocks(&nodes[0], TEST_FINAL_CLTV + MIN_CLTV_EXPIRY_DELTA as u32 - 1); // Confirm blocks until the HTLC expires
2632 check_closed_broadcast!(nodes[0], true);
2633 check_added_monitors!(nodes[0], 1);
2634 let events = nodes[0].node.get_and_clear_pending_events();
2635 assert_eq!(events.len(), 2);
2636 let mut first_claimed = false;
2637 for event in events {
2639 Event::PaymentSent { payment_preimage, payment_hash } => {
2640 if payment_preimage == our_payment_preimage && payment_hash == payment_hash_1 {
2641 assert!(!first_claimed);
2642 first_claimed = true;
2644 assert_eq!(payment_preimage, our_payment_preimage_2);
2645 assert_eq!(payment_hash, payment_hash_2);
2648 _ => panic!("Unexpected event"),
2651 check_tx_local_broadcast!(nodes[0], true, node_a_commitment_tx[0], chan_1.3);
2654 fn do_test_htlc_on_chain_timeout(connect_style: ConnectStyle) {
2655 // Test that in case of a unilateral close onchain, we detect the state of output and
2656 // timeout the HTLC backward accordingly. So here we test that ChannelManager is
2657 // broadcasting the right event to other nodes in payment path.
2658 // A ------------------> B ----------------------> C (timeout)
2659 // B's commitment tx C's commitment tx
2661 // B's HTLC timeout tx B's timeout tx
2663 let chanmon_cfgs = create_chanmon_cfgs(3);
2664 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2665 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2666 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2667 *nodes[0].connect_style.borrow_mut() = connect_style;
2668 *nodes[1].connect_style.borrow_mut() = connect_style;
2669 *nodes[2].connect_style.borrow_mut() = connect_style;
2671 // Create some intial channels
2672 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2673 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
2675 // Rebalance the network a bit by relaying one payment thorugh all the channels...
2676 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
2677 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
2679 let (_payment_preimage, payment_hash, _payment_secret) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2681 // Broadcast legit commitment tx from C on B's chain
2682 let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
2683 check_spends!(commitment_tx[0], chan_2.3);
2684 nodes[2].node.fail_htlc_backwards(&payment_hash);
2685 check_added_monitors!(nodes[2], 0);
2686 expect_pending_htlcs_forwardable!(nodes[2]);
2687 check_added_monitors!(nodes[2], 1);
2689 let events = nodes[2].node.get_and_clear_pending_msg_events();
2690 assert_eq!(events.len(), 1);
2692 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, .. } } => {
2693 assert!(update_add_htlcs.is_empty());
2694 assert!(!update_fail_htlcs.is_empty());
2695 assert!(update_fulfill_htlcs.is_empty());
2696 assert!(update_fail_malformed_htlcs.is_empty());
2697 assert_eq!(nodes[1].node.get_our_node_id(), *node_id);
2699 _ => panic!("Unexpected event"),
2701 mine_transaction(&nodes[2], &commitment_tx[0]);
2702 check_closed_broadcast!(nodes[2], true);
2703 check_added_monitors!(nodes[2], 1);
2704 let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 1 (commitment tx)
2705 assert_eq!(node_txn.len(), 1);
2706 check_spends!(node_txn[0], chan_2.3);
2707 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), 71);
2709 // Broadcast timeout transaction by B on received output from C's commitment tx on B's chain
2710 // Verify that B's ChannelManager is able to detect that HTLC is timeout by its own tx and react backward in consequence
2711 connect_blocks(&nodes[1], 200 - nodes[2].best_block_info().1);
2712 mine_transaction(&nodes[1], &commitment_tx[0]);
2715 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2716 assert_eq!(node_txn.len(), 5); // ChannelManager : 2 (commitment tx, HTLC-Timeout tx), ChannelMonitor : 2 (local commitment tx + HTLC-timeout), 1 timeout tx
2717 assert_eq!(node_txn[0], node_txn[3]);
2718 assert_eq!(node_txn[1], node_txn[4]);
2720 check_spends!(node_txn[2], commitment_tx[0]);
2721 assert_eq!(node_txn[2].clone().input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2723 check_spends!(node_txn[0], chan_2.3);
2724 check_spends!(node_txn[1], node_txn[0]);
2725 assert_eq!(node_txn[0].clone().input[0].witness.last().unwrap().len(), 71);
2726 assert_eq!(node_txn[1].clone().input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2728 timeout_tx = node_txn[2].clone();
2732 mine_transaction(&nodes[1], &timeout_tx);
2733 check_added_monitors!(nodes[1], 1);
2734 check_closed_broadcast!(nodes[1], true);
2736 // B will rebroadcast a fee-bumped timeout transaction here.
2737 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
2738 assert_eq!(node_txn.len(), 1);
2739 check_spends!(node_txn[0], commitment_tx[0]);
2742 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
2744 // B may rebroadcast its own holder commitment transaction here, as a safeguard against
2745 // some incredibly unlikely partial-eclipse-attack scenarios. That said, because the
2746 // original commitment_tx[0] (also spending chan_2.3) has reached ANTI_REORG_DELAY B really
2747 // shouldn't broadcast anything here, and in some connect style scenarios we do not.
2748 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
2749 if node_txn.len() == 1 {
2750 check_spends!(node_txn[0], chan_2.3);
2752 assert_eq!(node_txn.len(), 0);
2756 expect_pending_htlcs_forwardable!(nodes[1]);
2757 check_added_monitors!(nodes[1], 1);
2758 let events = nodes[1].node.get_and_clear_pending_msg_events();
2759 assert_eq!(events.len(), 1);
2761 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, .. } } => {
2762 assert!(update_add_htlcs.is_empty());
2763 assert!(!update_fail_htlcs.is_empty());
2764 assert!(update_fulfill_htlcs.is_empty());
2765 assert!(update_fail_malformed_htlcs.is_empty());
2766 assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
2768 _ => panic!("Unexpected event"),
2771 // Broadcast legit commitment tx from B on A's chain
2772 let commitment_tx = get_local_commitment_txn!(nodes[1], chan_1.2);
2773 check_spends!(commitment_tx[0], chan_1.3);
2775 mine_transaction(&nodes[0], &commitment_tx[0]);
2776 connect_blocks(&nodes[0], TEST_FINAL_CLTV + MIN_CLTV_EXPIRY_DELTA as u32 - 1); // Confirm blocks until the HTLC expires
2778 check_closed_broadcast!(nodes[0], true);
2779 check_added_monitors!(nodes[0], 1);
2780 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 1 commitment tx, ChannelMonitor : 1 timeout tx
2781 assert_eq!(node_txn.len(), 2);
2782 check_spends!(node_txn[0], chan_1.3);
2783 assert_eq!(node_txn[0].clone().input[0].witness.last().unwrap().len(), 71);
2784 check_spends!(node_txn[1], commitment_tx[0]);
2785 assert_eq!(node_txn[1].clone().input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2789 fn test_htlc_on_chain_timeout() {
2790 do_test_htlc_on_chain_timeout(ConnectStyle::BestBlockFirstSkippingBlocks);
2791 do_test_htlc_on_chain_timeout(ConnectStyle::TransactionsFirstSkippingBlocks);
2792 do_test_htlc_on_chain_timeout(ConnectStyle::FullBlockViaListen);
2796 fn test_simple_commitment_revoked_fail_backward() {
2797 // Test that in case of a revoked commitment tx, we detect the resolution of output by justice tx
2798 // and fail backward accordingly.
2800 let chanmon_cfgs = create_chanmon_cfgs(3);
2801 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2802 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2803 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2805 // Create some initial channels
2806 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2807 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
2809 let (payment_preimage, _payment_hash, _payment_secret) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3000000);
2810 // Get the will-be-revoked local txn from nodes[2]
2811 let revoked_local_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
2812 // Revoke the old state
2813 claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage);
2815 let (_, payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3000000);
2817 mine_transaction(&nodes[1], &revoked_local_txn[0]);
2818 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
2819 check_added_monitors!(nodes[1], 1);
2820 check_closed_broadcast!(nodes[1], true);
2822 expect_pending_htlcs_forwardable!(nodes[1]);
2823 check_added_monitors!(nodes[1], 1);
2824 let events = nodes[1].node.get_and_clear_pending_msg_events();
2825 assert_eq!(events.len(), 1);
2827 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, .. } } => {
2828 assert!(update_add_htlcs.is_empty());
2829 assert_eq!(update_fail_htlcs.len(), 1);
2830 assert!(update_fulfill_htlcs.is_empty());
2831 assert!(update_fail_malformed_htlcs.is_empty());
2832 assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
2834 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
2835 commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
2836 expect_payment_failed_with_update!(nodes[0], payment_hash, false, chan_2.0.contents.short_channel_id, true);
2838 _ => panic!("Unexpected event"),
2842 fn do_test_commitment_revoked_fail_backward_exhaustive(deliver_bs_raa: bool, use_dust: bool, no_to_remote: bool) {
2843 // Test that if our counterparty broadcasts a revoked commitment transaction we fail all
2844 // pending HTLCs on that channel backwards even if the HTLCs aren't present in our latest
2845 // commitment transaction anymore.
2846 // To do this, we have the peer which will broadcast a revoked commitment transaction send
2847 // a number of update_fail/commitment_signed updates without ever sending the RAA in
2848 // response to our commitment_signed. This is somewhat misbehavior-y, though not
2849 // technically disallowed and we should probably handle it reasonably.
2850 // Note that this is pretty exhaustive as an outbound HTLC which we haven't yet
2851 // failed/fulfilled backwards must be in at least one of the latest two remote commitment
2853 // * Once we move it out of our holding cell/add it, we will immediately include it in a
2854 // commitment_signed (implying it will be in the latest remote commitment transaction).
2855 // * Once they remove it, we will send a (the first) commitment_signed without the HTLC,
2856 // and once they revoke the previous commitment transaction (allowing us to send a new
2857 // commitment_signed) we will be free to fail/fulfill the HTLC backwards.
2858 let chanmon_cfgs = create_chanmon_cfgs(3);
2859 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2860 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2861 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2863 // Create some initial channels
2864 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2865 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
2867 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 });
2868 // Get the will-be-revoked local txn from nodes[2]
2869 let revoked_local_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
2870 assert_eq!(revoked_local_txn[0].output.len(), if no_to_remote { 1 } else { 2 });
2871 // Revoke the old state
2872 claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage);
2874 let value = if use_dust {
2875 // The dust limit applied to HTLC outputs considers the fee of the HTLC transaction as
2876 // well, so HTLCs at exactly the dust limit will not be included in commitment txn.
2877 nodes[2].node.channel_state.lock().unwrap().by_id.get(&chan_2.2).unwrap().holder_dust_limit_satoshis * 1000
2880 let (_, first_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
2881 let (_, second_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
2882 let (_, third_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
2884 assert!(nodes[2].node.fail_htlc_backwards(&first_payment_hash));
2885 expect_pending_htlcs_forwardable!(nodes[2]);
2886 check_added_monitors!(nodes[2], 1);
2887 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2888 assert!(updates.update_add_htlcs.is_empty());
2889 assert!(updates.update_fulfill_htlcs.is_empty());
2890 assert!(updates.update_fail_malformed_htlcs.is_empty());
2891 assert_eq!(updates.update_fail_htlcs.len(), 1);
2892 assert!(updates.update_fee.is_none());
2893 nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
2894 let bs_raa = commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false, true, false, true);
2895 // Drop the last RAA from 3 -> 2
2897 assert!(nodes[2].node.fail_htlc_backwards(&second_payment_hash));
2898 expect_pending_htlcs_forwardable!(nodes[2]);
2899 check_added_monitors!(nodes[2], 1);
2900 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2901 assert!(updates.update_add_htlcs.is_empty());
2902 assert!(updates.update_fulfill_htlcs.is_empty());
2903 assert!(updates.update_fail_malformed_htlcs.is_empty());
2904 assert_eq!(updates.update_fail_htlcs.len(), 1);
2905 assert!(updates.update_fee.is_none());
2906 nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
2907 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &updates.commitment_signed);
2908 check_added_monitors!(nodes[1], 1);
2909 // Note that nodes[1] is in AwaitingRAA, so won't send a CS
2910 let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
2911 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
2912 check_added_monitors!(nodes[2], 1);
2914 assert!(nodes[2].node.fail_htlc_backwards(&third_payment_hash));
2915 expect_pending_htlcs_forwardable!(nodes[2]);
2916 check_added_monitors!(nodes[2], 1);
2917 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2918 assert!(updates.update_add_htlcs.is_empty());
2919 assert!(updates.update_fulfill_htlcs.is_empty());
2920 assert!(updates.update_fail_malformed_htlcs.is_empty());
2921 assert_eq!(updates.update_fail_htlcs.len(), 1);
2922 assert!(updates.update_fee.is_none());
2923 nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
2924 // At this point first_payment_hash has dropped out of the latest two commitment
2925 // transactions that nodes[1] is tracking...
2926 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &updates.commitment_signed);
2927 check_added_monitors!(nodes[1], 1);
2928 // Note that nodes[1] is (still) in AwaitingRAA, so won't send a CS
2929 let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
2930 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
2931 check_added_monitors!(nodes[2], 1);
2933 // Add a fourth HTLC, this one will get sequestered away in nodes[1]'s holding cell waiting
2934 // on nodes[2]'s RAA.
2935 let (_, fourth_payment_hash, fourth_payment_secret) = get_payment_preimage_hash!(nodes[2]);
2936 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
2937 let logger = test_utils::TestLogger::new();
2938 let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[2].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
2939 nodes[1].node.send_payment(&route, fourth_payment_hash, &Some(fourth_payment_secret)).unwrap();
2940 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2941 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
2942 check_added_monitors!(nodes[1], 0);
2945 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_raa);
2946 // One monitor for the new revocation preimage, no second on as we won't generate a new
2947 // commitment transaction for nodes[0] until process_pending_htlc_forwards().
2948 check_added_monitors!(nodes[1], 1);
2949 let events = nodes[1].node.get_and_clear_pending_events();
2950 assert_eq!(events.len(), 1);
2952 Event::PendingHTLCsForwardable { .. } => { },
2953 _ => panic!("Unexpected event"),
2955 // Deliberately don't process the pending fail-back so they all fail back at once after
2956 // block connection just like the !deliver_bs_raa case
2959 let mut failed_htlcs = HashSet::new();
2960 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
2962 mine_transaction(&nodes[1], &revoked_local_txn[0]);
2963 check_added_monitors!(nodes[1], 1);
2964 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
2966 let events = nodes[1].node.get_and_clear_pending_events();
2967 assert_eq!(events.len(), if deliver_bs_raa { 1 } else { 2 });
2969 Event::PaymentFailed { ref payment_hash, .. } => {
2970 assert_eq!(*payment_hash, fourth_payment_hash);
2972 _ => panic!("Unexpected event"),
2974 if !deliver_bs_raa {
2976 Event::PendingHTLCsForwardable { .. } => { },
2977 _ => panic!("Unexpected event"),
2980 nodes[1].node.process_pending_htlc_forwards();
2981 check_added_monitors!(nodes[1], 1);
2983 let events = nodes[1].node.get_and_clear_pending_msg_events();
2984 assert_eq!(events.len(), if deliver_bs_raa { 4 } else { 3 });
2985 match events[if deliver_bs_raa { 1 } else { 0 }] {
2986 MessageSendEvent::BroadcastChannelUpdate { msg: msgs::ChannelUpdate { .. } } => {},
2987 _ => panic!("Unexpected event"),
2989 match events[if deliver_bs_raa { 2 } else { 1 }] {
2990 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { msg: msgs::ErrorMessage { channel_id, ref data } }, node_id: _ } => {
2991 assert_eq!(channel_id, chan_2.2);
2992 assert_eq!(data.as_str(), "Commitment or closing transaction was confirmed on chain.");
2994 _ => panic!("Unexpected event"),
2998 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, .. } } => {
2999 assert_eq!(nodes[2].node.get_our_node_id(), *node_id);
3000 assert_eq!(update_add_htlcs.len(), 1);
3001 assert!(update_fulfill_htlcs.is_empty());
3002 assert!(update_fail_htlcs.is_empty());
3003 assert!(update_fail_malformed_htlcs.is_empty());
3005 _ => panic!("Unexpected event"),
3008 match events[if deliver_bs_raa { 3 } else { 2 }] {
3009 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, .. } } => {
3010 assert!(update_add_htlcs.is_empty());
3011 assert_eq!(update_fail_htlcs.len(), 3);
3012 assert!(update_fulfill_htlcs.is_empty());
3013 assert!(update_fail_malformed_htlcs.is_empty());
3014 assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
3016 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
3017 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[1]);
3018 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[2]);
3020 commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
3022 let events = nodes[0].node.get_and_clear_pending_events();
3023 assert_eq!(events.len(), 3);
3025 Event::PaymentFailed { ref payment_hash, rejected_by_dest: _, ref network_update, .. } => {
3026 assert!(failed_htlcs.insert(payment_hash.0));
3027 // If we delivered B's RAA we got an unknown preimage error, not something
3028 // that we should update our routing table for.
3029 if !deliver_bs_raa {
3030 assert!(network_update.is_some());
3033 _ => panic!("Unexpected event"),
3036 Event::PaymentFailed { ref payment_hash, rejected_by_dest: _, ref network_update, .. } => {
3037 assert!(failed_htlcs.insert(payment_hash.0));
3038 assert!(network_update.is_some());
3040 _ => panic!("Unexpected event"),
3043 Event::PaymentFailed { ref payment_hash, rejected_by_dest: _, ref network_update, .. } => {
3044 assert!(failed_htlcs.insert(payment_hash.0));
3045 assert!(network_update.is_some());
3047 _ => panic!("Unexpected event"),
3050 _ => panic!("Unexpected event"),
3053 assert!(failed_htlcs.contains(&first_payment_hash.0));
3054 assert!(failed_htlcs.contains(&second_payment_hash.0));
3055 assert!(failed_htlcs.contains(&third_payment_hash.0));
3059 fn test_commitment_revoked_fail_backward_exhaustive_a() {
3060 do_test_commitment_revoked_fail_backward_exhaustive(false, true, false);
3061 do_test_commitment_revoked_fail_backward_exhaustive(true, true, false);
3062 do_test_commitment_revoked_fail_backward_exhaustive(false, false, false);
3063 do_test_commitment_revoked_fail_backward_exhaustive(true, false, false);
3067 fn test_commitment_revoked_fail_backward_exhaustive_b() {
3068 do_test_commitment_revoked_fail_backward_exhaustive(false, true, true);
3069 do_test_commitment_revoked_fail_backward_exhaustive(true, true, true);
3070 do_test_commitment_revoked_fail_backward_exhaustive(false, false, true);
3071 do_test_commitment_revoked_fail_backward_exhaustive(true, false, true);
3075 fn fail_backward_pending_htlc_upon_channel_failure() {
3076 let chanmon_cfgs = create_chanmon_cfgs(2);
3077 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3078 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3079 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3080 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1_000_000, 500_000_000, InitFeatures::known(), InitFeatures::known());
3081 let logger = test_utils::TestLogger::new();
3083 // Alice -> Bob: Route a payment but without Bob sending revoke_and_ack.
3085 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1]);
3086 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3087 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 50_000, TEST_FINAL_CLTV, &logger).unwrap();
3088 nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
3089 check_added_monitors!(nodes[0], 1);
3091 let payment_event = {
3092 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3093 assert_eq!(events.len(), 1);
3094 SendEvent::from_event(events.remove(0))
3096 assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
3097 assert_eq!(payment_event.msgs.len(), 1);
3100 // Alice -> Bob: Route another payment but now Alice waits for Bob's earlier revoke_and_ack.
3101 let (_, failed_payment_hash, failed_payment_secret) = get_payment_preimage_hash!(nodes[1]);
3103 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3104 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 50_000, TEST_FINAL_CLTV, &logger).unwrap();
3105 nodes[0].node.send_payment(&route, failed_payment_hash, &Some(failed_payment_secret)).unwrap();
3106 check_added_monitors!(nodes[0], 0);
3108 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3111 // Alice <- Bob: Send a malformed update_add_htlc so Alice fails the channel.
3113 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[0]);
3115 let secp_ctx = Secp256k1::new();
3116 let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
3117 let current_height = nodes[1].node.best_block.read().unwrap().height() + 1;
3118 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
3119 let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[0].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 50_000, TEST_FINAL_CLTV, &logger).unwrap();
3120 let (onion_payloads, _amount_msat, cltv_expiry) = onion_utils::build_onion_payloads(&route.paths[0], 50_000, &Some(payment_secret), current_height, &None).unwrap();
3121 let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route.paths[0], &session_priv).unwrap();
3122 let onion_routing_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
3124 // Send a 0-msat update_add_htlc to fail the channel.
3125 let update_add_htlc = msgs::UpdateAddHTLC {
3131 onion_routing_packet,
3133 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &update_add_htlc);
3136 // Check that Alice fails backward the pending HTLC from the second payment.
3137 expect_payment_failed!(nodes[0], failed_payment_hash, true);
3138 check_closed_broadcast!(nodes[0], true);
3139 check_added_monitors!(nodes[0], 1);
3143 fn test_htlc_ignore_latest_remote_commitment() {
3144 // Test that HTLC transactions spending the latest remote commitment transaction are simply
3145 // ignored if we cannot claim them. This originally tickled an invalid unwrap().
3146 let chanmon_cfgs = create_chanmon_cfgs(2);
3147 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3148 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3149 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3150 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3152 route_payment(&nodes[0], &[&nodes[1]], 10000000);
3153 nodes[0].node.force_close_channel(&nodes[0].node.list_channels()[0].channel_id).unwrap();
3154 connect_blocks(&nodes[0], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + 1);
3155 check_closed_broadcast!(nodes[0], true);
3156 check_added_monitors!(nodes[0], 1);
3158 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
3159 assert_eq!(node_txn.len(), 3);
3160 assert_eq!(node_txn[0], node_txn[1]);
3162 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3163 connect_block(&nodes[1], &Block { header, txdata: vec![node_txn[0].clone(), node_txn[1].clone()]});
3164 check_closed_broadcast!(nodes[1], true);
3165 check_added_monitors!(nodes[1], 1);
3167 // Duplicate the connect_block call since this may happen due to other listeners
3168 // registering new transactions
3169 header.prev_blockhash = header.block_hash();
3170 connect_block(&nodes[1], &Block { header, txdata: vec![node_txn[0].clone(), node_txn[2].clone()]});
3174 fn test_force_close_fail_back() {
3175 // Check which HTLCs are failed-backwards on channel force-closure
3176 let chanmon_cfgs = create_chanmon_cfgs(3);
3177 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3178 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3179 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3180 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3181 create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3182 let logger = test_utils::TestLogger::new();
3184 let (our_payment_preimage, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[2]);
3186 let mut payment_event = {
3187 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3188 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[2].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 1000000, 42, &logger).unwrap();
3189 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
3190 check_added_monitors!(nodes[0], 1);
3192 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3193 assert_eq!(events.len(), 1);
3194 SendEvent::from_event(events.remove(0))
3197 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
3198 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
3200 expect_pending_htlcs_forwardable!(nodes[1]);
3202 let mut events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3203 assert_eq!(events_2.len(), 1);
3204 payment_event = SendEvent::from_event(events_2.remove(0));
3205 assert_eq!(payment_event.msgs.len(), 1);
3207 check_added_monitors!(nodes[1], 1);
3208 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
3209 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg);
3210 check_added_monitors!(nodes[2], 1);
3211 let (_, _) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3213 // nodes[2] now has the latest commitment transaction, but hasn't revoked its previous
3214 // state or updated nodes[1]' state. Now force-close and broadcast that commitment/HTLC
3215 // transaction and ensure nodes[1] doesn't fail-backwards (this was originally a bug!).
3217 nodes[2].node.force_close_channel(&payment_event.commitment_msg.channel_id).unwrap();
3218 check_closed_broadcast!(nodes[2], true);
3219 check_added_monitors!(nodes[2], 1);
3221 let mut node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap();
3222 // Note that we don't bother broadcasting the HTLC-Success transaction here as we don't
3223 // have a use for it unless nodes[2] learns the preimage somehow, the funds will go
3224 // back to nodes[1] upon timeout otherwise.
3225 assert_eq!(node_txn.len(), 1);
3229 mine_transaction(&nodes[1], &tx);
3231 // Note no UpdateHTLCs event here from nodes[1] to nodes[0]!
3232 check_closed_broadcast!(nodes[1], true);
3233 check_added_monitors!(nodes[1], 1);
3235 // Now check that if we add the preimage to ChannelMonitor it broadcasts our HTLC-Success..
3237 let mut monitors = nodes[2].chain_monitor.chain_monitor.monitors.read().unwrap();
3238 monitors.get(&OutPoint{ txid: Txid::from_slice(&payment_event.commitment_msg.channel_id[..]).unwrap(), index: 0 }).unwrap()
3239 .provide_payment_preimage(&our_payment_hash, &our_payment_preimage, &node_cfgs[2].tx_broadcaster, &node_cfgs[2].fee_estimator, &&logger);
3241 mine_transaction(&nodes[2], &tx);
3242 let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap();
3243 assert_eq!(node_txn.len(), 1);
3244 assert_eq!(node_txn[0].input.len(), 1);
3245 assert_eq!(node_txn[0].input[0].previous_output.txid, tx.txid());
3246 assert_eq!(node_txn[0].lock_time, 0); // Must be an HTLC-Success
3247 assert_eq!(node_txn[0].input[0].witness.len(), 5); // Must be an HTLC-Success
3249 check_spends!(node_txn[0], tx);
3253 fn test_dup_events_on_peer_disconnect() {
3254 // Test that if we receive a duplicative update_fulfill_htlc message after a reconnect we do
3255 // not generate a corresponding duplicative PaymentSent event. This did not use to be the case
3256 // as we used to generate the event immediately upon receipt of the payment preimage in the
3257 // update_fulfill_htlc message.
3259 let chanmon_cfgs = create_chanmon_cfgs(2);
3260 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3261 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3262 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3263 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3265 let payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 1000000).0;
3267 assert!(nodes[1].node.claim_funds(payment_preimage));
3268 check_added_monitors!(nodes[1], 1);
3269 let claim_msgs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3270 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &claim_msgs.update_fulfill_htlcs[0]);
3271 expect_payment_sent!(nodes[0], payment_preimage);
3273 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3274 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3276 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (1, 0), (0, 0), (0, 0), (0, 0), (false, false));
3277 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
3281 fn test_simple_peer_disconnect() {
3282 // Test that we can reconnect when there are no lost messages
3283 let chanmon_cfgs = create_chanmon_cfgs(3);
3284 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3285 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3286 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3287 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3288 create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3290 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3291 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3292 reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3294 let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3295 let payment_hash_2 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3296 fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_hash_2);
3297 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_preimage_1);
3299 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3300 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3301 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3303 let (payment_preimage_3, payment_hash_3, _) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000);
3304 let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3305 let payment_hash_5 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3306 let payment_hash_6 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3308 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3309 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3311 claim_payment_along_route(&nodes[0], &[&[&nodes[1], &nodes[2]]], true, payment_preimage_3);
3312 fail_payment_along_route(&nodes[0], &[&[&nodes[1], &nodes[2]]], true, payment_hash_5);
3314 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (1, 0), (1, 0), (false, false));
3316 let events = nodes[0].node.get_and_clear_pending_events();
3317 assert_eq!(events.len(), 2);
3319 Event::PaymentSent { payment_preimage, payment_hash } => {
3320 assert_eq!(payment_preimage, payment_preimage_3);
3321 assert_eq!(payment_hash, payment_hash_3);
3323 _ => panic!("Unexpected event"),
3326 Event::PaymentFailed { payment_hash, rejected_by_dest, .. } => {
3327 assert_eq!(payment_hash, payment_hash_5);
3328 assert!(rejected_by_dest);
3330 _ => panic!("Unexpected event"),
3334 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_preimage_4);
3335 fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_hash_6);
3338 fn do_test_drop_messages_peer_disconnect(messages_delivered: u8, simulate_broken_lnd: bool) {
3339 // Test that we can reconnect when in-flight HTLC updates get dropped
3340 let chanmon_cfgs = create_chanmon_cfgs(2);
3341 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3342 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3343 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3345 let mut as_funding_locked = None;
3346 if messages_delivered == 0 {
3347 let (funding_locked, _, _) = create_chan_between_nodes_with_value_a(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
3348 as_funding_locked = Some(funding_locked);
3349 // nodes[1] doesn't receive the funding_locked message (it'll be re-sent on reconnect)
3350 // Note that we store it so that if we're running with `simulate_broken_lnd` we can deliver
3351 // it before the channel_reestablish message.
3353 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3356 let (payment_preimage_1, payment_hash_1, payment_secret_1) = get_payment_preimage_hash!(nodes[1]);
3358 let logger = test_utils::TestLogger::new();
3359 let payment_event = {
3360 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3361 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph,
3362 &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), Some(&nodes[0].node.list_usable_channels().iter().collect::<Vec<_>>()),
3363 &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
3364 nodes[0].node.send_payment(&route, payment_hash_1, &Some(payment_secret_1)).unwrap();
3365 check_added_monitors!(nodes[0], 1);
3367 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3368 assert_eq!(events.len(), 1);
3369 SendEvent::from_event(events.remove(0))
3371 assert_eq!(nodes[1].node.get_our_node_id(), payment_event.node_id);
3373 if messages_delivered < 2 {
3374 // Drop the payment_event messages, and let them get re-generated in reconnect_nodes!
3376 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
3377 if messages_delivered >= 3 {
3378 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
3379 check_added_monitors!(nodes[1], 1);
3380 let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3382 if messages_delivered >= 4 {
3383 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3384 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3385 check_added_monitors!(nodes[0], 1);
3387 if messages_delivered >= 5 {
3388 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_commitment_signed);
3389 let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3390 // No commitment_signed so get_event_msg's assert(len == 1) passes
3391 check_added_monitors!(nodes[0], 1);
3393 if messages_delivered >= 6 {
3394 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3395 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3396 check_added_monitors!(nodes[1], 1);
3403 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3404 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3405 if messages_delivered < 3 {
3406 if simulate_broken_lnd {
3407 // lnd has a long-standing bug where they send a funding_locked prior to a
3408 // channel_reestablish if you reconnect prior to funding_locked time.
3410 // Here we simulate that behavior, delivering a funding_locked immediately on
3411 // reconnect. Note that we don't bother skipping the now-duplicate funding_locked sent
3412 // in `reconnect_nodes` but we currently don't fail based on that.
3414 // See-also <https://github.com/lightningnetwork/lnd/issues/4006>
3415 nodes[1].node.handle_funding_locked(&nodes[0].node.get_our_node_id(), &as_funding_locked.as_ref().unwrap().0);
3417 // Even if the funding_locked messages get exchanged, as long as nothing further was
3418 // received on either side, both sides will need to resend them.
3419 reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 1), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3420 } else if messages_delivered == 3 {
3421 // nodes[0] still wants its RAA + commitment_signed
3422 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (-1, 0), (0, 0), (0, 0), (0, 0), (0, 0), (true, false));
3423 } else if messages_delivered == 4 {
3424 // nodes[0] still wants its commitment_signed
3425 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (-1, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3426 } else if messages_delivered == 5 {
3427 // nodes[1] still wants its final RAA
3428 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, true));
3429 } else if messages_delivered == 6 {
3430 // Everything was delivered...
3431 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3434 let events_1 = nodes[1].node.get_and_clear_pending_events();
3435 assert_eq!(events_1.len(), 1);
3437 Event::PendingHTLCsForwardable { .. } => { },
3438 _ => panic!("Unexpected event"),
3441 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3442 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3443 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3445 nodes[1].node.process_pending_htlc_forwards();
3447 let events_2 = nodes[1].node.get_and_clear_pending_events();
3448 assert_eq!(events_2.len(), 1);
3450 Event::PaymentReceived { ref payment_hash, ref purpose, amt } => {
3451 assert_eq!(payment_hash_1, *payment_hash);
3452 assert_eq!(amt, 1000000);
3454 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
3455 assert!(payment_preimage.is_none());
3456 assert_eq!(payment_secret_1, *payment_secret);
3458 _ => panic!("expected PaymentPurpose::InvoicePayment")
3461 _ => panic!("Unexpected event"),
3464 nodes[1].node.claim_funds(payment_preimage_1);
3465 check_added_monitors!(nodes[1], 1);
3467 let events_3 = nodes[1].node.get_and_clear_pending_msg_events();
3468 assert_eq!(events_3.len(), 1);
3469 let (update_fulfill_htlc, commitment_signed) = match events_3[0] {
3470 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
3471 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3472 assert!(updates.update_add_htlcs.is_empty());
3473 assert!(updates.update_fail_htlcs.is_empty());
3474 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
3475 assert!(updates.update_fail_malformed_htlcs.is_empty());
3476 assert!(updates.update_fee.is_none());
3477 (updates.update_fulfill_htlcs[0].clone(), updates.commitment_signed.clone())
3479 _ => panic!("Unexpected event"),
3482 if messages_delivered >= 1 {
3483 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlc);
3485 let events_4 = nodes[0].node.get_and_clear_pending_events();
3486 assert_eq!(events_4.len(), 1);
3488 Event::PaymentSent { ref payment_preimage, ref payment_hash } => {
3489 assert_eq!(payment_preimage_1, *payment_preimage);
3490 assert_eq!(payment_hash_1, *payment_hash);
3492 _ => panic!("Unexpected event"),
3495 if messages_delivered >= 2 {
3496 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
3497 check_added_monitors!(nodes[0], 1);
3498 let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
3500 if messages_delivered >= 3 {
3501 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3502 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3503 check_added_monitors!(nodes[1], 1);
3505 if messages_delivered >= 4 {
3506 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed);
3507 let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3508 // No commitment_signed so get_event_msg's assert(len == 1) passes
3509 check_added_monitors!(nodes[1], 1);
3511 if messages_delivered >= 5 {
3512 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3513 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3514 check_added_monitors!(nodes[0], 1);
3521 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3522 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3523 if messages_delivered < 2 {
3524 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (1, 0), (0, 0), (0, 0), (0, 0), (false, false));
3525 if messages_delivered < 1 {
3526 let events_4 = nodes[0].node.get_and_clear_pending_events();
3527 assert_eq!(events_4.len(), 1);
3529 Event::PaymentSent { ref payment_preimage, ref payment_hash } => {
3530 assert_eq!(payment_preimage_1, *payment_preimage);
3531 assert_eq!(payment_hash_1, *payment_hash);
3533 _ => panic!("Unexpected event"),
3536 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3538 } else if messages_delivered == 2 {
3539 // nodes[0] still wants its RAA + commitment_signed
3540 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, -1), (0, 0), (0, 0), (0, 0), (0, 0), (false, true));
3541 } else if messages_delivered == 3 {
3542 // nodes[0] still wants its commitment_signed
3543 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, -1), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3544 } else if messages_delivered == 4 {
3545 // nodes[1] still wants its final RAA
3546 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (true, false));
3547 } else if messages_delivered == 5 {
3548 // Everything was delivered...
3549 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3552 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3553 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3554 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3556 // Channel should still work fine...
3557 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3558 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph,
3559 &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), Some(&nodes[0].node.list_usable_channels().iter().collect::<Vec<_>>()),
3560 &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
3561 let payment_preimage_2 = send_along_route(&nodes[0], route, &[&nodes[1]], 1000000).0;
3562 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
3566 fn test_drop_messages_peer_disconnect_a() {
3567 do_test_drop_messages_peer_disconnect(0, true);
3568 do_test_drop_messages_peer_disconnect(0, false);
3569 do_test_drop_messages_peer_disconnect(1, false);
3570 do_test_drop_messages_peer_disconnect(2, false);
3574 fn test_drop_messages_peer_disconnect_b() {
3575 do_test_drop_messages_peer_disconnect(3, false);
3576 do_test_drop_messages_peer_disconnect(4, false);
3577 do_test_drop_messages_peer_disconnect(5, false);
3578 do_test_drop_messages_peer_disconnect(6, false);
3582 fn test_funding_peer_disconnect() {
3583 // Test that we can lock in our funding tx while disconnected
3584 let chanmon_cfgs = create_chanmon_cfgs(2);
3585 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3586 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3587 let persister: test_utils::TestPersister;
3588 let new_chain_monitor: test_utils::TestChainMonitor;
3589 let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
3590 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3591 let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
3593 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3594 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3596 confirm_transaction(&nodes[0], &tx);
3597 let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
3598 assert_eq!(events_1.len(), 1);
3600 MessageSendEvent::SendFundingLocked { ref node_id, msg: _ } => {
3601 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
3603 _ => panic!("Unexpected event"),
3606 reconnect_nodes(&nodes[0], &nodes[1], (false, true), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3608 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3609 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3611 confirm_transaction(&nodes[1], &tx);
3612 let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3613 assert_eq!(events_2.len(), 2);
3614 let funding_locked = match events_2[0] {
3615 MessageSendEvent::SendFundingLocked { ref node_id, ref msg } => {
3616 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3619 _ => panic!("Unexpected event"),
3621 let bs_announcement_sigs = match events_2[1] {
3622 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
3623 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3626 _ => panic!("Unexpected event"),
3629 reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3631 nodes[0].node.handle_funding_locked(&nodes[1].node.get_our_node_id(), &funding_locked);
3632 nodes[0].node.handle_announcement_signatures(&nodes[1].node.get_our_node_id(), &bs_announcement_sigs);
3633 let events_3 = nodes[0].node.get_and_clear_pending_msg_events();
3634 assert_eq!(events_3.len(), 2);
3635 let as_announcement_sigs = match events_3[0] {
3636 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
3637 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
3640 _ => panic!("Unexpected event"),
3642 let (as_announcement, as_update) = match events_3[1] {
3643 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
3644 (msg.clone(), update_msg.clone())
3646 _ => panic!("Unexpected event"),
3649 nodes[1].node.handle_announcement_signatures(&nodes[0].node.get_our_node_id(), &as_announcement_sigs);
3650 let events_4 = nodes[1].node.get_and_clear_pending_msg_events();
3651 assert_eq!(events_4.len(), 1);
3652 let (_, bs_update) = match events_4[0] {
3653 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
3654 (msg.clone(), update_msg.clone())
3656 _ => panic!("Unexpected event"),
3659 nodes[0].net_graph_msg_handler.handle_channel_announcement(&as_announcement).unwrap();
3660 nodes[0].net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
3661 nodes[0].net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
3663 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3664 let logger = test_utils::TestLogger::new();
3665 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
3666 let (payment_preimage, _, _) = send_along_route(&nodes[0], route, &[&nodes[1]], 1000000);
3667 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage);
3669 // Check that after deserialization and reconnection we can still generate an identical
3670 // channel_announcement from the cached signatures.
3671 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3673 let nodes_0_serialized = nodes[0].node.encode();
3674 let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
3675 nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
3677 persister = test_utils::TestPersister::new();
3678 let keys_manager = &chanmon_cfgs[0].keys_manager;
3679 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);
3680 nodes[0].chain_monitor = &new_chain_monitor;
3681 let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
3682 let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
3683 &mut chan_0_monitor_read, keys_manager).unwrap();
3684 assert!(chan_0_monitor_read.is_empty());
3686 let mut nodes_0_read = &nodes_0_serialized[..];
3687 let (_, nodes_0_deserialized_tmp) = {
3688 let mut channel_monitors = HashMap::new();
3689 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
3690 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
3691 default_config: UserConfig::default(),
3693 fee_estimator: node_cfgs[0].fee_estimator,
3694 chain_monitor: nodes[0].chain_monitor,
3695 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
3696 logger: nodes[0].logger,
3700 nodes_0_deserialized = nodes_0_deserialized_tmp;
3701 assert!(nodes_0_read.is_empty());
3703 assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
3704 nodes[0].node = &nodes_0_deserialized;
3705 check_added_monitors!(nodes[0], 1);
3707 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3709 // as_announcement should be re-generated exactly by broadcast_node_announcement.
3710 nodes[0].node.broadcast_node_announcement([0, 0, 0], [0; 32], Vec::new());
3711 let msgs = nodes[0].node.get_and_clear_pending_msg_events();
3712 let mut found_announcement = false;
3713 for event in msgs.iter() {
3715 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, .. } => {
3716 if *msg == as_announcement { found_announcement = true; }
3718 MessageSendEvent::BroadcastNodeAnnouncement { .. } => {},
3719 _ => panic!("Unexpected event"),
3722 assert!(found_announcement);
3726 fn test_drop_messages_peer_disconnect_dual_htlc() {
3727 // Test that we can handle reconnecting when both sides of a channel have pending
3728 // commitment_updates when we disconnect.
3729 let chanmon_cfgs = create_chanmon_cfgs(2);
3730 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3731 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3732 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3733 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3734 let logger = test_utils::TestLogger::new();
3736 let (payment_preimage_1, payment_hash_1, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
3738 // Now try to send a second payment which will fail to send
3739 let (payment_preimage_2, payment_hash_2, payment_secret_2) = get_payment_preimage_hash!(nodes[1]);
3740 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3741 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
3742 nodes[0].node.send_payment(&route, payment_hash_2, &Some(payment_secret_2)).unwrap();
3743 check_added_monitors!(nodes[0], 1);
3745 let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
3746 assert_eq!(events_1.len(), 1);
3748 MessageSendEvent::UpdateHTLCs { .. } => {},
3749 _ => panic!("Unexpected event"),
3752 assert!(nodes[1].node.claim_funds(payment_preimage_1));
3753 check_added_monitors!(nodes[1], 1);
3755 let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3756 assert_eq!(events_2.len(), 1);
3758 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 } } => {
3759 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3760 assert!(update_add_htlcs.is_empty());
3761 assert_eq!(update_fulfill_htlcs.len(), 1);
3762 assert!(update_fail_htlcs.is_empty());
3763 assert!(update_fail_malformed_htlcs.is_empty());
3764 assert!(update_fee.is_none());
3766 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlcs[0]);
3767 let events_3 = nodes[0].node.get_and_clear_pending_events();
3768 assert_eq!(events_3.len(), 1);
3770 Event::PaymentSent { ref payment_preimage, ref payment_hash } => {
3771 assert_eq!(*payment_preimage, payment_preimage_1);
3772 assert_eq!(*payment_hash, payment_hash_1);
3774 _ => panic!("Unexpected event"),
3777 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), commitment_signed);
3778 let _ = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3779 // No commitment_signed so get_event_msg's assert(len == 1) passes
3780 check_added_monitors!(nodes[0], 1);
3782 _ => panic!("Unexpected event"),
3785 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3786 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3788 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
3789 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
3790 assert_eq!(reestablish_1.len(), 1);
3791 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
3792 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
3793 assert_eq!(reestablish_2.len(), 1);
3795 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
3796 let as_resp = handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
3797 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
3798 let bs_resp = handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
3800 assert!(as_resp.0.is_none());
3801 assert!(bs_resp.0.is_none());
3803 assert!(bs_resp.1.is_none());
3804 assert!(bs_resp.2.is_none());
3806 assert!(as_resp.3 == RAACommitmentOrder::CommitmentFirst);
3808 assert_eq!(as_resp.2.as_ref().unwrap().update_add_htlcs.len(), 1);
3809 assert!(as_resp.2.as_ref().unwrap().update_fulfill_htlcs.is_empty());
3810 assert!(as_resp.2.as_ref().unwrap().update_fail_htlcs.is_empty());
3811 assert!(as_resp.2.as_ref().unwrap().update_fail_malformed_htlcs.is_empty());
3812 assert!(as_resp.2.as_ref().unwrap().update_fee.is_none());
3813 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &as_resp.2.as_ref().unwrap().update_add_htlcs[0]);
3814 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_resp.2.as_ref().unwrap().commitment_signed);
3815 let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3816 // No commitment_signed so get_event_msg's assert(len == 1) passes
3817 check_added_monitors!(nodes[1], 1);
3819 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), as_resp.1.as_ref().unwrap());
3820 let bs_second_commitment_signed = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3821 assert!(bs_second_commitment_signed.update_add_htlcs.is_empty());
3822 assert!(bs_second_commitment_signed.update_fulfill_htlcs.is_empty());
3823 assert!(bs_second_commitment_signed.update_fail_htlcs.is_empty());
3824 assert!(bs_second_commitment_signed.update_fail_malformed_htlcs.is_empty());
3825 assert!(bs_second_commitment_signed.update_fee.is_none());
3826 check_added_monitors!(nodes[1], 1);
3828 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3829 let as_commitment_signed = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
3830 assert!(as_commitment_signed.update_add_htlcs.is_empty());
3831 assert!(as_commitment_signed.update_fulfill_htlcs.is_empty());
3832 assert!(as_commitment_signed.update_fail_htlcs.is_empty());
3833 assert!(as_commitment_signed.update_fail_malformed_htlcs.is_empty());
3834 assert!(as_commitment_signed.update_fee.is_none());
3835 check_added_monitors!(nodes[0], 1);
3837 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_commitment_signed.commitment_signed);
3838 let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3839 // No commitment_signed so get_event_msg's assert(len == 1) passes
3840 check_added_monitors!(nodes[0], 1);
3842 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed.commitment_signed);
3843 let bs_second_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3844 // No commitment_signed so get_event_msg's assert(len == 1) passes
3845 check_added_monitors!(nodes[1], 1);
3847 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3848 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3849 check_added_monitors!(nodes[1], 1);
3851 expect_pending_htlcs_forwardable!(nodes[1]);
3853 let events_5 = nodes[1].node.get_and_clear_pending_events();
3854 assert_eq!(events_5.len(), 1);
3856 Event::PaymentReceived { ref payment_hash, ref purpose, .. } => {
3857 assert_eq!(payment_hash_2, *payment_hash);
3859 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
3860 assert!(payment_preimage.is_none());
3861 assert_eq!(payment_secret_2, *payment_secret);
3863 _ => panic!("expected PaymentPurpose::InvoicePayment")
3866 _ => panic!("Unexpected event"),
3869 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke_and_ack);
3870 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3871 check_added_monitors!(nodes[0], 1);
3873 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
3876 fn do_test_htlc_timeout(send_partial_mpp: bool) {
3877 // If the user fails to claim/fail an HTLC within the HTLC CLTV timeout we fail it for them
3878 // to avoid our counterparty failing the channel.
3879 let chanmon_cfgs = create_chanmon_cfgs(2);
3880 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3881 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3882 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3884 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3885 let logger = test_utils::TestLogger::new();
3887 let our_payment_hash = if send_partial_mpp {
3888 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3889 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
3890 let (_, our_payment_hash, payment_secret) = get_payment_preimage_hash!(&nodes[1]);
3891 // Use the utility function send_payment_along_path to send the payment with MPP data which
3892 // indicates there are more HTLCs coming.
3893 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.
3894 let mpp_id = MppId([42; 32]);
3895 nodes[0].node.send_payment_along_path(&route.paths[0], &our_payment_hash, &Some(payment_secret), 200000, cur_height, mpp_id, &None).unwrap();
3896 check_added_monitors!(nodes[0], 1);
3897 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3898 assert_eq!(events.len(), 1);
3899 // Now do the relevant commitment_signed/RAA dances along the path, noting that the final
3900 // hop should *not* yet generate any PaymentReceived event(s).
3901 pass_along_path(&nodes[0], &[&nodes[1]], 100000, our_payment_hash, Some(payment_secret), events.drain(..).next().unwrap(), false, None);
3904 route_payment(&nodes[0], &[&nodes[1]], 100000).1
3907 let mut block = Block {
3908 header: BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
3911 connect_block(&nodes[0], &block);
3912 connect_block(&nodes[1], &block);
3913 let block_count = TEST_FINAL_CLTV + CHAN_CONFIRM_DEPTH + 2 - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS;
3914 for _ in CHAN_CONFIRM_DEPTH + 2..block_count {
3915 block.header.prev_blockhash = block.block_hash();
3916 connect_block(&nodes[0], &block);
3917 connect_block(&nodes[1], &block);
3920 expect_pending_htlcs_forwardable!(nodes[1]);
3922 check_added_monitors!(nodes[1], 1);
3923 let htlc_timeout_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3924 assert!(htlc_timeout_updates.update_add_htlcs.is_empty());
3925 assert_eq!(htlc_timeout_updates.update_fail_htlcs.len(), 1);
3926 assert!(htlc_timeout_updates.update_fail_malformed_htlcs.is_empty());
3927 assert!(htlc_timeout_updates.update_fee.is_none());
3929 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_timeout_updates.update_fail_htlcs[0]);
3930 commitment_signed_dance!(nodes[0], nodes[1], htlc_timeout_updates.commitment_signed, false);
3931 // 100_000 msat as u64, followed by the height at which we failed back above
3932 let mut expected_failure_data = byte_utils::be64_to_array(100_000).to_vec();
3933 expected_failure_data.extend_from_slice(&byte_utils::be32_to_array(block_count - 1));
3934 expect_payment_failed!(nodes[0], our_payment_hash, true, 0x4000 | 15, &expected_failure_data[..]);
3938 fn test_htlc_timeout() {
3939 do_test_htlc_timeout(true);
3940 do_test_htlc_timeout(false);
3943 fn do_test_holding_cell_htlc_add_timeouts(forwarded_htlc: bool) {
3944 // Tests that HTLCs in the holding cell are timed out after the requisite number of blocks.
3945 let chanmon_cfgs = create_chanmon_cfgs(3);
3946 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3947 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3948 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3949 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3950 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3952 // Make sure all nodes are at the same starting height
3953 connect_blocks(&nodes[0], 2*CHAN_CONFIRM_DEPTH + 1 - nodes[0].best_block_info().1);
3954 connect_blocks(&nodes[1], 2*CHAN_CONFIRM_DEPTH + 1 - nodes[1].best_block_info().1);
3955 connect_blocks(&nodes[2], 2*CHAN_CONFIRM_DEPTH + 1 - nodes[2].best_block_info().1);
3957 let logger = test_utils::TestLogger::new();
3959 // Route a first payment to get the 1 -> 2 channel in awaiting_raa...
3960 let (_, first_payment_hash, first_payment_secret) = get_payment_preimage_hash!(nodes[2]);
3962 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
3963 let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[2].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
3964 nodes[1].node.send_payment(&route, first_payment_hash, &Some(first_payment_secret)).unwrap();
3966 assert_eq!(nodes[1].node.get_and_clear_pending_msg_events().len(), 1);
3967 check_added_monitors!(nodes[1], 1);
3969 // Now attempt to route a second payment, which should be placed in the holding cell
3970 let (_, second_payment_hash, second_payment_secret) = get_payment_preimage_hash!(nodes[2]);
3972 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3973 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[2].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
3974 nodes[0].node.send_payment(&route, second_payment_hash, &Some(first_payment_secret)).unwrap();
3975 check_added_monitors!(nodes[0], 1);
3976 let payment_event = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
3977 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
3978 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
3979 expect_pending_htlcs_forwardable!(nodes[1]);
3980 check_added_monitors!(nodes[1], 0);
3982 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
3983 let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[2].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
3984 nodes[1].node.send_payment(&route, second_payment_hash, &Some(second_payment_secret)).unwrap();
3985 check_added_monitors!(nodes[1], 0);
3988 connect_blocks(&nodes[1], TEST_FINAL_CLTV - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS);
3989 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3990 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
3991 connect_blocks(&nodes[1], 1);
3994 expect_pending_htlcs_forwardable!(nodes[1]);
3995 check_added_monitors!(nodes[1], 1);
3996 let fail_commit = nodes[1].node.get_and_clear_pending_msg_events();
3997 assert_eq!(fail_commit.len(), 1);
3998 match fail_commit[0] {
3999 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fail_htlcs, ref commitment_signed, .. }, .. } => {
4000 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
4001 commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, true, true);
4003 _ => unreachable!(),
4005 expect_payment_failed_with_update!(nodes[0], second_payment_hash, false, chan_2.0.contents.short_channel_id, false);
4007 expect_payment_failed!(nodes[1], second_payment_hash, true);
4012 fn test_holding_cell_htlc_add_timeouts() {
4013 do_test_holding_cell_htlc_add_timeouts(false);
4014 do_test_holding_cell_htlc_add_timeouts(true);
4018 fn test_no_txn_manager_serialize_deserialize() {
4019 let chanmon_cfgs = create_chanmon_cfgs(2);
4020 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4021 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4022 let logger: test_utils::TestLogger;
4023 let fee_estimator: test_utils::TestFeeEstimator;
4024 let persister: test_utils::TestPersister;
4025 let new_chain_monitor: test_utils::TestChainMonitor;
4026 let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4027 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4029 let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
4031 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4033 let nodes_0_serialized = nodes[0].node.encode();
4034 let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4035 nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
4037 logger = test_utils::TestLogger::new();
4038 fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
4039 persister = test_utils::TestPersister::new();
4040 let keys_manager = &chanmon_cfgs[0].keys_manager;
4041 new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator, &persister, keys_manager);
4042 nodes[0].chain_monitor = &new_chain_monitor;
4043 let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4044 let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
4045 &mut chan_0_monitor_read, keys_manager).unwrap();
4046 assert!(chan_0_monitor_read.is_empty());
4048 let mut nodes_0_read = &nodes_0_serialized[..];
4049 let config = UserConfig::default();
4050 let (_, nodes_0_deserialized_tmp) = {
4051 let mut channel_monitors = HashMap::new();
4052 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4053 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4054 default_config: config,
4056 fee_estimator: &fee_estimator,
4057 chain_monitor: nodes[0].chain_monitor,
4058 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4063 nodes_0_deserialized = nodes_0_deserialized_tmp;
4064 assert!(nodes_0_read.is_empty());
4066 assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4067 nodes[0].node = &nodes_0_deserialized;
4068 assert_eq!(nodes[0].node.list_channels().len(), 1);
4069 check_added_monitors!(nodes[0], 1);
4071 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4072 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
4073 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4074 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
4076 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
4077 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4078 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
4079 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4081 let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
4082 let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
4083 for node in nodes.iter() {
4084 assert!(node.net_graph_msg_handler.handle_channel_announcement(&announcement).unwrap());
4085 node.net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
4086 node.net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
4089 send_payment(&nodes[0], &[&nodes[1]], 1000000);
4094 let chanmon_cfgs = create_chanmon_cfgs(4);
4095 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
4096 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
4097 let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
4099 let chan_1_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
4100 let chan_2_id = create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
4101 let chan_3_id = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
4102 let chan_4_id = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
4103 let logger = test_utils::TestLogger::new();
4105 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(&nodes[3]);
4106 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
4107 let mut route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[3].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
4108 let path = route.paths[0].clone();
4109 route.paths.push(path);
4110 route.paths[0][0].pubkey = nodes[1].node.get_our_node_id();
4111 route.paths[0][0].short_channel_id = chan_1_id;
4112 route.paths[0][1].short_channel_id = chan_3_id;
4113 route.paths[1][0].pubkey = nodes[2].node.get_our_node_id();
4114 route.paths[1][0].short_channel_id = chan_2_id;
4115 route.paths[1][1].short_channel_id = chan_4_id;
4116 send_along_route_with_secret(&nodes[0], route, &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], 200_000, payment_hash, payment_secret);
4117 fail_payment_along_route(&nodes[0], &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], false, payment_hash);
4121 fn test_dup_htlc_onchain_fails_on_reload() {
4122 // When a Channel is closed, any outbound HTLCs which were relayed through it are simply
4123 // dropped when the Channel is. From there, the ChannelManager relies on the ChannelMonitor
4124 // having a copy of the relevant fail-/claim-back data and processes the HTLC fail/claim when
4125 // the ChannelMonitor tells it to.
4127 // If, due to an on-chain event, an HTLC is failed/claimed, and then we serialize the
4128 // ChannelManager, we generally expect there not to be a duplicate HTLC fail/claim (eg via a
4129 // PaymentFailed event appearing). However, because we may not serialize the relevant
4130 // ChannelMonitor at the same time, this isn't strictly guaranteed. In order to provide this
4131 // consistency, the ChannelManager explicitly tracks pending-onchain-resolution outbound HTLCs
4132 // and de-duplicates ChannelMonitor events.
4134 // This tests that explicit tracking behavior.
4135 let chanmon_cfgs = create_chanmon_cfgs(2);
4136 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4137 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4138 let persister: test_utils::TestPersister;
4139 let new_chain_monitor: test_utils::TestChainMonitor;
4140 let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4141 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4143 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4145 // Route a payment, but force-close the channel before the HTLC fulfill message arrives at
4147 let (payment_preimage, _, _) = route_payment(&nodes[0], &[&nodes[1]], 10000000);
4148 nodes[0].node.force_close_channel(&nodes[0].node.list_channels()[0].channel_id).unwrap();
4149 check_closed_broadcast!(nodes[0], true);
4150 check_added_monitors!(nodes[0], 1);
4152 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
4153 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4155 // Connect blocks until the CLTV timeout is up so that we get an HTLC-Timeout transaction
4156 connect_blocks(&nodes[0], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + 1);
4157 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
4158 assert_eq!(node_txn.len(), 3);
4159 assert_eq!(node_txn[0], node_txn[1]);
4161 assert!(nodes[1].node.claim_funds(payment_preimage));
4162 check_added_monitors!(nodes[1], 1);
4164 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4165 connect_block(&nodes[1], &Block { header, txdata: vec![node_txn[1].clone(), node_txn[2].clone()]});
4166 check_closed_broadcast!(nodes[1], true);
4167 check_added_monitors!(nodes[1], 1);
4168 let claim_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
4170 header.prev_blockhash = nodes[0].best_block_hash();
4171 connect_block(&nodes[0], &Block { header, txdata: vec![node_txn[1].clone(), node_txn[2].clone()]});
4173 // Serialize out the ChannelMonitor before connecting the on-chain claim transactions. This is
4174 // fairly normal behavior as ChannelMonitor(s) are often not re-serialized when on-chain events
4175 // happen, unlike ChannelManager which tends to be re-serialized after any relevant event(s).
4176 let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4177 nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
4179 header.prev_blockhash = nodes[0].best_block_hash();
4180 let claim_block = Block { header, txdata: claim_txn};
4181 connect_block(&nodes[0], &claim_block);
4182 expect_payment_sent!(nodes[0], payment_preimage);
4184 // ChannelManagers generally get re-serialized after any relevant event(s). Since we just
4185 // connected a highly-relevant block, it likely gets serialized out now.
4186 let mut chan_manager_serialized = test_utils::TestVecWriter(Vec::new());
4187 nodes[0].node.write(&mut chan_manager_serialized).unwrap();
4189 // Now reload nodes[0]...
4190 persister = test_utils::TestPersister::new();
4191 let keys_manager = &chanmon_cfgs[0].keys_manager;
4192 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);
4193 nodes[0].chain_monitor = &new_chain_monitor;
4194 let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4195 let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
4196 &mut chan_0_monitor_read, keys_manager).unwrap();
4197 assert!(chan_0_monitor_read.is_empty());
4199 let (_, nodes_0_deserialized_tmp) = {
4200 let mut channel_monitors = HashMap::new();
4201 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4202 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>
4203 ::read(&mut io::Cursor::new(&chan_manager_serialized.0[..]), ChannelManagerReadArgs {
4204 default_config: Default::default(),
4206 fee_estimator: node_cfgs[0].fee_estimator,
4207 chain_monitor: nodes[0].chain_monitor,
4208 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4209 logger: nodes[0].logger,
4213 nodes_0_deserialized = nodes_0_deserialized_tmp;
4215 assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4216 check_added_monitors!(nodes[0], 1);
4217 nodes[0].node = &nodes_0_deserialized;
4219 // Note that if we re-connect the block which exposed nodes[0] to the payment preimage (but
4220 // which the current ChannelMonitor has not seen), the ChannelManager's de-duplication of
4221 // payment events should kick in, leaving us with no pending events here.
4222 let height = nodes[0].blocks.lock().unwrap().len() as u32 - 1;
4223 nodes[0].chain_monitor.chain_monitor.block_connected(&claim_block, height);
4224 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
4228 fn test_manager_serialize_deserialize_events() {
4229 // This test makes sure the events field in ChannelManager survives de/serialization
4230 let chanmon_cfgs = create_chanmon_cfgs(2);
4231 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4232 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4233 let fee_estimator: test_utils::TestFeeEstimator;
4234 let persister: test_utils::TestPersister;
4235 let logger: test_utils::TestLogger;
4236 let new_chain_monitor: test_utils::TestChainMonitor;
4237 let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4238 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4240 // Start creating a channel, but stop right before broadcasting the funding transaction
4241 let channel_value = 100000;
4242 let push_msat = 10001;
4243 let a_flags = InitFeatures::known();
4244 let b_flags = InitFeatures::known();
4245 let node_a = nodes.remove(0);
4246 let node_b = nodes.remove(0);
4247 node_a.node.create_channel(node_b.node.get_our_node_id(), channel_value, push_msat, 42, None).unwrap();
4248 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()));
4249 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()));
4251 let (temporary_channel_id, tx, funding_output) = create_funding_transaction(&node_a, channel_value, 42);
4253 node_a.node.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
4254 check_added_monitors!(node_a, 0);
4256 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()));
4258 let mut added_monitors = node_b.chain_monitor.added_monitors.lock().unwrap();
4259 assert_eq!(added_monitors.len(), 1);
4260 assert_eq!(added_monitors[0].0, funding_output);
4261 added_monitors.clear();
4264 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()));
4266 let mut added_monitors = node_a.chain_monitor.added_monitors.lock().unwrap();
4267 assert_eq!(added_monitors.len(), 1);
4268 assert_eq!(added_monitors[0].0, funding_output);
4269 added_monitors.clear();
4271 // Normally, this is where node_a would broadcast the funding transaction, but the test de/serializes first instead
4276 // Start the de/seriailization process mid-channel creation to check that the channel manager will hold onto events that are serialized
4277 let nodes_0_serialized = nodes[0].node.encode();
4278 let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4279 nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
4281 fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
4282 logger = test_utils::TestLogger::new();
4283 persister = test_utils::TestPersister::new();
4284 let keys_manager = &chanmon_cfgs[0].keys_manager;
4285 new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator, &persister, keys_manager);
4286 nodes[0].chain_monitor = &new_chain_monitor;
4287 let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4288 let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
4289 &mut chan_0_monitor_read, keys_manager).unwrap();
4290 assert!(chan_0_monitor_read.is_empty());
4292 let mut nodes_0_read = &nodes_0_serialized[..];
4293 let config = UserConfig::default();
4294 let (_, nodes_0_deserialized_tmp) = {
4295 let mut channel_monitors = HashMap::new();
4296 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4297 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4298 default_config: config,
4300 fee_estimator: &fee_estimator,
4301 chain_monitor: nodes[0].chain_monitor,
4302 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4307 nodes_0_deserialized = nodes_0_deserialized_tmp;
4308 assert!(nodes_0_read.is_empty());
4310 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4312 assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4313 nodes[0].node = &nodes_0_deserialized;
4315 // After deserializing, make sure the funding_transaction is still held by the channel manager
4316 let events_4 = nodes[0].node.get_and_clear_pending_events();
4317 assert_eq!(events_4.len(), 0);
4318 assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
4319 assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0].txid(), funding_output.txid);
4321 // Make sure the channel is functioning as though the de/serialization never happened
4322 assert_eq!(nodes[0].node.list_channels().len(), 1);
4323 check_added_monitors!(nodes[0], 1);
4325 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4326 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
4327 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4328 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
4330 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
4331 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4332 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
4333 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4335 let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
4336 let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
4337 for node in nodes.iter() {
4338 assert!(node.net_graph_msg_handler.handle_channel_announcement(&announcement).unwrap());
4339 node.net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
4340 node.net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
4343 send_payment(&nodes[0], &[&nodes[1]], 1000000);
4347 fn test_simple_manager_serialize_deserialize() {
4348 let chanmon_cfgs = create_chanmon_cfgs(2);
4349 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4350 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4351 let logger: test_utils::TestLogger;
4352 let fee_estimator: test_utils::TestFeeEstimator;
4353 let persister: test_utils::TestPersister;
4354 let new_chain_monitor: test_utils::TestChainMonitor;
4355 let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4356 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4357 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4359 let (our_payment_preimage, _, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
4360 let (_, our_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
4362 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4364 let nodes_0_serialized = nodes[0].node.encode();
4365 let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4366 nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
4368 logger = test_utils::TestLogger::new();
4369 fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
4370 persister = test_utils::TestPersister::new();
4371 let keys_manager = &chanmon_cfgs[0].keys_manager;
4372 new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator, &persister, keys_manager);
4373 nodes[0].chain_monitor = &new_chain_monitor;
4374 let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4375 let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
4376 &mut chan_0_monitor_read, keys_manager).unwrap();
4377 assert!(chan_0_monitor_read.is_empty());
4379 let mut nodes_0_read = &nodes_0_serialized[..];
4380 let (_, nodes_0_deserialized_tmp) = {
4381 let mut channel_monitors = HashMap::new();
4382 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4383 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4384 default_config: UserConfig::default(),
4386 fee_estimator: &fee_estimator,
4387 chain_monitor: nodes[0].chain_monitor,
4388 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4393 nodes_0_deserialized = nodes_0_deserialized_tmp;
4394 assert!(nodes_0_read.is_empty());
4396 assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4397 nodes[0].node = &nodes_0_deserialized;
4398 check_added_monitors!(nodes[0], 1);
4400 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
4402 fail_payment(&nodes[0], &[&nodes[1]], our_payment_hash);
4403 claim_payment(&nodes[0], &[&nodes[1]], our_payment_preimage);
4407 fn test_manager_serialize_deserialize_inconsistent_monitor() {
4408 // Test deserializing a ChannelManager with an out-of-date ChannelMonitor
4409 let chanmon_cfgs = create_chanmon_cfgs(4);
4410 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
4411 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
4412 let logger: test_utils::TestLogger;
4413 let fee_estimator: test_utils::TestFeeEstimator;
4414 let persister: test_utils::TestPersister;
4415 let new_chain_monitor: test_utils::TestChainMonitor;
4416 let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4417 let mut nodes = create_network(4, &node_cfgs, &node_chanmgrs);
4418 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4419 create_announced_chan_between_nodes(&nodes, 2, 0, InitFeatures::known(), InitFeatures::known());
4420 let (_, _, channel_id, funding_tx) = create_announced_chan_between_nodes(&nodes, 0, 3, InitFeatures::known(), InitFeatures::known());
4422 let mut node_0_stale_monitors_serialized = Vec::new();
4423 for monitor in nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter() {
4424 let mut writer = test_utils::TestVecWriter(Vec::new());
4425 monitor.1.write(&mut writer).unwrap();
4426 node_0_stale_monitors_serialized.push(writer.0);
4429 let (our_payment_preimage, _, _) = route_payment(&nodes[2], &[&nodes[0], &nodes[1]], 1000000);
4431 // Serialize the ChannelManager here, but the monitor we keep up-to-date
4432 let nodes_0_serialized = nodes[0].node.encode();
4434 route_payment(&nodes[0], &[&nodes[3]], 1000000);
4435 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4436 nodes[2].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4437 nodes[3].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4439 // Now the ChannelMonitor (which is now out-of-sync with ChannelManager for channel w/
4441 let mut node_0_monitors_serialized = Vec::new();
4442 for monitor in nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter() {
4443 let mut writer = test_utils::TestVecWriter(Vec::new());
4444 monitor.1.write(&mut writer).unwrap();
4445 node_0_monitors_serialized.push(writer.0);
4448 logger = test_utils::TestLogger::new();
4449 fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
4450 persister = test_utils::TestPersister::new();
4451 let keys_manager = &chanmon_cfgs[0].keys_manager;
4452 new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator, &persister, keys_manager);
4453 nodes[0].chain_monitor = &new_chain_monitor;
4456 let mut node_0_stale_monitors = Vec::new();
4457 for serialized in node_0_stale_monitors_serialized.iter() {
4458 let mut read = &serialized[..];
4459 let (_, monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(&mut read, keys_manager).unwrap();
4460 assert!(read.is_empty());
4461 node_0_stale_monitors.push(monitor);
4464 let mut node_0_monitors = Vec::new();
4465 for serialized in node_0_monitors_serialized.iter() {
4466 let mut read = &serialized[..];
4467 let (_, monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(&mut read, keys_manager).unwrap();
4468 assert!(read.is_empty());
4469 node_0_monitors.push(monitor);
4472 let mut nodes_0_read = &nodes_0_serialized[..];
4473 if let Err(msgs::DecodeError::InvalidValue) =
4474 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4475 default_config: UserConfig::default(),
4477 fee_estimator: &fee_estimator,
4478 chain_monitor: nodes[0].chain_monitor,
4479 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4481 channel_monitors: node_0_stale_monitors.iter_mut().map(|monitor| { (monitor.get_funding_txo().0, monitor) }).collect(),
4483 panic!("If the monitor(s) are stale, this indicates a bug and we should get an Err return");
4486 let mut nodes_0_read = &nodes_0_serialized[..];
4487 let (_, nodes_0_deserialized_tmp) =
4488 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4489 default_config: UserConfig::default(),
4491 fee_estimator: &fee_estimator,
4492 chain_monitor: nodes[0].chain_monitor,
4493 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4495 channel_monitors: node_0_monitors.iter_mut().map(|monitor| { (monitor.get_funding_txo().0, monitor) }).collect(),
4497 nodes_0_deserialized = nodes_0_deserialized_tmp;
4498 assert!(nodes_0_read.is_empty());
4500 { // Channel close should result in a commitment tx
4501 let txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4502 assert_eq!(txn.len(), 1);
4503 check_spends!(txn[0], funding_tx);
4504 assert_eq!(txn[0].input[0].previous_output.txid, funding_tx.txid());
4507 for monitor in node_0_monitors.drain(..) {
4508 assert!(nodes[0].chain_monitor.watch_channel(monitor.get_funding_txo().0, monitor).is_ok());
4509 check_added_monitors!(nodes[0], 1);
4511 nodes[0].node = &nodes_0_deserialized;
4513 // nodes[1] and nodes[2] have no lost state with nodes[0]...
4514 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
4515 reconnect_nodes(&nodes[0], &nodes[2], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
4516 //... and we can even still claim the payment!
4517 claim_payment(&nodes[2], &[&nodes[0], &nodes[1]], our_payment_preimage);
4519 nodes[3].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4520 let reestablish = get_event_msg!(nodes[3], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
4521 nodes[0].node.peer_connected(&nodes[3].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4522 nodes[0].node.handle_channel_reestablish(&nodes[3].node.get_our_node_id(), &reestablish);
4523 let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
4524 assert_eq!(msg_events.len(), 1);
4525 if let MessageSendEvent::HandleError { ref action, .. } = msg_events[0] {
4527 &ErrorAction::SendErrorMessage { ref msg } => {
4528 assert_eq!(msg.channel_id, channel_id);
4530 _ => panic!("Unexpected event!"),
4535 macro_rules! check_spendable_outputs {
4536 ($node: expr, $keysinterface: expr) => {
4538 let mut events = $node.chain_monitor.chain_monitor.get_and_clear_pending_events();
4539 let mut txn = Vec::new();
4540 let mut all_outputs = Vec::new();
4541 let secp_ctx = Secp256k1::new();
4542 for event in events.drain(..) {
4544 Event::SpendableOutputs { mut outputs } => {
4545 for outp in outputs.drain(..) {
4546 txn.push($keysinterface.backing.spend_spendable_outputs(&[&outp], Vec::new(), Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(), 253, &secp_ctx).unwrap());
4547 all_outputs.push(outp);
4550 _ => panic!("Unexpected event"),
4553 if all_outputs.len() > 1 {
4554 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) {
4564 fn test_claim_sizeable_push_msat() {
4565 // Incidentally test SpendableOutput event generation due to detection of to_local output on commitment tx
4566 let chanmon_cfgs = create_chanmon_cfgs(2);
4567 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4568 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4569 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4571 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 99000000, InitFeatures::known(), InitFeatures::known());
4572 nodes[1].node.force_close_channel(&chan.2).unwrap();
4573 check_closed_broadcast!(nodes[1], true);
4574 check_added_monitors!(nodes[1], 1);
4575 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4576 assert_eq!(node_txn.len(), 1);
4577 check_spends!(node_txn[0], chan.3);
4578 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
4580 mine_transaction(&nodes[1], &node_txn[0]);
4581 connect_blocks(&nodes[1], BREAKDOWN_TIMEOUT as u32 - 1);
4583 let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
4584 assert_eq!(spend_txn.len(), 1);
4585 assert_eq!(spend_txn[0].input.len(), 1);
4586 check_spends!(spend_txn[0], node_txn[0]);
4587 assert_eq!(spend_txn[0].input[0].sequence, BREAKDOWN_TIMEOUT as u32);
4591 fn test_claim_on_remote_sizeable_push_msat() {
4592 // Same test as previous, just test on remote commitment tx, as per_commitment_point registration changes following you're funder/fundee and
4593 // to_remote output is encumbered by a P2WPKH
4594 let chanmon_cfgs = create_chanmon_cfgs(2);
4595 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4596 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4597 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4599 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 99000000, InitFeatures::known(), InitFeatures::known());
4600 nodes[0].node.force_close_channel(&chan.2).unwrap();
4601 check_closed_broadcast!(nodes[0], true);
4602 check_added_monitors!(nodes[0], 1);
4604 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4605 assert_eq!(node_txn.len(), 1);
4606 check_spends!(node_txn[0], chan.3);
4607 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
4609 mine_transaction(&nodes[1], &node_txn[0]);
4610 check_closed_broadcast!(nodes[1], true);
4611 check_added_monitors!(nodes[1], 1);
4612 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4614 let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
4615 assert_eq!(spend_txn.len(), 1);
4616 check_spends!(spend_txn[0], node_txn[0]);
4620 fn test_claim_on_remote_revoked_sizeable_push_msat() {
4621 // Same test as previous, just test on remote revoked commitment tx, as per_commitment_point registration changes following you're funder/fundee and
4622 // to_remote output is encumbered by a P2WPKH
4624 let chanmon_cfgs = create_chanmon_cfgs(2);
4625 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4626 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4627 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4629 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 59000000, InitFeatures::known(), InitFeatures::known());
4630 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4631 let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan.2);
4632 assert_eq!(revoked_local_txn[0].input.len(), 1);
4633 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
4635 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
4636 mine_transaction(&nodes[1], &revoked_local_txn[0]);
4637 check_closed_broadcast!(nodes[1], true);
4638 check_added_monitors!(nodes[1], 1);
4640 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4641 mine_transaction(&nodes[1], &node_txn[0]);
4642 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4644 let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
4645 assert_eq!(spend_txn.len(), 3);
4646 check_spends!(spend_txn[0], revoked_local_txn[0]); // to_remote output on revoked remote commitment_tx
4647 check_spends!(spend_txn[1], node_txn[0]);
4648 check_spends!(spend_txn[2], revoked_local_txn[0], node_txn[0]); // Both outputs
4652 fn test_static_spendable_outputs_preimage_tx() {
4653 let chanmon_cfgs = create_chanmon_cfgs(2);
4654 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4655 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4656 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4658 // Create some initial channels
4659 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4661 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4663 let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
4664 assert_eq!(commitment_tx[0].input.len(), 1);
4665 assert_eq!(commitment_tx[0].input[0].previous_output.txid, chan_1.3.txid());
4667 // Settle A's commitment tx on B's chain
4668 assert!(nodes[1].node.claim_funds(payment_preimage));
4669 check_added_monitors!(nodes[1], 1);
4670 mine_transaction(&nodes[1], &commitment_tx[0]);
4671 check_added_monitors!(nodes[1], 1);
4672 let events = nodes[1].node.get_and_clear_pending_msg_events();
4674 MessageSendEvent::UpdateHTLCs { .. } => {},
4675 _ => panic!("Unexpected event"),
4678 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
4679 _ => panic!("Unexepected event"),
4682 // Check B's monitor was able to send back output descriptor event for preimage tx on A's commitment tx
4683 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap(); // ChannelManager : 2 (local commitment tx + HTLC-Success), ChannelMonitor: preimage tx
4684 assert_eq!(node_txn.len(), 3);
4685 check_spends!(node_txn[0], commitment_tx[0]);
4686 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
4687 check_spends!(node_txn[1], chan_1.3);
4688 check_spends!(node_txn[2], node_txn[1]);
4690 mine_transaction(&nodes[1], &node_txn[0]);
4691 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4693 let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
4694 assert_eq!(spend_txn.len(), 1);
4695 check_spends!(spend_txn[0], node_txn[0]);
4699 fn test_static_spendable_outputs_timeout_tx() {
4700 let chanmon_cfgs = create_chanmon_cfgs(2);
4701 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4702 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4703 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4705 // Create some initial channels
4706 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4708 // Rebalance the network a bit by relaying one payment through all the channels ...
4709 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
4711 let (_, our_payment_hash, _) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3_000_000);
4713 let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
4714 assert_eq!(commitment_tx[0].input.len(), 1);
4715 assert_eq!(commitment_tx[0].input[0].previous_output.txid, chan_1.3.txid());
4717 // Settle A's commitment tx on B' chain
4718 mine_transaction(&nodes[1], &commitment_tx[0]);
4719 check_added_monitors!(nodes[1], 1);
4720 let events = nodes[1].node.get_and_clear_pending_msg_events();
4722 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
4723 _ => panic!("Unexpected event"),
4725 connect_blocks(&nodes[1], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
4727 // Check B's monitor was able to send back output descriptor event for timeout tx on A's commitment tx
4728 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
4729 assert_eq!(node_txn.len(), 2); // ChannelManager : 1 local commitent tx, ChannelMonitor: timeout tx
4730 check_spends!(node_txn[0], chan_1.3.clone());
4731 check_spends!(node_txn[1], commitment_tx[0].clone());
4732 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4734 mine_transaction(&nodes[1], &node_txn[1]);
4735 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4736 expect_payment_failed!(nodes[1], our_payment_hash, true);
4738 let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
4739 assert_eq!(spend_txn.len(), 3); // SpendableOutput: remote_commitment_tx.to_remote, timeout_tx.output
4740 check_spends!(spend_txn[0], commitment_tx[0]);
4741 check_spends!(spend_txn[1], node_txn[1]);
4742 check_spends!(spend_txn[2], node_txn[1], commitment_tx[0]); // All outputs
4746 fn test_static_spendable_outputs_justice_tx_revoked_commitment_tx() {
4747 let chanmon_cfgs = create_chanmon_cfgs(2);
4748 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4749 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4750 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4752 // Create some initial channels
4753 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4755 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4756 let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
4757 assert_eq!(revoked_local_txn[0].input.len(), 1);
4758 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
4760 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
4762 mine_transaction(&nodes[1], &revoked_local_txn[0]);
4763 check_closed_broadcast!(nodes[1], true);
4764 check_added_monitors!(nodes[1], 1);
4766 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4767 assert_eq!(node_txn.len(), 2);
4768 assert_eq!(node_txn[0].input.len(), 2);
4769 check_spends!(node_txn[0], revoked_local_txn[0]);
4771 mine_transaction(&nodes[1], &node_txn[0]);
4772 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4774 let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
4775 assert_eq!(spend_txn.len(), 1);
4776 check_spends!(spend_txn[0], node_txn[0]);
4780 fn test_static_spendable_outputs_justice_tx_revoked_htlc_timeout_tx() {
4781 let mut chanmon_cfgs = create_chanmon_cfgs(2);
4782 chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
4783 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4784 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4785 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4787 // Create some initial channels
4788 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4790 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4791 let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
4792 assert_eq!(revoked_local_txn[0].input.len(), 1);
4793 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
4795 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
4797 // A will generate HTLC-Timeout from revoked commitment tx
4798 mine_transaction(&nodes[0], &revoked_local_txn[0]);
4799 check_closed_broadcast!(nodes[0], true);
4800 check_added_monitors!(nodes[0], 1);
4801 connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
4803 let revoked_htlc_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4804 assert_eq!(revoked_htlc_txn.len(), 2);
4805 check_spends!(revoked_htlc_txn[0], chan_1.3);
4806 assert_eq!(revoked_htlc_txn[1].input.len(), 1);
4807 assert_eq!(revoked_htlc_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
4808 check_spends!(revoked_htlc_txn[1], revoked_local_txn[0]);
4809 assert_ne!(revoked_htlc_txn[1].lock_time, 0); // HTLC-Timeout
4811 // B will generate justice tx from A's revoked commitment/HTLC tx
4812 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4813 connect_block(&nodes[1], &Block { header, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[1].clone()] });
4814 check_closed_broadcast!(nodes[1], true);
4815 check_added_monitors!(nodes[1], 1);
4817 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4818 assert_eq!(node_txn.len(), 3); // ChannelMonitor: bogus justice tx, justice tx on revoked outputs, ChannelManager: local commitment tx
4819 // The first transaction generated is bogus - it spends both outputs of revoked_local_txn[0]
4820 // including the one already spent by revoked_htlc_txn[1]. That's OK, we'll spend with valid
4821 // transactions next...
4822 assert_eq!(node_txn[0].input.len(), 3);
4823 check_spends!(node_txn[0], revoked_local_txn[0], revoked_htlc_txn[1]);
4825 assert_eq!(node_txn[1].input.len(), 2);
4826 check_spends!(node_txn[1], revoked_local_txn[0], revoked_htlc_txn[1]);
4827 if node_txn[1].input[1].previous_output.txid == revoked_htlc_txn[1].txid() {
4828 assert_ne!(node_txn[1].input[0].previous_output, revoked_htlc_txn[1].input[0].previous_output);
4830 assert_eq!(node_txn[1].input[0].previous_output.txid, revoked_htlc_txn[1].txid());
4831 assert_ne!(node_txn[1].input[1].previous_output, revoked_htlc_txn[1].input[0].previous_output);
4834 assert_eq!(node_txn[2].input.len(), 1);
4835 check_spends!(node_txn[2], chan_1.3);
4837 mine_transaction(&nodes[1], &node_txn[1]);
4838 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4840 // Check B's ChannelMonitor was able to generate the right spendable output descriptor
4841 let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
4842 assert_eq!(spend_txn.len(), 1);
4843 assert_eq!(spend_txn[0].input.len(), 1);
4844 check_spends!(spend_txn[0], node_txn[1]);
4848 fn test_static_spendable_outputs_justice_tx_revoked_htlc_success_tx() {
4849 let mut chanmon_cfgs = create_chanmon_cfgs(2);
4850 chanmon_cfgs[1].keys_manager.disable_revocation_policy_check = true;
4851 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4852 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4853 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4855 // Create some initial channels
4856 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4858 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4859 let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan_1.2);
4860 assert_eq!(revoked_local_txn[0].input.len(), 1);
4861 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
4863 // The to-be-revoked commitment tx should have one HTLC and one to_remote output
4864 assert_eq!(revoked_local_txn[0].output.len(), 2);
4866 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
4868 // B will generate HTLC-Success from revoked commitment tx
4869 mine_transaction(&nodes[1], &revoked_local_txn[0]);
4870 check_closed_broadcast!(nodes[1], true);
4871 check_added_monitors!(nodes[1], 1);
4872 let revoked_htlc_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4874 assert_eq!(revoked_htlc_txn.len(), 2);
4875 assert_eq!(revoked_htlc_txn[0].input.len(), 1);
4876 assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4877 check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
4879 // Check that the unspent (of two) outputs on revoked_local_txn[0] is a P2WPKH:
4880 let unspent_local_txn_output = revoked_htlc_txn[0].input[0].previous_output.vout as usize ^ 1;
4881 assert_eq!(revoked_local_txn[0].output[unspent_local_txn_output].script_pubkey.len(), 2 + 20); // P2WPKH
4883 // A will generate justice tx from B's revoked commitment/HTLC tx
4884 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4885 connect_block(&nodes[0], &Block { header, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[0].clone()] });
4886 check_closed_broadcast!(nodes[0], true);
4887 check_added_monitors!(nodes[0], 1);
4889 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4890 assert_eq!(node_txn.len(), 3); // ChannelMonitor: justice tx on revoked commitment, justice tx on revoked HTLC-success, ChannelManager: local commitment tx
4892 // The first transaction generated is bogus - it spends both outputs of revoked_local_txn[0]
4893 // including the one already spent by revoked_htlc_txn[0]. That's OK, we'll spend with valid
4894 // transactions next...
4895 assert_eq!(node_txn[0].input.len(), 2);
4896 check_spends!(node_txn[0], revoked_local_txn[0], revoked_htlc_txn[0]);
4897 if node_txn[0].input[1].previous_output.txid == revoked_htlc_txn[0].txid() {
4898 assert_eq!(node_txn[0].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
4900 assert_eq!(node_txn[0].input[0].previous_output.txid, revoked_htlc_txn[0].txid());
4901 assert_eq!(node_txn[0].input[1].previous_output, revoked_htlc_txn[0].input[0].previous_output);
4904 assert_eq!(node_txn[1].input.len(), 1);
4905 check_spends!(node_txn[1], revoked_htlc_txn[0]);
4907 check_spends!(node_txn[2], chan_1.3);
4909 mine_transaction(&nodes[0], &node_txn[1]);
4910 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
4912 // Note that nodes[0]'s tx_broadcaster is still locked, so if we get here the channelmonitor
4913 // didn't try to generate any new transactions.
4915 // Check A's ChannelMonitor was able to generate the right spendable output descriptor
4916 let spend_txn = check_spendable_outputs!(nodes[0], node_cfgs[0].keys_manager);
4917 assert_eq!(spend_txn.len(), 3);
4918 assert_eq!(spend_txn[0].input.len(), 1);
4919 check_spends!(spend_txn[0], revoked_local_txn[0]); // spending to_remote output from revoked local tx
4920 assert_ne!(spend_txn[0].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
4921 check_spends!(spend_txn[1], node_txn[1]); // spending justice tx output on the htlc success tx
4922 check_spends!(spend_txn[2], revoked_local_txn[0], node_txn[1]); // Both outputs
4926 fn test_onchain_to_onchain_claim() {
4927 // Test that in case of channel closure, we detect the state of output and claim HTLC
4928 // on downstream peer's remote commitment tx.
4929 // First, have C claim an HTLC against its own latest commitment transaction.
4930 // Then, broadcast these to B, which should update the monitor downstream on the A<->B
4932 // Finally, check that B will claim the HTLC output if A's latest commitment transaction
4935 let chanmon_cfgs = create_chanmon_cfgs(3);
4936 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
4937 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
4938 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
4940 // Create some initial channels
4941 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4942 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
4944 // Ensure all nodes are at the same height
4945 let node_max_height = nodes.iter().map(|node| node.blocks.lock().unwrap().len()).max().unwrap() as u32;
4946 connect_blocks(&nodes[0], node_max_height - nodes[0].best_block_info().1);
4947 connect_blocks(&nodes[1], node_max_height - nodes[1].best_block_info().1);
4948 connect_blocks(&nodes[2], node_max_height - nodes[2].best_block_info().1);
4950 // Rebalance the network a bit by relaying one payment through all the channels ...
4951 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
4952 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
4954 let (payment_preimage, _payment_hash, _payment_secret) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
4955 let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
4956 check_spends!(commitment_tx[0], chan_2.3);
4957 nodes[2].node.claim_funds(payment_preimage);
4958 check_added_monitors!(nodes[2], 1);
4959 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
4960 assert!(updates.update_add_htlcs.is_empty());
4961 assert!(updates.update_fail_htlcs.is_empty());
4962 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
4963 assert!(updates.update_fail_malformed_htlcs.is_empty());
4965 mine_transaction(&nodes[2], &commitment_tx[0]);
4966 check_closed_broadcast!(nodes[2], true);
4967 check_added_monitors!(nodes[2], 1);
4969 let c_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 2 (commitment tx, HTLC-Success tx), ChannelMonitor : 1 (HTLC-Success tx)
4970 assert_eq!(c_txn.len(), 3);
4971 assert_eq!(c_txn[0], c_txn[2]);
4972 assert_eq!(commitment_tx[0], c_txn[1]);
4973 check_spends!(c_txn[1], chan_2.3);
4974 check_spends!(c_txn[2], c_txn[1]);
4975 assert_eq!(c_txn[1].input[0].witness.clone().last().unwrap().len(), 71);
4976 assert_eq!(c_txn[2].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4977 assert!(c_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
4978 assert_eq!(c_txn[0].lock_time, 0); // Success tx
4980 // 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
4981 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
4982 connect_block(&nodes[1], &Block { header, txdata: vec![c_txn[1].clone(), c_txn[2].clone()]});
4983 check_added_monitors!(nodes[1], 1);
4984 expect_payment_forwarded!(nodes[1], Some(1000), true);
4986 let mut b_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4987 // ChannelMonitor: claim tx
4988 assert_eq!(b_txn.len(), 1);
4989 check_spends!(b_txn[0], chan_2.3); // B local commitment tx, issued by ChannelManager
4992 let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
4993 assert_eq!(msg_events.len(), 3);
4994 check_added_monitors!(nodes[1], 1);
4995 match msg_events[0] {
4996 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
4997 _ => panic!("Unexpected event"),
4999 match msg_events[1] {
5000 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { .. }, node_id: _ } => {},
5001 _ => panic!("Unexpected event"),
5003 match msg_events[2] {
5004 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, .. } } => {
5005 assert!(update_add_htlcs.is_empty());
5006 assert!(update_fail_htlcs.is_empty());
5007 assert_eq!(update_fulfill_htlcs.len(), 1);
5008 assert!(update_fail_malformed_htlcs.is_empty());
5009 assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
5011 _ => panic!("Unexpected event"),
5013 // Broadcast A's commitment tx on B's chain to see if we are able to claim inbound HTLC with our HTLC-Success tx
5014 let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
5015 mine_transaction(&nodes[1], &commitment_tx[0]);
5016 let b_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5017 // ChannelMonitor: HTLC-Success tx, ChannelManager: local commitment tx + HTLC-Success tx
5018 assert_eq!(b_txn.len(), 3);
5019 check_spends!(b_txn[1], chan_1.3);
5020 check_spends!(b_txn[2], b_txn[1]);
5021 check_spends!(b_txn[0], commitment_tx[0]);
5022 assert_eq!(b_txn[0].input[0].witness.clone().last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5023 assert!(b_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
5024 assert_eq!(b_txn[0].lock_time, 0); // Success tx
5026 check_closed_broadcast!(nodes[1], true);
5027 check_added_monitors!(nodes[1], 1);
5031 fn test_duplicate_payment_hash_one_failure_one_success() {
5032 // Topology : A --> B --> C --> D
5033 // We route 2 payments with same hash between B and C, one will be timeout, the other successfully claim
5034 // Note that because C will refuse to generate two payment secrets for the same payment hash,
5035 // we forward one of the payments onwards to D.
5036 let chanmon_cfgs = create_chanmon_cfgs(4);
5037 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
5038 // When this test was written, the default base fee floated based on the HTLC count.
5039 // It is now fixed, so we simply set the fee to the expected value here.
5040 let mut config = test_default_channel_config();
5041 config.channel_options.forwarding_fee_base_msat = 196;
5042 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs,
5043 &[Some(config.clone()), Some(config.clone()), Some(config.clone()), Some(config.clone())]);
5044 let mut nodes = create_network(4, &node_cfgs, &node_chanmgrs);
5046 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5047 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
5048 create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
5050 let node_max_height = nodes.iter().map(|node| node.blocks.lock().unwrap().len()).max().unwrap() as u32;
5051 connect_blocks(&nodes[0], node_max_height - nodes[0].best_block_info().1);
5052 connect_blocks(&nodes[1], node_max_height - nodes[1].best_block_info().1);
5053 connect_blocks(&nodes[2], node_max_height - nodes[2].best_block_info().1);
5054 connect_blocks(&nodes[3], node_max_height - nodes[3].best_block_info().1);
5056 let (our_payment_preimage, duplicate_payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 900000);
5058 let payment_secret = nodes[3].node.create_inbound_payment_for_hash(duplicate_payment_hash, None, 7200, 0).unwrap();
5059 // We reduce the final CLTV here by a somewhat arbitrary constant to keep it under the one-byte
5060 // script push size limit so that the below script length checks match
5061 // ACCEPTED_HTLC_SCRIPT_WEIGHT.
5062 let route = get_route(&nodes[0].node.get_our_node_id(), &nodes[0].net_graph_msg_handler.network_graph,
5063 &nodes[3].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 900000, TEST_FINAL_CLTV - 40, nodes[0].logger).unwrap();
5064 send_along_route_with_secret(&nodes[0], route, &[&[&nodes[1], &nodes[2], &nodes[3]]], 900000, duplicate_payment_hash, payment_secret);
5066 let commitment_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
5067 assert_eq!(commitment_txn[0].input.len(), 1);
5068 check_spends!(commitment_txn[0], chan_2.3);
5070 mine_transaction(&nodes[1], &commitment_txn[0]);
5071 check_closed_broadcast!(nodes[1], true);
5072 check_added_monitors!(nodes[1], 1);
5073 connect_blocks(&nodes[1], TEST_FINAL_CLTV - 40 + MIN_CLTV_EXPIRY_DELTA as u32 - 1); // Confirm blocks until the HTLC expires
5075 let htlc_timeout_tx;
5076 { // Extract one of the two HTLC-Timeout transaction
5077 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5078 // ChannelMonitor: timeout tx * 3, ChannelManager: local commitment tx
5079 assert_eq!(node_txn.len(), 4);
5080 check_spends!(node_txn[0], chan_2.3);
5082 check_spends!(node_txn[1], commitment_txn[0]);
5083 assert_eq!(node_txn[1].input.len(), 1);
5084 check_spends!(node_txn[2], commitment_txn[0]);
5085 assert_eq!(node_txn[2].input.len(), 1);
5086 assert_eq!(node_txn[1].input[0].previous_output, node_txn[2].input[0].previous_output);
5087 check_spends!(node_txn[3], commitment_txn[0]);
5088 assert_ne!(node_txn[1].input[0].previous_output, node_txn[3].input[0].previous_output);
5090 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5091 assert_eq!(node_txn[2].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5092 assert_eq!(node_txn[3].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5093 htlc_timeout_tx = node_txn[1].clone();
5096 nodes[2].node.claim_funds(our_payment_preimage);
5097 mine_transaction(&nodes[2], &commitment_txn[0]);
5098 check_added_monitors!(nodes[2], 2);
5099 let events = nodes[2].node.get_and_clear_pending_msg_events();
5101 MessageSendEvent::UpdateHTLCs { .. } => {},
5102 _ => panic!("Unexpected event"),
5105 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5106 _ => panic!("Unexepected event"),
5108 let htlc_success_txn: Vec<_> = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
5109 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)
5110 check_spends!(htlc_success_txn[0], commitment_txn[0]);
5111 check_spends!(htlc_success_txn[1], commitment_txn[0]);
5112 assert_eq!(htlc_success_txn[0].input.len(), 1);
5113 assert_eq!(htlc_success_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5114 assert_eq!(htlc_success_txn[1].input.len(), 1);
5115 assert_eq!(htlc_success_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5116 assert_ne!(htlc_success_txn[0].input[0].previous_output, htlc_success_txn[1].input[0].previous_output);
5117 assert_eq!(htlc_success_txn[2], commitment_txn[0]);
5118 assert_eq!(htlc_success_txn[3], htlc_success_txn[0]);
5119 assert_eq!(htlc_success_txn[4], htlc_success_txn[1]);
5120 assert_ne!(htlc_success_txn[0].input[0].previous_output, htlc_timeout_tx.input[0].previous_output);
5122 mine_transaction(&nodes[1], &htlc_timeout_tx);
5123 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
5124 expect_pending_htlcs_forwardable!(nodes[1]);
5125 let htlc_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5126 assert!(htlc_updates.update_add_htlcs.is_empty());
5127 assert_eq!(htlc_updates.update_fail_htlcs.len(), 1);
5128 let first_htlc_id = htlc_updates.update_fail_htlcs[0].htlc_id;
5129 assert!(htlc_updates.update_fulfill_htlcs.is_empty());
5130 assert!(htlc_updates.update_fail_malformed_htlcs.is_empty());
5131 check_added_monitors!(nodes[1], 1);
5133 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_updates.update_fail_htlcs[0]);
5134 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
5136 commitment_signed_dance!(nodes[0], nodes[1], &htlc_updates.commitment_signed, false, true);
5138 expect_payment_failed_with_update!(nodes[0], duplicate_payment_hash, false, chan_2.0.contents.short_channel_id, true);
5140 // Solve 2nd HTLC by broadcasting on B's chain HTLC-Success Tx from C
5141 // Note that the fee paid is effectively double as the HTLC value (including the nodes[1] fee
5142 // and nodes[2] fee) is rounded down and then claimed in full.
5143 mine_transaction(&nodes[1], &htlc_success_txn[0]);
5144 expect_payment_forwarded!(nodes[1], Some(196*2), true);
5145 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5146 assert!(updates.update_add_htlcs.is_empty());
5147 assert!(updates.update_fail_htlcs.is_empty());
5148 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
5149 assert_ne!(updates.update_fulfill_htlcs[0].htlc_id, first_htlc_id);
5150 assert!(updates.update_fail_malformed_htlcs.is_empty());
5151 check_added_monitors!(nodes[1], 1);
5153 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
5154 commitment_signed_dance!(nodes[0], nodes[1], &updates.commitment_signed, false);
5156 let events = nodes[0].node.get_and_clear_pending_events();
5158 Event::PaymentSent { ref payment_preimage, ref payment_hash } => {
5159 assert_eq!(*payment_preimage, our_payment_preimage);
5160 assert_eq!(*payment_hash, duplicate_payment_hash);
5162 _ => panic!("Unexpected event"),
5167 fn test_dynamic_spendable_outputs_local_htlc_success_tx() {
5168 let chanmon_cfgs = create_chanmon_cfgs(2);
5169 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5170 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5171 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5173 // Create some initial channels
5174 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5176 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000).0;
5177 let local_txn = get_local_commitment_txn!(nodes[1], chan_1.2);
5178 assert_eq!(local_txn.len(), 1);
5179 assert_eq!(local_txn[0].input.len(), 1);
5180 check_spends!(local_txn[0], chan_1.3);
5182 // Give B knowledge of preimage to be able to generate a local HTLC-Success Tx
5183 nodes[1].node.claim_funds(payment_preimage);
5184 check_added_monitors!(nodes[1], 1);
5185 mine_transaction(&nodes[1], &local_txn[0]);
5186 check_added_monitors!(nodes[1], 1);
5187 let events = nodes[1].node.get_and_clear_pending_msg_events();
5189 MessageSendEvent::UpdateHTLCs { .. } => {},
5190 _ => panic!("Unexpected event"),
5193 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5194 _ => panic!("Unexepected event"),
5197 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5198 assert_eq!(node_txn.len(), 3);
5199 assert_eq!(node_txn[0], node_txn[2]);
5200 assert_eq!(node_txn[1], local_txn[0]);
5201 assert_eq!(node_txn[0].input.len(), 1);
5202 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5203 check_spends!(node_txn[0], local_txn[0]);
5207 mine_transaction(&nodes[1], &node_tx);
5208 connect_blocks(&nodes[1], BREAKDOWN_TIMEOUT as u32 - 1);
5210 // Verify that B is able to spend its own HTLC-Success tx thanks to spendable output event given back by its ChannelMonitor
5211 let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
5212 assert_eq!(spend_txn.len(), 1);
5213 assert_eq!(spend_txn[0].input.len(), 1);
5214 check_spends!(spend_txn[0], node_tx);
5215 assert_eq!(spend_txn[0].input[0].sequence, BREAKDOWN_TIMEOUT as u32);
5218 fn do_test_fail_backwards_unrevoked_remote_announce(deliver_last_raa: bool, announce_latest: bool) {
5219 // Test that we fail backwards the full set of HTLCs we need to when remote broadcasts an
5220 // unrevoked commitment transaction.
5221 // This includes HTLCs which were below the dust threshold as well as HTLCs which were awaiting
5222 // a remote RAA before they could be failed backwards (and combinations thereof).
5223 // We also test duplicate-hash HTLCs by adding two nodes on each side of the target nodes which
5224 // use the same payment hashes.
5225 // Thus, we use a six-node network:
5230 // And test where C fails back to A/B when D announces its latest commitment transaction
5231 let chanmon_cfgs = create_chanmon_cfgs(6);
5232 let node_cfgs = create_node_cfgs(6, &chanmon_cfgs);
5233 // When this test was written, the default base fee floated based on the HTLC count.
5234 // It is now fixed, so we simply set the fee to the expected value here.
5235 let mut config = test_default_channel_config();
5236 config.channel_options.forwarding_fee_base_msat = 196;
5237 let node_chanmgrs = create_node_chanmgrs(6, &node_cfgs,
5238 &[Some(config.clone()), Some(config.clone()), Some(config.clone()), Some(config.clone()), Some(config.clone()), Some(config.clone())]);
5239 let nodes = create_network(6, &node_cfgs, &node_chanmgrs);
5240 let logger = test_utils::TestLogger::new();
5242 create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known());
5243 create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
5244 let chan = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
5245 create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::known(), InitFeatures::known());
5246 create_announced_chan_between_nodes(&nodes, 3, 5, InitFeatures::known(), InitFeatures::known());
5248 // Rebalance and check output sanity...
5249 send_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 500000);
5250 send_payment(&nodes[1], &[&nodes[2], &nodes[3], &nodes[5]], 500000);
5251 assert_eq!(get_local_commitment_txn!(nodes[3], chan.2)[0].output.len(), 2);
5253 let ds_dust_limit = nodes[3].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().holder_dust_limit_satoshis;
5255 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
5257 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
5258 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
5259 let our_node_id = &nodes[1].node.get_our_node_id();
5260 let route = get_route(our_node_id, &net_graph_msg_handler.network_graph, &nodes[5].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), ds_dust_limit*1000, TEST_FINAL_CLTV, &logger).unwrap();
5262 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
5264 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
5266 let (_, payment_hash_3, _) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
5268 let (_, payment_hash_4, _) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
5269 let route = get_route(our_node_id, &net_graph_msg_handler.network_graph, &nodes[5].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
5271 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());
5273 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());
5276 let (_, payment_hash_5, _) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
5278 let route = get_route(our_node_id, &net_graph_msg_handler.network_graph, &nodes[5].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), ds_dust_limit*1000, TEST_FINAL_CLTV, &logger).unwrap();
5279 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
5282 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
5284 let route = get_route(our_node_id, &net_graph_msg_handler.network_graph, &nodes[5].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
5285 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());
5287 // Double-check that six of the new HTLC were added
5288 // We now have six HTLCs pending over the dust limit and six HTLCs under the dust limit (ie,
5289 // with to_local and to_remote outputs, 8 outputs and 6 HTLCs not included).
5290 assert_eq!(get_local_commitment_txn!(nodes[3], chan.2).len(), 1);
5291 assert_eq!(get_local_commitment_txn!(nodes[3], chan.2)[0].output.len(), 8);
5293 // Now fail back three of the over-dust-limit and three of the under-dust-limit payments in one go.
5294 // Fail 0th below-dust, 4th above-dust, 8th above-dust, 10th below-dust HTLCs
5295 assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_1));
5296 assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_3));
5297 assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_5));
5298 assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_6));
5299 check_added_monitors!(nodes[4], 0);
5300 expect_pending_htlcs_forwardable!(nodes[4]);
5301 check_added_monitors!(nodes[4], 1);
5303 let four_removes = get_htlc_update_msgs!(nodes[4], nodes[3].node.get_our_node_id());
5304 nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[0]);
5305 nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[1]);
5306 nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[2]);
5307 nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[3]);
5308 commitment_signed_dance!(nodes[3], nodes[4], four_removes.commitment_signed, false);
5310 // Fail 3rd below-dust and 7th above-dust HTLCs
5311 assert!(nodes[5].node.fail_htlc_backwards(&payment_hash_2));
5312 assert!(nodes[5].node.fail_htlc_backwards(&payment_hash_4));
5313 check_added_monitors!(nodes[5], 0);
5314 expect_pending_htlcs_forwardable!(nodes[5]);
5315 check_added_monitors!(nodes[5], 1);
5317 let two_removes = get_htlc_update_msgs!(nodes[5], nodes[3].node.get_our_node_id());
5318 nodes[3].node.handle_update_fail_htlc(&nodes[5].node.get_our_node_id(), &two_removes.update_fail_htlcs[0]);
5319 nodes[3].node.handle_update_fail_htlc(&nodes[5].node.get_our_node_id(), &two_removes.update_fail_htlcs[1]);
5320 commitment_signed_dance!(nodes[3], nodes[5], two_removes.commitment_signed, false);
5322 let ds_prev_commitment_tx = get_local_commitment_txn!(nodes[3], chan.2);
5324 expect_pending_htlcs_forwardable!(nodes[3]);
5325 check_added_monitors!(nodes[3], 1);
5326 let six_removes = get_htlc_update_msgs!(nodes[3], nodes[2].node.get_our_node_id());
5327 nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[0]);
5328 nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[1]);
5329 nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[2]);
5330 nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[3]);
5331 nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[4]);
5332 nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[5]);
5333 if deliver_last_raa {
5334 commitment_signed_dance!(nodes[2], nodes[3], six_removes.commitment_signed, false);
5336 let _cs_last_raa = commitment_signed_dance!(nodes[2], nodes[3], six_removes.commitment_signed, false, true, false, true);
5339 // D's latest commitment transaction now contains 1st + 2nd + 9th HTLCs (implicitly, they're
5340 // below the dust limit) and the 5th + 6th + 11th HTLCs. It has failed back the 0th, 3rd, 4th,
5341 // 7th, 8th, and 10th, but as we haven't yet delivered the final RAA to C, the fails haven't
5342 // propagated back to A/B yet (and D has two unrevoked commitment transactions).
5344 // We now broadcast the latest commitment transaction, which *should* result in failures for
5345 // the 0th, 1st, 2nd, 3rd, 4th, 7th, 8th, 9th, and 10th HTLCs, ie all the below-dust HTLCs and
5346 // the non-broadcast above-dust HTLCs.
5348 // Alternatively, we may broadcast the previous commitment transaction, which should only
5349 // result in failures for the below-dust HTLCs, ie the 0th, 1st, 2nd, 3rd, 9th, and 10th HTLCs.
5350 let ds_last_commitment_tx = get_local_commitment_txn!(nodes[3], chan.2);
5352 if announce_latest {
5353 mine_transaction(&nodes[2], &ds_last_commitment_tx[0]);
5355 mine_transaction(&nodes[2], &ds_prev_commitment_tx[0]);
5357 connect_blocks(&nodes[2], ANTI_REORG_DELAY - 1);
5358 check_closed_broadcast!(nodes[2], true);
5359 expect_pending_htlcs_forwardable!(nodes[2]);
5360 check_added_monitors!(nodes[2], 3);
5362 let cs_msgs = nodes[2].node.get_and_clear_pending_msg_events();
5363 assert_eq!(cs_msgs.len(), 2);
5364 let mut a_done = false;
5365 for msg in cs_msgs {
5367 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
5368 // Both under-dust HTLCs and the one above-dust HTLC that we had already failed
5369 // should be failed-backwards here.
5370 let target = if *node_id == nodes[0].node.get_our_node_id() {
5371 // If announce_latest, expect 0th, 1st, 4th, 8th, 10th HTLCs, else only 0th, 1st, 10th below-dust HTLCs
5372 for htlc in &updates.update_fail_htlcs {
5373 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 });
5375 assert_eq!(updates.update_fail_htlcs.len(), if announce_latest { 5 } else { 3 });
5380 // If announce_latest, expect 2nd, 3rd, 7th, 9th HTLCs, else only 2nd, 3rd, 9th below-dust HTLCs
5381 for htlc in &updates.update_fail_htlcs {
5382 assert!(htlc.htlc_id == 1 || htlc.htlc_id == 2 || htlc.htlc_id == 5 || if announce_latest { htlc.htlc_id == 4 } else { false });
5384 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
5385 assert_eq!(updates.update_fail_htlcs.len(), if announce_latest { 4 } else { 3 });
5388 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
5389 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[1]);
5390 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[2]);
5391 if announce_latest {
5392 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[3]);
5393 if *node_id == nodes[0].node.get_our_node_id() {
5394 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[4]);
5397 commitment_signed_dance!(target, nodes[2], updates.commitment_signed, false, true);
5399 _ => panic!("Unexpected event"),
5403 let as_events = nodes[0].node.get_and_clear_pending_events();
5404 assert_eq!(as_events.len(), if announce_latest { 5 } else { 3 });
5405 let mut as_failds = HashSet::new();
5406 let mut as_updates = 0;
5407 for event in as_events.iter() {
5408 if let &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, ref network_update, .. } = event {
5409 assert!(as_failds.insert(*payment_hash));
5410 if *payment_hash != payment_hash_2 {
5411 assert_eq!(*rejected_by_dest, deliver_last_raa);
5413 assert!(!rejected_by_dest);
5415 if network_update.is_some() {
5418 } else { panic!("Unexpected event"); }
5420 assert!(as_failds.contains(&payment_hash_1));
5421 assert!(as_failds.contains(&payment_hash_2));
5422 if announce_latest {
5423 assert!(as_failds.contains(&payment_hash_3));
5424 assert!(as_failds.contains(&payment_hash_5));
5426 assert!(as_failds.contains(&payment_hash_6));
5428 let bs_events = nodes[1].node.get_and_clear_pending_events();
5429 assert_eq!(bs_events.len(), if announce_latest { 4 } else { 3 });
5430 let mut bs_failds = HashSet::new();
5431 let mut bs_updates = 0;
5432 for event in bs_events.iter() {
5433 if let &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, ref network_update, .. } = event {
5434 assert!(bs_failds.insert(*payment_hash));
5435 if *payment_hash != payment_hash_1 && *payment_hash != payment_hash_5 {
5436 assert_eq!(*rejected_by_dest, deliver_last_raa);
5438 assert!(!rejected_by_dest);
5440 if network_update.is_some() {
5443 } else { panic!("Unexpected event"); }
5445 assert!(bs_failds.contains(&payment_hash_1));
5446 assert!(bs_failds.contains(&payment_hash_2));
5447 if announce_latest {
5448 assert!(bs_failds.contains(&payment_hash_4));
5450 assert!(bs_failds.contains(&payment_hash_5));
5452 // For each HTLC which was not failed-back by normal process (ie deliver_last_raa), we should
5453 // get a NetworkUpdate. A should have gotten 4 HTLCs which were failed-back due to
5454 // unknown-preimage-etc, B should have gotten 2. Thus, in the
5455 // announce_latest && deliver_last_raa case, we should have 5-4=1 and 4-2=2 NetworkUpdates.
5456 assert_eq!(as_updates, if deliver_last_raa { 1 } else if !announce_latest { 3 } else { 5 });
5457 assert_eq!(bs_updates, if deliver_last_raa { 2 } else if !announce_latest { 3 } else { 4 });
5461 fn test_fail_backwards_latest_remote_announce_a() {
5462 do_test_fail_backwards_unrevoked_remote_announce(false, true);
5466 fn test_fail_backwards_latest_remote_announce_b() {
5467 do_test_fail_backwards_unrevoked_remote_announce(true, true);
5471 fn test_fail_backwards_previous_remote_announce() {
5472 do_test_fail_backwards_unrevoked_remote_announce(false, false);
5473 // Note that true, true doesn't make sense as it implies we announce a revoked state, which is
5474 // tested for in test_commitment_revoked_fail_backward_exhaustive()
5478 fn test_dynamic_spendable_outputs_local_htlc_timeout_tx() {
5479 let chanmon_cfgs = create_chanmon_cfgs(2);
5480 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5481 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5482 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5484 // Create some initial channels
5485 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5487 let (_, our_payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000);
5488 let local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
5489 assert_eq!(local_txn[0].input.len(), 1);
5490 check_spends!(local_txn[0], chan_1.3);
5492 // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
5493 mine_transaction(&nodes[0], &local_txn[0]);
5494 check_closed_broadcast!(nodes[0], true);
5495 check_added_monitors!(nodes[0], 1);
5496 connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
5498 let htlc_timeout = {
5499 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5500 assert_eq!(node_txn.len(), 2);
5501 check_spends!(node_txn[0], chan_1.3);
5502 assert_eq!(node_txn[1].input.len(), 1);
5503 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5504 check_spends!(node_txn[1], local_txn[0]);
5508 mine_transaction(&nodes[0], &htlc_timeout);
5509 connect_blocks(&nodes[0], BREAKDOWN_TIMEOUT as u32 - 1);
5510 expect_payment_failed!(nodes[0], our_payment_hash, true);
5512 // Verify that A is able to spend its own HTLC-Timeout tx thanks to spendable output event given back by its ChannelMonitor
5513 let spend_txn = check_spendable_outputs!(nodes[0], node_cfgs[0].keys_manager);
5514 assert_eq!(spend_txn.len(), 3);
5515 check_spends!(spend_txn[0], local_txn[0]);
5516 assert_eq!(spend_txn[1].input.len(), 1);
5517 check_spends!(spend_txn[1], htlc_timeout);
5518 assert_eq!(spend_txn[1].input[0].sequence, BREAKDOWN_TIMEOUT as u32);
5519 assert_eq!(spend_txn[2].input.len(), 2);
5520 check_spends!(spend_txn[2], local_txn[0], htlc_timeout);
5521 assert!(spend_txn[2].input[0].sequence == BREAKDOWN_TIMEOUT as u32 ||
5522 spend_txn[2].input[1].sequence == BREAKDOWN_TIMEOUT as u32);
5526 fn test_key_derivation_params() {
5527 // This test is a copy of test_dynamic_spendable_outputs_local_htlc_timeout_tx, with
5528 // a key manager rotation to test that key_derivation_params returned in DynamicOutputP2WSH
5529 // let us re-derive the channel key set to then derive a delayed_payment_key.
5531 let chanmon_cfgs = create_chanmon_cfgs(3);
5533 // We manually create the node configuration to backup the seed.
5534 let seed = [42; 32];
5535 let keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
5536 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);
5537 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() };
5538 let mut node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5539 node_cfgs.remove(0);
5540 node_cfgs.insert(0, node);
5542 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5543 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5545 // Create some initial channels
5546 // Create a dummy channel to advance index by one and thus test re-derivation correctness
5548 let chan_0 = create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known());
5549 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5550 assert_ne!(chan_0.3.output[0].script_pubkey, chan_1.3.output[0].script_pubkey);
5552 // Ensure all nodes are at the same height
5553 let node_max_height = nodes.iter().map(|node| node.blocks.lock().unwrap().len()).max().unwrap() as u32;
5554 connect_blocks(&nodes[0], node_max_height - nodes[0].best_block_info().1);
5555 connect_blocks(&nodes[1], node_max_height - nodes[1].best_block_info().1);
5556 connect_blocks(&nodes[2], node_max_height - nodes[2].best_block_info().1);
5558 let (_, our_payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000);
5559 let local_txn_0 = get_local_commitment_txn!(nodes[0], chan_0.2);
5560 let local_txn_1 = get_local_commitment_txn!(nodes[0], chan_1.2);
5561 assert_eq!(local_txn_1[0].input.len(), 1);
5562 check_spends!(local_txn_1[0], chan_1.3);
5564 // We check funding pubkey are unique
5565 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]));
5566 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]));
5567 if from_0_funding_key_0 == from_1_funding_key_0
5568 || from_0_funding_key_0 == from_1_funding_key_1
5569 || from_0_funding_key_1 == from_1_funding_key_0
5570 || from_0_funding_key_1 == from_1_funding_key_1 {
5571 panic!("Funding pubkeys aren't unique");
5574 // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
5575 mine_transaction(&nodes[0], &local_txn_1[0]);
5576 connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
5577 check_closed_broadcast!(nodes[0], true);
5578 check_added_monitors!(nodes[0], 1);
5580 let htlc_timeout = {
5581 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5582 assert_eq!(node_txn[1].input.len(), 1);
5583 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5584 check_spends!(node_txn[1], local_txn_1[0]);
5588 mine_transaction(&nodes[0], &htlc_timeout);
5589 connect_blocks(&nodes[0], BREAKDOWN_TIMEOUT as u32 - 1);
5590 expect_payment_failed!(nodes[0], our_payment_hash, true);
5592 // Verify that A is able to spend its own HTLC-Timeout tx thanks to spendable output event given back by its ChannelMonitor
5593 let new_keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
5594 let spend_txn = check_spendable_outputs!(nodes[0], new_keys_manager);
5595 assert_eq!(spend_txn.len(), 3);
5596 check_spends!(spend_txn[0], local_txn_1[0]);
5597 assert_eq!(spend_txn[1].input.len(), 1);
5598 check_spends!(spend_txn[1], htlc_timeout);
5599 assert_eq!(spend_txn[1].input[0].sequence, BREAKDOWN_TIMEOUT as u32);
5600 assert_eq!(spend_txn[2].input.len(), 2);
5601 check_spends!(spend_txn[2], local_txn_1[0], htlc_timeout);
5602 assert!(spend_txn[2].input[0].sequence == BREAKDOWN_TIMEOUT as u32 ||
5603 spend_txn[2].input[1].sequence == BREAKDOWN_TIMEOUT as u32);
5607 fn test_static_output_closing_tx() {
5608 let chanmon_cfgs = create_chanmon_cfgs(2);
5609 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5610 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5611 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5613 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5615 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
5616 let closing_tx = close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true).2;
5618 mine_transaction(&nodes[0], &closing_tx);
5619 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
5621 let spend_txn = check_spendable_outputs!(nodes[0], node_cfgs[0].keys_manager);
5622 assert_eq!(spend_txn.len(), 1);
5623 check_spends!(spend_txn[0], closing_tx);
5625 mine_transaction(&nodes[1], &closing_tx);
5626 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
5628 let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
5629 assert_eq!(spend_txn.len(), 1);
5630 check_spends!(spend_txn[0], closing_tx);
5633 fn do_htlc_claim_local_commitment_only(use_dust: bool) {
5634 let chanmon_cfgs = create_chanmon_cfgs(2);
5635 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5636 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5637 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5638 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5640 let (our_payment_preimage, our_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1]], if use_dust { 50000 } else { 3000000 });
5642 // Claim the payment, but don't deliver A's commitment_signed, resulting in the HTLC only being
5643 // present in B's local commitment transaction, but none of A's commitment transactions.
5644 assert!(nodes[1].node.claim_funds(our_payment_preimage));
5645 check_added_monitors!(nodes[1], 1);
5647 let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5648 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fulfill_htlcs[0]);
5649 let events = nodes[0].node.get_and_clear_pending_events();
5650 assert_eq!(events.len(), 1);
5652 Event::PaymentSent { payment_preimage, payment_hash } => {
5653 assert_eq!(payment_preimage, our_payment_preimage);
5654 assert_eq!(payment_hash, our_payment_hash);
5656 _ => panic!("Unexpected event"),
5659 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_updates.commitment_signed);
5660 check_added_monitors!(nodes[0], 1);
5661 let as_updates = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5662 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_updates.0);
5663 check_added_monitors!(nodes[1], 1);
5665 let starting_block = nodes[1].best_block_info();
5666 let mut block = Block {
5667 header: BlockHeader { version: 0x20000000, prev_blockhash: starting_block.0, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
5670 for _ in starting_block.1 + 1..TEST_FINAL_CLTV - CLTV_CLAIM_BUFFER + starting_block.1 + 2 {
5671 connect_block(&nodes[1], &block);
5672 block.header.prev_blockhash = block.block_hash();
5674 test_txn_broadcast(&nodes[1], &chan, None, if use_dust { HTLCType::NONE } else { HTLCType::SUCCESS });
5675 check_closed_broadcast!(nodes[1], true);
5676 check_added_monitors!(nodes[1], 1);
5679 fn do_htlc_claim_current_remote_commitment_only(use_dust: bool) {
5680 let chanmon_cfgs = create_chanmon_cfgs(2);
5681 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5682 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5683 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5684 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5685 let logger = test_utils::TestLogger::new();
5687 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1]);
5688 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
5689 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), if use_dust { 50000 } else { 3000000 }, TEST_FINAL_CLTV, &logger).unwrap();
5690 nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
5691 check_added_monitors!(nodes[0], 1);
5693 let _as_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5695 // As far as A is concerned, the HTLC is now present only in the latest remote commitment
5696 // transaction, however it is not in A's latest local commitment, so we can just broadcast that
5697 // to "time out" the HTLC.
5699 let starting_block = nodes[1].best_block_info();
5700 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: starting_block.0, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5702 for _ in starting_block.1 + 1..TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + starting_block.1 + 2 {
5703 connect_block(&nodes[0], &Block { header, txdata: Vec::new()});
5704 header.prev_blockhash = header.block_hash();
5706 test_txn_broadcast(&nodes[0], &chan, None, HTLCType::NONE);
5707 check_closed_broadcast!(nodes[0], true);
5708 check_added_monitors!(nodes[0], 1);
5711 fn do_htlc_claim_previous_remote_commitment_only(use_dust: bool, check_revoke_no_close: bool) {
5712 let chanmon_cfgs = create_chanmon_cfgs(3);
5713 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5714 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5715 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5716 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5718 // Fail the payment, but don't deliver A's final RAA, resulting in the HTLC only being present
5719 // in B's previous (unrevoked) commitment transaction, but none of A's commitment transactions.
5720 // Also optionally test that we *don't* fail the channel in case the commitment transaction was
5721 // actually revoked.
5722 let htlc_value = if use_dust { 50000 } else { 3000000 };
5723 let (_, our_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1]], htlc_value);
5724 assert!(nodes[1].node.fail_htlc_backwards(&our_payment_hash));
5725 expect_pending_htlcs_forwardable!(nodes[1]);
5726 check_added_monitors!(nodes[1], 1);
5728 let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5729 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fail_htlcs[0]);
5730 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_updates.commitment_signed);
5731 check_added_monitors!(nodes[0], 1);
5732 let as_updates = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5733 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_updates.0);
5734 check_added_monitors!(nodes[1], 1);
5735 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_updates.1);
5736 check_added_monitors!(nodes[1], 1);
5737 let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
5739 if check_revoke_no_close {
5740 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
5741 check_added_monitors!(nodes[0], 1);
5744 let starting_block = nodes[1].best_block_info();
5745 let mut block = Block {
5746 header: BlockHeader { version: 0x20000000, prev_blockhash: starting_block.0, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
5749 for _ in starting_block.1 + 1..TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + CHAN_CONFIRM_DEPTH + 2 {
5750 connect_block(&nodes[0], &block);
5751 block.header.prev_blockhash = block.block_hash();
5753 if !check_revoke_no_close {
5754 test_txn_broadcast(&nodes[0], &chan, None, HTLCType::NONE);
5755 check_closed_broadcast!(nodes[0], true);
5756 check_added_monitors!(nodes[0], 1);
5758 expect_payment_failed!(nodes[0], our_payment_hash, true);
5762 // Test that we close channels on-chain when broadcastable HTLCs reach their timeout window.
5763 // There are only a few cases to test here:
5764 // * its not really normative behavior, but we test that below-dust HTLCs "included" in
5765 // broadcastable commitment transactions result in channel closure,
5766 // * its included in an unrevoked-but-previous remote commitment transaction,
5767 // * its included in the latest remote or local commitment transactions.
5768 // We test each of the three possible commitment transactions individually and use both dust and
5770 // Note that we don't bother testing both outbound and inbound HTLC failures for each case, and we
5771 // assume they are handled the same across all six cases, as both outbound and inbound failures are
5772 // tested for at least one of the cases in other tests.
5774 fn htlc_claim_single_commitment_only_a() {
5775 do_htlc_claim_local_commitment_only(true);
5776 do_htlc_claim_local_commitment_only(false);
5778 do_htlc_claim_current_remote_commitment_only(true);
5779 do_htlc_claim_current_remote_commitment_only(false);
5783 fn htlc_claim_single_commitment_only_b() {
5784 do_htlc_claim_previous_remote_commitment_only(true, false);
5785 do_htlc_claim_previous_remote_commitment_only(false, false);
5786 do_htlc_claim_previous_remote_commitment_only(true, true);
5787 do_htlc_claim_previous_remote_commitment_only(false, true);
5792 fn bolt2_open_channel_sending_node_checks_part1() { //This test needs to be on its own as we are catching a panic
5793 let chanmon_cfgs = create_chanmon_cfgs(2);
5794 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5795 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5796 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5797 //Force duplicate channel ids
5798 for node in nodes.iter() {
5799 *node.keys_manager.override_channel_id_priv.lock().unwrap() = Some([0; 32]);
5802 // BOLT #2 spec: Sending node must ensure temporary_channel_id is unique from any other channel ID with the same peer.
5803 let channel_value_satoshis=10000;
5804 let push_msat=10001;
5805 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).unwrap();
5806 let node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
5807 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &node0_to_1_send_open_channel);
5809 //Create a second channel with a channel_id collision
5810 assert!(nodes[0].node.create_channel(nodes[0].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
5814 fn bolt2_open_channel_sending_node_checks_part2() {
5815 let chanmon_cfgs = create_chanmon_cfgs(2);
5816 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5817 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5818 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5820 // BOLT #2 spec: Sending node must set funding_satoshis to less than 2^24 satoshis
5821 let channel_value_satoshis=2^24;
5822 let push_msat=10001;
5823 assert!(nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
5825 // BOLT #2 spec: Sending node must set push_msat to equal or less than 1000 * funding_satoshis
5826 let channel_value_satoshis=10000;
5827 // Test when push_msat is equal to 1000 * funding_satoshis.
5828 let push_msat=1000*channel_value_satoshis+1;
5829 assert!(nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
5831 // BOLT #2 spec: Sending node must set set channel_reserve_satoshis greater than or equal to dust_limit_satoshis
5832 let channel_value_satoshis=10000;
5833 let push_msat=10001;
5834 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
5835 let node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
5836 assert!(node0_to_1_send_open_channel.channel_reserve_satoshis>=node0_to_1_send_open_channel.dust_limit_satoshis);
5838 // BOLT #2 spec: Sending node must set undefined bits in channel_flags to 0
5839 // 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
5840 assert!(node0_to_1_send_open_channel.channel_flags<=1);
5842 // 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.
5843 assert!(BREAKDOWN_TIMEOUT>0);
5844 assert!(node0_to_1_send_open_channel.to_self_delay==BREAKDOWN_TIMEOUT);
5846 // BOLT #2 spec: Sending node must ensure the chain_hash value identifies the chain it wishes to open the channel within.
5847 let chain_hash=genesis_block(Network::Testnet).header.block_hash();
5848 assert_eq!(node0_to_1_send_open_channel.chain_hash,chain_hash);
5850 // 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.
5851 assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.funding_pubkey.serialize()).is_ok());
5852 assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.revocation_basepoint.serialize()).is_ok());
5853 assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.htlc_basepoint.serialize()).is_ok());
5854 assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.payment_point.serialize()).is_ok());
5855 assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.delayed_payment_basepoint.serialize()).is_ok());
5859 fn bolt2_open_channel_sane_dust_limit() {
5860 let chanmon_cfgs = create_chanmon_cfgs(2);
5861 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5862 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5863 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5865 let channel_value_satoshis=1000000;
5866 let push_msat=10001;
5867 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).unwrap();
5868 let mut node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
5869 node0_to_1_send_open_channel.dust_limit_satoshis = 661;
5870 node0_to_1_send_open_channel.channel_reserve_satoshis = 100001;
5872 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &node0_to_1_send_open_channel);
5873 let events = nodes[1].node.get_and_clear_pending_msg_events();
5874 let err_msg = match events[0] {
5875 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id: _ } => {
5878 _ => panic!("Unexpected event"),
5880 assert_eq!(err_msg.data, "dust_limit_satoshis (661) is greater than the implementation limit (660)");
5883 // Test that if we fail to send an HTLC that is being freed from the holding cell, and the HTLC
5884 // originated from our node, its failure is surfaced to the user. We trigger this failure to
5885 // free the HTLC by increasing our fee while the HTLC is in the holding cell such that the HTLC
5886 // is no longer affordable once it's freed.
5888 fn test_fail_holding_cell_htlc_upon_free() {
5889 let chanmon_cfgs = create_chanmon_cfgs(2);
5890 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5891 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5892 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5893 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
5894 let logger = test_utils::TestLogger::new();
5896 // First nodes[0] generates an update_fee, setting the channel's
5897 // pending_update_fee.
5899 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
5900 *feerate_lock += 20;
5902 nodes[0].node.timer_tick_occurred();
5903 check_added_monitors!(nodes[0], 1);
5905 let events = nodes[0].node.get_and_clear_pending_msg_events();
5906 assert_eq!(events.len(), 1);
5907 let (update_msg, commitment_signed) = match events[0] {
5908 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
5909 (update_fee.as_ref(), commitment_signed)
5911 _ => panic!("Unexpected event"),
5914 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
5916 let mut chan_stat = get_channel_value_stat!(nodes[0], chan.2);
5917 let channel_reserve = chan_stat.channel_reserve_msat;
5918 let feerate = get_feerate!(nodes[0], chan.2);
5920 // 2* and +1 HTLCs on the commit tx fee calculation for the fee spike reserve.
5921 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
5922 let max_can_send = 5000000 - channel_reserve - 2*commit_tx_fee_msat(feerate, 1 + 1);
5923 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
5924 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], max_can_send, TEST_FINAL_CLTV, &logger).unwrap();
5926 // Send a payment which passes reserve checks but gets stuck in the holding cell.
5927 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
5928 chan_stat = get_channel_value_stat!(nodes[0], chan.2);
5929 assert_eq!(chan_stat.holding_cell_outbound_amount_msat, max_can_send);
5931 // Flush the pending fee update.
5932 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
5933 let (as_revoke_and_ack, _) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5934 check_added_monitors!(nodes[1], 1);
5935 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_revoke_and_ack);
5936 check_added_monitors!(nodes[0], 1);
5938 // Upon receipt of the RAA, there will be an attempt to resend the holding cell
5939 // HTLC, but now that the fee has been raised the payment will now fail, causing
5940 // us to surface its failure to the user.
5941 chan_stat = get_channel_value_stat!(nodes[0], chan.2);
5942 assert_eq!(chan_stat.holding_cell_outbound_amount_msat, 0);
5943 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);
5944 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 {}",
5945 hex::encode(our_payment_hash.0), chan_stat.channel_reserve_msat, hex::encode(chan.2));
5946 nodes[0].logger.assert_log("lightning::ln::channel".to_string(), failure_log.to_string(), 1);
5948 // Check that the payment failed to be sent out.
5949 let events = nodes[0].node.get_and_clear_pending_events();
5950 assert_eq!(events.len(), 1);
5952 &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, ref network_update, ref error_code, ref error_data, ref all_paths_failed } => {
5953 assert_eq!(our_payment_hash.clone(), *payment_hash);
5954 assert_eq!(*rejected_by_dest, false);
5955 assert_eq!(*all_paths_failed, true);
5956 assert_eq!(*network_update, None);
5957 assert_eq!(*error_code, None);
5958 assert_eq!(*error_data, None);
5960 _ => panic!("Unexpected event"),
5964 // Test that if multiple HTLCs are released from the holding cell and one is
5965 // valid but the other is no longer valid upon release, the valid HTLC can be
5966 // successfully completed while the other one fails as expected.
5968 fn test_free_and_fail_holding_cell_htlcs() {
5969 let chanmon_cfgs = create_chanmon_cfgs(2);
5970 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5971 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5972 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5973 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
5974 let logger = test_utils::TestLogger::new();
5976 // First nodes[0] generates an update_fee, setting the channel's
5977 // pending_update_fee.
5979 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
5980 *feerate_lock += 200;
5982 nodes[0].node.timer_tick_occurred();
5983 check_added_monitors!(nodes[0], 1);
5985 let events = nodes[0].node.get_and_clear_pending_msg_events();
5986 assert_eq!(events.len(), 1);
5987 let (update_msg, commitment_signed) = match events[0] {
5988 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
5989 (update_fee.as_ref(), commitment_signed)
5991 _ => panic!("Unexpected event"),
5994 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
5996 let mut chan_stat = get_channel_value_stat!(nodes[0], chan.2);
5997 let channel_reserve = chan_stat.channel_reserve_msat;
5998 let feerate = get_feerate!(nodes[0], chan.2);
6000 // 2* and +1 HTLCs on the commit tx fee calculation for the fee spike reserve.
6001 let (payment_preimage_1, payment_hash_1, payment_secret_1) = get_payment_preimage_hash!(nodes[1]);
6003 let (_, payment_hash_2, payment_secret_2) = get_payment_preimage_hash!(nodes[1]);
6004 let amt_2 = 5000000 - channel_reserve - 2*commit_tx_fee_msat(feerate, 2 + 1) - amt_1;
6005 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6006 let route_1 = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], amt_1, TEST_FINAL_CLTV, &logger).unwrap();
6007 let route_2 = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], amt_2, TEST_FINAL_CLTV, &logger).unwrap();
6009 // Send 2 payments which pass reserve checks but get stuck in the holding cell.
6010 nodes[0].node.send_payment(&route_1, payment_hash_1, &Some(payment_secret_1)).unwrap();
6011 chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6012 assert_eq!(chan_stat.holding_cell_outbound_amount_msat, amt_1);
6013 nodes[0].node.send_payment(&route_2, payment_hash_2, &Some(payment_secret_2)).unwrap();
6014 chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6015 assert_eq!(chan_stat.holding_cell_outbound_amount_msat, amt_1 + amt_2);
6017 // Flush the pending fee update.
6018 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
6019 let (revoke_and_ack, commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6020 check_added_monitors!(nodes[1], 1);
6021 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_and_ack);
6022 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
6023 check_added_monitors!(nodes[0], 2);
6025 // Upon receipt of the RAA, there will be an attempt to resend the holding cell HTLCs,
6026 // but now that the fee has been raised the second payment will now fail, causing us
6027 // to surface its failure to the user. The first payment should succeed.
6028 chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6029 assert_eq!(chan_stat.holding_cell_outbound_amount_msat, 0);
6030 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);
6031 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 {}",
6032 hex::encode(payment_hash_2.0), chan_stat.channel_reserve_msat, hex::encode(chan.2));
6033 nodes[0].logger.assert_log("lightning::ln::channel".to_string(), failure_log.to_string(), 1);
6035 // Check that the second payment failed to be sent out.
6036 let events = nodes[0].node.get_and_clear_pending_events();
6037 assert_eq!(events.len(), 1);
6039 &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, ref network_update, ref error_code, ref error_data, ref all_paths_failed } => {
6040 assert_eq!(payment_hash_2.clone(), *payment_hash);
6041 assert_eq!(*rejected_by_dest, false);
6042 assert_eq!(*all_paths_failed, true);
6043 assert_eq!(*network_update, None);
6044 assert_eq!(*error_code, None);
6045 assert_eq!(*error_data, None);
6047 _ => panic!("Unexpected event"),
6050 // Complete the first payment and the RAA from the fee update.
6051 let (payment_event, send_raa_event) = {
6052 let mut msgs = nodes[0].node.get_and_clear_pending_msg_events();
6053 assert_eq!(msgs.len(), 2);
6054 (SendEvent::from_event(msgs.remove(0)), msgs.remove(0))
6056 let raa = match send_raa_event {
6057 MessageSendEvent::SendRevokeAndACK { msg, .. } => msg,
6058 _ => panic!("Unexpected event"),
6060 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &raa);
6061 check_added_monitors!(nodes[1], 1);
6062 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6063 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6064 let events = nodes[1].node.get_and_clear_pending_events();
6065 assert_eq!(events.len(), 1);
6067 Event::PendingHTLCsForwardable { .. } => {},
6068 _ => panic!("Unexpected event"),
6070 nodes[1].node.process_pending_htlc_forwards();
6071 let events = nodes[1].node.get_and_clear_pending_events();
6072 assert_eq!(events.len(), 1);
6074 Event::PaymentReceived { .. } => {},
6075 _ => panic!("Unexpected event"),
6077 nodes[1].node.claim_funds(payment_preimage_1);
6078 check_added_monitors!(nodes[1], 1);
6079 let update_msgs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6080 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_msgs.update_fulfill_htlcs[0]);
6081 commitment_signed_dance!(nodes[0], nodes[1], update_msgs.commitment_signed, false, true);
6082 let events = nodes[0].node.get_and_clear_pending_events();
6083 assert_eq!(events.len(), 1);
6085 Event::PaymentSent { ref payment_preimage, ref payment_hash } => {
6086 assert_eq!(*payment_preimage, payment_preimage_1);
6087 assert_eq!(*payment_hash, payment_hash_1);
6089 _ => panic!("Unexpected event"),
6093 // Test that if we fail to forward an HTLC that is being freed from the holding cell that the
6094 // HTLC is failed backwards. We trigger this failure to forward the freed HTLC by increasing
6095 // our fee while the HTLC is in the holding cell such that the HTLC is no longer affordable
6098 fn test_fail_holding_cell_htlc_upon_free_multihop() {
6099 let chanmon_cfgs = create_chanmon_cfgs(3);
6100 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
6101 // When this test was written, the default base fee floated based on the HTLC count.
6102 // It is now fixed, so we simply set the fee to the expected value here.
6103 let mut config = test_default_channel_config();
6104 config.channel_options.forwarding_fee_base_msat = 196;
6105 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[Some(config.clone()), Some(config.clone()), Some(config.clone())]);
6106 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
6107 let chan_0_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6108 let chan_1_2 = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6109 let logger = test_utils::TestLogger::new();
6111 // First nodes[1] generates an update_fee, setting the channel's
6112 // pending_update_fee.
6114 let mut feerate_lock = chanmon_cfgs[1].fee_estimator.sat_per_kw.lock().unwrap();
6115 *feerate_lock += 20;
6117 nodes[1].node.timer_tick_occurred();
6118 check_added_monitors!(nodes[1], 1);
6120 let events = nodes[1].node.get_and_clear_pending_msg_events();
6121 assert_eq!(events.len(), 1);
6122 let (update_msg, commitment_signed) = match events[0] {
6123 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
6124 (update_fee.as_ref(), commitment_signed)
6126 _ => panic!("Unexpected event"),
6129 nodes[2].node.handle_update_fee(&nodes[1].node.get_our_node_id(), update_msg.unwrap());
6131 let mut chan_stat = get_channel_value_stat!(nodes[0], chan_0_1.2);
6132 let channel_reserve = chan_stat.channel_reserve_msat;
6133 let feerate = get_feerate!(nodes[0], chan_0_1.2);
6135 // Send a payment which passes reserve checks but gets stuck in the holding cell.
6137 let total_routing_fee_msat = (nodes.len() - 2) as u64 * feemsat;
6138 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[2]);
6139 let max_can_send = 5000000 - channel_reserve - 2*commit_tx_fee_msat(feerate, 1 + 1) - total_routing_fee_msat;
6140 let payment_event = {
6141 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6142 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[2].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], max_can_send, TEST_FINAL_CLTV, &logger).unwrap();
6143 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6144 check_added_monitors!(nodes[0], 1);
6146 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
6147 assert_eq!(events.len(), 1);
6149 SendEvent::from_event(events.remove(0))
6151 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6152 check_added_monitors!(nodes[1], 0);
6153 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6154 expect_pending_htlcs_forwardable!(nodes[1]);
6156 chan_stat = get_channel_value_stat!(nodes[1], chan_1_2.2);
6157 assert_eq!(chan_stat.holding_cell_outbound_amount_msat, max_can_send);
6159 // Flush the pending fee update.
6160 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), commitment_signed);
6161 let (raa, commitment_signed) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
6162 check_added_monitors!(nodes[2], 1);
6163 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &raa);
6164 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &commitment_signed);
6165 check_added_monitors!(nodes[1], 2);
6167 // A final RAA message is generated to finalize the fee update.
6168 let events = nodes[1].node.get_and_clear_pending_msg_events();
6169 assert_eq!(events.len(), 1);
6171 let raa_msg = match &events[0] {
6172 &MessageSendEvent::SendRevokeAndACK { ref msg, .. } => {
6175 _ => panic!("Unexpected event"),
6178 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &raa_msg);
6179 check_added_monitors!(nodes[2], 1);
6180 assert!(nodes[2].node.get_and_clear_pending_msg_events().is_empty());
6182 // nodes[1]'s ChannelManager will now signal that we have HTLC forwards to process.
6183 let process_htlc_forwards_event = nodes[1].node.get_and_clear_pending_events();
6184 assert_eq!(process_htlc_forwards_event.len(), 1);
6185 match &process_htlc_forwards_event[0] {
6186 &Event::PendingHTLCsForwardable { .. } => {},
6187 _ => panic!("Unexpected event"),
6190 // In response, we call ChannelManager's process_pending_htlc_forwards
6191 nodes[1].node.process_pending_htlc_forwards();
6192 check_added_monitors!(nodes[1], 1);
6194 // This causes the HTLC to be failed backwards.
6195 let fail_event = nodes[1].node.get_and_clear_pending_msg_events();
6196 assert_eq!(fail_event.len(), 1);
6197 let (fail_msg, commitment_signed) = match &fail_event[0] {
6198 &MessageSendEvent::UpdateHTLCs { ref updates, .. } => {
6199 assert_eq!(updates.update_add_htlcs.len(), 0);
6200 assert_eq!(updates.update_fulfill_htlcs.len(), 0);
6201 assert_eq!(updates.update_fail_malformed_htlcs.len(), 0);
6202 assert_eq!(updates.update_fail_htlcs.len(), 1);
6203 (updates.update_fail_htlcs[0].clone(), updates.commitment_signed.clone())
6205 _ => panic!("Unexpected event"),
6208 // Pass the failure messages back to nodes[0].
6209 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
6210 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
6212 // Complete the HTLC failure+removal process.
6213 let (raa, commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6214 check_added_monitors!(nodes[0], 1);
6215 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &raa);
6216 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commitment_signed);
6217 check_added_monitors!(nodes[1], 2);
6218 let final_raa_event = nodes[1].node.get_and_clear_pending_msg_events();
6219 assert_eq!(final_raa_event.len(), 1);
6220 let raa = match &final_raa_event[0] {
6221 &MessageSendEvent::SendRevokeAndACK { ref msg, .. } => msg.clone(),
6222 _ => panic!("Unexpected event"),
6224 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &raa);
6225 expect_payment_failed_with_update!(nodes[0], our_payment_hash, false, chan_1_2.0.contents.short_channel_id, false);
6226 check_added_monitors!(nodes[0], 1);
6229 // BOLT 2 Requirements for the Sender when constructing and sending an update_add_htlc message.
6230 // 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.
6231 //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.
6234 fn test_update_add_htlc_bolt2_sender_value_below_minimum_msat() {
6235 //BOLT2 Requirement: MUST NOT offer amount_msat below the receiving node's htlc_minimum_msat (same validation check catches both of these)
6236 let chanmon_cfgs = create_chanmon_cfgs(2);
6237 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6238 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6239 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6240 let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6242 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6243 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6244 let logger = test_utils::TestLogger::new();
6245 let mut route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
6246 route.paths[0][0].fee_msat = 100;
6248 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
6249 assert!(regex::Regex::new(r"Cannot send less than their minimum HTLC value \(\d+\)").unwrap().is_match(err)));
6250 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6251 nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot send less than their minimum HTLC value".to_string(), 1);
6255 fn test_update_add_htlc_bolt2_sender_zero_value_msat() {
6256 //BOLT2 Requirement: MUST offer amount_msat greater than 0.
6257 let chanmon_cfgs = create_chanmon_cfgs(2);
6258 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6259 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6260 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6261 let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6262 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6264 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6265 let logger = test_utils::TestLogger::new();
6266 let mut route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
6267 route.paths[0][0].fee_msat = 0;
6268 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
6269 assert_eq!(err, "Cannot send 0-msat HTLC"));
6271 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6272 nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot send 0-msat HTLC".to_string(), 1);
6276 fn test_update_add_htlc_bolt2_receiver_zero_value_msat() {
6277 //BOLT2 Requirement: MUST offer amount_msat greater than 0.
6278 let chanmon_cfgs = create_chanmon_cfgs(2);
6279 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6280 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6281 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6282 let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6284 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6285 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6286 let logger = test_utils::TestLogger::new();
6287 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
6288 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6289 check_added_monitors!(nodes[0], 1);
6290 let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6291 updates.update_add_htlcs[0].amount_msat = 0;
6293 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6294 nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Remote side tried to send a 0-msat HTLC".to_string(), 1);
6295 check_closed_broadcast!(nodes[1], true).unwrap();
6296 check_added_monitors!(nodes[1], 1);
6300 fn test_update_add_htlc_bolt2_sender_cltv_expiry_too_high() {
6301 //BOLT 2 Requirement: MUST set cltv_expiry less than 500000000.
6302 //It is enforced when constructing a route.
6303 let chanmon_cfgs = create_chanmon_cfgs(2);
6304 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6305 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6306 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6307 let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 0, InitFeatures::known(), InitFeatures::known());
6308 let logger = test_utils::TestLogger::new();
6310 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6312 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6313 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100000000, 500000001, &logger).unwrap();
6314 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::RouteError { ref err },
6315 assert_eq!(err, &"Channel CLTV overflowed?"));
6319 fn test_update_add_htlc_bolt2_sender_exceed_max_htlc_num_and_htlc_id_increment() {
6320 //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.
6321 //BOLT 2 Requirement: for the first HTLC it offers MUST set id to 0.
6322 //BOLT 2 Requirement: MUST increase the value of id by 1 for each successive offer.
6323 let chanmon_cfgs = create_chanmon_cfgs(2);
6324 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6325 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6326 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6327 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 0, InitFeatures::known(), InitFeatures::known());
6328 let max_accepted_htlcs = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().counterparty_max_accepted_htlcs as u64;
6330 let logger = test_utils::TestLogger::new();
6331 for i in 0..max_accepted_htlcs {
6332 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6333 let payment_event = {
6334 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6335 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
6336 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6337 check_added_monitors!(nodes[0], 1);
6339 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
6340 assert_eq!(events.len(), 1);
6341 if let MessageSendEvent::UpdateHTLCs { node_id: _, updates: msgs::CommitmentUpdate{ update_add_htlcs: ref htlcs, .. }, } = events[0] {
6342 assert_eq!(htlcs[0].htlc_id, i);
6346 SendEvent::from_event(events.remove(0))
6348 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6349 check_added_monitors!(nodes[1], 0);
6350 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6352 expect_pending_htlcs_forwardable!(nodes[1]);
6353 expect_payment_received!(nodes[1], our_payment_hash, our_payment_secret, 100000);
6355 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6356 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6357 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
6358 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
6359 assert!(regex::Regex::new(r"Cannot push more than their max accepted HTLCs \(\d+\)").unwrap().is_match(err)));
6361 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6362 nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot push more than their max accepted HTLCs".to_string(), 1);
6366 fn test_update_add_htlc_bolt2_sender_exceed_max_htlc_value_in_flight() {
6367 //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.
6368 let chanmon_cfgs = create_chanmon_cfgs(2);
6369 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6370 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6371 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6372 let channel_value = 100000;
6373 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, channel_value, 0, InitFeatures::known(), InitFeatures::known());
6374 let max_in_flight = get_channel_value_stat!(nodes[0], chan.2).counterparty_max_htlc_value_in_flight_msat;
6376 send_payment(&nodes[0], &vec!(&nodes[1])[..], max_in_flight);
6378 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6379 // Manually create a route over our max in flight (which our router normally automatically
6381 let route = Route { paths: vec![vec![RouteHop {
6382 pubkey: nodes[1].node.get_our_node_id(), node_features: NodeFeatures::known(), channel_features: ChannelFeatures::known(),
6383 short_channel_id: nodes[1].node.list_usable_channels()[0].short_channel_id.unwrap(),
6384 fee_msat: max_in_flight + 1, cltv_expiry_delta: TEST_FINAL_CLTV
6386 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
6387 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)));
6389 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6390 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);
6392 send_payment(&nodes[0], &[&nodes[1]], max_in_flight);
6395 // BOLT 2 Requirements for the Receiver when handling an update_add_htlc message.
6397 fn test_update_add_htlc_bolt2_receiver_check_amount_received_more_than_min() {
6398 //BOLT2 Requirement: receiving an amount_msat equal to 0, OR less than its own htlc_minimum_msat -> SHOULD fail the channel.
6399 let chanmon_cfgs = create_chanmon_cfgs(2);
6400 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6401 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6402 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6403 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6404 let htlc_minimum_msat: u64;
6406 let chan_lock = nodes[0].node.channel_state.lock().unwrap();
6407 let channel = chan_lock.by_id.get(&chan.2).unwrap();
6408 htlc_minimum_msat = channel.get_holder_htlc_minimum_msat();
6411 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6412 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6413 let logger = test_utils::TestLogger::new();
6414 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], htlc_minimum_msat, TEST_FINAL_CLTV, &logger).unwrap();
6415 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6416 check_added_monitors!(nodes[0], 1);
6417 let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6418 updates.update_add_htlcs[0].amount_msat = htlc_minimum_msat-1;
6419 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6420 assert!(nodes[1].node.list_channels().is_empty());
6421 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6422 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()));
6423 check_added_monitors!(nodes[1], 1);
6427 fn test_update_add_htlc_bolt2_receiver_sender_can_afford_amount_sent() {
6428 //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
6429 let chanmon_cfgs = create_chanmon_cfgs(2);
6430 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6431 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6432 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6433 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6434 let logger = test_utils::TestLogger::new();
6436 let chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6437 let channel_reserve = chan_stat.channel_reserve_msat;
6438 let feerate = get_feerate!(nodes[0], chan.2);
6439 // The 2* and +1 are for the fee spike reserve.
6440 let commit_tx_fee_outbound = 2 * commit_tx_fee_msat(feerate, 1 + 1);
6442 let max_can_send = 5000000 - channel_reserve - commit_tx_fee_outbound;
6443 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6444 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6445 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], max_can_send, TEST_FINAL_CLTV, &logger).unwrap();
6446 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6447 check_added_monitors!(nodes[0], 1);
6448 let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6450 // Even though channel-initiator senders are required to respect the fee_spike_reserve,
6451 // at this time channel-initiatee receivers are not required to enforce that senders
6452 // respect the fee_spike_reserve.
6453 updates.update_add_htlcs[0].amount_msat = max_can_send + commit_tx_fee_outbound + 1;
6454 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6456 assert!(nodes[1].node.list_channels().is_empty());
6457 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6458 assert_eq!(err_msg.data, "Remote HTLC add would put them under remote reserve value");
6459 check_added_monitors!(nodes[1], 1);
6463 fn test_update_add_htlc_bolt2_receiver_check_max_htlc_limit() {
6464 //BOLT 2 Requirement: if a sending node adds more than its max_accepted_htlcs HTLCs to its local commitment transaction: SHOULD fail the channel
6465 //BOLT 2 Requirement: MUST allow multiple HTLCs with the same payment_hash.
6466 let chanmon_cfgs = create_chanmon_cfgs(2);
6467 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6468 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6469 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6470 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6471 let logger = test_utils::TestLogger::new();
6473 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6474 let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
6476 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6477 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 3999999, TEST_FINAL_CLTV, &logger).unwrap();
6479 let cur_height = nodes[0].node.best_block.read().unwrap().height() + 1;
6480 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::signing_only(), &route.paths[0], &session_priv).unwrap();
6481 let (onion_payloads, _htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 3999999, &Some(our_payment_secret), cur_height, &None).unwrap();
6482 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &our_payment_hash);
6484 let mut msg = msgs::UpdateAddHTLC {
6488 payment_hash: our_payment_hash,
6489 cltv_expiry: htlc_cltv,
6490 onion_routing_packet: onion_packet.clone(),
6493 for i in 0..super::channel::OUR_MAX_HTLCS {
6494 msg.htlc_id = i as u64;
6495 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
6497 msg.htlc_id = (super::channel::OUR_MAX_HTLCS) as u64;
6498 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
6500 assert!(nodes[1].node.list_channels().is_empty());
6501 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6502 assert!(regex::Regex::new(r"Remote tried to push more than our max accepted HTLCs \(\d+\)").unwrap().is_match(err_msg.data.as_str()));
6503 check_added_monitors!(nodes[1], 1);
6507 fn test_update_add_htlc_bolt2_receiver_check_max_in_flight_msat() {
6508 //OR adds more than its max_htlc_value_in_flight_msat worth of offered HTLCs to its local commitment transaction: SHOULD fail the channel
6509 let chanmon_cfgs = create_chanmon_cfgs(2);
6510 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6511 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6512 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6513 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
6514 let logger = test_utils::TestLogger::new();
6516 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6517 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6518 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 1000000, TEST_FINAL_CLTV, &logger).unwrap();
6519 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6520 check_added_monitors!(nodes[0], 1);
6521 let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6522 updates.update_add_htlcs[0].amount_msat = get_channel_value_stat!(nodes[1], chan.2).counterparty_max_htlc_value_in_flight_msat + 1;
6523 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6525 assert!(nodes[1].node.list_channels().is_empty());
6526 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6527 assert!(regex::Regex::new("Remote HTLC add would put them over our max HTLC value").unwrap().is_match(err_msg.data.as_str()));
6528 check_added_monitors!(nodes[1], 1);
6532 fn test_update_add_htlc_bolt2_receiver_check_cltv_expiry() {
6533 //BOLT2 Requirement: if sending node sets cltv_expiry to greater or equal to 500000000: SHOULD fail the channel.
6534 let chanmon_cfgs = create_chanmon_cfgs(2);
6535 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6536 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6537 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6538 let logger = test_utils::TestLogger::new();
6540 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6541 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6542 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6543 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 1000000, TEST_FINAL_CLTV, &logger).unwrap();
6544 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6545 check_added_monitors!(nodes[0], 1);
6546 let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6547 updates.update_add_htlcs[0].cltv_expiry = 500000000;
6548 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6550 assert!(nodes[1].node.list_channels().is_empty());
6551 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6552 assert_eq!(err_msg.data,"Remote provided CLTV expiry in seconds instead of block height");
6553 check_added_monitors!(nodes[1], 1);
6557 fn test_update_add_htlc_bolt2_receiver_check_repeated_id_ignore() {
6558 //BOLT 2 requirement: if the sender did not previously acknowledge the commitment of that HTLC: MUST ignore a repeated id value after a reconnection.
6559 // We test this by first testing that that repeated HTLCs pass commitment signature checks
6560 // after disconnect and that non-sequential htlc_ids result in a channel failure.
6561 let chanmon_cfgs = create_chanmon_cfgs(2);
6562 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6563 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6564 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6565 let logger = test_utils::TestLogger::new();
6567 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6568 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6569 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6570 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 1000000, TEST_FINAL_CLTV, &logger).unwrap();
6571 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6572 check_added_monitors!(nodes[0], 1);
6573 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6574 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6576 //Disconnect and Reconnect
6577 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
6578 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
6579 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
6580 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
6581 assert_eq!(reestablish_1.len(), 1);
6582 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
6583 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
6584 assert_eq!(reestablish_2.len(), 1);
6585 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
6586 handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
6587 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
6588 handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
6591 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6592 assert_eq!(updates.commitment_signed.htlc_signatures.len(), 1);
6593 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &updates.commitment_signed);
6594 check_added_monitors!(nodes[1], 1);
6595 let _bs_responses = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6597 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6599 assert!(nodes[1].node.list_channels().is_empty());
6600 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6601 assert!(regex::Regex::new(r"Remote skipped HTLC ID \(skipped ID: \d+\)").unwrap().is_match(err_msg.data.as_str()));
6602 check_added_monitors!(nodes[1], 1);
6606 fn test_update_fulfill_htlc_bolt2_update_fulfill_htlc_before_commitment() {
6607 //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.
6609 let chanmon_cfgs = create_chanmon_cfgs(2);
6610 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6611 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6612 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6613 let logger = test_utils::TestLogger::new();
6614 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6615 let (our_payment_preimage, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6616 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6617 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 1000000, TEST_FINAL_CLTV, &logger).unwrap();
6618 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6620 check_added_monitors!(nodes[0], 1);
6621 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6622 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6624 let update_msg = msgs::UpdateFulfillHTLC{
6627 payment_preimage: our_payment_preimage,
6630 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6632 assert!(nodes[0].node.list_channels().is_empty());
6633 let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6634 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()));
6635 check_added_monitors!(nodes[0], 1);
6639 fn test_update_fulfill_htlc_bolt2_update_fail_htlc_before_commitment() {
6640 //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.
6642 let chanmon_cfgs = create_chanmon_cfgs(2);
6643 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6644 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6645 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6646 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6647 let logger = test_utils::TestLogger::new();
6649 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6650 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6651 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 1000000, TEST_FINAL_CLTV, &logger).unwrap();
6652 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6653 check_added_monitors!(nodes[0], 1);
6654 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6655 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6657 let update_msg = msgs::UpdateFailHTLC{
6660 reason: msgs::OnionErrorPacket { data: Vec::new()},
6663 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6665 assert!(nodes[0].node.list_channels().is_empty());
6666 let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6667 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()));
6668 check_added_monitors!(nodes[0], 1);
6672 fn test_update_fulfill_htlc_bolt2_update_fail_malformed_htlc_before_commitment() {
6673 //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.
6675 let chanmon_cfgs = create_chanmon_cfgs(2);
6676 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6677 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6678 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6679 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6680 let logger = test_utils::TestLogger::new();
6682 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6683 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6684 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 1000000, TEST_FINAL_CLTV, &logger).unwrap();
6685 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6686 check_added_monitors!(nodes[0], 1);
6687 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6688 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6689 let update_msg = msgs::UpdateFailMalformedHTLC{
6692 sha256_of_onion: [1; 32],
6693 failure_code: 0x8000,
6696 nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6698 assert!(nodes[0].node.list_channels().is_empty());
6699 let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6700 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()));
6701 check_added_monitors!(nodes[0], 1);
6705 fn test_update_fulfill_htlc_bolt2_incorrect_htlc_id() {
6706 //BOLT 2 Requirement: A receiving node: if the id does not correspond to an HTLC in its current commitment transaction MUST fail the channel.
6708 let chanmon_cfgs = create_chanmon_cfgs(2);
6709 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6710 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6711 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6712 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6714 let our_payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 100000).0;
6716 nodes[1].node.claim_funds(our_payment_preimage);
6717 check_added_monitors!(nodes[1], 1);
6719 let events = nodes[1].node.get_and_clear_pending_msg_events();
6720 assert_eq!(events.len(), 1);
6721 let mut update_fulfill_msg: msgs::UpdateFulfillHTLC = {
6723 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, .. } } => {
6724 assert!(update_add_htlcs.is_empty());
6725 assert_eq!(update_fulfill_htlcs.len(), 1);
6726 assert!(update_fail_htlcs.is_empty());
6727 assert!(update_fail_malformed_htlcs.is_empty());
6728 assert!(update_fee.is_none());
6729 update_fulfill_htlcs[0].clone()
6731 _ => panic!("Unexpected event"),
6735 update_fulfill_msg.htlc_id = 1;
6737 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_msg);
6739 assert!(nodes[0].node.list_channels().is_empty());
6740 let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6741 assert_eq!(err_msg.data, "Remote tried to fulfill/fail an HTLC we couldn't find");
6742 check_added_monitors!(nodes[0], 1);
6746 fn test_update_fulfill_htlc_bolt2_wrong_preimage() {
6747 //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.
6749 let chanmon_cfgs = create_chanmon_cfgs(2);
6750 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6751 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6752 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6753 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6755 let our_payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 100000).0;
6757 nodes[1].node.claim_funds(our_payment_preimage);
6758 check_added_monitors!(nodes[1], 1);
6760 let events = nodes[1].node.get_and_clear_pending_msg_events();
6761 assert_eq!(events.len(), 1);
6762 let mut update_fulfill_msg: msgs::UpdateFulfillHTLC = {
6764 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, .. } } => {
6765 assert!(update_add_htlcs.is_empty());
6766 assert_eq!(update_fulfill_htlcs.len(), 1);
6767 assert!(update_fail_htlcs.is_empty());
6768 assert!(update_fail_malformed_htlcs.is_empty());
6769 assert!(update_fee.is_none());
6770 update_fulfill_htlcs[0].clone()
6772 _ => panic!("Unexpected event"),
6776 update_fulfill_msg.payment_preimage = PaymentPreimage([1; 32]);
6778 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_msg);
6780 assert!(nodes[0].node.list_channels().is_empty());
6781 let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6782 assert!(regex::Regex::new(r"Remote tried to fulfill HTLC \(\d+\) with an incorrect preimage").unwrap().is_match(err_msg.data.as_str()));
6783 check_added_monitors!(nodes[0], 1);
6787 fn test_update_fulfill_htlc_bolt2_missing_badonion_bit_for_malformed_htlc_message() {
6788 //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.
6790 let chanmon_cfgs = create_chanmon_cfgs(2);
6791 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6792 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6793 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6794 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
6795 let logger = test_utils::TestLogger::new();
6797 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6798 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6799 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 1000000, TEST_FINAL_CLTV, &logger).unwrap();
6800 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6801 check_added_monitors!(nodes[0], 1);
6803 let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6804 updates.update_add_htlcs[0].onion_routing_packet.version = 1; //Produce a malformed HTLC message
6806 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6807 check_added_monitors!(nodes[1], 0);
6808 commitment_signed_dance!(nodes[1], nodes[0], updates.commitment_signed, false, true);
6810 let events = nodes[1].node.get_and_clear_pending_msg_events();
6812 let mut update_msg: msgs::UpdateFailMalformedHTLC = {
6814 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, .. } } => {
6815 assert!(update_add_htlcs.is_empty());
6816 assert!(update_fulfill_htlcs.is_empty());
6817 assert!(update_fail_htlcs.is_empty());
6818 assert_eq!(update_fail_malformed_htlcs.len(), 1);
6819 assert!(update_fee.is_none());
6820 update_fail_malformed_htlcs[0].clone()
6822 _ => panic!("Unexpected event"),
6825 update_msg.failure_code &= !0x8000;
6826 nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6828 assert!(nodes[0].node.list_channels().is_empty());
6829 let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6830 assert_eq!(err_msg.data, "Got update_fail_malformed_htlc with BADONION not set");
6831 check_added_monitors!(nodes[0], 1);
6835 fn test_update_fulfill_htlc_bolt2_after_malformed_htlc_message_must_forward_update_fail_htlc() {
6836 //BOLT 2 Requirement: a receiving node which has an outgoing HTLC canceled by update_fail_malformed_htlc:
6837 // * 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.
6839 let chanmon_cfgs = create_chanmon_cfgs(3);
6840 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
6841 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
6842 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
6843 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
6844 create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
6845 let logger = test_utils::TestLogger::new();
6847 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[2]);
6850 let mut payment_event = {
6851 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6852 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[2].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
6853 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6854 check_added_monitors!(nodes[0], 1);
6855 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
6856 assert_eq!(events.len(), 1);
6857 SendEvent::from_event(events.remove(0))
6859 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6860 check_added_monitors!(nodes[1], 0);
6861 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6862 expect_pending_htlcs_forwardable!(nodes[1]);
6863 let mut events_2 = nodes[1].node.get_and_clear_pending_msg_events();
6864 assert_eq!(events_2.len(), 1);
6865 check_added_monitors!(nodes[1], 1);
6866 payment_event = SendEvent::from_event(events_2.remove(0));
6867 assert_eq!(payment_event.msgs.len(), 1);
6870 payment_event.msgs[0].onion_routing_packet.version = 1; //Produce a malformed HTLC message
6871 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
6872 check_added_monitors!(nodes[2], 0);
6873 commitment_signed_dance!(nodes[2], nodes[1], payment_event.commitment_msg, false, true);
6875 let events_3 = nodes[2].node.get_and_clear_pending_msg_events();
6876 assert_eq!(events_3.len(), 1);
6877 let update_msg : (msgs::UpdateFailMalformedHTLC, msgs::CommitmentSigned) = {
6879 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 } } => {
6880 assert!(update_add_htlcs.is_empty());
6881 assert!(update_fulfill_htlcs.is_empty());
6882 assert!(update_fail_htlcs.is_empty());
6883 assert_eq!(update_fail_malformed_htlcs.len(), 1);
6884 assert!(update_fee.is_none());
6885 (update_fail_malformed_htlcs[0].clone(), commitment_signed.clone())
6887 _ => panic!("Unexpected event"),
6891 nodes[1].node.handle_update_fail_malformed_htlc(&nodes[2].node.get_our_node_id(), &update_msg.0);
6893 check_added_monitors!(nodes[1], 0);
6894 commitment_signed_dance!(nodes[1], nodes[2], update_msg.1, false, true);
6895 expect_pending_htlcs_forwardable!(nodes[1]);
6896 let events_4 = nodes[1].node.get_and_clear_pending_msg_events();
6897 assert_eq!(events_4.len(), 1);
6899 //Confirm that handlinge the update_malformed_htlc message produces an update_fail_htlc message to be forwarded back along the route
6901 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, .. } } => {
6902 assert!(update_add_htlcs.is_empty());
6903 assert!(update_fulfill_htlcs.is_empty());
6904 assert_eq!(update_fail_htlcs.len(), 1);
6905 assert!(update_fail_malformed_htlcs.is_empty());
6906 assert!(update_fee.is_none());
6908 _ => panic!("Unexpected event"),
6911 check_added_monitors!(nodes[1], 1);
6914 fn do_test_failure_delay_dust_htlc_local_commitment(announce_latest: bool) {
6915 // Dust-HTLC failure updates must be delayed until failure-trigger tx (in this case local commitment) reach ANTI_REORG_DELAY
6916 // 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
6917 // HTLC could have been removed from lastest local commitment tx but still valid until we get remote RAA
6919 let mut chanmon_cfgs = create_chanmon_cfgs(2);
6920 chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
6921 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6922 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6923 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6924 let chan =create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6926 let bs_dust_limit = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().holder_dust_limit_satoshis;
6928 // We route 2 dust-HTLCs between A and B
6929 let (_, payment_hash_1, _) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
6930 let (_, payment_hash_2, _) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
6931 route_payment(&nodes[0], &[&nodes[1]], 1000000);
6933 // Cache one local commitment tx as previous
6934 let as_prev_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
6936 // Fail one HTLC to prune it in the will-be-latest-local commitment tx
6937 assert!(nodes[1].node.fail_htlc_backwards(&payment_hash_2));
6938 check_added_monitors!(nodes[1], 0);
6939 expect_pending_htlcs_forwardable!(nodes[1]);
6940 check_added_monitors!(nodes[1], 1);
6942 let remove = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6943 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &remove.update_fail_htlcs[0]);
6944 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &remove.commitment_signed);
6945 check_added_monitors!(nodes[0], 1);
6947 // Cache one local commitment tx as lastest
6948 let as_last_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
6950 let events = nodes[0].node.get_and_clear_pending_msg_events();
6952 MessageSendEvent::SendRevokeAndACK { node_id, .. } => {
6953 assert_eq!(node_id, nodes[1].node.get_our_node_id());
6955 _ => panic!("Unexpected event"),
6958 MessageSendEvent::UpdateHTLCs { node_id, .. } => {
6959 assert_eq!(node_id, nodes[1].node.get_our_node_id());
6961 _ => panic!("Unexpected event"),
6964 assert_ne!(as_prev_commitment_tx, as_last_commitment_tx);
6965 // Fail the 2 dust-HTLCs, move their failure in maturation buffer (htlc_updated_waiting_threshold_conf)
6966 if announce_latest {
6967 mine_transaction(&nodes[0], &as_last_commitment_tx[0]);
6969 mine_transaction(&nodes[0], &as_prev_commitment_tx[0]);
6972 check_closed_broadcast!(nodes[0], true);
6973 check_added_monitors!(nodes[0], 1);
6975 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
6976 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
6977 let events = nodes[0].node.get_and_clear_pending_events();
6978 // Only 2 PaymentFailed events should show up, over-dust HTLC has to be failed by timeout tx
6979 assert_eq!(events.len(), 2);
6980 let mut first_failed = false;
6981 for event in events {
6983 Event::PaymentFailed { payment_hash, .. } => {
6984 if payment_hash == payment_hash_1 {
6985 assert!(!first_failed);
6986 first_failed = true;
6988 assert_eq!(payment_hash, payment_hash_2);
6991 _ => panic!("Unexpected event"),
6997 fn test_failure_delay_dust_htlc_local_commitment() {
6998 do_test_failure_delay_dust_htlc_local_commitment(true);
6999 do_test_failure_delay_dust_htlc_local_commitment(false);
7002 fn do_test_sweep_outbound_htlc_failure_update(revoked: bool, local: bool) {
7003 // Outbound HTLC-failure updates must be cancelled if we get a reorg before we reach ANTI_REORG_DELAY.
7004 // Broadcast of revoked remote commitment tx, trigger failure-update of dust/non-dust HTLCs
7005 // Broadcast of remote commitment tx, trigger failure-update of dust-HTLCs
7006 // Broadcast of timeout tx on remote commitment tx, trigger failure-udate of non-dust HTLCs
7007 // Broadcast of local commitment tx, trigger failure-update of dust-HTLCs
7008 // Broadcast of HTLC-timeout tx on local commitment tx, trigger failure-update of non-dust HTLCs
7010 let chanmon_cfgs = create_chanmon_cfgs(3);
7011 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7012 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
7013 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7014 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7016 let bs_dust_limit = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().holder_dust_limit_satoshis;
7018 let (_payment_preimage_1, dust_hash, _payment_secret_1) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
7019 let (_payment_preimage_2, non_dust_hash, _payment_secret_2) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
7021 let as_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
7022 let bs_commitment_tx = get_local_commitment_txn!(nodes[1], chan.2);
7024 // We revoked bs_commitment_tx
7026 let (payment_preimage_3, _, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
7027 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_3);
7030 let mut timeout_tx = Vec::new();
7032 // We fail dust-HTLC 1 by broadcast of local commitment tx
7033 mine_transaction(&nodes[0], &as_commitment_tx[0]);
7034 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7035 expect_payment_failed!(nodes[0], dust_hash, true);
7037 connect_blocks(&nodes[0], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS - ANTI_REORG_DELAY);
7038 check_closed_broadcast!(nodes[0], true);
7039 check_added_monitors!(nodes[0], 1);
7040 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7041 timeout_tx.push(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[1].clone());
7042 assert_eq!(timeout_tx[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
7043 // We fail non-dust-HTLC 2 by broadcast of local HTLC-timeout tx on local commitment tx
7044 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7045 mine_transaction(&nodes[0], &timeout_tx[0]);
7046 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7047 expect_payment_failed!(nodes[0], non_dust_hash, true);
7049 // We fail dust-HTLC 1 by broadcast of remote commitment tx. If revoked, fail also non-dust HTLC
7050 mine_transaction(&nodes[0], &bs_commitment_tx[0]);
7051 check_closed_broadcast!(nodes[0], true);
7052 check_added_monitors!(nodes[0], 1);
7053 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7054 connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
7055 timeout_tx.push(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[1].clone());
7057 expect_payment_failed!(nodes[0], dust_hash, true);
7058 assert_eq!(timeout_tx[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
7059 // We fail non-dust-HTLC 2 by broadcast of local timeout tx on remote commitment tx
7060 mine_transaction(&nodes[0], &timeout_tx[0]);
7061 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7062 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7063 expect_payment_failed!(nodes[0], non_dust_hash, true);
7065 // If revoked, both dust & non-dust HTLCs should have been failed after ANTI_REORG_DELAY confs of revoked
7067 let events = nodes[0].node.get_and_clear_pending_events();
7068 assert_eq!(events.len(), 2);
7071 Event::PaymentFailed { payment_hash, .. } => {
7072 if payment_hash == dust_hash { first = true; }
7073 else { first = false; }
7075 _ => panic!("Unexpected event"),
7078 Event::PaymentFailed { payment_hash, .. } => {
7079 if first { assert_eq!(payment_hash, non_dust_hash); }
7080 else { assert_eq!(payment_hash, dust_hash); }
7082 _ => panic!("Unexpected event"),
7089 fn test_sweep_outbound_htlc_failure_update() {
7090 do_test_sweep_outbound_htlc_failure_update(false, true);
7091 do_test_sweep_outbound_htlc_failure_update(false, false);
7092 do_test_sweep_outbound_htlc_failure_update(true, false);
7096 fn test_user_configurable_csv_delay() {
7097 // We test our channel constructors yield errors when we pass them absurd csv delay
7099 let mut low_our_to_self_config = UserConfig::default();
7100 low_our_to_self_config.own_channel_config.our_to_self_delay = 6;
7101 let mut high_their_to_self_config = UserConfig::default();
7102 high_their_to_self_config.peer_channel_config_limits.their_to_self_delay = 100;
7103 let user_cfgs = [Some(high_their_to_self_config.clone()), None];
7104 let chanmon_cfgs = create_chanmon_cfgs(2);
7105 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7106 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &user_cfgs);
7107 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7109 // We test config.our_to_self > BREAKDOWN_TIMEOUT is enforced in Channel::new_outbound()
7110 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) {
7112 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())); },
7113 _ => panic!("Unexpected event"),
7115 } else { assert!(false) }
7117 // We test config.our_to_self > BREAKDOWN_TIMEOUT is enforced in Channel::new_from_req()
7118 nodes[1].node.create_channel(nodes[0].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
7119 let mut open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
7120 open_channel.to_self_delay = 200;
7121 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) {
7123 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())); },
7124 _ => panic!("Unexpected event"),
7126 } else { assert!(false); }
7128 // We test msg.to_self_delay <= config.their_to_self_delay is enforced in Chanel::accept_channel()
7129 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
7130 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()));
7131 let mut accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
7132 accept_channel.to_self_delay = 200;
7133 nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &accept_channel);
7134 if let MessageSendEvent::HandleError { ref action, .. } = nodes[0].node.get_and_clear_pending_msg_events()[0] {
7136 &ErrorAction::SendErrorMessage { ref msg } => {
7137 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()));
7139 _ => { assert!(false); }
7141 } else { assert!(false); }
7143 // We test msg.to_self_delay <= config.their_to_self_delay is enforced in Channel::new_from_req()
7144 nodes[1].node.create_channel(nodes[0].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
7145 let mut open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
7146 open_channel.to_self_delay = 200;
7147 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) {
7149 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())); },
7150 _ => panic!("Unexpected event"),
7152 } else { assert!(false); }
7156 fn test_data_loss_protect() {
7157 // We want to be sure that :
7158 // * we don't broadcast our Local Commitment Tx in case of fallen behind
7159 // (but this is not quite true - we broadcast during Drop because chanmon is out of sync with chanmgr)
7160 // * we close channel in case of detecting other being fallen behind
7161 // * we are able to claim our own outputs thanks to to_remote being static
7162 // TODO: this test is incomplete and the data_loss_protect implementation is incomplete - see issue #775
7168 let mut chanmon_cfgs = create_chanmon_cfgs(2);
7169 // We broadcast during Drop because chanmon is out of sync with chanmgr, which would cause a panic
7170 // during signing due to revoked tx
7171 chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
7172 let keys_manager = &chanmon_cfgs[0].keys_manager;
7175 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7176 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7177 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7179 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7181 // Cache node A state before any channel update
7182 let previous_node_state = nodes[0].node.encode();
7183 let mut previous_chain_monitor_state = test_utils::TestVecWriter(Vec::new());
7184 nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut previous_chain_monitor_state).unwrap();
7186 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
7187 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
7189 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
7190 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
7192 // Restore node A from previous state
7193 logger = test_utils::TestLogger::with_id(format!("node {}", 0));
7194 let mut chain_monitor = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(&mut io::Cursor::new(previous_chain_monitor_state.0), keys_manager).unwrap().1;
7195 chain_source = test_utils::TestChainSource::new(Network::Testnet);
7196 tx_broadcaster = test_utils::TestBroadcaster{txn_broadcasted: Mutex::new(Vec::new()), blocks: Arc::new(Mutex::new(Vec::new()))};
7197 fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
7198 persister = test_utils::TestPersister::new();
7199 monitor = test_utils::TestChainMonitor::new(Some(&chain_source), &tx_broadcaster, &logger, &fee_estimator, &persister, keys_manager);
7201 let mut channel_monitors = HashMap::new();
7202 channel_monitors.insert(OutPoint { txid: chan.3.txid(), index: 0 }, &mut chain_monitor);
7203 <(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 {
7204 keys_manager: keys_manager,
7205 fee_estimator: &fee_estimator,
7206 chain_monitor: &monitor,
7208 tx_broadcaster: &tx_broadcaster,
7209 default_config: UserConfig::default(),
7213 nodes[0].node = &node_state_0;
7214 assert!(monitor.watch_channel(OutPoint { txid: chan.3.txid(), index: 0 }, chain_monitor).is_ok());
7215 nodes[0].chain_monitor = &monitor;
7216 nodes[0].chain_source = &chain_source;
7218 check_added_monitors!(nodes[0], 1);
7220 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7221 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7223 let reestablish_0 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
7225 // Check we don't broadcast any transactions following learning of per_commitment_point from B
7226 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_0[0]);
7227 check_added_monitors!(nodes[0], 1);
7230 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
7231 assert_eq!(node_txn.len(), 0);
7234 let mut reestablish_1 = Vec::with_capacity(1);
7235 for msg in nodes[0].node.get_and_clear_pending_msg_events() {
7236 if let MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } = msg {
7237 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
7238 reestablish_1.push(msg.clone());
7239 } else if let MessageSendEvent::BroadcastChannelUpdate { .. } = msg {
7240 } else if let MessageSendEvent::HandleError { ref action, .. } = msg {
7242 &ErrorAction::SendErrorMessage { ref msg } => {
7243 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");
7245 _ => panic!("Unexpected event!"),
7248 panic!("Unexpected event")
7252 // Check we close channel detecting A is fallen-behind
7253 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
7254 assert_eq!(check_closed_broadcast!(nodes[1], true).unwrap().data, "Peer attempted to reestablish channel with a very old local commitment transaction");
7255 check_added_monitors!(nodes[1], 1);
7258 // Check A is able to claim to_remote output
7259 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
7260 assert_eq!(node_txn.len(), 1);
7261 check_spends!(node_txn[0], chan.3);
7262 assert_eq!(node_txn[0].output.len(), 2);
7263 mine_transaction(&nodes[0], &node_txn[0]);
7264 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7265 let spend_txn = check_spendable_outputs!(nodes[0], node_cfgs[0].keys_manager);
7266 assert_eq!(spend_txn.len(), 1);
7267 check_spends!(spend_txn[0], node_txn[0]);
7271 fn test_check_htlc_underpaying() {
7272 // Send payment through A -> B but A is maliciously
7273 // sending a probe payment (i.e less than expected value0
7274 // to B, B should refuse payment.
7276 let chanmon_cfgs = create_chanmon_cfgs(2);
7277 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7278 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7279 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7281 // Create some initial channels
7282 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7284 let route = get_route(&nodes[0].node.get_our_node_id(), &nodes[0].net_graph_msg_handler.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 10_000, TEST_FINAL_CLTV, nodes[0].logger).unwrap();
7285 let (_, our_payment_hash, _) = get_payment_preimage_hash!(nodes[0]);
7286 let our_payment_secret = nodes[1].node.create_inbound_payment_for_hash(our_payment_hash, Some(100_000), 7200, 0).unwrap();
7287 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
7288 check_added_monitors!(nodes[0], 1);
7290 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
7291 assert_eq!(events.len(), 1);
7292 let mut payment_event = SendEvent::from_event(events.pop().unwrap());
7293 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
7294 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
7296 // Note that we first have to wait a random delay before processing the receipt of the HTLC,
7297 // and then will wait a second random delay before failing the HTLC back:
7298 expect_pending_htlcs_forwardable!(nodes[1]);
7299 expect_pending_htlcs_forwardable!(nodes[1]);
7301 // Node 3 is expecting payment of 100_000 but received 10_000,
7302 // it should fail htlc like we didn't know the preimage.
7303 nodes[1].node.process_pending_htlc_forwards();
7305 let events = nodes[1].node.get_and_clear_pending_msg_events();
7306 assert_eq!(events.len(), 1);
7307 let (update_fail_htlc, commitment_signed) = match events[0] {
7308 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 } } => {
7309 assert!(update_add_htlcs.is_empty());
7310 assert!(update_fulfill_htlcs.is_empty());
7311 assert_eq!(update_fail_htlcs.len(), 1);
7312 assert!(update_fail_malformed_htlcs.is_empty());
7313 assert!(update_fee.is_none());
7314 (update_fail_htlcs[0].clone(), commitment_signed)
7316 _ => panic!("Unexpected event"),
7318 check_added_monitors!(nodes[1], 1);
7320 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlc);
7321 commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
7323 // 10_000 msat as u64, followed by a height of CHAN_CONFIRM_DEPTH as u32
7324 let mut expected_failure_data = byte_utils::be64_to_array(10_000).to_vec();
7325 expected_failure_data.extend_from_slice(&byte_utils::be32_to_array(CHAN_CONFIRM_DEPTH));
7326 expect_payment_failed!(nodes[0], our_payment_hash, true, 0x4000|15, &expected_failure_data[..]);
7330 fn test_announce_disable_channels() {
7331 // Create 2 channels between A and B. Disconnect B. Call timer_tick_occurred and check for generated
7332 // ChannelUpdate. Reconnect B, reestablish and check there is non-generated ChannelUpdate.
7334 let chanmon_cfgs = create_chanmon_cfgs(2);
7335 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7336 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7337 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7339 let short_id_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
7340 let short_id_2 = create_announced_chan_between_nodes(&nodes, 1, 0, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
7341 let short_id_3 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
7344 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
7345 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
7347 nodes[0].node.timer_tick_occurred(); // Enabled -> DisabledStaged
7348 nodes[0].node.timer_tick_occurred(); // DisabledStaged -> Disabled
7349 let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
7350 assert_eq!(msg_events.len(), 3);
7351 let mut chans_disabled: HashSet<u64> = [short_id_1, short_id_2, short_id_3].iter().map(|a| *a).collect();
7352 for e in msg_events {
7354 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
7355 assert_eq!(msg.contents.flags & (1<<1), 1<<1); // The "channel disabled" bit should be set
7356 // Check that each channel gets updated exactly once
7357 if !chans_disabled.remove(&msg.contents.short_channel_id) {
7358 panic!("Generated ChannelUpdate for wrong chan!");
7361 _ => panic!("Unexpected event"),
7365 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7366 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
7367 assert_eq!(reestablish_1.len(), 3);
7368 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7369 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
7370 assert_eq!(reestablish_2.len(), 3);
7372 // Reestablish chan_1
7373 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
7374 handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
7375 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
7376 handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
7377 // Reestablish chan_2
7378 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[1]);
7379 handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
7380 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[1]);
7381 handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
7382 // Reestablish chan_3
7383 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[2]);
7384 handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
7385 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[2]);
7386 handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
7388 nodes[0].node.timer_tick_occurred();
7389 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
7390 nodes[0].node.timer_tick_occurred();
7391 let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
7392 assert_eq!(msg_events.len(), 3);
7393 chans_disabled = [short_id_1, short_id_2, short_id_3].iter().map(|a| *a).collect();
7394 for e in msg_events {
7396 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
7397 assert_eq!(msg.contents.flags & (1<<1), 0); // The "channel disabled" bit should be off
7398 // Check that each channel gets updated exactly once
7399 if !chans_disabled.remove(&msg.contents.short_channel_id) {
7400 panic!("Generated ChannelUpdate for wrong chan!");
7403 _ => panic!("Unexpected event"),
7409 fn test_priv_forwarding_rejection() {
7410 // If we have a private channel with outbound liquidity, and
7411 // UserConfig::accept_forwards_to_priv_channels is set to false, we should reject any attempts
7412 // to forward through that channel.
7413 let chanmon_cfgs = create_chanmon_cfgs(3);
7414 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7415 let mut no_announce_cfg = test_default_channel_config();
7416 no_announce_cfg.channel_options.announced_channel = false;
7417 no_announce_cfg.accept_forwards_to_priv_channels = false;
7418 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, Some(no_announce_cfg), None]);
7419 let persister: test_utils::TestPersister;
7420 let new_chain_monitor: test_utils::TestChainMonitor;
7421 let nodes_1_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
7422 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7424 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1_000_000, 500_000_000, InitFeatures::known(), InitFeatures::known());
7426 // Note that the create_*_chan functions in utils requires announcement_signatures, which we do
7427 // not send for private channels.
7428 nodes[1].node.create_channel(nodes[2].node.get_our_node_id(), 1_000_000, 500_000_000, 42, None).unwrap();
7429 let open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[2].node.get_our_node_id());
7430 nodes[2].node.handle_open_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &open_channel);
7431 let accept_channel = get_event_msg!(nodes[2], MessageSendEvent::SendAcceptChannel, nodes[1].node.get_our_node_id());
7432 nodes[1].node.handle_accept_channel(&nodes[2].node.get_our_node_id(), InitFeatures::known(), &accept_channel);
7434 let (temporary_channel_id, tx, _) = create_funding_transaction(&nodes[1], 1_000_000, 42);
7435 nodes[1].node.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
7436 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()));
7437 check_added_monitors!(nodes[2], 1);
7439 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()));
7440 check_added_monitors!(nodes[1], 1);
7442 let conf_height = core::cmp::max(nodes[1].best_block_info().1 + 1, nodes[2].best_block_info().1 + 1);
7443 confirm_transaction_at(&nodes[1], &tx, conf_height);
7444 connect_blocks(&nodes[1], CHAN_CONFIRM_DEPTH - 1);
7445 confirm_transaction_at(&nodes[2], &tx, conf_height);
7446 connect_blocks(&nodes[2], CHAN_CONFIRM_DEPTH - 1);
7447 let as_funding_locked = get_event_msg!(nodes[1], MessageSendEvent::SendFundingLocked, nodes[2].node.get_our_node_id());
7448 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()));
7449 get_event_msg!(nodes[1], MessageSendEvent::SendChannelUpdate, nodes[2].node.get_our_node_id());
7450 nodes[2].node.handle_funding_locked(&nodes[1].node.get_our_node_id(), &as_funding_locked);
7451 get_event_msg!(nodes[2], MessageSendEvent::SendChannelUpdate, nodes[1].node.get_our_node_id());
7453 assert!(nodes[0].node.list_usable_channels()[0].is_public);
7454 assert_eq!(nodes[1].node.list_usable_channels().len(), 2);
7455 assert!(!nodes[2].node.list_usable_channels()[0].is_public);
7457 // We should always be able to forward through nodes[1] as long as its out through a public
7459 send_payment(&nodes[2], &[&nodes[1], &nodes[0]], 10_000);
7461 // ... however, if we send to nodes[2], we will have to pass the private channel from nodes[1]
7462 // to nodes[2], which should be rejected:
7463 let (our_payment_preimage, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[2]);
7464 let route = get_route(&nodes[0].node.get_our_node_id(),
7465 &nodes[0].net_graph_msg_handler.network_graph,
7466 &nodes[2].node.get_our_node_id(), Some(InvoiceFeatures::known()), None,
7467 &[&RouteHint(vec![RouteHintHop {
7468 src_node_id: nodes[1].node.get_our_node_id(),
7469 short_channel_id: nodes[2].node.list_channels()[0].short_channel_id.unwrap(),
7470 fees: RoutingFees { base_msat: 1000, proportional_millionths: 0 },
7471 cltv_expiry_delta: MIN_CLTV_EXPIRY_DELTA,
7472 htlc_minimum_msat: None,
7473 htlc_maximum_msat: None,
7474 }])], 10_000, TEST_FINAL_CLTV, nodes[0].logger).unwrap();
7476 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
7477 check_added_monitors!(nodes[0], 1);
7478 let payment_event = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
7479 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
7480 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false, true);
7482 let htlc_fail_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
7483 assert!(htlc_fail_updates.update_add_htlcs.is_empty());
7484 assert_eq!(htlc_fail_updates.update_fail_htlcs.len(), 1);
7485 assert!(htlc_fail_updates.update_fail_malformed_htlcs.is_empty());
7486 assert!(htlc_fail_updates.update_fee.is_none());
7488 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_fail_updates.update_fail_htlcs[0]);
7489 commitment_signed_dance!(nodes[0], nodes[1], htlc_fail_updates.commitment_signed, true, true);
7490 expect_payment_failed_with_update!(nodes[0], our_payment_hash, false, nodes[2].node.list_channels()[0].short_channel_id.unwrap(), true);
7492 // Now disconnect nodes[1] from its peers and restart with accept_forwards_to_priv_channels set
7493 // to true. Sadly there is currently no way to change it at runtime.
7495 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
7496 nodes[2].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
7498 let nodes_1_serialized = nodes[1].node.encode();
7499 let mut monitor_a_serialized = test_utils::TestVecWriter(Vec::new());
7500 let mut monitor_b_serialized = test_utils::TestVecWriter(Vec::new());
7502 let mons = nodes[1].chain_monitor.chain_monitor.monitors.read().unwrap();
7503 let mut mon_iter = mons.iter();
7504 mon_iter.next().unwrap().1.write(&mut monitor_a_serialized).unwrap();
7505 mon_iter.next().unwrap().1.write(&mut monitor_b_serialized).unwrap();
7508 persister = test_utils::TestPersister::new();
7509 let keys_manager = &chanmon_cfgs[1].keys_manager;
7510 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);
7511 nodes[1].chain_monitor = &new_chain_monitor;
7513 let mut monitor_a_read = &monitor_a_serialized.0[..];
7514 let mut monitor_b_read = &monitor_b_serialized.0[..];
7515 let (_, mut monitor_a) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(&mut monitor_a_read, keys_manager).unwrap();
7516 let (_, mut monitor_b) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(&mut monitor_b_read, keys_manager).unwrap();
7517 assert!(monitor_a_read.is_empty());
7518 assert!(monitor_b_read.is_empty());
7520 no_announce_cfg.accept_forwards_to_priv_channels = true;
7522 let mut nodes_1_read = &nodes_1_serialized[..];
7523 let (_, nodes_1_deserialized_tmp) = {
7524 let mut channel_monitors = HashMap::new();
7525 channel_monitors.insert(monitor_a.get_funding_txo().0, &mut monitor_a);
7526 channel_monitors.insert(monitor_b.get_funding_txo().0, &mut monitor_b);
7527 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_1_read, ChannelManagerReadArgs {
7528 default_config: no_announce_cfg,
7530 fee_estimator: node_cfgs[1].fee_estimator,
7531 chain_monitor: nodes[1].chain_monitor,
7532 tx_broadcaster: nodes[1].tx_broadcaster.clone(),
7533 logger: nodes[1].logger,
7537 assert!(nodes_1_read.is_empty());
7538 nodes_1_deserialized = nodes_1_deserialized_tmp;
7540 assert!(nodes[1].chain_monitor.watch_channel(monitor_a.get_funding_txo().0, monitor_a).is_ok());
7541 assert!(nodes[1].chain_monitor.watch_channel(monitor_b.get_funding_txo().0, monitor_b).is_ok());
7542 check_added_monitors!(nodes[1], 2);
7543 nodes[1].node = &nodes_1_deserialized;
7545 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::known() });
7546 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7547 let as_reestablish = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
7548 let bs_reestablish = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
7549 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &as_reestablish);
7550 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &bs_reestablish);
7551 get_event_msg!(nodes[0], MessageSendEvent::SendChannelUpdate, nodes[1].node.get_our_node_id());
7552 get_event_msg!(nodes[1], MessageSendEvent::SendChannelUpdate, nodes[0].node.get_our_node_id());
7554 nodes[1].node.peer_connected(&nodes[2].node.get_our_node_id(), &msgs::Init { features: InitFeatures::known() });
7555 nodes[2].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7556 let bs_reestablish = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[2].node.get_our_node_id());
7557 let cs_reestablish = get_event_msg!(nodes[2], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
7558 nodes[2].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &bs_reestablish);
7559 nodes[1].node.handle_channel_reestablish(&nodes[2].node.get_our_node_id(), &cs_reestablish);
7560 get_event_msg!(nodes[1], MessageSendEvent::SendChannelUpdate, nodes[2].node.get_our_node_id());
7561 get_event_msg!(nodes[2], MessageSendEvent::SendChannelUpdate, nodes[1].node.get_our_node_id());
7563 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
7564 check_added_monitors!(nodes[0], 1);
7565 pass_along_route(&nodes[0], &[&[&nodes[1], &nodes[2]]], 10_000, our_payment_hash, our_payment_secret);
7566 claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], our_payment_preimage);
7570 fn test_bump_penalty_txn_on_revoked_commitment() {
7571 // In case of penalty txn with too low feerates for getting into mempools, RBF-bump them to be sure
7572 // we're able to claim outputs on revoked commitment transaction before timelocks expiration
7574 let chanmon_cfgs = create_chanmon_cfgs(2);
7575 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7576 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7577 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7579 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
7580 let logger = test_utils::TestLogger::new();
7582 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
7583 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
7584 let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[0].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 3000000, 30, &logger).unwrap();
7585 send_along_route(&nodes[1], route, &vec!(&nodes[0])[..], 3000000);
7587 let revoked_txn = get_local_commitment_txn!(nodes[0], chan.2);
7588 // Revoked commitment txn with 4 outputs : to_local, to_remote, 1 outgoing HTLC, 1 incoming HTLC
7589 assert_eq!(revoked_txn[0].output.len(), 4);
7590 assert_eq!(revoked_txn[0].input.len(), 1);
7591 assert_eq!(revoked_txn[0].input[0].previous_output.txid, chan.3.txid());
7592 let revoked_txid = revoked_txn[0].txid();
7594 let mut penalty_sum = 0;
7595 for outp in revoked_txn[0].output.iter() {
7596 if outp.script_pubkey.is_v0_p2wsh() {
7597 penalty_sum += outp.value;
7601 // Connect blocks to change height_timer range to see if we use right soonest_timelock
7602 let header_114 = connect_blocks(&nodes[1], 14);
7604 // Actually revoke tx by claiming a HTLC
7605 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
7606 let header = BlockHeader { version: 0x20000000, prev_blockhash: header_114, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7607 connect_block(&nodes[1], &Block { header, txdata: vec![revoked_txn[0].clone()] });
7608 check_added_monitors!(nodes[1], 1);
7610 // One or more justice tx should have been broadcast, check it
7614 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7615 assert_eq!(node_txn.len(), 2); // justice tx (broadcasted from ChannelMonitor) + local commitment tx
7616 assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
7617 assert_eq!(node_txn[0].output.len(), 1);
7618 check_spends!(node_txn[0], revoked_txn[0]);
7619 let fee_1 = penalty_sum - node_txn[0].output[0].value;
7620 feerate_1 = fee_1 * 1000 / node_txn[0].get_weight() as u64;
7621 penalty_1 = node_txn[0].txid();
7625 // After exhaustion of height timer, a new bumped justice tx should have been broadcast, check it
7626 connect_blocks(&nodes[1], 15);
7627 let mut penalty_2 = penalty_1;
7628 let mut feerate_2 = 0;
7630 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7631 assert_eq!(node_txn.len(), 1);
7632 if node_txn[0].input[0].previous_output.txid == revoked_txid {
7633 assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
7634 assert_eq!(node_txn[0].output.len(), 1);
7635 check_spends!(node_txn[0], revoked_txn[0]);
7636 penalty_2 = node_txn[0].txid();
7637 // Verify new bumped tx is different from last claiming transaction, we don't want spurrious rebroadcast
7638 assert_ne!(penalty_2, penalty_1);
7639 let fee_2 = penalty_sum - node_txn[0].output[0].value;
7640 feerate_2 = fee_2 * 1000 / node_txn[0].get_weight() as u64;
7641 // Verify 25% bump heuristic
7642 assert!(feerate_2 * 100 >= feerate_1 * 125);
7646 assert_ne!(feerate_2, 0);
7648 // After exhaustion of height timer for a 2nd time, a new bumped justice tx should have been broadcast, check it
7649 connect_blocks(&nodes[1], 1);
7651 let mut feerate_3 = 0;
7653 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7654 assert_eq!(node_txn.len(), 1);
7655 if node_txn[0].input[0].previous_output.txid == revoked_txid {
7656 assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
7657 assert_eq!(node_txn[0].output.len(), 1);
7658 check_spends!(node_txn[0], revoked_txn[0]);
7659 penalty_3 = node_txn[0].txid();
7660 // Verify new bumped tx is different from last claiming transaction, we don't want spurrious rebroadcast
7661 assert_ne!(penalty_3, penalty_2);
7662 let fee_3 = penalty_sum - node_txn[0].output[0].value;
7663 feerate_3 = fee_3 * 1000 / node_txn[0].get_weight() as u64;
7664 // Verify 25% bump heuristic
7665 assert!(feerate_3 * 100 >= feerate_2 * 125);
7669 assert_ne!(feerate_3, 0);
7671 nodes[1].node.get_and_clear_pending_events();
7672 nodes[1].node.get_and_clear_pending_msg_events();
7676 fn test_bump_penalty_txn_on_revoked_htlcs() {
7677 // In case of penalty txn with too low feerates for getting into mempools, RBF-bump them to sure
7678 // we're able to claim outputs on revoked HTLC transactions before timelocks expiration
7680 let mut chanmon_cfgs = create_chanmon_cfgs(2);
7681 chanmon_cfgs[1].keys_manager.disable_revocation_policy_check = true;
7682 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7683 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7684 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7686 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
7687 // Lock HTLC in both directions (using a slightly lower CLTV delay to provide timely RBF bumps)
7688 let route = get_route(&nodes[0].node.get_our_node_id(), &nodes[0].net_graph_msg_handler.network_graph,
7689 &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 3_000_000, 50, nodes[0].logger).unwrap();
7690 let payment_preimage = send_along_route(&nodes[0], route, &[&nodes[1]], 3_000_000).0;
7691 let route = get_route(&nodes[1].node.get_our_node_id(), &nodes[1].net_graph_msg_handler.network_graph,
7692 &nodes[0].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 3_000_000, 50, nodes[0].logger).unwrap();
7693 send_along_route(&nodes[1], route, &[&nodes[0]], 3_000_000);
7695 let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan.2);
7696 assert_eq!(revoked_local_txn[0].input.len(), 1);
7697 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
7699 // Revoke local commitment tx
7700 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
7702 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7703 // B will generate both revoked HTLC-timeout/HTLC-preimage txn from revoked commitment tx
7704 connect_block(&nodes[1], &Block { header, txdata: vec![revoked_local_txn[0].clone()] });
7705 check_closed_broadcast!(nodes[1], true);
7706 check_added_monitors!(nodes[1], 1);
7707 connect_blocks(&nodes[1], 49); // Confirm blocks until the HTLC expires (note CLTV was explicitly 50 above)
7709 let revoked_htlc_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7710 assert_eq!(revoked_htlc_txn.len(), 3);
7711 check_spends!(revoked_htlc_txn[1], chan.3);
7713 assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
7714 assert_eq!(revoked_htlc_txn[0].input.len(), 1);
7715 check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
7717 assert_eq!(revoked_htlc_txn[2].input.len(), 1);
7718 assert_eq!(revoked_htlc_txn[2].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
7719 assert_eq!(revoked_htlc_txn[2].output.len(), 1);
7720 check_spends!(revoked_htlc_txn[2], revoked_local_txn[0]);
7722 // Broadcast set of revoked txn on A
7723 let hash_128 = connect_blocks(&nodes[0], 40);
7724 let header_11 = BlockHeader { version: 0x20000000, prev_blockhash: hash_128, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7725 connect_block(&nodes[0], &Block { header: header_11, txdata: vec![revoked_local_txn[0].clone()] });
7726 let header_129 = BlockHeader { version: 0x20000000, prev_blockhash: header_11.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7727 connect_block(&nodes[0], &Block { header: header_129, txdata: vec![revoked_htlc_txn[0].clone(), revoked_htlc_txn[2].clone()] });
7728 expect_pending_htlcs_forwardable_ignore!(nodes[0]);
7733 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7734 assert_eq!(node_txn.len(), 5); // 3 penalty txn on revoked commitment tx + A commitment tx + 1 penalty tnx on revoked HTLC txn
7735 // Verify claim tx are spending revoked HTLC txn
7737 // node_txn 0-2 each spend a separate revoked output from revoked_local_txn[0]
7738 // Note that node_txn[0] and node_txn[1] are bogus - they double spend the revoked_htlc_txn
7739 // which are included in the same block (they are broadcasted because we scan the
7740 // transactions linearly and generate claims as we go, they likely should be removed in the
7742 assert_eq!(node_txn[0].input.len(), 1);
7743 check_spends!(node_txn[0], revoked_local_txn[0]);
7744 assert_eq!(node_txn[1].input.len(), 1);
7745 check_spends!(node_txn[1], revoked_local_txn[0]);
7746 assert_eq!(node_txn[2].input.len(), 1);
7747 check_spends!(node_txn[2], revoked_local_txn[0]);
7749 // Each of the three justice transactions claim a separate (single) output of the three
7750 // available, which we check here:
7751 assert_ne!(node_txn[0].input[0].previous_output, node_txn[1].input[0].previous_output);
7752 assert_ne!(node_txn[0].input[0].previous_output, node_txn[2].input[0].previous_output);
7753 assert_ne!(node_txn[1].input[0].previous_output, node_txn[2].input[0].previous_output);
7755 assert_eq!(node_txn[0].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
7756 assert_eq!(node_txn[1].input[0].previous_output, revoked_htlc_txn[2].input[0].previous_output);
7758 // node_txn[3] is the local commitment tx broadcast just because (and somewhat in case of
7759 // reorgs, though its not clear its ever worth broadcasting conflicting txn like this when
7760 // a remote commitment tx has already been confirmed).
7761 check_spends!(node_txn[3], chan.3);
7763 // node_txn[4] spends the revoked outputs from the revoked_htlc_txn (which only have one
7764 // output, checked above).
7765 assert_eq!(node_txn[4].input.len(), 2);
7766 assert_eq!(node_txn[4].output.len(), 1);
7767 check_spends!(node_txn[4], revoked_htlc_txn[0], revoked_htlc_txn[2]);
7769 first = node_txn[4].txid();
7770 // Store both feerates for later comparison
7771 let fee_1 = revoked_htlc_txn[0].output[0].value + revoked_htlc_txn[2].output[0].value - node_txn[4].output[0].value;
7772 feerate_1 = fee_1 * 1000 / node_txn[4].get_weight() as u64;
7773 penalty_txn = vec![node_txn[2].clone()];
7777 // Connect one more block to see if bumped penalty are issued for HTLC txn
7778 let header_130 = BlockHeader { version: 0x20000000, prev_blockhash: header_129.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7779 connect_block(&nodes[0], &Block { header: header_130, txdata: penalty_txn });
7780 let header_131 = BlockHeader { version: 0x20000000, prev_blockhash: header_130.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7781 connect_block(&nodes[0], &Block { header: header_131, txdata: Vec::new() });
7783 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7784 assert_eq!(node_txn.len(), 2); // 2 bumped penalty txn on revoked commitment tx
7786 check_spends!(node_txn[0], revoked_local_txn[0]);
7787 check_spends!(node_txn[1], revoked_local_txn[0]);
7788 // Note that these are both bogus - they spend outputs already claimed in block 129:
7789 if node_txn[0].input[0].previous_output == revoked_htlc_txn[0].input[0].previous_output {
7790 assert_eq!(node_txn[1].input[0].previous_output, revoked_htlc_txn[2].input[0].previous_output);
7792 assert_eq!(node_txn[0].input[0].previous_output, revoked_htlc_txn[2].input[0].previous_output);
7793 assert_eq!(node_txn[1].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
7799 // Few more blocks to confirm penalty txn
7800 connect_blocks(&nodes[0], 4);
7801 assert!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
7802 let header_144 = connect_blocks(&nodes[0], 9);
7804 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7805 assert_eq!(node_txn.len(), 1);
7807 assert_eq!(node_txn[0].input.len(), 2);
7808 check_spends!(node_txn[0], revoked_htlc_txn[0], revoked_htlc_txn[2]);
7809 // Verify bumped tx is different and 25% bump heuristic
7810 assert_ne!(first, node_txn[0].txid());
7811 let fee_2 = revoked_htlc_txn[0].output[0].value + revoked_htlc_txn[2].output[0].value - node_txn[0].output[0].value;
7812 let feerate_2 = fee_2 * 1000 / node_txn[0].get_weight() as u64;
7813 assert!(feerate_2 * 100 > feerate_1 * 125);
7814 let txn = vec![node_txn[0].clone()];
7818 // Broadcast claim txn and confirm blocks to avoid further bumps on this outputs
7819 let header_145 = BlockHeader { version: 0x20000000, prev_blockhash: header_144, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7820 connect_block(&nodes[0], &Block { header: header_145, txdata: node_txn });
7821 connect_blocks(&nodes[0], 20);
7823 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7824 // We verify than no new transaction has been broadcast because previously
7825 // we were buggy on this exact behavior by not tracking for monitoring remote HTLC outputs (see #411)
7826 // which means we wouldn't see a spend of them by a justice tx and bumped justice tx
7827 // were generated forever instead of safe cleaning after confirmation and ANTI_REORG_SAFE_DELAY blocks.
7828 // Enforce spending of revoked htlc output by claiming transaction remove request as expected and dry
7829 // up bumped justice generation.
7830 assert_eq!(node_txn.len(), 0);
7833 check_closed_broadcast!(nodes[0], true);
7834 check_added_monitors!(nodes[0], 1);
7838 fn test_bump_penalty_txn_on_remote_commitment() {
7839 // In case of claim txn with too low feerates for getting into mempools, RBF-bump them to be sure
7840 // we're able to claim outputs on remote commitment transaction before timelocks expiration
7843 // Provide preimage for one
7844 // Check aggregation
7846 let chanmon_cfgs = create_chanmon_cfgs(2);
7847 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7848 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7849 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7851 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
7852 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
7853 route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000).0;
7855 // Remote commitment txn with 4 outputs : to_local, to_remote, 1 outgoing HTLC, 1 incoming HTLC
7856 let remote_txn = get_local_commitment_txn!(nodes[0], chan.2);
7857 assert_eq!(remote_txn[0].output.len(), 4);
7858 assert_eq!(remote_txn[0].input.len(), 1);
7859 assert_eq!(remote_txn[0].input[0].previous_output.txid, chan.3.txid());
7861 // Claim a HTLC without revocation (provide B monitor with preimage)
7862 nodes[1].node.claim_funds(payment_preimage);
7863 mine_transaction(&nodes[1], &remote_txn[0]);
7864 check_added_monitors!(nodes[1], 2);
7865 connect_blocks(&nodes[1], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
7867 // One or more claim tx should have been broadcast, check it
7871 let feerate_timeout;
7872 let feerate_preimage;
7874 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7875 // 9 transactions including:
7876 // 1*2 ChannelManager local broadcasts of commitment + HTLC-Success
7877 // 1*3 ChannelManager local broadcasts of commitment + HTLC-Success + HTLC-Timeout
7878 // 2 * HTLC-Success (one RBF bump we'll check later)
7880 assert_eq!(node_txn.len(), 8);
7881 assert_eq!(node_txn[0].input.len(), 1);
7882 assert_eq!(node_txn[6].input.len(), 1);
7883 check_spends!(node_txn[0], remote_txn[0]);
7884 check_spends!(node_txn[6], remote_txn[0]);
7885 assert_eq!(node_txn[0].input[0].previous_output, node_txn[3].input[0].previous_output);
7886 preimage_bump = node_txn[3].clone();
7888 check_spends!(node_txn[1], chan.3);
7889 check_spends!(node_txn[2], node_txn[1]);
7890 assert_eq!(node_txn[1], node_txn[4]);
7891 assert_eq!(node_txn[2], node_txn[5]);
7893 timeout = node_txn[6].txid();
7894 let index = node_txn[6].input[0].previous_output.vout;
7895 let fee = remote_txn[0].output[index as usize].value - node_txn[6].output[0].value;
7896 feerate_timeout = fee * 1000 / node_txn[6].get_weight() as u64;
7898 preimage = node_txn[0].txid();
7899 let index = node_txn[0].input[0].previous_output.vout;
7900 let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
7901 feerate_preimage = fee * 1000 / node_txn[0].get_weight() as u64;
7905 assert_ne!(feerate_timeout, 0);
7906 assert_ne!(feerate_preimage, 0);
7908 // After exhaustion of height timer, new bumped claim txn should have been broadcast, check it
7909 connect_blocks(&nodes[1], 15);
7911 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7912 assert_eq!(node_txn.len(), 1);
7913 assert_eq!(node_txn[0].input.len(), 1);
7914 assert_eq!(preimage_bump.input.len(), 1);
7915 check_spends!(node_txn[0], remote_txn[0]);
7916 check_spends!(preimage_bump, remote_txn[0]);
7918 let index = preimage_bump.input[0].previous_output.vout;
7919 let fee = remote_txn[0].output[index as usize].value - preimage_bump.output[0].value;
7920 let new_feerate = fee * 1000 / preimage_bump.get_weight() as u64;
7921 assert!(new_feerate * 100 > feerate_timeout * 125);
7922 assert_ne!(timeout, preimage_bump.txid());
7924 let index = node_txn[0].input[0].previous_output.vout;
7925 let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
7926 let new_feerate = fee * 1000 / node_txn[0].get_weight() as u64;
7927 assert!(new_feerate * 100 > feerate_preimage * 125);
7928 assert_ne!(preimage, node_txn[0].txid());
7933 nodes[1].node.get_and_clear_pending_events();
7934 nodes[1].node.get_and_clear_pending_msg_events();
7938 fn test_counterparty_raa_skip_no_crash() {
7939 // Previously, if our counterparty sent two RAAs in a row without us having provided a
7940 // commitment transaction, we would have happily carried on and provided them the next
7941 // commitment transaction based on one RAA forward. This would probably eventually have led to
7942 // channel closure, but it would not have resulted in funds loss. Still, our
7943 // EnforcingSigner would have panicked as it doesn't like jumps into the future. Here, we
7944 // check simply that the channel is closed in response to such an RAA, but don't check whether
7945 // we decide to punish our counterparty for revoking their funds (as we don't currently
7947 let chanmon_cfgs = create_chanmon_cfgs(2);
7948 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7949 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7950 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7951 let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).2;
7953 let mut guard = nodes[0].node.channel_state.lock().unwrap();
7954 let keys = guard.by_id.get_mut(&channel_id).unwrap().get_signer();
7956 const INITIAL_COMMITMENT_NUMBER: u64 = (1 << 48) - 1;
7958 // Make signer believe we got a counterparty signature, so that it allows the revocation
7959 keys.get_enforcement_state().last_holder_commitment -= 1;
7960 let per_commitment_secret = keys.release_commitment_secret(INITIAL_COMMITMENT_NUMBER);
7962 // Must revoke without gaps
7963 keys.get_enforcement_state().last_holder_commitment -= 1;
7964 keys.release_commitment_secret(INITIAL_COMMITMENT_NUMBER - 1);
7966 keys.get_enforcement_state().last_holder_commitment -= 1;
7967 let next_per_commitment_point = PublicKey::from_secret_key(&Secp256k1::new(),
7968 &SecretKey::from_slice(&keys.release_commitment_secret(INITIAL_COMMITMENT_NUMBER - 2)).unwrap());
7970 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(),
7971 &msgs::RevokeAndACK { channel_id, per_commitment_secret, next_per_commitment_point });
7972 assert_eq!(check_closed_broadcast!(nodes[1], true).unwrap().data, "Received an unexpected revoke_and_ack");
7973 check_added_monitors!(nodes[1], 1);
7977 fn test_bump_txn_sanitize_tracking_maps() {
7978 // Sanitizing pendning_claim_request and claimable_outpoints used to be buggy,
7979 // verify we clean then right after expiration of ANTI_REORG_DELAY.
7981 let chanmon_cfgs = create_chanmon_cfgs(2);
7982 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7983 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7984 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7986 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
7987 // Lock HTLC in both directions
7988 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000).0;
7989 route_payment(&nodes[1], &vec!(&nodes[0])[..], 9_000_000).0;
7991 let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan.2);
7992 assert_eq!(revoked_local_txn[0].input.len(), 1);
7993 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
7995 // Revoke local commitment tx
7996 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
7998 // Broadcast set of revoked txn on A
7999 connect_blocks(&nodes[0], TEST_FINAL_CLTV + 2 - CHAN_CONFIRM_DEPTH);
8000 expect_pending_htlcs_forwardable_ignore!(nodes[0]);
8001 assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 0);
8003 mine_transaction(&nodes[0], &revoked_local_txn[0]);
8004 check_closed_broadcast!(nodes[0], true);
8005 check_added_monitors!(nodes[0], 1);
8007 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8008 assert_eq!(node_txn.len(), 4); //ChannelMonitor: justice txn * 3, ChannelManager: local commitment tx
8009 check_spends!(node_txn[0], revoked_local_txn[0]);
8010 check_spends!(node_txn[1], revoked_local_txn[0]);
8011 check_spends!(node_txn[2], revoked_local_txn[0]);
8012 let penalty_txn = vec![node_txn[0].clone(), node_txn[1].clone(), node_txn[2].clone()];
8016 let header_130 = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8017 connect_block(&nodes[0], &Block { header: header_130, txdata: penalty_txn });
8018 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
8020 let monitors = nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap();
8021 if let Some(monitor) = monitors.get(&OutPoint { txid: chan.3.txid(), index: 0 }) {
8022 assert!(monitor.inner.lock().unwrap().onchain_tx_handler.pending_claim_requests.is_empty());
8023 assert!(monitor.inner.lock().unwrap().onchain_tx_handler.claimable_outpoints.is_empty());
8029 fn test_override_channel_config() {
8030 let chanmon_cfgs = create_chanmon_cfgs(2);
8031 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8032 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8033 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8035 // Node0 initiates a channel to node1 using the override config.
8036 let mut override_config = UserConfig::default();
8037 override_config.own_channel_config.our_to_self_delay = 200;
8039 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 16_000_000, 12_000_000, 42, Some(override_config)).unwrap();
8041 // Assert the channel created by node0 is using the override config.
8042 let res = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8043 assert_eq!(res.channel_flags, 0);
8044 assert_eq!(res.to_self_delay, 200);
8048 fn test_override_0msat_htlc_minimum() {
8049 let mut zero_config = UserConfig::default();
8050 zero_config.own_channel_config.our_htlc_minimum_msat = 0;
8051 let chanmon_cfgs = create_chanmon_cfgs(2);
8052 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8053 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, Some(zero_config.clone())]);
8054 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8056 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 16_000_000, 12_000_000, 42, Some(zero_config)).unwrap();
8057 let res = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8058 assert_eq!(res.htlc_minimum_msat, 1);
8060 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &res);
8061 let res = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
8062 assert_eq!(res.htlc_minimum_msat, 1);
8066 fn test_simple_mpp() {
8067 // Simple test of sending a multi-path payment.
8068 let chanmon_cfgs = create_chanmon_cfgs(4);
8069 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
8070 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
8071 let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
8073 let chan_1_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8074 let chan_2_id = create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8075 let chan_3_id = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8076 let chan_4_id = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8077 let logger = test_utils::TestLogger::new();
8079 let (payment_preimage, payment_hash, payment_secret) = get_payment_preimage_hash!(&nodes[3]);
8080 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
8081 let mut route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[3].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
8082 let path = route.paths[0].clone();
8083 route.paths.push(path);
8084 route.paths[0][0].pubkey = nodes[1].node.get_our_node_id();
8085 route.paths[0][0].short_channel_id = chan_1_id;
8086 route.paths[0][1].short_channel_id = chan_3_id;
8087 route.paths[1][0].pubkey = nodes[2].node.get_our_node_id();
8088 route.paths[1][0].short_channel_id = chan_2_id;
8089 route.paths[1][1].short_channel_id = chan_4_id;
8090 send_along_route_with_secret(&nodes[0], route, &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], 200_000, payment_hash, payment_secret);
8091 claim_payment_along_route(&nodes[0], &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], false, payment_preimage);
8095 fn test_preimage_storage() {
8096 // Simple test of payment preimage storage allowing no client-side storage to claim payments
8097 let chanmon_cfgs = create_chanmon_cfgs(2);
8098 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8099 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8100 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8102 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8105 let (payment_hash, payment_secret) = nodes[1].node.create_inbound_payment(Some(100_000), 7200, 42);
8107 let logger = test_utils::TestLogger::new();
8108 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
8109 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100_000, TEST_FINAL_CLTV, &logger).unwrap();
8110 nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
8111 check_added_monitors!(nodes[0], 1);
8112 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
8113 let mut payment_event = SendEvent::from_event(events.pop().unwrap());
8114 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
8115 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
8117 // Note that after leaving the above scope we have no knowledge of any arguments or return
8118 // values from previous calls.
8119 expect_pending_htlcs_forwardable!(nodes[1]);
8120 let events = nodes[1].node.get_and_clear_pending_events();
8121 assert_eq!(events.len(), 1);
8123 Event::PaymentReceived { ref purpose, .. } => {
8125 PaymentPurpose::InvoicePayment { payment_preimage, user_payment_id, .. } => {
8126 assert_eq!(*user_payment_id, 42);
8127 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage.unwrap());
8129 _ => panic!("expected PaymentPurpose::InvoicePayment")
8132 _ => panic!("Unexpected event"),
8137 fn test_secret_timeout() {
8138 // Simple test of payment secret storage time outs
8139 let chanmon_cfgs = create_chanmon_cfgs(2);
8140 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8141 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8142 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8144 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8146 let (payment_hash, payment_secret_1) = nodes[1].node.create_inbound_payment(Some(100_000), 2, 0);
8148 // We should fail to register the same payment hash twice, at least until we've connected a
8149 // block with time 7200 + CHAN_CONFIRM_DEPTH + 1.
8150 if let Err(APIError::APIMisuseError { err }) = nodes[1].node.create_inbound_payment_for_hash(payment_hash, Some(100_000), 2, 0) {
8151 assert_eq!(err, "Duplicate payment hash");
8152 } else { panic!(); }
8154 let node_1_blocks = nodes[1].blocks.lock().unwrap();
8156 header: BlockHeader {
8158 prev_blockhash: node_1_blocks.last().unwrap().0.block_hash(),
8159 merkle_root: Default::default(),
8160 time: node_1_blocks.len() as u32 + 7200, bits: 42, nonce: 42 },
8164 connect_block(&nodes[1], &block);
8165 if let Err(APIError::APIMisuseError { err }) = nodes[1].node.create_inbound_payment_for_hash(payment_hash, Some(100_000), 2, 0) {
8166 assert_eq!(err, "Duplicate payment hash");
8167 } else { panic!(); }
8169 // If we then connect the second block, we should be able to register the same payment hash
8170 // again with a different user_payment_id (this time getting a new payment secret).
8171 block.header.prev_blockhash = block.header.block_hash();
8172 block.header.time += 1;
8173 connect_block(&nodes[1], &block);
8174 let our_payment_secret = nodes[1].node.create_inbound_payment_for_hash(payment_hash, Some(100_000), 2, 42).unwrap();
8175 assert_ne!(payment_secret_1, our_payment_secret);
8178 let logger = test_utils::TestLogger::new();
8179 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
8180 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100_000, TEST_FINAL_CLTV, &logger).unwrap();
8181 nodes[0].node.send_payment(&route, payment_hash, &Some(our_payment_secret)).unwrap();
8182 check_added_monitors!(nodes[0], 1);
8183 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
8184 let mut payment_event = SendEvent::from_event(events.pop().unwrap());
8185 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
8186 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
8188 // Note that after leaving the above scope we have no knowledge of any arguments or return
8189 // values from previous calls.
8190 expect_pending_htlcs_forwardable!(nodes[1]);
8191 let events = nodes[1].node.get_and_clear_pending_events();
8192 assert_eq!(events.len(), 1);
8194 Event::PaymentReceived { purpose: PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, user_payment_id }, .. } => {
8195 assert!(payment_preimage.is_none());
8196 assert_eq!(user_payment_id, 42);
8197 assert_eq!(payment_secret, our_payment_secret);
8198 // We don't actually have the payment preimage with which to claim this payment!
8200 _ => panic!("Unexpected event"),
8205 fn test_bad_secret_hash() {
8206 // Simple test of unregistered payment hash/invalid payment secret handling
8207 let chanmon_cfgs = create_chanmon_cfgs(2);
8208 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8209 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8210 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8212 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8214 let random_payment_hash = PaymentHash([42; 32]);
8215 let random_payment_secret = PaymentSecret([43; 32]);
8216 let (our_payment_hash, our_payment_secret) = nodes[1].node.create_inbound_payment(Some(100_000), 2, 0);
8218 let logger = test_utils::TestLogger::new();
8219 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
8220 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100_000, TEST_FINAL_CLTV, &logger).unwrap();
8222 // All the below cases should end up being handled exactly identically, so we macro the
8223 // resulting events.
8224 macro_rules! handle_unknown_invalid_payment_data {
8226 check_added_monitors!(nodes[0], 1);
8227 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
8228 let payment_event = SendEvent::from_event(events.pop().unwrap());
8229 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
8230 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
8232 // We have to forward pending HTLCs once to process the receipt of the HTLC and then
8233 // again to process the pending backwards-failure of the HTLC
8234 expect_pending_htlcs_forwardable!(nodes[1]);
8235 expect_pending_htlcs_forwardable!(nodes[1]);
8236 check_added_monitors!(nodes[1], 1);
8238 // We should fail the payment back
8239 let mut events = nodes[1].node.get_and_clear_pending_msg_events();
8240 match events.pop().unwrap() {
8241 MessageSendEvent::UpdateHTLCs { node_id: _, updates: msgs::CommitmentUpdate { update_fail_htlcs, commitment_signed, .. } } => {
8242 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
8243 commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false);
8245 _ => panic!("Unexpected event"),
8250 let expected_error_code = 0x4000|15; // incorrect_or_unknown_payment_details
8251 // Error data is the HTLC value (100,000) and current block height
8252 let expected_error_data = [0, 0, 0, 0, 0, 1, 0x86, 0xa0, 0, 0, 0, CHAN_CONFIRM_DEPTH as u8];
8254 // Send a payment with the right payment hash but the wrong payment secret
8255 nodes[0].node.send_payment(&route, our_payment_hash, &Some(random_payment_secret)).unwrap();
8256 handle_unknown_invalid_payment_data!();
8257 expect_payment_failed!(nodes[0], our_payment_hash, true, expected_error_code, expected_error_data);
8259 // Send a payment with a random payment hash, but the right payment secret
8260 nodes[0].node.send_payment(&route, random_payment_hash, &Some(our_payment_secret)).unwrap();
8261 handle_unknown_invalid_payment_data!();
8262 expect_payment_failed!(nodes[0], random_payment_hash, true, expected_error_code, expected_error_data);
8264 // Send a payment with a random payment hash and random payment secret
8265 nodes[0].node.send_payment(&route, random_payment_hash, &Some(random_payment_secret)).unwrap();
8266 handle_unknown_invalid_payment_data!();
8267 expect_payment_failed!(nodes[0], random_payment_hash, true, expected_error_code, expected_error_data);
8271 fn test_update_err_monitor_lockdown() {
8272 // Our monitor will lock update of local commitment transaction if a broadcastion condition
8273 // has been fulfilled (either force-close from Channel or block height requiring a HTLC-
8274 // timeout). Trying to update monitor after lockdown should return a ChannelMonitorUpdateErr.
8276 // This scenario may happen in a watchtower setup, where watchtower process a block height
8277 // triggering a timeout while a slow-block-processing ChannelManager receives a local signed
8278 // commitment at same time.
8280 let chanmon_cfgs = create_chanmon_cfgs(2);
8281 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8282 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8283 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8285 // Create some initial channel
8286 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
8287 let outpoint = OutPoint { txid: chan_1.3.txid(), index: 0 };
8289 // Rebalance the network to generate htlc in the two directions
8290 send_payment(&nodes[0], &vec!(&nodes[1])[..], 10_000_000);
8292 // Route a HTLC from node 0 to node 1 (but don't settle)
8293 let preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000).0;
8295 // Copy ChainMonitor to simulate a watchtower and update block height of node 0 until its ChannelMonitor timeout HTLC onchain
8296 let chain_source = test_utils::TestChainSource::new(Network::Testnet);
8297 let logger = test_utils::TestLogger::with_id(format!("node {}", 0));
8298 let persister = test_utils::TestPersister::new();
8300 let monitors = nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap();
8301 let monitor = monitors.get(&outpoint).unwrap();
8302 let mut w = test_utils::TestVecWriter(Vec::new());
8303 monitor.write(&mut w).unwrap();
8304 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingSigner>)>::read(
8305 &mut io::Cursor::new(&w.0), &test_utils::OnlyReadsKeysInterface {}).unwrap().1;
8306 assert!(new_monitor == *monitor);
8307 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);
8308 assert!(watchtower.watch_channel(outpoint, new_monitor).is_ok());
8311 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8312 // Make the tx_broadcaster aware of enough blocks that it doesn't think we're violating
8313 // transaction lock time requirements here.
8314 chanmon_cfgs[0].tx_broadcaster.blocks.lock().unwrap().resize(200, (header, 0));
8315 watchtower.chain_monitor.block_connected(&Block { header, txdata: vec![] }, 200);
8317 // Try to update ChannelMonitor
8318 assert!(nodes[1].node.claim_funds(preimage));
8319 check_added_monitors!(nodes[1], 1);
8320 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
8321 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
8322 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
8323 if let Some(ref mut channel) = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan_1.2) {
8324 if let Ok((_, _, update)) = channel.commitment_signed(&updates.commitment_signed, &node_cfgs[0].logger) {
8325 if let Err(_) = watchtower.chain_monitor.update_channel(outpoint, update.clone()) {} else { assert!(false); }
8326 if let Ok(_) = nodes[0].chain_monitor.update_channel(outpoint, update) {} else { assert!(false); }
8327 } else { assert!(false); }
8328 } else { assert!(false); };
8329 // Our local monitor is in-sync and hasn't processed yet timeout
8330 check_added_monitors!(nodes[0], 1);
8331 let events = nodes[0].node.get_and_clear_pending_events();
8332 assert_eq!(events.len(), 1);
8336 fn test_concurrent_monitor_claim() {
8337 // Watchtower A receives block, broadcasts state N, then channel receives new state N+1,
8338 // sending it to both watchtowers, Bob accepts N+1, then receives block and broadcasts
8339 // the latest state N+1, Alice rejects state N+1, but Bob has already broadcast it,
8340 // state N+1 confirms. Alice claims output from state N+1.
8342 let chanmon_cfgs = create_chanmon_cfgs(2);
8343 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8344 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8345 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8347 // Create some initial channel
8348 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
8349 let outpoint = OutPoint { txid: chan_1.3.txid(), index: 0 };
8351 // Rebalance the network to generate htlc in the two directions
8352 send_payment(&nodes[0], &vec!(&nodes[1])[..], 10_000_000);
8354 // Route a HTLC from node 0 to node 1 (but don't settle)
8355 route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000).0;
8357 // Copy ChainMonitor to simulate watchtower Alice and update block height her ChannelMonitor timeout HTLC onchain
8358 let chain_source = test_utils::TestChainSource::new(Network::Testnet);
8359 let logger = test_utils::TestLogger::with_id(format!("node {}", "Alice"));
8360 let persister = test_utils::TestPersister::new();
8361 let watchtower_alice = {
8362 let monitors = nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap();
8363 let monitor = monitors.get(&outpoint).unwrap();
8364 let mut w = test_utils::TestVecWriter(Vec::new());
8365 monitor.write(&mut w).unwrap();
8366 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingSigner>)>::read(
8367 &mut io::Cursor::new(&w.0), &test_utils::OnlyReadsKeysInterface {}).unwrap().1;
8368 assert!(new_monitor == *monitor);
8369 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);
8370 assert!(watchtower.watch_channel(outpoint, new_monitor).is_ok());
8373 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8374 // Make the tx_broadcaster aware of enough blocks that it doesn't think we're violating
8375 // transaction lock time requirements here.
8376 chanmon_cfgs[0].tx_broadcaster.blocks.lock().unwrap().resize((CHAN_CONFIRM_DEPTH + 1 + TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS) as usize, (header, 0));
8377 watchtower_alice.chain_monitor.block_connected(&Block { header, txdata: vec![] }, CHAN_CONFIRM_DEPTH + 1 + TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS);
8379 // Watchtower Alice should have broadcast a commitment/HTLC-timeout
8381 let mut txn = chanmon_cfgs[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8382 assert_eq!(txn.len(), 2);
8386 // Copy ChainMonitor to simulate watchtower Bob and make it receive a commitment update first.
8387 let chain_source = test_utils::TestChainSource::new(Network::Testnet);
8388 let logger = test_utils::TestLogger::with_id(format!("node {}", "Bob"));
8389 let persister = test_utils::TestPersister::new();
8390 let watchtower_bob = {
8391 let monitors = nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap();
8392 let monitor = monitors.get(&outpoint).unwrap();
8393 let mut w = test_utils::TestVecWriter(Vec::new());
8394 monitor.write(&mut w).unwrap();
8395 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingSigner>)>::read(
8396 &mut io::Cursor::new(&w.0), &test_utils::OnlyReadsKeysInterface {}).unwrap().1;
8397 assert!(new_monitor == *monitor);
8398 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);
8399 assert!(watchtower.watch_channel(outpoint, new_monitor).is_ok());
8402 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8403 watchtower_bob.chain_monitor.block_connected(&Block { header, txdata: vec![] }, CHAN_CONFIRM_DEPTH + TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS);
8405 // Route another payment to generate another update with still previous HTLC pending
8406 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[0]);
8408 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
8409 let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[0].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 3000000 , TEST_FINAL_CLTV, &logger).unwrap();
8410 nodes[1].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
8412 check_added_monitors!(nodes[1], 1);
8414 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
8415 assert_eq!(updates.update_add_htlcs.len(), 1);
8416 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &updates.update_add_htlcs[0]);
8417 if let Some(ref mut channel) = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan_1.2) {
8418 if let Ok((_, _, update)) = channel.commitment_signed(&updates.commitment_signed, &node_cfgs[0].logger) {
8419 // Watchtower Alice should already have seen the block and reject the update
8420 if let Err(_) = watchtower_alice.chain_monitor.update_channel(outpoint, update.clone()) {} else { assert!(false); }
8421 if let Ok(_) = watchtower_bob.chain_monitor.update_channel(outpoint, update.clone()) {} else { assert!(false); }
8422 if let Ok(_) = nodes[0].chain_monitor.update_channel(outpoint, update) {} else { assert!(false); }
8423 } else { assert!(false); }
8424 } else { assert!(false); };
8425 // Our local monitor is in-sync and hasn't processed yet timeout
8426 check_added_monitors!(nodes[0], 1);
8428 //// Provide one more block to watchtower Bob, expect broadcast of commitment and HTLC-Timeout
8429 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8430 watchtower_bob.chain_monitor.block_connected(&Block { header, txdata: vec![] }, CHAN_CONFIRM_DEPTH + 1 + TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS);
8432 // Watchtower Bob should have broadcast a commitment/HTLC-timeout
8435 let mut txn = chanmon_cfgs[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8436 assert_eq!(txn.len(), 2);
8437 bob_state_y = txn[0].clone();
8441 // We confirm Bob's state Y on Alice, she should broadcast a HTLC-timeout
8442 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8443 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);
8445 let htlc_txn = chanmon_cfgs[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8446 // We broadcast twice the transaction, once due to the HTLC-timeout, once due
8447 // the onchain detection of the HTLC output
8448 assert_eq!(htlc_txn.len(), 2);
8449 check_spends!(htlc_txn[0], bob_state_y);
8450 check_spends!(htlc_txn[1], bob_state_y);
8455 fn test_pre_lockin_no_chan_closed_update() {
8456 // Test that if a peer closes a channel in response to a funding_created message we don't
8457 // generate a channel update (as the channel cannot appear on chain without a funding_signed
8460 // Doing so would imply a channel monitor update before the initial channel monitor
8461 // registration, violating our API guarantees.
8463 // Previously, full_stack_target managed to hit this case by opening then closing a channel,
8464 // then opening a second channel with the same funding output as the first (which is not
8465 // rejected because the first channel does not exist in the ChannelManager) and closing it
8466 // before receiving funding_signed.
8467 let chanmon_cfgs = create_chanmon_cfgs(2);
8468 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8469 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8470 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8472 // Create an initial channel
8473 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
8474 let mut open_chan_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8475 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_msg);
8476 let accept_chan_msg = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
8477 nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &accept_chan_msg);
8479 // Move the first channel through the funding flow...
8480 let (temporary_channel_id, tx, _) = create_funding_transaction(&nodes[0], 100000, 42);
8482 nodes[0].node.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
8483 check_added_monitors!(nodes[0], 0);
8485 let funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
8486 let channel_id = ::chain::transaction::OutPoint { txid: funding_created_msg.funding_txid, index: funding_created_msg.funding_output_index }.to_channel_id();
8487 nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msgs::ErrorMessage { channel_id, data: "Hi".to_owned() });
8488 assert!(nodes[0].chain_monitor.added_monitors.lock().unwrap().is_empty());
8492 fn test_htlc_no_detection() {
8493 // This test is a mutation to underscore the detection logic bug we had
8494 // before #653. HTLC value routed is above the remaining balance, thus
8495 // inverting HTLC and `to_remote` output. HTLC will come second and
8496 // it wouldn't be seen by pre-#653 detection as we were enumerate()'ing
8497 // on a watched outputs vector (Vec<TxOut>) thus implicitly relying on
8498 // outputs order detection for correct spending children filtring.
8500 let chanmon_cfgs = create_chanmon_cfgs(2);
8501 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8502 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8503 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8505 // Create some initial channels
8506 let chan_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
8508 send_payment(&nodes[0], &vec!(&nodes[1])[..], 1_000_000);
8509 let (_, our_payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 2_000_000);
8510 let local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
8511 assert_eq!(local_txn[0].input.len(), 1);
8512 assert_eq!(local_txn[0].output.len(), 3);
8513 check_spends!(local_txn[0], chan_1.3);
8515 // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
8516 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8517 connect_block(&nodes[0], &Block { header, txdata: vec![local_txn[0].clone()] });
8518 // We deliberately connect the local tx twice as this should provoke a failure calling
8519 // this test before #653 fix.
8520 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);
8521 check_closed_broadcast!(nodes[0], true);
8522 check_added_monitors!(nodes[0], 1);
8523 connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1);
8525 let htlc_timeout = {
8526 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8527 assert_eq!(node_txn[1].input.len(), 1);
8528 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
8529 check_spends!(node_txn[1], local_txn[0]);
8533 let header_201 = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8534 connect_block(&nodes[0], &Block { header: header_201, txdata: vec![htlc_timeout.clone()] });
8535 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
8536 expect_payment_failed!(nodes[0], our_payment_hash, true);
8539 fn do_test_onchain_htlc_settlement_after_close(broadcast_alice: bool, go_onchain_before_fulfill: bool) {
8540 // If we route an HTLC, then learn the HTLC's preimage after the upstream channel has been
8541 // force-closed, we must claim that HTLC on-chain. (Given an HTLC forwarded from Alice --> Bob -->
8542 // Carol, Alice would be the upstream node, and Carol the downstream.)
8544 // Steps of the test:
8545 // 1) Alice sends a HTLC to Carol through Bob.
8546 // 2) Carol doesn't settle the HTLC.
8547 // 3) If broadcast_alice is true, Alice force-closes her channel with Bob. Else Bob force closes.
8548 // Steps 4 and 5 may be reordered depending on go_onchain_before_fulfill.
8549 // 4) Bob sees the Alice's commitment on his chain or vice versa. An offered output is present
8550 // but can't be claimed as Bob doesn't have yet knowledge of the preimage.
8551 // 5) Carol release the preimage to Bob off-chain.
8552 // 6) Bob claims the offered output on the broadcasted commitment.
8553 let chanmon_cfgs = create_chanmon_cfgs(3);
8554 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
8555 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
8556 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
8558 // Create some initial channels
8559 let chan_ab = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
8560 create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 100000, 10001, InitFeatures::known(), InitFeatures::known());
8562 // Steps (1) and (2):
8563 // Send an HTLC Alice --> Bob --> Carol, but Carol doesn't settle the HTLC back.
8564 let (payment_preimage, _payment_hash, _payment_secret) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3_000_000);
8566 // Check that Alice's commitment transaction now contains an output for this HTLC.
8567 let alice_txn = get_local_commitment_txn!(nodes[0], chan_ab.2);
8568 check_spends!(alice_txn[0], chan_ab.3);
8569 assert_eq!(alice_txn[0].output.len(), 2);
8570 check_spends!(alice_txn[1], alice_txn[0]); // 2nd transaction is a non-final HTLC-timeout
8571 assert_eq!(alice_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
8572 assert_eq!(alice_txn.len(), 2);
8574 // Steps (3) and (4):
8575 // If `go_onchain_before_fufill`, broadcast the relevant commitment transaction and check that Bob
8576 // responds by (1) broadcasting a channel update and (2) adding a new ChannelMonitor.
8577 let mut force_closing_node = 0; // Alice force-closes
8578 if !broadcast_alice { force_closing_node = 1; } // Bob force-closes
8579 nodes[force_closing_node].node.force_close_channel(&chan_ab.2).unwrap();
8580 check_closed_broadcast!(nodes[force_closing_node], true);
8581 check_added_monitors!(nodes[force_closing_node], 1);
8582 if go_onchain_before_fulfill {
8583 let txn_to_broadcast = match broadcast_alice {
8584 true => alice_txn.clone(),
8585 false => get_local_commitment_txn!(nodes[1], chan_ab.2)
8587 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
8588 connect_block(&nodes[1], &Block { header, txdata: vec![txn_to_broadcast[0].clone()]});
8589 let mut bob_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8590 if broadcast_alice {
8591 check_closed_broadcast!(nodes[1], true);
8592 check_added_monitors!(nodes[1], 1);
8594 assert_eq!(bob_txn.len(), 1);
8595 check_spends!(bob_txn[0], chan_ab.3);
8599 // Carol then claims the funds and sends an update_fulfill message to Bob, and they go through the
8600 // process of removing the HTLC from their commitment transactions.
8601 assert!(nodes[2].node.claim_funds(payment_preimage));
8602 check_added_monitors!(nodes[2], 1);
8603 let carol_updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
8604 assert!(carol_updates.update_add_htlcs.is_empty());
8605 assert!(carol_updates.update_fail_htlcs.is_empty());
8606 assert!(carol_updates.update_fail_malformed_htlcs.is_empty());
8607 assert!(carol_updates.update_fee.is_none());
8608 assert_eq!(carol_updates.update_fulfill_htlcs.len(), 1);
8610 nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &carol_updates.update_fulfill_htlcs[0]);
8611 expect_payment_forwarded!(nodes[1], if go_onchain_before_fulfill || force_closing_node == 1 { None } else { Some(1000) }, false);
8612 // If Alice broadcasted but Bob doesn't know yet, here he prepares to tell her about the preimage.
8613 if !go_onchain_before_fulfill && broadcast_alice {
8614 let events = nodes[1].node.get_and_clear_pending_msg_events();
8615 assert_eq!(events.len(), 1);
8617 MessageSendEvent::UpdateHTLCs { ref node_id, .. } => {
8618 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
8620 _ => panic!("Unexpected event"),
8623 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &carol_updates.commitment_signed);
8624 // One monitor update for the preimage to update the Bob<->Alice channel, one monitor update
8625 // Carol<->Bob's updated commitment transaction info.
8626 check_added_monitors!(nodes[1], 2);
8628 let events = nodes[1].node.get_and_clear_pending_msg_events();
8629 assert_eq!(events.len(), 2);
8630 let bob_revocation = match events[0] {
8631 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
8632 assert_eq!(*node_id, nodes[2].node.get_our_node_id());
8635 _ => panic!("Unexpected event"),
8637 let bob_updates = match events[1] {
8638 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
8639 assert_eq!(*node_id, nodes[2].node.get_our_node_id());
8642 _ => panic!("Unexpected event"),
8645 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bob_revocation);
8646 check_added_monitors!(nodes[2], 1);
8647 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bob_updates.commitment_signed);
8648 check_added_monitors!(nodes[2], 1);
8650 let events = nodes[2].node.get_and_clear_pending_msg_events();
8651 assert_eq!(events.len(), 1);
8652 let carol_revocation = match events[0] {
8653 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
8654 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
8657 _ => panic!("Unexpected event"),
8659 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &carol_revocation);
8660 check_added_monitors!(nodes[1], 1);
8662 // If this test requires the force-closed channel to not be on-chain until after the fulfill,
8663 // here's where we put said channel's commitment tx on-chain.
8664 let mut txn_to_broadcast = alice_txn.clone();
8665 if !broadcast_alice { txn_to_broadcast = get_local_commitment_txn!(nodes[1], chan_ab.2); }
8666 if !go_onchain_before_fulfill {
8667 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
8668 connect_block(&nodes[1], &Block { header, txdata: vec![txn_to_broadcast[0].clone()]});
8669 // If Bob was the one to force-close, he will have already passed these checks earlier.
8670 if broadcast_alice {
8671 check_closed_broadcast!(nodes[1], true);
8672 check_added_monitors!(nodes[1], 1);
8674 let mut bob_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8675 if broadcast_alice {
8676 // In `connect_block()`, the ChainMonitor and ChannelManager are separately notified about a
8677 // new block being connected. The ChannelManager being notified triggers a monitor update,
8678 // which triggers broadcasting our commitment tx and an HTLC-claiming tx. The ChainMonitor
8679 // being notified triggers the HTLC-claiming tx redundantly, resulting in 3 total txs being
8681 assert_eq!(bob_txn.len(), 3);
8682 check_spends!(bob_txn[1], chan_ab.3);
8684 assert_eq!(bob_txn.len(), 2);
8685 check_spends!(bob_txn[0], chan_ab.3);
8690 // Finally, check that Bob broadcasted a preimage-claiming transaction for the HTLC output on the
8691 // broadcasted commitment transaction.
8693 let bob_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
8694 if go_onchain_before_fulfill {
8695 // Bob should now have an extra broadcasted tx, for the preimage-claiming transaction.
8696 assert_eq!(bob_txn.len(), 2);
8698 let script_weight = match broadcast_alice {
8699 true => OFFERED_HTLC_SCRIPT_WEIGHT,
8700 false => ACCEPTED_HTLC_SCRIPT_WEIGHT
8702 // If Alice force-closed and Bob didn't receive her commitment transaction until after he
8703 // received Carol's fulfill, he broadcasts the HTLC-output-claiming transaction first. Else if
8704 // Bob force closed or if he found out about Alice's commitment tx before receiving Carol's
8705 // fulfill, then he broadcasts the HTLC-output-claiming transaction second.
8706 if broadcast_alice && !go_onchain_before_fulfill {
8707 check_spends!(bob_txn[0], txn_to_broadcast[0]);
8708 assert_eq!(bob_txn[0].input[0].witness.last().unwrap().len(), script_weight);
8710 check_spends!(bob_txn[1], txn_to_broadcast[0]);
8711 assert_eq!(bob_txn[1].input[0].witness.last().unwrap().len(), script_weight);
8717 fn test_onchain_htlc_settlement_after_close() {
8718 do_test_onchain_htlc_settlement_after_close(true, true);
8719 do_test_onchain_htlc_settlement_after_close(false, true); // Technically redundant, but may as well
8720 do_test_onchain_htlc_settlement_after_close(true, false);
8721 do_test_onchain_htlc_settlement_after_close(false, false);
8725 fn test_duplicate_chan_id() {
8726 // Test that if a given peer tries to open a channel with the same channel_id as one that is
8727 // already open we reject it and keep the old channel.
8729 // Previously, full_stack_target managed to figure out that if you tried to open two channels
8730 // with the same funding output (ie post-funding channel_id), we'd create a monitor update for
8731 // the existing channel when we detect the duplicate new channel, screwing up our monitor
8732 // updating logic for the existing channel.
8733 let chanmon_cfgs = create_chanmon_cfgs(2);
8734 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8735 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8736 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8738 // Create an initial channel
8739 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
8740 let mut open_chan_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8741 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_msg);
8742 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()));
8744 // Try to create a second channel with the same temporary_channel_id as the first and check
8745 // that it is rejected.
8746 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_msg);
8748 let events = nodes[1].node.get_and_clear_pending_msg_events();
8749 assert_eq!(events.len(), 1);
8751 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
8752 // Technically, at this point, nodes[1] would be justified in thinking both the
8753 // first (valid) and second (invalid) channels are closed, given they both have
8754 // the same non-temporary channel_id. However, currently we do not, so we just
8755 // move forward with it.
8756 assert_eq!(msg.channel_id, open_chan_msg.temporary_channel_id);
8757 assert_eq!(node_id, nodes[0].node.get_our_node_id());
8759 _ => panic!("Unexpected event"),
8763 // Move the first channel through the funding flow...
8764 let (temporary_channel_id, tx, funding_output) = create_funding_transaction(&nodes[0], 100000, 42);
8766 nodes[0].node.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
8767 check_added_monitors!(nodes[0], 0);
8769 let mut funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
8770 nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created_msg);
8772 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
8773 assert_eq!(added_monitors.len(), 1);
8774 assert_eq!(added_monitors[0].0, funding_output);
8775 added_monitors.clear();
8777 let funding_signed_msg = get_event_msg!(nodes[1], MessageSendEvent::SendFundingSigned, nodes[0].node.get_our_node_id());
8779 let funding_outpoint = ::chain::transaction::OutPoint { txid: funding_created_msg.funding_txid, index: funding_created_msg.funding_output_index };
8780 let channel_id = funding_outpoint.to_channel_id();
8782 // Now we have the first channel past funding_created (ie it has a txid-based channel_id, not a
8785 // First try to open a second channel with a temporary channel id equal to the txid-based one.
8786 // Technically this is allowed by the spec, but we don't support it and there's little reason
8787 // to. Still, it shouldn't cause any other issues.
8788 open_chan_msg.temporary_channel_id = channel_id;
8789 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_msg);
8791 let events = nodes[1].node.get_and_clear_pending_msg_events();
8792 assert_eq!(events.len(), 1);
8794 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
8795 // Technically, at this point, nodes[1] would be justified in thinking both
8796 // channels are closed, but currently we do not, so we just move forward with it.
8797 assert_eq!(msg.channel_id, open_chan_msg.temporary_channel_id);
8798 assert_eq!(node_id, nodes[0].node.get_our_node_id());
8800 _ => panic!("Unexpected event"),
8804 // Now try to create a second channel which has a duplicate funding output.
8805 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
8806 let open_chan_2_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8807 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_2_msg);
8808 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()));
8809 create_funding_transaction(&nodes[0], 100000, 42); // Get and check the FundingGenerationReady event
8811 let funding_created = {
8812 let mut a_channel_lock = nodes[0].node.channel_state.lock().unwrap();
8813 let mut as_chan = a_channel_lock.by_id.get_mut(&open_chan_2_msg.temporary_channel_id).unwrap();
8814 let logger = test_utils::TestLogger::new();
8815 as_chan.get_outbound_funding_created(tx.clone(), funding_outpoint, &&logger).unwrap()
8817 check_added_monitors!(nodes[0], 0);
8818 nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created);
8819 // At this point we'll try to add a duplicate channel monitor, which will be rejected, but
8820 // still needs to be cleared here.
8821 check_added_monitors!(nodes[1], 1);
8823 // ...still, nodes[1] will reject the duplicate channel.
8825 let events = nodes[1].node.get_and_clear_pending_msg_events();
8826 assert_eq!(events.len(), 1);
8828 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
8829 // Technically, at this point, nodes[1] would be justified in thinking both
8830 // channels are closed, but currently we do not, so we just move forward with it.
8831 assert_eq!(msg.channel_id, channel_id);
8832 assert_eq!(node_id, nodes[0].node.get_our_node_id());
8834 _ => panic!("Unexpected event"),
8838 // finally, finish creating the original channel and send a payment over it to make sure
8839 // everything is functional.
8840 nodes[0].node.handle_funding_signed(&nodes[1].node.get_our_node_id(), &funding_signed_msg);
8842 let mut added_monitors = nodes[0].chain_monitor.added_monitors.lock().unwrap();
8843 assert_eq!(added_monitors.len(), 1);
8844 assert_eq!(added_monitors[0].0, funding_output);
8845 added_monitors.clear();
8848 let events_4 = nodes[0].node.get_and_clear_pending_events();
8849 assert_eq!(events_4.len(), 0);
8850 assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
8851 assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0].txid(), funding_output.txid);
8853 let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
8854 let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
8855 update_nodes_with_chan_announce(&nodes, 0, 1, &announcement, &as_update, &bs_update);
8856 send_payment(&nodes[0], &[&nodes[1]], 8000000);
8860 fn test_error_chans_closed() {
8861 // Test that we properly handle error messages, closing appropriate channels.
8863 // Prior to #787 we'd allow a peer to make us force-close a channel we had with a different
8864 // peer. The "real" fix for that is to index channels with peers_ids, however in the mean time
8865 // we can test various edge cases around it to ensure we don't regress.
8866 let chanmon_cfgs = create_chanmon_cfgs(3);
8867 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
8868 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
8869 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
8871 // Create some initial channels
8872 let chan_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
8873 let chan_2 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
8874 let chan_3 = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 100000, 10001, InitFeatures::known(), InitFeatures::known());
8876 assert_eq!(nodes[0].node.list_usable_channels().len(), 3);
8877 assert_eq!(nodes[1].node.list_usable_channels().len(), 2);
8878 assert_eq!(nodes[2].node.list_usable_channels().len(), 1);
8880 // Closing a channel from a different peer has no effect
8881 nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msgs::ErrorMessage { channel_id: chan_3.2, data: "ERR".to_owned() });
8882 assert_eq!(nodes[0].node.list_usable_channels().len(), 3);
8884 // Closing one channel doesn't impact others
8885 nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msgs::ErrorMessage { channel_id: chan_2.2, data: "ERR".to_owned() });
8886 check_added_monitors!(nodes[0], 1);
8887 check_closed_broadcast!(nodes[0], false);
8888 assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0).len(), 1);
8889 assert_eq!(nodes[0].node.list_usable_channels().len(), 2);
8890 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);
8891 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);
8893 // A null channel ID should close all channels
8894 let _chan_4 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
8895 nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msgs::ErrorMessage { channel_id: [0; 32], data: "ERR".to_owned() });
8896 check_added_monitors!(nodes[0], 2);
8897 let events = nodes[0].node.get_and_clear_pending_msg_events();
8898 assert_eq!(events.len(), 2);
8900 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
8901 assert_eq!(msg.contents.flags & 2, 2);
8903 _ => panic!("Unexpected event"),
8906 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
8907 assert_eq!(msg.contents.flags & 2, 2);
8909 _ => panic!("Unexpected event"),
8911 // Note that at this point users of a standard PeerHandler will end up calling
8912 // peer_disconnected with no_connection_possible set to false, duplicating the
8913 // close-all-channels logic. That's OK, we don't want to end up not force-closing channels for
8914 // users with their own peer handling logic. We duplicate the call here, however.
8915 assert_eq!(nodes[0].node.list_usable_channels().len(), 1);
8916 assert!(nodes[0].node.list_usable_channels()[0].channel_id == chan_3.2);
8918 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), true);
8919 assert_eq!(nodes[0].node.list_usable_channels().len(), 1);
8920 assert!(nodes[0].node.list_usable_channels()[0].channel_id == chan_3.2);
8924 fn test_invalid_funding_tx() {
8925 // Test that we properly handle invalid funding transactions sent to us from a peer.
8927 // Previously, all other major lightning implementations had failed to properly sanitize
8928 // funding transactions from their counterparties, leading to a multi-implementation critical
8929 // security vulnerability (though we always sanitized properly, we've previously had
8930 // un-released crashes in the sanitization process).
8931 let chanmon_cfgs = create_chanmon_cfgs(2);
8932 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8933 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8934 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8936 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100_000, 10_000, 42, None).unwrap();
8937 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()));
8938 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()));
8940 let (temporary_channel_id, mut tx, _) = create_funding_transaction(&nodes[0], 100_000, 42);
8941 for output in tx.output.iter_mut() {
8942 // Make the confirmed funding transaction have a bogus script_pubkey
8943 output.script_pubkey = bitcoin::Script::new();
8946 nodes[0].node.funding_transaction_generated_unchecked(&temporary_channel_id, tx.clone(), 0).unwrap();
8947 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()));
8948 check_added_monitors!(nodes[1], 1);
8950 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()));
8951 check_added_monitors!(nodes[0], 1);
8953 let events_1 = nodes[0].node.get_and_clear_pending_events();
8954 assert_eq!(events_1.len(), 0);
8956 assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
8957 assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0], tx);
8958 nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
8960 confirm_transaction_at(&nodes[1], &tx, 1);
8961 check_added_monitors!(nodes[1], 1);
8962 let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
8963 assert_eq!(events_2.len(), 1);
8964 if let MessageSendEvent::HandleError { node_id, action } = &events_2[0] {
8965 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
8966 if let msgs::ErrorAction::SendErrorMessage { msg } = action {
8967 assert_eq!(msg.data, "funding tx had wrong script/value or output index");
8968 } else { panic!(); }
8969 } else { panic!(); }
8970 assert_eq!(nodes[1].node.list_channels().len(), 0);
8973 fn do_test_tx_confirmed_skipping_blocks_immediate_broadcast(test_height_before_timelock: bool) {
8974 // In the first version of the chain::Confirm interface, after a refactor was made to not
8975 // broadcast CSV-locked transactions until their CSV lock is up, we wouldn't reliably broadcast
8976 // transactions after a `transactions_confirmed` call. Specifically, if the chain, provided via
8977 // `best_block_updated` is at height N, and a transaction output which we wish to spend at
8978 // height N-1 (due to a CSV to height N-1) is provided at height N, we will not broadcast the
8979 // spending transaction until height N+1 (or greater). This was due to the way
8980 // `ChannelMonitor::transactions_confirmed` worked, only checking if we should broadcast a
8981 // spending transaction at the height the input transaction was confirmed at, not whether we
8982 // should broadcast a spending transaction at the current height.
8983 // A second, similar, issue involved failing HTLCs backwards - because we only provided the
8984 // height at which transactions were confirmed to `OnchainTx::update_claims_view`, it wasn't
8985 // aware that the anti-reorg-delay had, in fact, already expired, waiting to fail-backwards
8986 // until we learned about an additional block.
8988 // As an additional check, if `test_height_before_timelock` is set, we instead test that we
8989 // aren't broadcasting transactions too early (ie not broadcasting them at all).
8990 let chanmon_cfgs = create_chanmon_cfgs(3);
8991 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
8992 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
8993 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
8994 *nodes[0].connect_style.borrow_mut() = ConnectStyle::BestBlockFirstSkippingBlocks;
8996 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
8997 let (chan_announce, _, channel_id, _) = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
8998 let (_, payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1_000_000);
8999 nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id(), false);
9000 nodes[2].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
9002 nodes[1].node.force_close_channel(&channel_id).unwrap();
9003 check_closed_broadcast!(nodes[1], true);
9004 check_added_monitors!(nodes[1], 1);
9005 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
9006 assert_eq!(node_txn.len(), 1);
9008 let conf_height = nodes[1].best_block_info().1;
9009 if !test_height_before_timelock {
9010 connect_blocks(&nodes[1], 24 * 6);
9012 nodes[1].chain_monitor.chain_monitor.transactions_confirmed(
9013 &nodes[1].get_block_header(conf_height), &[(0, &node_txn[0])], conf_height);
9014 if test_height_before_timelock {
9015 // If we confirmed the close transaction, but timelocks have not yet expired, we should not
9016 // generate any events or broadcast any transactions
9017 assert!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
9018 assert!(nodes[1].chain_monitor.chain_monitor.get_and_clear_pending_events().is_empty());
9020 // We should broadcast an HTLC transaction spending our funding transaction first
9021 let spending_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
9022 assert_eq!(spending_txn.len(), 2);
9023 assert_eq!(spending_txn[0], node_txn[0]);
9024 check_spends!(spending_txn[1], node_txn[0]);
9025 // We should also generate a SpendableOutputs event with the to_self output (as its
9027 let descriptor_spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
9028 assert_eq!(descriptor_spend_txn.len(), 1);
9030 // If we also discover that the HTLC-Timeout transaction was confirmed some time ago, we
9031 // should immediately fail-backwards the HTLC to the previous hop, without waiting for an
9032 // additional block built on top of the current chain.
9033 nodes[1].chain_monitor.chain_monitor.transactions_confirmed(
9034 &nodes[1].get_block_header(conf_height + 1), &[(0, &spending_txn[1])], conf_height + 1);
9035 expect_pending_htlcs_forwardable!(nodes[1]);
9036 check_added_monitors!(nodes[1], 1);
9038 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
9039 assert!(updates.update_add_htlcs.is_empty());
9040 assert!(updates.update_fulfill_htlcs.is_empty());
9041 assert_eq!(updates.update_fail_htlcs.len(), 1);
9042 assert!(updates.update_fail_malformed_htlcs.is_empty());
9043 assert!(updates.update_fee.is_none());
9044 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
9045 commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, true, true);
9046 expect_payment_failed_with_update!(nodes[0], payment_hash, false, chan_announce.contents.short_channel_id, true);
9051 fn test_tx_confirmed_skipping_blocks_immediate_broadcast() {
9052 do_test_tx_confirmed_skipping_blocks_immediate_broadcast(false);
9053 do_test_tx_confirmed_skipping_blocks_immediate_broadcast(true);
9057 fn test_keysend_payments_to_public_node() {
9058 let chanmon_cfgs = create_chanmon_cfgs(2);
9059 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
9060 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
9061 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
9063 let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
9064 let network_graph = &nodes[0].net_graph_msg_handler.network_graph;
9065 let payer_pubkey = nodes[0].node.get_our_node_id();
9066 let payee_pubkey = nodes[1].node.get_our_node_id();
9067 let route = get_route(&payer_pubkey, network_graph, &payee_pubkey, None,
9068 None, &vec![], 10000, 40,
9069 nodes[0].logger).unwrap();
9071 let test_preimage = PaymentPreimage([42; 32]);
9072 let payment_hash = nodes[0].node.send_spontaneous_payment(&route, Some(test_preimage)).unwrap();
9073 check_added_monitors!(nodes[0], 1);
9074 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
9075 assert_eq!(events.len(), 1);
9076 let event = events.pop().unwrap();
9077 let path = vec![&nodes[1]];
9078 pass_along_path(&nodes[0], &path, 10000, payment_hash, None, event, true, Some(test_preimage));
9079 claim_payment(&nodes[0], &path, test_preimage);
9083 fn test_keysend_payments_to_private_node() {
9084 let chanmon_cfgs = create_chanmon_cfgs(2);
9085 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
9086 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
9087 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
9089 let payer_pubkey = nodes[0].node.get_our_node_id();
9090 let payee_pubkey = nodes[1].node.get_our_node_id();
9091 nodes[0].node.peer_connected(&payee_pubkey, &msgs::Init { features: InitFeatures::known() });
9092 nodes[1].node.peer_connected(&payer_pubkey, &msgs::Init { features: InitFeatures::known() });
9094 let _chan = create_chan_between_nodes(&nodes[0], &nodes[1], InitFeatures::known(), InitFeatures::known());
9095 let network_graph = &nodes[0].net_graph_msg_handler.network_graph;
9096 let first_hops = nodes[0].node.list_usable_channels();
9097 let route = get_keysend_route(&payer_pubkey, &network_graph, &payee_pubkey,
9098 Some(&first_hops.iter().collect::<Vec<_>>()), &vec![], 10000, 40,
9099 nodes[0].logger).unwrap();
9101 let test_preimage = PaymentPreimage([42; 32]);
9102 let payment_hash = nodes[0].node.send_spontaneous_payment(&route, Some(test_preimage)).unwrap();
9103 check_added_monitors!(nodes[0], 1);
9104 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
9105 assert_eq!(events.len(), 1);
9106 let event = events.pop().unwrap();
9107 let path = vec![&nodes[1]];
9108 pass_along_path(&nodes[0], &path, 10000, payment_hash, None, event, true, Some(test_preimage));
9109 claim_payment(&nodes[0], &path, test_preimage);
9112 fn do_test_max_dust_htlc_exposure(dust_outbound_balance: bool, at_forward: bool, on_holder_tx: bool) {
9113 // Test that we properly reject dust HTLC violating our `max_dust_htlc_exposure_msat` policy.
9115 // At HTLC forward (`send_payment()`), if the sum of the trimmed-to-dust HTLC inbound and
9116 // trimmed-to-dust HTLC outbound balance and this new payment as included on next counterparty
9117 // commitment are above our `max_dust_htlc_exposure_msat`, we'll reject the update.
9118 // At HTLC reception (`update_add_htlc()`), if the sum of the trimmed-to-dust HTLC inbound
9119 // and trimmed-to-dust HTLC outbound balance and this new received HTLC as included on next
9120 // counterparty commitment are above our `max_dust_htlc_exposure_msat`, we'll fail the update.
9121 // Note, we return a `temporary_channel_failure` (0x1000 | 7), as the channel might be
9122 // available again for HTLC processing once the dust bandwidth has cleared up.
9124 let chanmon_cfgs = create_chanmon_cfgs(2);
9125 let mut config = test_default_channel_config();
9126 config.channel_options.max_dust_htlc_exposure_msat = 5_000_000; // default setting value
9127 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
9128 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, Some(config)]);
9129 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
9131 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 1_000_000, 500_000_000, 42, None).unwrap();
9132 let mut open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
9133 open_channel.max_htlc_value_in_flight_msat = 50_000_000;
9134 open_channel.max_accepted_htlcs = 60;
9135 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_channel);
9136 let mut accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
9138 accept_channel.dust_limit_satoshis = 660;
9140 nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &accept_channel);
9142 let (temporary_channel_id, tx, _) = create_funding_transaction(&nodes[0], 1_000_000, 42);
9145 if let Some(mut chan) = nodes[1].node.channel_state.lock().unwrap().by_id.get_mut(&temporary_channel_id) {
9146 chan.holder_dust_limit_satoshis = 660;
9150 nodes[0].node.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
9151 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()));
9152 check_added_monitors!(nodes[1], 1);
9154 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()));
9155 check_added_monitors!(nodes[0], 1);
9157 let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
9158 let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
9159 update_nodes_with_chan_announce(&nodes, 0, 1, &announcement, &as_update, &bs_update);
9162 if dust_outbound_balance {
9164 let (route, payment_hash, _, payment_secret) = get_route_and_payment_hash!(nodes[1], nodes[0], 2_300_000);
9165 if let Err(_) = nodes[1].node.send_payment(&route, payment_hash, &Some(payment_secret)) { panic!("Unexpected event at dust HTLC {}", i); }
9169 route_payment(&nodes[0], &[&nodes[1]], 2_300_000);
9173 if dust_outbound_balance {
9175 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
9176 if let Err(_) = nodes[1].node.send_payment(&route, payment_hash, &Some(payment_secret)) { panic!("Unexpected event at dust HTLC {}", i); }
9180 route_payment(&nodes[0], &[&nodes[1]], 200_000); // + 167_000 msat of HTLC-timeout tx at 253 sats/kWU
9186 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 });
9187 let mut config = UserConfig::default();
9189 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)));
9191 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)));
9194 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 });
9195 nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
9196 check_added_monitors!(nodes[0], 1);
9197 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
9198 assert_eq!(events.len(), 1);
9199 let payment_event = SendEvent::from_event(events.remove(0));
9200 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
9202 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);
9204 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);
9208 let _ = nodes[1].node.get_and_clear_pending_msg_events();
9209 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
9210 added_monitors.clear();
9214 fn test_max_dust_htlc_exposure() {
9215 do_test_max_dust_htlc_exposure(true, true, true);
9216 do_test_max_dust_htlc_exposure(false, true, true);
9217 do_test_max_dust_htlc_exposure(false, false, true);
9218 do_test_max_dust_htlc_exposure(false, false, false);
9219 do_test_max_dust_htlc_exposure(true, true, false);
9220 do_test_max_dust_htlc_exposure(true, false, false);
9221 do_test_max_dust_htlc_exposure(true, false, true);
9222 do_test_max_dust_htlc_exposure(false, true, false);