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);
641 check_closed_event!(nodes[1], 1);
645 fn test_update_fee_with_fundee_update_add_htlc() {
646 let chanmon_cfgs = create_chanmon_cfgs(2);
647 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
648 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
649 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
650 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
651 let logger = test_utils::TestLogger::new();
654 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
657 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
660 nodes[0].node.timer_tick_occurred();
661 check_added_monitors!(nodes[0], 1);
663 let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
664 assert_eq!(events_0.len(), 1);
665 let (update_msg, commitment_signed) = match events_0[0] {
666 MessageSendEvent::UpdateHTLCs { node_id:_, updates: msgs::CommitmentUpdate { update_add_htlcs:_, update_fulfill_htlcs:_, update_fail_htlcs:_, update_fail_malformed_htlcs:_, ref update_fee, ref commitment_signed } } => {
667 (update_fee.as_ref(), commitment_signed)
669 _ => panic!("Unexpected event"),
671 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
672 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
673 let (revoke_msg, commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
674 check_added_monitors!(nodes[1], 1);
676 let (our_payment_preimage, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[0]);
677 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
678 let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[0].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 800000, TEST_FINAL_CLTV, &logger).unwrap();
680 // nothing happens since node[1] is in AwaitingRemoteRevoke
681 nodes[1].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
683 let mut added_monitors = nodes[0].chain_monitor.added_monitors.lock().unwrap();
684 assert_eq!(added_monitors.len(), 0);
685 added_monitors.clear();
687 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
688 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
689 // node[1] has nothing to do
691 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
692 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
693 check_added_monitors!(nodes[0], 1);
695 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
696 let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
697 // No commitment_signed so get_event_msg's assert(len == 1) passes
698 check_added_monitors!(nodes[0], 1);
699 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg);
700 check_added_monitors!(nodes[1], 1);
701 // AwaitingRemoteRevoke ends here
703 let commitment_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
704 assert_eq!(commitment_update.update_add_htlcs.len(), 1);
705 assert_eq!(commitment_update.update_fulfill_htlcs.len(), 0);
706 assert_eq!(commitment_update.update_fail_htlcs.len(), 0);
707 assert_eq!(commitment_update.update_fail_malformed_htlcs.len(), 0);
708 assert_eq!(commitment_update.update_fee.is_none(), true);
710 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &commitment_update.update_add_htlcs[0]);
711 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_update.commitment_signed);
712 check_added_monitors!(nodes[0], 1);
713 let (revoke, commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
715 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke);
716 check_added_monitors!(nodes[1], 1);
717 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
719 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commitment_signed);
720 check_added_monitors!(nodes[1], 1);
721 let revoke = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
722 // No commitment_signed so get_event_msg's assert(len == 1) passes
724 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke);
725 check_added_monitors!(nodes[0], 1);
726 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
728 let events = nodes[0].node.get_and_clear_pending_events();
729 expect_pending_htlcs_forwardable!(nodes[0], events);
731 let events = nodes[0].node.get_and_clear_pending_events();
732 assert_eq!(events.len(), 1);
734 Event::PaymentReceived { .. } => { },
735 _ => panic!("Unexpected event"),
738 claim_payment(&nodes[1], &vec!(&nodes[0])[..], our_payment_preimage);
740 send_payment(&nodes[1], &vec!(&nodes[0])[..], 800000);
741 send_payment(&nodes[0], &vec!(&nodes[1])[..], 800000);
742 close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true);
743 check_closed_event!(nodes[0], 1);
744 check_closed_event!(nodes[1], 1);
748 fn test_update_fee() {
749 let chanmon_cfgs = create_chanmon_cfgs(2);
750 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
751 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
752 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
753 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
754 let channel_id = chan.2;
757 // (1) update_fee/commitment_signed ->
758 // <- (2) revoke_and_ack
759 // .- send (3) commitment_signed
760 // (4) update_fee/commitment_signed ->
761 // .- send (5) revoke_and_ack (no CS as we're awaiting a revoke)
762 // <- (3) commitment_signed delivered
763 // send (6) revoke_and_ack -.
764 // <- (5) deliver revoke_and_ack
765 // (6) deliver revoke_and_ack ->
766 // .- send (7) commitment_signed in response to (4)
767 // <- (7) deliver commitment_signed
770 // Create and deliver (1)...
773 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
774 feerate = *feerate_lock;
775 *feerate_lock = feerate + 20;
777 nodes[0].node.timer_tick_occurred();
778 check_added_monitors!(nodes[0], 1);
780 let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
781 assert_eq!(events_0.len(), 1);
782 let (update_msg, commitment_signed) = match events_0[0] {
783 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 } } => {
784 (update_fee.as_ref(), commitment_signed)
786 _ => panic!("Unexpected event"),
788 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
790 // Generate (2) and (3):
791 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
792 let (revoke_msg, commitment_signed_0) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
793 check_added_monitors!(nodes[1], 1);
796 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
797 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
798 check_added_monitors!(nodes[0], 1);
800 // Create and deliver (4)...
802 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
803 *feerate_lock = feerate + 30;
805 nodes[0].node.timer_tick_occurred();
806 check_added_monitors!(nodes[0], 1);
807 let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
808 assert_eq!(events_0.len(), 1);
809 let (update_msg, commitment_signed) = match events_0[0] {
810 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 } } => {
811 (update_fee.as_ref(), commitment_signed)
813 _ => panic!("Unexpected event"),
816 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
817 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
818 check_added_monitors!(nodes[1], 1);
820 let revoke_msg = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
821 // No commitment_signed so get_event_msg's assert(len == 1) passes
823 // Handle (3), creating (6):
824 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed_0);
825 check_added_monitors!(nodes[0], 1);
826 let revoke_msg_0 = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
827 // No commitment_signed so get_event_msg's assert(len == 1) passes
830 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
831 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
832 check_added_monitors!(nodes[0], 1);
834 // Deliver (6), creating (7):
835 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg_0);
836 let commitment_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
837 assert!(commitment_update.update_add_htlcs.is_empty());
838 assert!(commitment_update.update_fulfill_htlcs.is_empty());
839 assert!(commitment_update.update_fail_htlcs.is_empty());
840 assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
841 assert!(commitment_update.update_fee.is_none());
842 check_added_monitors!(nodes[1], 1);
845 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_update.commitment_signed);
846 check_added_monitors!(nodes[0], 1);
847 let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
848 // No commitment_signed so get_event_msg's assert(len == 1) passes
850 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg);
851 check_added_monitors!(nodes[1], 1);
852 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
854 assert_eq!(get_feerate!(nodes[0], channel_id), feerate + 30);
855 assert_eq!(get_feerate!(nodes[1], channel_id), feerate + 30);
856 close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true);
857 check_closed_event!(nodes[0], 1);
858 check_closed_event!(nodes[1], 1);
862 fn fake_network_test() {
863 // Simple test which builds a network of ChannelManagers, connects them to each other, and
864 // tests that payments get routed and transactions broadcast in semi-reasonable ways.
865 let chanmon_cfgs = create_chanmon_cfgs(4);
866 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
867 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
868 let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
870 // Create some initial channels
871 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
872 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
873 let chan_3 = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
875 // Rebalance the network a bit by relaying one payment through all the channels...
876 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000);
877 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000);
878 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000);
879 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000);
881 // Send some more payments
882 send_payment(&nodes[1], &vec!(&nodes[2], &nodes[3])[..], 1000000);
883 send_payment(&nodes[3], &vec!(&nodes[2], &nodes[1], &nodes[0])[..], 1000000);
884 send_payment(&nodes[3], &vec!(&nodes[2], &nodes[1])[..], 1000000);
886 // Test failure packets
887 let payment_hash_1 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 1000000).1;
888 fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], payment_hash_1);
890 // Add a new channel that skips 3
891 let chan_4 = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known());
893 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 1000000);
894 send_payment(&nodes[2], &vec!(&nodes[3])[..], 1000000);
895 send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
896 send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
897 send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
898 send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
899 send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
901 // Do some rebalance loop payments, simultaneously
902 let mut hops = Vec::with_capacity(3);
904 pubkey: nodes[2].node.get_our_node_id(),
905 node_features: NodeFeatures::empty(),
906 short_channel_id: chan_2.0.contents.short_channel_id,
907 channel_features: ChannelFeatures::empty(),
909 cltv_expiry_delta: chan_3.0.contents.cltv_expiry_delta as u32
912 pubkey: nodes[3].node.get_our_node_id(),
913 node_features: NodeFeatures::empty(),
914 short_channel_id: chan_3.0.contents.short_channel_id,
915 channel_features: ChannelFeatures::empty(),
917 cltv_expiry_delta: chan_4.1.contents.cltv_expiry_delta as u32
920 pubkey: nodes[1].node.get_our_node_id(),
921 node_features: NodeFeatures::known(),
922 short_channel_id: chan_4.0.contents.short_channel_id,
923 channel_features: ChannelFeatures::known(),
925 cltv_expiry_delta: TEST_FINAL_CLTV,
927 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;
928 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;
929 let payment_preimage_1 = send_along_route(&nodes[1], Route { paths: vec![hops] }, &vec!(&nodes[2], &nodes[3], &nodes[1])[..], 1000000).0;
931 let mut hops = Vec::with_capacity(3);
933 pubkey: nodes[3].node.get_our_node_id(),
934 node_features: NodeFeatures::empty(),
935 short_channel_id: chan_4.0.contents.short_channel_id,
936 channel_features: ChannelFeatures::empty(),
938 cltv_expiry_delta: chan_3.1.contents.cltv_expiry_delta as u32
941 pubkey: nodes[2].node.get_our_node_id(),
942 node_features: NodeFeatures::empty(),
943 short_channel_id: chan_3.0.contents.short_channel_id,
944 channel_features: ChannelFeatures::empty(),
946 cltv_expiry_delta: chan_2.1.contents.cltv_expiry_delta as u32
949 pubkey: nodes[1].node.get_our_node_id(),
950 node_features: NodeFeatures::known(),
951 short_channel_id: chan_2.0.contents.short_channel_id,
952 channel_features: ChannelFeatures::known(),
954 cltv_expiry_delta: TEST_FINAL_CLTV,
956 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;
957 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;
958 let payment_hash_2 = send_along_route(&nodes[1], Route { paths: vec![hops] }, &vec!(&nodes[3], &nodes[2], &nodes[1])[..], 1000000).1;
960 // Claim the rebalances...
961 fail_payment(&nodes[1], &vec!(&nodes[3], &nodes[2], &nodes[1])[..], payment_hash_2);
962 claim_payment(&nodes[1], &vec!(&nodes[2], &nodes[3], &nodes[1])[..], payment_preimage_1);
964 // Add a duplicate new channel from 2 to 4
965 let chan_5 = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known());
967 // Send some payments across both channels
968 let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
969 let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
970 let payment_preimage_5 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
973 route_over_limit(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000);
974 let events = nodes[0].node.get_and_clear_pending_msg_events();
975 assert_eq!(events.len(), 0);
976 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);
978 //TODO: Test that routes work again here as we've been notified that the channel is full
980 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_3);
981 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_4);
982 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_5);
984 // Close down the channels...
985 close_channel(&nodes[0], &nodes[1], &chan_1.2, chan_1.3, true);
986 check_closed_event!(nodes[0], 1);
987 check_closed_event!(nodes[1], 1);
988 close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, false);
989 check_closed_event!(nodes[1], 1);
990 check_closed_event!(nodes[2], 1);
991 close_channel(&nodes[2], &nodes[3], &chan_3.2, chan_3.3, true);
992 check_closed_event!(nodes[2], 1);
993 check_closed_event!(nodes[3], 1);
994 close_channel(&nodes[1], &nodes[3], &chan_4.2, chan_4.3, false);
995 check_closed_event!(nodes[1], 1);
996 check_closed_event!(nodes[3], 1);
997 close_channel(&nodes[1], &nodes[3], &chan_5.2, chan_5.3, false);
998 check_closed_event!(nodes[1], 1);
999 check_closed_event!(nodes[3], 1);
1003 fn holding_cell_htlc_counting() {
1004 // Tests that HTLCs in the holding cell count towards the pending HTLC limits on outbound HTLCs
1005 // to ensure we don't end up with HTLCs sitting around in our holding cell for several
1006 // commitment dance rounds.
1007 let chanmon_cfgs = create_chanmon_cfgs(3);
1008 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1009 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1010 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1011 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
1012 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
1013 let logger = test_utils::TestLogger::new();
1015 let mut payments = Vec::new();
1016 for _ in 0..::ln::channel::OUR_MAX_HTLCS {
1017 let (payment_preimage, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[2]);
1018 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
1019 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();
1020 nodes[1].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
1021 payments.push((payment_preimage, payment_hash));
1023 check_added_monitors!(nodes[1], 1);
1025 let mut events = nodes[1].node.get_and_clear_pending_msg_events();
1026 assert_eq!(events.len(), 1);
1027 let initial_payment_event = SendEvent::from_event(events.pop().unwrap());
1028 assert_eq!(initial_payment_event.node_id, nodes[2].node.get_our_node_id());
1030 // There is now one HTLC in an outbound commitment transaction and (OUR_MAX_HTLCS - 1) HTLCs in
1031 // the holding cell waiting on B's RAA to send. At this point we should not be able to add
1033 let (_, payment_hash_1, payment_secret_1) = get_payment_preimage_hash!(nodes[2]);
1035 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
1036 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();
1037 unwrap_send_err!(nodes[1].node.send_payment(&route, payment_hash_1, &Some(payment_secret_1)), true, APIError::ChannelUnavailable { ref err },
1038 assert!(regex::Regex::new(r"Cannot push more than their max accepted HTLCs \(\d+\)").unwrap().is_match(err)));
1039 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1040 nodes[1].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot push more than their max accepted HTLCs".to_string(), 1);
1043 // This should also be true if we try to forward a payment.
1044 let (_, payment_hash_2, payment_secret_2) = get_payment_preimage_hash!(nodes[2]);
1046 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
1047 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();
1048 nodes[0].node.send_payment(&route, payment_hash_2, &Some(payment_secret_2)).unwrap();
1049 check_added_monitors!(nodes[0], 1);
1052 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1053 assert_eq!(events.len(), 1);
1054 let payment_event = SendEvent::from_event(events.pop().unwrap());
1055 assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
1057 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1058 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
1059 // We have to forward pending HTLCs twice - once tries to forward the payment forward (and
1060 // fails), the second will process the resulting failure and fail the HTLC backward.
1061 let events = nodes[1].node.get_and_clear_pending_events();
1062 expect_pending_htlcs_forwardable!(nodes[1], events);
1063 let events = nodes[1].node.get_and_clear_pending_events();
1064 expect_pending_htlcs_forwardable!(nodes[1], events);
1065 check_added_monitors!(nodes[1], 1);
1067 let bs_fail_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1068 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &bs_fail_updates.update_fail_htlcs[0]);
1069 commitment_signed_dance!(nodes[0], nodes[1], bs_fail_updates.commitment_signed, false, true);
1071 expect_payment_failed_with_update!(nodes[0], payment_hash_2, false, chan_2.0.contents.short_channel_id, false);
1073 // Now forward all the pending HTLCs and claim them back
1074 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &initial_payment_event.msgs[0]);
1075 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &initial_payment_event.commitment_msg);
1076 check_added_monitors!(nodes[2], 1);
1078 let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1079 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_revoke_and_ack);
1080 check_added_monitors!(nodes[1], 1);
1081 let as_updates = get_htlc_update_msgs!(nodes[1], nodes[2].node.get_our_node_id());
1083 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &bs_commitment_signed);
1084 check_added_monitors!(nodes[1], 1);
1085 let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
1087 for ref update in as_updates.update_add_htlcs.iter() {
1088 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), update);
1090 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &as_updates.commitment_signed);
1091 check_added_monitors!(nodes[2], 1);
1092 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
1093 check_added_monitors!(nodes[2], 1);
1094 let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1096 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_revoke_and_ack);
1097 check_added_monitors!(nodes[1], 1);
1098 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &bs_commitment_signed);
1099 check_added_monitors!(nodes[1], 1);
1100 let as_final_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
1102 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_final_raa);
1103 check_added_monitors!(nodes[2], 1);
1105 let events = nodes[2].node.get_and_clear_pending_events();
1106 expect_pending_htlcs_forwardable!(nodes[2], events);
1108 let events = nodes[2].node.get_and_clear_pending_events();
1109 assert_eq!(events.len(), payments.len());
1110 for (event, &(_, ref hash)) in events.iter().zip(payments.iter()) {
1112 &Event::PaymentReceived { ref payment_hash, .. } => {
1113 assert_eq!(*payment_hash, *hash);
1115 _ => panic!("Unexpected event"),
1119 for (preimage, _) in payments.drain(..) {
1120 claim_payment(&nodes[1], &[&nodes[2]], preimage);
1123 send_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1000000);
1127 fn duplicate_htlc_test() {
1128 // Test that we accept duplicate payment_hash HTLCs across the network and that
1129 // claiming/failing them are all separate and don't affect each other
1130 let chanmon_cfgs = create_chanmon_cfgs(6);
1131 let node_cfgs = create_node_cfgs(6, &chanmon_cfgs);
1132 let node_chanmgrs = create_node_chanmgrs(6, &node_cfgs, &[None, None, None, None, None, None]);
1133 let mut nodes = create_network(6, &node_cfgs, &node_chanmgrs);
1135 // Create some initial channels to route via 3 to 4/5 from 0/1/2
1136 create_announced_chan_between_nodes(&nodes, 0, 3, InitFeatures::known(), InitFeatures::known());
1137 create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known());
1138 create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
1139 create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::known(), InitFeatures::known());
1140 create_announced_chan_between_nodes(&nodes, 3, 5, InitFeatures::known(), InitFeatures::known());
1142 let (payment_preimage, payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[3], &nodes[4])[..], 1000000);
1144 *nodes[0].network_payment_count.borrow_mut() -= 1;
1145 assert_eq!(route_payment(&nodes[1], &vec!(&nodes[3])[..], 1000000).0, payment_preimage);
1147 *nodes[0].network_payment_count.borrow_mut() -= 1;
1148 assert_eq!(route_payment(&nodes[2], &vec!(&nodes[3], &nodes[5])[..], 1000000).0, payment_preimage);
1150 claim_payment(&nodes[0], &vec!(&nodes[3], &nodes[4])[..], payment_preimage);
1151 fail_payment(&nodes[2], &vec!(&nodes[3], &nodes[5])[..], payment_hash);
1152 claim_payment(&nodes[1], &vec!(&nodes[3])[..], payment_preimage);
1156 fn test_duplicate_htlc_different_direction_onchain() {
1157 // Test that ChannelMonitor doesn't generate 2 preimage txn
1158 // when we have 2 HTLCs with same preimage that go across a node
1159 // in opposite directions, even with the same payment secret.
1160 let chanmon_cfgs = create_chanmon_cfgs(2);
1161 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1162 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1163 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1165 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
1166 let logger = test_utils::TestLogger::new();
1169 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
1171 let (payment_preimage, payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 900_000);
1173 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
1174 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();
1175 let node_a_payment_secret = nodes[0].node.create_inbound_payment_for_hash(payment_hash, None, 7200, 0).unwrap();
1176 send_along_route_with_secret(&nodes[1], route, &[&[&nodes[0]]], 800_000, payment_hash, node_a_payment_secret);
1178 // Provide preimage to node 0 by claiming payment
1179 nodes[0].node.claim_funds(payment_preimage);
1180 check_added_monitors!(nodes[0], 1);
1182 // Broadcast node 1 commitment txn
1183 let remote_txn = get_local_commitment_txn!(nodes[1], chan_1.2);
1185 assert_eq!(remote_txn[0].output.len(), 4); // 1 local, 1 remote, 1 htlc inbound, 1 htlc outbound
1186 let mut has_both_htlcs = 0; // check htlcs match ones committed
1187 for outp in remote_txn[0].output.iter() {
1188 if outp.value == 800_000 / 1000 {
1189 has_both_htlcs += 1;
1190 } else if outp.value == 900_000 / 1000 {
1191 has_both_htlcs += 1;
1194 assert_eq!(has_both_htlcs, 2);
1196 mine_transaction(&nodes[0], &remote_txn[0]);
1197 check_added_monitors!(nodes[0], 1);
1198 check_closed_event!(nodes[0], 1);
1199 connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
1201 // Check we only broadcast 1 timeout tx
1202 let claim_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
1203 assert_eq!(claim_txn.len(), 8);
1204 assert_eq!(claim_txn[1], claim_txn[4]);
1205 assert_eq!(claim_txn[2], claim_txn[5]);
1206 check_spends!(claim_txn[1], chan_1.3);
1207 check_spends!(claim_txn[2], claim_txn[1]);
1208 check_spends!(claim_txn[7], claim_txn[1]);
1210 assert_eq!(claim_txn[0].input.len(), 1);
1211 assert_eq!(claim_txn[3].input.len(), 1);
1212 assert_eq!(claim_txn[0].input[0].previous_output, claim_txn[3].input[0].previous_output);
1214 assert_eq!(claim_txn[0].input.len(), 1);
1215 assert_eq!(claim_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC 1 <--> 0, preimage tx
1216 check_spends!(claim_txn[0], remote_txn[0]);
1217 assert_eq!(remote_txn[0].output[claim_txn[0].input[0].previous_output.vout as usize].value, 800);
1218 assert_eq!(claim_txn[6].input.len(), 1);
1219 assert_eq!(claim_txn[6].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // HTLC 0 <--> 1, timeout tx
1220 check_spends!(claim_txn[6], remote_txn[0]);
1221 assert_eq!(remote_txn[0].output[claim_txn[6].input[0].previous_output.vout as usize].value, 900);
1223 let events = nodes[0].node.get_and_clear_pending_msg_events();
1224 assert_eq!(events.len(), 3);
1227 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
1228 MessageSendEvent::HandleError { node_id, action: msgs::ErrorAction::SendErrorMessage { ref msg } } => {
1229 assert_eq!(node_id, nodes[1].node.get_our_node_id());
1230 assert_eq!(msg.data, "Commitment or closing transaction was confirmed on chain.");
1232 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, .. } } => {
1233 assert!(update_add_htlcs.is_empty());
1234 assert!(update_fail_htlcs.is_empty());
1235 assert_eq!(update_fulfill_htlcs.len(), 1);
1236 assert!(update_fail_malformed_htlcs.is_empty());
1237 assert_eq!(nodes[1].node.get_our_node_id(), *node_id);
1239 _ => panic!("Unexpected event"),
1245 fn test_basic_channel_reserve() {
1246 let chanmon_cfgs = create_chanmon_cfgs(2);
1247 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1248 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1249 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1250 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1251 let logger = test_utils::TestLogger::new();
1253 let chan_stat = get_channel_value_stat!(nodes[0], chan.2);
1254 let channel_reserve = chan_stat.channel_reserve_msat;
1256 // The 2* and +1 are for the fee spike reserve.
1257 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
1258 let commit_tx_fee = 2 * commit_tx_fee_msat(get_feerate!(nodes[0], chan.2), 1 + 1);
1259 let max_can_send = 5000000 - channel_reserve - commit_tx_fee;
1260 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
1261 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();
1262 let err = nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).err().unwrap();
1264 PaymentSendFailure::AllFailedRetrySafe(ref fails) => {
1266 &APIError::ChannelUnavailable{ref err} =>
1267 assert!(regex::Regex::new(r"Cannot send value that would put our balance under counterparty-announced channel reserve value \(\d+\)").unwrap().is_match(err)),
1268 _ => panic!("Unexpected error variant"),
1271 _ => panic!("Unexpected error variant"),
1273 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1274 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);
1276 send_payment(&nodes[0], &vec![&nodes[1]], max_can_send);
1280 fn test_fee_spike_violation_fails_htlc() {
1281 let chanmon_cfgs = create_chanmon_cfgs(2);
1282 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1283 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1284 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1285 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1287 let (route, payment_hash, _, payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], 3460001);
1288 // Need to manually create the update_add_htlc message to go around the channel reserve check in send_htlc()
1289 let secp_ctx = Secp256k1::new();
1290 let session_priv = SecretKey::from_slice(&[42; 32]).expect("RNG is bad!");
1292 let cur_height = nodes[1].node.best_block.read().unwrap().height() + 1;
1294 let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route.paths[0], &session_priv).unwrap();
1295 let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 3460001, &Some(payment_secret), cur_height, &None).unwrap();
1296 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
1297 let msg = msgs::UpdateAddHTLC {
1300 amount_msat: htlc_msat,
1301 payment_hash: payment_hash,
1302 cltv_expiry: htlc_cltv,
1303 onion_routing_packet: onion_packet,
1306 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
1308 // Now manually create the commitment_signed message corresponding to the update_add
1309 // nodes[0] just sent. In the code for construction of this message, "local" refers
1310 // to the sender of the message, and "remote" refers to the receiver.
1312 let feerate_per_kw = get_feerate!(nodes[0], chan.2);
1314 const INITIAL_COMMITMENT_NUMBER: u64 = (1 << 48) - 1;
1316 // Get the EnforcingSigner for each channel, which will be used to (1) get the keys
1317 // needed to sign the new commitment tx and (2) sign the new commitment tx.
1318 let (local_revocation_basepoint, local_htlc_basepoint, local_secret, next_local_point, local_funding) = {
1319 let chan_lock = nodes[0].node.channel_state.lock().unwrap();
1320 let local_chan = chan_lock.by_id.get(&chan.2).unwrap();
1321 let chan_signer = local_chan.get_signer();
1322 // Make the signer believe we validated another commitment, so we can release the secret
1323 chan_signer.get_enforcement_state().last_holder_commitment -= 1;
1325 let pubkeys = chan_signer.pubkeys();
1326 (pubkeys.revocation_basepoint, pubkeys.htlc_basepoint,
1327 chan_signer.release_commitment_secret(INITIAL_COMMITMENT_NUMBER),
1328 chan_signer.get_per_commitment_point(INITIAL_COMMITMENT_NUMBER - 2, &secp_ctx),
1329 chan_signer.pubkeys().funding_pubkey)
1331 let (remote_delayed_payment_basepoint, remote_htlc_basepoint, remote_point, remote_funding) = {
1332 let chan_lock = nodes[1].node.channel_state.lock().unwrap();
1333 let remote_chan = chan_lock.by_id.get(&chan.2).unwrap();
1334 let chan_signer = remote_chan.get_signer();
1335 let pubkeys = chan_signer.pubkeys();
1336 (pubkeys.delayed_payment_basepoint, pubkeys.htlc_basepoint,
1337 chan_signer.get_per_commitment_point(INITIAL_COMMITMENT_NUMBER - 1, &secp_ctx),
1338 chan_signer.pubkeys().funding_pubkey)
1341 // Assemble the set of keys we can use for signatures for our commitment_signed message.
1342 let commit_tx_keys = chan_utils::TxCreationKeys::derive_new(&secp_ctx, &remote_point, &remote_delayed_payment_basepoint,
1343 &remote_htlc_basepoint, &local_revocation_basepoint, &local_htlc_basepoint).unwrap();
1345 // Build the remote commitment transaction so we can sign it, and then later use the
1346 // signature for the commitment_signed message.
1347 let local_chan_balance = 1313;
1349 let accepted_htlc_info = chan_utils::HTLCOutputInCommitment {
1351 amount_msat: 3460001,
1352 cltv_expiry: htlc_cltv,
1354 transaction_output_index: Some(1),
1357 let commitment_number = INITIAL_COMMITMENT_NUMBER - 1;
1360 let local_chan_lock = nodes[0].node.channel_state.lock().unwrap();
1361 let local_chan = local_chan_lock.by_id.get(&chan.2).unwrap();
1362 let local_chan_signer = local_chan.get_signer();
1363 let commitment_tx = CommitmentTransaction::new_with_auxiliary_htlc_data(
1367 false, local_funding, remote_funding,
1368 commit_tx_keys.clone(),
1370 &mut vec![(accepted_htlc_info, ())],
1371 &local_chan.channel_transaction_parameters.as_counterparty_broadcastable()
1373 local_chan_signer.sign_counterparty_commitment(&commitment_tx, &secp_ctx).unwrap()
1376 let commit_signed_msg = msgs::CommitmentSigned {
1379 htlc_signatures: res.1
1382 // Send the commitment_signed message to the nodes[1].
1383 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commit_signed_msg);
1384 let _ = nodes[1].node.get_and_clear_pending_msg_events();
1386 // Send the RAA to nodes[1].
1387 let raa_msg = msgs::RevokeAndACK {
1389 per_commitment_secret: local_secret,
1390 next_per_commitment_point: next_local_point
1392 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &raa_msg);
1394 let events = nodes[1].node.get_and_clear_pending_msg_events();
1395 assert_eq!(events.len(), 1);
1396 // Make sure the HTLC failed in the way we expect.
1398 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fail_htlcs, .. }, .. } => {
1399 assert_eq!(update_fail_htlcs.len(), 1);
1400 update_fail_htlcs[0].clone()
1402 _ => panic!("Unexpected event"),
1404 nodes[1].logger.assert_log("lightning::ln::channel".to_string(),
1405 format!("Attempting to fail HTLC due to fee spike buffer violation in channel {}. Rebalancing is required.", ::hex::encode(raa_msg.channel_id)), 1);
1407 check_added_monitors!(nodes[1], 2);
1411 fn test_chan_reserve_violation_outbound_htlc_inbound_chan() {
1412 let mut chanmon_cfgs = create_chanmon_cfgs(2);
1413 // Set the fee rate for the channel very high, to the point where the fundee
1414 // sending any above-dust amount would result in a channel reserve violation.
1415 // In this test we check that we would be prevented from sending an HTLC in
1417 let feerate_per_kw = 253;
1418 chanmon_cfgs[0].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(feerate_per_kw) };
1419 chanmon_cfgs[1].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(feerate_per_kw) };
1420 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1421 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1422 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1424 let mut push_amt = 100_000_000;
1425 push_amt -= feerate_per_kw as u64 * (COMMITMENT_TX_BASE_WEIGHT + COMMITMENT_TX_WEIGHT_PER_HTLC) / 1000 * 1000;
1426 push_amt -= Channel::<EnforcingSigner>::get_holder_selected_channel_reserve_satoshis(100_000) * 1000;
1428 let _ = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100_000, push_amt, InitFeatures::known(), InitFeatures::known());
1430 // Sending exactly enough to hit the reserve amount should be accepted
1431 let (_, _, _) = route_payment(&nodes[1], &[&nodes[0]], 1_000_000);
1433 // However one more HTLC should be significantly over the reserve amount and fail.
1434 let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[1], nodes[0], 1_000_000);
1435 unwrap_send_err!(nodes[1].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
1436 assert_eq!(err, "Cannot send value that would put counterparty balance under holder-announced channel reserve value"));
1437 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1438 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);
1442 fn test_chan_reserve_violation_inbound_htlc_outbound_channel() {
1443 let mut chanmon_cfgs = create_chanmon_cfgs(2);
1444 // Set the fee rate for the channel very high, to the point where the funder
1445 // receiving 1 update_add_htlc would result in them closing the channel due
1446 // to channel reserve violation. This close could also happen if the fee went
1447 // up a more realistic amount, but many HTLCs were outstanding at the time of
1448 // the update_add_htlc.
1449 chanmon_cfgs[0].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(6000) };
1450 chanmon_cfgs[1].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(6000) };
1451 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1452 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1453 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1454 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1456 let (route, payment_hash, _, payment_secret) = get_route_and_payment_hash!(nodes[1], nodes[0], 1000);
1457 // Need to manually create the update_add_htlc message to go around the channel reserve check in send_htlc()
1458 let secp_ctx = Secp256k1::new();
1459 let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
1460 let cur_height = nodes[1].node.best_block.read().unwrap().height() + 1;
1461 let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route.paths[0], &session_priv).unwrap();
1462 let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 1000, &Some(payment_secret), cur_height, &None).unwrap();
1463 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
1464 let msg = msgs::UpdateAddHTLC {
1467 amount_msat: htlc_msat + 1,
1468 payment_hash: payment_hash,
1469 cltv_expiry: htlc_cltv,
1470 onion_routing_packet: onion_packet,
1473 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &msg);
1474 // Check that the payment failed and the channel is closed in response to the malicious UpdateAdd.
1475 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);
1476 assert_eq!(nodes[0].node.list_channels().len(), 0);
1477 let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
1478 assert_eq!(err_msg.data, "Cannot accept HTLC that would put our balance under counterparty-announced channel reserve value");
1479 check_added_monitors!(nodes[0], 1);
1480 check_closed_event!(nodes[0], 1);
1484 fn test_chan_reserve_dust_inbound_htlcs_outbound_chan() {
1485 // Test that if we receive many dust HTLCs over an outbound channel, they don't count when
1486 // calculating our commitment transaction fee (this was previously broken).
1487 let mut chanmon_cfgs = create_chanmon_cfgs(2);
1488 let feerate_per_kw = 253;
1489 chanmon_cfgs[0].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(feerate_per_kw) };
1490 chanmon_cfgs[1].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(feerate_per_kw) };
1492 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1493 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None, None]);
1494 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1496 // Set nodes[0]'s balance such that they will consider any above-dust received HTLC to be a
1497 // channel reserve violation (so their balance is channel reserve (1000 sats) + commitment
1498 // transaction fee with 0 HTLCs (183 sats)).
1499 let mut push_amt = 100_000_000;
1500 push_amt -= feerate_per_kw as u64 * (COMMITMENT_TX_BASE_WEIGHT) / 1000 * 1000;
1501 push_amt -= Channel::<EnforcingSigner>::get_holder_selected_channel_reserve_satoshis(100_000) * 1000;
1502 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, push_amt, InitFeatures::known(), InitFeatures::known());
1504 let dust_amt = crate::ln::channel::MIN_DUST_LIMIT_SATOSHIS * 1000
1505 + feerate_per_kw as u64 * HTLC_SUCCESS_TX_WEIGHT / 1000 * 1000 - 1;
1506 // In the previous code, routing this dust payment would cause nodes[0] to perceive a channel
1507 // reserve violation even though it's a dust HTLC and therefore shouldn't count towards the
1508 // commitment transaction fee.
1509 let (_, _, _) = route_payment(&nodes[1], &[&nodes[0]], dust_amt);
1511 // One more than the dust amt should fail, however.
1512 let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[1], nodes[0], dust_amt + 1);
1513 unwrap_send_err!(nodes[1].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
1514 assert_eq!(err, "Cannot send value that would put counterparty balance under holder-announced channel reserve value"));
1518 fn test_chan_reserve_dust_inbound_htlcs_inbound_chan() {
1519 // Test that if we receive many dust HTLCs over an inbound channel, they don't count when
1520 // calculating our counterparty's commitment transaction fee (this was previously broken).
1521 let chanmon_cfgs = create_chanmon_cfgs(2);
1522 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1523 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None, None]);
1524 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1525 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 98000000, InitFeatures::known(), InitFeatures::known());
1527 let payment_amt = 46000; // Dust amount
1528 // In the previous code, these first four payments would succeed.
1529 let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1530 let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1531 let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1532 let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1534 // Then these next 5 would be interpreted by nodes[1] as violating the fee spike buffer.
1535 let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1536 let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1537 let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1538 let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1539 let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1541 // And this last payment previously resulted in nodes[1] closing on its inbound-channel
1542 // counterparty, because it counted all the previous dust HTLCs against nodes[0]'s commitment
1543 // transaction fee and therefore perceived this next payment as a channel reserve violation.
1544 let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1548 fn test_chan_reserve_violation_inbound_htlc_inbound_chan() {
1549 let chanmon_cfgs = create_chanmon_cfgs(3);
1550 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1551 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1552 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1553 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1554 let _ = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1557 let total_routing_fee_msat = (nodes.len() - 2) as u64 * feemsat;
1558 let chan_stat = get_channel_value_stat!(nodes[0], chan.2);
1559 let feerate = get_feerate!(nodes[0], chan.2);
1561 // Add a 2* and +1 for the fee spike reserve.
1562 let commit_tx_fee_2_htlc = 2*commit_tx_fee_msat(feerate, 2 + 1);
1563 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;
1564 let amt_msat_1 = recv_value_1 + total_routing_fee_msat;
1566 // Add a pending HTLC.
1567 let (route_1, our_payment_hash_1, _, our_payment_secret_1) = get_route_and_payment_hash!(nodes[0], nodes[2], amt_msat_1);
1568 let payment_event_1 = {
1569 nodes[0].node.send_payment(&route_1, our_payment_hash_1, &Some(our_payment_secret_1)).unwrap();
1570 check_added_monitors!(nodes[0], 1);
1572 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1573 assert_eq!(events.len(), 1);
1574 SendEvent::from_event(events.remove(0))
1576 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event_1.msgs[0]);
1578 // Attempt to trigger a channel reserve violation --> payment failure.
1579 let commit_tx_fee_2_htlcs = commit_tx_fee_msat(feerate, 2);
1580 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;
1581 let amt_msat_2 = recv_value_2 + total_routing_fee_msat;
1582 let (route_2, _, _, _) = get_route_and_payment_hash!(nodes[0], nodes[2], amt_msat_2);
1584 // Need to manually create the update_add_htlc message to go around the channel reserve check in send_htlc()
1585 let secp_ctx = Secp256k1::new();
1586 let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
1587 let cur_height = nodes[0].node.best_block.read().unwrap().height() + 1;
1588 let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route_2.paths[0], &session_priv).unwrap();
1589 let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route_2.paths[0], recv_value_2, &None, cur_height, &None).unwrap();
1590 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &our_payment_hash_1);
1591 let msg = msgs::UpdateAddHTLC {
1594 amount_msat: htlc_msat + 1,
1595 payment_hash: our_payment_hash_1,
1596 cltv_expiry: htlc_cltv,
1597 onion_routing_packet: onion_packet,
1600 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
1601 // Check that the payment failed and the channel is closed in response to the malicious UpdateAdd.
1602 nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Remote HTLC add would put them under remote reserve value".to_string(), 1);
1603 assert_eq!(nodes[1].node.list_channels().len(), 1);
1604 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
1605 assert_eq!(err_msg.data, "Remote HTLC add would put them under remote reserve value");
1606 check_added_monitors!(nodes[1], 1);
1607 check_closed_event!(nodes[1], 1);
1611 fn test_inbound_outbound_capacity_is_not_zero() {
1612 let chanmon_cfgs = create_chanmon_cfgs(2);
1613 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1614 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1615 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1616 let _ = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1617 let channels0 = node_chanmgrs[0].list_channels();
1618 let channels1 = node_chanmgrs[1].list_channels();
1619 assert_eq!(channels0.len(), 1);
1620 assert_eq!(channels1.len(), 1);
1622 let reserve = Channel::<EnforcingSigner>::get_holder_selected_channel_reserve_satoshis(100000);
1623 assert_eq!(channels0[0].inbound_capacity_msat, 95000000 - reserve*1000);
1624 assert_eq!(channels1[0].outbound_capacity_msat, 95000000 - reserve*1000);
1626 assert_eq!(channels0[0].outbound_capacity_msat, 100000 * 1000 - 95000000 - reserve*1000);
1627 assert_eq!(channels1[0].inbound_capacity_msat, 100000 * 1000 - 95000000 - reserve*1000);
1630 fn commit_tx_fee_msat(feerate: u32, num_htlcs: u64) -> u64 {
1631 (COMMITMENT_TX_BASE_WEIGHT + num_htlcs * COMMITMENT_TX_WEIGHT_PER_HTLC) * feerate as u64 / 1000 * 1000
1635 fn test_channel_reserve_holding_cell_htlcs() {
1636 let chanmon_cfgs = create_chanmon_cfgs(3);
1637 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1638 // When this test was written, the default base fee floated based on the HTLC count.
1639 // It is now fixed, so we simply set the fee to the expected value here.
1640 let mut config = test_default_channel_config();
1641 config.channel_options.forwarding_fee_base_msat = 239;
1642 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[Some(config.clone()), Some(config.clone()), Some(config.clone())]);
1643 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1644 let chan_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 190000, 1001, InitFeatures::known(), InitFeatures::known());
1645 let chan_2 = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 190000, 1001, InitFeatures::known(), InitFeatures::known());
1647 let mut stat01 = get_channel_value_stat!(nodes[0], chan_1.2);
1648 let mut stat11 = get_channel_value_stat!(nodes[1], chan_1.2);
1650 let mut stat12 = get_channel_value_stat!(nodes[1], chan_2.2);
1651 let mut stat22 = get_channel_value_stat!(nodes[2], chan_2.2);
1653 macro_rules! expect_forward {
1655 let mut events = $node.node.get_and_clear_pending_msg_events();
1656 assert_eq!(events.len(), 1);
1657 check_added_monitors!($node, 1);
1658 let payment_event = SendEvent::from_event(events.remove(0));
1663 let feemsat = 239; // set above
1664 let total_fee_msat = (nodes.len() - 2) as u64 * feemsat;
1665 let feerate = get_feerate!(nodes[0], chan_1.2);
1667 let recv_value_0 = stat01.counterparty_max_htlc_value_in_flight_msat - total_fee_msat;
1669 // attempt to send amt_msat > their_max_htlc_value_in_flight_msat
1671 let (mut route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], recv_value_0);
1672 route.paths[0].last_mut().unwrap().fee_msat += 1;
1673 assert!(route.paths[0].iter().rev().skip(1).all(|h| h.fee_msat == feemsat));
1674 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
1675 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)));
1676 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1677 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);
1680 // channel reserve is bigger than their_max_htlc_value_in_flight_msat so loop to deplete
1681 // nodes[0]'s wealth
1683 let amt_msat = recv_value_0 + total_fee_msat;
1684 // 3 for the 3 HTLCs that will be sent, 2* and +1 for the fee spike reserve.
1685 // Also, ensure that each payment has enough to be over the dust limit to
1686 // ensure it'll be included in each commit tx fee calculation.
1687 let commit_tx_fee_all_htlcs = 2*commit_tx_fee_msat(feerate, 3 + 1);
1688 let ensure_htlc_amounts_above_dust_buffer = 3 * (stat01.counterparty_dust_limit_msat + 1000);
1689 if stat01.value_to_self_msat < stat01.channel_reserve_msat + commit_tx_fee_all_htlcs + ensure_htlc_amounts_above_dust_buffer + amt_msat {
1692 send_payment(&nodes[0], &vec![&nodes[1], &nodes[2]][..], recv_value_0);
1694 let (stat01_, stat11_, stat12_, stat22_) = (
1695 get_channel_value_stat!(nodes[0], chan_1.2),
1696 get_channel_value_stat!(nodes[1], chan_1.2),
1697 get_channel_value_stat!(nodes[1], chan_2.2),
1698 get_channel_value_stat!(nodes[2], chan_2.2),
1701 assert_eq!(stat01_.value_to_self_msat, stat01.value_to_self_msat - amt_msat);
1702 assert_eq!(stat11_.value_to_self_msat, stat11.value_to_self_msat + amt_msat);
1703 assert_eq!(stat12_.value_to_self_msat, stat12.value_to_self_msat - (amt_msat - feemsat));
1704 assert_eq!(stat22_.value_to_self_msat, stat22.value_to_self_msat + (amt_msat - feemsat));
1705 stat01 = stat01_; stat11 = stat11_; stat12 = stat12_; stat22 = stat22_;
1708 // adding pending output.
1709 // 2* and +1 HTLCs on the commit tx fee for the fee spike reserve.
1710 // The reason we're dividing by two here is as follows: the dividend is the total outbound liquidity
1711 // after fees, the channel reserve, and the fee spike buffer are removed. We eventually want to
1712 // divide this quantity into 3 portions, that will each be sent in an HTLC. This allows us
1713 // to test channel channel reserve policy at the edges of what amount is sendable, i.e.
1714 // cases where 1 msat over X amount will cause a payment failure, but anything less than
1715 // that can be sent successfully. So, dividing by two is a somewhat arbitrary way of getting
1716 // the amount of the first of these aforementioned 3 payments. The reason we split into 3 payments
1717 // is to test the behavior of the holding cell with respect to channel reserve and commit tx fee
1719 let commit_tx_fee_2_htlcs = 2*commit_tx_fee_msat(feerate, 2 + 1);
1720 let recv_value_1 = (stat01.value_to_self_msat - stat01.channel_reserve_msat - total_fee_msat - commit_tx_fee_2_htlcs)/2;
1721 let amt_msat_1 = recv_value_1 + total_fee_msat;
1723 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);
1724 let payment_event_1 = {
1725 nodes[0].node.send_payment(&route_1, our_payment_hash_1, &Some(our_payment_secret_1)).unwrap();
1726 check_added_monitors!(nodes[0], 1);
1728 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1729 assert_eq!(events.len(), 1);
1730 SendEvent::from_event(events.remove(0))
1732 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event_1.msgs[0]);
1734 // channel reserve test with htlc pending output > 0
1735 let recv_value_2 = stat01.value_to_self_msat - amt_msat_1 - stat01.channel_reserve_msat - total_fee_msat - commit_tx_fee_2_htlcs;
1737 let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], recv_value_2 + 1);
1738 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
1739 assert!(regex::Regex::new(r"Cannot send value that would put our balance under counterparty-announced channel reserve value \(\d+\)").unwrap().is_match(err)));
1740 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1743 // split the rest to test holding cell
1744 let commit_tx_fee_3_htlcs = 2*commit_tx_fee_msat(feerate, 3 + 1);
1745 let additional_htlc_cost_msat = commit_tx_fee_3_htlcs - commit_tx_fee_2_htlcs;
1746 let recv_value_21 = recv_value_2/2 - additional_htlc_cost_msat/2;
1747 let recv_value_22 = recv_value_2 - recv_value_21 - total_fee_msat - additional_htlc_cost_msat;
1749 let stat = get_channel_value_stat!(nodes[0], chan_1.2);
1750 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);
1753 // now see if they go through on both sides
1754 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);
1755 // but this will stuck in the holding cell
1756 nodes[0].node.send_payment(&route_21, our_payment_hash_21, &Some(our_payment_secret_21)).unwrap();
1757 check_added_monitors!(nodes[0], 0);
1758 let events = nodes[0].node.get_and_clear_pending_events();
1759 assert_eq!(events.len(), 0);
1761 // test with outbound holding cell amount > 0
1763 let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], recv_value_22+1);
1764 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
1765 assert!(regex::Regex::new(r"Cannot send value that would put our balance under counterparty-announced channel reserve value \(\d+\)").unwrap().is_match(err)));
1766 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1767 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);
1770 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);
1771 // this will also stuck in the holding cell
1772 nodes[0].node.send_payment(&route_22, our_payment_hash_22, &Some(our_payment_secret_22)).unwrap();
1773 check_added_monitors!(nodes[0], 0);
1774 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
1775 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1777 // flush the pending htlc
1778 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event_1.commitment_msg);
1779 let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1780 check_added_monitors!(nodes[1], 1);
1782 // the pending htlc should be promoted to committed
1783 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_revoke_and_ack);
1784 check_added_monitors!(nodes[0], 1);
1785 let commitment_update_2 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1787 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &as_commitment_signed);
1788 let bs_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1789 // No commitment_signed so get_event_msg's assert(len == 1) passes
1790 check_added_monitors!(nodes[0], 1);
1792 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &bs_revoke_and_ack);
1793 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1794 check_added_monitors!(nodes[1], 1);
1796 let events = nodes[1].node.get_and_clear_pending_events();
1797 expect_pending_htlcs_forwardable!(nodes[1], events);
1799 let ref payment_event_11 = expect_forward!(nodes[1]);
1800 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_11.msgs[0]);
1801 commitment_signed_dance!(nodes[2], nodes[1], payment_event_11.commitment_msg, false);
1803 let events = nodes[2].node.get_and_clear_pending_events();
1804 expect_pending_htlcs_forwardable!(nodes[2], events);
1805 expect_payment_received!(nodes[2], our_payment_hash_1, our_payment_secret_1, recv_value_1);
1807 // flush the htlcs in the holding cell
1808 assert_eq!(commitment_update_2.update_add_htlcs.len(), 2);
1809 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &commitment_update_2.update_add_htlcs[0]);
1810 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &commitment_update_2.update_add_htlcs[1]);
1811 commitment_signed_dance!(nodes[1], nodes[0], &commitment_update_2.commitment_signed, false);
1812 let events = nodes[1].node.get_and_clear_pending_events();
1813 expect_pending_htlcs_forwardable!(nodes[1], events);
1815 let ref payment_event_3 = expect_forward!(nodes[1]);
1816 assert_eq!(payment_event_3.msgs.len(), 2);
1817 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_3.msgs[0]);
1818 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_3.msgs[1]);
1820 commitment_signed_dance!(nodes[2], nodes[1], &payment_event_3.commitment_msg, false);
1821 let events = nodes[2].node.get_and_clear_pending_events();
1822 expect_pending_htlcs_forwardable!(nodes[2], events);
1824 let events = nodes[2].node.get_and_clear_pending_events();
1825 assert_eq!(events.len(), 2);
1827 Event::PaymentReceived { ref payment_hash, ref purpose, amt } => {
1828 assert_eq!(our_payment_hash_21, *payment_hash);
1829 assert_eq!(recv_value_21, amt);
1831 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
1832 assert!(payment_preimage.is_none());
1833 assert_eq!(our_payment_secret_21, *payment_secret);
1835 _ => panic!("expected PaymentPurpose::InvoicePayment")
1838 _ => panic!("Unexpected event"),
1841 Event::PaymentReceived { ref payment_hash, ref purpose, amt } => {
1842 assert_eq!(our_payment_hash_22, *payment_hash);
1843 assert_eq!(recv_value_22, amt);
1845 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
1846 assert!(payment_preimage.is_none());
1847 assert_eq!(our_payment_secret_22, *payment_secret);
1849 _ => panic!("expected PaymentPurpose::InvoicePayment")
1852 _ => panic!("Unexpected event"),
1855 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_1);
1856 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_21);
1857 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_22);
1859 let commit_tx_fee_0_htlcs = 2*commit_tx_fee_msat(feerate, 1);
1860 let recv_value_3 = commit_tx_fee_2_htlcs - commit_tx_fee_0_htlcs - total_fee_msat;
1861 send_payment(&nodes[0], &vec![&nodes[1], &nodes[2]][..], recv_value_3);
1863 let commit_tx_fee_1_htlc = 2*commit_tx_fee_msat(feerate, 1 + 1);
1864 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);
1865 let stat0 = get_channel_value_stat!(nodes[0], chan_1.2);
1866 assert_eq!(stat0.value_to_self_msat, expected_value_to_self);
1867 assert_eq!(stat0.value_to_self_msat, stat0.channel_reserve_msat + commit_tx_fee_1_htlc);
1869 let stat2 = get_channel_value_stat!(nodes[2], chan_2.2);
1870 assert_eq!(stat2.value_to_self_msat, stat22.value_to_self_msat + recv_value_1 + recv_value_21 + recv_value_22 + recv_value_3);
1874 fn channel_reserve_in_flight_removes() {
1875 // In cases where one side claims an HTLC, it thinks it has additional available funds that it
1876 // can send to its counterparty, but due to update ordering, the other side may not yet have
1877 // considered those HTLCs fully removed.
1878 // This tests that we don't count HTLCs which will not be included in the next remote
1879 // commitment transaction towards the reserve value (as it implies no commitment transaction
1880 // will be generated which violates the remote reserve value).
1881 // This was broken previously, and discovered by the chanmon_fail_consistency fuzz test.
1883 // * route two HTLCs from A to B (note that, at a high level, this test is checking that, when
1884 // you consider the values of both of these HTLCs, B may not send an HTLC back to A, but if
1885 // you only consider the value of the first HTLC, it may not),
1886 // * start routing a third HTLC from A to B,
1887 // * claim the first two HTLCs (though B will generate an update_fulfill for one, and put
1888 // the other claim in its holding cell, as it immediately goes into AwaitingRAA),
1889 // * deliver the first fulfill from B
1890 // * deliver the update_add and an RAA from A, resulting in B freeing the second holding cell
1892 // * deliver A's response CS and RAA.
1893 // This results in A having the second HTLC in AwaitingRemovedRemoteRevoke, but B having
1894 // removed it fully. B now has the push_msat plus the first two HTLCs in value.
1895 // * Now B happily sends another HTLC, potentially violating its reserve value from A's point
1896 // of view (if A counts the AwaitingRemovedRemoteRevoke HTLC).
1897 let chanmon_cfgs = create_chanmon_cfgs(2);
1898 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1899 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1900 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1901 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
1902 let logger = test_utils::TestLogger::new();
1904 let b_chan_values = get_channel_value_stat!(nodes[1], chan_1.2);
1905 // Route the first two HTLCs.
1906 let (payment_preimage_1, _, _) = route_payment(&nodes[0], &[&nodes[1]], b_chan_values.channel_reserve_msat - b_chan_values.value_to_self_msat - 10000);
1907 let (payment_preimage_2, _, _) = route_payment(&nodes[0], &[&nodes[1]], 20000);
1909 // Start routing the third HTLC (this is just used to get everyone in the right state).
1910 let (payment_preimage_3, payment_hash_3, payment_secret_3) = get_payment_preimage_hash!(nodes[1]);
1912 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
1913 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();
1914 nodes[0].node.send_payment(&route, payment_hash_3, &Some(payment_secret_3)).unwrap();
1915 check_added_monitors!(nodes[0], 1);
1916 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1917 assert_eq!(events.len(), 1);
1918 SendEvent::from_event(events.remove(0))
1921 // Now claim both of the first two HTLCs on B's end, putting B in AwaitingRAA and generating an
1922 // initial fulfill/CS.
1923 assert!(nodes[1].node.claim_funds(payment_preimage_1));
1924 check_added_monitors!(nodes[1], 1);
1925 let bs_removes = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1927 // This claim goes in B's holding cell, allowing us to have a pending B->A RAA which does not
1928 // remove the second HTLC when we send the HTLC back from B to A.
1929 assert!(nodes[1].node.claim_funds(payment_preimage_2));
1930 check_added_monitors!(nodes[1], 1);
1931 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1933 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_removes.update_fulfill_htlcs[0]);
1934 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_removes.commitment_signed);
1935 check_added_monitors!(nodes[0], 1);
1936 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1937 let events = nodes[0].node.get_and_clear_pending_events();
1938 expect_payment_sent!(nodes[0], payment_preimage_1, events);
1940 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_1.msgs[0]);
1941 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &send_1.commitment_msg);
1942 check_added_monitors!(nodes[1], 1);
1943 // B is already AwaitingRAA, so cant generate a CS here
1944 let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
1946 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1947 check_added_monitors!(nodes[1], 1);
1948 let bs_cs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1950 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
1951 check_added_monitors!(nodes[0], 1);
1952 let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1954 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
1955 check_added_monitors!(nodes[1], 1);
1956 let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
1958 // The second HTLCis removed, but as A is in AwaitingRAA it can't generate a CS here, so the
1959 // RAA that B generated above doesn't fully resolve the second HTLC from A's point of view.
1960 // However, the RAA A generates here *does* fully resolve the HTLC from B's point of view (as A
1961 // can no longer broadcast a commitment transaction with it and B has the preimage so can go
1962 // on-chain as necessary).
1963 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_cs.update_fulfill_htlcs[0]);
1964 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_cs.commitment_signed);
1965 check_added_monitors!(nodes[0], 1);
1966 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1967 let events = nodes[0].node.get_and_clear_pending_events();
1968 expect_payment_sent!(nodes[0], payment_preimage_2, events);
1970 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1971 check_added_monitors!(nodes[1], 1);
1972 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1974 let events = nodes[1].node.get_and_clear_pending_events();
1975 expect_pending_htlcs_forwardable!(nodes[1], events);
1976 expect_payment_received!(nodes[1], payment_hash_3, payment_secret_3, 100000);
1978 // Note that as this RAA was generated before the delivery of the update_fulfill it shouldn't
1979 // resolve the second HTLC from A's point of view.
1980 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
1981 check_added_monitors!(nodes[0], 1);
1982 let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1984 // Now that B doesn't have the second RAA anymore, but A still does, send a payment from B back
1985 // to A to ensure that A doesn't count the almost-removed HTLC in update_add processing.
1986 let (payment_preimage_4, payment_hash_4, payment_secret_4) = get_payment_preimage_hash!(nodes[0]);
1988 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
1989 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();
1990 nodes[1].node.send_payment(&route, payment_hash_4, &Some(payment_secret_4)).unwrap();
1991 check_added_monitors!(nodes[1], 1);
1992 let mut events = nodes[1].node.get_and_clear_pending_msg_events();
1993 assert_eq!(events.len(), 1);
1994 SendEvent::from_event(events.remove(0))
1997 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &send_2.msgs[0]);
1998 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &send_2.commitment_msg);
1999 check_added_monitors!(nodes[0], 1);
2000 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2002 // Now just resolve all the outstanding messages/HTLCs for completeness...
2004 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
2005 check_added_monitors!(nodes[1], 1);
2006 let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2008 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
2009 check_added_monitors!(nodes[1], 1);
2011 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2012 check_added_monitors!(nodes[0], 1);
2013 let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2015 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
2016 check_added_monitors!(nodes[1], 1);
2017 let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2019 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2020 check_added_monitors!(nodes[0], 1);
2022 let events = nodes[0].node.get_and_clear_pending_events();
2023 expect_pending_htlcs_forwardable!(nodes[0], events);
2024 expect_payment_received!(nodes[0], payment_hash_4, payment_secret_4, 10000);
2026 claim_payment(&nodes[1], &[&nodes[0]], payment_preimage_4);
2027 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_3);
2031 fn channel_monitor_network_test() {
2032 // Simple test which builds a network of ChannelManagers, connects them to each other, and
2033 // tests that ChannelMonitor is able to recover from various states.
2034 let chanmon_cfgs = create_chanmon_cfgs(5);
2035 let node_cfgs = create_node_cfgs(5, &chanmon_cfgs);
2036 let node_chanmgrs = create_node_chanmgrs(5, &node_cfgs, &[None, None, None, None, None]);
2037 let nodes = create_network(5, &node_cfgs, &node_chanmgrs);
2039 // Create some initial channels
2040 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2041 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
2042 let chan_3 = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
2043 let chan_4 = create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::known(), InitFeatures::known());
2045 // Make sure all nodes are at the same starting height
2046 connect_blocks(&nodes[0], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[0].best_block_info().1);
2047 connect_blocks(&nodes[1], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[1].best_block_info().1);
2048 connect_blocks(&nodes[2], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[2].best_block_info().1);
2049 connect_blocks(&nodes[3], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[3].best_block_info().1);
2050 connect_blocks(&nodes[4], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[4].best_block_info().1);
2052 // Rebalance the network a bit by relaying one payment through all the channels...
2053 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
2054 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
2055 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
2056 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
2058 // Simple case with no pending HTLCs:
2059 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), true);
2060 check_added_monitors!(nodes[1], 1);
2061 check_closed_broadcast!(nodes[1], false);
2063 let mut node_txn = test_txn_broadcast(&nodes[1], &chan_1, None, HTLCType::NONE);
2064 assert_eq!(node_txn.len(), 1);
2065 mine_transaction(&nodes[0], &node_txn[0]);
2066 check_added_monitors!(nodes[0], 1);
2067 test_txn_broadcast(&nodes[0], &chan_1, None, HTLCType::NONE);
2069 check_closed_broadcast!(nodes[0], true);
2070 assert_eq!(nodes[0].node.list_channels().len(), 0);
2071 assert_eq!(nodes[1].node.list_channels().len(), 1);
2072 check_closed_event!(nodes[0], 1);
2073 check_closed_event!(nodes[1], 1);
2075 // One pending HTLC is discarded by the force-close:
2076 let payment_preimage_1 = route_payment(&nodes[1], &vec!(&nodes[2], &nodes[3])[..], 3000000).0;
2078 // Simple case of one pending HTLC to HTLC-Timeout (note that the HTLC-Timeout is not
2079 // broadcasted until we reach the timelock time).
2080 nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id(), true);
2081 check_closed_broadcast!(nodes[1], false);
2082 check_added_monitors!(nodes[1], 1);
2084 let mut node_txn = test_txn_broadcast(&nodes[1], &chan_2, None, HTLCType::NONE);
2085 connect_blocks(&nodes[1], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + MIN_CLTV_EXPIRY_DELTA as u32 + 1);
2086 test_txn_broadcast(&nodes[1], &chan_2, None, HTLCType::TIMEOUT);
2087 mine_transaction(&nodes[2], &node_txn[0]);
2088 check_added_monitors!(nodes[2], 1);
2089 test_txn_broadcast(&nodes[2], &chan_2, None, HTLCType::NONE);
2091 check_closed_broadcast!(nodes[2], true);
2092 assert_eq!(nodes[1].node.list_channels().len(), 0);
2093 assert_eq!(nodes[2].node.list_channels().len(), 1);
2094 check_closed_event!(nodes[1], 1);
2095 check_closed_event!(nodes[2], 1);
2097 macro_rules! claim_funds {
2098 ($node: expr, $prev_node: expr, $preimage: expr) => {
2100 assert!($node.node.claim_funds($preimage));
2101 check_added_monitors!($node, 1);
2103 let events = $node.node.get_and_clear_pending_msg_events();
2104 assert_eq!(events.len(), 1);
2106 MessageSendEvent::UpdateHTLCs { ref node_id, updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fail_htlcs, .. } } => {
2107 assert!(update_add_htlcs.is_empty());
2108 assert!(update_fail_htlcs.is_empty());
2109 assert_eq!(*node_id, $prev_node.node.get_our_node_id());
2111 _ => panic!("Unexpected event"),
2117 // nodes[3] gets the preimage, but nodes[2] already disconnected, resulting in a nodes[2]
2118 // HTLC-Timeout and a nodes[3] claim against it (+ its own announces)
2119 nodes[2].node.peer_disconnected(&nodes[3].node.get_our_node_id(), true);
2120 check_added_monitors!(nodes[2], 1);
2121 check_closed_broadcast!(nodes[2], false);
2122 let node2_commitment_txid;
2124 let node_txn = test_txn_broadcast(&nodes[2], &chan_3, None, HTLCType::NONE);
2125 connect_blocks(&nodes[2], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + MIN_CLTV_EXPIRY_DELTA as u32 + 1);
2126 test_txn_broadcast(&nodes[2], &chan_3, None, HTLCType::TIMEOUT);
2127 node2_commitment_txid = node_txn[0].txid();
2129 // Claim the payment on nodes[3], giving it knowledge of the preimage
2130 claim_funds!(nodes[3], nodes[2], payment_preimage_1);
2131 mine_transaction(&nodes[3], &node_txn[0]);
2132 check_added_monitors!(nodes[3], 1);
2133 check_preimage_claim(&nodes[3], &node_txn);
2135 check_closed_broadcast!(nodes[3], true);
2136 assert_eq!(nodes[2].node.list_channels().len(), 0);
2137 assert_eq!(nodes[3].node.list_channels().len(), 1);
2138 check_closed_event!(nodes[2], 1);
2139 check_closed_event!(nodes[3], 1);
2141 // Drop the ChannelMonitor for the previous channel to avoid it broadcasting transactions and
2142 // confusing us in the following tests.
2143 let chan_3_mon = nodes[3].chain_monitor.chain_monitor.monitors.write().unwrap().remove(&OutPoint { txid: chan_3.3.txid(), index: 0 }).unwrap();
2145 // One pending HTLC to time out:
2146 let payment_preimage_2 = route_payment(&nodes[3], &vec!(&nodes[4])[..], 3000000).0;
2147 // CLTV expires at TEST_FINAL_CLTV + 1 (current height) + 1 (added in send_payment for
2150 let (close_chan_update_1, close_chan_update_2) = {
2151 connect_blocks(&nodes[3], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + 1);
2152 let events = nodes[3].node.get_and_clear_pending_msg_events();
2153 assert_eq!(events.len(), 2);
2154 let close_chan_update_1 = match events[0] {
2155 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
2158 _ => panic!("Unexpected event"),
2161 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { .. }, node_id } => {
2162 assert_eq!(node_id, nodes[4].node.get_our_node_id());
2164 _ => panic!("Unexpected event"),
2166 check_added_monitors!(nodes[3], 1);
2168 // Clear bumped claiming txn spending node 2 commitment tx. Bumped txn are generated after reaching some height timer.
2170 let mut node_txn = nodes[3].tx_broadcaster.txn_broadcasted.lock().unwrap();
2171 node_txn.retain(|tx| {
2172 if tx.input[0].previous_output.txid == node2_commitment_txid {
2178 let node_txn = test_txn_broadcast(&nodes[3], &chan_4, None, HTLCType::TIMEOUT);
2180 // Claim the payment on nodes[4], giving it knowledge of the preimage
2181 claim_funds!(nodes[4], nodes[3], payment_preimage_2);
2183 connect_blocks(&nodes[4], TEST_FINAL_CLTV - CLTV_CLAIM_BUFFER + 2);
2184 let events = nodes[4].node.get_and_clear_pending_msg_events();
2185 assert_eq!(events.len(), 2);
2186 let close_chan_update_2 = match events[0] {
2187 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
2190 _ => panic!("Unexpected event"),
2193 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { .. }, node_id } => {
2194 assert_eq!(node_id, nodes[3].node.get_our_node_id());
2196 _ => panic!("Unexpected event"),
2198 check_added_monitors!(nodes[4], 1);
2199 test_txn_broadcast(&nodes[4], &chan_4, None, HTLCType::SUCCESS);
2201 mine_transaction(&nodes[4], &node_txn[0]);
2202 check_preimage_claim(&nodes[4], &node_txn);
2203 (close_chan_update_1, close_chan_update_2)
2205 nodes[3].net_graph_msg_handler.handle_channel_update(&close_chan_update_2).unwrap();
2206 nodes[4].net_graph_msg_handler.handle_channel_update(&close_chan_update_1).unwrap();
2207 assert_eq!(nodes[3].node.list_channels().len(), 0);
2208 assert_eq!(nodes[4].node.list_channels().len(), 0);
2210 nodes[3].chain_monitor.chain_monitor.monitors.write().unwrap().insert(OutPoint { txid: chan_3.3.txid(), index: 0 }, chan_3_mon);
2211 check_closed_event!(nodes[3], 1);
2212 check_closed_event!(nodes[4], 1);
2216 fn test_justice_tx() {
2217 // Test justice txn built on revoked HTLC-Success tx, against both sides
2218 let mut alice_config = UserConfig::default();
2219 alice_config.channel_options.announced_channel = true;
2220 alice_config.peer_channel_config_limits.force_announced_channel_preference = false;
2221 alice_config.own_channel_config.our_to_self_delay = 6 * 24 * 5;
2222 let mut bob_config = UserConfig::default();
2223 bob_config.channel_options.announced_channel = true;
2224 bob_config.peer_channel_config_limits.force_announced_channel_preference = false;
2225 bob_config.own_channel_config.our_to_self_delay = 6 * 24 * 3;
2226 let user_cfgs = [Some(alice_config), Some(bob_config)];
2227 let mut chanmon_cfgs = create_chanmon_cfgs(2);
2228 chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
2229 chanmon_cfgs[1].keys_manager.disable_revocation_policy_check = true;
2230 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2231 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &user_cfgs);
2232 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2233 // Create some new channels:
2234 let chan_5 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2236 // A pending HTLC which will be revoked:
2237 let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2238 // Get the will-be-revoked local txn from nodes[0]
2239 let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_5.2);
2240 assert_eq!(revoked_local_txn.len(), 2); // First commitment tx, then HTLC tx
2241 assert_eq!(revoked_local_txn[0].input.len(), 1);
2242 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_5.3.txid());
2243 assert_eq!(revoked_local_txn[0].output.len(), 2); // Only HTLC and output back to 0 are present
2244 assert_eq!(revoked_local_txn[1].input.len(), 1);
2245 assert_eq!(revoked_local_txn[1].input[0].previous_output.txid, revoked_local_txn[0].txid());
2246 assert_eq!(revoked_local_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC-Timeout
2247 // Revoke the old state
2248 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_3);
2251 mine_transaction(&nodes[1], &revoked_local_txn[0]);
2253 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2254 assert_eq!(node_txn.len(), 2); // ChannelMonitor: penalty tx, ChannelManager: local commitment tx
2255 assert_eq!(node_txn[0].input.len(), 2); // We should claim the revoked output and the HTLC output
2257 check_spends!(node_txn[0], revoked_local_txn[0]);
2258 node_txn.swap_remove(0);
2259 node_txn.truncate(1);
2261 check_added_monitors!(nodes[1], 1);
2262 check_closed_event!(nodes[1], 1);
2263 test_txn_broadcast(&nodes[1], &chan_5, None, HTLCType::NONE);
2265 mine_transaction(&nodes[0], &revoked_local_txn[0]);
2266 connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
2267 // Verify broadcast of revoked HTLC-timeout
2268 let node_txn = test_txn_broadcast(&nodes[0], &chan_5, Some(revoked_local_txn[0].clone()), HTLCType::TIMEOUT);
2269 check_added_monitors!(nodes[0], 1);
2270 check_closed_event!(nodes[0], 1);
2271 // Broadcast revoked HTLC-timeout on node 1
2272 mine_transaction(&nodes[1], &node_txn[1]);
2273 test_revoked_htlc_claim_txn_broadcast(&nodes[1], node_txn[1].clone(), revoked_local_txn[0].clone());
2275 get_announce_close_broadcast_events(&nodes, 0, 1);
2277 assert_eq!(nodes[0].node.list_channels().len(), 0);
2278 assert_eq!(nodes[1].node.list_channels().len(), 0);
2280 // We test justice_tx build by A on B's revoked HTLC-Success tx
2281 // Create some new channels:
2282 let chan_6 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2284 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2288 // A pending HTLC which will be revoked:
2289 let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2290 // Get the will-be-revoked local txn from B
2291 let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan_6.2);
2292 assert_eq!(revoked_local_txn.len(), 1); // Only commitment tx
2293 assert_eq!(revoked_local_txn[0].input.len(), 1);
2294 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_6.3.txid());
2295 assert_eq!(revoked_local_txn[0].output.len(), 2); // Only HTLC and output back to A are present
2296 // Revoke the old state
2297 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_4);
2299 mine_transaction(&nodes[0], &revoked_local_txn[0]);
2301 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
2302 assert_eq!(node_txn.len(), 2); //ChannelMonitor: penalty tx, ChannelManager: local commitment tx
2303 assert_eq!(node_txn[0].input.len(), 1); // We claim the received HTLC output
2305 check_spends!(node_txn[0], revoked_local_txn[0]);
2306 node_txn.swap_remove(0);
2308 check_added_monitors!(nodes[0], 1);
2309 test_txn_broadcast(&nodes[0], &chan_6, None, HTLCType::NONE);
2311 mine_transaction(&nodes[1], &revoked_local_txn[0]);
2312 check_closed_event!(nodes[1], 1);
2313 let node_txn = test_txn_broadcast(&nodes[1], &chan_6, Some(revoked_local_txn[0].clone()), HTLCType::SUCCESS);
2314 check_added_monitors!(nodes[1], 1);
2315 mine_transaction(&nodes[0], &node_txn[1]);
2316 check_closed_event!(nodes[0], 1);
2317 test_revoked_htlc_claim_txn_broadcast(&nodes[0], node_txn[1].clone(), revoked_local_txn[0].clone());
2319 get_announce_close_broadcast_events(&nodes, 0, 1);
2320 assert_eq!(nodes[0].node.list_channels().len(), 0);
2321 assert_eq!(nodes[1].node.list_channels().len(), 0);
2325 fn revoked_output_claim() {
2326 // Simple test to ensure a node will claim a revoked output when a stale remote commitment
2327 // transaction is broadcast by its counterparty
2328 let chanmon_cfgs = create_chanmon_cfgs(2);
2329 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2330 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2331 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2332 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2333 // node[0] is gonna to revoke an old state thus node[1] should be able to claim the revoked output
2334 let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2335 assert_eq!(revoked_local_txn.len(), 1);
2336 // Only output is the full channel value back to nodes[0]:
2337 assert_eq!(revoked_local_txn[0].output.len(), 1);
2338 // Send a payment through, updating everyone's latest commitment txn
2339 send_payment(&nodes[0], &vec!(&nodes[1])[..], 5000000);
2341 // Inform nodes[1] that nodes[0] broadcast a stale tx
2342 mine_transaction(&nodes[1], &revoked_local_txn[0]);
2343 check_added_monitors!(nodes[1], 1);
2344 check_closed_event!(nodes[1], 1);
2345 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2346 assert_eq!(node_txn.len(), 2); // ChannelMonitor: justice tx against revoked to_local output, ChannelManager: local commitment tx
2348 check_spends!(node_txn[0], revoked_local_txn[0]);
2349 check_spends!(node_txn[1], chan_1.3);
2351 // Inform nodes[0] that a watchtower cheated on its behalf, so it will force-close the chan
2352 mine_transaction(&nodes[0], &revoked_local_txn[0]);
2353 get_announce_close_broadcast_events(&nodes, 0, 1);
2354 check_added_monitors!(nodes[0], 1);
2355 check_closed_event!(nodes[0], 1);
2359 fn claim_htlc_outputs_shared_tx() {
2360 // Node revoked old state, htlcs haven't time out yet, claim them in shared justice tx
2361 let mut chanmon_cfgs = create_chanmon_cfgs(2);
2362 chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
2363 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2364 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2365 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2367 // Create some new channel:
2368 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2370 // Rebalance the network to generate htlc in the two directions
2371 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
2372 // 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
2373 let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2374 let (_payment_preimage_2, payment_hash_2, _) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000);
2376 // Get the will-be-revoked local txn from node[0]
2377 let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2378 assert_eq!(revoked_local_txn.len(), 2); // commitment tx + 1 HTLC-Timeout tx
2379 assert_eq!(revoked_local_txn[0].input.len(), 1);
2380 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
2381 assert_eq!(revoked_local_txn[1].input.len(), 1);
2382 assert_eq!(revoked_local_txn[1].input[0].previous_output.txid, revoked_local_txn[0].txid());
2383 assert_eq!(revoked_local_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC-Timeout
2384 check_spends!(revoked_local_txn[1], revoked_local_txn[0]);
2386 //Revoke the old state
2387 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_1);
2390 mine_transaction(&nodes[0], &revoked_local_txn[0]);
2391 check_added_monitors!(nodes[0], 1);
2392 check_closed_event!(nodes[0], 1);
2393 mine_transaction(&nodes[1], &revoked_local_txn[0]);
2394 check_added_monitors!(nodes[1], 1);
2395 check_closed_event!(nodes[1], 1);
2396 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
2397 let events = nodes[1].node.get_and_clear_pending_events();
2398 expect_payment_failed!(nodes[1], events, payment_hash_2, true);
2400 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2401 assert_eq!(node_txn.len(), 2); // ChannelMonitor: penalty tx, ChannelManager: local commitment
2403 assert_eq!(node_txn[0].input.len(), 3); // Claim the revoked output + both revoked HTLC outputs
2404 check_spends!(node_txn[0], revoked_local_txn[0]);
2406 let mut witness_lens = BTreeSet::new();
2407 witness_lens.insert(node_txn[0].input[0].witness.last().unwrap().len());
2408 witness_lens.insert(node_txn[0].input[1].witness.last().unwrap().len());
2409 witness_lens.insert(node_txn[0].input[2].witness.last().unwrap().len());
2410 assert_eq!(witness_lens.len(), 3);
2411 assert_eq!(*witness_lens.iter().skip(0).next().unwrap(), 77); // revoked to_local
2412 assert_eq!(*witness_lens.iter().skip(1).next().unwrap(), OFFERED_HTLC_SCRIPT_WEIGHT); // revoked offered HTLC
2413 assert_eq!(*witness_lens.iter().skip(2).next().unwrap(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // revoked received HTLC
2415 // Next nodes[1] broadcasts its current local tx state:
2416 assert_eq!(node_txn[1].input.len(), 1);
2417 assert_eq!(node_txn[1].input[0].previous_output.txid, chan_1.3.txid()); //Spending funding tx unique txouput, tx broadcasted by ChannelManager
2419 get_announce_close_broadcast_events(&nodes, 0, 1);
2420 assert_eq!(nodes[0].node.list_channels().len(), 0);
2421 assert_eq!(nodes[1].node.list_channels().len(), 0);
2425 fn claim_htlc_outputs_single_tx() {
2426 // Node revoked old state, htlcs have timed out, claim each of them in separated justice tx
2427 let mut chanmon_cfgs = create_chanmon_cfgs(2);
2428 chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
2429 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2430 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2431 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2433 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2435 // Rebalance the network to generate htlc in the two directions
2436 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
2437 // 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
2438 // time as two different claim transactions as we're gonna to timeout htlc with given a high current height
2439 let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2440 let (_payment_preimage_2, payment_hash_2, _payment_secret_2) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000);
2442 // Get the will-be-revoked local txn from node[0]
2443 let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2445 //Revoke the old state
2446 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_1);
2449 confirm_transaction_at(&nodes[0], &revoked_local_txn[0], 100);
2450 check_added_monitors!(nodes[0], 1);
2451 confirm_transaction_at(&nodes[1], &revoked_local_txn[0], 100);
2452 check_added_monitors!(nodes[1], 1);
2453 check_closed_event!(nodes[1], 1);
2454 let mut events = nodes[0].node.get_and_clear_pending_events();
2455 expect_pending_htlcs_forwardable_ignore!(nodes[0], events[0..1]);
2457 Event::ChannelClosed { .. } => {}
2458 _ => panic!("Unexpected event"),
2461 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
2462 let events = nodes[1].node.get_and_clear_pending_events();
2463 expect_payment_failed!(nodes[1], events, payment_hash_2, true);
2465 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2466 assert_eq!(node_txn.len(), 9);
2467 // ChannelMonitor: justice tx revoked offered htlc, justice tx revoked received htlc, justice tx revoked to_local (3)
2468 // ChannelManager: local commmitment + local HTLC-timeout (2)
2469 // 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)
2470 // ChannelMonitor: local commitment + local HTLC-timeout (2)
2472 // Check the pair local commitment and HTLC-timeout broadcast due to HTLC expiration
2473 assert_eq!(node_txn[0].input.len(), 1);
2474 check_spends!(node_txn[0], chan_1.3);
2475 assert_eq!(node_txn[1].input.len(), 1);
2476 let witness_script = node_txn[1].input[0].witness.last().unwrap();
2477 assert_eq!(witness_script.len(), OFFERED_HTLC_SCRIPT_WEIGHT); //Spending an offered htlc output
2478 check_spends!(node_txn[1], node_txn[0]);
2480 // Justice transactions are indices 1-2-4
2481 assert_eq!(node_txn[2].input.len(), 1);
2482 assert_eq!(node_txn[3].input.len(), 1);
2483 assert_eq!(node_txn[4].input.len(), 1);
2485 check_spends!(node_txn[2], revoked_local_txn[0]);
2486 check_spends!(node_txn[3], revoked_local_txn[0]);
2487 check_spends!(node_txn[4], revoked_local_txn[0]);
2489 let mut witness_lens = BTreeSet::new();
2490 witness_lens.insert(node_txn[2].input[0].witness.last().unwrap().len());
2491 witness_lens.insert(node_txn[3].input[0].witness.last().unwrap().len());
2492 witness_lens.insert(node_txn[4].input[0].witness.last().unwrap().len());
2493 assert_eq!(witness_lens.len(), 3);
2494 assert_eq!(*witness_lens.iter().skip(0).next().unwrap(), 77); // revoked to_local
2495 assert_eq!(*witness_lens.iter().skip(1).next().unwrap(), OFFERED_HTLC_SCRIPT_WEIGHT); // revoked offered HTLC
2496 assert_eq!(*witness_lens.iter().skip(2).next().unwrap(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // revoked received HTLC
2498 get_announce_close_broadcast_events(&nodes, 0, 1);
2499 assert_eq!(nodes[0].node.list_channels().len(), 0);
2500 assert_eq!(nodes[1].node.list_channels().len(), 0);
2504 fn test_htlc_on_chain_success() {
2505 // Test that in case of a unilateral close onchain, we detect the state of output and pass
2506 // the preimage backward accordingly. So here we test that ChannelManager is
2507 // broadcasting the right event to other nodes in payment path.
2508 // We test with two HTLCs simultaneously as that was not handled correctly in the past.
2509 // A --------------------> B ----------------------> C (preimage)
2510 // First, C should claim the HTLC outputs via HTLC-Success when its own latest local
2511 // commitment transaction was broadcast.
2512 // Then, B should learn the preimage from said transactions, attempting to claim backwards
2514 // B should be able to claim via preimage if A then broadcasts its local tx.
2515 // Finally, when A sees B's latest local commitment transaction it should be able to claim
2516 // the HTLC outputs via the preimage it learned (which, once confirmed should generate a
2517 // PaymentSent event).
2519 let chanmon_cfgs = create_chanmon_cfgs(3);
2520 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2521 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2522 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2524 // Create some initial channels
2525 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2526 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
2528 // Ensure all nodes are at the same height
2529 let node_max_height = nodes.iter().map(|node| node.blocks.lock().unwrap().len()).max().unwrap() as u32;
2530 connect_blocks(&nodes[0], node_max_height - nodes[0].best_block_info().1);
2531 connect_blocks(&nodes[1], node_max_height - nodes[1].best_block_info().1);
2532 connect_blocks(&nodes[2], node_max_height - nodes[2].best_block_info().1);
2534 // Rebalance the network a bit by relaying one payment through all the channels...
2535 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
2536 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
2538 let (our_payment_preimage, _payment_hash, _payment_secret) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2539 let (our_payment_preimage_2, _payment_hash_2, _payment_secret_2) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2541 // Broadcast legit commitment tx from C on B's chain
2542 // Broadcast HTLC Success transaction by C on received output from C's commitment tx on B's chain
2543 let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
2544 assert_eq!(commitment_tx.len(), 1);
2545 check_spends!(commitment_tx[0], chan_2.3);
2546 nodes[2].node.claim_funds(our_payment_preimage);
2547 nodes[2].node.claim_funds(our_payment_preimage_2);
2548 check_added_monitors!(nodes[2], 2);
2549 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2550 assert!(updates.update_add_htlcs.is_empty());
2551 assert!(updates.update_fail_htlcs.is_empty());
2552 assert!(updates.update_fail_malformed_htlcs.is_empty());
2553 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
2555 mine_transaction(&nodes[2], &commitment_tx[0]);
2556 check_closed_broadcast!(nodes[2], true);
2557 check_added_monitors!(nodes[2], 1);
2558 check_closed_event!(nodes[2], 1);
2559 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)
2560 assert_eq!(node_txn.len(), 5);
2561 assert_eq!(node_txn[0], node_txn[3]);
2562 assert_eq!(node_txn[1], node_txn[4]);
2563 assert_eq!(node_txn[2], commitment_tx[0]);
2564 check_spends!(node_txn[0], commitment_tx[0]);
2565 check_spends!(node_txn[1], commitment_tx[0]);
2566 assert_eq!(node_txn[0].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2567 assert_eq!(node_txn[1].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2568 assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2569 assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2570 assert_eq!(node_txn[0].lock_time, 0);
2571 assert_eq!(node_txn[1].lock_time, 0);
2573 // Verify that B's ChannelManager is able to extract preimage from HTLC Success tx and pass it backward
2574 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2575 connect_block(&nodes[1], &Block { header, txdata: node_txn});
2576 connect_blocks(&nodes[1], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
2578 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
2579 assert_eq!(added_monitors.len(), 1);
2580 assert_eq!(added_monitors[0].0.txid, chan_2.3.txid());
2581 added_monitors.clear();
2583 let forwarded_events = nodes[1].node.get_and_clear_pending_events();
2584 assert_eq!(forwarded_events.len(), 2);
2585 if let Event::PaymentForwarded { fee_earned_msat: Some(1000), claim_from_onchain_tx: true } = forwarded_events[0] {
2586 } else { panic!(); }
2587 if let Event::PaymentForwarded { fee_earned_msat: Some(1000), claim_from_onchain_tx: true } = forwarded_events[1] {
2588 } else { panic!(); }
2589 let events = nodes[1].node.get_and_clear_pending_msg_events();
2591 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
2592 assert_eq!(added_monitors.len(), 2);
2593 assert_eq!(added_monitors[0].0.txid, chan_1.3.txid());
2594 assert_eq!(added_monitors[1].0.txid, chan_1.3.txid());
2595 added_monitors.clear();
2597 assert_eq!(events.len(), 3);
2599 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
2600 _ => panic!("Unexpected event"),
2603 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { .. }, node_id: _ } => {},
2604 _ => panic!("Unexpected event"),
2608 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, .. } } => {
2609 assert!(update_add_htlcs.is_empty());
2610 assert!(update_fail_htlcs.is_empty());
2611 assert_eq!(update_fulfill_htlcs.len(), 1);
2612 assert!(update_fail_malformed_htlcs.is_empty());
2613 assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
2615 _ => panic!("Unexpected event"),
2617 macro_rules! check_tx_local_broadcast {
2618 ($node: expr, $htlc_offered: expr, $commitment_tx: expr, $chan_tx: expr) => { {
2619 let mut node_txn = $node.tx_broadcaster.txn_broadcasted.lock().unwrap();
2620 assert_eq!(node_txn.len(), 3);
2621 // Node[1]: ChannelManager: 3 (commitment tx, 2*HTLC-Timeout tx), ChannelMonitor: 2 (timeout tx)
2622 // Node[0]: ChannelManager: 3 (commtiemtn tx, 2*HTLC-Timeout tx), ChannelMonitor: 2 HTLC-timeout
2623 check_spends!(node_txn[1], $commitment_tx);
2624 check_spends!(node_txn[2], $commitment_tx);
2625 assert_ne!(node_txn[1].lock_time, 0);
2626 assert_ne!(node_txn[2].lock_time, 0);
2628 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2629 assert_eq!(node_txn[2].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2630 assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2631 assert!(node_txn[2].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2633 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2634 assert_eq!(node_txn[2].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2635 assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2636 assert!(node_txn[2].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2638 check_spends!(node_txn[0], $chan_tx);
2639 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), 71);
2643 // nodes[1] now broadcasts its own local state as a fallback, suggesting an alternate
2644 // commitment transaction with a corresponding HTLC-Timeout transactions, as well as a
2645 // timeout-claim of the output that nodes[2] just claimed via success.
2646 check_tx_local_broadcast!(nodes[1], false, commitment_tx[0], chan_2.3);
2648 // Broadcast legit commitment tx from A on B's chain
2649 // Broadcast preimage tx by B on offered output from A commitment tx on A's chain
2650 let node_a_commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
2651 check_spends!(node_a_commitment_tx[0], chan_1.3);
2652 mine_transaction(&nodes[1], &node_a_commitment_tx[0]);
2653 check_closed_broadcast!(nodes[1], true);
2654 check_added_monitors!(nodes[1], 1);
2655 check_closed_event!(nodes[1], 2);
2656 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
2657 assert_eq!(node_txn.len(), 6); // ChannelManager : 3 (commitment tx + HTLC-Sucess * 2), ChannelMonitor : 3 (HTLC-Success, 2* RBF bumps of above HTLC txn)
2658 let commitment_spend =
2659 if node_txn[0].input[0].previous_output.txid == node_a_commitment_tx[0].txid() {
2660 check_spends!(node_txn[1], commitment_tx[0]);
2661 check_spends!(node_txn[2], commitment_tx[0]);
2662 assert_ne!(node_txn[1].input[0].previous_output.vout, node_txn[2].input[0].previous_output.vout);
2665 check_spends!(node_txn[0], commitment_tx[0]);
2666 check_spends!(node_txn[1], commitment_tx[0]);
2667 assert_ne!(node_txn[0].input[0].previous_output.vout, node_txn[1].input[0].previous_output.vout);
2671 check_spends!(commitment_spend, node_a_commitment_tx[0]);
2672 assert_eq!(commitment_spend.input.len(), 2);
2673 assert_eq!(commitment_spend.input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2674 assert_eq!(commitment_spend.input[1].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2675 assert_eq!(commitment_spend.lock_time, 0);
2676 assert!(commitment_spend.output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2677 check_spends!(node_txn[3], chan_1.3);
2678 assert_eq!(node_txn[3].input[0].witness.clone().last().unwrap().len(), 71);
2679 check_spends!(node_txn[4], node_txn[3]);
2680 check_spends!(node_txn[5], node_txn[3]);
2681 // We don't bother to check that B can claim the HTLC output on its commitment tx here as
2682 // we already checked the same situation with A.
2684 // Verify that A's ChannelManager is able to extract preimage from preimage tx and generate PaymentSent
2685 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2686 connect_block(&nodes[0], &Block { header, txdata: vec![node_a_commitment_tx[0].clone(), commitment_spend.clone()] });
2687 connect_blocks(&nodes[0], TEST_FINAL_CLTV + MIN_CLTV_EXPIRY_DELTA as u32 - 1); // Confirm blocks until the HTLC expires
2688 check_closed_broadcast!(nodes[0], true);
2689 check_added_monitors!(nodes[0], 1);
2690 let events = nodes[0].node.get_and_clear_pending_events();
2691 assert_eq!(events.len(), 3);
2692 let mut first_claimed = false;
2693 for event in events {
2695 Event::PaymentSent { payment_preimage } => {
2696 if payment_preimage == our_payment_preimage {
2697 assert!(!first_claimed);
2698 first_claimed = true;
2700 assert_eq!(payment_preimage, our_payment_preimage_2);
2703 Event::ChannelClosed { .. } => {},
2704 _ => panic!("Unexpected event"),
2707 check_tx_local_broadcast!(nodes[0], true, node_a_commitment_tx[0], chan_1.3);
2710 fn do_test_htlc_on_chain_timeout(connect_style: ConnectStyle) {
2711 // Test that in case of a unilateral close onchain, we detect the state of output and
2712 // timeout the HTLC backward accordingly. So here we test that ChannelManager is
2713 // broadcasting the right event to other nodes in payment path.
2714 // A ------------------> B ----------------------> C (timeout)
2715 // B's commitment tx C's commitment tx
2717 // B's HTLC timeout tx B's timeout tx
2719 let chanmon_cfgs = create_chanmon_cfgs(3);
2720 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2721 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2722 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2723 *nodes[0].connect_style.borrow_mut() = connect_style;
2724 *nodes[1].connect_style.borrow_mut() = connect_style;
2725 *nodes[2].connect_style.borrow_mut() = connect_style;
2727 // Create some intial channels
2728 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2729 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
2731 // Rebalance the network a bit by relaying one payment thorugh all the channels...
2732 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
2733 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
2735 let (_payment_preimage, payment_hash, _payment_secret) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2737 // Broadcast legit commitment tx from C on B's chain
2738 let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
2739 check_spends!(commitment_tx[0], chan_2.3);
2740 nodes[2].node.fail_htlc_backwards(&payment_hash);
2741 check_added_monitors!(nodes[2], 0);
2742 let events = nodes[2].node.get_and_clear_pending_events();
2743 expect_pending_htlcs_forwardable!(nodes[2], events);
2744 check_added_monitors!(nodes[2], 1);
2746 let events = nodes[2].node.get_and_clear_pending_msg_events();
2747 assert_eq!(events.len(), 1);
2749 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, .. } } => {
2750 assert!(update_add_htlcs.is_empty());
2751 assert!(!update_fail_htlcs.is_empty());
2752 assert!(update_fulfill_htlcs.is_empty());
2753 assert!(update_fail_malformed_htlcs.is_empty());
2754 assert_eq!(nodes[1].node.get_our_node_id(), *node_id);
2756 _ => panic!("Unexpected event"),
2758 mine_transaction(&nodes[2], &commitment_tx[0]);
2759 check_closed_broadcast!(nodes[2], true);
2760 check_added_monitors!(nodes[2], 1);
2761 check_closed_event!(nodes[2], 1);
2762 let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 1 (commitment tx)
2763 assert_eq!(node_txn.len(), 1);
2764 check_spends!(node_txn[0], chan_2.3);
2765 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), 71);
2767 // Broadcast timeout transaction by B on received output from C's commitment tx on B's chain
2768 // Verify that B's ChannelManager is able to detect that HTLC is timeout by its own tx and react backward in consequence
2769 connect_blocks(&nodes[1], 200 - nodes[2].best_block_info().1);
2770 mine_transaction(&nodes[1], &commitment_tx[0]);
2771 check_closed_event!(nodes[1], 1);
2774 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2775 assert_eq!(node_txn.len(), 5); // ChannelManager : 2 (commitment tx, HTLC-Timeout tx), ChannelMonitor : 2 (local commitment tx + HTLC-timeout), 1 timeout tx
2776 assert_eq!(node_txn[0], node_txn[3]);
2777 assert_eq!(node_txn[1], node_txn[4]);
2779 check_spends!(node_txn[2], commitment_tx[0]);
2780 assert_eq!(node_txn[2].clone().input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2782 check_spends!(node_txn[0], chan_2.3);
2783 check_spends!(node_txn[1], node_txn[0]);
2784 assert_eq!(node_txn[0].clone().input[0].witness.last().unwrap().len(), 71);
2785 assert_eq!(node_txn[1].clone().input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2787 timeout_tx = node_txn[2].clone();
2791 mine_transaction(&nodes[1], &timeout_tx);
2792 check_added_monitors!(nodes[1], 1);
2793 check_closed_broadcast!(nodes[1], true);
2795 // B will rebroadcast a fee-bumped timeout transaction here.
2796 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
2797 assert_eq!(node_txn.len(), 1);
2798 check_spends!(node_txn[0], commitment_tx[0]);
2801 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
2803 // B may rebroadcast its own holder commitment transaction here, as a safeguard against
2804 // some incredibly unlikely partial-eclipse-attack scenarios. That said, because the
2805 // original commitment_tx[0] (also spending chan_2.3) has reached ANTI_REORG_DELAY B really
2806 // shouldn't broadcast anything here, and in some connect style scenarios we do not.
2807 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
2808 if node_txn.len() == 1 {
2809 check_spends!(node_txn[0], chan_2.3);
2811 assert_eq!(node_txn.len(), 0);
2815 let events = nodes[1].node.get_and_clear_pending_events();
2816 expect_pending_htlcs_forwardable!(nodes[1], events);
2817 check_added_monitors!(nodes[1], 1);
2818 let events = nodes[1].node.get_and_clear_pending_msg_events();
2819 assert_eq!(events.len(), 1);
2821 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, .. } } => {
2822 assert!(update_add_htlcs.is_empty());
2823 assert!(!update_fail_htlcs.is_empty());
2824 assert!(update_fulfill_htlcs.is_empty());
2825 assert!(update_fail_malformed_htlcs.is_empty());
2826 assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
2828 _ => panic!("Unexpected event"),
2831 // Broadcast legit commitment tx from B on A's chain
2832 let commitment_tx = get_local_commitment_txn!(nodes[1], chan_1.2);
2833 check_spends!(commitment_tx[0], chan_1.3);
2835 mine_transaction(&nodes[0], &commitment_tx[0]);
2836 connect_blocks(&nodes[0], TEST_FINAL_CLTV + MIN_CLTV_EXPIRY_DELTA as u32 - 1); // Confirm blocks until the HTLC expires
2838 check_closed_broadcast!(nodes[0], true);
2839 check_added_monitors!(nodes[0], 1);
2840 check_closed_event!(nodes[0], 1);
2841 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 1 commitment tx, ChannelMonitor : 1 timeout tx
2842 assert_eq!(node_txn.len(), 2);
2843 check_spends!(node_txn[0], chan_1.3);
2844 assert_eq!(node_txn[0].clone().input[0].witness.last().unwrap().len(), 71);
2845 check_spends!(node_txn[1], commitment_tx[0]);
2846 assert_eq!(node_txn[1].clone().input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2850 fn test_htlc_on_chain_timeout() {
2851 do_test_htlc_on_chain_timeout(ConnectStyle::BestBlockFirstSkippingBlocks);
2852 do_test_htlc_on_chain_timeout(ConnectStyle::TransactionsFirstSkippingBlocks);
2853 do_test_htlc_on_chain_timeout(ConnectStyle::FullBlockViaListen);
2857 fn test_simple_commitment_revoked_fail_backward() {
2858 // Test that in case of a revoked commitment tx, we detect the resolution of output by justice tx
2859 // and fail backward accordingly.
2861 let chanmon_cfgs = create_chanmon_cfgs(3);
2862 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2863 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2864 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2866 // Create some initial channels
2867 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2868 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
2870 let (payment_preimage, _payment_hash, _payment_secret) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3000000);
2871 // Get the will-be-revoked local txn from nodes[2]
2872 let revoked_local_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
2873 // Revoke the old state
2874 claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage);
2876 let (_, payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3000000);
2878 mine_transaction(&nodes[1], &revoked_local_txn[0]);
2879 check_closed_event!(nodes[1], 1);
2880 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
2881 check_added_monitors!(nodes[1], 1);
2882 check_closed_broadcast!(nodes[1], true);
2884 let events = nodes[1].node.get_and_clear_pending_events();
2885 expect_pending_htlcs_forwardable!(nodes[1], events);
2886 check_added_monitors!(nodes[1], 1);
2887 let events = nodes[1].node.get_and_clear_pending_msg_events();
2888 assert_eq!(events.len(), 1);
2890 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, .. } } => {
2891 assert!(update_add_htlcs.is_empty());
2892 assert_eq!(update_fail_htlcs.len(), 1);
2893 assert!(update_fulfill_htlcs.is_empty());
2894 assert!(update_fail_malformed_htlcs.is_empty());
2895 assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
2897 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
2898 commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
2899 expect_payment_failed_with_update!(nodes[0], payment_hash, false, chan_2.0.contents.short_channel_id, true);
2901 _ => panic!("Unexpected event"),
2905 fn do_test_commitment_revoked_fail_backward_exhaustive(deliver_bs_raa: bool, use_dust: bool, no_to_remote: bool) {
2906 // Test that if our counterparty broadcasts a revoked commitment transaction we fail all
2907 // pending HTLCs on that channel backwards even if the HTLCs aren't present in our latest
2908 // commitment transaction anymore.
2909 // To do this, we have the peer which will broadcast a revoked commitment transaction send
2910 // a number of update_fail/commitment_signed updates without ever sending the RAA in
2911 // response to our commitment_signed. This is somewhat misbehavior-y, though not
2912 // technically disallowed and we should probably handle it reasonably.
2913 // Note that this is pretty exhaustive as an outbound HTLC which we haven't yet
2914 // failed/fulfilled backwards must be in at least one of the latest two remote commitment
2916 // * Once we move it out of our holding cell/add it, we will immediately include it in a
2917 // commitment_signed (implying it will be in the latest remote commitment transaction).
2918 // * Once they remove it, we will send a (the first) commitment_signed without the HTLC,
2919 // and once they revoke the previous commitment transaction (allowing us to send a new
2920 // commitment_signed) we will be free to fail/fulfill the HTLC backwards.
2921 let chanmon_cfgs = create_chanmon_cfgs(3);
2922 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2923 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2924 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2926 // Create some initial channels
2927 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2928 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
2930 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 });
2931 // Get the will-be-revoked local txn from nodes[2]
2932 let revoked_local_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
2933 assert_eq!(revoked_local_txn[0].output.len(), if no_to_remote { 1 } else { 2 });
2934 // Revoke the old state
2935 claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage);
2937 let value = if use_dust {
2938 // The dust limit applied to HTLC outputs considers the fee of the HTLC transaction as
2939 // well, so HTLCs at exactly the dust limit will not be included in commitment txn.
2940 nodes[2].node.channel_state.lock().unwrap().by_id.get(&chan_2.2).unwrap().holder_dust_limit_satoshis * 1000
2943 let (_, first_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
2944 let (_, second_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
2945 let (_, third_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
2947 assert!(nodes[2].node.fail_htlc_backwards(&first_payment_hash));
2948 let events = nodes[2].node.get_and_clear_pending_events();
2949 expect_pending_htlcs_forwardable!(nodes[2], events);
2950 check_added_monitors!(nodes[2], 1);
2951 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2952 assert!(updates.update_add_htlcs.is_empty());
2953 assert!(updates.update_fulfill_htlcs.is_empty());
2954 assert!(updates.update_fail_malformed_htlcs.is_empty());
2955 assert_eq!(updates.update_fail_htlcs.len(), 1);
2956 assert!(updates.update_fee.is_none());
2957 nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
2958 let bs_raa = commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false, true, false, true);
2959 // Drop the last RAA from 3 -> 2
2961 assert!(nodes[2].node.fail_htlc_backwards(&second_payment_hash));
2962 let events = nodes[2].node.get_and_clear_pending_events();
2963 expect_pending_htlcs_forwardable!(nodes[2], events);
2964 check_added_monitors!(nodes[2], 1);
2965 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2966 assert!(updates.update_add_htlcs.is_empty());
2967 assert!(updates.update_fulfill_htlcs.is_empty());
2968 assert!(updates.update_fail_malformed_htlcs.is_empty());
2969 assert_eq!(updates.update_fail_htlcs.len(), 1);
2970 assert!(updates.update_fee.is_none());
2971 nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
2972 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &updates.commitment_signed);
2973 check_added_monitors!(nodes[1], 1);
2974 // Note that nodes[1] is in AwaitingRAA, so won't send a CS
2975 let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
2976 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
2977 check_added_monitors!(nodes[2], 1);
2979 assert!(nodes[2].node.fail_htlc_backwards(&third_payment_hash));
2980 let events = nodes[2].node.get_and_clear_pending_events();
2981 expect_pending_htlcs_forwardable!(nodes[2], events);
2982 check_added_monitors!(nodes[2], 1);
2983 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2984 assert!(updates.update_add_htlcs.is_empty());
2985 assert!(updates.update_fulfill_htlcs.is_empty());
2986 assert!(updates.update_fail_malformed_htlcs.is_empty());
2987 assert_eq!(updates.update_fail_htlcs.len(), 1);
2988 assert!(updates.update_fee.is_none());
2989 nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
2990 // At this point first_payment_hash has dropped out of the latest two commitment
2991 // transactions that nodes[1] is tracking...
2992 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &updates.commitment_signed);
2993 check_added_monitors!(nodes[1], 1);
2994 // Note that nodes[1] is (still) in AwaitingRAA, so won't send a CS
2995 let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
2996 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
2997 check_added_monitors!(nodes[2], 1);
2999 // Add a fourth HTLC, this one will get sequestered away in nodes[1]'s holding cell waiting
3000 // on nodes[2]'s RAA.
3001 let (_, fourth_payment_hash, fourth_payment_secret) = get_payment_preimage_hash!(nodes[2]);
3002 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
3003 let logger = test_utils::TestLogger::new();
3004 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();
3005 nodes[1].node.send_payment(&route, fourth_payment_hash, &Some(fourth_payment_secret)).unwrap();
3006 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3007 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
3008 check_added_monitors!(nodes[1], 0);
3011 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_raa);
3012 // One monitor for the new revocation preimage, no second on as we won't generate a new
3013 // commitment transaction for nodes[0] until process_pending_htlc_forwards().
3014 check_added_monitors!(nodes[1], 1);
3015 let events = nodes[1].node.get_and_clear_pending_events();
3016 assert_eq!(events.len(), 1);
3018 Event::PendingHTLCsForwardable { .. } => { },
3019 _ => panic!("Unexpected event"),
3021 // Deliberately don't process the pending fail-back so they all fail back at once after
3022 // block connection just like the !deliver_bs_raa case
3025 let mut failed_htlcs = HashSet::new();
3026 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
3028 mine_transaction(&nodes[1], &revoked_local_txn[0]);
3029 check_added_monitors!(nodes[1], 1);
3030 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
3032 let events = nodes[1].node.get_and_clear_pending_events();
3033 assert_eq!(events.len(), if deliver_bs_raa { 2 } else { 3 });
3035 Event::ChannelClosed { .. } => { },
3036 _ => panic!("Unexepected event"),
3039 Event::PaymentFailed { ref payment_hash, .. } => {
3040 assert_eq!(*payment_hash, fourth_payment_hash);
3042 _ => panic!("Unexpected event"),
3044 if !deliver_bs_raa {
3046 Event::PendingHTLCsForwardable { .. } => { },
3047 _ => panic!("Unexpected event"),
3050 nodes[1].node.process_pending_htlc_forwards();
3051 check_added_monitors!(nodes[1], 1);
3053 let events = nodes[1].node.get_and_clear_pending_msg_events();
3054 assert_eq!(events.len(), if deliver_bs_raa { 4 } else { 3 });
3055 match events[if deliver_bs_raa { 1 } else { 0 }] {
3056 MessageSendEvent::BroadcastChannelUpdate { msg: msgs::ChannelUpdate { .. } } => {},
3057 _ => panic!("Unexpected event"),
3059 match events[if deliver_bs_raa { 2 } else { 1 }] {
3060 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { msg: msgs::ErrorMessage { channel_id, ref data } }, node_id: _ } => {
3061 assert_eq!(channel_id, chan_2.2);
3062 assert_eq!(data.as_str(), "Commitment or closing transaction was confirmed on chain.");
3064 _ => panic!("Unexpected event"),
3068 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, .. } } => {
3069 assert_eq!(nodes[2].node.get_our_node_id(), *node_id);
3070 assert_eq!(update_add_htlcs.len(), 1);
3071 assert!(update_fulfill_htlcs.is_empty());
3072 assert!(update_fail_htlcs.is_empty());
3073 assert!(update_fail_malformed_htlcs.is_empty());
3075 _ => panic!("Unexpected event"),
3078 match events[if deliver_bs_raa { 3 } else { 2 }] {
3079 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, .. } } => {
3080 assert!(update_add_htlcs.is_empty());
3081 assert_eq!(update_fail_htlcs.len(), 3);
3082 assert!(update_fulfill_htlcs.is_empty());
3083 assert!(update_fail_malformed_htlcs.is_empty());
3084 assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
3086 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
3087 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[1]);
3088 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[2]);
3090 commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
3092 let events = nodes[0].node.get_and_clear_pending_events();
3093 assert_eq!(events.len(), 3);
3095 Event::PaymentFailed { ref payment_hash, rejected_by_dest: _, ref network_update, .. } => {
3096 assert!(failed_htlcs.insert(payment_hash.0));
3097 // If we delivered B's RAA we got an unknown preimage error, not something
3098 // that we should update our routing table for.
3099 if !deliver_bs_raa {
3100 assert!(network_update.is_some());
3103 _ => panic!("Unexpected event"),
3106 Event::PaymentFailed { ref payment_hash, rejected_by_dest: _, ref network_update, .. } => {
3107 assert!(failed_htlcs.insert(payment_hash.0));
3108 assert!(network_update.is_some());
3110 _ => panic!("Unexpected event"),
3113 Event::PaymentFailed { ref payment_hash, rejected_by_dest: _, ref network_update, .. } => {
3114 assert!(failed_htlcs.insert(payment_hash.0));
3115 assert!(network_update.is_some());
3117 _ => panic!("Unexpected event"),
3120 _ => panic!("Unexpected event"),
3123 assert!(failed_htlcs.contains(&first_payment_hash.0));
3124 assert!(failed_htlcs.contains(&second_payment_hash.0));
3125 assert!(failed_htlcs.contains(&third_payment_hash.0));
3129 fn test_commitment_revoked_fail_backward_exhaustive_a() {
3130 do_test_commitment_revoked_fail_backward_exhaustive(false, true, false);
3131 do_test_commitment_revoked_fail_backward_exhaustive(true, true, false);
3132 do_test_commitment_revoked_fail_backward_exhaustive(false, false, false);
3133 do_test_commitment_revoked_fail_backward_exhaustive(true, false, false);
3137 fn test_commitment_revoked_fail_backward_exhaustive_b() {
3138 do_test_commitment_revoked_fail_backward_exhaustive(false, true, true);
3139 do_test_commitment_revoked_fail_backward_exhaustive(true, true, true);
3140 do_test_commitment_revoked_fail_backward_exhaustive(false, false, true);
3141 do_test_commitment_revoked_fail_backward_exhaustive(true, false, true);
3145 fn fail_backward_pending_htlc_upon_channel_failure() {
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 mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3150 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1_000_000, 500_000_000, InitFeatures::known(), InitFeatures::known());
3151 let logger = test_utils::TestLogger::new();
3153 // Alice -> Bob: Route a payment but without Bob sending revoke_and_ack.
3155 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1]);
3156 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3157 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();
3158 nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
3159 check_added_monitors!(nodes[0], 1);
3161 let payment_event = {
3162 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3163 assert_eq!(events.len(), 1);
3164 SendEvent::from_event(events.remove(0))
3166 assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
3167 assert_eq!(payment_event.msgs.len(), 1);
3170 // Alice -> Bob: Route another payment but now Alice waits for Bob's earlier revoke_and_ack.
3171 let (_, failed_payment_hash, failed_payment_secret) = get_payment_preimage_hash!(nodes[1]);
3173 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3174 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();
3175 nodes[0].node.send_payment(&route, failed_payment_hash, &Some(failed_payment_secret)).unwrap();
3176 check_added_monitors!(nodes[0], 0);
3178 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3181 // Alice <- Bob: Send a malformed update_add_htlc so Alice fails the channel.
3183 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[0]);
3185 let secp_ctx = Secp256k1::new();
3186 let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
3187 let current_height = nodes[1].node.best_block.read().unwrap().height() + 1;
3188 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
3189 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();
3190 let (onion_payloads, _amount_msat, cltv_expiry) = onion_utils::build_onion_payloads(&route.paths[0], 50_000, &Some(payment_secret), current_height, &None).unwrap();
3191 let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route.paths[0], &session_priv).unwrap();
3192 let onion_routing_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
3194 // Send a 0-msat update_add_htlc to fail the channel.
3195 let update_add_htlc = msgs::UpdateAddHTLC {
3201 onion_routing_packet,
3203 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &update_add_htlc);
3205 let events = nodes[0].node.get_and_clear_pending_events();
3206 // Check that Alice fails backward the pending HTLC from the second payment.
3207 expect_payment_failed!(nodes[0], events[0..1].to_vec(), failed_payment_hash, true);
3209 Event::ChannelClosed { .. } => {}
3210 _ => panic!("Unexpected event"),
3212 check_closed_broadcast!(nodes[0], true);
3213 check_added_monitors!(nodes[0], 1);
3217 fn test_htlc_ignore_latest_remote_commitment() {
3218 // Test that HTLC transactions spending the latest remote commitment transaction are simply
3219 // ignored if we cannot claim them. This originally tickled an invalid unwrap().
3220 let chanmon_cfgs = create_chanmon_cfgs(2);
3221 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3222 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3223 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3224 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3226 route_payment(&nodes[0], &[&nodes[1]], 10000000);
3227 nodes[0].node.force_close_channel(&nodes[0].node.list_channels()[0].channel_id).unwrap();
3228 connect_blocks(&nodes[0], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + 1);
3229 check_closed_broadcast!(nodes[0], true);
3230 check_added_monitors!(nodes[0], 1);
3231 check_closed_event!(nodes[0], 1);
3233 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
3234 assert_eq!(node_txn.len(), 3);
3235 assert_eq!(node_txn[0], node_txn[1]);
3237 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3238 connect_block(&nodes[1], &Block { header, txdata: vec![node_txn[0].clone(), node_txn[1].clone()]});
3239 check_closed_broadcast!(nodes[1], true);
3240 check_added_monitors!(nodes[1], 1);
3241 check_closed_event!(nodes[1], 1);
3243 // Duplicate the connect_block call since this may happen due to other listeners
3244 // registering new transactions
3245 header.prev_blockhash = header.block_hash();
3246 connect_block(&nodes[1], &Block { header, txdata: vec![node_txn[0].clone(), node_txn[2].clone()]});
3250 fn test_force_close_fail_back() {
3251 // Check which HTLCs are failed-backwards on channel force-closure
3252 let chanmon_cfgs = create_chanmon_cfgs(3);
3253 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3254 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3255 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3256 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3257 create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3258 let logger = test_utils::TestLogger::new();
3260 let (our_payment_preimage, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[2]);
3262 let mut payment_event = {
3263 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3264 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();
3265 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
3266 check_added_monitors!(nodes[0], 1);
3268 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3269 assert_eq!(events.len(), 1);
3270 SendEvent::from_event(events.remove(0))
3273 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
3274 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
3276 let events = nodes[1].node.get_and_clear_pending_events();
3277 expect_pending_htlcs_forwardable!(nodes[1], events);
3279 let mut events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3280 assert_eq!(events_2.len(), 1);
3281 payment_event = SendEvent::from_event(events_2.remove(0));
3282 assert_eq!(payment_event.msgs.len(), 1);
3284 check_added_monitors!(nodes[1], 1);
3285 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
3286 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg);
3287 check_added_monitors!(nodes[2], 1);
3288 let (_, _) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3290 // nodes[2] now has the latest commitment transaction, but hasn't revoked its previous
3291 // state or updated nodes[1]' state. Now force-close and broadcast that commitment/HTLC
3292 // transaction and ensure nodes[1] doesn't fail-backwards (this was originally a bug!).
3294 nodes[2].node.force_close_channel(&payment_event.commitment_msg.channel_id).unwrap();
3295 check_closed_broadcast!(nodes[2], true);
3296 check_added_monitors!(nodes[2], 1);
3297 check_closed_event!(nodes[2], 1);
3299 let mut node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap();
3300 // Note that we don't bother broadcasting the HTLC-Success transaction here as we don't
3301 // have a use for it unless nodes[2] learns the preimage somehow, the funds will go
3302 // back to nodes[1] upon timeout otherwise.
3303 assert_eq!(node_txn.len(), 1);
3307 mine_transaction(&nodes[1], &tx);
3309 // Note no UpdateHTLCs event here from nodes[1] to nodes[0]!
3310 check_closed_broadcast!(nodes[1], true);
3311 check_added_monitors!(nodes[1], 1);
3312 check_closed_event!(nodes[1], 1);
3314 // Now check that if we add the preimage to ChannelMonitor it broadcasts our HTLC-Success..
3316 let mut monitors = nodes[2].chain_monitor.chain_monitor.monitors.read().unwrap();
3317 monitors.get(&OutPoint{ txid: Txid::from_slice(&payment_event.commitment_msg.channel_id[..]).unwrap(), index: 0 }).unwrap()
3318 .provide_payment_preimage(&our_payment_hash, &our_payment_preimage, &node_cfgs[2].tx_broadcaster, &node_cfgs[2].fee_estimator, &&logger);
3320 mine_transaction(&nodes[2], &tx);
3321 let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap();
3322 assert_eq!(node_txn.len(), 1);
3323 assert_eq!(node_txn[0].input.len(), 1);
3324 assert_eq!(node_txn[0].input[0].previous_output.txid, tx.txid());
3325 assert_eq!(node_txn[0].lock_time, 0); // Must be an HTLC-Success
3326 assert_eq!(node_txn[0].input[0].witness.len(), 5); // Must be an HTLC-Success
3328 check_spends!(node_txn[0], tx);
3332 fn test_dup_events_on_peer_disconnect() {
3333 // Test that if we receive a duplicative update_fulfill_htlc message after a reconnect we do
3334 // not generate a corresponding duplicative PaymentSent event. This did not use to be the case
3335 // as we used to generate the event immediately upon receipt of the payment preimage in the
3336 // update_fulfill_htlc message.
3338 let chanmon_cfgs = create_chanmon_cfgs(2);
3339 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3340 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3341 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3342 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3344 let payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 1000000).0;
3346 assert!(nodes[1].node.claim_funds(payment_preimage));
3347 check_added_monitors!(nodes[1], 1);
3348 let claim_msgs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3349 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &claim_msgs.update_fulfill_htlcs[0]);
3350 let events = nodes[0].node.get_and_clear_pending_events();
3351 expect_payment_sent!(nodes[0], payment_preimage, events);
3353 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3354 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3356 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (1, 0), (0, 0), (0, 0), (0, 0), (false, false));
3357 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
3361 fn test_simple_peer_disconnect() {
3362 // Test that we can reconnect when there are no lost messages
3363 let chanmon_cfgs = create_chanmon_cfgs(3);
3364 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3365 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3366 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3367 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3368 create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3370 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3371 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3372 reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3374 let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3375 let payment_hash_2 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3376 fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_hash_2);
3377 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_preimage_1);
3379 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3380 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3381 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3383 let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3384 let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3385 let payment_hash_5 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3386 let payment_hash_6 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3388 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3389 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3391 claim_payment_along_route(&nodes[0], &[&[&nodes[1], &nodes[2]]], true, payment_preimage_3);
3392 fail_payment_along_route(&nodes[0], &[&[&nodes[1], &nodes[2]]], true, payment_hash_5);
3394 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (1, 0), (1, 0), (false, false));
3396 let events = nodes[0].node.get_and_clear_pending_events();
3397 assert_eq!(events.len(), 2);
3399 Event::PaymentSent { payment_preimage } => {
3400 assert_eq!(payment_preimage, payment_preimage_3);
3402 _ => panic!("Unexpected event"),
3405 Event::PaymentFailed { payment_hash, rejected_by_dest, .. } => {
3406 assert_eq!(payment_hash, payment_hash_5);
3407 assert!(rejected_by_dest);
3409 _ => panic!("Unexpected event"),
3413 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_preimage_4);
3414 fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_hash_6);
3417 fn do_test_drop_messages_peer_disconnect(messages_delivered: u8, simulate_broken_lnd: bool) {
3418 // Test that we can reconnect when in-flight HTLC updates get dropped
3419 let chanmon_cfgs = create_chanmon_cfgs(2);
3420 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3421 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3422 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3424 let mut as_funding_locked = None;
3425 if messages_delivered == 0 {
3426 let (funding_locked, _, _) = create_chan_between_nodes_with_value_a(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
3427 as_funding_locked = Some(funding_locked);
3428 // nodes[1] doesn't receive the funding_locked message (it'll be re-sent on reconnect)
3429 // Note that we store it so that if we're running with `simulate_broken_lnd` we can deliver
3430 // it before the channel_reestablish message.
3432 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3435 let (payment_preimage_1, payment_hash_1, payment_secret_1) = get_payment_preimage_hash!(nodes[1]);
3437 let logger = test_utils::TestLogger::new();
3438 let payment_event = {
3439 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3440 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph,
3441 &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), Some(&nodes[0].node.list_usable_channels().iter().collect::<Vec<_>>()),
3442 &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
3443 nodes[0].node.send_payment(&route, payment_hash_1, &Some(payment_secret_1)).unwrap();
3444 check_added_monitors!(nodes[0], 1);
3446 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3447 assert_eq!(events.len(), 1);
3448 SendEvent::from_event(events.remove(0))
3450 assert_eq!(nodes[1].node.get_our_node_id(), payment_event.node_id);
3452 if messages_delivered < 2 {
3453 // Drop the payment_event messages, and let them get re-generated in reconnect_nodes!
3455 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
3456 if messages_delivered >= 3 {
3457 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
3458 check_added_monitors!(nodes[1], 1);
3459 let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3461 if messages_delivered >= 4 {
3462 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3463 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3464 check_added_monitors!(nodes[0], 1);
3466 if messages_delivered >= 5 {
3467 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_commitment_signed);
3468 let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3469 // No commitment_signed so get_event_msg's assert(len == 1) passes
3470 check_added_monitors!(nodes[0], 1);
3472 if messages_delivered >= 6 {
3473 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3474 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3475 check_added_monitors!(nodes[1], 1);
3482 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3483 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3484 if messages_delivered < 3 {
3485 if simulate_broken_lnd {
3486 // lnd has a long-standing bug where they send a funding_locked prior to a
3487 // channel_reestablish if you reconnect prior to funding_locked time.
3489 // Here we simulate that behavior, delivering a funding_locked immediately on
3490 // reconnect. Note that we don't bother skipping the now-duplicate funding_locked sent
3491 // in `reconnect_nodes` but we currently don't fail based on that.
3493 // See-also <https://github.com/lightningnetwork/lnd/issues/4006>
3494 nodes[1].node.handle_funding_locked(&nodes[0].node.get_our_node_id(), &as_funding_locked.as_ref().unwrap().0);
3496 // Even if the funding_locked messages get exchanged, as long as nothing further was
3497 // received on either side, both sides will need to resend them.
3498 reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 1), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3499 } else if messages_delivered == 3 {
3500 // nodes[0] still wants its RAA + commitment_signed
3501 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (-1, 0), (0, 0), (0, 0), (0, 0), (0, 0), (true, false));
3502 } else if messages_delivered == 4 {
3503 // nodes[0] still wants its commitment_signed
3504 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (-1, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3505 } else if messages_delivered == 5 {
3506 // nodes[1] still wants its final RAA
3507 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, true));
3508 } else if messages_delivered == 6 {
3509 // Everything was delivered...
3510 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3513 let events_1 = nodes[1].node.get_and_clear_pending_events();
3514 assert_eq!(events_1.len(), 1);
3516 Event::PendingHTLCsForwardable { .. } => { },
3517 _ => panic!("Unexpected event"),
3520 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3521 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3522 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3524 nodes[1].node.process_pending_htlc_forwards();
3526 let events_2 = nodes[1].node.get_and_clear_pending_events();
3527 assert_eq!(events_2.len(), 1);
3529 Event::PaymentReceived { ref payment_hash, ref purpose, amt } => {
3530 assert_eq!(payment_hash_1, *payment_hash);
3531 assert_eq!(amt, 1000000);
3533 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
3534 assert!(payment_preimage.is_none());
3535 assert_eq!(payment_secret_1, *payment_secret);
3537 _ => panic!("expected PaymentPurpose::InvoicePayment")
3540 _ => panic!("Unexpected event"),
3543 nodes[1].node.claim_funds(payment_preimage_1);
3544 check_added_monitors!(nodes[1], 1);
3546 let events_3 = nodes[1].node.get_and_clear_pending_msg_events();
3547 assert_eq!(events_3.len(), 1);
3548 let (update_fulfill_htlc, commitment_signed) = match events_3[0] {
3549 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
3550 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3551 assert!(updates.update_add_htlcs.is_empty());
3552 assert!(updates.update_fail_htlcs.is_empty());
3553 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
3554 assert!(updates.update_fail_malformed_htlcs.is_empty());
3555 assert!(updates.update_fee.is_none());
3556 (updates.update_fulfill_htlcs[0].clone(), updates.commitment_signed.clone())
3558 _ => panic!("Unexpected event"),
3561 if messages_delivered >= 1 {
3562 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlc);
3564 let events_4 = nodes[0].node.get_and_clear_pending_events();
3565 assert_eq!(events_4.len(), 1);
3567 Event::PaymentSent { ref payment_preimage } => {
3568 assert_eq!(payment_preimage_1, *payment_preimage);
3570 _ => panic!("Unexpected event"),
3573 if messages_delivered >= 2 {
3574 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
3575 check_added_monitors!(nodes[0], 1);
3576 let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
3578 if messages_delivered >= 3 {
3579 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3580 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3581 check_added_monitors!(nodes[1], 1);
3583 if messages_delivered >= 4 {
3584 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed);
3585 let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3586 // No commitment_signed so get_event_msg's assert(len == 1) passes
3587 check_added_monitors!(nodes[1], 1);
3589 if messages_delivered >= 5 {
3590 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3591 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3592 check_added_monitors!(nodes[0], 1);
3599 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3600 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3601 if messages_delivered < 2 {
3602 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (1, 0), (0, 0), (0, 0), (0, 0), (false, false));
3603 if messages_delivered < 1 {
3604 let events_4 = nodes[0].node.get_and_clear_pending_events();
3605 assert_eq!(events_4.len(), 1);
3607 Event::PaymentSent { ref payment_preimage } => {
3608 assert_eq!(payment_preimage_1, *payment_preimage);
3610 _ => panic!("Unexpected event"),
3613 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3615 } else if messages_delivered == 2 {
3616 // nodes[0] still wants its RAA + commitment_signed
3617 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, -1), (0, 0), (0, 0), (0, 0), (0, 0), (false, true));
3618 } else if messages_delivered == 3 {
3619 // nodes[0] still wants its commitment_signed
3620 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, -1), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3621 } else if messages_delivered == 4 {
3622 // nodes[1] still wants its final RAA
3623 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (true, false));
3624 } else if messages_delivered == 5 {
3625 // Everything was delivered...
3626 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3629 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3630 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3631 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3633 // Channel should still work fine...
3634 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3635 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph,
3636 &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), Some(&nodes[0].node.list_usable_channels().iter().collect::<Vec<_>>()),
3637 &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
3638 let payment_preimage_2 = send_along_route(&nodes[0], route, &[&nodes[1]], 1000000).0;
3639 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
3643 fn test_drop_messages_peer_disconnect_a() {
3644 do_test_drop_messages_peer_disconnect(0, true);
3645 do_test_drop_messages_peer_disconnect(0, false);
3646 do_test_drop_messages_peer_disconnect(1, false);
3647 do_test_drop_messages_peer_disconnect(2, false);
3651 fn test_drop_messages_peer_disconnect_b() {
3652 do_test_drop_messages_peer_disconnect(3, false);
3653 do_test_drop_messages_peer_disconnect(4, false);
3654 do_test_drop_messages_peer_disconnect(5, false);
3655 do_test_drop_messages_peer_disconnect(6, false);
3659 fn test_funding_peer_disconnect() {
3660 // Test that we can lock in our funding tx while disconnected
3661 let chanmon_cfgs = create_chanmon_cfgs(2);
3662 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3663 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3664 let persister: test_utils::TestPersister;
3665 let new_chain_monitor: test_utils::TestChainMonitor;
3666 let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
3667 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3668 let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
3670 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3671 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3673 confirm_transaction(&nodes[0], &tx);
3674 let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
3675 assert_eq!(events_1.len(), 1);
3677 MessageSendEvent::SendFundingLocked { ref node_id, msg: _ } => {
3678 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
3680 _ => panic!("Unexpected event"),
3683 reconnect_nodes(&nodes[0], &nodes[1], (false, true), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3685 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3686 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3688 confirm_transaction(&nodes[1], &tx);
3689 let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3690 assert_eq!(events_2.len(), 2);
3691 let funding_locked = match events_2[0] {
3692 MessageSendEvent::SendFundingLocked { ref node_id, ref msg } => {
3693 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3696 _ => panic!("Unexpected event"),
3698 let bs_announcement_sigs = match events_2[1] {
3699 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
3700 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3703 _ => panic!("Unexpected event"),
3706 reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3708 nodes[0].node.handle_funding_locked(&nodes[1].node.get_our_node_id(), &funding_locked);
3709 nodes[0].node.handle_announcement_signatures(&nodes[1].node.get_our_node_id(), &bs_announcement_sigs);
3710 let events_3 = nodes[0].node.get_and_clear_pending_msg_events();
3711 assert_eq!(events_3.len(), 2);
3712 let as_announcement_sigs = match events_3[0] {
3713 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
3714 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
3717 _ => panic!("Unexpected event"),
3719 let (as_announcement, as_update) = match events_3[1] {
3720 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
3721 (msg.clone(), update_msg.clone())
3723 _ => panic!("Unexpected event"),
3726 nodes[1].node.handle_announcement_signatures(&nodes[0].node.get_our_node_id(), &as_announcement_sigs);
3727 let events_4 = nodes[1].node.get_and_clear_pending_msg_events();
3728 assert_eq!(events_4.len(), 1);
3729 let (_, bs_update) = match events_4[0] {
3730 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
3731 (msg.clone(), update_msg.clone())
3733 _ => panic!("Unexpected event"),
3736 nodes[0].net_graph_msg_handler.handle_channel_announcement(&as_announcement).unwrap();
3737 nodes[0].net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
3738 nodes[0].net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
3740 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3741 let logger = test_utils::TestLogger::new();
3742 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();
3743 let (payment_preimage, _, _) = send_along_route(&nodes[0], route, &[&nodes[1]], 1000000);
3744 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage);
3746 // Check that after deserialization and reconnection we can still generate an identical
3747 // channel_announcement from the cached signatures.
3748 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3750 let nodes_0_serialized = nodes[0].node.encode();
3751 let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
3752 nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
3754 persister = test_utils::TestPersister::new();
3755 let keys_manager = &chanmon_cfgs[0].keys_manager;
3756 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);
3757 nodes[0].chain_monitor = &new_chain_monitor;
3758 let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
3759 let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
3760 &mut chan_0_monitor_read, keys_manager).unwrap();
3761 assert!(chan_0_monitor_read.is_empty());
3763 let mut nodes_0_read = &nodes_0_serialized[..];
3764 let (_, nodes_0_deserialized_tmp) = {
3765 let mut channel_monitors = HashMap::new();
3766 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
3767 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
3768 default_config: UserConfig::default(),
3770 fee_estimator: node_cfgs[0].fee_estimator,
3771 chain_monitor: nodes[0].chain_monitor,
3772 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
3773 logger: nodes[0].logger,
3777 nodes_0_deserialized = nodes_0_deserialized_tmp;
3778 assert!(nodes_0_read.is_empty());
3780 assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
3781 nodes[0].node = &nodes_0_deserialized;
3782 check_added_monitors!(nodes[0], 1);
3784 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3786 // as_announcement should be re-generated exactly by broadcast_node_announcement.
3787 nodes[0].node.broadcast_node_announcement([0, 0, 0], [0; 32], Vec::new());
3788 let msgs = nodes[0].node.get_and_clear_pending_msg_events();
3789 let mut found_announcement = false;
3790 for event in msgs.iter() {
3792 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, .. } => {
3793 if *msg == as_announcement { found_announcement = true; }
3795 MessageSendEvent::BroadcastNodeAnnouncement { .. } => {},
3796 _ => panic!("Unexpected event"),
3799 assert!(found_announcement);
3803 fn test_drop_messages_peer_disconnect_dual_htlc() {
3804 // Test that we can handle reconnecting when both sides of a channel have pending
3805 // commitment_updates when we disconnect.
3806 let chanmon_cfgs = create_chanmon_cfgs(2);
3807 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3808 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3809 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3810 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3811 let logger = test_utils::TestLogger::new();
3813 let (payment_preimage_1, _, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
3815 // Now try to send a second payment which will fail to send
3816 let (payment_preimage_2, payment_hash_2, payment_secret_2) = get_payment_preimage_hash!(nodes[1]);
3817 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3818 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();
3819 nodes[0].node.send_payment(&route, payment_hash_2, &Some(payment_secret_2)).unwrap();
3820 check_added_monitors!(nodes[0], 1);
3822 let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
3823 assert_eq!(events_1.len(), 1);
3825 MessageSendEvent::UpdateHTLCs { .. } => {},
3826 _ => panic!("Unexpected event"),
3829 assert!(nodes[1].node.claim_funds(payment_preimage_1));
3830 check_added_monitors!(nodes[1], 1);
3832 let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3833 assert_eq!(events_2.len(), 1);
3835 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 } } => {
3836 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3837 assert!(update_add_htlcs.is_empty());
3838 assert_eq!(update_fulfill_htlcs.len(), 1);
3839 assert!(update_fail_htlcs.is_empty());
3840 assert!(update_fail_malformed_htlcs.is_empty());
3841 assert!(update_fee.is_none());
3843 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlcs[0]);
3844 let events_3 = nodes[0].node.get_and_clear_pending_events();
3845 assert_eq!(events_3.len(), 1);
3847 Event::PaymentSent { ref payment_preimage } => {
3848 assert_eq!(*payment_preimage, payment_preimage_1);
3850 _ => panic!("Unexpected event"),
3853 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), commitment_signed);
3854 let _ = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3855 // No commitment_signed so get_event_msg's assert(len == 1) passes
3856 check_added_monitors!(nodes[0], 1);
3858 _ => panic!("Unexpected event"),
3861 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3862 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3864 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
3865 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
3866 assert_eq!(reestablish_1.len(), 1);
3867 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
3868 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
3869 assert_eq!(reestablish_2.len(), 1);
3871 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
3872 let as_resp = handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
3873 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
3874 let bs_resp = handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
3876 assert!(as_resp.0.is_none());
3877 assert!(bs_resp.0.is_none());
3879 assert!(bs_resp.1.is_none());
3880 assert!(bs_resp.2.is_none());
3882 assert!(as_resp.3 == RAACommitmentOrder::CommitmentFirst);
3884 assert_eq!(as_resp.2.as_ref().unwrap().update_add_htlcs.len(), 1);
3885 assert!(as_resp.2.as_ref().unwrap().update_fulfill_htlcs.is_empty());
3886 assert!(as_resp.2.as_ref().unwrap().update_fail_htlcs.is_empty());
3887 assert!(as_resp.2.as_ref().unwrap().update_fail_malformed_htlcs.is_empty());
3888 assert!(as_resp.2.as_ref().unwrap().update_fee.is_none());
3889 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &as_resp.2.as_ref().unwrap().update_add_htlcs[0]);
3890 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_resp.2.as_ref().unwrap().commitment_signed);
3891 let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3892 // No commitment_signed so get_event_msg's assert(len == 1) passes
3893 check_added_monitors!(nodes[1], 1);
3895 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), as_resp.1.as_ref().unwrap());
3896 let bs_second_commitment_signed = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3897 assert!(bs_second_commitment_signed.update_add_htlcs.is_empty());
3898 assert!(bs_second_commitment_signed.update_fulfill_htlcs.is_empty());
3899 assert!(bs_second_commitment_signed.update_fail_htlcs.is_empty());
3900 assert!(bs_second_commitment_signed.update_fail_malformed_htlcs.is_empty());
3901 assert!(bs_second_commitment_signed.update_fee.is_none());
3902 check_added_monitors!(nodes[1], 1);
3904 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3905 let as_commitment_signed = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
3906 assert!(as_commitment_signed.update_add_htlcs.is_empty());
3907 assert!(as_commitment_signed.update_fulfill_htlcs.is_empty());
3908 assert!(as_commitment_signed.update_fail_htlcs.is_empty());
3909 assert!(as_commitment_signed.update_fail_malformed_htlcs.is_empty());
3910 assert!(as_commitment_signed.update_fee.is_none());
3911 check_added_monitors!(nodes[0], 1);
3913 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_commitment_signed.commitment_signed);
3914 let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3915 // No commitment_signed so get_event_msg's assert(len == 1) passes
3916 check_added_monitors!(nodes[0], 1);
3918 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed.commitment_signed);
3919 let bs_second_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3920 // No commitment_signed so get_event_msg's assert(len == 1) passes
3921 check_added_monitors!(nodes[1], 1);
3923 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3924 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3925 check_added_monitors!(nodes[1], 1);
3927 let events = nodes[1].node.get_and_clear_pending_events();
3928 expect_pending_htlcs_forwardable!(nodes[1], events);
3930 let events_5 = nodes[1].node.get_and_clear_pending_events();
3931 assert_eq!(events_5.len(), 1);
3933 Event::PaymentReceived { ref payment_hash, ref purpose, .. } => {
3934 assert_eq!(payment_hash_2, *payment_hash);
3936 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
3937 assert!(payment_preimage.is_none());
3938 assert_eq!(payment_secret_2, *payment_secret);
3940 _ => panic!("expected PaymentPurpose::InvoicePayment")
3943 _ => panic!("Unexpected event"),
3946 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke_and_ack);
3947 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3948 check_added_monitors!(nodes[0], 1);
3950 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
3953 fn do_test_htlc_timeout(send_partial_mpp: bool) {
3954 // If the user fails to claim/fail an HTLC within the HTLC CLTV timeout we fail it for them
3955 // to avoid our counterparty failing the channel.
3956 let chanmon_cfgs = create_chanmon_cfgs(2);
3957 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3958 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3959 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3961 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3962 let logger = test_utils::TestLogger::new();
3964 let our_payment_hash = if send_partial_mpp {
3965 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3966 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();
3967 let (_, our_payment_hash, payment_secret) = get_payment_preimage_hash!(&nodes[1]);
3968 // Use the utility function send_payment_along_path to send the payment with MPP data which
3969 // indicates there are more HTLCs coming.
3970 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.
3971 let mpp_id = MppId([42; 32]);
3972 nodes[0].node.send_payment_along_path(&route.paths[0], &our_payment_hash, &Some(payment_secret), 200000, cur_height, mpp_id, &None).unwrap();
3973 check_added_monitors!(nodes[0], 1);
3974 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3975 assert_eq!(events.len(), 1);
3976 // Now do the relevant commitment_signed/RAA dances along the path, noting that the final
3977 // hop should *not* yet generate any PaymentReceived event(s).
3978 pass_along_path(&nodes[0], &[&nodes[1]], 100000, our_payment_hash, Some(payment_secret), events.drain(..).next().unwrap(), false, None);
3981 route_payment(&nodes[0], &[&nodes[1]], 100000).1
3984 let mut block = Block {
3985 header: BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
3988 connect_block(&nodes[0], &block);
3989 connect_block(&nodes[1], &block);
3990 let block_count = TEST_FINAL_CLTV + CHAN_CONFIRM_DEPTH + 2 - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS;
3991 for _ in CHAN_CONFIRM_DEPTH + 2..block_count {
3992 block.header.prev_blockhash = block.block_hash();
3993 connect_block(&nodes[0], &block);
3994 connect_block(&nodes[1], &block);
3997 let events = nodes[1].node.get_and_clear_pending_events();
3998 expect_pending_htlcs_forwardable!(nodes[1], events);
4000 check_added_monitors!(nodes[1], 1);
4001 let htlc_timeout_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4002 assert!(htlc_timeout_updates.update_add_htlcs.is_empty());
4003 assert_eq!(htlc_timeout_updates.update_fail_htlcs.len(), 1);
4004 assert!(htlc_timeout_updates.update_fail_malformed_htlcs.is_empty());
4005 assert!(htlc_timeout_updates.update_fee.is_none());
4007 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_timeout_updates.update_fail_htlcs[0]);
4008 commitment_signed_dance!(nodes[0], nodes[1], htlc_timeout_updates.commitment_signed, false);
4009 // 100_000 msat as u64, followed by the height at which we failed back above
4010 let mut expected_failure_data = byte_utils::be64_to_array(100_000).to_vec();
4011 expected_failure_data.extend_from_slice(&byte_utils::be32_to_array(block_count - 1));
4012 let events = nodes[0].node.get_and_clear_pending_events();
4013 expect_payment_failed!(nodes[0], events, our_payment_hash, true, 0x4000 | 15, &expected_failure_data[..]);
4017 fn test_htlc_timeout() {
4018 do_test_htlc_timeout(true);
4019 do_test_htlc_timeout(false);
4022 fn do_test_holding_cell_htlc_add_timeouts(forwarded_htlc: bool) {
4023 // Tests that HTLCs in the holding cell are timed out after the requisite number of blocks.
4024 let chanmon_cfgs = create_chanmon_cfgs(3);
4025 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
4026 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
4027 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
4028 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4029 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
4031 // Make sure all nodes are at the same starting height
4032 connect_blocks(&nodes[0], 2*CHAN_CONFIRM_DEPTH + 1 - nodes[0].best_block_info().1);
4033 connect_blocks(&nodes[1], 2*CHAN_CONFIRM_DEPTH + 1 - nodes[1].best_block_info().1);
4034 connect_blocks(&nodes[2], 2*CHAN_CONFIRM_DEPTH + 1 - nodes[2].best_block_info().1);
4036 let logger = test_utils::TestLogger::new();
4038 // Route a first payment to get the 1 -> 2 channel in awaiting_raa...
4039 let (_, first_payment_hash, first_payment_secret) = get_payment_preimage_hash!(nodes[2]);
4041 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
4042 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();
4043 nodes[1].node.send_payment(&route, first_payment_hash, &Some(first_payment_secret)).unwrap();
4045 assert_eq!(nodes[1].node.get_and_clear_pending_msg_events().len(), 1);
4046 check_added_monitors!(nodes[1], 1);
4048 // Now attempt to route a second payment, which should be placed in the holding cell
4049 let (_, second_payment_hash, second_payment_secret) = get_payment_preimage_hash!(nodes[2]);
4051 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
4052 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();
4053 nodes[0].node.send_payment(&route, second_payment_hash, &Some(first_payment_secret)).unwrap();
4054 check_added_monitors!(nodes[0], 1);
4055 let payment_event = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
4056 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
4057 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
4058 let events = nodes[1].node.get_and_clear_pending_events();
4059 expect_pending_htlcs_forwardable!(nodes[1], events);
4060 check_added_monitors!(nodes[1], 0);
4062 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
4063 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();
4064 nodes[1].node.send_payment(&route, second_payment_hash, &Some(second_payment_secret)).unwrap();
4065 check_added_monitors!(nodes[1], 0);
4068 connect_blocks(&nodes[1], TEST_FINAL_CLTV - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS);
4069 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4070 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
4071 connect_blocks(&nodes[1], 1);
4074 let events = nodes[1].node.get_and_clear_pending_events();
4075 expect_pending_htlcs_forwardable!(nodes[1], events);
4076 check_added_monitors!(nodes[1], 1);
4077 let fail_commit = nodes[1].node.get_and_clear_pending_msg_events();
4078 assert_eq!(fail_commit.len(), 1);
4079 match fail_commit[0] {
4080 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fail_htlcs, ref commitment_signed, .. }, .. } => {
4081 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
4082 commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, true, true);
4084 _ => unreachable!(),
4086 expect_payment_failed_with_update!(nodes[0], second_payment_hash, false, chan_2.0.contents.short_channel_id, false);
4088 let events = nodes[1].node.get_and_clear_pending_events();
4089 expect_payment_failed!(nodes[1], events, second_payment_hash, true);
4094 fn test_holding_cell_htlc_add_timeouts() {
4095 do_test_holding_cell_htlc_add_timeouts(false);
4096 do_test_holding_cell_htlc_add_timeouts(true);
4100 fn test_no_txn_manager_serialize_deserialize() {
4101 let chanmon_cfgs = create_chanmon_cfgs(2);
4102 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4103 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4104 let logger: test_utils::TestLogger;
4105 let fee_estimator: test_utils::TestFeeEstimator;
4106 let persister: test_utils::TestPersister;
4107 let new_chain_monitor: test_utils::TestChainMonitor;
4108 let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4109 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4111 let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
4113 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4115 let nodes_0_serialized = nodes[0].node.encode();
4116 let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4117 nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
4119 logger = test_utils::TestLogger::new();
4120 fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
4121 persister = test_utils::TestPersister::new();
4122 let keys_manager = &chanmon_cfgs[0].keys_manager;
4123 new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator, &persister, keys_manager);
4124 nodes[0].chain_monitor = &new_chain_monitor;
4125 let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4126 let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
4127 &mut chan_0_monitor_read, keys_manager).unwrap();
4128 assert!(chan_0_monitor_read.is_empty());
4130 let mut nodes_0_read = &nodes_0_serialized[..];
4131 let config = UserConfig::default();
4132 let (_, nodes_0_deserialized_tmp) = {
4133 let mut channel_monitors = HashMap::new();
4134 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4135 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4136 default_config: config,
4138 fee_estimator: &fee_estimator,
4139 chain_monitor: nodes[0].chain_monitor,
4140 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4145 nodes_0_deserialized = nodes_0_deserialized_tmp;
4146 assert!(nodes_0_read.is_empty());
4148 assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4149 nodes[0].node = &nodes_0_deserialized;
4150 assert_eq!(nodes[0].node.list_channels().len(), 1);
4151 check_added_monitors!(nodes[0], 1);
4153 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4154 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
4155 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4156 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
4158 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
4159 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4160 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
4161 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4163 let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
4164 let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
4165 for node in nodes.iter() {
4166 assert!(node.net_graph_msg_handler.handle_channel_announcement(&announcement).unwrap());
4167 node.net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
4168 node.net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
4171 send_payment(&nodes[0], &[&nodes[1]], 1000000);
4176 let chanmon_cfgs = create_chanmon_cfgs(4);
4177 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
4178 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
4179 let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
4181 let chan_1_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
4182 let chan_2_id = create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
4183 let chan_3_id = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
4184 let chan_4_id = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
4185 let logger = test_utils::TestLogger::new();
4187 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(&nodes[3]);
4188 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
4189 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();
4190 let path = route.paths[0].clone();
4191 route.paths.push(path);
4192 route.paths[0][0].pubkey = nodes[1].node.get_our_node_id();
4193 route.paths[0][0].short_channel_id = chan_1_id;
4194 route.paths[0][1].short_channel_id = chan_3_id;
4195 route.paths[1][0].pubkey = nodes[2].node.get_our_node_id();
4196 route.paths[1][0].short_channel_id = chan_2_id;
4197 route.paths[1][1].short_channel_id = chan_4_id;
4198 send_along_route_with_secret(&nodes[0], route, &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], 200_000, payment_hash, payment_secret);
4199 fail_payment_along_route(&nodes[0], &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], false, payment_hash);
4203 fn test_dup_htlc_onchain_fails_on_reload() {
4204 // When a Channel is closed, any outbound HTLCs which were relayed through it are simply
4205 // dropped when the Channel is. From there, the ChannelManager relies on the ChannelMonitor
4206 // having a copy of the relevant fail-/claim-back data and processes the HTLC fail/claim when
4207 // the ChannelMonitor tells it to.
4209 // If, due to an on-chain event, an HTLC is failed/claimed, and then we serialize the
4210 // ChannelManager, we generally expect there not to be a duplicate HTLC fail/claim (eg via a
4211 // PaymentFailed event appearing). However, because we may not serialize the relevant
4212 // ChannelMonitor at the same time, this isn't strictly guaranteed. In order to provide this
4213 // consistency, the ChannelManager explicitly tracks pending-onchain-resolution outbound HTLCs
4214 // and de-duplicates ChannelMonitor events.
4216 // This tests that explicit tracking behavior.
4217 let chanmon_cfgs = create_chanmon_cfgs(2);
4218 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4219 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4220 let persister: test_utils::TestPersister;
4221 let new_chain_monitor: test_utils::TestChainMonitor;
4222 let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4223 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4225 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4227 // Route a payment, but force-close the channel before the HTLC fulfill message arrives at
4229 let (payment_preimage, _, _) = route_payment(&nodes[0], &[&nodes[1]], 10000000);
4230 nodes[0].node.force_close_channel(&nodes[0].node.list_channels()[0].channel_id).unwrap();
4231 check_closed_broadcast!(nodes[0], true);
4232 check_added_monitors!(nodes[0], 1);
4233 check_closed_event!(nodes[0], 1);
4235 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
4236 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4238 // Connect blocks until the CLTV timeout is up so that we get an HTLC-Timeout transaction
4239 connect_blocks(&nodes[0], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + 1);
4240 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
4241 assert_eq!(node_txn.len(), 3);
4242 assert_eq!(node_txn[0], node_txn[1]);
4244 assert!(nodes[1].node.claim_funds(payment_preimage));
4245 check_added_monitors!(nodes[1], 1);
4247 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4248 connect_block(&nodes[1], &Block { header, txdata: vec![node_txn[1].clone(), node_txn[2].clone()]});
4249 check_closed_broadcast!(nodes[1], true);
4250 check_added_monitors!(nodes[1], 1);
4251 check_closed_event!(nodes[1], 1);
4252 let claim_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
4254 header.prev_blockhash = nodes[0].best_block_hash();
4255 connect_block(&nodes[0], &Block { header, txdata: vec![node_txn[1].clone(), node_txn[2].clone()]});
4257 // Serialize out the ChannelMonitor before connecting the on-chain claim transactions. This is
4258 // fairly normal behavior as ChannelMonitor(s) are often not re-serialized when on-chain events
4259 // happen, unlike ChannelManager which tends to be re-serialized after any relevant event(s).
4260 let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4261 nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
4263 header.prev_blockhash = nodes[0].best_block_hash();
4264 let claim_block = Block { header, txdata: claim_txn};
4265 connect_block(&nodes[0], &claim_block);
4266 let events = nodes[0].node.get_and_clear_pending_events();
4267 expect_payment_sent!(nodes[0], payment_preimage, events);
4269 // ChannelManagers generally get re-serialized after any relevant event(s). Since we just
4270 // connected a highly-relevant block, it likely gets serialized out now.
4271 let mut chan_manager_serialized = test_utils::TestVecWriter(Vec::new());
4272 nodes[0].node.write(&mut chan_manager_serialized).unwrap();
4274 // Now reload nodes[0]...
4275 persister = test_utils::TestPersister::new();
4276 let keys_manager = &chanmon_cfgs[0].keys_manager;
4277 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);
4278 nodes[0].chain_monitor = &new_chain_monitor;
4279 let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4280 let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
4281 &mut chan_0_monitor_read, keys_manager).unwrap();
4282 assert!(chan_0_monitor_read.is_empty());
4284 let (_, nodes_0_deserialized_tmp) = {
4285 let mut channel_monitors = HashMap::new();
4286 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4287 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>
4288 ::read(&mut io::Cursor::new(&chan_manager_serialized.0[..]), ChannelManagerReadArgs {
4289 default_config: Default::default(),
4291 fee_estimator: node_cfgs[0].fee_estimator,
4292 chain_monitor: nodes[0].chain_monitor,
4293 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4294 logger: nodes[0].logger,
4298 nodes_0_deserialized = nodes_0_deserialized_tmp;
4300 assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4301 check_added_monitors!(nodes[0], 1);
4302 nodes[0].node = &nodes_0_deserialized;
4304 // Note that if we re-connect the block which exposed nodes[0] to the payment preimage (but
4305 // which the current ChannelMonitor has not seen), the ChannelManager's de-duplication of
4306 // payment events should kick in, leaving us with no pending events here.
4307 let height = nodes[0].blocks.lock().unwrap().len() as u32 - 1;
4308 nodes[0].chain_monitor.chain_monitor.block_connected(&claim_block, height);
4309 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
4313 fn test_manager_serialize_deserialize_events() {
4314 // This test makes sure the events field in ChannelManager survives de/serialization
4315 let chanmon_cfgs = create_chanmon_cfgs(2);
4316 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4317 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4318 let fee_estimator: test_utils::TestFeeEstimator;
4319 let persister: test_utils::TestPersister;
4320 let logger: test_utils::TestLogger;
4321 let new_chain_monitor: test_utils::TestChainMonitor;
4322 let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4323 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4325 // Start creating a channel, but stop right before broadcasting the funding transaction
4326 let channel_value = 100000;
4327 let push_msat = 10001;
4328 let a_flags = InitFeatures::known();
4329 let b_flags = InitFeatures::known();
4330 let node_a = nodes.remove(0);
4331 let node_b = nodes.remove(0);
4332 node_a.node.create_channel(node_b.node.get_our_node_id(), channel_value, push_msat, 42, None).unwrap();
4333 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()));
4334 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()));
4336 let (temporary_channel_id, tx, funding_output) = create_funding_transaction(&node_a, channel_value, 42);
4338 node_a.node.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
4339 check_added_monitors!(node_a, 0);
4341 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()));
4343 let mut added_monitors = node_b.chain_monitor.added_monitors.lock().unwrap();
4344 assert_eq!(added_monitors.len(), 1);
4345 assert_eq!(added_monitors[0].0, funding_output);
4346 added_monitors.clear();
4349 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()));
4351 let mut added_monitors = node_a.chain_monitor.added_monitors.lock().unwrap();
4352 assert_eq!(added_monitors.len(), 1);
4353 assert_eq!(added_monitors[0].0, funding_output);
4354 added_monitors.clear();
4356 // Normally, this is where node_a would broadcast the funding transaction, but the test de/serializes first instead
4361 // Start the de/seriailization process mid-channel creation to check that the channel manager will hold onto events that are serialized
4362 let nodes_0_serialized = nodes[0].node.encode();
4363 let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4364 nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
4366 fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
4367 logger = test_utils::TestLogger::new();
4368 persister = test_utils::TestPersister::new();
4369 let keys_manager = &chanmon_cfgs[0].keys_manager;
4370 new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator, &persister, keys_manager);
4371 nodes[0].chain_monitor = &new_chain_monitor;
4372 let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4373 let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
4374 &mut chan_0_monitor_read, keys_manager).unwrap();
4375 assert!(chan_0_monitor_read.is_empty());
4377 let mut nodes_0_read = &nodes_0_serialized[..];
4378 let config = UserConfig::default();
4379 let (_, nodes_0_deserialized_tmp) = {
4380 let mut channel_monitors = HashMap::new();
4381 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4382 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4383 default_config: config,
4385 fee_estimator: &fee_estimator,
4386 chain_monitor: nodes[0].chain_monitor,
4387 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4392 nodes_0_deserialized = nodes_0_deserialized_tmp;
4393 assert!(nodes_0_read.is_empty());
4395 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4397 assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4398 nodes[0].node = &nodes_0_deserialized;
4400 // After deserializing, make sure the funding_transaction is still held by the channel manager
4401 let events_4 = nodes[0].node.get_and_clear_pending_events();
4402 assert_eq!(events_4.len(), 0);
4403 assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
4404 assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0].txid(), funding_output.txid);
4406 // Make sure the channel is functioning as though the de/serialization never happened
4407 assert_eq!(nodes[0].node.list_channels().len(), 1);
4408 check_added_monitors!(nodes[0], 1);
4410 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4411 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
4412 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4413 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
4415 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
4416 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4417 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
4418 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4420 let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
4421 let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
4422 for node in nodes.iter() {
4423 assert!(node.net_graph_msg_handler.handle_channel_announcement(&announcement).unwrap());
4424 node.net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
4425 node.net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
4428 send_payment(&nodes[0], &[&nodes[1]], 1000000);
4432 fn test_simple_manager_serialize_deserialize() {
4433 let chanmon_cfgs = create_chanmon_cfgs(2);
4434 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4435 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4436 let logger: test_utils::TestLogger;
4437 let fee_estimator: test_utils::TestFeeEstimator;
4438 let persister: test_utils::TestPersister;
4439 let new_chain_monitor: test_utils::TestChainMonitor;
4440 let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4441 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4442 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4444 let (our_payment_preimage, _, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
4445 let (_, our_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
4447 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4449 let nodes_0_serialized = nodes[0].node.encode();
4450 let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4451 nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
4453 logger = test_utils::TestLogger::new();
4454 fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
4455 persister = test_utils::TestPersister::new();
4456 let keys_manager = &chanmon_cfgs[0].keys_manager;
4457 new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator, &persister, keys_manager);
4458 nodes[0].chain_monitor = &new_chain_monitor;
4459 let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4460 let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
4461 &mut chan_0_monitor_read, keys_manager).unwrap();
4462 assert!(chan_0_monitor_read.is_empty());
4464 let mut nodes_0_read = &nodes_0_serialized[..];
4465 let (_, nodes_0_deserialized_tmp) = {
4466 let mut channel_monitors = HashMap::new();
4467 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4468 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4469 default_config: UserConfig::default(),
4471 fee_estimator: &fee_estimator,
4472 chain_monitor: nodes[0].chain_monitor,
4473 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4478 nodes_0_deserialized = nodes_0_deserialized_tmp;
4479 assert!(nodes_0_read.is_empty());
4481 assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4482 nodes[0].node = &nodes_0_deserialized;
4483 check_added_monitors!(nodes[0], 1);
4485 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
4487 fail_payment(&nodes[0], &[&nodes[1]], our_payment_hash);
4488 claim_payment(&nodes[0], &[&nodes[1]], our_payment_preimage);
4492 fn test_manager_serialize_deserialize_inconsistent_monitor() {
4493 // Test deserializing a ChannelManager with an out-of-date ChannelMonitor
4494 let chanmon_cfgs = create_chanmon_cfgs(4);
4495 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
4496 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
4497 let logger: test_utils::TestLogger;
4498 let fee_estimator: test_utils::TestFeeEstimator;
4499 let persister: test_utils::TestPersister;
4500 let new_chain_monitor: test_utils::TestChainMonitor;
4501 let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4502 let mut nodes = create_network(4, &node_cfgs, &node_chanmgrs);
4503 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4504 create_announced_chan_between_nodes(&nodes, 2, 0, InitFeatures::known(), InitFeatures::known());
4505 let (_, _, channel_id, funding_tx) = create_announced_chan_between_nodes(&nodes, 0, 3, InitFeatures::known(), InitFeatures::known());
4507 let mut node_0_stale_monitors_serialized = Vec::new();
4508 for monitor in nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter() {
4509 let mut writer = test_utils::TestVecWriter(Vec::new());
4510 monitor.1.write(&mut writer).unwrap();
4511 node_0_stale_monitors_serialized.push(writer.0);
4514 let (our_payment_preimage, _, _) = route_payment(&nodes[2], &[&nodes[0], &nodes[1]], 1000000);
4516 // Serialize the ChannelManager here, but the monitor we keep up-to-date
4517 let nodes_0_serialized = nodes[0].node.encode();
4519 route_payment(&nodes[0], &[&nodes[3]], 1000000);
4520 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4521 nodes[2].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4522 nodes[3].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4524 // Now the ChannelMonitor (which is now out-of-sync with ChannelManager for channel w/
4526 let mut node_0_monitors_serialized = Vec::new();
4527 for monitor in nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter() {
4528 let mut writer = test_utils::TestVecWriter(Vec::new());
4529 monitor.1.write(&mut writer).unwrap();
4530 node_0_monitors_serialized.push(writer.0);
4533 logger = test_utils::TestLogger::new();
4534 fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
4535 persister = test_utils::TestPersister::new();
4536 let keys_manager = &chanmon_cfgs[0].keys_manager;
4537 new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator, &persister, keys_manager);
4538 nodes[0].chain_monitor = &new_chain_monitor;
4541 let mut node_0_stale_monitors = Vec::new();
4542 for serialized in node_0_stale_monitors_serialized.iter() {
4543 let mut read = &serialized[..];
4544 let (_, monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(&mut read, keys_manager).unwrap();
4545 assert!(read.is_empty());
4546 node_0_stale_monitors.push(monitor);
4549 let mut node_0_monitors = Vec::new();
4550 for serialized in node_0_monitors_serialized.iter() {
4551 let mut read = &serialized[..];
4552 let (_, monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(&mut read, keys_manager).unwrap();
4553 assert!(read.is_empty());
4554 node_0_monitors.push(monitor);
4557 let mut nodes_0_read = &nodes_0_serialized[..];
4558 if let Err(msgs::DecodeError::InvalidValue) =
4559 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4560 default_config: UserConfig::default(),
4562 fee_estimator: &fee_estimator,
4563 chain_monitor: nodes[0].chain_monitor,
4564 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4566 channel_monitors: node_0_stale_monitors.iter_mut().map(|monitor| { (monitor.get_funding_txo().0, monitor) }).collect(),
4568 panic!("If the monitor(s) are stale, this indicates a bug and we should get an Err return");
4571 let mut nodes_0_read = &nodes_0_serialized[..];
4572 let (_, nodes_0_deserialized_tmp) =
4573 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4574 default_config: UserConfig::default(),
4576 fee_estimator: &fee_estimator,
4577 chain_monitor: nodes[0].chain_monitor,
4578 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4580 channel_monitors: node_0_monitors.iter_mut().map(|monitor| { (monitor.get_funding_txo().0, monitor) }).collect(),
4582 nodes_0_deserialized = nodes_0_deserialized_tmp;
4583 assert!(nodes_0_read.is_empty());
4585 { // Channel close should result in a commitment tx
4586 let txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4587 assert_eq!(txn.len(), 1);
4588 check_spends!(txn[0], funding_tx);
4589 assert_eq!(txn[0].input[0].previous_output.txid, funding_tx.txid());
4592 for monitor in node_0_monitors.drain(..) {
4593 assert!(nodes[0].chain_monitor.watch_channel(monitor.get_funding_txo().0, monitor).is_ok());
4594 check_added_monitors!(nodes[0], 1);
4596 nodes[0].node = &nodes_0_deserialized;
4598 // nodes[1] and nodes[2] have no lost state with nodes[0]...
4599 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
4600 reconnect_nodes(&nodes[0], &nodes[2], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
4601 //... and we can even still claim the payment!
4602 claim_payment(&nodes[2], &[&nodes[0], &nodes[1]], our_payment_preimage);
4604 nodes[3].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4605 let reestablish = get_event_msg!(nodes[3], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
4606 nodes[0].node.peer_connected(&nodes[3].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4607 nodes[0].node.handle_channel_reestablish(&nodes[3].node.get_our_node_id(), &reestablish);
4608 let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
4609 assert_eq!(msg_events.len(), 1);
4610 if let MessageSendEvent::HandleError { ref action, .. } = msg_events[0] {
4612 &ErrorAction::SendErrorMessage { ref msg } => {
4613 assert_eq!(msg.channel_id, channel_id);
4615 _ => panic!("Unexpected event!"),
4620 macro_rules! check_spendable_outputs {
4621 ($node: expr, $keysinterface: expr) => {
4623 let mut events = $node.chain_monitor.chain_monitor.get_and_clear_pending_events();
4624 let mut txn = Vec::new();
4625 let mut all_outputs = Vec::new();
4626 let secp_ctx = Secp256k1::new();
4627 for event in events.drain(..) {
4629 Event::SpendableOutputs { mut outputs } => {
4630 for outp in outputs.drain(..) {
4631 txn.push($keysinterface.backing.spend_spendable_outputs(&[&outp], Vec::new(), Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(), 253, &secp_ctx).unwrap());
4632 all_outputs.push(outp);
4635 _ => panic!("Unexpected event"),
4638 if all_outputs.len() > 1 {
4639 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) {
4649 fn test_claim_sizeable_push_msat() {
4650 // Incidentally test SpendableOutput event generation due to detection of to_local output on commitment tx
4651 let chanmon_cfgs = create_chanmon_cfgs(2);
4652 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4653 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4654 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4656 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 99000000, InitFeatures::known(), InitFeatures::known());
4657 nodes[1].node.force_close_channel(&chan.2).unwrap();
4658 check_closed_broadcast!(nodes[1], true);
4659 check_added_monitors!(nodes[1], 1);
4660 check_closed_event!(nodes[1], 1);
4661 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4662 assert_eq!(node_txn.len(), 1);
4663 check_spends!(node_txn[0], chan.3);
4664 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
4666 mine_transaction(&nodes[1], &node_txn[0]);
4667 connect_blocks(&nodes[1], BREAKDOWN_TIMEOUT as u32 - 1);
4669 let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
4670 assert_eq!(spend_txn.len(), 1);
4671 assert_eq!(spend_txn[0].input.len(), 1);
4672 check_spends!(spend_txn[0], node_txn[0]);
4673 assert_eq!(spend_txn[0].input[0].sequence, BREAKDOWN_TIMEOUT as u32);
4677 fn test_claim_on_remote_sizeable_push_msat() {
4678 // Same test as previous, just test on remote commitment tx, as per_commitment_point registration changes following you're funder/fundee and
4679 // to_remote output is encumbered by a P2WPKH
4680 let chanmon_cfgs = create_chanmon_cfgs(2);
4681 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4682 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4683 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4685 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 99000000, InitFeatures::known(), InitFeatures::known());
4686 nodes[0].node.force_close_channel(&chan.2).unwrap();
4687 check_closed_broadcast!(nodes[0], true);
4688 check_added_monitors!(nodes[0], 1);
4689 check_closed_event!(nodes[0], 1);
4691 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4692 assert_eq!(node_txn.len(), 1);
4693 check_spends!(node_txn[0], chan.3);
4694 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
4696 mine_transaction(&nodes[1], &node_txn[0]);
4697 check_closed_broadcast!(nodes[1], true);
4698 check_added_monitors!(nodes[1], 1);
4699 check_closed_event!(nodes[1], 1);
4700 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4702 let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
4703 assert_eq!(spend_txn.len(), 1);
4704 check_spends!(spend_txn[0], node_txn[0]);
4708 fn test_claim_on_remote_revoked_sizeable_push_msat() {
4709 // Same test as previous, just test on remote revoked commitment tx, as per_commitment_point registration changes following you're funder/fundee and
4710 // to_remote output is encumbered by a P2WPKH
4712 let chanmon_cfgs = create_chanmon_cfgs(2);
4713 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4714 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4715 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4717 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 59000000, InitFeatures::known(), InitFeatures::known());
4718 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4719 let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan.2);
4720 assert_eq!(revoked_local_txn[0].input.len(), 1);
4721 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
4723 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
4724 mine_transaction(&nodes[1], &revoked_local_txn[0]);
4725 check_closed_broadcast!(nodes[1], true);
4726 check_added_monitors!(nodes[1], 1);
4727 check_closed_event!(nodes[1], 1);
4729 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4730 mine_transaction(&nodes[1], &node_txn[0]);
4731 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4733 let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
4734 assert_eq!(spend_txn.len(), 3);
4735 check_spends!(spend_txn[0], revoked_local_txn[0]); // to_remote output on revoked remote commitment_tx
4736 check_spends!(spend_txn[1], node_txn[0]);
4737 check_spends!(spend_txn[2], revoked_local_txn[0], node_txn[0]); // Both outputs
4741 fn test_static_spendable_outputs_preimage_tx() {
4742 let chanmon_cfgs = create_chanmon_cfgs(2);
4743 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4744 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4745 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4747 // Create some initial channels
4748 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4750 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4752 let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
4753 assert_eq!(commitment_tx[0].input.len(), 1);
4754 assert_eq!(commitment_tx[0].input[0].previous_output.txid, chan_1.3.txid());
4756 // Settle A's commitment tx on B's chain
4757 assert!(nodes[1].node.claim_funds(payment_preimage));
4758 check_added_monitors!(nodes[1], 1);
4759 mine_transaction(&nodes[1], &commitment_tx[0]);
4760 check_added_monitors!(nodes[1], 1);
4761 let events = nodes[1].node.get_and_clear_pending_msg_events();
4763 MessageSendEvent::UpdateHTLCs { .. } => {},
4764 _ => panic!("Unexpected event"),
4767 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
4768 _ => panic!("Unexepected event"),
4771 // Check B's monitor was able to send back output descriptor event for preimage tx on A's commitment tx
4772 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap(); // ChannelManager : 2 (local commitment tx + HTLC-Success), ChannelMonitor: preimage tx
4773 assert_eq!(node_txn.len(), 3);
4774 check_spends!(node_txn[0], commitment_tx[0]);
4775 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
4776 check_spends!(node_txn[1], chan_1.3);
4777 check_spends!(node_txn[2], node_txn[1]);
4779 mine_transaction(&nodes[1], &node_txn[0]);
4780 check_closed_event!(nodes[1], 1);
4781 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4783 let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
4784 assert_eq!(spend_txn.len(), 1);
4785 check_spends!(spend_txn[0], node_txn[0]);
4789 fn test_static_spendable_outputs_timeout_tx() {
4790 let chanmon_cfgs = create_chanmon_cfgs(2);
4791 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4792 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4793 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4795 // Create some initial channels
4796 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4798 // Rebalance the network a bit by relaying one payment through all the channels ...
4799 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
4801 let (_, our_payment_hash, _) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3_000_000);
4803 let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
4804 assert_eq!(commitment_tx[0].input.len(), 1);
4805 assert_eq!(commitment_tx[0].input[0].previous_output.txid, chan_1.3.txid());
4807 // Settle A's commitment tx on B' chain
4808 mine_transaction(&nodes[1], &commitment_tx[0]);
4809 check_added_monitors!(nodes[1], 1);
4810 let events = nodes[1].node.get_and_clear_pending_msg_events();
4812 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
4813 _ => panic!("Unexpected event"),
4815 connect_blocks(&nodes[1], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
4817 // Check B's monitor was able to send back output descriptor event for timeout tx on A's commitment tx
4818 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
4819 assert_eq!(node_txn.len(), 2); // ChannelManager : 1 local commitent tx, ChannelMonitor: timeout tx
4820 check_spends!(node_txn[0], chan_1.3.clone());
4821 check_spends!(node_txn[1], commitment_tx[0].clone());
4822 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4824 mine_transaction(&nodes[1], &node_txn[1]);
4825 check_closed_event!(nodes[1], 1);
4826 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4827 let events = nodes[1].node.get_and_clear_pending_events();
4828 expect_payment_failed!(nodes[1], events, our_payment_hash, true);
4830 let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
4831 assert_eq!(spend_txn.len(), 3); // SpendableOutput: remote_commitment_tx.to_remote, timeout_tx.output
4832 check_spends!(spend_txn[0], commitment_tx[0]);
4833 check_spends!(spend_txn[1], node_txn[1]);
4834 check_spends!(spend_txn[2], node_txn[1], commitment_tx[0]); // All outputs
4838 fn test_static_spendable_outputs_justice_tx_revoked_commitment_tx() {
4839 let chanmon_cfgs = create_chanmon_cfgs(2);
4840 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4841 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4842 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4844 // Create some initial channels
4845 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4847 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4848 let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
4849 assert_eq!(revoked_local_txn[0].input.len(), 1);
4850 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
4852 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
4854 mine_transaction(&nodes[1], &revoked_local_txn[0]);
4855 check_closed_broadcast!(nodes[1], true);
4856 check_added_monitors!(nodes[1], 1);
4857 check_closed_event!(nodes[1], 1);
4859 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4860 assert_eq!(node_txn.len(), 2);
4861 assert_eq!(node_txn[0].input.len(), 2);
4862 check_spends!(node_txn[0], revoked_local_txn[0]);
4864 mine_transaction(&nodes[1], &node_txn[0]);
4865 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4867 let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
4868 assert_eq!(spend_txn.len(), 1);
4869 check_spends!(spend_txn[0], node_txn[0]);
4873 fn test_static_spendable_outputs_justice_tx_revoked_htlc_timeout_tx() {
4874 let mut chanmon_cfgs = create_chanmon_cfgs(2);
4875 chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
4876 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4877 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4878 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4880 // Create some initial channels
4881 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4883 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4884 let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
4885 assert_eq!(revoked_local_txn[0].input.len(), 1);
4886 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
4888 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
4890 // A will generate HTLC-Timeout from revoked commitment tx
4891 mine_transaction(&nodes[0], &revoked_local_txn[0]);
4892 check_closed_broadcast!(nodes[0], true);
4893 check_added_monitors!(nodes[0], 1);
4894 check_closed_event!(nodes[0], 1);
4895 connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
4897 let revoked_htlc_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4898 assert_eq!(revoked_htlc_txn.len(), 2);
4899 check_spends!(revoked_htlc_txn[0], chan_1.3);
4900 assert_eq!(revoked_htlc_txn[1].input.len(), 1);
4901 assert_eq!(revoked_htlc_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
4902 check_spends!(revoked_htlc_txn[1], revoked_local_txn[0]);
4903 assert_ne!(revoked_htlc_txn[1].lock_time, 0); // HTLC-Timeout
4905 // B will generate justice tx from A's revoked commitment/HTLC tx
4906 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4907 connect_block(&nodes[1], &Block { header, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[1].clone()] });
4908 check_closed_broadcast!(nodes[1], true);
4909 check_added_monitors!(nodes[1], 1);
4910 check_closed_event!(nodes[1], 1);
4912 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4913 assert_eq!(node_txn.len(), 3); // ChannelMonitor: bogus justice tx, justice tx on revoked outputs, ChannelManager: local commitment tx
4914 // The first transaction generated is bogus - it spends both outputs of revoked_local_txn[0]
4915 // including the one already spent by revoked_htlc_txn[1]. That's OK, we'll spend with valid
4916 // transactions next...
4917 assert_eq!(node_txn[0].input.len(), 3);
4918 check_spends!(node_txn[0], revoked_local_txn[0], revoked_htlc_txn[1]);
4920 assert_eq!(node_txn[1].input.len(), 2);
4921 check_spends!(node_txn[1], revoked_local_txn[0], revoked_htlc_txn[1]);
4922 if node_txn[1].input[1].previous_output.txid == revoked_htlc_txn[1].txid() {
4923 assert_ne!(node_txn[1].input[0].previous_output, revoked_htlc_txn[1].input[0].previous_output);
4925 assert_eq!(node_txn[1].input[0].previous_output.txid, revoked_htlc_txn[1].txid());
4926 assert_ne!(node_txn[1].input[1].previous_output, revoked_htlc_txn[1].input[0].previous_output);
4929 assert_eq!(node_txn[2].input.len(), 1);
4930 check_spends!(node_txn[2], chan_1.3);
4932 mine_transaction(&nodes[1], &node_txn[1]);
4933 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4935 // Check B's ChannelMonitor was able to generate the right spendable output descriptor
4936 let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
4937 assert_eq!(spend_txn.len(), 1);
4938 assert_eq!(spend_txn[0].input.len(), 1);
4939 check_spends!(spend_txn[0], node_txn[1]);
4943 fn test_static_spendable_outputs_justice_tx_revoked_htlc_success_tx() {
4944 let mut chanmon_cfgs = create_chanmon_cfgs(2);
4945 chanmon_cfgs[1].keys_manager.disable_revocation_policy_check = true;
4946 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4947 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4948 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4950 // Create some initial channels
4951 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4953 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4954 let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan_1.2);
4955 assert_eq!(revoked_local_txn[0].input.len(), 1);
4956 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
4958 // The to-be-revoked commitment tx should have one HTLC and one to_remote output
4959 assert_eq!(revoked_local_txn[0].output.len(), 2);
4961 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
4963 // B will generate HTLC-Success from revoked commitment tx
4964 mine_transaction(&nodes[1], &revoked_local_txn[0]);
4965 check_closed_broadcast!(nodes[1], true);
4966 check_added_monitors!(nodes[1], 1);
4967 check_closed_event!(nodes[1], 1);
4968 let revoked_htlc_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4970 assert_eq!(revoked_htlc_txn.len(), 2);
4971 assert_eq!(revoked_htlc_txn[0].input.len(), 1);
4972 assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4973 check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
4975 // Check that the unspent (of two) outputs on revoked_local_txn[0] is a P2WPKH:
4976 let unspent_local_txn_output = revoked_htlc_txn[0].input[0].previous_output.vout as usize ^ 1;
4977 assert_eq!(revoked_local_txn[0].output[unspent_local_txn_output].script_pubkey.len(), 2 + 20); // P2WPKH
4979 // A will generate justice tx from B's revoked commitment/HTLC tx
4980 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4981 connect_block(&nodes[0], &Block { header, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[0].clone()] });
4982 check_closed_broadcast!(nodes[0], true);
4983 check_added_monitors!(nodes[0], 1);
4984 check_closed_event!(nodes[0], 1);
4986 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4987 assert_eq!(node_txn.len(), 3); // ChannelMonitor: justice tx on revoked commitment, justice tx on revoked HTLC-success, ChannelManager: local commitment tx
4989 // The first transaction generated is bogus - it spends both outputs of revoked_local_txn[0]
4990 // including the one already spent by revoked_htlc_txn[0]. That's OK, we'll spend with valid
4991 // transactions next...
4992 assert_eq!(node_txn[0].input.len(), 2);
4993 check_spends!(node_txn[0], revoked_local_txn[0], revoked_htlc_txn[0]);
4994 if node_txn[0].input[1].previous_output.txid == revoked_htlc_txn[0].txid() {
4995 assert_eq!(node_txn[0].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
4997 assert_eq!(node_txn[0].input[0].previous_output.txid, revoked_htlc_txn[0].txid());
4998 assert_eq!(node_txn[0].input[1].previous_output, revoked_htlc_txn[0].input[0].previous_output);
5001 assert_eq!(node_txn[1].input.len(), 1);
5002 check_spends!(node_txn[1], revoked_htlc_txn[0]);
5004 check_spends!(node_txn[2], chan_1.3);
5006 mine_transaction(&nodes[0], &node_txn[1]);
5007 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
5009 // Note that nodes[0]'s tx_broadcaster is still locked, so if we get here the channelmonitor
5010 // didn't try to generate any new transactions.
5012 // Check A's ChannelMonitor was able to generate the right spendable output descriptor
5013 let spend_txn = check_spendable_outputs!(nodes[0], node_cfgs[0].keys_manager);
5014 assert_eq!(spend_txn.len(), 3);
5015 assert_eq!(spend_txn[0].input.len(), 1);
5016 check_spends!(spend_txn[0], revoked_local_txn[0]); // spending to_remote output from revoked local tx
5017 assert_ne!(spend_txn[0].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
5018 check_spends!(spend_txn[1], node_txn[1]); // spending justice tx output on the htlc success tx
5019 check_spends!(spend_txn[2], revoked_local_txn[0], node_txn[1]); // Both outputs
5023 fn test_onchain_to_onchain_claim() {
5024 // Test that in case of channel closure, we detect the state of output and claim HTLC
5025 // on downstream peer's remote commitment tx.
5026 // First, have C claim an HTLC against its own latest commitment transaction.
5027 // Then, broadcast these to B, which should update the monitor downstream on the A<->B
5029 // Finally, check that B will claim the HTLC output if A's latest commitment transaction
5032 let chanmon_cfgs = create_chanmon_cfgs(3);
5033 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5034 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5035 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5037 // Create some initial channels
5038 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5039 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
5041 // Ensure all nodes are at the same height
5042 let node_max_height = nodes.iter().map(|node| node.blocks.lock().unwrap().len()).max().unwrap() as u32;
5043 connect_blocks(&nodes[0], node_max_height - nodes[0].best_block_info().1);
5044 connect_blocks(&nodes[1], node_max_height - nodes[1].best_block_info().1);
5045 connect_blocks(&nodes[2], node_max_height - nodes[2].best_block_info().1);
5047 // Rebalance the network a bit by relaying one payment through all the channels ...
5048 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
5049 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
5051 let (payment_preimage, _payment_hash, _payment_secret) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
5052 let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
5053 check_spends!(commitment_tx[0], chan_2.3);
5054 nodes[2].node.claim_funds(payment_preimage);
5055 check_added_monitors!(nodes[2], 1);
5056 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
5057 assert!(updates.update_add_htlcs.is_empty());
5058 assert!(updates.update_fail_htlcs.is_empty());
5059 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
5060 assert!(updates.update_fail_malformed_htlcs.is_empty());
5062 mine_transaction(&nodes[2], &commitment_tx[0]);
5063 check_closed_broadcast!(nodes[2], true);
5064 check_added_monitors!(nodes[2], 1);
5065 check_closed_event!(nodes[2], 1);
5067 let c_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 2 (commitment tx, HTLC-Success tx), ChannelMonitor : 1 (HTLC-Success tx)
5068 assert_eq!(c_txn.len(), 3);
5069 assert_eq!(c_txn[0], c_txn[2]);
5070 assert_eq!(commitment_tx[0], c_txn[1]);
5071 check_spends!(c_txn[1], chan_2.3);
5072 check_spends!(c_txn[2], c_txn[1]);
5073 assert_eq!(c_txn[1].input[0].witness.clone().last().unwrap().len(), 71);
5074 assert_eq!(c_txn[2].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5075 assert!(c_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
5076 assert_eq!(c_txn[0].lock_time, 0); // Success tx
5078 // 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
5079 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
5080 connect_block(&nodes[1], &Block { header, txdata: vec![c_txn[1].clone(), c_txn[2].clone()]});
5081 check_added_monitors!(nodes[1], 1);
5082 expect_payment_forwarded!(nodes[1], Some(1000), true);
5084 let mut b_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5085 // ChannelMonitor: claim tx
5086 assert_eq!(b_txn.len(), 1);
5087 check_spends!(b_txn[0], chan_2.3); // B local commitment tx, issued by ChannelManager
5090 check_added_monitors!(nodes[1], 1);
5091 check_closed_event!(nodes[1], 1);
5092 let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
5093 assert_eq!(msg_events.len(), 3);
5094 check_added_monitors!(nodes[1], 1);
5095 match msg_events[0] {
5096 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5097 _ => panic!("Unexpected event"),
5099 match msg_events[1] {
5100 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { .. }, node_id: _ } => {},
5101 _ => panic!("Unexpected event"),
5103 match msg_events[2] {
5104 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, .. } } => {
5105 assert!(update_add_htlcs.is_empty());
5106 assert!(update_fail_htlcs.is_empty());
5107 assert_eq!(update_fulfill_htlcs.len(), 1);
5108 assert!(update_fail_malformed_htlcs.is_empty());
5109 assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
5111 _ => panic!("Unexpected event"),
5113 // Broadcast A's commitment tx on B's chain to see if we are able to claim inbound HTLC with our HTLC-Success tx
5114 let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
5115 mine_transaction(&nodes[1], &commitment_tx[0]);
5116 check_closed_event!(nodes[1], 1);
5117 let b_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5118 // ChannelMonitor: HTLC-Success tx, ChannelManager: local commitment tx + HTLC-Success tx
5119 assert_eq!(b_txn.len(), 3);
5120 check_spends!(b_txn[1], chan_1.3);
5121 check_spends!(b_txn[2], b_txn[1]);
5122 check_spends!(b_txn[0], commitment_tx[0]);
5123 assert_eq!(b_txn[0].input[0].witness.clone().last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5124 assert!(b_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
5125 assert_eq!(b_txn[0].lock_time, 0); // Success tx
5127 check_closed_broadcast!(nodes[1], true);
5128 check_added_monitors!(nodes[1], 1);
5132 fn test_duplicate_payment_hash_one_failure_one_success() {
5133 // Topology : A --> B --> C --> D
5134 // We route 2 payments with same hash between B and C, one will be timeout, the other successfully claim
5135 // Note that because C will refuse to generate two payment secrets for the same payment hash,
5136 // we forward one of the payments onwards to D.
5137 let chanmon_cfgs = create_chanmon_cfgs(4);
5138 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
5139 // When this test was written, the default base fee floated based on the HTLC count.
5140 // It is now fixed, so we simply set the fee to the expected value here.
5141 let mut config = test_default_channel_config();
5142 config.channel_options.forwarding_fee_base_msat = 196;
5143 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs,
5144 &[Some(config.clone()), Some(config.clone()), Some(config.clone()), Some(config.clone())]);
5145 let mut nodes = create_network(4, &node_cfgs, &node_chanmgrs);
5147 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5148 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
5149 create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
5151 let node_max_height = nodes.iter().map(|node| node.blocks.lock().unwrap().len()).max().unwrap() as u32;
5152 connect_blocks(&nodes[0], node_max_height - nodes[0].best_block_info().1);
5153 connect_blocks(&nodes[1], node_max_height - nodes[1].best_block_info().1);
5154 connect_blocks(&nodes[2], node_max_height - nodes[2].best_block_info().1);
5155 connect_blocks(&nodes[3], node_max_height - nodes[3].best_block_info().1);
5157 let (our_payment_preimage, duplicate_payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 900000);
5159 let payment_secret = nodes[3].node.create_inbound_payment_for_hash(duplicate_payment_hash, None, 7200, 0).unwrap();
5160 // We reduce the final CLTV here by a somewhat arbitrary constant to keep it under the one-byte
5161 // script push size limit so that the below script length checks match
5162 // ACCEPTED_HTLC_SCRIPT_WEIGHT.
5163 let route = get_route(&nodes[0].node.get_our_node_id(), &nodes[0].net_graph_msg_handler.network_graph,
5164 &nodes[3].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 900000, TEST_FINAL_CLTV - 40, nodes[0].logger).unwrap();
5165 send_along_route_with_secret(&nodes[0], route, &[&[&nodes[1], &nodes[2], &nodes[3]]], 900000, duplicate_payment_hash, payment_secret);
5167 let commitment_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
5168 assert_eq!(commitment_txn[0].input.len(), 1);
5169 check_spends!(commitment_txn[0], chan_2.3);
5171 mine_transaction(&nodes[1], &commitment_txn[0]);
5172 check_closed_broadcast!(nodes[1], true);
5173 check_added_monitors!(nodes[1], 1);
5174 check_closed_event!(nodes[1], 1);
5175 connect_blocks(&nodes[1], TEST_FINAL_CLTV - 40 + MIN_CLTV_EXPIRY_DELTA as u32 - 1); // Confirm blocks until the HTLC expires
5177 let htlc_timeout_tx;
5178 { // Extract one of the two HTLC-Timeout transaction
5179 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5180 // ChannelMonitor: timeout tx * 3, ChannelManager: local commitment tx
5181 assert_eq!(node_txn.len(), 4);
5182 check_spends!(node_txn[0], chan_2.3);
5184 check_spends!(node_txn[1], commitment_txn[0]);
5185 assert_eq!(node_txn[1].input.len(), 1);
5186 check_spends!(node_txn[2], commitment_txn[0]);
5187 assert_eq!(node_txn[2].input.len(), 1);
5188 assert_eq!(node_txn[1].input[0].previous_output, node_txn[2].input[0].previous_output);
5189 check_spends!(node_txn[3], commitment_txn[0]);
5190 assert_ne!(node_txn[1].input[0].previous_output, node_txn[3].input[0].previous_output);
5192 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5193 assert_eq!(node_txn[2].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5194 assert_eq!(node_txn[3].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5195 htlc_timeout_tx = node_txn[1].clone();
5198 nodes[2].node.claim_funds(our_payment_preimage);
5199 mine_transaction(&nodes[2], &commitment_txn[0]);
5200 check_added_monitors!(nodes[2], 2);
5201 check_closed_event!(nodes[2], 1);
5202 let events = nodes[2].node.get_and_clear_pending_msg_events();
5204 MessageSendEvent::UpdateHTLCs { .. } => {},
5205 _ => panic!("Unexpected event"),
5208 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5209 _ => panic!("Unexepected event"),
5211 let htlc_success_txn: Vec<_> = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
5212 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)
5213 check_spends!(htlc_success_txn[0], commitment_txn[0]);
5214 check_spends!(htlc_success_txn[1], commitment_txn[0]);
5215 assert_eq!(htlc_success_txn[0].input.len(), 1);
5216 assert_eq!(htlc_success_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5217 assert_eq!(htlc_success_txn[1].input.len(), 1);
5218 assert_eq!(htlc_success_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5219 assert_ne!(htlc_success_txn[0].input[0].previous_output, htlc_success_txn[1].input[0].previous_output);
5220 assert_eq!(htlc_success_txn[2], commitment_txn[0]);
5221 assert_eq!(htlc_success_txn[3], htlc_success_txn[0]);
5222 assert_eq!(htlc_success_txn[4], htlc_success_txn[1]);
5223 assert_ne!(htlc_success_txn[0].input[0].previous_output, htlc_timeout_tx.input[0].previous_output);
5225 mine_transaction(&nodes[1], &htlc_timeout_tx);
5226 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
5227 let events = nodes[1].node.get_and_clear_pending_events();
5228 expect_pending_htlcs_forwardable!(nodes[1], events);
5229 let htlc_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5230 assert!(htlc_updates.update_add_htlcs.is_empty());
5231 assert_eq!(htlc_updates.update_fail_htlcs.len(), 1);
5232 let first_htlc_id = htlc_updates.update_fail_htlcs[0].htlc_id;
5233 assert!(htlc_updates.update_fulfill_htlcs.is_empty());
5234 assert!(htlc_updates.update_fail_malformed_htlcs.is_empty());
5235 check_added_monitors!(nodes[1], 1);
5237 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_updates.update_fail_htlcs[0]);
5238 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
5240 commitment_signed_dance!(nodes[0], nodes[1], &htlc_updates.commitment_signed, false, true);
5242 expect_payment_failed_with_update!(nodes[0], duplicate_payment_hash, false, chan_2.0.contents.short_channel_id, true);
5244 // Solve 2nd HTLC by broadcasting on B's chain HTLC-Success Tx from C
5245 // Note that the fee paid is effectively double as the HTLC value (including the nodes[1] fee
5246 // and nodes[2] fee) is rounded down and then claimed in full.
5247 mine_transaction(&nodes[1], &htlc_success_txn[0]);
5248 expect_payment_forwarded!(nodes[1], Some(196*2), true);
5249 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5250 assert!(updates.update_add_htlcs.is_empty());
5251 assert!(updates.update_fail_htlcs.is_empty());
5252 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
5253 assert_ne!(updates.update_fulfill_htlcs[0].htlc_id, first_htlc_id);
5254 assert!(updates.update_fail_malformed_htlcs.is_empty());
5255 check_added_monitors!(nodes[1], 1);
5257 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
5258 commitment_signed_dance!(nodes[0], nodes[1], &updates.commitment_signed, false);
5260 let events = nodes[0].node.get_and_clear_pending_events();
5262 Event::PaymentSent { ref payment_preimage } => {
5263 assert_eq!(*payment_preimage, our_payment_preimage);
5265 _ => panic!("Unexpected event"),
5270 fn test_dynamic_spendable_outputs_local_htlc_success_tx() {
5271 let chanmon_cfgs = create_chanmon_cfgs(2);
5272 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5273 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5274 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5276 // Create some initial channels
5277 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5279 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000).0;
5280 let local_txn = get_local_commitment_txn!(nodes[1], chan_1.2);
5281 assert_eq!(local_txn.len(), 1);
5282 assert_eq!(local_txn[0].input.len(), 1);
5283 check_spends!(local_txn[0], chan_1.3);
5285 // Give B knowledge of preimage to be able to generate a local HTLC-Success Tx
5286 nodes[1].node.claim_funds(payment_preimage);
5287 check_added_monitors!(nodes[1], 1);
5288 mine_transaction(&nodes[1], &local_txn[0]);
5289 check_added_monitors!(nodes[1], 1);
5290 check_closed_event!(nodes[1], 1);
5291 let events = nodes[1].node.get_and_clear_pending_msg_events();
5293 MessageSendEvent::UpdateHTLCs { .. } => {},
5294 _ => panic!("Unexpected event"),
5297 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5298 _ => panic!("Unexepected event"),
5301 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5302 assert_eq!(node_txn.len(), 3);
5303 assert_eq!(node_txn[0], node_txn[2]);
5304 assert_eq!(node_txn[1], local_txn[0]);
5305 assert_eq!(node_txn[0].input.len(), 1);
5306 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5307 check_spends!(node_txn[0], local_txn[0]);
5311 mine_transaction(&nodes[1], &node_tx);
5312 connect_blocks(&nodes[1], BREAKDOWN_TIMEOUT as u32 - 1);
5314 // Verify that B is able to spend its own HTLC-Success tx thanks to spendable output event given back by its ChannelMonitor
5315 let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
5316 assert_eq!(spend_txn.len(), 1);
5317 assert_eq!(spend_txn[0].input.len(), 1);
5318 check_spends!(spend_txn[0], node_tx);
5319 assert_eq!(spend_txn[0].input[0].sequence, BREAKDOWN_TIMEOUT as u32);
5322 fn do_test_fail_backwards_unrevoked_remote_announce(deliver_last_raa: bool, announce_latest: bool) {
5323 // Test that we fail backwards the full set of HTLCs we need to when remote broadcasts an
5324 // unrevoked commitment transaction.
5325 // This includes HTLCs which were below the dust threshold as well as HTLCs which were awaiting
5326 // a remote RAA before they could be failed backwards (and combinations thereof).
5327 // We also test duplicate-hash HTLCs by adding two nodes on each side of the target nodes which
5328 // use the same payment hashes.
5329 // Thus, we use a six-node network:
5334 // And test where C fails back to A/B when D announces its latest commitment transaction
5335 let chanmon_cfgs = create_chanmon_cfgs(6);
5336 let node_cfgs = create_node_cfgs(6, &chanmon_cfgs);
5337 // When this test was written, the default base fee floated based on the HTLC count.
5338 // It is now fixed, so we simply set the fee to the expected value here.
5339 let mut config = test_default_channel_config();
5340 config.channel_options.forwarding_fee_base_msat = 196;
5341 let node_chanmgrs = create_node_chanmgrs(6, &node_cfgs,
5342 &[Some(config.clone()), Some(config.clone()), Some(config.clone()), Some(config.clone()), Some(config.clone()), Some(config.clone())]);
5343 let nodes = create_network(6, &node_cfgs, &node_chanmgrs);
5344 let logger = test_utils::TestLogger::new();
5346 create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known());
5347 create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
5348 let chan = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
5349 create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::known(), InitFeatures::known());
5350 create_announced_chan_between_nodes(&nodes, 3, 5, InitFeatures::known(), InitFeatures::known());
5352 // Rebalance and check output sanity...
5353 send_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 500000);
5354 send_payment(&nodes[1], &[&nodes[2], &nodes[3], &nodes[5]], 500000);
5355 assert_eq!(get_local_commitment_txn!(nodes[3], chan.2)[0].output.len(), 2);
5357 let ds_dust_limit = nodes[3].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().holder_dust_limit_satoshis;
5359 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
5361 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
5362 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
5363 let our_node_id = &nodes[1].node.get_our_node_id();
5364 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();
5366 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
5368 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
5370 let (_, payment_hash_3, _) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
5372 let (_, payment_hash_4, _) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
5373 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();
5375 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());
5377 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());
5380 let (_, payment_hash_5, _) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
5382 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();
5383 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
5386 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
5388 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();
5389 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());
5391 // Double-check that six of the new HTLC were added
5392 // We now have six HTLCs pending over the dust limit and six HTLCs under the dust limit (ie,
5393 // with to_local and to_remote outputs, 8 outputs and 6 HTLCs not included).
5394 assert_eq!(get_local_commitment_txn!(nodes[3], chan.2).len(), 1);
5395 assert_eq!(get_local_commitment_txn!(nodes[3], chan.2)[0].output.len(), 8);
5397 // Now fail back three of the over-dust-limit and three of the under-dust-limit payments in one go.
5398 // Fail 0th below-dust, 4th above-dust, 8th above-dust, 10th below-dust HTLCs
5399 assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_1));
5400 assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_3));
5401 assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_5));
5402 assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_6));
5403 check_added_monitors!(nodes[4], 0);
5404 let events = nodes[4].node.get_and_clear_pending_events();
5405 expect_pending_htlcs_forwardable!(nodes[4], events);
5406 check_added_monitors!(nodes[4], 1);
5408 let four_removes = get_htlc_update_msgs!(nodes[4], nodes[3].node.get_our_node_id());
5409 nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[0]);
5410 nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[1]);
5411 nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[2]);
5412 nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[3]);
5413 commitment_signed_dance!(nodes[3], nodes[4], four_removes.commitment_signed, false);
5415 // Fail 3rd below-dust and 7th above-dust HTLCs
5416 assert!(nodes[5].node.fail_htlc_backwards(&payment_hash_2));
5417 assert!(nodes[5].node.fail_htlc_backwards(&payment_hash_4));
5418 check_added_monitors!(nodes[5], 0);
5419 let events = nodes[5].node.get_and_clear_pending_events();
5420 expect_pending_htlcs_forwardable!(nodes[5], events);
5421 check_added_monitors!(nodes[5], 1);
5423 let two_removes = get_htlc_update_msgs!(nodes[5], nodes[3].node.get_our_node_id());
5424 nodes[3].node.handle_update_fail_htlc(&nodes[5].node.get_our_node_id(), &two_removes.update_fail_htlcs[0]);
5425 nodes[3].node.handle_update_fail_htlc(&nodes[5].node.get_our_node_id(), &two_removes.update_fail_htlcs[1]);
5426 commitment_signed_dance!(nodes[3], nodes[5], two_removes.commitment_signed, false);
5428 let ds_prev_commitment_tx = get_local_commitment_txn!(nodes[3], chan.2);
5430 let events = nodes[3].node.get_and_clear_pending_events();
5431 expect_pending_htlcs_forwardable!(nodes[3], events);
5432 check_added_monitors!(nodes[3], 1);
5433 let six_removes = get_htlc_update_msgs!(nodes[3], nodes[2].node.get_our_node_id());
5434 nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[0]);
5435 nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[1]);
5436 nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[2]);
5437 nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[3]);
5438 nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[4]);
5439 nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[5]);
5440 if deliver_last_raa {
5441 commitment_signed_dance!(nodes[2], nodes[3], six_removes.commitment_signed, false);
5443 let _cs_last_raa = commitment_signed_dance!(nodes[2], nodes[3], six_removes.commitment_signed, false, true, false, true);
5446 // D's latest commitment transaction now contains 1st + 2nd + 9th HTLCs (implicitly, they're
5447 // below the dust limit) and the 5th + 6th + 11th HTLCs. It has failed back the 0th, 3rd, 4th,
5448 // 7th, 8th, and 10th, but as we haven't yet delivered the final RAA to C, the fails haven't
5449 // propagated back to A/B yet (and D has two unrevoked commitment transactions).
5451 // We now broadcast the latest commitment transaction, which *should* result in failures for
5452 // the 0th, 1st, 2nd, 3rd, 4th, 7th, 8th, 9th, and 10th HTLCs, ie all the below-dust HTLCs and
5453 // the non-broadcast above-dust HTLCs.
5455 // Alternatively, we may broadcast the previous commitment transaction, which should only
5456 // result in failures for the below-dust HTLCs, ie the 0th, 1st, 2nd, 3rd, 9th, and 10th HTLCs.
5457 let ds_last_commitment_tx = get_local_commitment_txn!(nodes[3], chan.2);
5459 if announce_latest {
5460 mine_transaction(&nodes[2], &ds_last_commitment_tx[0]);
5461 let events = nodes[2].node.get_and_clear_pending_events();
5462 if deliver_last_raa {
5463 assert_eq!(events.len(), 2);
5465 Event::ChannelClosed { .. } => {}
5466 _ => panic!("Unexpected event"),
5468 connect_blocks(&nodes[2], ANTI_REORG_DELAY - 1);
5469 check_closed_broadcast!(nodes[2], true);
5470 expect_pending_htlcs_forwardable!(nodes[2], events[0..1]);
5472 assert_eq!(events.len(), 1);
5474 Event::ChannelClosed { .. } => {}
5475 _ => panic!("Unexpected event"),
5477 connect_blocks(&nodes[2], ANTI_REORG_DELAY - 1);
5478 check_closed_broadcast!(nodes[2], true);
5479 let events = nodes[2].node.get_and_clear_pending_events();
5480 expect_pending_htlcs_forwardable!(nodes[2], events);
5483 mine_transaction(&nodes[2], &ds_prev_commitment_tx[0]);
5484 let events = nodes[2].node.get_and_clear_pending_events();
5485 if deliver_last_raa {
5486 assert_eq!(events.len(), 2);
5488 Event::ChannelClosed { .. } => {}
5489 _ => panic!("Unexpected event"),
5491 connect_blocks(&nodes[2], ANTI_REORG_DELAY - 1);
5492 check_closed_broadcast!(nodes[2], true);
5493 expect_pending_htlcs_forwardable!(nodes[2], events[0..1]);
5495 assert_eq!(events.len(), 1);
5497 Event::ChannelClosed { .. } => {}
5498 _ => panic!("Unexpected event"),
5500 connect_blocks(&nodes[2], ANTI_REORG_DELAY - 1);
5501 check_closed_broadcast!(nodes[2], true);
5502 let events = nodes[2].node.get_and_clear_pending_events();
5503 expect_pending_htlcs_forwardable!(nodes[2], events);
5506 check_added_monitors!(nodes[2], 3);
5508 let cs_msgs = nodes[2].node.get_and_clear_pending_msg_events();
5509 assert_eq!(cs_msgs.len(), 2);
5510 let mut a_done = false;
5511 for msg in cs_msgs {
5513 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
5514 // Both under-dust HTLCs and the one above-dust HTLC that we had already failed
5515 // should be failed-backwards here.
5516 let target = if *node_id == nodes[0].node.get_our_node_id() {
5517 // If announce_latest, expect 0th, 1st, 4th, 8th, 10th HTLCs, else only 0th, 1st, 10th below-dust HTLCs
5518 for htlc in &updates.update_fail_htlcs {
5519 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 });
5521 assert_eq!(updates.update_fail_htlcs.len(), if announce_latest { 5 } else { 3 });
5526 // If announce_latest, expect 2nd, 3rd, 7th, 9th HTLCs, else only 2nd, 3rd, 9th below-dust HTLCs
5527 for htlc in &updates.update_fail_htlcs {
5528 assert!(htlc.htlc_id == 1 || htlc.htlc_id == 2 || htlc.htlc_id == 5 || if announce_latest { htlc.htlc_id == 4 } else { false });
5530 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
5531 assert_eq!(updates.update_fail_htlcs.len(), if announce_latest { 4 } else { 3 });
5534 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
5535 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[1]);
5536 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[2]);
5537 if announce_latest {
5538 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[3]);
5539 if *node_id == nodes[0].node.get_our_node_id() {
5540 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[4]);
5543 commitment_signed_dance!(target, nodes[2], updates.commitment_signed, false, true);
5545 _ => panic!("Unexpected event"),
5549 let as_events = nodes[0].node.get_and_clear_pending_events();
5550 assert_eq!(as_events.len(), if announce_latest { 5 } else { 3 });
5551 let mut as_failds = HashSet::new();
5552 let mut as_updates = 0;
5553 for event in as_events.iter() {
5554 if let &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, ref network_update, .. } = event {
5555 assert!(as_failds.insert(*payment_hash));
5556 if *payment_hash != payment_hash_2 {
5557 assert_eq!(*rejected_by_dest, deliver_last_raa);
5559 assert!(!rejected_by_dest);
5561 if network_update.is_some() {
5564 } else { panic!("Unexpected event"); }
5566 assert!(as_failds.contains(&payment_hash_1));
5567 assert!(as_failds.contains(&payment_hash_2));
5568 if announce_latest {
5569 assert!(as_failds.contains(&payment_hash_3));
5570 assert!(as_failds.contains(&payment_hash_5));
5572 assert!(as_failds.contains(&payment_hash_6));
5574 let bs_events = nodes[1].node.get_and_clear_pending_events();
5575 assert_eq!(bs_events.len(), if announce_latest { 4 } else { 3 });
5576 let mut bs_failds = HashSet::new();
5577 let mut bs_updates = 0;
5578 for event in bs_events.iter() {
5579 if let &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, ref network_update, .. } = event {
5580 assert!(bs_failds.insert(*payment_hash));
5581 if *payment_hash != payment_hash_1 && *payment_hash != payment_hash_5 {
5582 assert_eq!(*rejected_by_dest, deliver_last_raa);
5584 assert!(!rejected_by_dest);
5586 if network_update.is_some() {
5589 } else { panic!("Unexpected event"); }
5591 assert!(bs_failds.contains(&payment_hash_1));
5592 assert!(bs_failds.contains(&payment_hash_2));
5593 if announce_latest {
5594 assert!(bs_failds.contains(&payment_hash_4));
5596 assert!(bs_failds.contains(&payment_hash_5));
5598 // For each HTLC which was not failed-back by normal process (ie deliver_last_raa), we should
5599 // get a NetworkUpdate. A should have gotten 4 HTLCs which were failed-back due to
5600 // unknown-preimage-etc, B should have gotten 2. Thus, in the
5601 // announce_latest && deliver_last_raa case, we should have 5-4=1 and 4-2=2 NetworkUpdates.
5602 assert_eq!(as_updates, if deliver_last_raa { 1 } else if !announce_latest { 3 } else { 5 });
5603 assert_eq!(bs_updates, if deliver_last_raa { 2 } else if !announce_latest { 3 } else { 4 });
5607 fn test_fail_backwards_latest_remote_announce_a() {
5608 do_test_fail_backwards_unrevoked_remote_announce(false, true);
5612 fn test_fail_backwards_latest_remote_announce_b() {
5613 do_test_fail_backwards_unrevoked_remote_announce(true, true);
5617 fn test_fail_backwards_previous_remote_announce() {
5618 do_test_fail_backwards_unrevoked_remote_announce(false, false);
5619 // Note that true, true doesn't make sense as it implies we announce a revoked state, which is
5620 // tested for in test_commitment_revoked_fail_backward_exhaustive()
5624 fn test_dynamic_spendable_outputs_local_htlc_timeout_tx() {
5625 let chanmon_cfgs = create_chanmon_cfgs(2);
5626 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5627 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5628 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5630 // Create some initial channels
5631 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5633 let (_, our_payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000);
5634 let local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
5635 assert_eq!(local_txn[0].input.len(), 1);
5636 check_spends!(local_txn[0], chan_1.3);
5638 // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
5639 mine_transaction(&nodes[0], &local_txn[0]);
5640 check_closed_broadcast!(nodes[0], true);
5641 check_added_monitors!(nodes[0], 1);
5642 check_closed_event!(nodes[0], 1);
5643 connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
5645 let htlc_timeout = {
5646 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5647 assert_eq!(node_txn.len(), 2);
5648 check_spends!(node_txn[0], chan_1.3);
5649 assert_eq!(node_txn[1].input.len(), 1);
5650 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5651 check_spends!(node_txn[1], local_txn[0]);
5655 mine_transaction(&nodes[0], &htlc_timeout);
5656 connect_blocks(&nodes[0], BREAKDOWN_TIMEOUT as u32 - 1);
5657 let events = nodes[0].node.get_and_clear_pending_events();
5658 expect_payment_failed!(nodes[0], events, our_payment_hash, true);
5660 // Verify that A is able to spend its own HTLC-Timeout tx thanks to spendable output event given back by its ChannelMonitor
5661 let spend_txn = check_spendable_outputs!(nodes[0], node_cfgs[0].keys_manager);
5662 assert_eq!(spend_txn.len(), 3);
5663 check_spends!(spend_txn[0], local_txn[0]);
5664 assert_eq!(spend_txn[1].input.len(), 1);
5665 check_spends!(spend_txn[1], htlc_timeout);
5666 assert_eq!(spend_txn[1].input[0].sequence, BREAKDOWN_TIMEOUT as u32);
5667 assert_eq!(spend_txn[2].input.len(), 2);
5668 check_spends!(spend_txn[2], local_txn[0], htlc_timeout);
5669 assert!(spend_txn[2].input[0].sequence == BREAKDOWN_TIMEOUT as u32 ||
5670 spend_txn[2].input[1].sequence == BREAKDOWN_TIMEOUT as u32);
5674 fn test_key_derivation_params() {
5675 // This test is a copy of test_dynamic_spendable_outputs_local_htlc_timeout_tx, with
5676 // a key manager rotation to test that key_derivation_params returned in DynamicOutputP2WSH
5677 // let us re-derive the channel key set to then derive a delayed_payment_key.
5679 let chanmon_cfgs = create_chanmon_cfgs(3);
5681 // We manually create the node configuration to backup the seed.
5682 let seed = [42; 32];
5683 let keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
5684 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);
5685 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() };
5686 let mut node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5687 node_cfgs.remove(0);
5688 node_cfgs.insert(0, node);
5690 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5691 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5693 // Create some initial channels
5694 // Create a dummy channel to advance index by one and thus test re-derivation correctness
5696 let chan_0 = create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known());
5697 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5698 assert_ne!(chan_0.3.output[0].script_pubkey, chan_1.3.output[0].script_pubkey);
5700 // Ensure all nodes are at the same height
5701 let node_max_height = nodes.iter().map(|node| node.blocks.lock().unwrap().len()).max().unwrap() as u32;
5702 connect_blocks(&nodes[0], node_max_height - nodes[0].best_block_info().1);
5703 connect_blocks(&nodes[1], node_max_height - nodes[1].best_block_info().1);
5704 connect_blocks(&nodes[2], node_max_height - nodes[2].best_block_info().1);
5706 let (_, our_payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000);
5707 let local_txn_0 = get_local_commitment_txn!(nodes[0], chan_0.2);
5708 let local_txn_1 = get_local_commitment_txn!(nodes[0], chan_1.2);
5709 assert_eq!(local_txn_1[0].input.len(), 1);
5710 check_spends!(local_txn_1[0], chan_1.3);
5712 // We check funding pubkey are unique
5713 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]));
5714 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]));
5715 if from_0_funding_key_0 == from_1_funding_key_0
5716 || from_0_funding_key_0 == from_1_funding_key_1
5717 || from_0_funding_key_1 == from_1_funding_key_0
5718 || from_0_funding_key_1 == from_1_funding_key_1 {
5719 panic!("Funding pubkeys aren't unique");
5722 // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
5723 mine_transaction(&nodes[0], &local_txn_1[0]);
5724 connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
5725 check_closed_broadcast!(nodes[0], true);
5726 check_added_monitors!(nodes[0], 1);
5727 check_closed_event!(nodes[0], 1);
5729 let htlc_timeout = {
5730 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5731 assert_eq!(node_txn[1].input.len(), 1);
5732 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5733 check_spends!(node_txn[1], local_txn_1[0]);
5737 mine_transaction(&nodes[0], &htlc_timeout);
5738 connect_blocks(&nodes[0], BREAKDOWN_TIMEOUT as u32 - 1);
5739 let events = nodes[0].node.get_and_clear_pending_events();
5740 expect_payment_failed!(nodes[0], events, our_payment_hash, true);
5742 // Verify that A is able to spend its own HTLC-Timeout tx thanks to spendable output event given back by its ChannelMonitor
5743 let new_keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
5744 let spend_txn = check_spendable_outputs!(nodes[0], new_keys_manager);
5745 assert_eq!(spend_txn.len(), 3);
5746 check_spends!(spend_txn[0], local_txn_1[0]);
5747 assert_eq!(spend_txn[1].input.len(), 1);
5748 check_spends!(spend_txn[1], htlc_timeout);
5749 assert_eq!(spend_txn[1].input[0].sequence, BREAKDOWN_TIMEOUT as u32);
5750 assert_eq!(spend_txn[2].input.len(), 2);
5751 check_spends!(spend_txn[2], local_txn_1[0], htlc_timeout);
5752 assert!(spend_txn[2].input[0].sequence == BREAKDOWN_TIMEOUT as u32 ||
5753 spend_txn[2].input[1].sequence == BREAKDOWN_TIMEOUT as u32);
5757 fn test_static_output_closing_tx() {
5758 let chanmon_cfgs = create_chanmon_cfgs(2);
5759 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5760 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5761 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5763 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5765 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
5766 let closing_tx = close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true).2;
5768 mine_transaction(&nodes[0], &closing_tx);
5769 check_closed_event!(nodes[0], 1);
5770 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
5772 let spend_txn = check_spendable_outputs!(nodes[0], node_cfgs[0].keys_manager);
5773 assert_eq!(spend_txn.len(), 1);
5774 check_spends!(spend_txn[0], closing_tx);
5776 mine_transaction(&nodes[1], &closing_tx);
5777 check_closed_event!(nodes[1], 1);
5778 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
5780 let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
5781 assert_eq!(spend_txn.len(), 1);
5782 check_spends!(spend_txn[0], closing_tx);
5785 fn do_htlc_claim_local_commitment_only(use_dust: bool) {
5786 let chanmon_cfgs = create_chanmon_cfgs(2);
5787 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5788 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5789 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5790 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5792 let (our_payment_preimage, _, _) = route_payment(&nodes[0], &[&nodes[1]], if use_dust { 50000 } else { 3000000 });
5794 // Claim the payment, but don't deliver A's commitment_signed, resulting in the HTLC only being
5795 // present in B's local commitment transaction, but none of A's commitment transactions.
5796 assert!(nodes[1].node.claim_funds(our_payment_preimage));
5797 check_added_monitors!(nodes[1], 1);
5799 let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5800 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fulfill_htlcs[0]);
5801 let events = nodes[0].node.get_and_clear_pending_events();
5802 assert_eq!(events.len(), 1);
5804 Event::PaymentSent { payment_preimage } => {
5805 assert_eq!(payment_preimage, our_payment_preimage);
5807 _ => panic!("Unexpected event"),
5810 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_updates.commitment_signed);
5811 check_added_monitors!(nodes[0], 1);
5812 let as_updates = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5813 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_updates.0);
5814 check_added_monitors!(nodes[1], 1);
5816 let starting_block = nodes[1].best_block_info();
5817 let mut block = Block {
5818 header: BlockHeader { version: 0x20000000, prev_blockhash: starting_block.0, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
5821 for _ in starting_block.1 + 1..TEST_FINAL_CLTV - CLTV_CLAIM_BUFFER + starting_block.1 + 2 {
5822 connect_block(&nodes[1], &block);
5823 block.header.prev_blockhash = block.block_hash();
5825 test_txn_broadcast(&nodes[1], &chan, None, if use_dust { HTLCType::NONE } else { HTLCType::SUCCESS });
5826 check_closed_broadcast!(nodes[1], true);
5827 check_added_monitors!(nodes[1], 1);
5828 check_closed_event!(nodes[1], 1);
5831 fn do_htlc_claim_current_remote_commitment_only(use_dust: bool) {
5832 let chanmon_cfgs = create_chanmon_cfgs(2);
5833 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5834 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5835 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5836 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5837 let logger = test_utils::TestLogger::new();
5839 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1]);
5840 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
5841 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();
5842 nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
5843 check_added_monitors!(nodes[0], 1);
5845 let _as_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5847 // As far as A is concerned, the HTLC is now present only in the latest remote commitment
5848 // transaction, however it is not in A's latest local commitment, so we can just broadcast that
5849 // to "time out" the HTLC.
5851 let starting_block = nodes[1].best_block_info();
5852 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: starting_block.0, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5854 for _ in starting_block.1 + 1..TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + starting_block.1 + 2 {
5855 connect_block(&nodes[0], &Block { header, txdata: Vec::new()});
5856 header.prev_blockhash = header.block_hash();
5858 test_txn_broadcast(&nodes[0], &chan, None, HTLCType::NONE);
5859 check_closed_broadcast!(nodes[0], true);
5860 check_added_monitors!(nodes[0], 1);
5861 check_closed_event!(nodes[0], 1);
5864 fn do_htlc_claim_previous_remote_commitment_only(use_dust: bool, check_revoke_no_close: bool) {
5865 let chanmon_cfgs = create_chanmon_cfgs(3);
5866 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5867 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5868 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5869 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5871 // Fail the payment, but don't deliver A's final RAA, resulting in the HTLC only being present
5872 // in B's previous (unrevoked) commitment transaction, but none of A's commitment transactions.
5873 // Also optionally test that we *don't* fail the channel in case the commitment transaction was
5874 // actually revoked.
5875 let htlc_value = if use_dust { 50000 } else { 3000000 };
5876 let (_, our_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1]], htlc_value);
5877 assert!(nodes[1].node.fail_htlc_backwards(&our_payment_hash));
5878 let events = nodes[1].node.get_and_clear_pending_events();
5879 expect_pending_htlcs_forwardable!(nodes[1], events);
5880 check_added_monitors!(nodes[1], 1);
5882 let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5883 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fail_htlcs[0]);
5884 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_updates.commitment_signed);
5885 check_added_monitors!(nodes[0], 1);
5886 let as_updates = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5887 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_updates.0);
5888 check_added_monitors!(nodes[1], 1);
5889 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_updates.1);
5890 check_added_monitors!(nodes[1], 1);
5891 let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
5893 if check_revoke_no_close {
5894 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
5895 check_added_monitors!(nodes[0], 1);
5898 let starting_block = nodes[1].best_block_info();
5899 let mut block = Block {
5900 header: BlockHeader { version: 0x20000000, prev_blockhash: starting_block.0, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
5903 for _ in starting_block.1 + 1..TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + CHAN_CONFIRM_DEPTH + 2 {
5904 connect_block(&nodes[0], &block);
5905 block.header.prev_blockhash = block.block_hash();
5907 if !check_revoke_no_close {
5908 test_txn_broadcast(&nodes[0], &chan, None, HTLCType::NONE);
5909 check_closed_broadcast!(nodes[0], true);
5910 check_added_monitors!(nodes[0], 1);
5911 check_closed_event!(nodes[0], 1);
5913 let events = nodes[0].node.get_and_clear_pending_events();
5914 expect_payment_failed!(nodes[0], events, our_payment_hash, true);
5918 // Test that we close channels on-chain when broadcastable HTLCs reach their timeout window.
5919 // There are only a few cases to test here:
5920 // * its not really normative behavior, but we test that below-dust HTLCs "included" in
5921 // broadcastable commitment transactions result in channel closure,
5922 // * its included in an unrevoked-but-previous remote commitment transaction,
5923 // * its included in the latest remote or local commitment transactions.
5924 // We test each of the three possible commitment transactions individually and use both dust and
5926 // Note that we don't bother testing both outbound and inbound HTLC failures for each case, and we
5927 // assume they are handled the same across all six cases, as both outbound and inbound failures are
5928 // tested for at least one of the cases in other tests.
5930 fn htlc_claim_single_commitment_only_a() {
5931 do_htlc_claim_local_commitment_only(true);
5932 do_htlc_claim_local_commitment_only(false);
5934 do_htlc_claim_current_remote_commitment_only(true);
5935 do_htlc_claim_current_remote_commitment_only(false);
5939 fn htlc_claim_single_commitment_only_b() {
5940 do_htlc_claim_previous_remote_commitment_only(true, false);
5941 do_htlc_claim_previous_remote_commitment_only(false, false);
5942 do_htlc_claim_previous_remote_commitment_only(true, true);
5943 do_htlc_claim_previous_remote_commitment_only(false, true);
5948 fn bolt2_open_channel_sending_node_checks_part1() { //This test needs to be on its own as we are catching a panic
5949 let chanmon_cfgs = create_chanmon_cfgs(2);
5950 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5951 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5952 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5953 //Force duplicate channel ids
5954 for node in nodes.iter() {
5955 *node.keys_manager.override_channel_id_priv.lock().unwrap() = Some([0; 32]);
5958 // BOLT #2 spec: Sending node must ensure temporary_channel_id is unique from any other channel ID with the same peer.
5959 let channel_value_satoshis=10000;
5960 let push_msat=10001;
5961 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).unwrap();
5962 let node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
5963 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &node0_to_1_send_open_channel);
5965 //Create a second channel with a channel_id collision
5966 assert!(nodes[0].node.create_channel(nodes[0].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
5970 fn bolt2_open_channel_sending_node_checks_part2() {
5971 let chanmon_cfgs = create_chanmon_cfgs(2);
5972 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5973 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5974 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5976 // BOLT #2 spec: Sending node must set funding_satoshis to less than 2^24 satoshis
5977 let channel_value_satoshis=2^24;
5978 let push_msat=10001;
5979 assert!(nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
5981 // BOLT #2 spec: Sending node must set push_msat to equal or less than 1000 * funding_satoshis
5982 let channel_value_satoshis=10000;
5983 // Test when push_msat is equal to 1000 * funding_satoshis.
5984 let push_msat=1000*channel_value_satoshis+1;
5985 assert!(nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
5987 // BOLT #2 spec: Sending node must set set channel_reserve_satoshis greater than or equal to dust_limit_satoshis
5988 let channel_value_satoshis=10000;
5989 let push_msat=10001;
5990 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
5991 let node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
5992 assert!(node0_to_1_send_open_channel.channel_reserve_satoshis>=node0_to_1_send_open_channel.dust_limit_satoshis);
5994 // BOLT #2 spec: Sending node must set undefined bits in channel_flags to 0
5995 // 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
5996 assert!(node0_to_1_send_open_channel.channel_flags<=1);
5998 // 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.
5999 assert!(BREAKDOWN_TIMEOUT>0);
6000 assert!(node0_to_1_send_open_channel.to_self_delay==BREAKDOWN_TIMEOUT);
6002 // BOLT #2 spec: Sending node must ensure the chain_hash value identifies the chain it wishes to open the channel within.
6003 let chain_hash=genesis_block(Network::Testnet).header.block_hash();
6004 assert_eq!(node0_to_1_send_open_channel.chain_hash,chain_hash);
6006 // 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.
6007 assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.funding_pubkey.serialize()).is_ok());
6008 assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.revocation_basepoint.serialize()).is_ok());
6009 assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.htlc_basepoint.serialize()).is_ok());
6010 assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.payment_point.serialize()).is_ok());
6011 assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.delayed_payment_basepoint.serialize()).is_ok());
6015 fn bolt2_open_channel_sane_dust_limit() {
6016 let chanmon_cfgs = create_chanmon_cfgs(2);
6017 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6018 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6019 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6021 let channel_value_satoshis=1000000;
6022 let push_msat=10001;
6023 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).unwrap();
6024 let mut node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
6025 node0_to_1_send_open_channel.dust_limit_satoshis = 661;
6026 node0_to_1_send_open_channel.channel_reserve_satoshis = 100001;
6028 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &node0_to_1_send_open_channel);
6029 let events = nodes[1].node.get_and_clear_pending_msg_events();
6030 let err_msg = match events[0] {
6031 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id: _ } => {
6034 _ => panic!("Unexpected event"),
6036 assert_eq!(err_msg.data, "dust_limit_satoshis (661) is greater than the implementation limit (660)");
6039 // Test that if we fail to send an HTLC that is being freed from the holding cell, and the HTLC
6040 // originated from our node, its failure is surfaced to the user. We trigger this failure to
6041 // free the HTLC by increasing our fee while the HTLC is in the holding cell such that the HTLC
6042 // is no longer affordable once it's freed.
6044 fn test_fail_holding_cell_htlc_upon_free() {
6045 let chanmon_cfgs = create_chanmon_cfgs(2);
6046 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6047 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6048 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6049 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6050 let logger = test_utils::TestLogger::new();
6052 // First nodes[0] generates an update_fee, setting the channel's
6053 // pending_update_fee.
6055 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
6056 *feerate_lock += 20;
6058 nodes[0].node.timer_tick_occurred();
6059 check_added_monitors!(nodes[0], 1);
6061 let events = nodes[0].node.get_and_clear_pending_msg_events();
6062 assert_eq!(events.len(), 1);
6063 let (update_msg, commitment_signed) = match events[0] {
6064 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
6065 (update_fee.as_ref(), commitment_signed)
6067 _ => panic!("Unexpected event"),
6070 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
6072 let mut chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6073 let channel_reserve = chan_stat.channel_reserve_msat;
6074 let feerate = get_feerate!(nodes[0], chan.2);
6076 // 2* and +1 HTLCs on the commit tx fee calculation for the fee spike reserve.
6077 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6078 let max_can_send = 5000000 - channel_reserve - 2*commit_tx_fee_msat(feerate, 1 + 1);
6079 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6080 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();
6082 // Send a payment which passes reserve checks but gets stuck in the holding cell.
6083 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6084 chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6085 assert_eq!(chan_stat.holding_cell_outbound_amount_msat, max_can_send);
6087 // Flush the pending fee update.
6088 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
6089 let (as_revoke_and_ack, _) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6090 check_added_monitors!(nodes[1], 1);
6091 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_revoke_and_ack);
6092 check_added_monitors!(nodes[0], 1);
6094 // Upon receipt of the RAA, there will be an attempt to resend the holding cell
6095 // HTLC, but now that the fee has been raised the payment will now fail, causing
6096 // us to surface its failure to the user.
6097 chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6098 assert_eq!(chan_stat.holding_cell_outbound_amount_msat, 0);
6099 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);
6100 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 {}",
6101 hex::encode(our_payment_hash.0), chan_stat.channel_reserve_msat, hex::encode(chan.2));
6102 nodes[0].logger.assert_log("lightning::ln::channel".to_string(), failure_log.to_string(), 1);
6104 // Check that the payment failed to be sent out.
6105 let events = nodes[0].node.get_and_clear_pending_events();
6106 assert_eq!(events.len(), 1);
6108 &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, ref network_update, ref error_code, ref error_data, ref all_paths_failed } => {
6109 assert_eq!(our_payment_hash.clone(), *payment_hash);
6110 assert_eq!(*rejected_by_dest, false);
6111 assert_eq!(*all_paths_failed, true);
6112 assert_eq!(*network_update, None);
6113 assert_eq!(*error_code, None);
6114 assert_eq!(*error_data, None);
6116 _ => panic!("Unexpected event"),
6120 // Test that if multiple HTLCs are released from the holding cell and one is
6121 // valid but the other is no longer valid upon release, the valid HTLC can be
6122 // successfully completed while the other one fails as expected.
6124 fn test_free_and_fail_holding_cell_htlcs() {
6125 let chanmon_cfgs = create_chanmon_cfgs(2);
6126 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6127 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6128 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6129 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6130 let logger = test_utils::TestLogger::new();
6132 // First nodes[0] generates an update_fee, setting the channel's
6133 // pending_update_fee.
6135 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
6136 *feerate_lock += 200;
6138 nodes[0].node.timer_tick_occurred();
6139 check_added_monitors!(nodes[0], 1);
6141 let events = nodes[0].node.get_and_clear_pending_msg_events();
6142 assert_eq!(events.len(), 1);
6143 let (update_msg, commitment_signed) = match events[0] {
6144 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
6145 (update_fee.as_ref(), commitment_signed)
6147 _ => panic!("Unexpected event"),
6150 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
6152 let mut chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6153 let channel_reserve = chan_stat.channel_reserve_msat;
6154 let feerate = get_feerate!(nodes[0], chan.2);
6156 // 2* and +1 HTLCs on the commit tx fee calculation for the fee spike reserve.
6157 let (payment_preimage_1, payment_hash_1, payment_secret_1) = get_payment_preimage_hash!(nodes[1]);
6159 let (_, payment_hash_2, payment_secret_2) = get_payment_preimage_hash!(nodes[1]);
6160 let amt_2 = 5000000 - channel_reserve - 2*commit_tx_fee_msat(feerate, 2 + 1) - amt_1;
6161 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6162 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();
6163 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();
6165 // Send 2 payments which pass reserve checks but get stuck in the holding cell.
6166 nodes[0].node.send_payment(&route_1, payment_hash_1, &Some(payment_secret_1)).unwrap();
6167 chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6168 assert_eq!(chan_stat.holding_cell_outbound_amount_msat, amt_1);
6169 nodes[0].node.send_payment(&route_2, payment_hash_2, &Some(payment_secret_2)).unwrap();
6170 chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6171 assert_eq!(chan_stat.holding_cell_outbound_amount_msat, amt_1 + amt_2);
6173 // Flush the pending fee update.
6174 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
6175 let (revoke_and_ack, commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6176 check_added_monitors!(nodes[1], 1);
6177 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_and_ack);
6178 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
6179 check_added_monitors!(nodes[0], 2);
6181 // Upon receipt of the RAA, there will be an attempt to resend the holding cell HTLCs,
6182 // but now that the fee has been raised the second payment will now fail, causing us
6183 // to surface its failure to the user. The first payment should succeed.
6184 chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6185 assert_eq!(chan_stat.holding_cell_outbound_amount_msat, 0);
6186 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);
6187 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 {}",
6188 hex::encode(payment_hash_2.0), chan_stat.channel_reserve_msat, hex::encode(chan.2));
6189 nodes[0].logger.assert_log("lightning::ln::channel".to_string(), failure_log.to_string(), 1);
6191 // Check that the second payment failed to be sent out.
6192 let events = nodes[0].node.get_and_clear_pending_events();
6193 assert_eq!(events.len(), 1);
6195 &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, ref network_update, ref error_code, ref error_data, ref all_paths_failed } => {
6196 assert_eq!(payment_hash_2.clone(), *payment_hash);
6197 assert_eq!(*rejected_by_dest, false);
6198 assert_eq!(*all_paths_failed, true);
6199 assert_eq!(*network_update, None);
6200 assert_eq!(*error_code, None);
6201 assert_eq!(*error_data, None);
6203 _ => panic!("Unexpected event"),
6206 // Complete the first payment and the RAA from the fee update.
6207 let (payment_event, send_raa_event) = {
6208 let mut msgs = nodes[0].node.get_and_clear_pending_msg_events();
6209 assert_eq!(msgs.len(), 2);
6210 (SendEvent::from_event(msgs.remove(0)), msgs.remove(0))
6212 let raa = match send_raa_event {
6213 MessageSendEvent::SendRevokeAndACK { msg, .. } => msg,
6214 _ => panic!("Unexpected event"),
6216 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &raa);
6217 check_added_monitors!(nodes[1], 1);
6218 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6219 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6220 let events = nodes[1].node.get_and_clear_pending_events();
6221 assert_eq!(events.len(), 1);
6223 Event::PendingHTLCsForwardable { .. } => {},
6224 _ => panic!("Unexpected event"),
6226 nodes[1].node.process_pending_htlc_forwards();
6227 let events = nodes[1].node.get_and_clear_pending_events();
6228 assert_eq!(events.len(), 1);
6230 Event::PaymentReceived { .. } => {},
6231 _ => panic!("Unexpected event"),
6233 nodes[1].node.claim_funds(payment_preimage_1);
6234 check_added_monitors!(nodes[1], 1);
6235 let update_msgs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6236 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_msgs.update_fulfill_htlcs[0]);
6237 commitment_signed_dance!(nodes[0], nodes[1], update_msgs.commitment_signed, false, true);
6238 let events = nodes[0].node.get_and_clear_pending_events();
6239 assert_eq!(events.len(), 1);
6241 Event::PaymentSent { ref payment_preimage } => {
6242 assert_eq!(*payment_preimage, payment_preimage_1);
6244 _ => panic!("Unexpected event"),
6248 // Test that if we fail to forward an HTLC that is being freed from the holding cell that the
6249 // HTLC is failed backwards. We trigger this failure to forward the freed HTLC by increasing
6250 // our fee while the HTLC is in the holding cell such that the HTLC is no longer affordable
6253 fn test_fail_holding_cell_htlc_upon_free_multihop() {
6254 let chanmon_cfgs = create_chanmon_cfgs(3);
6255 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
6256 // When this test was written, the default base fee floated based on the HTLC count.
6257 // It is now fixed, so we simply set the fee to the expected value here.
6258 let mut config = test_default_channel_config();
6259 config.channel_options.forwarding_fee_base_msat = 196;
6260 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[Some(config.clone()), Some(config.clone()), Some(config.clone())]);
6261 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
6262 let chan_0_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6263 let chan_1_2 = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6264 let logger = test_utils::TestLogger::new();
6266 // First nodes[1] generates an update_fee, setting the channel's
6267 // pending_update_fee.
6269 let mut feerate_lock = chanmon_cfgs[1].fee_estimator.sat_per_kw.lock().unwrap();
6270 *feerate_lock += 20;
6272 nodes[1].node.timer_tick_occurred();
6273 check_added_monitors!(nodes[1], 1);
6275 let events = nodes[1].node.get_and_clear_pending_msg_events();
6276 assert_eq!(events.len(), 1);
6277 let (update_msg, commitment_signed) = match events[0] {
6278 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
6279 (update_fee.as_ref(), commitment_signed)
6281 _ => panic!("Unexpected event"),
6284 nodes[2].node.handle_update_fee(&nodes[1].node.get_our_node_id(), update_msg.unwrap());
6286 let mut chan_stat = get_channel_value_stat!(nodes[0], chan_0_1.2);
6287 let channel_reserve = chan_stat.channel_reserve_msat;
6288 let feerate = get_feerate!(nodes[0], chan_0_1.2);
6290 // Send a payment which passes reserve checks but gets stuck in the holding cell.
6292 let total_routing_fee_msat = (nodes.len() - 2) as u64 * feemsat;
6293 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[2]);
6294 let max_can_send = 5000000 - channel_reserve - 2*commit_tx_fee_msat(feerate, 1 + 1) - total_routing_fee_msat;
6295 let payment_event = {
6296 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6297 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();
6298 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6299 check_added_monitors!(nodes[0], 1);
6301 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
6302 assert_eq!(events.len(), 1);
6304 SendEvent::from_event(events.remove(0))
6306 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6307 check_added_monitors!(nodes[1], 0);
6308 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6309 let events = nodes[1].node.get_and_clear_pending_events();
6310 expect_pending_htlcs_forwardable!(nodes[1], events);
6312 chan_stat = get_channel_value_stat!(nodes[1], chan_1_2.2);
6313 assert_eq!(chan_stat.holding_cell_outbound_amount_msat, max_can_send);
6315 // Flush the pending fee update.
6316 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), commitment_signed);
6317 let (raa, commitment_signed) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
6318 check_added_monitors!(nodes[2], 1);
6319 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &raa);
6320 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &commitment_signed);
6321 check_added_monitors!(nodes[1], 2);
6323 // A final RAA message is generated to finalize the fee update.
6324 let events = nodes[1].node.get_and_clear_pending_msg_events();
6325 assert_eq!(events.len(), 1);
6327 let raa_msg = match &events[0] {
6328 &MessageSendEvent::SendRevokeAndACK { ref msg, .. } => {
6331 _ => panic!("Unexpected event"),
6334 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &raa_msg);
6335 check_added_monitors!(nodes[2], 1);
6336 assert!(nodes[2].node.get_and_clear_pending_msg_events().is_empty());
6338 // nodes[1]'s ChannelManager will now signal that we have HTLC forwards to process.
6339 let process_htlc_forwards_event = nodes[1].node.get_and_clear_pending_events();
6340 assert_eq!(process_htlc_forwards_event.len(), 1);
6341 match &process_htlc_forwards_event[0] {
6342 &Event::PendingHTLCsForwardable { .. } => {},
6343 _ => panic!("Unexpected event"),
6346 // In response, we call ChannelManager's process_pending_htlc_forwards
6347 nodes[1].node.process_pending_htlc_forwards();
6348 check_added_monitors!(nodes[1], 1);
6350 // This causes the HTLC to be failed backwards.
6351 let fail_event = nodes[1].node.get_and_clear_pending_msg_events();
6352 assert_eq!(fail_event.len(), 1);
6353 let (fail_msg, commitment_signed) = match &fail_event[0] {
6354 &MessageSendEvent::UpdateHTLCs { ref updates, .. } => {
6355 assert_eq!(updates.update_add_htlcs.len(), 0);
6356 assert_eq!(updates.update_fulfill_htlcs.len(), 0);
6357 assert_eq!(updates.update_fail_malformed_htlcs.len(), 0);
6358 assert_eq!(updates.update_fail_htlcs.len(), 1);
6359 (updates.update_fail_htlcs[0].clone(), updates.commitment_signed.clone())
6361 _ => panic!("Unexpected event"),
6364 // Pass the failure messages back to nodes[0].
6365 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
6366 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
6368 // Complete the HTLC failure+removal process.
6369 let (raa, commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6370 check_added_monitors!(nodes[0], 1);
6371 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &raa);
6372 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commitment_signed);
6373 check_added_monitors!(nodes[1], 2);
6374 let final_raa_event = nodes[1].node.get_and_clear_pending_msg_events();
6375 assert_eq!(final_raa_event.len(), 1);
6376 let raa = match &final_raa_event[0] {
6377 &MessageSendEvent::SendRevokeAndACK { ref msg, .. } => msg.clone(),
6378 _ => panic!("Unexpected event"),
6380 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &raa);
6381 expect_payment_failed_with_update!(nodes[0], our_payment_hash, false, chan_1_2.0.contents.short_channel_id, false);
6382 check_added_monitors!(nodes[0], 1);
6385 // BOLT 2 Requirements for the Sender when constructing and sending an update_add_htlc message.
6386 // 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.
6387 //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.
6390 fn test_update_add_htlc_bolt2_sender_value_below_minimum_msat() {
6391 //BOLT2 Requirement: MUST NOT offer amount_msat below the receiving node's htlc_minimum_msat (same validation check catches both of these)
6392 let chanmon_cfgs = create_chanmon_cfgs(2);
6393 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6394 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6395 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6396 let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6398 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6399 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6400 let logger = test_utils::TestLogger::new();
6401 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();
6402 route.paths[0][0].fee_msat = 100;
6404 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
6405 assert!(regex::Regex::new(r"Cannot send less than their minimum HTLC value \(\d+\)").unwrap().is_match(err)));
6406 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6407 nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot send less than their minimum HTLC value".to_string(), 1);
6411 fn test_update_add_htlc_bolt2_sender_zero_value_msat() {
6412 //BOLT2 Requirement: MUST offer amount_msat greater than 0.
6413 let chanmon_cfgs = create_chanmon_cfgs(2);
6414 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6415 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6416 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6417 let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6418 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6420 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6421 let logger = test_utils::TestLogger::new();
6422 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();
6423 route.paths[0][0].fee_msat = 0;
6424 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
6425 assert_eq!(err, "Cannot send 0-msat HTLC"));
6427 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6428 nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot send 0-msat HTLC".to_string(), 1);
6432 fn test_update_add_htlc_bolt2_receiver_zero_value_msat() {
6433 //BOLT2 Requirement: MUST offer amount_msat greater than 0.
6434 let chanmon_cfgs = create_chanmon_cfgs(2);
6435 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6436 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6437 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6438 let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6440 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6441 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6442 let logger = test_utils::TestLogger::new();
6443 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();
6444 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6445 check_added_monitors!(nodes[0], 1);
6446 let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6447 updates.update_add_htlcs[0].amount_msat = 0;
6449 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6450 nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Remote side tried to send a 0-msat HTLC".to_string(), 1);
6451 check_closed_broadcast!(nodes[1], true).unwrap();
6452 check_added_monitors!(nodes[1], 1);
6453 check_closed_event!(nodes[1], 1);
6457 fn test_update_add_htlc_bolt2_sender_cltv_expiry_too_high() {
6458 //BOLT 2 Requirement: MUST set cltv_expiry less than 500000000.
6459 //It is enforced when constructing a route.
6460 let chanmon_cfgs = create_chanmon_cfgs(2);
6461 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6462 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6463 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6464 let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 0, InitFeatures::known(), InitFeatures::known());
6465 let logger = test_utils::TestLogger::new();
6467 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6469 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6470 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();
6471 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::RouteError { ref err },
6472 assert_eq!(err, &"Channel CLTV overflowed?"));
6476 fn test_update_add_htlc_bolt2_sender_exceed_max_htlc_num_and_htlc_id_increment() {
6477 //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.
6478 //BOLT 2 Requirement: for the first HTLC it offers MUST set id to 0.
6479 //BOLT 2 Requirement: MUST increase the value of id by 1 for each successive offer.
6480 let chanmon_cfgs = create_chanmon_cfgs(2);
6481 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6482 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6483 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6484 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 0, InitFeatures::known(), InitFeatures::known());
6485 let max_accepted_htlcs = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().counterparty_max_accepted_htlcs as u64;
6487 let logger = test_utils::TestLogger::new();
6488 for i in 0..max_accepted_htlcs {
6489 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6490 let payment_event = {
6491 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6492 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();
6493 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6494 check_added_monitors!(nodes[0], 1);
6496 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
6497 assert_eq!(events.len(), 1);
6498 if let MessageSendEvent::UpdateHTLCs { node_id: _, updates: msgs::CommitmentUpdate{ update_add_htlcs: ref htlcs, .. }, } = events[0] {
6499 assert_eq!(htlcs[0].htlc_id, i);
6503 SendEvent::from_event(events.remove(0))
6505 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6506 check_added_monitors!(nodes[1], 0);
6507 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6509 let events = nodes[1].node.get_and_clear_pending_events();
6510 expect_pending_htlcs_forwardable!(nodes[1], events);
6511 expect_payment_received!(nodes[1], our_payment_hash, our_payment_secret, 100000);
6513 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6514 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6515 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();
6516 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
6517 assert!(regex::Regex::new(r"Cannot push more than their max accepted HTLCs \(\d+\)").unwrap().is_match(err)));
6519 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6520 nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot push more than their max accepted HTLCs".to_string(), 1);
6524 fn test_update_add_htlc_bolt2_sender_exceed_max_htlc_value_in_flight() {
6525 //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.
6526 let chanmon_cfgs = create_chanmon_cfgs(2);
6527 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6528 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6529 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6530 let channel_value = 100000;
6531 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, channel_value, 0, InitFeatures::known(), InitFeatures::known());
6532 let max_in_flight = get_channel_value_stat!(nodes[0], chan.2).counterparty_max_htlc_value_in_flight_msat;
6534 send_payment(&nodes[0], &vec!(&nodes[1])[..], max_in_flight);
6536 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6537 // Manually create a route over our max in flight (which our router normally automatically
6539 let route = Route { paths: vec![vec![RouteHop {
6540 pubkey: nodes[1].node.get_our_node_id(), node_features: NodeFeatures::known(), channel_features: ChannelFeatures::known(),
6541 short_channel_id: nodes[1].node.list_usable_channels()[0].short_channel_id.unwrap(),
6542 fee_msat: max_in_flight + 1, cltv_expiry_delta: TEST_FINAL_CLTV
6544 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
6545 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)));
6547 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6548 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);
6550 send_payment(&nodes[0], &[&nodes[1]], max_in_flight);
6553 // BOLT 2 Requirements for the Receiver when handling an update_add_htlc message.
6555 fn test_update_add_htlc_bolt2_receiver_check_amount_received_more_than_min() {
6556 //BOLT2 Requirement: receiving an amount_msat equal to 0, OR less than its own htlc_minimum_msat -> SHOULD fail the channel.
6557 let chanmon_cfgs = create_chanmon_cfgs(2);
6558 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6559 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6560 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6561 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6562 let htlc_minimum_msat: u64;
6564 let chan_lock = nodes[0].node.channel_state.lock().unwrap();
6565 let channel = chan_lock.by_id.get(&chan.2).unwrap();
6566 htlc_minimum_msat = channel.get_holder_htlc_minimum_msat();
6569 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6570 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6571 let logger = test_utils::TestLogger::new();
6572 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();
6573 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6574 check_added_monitors!(nodes[0], 1);
6575 let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6576 updates.update_add_htlcs[0].amount_msat = htlc_minimum_msat-1;
6577 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6578 assert!(nodes[1].node.list_channels().is_empty());
6579 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6580 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()));
6581 check_added_monitors!(nodes[1], 1);
6582 check_closed_event!(nodes[1], 1);
6586 fn test_update_add_htlc_bolt2_receiver_sender_can_afford_amount_sent() {
6587 //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
6588 let chanmon_cfgs = create_chanmon_cfgs(2);
6589 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6590 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6591 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6592 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6593 let logger = test_utils::TestLogger::new();
6595 let chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6596 let channel_reserve = chan_stat.channel_reserve_msat;
6597 let feerate = get_feerate!(nodes[0], chan.2);
6598 // The 2* and +1 are for the fee spike reserve.
6599 let commit_tx_fee_outbound = 2 * commit_tx_fee_msat(feerate, 1 + 1);
6601 let max_can_send = 5000000 - channel_reserve - commit_tx_fee_outbound;
6602 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6603 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6604 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();
6605 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6606 check_added_monitors!(nodes[0], 1);
6607 let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6609 // Even though channel-initiator senders are required to respect the fee_spike_reserve,
6610 // at this time channel-initiatee receivers are not required to enforce that senders
6611 // respect the fee_spike_reserve.
6612 updates.update_add_htlcs[0].amount_msat = max_can_send + commit_tx_fee_outbound + 1;
6613 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6615 assert!(nodes[1].node.list_channels().is_empty());
6616 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6617 assert_eq!(err_msg.data, "Remote HTLC add would put them under remote reserve value");
6618 check_added_monitors!(nodes[1], 1);
6619 check_closed_event!(nodes[1], 1);
6623 fn test_update_add_htlc_bolt2_receiver_check_max_htlc_limit() {
6624 //BOLT 2 Requirement: if a sending node adds more than its max_accepted_htlcs HTLCs to its local commitment transaction: SHOULD fail the channel
6625 //BOLT 2 Requirement: MUST allow multiple HTLCs with the same payment_hash.
6626 let chanmon_cfgs = create_chanmon_cfgs(2);
6627 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6628 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6629 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6630 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6631 let logger = test_utils::TestLogger::new();
6633 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6634 let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
6636 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6637 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();
6639 let cur_height = nodes[0].node.best_block.read().unwrap().height() + 1;
6640 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::signing_only(), &route.paths[0], &session_priv).unwrap();
6641 let (onion_payloads, _htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 3999999, &Some(our_payment_secret), cur_height, &None).unwrap();
6642 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &our_payment_hash);
6644 let mut msg = msgs::UpdateAddHTLC {
6648 payment_hash: our_payment_hash,
6649 cltv_expiry: htlc_cltv,
6650 onion_routing_packet: onion_packet.clone(),
6653 for i in 0..super::channel::OUR_MAX_HTLCS {
6654 msg.htlc_id = i as u64;
6655 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
6657 msg.htlc_id = (super::channel::OUR_MAX_HTLCS) as u64;
6658 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
6660 assert!(nodes[1].node.list_channels().is_empty());
6661 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6662 assert!(regex::Regex::new(r"Remote tried to push more than our max accepted HTLCs \(\d+\)").unwrap().is_match(err_msg.data.as_str()));
6663 check_added_monitors!(nodes[1], 1);
6664 check_closed_event!(nodes[1], 1);
6668 fn test_update_add_htlc_bolt2_receiver_check_max_in_flight_msat() {
6669 //OR adds more than its max_htlc_value_in_flight_msat worth of offered HTLCs to its local commitment transaction: SHOULD fail the channel
6670 let chanmon_cfgs = create_chanmon_cfgs(2);
6671 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6672 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6673 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6674 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
6675 let logger = test_utils::TestLogger::new();
6677 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6678 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6679 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();
6680 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6681 check_added_monitors!(nodes[0], 1);
6682 let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6683 updates.update_add_htlcs[0].amount_msat = get_channel_value_stat!(nodes[1], chan.2).counterparty_max_htlc_value_in_flight_msat + 1;
6684 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6686 assert!(nodes[1].node.list_channels().is_empty());
6687 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6688 assert!(regex::Regex::new("Remote HTLC add would put them over our max HTLC value").unwrap().is_match(err_msg.data.as_str()));
6689 check_added_monitors!(nodes[1], 1);
6690 check_closed_event!(nodes[1], 1);
6694 fn test_update_add_htlc_bolt2_receiver_check_cltv_expiry() {
6695 //BOLT2 Requirement: if sending node sets cltv_expiry to greater or equal to 500000000: SHOULD fail the channel.
6696 let chanmon_cfgs = create_chanmon_cfgs(2);
6697 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6698 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6699 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6700 let logger = test_utils::TestLogger::new();
6702 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6703 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6704 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6705 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();
6706 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6707 check_added_monitors!(nodes[0], 1);
6708 let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6709 updates.update_add_htlcs[0].cltv_expiry = 500000000;
6710 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6712 assert!(nodes[1].node.list_channels().is_empty());
6713 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6714 assert_eq!(err_msg.data,"Remote provided CLTV expiry in seconds instead of block height");
6715 check_added_monitors!(nodes[1], 1);
6716 check_closed_event!(nodes[1], 1);
6720 fn test_update_add_htlc_bolt2_receiver_check_repeated_id_ignore() {
6721 //BOLT 2 requirement: if the sender did not previously acknowledge the commitment of that HTLC: MUST ignore a repeated id value after a reconnection.
6722 // We test this by first testing that that repeated HTLCs pass commitment signature checks
6723 // after disconnect and that non-sequential htlc_ids result in a channel failure.
6724 let chanmon_cfgs = create_chanmon_cfgs(2);
6725 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6726 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6727 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6728 let logger = test_utils::TestLogger::new();
6730 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6731 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6732 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6733 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();
6734 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6735 check_added_monitors!(nodes[0], 1);
6736 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6737 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6739 //Disconnect and Reconnect
6740 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
6741 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
6742 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
6743 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
6744 assert_eq!(reestablish_1.len(), 1);
6745 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
6746 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
6747 assert_eq!(reestablish_2.len(), 1);
6748 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
6749 handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
6750 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
6751 handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
6754 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6755 assert_eq!(updates.commitment_signed.htlc_signatures.len(), 1);
6756 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &updates.commitment_signed);
6757 check_added_monitors!(nodes[1], 1);
6758 let _bs_responses = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6760 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6762 assert!(nodes[1].node.list_channels().is_empty());
6763 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6764 assert!(regex::Regex::new(r"Remote skipped HTLC ID \(skipped ID: \d+\)").unwrap().is_match(err_msg.data.as_str()));
6765 check_added_monitors!(nodes[1], 1);
6766 check_closed_event!(nodes[1], 1);
6770 fn test_update_fulfill_htlc_bolt2_update_fulfill_htlc_before_commitment() {
6771 //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.
6773 let chanmon_cfgs = create_chanmon_cfgs(2);
6774 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6775 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6776 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6777 let logger = test_utils::TestLogger::new();
6778 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6779 let (our_payment_preimage, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6780 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6781 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();
6782 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6784 check_added_monitors!(nodes[0], 1);
6785 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6786 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6788 let update_msg = msgs::UpdateFulfillHTLC{
6791 payment_preimage: our_payment_preimage,
6794 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6796 assert!(nodes[0].node.list_channels().is_empty());
6797 let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6798 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()));
6799 check_added_monitors!(nodes[0], 1);
6800 check_closed_event!(nodes[0], 1);
6804 fn test_update_fulfill_htlc_bolt2_update_fail_htlc_before_commitment() {
6805 //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.
6807 let chanmon_cfgs = create_chanmon_cfgs(2);
6808 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6809 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6810 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6811 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6812 let logger = test_utils::TestLogger::new();
6814 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6815 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6816 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();
6817 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6818 check_added_monitors!(nodes[0], 1);
6819 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6820 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6822 let update_msg = msgs::UpdateFailHTLC{
6825 reason: msgs::OnionErrorPacket { data: Vec::new()},
6828 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6830 assert!(nodes[0].node.list_channels().is_empty());
6831 let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6832 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()));
6833 check_added_monitors!(nodes[0], 1);
6834 check_closed_event!(nodes[0], 1);
6838 fn test_update_fulfill_htlc_bolt2_update_fail_malformed_htlc_before_commitment() {
6839 //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.
6841 let chanmon_cfgs = create_chanmon_cfgs(2);
6842 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6843 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6844 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6845 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6846 let logger = test_utils::TestLogger::new();
6848 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6849 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6850 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();
6851 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6852 check_added_monitors!(nodes[0], 1);
6853 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6854 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6855 let update_msg = msgs::UpdateFailMalformedHTLC{
6858 sha256_of_onion: [1; 32],
6859 failure_code: 0x8000,
6862 nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6864 assert!(nodes[0].node.list_channels().is_empty());
6865 let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6866 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()));
6867 check_added_monitors!(nodes[0], 1);
6868 check_closed_event!(nodes[0], 1);
6872 fn test_update_fulfill_htlc_bolt2_incorrect_htlc_id() {
6873 //BOLT 2 Requirement: A receiving node: if the id does not correspond to an HTLC in its current commitment transaction MUST fail the channel.
6875 let chanmon_cfgs = create_chanmon_cfgs(2);
6876 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6877 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6878 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6879 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6881 let our_payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 100000).0;
6883 nodes[1].node.claim_funds(our_payment_preimage);
6884 check_added_monitors!(nodes[1], 1);
6886 let events = nodes[1].node.get_and_clear_pending_msg_events();
6887 assert_eq!(events.len(), 1);
6888 let mut update_fulfill_msg: msgs::UpdateFulfillHTLC = {
6890 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, .. } } => {
6891 assert!(update_add_htlcs.is_empty());
6892 assert_eq!(update_fulfill_htlcs.len(), 1);
6893 assert!(update_fail_htlcs.is_empty());
6894 assert!(update_fail_malformed_htlcs.is_empty());
6895 assert!(update_fee.is_none());
6896 update_fulfill_htlcs[0].clone()
6898 _ => panic!("Unexpected event"),
6902 update_fulfill_msg.htlc_id = 1;
6904 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_msg);
6906 assert!(nodes[0].node.list_channels().is_empty());
6907 let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6908 assert_eq!(err_msg.data, "Remote tried to fulfill/fail an HTLC we couldn't find");
6909 check_added_monitors!(nodes[0], 1);
6910 check_closed_event!(nodes[0], 1);
6914 fn test_update_fulfill_htlc_bolt2_wrong_preimage() {
6915 //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.
6917 let chanmon_cfgs = create_chanmon_cfgs(2);
6918 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6919 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6920 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6921 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6923 let our_payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 100000).0;
6925 nodes[1].node.claim_funds(our_payment_preimage);
6926 check_added_monitors!(nodes[1], 1);
6928 let events = nodes[1].node.get_and_clear_pending_msg_events();
6929 assert_eq!(events.len(), 1);
6930 let mut update_fulfill_msg: msgs::UpdateFulfillHTLC = {
6932 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, .. } } => {
6933 assert!(update_add_htlcs.is_empty());
6934 assert_eq!(update_fulfill_htlcs.len(), 1);
6935 assert!(update_fail_htlcs.is_empty());
6936 assert!(update_fail_malformed_htlcs.is_empty());
6937 assert!(update_fee.is_none());
6938 update_fulfill_htlcs[0].clone()
6940 _ => panic!("Unexpected event"),
6944 update_fulfill_msg.payment_preimage = PaymentPreimage([1; 32]);
6946 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_msg);
6948 assert!(nodes[0].node.list_channels().is_empty());
6949 let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6950 assert!(regex::Regex::new(r"Remote tried to fulfill HTLC \(\d+\) with an incorrect preimage").unwrap().is_match(err_msg.data.as_str()));
6951 check_added_monitors!(nodes[0], 1);
6952 check_closed_event!(nodes[0], 1);
6956 fn test_update_fulfill_htlc_bolt2_missing_badonion_bit_for_malformed_htlc_message() {
6957 //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.
6959 let chanmon_cfgs = create_chanmon_cfgs(2);
6960 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6961 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6962 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6963 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
6964 let logger = test_utils::TestLogger::new();
6966 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6967 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6968 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();
6969 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6970 check_added_monitors!(nodes[0], 1);
6972 let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6973 updates.update_add_htlcs[0].onion_routing_packet.version = 1; //Produce a malformed HTLC message
6975 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6976 check_added_monitors!(nodes[1], 0);
6977 commitment_signed_dance!(nodes[1], nodes[0], updates.commitment_signed, false, true);
6979 let events = nodes[1].node.get_and_clear_pending_msg_events();
6981 let mut update_msg: msgs::UpdateFailMalformedHTLC = {
6983 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, .. } } => {
6984 assert!(update_add_htlcs.is_empty());
6985 assert!(update_fulfill_htlcs.is_empty());
6986 assert!(update_fail_htlcs.is_empty());
6987 assert_eq!(update_fail_malformed_htlcs.len(), 1);
6988 assert!(update_fee.is_none());
6989 update_fail_malformed_htlcs[0].clone()
6991 _ => panic!("Unexpected event"),
6994 update_msg.failure_code &= !0x8000;
6995 nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6997 assert!(nodes[0].node.list_channels().is_empty());
6998 let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6999 assert_eq!(err_msg.data, "Got update_fail_malformed_htlc with BADONION not set");
7000 check_added_monitors!(nodes[0], 1);
7001 check_closed_event!(nodes[0], 1);
7005 fn test_update_fulfill_htlc_bolt2_after_malformed_htlc_message_must_forward_update_fail_htlc() {
7006 //BOLT 2 Requirement: a receiving node which has an outgoing HTLC canceled by update_fail_malformed_htlc:
7007 // * 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.
7009 let chanmon_cfgs = create_chanmon_cfgs(3);
7010 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7011 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
7012 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7013 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7014 create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7015 let logger = test_utils::TestLogger::new();
7017 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[2]);
7020 let mut payment_event = {
7021 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
7022 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();
7023 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
7024 check_added_monitors!(nodes[0], 1);
7025 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
7026 assert_eq!(events.len(), 1);
7027 SendEvent::from_event(events.remove(0))
7029 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
7030 check_added_monitors!(nodes[1], 0);
7031 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
7032 let events = nodes[1].node.get_and_clear_pending_events();
7033 expect_pending_htlcs_forwardable!(nodes[1], events);
7034 let mut events_2 = nodes[1].node.get_and_clear_pending_msg_events();
7035 assert_eq!(events_2.len(), 1);
7036 check_added_monitors!(nodes[1], 1);
7037 payment_event = SendEvent::from_event(events_2.remove(0));
7038 assert_eq!(payment_event.msgs.len(), 1);
7041 payment_event.msgs[0].onion_routing_packet.version = 1; //Produce a malformed HTLC message
7042 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
7043 check_added_monitors!(nodes[2], 0);
7044 commitment_signed_dance!(nodes[2], nodes[1], payment_event.commitment_msg, false, true);
7046 let events_3 = nodes[2].node.get_and_clear_pending_msg_events();
7047 assert_eq!(events_3.len(), 1);
7048 let update_msg : (msgs::UpdateFailMalformedHTLC, msgs::CommitmentSigned) = {
7050 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 } } => {
7051 assert!(update_add_htlcs.is_empty());
7052 assert!(update_fulfill_htlcs.is_empty());
7053 assert!(update_fail_htlcs.is_empty());
7054 assert_eq!(update_fail_malformed_htlcs.len(), 1);
7055 assert!(update_fee.is_none());
7056 (update_fail_malformed_htlcs[0].clone(), commitment_signed.clone())
7058 _ => panic!("Unexpected event"),
7062 nodes[1].node.handle_update_fail_malformed_htlc(&nodes[2].node.get_our_node_id(), &update_msg.0);
7064 check_added_monitors!(nodes[1], 0);
7065 commitment_signed_dance!(nodes[1], nodes[2], update_msg.1, false, true);
7066 let events = nodes[1].node.get_and_clear_pending_events();
7067 expect_pending_htlcs_forwardable!(nodes[1], events);
7068 let events_4 = nodes[1].node.get_and_clear_pending_msg_events();
7069 assert_eq!(events_4.len(), 1);
7071 //Confirm that handlinge the update_malformed_htlc message produces an update_fail_htlc message to be forwarded back along the route
7073 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, .. } } => {
7074 assert!(update_add_htlcs.is_empty());
7075 assert!(update_fulfill_htlcs.is_empty());
7076 assert_eq!(update_fail_htlcs.len(), 1);
7077 assert!(update_fail_malformed_htlcs.is_empty());
7078 assert!(update_fee.is_none());
7080 _ => panic!("Unexpected event"),
7083 check_added_monitors!(nodes[1], 1);
7086 fn do_test_failure_delay_dust_htlc_local_commitment(announce_latest: bool) {
7087 // Dust-HTLC failure updates must be delayed until failure-trigger tx (in this case local commitment) reach ANTI_REORG_DELAY
7088 // 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
7089 // HTLC could have been removed from lastest local commitment tx but still valid until we get remote RAA
7091 let mut chanmon_cfgs = create_chanmon_cfgs(2);
7092 chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
7093 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7094 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7095 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7096 let chan =create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7098 let bs_dust_limit = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().holder_dust_limit_satoshis;
7100 // We route 2 dust-HTLCs between A and B
7101 let (_, payment_hash_1, _) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
7102 let (_, payment_hash_2, _) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
7103 route_payment(&nodes[0], &[&nodes[1]], 1000000);
7105 // Cache one local commitment tx as previous
7106 let as_prev_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
7108 // Fail one HTLC to prune it in the will-be-latest-local commitment tx
7109 assert!(nodes[1].node.fail_htlc_backwards(&payment_hash_2));
7110 check_added_monitors!(nodes[1], 0);
7111 let events = nodes[1].node.get_and_clear_pending_events();
7112 expect_pending_htlcs_forwardable!(nodes[1], events);
7113 check_added_monitors!(nodes[1], 1);
7115 let remove = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
7116 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &remove.update_fail_htlcs[0]);
7117 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &remove.commitment_signed);
7118 check_added_monitors!(nodes[0], 1);
7120 // Cache one local commitment tx as lastest
7121 let as_last_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
7123 let events = nodes[0].node.get_and_clear_pending_msg_events();
7125 MessageSendEvent::SendRevokeAndACK { node_id, .. } => {
7126 assert_eq!(node_id, nodes[1].node.get_our_node_id());
7128 _ => panic!("Unexpected event"),
7131 MessageSendEvent::UpdateHTLCs { node_id, .. } => {
7132 assert_eq!(node_id, nodes[1].node.get_our_node_id());
7134 _ => panic!("Unexpected event"),
7137 assert_ne!(as_prev_commitment_tx, as_last_commitment_tx);
7138 // Fail the 2 dust-HTLCs, move their failure in maturation buffer (htlc_updated_waiting_threshold_conf)
7139 if announce_latest {
7140 mine_transaction(&nodes[0], &as_last_commitment_tx[0]);
7142 mine_transaction(&nodes[0], &as_prev_commitment_tx[0]);
7145 check_closed_broadcast!(nodes[0], true);
7146 check_added_monitors!(nodes[0], 1);
7147 check_closed_event!(nodes[0], 1);
7149 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7150 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7151 let events = nodes[0].node.get_and_clear_pending_events();
7152 // Only 2 PaymentFailed events should show up, over-dust HTLC has to be failed by timeout tx
7153 assert_eq!(events.len(), 2);
7154 let mut first_failed = false;
7155 for event in events {
7157 Event::PaymentFailed { payment_hash, .. } => {
7158 if payment_hash == payment_hash_1 {
7159 assert!(!first_failed);
7160 first_failed = true;
7162 assert_eq!(payment_hash, payment_hash_2);
7165 _ => panic!("Unexpected event"),
7171 fn test_failure_delay_dust_htlc_local_commitment() {
7172 do_test_failure_delay_dust_htlc_local_commitment(true);
7173 do_test_failure_delay_dust_htlc_local_commitment(false);
7176 fn do_test_sweep_outbound_htlc_failure_update(revoked: bool, local: bool) {
7177 // Outbound HTLC-failure updates must be cancelled if we get a reorg before we reach ANTI_REORG_DELAY.
7178 // Broadcast of revoked remote commitment tx, trigger failure-update of dust/non-dust HTLCs
7179 // Broadcast of remote commitment tx, trigger failure-update of dust-HTLCs
7180 // Broadcast of timeout tx on remote commitment tx, trigger failure-udate of non-dust HTLCs
7181 // Broadcast of local commitment tx, trigger failure-update of dust-HTLCs
7182 // Broadcast of HTLC-timeout tx on local commitment tx, trigger failure-update of non-dust HTLCs
7184 let chanmon_cfgs = create_chanmon_cfgs(3);
7185 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7186 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
7187 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7188 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7190 let bs_dust_limit = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().holder_dust_limit_satoshis;
7192 let (_payment_preimage_1, dust_hash, _payment_secret_1) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
7193 let (_payment_preimage_2, non_dust_hash, _payment_secret_2) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
7195 let as_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
7196 let bs_commitment_tx = get_local_commitment_txn!(nodes[1], chan.2);
7198 // We revoked bs_commitment_tx
7200 let (payment_preimage_3, _, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
7201 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_3);
7204 let mut timeout_tx = Vec::new();
7206 // We fail dust-HTLC 1 by broadcast of local commitment tx
7207 mine_transaction(&nodes[0], &as_commitment_tx[0]);
7208 check_closed_event!(nodes[0], 1);
7209 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7210 let events = nodes[0].node.get_and_clear_pending_events();
7211 expect_payment_failed!(nodes[0], events, dust_hash, true);
7213 connect_blocks(&nodes[0], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS - ANTI_REORG_DELAY);
7214 check_closed_broadcast!(nodes[0], true);
7215 check_added_monitors!(nodes[0], 1);
7216 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7217 timeout_tx.push(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[1].clone());
7218 assert_eq!(timeout_tx[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
7219 // We fail non-dust-HTLC 2 by broadcast of local HTLC-timeout tx on local commitment tx
7220 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7221 mine_transaction(&nodes[0], &timeout_tx[0]);
7222 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7223 let events = nodes[0].node.get_and_clear_pending_events();
7224 expect_payment_failed!(nodes[0], events, non_dust_hash, true);
7226 // We fail dust-HTLC 1 by broadcast of remote commitment tx. If revoked, fail also non-dust HTLC
7227 mine_transaction(&nodes[0], &bs_commitment_tx[0]);
7228 check_closed_broadcast!(nodes[0], true);
7229 check_added_monitors!(nodes[0], 1);
7230 check_closed_event!(nodes[0], 1);
7231 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7232 connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
7233 timeout_tx.push(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[1].clone());
7235 let events = nodes[0].node.get_and_clear_pending_events();
7236 expect_payment_failed!(nodes[0], events, dust_hash, true);
7237 assert_eq!(timeout_tx[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
7238 // We fail non-dust-HTLC 2 by broadcast of local timeout tx on remote commitment tx
7239 mine_transaction(&nodes[0], &timeout_tx[0]);
7240 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7241 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7242 let events = nodes[0].node.get_and_clear_pending_events();
7243 expect_payment_failed!(nodes[0], events, non_dust_hash, true);
7245 // If revoked, both dust & non-dust HTLCs should have been failed after ANTI_REORG_DELAY confs of revoked
7247 let events = nodes[0].node.get_and_clear_pending_events();
7248 assert_eq!(events.len(), 2);
7251 Event::PaymentFailed { payment_hash, .. } => {
7252 if payment_hash == dust_hash { first = true; }
7253 else { first = false; }
7255 _ => panic!("Unexpected event"),
7258 Event::PaymentFailed { payment_hash, .. } => {
7259 if first { assert_eq!(payment_hash, non_dust_hash); }
7260 else { assert_eq!(payment_hash, dust_hash); }
7262 _ => panic!("Unexpected event"),
7269 fn test_sweep_outbound_htlc_failure_update() {
7270 do_test_sweep_outbound_htlc_failure_update(false, true);
7271 do_test_sweep_outbound_htlc_failure_update(false, false);
7272 do_test_sweep_outbound_htlc_failure_update(true, false);
7276 fn test_user_configurable_csv_delay() {
7277 // We test our channel constructors yield errors when we pass them absurd csv delay
7279 let mut low_our_to_self_config = UserConfig::default();
7280 low_our_to_self_config.own_channel_config.our_to_self_delay = 6;
7281 let mut high_their_to_self_config = UserConfig::default();
7282 high_their_to_self_config.peer_channel_config_limits.their_to_self_delay = 100;
7283 let user_cfgs = [Some(high_their_to_self_config.clone()), None];
7284 let chanmon_cfgs = create_chanmon_cfgs(2);
7285 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7286 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &user_cfgs);
7287 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7289 // We test config.our_to_self > BREAKDOWN_TIMEOUT is enforced in Channel::new_outbound()
7290 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) {
7292 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())); },
7293 _ => panic!("Unexpected event"),
7295 } else { assert!(false) }
7297 // We test config.our_to_self > BREAKDOWN_TIMEOUT is enforced in Channel::new_from_req()
7298 nodes[1].node.create_channel(nodes[0].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
7299 let mut open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
7300 open_channel.to_self_delay = 200;
7301 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) {
7303 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())); },
7304 _ => panic!("Unexpected event"),
7306 } else { assert!(false); }
7308 // We test msg.to_self_delay <= config.their_to_self_delay is enforced in Chanel::accept_channel()
7309 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
7310 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()));
7311 let mut accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
7312 accept_channel.to_self_delay = 200;
7313 nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &accept_channel);
7314 if let MessageSendEvent::HandleError { ref action, .. } = nodes[0].node.get_and_clear_pending_msg_events()[0] {
7316 &ErrorAction::SendErrorMessage { ref msg } => {
7317 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()));
7319 _ => { assert!(false); }
7321 } else { assert!(false); }
7322 check_closed_event!(nodes[0], 1);
7324 // We test msg.to_self_delay <= config.their_to_self_delay is enforced in Channel::new_from_req()
7325 nodes[1].node.create_channel(nodes[0].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
7326 let mut open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
7327 open_channel.to_self_delay = 200;
7328 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) {
7330 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())); },
7331 _ => panic!("Unexpected event"),
7333 } else { assert!(false); }
7337 fn test_data_loss_protect() {
7338 // We want to be sure that :
7339 // * we don't broadcast our Local Commitment Tx in case of fallen behind
7340 // (but this is not quite true - we broadcast during Drop because chanmon is out of sync with chanmgr)
7341 // * we close channel in case of detecting other being fallen behind
7342 // * we are able to claim our own outputs thanks to to_remote being static
7343 // TODO: this test is incomplete and the data_loss_protect implementation is incomplete - see issue #775
7349 let mut chanmon_cfgs = create_chanmon_cfgs(2);
7350 // We broadcast during Drop because chanmon is out of sync with chanmgr, which would cause a panic
7351 // during signing due to revoked tx
7352 chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
7353 let keys_manager = &chanmon_cfgs[0].keys_manager;
7356 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7357 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7358 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7360 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7362 // Cache node A state before any channel update
7363 let previous_node_state = nodes[0].node.encode();
7364 let mut previous_chain_monitor_state = test_utils::TestVecWriter(Vec::new());
7365 nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut previous_chain_monitor_state).unwrap();
7367 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
7368 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
7370 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
7371 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
7373 // Restore node A from previous state
7374 logger = test_utils::TestLogger::with_id(format!("node {}", 0));
7375 let mut chain_monitor = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(&mut io::Cursor::new(previous_chain_monitor_state.0), keys_manager).unwrap().1;
7376 chain_source = test_utils::TestChainSource::new(Network::Testnet);
7377 tx_broadcaster = test_utils::TestBroadcaster{txn_broadcasted: Mutex::new(Vec::new()), blocks: Arc::new(Mutex::new(Vec::new()))};
7378 fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
7379 persister = test_utils::TestPersister::new();
7380 monitor = test_utils::TestChainMonitor::new(Some(&chain_source), &tx_broadcaster, &logger, &fee_estimator, &persister, keys_manager);
7382 let mut channel_monitors = HashMap::new();
7383 channel_monitors.insert(OutPoint { txid: chan.3.txid(), index: 0 }, &mut chain_monitor);
7384 <(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 {
7385 keys_manager: keys_manager,
7386 fee_estimator: &fee_estimator,
7387 chain_monitor: &monitor,
7389 tx_broadcaster: &tx_broadcaster,
7390 default_config: UserConfig::default(),
7394 nodes[0].node = &node_state_0;
7395 assert!(monitor.watch_channel(OutPoint { txid: chan.3.txid(), index: 0 }, chain_monitor).is_ok());
7396 nodes[0].chain_monitor = &monitor;
7397 nodes[0].chain_source = &chain_source;
7399 check_added_monitors!(nodes[0], 1);
7401 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7402 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7404 let reestablish_0 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
7406 // Check we don't broadcast any transactions following learning of per_commitment_point from B
7407 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_0[0]);
7408 check_added_monitors!(nodes[0], 1);
7411 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
7412 assert_eq!(node_txn.len(), 0);
7415 let mut reestablish_1 = Vec::with_capacity(1);
7416 for msg in nodes[0].node.get_and_clear_pending_msg_events() {
7417 if let MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } = msg {
7418 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
7419 reestablish_1.push(msg.clone());
7420 } else if let MessageSendEvent::BroadcastChannelUpdate { .. } = msg {
7421 } else if let MessageSendEvent::HandleError { ref action, .. } = msg {
7423 &ErrorAction::SendErrorMessage { ref msg } => {
7424 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");
7426 _ => panic!("Unexpected event!"),
7429 panic!("Unexpected event")
7433 // Check we close channel detecting A is fallen-behind
7434 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
7435 check_closed_event!(nodes[1], 1);
7436 assert_eq!(check_closed_broadcast!(nodes[1], true).unwrap().data, "Peer attempted to reestablish channel with a very old local commitment transaction");
7437 check_added_monitors!(nodes[1], 1);
7439 // Check A is able to claim to_remote output
7440 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
7441 assert_eq!(node_txn.len(), 1);
7442 check_spends!(node_txn[0], chan.3);
7443 assert_eq!(node_txn[0].output.len(), 2);
7444 mine_transaction(&nodes[0], &node_txn[0]);
7445 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7446 check_closed_event!(nodes[0], 1);
7447 let spend_txn = check_spendable_outputs!(nodes[0], node_cfgs[0].keys_manager);
7448 assert_eq!(spend_txn.len(), 1);
7449 check_spends!(spend_txn[0], node_txn[0]);
7453 fn test_check_htlc_underpaying() {
7454 // Send payment through A -> B but A is maliciously
7455 // sending a probe payment (i.e less than expected value0
7456 // to B, B should refuse payment.
7458 let chanmon_cfgs = create_chanmon_cfgs(2);
7459 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7460 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7461 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7463 // Create some initial channels
7464 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7466 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();
7467 let (_, our_payment_hash, _) = get_payment_preimage_hash!(nodes[0]);
7468 let our_payment_secret = nodes[1].node.create_inbound_payment_for_hash(our_payment_hash, Some(100_000), 7200, 0).unwrap();
7469 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
7470 check_added_monitors!(nodes[0], 1);
7472 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
7473 assert_eq!(events.len(), 1);
7474 let mut payment_event = SendEvent::from_event(events.pop().unwrap());
7475 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
7476 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
7478 // Note that we first have to wait a random delay before processing the receipt of the HTLC,
7479 // and then will wait a second random delay before failing the HTLC back:
7480 let events = nodes[1].node.get_and_clear_pending_events();
7481 expect_pending_htlcs_forwardable!(nodes[1], events);
7482 let events = nodes[1].node.get_and_clear_pending_events();
7483 expect_pending_htlcs_forwardable!(nodes[1], events);
7485 // Node 3 is expecting payment of 100_000 but received 10_000,
7486 // it should fail htlc like we didn't know the preimage.
7487 nodes[1].node.process_pending_htlc_forwards();
7489 let events = nodes[1].node.get_and_clear_pending_msg_events();
7490 assert_eq!(events.len(), 1);
7491 let (update_fail_htlc, commitment_signed) = match events[0] {
7492 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 } } => {
7493 assert!(update_add_htlcs.is_empty());
7494 assert!(update_fulfill_htlcs.is_empty());
7495 assert_eq!(update_fail_htlcs.len(), 1);
7496 assert!(update_fail_malformed_htlcs.is_empty());
7497 assert!(update_fee.is_none());
7498 (update_fail_htlcs[0].clone(), commitment_signed)
7500 _ => panic!("Unexpected event"),
7502 check_added_monitors!(nodes[1], 1);
7504 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlc);
7505 commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
7507 // 10_000 msat as u64, followed by a height of CHAN_CONFIRM_DEPTH as u32
7508 let mut expected_failure_data = byte_utils::be64_to_array(10_000).to_vec();
7509 expected_failure_data.extend_from_slice(&byte_utils::be32_to_array(CHAN_CONFIRM_DEPTH));
7510 let events = nodes[0].node.get_and_clear_pending_events();
7511 expect_payment_failed!(nodes[0], events, our_payment_hash, true, 0x4000|15, &expected_failure_data[..]);
7515 fn test_announce_disable_channels() {
7516 // Create 2 channels between A and B. Disconnect B. Call timer_tick_occurred and check for generated
7517 // ChannelUpdate. Reconnect B, reestablish and check there is non-generated ChannelUpdate.
7519 let chanmon_cfgs = create_chanmon_cfgs(2);
7520 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7521 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7522 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7524 let short_id_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
7525 let short_id_2 = create_announced_chan_between_nodes(&nodes, 1, 0, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
7526 let short_id_3 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
7529 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
7530 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
7532 nodes[0].node.timer_tick_occurred(); // Enabled -> DisabledStaged
7533 nodes[0].node.timer_tick_occurred(); // DisabledStaged -> Disabled
7534 let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
7535 assert_eq!(msg_events.len(), 3);
7536 let mut chans_disabled: HashSet<u64> = [short_id_1, short_id_2, short_id_3].iter().map(|a| *a).collect();
7537 for e in msg_events {
7539 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
7540 assert_eq!(msg.contents.flags & (1<<1), 1<<1); // The "channel disabled" bit should be set
7541 // Check that each channel gets updated exactly once
7542 if !chans_disabled.remove(&msg.contents.short_channel_id) {
7543 panic!("Generated ChannelUpdate for wrong chan!");
7546 _ => panic!("Unexpected event"),
7550 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7551 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
7552 assert_eq!(reestablish_1.len(), 3);
7553 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7554 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
7555 assert_eq!(reestablish_2.len(), 3);
7557 // Reestablish chan_1
7558 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
7559 handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
7560 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
7561 handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
7562 // Reestablish chan_2
7563 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[1]);
7564 handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
7565 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[1]);
7566 handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
7567 // Reestablish chan_3
7568 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[2]);
7569 handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
7570 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[2]);
7571 handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
7573 nodes[0].node.timer_tick_occurred();
7574 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
7575 nodes[0].node.timer_tick_occurred();
7576 let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
7577 assert_eq!(msg_events.len(), 3);
7578 chans_disabled = [short_id_1, short_id_2, short_id_3].iter().map(|a| *a).collect();
7579 for e in msg_events {
7581 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
7582 assert_eq!(msg.contents.flags & (1<<1), 0); // The "channel disabled" bit should be off
7583 // Check that each channel gets updated exactly once
7584 if !chans_disabled.remove(&msg.contents.short_channel_id) {
7585 panic!("Generated ChannelUpdate for wrong chan!");
7588 _ => panic!("Unexpected event"),
7594 fn test_priv_forwarding_rejection() {
7595 // If we have a private channel with outbound liquidity, and
7596 // UserConfig::accept_forwards_to_priv_channels is set to false, we should reject any attempts
7597 // to forward through that channel.
7598 let chanmon_cfgs = create_chanmon_cfgs(3);
7599 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7600 let mut no_announce_cfg = test_default_channel_config();
7601 no_announce_cfg.channel_options.announced_channel = false;
7602 no_announce_cfg.accept_forwards_to_priv_channels = false;
7603 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, Some(no_announce_cfg), None]);
7604 let persister: test_utils::TestPersister;
7605 let new_chain_monitor: test_utils::TestChainMonitor;
7606 let nodes_1_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
7607 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7609 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1_000_000, 500_000_000, InitFeatures::known(), InitFeatures::known());
7611 // Note that the create_*_chan functions in utils requires announcement_signatures, which we do
7612 // not send for private channels.
7613 nodes[1].node.create_channel(nodes[2].node.get_our_node_id(), 1_000_000, 500_000_000, 42, None).unwrap();
7614 let open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[2].node.get_our_node_id());
7615 nodes[2].node.handle_open_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &open_channel);
7616 let accept_channel = get_event_msg!(nodes[2], MessageSendEvent::SendAcceptChannel, nodes[1].node.get_our_node_id());
7617 nodes[1].node.handle_accept_channel(&nodes[2].node.get_our_node_id(), InitFeatures::known(), &accept_channel);
7619 let (temporary_channel_id, tx, _) = create_funding_transaction(&nodes[1], 1_000_000, 42);
7620 nodes[1].node.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
7621 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()));
7622 check_added_monitors!(nodes[2], 1);
7624 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()));
7625 check_added_monitors!(nodes[1], 1);
7627 let conf_height = core::cmp::max(nodes[1].best_block_info().1 + 1, nodes[2].best_block_info().1 + 1);
7628 confirm_transaction_at(&nodes[1], &tx, conf_height);
7629 connect_blocks(&nodes[1], CHAN_CONFIRM_DEPTH - 1);
7630 confirm_transaction_at(&nodes[2], &tx, conf_height);
7631 connect_blocks(&nodes[2], CHAN_CONFIRM_DEPTH - 1);
7632 let as_funding_locked = get_event_msg!(nodes[1], MessageSendEvent::SendFundingLocked, nodes[2].node.get_our_node_id());
7633 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()));
7634 get_event_msg!(nodes[1], MessageSendEvent::SendChannelUpdate, nodes[2].node.get_our_node_id());
7635 nodes[2].node.handle_funding_locked(&nodes[1].node.get_our_node_id(), &as_funding_locked);
7636 get_event_msg!(nodes[2], MessageSendEvent::SendChannelUpdate, nodes[1].node.get_our_node_id());
7638 assert!(nodes[0].node.list_usable_channels()[0].is_public);
7639 assert_eq!(nodes[1].node.list_usable_channels().len(), 2);
7640 assert!(!nodes[2].node.list_usable_channels()[0].is_public);
7642 // We should always be able to forward through nodes[1] as long as its out through a public
7644 send_payment(&nodes[2], &[&nodes[1], &nodes[0]], 10_000);
7646 // ... however, if we send to nodes[2], we will have to pass the private channel from nodes[1]
7647 // to nodes[2], which should be rejected:
7648 let (our_payment_preimage, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[2]);
7649 let route = get_route(&nodes[0].node.get_our_node_id(),
7650 &nodes[0].net_graph_msg_handler.network_graph,
7651 &nodes[2].node.get_our_node_id(), Some(InvoiceFeatures::known()), None,
7652 &[&RouteHint(vec![RouteHintHop {
7653 src_node_id: nodes[1].node.get_our_node_id(),
7654 short_channel_id: nodes[2].node.list_channels()[0].short_channel_id.unwrap(),
7655 fees: RoutingFees { base_msat: 1000, proportional_millionths: 0 },
7656 cltv_expiry_delta: MIN_CLTV_EXPIRY_DELTA,
7657 htlc_minimum_msat: None,
7658 htlc_maximum_msat: None,
7659 }])], 10_000, TEST_FINAL_CLTV, nodes[0].logger).unwrap();
7661 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
7662 check_added_monitors!(nodes[0], 1);
7663 let payment_event = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
7664 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
7665 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false, true);
7667 let htlc_fail_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
7668 assert!(htlc_fail_updates.update_add_htlcs.is_empty());
7669 assert_eq!(htlc_fail_updates.update_fail_htlcs.len(), 1);
7670 assert!(htlc_fail_updates.update_fail_malformed_htlcs.is_empty());
7671 assert!(htlc_fail_updates.update_fee.is_none());
7673 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_fail_updates.update_fail_htlcs[0]);
7674 commitment_signed_dance!(nodes[0], nodes[1], htlc_fail_updates.commitment_signed, true, true);
7675 expect_payment_failed_with_update!(nodes[0], our_payment_hash, false, nodes[2].node.list_channels()[0].short_channel_id.unwrap(), true);
7677 // Now disconnect nodes[1] from its peers and restart with accept_forwards_to_priv_channels set
7678 // to true. Sadly there is currently no way to change it at runtime.
7680 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
7681 nodes[2].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
7683 let nodes_1_serialized = nodes[1].node.encode();
7684 let mut monitor_a_serialized = test_utils::TestVecWriter(Vec::new());
7685 let mut monitor_b_serialized = test_utils::TestVecWriter(Vec::new());
7687 let mons = nodes[1].chain_monitor.chain_monitor.monitors.read().unwrap();
7688 let mut mon_iter = mons.iter();
7689 mon_iter.next().unwrap().1.write(&mut monitor_a_serialized).unwrap();
7690 mon_iter.next().unwrap().1.write(&mut monitor_b_serialized).unwrap();
7693 persister = test_utils::TestPersister::new();
7694 let keys_manager = &chanmon_cfgs[1].keys_manager;
7695 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);
7696 nodes[1].chain_monitor = &new_chain_monitor;
7698 let mut monitor_a_read = &monitor_a_serialized.0[..];
7699 let mut monitor_b_read = &monitor_b_serialized.0[..];
7700 let (_, mut monitor_a) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(&mut monitor_a_read, keys_manager).unwrap();
7701 let (_, mut monitor_b) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(&mut monitor_b_read, keys_manager).unwrap();
7702 assert!(monitor_a_read.is_empty());
7703 assert!(monitor_b_read.is_empty());
7705 no_announce_cfg.accept_forwards_to_priv_channels = true;
7707 let mut nodes_1_read = &nodes_1_serialized[..];
7708 let (_, nodes_1_deserialized_tmp) = {
7709 let mut channel_monitors = HashMap::new();
7710 channel_monitors.insert(monitor_a.get_funding_txo().0, &mut monitor_a);
7711 channel_monitors.insert(monitor_b.get_funding_txo().0, &mut monitor_b);
7712 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_1_read, ChannelManagerReadArgs {
7713 default_config: no_announce_cfg,
7715 fee_estimator: node_cfgs[1].fee_estimator,
7716 chain_monitor: nodes[1].chain_monitor,
7717 tx_broadcaster: nodes[1].tx_broadcaster.clone(),
7718 logger: nodes[1].logger,
7722 assert!(nodes_1_read.is_empty());
7723 nodes_1_deserialized = nodes_1_deserialized_tmp;
7725 assert!(nodes[1].chain_monitor.watch_channel(monitor_a.get_funding_txo().0, monitor_a).is_ok());
7726 assert!(nodes[1].chain_monitor.watch_channel(monitor_b.get_funding_txo().0, monitor_b).is_ok());
7727 check_added_monitors!(nodes[1], 2);
7728 nodes[1].node = &nodes_1_deserialized;
7730 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::known() });
7731 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7732 let as_reestablish = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
7733 let bs_reestablish = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
7734 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &as_reestablish);
7735 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &bs_reestablish);
7736 get_event_msg!(nodes[0], MessageSendEvent::SendChannelUpdate, nodes[1].node.get_our_node_id());
7737 get_event_msg!(nodes[1], MessageSendEvent::SendChannelUpdate, nodes[0].node.get_our_node_id());
7739 nodes[1].node.peer_connected(&nodes[2].node.get_our_node_id(), &msgs::Init { features: InitFeatures::known() });
7740 nodes[2].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7741 let bs_reestablish = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[2].node.get_our_node_id());
7742 let cs_reestablish = get_event_msg!(nodes[2], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
7743 nodes[2].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &bs_reestablish);
7744 nodes[1].node.handle_channel_reestablish(&nodes[2].node.get_our_node_id(), &cs_reestablish);
7745 get_event_msg!(nodes[1], MessageSendEvent::SendChannelUpdate, nodes[2].node.get_our_node_id());
7746 get_event_msg!(nodes[2], MessageSendEvent::SendChannelUpdate, nodes[1].node.get_our_node_id());
7748 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
7749 check_added_monitors!(nodes[0], 1);
7750 pass_along_route(&nodes[0], &[&[&nodes[1], &nodes[2]]], 10_000, our_payment_hash, our_payment_secret);
7751 claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], our_payment_preimage);
7755 fn test_bump_penalty_txn_on_revoked_commitment() {
7756 // In case of penalty txn with too low feerates for getting into mempools, RBF-bump them to be sure
7757 // we're able to claim outputs on revoked commitment transaction before timelocks expiration
7759 let chanmon_cfgs = create_chanmon_cfgs(2);
7760 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7761 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7762 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7764 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
7765 let logger = test_utils::TestLogger::new();
7767 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
7768 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
7769 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();
7770 send_along_route(&nodes[1], route, &vec!(&nodes[0])[..], 3000000);
7772 let revoked_txn = get_local_commitment_txn!(nodes[0], chan.2);
7773 // Revoked commitment txn with 4 outputs : to_local, to_remote, 1 outgoing HTLC, 1 incoming HTLC
7774 assert_eq!(revoked_txn[0].output.len(), 4);
7775 assert_eq!(revoked_txn[0].input.len(), 1);
7776 assert_eq!(revoked_txn[0].input[0].previous_output.txid, chan.3.txid());
7777 let revoked_txid = revoked_txn[0].txid();
7779 let mut penalty_sum = 0;
7780 for outp in revoked_txn[0].output.iter() {
7781 if outp.script_pubkey.is_v0_p2wsh() {
7782 penalty_sum += outp.value;
7786 // Connect blocks to change height_timer range to see if we use right soonest_timelock
7787 let header_114 = connect_blocks(&nodes[1], 14);
7789 // Actually revoke tx by claiming a HTLC
7790 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
7791 let header = BlockHeader { version: 0x20000000, prev_blockhash: header_114, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7792 connect_block(&nodes[1], &Block { header, txdata: vec![revoked_txn[0].clone()] });
7793 check_added_monitors!(nodes[1], 1);
7795 // One or more justice tx should have been broadcast, check it
7799 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7800 assert_eq!(node_txn.len(), 2); // justice tx (broadcasted from ChannelMonitor) + local commitment tx
7801 assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
7802 assert_eq!(node_txn[0].output.len(), 1);
7803 check_spends!(node_txn[0], revoked_txn[0]);
7804 let fee_1 = penalty_sum - node_txn[0].output[0].value;
7805 feerate_1 = fee_1 * 1000 / node_txn[0].get_weight() as u64;
7806 penalty_1 = node_txn[0].txid();
7810 // After exhaustion of height timer, a new bumped justice tx should have been broadcast, check it
7811 connect_blocks(&nodes[1], 15);
7812 let mut penalty_2 = penalty_1;
7813 let mut feerate_2 = 0;
7815 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7816 assert_eq!(node_txn.len(), 1);
7817 if node_txn[0].input[0].previous_output.txid == revoked_txid {
7818 assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
7819 assert_eq!(node_txn[0].output.len(), 1);
7820 check_spends!(node_txn[0], revoked_txn[0]);
7821 penalty_2 = node_txn[0].txid();
7822 // Verify new bumped tx is different from last claiming transaction, we don't want spurrious rebroadcast
7823 assert_ne!(penalty_2, penalty_1);
7824 let fee_2 = penalty_sum - node_txn[0].output[0].value;
7825 feerate_2 = fee_2 * 1000 / node_txn[0].get_weight() as u64;
7826 // Verify 25% bump heuristic
7827 assert!(feerate_2 * 100 >= feerate_1 * 125);
7831 assert_ne!(feerate_2, 0);
7833 // After exhaustion of height timer for a 2nd time, a new bumped justice tx should have been broadcast, check it
7834 connect_blocks(&nodes[1], 1);
7836 let mut feerate_3 = 0;
7838 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7839 assert_eq!(node_txn.len(), 1);
7840 if node_txn[0].input[0].previous_output.txid == revoked_txid {
7841 assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
7842 assert_eq!(node_txn[0].output.len(), 1);
7843 check_spends!(node_txn[0], revoked_txn[0]);
7844 penalty_3 = node_txn[0].txid();
7845 // Verify new bumped tx is different from last claiming transaction, we don't want spurrious rebroadcast
7846 assert_ne!(penalty_3, penalty_2);
7847 let fee_3 = penalty_sum - node_txn[0].output[0].value;
7848 feerate_3 = fee_3 * 1000 / node_txn[0].get_weight() as u64;
7849 // Verify 25% bump heuristic
7850 assert!(feerate_3 * 100 >= feerate_2 * 125);
7854 assert_ne!(feerate_3, 0);
7856 nodes[1].node.get_and_clear_pending_events();
7857 nodes[1].node.get_and_clear_pending_msg_events();
7861 fn test_bump_penalty_txn_on_revoked_htlcs() {
7862 // In case of penalty txn with too low feerates for getting into mempools, RBF-bump them to sure
7863 // we're able to claim outputs on revoked HTLC transactions before timelocks expiration
7865 let mut chanmon_cfgs = create_chanmon_cfgs(2);
7866 chanmon_cfgs[1].keys_manager.disable_revocation_policy_check = true;
7867 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7868 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7869 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7871 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
7872 // Lock HTLC in both directions (using a slightly lower CLTV delay to provide timely RBF bumps)
7873 let route = get_route(&nodes[0].node.get_our_node_id(), &nodes[0].net_graph_msg_handler.network_graph,
7874 &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 3_000_000, 50, nodes[0].logger).unwrap();
7875 let payment_preimage = send_along_route(&nodes[0], route, &[&nodes[1]], 3_000_000).0;
7876 let route = get_route(&nodes[1].node.get_our_node_id(), &nodes[1].net_graph_msg_handler.network_graph,
7877 &nodes[0].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 3_000_000, 50, nodes[0].logger).unwrap();
7878 send_along_route(&nodes[1], route, &[&nodes[0]], 3_000_000);
7880 let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan.2);
7881 assert_eq!(revoked_local_txn[0].input.len(), 1);
7882 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
7884 // Revoke local commitment tx
7885 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
7887 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7888 // B will generate both revoked HTLC-timeout/HTLC-preimage txn from revoked commitment tx
7889 connect_block(&nodes[1], &Block { header, txdata: vec![revoked_local_txn[0].clone()] });
7890 check_closed_broadcast!(nodes[1], true);
7891 check_added_monitors!(nodes[1], 1);
7892 check_closed_event!(nodes[1], 1);
7893 connect_blocks(&nodes[1], 49); // Confirm blocks until the HTLC expires (note CLTV was explicitly 50 above)
7895 let revoked_htlc_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7896 assert_eq!(revoked_htlc_txn.len(), 3);
7897 check_spends!(revoked_htlc_txn[1], chan.3);
7899 assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
7900 assert_eq!(revoked_htlc_txn[0].input.len(), 1);
7901 check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
7903 assert_eq!(revoked_htlc_txn[2].input.len(), 1);
7904 assert_eq!(revoked_htlc_txn[2].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
7905 assert_eq!(revoked_htlc_txn[2].output.len(), 1);
7906 check_spends!(revoked_htlc_txn[2], revoked_local_txn[0]);
7908 // Broadcast set of revoked txn on A
7909 let hash_128 = connect_blocks(&nodes[0], 40);
7910 let header_11 = BlockHeader { version: 0x20000000, prev_blockhash: hash_128, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7911 connect_block(&nodes[0], &Block { header: header_11, txdata: vec![revoked_local_txn[0].clone()] });
7912 let header_129 = BlockHeader { version: 0x20000000, prev_blockhash: header_11.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7913 connect_block(&nodes[0], &Block { header: header_129, txdata: vec![revoked_htlc_txn[0].clone(), revoked_htlc_txn[2].clone()] });
7914 let events = nodes[0].node.get_and_clear_pending_events();
7915 expect_pending_htlcs_forwardable_ignore!(nodes[0], events[0..1]);
7917 Event::ChannelClosed { .. } => {}
7918 _ => panic!("Unexpected event"),
7924 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7925 assert_eq!(node_txn.len(), 5); // 3 penalty txn on revoked commitment tx + A commitment tx + 1 penalty tnx on revoked HTLC txn
7926 // Verify claim tx are spending revoked HTLC txn
7928 // node_txn 0-2 each spend a separate revoked output from revoked_local_txn[0]
7929 // Note that node_txn[0] and node_txn[1] are bogus - they double spend the revoked_htlc_txn
7930 // which are included in the same block (they are broadcasted because we scan the
7931 // transactions linearly and generate claims as we go, they likely should be removed in the
7933 assert_eq!(node_txn[0].input.len(), 1);
7934 check_spends!(node_txn[0], revoked_local_txn[0]);
7935 assert_eq!(node_txn[1].input.len(), 1);
7936 check_spends!(node_txn[1], revoked_local_txn[0]);
7937 assert_eq!(node_txn[2].input.len(), 1);
7938 check_spends!(node_txn[2], revoked_local_txn[0]);
7940 // Each of the three justice transactions claim a separate (single) output of the three
7941 // available, which we check here:
7942 assert_ne!(node_txn[0].input[0].previous_output, node_txn[1].input[0].previous_output);
7943 assert_ne!(node_txn[0].input[0].previous_output, node_txn[2].input[0].previous_output);
7944 assert_ne!(node_txn[1].input[0].previous_output, node_txn[2].input[0].previous_output);
7946 assert_eq!(node_txn[0].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
7947 assert_eq!(node_txn[1].input[0].previous_output, revoked_htlc_txn[2].input[0].previous_output);
7949 // node_txn[3] is the local commitment tx broadcast just because (and somewhat in case of
7950 // reorgs, though its not clear its ever worth broadcasting conflicting txn like this when
7951 // a remote commitment tx has already been confirmed).
7952 check_spends!(node_txn[3], chan.3);
7954 // node_txn[4] spends the revoked outputs from the revoked_htlc_txn (which only have one
7955 // output, checked above).
7956 assert_eq!(node_txn[4].input.len(), 2);
7957 assert_eq!(node_txn[4].output.len(), 1);
7958 check_spends!(node_txn[4], revoked_htlc_txn[0], revoked_htlc_txn[2]);
7960 first = node_txn[4].txid();
7961 // Store both feerates for later comparison
7962 let fee_1 = revoked_htlc_txn[0].output[0].value + revoked_htlc_txn[2].output[0].value - node_txn[4].output[0].value;
7963 feerate_1 = fee_1 * 1000 / node_txn[4].get_weight() as u64;
7964 penalty_txn = vec![node_txn[2].clone()];
7968 // Connect one more block to see if bumped penalty are issued for HTLC txn
7969 let header_130 = BlockHeader { version: 0x20000000, prev_blockhash: header_129.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7970 connect_block(&nodes[0], &Block { header: header_130, txdata: penalty_txn });
7971 let header_131 = BlockHeader { version: 0x20000000, prev_blockhash: header_130.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7972 connect_block(&nodes[0], &Block { header: header_131, txdata: Vec::new() });
7974 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7975 assert_eq!(node_txn.len(), 2); // 2 bumped penalty txn on revoked commitment tx
7977 check_spends!(node_txn[0], revoked_local_txn[0]);
7978 check_spends!(node_txn[1], revoked_local_txn[0]);
7979 // Note that these are both bogus - they spend outputs already claimed in block 129:
7980 if node_txn[0].input[0].previous_output == revoked_htlc_txn[0].input[0].previous_output {
7981 assert_eq!(node_txn[1].input[0].previous_output, revoked_htlc_txn[2].input[0].previous_output);
7983 assert_eq!(node_txn[0].input[0].previous_output, revoked_htlc_txn[2].input[0].previous_output);
7984 assert_eq!(node_txn[1].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
7990 // Few more blocks to confirm penalty txn
7991 connect_blocks(&nodes[0], 4);
7992 assert!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
7993 let header_144 = connect_blocks(&nodes[0], 9);
7995 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7996 assert_eq!(node_txn.len(), 1);
7998 assert_eq!(node_txn[0].input.len(), 2);
7999 check_spends!(node_txn[0], revoked_htlc_txn[0], revoked_htlc_txn[2]);
8000 // Verify bumped tx is different and 25% bump heuristic
8001 assert_ne!(first, node_txn[0].txid());
8002 let fee_2 = revoked_htlc_txn[0].output[0].value + revoked_htlc_txn[2].output[0].value - node_txn[0].output[0].value;
8003 let feerate_2 = fee_2 * 1000 / node_txn[0].get_weight() as u64;
8004 assert!(feerate_2 * 100 > feerate_1 * 125);
8005 let txn = vec![node_txn[0].clone()];
8009 // Broadcast claim txn and confirm blocks to avoid further bumps on this outputs
8010 let header_145 = BlockHeader { version: 0x20000000, prev_blockhash: header_144, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8011 connect_block(&nodes[0], &Block { header: header_145, txdata: node_txn });
8012 connect_blocks(&nodes[0], 20);
8014 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8015 // We verify than no new transaction has been broadcast because previously
8016 // we were buggy on this exact behavior by not tracking for monitoring remote HTLC outputs (see #411)
8017 // which means we wouldn't see a spend of them by a justice tx and bumped justice tx
8018 // were generated forever instead of safe cleaning after confirmation and ANTI_REORG_SAFE_DELAY blocks.
8019 // Enforce spending of revoked htlc output by claiming transaction remove request as expected and dry
8020 // up bumped justice generation.
8021 assert_eq!(node_txn.len(), 0);
8024 check_closed_broadcast!(nodes[0], true);
8025 check_added_monitors!(nodes[0], 1);
8029 fn test_bump_penalty_txn_on_remote_commitment() {
8030 // In case of claim txn with too low feerates for getting into mempools, RBF-bump them to be sure
8031 // we're able to claim outputs on remote commitment transaction before timelocks expiration
8034 // Provide preimage for one
8035 // Check aggregation
8037 let chanmon_cfgs = create_chanmon_cfgs(2);
8038 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8039 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8040 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8042 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
8043 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
8044 route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000).0;
8046 // Remote commitment txn with 4 outputs : to_local, to_remote, 1 outgoing HTLC, 1 incoming HTLC
8047 let remote_txn = get_local_commitment_txn!(nodes[0], chan.2);
8048 assert_eq!(remote_txn[0].output.len(), 4);
8049 assert_eq!(remote_txn[0].input.len(), 1);
8050 assert_eq!(remote_txn[0].input[0].previous_output.txid, chan.3.txid());
8052 // Claim a HTLC without revocation (provide B monitor with preimage)
8053 nodes[1].node.claim_funds(payment_preimage);
8054 mine_transaction(&nodes[1], &remote_txn[0]);
8055 check_added_monitors!(nodes[1], 2);
8056 connect_blocks(&nodes[1], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
8058 // One or more claim tx should have been broadcast, check it
8062 let feerate_timeout;
8063 let feerate_preimage;
8065 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8066 // 9 transactions including:
8067 // 1*2 ChannelManager local broadcasts of commitment + HTLC-Success
8068 // 1*3 ChannelManager local broadcasts of commitment + HTLC-Success + HTLC-Timeout
8069 // 2 * HTLC-Success (one RBF bump we'll check later)
8071 assert_eq!(node_txn.len(), 8);
8072 assert_eq!(node_txn[0].input.len(), 1);
8073 assert_eq!(node_txn[6].input.len(), 1);
8074 check_spends!(node_txn[0], remote_txn[0]);
8075 check_spends!(node_txn[6], remote_txn[0]);
8076 assert_eq!(node_txn[0].input[0].previous_output, node_txn[3].input[0].previous_output);
8077 preimage_bump = node_txn[3].clone();
8079 check_spends!(node_txn[1], chan.3);
8080 check_spends!(node_txn[2], node_txn[1]);
8081 assert_eq!(node_txn[1], node_txn[4]);
8082 assert_eq!(node_txn[2], node_txn[5]);
8084 timeout = node_txn[6].txid();
8085 let index = node_txn[6].input[0].previous_output.vout;
8086 let fee = remote_txn[0].output[index as usize].value - node_txn[6].output[0].value;
8087 feerate_timeout = fee * 1000 / node_txn[6].get_weight() as u64;
8089 preimage = node_txn[0].txid();
8090 let index = node_txn[0].input[0].previous_output.vout;
8091 let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
8092 feerate_preimage = fee * 1000 / node_txn[0].get_weight() as u64;
8096 assert_ne!(feerate_timeout, 0);
8097 assert_ne!(feerate_preimage, 0);
8099 // After exhaustion of height timer, new bumped claim txn should have been broadcast, check it
8100 connect_blocks(&nodes[1], 15);
8102 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8103 assert_eq!(node_txn.len(), 1);
8104 assert_eq!(node_txn[0].input.len(), 1);
8105 assert_eq!(preimage_bump.input.len(), 1);
8106 check_spends!(node_txn[0], remote_txn[0]);
8107 check_spends!(preimage_bump, remote_txn[0]);
8109 let index = preimage_bump.input[0].previous_output.vout;
8110 let fee = remote_txn[0].output[index as usize].value - preimage_bump.output[0].value;
8111 let new_feerate = fee * 1000 / preimage_bump.get_weight() as u64;
8112 assert!(new_feerate * 100 > feerate_timeout * 125);
8113 assert_ne!(timeout, preimage_bump.txid());
8115 let index = node_txn[0].input[0].previous_output.vout;
8116 let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
8117 let new_feerate = fee * 1000 / node_txn[0].get_weight() as u64;
8118 assert!(new_feerate * 100 > feerate_preimage * 125);
8119 assert_ne!(preimage, node_txn[0].txid());
8124 nodes[1].node.get_and_clear_pending_events();
8125 nodes[1].node.get_and_clear_pending_msg_events();
8129 fn test_counterparty_raa_skip_no_crash() {
8130 // Previously, if our counterparty sent two RAAs in a row without us having provided a
8131 // commitment transaction, we would have happily carried on and provided them the next
8132 // commitment transaction based on one RAA forward. This would probably eventually have led to
8133 // channel closure, but it would not have resulted in funds loss. Still, our
8134 // EnforcingSigner would have panicked as it doesn't like jumps into the future. Here, we
8135 // check simply that the channel is closed in response to such an RAA, but don't check whether
8136 // we decide to punish our counterparty for revoking their funds (as we don't currently
8138 let chanmon_cfgs = create_chanmon_cfgs(2);
8139 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8140 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8141 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8142 let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).2;
8144 let mut guard = nodes[0].node.channel_state.lock().unwrap();
8145 let keys = guard.by_id.get_mut(&channel_id).unwrap().get_signer();
8147 const INITIAL_COMMITMENT_NUMBER: u64 = (1 << 48) - 1;
8149 // Make signer believe we got a counterparty signature, so that it allows the revocation
8150 keys.get_enforcement_state().last_holder_commitment -= 1;
8151 let per_commitment_secret = keys.release_commitment_secret(INITIAL_COMMITMENT_NUMBER);
8153 // Must revoke without gaps
8154 keys.get_enforcement_state().last_holder_commitment -= 1;
8155 keys.release_commitment_secret(INITIAL_COMMITMENT_NUMBER - 1);
8157 keys.get_enforcement_state().last_holder_commitment -= 1;
8158 let next_per_commitment_point = PublicKey::from_secret_key(&Secp256k1::new(),
8159 &SecretKey::from_slice(&keys.release_commitment_secret(INITIAL_COMMITMENT_NUMBER - 2)).unwrap());
8161 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(),
8162 &msgs::RevokeAndACK { channel_id, per_commitment_secret, next_per_commitment_point });
8163 assert_eq!(check_closed_broadcast!(nodes[1], true).unwrap().data, "Received an unexpected revoke_and_ack");
8164 check_added_monitors!(nodes[1], 1);
8165 check_closed_event!(nodes[1], 1);
8169 fn test_bump_txn_sanitize_tracking_maps() {
8170 // Sanitizing pendning_claim_request and claimable_outpoints used to be buggy,
8171 // verify we clean then right after expiration of ANTI_REORG_DELAY.
8173 let chanmon_cfgs = create_chanmon_cfgs(2);
8174 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8175 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8176 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8178 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
8179 // Lock HTLC in both directions
8180 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000).0;
8181 route_payment(&nodes[1], &vec!(&nodes[0])[..], 9_000_000).0;
8183 let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan.2);
8184 assert_eq!(revoked_local_txn[0].input.len(), 1);
8185 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
8187 // Revoke local commitment tx
8188 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
8190 // Broadcast set of revoked txn on A
8191 connect_blocks(&nodes[0], TEST_FINAL_CLTV + 2 - CHAN_CONFIRM_DEPTH);
8192 let events = nodes[0].node.get_and_clear_pending_events();
8193 expect_pending_htlcs_forwardable_ignore!(nodes[0], events);
8194 assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 0);
8196 mine_transaction(&nodes[0], &revoked_local_txn[0]);
8197 check_closed_broadcast!(nodes[0], true);
8198 check_added_monitors!(nodes[0], 1);
8199 check_closed_event!(nodes[0], 1);
8201 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8202 assert_eq!(node_txn.len(), 4); //ChannelMonitor: justice txn * 3, ChannelManager: local commitment tx
8203 check_spends!(node_txn[0], revoked_local_txn[0]);
8204 check_spends!(node_txn[1], revoked_local_txn[0]);
8205 check_spends!(node_txn[2], revoked_local_txn[0]);
8206 let penalty_txn = vec![node_txn[0].clone(), node_txn[1].clone(), node_txn[2].clone()];
8210 let header_130 = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8211 connect_block(&nodes[0], &Block { header: header_130, txdata: penalty_txn });
8212 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
8214 let monitors = nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap();
8215 if let Some(monitor) = monitors.get(&OutPoint { txid: chan.3.txid(), index: 0 }) {
8216 assert!(monitor.inner.lock().unwrap().onchain_tx_handler.pending_claim_requests.is_empty());
8217 assert!(monitor.inner.lock().unwrap().onchain_tx_handler.claimable_outpoints.is_empty());
8223 fn test_override_channel_config() {
8224 let chanmon_cfgs = create_chanmon_cfgs(2);
8225 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8226 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8227 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8229 // Node0 initiates a channel to node1 using the override config.
8230 let mut override_config = UserConfig::default();
8231 override_config.own_channel_config.our_to_self_delay = 200;
8233 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 16_000_000, 12_000_000, 42, Some(override_config)).unwrap();
8235 // Assert the channel created by node0 is using the override config.
8236 let res = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8237 assert_eq!(res.channel_flags, 0);
8238 assert_eq!(res.to_self_delay, 200);
8242 fn test_override_0msat_htlc_minimum() {
8243 let mut zero_config = UserConfig::default();
8244 zero_config.own_channel_config.our_htlc_minimum_msat = 0;
8245 let chanmon_cfgs = create_chanmon_cfgs(2);
8246 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8247 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, Some(zero_config.clone())]);
8248 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8250 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 16_000_000, 12_000_000, 42, Some(zero_config)).unwrap();
8251 let res = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8252 assert_eq!(res.htlc_minimum_msat, 1);
8254 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &res);
8255 let res = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
8256 assert_eq!(res.htlc_minimum_msat, 1);
8260 fn test_simple_mpp() {
8261 // Simple test of sending a multi-path payment.
8262 let chanmon_cfgs = create_chanmon_cfgs(4);
8263 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
8264 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
8265 let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
8267 let chan_1_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8268 let chan_2_id = create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8269 let chan_3_id = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8270 let chan_4_id = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8271 let logger = test_utils::TestLogger::new();
8273 let (payment_preimage, payment_hash, payment_secret) = get_payment_preimage_hash!(&nodes[3]);
8274 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
8275 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();
8276 let path = route.paths[0].clone();
8277 route.paths.push(path);
8278 route.paths[0][0].pubkey = nodes[1].node.get_our_node_id();
8279 route.paths[0][0].short_channel_id = chan_1_id;
8280 route.paths[0][1].short_channel_id = chan_3_id;
8281 route.paths[1][0].pubkey = nodes[2].node.get_our_node_id();
8282 route.paths[1][0].short_channel_id = chan_2_id;
8283 route.paths[1][1].short_channel_id = chan_4_id;
8284 send_along_route_with_secret(&nodes[0], route, &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], 200_000, payment_hash, payment_secret);
8285 claim_payment_along_route(&nodes[0], &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], false, payment_preimage);
8289 fn test_preimage_storage() {
8290 // Simple test of payment preimage storage allowing no client-side storage to claim payments
8291 let chanmon_cfgs = create_chanmon_cfgs(2);
8292 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8293 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8294 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8296 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8299 let (payment_hash, payment_secret) = nodes[1].node.create_inbound_payment(Some(100_000), 7200, 42);
8301 let logger = test_utils::TestLogger::new();
8302 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
8303 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();
8304 nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
8305 check_added_monitors!(nodes[0], 1);
8306 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
8307 let mut payment_event = SendEvent::from_event(events.pop().unwrap());
8308 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
8309 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
8311 // Note that after leaving the above scope we have no knowledge of any arguments or return
8312 // values from previous calls.
8313 let events = nodes[1].node.get_and_clear_pending_events();
8314 expect_pending_htlcs_forwardable!(nodes[1], events);
8315 let events = nodes[1].node.get_and_clear_pending_events();
8316 assert_eq!(events.len(), 1);
8318 Event::PaymentReceived { ref purpose, .. } => {
8320 PaymentPurpose::InvoicePayment { payment_preimage, user_payment_id, .. } => {
8321 assert_eq!(*user_payment_id, 42);
8322 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage.unwrap());
8324 _ => panic!("expected PaymentPurpose::InvoicePayment")
8327 _ => panic!("Unexpected event"),
8332 fn test_secret_timeout() {
8333 // Simple test of payment secret storage time outs
8334 let chanmon_cfgs = create_chanmon_cfgs(2);
8335 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8336 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8337 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8339 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8341 let (payment_hash, payment_secret_1) = nodes[1].node.create_inbound_payment(Some(100_000), 2, 0);
8343 // We should fail to register the same payment hash twice, at least until we've connected a
8344 // block with time 7200 + CHAN_CONFIRM_DEPTH + 1.
8345 if let Err(APIError::APIMisuseError { err }) = nodes[1].node.create_inbound_payment_for_hash(payment_hash, Some(100_000), 2, 0) {
8346 assert_eq!(err, "Duplicate payment hash");
8347 } else { panic!(); }
8349 let node_1_blocks = nodes[1].blocks.lock().unwrap();
8351 header: BlockHeader {
8353 prev_blockhash: node_1_blocks.last().unwrap().0.block_hash(),
8354 merkle_root: Default::default(),
8355 time: node_1_blocks.len() as u32 + 7200, bits: 42, nonce: 42 },
8359 connect_block(&nodes[1], &block);
8360 if let Err(APIError::APIMisuseError { err }) = nodes[1].node.create_inbound_payment_for_hash(payment_hash, Some(100_000), 2, 0) {
8361 assert_eq!(err, "Duplicate payment hash");
8362 } else { panic!(); }
8364 // If we then connect the second block, we should be able to register the same payment hash
8365 // again with a different user_payment_id (this time getting a new payment secret).
8366 block.header.prev_blockhash = block.header.block_hash();
8367 block.header.time += 1;
8368 connect_block(&nodes[1], &block);
8369 let our_payment_secret = nodes[1].node.create_inbound_payment_for_hash(payment_hash, Some(100_000), 2, 42).unwrap();
8370 assert_ne!(payment_secret_1, our_payment_secret);
8373 let logger = test_utils::TestLogger::new();
8374 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
8375 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();
8376 nodes[0].node.send_payment(&route, payment_hash, &Some(our_payment_secret)).unwrap();
8377 check_added_monitors!(nodes[0], 1);
8378 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
8379 let mut payment_event = SendEvent::from_event(events.pop().unwrap());
8380 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
8381 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
8383 // Note that after leaving the above scope we have no knowledge of any arguments or return
8384 // values from previous calls.
8385 let events = nodes[1].node.get_and_clear_pending_events();
8386 expect_pending_htlcs_forwardable!(nodes[1], events);
8387 let events = nodes[1].node.get_and_clear_pending_events();
8388 assert_eq!(events.len(), 1);
8390 Event::PaymentReceived { purpose: PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, user_payment_id }, .. } => {
8391 assert!(payment_preimage.is_none());
8392 assert_eq!(user_payment_id, 42);
8393 assert_eq!(payment_secret, our_payment_secret);
8394 // We don't actually have the payment preimage with which to claim this payment!
8396 _ => panic!("Unexpected event"),
8401 fn test_bad_secret_hash() {
8402 // Simple test of unregistered payment hash/invalid payment secret handling
8403 let chanmon_cfgs = create_chanmon_cfgs(2);
8404 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8405 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8406 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8408 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8410 let random_payment_hash = PaymentHash([42; 32]);
8411 let random_payment_secret = PaymentSecret([43; 32]);
8412 let (our_payment_hash, our_payment_secret) = nodes[1].node.create_inbound_payment(Some(100_000), 2, 0);
8414 let logger = test_utils::TestLogger::new();
8415 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
8416 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();
8418 // All the below cases should end up being handled exactly identically, so we macro the
8419 // resulting events.
8420 macro_rules! handle_unknown_invalid_payment_data {
8422 check_added_monitors!(nodes[0], 1);
8423 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
8424 let payment_event = SendEvent::from_event(events.pop().unwrap());
8425 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
8426 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
8428 // We have to forward pending HTLCs once to process the receipt of the HTLC and then
8429 // again to process the pending backwards-failure of the HTLC
8430 let events = nodes[1].node.get_and_clear_pending_events();
8431 expect_pending_htlcs_forwardable!(nodes[1], events);
8432 let events = nodes[1].node.get_and_clear_pending_events();
8433 expect_pending_htlcs_forwardable!(nodes[1], events);
8434 check_added_monitors!(nodes[1], 1);
8436 // We should fail the payment back
8437 let mut events = nodes[1].node.get_and_clear_pending_msg_events();
8438 match events.pop().unwrap() {
8439 MessageSendEvent::UpdateHTLCs { node_id: _, updates: msgs::CommitmentUpdate { update_fail_htlcs, commitment_signed, .. } } => {
8440 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
8441 commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false);
8443 _ => panic!("Unexpected event"),
8448 let expected_error_code = 0x4000|15; // incorrect_or_unknown_payment_details
8449 // Error data is the HTLC value (100,000) and current block height
8450 let expected_error_data = [0, 0, 0, 0, 0, 1, 0x86, 0xa0, 0, 0, 0, CHAN_CONFIRM_DEPTH as u8];
8452 // Send a payment with the right payment hash but the wrong payment secret
8453 nodes[0].node.send_payment(&route, our_payment_hash, &Some(random_payment_secret)).unwrap();
8454 handle_unknown_invalid_payment_data!();
8455 let events = nodes[0].node.get_and_clear_pending_events();
8456 expect_payment_failed!(nodes[0], events, our_payment_hash, true, expected_error_code, expected_error_data);
8458 // Send a payment with a random payment hash, but the right payment secret
8459 nodes[0].node.send_payment(&route, random_payment_hash, &Some(our_payment_secret)).unwrap();
8460 handle_unknown_invalid_payment_data!();
8461 let events = nodes[0].node.get_and_clear_pending_events();
8462 expect_payment_failed!(nodes[0], events, random_payment_hash, true, expected_error_code, expected_error_data);
8464 // Send a payment with a random payment hash and random payment secret
8465 nodes[0].node.send_payment(&route, random_payment_hash, &Some(random_payment_secret)).unwrap();
8466 handle_unknown_invalid_payment_data!();
8467 let events = nodes[0].node.get_and_clear_pending_events();
8468 expect_payment_failed!(nodes[0], events, random_payment_hash, true, expected_error_code, expected_error_data);
8472 fn test_update_err_monitor_lockdown() {
8473 // Our monitor will lock update of local commitment transaction if a broadcastion condition
8474 // has been fulfilled (either force-close from Channel or block height requiring a HTLC-
8475 // timeout). Trying to update monitor after lockdown should return a ChannelMonitorUpdateErr.
8477 // This scenario may happen in a watchtower setup, where watchtower process a block height
8478 // triggering a timeout while a slow-block-processing ChannelManager receives a local signed
8479 // commitment at same time.
8481 let chanmon_cfgs = create_chanmon_cfgs(2);
8482 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8483 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8484 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8486 // Create some initial channel
8487 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
8488 let outpoint = OutPoint { txid: chan_1.3.txid(), index: 0 };
8490 // Rebalance the network to generate htlc in the two directions
8491 send_payment(&nodes[0], &vec!(&nodes[1])[..], 10_000_000);
8493 // Route a HTLC from node 0 to node 1 (but don't settle)
8494 let preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000).0;
8496 // Copy ChainMonitor to simulate a watchtower and update block height of node 0 until its ChannelMonitor timeout HTLC onchain
8497 let chain_source = test_utils::TestChainSource::new(Network::Testnet);
8498 let logger = test_utils::TestLogger::with_id(format!("node {}", 0));
8499 let persister = test_utils::TestPersister::new();
8501 let monitors = nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap();
8502 let monitor = monitors.get(&outpoint).unwrap();
8503 let mut w = test_utils::TestVecWriter(Vec::new());
8504 monitor.write(&mut w).unwrap();
8505 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingSigner>)>::read(
8506 &mut io::Cursor::new(&w.0), &test_utils::OnlyReadsKeysInterface {}).unwrap().1;
8507 assert!(new_monitor == *monitor);
8508 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);
8509 assert!(watchtower.watch_channel(outpoint, new_monitor).is_ok());
8512 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8513 // Make the tx_broadcaster aware of enough blocks that it doesn't think we're violating
8514 // transaction lock time requirements here.
8515 chanmon_cfgs[0].tx_broadcaster.blocks.lock().unwrap().resize(200, (header, 0));
8516 watchtower.chain_monitor.block_connected(&Block { header, txdata: vec![] }, 200);
8518 // Try to update ChannelMonitor
8519 assert!(nodes[1].node.claim_funds(preimage));
8520 check_added_monitors!(nodes[1], 1);
8521 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
8522 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
8523 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
8524 if let Some(ref mut channel) = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan_1.2) {
8525 if let Ok((_, _, update)) = channel.commitment_signed(&updates.commitment_signed, &node_cfgs[0].logger) {
8526 if let Err(_) = watchtower.chain_monitor.update_channel(outpoint, update.clone()) {} else { assert!(false); }
8527 if let Ok(_) = nodes[0].chain_monitor.update_channel(outpoint, update) {} else { assert!(false); }
8528 } else { assert!(false); }
8529 } else { assert!(false); };
8530 // Our local monitor is in-sync and hasn't processed yet timeout
8531 check_added_monitors!(nodes[0], 1);
8532 let events = nodes[0].node.get_and_clear_pending_events();
8533 assert_eq!(events.len(), 1);
8537 fn test_concurrent_monitor_claim() {
8538 // Watchtower A receives block, broadcasts state N, then channel receives new state N+1,
8539 // sending it to both watchtowers, Bob accepts N+1, then receives block and broadcasts
8540 // the latest state N+1, Alice rejects state N+1, but Bob has already broadcast it,
8541 // state N+1 confirms. Alice claims output from state N+1.
8543 let chanmon_cfgs = create_chanmon_cfgs(2);
8544 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8545 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8546 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8548 // Create some initial channel
8549 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
8550 let outpoint = OutPoint { txid: chan_1.3.txid(), index: 0 };
8552 // Rebalance the network to generate htlc in the two directions
8553 send_payment(&nodes[0], &vec!(&nodes[1])[..], 10_000_000);
8555 // Route a HTLC from node 0 to node 1 (but don't settle)
8556 route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000).0;
8558 // Copy ChainMonitor to simulate watchtower Alice and update block height her ChannelMonitor timeout HTLC onchain
8559 let chain_source = test_utils::TestChainSource::new(Network::Testnet);
8560 let logger = test_utils::TestLogger::with_id(format!("node {}", "Alice"));
8561 let persister = test_utils::TestPersister::new();
8562 let watchtower_alice = {
8563 let monitors = nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap();
8564 let monitor = monitors.get(&outpoint).unwrap();
8565 let mut w = test_utils::TestVecWriter(Vec::new());
8566 monitor.write(&mut w).unwrap();
8567 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingSigner>)>::read(
8568 &mut io::Cursor::new(&w.0), &test_utils::OnlyReadsKeysInterface {}).unwrap().1;
8569 assert!(new_monitor == *monitor);
8570 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);
8571 assert!(watchtower.watch_channel(outpoint, new_monitor).is_ok());
8574 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8575 // Make the tx_broadcaster aware of enough blocks that it doesn't think we're violating
8576 // transaction lock time requirements here.
8577 chanmon_cfgs[0].tx_broadcaster.blocks.lock().unwrap().resize((CHAN_CONFIRM_DEPTH + 1 + TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS) as usize, (header, 0));
8578 watchtower_alice.chain_monitor.block_connected(&Block { header, txdata: vec![] }, CHAN_CONFIRM_DEPTH + 1 + TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS);
8580 // Watchtower Alice should have broadcast a commitment/HTLC-timeout
8582 let mut txn = chanmon_cfgs[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8583 assert_eq!(txn.len(), 2);
8587 // Copy ChainMonitor to simulate watchtower Bob and make it receive a commitment update first.
8588 let chain_source = test_utils::TestChainSource::new(Network::Testnet);
8589 let logger = test_utils::TestLogger::with_id(format!("node {}", "Bob"));
8590 let persister = test_utils::TestPersister::new();
8591 let watchtower_bob = {
8592 let monitors = nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap();
8593 let monitor = monitors.get(&outpoint).unwrap();
8594 let mut w = test_utils::TestVecWriter(Vec::new());
8595 monitor.write(&mut w).unwrap();
8596 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingSigner>)>::read(
8597 &mut io::Cursor::new(&w.0), &test_utils::OnlyReadsKeysInterface {}).unwrap().1;
8598 assert!(new_monitor == *monitor);
8599 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);
8600 assert!(watchtower.watch_channel(outpoint, new_monitor).is_ok());
8603 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8604 watchtower_bob.chain_monitor.block_connected(&Block { header, txdata: vec![] }, CHAN_CONFIRM_DEPTH + TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS);
8606 // Route another payment to generate another update with still previous HTLC pending
8607 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[0]);
8609 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
8610 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();
8611 nodes[1].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
8613 check_added_monitors!(nodes[1], 1);
8615 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
8616 assert_eq!(updates.update_add_htlcs.len(), 1);
8617 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &updates.update_add_htlcs[0]);
8618 if let Some(ref mut channel) = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan_1.2) {
8619 if let Ok((_, _, update)) = channel.commitment_signed(&updates.commitment_signed, &node_cfgs[0].logger) {
8620 // Watchtower Alice should already have seen the block and reject the update
8621 if let Err(_) = watchtower_alice.chain_monitor.update_channel(outpoint, update.clone()) {} else { assert!(false); }
8622 if let Ok(_) = watchtower_bob.chain_monitor.update_channel(outpoint, update.clone()) {} else { assert!(false); }
8623 if let Ok(_) = nodes[0].chain_monitor.update_channel(outpoint, update) {} else { assert!(false); }
8624 } else { assert!(false); }
8625 } else { assert!(false); };
8626 // Our local monitor is in-sync and hasn't processed yet timeout
8627 check_added_monitors!(nodes[0], 1);
8629 //// Provide one more block to watchtower Bob, expect broadcast of commitment and HTLC-Timeout
8630 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8631 watchtower_bob.chain_monitor.block_connected(&Block { header, txdata: vec![] }, CHAN_CONFIRM_DEPTH + 1 + TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS);
8633 // Watchtower Bob should have broadcast a commitment/HTLC-timeout
8636 let mut txn = chanmon_cfgs[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8637 assert_eq!(txn.len(), 2);
8638 bob_state_y = txn[0].clone();
8642 // We confirm Bob's state Y on Alice, she should broadcast a HTLC-timeout
8643 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8644 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);
8646 let htlc_txn = chanmon_cfgs[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8647 // We broadcast twice the transaction, once due to the HTLC-timeout, once due
8648 // the onchain detection of the HTLC output
8649 assert_eq!(htlc_txn.len(), 2);
8650 check_spends!(htlc_txn[0], bob_state_y);
8651 check_spends!(htlc_txn[1], bob_state_y);
8656 fn test_pre_lockin_no_chan_closed_update() {
8657 // Test that if a peer closes a channel in response to a funding_created message we don't
8658 // generate a channel update (as the channel cannot appear on chain without a funding_signed
8661 // Doing so would imply a channel monitor update before the initial channel monitor
8662 // registration, violating our API guarantees.
8664 // Previously, full_stack_target managed to hit this case by opening then closing a channel,
8665 // then opening a second channel with the same funding output as the first (which is not
8666 // rejected because the first channel does not exist in the ChannelManager) and closing it
8667 // before receiving funding_signed.
8668 let chanmon_cfgs = create_chanmon_cfgs(2);
8669 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8670 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8671 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8673 // Create an initial channel
8674 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
8675 let mut open_chan_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8676 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_msg);
8677 let accept_chan_msg = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
8678 nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &accept_chan_msg);
8680 // Move the first channel through the funding flow...
8681 let (temporary_channel_id, tx, _) = create_funding_transaction(&nodes[0], 100000, 42);
8683 nodes[0].node.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
8684 check_added_monitors!(nodes[0], 0);
8686 let funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
8687 let channel_id = ::chain::transaction::OutPoint { txid: funding_created_msg.funding_txid, index: funding_created_msg.funding_output_index }.to_channel_id();
8688 nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msgs::ErrorMessage { channel_id, data: "Hi".to_owned() });
8689 assert!(nodes[0].chain_monitor.added_monitors.lock().unwrap().is_empty());
8690 check_closed_event!(nodes[0], 1);
8694 fn test_htlc_no_detection() {
8695 // This test is a mutation to underscore the detection logic bug we had
8696 // before #653. HTLC value routed is above the remaining balance, thus
8697 // inverting HTLC and `to_remote` output. HTLC will come second and
8698 // it wouldn't be seen by pre-#653 detection as we were enumerate()'ing
8699 // on a watched outputs vector (Vec<TxOut>) thus implicitly relying on
8700 // outputs order detection for correct spending children filtring.
8702 let chanmon_cfgs = create_chanmon_cfgs(2);
8703 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8704 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8705 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8707 // Create some initial channels
8708 let chan_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
8710 send_payment(&nodes[0], &vec!(&nodes[1])[..], 1_000_000);
8711 let (_, our_payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 2_000_000);
8712 let local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
8713 assert_eq!(local_txn[0].input.len(), 1);
8714 assert_eq!(local_txn[0].output.len(), 3);
8715 check_spends!(local_txn[0], chan_1.3);
8717 // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
8718 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8719 connect_block(&nodes[0], &Block { header, txdata: vec![local_txn[0].clone()] });
8720 // We deliberately connect the local tx twice as this should provoke a failure calling
8721 // this test before #653 fix.
8722 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);
8723 check_closed_broadcast!(nodes[0], true);
8724 check_added_monitors!(nodes[0], 1);
8725 check_closed_event!(nodes[0], 1);
8726 connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1);
8728 let htlc_timeout = {
8729 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8730 assert_eq!(node_txn[1].input.len(), 1);
8731 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
8732 check_spends!(node_txn[1], local_txn[0]);
8736 let header_201 = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8737 connect_block(&nodes[0], &Block { header: header_201, txdata: vec![htlc_timeout.clone()] });
8738 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
8739 let events = nodes[0].node.get_and_clear_pending_events();
8740 expect_payment_failed!(nodes[0], events, our_payment_hash, true);
8743 fn do_test_onchain_htlc_settlement_after_close(broadcast_alice: bool, go_onchain_before_fulfill: bool) {
8744 // If we route an HTLC, then learn the HTLC's preimage after the upstream channel has been
8745 // force-closed, we must claim that HTLC on-chain. (Given an HTLC forwarded from Alice --> Bob -->
8746 // Carol, Alice would be the upstream node, and Carol the downstream.)
8748 // Steps of the test:
8749 // 1) Alice sends a HTLC to Carol through Bob.
8750 // 2) Carol doesn't settle the HTLC.
8751 // 3) If broadcast_alice is true, Alice force-closes her channel with Bob. Else Bob force closes.
8752 // Steps 4 and 5 may be reordered depending on go_onchain_before_fulfill.
8753 // 4) Bob sees the Alice's commitment on his chain or vice versa. An offered output is present
8754 // but can't be claimed as Bob doesn't have yet knowledge of the preimage.
8755 // 5) Carol release the preimage to Bob off-chain.
8756 // 6) Bob claims the offered output on the broadcasted commitment.
8757 let chanmon_cfgs = create_chanmon_cfgs(3);
8758 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
8759 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
8760 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
8762 // Create some initial channels
8763 let chan_ab = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
8764 create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 100000, 10001, InitFeatures::known(), InitFeatures::known());
8766 // Steps (1) and (2):
8767 // Send an HTLC Alice --> Bob --> Carol, but Carol doesn't settle the HTLC back.
8768 let (payment_preimage, _payment_hash, _payment_secret) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3_000_000);
8770 // Check that Alice's commitment transaction now contains an output for this HTLC.
8771 let alice_txn = get_local_commitment_txn!(nodes[0], chan_ab.2);
8772 check_spends!(alice_txn[0], chan_ab.3);
8773 assert_eq!(alice_txn[0].output.len(), 2);
8774 check_spends!(alice_txn[1], alice_txn[0]); // 2nd transaction is a non-final HTLC-timeout
8775 assert_eq!(alice_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
8776 assert_eq!(alice_txn.len(), 2);
8778 // Steps (3) and (4):
8779 // If `go_onchain_before_fufill`, broadcast the relevant commitment transaction and check that Bob
8780 // responds by (1) broadcasting a channel update and (2) adding a new ChannelMonitor.
8781 let mut force_closing_node = 0; // Alice force-closes
8782 if !broadcast_alice { force_closing_node = 1; } // Bob force-closes
8783 nodes[force_closing_node].node.force_close_channel(&chan_ab.2).unwrap();
8784 check_closed_broadcast!(nodes[force_closing_node], true);
8785 check_added_monitors!(nodes[force_closing_node], 1);
8786 check_closed_event!(nodes[force_closing_node], 1);
8787 if go_onchain_before_fulfill {
8788 let txn_to_broadcast = match broadcast_alice {
8789 true => alice_txn.clone(),
8790 false => get_local_commitment_txn!(nodes[1], chan_ab.2)
8792 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
8793 connect_block(&nodes[1], &Block { header, txdata: vec![txn_to_broadcast[0].clone()]});
8794 let mut bob_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8795 if broadcast_alice {
8796 check_closed_broadcast!(nodes[1], true);
8797 check_added_monitors!(nodes[1], 1);
8798 check_closed_event!(nodes[1], 1);
8800 assert_eq!(bob_txn.len(), 1);
8801 check_spends!(bob_txn[0], chan_ab.3);
8805 // Carol then claims the funds and sends an update_fulfill message to Bob, and they go through the
8806 // process of removing the HTLC from their commitment transactions.
8807 assert!(nodes[2].node.claim_funds(payment_preimage));
8808 check_added_monitors!(nodes[2], 1);
8809 let carol_updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
8810 assert!(carol_updates.update_add_htlcs.is_empty());
8811 assert!(carol_updates.update_fail_htlcs.is_empty());
8812 assert!(carol_updates.update_fail_malformed_htlcs.is_empty());
8813 assert!(carol_updates.update_fee.is_none());
8814 assert_eq!(carol_updates.update_fulfill_htlcs.len(), 1);
8816 nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &carol_updates.update_fulfill_htlcs[0]);
8817 expect_payment_forwarded!(nodes[1], if go_onchain_before_fulfill || force_closing_node == 1 { None } else { Some(1000) }, false);
8818 // If Alice broadcasted but Bob doesn't know yet, here he prepares to tell her about the preimage.
8819 if !go_onchain_before_fulfill && broadcast_alice {
8820 let events = nodes[1].node.get_and_clear_pending_msg_events();
8821 assert_eq!(events.len(), 1);
8823 MessageSendEvent::UpdateHTLCs { ref node_id, .. } => {
8824 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
8826 _ => panic!("Unexpected event"),
8829 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &carol_updates.commitment_signed);
8830 // One monitor update for the preimage to update the Bob<->Alice channel, one monitor update
8831 // Carol<->Bob's updated commitment transaction info.
8832 check_added_monitors!(nodes[1], 2);
8834 let events = nodes[1].node.get_and_clear_pending_msg_events();
8835 assert_eq!(events.len(), 2);
8836 let bob_revocation = match events[0] {
8837 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
8838 assert_eq!(*node_id, nodes[2].node.get_our_node_id());
8841 _ => panic!("Unexpected event"),
8843 let bob_updates = match events[1] {
8844 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
8845 assert_eq!(*node_id, nodes[2].node.get_our_node_id());
8848 _ => panic!("Unexpected event"),
8851 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bob_revocation);
8852 check_added_monitors!(nodes[2], 1);
8853 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bob_updates.commitment_signed);
8854 check_added_monitors!(nodes[2], 1);
8856 let events = nodes[2].node.get_and_clear_pending_msg_events();
8857 assert_eq!(events.len(), 1);
8858 let carol_revocation = match events[0] {
8859 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
8860 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
8863 _ => panic!("Unexpected event"),
8865 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &carol_revocation);
8866 check_added_monitors!(nodes[1], 1);
8868 // If this test requires the force-closed channel to not be on-chain until after the fulfill,
8869 // here's where we put said channel's commitment tx on-chain.
8870 let mut txn_to_broadcast = alice_txn.clone();
8871 if !broadcast_alice { txn_to_broadcast = get_local_commitment_txn!(nodes[1], chan_ab.2); }
8872 if !go_onchain_before_fulfill {
8873 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
8874 connect_block(&nodes[1], &Block { header, txdata: vec![txn_to_broadcast[0].clone()]});
8875 // If Bob was the one to force-close, he will have already passed these checks earlier.
8876 if broadcast_alice {
8877 check_closed_broadcast!(nodes[1], true);
8878 check_added_monitors!(nodes[1], 1);
8879 check_closed_event!(nodes[1], 1);
8881 let mut bob_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8882 if broadcast_alice {
8883 // In `connect_block()`, the ChainMonitor and ChannelManager are separately notified about a
8884 // new block being connected. The ChannelManager being notified triggers a monitor update,
8885 // which triggers broadcasting our commitment tx and an HTLC-claiming tx. The ChainMonitor
8886 // being notified triggers the HTLC-claiming tx redundantly, resulting in 3 total txs being
8888 assert_eq!(bob_txn.len(), 3);
8889 check_spends!(bob_txn[1], chan_ab.3);
8891 assert_eq!(bob_txn.len(), 2);
8892 check_spends!(bob_txn[0], chan_ab.3);
8897 // Finally, check that Bob broadcasted a preimage-claiming transaction for the HTLC output on the
8898 // broadcasted commitment transaction.
8900 let bob_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
8901 if go_onchain_before_fulfill {
8902 // Bob should now have an extra broadcasted tx, for the preimage-claiming transaction.
8903 assert_eq!(bob_txn.len(), 2);
8905 let script_weight = match broadcast_alice {
8906 true => OFFERED_HTLC_SCRIPT_WEIGHT,
8907 false => ACCEPTED_HTLC_SCRIPT_WEIGHT
8909 // If Alice force-closed and Bob didn't receive her commitment transaction until after he
8910 // received Carol's fulfill, he broadcasts the HTLC-output-claiming transaction first. Else if
8911 // Bob force closed or if he found out about Alice's commitment tx before receiving Carol's
8912 // fulfill, then he broadcasts the HTLC-output-claiming transaction second.
8913 if broadcast_alice && !go_onchain_before_fulfill {
8914 check_spends!(bob_txn[0], txn_to_broadcast[0]);
8915 assert_eq!(bob_txn[0].input[0].witness.last().unwrap().len(), script_weight);
8917 check_spends!(bob_txn[1], txn_to_broadcast[0]);
8918 assert_eq!(bob_txn[1].input[0].witness.last().unwrap().len(), script_weight);
8924 fn test_onchain_htlc_settlement_after_close() {
8925 do_test_onchain_htlc_settlement_after_close(true, true);
8926 do_test_onchain_htlc_settlement_after_close(false, true); // Technically redundant, but may as well
8927 do_test_onchain_htlc_settlement_after_close(true, false);
8928 do_test_onchain_htlc_settlement_after_close(false, false);
8932 fn test_duplicate_chan_id() {
8933 // Test that if a given peer tries to open a channel with the same channel_id as one that is
8934 // already open we reject it and keep the old channel.
8936 // Previously, full_stack_target managed to figure out that if you tried to open two channels
8937 // with the same funding output (ie post-funding channel_id), we'd create a monitor update for
8938 // the existing channel when we detect the duplicate new channel, screwing up our monitor
8939 // updating logic for the existing channel.
8940 let chanmon_cfgs = create_chanmon_cfgs(2);
8941 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8942 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8943 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8945 // Create an initial channel
8946 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
8947 let mut open_chan_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8948 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_msg);
8949 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()));
8951 // Try to create a second channel with the same temporary_channel_id as the first and check
8952 // that it is rejected.
8953 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_msg);
8955 let events = nodes[1].node.get_and_clear_pending_msg_events();
8956 assert_eq!(events.len(), 1);
8958 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
8959 // Technically, at this point, nodes[1] would be justified in thinking both the
8960 // first (valid) and second (invalid) channels are closed, given they both have
8961 // the same non-temporary channel_id. However, currently we do not, so we just
8962 // move forward with it.
8963 assert_eq!(msg.channel_id, open_chan_msg.temporary_channel_id);
8964 assert_eq!(node_id, nodes[0].node.get_our_node_id());
8966 _ => panic!("Unexpected event"),
8970 // Move the first channel through the funding flow...
8971 let (temporary_channel_id, tx, funding_output) = create_funding_transaction(&nodes[0], 100000, 42);
8973 nodes[0].node.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
8974 check_added_monitors!(nodes[0], 0);
8976 let mut funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
8977 nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created_msg);
8979 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
8980 assert_eq!(added_monitors.len(), 1);
8981 assert_eq!(added_monitors[0].0, funding_output);
8982 added_monitors.clear();
8984 let funding_signed_msg = get_event_msg!(nodes[1], MessageSendEvent::SendFundingSigned, nodes[0].node.get_our_node_id());
8986 let funding_outpoint = ::chain::transaction::OutPoint { txid: funding_created_msg.funding_txid, index: funding_created_msg.funding_output_index };
8987 let channel_id = funding_outpoint.to_channel_id();
8989 // Now we have the first channel past funding_created (ie it has a txid-based channel_id, not a
8992 // First try to open a second channel with a temporary channel id equal to the txid-based one.
8993 // Technically this is allowed by the spec, but we don't support it and there's little reason
8994 // to. Still, it shouldn't cause any other issues.
8995 open_chan_msg.temporary_channel_id = channel_id;
8996 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_msg);
8998 let events = nodes[1].node.get_and_clear_pending_msg_events();
8999 assert_eq!(events.len(), 1);
9001 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
9002 // Technically, at this point, nodes[1] would be justified in thinking both
9003 // channels are closed, but currently we do not, so we just move forward with it.
9004 assert_eq!(msg.channel_id, open_chan_msg.temporary_channel_id);
9005 assert_eq!(node_id, nodes[0].node.get_our_node_id());
9007 _ => panic!("Unexpected event"),
9011 // Now try to create a second channel which has a duplicate funding output.
9012 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
9013 let open_chan_2_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
9014 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_2_msg);
9015 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()));
9016 create_funding_transaction(&nodes[0], 100000, 42); // Get and check the FundingGenerationReady event
9018 let funding_created = {
9019 let mut a_channel_lock = nodes[0].node.channel_state.lock().unwrap();
9020 let mut as_chan = a_channel_lock.by_id.get_mut(&open_chan_2_msg.temporary_channel_id).unwrap();
9021 let logger = test_utils::TestLogger::new();
9022 as_chan.get_outbound_funding_created(tx.clone(), funding_outpoint, &&logger).unwrap()
9024 check_added_monitors!(nodes[0], 0);
9025 nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created);
9026 // At this point we'll try to add a duplicate channel monitor, which will be rejected, but
9027 // still needs to be cleared here.
9028 check_added_monitors!(nodes[1], 1);
9030 // ...still, nodes[1] will reject the duplicate channel.
9032 let events = nodes[1].node.get_and_clear_pending_msg_events();
9033 assert_eq!(events.len(), 1);
9035 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
9036 // Technically, at this point, nodes[1] would be justified in thinking both
9037 // channels are closed, but currently we do not, so we just move forward with it.
9038 assert_eq!(msg.channel_id, channel_id);
9039 assert_eq!(node_id, nodes[0].node.get_our_node_id());
9041 _ => panic!("Unexpected event"),
9045 // finally, finish creating the original channel and send a payment over it to make sure
9046 // everything is functional.
9047 nodes[0].node.handle_funding_signed(&nodes[1].node.get_our_node_id(), &funding_signed_msg);
9049 let mut added_monitors = nodes[0].chain_monitor.added_monitors.lock().unwrap();
9050 assert_eq!(added_monitors.len(), 1);
9051 assert_eq!(added_monitors[0].0, funding_output);
9052 added_monitors.clear();
9055 let events_4 = nodes[0].node.get_and_clear_pending_events();
9056 assert_eq!(events_4.len(), 0);
9057 assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
9058 assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0].txid(), funding_output.txid);
9060 let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
9061 let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
9062 update_nodes_with_chan_announce(&nodes, 0, 1, &announcement, &as_update, &bs_update);
9063 send_payment(&nodes[0], &[&nodes[1]], 8000000);
9067 fn test_error_chans_closed() {
9068 // Test that we properly handle error messages, closing appropriate channels.
9070 // Prior to #787 we'd allow a peer to make us force-close a channel we had with a different
9071 // peer. The "real" fix for that is to index channels with peers_ids, however in the mean time
9072 // we can test various edge cases around it to ensure we don't regress.
9073 let chanmon_cfgs = create_chanmon_cfgs(3);
9074 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
9075 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
9076 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
9078 // Create some initial channels
9079 let chan_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
9080 let chan_2 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
9081 let chan_3 = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 100000, 10001, InitFeatures::known(), InitFeatures::known());
9083 assert_eq!(nodes[0].node.list_usable_channels().len(), 3);
9084 assert_eq!(nodes[1].node.list_usable_channels().len(), 2);
9085 assert_eq!(nodes[2].node.list_usable_channels().len(), 1);
9087 // Closing a channel from a different peer has no effect
9088 nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msgs::ErrorMessage { channel_id: chan_3.2, data: "ERR".to_owned() });
9089 assert_eq!(nodes[0].node.list_usable_channels().len(), 3);
9091 // Closing one channel doesn't impact others
9092 nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msgs::ErrorMessage { channel_id: chan_2.2, data: "ERR".to_owned() });
9093 check_added_monitors!(nodes[0], 1);
9094 check_closed_broadcast!(nodes[0], false);
9095 check_closed_event!(nodes[0], 1);
9096 assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0).len(), 1);
9097 assert_eq!(nodes[0].node.list_usable_channels().len(), 2);
9098 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);
9099 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);
9101 // A null channel ID should close all channels
9102 let _chan_4 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
9103 nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msgs::ErrorMessage { channel_id: [0; 32], data: "ERR".to_owned() });
9104 check_added_monitors!(nodes[0], 2);
9105 check_closed_event!(nodes[0], 2);
9106 let events = nodes[0].node.get_and_clear_pending_msg_events();
9107 assert_eq!(events.len(), 2);
9109 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
9110 assert_eq!(msg.contents.flags & 2, 2);
9112 _ => panic!("Unexpected event"),
9115 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
9116 assert_eq!(msg.contents.flags & 2, 2);
9118 _ => panic!("Unexpected event"),
9120 // Note that at this point users of a standard PeerHandler will end up calling
9121 // peer_disconnected with no_connection_possible set to false, duplicating the
9122 // close-all-channels logic. That's OK, we don't want to end up not force-closing channels for
9123 // users with their own peer handling logic. We duplicate the call here, however.
9124 assert_eq!(nodes[0].node.list_usable_channels().len(), 1);
9125 assert!(nodes[0].node.list_usable_channels()[0].channel_id == chan_3.2);
9127 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), true);
9128 assert_eq!(nodes[0].node.list_usable_channels().len(), 1);
9129 assert!(nodes[0].node.list_usable_channels()[0].channel_id == chan_3.2);
9133 fn test_invalid_funding_tx() {
9134 // Test that we properly handle invalid funding transactions sent to us from a peer.
9136 // Previously, all other major lightning implementations had failed to properly sanitize
9137 // funding transactions from their counterparties, leading to a multi-implementation critical
9138 // security vulnerability (though we always sanitized properly, we've previously had
9139 // un-released crashes in the sanitization process).
9140 let chanmon_cfgs = create_chanmon_cfgs(2);
9141 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
9142 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
9143 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
9145 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100_000, 10_000, 42, None).unwrap();
9146 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()));
9147 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()));
9149 let (temporary_channel_id, mut tx, _) = create_funding_transaction(&nodes[0], 100_000, 42);
9150 for output in tx.output.iter_mut() {
9151 // Make the confirmed funding transaction have a bogus script_pubkey
9152 output.script_pubkey = bitcoin::Script::new();
9155 nodes[0].node.funding_transaction_generated_unchecked(&temporary_channel_id, tx.clone(), 0).unwrap();
9156 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()));
9157 check_added_monitors!(nodes[1], 1);
9159 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()));
9160 check_added_monitors!(nodes[0], 1);
9162 let events_1 = nodes[0].node.get_and_clear_pending_events();
9163 assert_eq!(events_1.len(), 0);
9165 assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
9166 assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0], tx);
9167 nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
9169 confirm_transaction_at(&nodes[1], &tx, 1);
9170 check_closed_event!(nodes[1], 1);
9171 check_added_monitors!(nodes[1], 1);
9172 let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
9173 assert_eq!(events_2.len(), 1);
9174 if let MessageSendEvent::HandleError { node_id, action } = &events_2[0] {
9175 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
9176 if let msgs::ErrorAction::SendErrorMessage { msg } = action {
9177 assert_eq!(msg.data, "funding tx had wrong script/value or output index");
9178 } else { panic!(); }
9179 } else { panic!(); }
9180 assert_eq!(nodes[1].node.list_channels().len(), 0);
9183 fn do_test_tx_confirmed_skipping_blocks_immediate_broadcast(test_height_before_timelock: bool) {
9184 // In the first version of the chain::Confirm interface, after a refactor was made to not
9185 // broadcast CSV-locked transactions until their CSV lock is up, we wouldn't reliably broadcast
9186 // transactions after a `transactions_confirmed` call. Specifically, if the chain, provided via
9187 // `best_block_updated` is at height N, and a transaction output which we wish to spend at
9188 // height N-1 (due to a CSV to height N-1) is provided at height N, we will not broadcast the
9189 // spending transaction until height N+1 (or greater). This was due to the way
9190 // `ChannelMonitor::transactions_confirmed` worked, only checking if we should broadcast a
9191 // spending transaction at the height the input transaction was confirmed at, not whether we
9192 // should broadcast a spending transaction at the current height.
9193 // A second, similar, issue involved failing HTLCs backwards - because we only provided the
9194 // height at which transactions were confirmed to `OnchainTx::update_claims_view`, it wasn't
9195 // aware that the anti-reorg-delay had, in fact, already expired, waiting to fail-backwards
9196 // until we learned about an additional block.
9198 // As an additional check, if `test_height_before_timelock` is set, we instead test that we
9199 // aren't broadcasting transactions too early (ie not broadcasting them at all).
9200 let chanmon_cfgs = create_chanmon_cfgs(3);
9201 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
9202 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
9203 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
9204 *nodes[0].connect_style.borrow_mut() = ConnectStyle::BestBlockFirstSkippingBlocks;
9206 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
9207 let (chan_announce, _, channel_id, _) = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
9208 let (_, payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1_000_000);
9209 nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id(), false);
9210 nodes[2].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
9212 nodes[1].node.force_close_channel(&channel_id).unwrap();
9213 check_closed_broadcast!(nodes[1], true);
9214 check_closed_event!(nodes[1], 1);
9215 check_added_monitors!(nodes[1], 1);
9216 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
9217 assert_eq!(node_txn.len(), 1);
9219 let conf_height = nodes[1].best_block_info().1;
9220 if !test_height_before_timelock {
9221 connect_blocks(&nodes[1], 24 * 6);
9223 nodes[1].chain_monitor.chain_monitor.transactions_confirmed(
9224 &nodes[1].get_block_header(conf_height), &[(0, &node_txn[0])], conf_height);
9225 if test_height_before_timelock {
9226 // If we confirmed the close transaction, but timelocks have not yet expired, we should not
9227 // generate any events or broadcast any transactions
9228 assert!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
9229 assert!(nodes[1].chain_monitor.chain_monitor.get_and_clear_pending_events().is_empty());
9231 // We should broadcast an HTLC transaction spending our funding transaction first
9232 let spending_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
9233 assert_eq!(spending_txn.len(), 2);
9234 assert_eq!(spending_txn[0], node_txn[0]);
9235 check_spends!(spending_txn[1], node_txn[0]);
9236 // We should also generate a SpendableOutputs event with the to_self output (as its
9238 let descriptor_spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
9239 assert_eq!(descriptor_spend_txn.len(), 1);
9241 // If we also discover that the HTLC-Timeout transaction was confirmed some time ago, we
9242 // should immediately fail-backwards the HTLC to the previous hop, without waiting for an
9243 // additional block built on top of the current chain.
9244 nodes[1].chain_monitor.chain_monitor.transactions_confirmed(
9245 &nodes[1].get_block_header(conf_height + 1), &[(0, &spending_txn[1])], conf_height + 1);
9246 let events = nodes[1].node.get_and_clear_pending_events();
9247 expect_pending_htlcs_forwardable!(nodes[1], events);
9248 check_added_monitors!(nodes[1], 1);
9250 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
9251 assert!(updates.update_add_htlcs.is_empty());
9252 assert!(updates.update_fulfill_htlcs.is_empty());
9253 assert_eq!(updates.update_fail_htlcs.len(), 1);
9254 assert!(updates.update_fail_malformed_htlcs.is_empty());
9255 assert!(updates.update_fee.is_none());
9256 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
9257 commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, true, true);
9258 expect_payment_failed_with_update!(nodes[0], payment_hash, false, chan_announce.contents.short_channel_id, true);
9263 fn test_tx_confirmed_skipping_blocks_immediate_broadcast() {
9264 do_test_tx_confirmed_skipping_blocks_immediate_broadcast(false);
9265 do_test_tx_confirmed_skipping_blocks_immediate_broadcast(true);
9269 fn test_keysend_payments_to_public_node() {
9270 let chanmon_cfgs = create_chanmon_cfgs(2);
9271 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
9272 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
9273 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
9275 let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
9276 let network_graph = &nodes[0].net_graph_msg_handler.network_graph;
9277 let payer_pubkey = nodes[0].node.get_our_node_id();
9278 let payee_pubkey = nodes[1].node.get_our_node_id();
9279 let route = get_route(&payer_pubkey, network_graph, &payee_pubkey, None,
9280 None, &vec![], 10000, 40,
9281 nodes[0].logger).unwrap();
9283 let test_preimage = PaymentPreimage([42; 32]);
9284 let payment_hash = nodes[0].node.send_spontaneous_payment(&route, Some(test_preimage)).unwrap();
9285 check_added_monitors!(nodes[0], 1);
9286 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
9287 assert_eq!(events.len(), 1);
9288 let event = events.pop().unwrap();
9289 let path = vec![&nodes[1]];
9290 pass_along_path(&nodes[0], &path, 10000, payment_hash, None, event, true, Some(test_preimage));
9291 claim_payment(&nodes[0], &path, test_preimage);
9295 fn test_keysend_payments_to_private_node() {
9296 let chanmon_cfgs = create_chanmon_cfgs(2);
9297 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
9298 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
9299 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
9301 let payer_pubkey = nodes[0].node.get_our_node_id();
9302 let payee_pubkey = nodes[1].node.get_our_node_id();
9303 nodes[0].node.peer_connected(&payee_pubkey, &msgs::Init { features: InitFeatures::known() });
9304 nodes[1].node.peer_connected(&payer_pubkey, &msgs::Init { features: InitFeatures::known() });
9306 let _chan = create_chan_between_nodes(&nodes[0], &nodes[1], InitFeatures::known(), InitFeatures::known());
9307 let network_graph = &nodes[0].net_graph_msg_handler.network_graph;
9308 let first_hops = nodes[0].node.list_usable_channels();
9309 let route = get_keysend_route(&payer_pubkey, &network_graph, &payee_pubkey,
9310 Some(&first_hops.iter().collect::<Vec<_>>()), &vec![], 10000, 40,
9311 nodes[0].logger).unwrap();
9313 let test_preimage = PaymentPreimage([42; 32]);
9314 let payment_hash = nodes[0].node.send_spontaneous_payment(&route, Some(test_preimage)).unwrap();
9315 check_added_monitors!(nodes[0], 1);
9316 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
9317 assert_eq!(events.len(), 1);
9318 let event = events.pop().unwrap();
9319 let path = vec![&nodes[1]];
9320 pass_along_path(&nodes[0], &path, 10000, payment_hash, None, event, true, Some(test_preimage));
9321 claim_payment(&nodes[0], &path, test_preimage);
9324 fn do_test_max_dust_htlc_exposure(dust_outbound_balance: bool, at_forward: bool, on_holder_tx: bool) {
9325 // Test that we properly reject dust HTLC violating our `max_dust_htlc_exposure_msat` policy.
9327 // At HTLC forward (`send_payment()`), if the sum of the trimmed-to-dust HTLC inbound and
9328 // trimmed-to-dust HTLC outbound balance and this new payment as included on next counterparty
9329 // commitment are above our `max_dust_htlc_exposure_msat`, we'll reject the update.
9330 // At HTLC reception (`update_add_htlc()`), if the sum of the trimmed-to-dust HTLC inbound
9331 // and trimmed-to-dust HTLC outbound balance and this new received HTLC as included on next
9332 // counterparty commitment are above our `max_dust_htlc_exposure_msat`, we'll fail the update.
9333 // Note, we return a `temporary_channel_failure` (0x1000 | 7), as the channel might be
9334 // available again for HTLC processing once the dust bandwidth has cleared up.
9336 let chanmon_cfgs = create_chanmon_cfgs(2);
9337 let mut config = test_default_channel_config();
9338 config.channel_options.max_dust_htlc_exposure_msat = 5_000_000; // default setting value
9339 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
9340 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, Some(config)]);
9341 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
9343 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 1_000_000, 500_000_000, 42, None).unwrap();
9344 let mut open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
9345 open_channel.max_htlc_value_in_flight_msat = 50_000_000;
9346 open_channel.max_accepted_htlcs = 60;
9347 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_channel);
9348 let mut accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
9350 accept_channel.dust_limit_satoshis = 660;
9352 nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &accept_channel);
9354 let (temporary_channel_id, tx, _) = create_funding_transaction(&nodes[0], 1_000_000, 42);
9357 if let Some(mut chan) = nodes[1].node.channel_state.lock().unwrap().by_id.get_mut(&temporary_channel_id) {
9358 chan.holder_dust_limit_satoshis = 660;
9362 nodes[0].node.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
9363 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()));
9364 check_added_monitors!(nodes[1], 1);
9366 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()));
9367 check_added_monitors!(nodes[0], 1);
9369 let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
9370 let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
9371 update_nodes_with_chan_announce(&nodes, 0, 1, &announcement, &as_update, &bs_update);
9374 if dust_outbound_balance {
9376 let (route, payment_hash, _, payment_secret) = get_route_and_payment_hash!(nodes[1], nodes[0], 2_300_000);
9377 if let Err(_) = nodes[1].node.send_payment(&route, payment_hash, &Some(payment_secret)) { panic!("Unexpected event at dust HTLC {}", i); }
9381 route_payment(&nodes[0], &[&nodes[1]], 2_300_000);
9385 if dust_outbound_balance {
9387 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
9388 if let Err(_) = nodes[1].node.send_payment(&route, payment_hash, &Some(payment_secret)) { panic!("Unexpected event at dust HTLC {}", i); }
9392 route_payment(&nodes[0], &[&nodes[1]], 200_000); // + 167_000 msat of HTLC-timeout tx at 253 sats/kWU
9398 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 });
9399 let mut config = UserConfig::default();
9401 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)));
9403 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)));
9406 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 });
9407 nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
9408 check_added_monitors!(nodes[0], 1);
9409 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
9410 assert_eq!(events.len(), 1);
9411 let payment_event = SendEvent::from_event(events.remove(0));
9412 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
9414 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);
9416 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);
9420 let _ = nodes[1].node.get_and_clear_pending_msg_events();
9421 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
9422 added_monitors.clear();
9426 fn test_max_dust_htlc_exposure() {
9427 do_test_max_dust_htlc_exposure(true, true, true);
9428 do_test_max_dust_htlc_exposure(false, true, true);
9429 do_test_max_dust_htlc_exposure(false, false, true);
9430 do_test_max_dust_htlc_exposure(false, false, false);
9431 do_test_max_dust_htlc_exposure(true, true, false);
9432 do_test_max_dust_htlc_exposure(true, false, false);
9433 do_test_max_dust_htlc_exposure(true, false, true);
9434 do_test_max_dust_htlc_exposure(false, true, false);